Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add host cli to generate ica packet data #2297

Merged
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
22d9e1b
wip: adding command to display json value for interchain packet data
chatton Sep 14, 2022
3ecdc1d
tests: adding tests for generatePacketData
chatton Sep 15, 2022
1f12260
Merge branch 'main' into cian/issue#2243-add-a-ics27-host-cli-to-gene…
chatton Sep 15, 2022
fe4880a
chore: adding changelog entry
chatton Sep 15, 2022
4f3ef30
chore: fix useless assignment to local var
chatton Sep 15, 2022
4e6ed4e
chore: fix typo
chatton Sep 15, 2022
47abc0b
Merge branch 'main' into cian/issue#2243-add-a-ics27-host-cli-to-gene…
chatton Sep 19, 2022
96f1f24
Merge branch 'main' into cian/issue#2243-add-a-ics27-host-cli-to-gene…
chatton Sep 20, 2022
e067218
Merge branch 'main' into cian/issue#2243-add-a-ics27-host-cli-to-gene…
chatton Sep 21, 2022
8645a8b
chore: addressing PR feedback
chatton Sep 21, 2022
d520833
Merge branch 'main' into cian/issue#2243-add-a-ics27-host-cli-to-gene…
chatton Sep 21, 2022
2a43f5c
chore: merge main
chatton Sep 22, 2022
c5f7fdd
Merge branch 'main' into cian/issue#2243-add-a-ics27-host-cli-to-gene…
chatton Sep 22, 2022
cf2179f
chore: bumping imports
chatton Sep 22, 2022
d477702
Merge branch 'cian/issue#2243-add-a-ics27-host-cli-to-generate-ica-pa…
chatton Sep 22, 2022
5ae13d3
feat: adding support for both single and multiple messages
chatton Sep 23, 2022
e306637
chore: addressing PR feedback
chatton Sep 26, 2022
7411b53
Update modules/apps/27-interchain-accounts/host/client/cli/cli.go
chatton Sep 26, 2022
5076fbd
Merge branch 'main' into cian/issue#2243-add-a-ics27-host-cli-to-gene…
chatton Sep 27, 2022
30b7907
chore: use version AppName variable
chatton Sep 27, 2022
8bfbf57
Merge branch 'main' into cian/issue#2243-add-a-ics27-host-cli-to-gene…
chatton Sep 28, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
* (apps/27-interchain-accounts) [\#2290](https://github.com/cosmos/ibc-go/pull/2290) Changed `DefaultParams` function in `host` submodule to allow all messages by default. Defined a constant named `AllowAllHostMsgs` for `host` module to keep wildcard "*" string which allows all messages.
* (apps/27-interchain-accounts) [\#2248](https://github.com/cosmos/ibc-go/pull/2248) Adding call to underlying app in `OnChanCloseConfirm` callback of the controller submodule and adding relevant unit tests.
* (apps/27-interchain-accounts) [\#2251](https://github.com/cosmos/ibc-go/pull/2251) Adding `msgServer` struct to controller submodule that embeds the `Keeper` struct.
* (apps/27-interchain-accounts) [\#2297](https://github.com/cosmos/ibc-go/pull/2297) Adding cli command to generate ICS27 packet data.

### Features

Expand Down
1 change: 1 addition & 0 deletions modules/apps/27-interchain-accounts/client/cli/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ func NewTxCmd() *cobra.Command {

icaTxCmd.AddCommand(
controllercli.NewTxCmd(),
hostcli.NewTxCmd(),
)

return icaTxCmd
Expand Down
18 changes: 18 additions & 0 deletions modules/apps/27-interchain-accounts/host/client/cli/cli.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package cli

import (
"github.com/cosmos/cosmos-sdk/client"
"github.com/spf13/cobra"
)

Expand All @@ -20,3 +21,20 @@ func GetQueryCmd() *cobra.Command {

return queryCmd
}

// NewTxCmd creates and returns the tx command
func NewTxCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "host",
Short: "interchain-accounts host subcommands",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Short: "interchain-accounts host subcommands",
Short: "IBC interchain accounts host transaction subcommands",

See this PR.

DisableFlagParsing: true,
SuggestionsMinimumDistance: 2,
RunE: client.ValidateCmd,
}

cmd.AddCommand(
generatePacketDataCmd(),
)

return cmd
}
112 changes: 112 additions & 0 deletions modules/apps/27-interchain-accounts/host/client/cli/tx.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
package cli

import (
"encoding/json"

"github.com/cosmos/cosmos-sdk/client"
"github.com/cosmos/cosmos-sdk/codec"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/spf13/cobra"

icatypes "github.com/cosmos/ibc-go/v6/modules/apps/27-interchain-accounts/types"
)

const (
memoFlag string = "memo"
)

func generatePacketDataCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "generate-packet-data [message]",
Short: "Generates ICA packet data.",
Long: `generate-packet-data accepts a message string and serializes it
into packet data which is outputted to stdout. It can be used in conjunction with send-tx"
which submits pre-built packet data containing messages to be executed on the host chain.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible to add an example here? Maybe we can just use the regular bank transfer message used in the example in the ica-demo repo?

'{
    "@type":"/cosmos.bank.v1beta1.MsgSend",
    "from_address":"cosmos15ccshhmp0gsx29qpqq6g4zmltnnvgmyu9ueuadh9y2nc5zj0szls5gtddz",
    "to_address":"cosmos10h9stc5v6ntgeygf5xf945njqq5h32r53uquvw",
    "amount": [
        {
            "denom": "stake",
            "amount": "1000"
        }
    ]
}'

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great suggestions, I'll add this as an example

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@crodriguezvega I added this example and also a multi message example.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @chatton!

`,
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
clientCtx, err := client.GetClientTxContext(cmd)
if err != nil {
return err
}

cdc := codec.NewProtoCodec(clientCtx.InterfaceRegistry)

memo, err := cmd.Flags().GetString(memoFlag)
if err != nil {
return err
}

packetDataBytes, err := generatePacketData(cdc, []byte(args[0]), memo)
Fixed Show fixed Hide fixed
if err != nil {
return err
}

cmd.Println(string(packetDataBytes))

return nil
},
}

cmd.Flags().String(memoFlag, "", "an optional memo to be included in the interchain account packet data")
return cmd
}

// generatePacketData takes in message bytes and a memo and serializes the message into an
// instance of InterchainAccountPacketData which is returned as bytes.
func generatePacketData(cdc *codec.ProtoCodec, msgBytes []byte, memo string) ([]byte, error) {
sdkMessages, err := convertBytesIntoSdkMessages(cdc, msgBytes)
if err != nil {
return nil, err
}

return generateIcaPacketDataFromSdkMessages(cdc, sdkMessages, memo)
}

// convertBytesIntoSdkMessages returns a list of sdk messages from bytes. The bytes can be in the form of a single
// message, or a json array of messages.
func convertBytesIntoSdkMessages(cdc *codec.ProtoCodec, msgBytes []byte) ([]sdk.Msg, error) {
var rawMessages []json.RawMessage
if err := json.Unmarshal(msgBytes, &rawMessages); err != nil {
// if we fail to unmarshal a list of messages, we assume we are just dealing with a single message.
// in this case we return a list of a single item.
var msg sdk.Msg
if err := cdc.UnmarshalInterfaceJSON(msgBytes, &msg); err != nil {
return nil, err
}

return []sdk.Msg{msg}, nil
}

sdkMessages := make([]sdk.Msg, len(rawMessages))
for i, anyJSON := range rawMessages {
var msg sdk.Msg
if err := cdc.UnmarshalInterfaceJSON(anyJSON, &msg); err != nil {
return nil, err
}

sdkMessages[i] = msg
}

return sdkMessages, nil
}

// generateIcaPacketDataFromSdkMessages generates ica packet data as bytes from a given set of sdk messages and a memo.
func generateIcaPacketDataFromSdkMessages(cdc *codec.ProtoCodec, sdkMessages []sdk.Msg, memo string) ([]byte, error) {
icaPacketDataBytes, err := icatypes.SerializeCosmosTx(cdc, sdkMessages)
if err != nil {
return nil, err
}

icaPacketData := icatypes.InterchainAccountPacketData{
Type: icatypes.EXECUTE_TX,
Data: icaPacketDataBytes,
Memo: memo,
}

if err := icaPacketData.ValidateBasic(); err != nil {
return nil, err
}

return cdc.MarshalJSON(&icaPacketData)
}
155 changes: 155 additions & 0 deletions modules/apps/27-interchain-accounts/host/client/cli/tx_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
package cli

import (
"fmt"
"testing"

"github.com/cosmos/cosmos-sdk/codec"
codectypes "github.com/cosmos/cosmos-sdk/codec/types"
sdk "github.com/cosmos/cosmos-sdk/types"
banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
"github.com/stretchr/testify/require"

icatypes "github.com/cosmos/ibc-go/v6/modules/apps/27-interchain-accounts/types"
)

const msgDelegateMessage = `{
"@type": "/cosmos.staking.v1beta1.MsgDelegate",
"delegator_address": "cosmos15ccshhmp0gsx29qpqq6g4zmltnnvgmyu9ueuadh9y2nc5zj0szls5gtddz",
"validator_address": "cosmosvaloper1qnk2n4nlkpw9xfqntladh74w6ujtulwnmxnh3k",
"amount": {
"denom": "stake",
"amount": "1000"
}
}`

const bankSendMessage = `{
"@type":"/cosmos.bank.v1beta1.MsgSend",
"from_address":"cosmos15ccshhmp0gsx29qpqq6g4zmltnnvgmyu9ueuadh9y2nc5zj0szls5gtddz",
"to_address":"cosmos10h9stc5v6ntgeygf5xf945njqq5h32r53uquvw",
"amount": [
{
"denom": "stake",
"amount": "1000"
}
]
}`

var multiMsg = fmt.Sprintf("[ %s, %s ]", msgDelegateMessage, bankSendMessage)

func TestGeneratePacketData(t *testing.T) {
tests := []struct {
name string
memo string
expectedPass bool
message string
registerInterfaceFn func(registry codectypes.InterfaceRegistry)
assertionFn func(t *testing.T, msgs []sdk.Msg)
}{
{
name: "multi message",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name: "multi message",
name: "packet data generation succeeds (MsgDelegate & MsgSend)",

memo: "",
expectedPass: true,
message: multiMsg,
registerInterfaceFn: func(registry codectypes.InterfaceRegistry) {
stakingtypes.RegisterInterfaces(registry)
banktypes.RegisterInterfaces(registry)
},
assertionFn: func(t *testing.T, msgs []sdk.Msg) {
assertMsgDelegate(t, msgs, 0)
Copy link
Contributor

@crodriguezvega crodriguezvega Sep 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a nit, but instead of passing the slice of messages and the index, couldn't you just pass msgs[0]?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes you're right, this can simplify things a little bit!

assertMsgBankSend(t, msgs, 1)
},
},
{
name: "packet data generation succeeds (MsgDelegate)",
memo: "non-empty-memo",
expectedPass: true,
message: msgDelegateMessage,
registerInterfaceFn: stakingtypes.RegisterInterfaces,
assertionFn: func(t *testing.T, msgs []sdk.Msg) {
assertMsgDelegate(t, msgs, 0)
},
},
{
name: "packet data generation succeeds (MsgSend)",
memo: "non-empty-memo",
expectedPass: true,
message: bankSendMessage,
registerInterfaceFn: banktypes.RegisterInterfaces,
assertionFn: func(t *testing.T, msgs []sdk.Msg) {
assertMsgBankSend(t, msgs, 0)
},
},
{
name: "empty memo is valid",
memo: "",
expectedPass: true,
message: msgDelegateMessage,
registerInterfaceFn: stakingtypes.RegisterInterfaces,
assertionFn: nil,
},
{
name: "invalid message string",
expectedPass: false,
message: "<invalid-message-body>",
},
}

for _, tc := range tests {
tc := tc
ir := codectypes.NewInterfaceRegistry()
if tc.registerInterfaceFn != nil {
tc.registerInterfaceFn(ir)
}

cdc := codec.NewProtoCodec(ir)

t.Run(tc.name, func(t *testing.T) {
bz, err := generatePacketData(cdc, []byte(tc.message), tc.memo)

if tc.expectedPass {
require.NoError(t, err)
require.NotNil(t, bz)

packetData := icatypes.InterchainAccountPacketData{}
err = cdc.UnmarshalJSON(bz, &packetData)
require.NoError(t, err)

require.Equal(t, icatypes.EXECUTE_TX, packetData.Type)
require.Equal(t, tc.memo, packetData.Memo)

data := packetData.Data
messages, err := icatypes.DeserializeCosmosTx(cdc, data)

require.NoError(t, err)
require.NotNil(t, messages)

if tc.assertionFn != nil {
tc.assertionFn(t, messages)
}
} else {
require.Error(t, err)
require.Nil(t, bz)
}
})
}
}

func assertMsgBankSend(t *testing.T, msgs []sdk.Msg, idx int) {
bankSendMsg, ok := msgs[idx].(*banktypes.MsgSend)
require.True(t, ok)
require.Equal(t, "cosmos15ccshhmp0gsx29qpqq6g4zmltnnvgmyu9ueuadh9y2nc5zj0szls5gtddz", bankSendMsg.FromAddress)
require.Equal(t, "cosmos10h9stc5v6ntgeygf5xf945njqq5h32r53uquvw", bankSendMsg.ToAddress)
require.Equal(t, "stake", bankSendMsg.Amount.GetDenomByIndex(0))
require.Equal(t, uint64(1000), bankSendMsg.Amount[0].Amount.Uint64())
}

func assertMsgDelegate(t *testing.T, msgs []sdk.Msg, idx int) {
msgDelegate, ok := msgs[idx].(*stakingtypes.MsgDelegate)
require.True(t, ok)
require.Equal(t, "cosmos15ccshhmp0gsx29qpqq6g4zmltnnvgmyu9ueuadh9y2nc5zj0szls5gtddz", msgDelegate.DelegatorAddress)
require.Equal(t, "cosmosvaloper1qnk2n4nlkpw9xfqntladh74w6ujtulwnmxnh3k", msgDelegate.ValidatorAddress)
require.Equal(t, "stake", msgDelegate.Amount.Denom)
require.Equal(t, uint64(1000), msgDelegate.Amount.Amount.Uint64())
}