refactor!: rm usages of .GetSignBytes

cosmos · May 8, 2023 · 025d165 · 025d165
1 parent 2f21cb5
commit 025d165
Show file tree

Hide file tree

Showing 33 changed files with 435 additions and 796 deletions.
diff --git a/api/cosmos/tx/v1beta1/tx.pulsar.go b/api/cosmos/tx/v1beta1/tx.pulsar.go
diff --git a/go.mod b/go.mod
@@ -162,6 +162,8 @@ require (
 
 // Below are the long-lived replace of the Cosmos SDK
 replace (
+	// TODO remove after cosmossdk.io/api release
+	cosmossdk.io/api => ./api
 	cosmossdk.io/core => ./core
 	cosmossdk.io/store => ./store
 	// TODO: remove after 0.7.0 release

diff --git a/go.sum b/go.sum
@@ -35,8 +35,6 @@ cloud.google.com/go/storage v1.6.0/go.mod h1:N7U0C8pVQ/+NIKOBQyamJIeKQKkZ+mxpohl
 cloud.google.com/go/storage v1.8.0/go.mod h1:Wv1Oy7z6Yz3DshWRJFhqM/UCfaWIRTdp0RXyy7KQOVs=
 cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9ullr3+Kg0=
 cloud.google.com/go/storage v1.14.0/go.mod h1:GrKmX003DSIwi9o29oFT7YDnHYwZoctc3fOKtUw0Xmo=
-cosmossdk.io/api v0.4.1 h1:0ikaYM6GyxTYYcfBiyR8YnLCfhNnhKpEFnaSepCTmqg=
-cosmossdk.io/api v0.4.1/go.mod h1:jR7k5ok90LxW2lFUXvd8Vpo/dr4PpiyVegxdm7b1ZdE=
 cosmossdk.io/collections v0.1.0 h1:nzJGeiq32KnZroSrhB6rPifw4I85Cgmzw/YAmr4luv8=
 cosmossdk.io/collections v0.1.0/go.mod h1:xbauc0YsbUF8qKMVeBZl0pFCunxBIhKN/WlxpZ3lBuo=
 cosmossdk.io/depinject v1.0.0-alpha.3 h1:6evFIgj//Y3w09bqOUOzEpFj5tsxBqdc5CfkO7z+zfw=

diff --git a/proto/cosmos/tx/v1beta1/tx.proto b/proto/cosmos/tx/v1beta1/tx.proto
@@ -1,6 +1,7 @@
 syntax = "proto3";
 package cosmos.tx.v1beta1;
 
+import "amino/amino.proto";
 import "gogoproto/gogo.proto";
 import "cosmos/crypto/multisig/v1beta1/multisig.proto";
 import "cosmos/base/v1beta1/coin.proto";
@@ -205,8 +206,12 @@ message ModeInfo {
 // which must be above some miminum to be accepted into the mempool.
 message Fee {
   // amount is the amount of coins to be paid as a fee
-  repeated cosmos.base.v1beta1.Coin amount = 1
-      [(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"];
+  repeated cosmos.base.v1beta1.Coin amount = 1 [
+    (gogoproto.nullable) = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
+    (amino.dont_omitempty) = true,
+    (amino.encoding) = "legacy_coins"
+  ];
 
   // gas_limit is the maximum gas that can be used in transaction processing
   // before an out of gas error occurs
@@ -228,8 +233,12 @@ message Fee {
 // Since: cosmos-sdk 0.46
 message Tip {
   // amount is the amount of the tip
-  repeated cosmos.base.v1beta1.Coin amount = 1
-      [(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"];
+  repeated cosmos.base.v1beta1.Coin amount = 1 [
+    (gogoproto.nullable) = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
+    (amino.dont_omitempty) = true,
+    (amino.encoding) = "legacy_coins"
+  ];
   // tipper is the address of the account paying for the tip
   string tipper = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
 }

diff --git a/server/mock/tx.go b/server/mock/tx.go
@@ -100,10 +100,6 @@ func (msg *KVStoreTx) GetMsgs() []sdk.Msg {
 	return []sdk.Msg{msg}
 }
 
-func (msg *KVStoreTx) GetSignBytes() []byte {
-	return msg.bytes
-}
-
 // Should the app be calling this? Or only handlers?
 func (msg *KVStoreTx) ValidateBasic() error {
 	return nil

diff --git a/testutil/testdata/tx.go b/testutil/testdata/tx.go
@@ -1,7 +1,6 @@
 package testdata
 
 import (
-	"encoding/json"
 	"testing"
 
 	"gotest.tools/v3/assert"
@@ -78,14 +77,6 @@ func NewTestMsg(addrs ...sdk.AccAddress) *TestMsg {
 
 var _ sdk.Msg = (*TestMsg)(nil)
 
-func (msg *TestMsg) GetSignBytes() []byte {
-	bz, err := json.Marshal(msg.Signers)
-	if err != nil {
-		panic(err)
-	}
-	return sdk.MustSortJSON(bz)
-}
-
 func (msg *TestMsg) GetSigners() []sdk.AccAddress {
 	signers := make([]sdk.AccAddress, 0, len(msg.Signers))
 	for _, addr := range msg.Signers {

diff --git a/types/tx/tx.pb.go b/types/tx/tx.pb.go
diff --git a/x/auth/migrations/legacytx/stdsign.go b/x/auth/migrations/legacytx/stdsign.go
@@ -44,16 +44,18 @@ type StdSignDoc struct {
 	Tip           *StdTip           `json:"tip,omitempty" yaml:"tip"`
 }
 
+var RegressionTestingAminoCodec *codec.LegacyAmino
+
 // StdSignBytes returns the bytes to sign for a transaction.
+// Deprecated: Only used in regression tests.
 func StdSignBytes(chainID string, accnum, sequence, timeout uint64, fee StdFee, msgs []sdk.Msg, memo string, tip *tx.Tip) []byte {
+	if RegressionTestingAminoCodec == nil {
+		panic(fmt.Errorf("must set RegressionTestingAminoCodec before calling StdSignBytes"))
+	}
 	msgsBytes := make([]json.RawMessage, 0, len(msgs))
 	for _, msg := range msgs {
-		legacyMsg, ok := msg.(LegacyMsg)
-		if !ok {
-			panic(fmt.Errorf("expected %T when using amino JSON", (*LegacyMsg)(nil)))
-		}
-
-		msgsBytes = append(msgsBytes, json.RawMessage(legacyMsg.GetSignBytes()))
+		bz := RegressionTestingAminoCodec.MustMarshalJSON(msg)
+		msgsBytes = append(msgsBytes, sdk.MustSortJSON(bz))
 	}
 
 	var stdTip *StdTip

diff --git a/x/auth/migrations/legacytx/stdsignmsg.go b/x/auth/migrations/legacytx/stdsignmsg.go
@@ -19,11 +19,6 @@ type StdSignMsg struct {
 	Memo          string    `json:"memo" yaml:"memo"`
 }
 
-// get message bytes
-func (msg StdSignMsg) Bytes() []byte {
-	return StdSignBytes(msg.ChainID, msg.AccountNumber, msg.Sequence, msg.TimeoutHeight, msg.Fee, msg.Msgs, msg.Memo, nil)
-}
-
 func (msg StdSignMsg) UnpackInterfaces(unpacker types.AnyUnpacker) error {
 	for _, m := range msg.Msgs {
 		err := types.UnpackInterfaces(m, unpacker)