connect

Documentation

Index

• func WithEndpoint(chainName string, rpc string) option
• func WithInfuraENV(keyVar string) option
• func WithPublicRPCs() option
• type Connector
  • func New(ctx context.Context, netID netconf.ID, opts ...option) (Connector, error)
  • func (c Connector) Backend(chainID uint64) (*ethbackend.Backend, error)

Functions

func WithEndpoint

func WithEndpoint(chainName string, rpc string) option

WithEndpoint returns an option to set the RPC endpoint for the given chain name or chain ID.

func WithInfuraENV

func WithInfuraENV(keyVar string) option

WithInfuraENV returns an option using the provided ENV VAR as infura API key for all xchains.

func WithPublicRPCs

func WithPublicRPCs() option

WithPublicRPCs returns an option using well known public free RPCs for all xchains. This is used be default if no other option is provided.

Types

type Connector

type Connector struct {
	Network    netconf.Network
	XProvider  xchain.Provider
	CProvider  cchain.Provider
	EthClients map[uint64]ethclient.Client
	CmtCl      rpcclient.Client
}

Connector provider a simple abstraction to connect to the Omni network.

func New

func New(ctx context.Context, netID netconf.ID, opts ...option) (Connector, error)

New returns a populated Connector for the given network. It connects to well-known free public RPCs. Use WithInfuraENV or WithEndpoint to override this.

func (Connector) Backend

func (c Connector) Backend(chainID uint64) (*ethbackend.Backend, error)

Backend returns an ethbackend for the given chainID.