feat(x/tx): add basic handler types + sign mode direct #14787

aaronc · 2023-01-25T19:28:44Z

Description

Closes: #XXXX

Work is currently proceeding on sign mode textual in the new x/tx module, we are starting to look into #10993, and autocli/hubl will soon want tx support. The intention of this PR is to introduce a bit more structure to x/tx in terms of how sign modes are added and also to introduce the very basic sign mode direct as a building block.

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

confirmed the correct type prefix in the PR title
confirmed ! in the type prefix if API or client breaking change
confirmed all author checklist items have been addressed
reviewed state machine logic
reviewed API design and naming
reviewed documentation is accurate
reviewed tests and test coverage
manually tested (if applicable)

amaury1093

I prefer this SignModeHandler interface over the old one (with Modes and DefaultMode).

My only doubt about merging this now, is how long the 2 sign mode handlers will co-exist. Tx and signing stuff is already confusing, and this adds more complexity. For example, Evmos has their own handler, and I guess for hubl to work on their chain, they also need to add a new x/tx sign mode handler.

I would feel more comfortable if e.g. we did a spike to see if removing the old sign mode handler and replacing with this one right now would be viable (no unknown surprises). We would at least have the peace of mind that if we prioritized it, we could make the switch asap.

amaury1093 · 2023-01-26T10:22:34Z

x/tx/signing/std/handler_map.go

@@ -0,0 +1,28 @@
+package std


Why does std mean here? Could we put it in signing directly?

std just means standard or default. default is a reserved keyword but I wanted to do that
We can't put it in signing because this depends on all the other sign modes and all sign modes depend on signing.

x/tx/signing/std/handler_map.go

amaury1093 · 2023-01-26T10:39:37Z

x/tx/signing/std/handler_map.go

+	if s.CoinMetadataQueryFn == nil {
+		return nil, fmt.Errorf("missing %T needed for SIGN_MODE_TEXTUAL", s.CoinMetadataQueryFn)
+	}


This should go in textual.NewSignModeHandler. I believe in tests there are a couple of textual.NewSignModeHandler(nil), which should simply be replaced by textual.SignModeHandler{}.

I can do that in a follow-up if you want to keep this PR focused on tx signing structure.

Can you do that in a follow-up @AmauryM ?

x/tx/signing/tx_data.go

amaury1093 · 2023-01-26T10:44:39Z

x/tx/signing/tx_data.go

+	// BodyHasUnknownNonCriticals should be set to true if the transaction has been
+	// decoded and found to have unknown non-critical fields. This is only needed
+	// for amino JSON signing.
+	BodyHasUnknownNonCriticals bool


What should the amino handler do if this is true? Currently we just ignore right?

I think we reject but we should check

amaury1093 · 2023-01-26T10:47:39Z

x/tx/textual/valuerenderer.go

 // to specific value renderers for SIGN_MODE_TEXTUAL.
-type Textual struct {
+type SignModeHandler struct {


Renaming makes sense 👍

aaronc · 2023-01-26T12:27:29Z

I think we should consider this tx semantic version 2 - it's not duplication it's the next version. We can deprecate and remove the existing sign mode handler stuff once we can support amino JSON with protoreflect which hopefully will be ready soon

amaury1093 · 2023-01-26T14:26:31Z

I understand this is the next version. I think it's better to do it in this order:

protoreflect amino json encoder
this pr
remove old sign mode handler

rather than doing 2, 1, 3. Or more precisely, 2+3 should be done close to each other, this way the co-existence phase is as short as possible. BTW 1 can be shipped without 2+3, i.e. plugged into the old system, that's why I'm proposing to do it first.

If we decide that these 3 pieces will be merged atomically for the next release v048, then it's fine to merge this PR now.

aaronc · 2023-01-26T19:01:32Z

The reason I'd prefer to do this sooner is because it gives a structure to implement the amino JSON support and to start migrating the other stuff. For instance, we can start migrating aux and ante handler stuff if we have this

aaronc · 2023-02-06T15:55:23Z

Okay to move forward with this @AmauryM ? #14877 is moving forward and I think we can make pretty quick progress on other things

amaury1093 · 2023-02-06T16:15:14Z

Sure, let's fix the last couple of comments and merge this

…rect

aaronc · 2023-02-06T16:32:21Z

I did the one refactoring you suggested @AmauryM. There's another part that you said could be dealt with in a follow-up and then the one question about the SignModeOptions API.

amaury1093

LGTM

x/tx/signing/std/handler_map.go

aaronc · 2023-02-08T14:29:14Z

This needs a review from someone in @cosmos/sdk-core-dev

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

aaronc added 5 commits January 23, 2023 17:18

feat(x/tx): add basic sign mode direct support

a6d9c55

WIP

0972e0a

WIP

94810ea

WIP

6818e1d

working test

705fc3f

github-actions bot added the C:x/tx label Jan 25, 2023

aaronc added 2 commits January 25, 2023 14:34

docs

0d7b735

add standard handle map

72839f1

aaronc requested a review from amaury1093 January 25, 2023 19:43

aaronc changed the title ~~feat(x/tx): add basic sign mode direct support~~ feat(x/tx): add basic handler types + sign mode direct Jan 25, 2023

amaury1093 reviewed Jan 26, 2023

View reviewed changes

aaronc added 3 commits February 6, 2023 11:24

Merge branch 'main' of github.com:cosmos/cosmos-sdk into aaronc/tx-di…

29720cf

…rect

imports

e93a062

simplify TxData

3c67685

aaronc marked this pull request as ready for review February 6, 2023 16:31

aaronc requested a review from a team as a code owner February 6, 2023 16:31

amaury1093 approved these changes Feb 7, 2023

View reviewed changes

x/tx/signing/std/handler_map.go Show resolved Hide resolved

aaronc added 2 commits February 7, 2023 10:33

Merge branch 'main' into aaronc/tx-direct

6f4a47f

Merge branch 'main' into aaronc/tx-direct

97b03ba

julienrbrt assigned julienrbrt, JeancarloBarrios and samricotta Feb 8, 2023

amaury1093 approved these changes Feb 9, 2023

View reviewed changes

Merge branch 'main' into aaronc/tx-direct

b1484b4

julienrbrt approved these changes Feb 9, 2023

View reviewed changes

amaury1093 enabled auto-merge (squash) February 9, 2023 14:54

amaury1093 merged commit 8bd9288 into main Feb 9, 2023

amaury1093 deleted the aaronc/tx-direct branch February 9, 2023 15:01

facundomedica mentioned this pull request Feb 10, 2023

refactor: update to x/tx v0.2.0 #14994

Merged

19 tasks

faddat mentioned this pull request Mar 28, 2023

update linter to 1521 ChihuahuaChain/cosmos-sdk#6

Closed

19 tasks

tsenart pushed a commit to meka-dev/cosmos-sdk that referenced this pull request Apr 12, 2023

feat(x/tx): add basic handler types + sign mode direct (cosmos#14787)

12abcc5

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(x/tx): add basic handler types + sign mode direct #14787

feat(x/tx): add basic handler types + sign mode direct #14787

aaronc commented Jan 25, 2023

amaury1093 left a comment

amaury1093 Jan 26, 2023

aaronc Jan 26, 2023

amaury1093 Jan 26, 2023

aaronc Feb 6, 2023

amaury1093 Feb 6, 2023

amaury1093 Jan 26, 2023

aaronc Jan 26, 2023 •

edited

Loading

amaury1093 Jan 26, 2023

aaronc commented Jan 26, 2023

amaury1093 commented Jan 26, 2023

aaronc commented Jan 26, 2023

aaronc commented Feb 6, 2023

amaury1093 commented Feb 6, 2023

aaronc commented Feb 6, 2023

amaury1093 left a comment

aaronc commented Feb 8, 2023

feat(x/tx): add basic handler types + sign mode direct #14787

feat(x/tx): add basic handler types + sign mode direct #14787

Conversation

aaronc commented Jan 25, 2023

Description

Author Checklist

Reviewers Checklist

amaury1093 left a comment

Choose a reason for hiding this comment

amaury1093 Jan 26, 2023

Choose a reason for hiding this comment

aaronc Jan 26, 2023

Choose a reason for hiding this comment

amaury1093 Jan 26, 2023

Choose a reason for hiding this comment

aaronc Feb 6, 2023

Choose a reason for hiding this comment

amaury1093 Feb 6, 2023

Choose a reason for hiding this comment

amaury1093 Jan 26, 2023

Choose a reason for hiding this comment

aaronc Jan 26, 2023 • edited Loading

Choose a reason for hiding this comment

amaury1093 Jan 26, 2023

Choose a reason for hiding this comment

aaronc commented Jan 26, 2023

amaury1093 commented Jan 26, 2023

aaronc commented Jan 26, 2023

aaronc commented Feb 6, 2023

amaury1093 commented Feb 6, 2023

aaronc commented Feb 6, 2023

amaury1093 left a comment

Choose a reason for hiding this comment

aaronc commented Feb 8, 2023

aaronc Jan 26, 2023 •

edited

Loading