ibc/applications

Table of Contents

• ibc/applications/transfer/v2/packet.proto
  • MFungibleTokenPacketData
• ibc/applications/transfer/v1/query.proto
  • MQueryDenomHashRequest
  • MQueryDenomHashResponse
  • MQueryDenomTraceRequest
  • MQueryDenomTraceResponse
  • MQueryDenomTracesRequest
  • MQueryDenomTracesResponse
  • MQueryParamsRequest
  • MQueryParamsResponse
  • SQuery
• ibc/applications/transfer/v1/genesis.proto
  • MGenesisState
• ibc/applications/transfer/v1/transfer.proto
  • MDenomTrace
  • MParams
• ibc/applications/transfer/v1/tx.proto
  • MMsgTransfer
  • MMsgTransferResponse
  • SMsg
• ibc/applications/interchain_accounts/controller/v1/query.proto
  • MQueryParamsRequest
  • MQueryParamsResponse
  • SQuery
• ibc/applications/interchain_accounts/controller/v1/controller.proto
  • MParams
• ibc/applications/interchain_accounts/v1/metadata.proto
  • MMetadata
• ibc/applications/interchain_accounts/v1/genesis.proto
  • MActiveChannel
  • MControllerGenesisState
  • MGenesisState
  • MHostGenesisState
  • MRegisteredInterchainAccount
• ibc/applications/interchain_accounts/v1/packet.proto
  • MCosmosTx
  • MInterchainAccountPacketData
  • EType
• ibc/applications/interchain_accounts/v1/account.proto
  • MInterchainAccount
• ibc/applications/interchain_accounts/host/v1/host.proto
  • MParams
• ibc/applications/interchain_accounts/host/v1/query.proto
  • MQueryParamsRequest
  • MQueryParamsResponse
  • SQuery
• Scalar Value Types

ibc/applications/transfer/v2/packet.proto

Top

FungibleTokenPacketData

FungibleTokenPacketData defines a struct for the packet payload

See FungibleTokenPacketData spec:

https://github.com/cosmos/ibc/tree/master/spec/app/ics-020-fungible-token-transfer#data-structures

Field	Type	Label	Description
denom	string		the token denomination to be transferred
amount	string		the token amount to be transferred
sender	string		the sender address
receiver	string		the recipient address on the destination chain

ibc/applications/transfer/v1/query.proto

Top

QueryDenomHashRequest

QueryDenomHashRequest is the request type for the Query/DenomHash RPC

method

Field	Type	Label	Description
trace	string		The denomination trace ([port_id]/[channel_id])+/[denom]

QueryDenomHashResponse

QueryDenomHashResponse is the response type for the Query/DenomHash RPC

method.

Field	Type	Label	Description
hash	string		hash (in hex format) of the denomination trace information.

QueryDenomTraceRequest

QueryDenomTraceRequest is the request type for the Query/DenomTrace RPC

method

Field	Type	Label	Description
hash	string		hash (in hex format) of the denomination trace information.

QueryDenomTraceResponse

QueryDenomTraceResponse is the response type for the Query/DenomTrace RPC

method.

Field	Type	Label	Description
denom_trace	DenomTrace		denom_trace returns the requested denomination trace information.

QueryDenomTracesRequest

QueryConnectionsRequest is the request type for the Query/DenomTraces RPC

method

Field	Type	Label	Description
pagination	cosmos.base.query.v1beta1.PageRequest		pagination defines an optional pagination for the request.

QueryDenomTracesResponse

QueryConnectionsResponse is the response type for the Query/DenomTraces RPC

method.

Field	Type	Label	Description
denom_traces	DenomTrace	repeated	denom_traces returns all denominations trace information.
pagination	cosmos.base.query.v1beta1.PageResponse		pagination defines the pagination in the response.

QueryParamsRequest

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

QueryParamsResponse

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

Field	Type	Label	Description
params	Params		params defines the parameters of the module.

Query

Query provides defines the gRPC querier service.

Method Name	Request Type	Response Type	Description
DenomTrace	QueryDenomTraceRequest	QueryDenomTraceResponse	DenomTrace queries a denomination trace information.
DenomTraces	QueryDenomTracesRequest	QueryDenomTracesResponse	DenomTraces queries all denomination traces.
Params	QueryParamsRequest	QueryParamsResponse	Params queries all parameters of the ibc-transfer module.
DenomHash	QueryDenomHashRequest	QueryDenomHashResponse	DenomHash queries a denomination hash information.

Methods with HTTP bindings

Method Name	Method	Pattern	Body
DenomTrace	GET	/ibc/apps/transfer/v1/denom_traces/{hash}
DenomTraces	GET	/ibc/apps/transfer/v1/denom_traces
Params	GET	/ibc/apps/transfer/v1/params
DenomHash	GET	/ibc/apps/transfer/v1/denom_hashes/{trace}

ibc/applications/transfer/v1/genesis.proto

Top

GenesisState

GenesisState defines the ibc-transfer genesis state

Field	Type	Label	Description
port_id	string
denom_traces	DenomTrace	repeated
params	Params

ibc/applications/transfer/v1/transfer.proto

Top

DenomTrace

DenomTrace contains the base denomination for ICS20 fungible tokens and the

source tracing information path.

Field	Type	Label	Description
path	string		path defines the chain of port/channel identifiers used for tracing the source of the fungible token.
base_denom	string		base denomination of the relayed fungible token.

Params

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.

Field	Type	Label	Description
send_enabled	bool		send_enabled enables or disables all cross-chain token transfers from this chain.
receive_enabled	bool		receive_enabled enables or disables all cross-chain token transfers to this chain.

ibc/applications/transfer/v1/tx.proto

Top

MsgTransfer

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

Field	Type	Label	Description
source_port	string		the port on which the packet will be sent
source_channel	string		the channel by which the packet will be sent
token	cosmos.base.v1beta1.Coin		the tokens to be transferred
sender	string		the sender address
receiver	string		the recipient address on the destination chain
timeout_height	ibc.core.client.v1.Height		Timeout height relative to the current block height. The timeout is disabled when set to 0.
timeout_timestamp	uint64		Timeout timestamp in absolute nanoseconds since unix epoch. The timeout is disabled when set to 0.

MsgTransferResponse

MsgTransferResponse defines the Msg/Transfer response type.

Msg

Msg defines the ibc/transfer Msg service.

Method Name	Request Type	Response Type	Description
Transfer	MsgTransfer	MsgTransferResponse	Transfer defines a rpc handler method for MsgTransfer.

ibc/applications/interchain_accounts/controller/v1/query.proto

Top

QueryParamsRequest

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

QueryParamsResponse

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

Field	Type	Label	Description
params	Params		params defines the parameters of the module.

Query

Query provides defines the gRPC querier service.

Method Name	Request Type	Response Type	Description
Params	QueryParamsRequest	QueryParamsResponse	Params queries all parameters of the ICA controller submodule.

Methods with HTTP bindings

Method Name	Method	Pattern	Body
Params	GET	/ibc/apps/interchain_accounts/controller/v1/params

ibc/applications/interchain_accounts/controller/v1/controller.proto

Top

Params

Params defines the set of on-chain interchain accounts parameters.

The following parameters may be used to disable the controller submodule.

Field	Type	Label	Description
controller_enabled	bool		controller_enabled enables or disables the controller submodule.

ibc/applications/interchain_accounts/v1/metadata.proto

Top

Metadata

Metadata defines a set of protocol specific data encoded into the ICS27

channel version bytestring See ICS004:

https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#Versioning

Field	Type	Label	Description
version	string		version defines the ICS27 protocol version
controller_connection_id	string		controller_connection_id is the connection identifier associated with the controller chain
host_connection_id	string		host_connection_id is the connection identifier associated with the host chain
address	string		address defines the interchain account address to be fulfilled upon the OnChanOpenTry handshake step NOTE: the address field is empty on the OnChanOpenInit handshake step
encoding	string		encoding defines the supported codec format
tx_type	string		tx_type defines the type of transactions the interchain account can execute

ibc/applications/interchain_accounts/v1/genesis.proto

Top

ActiveChannel

ActiveChannel contains a connection ID, port ID and associated active channel

ID

Field	Type	Label	Description
connection_id	string
port_id	string
channel_id	string

ControllerGenesisState

ControllerGenesisState defines the interchain accounts controller genesis

state

Field	Type	Label	Description
active_channels	ActiveChannel	repeated
interchain_accounts	RegisteredInterchainAccount	repeated
ports	string	repeated
params	ibc.applications.interchain_accounts.controller.v1.Params

GenesisState

GenesisState defines the interchain accounts genesis state

Field	Type	Label	Description
controller_genesis_state	ControllerGenesisState
host_genesis_state	HostGenesisState

HostGenesisState

HostGenesisState defines the interchain accounts host genesis state

Field	Type	Label	Description
active_channels	ActiveChannel	repeated
interchain_accounts	RegisteredInterchainAccount	repeated
port	string
params	ibc.applications.interchain_accounts.host.v1.Params

RegisteredInterchainAccount

RegisteredInterchainAccount contains a connection ID, port ID and associated

interchain account address

Field	Type	Label	Description
connection_id	string
port_id	string
account_address	string

ibc/applications/interchain_accounts/v1/packet.proto

Top

CosmosTx

CosmosTx contains a list of sdk.Msg's. It should be used when sending

transactions to an SDK host chain.

Field	Type	Label	Description
messages	google.protobuf.Any	repeated

InterchainAccountPacketData

InterchainAccountPacketData is comprised of a raw transaction, type of

transaction and optional memo field.

Field	Type	Label	Description
type	Type
data	bytes
memo	string

Type

Type defines a classification of message issued from a controller chain to

its associated interchain accounts host

Name	Number	Description
TYPE_UNSPECIFIED	0	Default zero value enumeration
TYPE_EXECUTE_TX	1	Execute a transaction on an interchain accounts host chain

ibc/applications/interchain_accounts/v1/account.proto

Top

InterchainAccount

An InterchainAccount is defined as a BaseAccount & the address of the account

owner on the controller chain

Field	Type	Label	Description
base_account	cosmos.auth.v1beta1.BaseAccount
account_owner	string

ibc/applications/interchain_accounts/host/v1/host.proto

Top

Params

Params defines the set of on-chain interchain accounts parameters.

The following parameters may be used to disable the host submodule.

Field	Type	Label	Description
host_enabled	bool		host_enabled enables or disables the host submodule.
allow_messages	string	repeated	allow_messages defines a list of sdk message typeURLs allowed to be executed on a host chain.

ibc/applications/interchain_accounts/host/v1/query.proto

Top

QueryParamsRequest

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

QueryParamsResponse

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

Field	Type	Label	Description
params	Params		params defines the parameters of the module.

Query

Query provides defines the gRPC querier service.

Method Name	Request Type	Response Type	Description
Params	QueryParamsRequest	QueryParamsResponse	Params queries all parameters of the ICA host submodule.

Methods with HTTP bindings

Method Name	Method	Pattern	Body
Params	GET	/ibc/apps/interchain_accounts/host/v1/params

Scalar Value Types

.proto Type	Notes	Python Type
double		float
float		float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int/long
uint32	Uses variable-length encoding.	int/long
uint64	Uses variable-length encoding.	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	int/long
sfixed32	Always four bytes.	int
sfixed64	Always eight bytes.	int/long
bool		boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	str/unicode
bytes	May contain any arbitrary sequence of bytes.	str