From 931fbcff5cb4980c76239a75f2eb5b76b609fa4c Mon Sep 17 00:00:00 2001 From: Matt Kocubinski Date: Fri, 5 May 2023 15:47:12 -0500 Subject: [PATCH] refactor(x/tx)!: rename aminojson.NewAminoJSON -> aminojson.NewEncoder (#16044) --- tests/integration/aminojson/aminojson_test.go | 6 +++--- tests/integration/aminojson/repeated_test.go | 2 +- x/auth/tx/config.go | 2 +- x/tx/signing/aminojson/aminojson.go | 2 +- x/tx/signing/aminojson/aminojson_test.go | 2 +- x/tx/signing/aminojson/json_marshal.go | 4 ++-- x/tx/signing/aminojson/json_marshal_test.go | 6 +++--- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/tests/integration/aminojson/aminojson_test.go b/tests/integration/aminojson/aminojson_test.go index 25b714b6a7..fa79f006f8 100644 --- a/tests/integration/aminojson/aminojson_test.go +++ b/tests/integration/aminojson/aminojson_test.go @@ -91,7 +91,7 @@ func TestAminoJSON_Equivalence(t *testing.T) { distribution.AppModuleBasic{}, evidence.AppModuleBasic{}, feegrantmodule.AppModuleBasic{}, gov.AppModuleBasic{}, groupmodule.AppModuleBasic{}, mint.AppModuleBasic{}, params.AppModuleBasic{}, slashing.AppModuleBasic{}, staking.AppModuleBasic{}, upgrade.AppModuleBasic{}, vesting.AppModuleBasic{}) - aj := aminojson.NewAminoJSON() + aj := aminojson.NewEncoder() for _, tt := range rapidgen.DefaultGeneratedTypes { name := string(tt.Pulsar.ProtoReflect().Descriptor().FullName()) @@ -192,7 +192,7 @@ func TestAminoJSON_LegacyParity(t *testing.T) { bank.AppModuleBasic{}, distribution.AppModuleBasic{}, slashing.AppModuleBasic{}, staking.AppModuleBasic{}, vesting.AppModuleBasic{}) - aj := aminojson.NewAminoJSON() + aj := aminojson.NewEncoder() addr1 := types.AccAddress("addr1") now := time.Now() @@ -480,7 +480,7 @@ func TestSendAuthorization(t *testing.T) { encCfg := testutil.MakeTestEncodingConfig(auth.AppModuleBasic{}, authzmodule.AppModuleBasic{}, distribution.AppModuleBasic{}, bank.AppModuleBasic{}) - aj := aminojson.NewAminoJSON() + aj := aminojson.NewEncoder() // beware, Coins has as custom MarshalJSON method which changes how nil is handled // nil -> [] (empty list) diff --git a/tests/integration/aminojson/repeated_test.go b/tests/integration/aminojson/repeated_test.go index 0368214fa2..15390de183 100644 --- a/tests/integration/aminojson/repeated_test.go +++ b/tests/integration/aminojson/repeated_test.go @@ -17,7 +17,7 @@ import ( func TestRepeatedFields(t *testing.T) { cdc := codec.NewLegacyAmino() - aj := aminojson.NewAminoJSON() + aj := aminojson.NewEncoder() cases := map[string]struct { gogo gogoproto.Message diff --git a/x/auth/tx/config.go b/x/auth/tx/config.go index 448c9ebb02..755670a2b9 100644 --- a/x/auth/tx/config.go +++ b/x/auth/tx/config.go @@ -142,7 +142,7 @@ func NewTxConfigWithOptions(protoCodec codec.ProtoCodecMarshaler, configOptions panic(err) } case signingtypes.SignMode_SIGN_MODE_LEGACY_AMINO_JSON: - aminoJSONEncoder := aminojson.NewAminoJSON() + aminoJSONEncoder := aminojson.NewEncoder() handlers[i] = aminojson.NewSignModeHandler(aminojson.SignModeHandlerOptions{ FileResolver: signingOpts.FileResolver, TypeResolver: signingOpts.TypeResolver, diff --git a/x/tx/signing/aminojson/aminojson.go b/x/tx/signing/aminojson/aminojson.go index 8fa486f887..34a94146ef 100644 --- a/x/tx/signing/aminojson/aminojson.go +++ b/x/tx/signing/aminojson/aminojson.go @@ -42,7 +42,7 @@ func NewSignModeHandler(options SignModeHandlerOptions) *SignModeHandler { h.typeResolver = options.TypeResolver } if options.Encoder == nil { - h.encoder = NewAminoJSON() + h.encoder = NewEncoder() } else { h.encoder = *options.Encoder } diff --git a/x/tx/signing/aminojson/aminojson_test.go b/x/tx/signing/aminojson/aminojson_test.go index 10de8d1c43..2b619b5f6d 100644 --- a/x/tx/signing/aminojson/aminojson_test.go +++ b/x/tx/signing/aminojson/aminojson_test.go @@ -106,7 +106,7 @@ func TestAminoJsonSignMode(t *testing.T) { func TestNewSignModeHandler(t *testing.T) { handler := aminojson.NewSignModeHandler(aminojson.SignModeHandlerOptions{}) require.NotNil(t, handler) - aj := aminojson.NewAminoJSON() + aj := aminojson.NewEncoder() handler = aminojson.NewSignModeHandler(aminojson.SignModeHandlerOptions{ FileResolver: protoregistry.GlobalFiles, TypeResolver: protoregistry.GlobalTypes, diff --git a/x/tx/signing/aminojson/json_marshal.go b/x/tx/signing/aminojson/json_marshal.go index 01a91c7a2e..f018797017 100644 --- a/x/tx/signing/aminojson/json_marshal.go +++ b/x/tx/signing/aminojson/json_marshal.go @@ -25,9 +25,9 @@ type Encoder struct { fieldEncoders map[string]FieldEncoder } -// NewAminoJSON returns a new Encoder capable of serializing protobuf messages to JSON using the Amino JSON encoding +// NewEncoder returns a new Encoder capable of serializing protobuf messages to JSON using the Amino JSON encoding // rules. -func NewAminoJSON() Encoder { +func NewEncoder() Encoder { enc := Encoder{ scalarEncoders: map[string]FieldEncoder{ "cosmos.Dec": cosmosDecEncoder, diff --git a/x/tx/signing/aminojson/json_marshal_test.go b/x/tx/signing/aminojson/json_marshal_test.go index c86c2173a2..aab4f3952e 100644 --- a/x/tx/signing/aminojson/json_marshal_test.go +++ b/x/tx/signing/aminojson/json_marshal_test.go @@ -29,7 +29,7 @@ func TestAminoJSON_EdgeCases(t *testing.T) { cdc := amino.NewCodec() cdc.RegisterConcrete(&testpb.ABitOfEverything{}, "ABitOfEverything", nil) cdc.RegisterConcrete(&testpb.NestedMessage{}, "NestedMessage", nil) - aj := aminojson.NewAminoJSON() + aj := aminojson.NewEncoder() cases := map[string]struct { msg proto.Message @@ -91,7 +91,7 @@ func TestAminoJSON(t *testing.T) { Si64: -59268425823934, Sf64: -659101379604211154, } - bz, err := aminojson.NewAminoJSON().Marshal(msg) + bz, err := aminojson.NewEncoder().Marshal(msg) assert.NilError(t, err) legacyBz, err := cdc.MarshalJSON(msg) assert.NilError(t, err) @@ -102,7 +102,7 @@ func TestRapid(t *testing.T) { gen := rapidproto.MessageGenerator(&testpb.ABitOfEverything{}, rapidproto.GeneratorOptions{}) rapid.Check(t, func(t *rapid.T) { msg := gen.Draw(t, "msg") - bz, err := aminojson.NewAminoJSON().Marshal(msg) + bz, err := aminojson.NewEncoder().Marshal(msg) assert.NilError(t, err) checkInvariants(t, msg, bz) })