Skip to main content
Version: Next

Client

CLI​

A user can query and interact with the Interchain Accounts module using the CLI. Use the --help flag to discover the available commands:

simd query interchain-accounts --help

Please not that this section does not document all the available commands, but only the ones that deserved extra documentation that was not possible to fit in the command line documentation.

Controller​

A user can query and interact with the controller submodule.

Query​

The query commands allow users to query the controller submodule.

simd query interchain-accounts controller --help

Transactions​

The tx commands allow users to interact with the controller submodule.

simd tx interchain-accounts controller --help

register​

The register command allows users to register an interchain account on a host chain on the provided connection.

simd tx interchain-accounts controller register [connection-id] [flags]

During registration a new channel is set up between controller and host. There are two flags available that influence the channel that is created:

  • --version to specify the (JSON-formatted) version string of the channel. For example: {\"version\":\"ics27-1\",\"encoding\":\"proto3\",\"tx_type\":\"sdk_multi_msg\",\"controller_connection_id\":\"connection-0\",\"host_connection_id\":\"connection-0\"}. Passing a custom version string is useful if you want to specify, for example, the encoding format of the interchain accounts packet data (either proto3 or proto3json). If not specified the controller submodule will generate a default version string.
  • --ordering to specify the ordering of the channel. Available options are order_ordered (default if not specified) and order_unordered.

Example:

simd tx interchain-accounts controller register connection-0 --ordering order_unordered --from cosmos1..

send-tx​

The send-tx command allows users to send a transaction on the provided connection to be executed using an interchain account on the host chain.

simd tx interchain-accounts controller send-tx [connection-id] [path/to/packet_msg.json]

Example:

simd tx interchain-accounts controller send-tx connection-0 packet-data.json --from cosmos1..

See below for example contents of packet-data.json. The CLI handler will unmarshal the following into InterchainAccountPacketData appropriately.

{
  "type":"TYPE_EXECUTE_TX",
  "data":"CqIBChwvY29zbW9zLmJhbmsudjFiZXRhMS5Nc2dTZW5kEoEBCkFjb3Ntb3MxNWNjc2hobXAwZ3N4MjlxcHFxNmc0em1sdG5udmdteXU5dWV1YWRoOXkybmM1emowc3psczVndGRkehItY29zbW9zMTBoOXN0YzV2Nm50Z2V5Z2Y1eGY5NDVuanFxNWgzMnI1M3VxdXZ3Gg0KBXN0YWtlEgQxMDAw",
  "memo":""
}

Note the data field is a base64 encoded byte string as per the tx encoding agreed upon during the channel handshake.

A helper CLI is provided in the host submodule which can be used to generate the packet data JSON using the counterparty chain's binary. See the generate-packet-data command for an example.

Host​

A user can query and interact with the host submodule.

Query​

The query commands allow users to query the host submodule.

simd query interchain-accounts host --help

Transactions​

The tx commands allow users to interact with the controller submodule.

simd tx interchain-accounts host --help
generate-packet-data​

The generate-packet-data command allows users to generate protobuf or proto3 JSON encoded interchain accounts packet data for input message(s). The packet data can then be used with the controller submodule's send-tx command. The --encoding flag can be used to specify the encoding format (value must be either proto3 or proto3json); if not specified, the default will be proto3. The --memo flag can be used to include a memo string in the interchain accounts packet data.

simd tx interchain-accounts host generate-packet-data [message]

Example:

simd tx interchain-accounts host generate-packet-data '[{
  "@type":"/cosmos.bank.v1beta1.MsgSend",
  "from_address":"cosmos15ccshhmp0gsx29qpqq6g4zmltnnvgmyu9ueuadh9y2nc5zj0szls5gtddz",
  "to_address":"cosmos10h9stc5v6ntgeygf5xf945njqq5h32r53uquvw",
  "amount": [
    {
      "denom": "stake",
      "amount": "1000"
    }
  ]
}]' --memo memo

The command accepts a single sdk.Msg or a list of sdk.Msgs that will be encoded into the outputs data field.

Example output:

{
  "type":"TYPE_EXECUTE_TX",
  "data":"CqIBChwvY29zbW9zLmJhbmsudjFiZXRhMS5Nc2dTZW5kEoEBCkFjb3Ntb3MxNWNjc2hobXAwZ3N4MjlxcHFxNmc0em1sdG5udmdteXU5dWV1YWRoOXkybmM1emowc3psczVndGRkehItY29zbW9zMTBoOXN0YzV2Nm50Z2V5Z2Y1eGY5NDVuanFxNWgzMnI1M3VxdXZ3Gg0KBXN0YWtlEgQxMDAw",
  "memo":"memo"
}

gRPC​

A user can query the interchain account module using gRPC endpoints.

Controller​

A user can query the controller submodule using gRPC endpoints.

InterchainAccount​

The InterchainAccount endpoint allows users to query the controller submodule for the interchain account address for a given owner on a particular connection.

ibc.applications.interchain_accounts.controller.v1.Query/InterchainAccount

Example:

grpcurl -plaintext \
  -d '{"owner":"cosmos1..","connection_id":"connection-0"}' \
  localhost:9090 \
  ibc.applications.interchain_accounts.controller.v1.Query/InterchainAccount

Params​

The Params endpoint users to query the current controller submodule parameters.

ibc.applications.interchain_accounts.controller.v1.Query/Params

Example:

grpcurl -plaintext \
  localhost:9090 \
  ibc.applications.interchain_accounts.controller.v1.Query/Params

Host​

A user can query the host submodule using gRPC endpoints.

Params​

The Params endpoint users to query the current host submodule parameters.

ibc.applications.interchain_accounts.host.v1.Query/Params

Example:

grpcurl -plaintext \
  localhost:9090 \
  ibc.applications.interchain_accounts.host.v1.Query/Params