test

Documentation

Index

• Variables
• type AlphabetWithProofProvider
  • func NewAlphabetWithProofProvider(t *testing.T, startingL2BlockNumber *big.Int, maxDepth types.Depth, ...) *AlphabetWithProofProvider
  • func (c *AlphabetWithProofProvider) GetL2BlockNumberChallenge(_ context.Context) (*types.InvalidL2BlockNumberChallenge, error)
  • func (a *AlphabetWithProofProvider) GetStepData(ctx context.Context, i types.Position) ([]byte, []byte, *types.PreimageOracleData, error)
• type ClaimBuilder
  • func NewAlphabetClaimBuilder(t *testing.T, startingL2BlockNumber *big.Int, maxDepth types.Depth) *ClaimBuilder
  • func NewClaimBuilder(t *testing.T, maxDepth types.Depth, provider types.TraceProvider) *ClaimBuilder
  • func (c *ClaimBuilder) AttackClaim(claim types.Claim, opts ...ClaimOpt) types.Claim
  • func (c *ClaimBuilder) CorrectClaimAtPosition(pos types.Position) common.Hash
  • func (c *ClaimBuilder) CorrectOracleData(idx *big.Int) *types.PreimageOracleData
  • func (c *ClaimBuilder) CorrectPreState(idx *big.Int) []byte
  • func (c *ClaimBuilder) CorrectProofData(idx *big.Int) []byte
  • func (c *ClaimBuilder) CorrectTraceProvider() types.TraceProvider
  • func (c *ClaimBuilder) CreateLeafClaim(traceIndex *big.Int, opts ...ClaimOpt) types.Claim
  • func (c *ClaimBuilder) CreateRootClaim(opts ...ClaimOpt) types.Claim
  • func (c *ClaimBuilder) DefendClaim(claim types.Claim, opts ...ClaimOpt) types.Claim
  • func (c *ClaimBuilder) GameBuilder(rootOpts ...ClaimOpt) *GameBuilder
  • func (c *ClaimBuilder) Seq(rootOpts ...ClaimOpt) *SequenceBuilder
• type ClaimOpt
  • func WithClaimant(claimant common.Address) ClaimOpt
  • func WithClock(timestamp time.Time, duration time.Duration) ClaimOpt
  • func WithInvalidValue(invalid bool) ClaimOpt
  • func WithParent(claim types.Claim) ClaimOpt
  • func WithValue(value common.Hash) ClaimOpt
• type GameBuilder
  • func NewGameBuilderFromGame(t *testing.T, provider types.TraceProvider, game types.Game) *GameBuilder
  • func (g *GameBuilder) Seq() *GameBuilderSeq
  • func (g *GameBuilder) SeqFrom(claim types.Claim) *GameBuilderSeq
• type GameBuilderSeq
  • func (s *GameBuilderSeq) Attack(opts ...ClaimOpt) *GameBuilderSeq
  • func (s *GameBuilderSeq) Defend(opts ...ClaimOpt) *GameBuilderSeq
  • func (s *GameBuilderSeq) ExpectAttack() *GameBuilderSeq
  • func (s *GameBuilderSeq) ExpectDefend() *GameBuilderSeq
  • func (s *GameBuilderSeq) ExpectStepAttack() *GameBuilderSeq
  • func (s *GameBuilderSeq) ExpectStepDefend() *GameBuilderSeq
  • func (g *GameBuilderSeq) IsMaxDepth() bool
  • func (g *GameBuilderSeq) IsRoot() bool
  • func (s *GameBuilderSeq) Step(opts ...ClaimOpt)
• type SequenceBuilder
  • func (s *SequenceBuilder) Attack(opts ...ClaimOpt) *SequenceBuilder
  • func (s *SequenceBuilder) Defend(opts ...ClaimOpt) *SequenceBuilder
  • func (s *SequenceBuilder) Get() types.Claim

Variables

var DefaultClaimant = common.Address{0xba, 0xdb, 0xad, 0xba, 0xdb, 0xad}

Types

type AlphabetWithProofProvider

type AlphabetWithProofProvider struct {
	*alphabet.AlphabetTraceProvider

	OracleError      error
	L2BlockChallenge *types.InvalidL2BlockNumberChallenge
	// contains filtered or unexported fields
}

func NewAlphabetWithProofProvider

func NewAlphabetWithProofProvider(t *testing.T, startingL2BlockNumber *big.Int, maxDepth types.Depth, oracleError error) *AlphabetWithProofProvider

func (*AlphabetWithProofProvider) GetL2BlockNumberChallenge

func (c *AlphabetWithProofProvider) GetL2BlockNumberChallenge(_ context.Context) (*types.InvalidL2BlockNumberChallenge, error)

func (*AlphabetWithProofProvider) GetStepData

func (a *AlphabetWithProofProvider) GetStepData(ctx context.Context, i types.Position) ([]byte, []byte, *types.PreimageOracleData, error)

type ClaimBuilder

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

ClaimBuilder is a test utility to enable creating claims in a wide range of situations

func NewAlphabetClaimBuilder

func NewAlphabetClaimBuilder(t *testing.T, startingL2BlockNumber *big.Int, maxDepth types.Depth) *ClaimBuilder

func NewClaimBuilder

func NewClaimBuilder(t *testing.T, maxDepth types.Depth, provider types.TraceProvider) *ClaimBuilder

NewClaimBuilder creates a new ClaimBuilder.

func (*ClaimBuilder) AttackClaim

func (c *ClaimBuilder) AttackClaim(claim types.Claim, opts ...ClaimOpt) types.Claim

func (*ClaimBuilder) CorrectClaimAtPosition

func (c *ClaimBuilder) CorrectClaimAtPosition(pos types.Position) common.Hash

CorrectClaimAtPosition returns the canonical claim at a specified position

func (*ClaimBuilder) CorrectOracleData

func (c *ClaimBuilder) CorrectOracleData(idx *big.Int) *types.PreimageOracleData

func (*ClaimBuilder) CorrectPreState

func (c *ClaimBuilder) CorrectPreState(idx *big.Int) []byte

CorrectPreState returns the pre-state (not hashed) required to execute the valid step at the specified trace index

func (*ClaimBuilder) CorrectProofData

func (c *ClaimBuilder) CorrectProofData(idx *big.Int) []byte

CorrectProofData returns the proof-data required to execute the valid step at the specified trace index

func (*ClaimBuilder) CorrectTraceProvider

func (c *ClaimBuilder) CorrectTraceProvider() types.TraceProvider

CorrectTraceProvider returns a types.TraceProvider that provides the canonical trace.

func (*ClaimBuilder) CreateLeafClaim

func (c *ClaimBuilder) CreateLeafClaim(traceIndex *big.Int, opts ...ClaimOpt) types.Claim

func (*ClaimBuilder) CreateRootClaim

func (c *ClaimBuilder) CreateRootClaim(opts ...ClaimOpt) types.Claim

func (*ClaimBuilder) DefendClaim

func (c *ClaimBuilder) DefendClaim(claim types.Claim, opts ...ClaimOpt) types.Claim

func (*ClaimBuilder) GameBuilder

func (c *ClaimBuilder) GameBuilder(rootOpts ...ClaimOpt) *GameBuilder

func (*ClaimBuilder) Seq

func (c *ClaimBuilder) Seq(rootOpts ...ClaimOpt) *SequenceBuilder

Seq starts building a claim by following a sequence of attack and defend moves from the root The returned SequenceBuilder can be used to add additional moves. e.g: claim := Seq(true).Attack(false).Attack(true).Defend(true).Get()

type ClaimOpt

type ClaimOpt interface {
	Apply(cfg *claimCfg)
}

func WithClaimant

func WithClaimant(claimant common.Address) ClaimOpt

func WithClock

func WithClock(timestamp time.Time, duration time.Duration) ClaimOpt

func WithInvalidValue

func WithInvalidValue(invalid bool) ClaimOpt

func WithParent

func WithParent(claim types.Claim) ClaimOpt

func WithValue

func WithValue(value common.Hash) ClaimOpt

type GameBuilder

type GameBuilder struct {
	Game            types.Game
	ExpectedActions []types.Action
	// contains filtered or unexported fields
}

func NewGameBuilderFromGame

func NewGameBuilderFromGame(t *testing.T, provider types.TraceProvider, game types.Game) *GameBuilder

func (*GameBuilder) Seq

func (g *GameBuilder) Seq() *GameBuilderSeq

func (*GameBuilder) SeqFrom

func (g *GameBuilder) SeqFrom(claim types.Claim) *GameBuilderSeq

type GameBuilderSeq

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

func (*GameBuilderSeq) Attack

func (s *GameBuilderSeq) Attack(opts ...ClaimOpt) *GameBuilderSeq

func (*GameBuilderSeq) Defend

func (s *GameBuilderSeq) Defend(opts ...ClaimOpt) *GameBuilderSeq

func (*GameBuilderSeq) ExpectAttack

func (s *GameBuilderSeq) ExpectAttack() *GameBuilderSeq

func (*GameBuilderSeq) ExpectDefend

func (s *GameBuilderSeq) ExpectDefend() *GameBuilderSeq

func (*GameBuilderSeq) ExpectStepAttack

func (s *GameBuilderSeq) ExpectStepAttack() *GameBuilderSeq

func (*GameBuilderSeq) ExpectStepDefend

func (s *GameBuilderSeq) ExpectStepDefend() *GameBuilderSeq

func (*GameBuilderSeq) IsMaxDepth

func (g *GameBuilderSeq) IsMaxDepth() bool

func (*GameBuilderSeq) IsRoot

func (g *GameBuilderSeq) IsRoot() bool

func (*GameBuilderSeq) Step

func (s *GameBuilderSeq) Step(opts ...ClaimOpt)

type SequenceBuilder

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

func (*SequenceBuilder) Attack

func (s *SequenceBuilder) Attack(opts ...ClaimOpt) *SequenceBuilder

func (*SequenceBuilder) Defend

func (s *SequenceBuilder) Defend(opts ...ClaimOpt) *SequenceBuilder

func (*SequenceBuilder) Get

func (s *SequenceBuilder) Get() types.Claim