relayer

Documentation

Index

• func CreateSubmissions(up StreamUpdate) ([]xchain.Submission, error)
• func Run(ctx context.Context, cfg Config) error
• func WriteConfigTOML(cfg Config, logCfg log.Config, path string) error
• type Config
  • func DefaultConfig() Config
• type CreateFunc
• type SendFunc
• type Sender
  • func NewSender(chain netconf.Chain, rpcClient ethclient.Client, privateKey ecdsa.PrivateKey, ...) (Sender, error)
  • func (o Sender) SendTransaction(ctx context.Context, sub xchain.Submission) error
• type State
  • func LoadCursors(path string) (*State, bool, error)
  • func NewEmptyState(filePath string) *State
  • func (s *State) Clear(dstID uint64) error
  • func (s *State) GetOffset(dstID, srcID uint64) uint64
  • func (s *State) Persist(dstID, srcID, offset uint64) error
• type StreamUpdate
• type Worker
  • func NewWorker(destChain netconf.Chain, network netconf.Network, cProvider cchain.Provider, ...) *Worker
  • func (w *Worker) Run(ctx context.Context)

Functions

func CreateSubmissions

func CreateSubmissions(up StreamUpdate) ([]xchain.Submission, error)

CreateSubmissions splits the update into multiple submissions that are each small enough (wrt calldata and gas) to be submitted on-chain.

func Run

func Run(ctx context.Context, cfg Config) error

func WriteConfigTOML

func WriteConfigTOML(cfg Config, logCfg log.Config, path string) error

WriteConfigTOML writes the toml halo config to disk.

Types

type Config

type Config struct {
	RPCEndpoints   xchain.RPCEndpoints
	PrivateKey     string
	HaloURL        string
	Network        netconf.ID
	MonitoringAddr string
	StateFile      string
}

func DefaultConfig

func DefaultConfig() Config

type CreateFunc

type CreateFunc func(streamUpdate StreamUpdate) ([]xchain.Submission, error)

CreateFunc is a function that creates one or more submissions from the given stream update.

type SendFunc

type SendFunc func(ctx context.Context, submission xchain.Submission) error

SendFunc sends a submission to the destination chain by invoking "xsubmit" on portal contract.

type Sender

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

Sender uses txmgr to send transactions to the destination chain.

func NewSender

func NewSender(chain netconf.Chain, rpcClient ethclient.Client,
	privateKey ecdsa.PrivateKey, chainNames map[uint64]string) (Sender, error)

NewSender creates a new sender that uses txmgr to send transactions to the destination chain.

func (Sender) SendTransaction

func (o Sender) SendTransaction(ctx context.Context, sub xchain.Submission) error

SendTransaction sends the submission to the destination chain.

type State

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

State represents the state of the relayer. It keeps track of the last successfully processed block.

func LoadCursors

func LoadCursors(path string) (*State, bool, error)

LoadCursors loads a file state from the given path.

func NewEmptyState

func NewEmptyState(filePath string) *State

NewEmptyState creates a new empty state with the given file path.

func (*State) Clear

func (s *State) Clear(dstID uint64) error

Clear deletes all destination chain cursors.

func (*State) GetOffset

func (s *State) GetOffset(dstID, srcID uint64) uint64

GetOffset returns the last submitted offset for the given destChainID and srcChainID.

func (*State) Persist

func (s *State) Persist(dstID, srcID, offset uint64) error

Persist saves the given offset for the given src and dest chain pair..

type StreamUpdate

type StreamUpdate struct {
	xchain.StreamID
	Tree        xchain.BlockTree
	Attestation xchain.Attestation // Attestation for the xmsgs
	Msgs        []xchain.Msg       // msgs that increment the cursor
}

type Worker

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

func NewWorker

func NewWorker(destChain netconf.Chain, network netconf.Network, cProvider cchain.Provider,
	xProvider xchain.Provider, creator CreateFunc, sendProvider func() (SendFunc, error), state *State,
	awaitValSet awaitValSet,
) *Worker

NewWorker creates a new worker for a single destination chain.

func (*Worker) Run

func (w *Worker) Run(ctx context.Context)