executor

Documentation

Overview

Package executor is the executor agent.

Index

• type Backend
• type ChainExecutor
• type Executor
  • func NewExecutor(ctx context.Context, config config.Config, executorDB db.ExecutorDB, ...) (*Executor, error)
  • func (e Executor) BuildTreeFromDB(ctx context.Context, chainID uint32, destination uint32) error
  • func (e Executor) Execute(ctx context.Context, message types.Message) (bool, error)
  • func (e Executor) Listen(ctx context.Context, chainID uint32) error
  • func (e Executor) Start(ctx context.Context) error
  • func (e Executor) Stop(chainID uint32)
  • func (e Executor) VerifyMessageMerkleProof(message types.Message) (bool, error)
  • func (e Executor) VerifyMessageOptimisticPeriod(ctx context.Context, message types.Message) (*uint32, error)

Types

type Backend

type Backend interface {
	// HeaderByNumber returns the block header with the given block number.
	HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error)
}

Backend is the backend for the executor.

type ChainExecutor

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

ChainExecutor is a struct that contains the necessary information for each chain level executor.

type Executor

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

Executor is the executor agent.

func NewExecutor

func NewExecutor(ctx context.Context, config config.Config, executorDB db.ExecutorDB, scribeClient client.ScribeClient, clients map[uint32]Backend) (*Executor, error)

NewExecutor creates a new executor agent.

func (Executor) BuildTreeFromDB

func (e Executor) BuildTreeFromDB(ctx context.Context, chainID uint32, destination uint32) error

BuildTreeFromDB builds the merkle tree from the database's messages. This function will reset the current merkle tree and replace it with the one built from the database. This function should also not be called while Start or Listen are running.

func (Executor) Execute

func (e Executor) Execute(ctx context.Context, message types.Message) (bool, error)

Execute calls execute on `destination.sol` on the destination chain, after verifying the message.

func (Executor) Listen

func (e Executor) Listen(ctx context.Context, chainID uint32) error

Listen listens to the log channel and processes the logs. Requires Start to be called first.

func (Executor) Start

func (e Executor) Start(ctx context.Context) error

Start starts the executor agent. This uses gRPC to process the logs.

func (Executor) Stop

func (e Executor) Stop(chainID uint32)

Stop stops the executor agent.

func (Executor) VerifyMessageMerkleProof

func (e Executor) VerifyMessageMerkleProof(message types.Message) (bool, error)

VerifyMessageMerkleProof verifies a message against the merkle tree at the state of the given nonce.

func (Executor) VerifyMessageOptimisticPeriod

func (e Executor) VerifyMessageOptimisticPeriod(ctx context.Context, message types.Message) (*uint32, error)

VerifyMessageOptimisticPeriod verifies that the optimistic period is valid.