This document is relevant only for fungible token transfers over channels on v1 of the ICS-20 protocol.
Client
CLI
A user can query and interact with the transfer
module using the CLI. Use the --help
flag to discover the available commands:
Query
The query
commands allow users to query transfer
state.
simd query ibc-transfer --help
Transactions
The tx
commands allow users to interact with the controller submodule.
simd tx ibc-transfer --help
transfer
The transfer
command allows users to execute cross-chain token transfers from the source port ID and channel ID on the sending chain.
simd tx ibc-transfer transfer [src-port] [src-channel] [receiver] [coins] [flags]
The coins
parameter accepts the amount and denomination (e.g. 100uatom
) of the tokens to be transferred.
The additional flags that can be used with the command are:
--packet-timeout-height
to specify the timeout block height in the format{revision}-{height}
. The default value is0-0
, which effectively disables the timeout. Timeout height can only be absolute, therefore this option must be used in combination with--absolute-timeouts
set to true.--packet-timeout-timestamp
to specify the timeout timestamp in nanoseconds. The timeout can be either relative (fromthe current UTC time) or absolute. The default value is 10 minutes (and thus relative). The timeout is disabled when set to 0.--absolute-timeouts
to interpret the timeout timestamp as an aboslute value (when set to true). The default value is false (and thus the timeout timeout is considered relative to current UTC time).--memo
to specify the memo string to be sent along with the transfer packet. If forwarding is used, then the memo string will be carried through the intermediary chains to the final destination.
total-escrow
The total-escrow
command allows users to query the total amount in escrow for a particular coin denomination regardless of the transfer channel from where the coins were sent out.
simd query ibc-transfer total-escrow [denom] [flags]
Example:
simd query ibc-transfer total-escrow samoleans
Example Output:
amount: "100"
gRPC
A user can query the transfer
module using gRPC endpoints.
TotalEscrowForDenom
The TotalEscrowForDenom
endpoint allows users to query the total amount in escrow for a particular coin denomination regardless of the transfer channel from where the coins were sent out.
ibc.applications.transfer.v1.Query/TotalEscrowForDenom
Example:
grpcurl -plaintext \
-d '{"denom":"samoleans"}' \
localhost:9090 \
ibc.applications.transfer.v1.Query/TotalEscrowForDenom
Example output:
{
"amount": "100"
}