refactor(x/tx): use dynamicpb instead of type resolver in any marshal #16048
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,14 +2,20 @@ package simulation | |
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "math/rand" | ||
| "time" | ||
|
|
||
| gogoproto "github.com/cosmos/gogoproto/proto" | ||
| "google.golang.org/protobuf/proto" | ||
| protoreflect "google.golang.org/protobuf/reflect/protoreflect" | ||
| "google.golang.org/protobuf/types/dynamicpb" | ||
|
|
||
| "cosmossdk.io/x/tx/signing/aminojson" | ||
| "github.com/cosmos/cosmos-sdk/baseapp" | ||
| "github.com/cosmos/cosmos-sdk/codec" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/cosmos/cosmos-sdk/types/kv" | ||
| ) | ||
|
|
||
| // Deprecated: Use WeightedProposalMsg instead. | ||
|
|
@@ -95,11 +101,30 @@ func NewOperationMsg(msg sdk.Msg, ok bool, comment string, cdc *codec.ProtoCodec | |
| moduleName = msgType | ||
| } | ||
|
|
||
| resolver := gogoproto.HybridResolver | ||
| desc, err := resolver.FindDescriptorByName(protoreflect.FullName(gogoproto.MessageName(msg))) | ||
| if err != nil { | ||
| panic(fmt.Errorf("failed to find proto descriptor for %s: %w", msgType, err)) | ||
| } | ||
|
|
||
| dynamicMsgType := dynamicpb.NewMessageType(desc.(protoreflect.MessageDescriptor)) | ||
| dynamicMsg := dynamicMsgType.New().Interface() | ||
| gogoBytes, err := gogoproto.Marshal(msg) | ||
| if err != nil { | ||
| panic(fmt.Errorf("failed to marshal msg: %w", err)) | ||
| } | ||
| err = proto.Unmarshal(gogoBytes, dynamicMsg) | ||
| if err != nil { | ||
| panic(fmt.Errorf("failed to unmarshal msg: %w", err)) | ||
| } | ||
|
|
||
| encoder := aminojson.NewEncoder(aminojson.EncoderOptions{FileResolver: resolver}) | ||
| jsonBytes, err := encoder.Marshal(dynamicMsg) | ||
| if err != nil { | ||
| panic(fmt.Errorf("failed to marshal msg: %w", err)) | ||
| } | ||
|
There was a problem hiding this comment. Since this will be pretty common let's create some helpers for it. I would even go as far as saying that we can add a There was a problem hiding this comment. Are you suggesting adding |
||
|
|
||
| return NewOperationMsgBasic(moduleName, msgType, comment, ok, jsonBytes) | ||
| } | ||
|
|
||
| // NoOpMsg - create a no-operation message | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,9 @@ import ( | |
| "github.com/pkg/errors" | ||
| "google.golang.org/protobuf/proto" | ||
| "google.golang.org/protobuf/reflect/protoreflect" | ||
| "google.golang.org/protobuf/reflect/protoregistry" | ||
|
|
||
| "cosmossdk.io/x/tx/signing" | ||
| ) | ||
|
|
||
| // MessageEncoder is a function that can encode a protobuf protoreflect.Message to JSON. | ||
|
|
@@ -17,17 +20,26 @@ type MessageEncoder func(*Encoder, protoreflect.Message, io.Writer) error | |
| // FieldEncoder is a function that can encode a protobuf protoreflect.Value to JSON. | ||
| type FieldEncoder func(*Encoder, protoreflect.Value, io.Writer) error | ||
|
|
||
| // EncoderOptions are options for creating a new Encoder. | ||
| type EncoderOptions struct { | ||
| FileResolver signing.ProtoFileResolver | ||
|
There was a problem hiding this comment. I think there should be a TypeResolver option too |
||
| } | ||
|
|
||
| // Encoder is a JSON encoder that uses the Amino JSON encoding rules for protobuf messages. | ||
| type Encoder struct { | ||
| // maps cosmos_proto.scalar -> field encoder | ||
| scalarEncoders map[string]FieldEncoder | ||
| messageEncoders map[string]MessageEncoder | ||
| fieldEncoders map[string]FieldEncoder | ||
| fileResolver signing.ProtoFileResolver | ||
| } | ||
|
|
||
| // NewEncoder returns a new Encoder capable of serializing protobuf messages to JSON using the Amino JSON encoding | ||
| // rules. | ||
| func NewEncoder(options EncoderOptions) Encoder { | ||
|
There was a problem hiding this comment. If the options are facultative and do not need to be used all at the same time, why not having them variadic? There was a problem hiding this comment. It seems like a misuse of variadic to me since we never want more than one of them. There was a problem hiding this comment. Maybe we could have two constructors: Personally it seems OK to me supply empty options as a default with only one constructor. Any thoughts @aaronc ? There was a problem hiding this comment. Empty options would almost always be incorrect There was a problem hiding this comment. They're correct in tests. What are you proposing instead? There was a problem hiding this comment. I propose one |
||
| if options.FileResolver == nil { | ||
| options.FileResolver = protoregistry.GlobalFiles | ||
| } | ||
| enc := Encoder{ | ||
| scalarEncoders: map[string]FieldEncoder{ | ||
| "cosmos.Dec": cosmosDecEncoder, | ||
|
|
@@ -42,6 +54,7 @@ func NewEncoder() Encoder { | |
| "legacy_coins": nullSliceAsEmptyEncoder, | ||
| "cosmos_dec_bytes": cosmosDecEncoder, | ||
| }, | ||
| fileResolver: options.FileResolver, | ||
| } | ||
| return enc | ||
| } | ||
|
|
@@ -92,7 +105,7 @@ func (enc Encoder) Marshal(message proto.Message) ([]byte, error) { | |
| } | ||
|
|
||
| func (enc Encoder) beginMarshal(msg protoreflect.Message, writer io.Writer) error { | ||
| name, named := getMessageAminoName(msg.Descriptor().Options()) | ||
| if named { | ||
| _, err := writer.Write([]byte(fmt.Sprintf(`{"type":"%s","value":`, name))) | ||
| if err != nil { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another option I explored was packing sdk.Msg into an any message and then marshaling that, but if we do
the encoder will reject messages that are not tagged with an amino.name. Strictly speaking we don't need
an amino.name on messages which aren't expected to be packed into any fields except for this one case.