client

Documentation

Index

• Constants
• func CreateHinterChannel() preimage.FileChannel
• func CreatePreimageChannel() preimage.FileChannel
• func Main(logger log.Logger)
• func RunProgram(logger log.Logger, preimageOracle io.ReadWriter, preimageHinter io.ReadWriter) error
• type BootInfo
• type BootstrapClient
  • func NewBootstrapClient(r oracleClient) *BootstrapClient
  • func (br *BootstrapClient) BootInfo() *BootInfo

Constants

const (
	L1HeadLocalIndex preimage.LocalIndexKey = iota + 1
	L2OutputRootLocalIndex
	L2ClaimLocalIndex
	L2ClaimBlockNumberLocalIndex
	L2ChainIDLocalIndex

	// These local keys are only used for custom chains
	L2ChainConfigLocalIndex
	RollupConfigLocalIndex
)

const (
	// 0,1,2 used for stdin,stdout,stderr
	HClientRFd = iota + 3
	HClientWFd
	PClientRFd
	PClientWFd
	MaxFd
)

const CustomChainIDIndicator = uint64(math.MaxUint64)

CustomChainIDIndicator is used to detect when the program should load custom chain configuration

Functions

func CreateHinterChannel

func CreateHinterChannel() preimage.FileChannel

func CreatePreimageChannel

func CreatePreimageChannel() preimage.FileChannel

CreatePreimageChannel returns a FileChannel for the preimage oracle in a detached context

func Main

func Main(logger log.Logger)

Main executes the client program in a detached context and exits the current process. The client runtime environment must be preset before calling this function.

func RunProgram

func RunProgram(logger log.Logger, preimageOracle io.ReadWriter, preimageHinter io.ReadWriter) error

RunProgram executes the Program, while attached to an IO based pre-image oracle, to be served by a host.

Types

type BootInfo

type BootInfo struct {
	L1Head             common.Hash
	L2OutputRoot       common.Hash
	L2Claim            common.Hash
	L2ClaimBlockNumber uint64
	L2ChainID          uint64

	L2ChainConfig *params.ChainConfig
	RollupConfig  *rollup.Config
}

type BootstrapClient

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

func NewBootstrapClient

func NewBootstrapClient(r oracleClient) *BootstrapClient

func (*BootstrapClient) BootInfo

func (br *BootstrapClient) BootInfo() *BootInfo