centralized

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 CosmosRelayerChainConfig
• type CosmosRelayerChainConfigValue
• type Dapp
• type EVMRelayerChainConfig
• type EVMRelayerChainConfigValue
• type ICONRelayer
  • func NewCentralizedRelayer(log *zap.Logger, testName string, cli *client.Client, networkID string, ...) *ICONRelayer
• type 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 SUIRelayerChainConfig
• type SUIRelayerChainConfigValue
• type SolanaRelayerChainConfig
• type SolanaRelayerChainConfigValue
• type StellarRelayerChainConfig
• type StellarRelayerChainConfigValue
• type SuiDapp
• type SuiDappModule
• type WalletModel

Constants

const (
	DefaultContainerImage   = "centralized-relay"
	DefaultContainerVersion = "latest"
)

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 CosmosRelayerChainConfig

type CosmosRelayerChainConfig struct {
	Type  string                        `json:"type"`
	Value CosmosRelayerChainConfigValue `json:"value"`
}

type CosmosRelayerChainConfigValue

type CosmosRelayerChainConfigValue struct {
	NID                    string            `yaml:"nid"`
	RPCURL                 string            `yaml:"rpc-url"`
	GrpcUrl                string            `yaml:"grpc-url"`
	StartHeight            int               `yaml:"start-height"`
	GasPrice               string            `yaml:"gas-price"`
	GasLimit               int               `yaml:"gas-limit"`
	Contracts              map[string]string `yaml:"contracts"`
	BlockInterval          string            `yaml:"block-interval"`
	Address                string            `yaml:"address"`
	KeyringBackend         string            `yaml:"keyring-backend"`
	TxConfirmationInterval string            `yaml:"tx-confirmation-interval"`
	ChainName              string            `yaml:"chain-name"`
	MinGasAmount           uint64            `yaml:"min-gas-amount"`
	AccountPrefix          string            `yaml:"account-prefix"`
	Denomination           string            `yaml:"denomination"`
	ChainID                string            `yaml:"chain-id"`
	BroadcastMode          string            `yaml:"broadcast-mode"` // sync, async and block. Recommended: sync
	SignModeStr            string            `yaml:"sign-mode"`
	MaxGasAmount           uint64            `yaml:"max-gas-amount"`
	Simulate               bool              `yaml:"simulate"`
	GasAdjustment          float64           `yaml:"gas-adjustment"`
	FinalityBlock          uint64            `yaml:"finality-block"`
}

type Dapp

type Dapp struct {
	Name      string `yaml:"name"`
	ProgramID string `yaml:"program-id"`
}

type EVMRelayerChainConfig

type EVMRelayerChainConfig struct {
	Type  string                     `json:"type"`
	Value EVMRelayerChainConfigValue `json:"value"`
}

type EVMRelayerChainConfigValue

type EVMRelayerChainConfigValue struct {
	NID           string            `yaml:"nid"`
	RPCURL        string            `yaml:"rpc-url"`
	WebsocketUrl  string            `yaml:"websocket-url"`
	StartHeight   int               `yaml:"start-height"`
	GasPrice      int64             `yaml:"gas-price"`
	GasLimit      int               `yaml:"gas-limit"`
	Contracts     map[string]string `yaml:"contracts"`
	BlockInterval string            `yaml:"block-interval"`
	Address       string            `yaml:"address"`
	FinalityBlock uint64            `yaml:"finality-block"`
}

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 NewCentralizedRelayer

func NewCentralizedRelayer(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"`
}

type ICONRelayerChainConfigValue

type ICONRelayerChainConfigValue struct {
	NID           string            `yaml:"nid"`
	RPCURL        string            `yaml:"rpc-url"`
	StartHeight   int               `yaml:"start-height"`
	NetworkID     int               `yaml:"network-id"`
	Contracts     map[string]string `yaml:"contracts"`
	BlockInterval string            `yaml:"block-interval"`
	Address       string            `yaml:"address"`
	FinalityBlock uint64            `yaml:"finality-block"`
	StepMin       int64             `yaml:"step-min"`
	StepLimit     int64             `yaml:"step-limit"`
}

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 SUIRelayerChainConfig

type SUIRelayerChainConfig struct {
	Type  string                     `json:"type"`
	Value SUIRelayerChainConfigValue `json:"value"`
}

type SUIRelayerChainConfigValue

type SUIRelayerChainConfigValue struct {
	NID             string    `yaml:"nid"`
	RPCURL          string    `yaml:"rpc-url"`
	WebsocketUrl    string    `yaml:"ws-url"`
	StartHeight     int       `yaml:"start-height"`
	XcallPkgId      string    `yaml:"xcall-package-id"`
	ConnectionId    string    `yaml:"connection-id"`
	ConnectionCapId string    `yaml:"connection-cap-id"`
	XcallStorageId  string    `yaml:"xcall-storage-id"`
	NetworkID       int       `yaml:"network-id"`
	BlockInterval   string    `yaml:"block-interval"`
	Address         string    `yaml:"address"`
	FinalityBlock   uint64    `yaml:"finality-block"`
	GasPrice        int64     `yaml:"gas-price"`
	GasLimit        int       `yaml:"gas-limit"`
	Dapps           []SuiDapp `yaml:"dapps"`
}

type SolanaRelayerChainConfig

type SolanaRelayerChainConfig struct {
	Type  string                        `json:"type"`
	Value SolanaRelayerChainConfigValue `json:"value"`
}

type SolanaRelayerChainConfigValue

type SolanaRelayerChainConfigValue struct {
	Disabled          bool     `yaml:"disabled" json:"disabled"`
	ChainName         string   `yaml:"-"`
	RPCUrl            string   `yaml:"rpc-url"`
	Address           string   `yaml:"address"`
	XcallProgram      string   `yaml:"xcall-program"`
	ConnectionProgram string   `yaml:"connection-program"`
	OtherConnections  []string `yaml:"other-connections"`
	Dapps             []Dapp   `yaml:"dapps"`
	CpNIDs            []string `yaml:"cp-nids"`     //counter party NIDs Eg: ["0x2.icon", "0x7.icon"]
	AltAddress        string   `yaml:"alt-address"` // address lookup table address
	NID               string   `yaml:"nid"`
	HomeDir           string   `yaml:"home-dir"`
	GasLimit          uint64   `yaml:"gas-limit"`
	StartHeight       uint64   `yaml:"start-height"`
}

type StellarRelayerChainConfig

type StellarRelayerChainConfig struct {
	Type  string                         `json:"type"`
	Value StellarRelayerChainConfigValue `json:"value"`
}

type StellarRelayerChainConfigValue

type StellarRelayerChainConfigValue struct {
	NID               string            `yaml:"nid"`
	SorobanUrl        string            `yaml:"soroban-url"`
	HorizonUrl        string            `yaml:"horizon-url"`
	StartHeight       int               `yaml:"start-height"`
	NetworkID         int               `yaml:"network-id"`
	Contracts         map[string]string `yaml:"contracts"`
	BlockInterval     string            `yaml:"block-interval"`
	Address           string            `yaml:"address"`
	FinalityBlock     uint64            `yaml:"finality-block"`
	MaxInclusionFee   int64             `yaml:"max-inclusion-fee"`
	NetworkPassphrase string            `yaml:"network-passphrase"`
}

type SuiDapp

type SuiDapp struct {
	PkgID string `json:"package-id" yaml:"package-id"`

	Modules []SuiDappModule `json:"modules" yaml:"modules"`
}

type SuiDappModule

type SuiDappModule struct {
	Name     string `yaml:"name" json:"name"`
	CapID    string `yaml:"cap-id" json:"cap-id"`
	ConfigID string `yaml:"config-id" json:"config-id"`
}

type WalletModel

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