Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

ibc

package

Go to main page

Versions in this module

v10

v10.0.0

Jun 16, 2025

Changes in this version

+ const Cosmos

+ const Ethereum

+ const Namada

+ const Parachain

+ const Penumbra

+ const Polkadot

+ const RelayChain

+ const Thorchain

+ const UTXO

+ type Chain interface

+ Acknowledgements func(ctx context.Context, height int64) ([]PacketAcknowledgement, error)

+ BuildRelayerWallet func(ctx context.Context, keyName string) (Wallet, error)

+ BuildWallet func(ctx context.Context, keyName string, mnemonic string) (Wallet, error)

+ Config func() ChainConfig

+ CreateKey func(ctx context.Context, keyName string) error

+ Exec func(ctx context.Context, cmd []string, env []string) (stdout, stderr []byte, err error)

+ ExportState func(ctx context.Context, height int64) (string, error)

+ GetAddress func(ctx context.Context, keyName string) ([]byte, error)

+ GetBalance func(ctx context.Context, address string, denom string) (math.Int, error)

+ GetGRPCAddress func() string

+ GetGasFeesInNativeDenom func(gasPaid int64) int64

+ GetHostGRPCAddress func() string

+ GetHostPeerAddress func() string

+ GetHostRPCAddress func() string

+ GetRPCAddress func() string

+ Height func(ctx context.Context) (int64, error)

+ HomeDir func() string

+ Initialize func(ctx context.Context, testName string, cli *client.Client, networkID string) error

+ RecoverKey func(ctx context.Context, name, mnemonic string) error

+ SendFunds func(ctx context.Context, keyName string, amount WalletAmount) error

+ SendFundsWithNote func(ctx context.Context, keyName string, amount WalletAmount, note string) (string, error)

+ SendIBCTransfer func(ctx context.Context, channelID, keyName string, amount WalletAmount, ...) (Tx, error)

+ Start func(testName string, ctx context.Context, additionalGenesisWallets ...WalletAmount) error

+ Timeouts func(ctx context.Context, height int64) ([]PacketTimeout, error)

+ type ChainConfig struct

+ AdditionalStartArgs []string

+ Bech32Prefix string

+ Bin string

+ ChainID string

+ CoinDecimals *int64

+ CoinType string

+ CometMock CometMockConfig

+ ConfigFileOverrides map[string]any

+ Denom string

+ EncodingConfig *testutil.TestEncodingConfig

+ Env []string

+ ExposeAdditionalPorts []string

+ Gas string

+ GasAdjustment float64

+ GasPrices string

+ Genesis *GenesisConfig

+ HostPortOverride map[int]int

+ Images []DockerImage

+ InterchainSecurityConfig ICSConfig

+ ModifyGenesis func(ChainConfig, []byte) ([]byte, error)

+ ModifyGenesisAmounts func(int) (sdk.Coin, sdk.Coin)

+ Name string

+ NoHostMount bool

+ PreGenesis func(Chain) error

+ SidecarConfigs []SidecarConfig

+ SigningAlgorithm string

+ SkipGenTx bool

+ TrustingPeriod string

+ Type string

+ UsingChainIDFlagCLI bool

+ func (c *ChainConfig) WithCodeCoverage(override ...string)

+ func (c ChainConfig) Clone() ChainConfig

+ func (c ChainConfig) IsFullyConfigured() bool

+ func (c ChainConfig) MergeChainSpecConfig(other ChainConfig) ChainConfig

+ func (c ChainConfig) UsesCometMock() bool

+ func (c ChainConfig) VerifyCoinType() (string, error)

+ type ChannelCounterparty struct

+ ChannelID string

+ PortID string

+ type ChannelFilter struct

+ ChannelList []string

+ Rule string

+ type ChannelOutput struct

+ ChannelID string

+ ConnectionHops []string

+ Counterparty ChannelCounterparty

+ Ordering string

+ PortID string

+ State string

+ Version string

+ func GetTransferChannel(ctx context.Context, r Relayer, rep RelayerExecReporter, ...) (*ChannelOutput, error)

+ type ClientOutput struct

+ ClientID string

+ ClientState ClientState

+ type ClientOutputs []*ClientOutput

+ type ClientState struct

+ ChainID string

+ type CometMockConfig struct

+ BlockTimeMs int

+ Image DockerImage

+ type ConnectionOutput struct

+ ClientID string

+ Counterparty *ibcexported.Counterparty

+ DelayPeriod string

+ ID string

+ State string

+ Versions []*ibcexported.Version

+ type ConnectionOutputs []*ConnectionOutput

+ type CreateChannelOptions struct

+ DestPortName string

+ Order Order

+ Override bool

+ SourcePortName string

+ Version string

+ func DefaultChannelOpts() CreateChannelOptions

+ func (opts CreateChannelOptions) Validate() error

+ type CreateClientOptions struct

+ MaxClockDrift string

+ Override bool

+ TrustingPeriod string

+ TrustingPeriodPercentage int64

+ func DefaultClientOpts() CreateClientOptions

+ func (opts CreateClientOptions) Validate() error

+ type DockerImage struct

+ Repository string

+ UIDGID string

+ Version string

+ func NewDockerImage(repository, version, uidGID string) DockerImage

+ func (i DockerImage) IsFullyConfigured() bool

+ func (i DockerImage) PullImage(ctx context.Context, client *client.Client) error

+ func (i DockerImage) Ref() string

+ func (i DockerImage) Validate() error

+ type GenesisConfig struct

+ AllValidators bool

+ Contents []byte

+ MaxVals int

+ type IBCTimeout struct

+ Height int64

+ NanoSeconds uint64

+ type ICSConfig struct

+ ConsumerCopyProviderKey func(int) bool

+ ConsumerVerOverride string

+ ICSImageRepo string

+ ProviderVerOverride string

+ type Nanoseconds uint64

+ type NopRelayerExecReporter struct

+ func (NopRelayerExecReporter) TrackRelayerExec(string, []string, string, string, int, time.Time, time.Time, error)

+ type Order int

+ const Invalid

+ const Ordered

+ const Unordered

+ func (o Order) String() string

+ func (o Order) Validate() error

+ type Packet struct

+ Data []byte

+ DestChannel string

+ DestPort string

+ Sequence uint64

+ SourceChannel string

+ SourcePort string

+ TimeoutHeight string

+ TimeoutTimestamp Nanoseconds

+ func (packet Packet) Equal(other Packet) bool

+ func (packet Packet) Validate() error

+ type PacketAcknowledgement struct

+ Acknowledgement []byte

+ Packet Packet

+ func (ack PacketAcknowledgement) Validate() error

+ type PacketTimeout struct

+ Packet Packet

+ func (timeout PacketTimeout) Validate() error

+ type PathUpdateOptions struct

+ ChannelFilter *ChannelFilter

+ DstChainID *string

+ DstClientID *string

+ DstConnID *string

+ SrcChainID *string

+ SrcClientID *string

+ SrcConnID *string

+ type Relayer interface

+ AddChainConfiguration func(ctx context.Context, rep RelayerExecReporter, chainConfig ChainConfig, ...) error

+ AddKey func(ctx context.Context, rep RelayerExecReporter, ...) (Wallet, error)

+ CreateChannel func(ctx context.Context, rep RelayerExecReporter, pathName string, ...) error

+ CreateClient func(ctx context.Context, rep RelayerExecReporter, srcChainID string, ...) error

+ CreateClients func(ctx context.Context, rep RelayerExecReporter, pathName string, ...) error

+ CreateConnections func(ctx context.Context, rep RelayerExecReporter, pathName string) error

+ Exec func(ctx context.Context, rep RelayerExecReporter, cmd []string, env []string) RelayerExecResult

+ Flush func(ctx context.Context, rep RelayerExecReporter, pathName string, ...) error

+ GeneratePath func(ctx context.Context, rep RelayerExecReporter, ...) error

+ GetChannels func(ctx context.Context, rep RelayerExecReporter, chainID string) ([]ChannelOutput, error)

+ GetClients func(ctx context.Context, rep RelayerExecReporter, chainID string) (ClientOutputs, error)

+ GetConnections func(ctx context.Context, rep RelayerExecReporter, chainID string) (ConnectionOutputs, error)

+ GetWallet func(chainID string) (Wallet, bool)

+ LinkPath func(ctx context.Context, rep RelayerExecReporter, pathName string, ...) error

+ PauseRelayer func(ctx context.Context) error

+ RestoreKey func(ctx context.Context, rep RelayerExecReporter, cfg ChainConfig, ...) error

+ ResumeRelayer func(ctx context.Context) error

+ SetClientContractHash func(ctx context.Context, rep RelayerExecReporter, cfg ChainConfig, hash string) error

+ StartRelayer func(ctx context.Context, rep RelayerExecReporter, pathNames ...string) error

+ StopRelayer func(ctx context.Context, rep RelayerExecReporter) error

+ UpdateClients func(ctx context.Context, rep RelayerExecReporter, pathName string) error

+ UpdatePath func(ctx context.Context, rep RelayerExecReporter, pathName string, ...) error

+ UseDockerNetwork func() bool

+ type RelayerExecReporter interface

+ TrackRelayerExec func(containerName string, command []string, stdout, stderr string, exitCode int, ...)

+ type RelayerExecResult struct

+ Err error

+ ExitCode int

+ Stderr []byte

+ Stdout []byte

+ type RelayerImplementation int64

+ const CosmosRly

+ const Hermes

+ const Hyperspace

+ type SidecarConfig struct

+ Env []string

+ HomeDir string

+ Image DockerImage

+ Ports []string

+ PreStart bool

+ ProcessName string

+ StartCmd []string

+ ValidatorProcess bool

+ type TransferOptions struct

+ AbsoluteTimeouts bool

+ Memo string

+ Port string

+ Timeout *IBCTimeout

+ type Tx struct

+ GasSpent int64

+ Height int64

+ Packet Packet

+ TxHash string

+ func (tx Tx) Validate() error

+ type Wallet interface

+ Address func() []byte

+ FormattedAddress func() string

+ KeyName func() string

+ Mnemonic func() string

+ type WalletAmount struct

+ Address string

+ Amount math.Int

+ Denom string

v10.0.0-rc.1

Jun 16, 2025

v10.0.0-alpha.2

Jun 10, 2025

v10.0.0-alpha.1

Jun 6, 2025