fault

Documentation

Index

• Variables
• type Agent
  • func NewAgent(m metrics.Metricer, systemClock clock.Clock, l1Clock types.ClockReader, ...) *Agent
  • func (a *Agent) Act(ctx context.Context) error
• type ClaimLoader
• type CloseFunc
  • func RegisterGameTypes(ctx context.Context, systemClock clock.Clock, l1Clock faultTypes.ClockReader, ...) (CloseFunc, error)
• type GameContract
• type GameInfo
• type GamePlayer
  • func NewGamePlayer(ctx context.Context, systemClock clock.Clock, l1Clock types.ClockReader, ...) (*GamePlayer, error)
  • func (g *GamePlayer) ProgressGame(ctx context.Context) gameTypes.GameStatus
  • func (g *GamePlayer) Status() gameTypes.GameStatus
  • func (g *GamePlayer) ValidatePrestate(ctx context.Context) error
• type L1HeaderSource
• type OracleRegistry
• type PrestateLoader
• type PrestateSource
• type PrestateValidator
  • func NewPrestateValidator(valueName string, contractProvider PrestateLoader, ...) *PrestateValidator
  • func (v *PrestateValidator) Validate(ctx context.Context) error
• type Registry
• type Responder
• type RollupClient
• type SyncStatusProvider
• type SyncValidator
• type TxSender
• type Validator

Variables

var ErrNotInSync = errors.New("local node too far behind")

Types

type Agent

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

func NewAgent

func NewAgent(
	m metrics.Metricer,
	systemClock clock.Clock,
	l1Clock types.ClockReader,
	loader ClaimLoader,
	maxDepth types.Depth,
	maxClockDuration time.Duration,
	trace types.TraceAccessor,
	responder Responder,
	log log.Logger,
	selective bool,
	claimants []common.Address,
) *Agent

func (*Agent) Act

func (a *Agent) Act(ctx context.Context) error

Act iterates the game & performs all of the next actions.

type ClaimLoader

type ClaimLoader interface {
	GetAllClaims(ctx context.Context, block rpcblock.Block) ([]types.Claim, error)
	IsL2BlockNumberChallenged(ctx context.Context, block rpcblock.Block) (bool, error)
}

type CloseFunc

type CloseFunc func()

func RegisterGameTypes

func RegisterGameTypes(
	ctx context.Context,
	systemClock clock.Clock,
	l1Clock faultTypes.ClockReader,
	logger log.Logger,
	m metrics.Metricer,
	cfg *config.Config,
	registry Registry,
	oracles OracleRegistry,
	rollupClient RollupClient,
	txSender TxSender,
	gameFactory *contracts.DisputeGameFactoryContract,
	caller *batching.MultiCaller,
	l1HeaderSource L1HeaderSource,
	selective bool,
	claimants []common.Address,
) (CloseFunc, error)

type GameContract

type GameContract interface {
	preimages.PreimageGameContract
	responder.GameContract
	claims.BondContract
	GameInfo
	ClaimLoader
	GetStatus(ctx context.Context) (gameTypes.GameStatus, error)
	GetMaxGameDepth(ctx context.Context) (types.Depth, error)
	GetMaxClockDuration(ctx context.Context) (time.Duration, error)
	GetOracle(ctx context.Context) (*contracts.PreimageOracleContract, error)
	GetL1Head(ctx context.Context) (common.Hash, error)
}

type GameInfo

type GameInfo interface {
	GetStatus(context.Context) (gameTypes.GameStatus, error)
	GetClaimCount(context.Context) (uint64, error)
}

type GamePlayer

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

func NewGamePlayer

func NewGamePlayer(
	ctx context.Context,
	systemClock clock.Clock,
	l1Clock types.ClockReader,
	logger log.Logger,
	m metrics.Metricer,
	dir string,
	addr common.Address,
	txSender TxSender,
	loader GameContract,
	syncValidator SyncValidator,
	validators []Validator,
	creator resourceCreator,
	l1HeaderSource L1HeaderSource,
	selective bool,
	claimants []common.Address,
) (*GamePlayer, error)

func (*GamePlayer) ProgressGame

func (g *GamePlayer) ProgressGame(ctx context.Context) gameTypes.GameStatus

func (*GamePlayer) Status

func (g *GamePlayer) Status() gameTypes.GameStatus

func (*GamePlayer) ValidatePrestate

func (g *GamePlayer) ValidatePrestate(ctx context.Context) error

type L1HeaderSource

type L1HeaderSource interface {
	HeaderByHash(context.Context, common.Hash) (*gethTypes.Header, error)
}

type OracleRegistry

type OracleRegistry interface {
	RegisterOracle(oracle keccakTypes.LargePreimageOracle)
}

type PrestateLoader

type PrestateLoader = func(ctx context.Context) (common.Hash, error)

type PrestateSource

type PrestateSource interface {
	// PrestatePath returns the path to the prestate file to use for the game.
	// The provided prestateHash may be used to differentiate between different states but no guarantee is made that
	// the returned prestate matches the supplied hash.
	PrestatePath(prestateHash common.Hash) (string, error)
}

type PrestateValidator

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

func NewPrestateValidator

func NewPrestateValidator(valueName string, contractProvider PrestateLoader, localProvider types.PrestateProvider) *PrestateValidator

func (*PrestateValidator) Validate

func (v *PrestateValidator) Validate(ctx context.Context) error

type Registry

type Registry interface {
	RegisterGameType(gameType uint32, creator scheduler.PlayerCreator)
	RegisterBondContract(gameType uint32, creator claims.BondContractCreator)
}

type Responder

type Responder interface {
	CallResolve(ctx context.Context) (gameTypes.GameStatus, error)
	Resolve() error
	CallResolveClaim(ctx context.Context, claimIdx uint64) error
	ResolveClaims(claimIdx ...uint64) error
	PerformAction(ctx context.Context, action types.Action) error
}

Responder takes a response action & executes. For full op-challenger this means executing the transaction on chain.

type RollupClient

type RollupClient interface {
	outputs.OutputRollupClient
	SyncStatusProvider
}

type SyncStatusProvider

type SyncStatusProvider interface {
	SyncStatus(context.Context) (*eth.SyncStatus, error)
}

type SyncValidator

type SyncValidator interface {
	ValidateNodeSynced(ctx context.Context, gameL1Head eth.BlockID) error
}

type TxSender

type TxSender interface {
	From() common.Address
	SendAndWaitSimple(txPurpose string, txs ...txmgr.TxCandidate) error
}

type Validator

type Validator interface {
	Validate(ctx context.Context) error
}