8fc9f76329
<!-- 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: #10443 For creating an intermediary/auxiliary tx (e.g. by the tipper in tipped transactions), using the existing `client.TxBuilder` is awkward. We propose a new client-side builder for this purpose. API Usage (e.g. how the tipper would programmtically use this): ```go // Note: there's no need to use clientCtx.TxConfig anymore! bldr := clienttx.NewAuxTxBuilder() err := bldr.SetMsgs(msgs...) bldr.SetAddress("cosmos1...") bldr.SetMemo(...) bldr.SetTip(...) bldr.SetPubKey(...) err := bldr.SetSignMode(...) // DIRECT_AUX or AMINO, or else error // ... other setters are available // Get the bytes to sign. signBz, err := bldr.GetSignBytes() // Sign the bz using your favorite method. sig, err := privKey.sign(signBz) // Set the signature bldr.SetSig(sig) // Get the final auxSignerData to be sent to the fee payer auxSignerData, err:= bldr.GetAuxSignerData() ``` auxSignerData is a protobuf message, whose JSON reprensentation looks like: ```json { "address": "cosmos1...", "mode": "SIGN_MODE_{DIRECT_AUX,LEGACY_AMINO_JSON}", "sign_doc": { "body_bytes": "{base64 bytes}", "public_key": { "@type": "cosmos.sepc256k1.PubKey", "key": "{base64 bytes}" }, "chain_id": "...", "account_number": 24, "sequence": 42, "tip": { "amount": [{ "denom": "uregen", "amount": 1000 }], "tipper": "cosmos1..." } }, "sig": "{base64 bytes}" } ``` Then the fee payer would use the TxBuilder to construct the final TX, with a new helper method: `AddAuxSignerData`: ```go // get auxSignerData from AuxTxBuilder auxSignerData := ... txBuilder := txConfig.NewTxBuilder() err := txBuilder.AddAuxSignerData(auxSignerData) // Set fee payer data txBuilder.SetFee() txBuilder.SetGasLimit() txBuilder.SetFeePayer() sigs, err := txBuilder.GetSignaturesV2() auxSig := sigs[0] // the aux signer's signature // Set all signer infos (1st round of calling SetSignatures) txBuilder.SetSignatures( auxSig, // The aux SignatureV2 signing.SignatureV2{...}, // The feePayer's SignatureV2 ) // Sign signBz, err = encCfg.TxConfig.SignModeHandler().GetSignBytes(...) feepayerSig, err := feepayerPriv.Sign(signBz) // Set all signatures (2nd round of calling SetSignatures) txBuilder.SetSignatures( auxSig, // The aux SignatureV2 signing.SignatureV2{feepayerSig, ...}, // The feePayer's SignatureV2 ) ``` --- ### 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)
255 lines
6.3 KiB
Go
255 lines
6.3 KiB
Go
package tx_test
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/cosmos/cosmos-sdk/client/tx"
|
|
"github.com/cosmos/cosmos-sdk/codec"
|
|
codectypes "github.com/cosmos/cosmos-sdk/codec/types"
|
|
cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
|
|
"github.com/cosmos/cosmos-sdk/simapp"
|
|
"github.com/cosmos/cosmos-sdk/testutil/testdata"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
typestx "github.com/cosmos/cosmos-sdk/types/tx"
|
|
"github.com/cosmos/cosmos-sdk/types/tx/signing"
|
|
)
|
|
|
|
func TestAuxTxBuilder(t *testing.T) {
|
|
encCfg := simapp.MakeTestEncodingConfig()
|
|
testdata.RegisterInterfaces(encCfg.InterfaceRegistry)
|
|
|
|
var b tx.AuxTxBuilder
|
|
|
|
testcases := []struct {
|
|
name string
|
|
malleate func() error
|
|
expErr bool
|
|
expErrStr string
|
|
}{
|
|
{
|
|
"cannot set SIGN_MODE_DIRECT",
|
|
func() error {
|
|
return b.SetSignMode(signing.SignMode_SIGN_MODE_DIRECT)
|
|
},
|
|
true, "AuxTxBuilder can only sign with SIGN_MODE_DIRECT_AUX or SIGN_MODE_LEGACY_AMINO_JSON",
|
|
},
|
|
{
|
|
"cannot set invalid pubkey",
|
|
func() error {
|
|
return b.SetPubKey(cryptotypes.PubKey(nil))
|
|
},
|
|
true, "failed packing protobuf message to Any",
|
|
},
|
|
{
|
|
"cannot set invalid Msg",
|
|
func() error {
|
|
return b.SetMsgs(sdk.Msg(nil))
|
|
},
|
|
true, "failed packing protobuf message to Any",
|
|
},
|
|
{
|
|
"GetSignBytes body should not be nil",
|
|
func() error {
|
|
_, err := b.GetSignBytes()
|
|
return err
|
|
},
|
|
true, "aux tx is nil, call setters on AuxTxBuilder first",
|
|
},
|
|
{
|
|
"GetSignBytes pubkey should not be nil",
|
|
func() error {
|
|
b.SetMsgs(msg1)
|
|
|
|
_, err := b.GetSignBytes()
|
|
return err
|
|
},
|
|
true, "public key cannot be empty: invalid pubkey",
|
|
},
|
|
{
|
|
"GetSignBytes invalid sign mode",
|
|
func() error {
|
|
b.SetMsgs(msg1)
|
|
b.SetPubKey(pub1)
|
|
|
|
_, err := b.GetSignBytes()
|
|
return err
|
|
},
|
|
true, "got unknown sign mode SIGN_MODE_UNSPECIFIED",
|
|
},
|
|
{
|
|
"GetSignBytes tipper should not be nil (if tip is set)",
|
|
func() error {
|
|
b.SetMsgs(msg1)
|
|
b.SetPubKey(pub1)
|
|
b.SetTip(&typestx.Tip{})
|
|
err := b.SetSignMode(signing.SignMode_SIGN_MODE_DIRECT_AUX)
|
|
require.NoError(t, err)
|
|
|
|
_, err = b.GetSignBytes()
|
|
return err
|
|
},
|
|
true, "tipper cannot be empty",
|
|
},
|
|
{
|
|
"GetSignBytes works for DIRECT_AUX",
|
|
func() error {
|
|
b.SetMsgs(msg1)
|
|
b.SetPubKey(pub1)
|
|
b.SetTip(tip)
|
|
err := b.SetSignMode(signing.SignMode_SIGN_MODE_DIRECT_AUX)
|
|
require.NoError(t, err)
|
|
|
|
_, err = b.GetSignBytes()
|
|
return err
|
|
},
|
|
false, "",
|
|
},
|
|
{
|
|
"GetAuxSignerData address should not be empty",
|
|
func() error {
|
|
b.SetMsgs(msg1)
|
|
b.SetPubKey(pub1)
|
|
b.SetTip(tip)
|
|
err := b.SetSignMode(signing.SignMode_SIGN_MODE_DIRECT_AUX)
|
|
require.NoError(t, err)
|
|
|
|
_, err = b.GetSignBytes()
|
|
require.NoError(t, err)
|
|
|
|
_, err = b.GetAuxSignerData()
|
|
return err
|
|
},
|
|
true, "address cannot be empty: invalid request",
|
|
},
|
|
{
|
|
"GetAuxSignerData signature should not be empty",
|
|
func() error {
|
|
b.SetMsgs(msg1)
|
|
b.SetPubKey(pub1)
|
|
b.SetTip(tip)
|
|
b.SetAddress(addr1.String())
|
|
err := b.SetSignMode(signing.SignMode_SIGN_MODE_DIRECT_AUX)
|
|
require.NoError(t, err)
|
|
|
|
_, err = b.GetSignBytes()
|
|
require.NoError(t, err)
|
|
|
|
_, err = b.GetAuxSignerData()
|
|
return err
|
|
},
|
|
true, "signature cannot be empty: no signatures supplied",
|
|
},
|
|
{
|
|
"GetAuxSignerData works for DIRECT_AUX",
|
|
func() error {
|
|
b.SetAccountNumber(1)
|
|
b.SetSequence(2)
|
|
b.SetTimeoutHeight(timeoutHeight)
|
|
b.SetMemo(memo)
|
|
b.SetChainID(chainID)
|
|
b.SetMsgs(msg1)
|
|
b.SetPubKey(pub1)
|
|
b.SetTip(tip)
|
|
b.SetAddress(addr1.String())
|
|
err := b.SetSignMode(signing.SignMode_SIGN_MODE_DIRECT_AUX)
|
|
require.NoError(t, err)
|
|
|
|
_, err = b.GetSignBytes()
|
|
require.NoError(t, err)
|
|
b.SetSignature(rawSig)
|
|
|
|
auxSignerData, err := b.GetAuxSignerData()
|
|
|
|
// Make sure auxSignerData is correctly populated
|
|
checkCorrectData(t, encCfg.Codec, auxSignerData, signing.SignMode_SIGN_MODE_DIRECT_AUX)
|
|
|
|
return err
|
|
},
|
|
false, "",
|
|
},
|
|
{
|
|
"GetSignBytes works for LEGACY_AMINO_JSON",
|
|
func() error {
|
|
b.SetMsgs(msg1)
|
|
b.SetPubKey(pub1)
|
|
b.SetTip(tip)
|
|
b.SetAddress(addr1.String())
|
|
err := b.SetSignMode(signing.SignMode_SIGN_MODE_LEGACY_AMINO_JSON)
|
|
require.NoError(t, err)
|
|
|
|
_, err = b.GetSignBytes()
|
|
return err
|
|
},
|
|
false, "",
|
|
},
|
|
{
|
|
"GetAuxSignerData works for LEGACY_AMINO_JSON",
|
|
func() error {
|
|
b.SetAccountNumber(1)
|
|
b.SetSequence(2)
|
|
b.SetTimeoutHeight(timeoutHeight)
|
|
b.SetMemo(memo)
|
|
b.SetChainID(chainID)
|
|
b.SetMsgs(msg1)
|
|
b.SetPubKey(pub1)
|
|
b.SetTip(tip)
|
|
b.SetAddress(addr1.String())
|
|
err := b.SetSignMode(signing.SignMode_SIGN_MODE_LEGACY_AMINO_JSON)
|
|
require.NoError(t, err)
|
|
|
|
_, err = b.GetSignBytes()
|
|
require.NoError(t, err)
|
|
b.SetSignature(rawSig)
|
|
|
|
auxSignerData, err := b.GetAuxSignerData()
|
|
|
|
// Make sure auxSignerData is correctly populated
|
|
checkCorrectData(t, encCfg.Codec, auxSignerData, signing.SignMode_SIGN_MODE_LEGACY_AMINO_JSON)
|
|
|
|
return err
|
|
},
|
|
false, "",
|
|
},
|
|
}
|
|
|
|
for _, tc := range testcases {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
b = tx.NewAuxTxBuilder()
|
|
err := tc.malleate()
|
|
|
|
if tc.expErr {
|
|
require.Error(t, err)
|
|
require.Contains(t, err.Error(), tc.expErrStr)
|
|
} else {
|
|
require.NoError(t, err)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// checkCorrectData that the auxSignerData's content matches the inputs we gave.
|
|
func checkCorrectData(t *testing.T, cdc codec.Codec, auxSignerData typestx.AuxSignerData, signMode signing.SignMode) {
|
|
pkAny, err := codectypes.NewAnyWithValue(pub1)
|
|
require.NoError(t, err)
|
|
msgAny, err := codectypes.NewAnyWithValue(msg1)
|
|
require.NoError(t, err)
|
|
|
|
var body typestx.TxBody
|
|
err = cdc.Unmarshal(auxSignerData.SignDoc.BodyBytes, &body)
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, uint64(1), auxSignerData.SignDoc.AccountNumber)
|
|
require.Equal(t, uint64(2), auxSignerData.SignDoc.Sequence)
|
|
require.Equal(t, timeoutHeight, body.TimeoutHeight)
|
|
require.Equal(t, memo, body.Memo)
|
|
require.Equal(t, chainID, auxSignerData.SignDoc.ChainId)
|
|
require.Equal(t, msgAny, body.GetMessages()[0])
|
|
require.Equal(t, pkAny, auxSignerData.SignDoc.PublicKey)
|
|
require.Equal(t, tip, auxSignerData.SignDoc.Tip)
|
|
require.Equal(t, signMode, auxSignerData.Mode)
|
|
require.Equal(t, rawSig, auxSignerData.Sig)
|
|
}
|