Add Tx, SignDoc from #6111 to types/types.proto, refactor Tx -> TxI a…

…nd Fee -> FeeI
cosmos · May 13, 2020 · 6a1a345 · 6a1a345
1 parent 6d7fc91
commit 6a1a345
Show file tree

Hide file tree

Showing 29 changed files with 3,767 additions and 767 deletions.
diff --git a/baseapp/baseapp.go b/baseapp/baseapp.go
@@ -467,7 +467,7 @@ func (app *BaseApp) cacheTxContext(ctx sdk.Context, txBytes []byte) (sdk.Context
 // Note, gas execution info is always returned. A reference to a Result is
 // returned if the tx does not run out of gas and if all the messages are valid
 // and execute successfully. An error is returned otherwise.
-func (app *BaseApp) runTx(mode runTxMode, txBytes []byte, tx sdk.Tx) (gInfo sdk.GasInfo, result *sdk.Result, err error) {
+func (app *BaseApp) runTx(mode runTxMode, txBytes []byte, tx sdk.TxI) (gInfo sdk.GasInfo, result *sdk.Result, err error) {
 	// NOTE: GasWanted should be returned by the AnteHandler. GasUsed is
 	// determined by the GasMeter. We need access to the context to get the gas
 	// meter so we initialize upfront.

diff --git a/baseapp/baseapp_test.go b/baseapp/baseapp_test.go
@@ -648,7 +648,7 @@ func (msg msgCounter2) ValidateBasic() error {
 
 // amino decode
 func testTxDecoder(cdc *codec.Codec) sdk.TxDecoder {
-	return func(txBytes []byte) (sdk.Tx, error) {
+	return func(txBytes []byte) (sdk.TxI, error) {
 		var tx txTest
 		if len(txBytes) == 0 {
 			return nil, sdkerrors.Wrap(sdkerrors.ErrTxDecode, "tx bytes are empty")
@@ -664,7 +664,7 @@ func testTxDecoder(cdc *codec.Codec) sdk.TxDecoder {
 }
 
 func anteHandlerTxTest(t *testing.T, capKey sdk.StoreKey, storeKey []byte) sdk.AnteHandler {
-	return func(ctx sdk.Context, tx sdk.Tx, simulate bool) (newCtx sdk.Context, err error) {
+	return func(ctx sdk.Context, tx sdk.TxI, simulate bool) (newCtx sdk.Context, err error) {
 		newCtx = ctx.WithEventManager(sdk.NewEventManager())
 		store := newCtx.KVStore(capKey)
 		txTest := tx.(txTest)
@@ -942,7 +942,7 @@ func TestSimulateTx(t *testing.T) {
 	gasConsumed := uint64(5)
 
 	anteOpt := func(bapp *BaseApp) {
-		bapp.SetAnteHandler(func(ctx sdk.Context, tx sdk.Tx, simulate bool) (newCtx sdk.Context, err error) {
+		bapp.SetAnteHandler(func(ctx sdk.Context, tx sdk.TxI, simulate bool) (newCtx sdk.Context, err error) {
 			newCtx = ctx.WithGasMeter(sdk.NewGasMeter(gasConsumed))
 			return
 		})
@@ -1008,7 +1008,7 @@ func TestSimulateTx(t *testing.T) {
 
 func TestRunInvalidTransaction(t *testing.T) {
 	anteOpt := func(bapp *BaseApp) {
-		bapp.SetAnteHandler(func(ctx sdk.Context, tx sdk.Tx, simulate bool) (newCtx sdk.Context, err error) {
+		bapp.SetAnteHandler(func(ctx sdk.Context, tx sdk.TxI, simulate bool) (newCtx sdk.Context, err error) {
 			return
 		})
 	}
@@ -1111,7 +1111,7 @@ func TestRunInvalidTransaction(t *testing.T) {
 func TestTxGasLimits(t *testing.T) {
 	gasGranted := uint64(10)
 	anteOpt := func(bapp *BaseApp) {
-		bapp.SetAnteHandler(func(ctx sdk.Context, tx sdk.Tx, simulate bool) (newCtx sdk.Context, err error) {
+		bapp.SetAnteHandler(func(ctx sdk.Context, tx sdk.TxI, simulate bool) (newCtx sdk.Context, err error) {
 			newCtx = ctx.WithGasMeter(sdk.NewGasMeter(gasGranted))
 
 			// AnteHandlers must have their own defer/recover in order for the BaseApp
@@ -1199,7 +1199,7 @@ func TestTxGasLimits(t *testing.T) {
 func TestMaxBlockGasLimits(t *testing.T) {
 	gasGranted := uint64(10)
 	anteOpt := func(bapp *BaseApp) {
-		bapp.SetAnteHandler(func(ctx sdk.Context, tx sdk.Tx, simulate bool) (newCtx sdk.Context, err error) {
+		bapp.SetAnteHandler(func(ctx sdk.Context, tx sdk.TxI, simulate bool) (newCtx sdk.Context, err error) {
 			newCtx = ctx.WithGasMeter(sdk.NewGasMeter(gasGranted))
 
 			defer func() {
@@ -1368,7 +1368,7 @@ func TestBaseAppAnteHandler(t *testing.T) {
 func TestGasConsumptionBadTx(t *testing.T) {
 	gasWanted := uint64(5)
 	anteOpt := func(bapp *BaseApp) {
-		bapp.SetAnteHandler(func(ctx sdk.Context, tx sdk.Tx, simulate bool) (newCtx sdk.Context, err error) {
+		bapp.SetAnteHandler(func(ctx sdk.Context, tx sdk.TxI, simulate bool) (newCtx sdk.Context, err error) {
 			newCtx = ctx.WithGasMeter(sdk.NewGasMeter(gasWanted))
 
 			defer func() {
@@ -1439,7 +1439,7 @@ func TestGasConsumptionBadTx(t *testing.T) {
 func TestQuery(t *testing.T) {
 	key, value := []byte("hello"), []byte("goodbye")
 	anteOpt := func(bapp *BaseApp) {
-		bapp.SetAnteHandler(func(ctx sdk.Context, tx sdk.Tx, simulate bool) (newCtx sdk.Context, err error) {
+		bapp.SetAnteHandler(func(ctx sdk.Context, tx sdk.TxI, simulate bool) (newCtx sdk.Context, err error) {
 			store := ctx.KVStore(capKey1)
 			store.Set(key, value)
 			return

diff --git a/baseapp/helpers.go b/baseapp/helpers.go
@@ -10,15 +10,15 @@ import (
 
 var isAlphaNumeric = regexp.MustCompile(`^[a-zA-Z0-9]+$`).MatchString
 
-func (app *BaseApp) Check(tx sdk.Tx) (sdk.GasInfo, *sdk.Result, error) {
+func (app *BaseApp) Check(tx sdk.TxI) (sdk.GasInfo, *sdk.Result, error) {
 	return app.runTx(runTxModeCheck, nil, tx)
 }
 
-func (app *BaseApp) Simulate(txBytes []byte, tx sdk.Tx) (sdk.GasInfo, *sdk.Result, error) {
+func (app *BaseApp) Simulate(txBytes []byte, tx sdk.TxI) (sdk.GasInfo, *sdk.Result, error) {
 	return app.runTx(runTxModeSimulate, txBytes, tx)
 }
 
-func (app *BaseApp) Deliver(tx sdk.Tx) (sdk.GasInfo, *sdk.Result, error) {
+func (app *BaseApp) Deliver(tx sdk.TxI) (sdk.GasInfo, *sdk.Result, error) {
 	return app.runTx(runTxModeDeliver, nil, tx)
 }
 

diff --git a/client/tx/tx.go b/client/tx/tx.go
@@ -32,7 +32,7 @@ type (
 	}
 
 	ClientFee interface {
-		sdk.Fee
+		sdk.FeeI
 		SetGas(uint64)
 		SetAmount(sdk.Coins)
 	}
@@ -48,13 +48,13 @@ type (
 	// signatures, and provide canonical bytes to sign over. The transaction must
 	// also know how to encode itself.
 	ClientTx interface {
-		sdk.Tx
+		sdk.TxI
 		codec.ProtoMarshaler
 
 		SetMsgs(...sdk.Msg) error
 		GetSignatures() []sdk.Signature
 		SetSignatures(...ClientSignature) error
-		GetFee() sdk.Fee
+		GetFee() sdk.FeeI
 		SetFee(ClientFee) error
 		GetMemo() string
 		SetMemo(string)

diff --git a/server/mock/tx.go b/server/mock/tx.go
@@ -16,7 +16,7 @@ type kvstoreTx struct {
 	bytes []byte
 }
 
-var _ sdk.Tx = kvstoreTx{}
+var _ sdk.TxI = kvstoreTx{}
 
 func NewTx(key, value string) kvstoreTx {
 	bytes := fmt.Sprintf("%s=%s", key, value)
@@ -58,8 +58,8 @@ func (tx kvstoreTx) GetSigners() []sdk.AccAddress {
 
 // takes raw transaction bytes and decodes them into an sdk.Tx. An sdk.Tx has
 // all the signatures and can be used to authenticate.
-func decodeTx(txBytes []byte) (sdk.Tx, error) {
-	var tx sdk.Tx
+func decodeTx(txBytes []byte) (sdk.TxI, error) {
+	var tx sdk.TxI
 
 	split := bytes.Split(txBytes, []byte("="))
 	if len(split) == 1 {

diff --git a/std/tx.go b/std/tx.go
@@ -1,7 +1,7 @@
 package std
 
 import (
-	"github.com/tendermint/go-amino"
+	amino "github.com/tendermint/go-amino"
 	"github.com/tendermint/tendermint/crypto"
 
 	clientx "github.com/cosmos/cosmos-sdk/client/tx"
@@ -11,7 +11,7 @@ import (
 )
 
 var (
-	_ sdk.Tx                  = (*Transaction)(nil)
+	_ sdk.TxI                 = (*Transaction)(nil)
 	_ clientx.ClientTx        = (*Transaction)(nil)
 	_ clientx.Generator       = TxGenerator{}
 	_ clientx.ClientFee       = &StdFee{}
@@ -147,7 +147,7 @@ func (tx *Transaction) SetSignatures(sdkSigs ...clientx.ClientSignature) error {
 }
 
 // GetFee returns the transaction's fee.
-func (tx Transaction) GetFee() sdk.Fee {
+func (tx Transaction) GetFee() sdk.FeeI {
 	return tx.Fee
 }
 

diff --git a/tests/mocks/types_handler.go b/tests/mocks/types_handler.go
diff --git a/types/codec.go b/types/codec.go
@@ -11,7 +11,7 @@ import (
 // Register the sdk message type
 func RegisterCodec(cdc *codec.Codec) {
 	cdc.RegisterInterface((*Msg)(nil), nil)
-	cdc.RegisterInterface((*Tx)(nil), nil)
+	cdc.RegisterInterface((*TxI)(nil), nil)
 }
 
 // Register the sdk message type

diff --git a/types/config_test.go b/types/config_test.go
@@ -24,9 +24,9 @@ func TestConfig_SetTxEncoder(t *testing.T) {
 	mockErr := errors.New("test")
 	config := sdk.NewConfig()
 	require.Nil(t, config.GetTxEncoder())
-	encFunc := sdk.TxEncoder(func(tx sdk.Tx) ([]byte, error) { return nil, nil })
+	encFunc := sdk.TxEncoder(func(tx sdk.TxI) ([]byte, error) { return nil, nil })
 	config.SetTxEncoder(encFunc)
-	_, err := config.GetTxEncoder()(sdk.Tx(nil))
+	_, err := config.GetTxEncoder()(sdk.TxI(nil))
 	require.Error(t, mockErr, err)
 
 	config.Seal()

diff --git a/types/handler.go b/types/handler.go
@@ -5,11 +5,11 @@ type Handler func(ctx Context, msg Msg) (*Result, error)
 
 // AnteHandler authenticates transactions, before their internal messages are handled.
 // If newCtx.IsZero(), ctx is used instead.
-type AnteHandler func(ctx Context, tx Tx, simulate bool) (newCtx Context, err error)
+type AnteHandler func(ctx Context, tx TxI, simulate bool) (newCtx Context, err error)
 
 // AnteDecorator wraps the next AnteHandler to perform custom pre- and post-processing.
 type AnteDecorator interface {
-	AnteHandle(ctx Context, tx Tx, simulate bool, next AnteHandler) (newCtx Context, err error)
+	AnteHandle(ctx Context, tx TxI, simulate bool, next AnteHandler) (newCtx Context, err error)
 }
 
 // ChainDecorator chains AnteDecorators together with each AnteDecorator
@@ -36,7 +36,7 @@ func ChainAnteDecorators(chain ...AnteDecorator) AnteHandler {
 		chain = append(chain, Terminator{})
 	}
 
-	return func(ctx Context, tx Tx, simulate bool) (Context, error) {
+	return func(ctx Context, tx TxI, simulate bool) (Context, error) {
 		return chain[0].AnteHandle(ctx, tx, simulate, ChainAnteDecorators(chain[1:]...))
 	}
 }
@@ -61,6 +61,6 @@ func ChainAnteDecorators(chain ...AnteDecorator) AnteHandler {
 type Terminator struct{}
 
 // Simply return provided Context and nil error
-func (t Terminator) AnteHandle(ctx Context, _ Tx, _ bool, _ AnteHandler) (Context, error) {
+func (t Terminator) AnteHandle(ctx Context, _ TxI, _ bool, _ AnteHandler) (Context, error) {
 	return ctx, nil
 }
diff --git a/types/handler_test.go b/types/handler_test.go
@@ -15,7 +15,7 @@ func TestChainAnteDecorators(t *testing.T) {
 	// test panic
 	require.Nil(t, sdk.ChainAnteDecorators([]sdk.AnteDecorator{}...))
 
-	ctx, tx := sdk.Context{}, sdk.Tx(nil)
+	ctx, tx := sdk.Context{}, sdk.TxI(nil)
 	mockCtrl := gomock.NewController(t)
 	mockAnteDecorator1 := mocks.NewMockAnteDecorator(mockCtrl)
 	mockAnteDecorator1.EXPECT().AnteHandle(gomock.Eq(ctx), gomock.Eq(tx), true, gomock.Any()).Times(1)

diff --git a/types/result.go b/types/result.go
@@ -79,12 +79,12 @@ type TxResponse struct {
 	Info      string          `json:"info,omitempty"`
 	GasWanted int64           `json:"gas_wanted,omitempty"`
 	GasUsed   int64           `json:"gas_used,omitempty"`
-	Tx        Tx              `json:"tx,omitempty"`
+	Tx        TxI             `json:"tx,omitempty"`
 	Timestamp string          `json:"timestamp,omitempty"`
 }
 
 // NewResponseResultTx returns a TxResponse given a ResultTx from tendermint
-func NewResponseResultTx(res *ctypes.ResultTx, tx Tx, timestamp string) TxResponse {
+func NewResponseResultTx(res *ctypes.ResultTx, tx TxI, timestamp string) TxResponse {
 	if res == nil {
 		return TxResponse{}
 	}

diff --git a/types/result_test.go b/types/result_test.go
@@ -91,12 +91,12 @@ func TestResponseResultTx(t *testing.T) {
 		Info:      "info",
 		GasWanted: 100,
 		GasUsed:   90,
-		Tx:        sdk.Tx(nil),
+		Tx:        sdk.TxI(nil),
 		Timestamp: "timestamp",
 	}
 
-	require.Equal(t, want, sdk.NewResponseResultTx(resultTx, sdk.Tx(nil), "timestamp"))
-	require.Equal(t, sdk.TxResponse{}, sdk.NewResponseResultTx(nil, sdk.Tx(nil), "timestamp"))
+	require.Equal(t, want, sdk.NewResponseResultTx(resultTx, sdk.TxI(nil), "timestamp"))
+	require.Equal(t, sdk.TxResponse{}, sdk.NewResponseResultTx(nil, sdk.TxI(nil), "timestamp"))
 	require.Equal(t, `Response:
   Height: 10
   TxHash: 74657374
@@ -108,7 +108,7 @@ func TestResponseResultTx(t *testing.T) {
   GasWanted: 100
   GasUsed: 90
   Codespace: codespace
-  Timestamp: timestamp`, sdk.NewResponseResultTx(resultTx, sdk.Tx(nil), "timestamp").String())
+  Timestamp: timestamp`, sdk.NewResponseResultTx(resultTx, sdk.TxI(nil), "timestamp").String())
 	require.True(t, sdk.TxResponse{}.Empty())
 	require.False(t, want.Empty())
 

diff --git a/types/tx_msg.go b/types/tx_msg.go
@@ -31,9 +31,9 @@ type (
 		GetSigners() []AccAddress
 	}
 
-	// Fee defines an interface for an application application-defined concrete
+	// FeeI defines an interface for an application application-defined concrete
 	// transaction type to be able to set and return the transaction fee.
-	Fee interface {
+	FeeI interface {
 		GetGas() uint64
 		GetAmount() Coins
 	}
@@ -46,7 +46,7 @@ type (
 	}
 
 	// Tx defines the interface a transaction must fulfill.
-	Tx interface {
+	TxI interface {
 		// Gets the all the transaction's messages.
 		GetMsgs() []Msg
 
@@ -57,10 +57,10 @@ type (
 )
 
 // TxDecoder unmarshals transaction bytes
-type TxDecoder func(txBytes []byte) (Tx, error)
+type TxDecoder func(txBytes []byte) (TxI, error)
 
 // TxEncoder marshals transaction to bytes
-type TxEncoder func(tx Tx) ([]byte, error)
+type TxEncoder func(tx TxI) ([]byte, error)
 
 //__________________________________________________________