rly

Documentation

Overview

Package rly provides an interface to the cosmos relayer running in a Docker container.

Index

• Constants
• func Capabilities() map[relayer.Capability]bool
• type ArchRelayerChainConfig
• type ArchRelayerChainConfigValue
• type ICONRelayer
  • func NewICONRelayer(log *zap.Logger, testName string, cli *client.Client, networkID string, ...) *ICONRelayer
• type ICONRelayerChainConfig
  • func ChainConfigToICONRelayerChainConfig(chainConfig ibc.ChainConfig, keyName, rpcAddr, gprcAddr string) ICONRelayerChainConfig
• type ICONRelayerChainConfigValue
• type RlyWallet
  • func NewWallet(keyname string, address string, mnemonic string) *RlyWallet
  • func (w *RlyWallet) Address() []byte
  • func (w *RlyWallet) FormattedAddress() string
  • func (w *RlyWallet) KeyName() string
  • func (w *RlyWallet) Mnemonic() string
• type WalletModel

Constants

const (
	DefaultContainerImage   = "ghcr.io/cosmos/relayer"
	DefaultContainerVersion = "v2.3.1"
)

const (
	RlyDefaultUidGid = "100:1000"
)

Functions

func Capabilities

func Capabilities() map[relayer.Capability]bool

Capabilities returns the set of capabilities of the Cosmos relayer.

Note, this API may change if the rly package eventually needs to distinguish between multiple rly versions.

Types

type ArchRelayerChainConfig

type ArchRelayerChainConfig struct {
	Type  string                      `json:"type"`
	Value ArchRelayerChainConfigValue `json:"value"`
}

type ArchRelayerChainConfigValue

type ArchRelayerChainConfigValue struct {
	rly.CosmosRelayerChainConfigValue
	KeyDir            string `json:"key-directory"`
	MinGasAmount      int    `json:"min-gas-amount"`
	CoinType          int    `json:"coin-type"`
	StartHeight       int    `json:"start-height"`
	IBCHandlerAddress string `json:"ibc-handler-address"`
	BlockInterval     int    `json:"block-interval"`
}

type ICONRelayer

type ICONRelayer struct {
	// Embedded DockerRelayer so commands just work.
	*relayer.DockerRelayer
}

ICONRelayer is the ibc.Relayer implementation for github.com/cosmos/relayer.

func NewICONRelayer

func NewICONRelayer(log *zap.Logger, testName string, cli *client.Client, networkID string, options ...relayer.RelayerOption) *ICONRelayer

type ICONRelayerChainConfig

type ICONRelayerChainConfig struct {
	Type  string                      `json:"type"`
	Value ICONRelayerChainConfigValue `json:"value"`
}

func ChainConfigToICONRelayerChainConfig

func ChainConfigToICONRelayerChainConfig(chainConfig ibc.ChainConfig, keyName, rpcAddr, gprcAddr string) ICONRelayerChainConfig

type ICONRelayerChainConfigValue

type ICONRelayerChainConfigValue struct {
	KeyDirectory      string `json:"key-directory"`
	Key               string `json:"key"`
	ChainID           string `json:"chain-id"`
	RPCAddr           string `json:"rpc-addr"`
	Timeout           string `json:"timeout"`
	Keystore          string `json:"keystore"`
	Password          string `json:"password"`
	IconNetworkID     int    `json:"icon-network-id"`
	BtpNetworkID      int    `json:"btp-network-id"`
	StartHeight       int    `json:"start-height"`
	BTPNetworkTypeID  int    `json:"btp-network-type-id"`
	IBCHandlerAddress string `json:"ibc-handler-address"`
	BlockInterval     int    `json:"block-interval"`
}

type RlyWallet

type RlyWallet struct {
	// contains filtered or unexported fields
}

func NewWallet

func NewWallet(keyname string, address string, mnemonic string) *RlyWallet

func (*RlyWallet) Address

func (w *RlyWallet) Address() []byte

Get Address

func (*RlyWallet) FormattedAddress

func (w *RlyWallet) FormattedAddress() string

func (*RlyWallet) KeyName

func (w *RlyWallet) KeyName() string

func (*RlyWallet) Mnemonic

func (w *RlyWallet) Mnemonic() string

Get mnemonic, only used for relayer wallets

type WalletModel

type WalletModel struct {
	Mnemonic string `json:"mnemonic"`
	Address  string `json:"address"`
}