package ibc.applications.transfer.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the ibc/transfer Msg service.

• rpc Transfer (MsgTransfer, MsgTransferResponse)

  tx.proto:14

  Transfer defines a rpc handler method for MsgTransfer.

  message MsgTransfer

  tx.proto:20

  MsgTransfer defines a msg to transfer fungible tokens (i.e Coins) between ICS20 enabled chains. See ICS Spec here: https://github.com/cosmos/ibc/tree/master/spec/app/ics-020-fungible-token-transfer#data-structures

  • string source_port = 1

    the port on which the packet will be sent

  • string source_channel = 2

    the channel by which the packet will be sent

  • optional cosmos.base.v1beta1.Coin token = 3

    the tokens to be transferred

  • string sender = 4

    the sender address

  • string receiver = 5

    the recipient address on the destination chain

  • optional core.client.v1.Height timeout_height = 6

    Timeout height relative to the current block height. The timeout is disabled when set to 0.

  • uint64 timeout_timestamp = 7

    Timeout timestamp in absolute nanoseconds since unix epoch. The timeout is disabled when set to 0.

  • string memo = 8

    optional memo

  message MsgTransferResponse

  tx.proto:46

  MsgTransferResponse defines the Msg/Transfer response type.

  • uint64 sequence = 1

    sequence number of the transfer packet sent

Query provides defines the gRPC querier service.

• rpc DenomTraces (QueryDenomTracesRequest, QueryDenomTracesResponse)

  query.proto:16

  DenomTraces queries all denomination traces.

  message QueryDenomTracesRequest

  query.proto:62

  QueryConnectionsRequest is the request type for the Query/DenomTraces RPC method

  • optional cosmos.base.query.v1beta1.PageRequest pagination = 1

    pagination defines an optional pagination for the request.

  message QueryDenomTracesResponse

  query.proto:69

  QueryConnectionsResponse is the response type for the Query/DenomTraces RPC method.

  • repeated DenomTrace denom_traces = 1

    denom_traces returns all denominations trace information.

  • optional cosmos.base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response.

• rpc DenomTrace (QueryDenomTraceRequest, QueryDenomTraceResponse)

  query.proto:21

  DenomTrace queries a denomination trace information.

  message QueryDenomTraceRequest

  query.proto:48

  QueryDenomTraceRequest is the request type for the Query/DenomTrace RPC method

  • string hash = 1

    hash (in hex format) or denom (full denom with ibc prefix) of the denomination trace information.

  message QueryDenomTraceResponse

  query.proto:55

  QueryDenomTraceResponse is the response type for the Query/DenomTrace RPC method.

  • optional DenomTrace denom_trace = 1

    denom_trace returns the requested denomination trace information.

• rpc Params (QueryParamsRequest, QueryParamsResponse)

  query.proto:26

  Params queries all parameters of the ibc-transfer module.

  message QueryParamsRequest

  query.proto:77

  QueryParamsRequest is the request type for the Query/Params RPC method.

  (message has no fields)

  message QueryParamsResponse

  query.proto:80

  QueryParamsResponse is the response type for the Query/Params RPC method.

  • optional Params params = 1

    params defines the parameters of the module.

• rpc DenomHash (QueryDenomHashRequest, QueryDenomHashResponse)

  query.proto:31

  DenomHash queries a denomination hash information.

  message QueryDenomHashRequest

  query.proto:87

  QueryDenomHashRequest is the request type for the Query/DenomHash RPC method

  • string trace = 1

    The denomination trace ([port_id]/[channel_id])+/[denom]

  message QueryDenomHashResponse

  query.proto:94

  QueryDenomHashResponse is the response type for the Query/DenomHash RPC method.

  • string hash = 1

    hash (in hex format) of the denomination trace information.

• rpc EscrowAddress (QueryEscrowAddressRequest, QueryEscrowAddressResponse)

  query.proto:36

  EscrowAddress returns the escrow address for a particular port and channel id.

  message QueryEscrowAddressRequest

  query.proto:100

  QueryEscrowAddressRequest is the request type for the EscrowAddress RPC method.

  • string port_id = 1

    unique port identifier

  • string channel_id = 2

    unique channel identifier

  message QueryEscrowAddressResponse

  query.proto:108

  QueryEscrowAddressResponse is the response type of the EscrowAddress RPC method.

  • string escrow_address = 1

    the escrow account address

• rpc TotalEscrowForDenom (QueryTotalEscrowForDenomRequest, QueryTotalEscrowForDenomResponse)

  query.proto:41

  TotalEscrowForDenom returns the total amount of tokens in escrow based on the denom.

  message QueryTotalEscrowForDenomRequest

  query.proto:114

  QueryTotalEscrowForDenomRequest is the request type for TotalEscrowForDenom RPC method.

  • string denom = 1

  message QueryTotalEscrowForDenomResponse

  query.proto:119

  QueryTotalEscrowForDenomResponse is the response type for TotalEscrowForDenom RPC method.

  • optional cosmos.base.v1beta1.Coin amount = 1

Allocation defines the spend limit for a particular port and channel

Used in: TransferAuthorization

• string source_port = 1

  the port on which the packet will be sent

• string source_channel = 2

  the channel by which the packet will be sent

• repeated cosmos.base.v1beta1.Coin spend_limit = 3

  spend limitation on the channel

• repeated string allow_list = 4

  allow list of receivers, an empty allow list permits any receiver address

DenomTrace contains the base denomination for ICS20 fungible tokens and the source tracing information path.

Used in: GenesisState, QueryDenomTraceResponse, QueryDenomTracesResponse

• string path = 1

  path defines the chain of port/channel identifiers used for tracing the source of the fungible token.

• string base_denom = 2

  base denomination of the relayed fungible token.

GenesisState defines the ibc-transfer genesis state

• string port_id = 1

• repeated DenomTrace denom_traces = 2

• optional Params params = 3

• repeated cosmos.base.v1beta1.Coin total_escrowed = 4

  total_escrowed contains the total amount of tokens escrowed by the transfer module

Params defines the set of IBC transfer parameters. NOTE: To prevent a single token from being transferred, set the TransfersEnabled parameter to true and then set the bank module's SendEnabled parameter for the denomination to false.

Used in: GenesisState, QueryParamsResponse

• bool send_enabled = 1

  send_enabled enables or disables all cross-chain token transfers from this chain.

• bool receive_enabled = 2

  receive_enabled enables or disables all cross-chain token transfers to this chain.

TransferAuthorization allows the grantee to spend up to spend_limit coins from the granter's account for ibc transfer on a specific channel

• repeated Allocation allocations = 1

  port and channel amounts