5d86db3ce5
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description Closes: #10484 This PR makes the following big changes: ### 1. Change the tx.Handler interface ```diff - CheckTx(ctx context.Context, tx sdk.Tx, req abci.RequestCheckTx) (abci.ResponseCheckTx, error) + CheckTx(ctx context.Context, req tx.Request, checkReq tx.RequestCheckTx) (tx.Response, tx.ResponseCheckTx, error) // same for Deliver and Simulate ``` where: ```go type Response struct { GasWanted uint64 GasUsed uint64 // MsgResponses is an array containing each Msg service handler's response // type, packed in an Any. This will get proto-serialized into the `Data` field // in the ABCI Check/DeliverTx responses. MsgResponses []*codectypes.Any Log string Events []abci.Event } ``` ### 2. Change what gets passed into the ABCI Check/DeliverTx `Data` field Before, we were passing the concatenation of MsgResponse bytes into the `Data`. Now we are passing the proto-serialiazation of this struct: ```proto message TxMsgData { repeated google.protobuf.Any msg_responses = 2; } ``` <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> --- ### 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... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)
92 lines
1.9 KiB
Go
92 lines
1.9 KiB
Go
//nolint
|
|
package mock
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"math"
|
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
|
|
"github.com/cosmos/cosmos-sdk/x/auth/middleware"
|
|
)
|
|
|
|
// kvstoreTx defines a tx for mock purposes. The `key` and `value` fields will
|
|
// set those bytes in the kvstore, and the `bytes` field represents its
|
|
// GetSignBytes value.
|
|
type kvstoreTx struct {
|
|
key []byte
|
|
value []byte
|
|
bytes []byte
|
|
}
|
|
|
|
// dummy implementation of proto.Message
|
|
func (msg *kvstoreTx) Reset() {}
|
|
func (msg *kvstoreTx) String() string { return "TODO" }
|
|
func (msg *kvstoreTx) ProtoMessage() {}
|
|
|
|
var _ sdk.Tx = &kvstoreTx{}
|
|
var _ sdk.Msg = &kvstoreTx{}
|
|
var _ middleware.GasTx = &kvstoreTx{}
|
|
|
|
func NewTx(key, value string) kvstoreTx {
|
|
bytes := fmt.Sprintf("%s=%s", key, value)
|
|
return kvstoreTx{
|
|
key: []byte(key),
|
|
value: []byte(value),
|
|
bytes: []byte(bytes),
|
|
}
|
|
}
|
|
|
|
func (tx kvstoreTx) Route() string {
|
|
return "kvstore"
|
|
}
|
|
|
|
func (tx kvstoreTx) Type() string {
|
|
return "kvstore_tx"
|
|
}
|
|
|
|
func (tx *kvstoreTx) GetMsgs() []sdk.Msg {
|
|
return []sdk.Msg{tx}
|
|
}
|
|
|
|
func (tx kvstoreTx) GetMemo() string {
|
|
return ""
|
|
}
|
|
|
|
func (tx kvstoreTx) GetSignBytes() []byte {
|
|
return tx.bytes
|
|
}
|
|
|
|
// Should the app be calling this? Or only handlers?
|
|
func (tx kvstoreTx) ValidateBasic() error {
|
|
return nil
|
|
}
|
|
|
|
func (tx kvstoreTx) GetSigners() []sdk.AccAddress {
|
|
return nil
|
|
}
|
|
|
|
func (tx kvstoreTx) GetGas() uint64 {
|
|
return math.MaxUint64
|
|
}
|
|
|
|
// 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
|
|
|
|
split := bytes.Split(txBytes, []byte("="))
|
|
if len(split) == 1 {
|
|
k := split[0]
|
|
tx = &kvstoreTx{k, k, txBytes}
|
|
} else if len(split) == 2 {
|
|
k, v := split[0], split[1]
|
|
tx = &kvstoreTx{k, v, txBytes}
|
|
} else {
|
|
return nil, sdkerrors.Wrap(sdkerrors.ErrTxDecode, "too many '='")
|
|
}
|
|
|
|
return tx, nil
|
|
}
|