fault

Documentation

Index

• type Agent
  • func NewAgent(m metrics.Metricer, loader ClaimLoader, maxDepth types.Depth, ...) *Agent
  • func (a *Agent) Act(ctx context.Context) error
• type ClaimLoader
• type CloseFunc
  • func RegisterGameTypes(registry Registry, ctx context.Context, cl faultTypes.ClockReader, ...) (CloseFunc, error)
• type GameContract
• type GameInfo
• type GamePlayer
  • func NewGamePlayer(ctx context.Context, cl types.ClockReader, logger log.Logger, ...) (*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 PrestateLoader
• type PrestateValidator
  • func NewPrestateValidator(loader PrestateLoader, provider types.PrestateProvider) *PrestateValidator
  • func (v *PrestateValidator) Validate(ctx context.Context) error
• type Registry
• type Responder
• type Validator

Types

type Agent

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

func NewAgent

func NewAgent(m metrics.Metricer, loader ClaimLoader, maxDepth types.Depth, trace types.TraceAccessor, responder Responder, log log.Logger) *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) ([]types.Claim, error)
}

type CloseFunc

type CloseFunc func()

func RegisterGameTypes

func RegisterGameTypes(
	registry Registry,
	ctx context.Context,
	cl faultTypes.ClockReader,
	logger log.Logger,
	m metrics.Metricer,
	cfg *config.Config,
	rollupClient outputs.OutputRollupClient,
	txSender types.TxSender,
	gameFactory *contracts.DisputeGameFactoryContract,
	caller *batching.MultiCaller,
) (CloseFunc, error)

type GameContract

type GameContract interface {
	preimages.PreimageGameContract
	responder.GameContract
	GameInfo
	ClaimLoader
	GetStatus(ctx context.Context) (gameTypes.GameStatus, error)
	GetMaxGameDepth(ctx context.Context) (types.Depth, error)
	GetOracle(ctx context.Context) (*contracts.PreimageOracleContract, 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,
	cl types.ClockReader,
	logger log.Logger,
	m metrics.Metricer,
	dir string,
	addr common.Address,
	txSender gameTypes.TxSender,
	loader GameContract,
	validators []Validator,
	creator resourceCreator,
) (*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 PrestateLoader

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

type PrestateValidator

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

func NewPrestateValidator

func NewPrestateValidator(loader PrestateLoader, provider 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, oracle keccakTypes.LargePreimageOracle)
	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
	ResolveClaim(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 Validator

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