package
8.5.1
Repository: https://github.com/cosmos/ibc-go.git
Documentation: pkg.go.dev

# Functions

DefaultGenesisState returns a GenesisState with "transfer" as the default PortID.
DefaultParams is the default parameter configuration for the ibc-transfer module.
GetDenomPrefix returns the receiving denomination prefix.
GetEscrowAddress returns the escrow address for the specified channel.
GetPrefixedDenom returns the denomination with the portID and channelID prefixed.
GetTransferCoin creates a transfer coin with the port ID and channel ID prefixed to the base denom.
NewFungibleTokenPacketData contructs a new FungibleTokenPacketData instance.
NewGenesisState creates a new ibc-transfer GenesisState instance.
No description provided by the author
NewMsgTransfer creates a new MsgTransfer instance.
NewMsgUpdateParams creates a new MsgUpdateParams instance.
NewParams creates a new parameter configuration for the ibc transfer module.
No description provided by the author
NewTransferAuthorization creates a new TransferAuthorization object.
ParamKeyTable type declaration for parameters.
ParseDenomTrace parses a string with the ibc prefix (denom trace) and the base denomination into a DenomTrace type.
ParseHexHash parses a hex hash in string format to bytes and validates its correctness.
ReceiverChainIsSource returns true if the denomination originally came from the receiving chain and false otherwise.
RegisterInterfaces register the ibc transfer module interfaces to protobuf Any.
RegisterLegacyAminoCodec registers the necessary x/ibc transfer interfaces and concrete types on the provided LegacyAmino codec.
No description provided by the author
RegisterQueryHandler registers the http handlers for service Query to "mux".
RegisterQueryHandlerClient registers the http handlers for service Query to "mux".
RegisterQueryHandlerFromEndpoint is same as RegisterQueryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterQueryHandlerServer registers the http handlers for service Query to "mux".
No description provided by the author
SenderChainIsSource returns false if the denomination originally came from the receiving chain and true otherwise.
TotalEscrowForDenomKey returns the store key of under which the total amout of source chain tokens in escrow is stored.
UnboundedSpendLimit returns the sentinel value that can be used as the amount for a denomination's spend limit for which spend limit updating should be disabled.
ValidateIBCDenom validates that the given denomination is either: - A valid base denomination (eg: 'uatom' or 'gamm/pool/1' as in https://github.com/cosmos/ibc-go/issues/894) - A valid fungible token representation (i.e 'ibc/{hash}') per ADR 001 https://github.com/cosmos/ibc-go/blob/main/docs/architecture/adr-001-coin-source-tracing.md.
ValidatePrefixedDenom checks that the denomination for an IBC fungible token packet denom is correctly prefixed.

# Constants

AllowAllPacketDataKeys holds the string key that allows all memo strings in authz transfer messages.
IBC transfer events.
IBC transfer events.
IBC transfer events.
IBC transfer events.
IBC transfer events.
IBC transfer events.
IBC transfer events.
IBC transfer events.
IBC transfer events.
IBC transfer events.
IBC transfer events.
DefaultReceiveEnabled enabled.
DefaultSendEnabled enabled.
DenomPrefix is the prefix used for internal SDK coin representation.
IBC transfer events.
IBC transfer events.
IBC transfer events.
IBC transfer events.
IBC transfer events.
No description provided by the author
maximum length of the memo in bytes (value chosen arbitrarily).
maximum length of the receiver address in bytes (value chosen arbitrarily).
ModuleName defines the IBC transfer name.
No description provided by the author
PortID is the default port id that transfer module binds to.
QuerierRoute is the querier route for IBC transfer.
RouterKey is the message route for IBC transfer.
StoreKey is the store key string for IBC transfer.
Version defines the current version the IBC tranfer module supports.

# Variables

DefaultRelativePacketTimeoutHeight is the default packet timeout height (in blocks) relative to the current block height of the counterparty chain provided by the client state.
DefaultRelativePacketTimeoutTimestamp is the default packet timeout timestamp (in nanoseconds) relative to the current block timestamp of the counterparty chain provided by the client state.
DenomTraceKey defines the key to store the denomination trace info in store.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IBC transfer sentinel errors.
IBC transfer sentinel errors.
IBC transfer sentinel errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IBC transfer sentinel errors.
IBC transfer sentinel errors.
IBC transfer sentinel errors.
IBC transfer sentinel errors.
IBC transfer sentinel errors.
IBC transfer sentinel errors.
IBC transfer sentinel errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
KeyReceiveEnabled is store's key for ReceiveEnabled Params.
KeySendEnabled is store's key for SendEnabled Params.
ModuleCdc references the global x/ibc-transfer module codec.
PortKey defines the key to store the port ID in store.

# Structs

Allocation defines the spend limit for a particular port and channel.
DenomTrace contains the base denomination for ICS20 fungible tokens and the source tracing information path.
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.
GenesisState defines the ibc-transfer genesis state.
MsgTransfer defines a msg to transfer fungible tokens (i.e Coins) between ICS20 enabled chains.
MsgTransferResponse defines the Msg/Transfer response type.
MsgUpdateParams is the Msg/UpdateParams request type.
MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message.
Params defines the set of IBC transfer parameters.
QueryDenomHashRequest is the request type for the Query/DenomHash RPC method.
QueryDenomHashResponse is the response type for the Query/DenomHash RPC method.
QueryDenomTraceRequest is the request type for the Query/DenomTrace RPC method.
QueryDenomTraceResponse is the response type for the Query/DenomTrace RPC method.
QueryConnectionsRequest is the request type for the Query/DenomTraces RPC method.
QueryConnectionsResponse is the response type for the Query/DenomTraces RPC method.
QueryEscrowAddressRequest is the request type for the EscrowAddress RPC method.
QueryEscrowAddressResponse is the response type of the EscrowAddress RPC method.
QueryParamsRequest is the request type for the Query/Params RPC method.
QueryParamsResponse is the response type for the Query/Params RPC method.
QueryTotalEscrowForDenomRequest is the request type for TotalEscrowForDenom RPC method.
QueryTotalEscrowForDenomResponse is the response type for TotalEscrowForDenom RPC method.
TransferAuthorization allows the grantee to spend up to spend_limit coins from the granter's account for ibc transfer on a specific channel.
UnimplementedMsgServer can be embedded to have forward compatible implementations.
UnimplementedQueryServer can be embedded to have forward compatible implementations.

# Interfaces

AccountKeeper defines the contract required for account APIs.
BankKeeper defines the expected bank keeper.
ChannelKeeper defines the expected IBC channel keeper.
ClientKeeper defines the expected IBC client keeper.
ConnectionKeeper defines the expected IBC connection keeper.
MsgClient is the client API for Msg service.
MsgServer is the server API for Msg service.
ParamSubspace defines the expected Subspace interface for module parameters.
PortKeeper defines the expected IBC port keeper.
QueryClient is the client API for Query service.
QueryServer is the server API for Query service.

# Type aliases

Traces defines a wrapper type for a slice of DenomTrace.