cannon

Documentation

Index

• type CannonMetricer
• type CannonTraceProvider
  • func NewTraceProvider(logger log.Logger, m CannonMetricer, cfg *config.Config, ...) *CannonTraceProvider
  • func (p *CannonTraceProvider) AbsolutePreStateCommitment(_ context.Context) (common.Hash, error)
  • func (p *CannonTraceProvider) Get(ctx context.Context, pos types.Position) (common.Hash, error)
  • func (p *CannonTraceProvider) GetStepData(ctx context.Context, pos types.Position) ([]byte, []byte, *types.PreimageOracleData, error)
  • func (p *CannonTraceProvider) SetMaxDepth(gameDepth uint64)
• type Executor
  • func NewExecutor(logger log.Logger, m CannonMetricer, cfg *config.Config, ...) *Executor
  • func (e *Executor) GenerateProof(ctx context.Context, dir string, i uint64) error
• type GameInputsSource
• type L1HeadSource
• type L2HeaderSource
• type LocalGameInputs
  • func FetchLocalInputs(ctx context.Context, caller GameInputsSource, l2Client L2HeaderSource) (LocalGameInputs, error)
  • func FetchLocalInputsFromProposals(ctx context.Context, caller L1HeadSource, l2Client L2HeaderSource, ...) (LocalGameInputs, error)
• type ProofGenerator

Types

type CannonMetricer

type CannonMetricer interface {
	RecordCannonExecutionTime(t float64)
}

type CannonTraceProvider

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

func NewTraceProvider

func NewTraceProvider(logger log.Logger, m CannonMetricer, cfg *config.Config, localContext common.Hash, localInputs LocalGameInputs, dir string, gameDepth uint64) *CannonTraceProvider

func (*CannonTraceProvider) AbsolutePreStateCommitment

func (p *CannonTraceProvider) AbsolutePreStateCommitment(_ context.Context) (common.Hash, error)

func (*CannonTraceProvider) Get

func (p *CannonTraceProvider) Get(ctx context.Context, pos types.Position) (common.Hash, error)

func (*CannonTraceProvider) GetStepData

func (p *CannonTraceProvider) GetStepData(ctx context.Context, pos types.Position) ([]byte, []byte, *types.PreimageOracleData, error)

func (*CannonTraceProvider) SetMaxDepth

func (p *CannonTraceProvider) SetMaxDepth(gameDepth uint64)

type Executor

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

func NewExecutor

func NewExecutor(logger log.Logger, m CannonMetricer, cfg *config.Config, inputs LocalGameInputs) *Executor

func (*Executor) GenerateProof

func (e *Executor) GenerateProof(ctx context.Context, dir string, i uint64) error

type GameInputsSource

type GameInputsSource interface {
	L1HeadSource
	GetProposals(ctx context.Context) (agreed contracts.Proposal, disputed contracts.Proposal, err error)
}

type L1HeadSource

type L1HeadSource interface {
	GetL1Head(ctx context.Context) (common.Hash, error)
}

type L2HeaderSource

type L2HeaderSource interface {
	HeaderByNumber(context.Context, *big.Int) (*ethtypes.Header, error)
}

type LocalGameInputs

type LocalGameInputs struct {
	L1Head        common.Hash
	L2Head        common.Hash
	L2OutputRoot  common.Hash
	L2Claim       common.Hash
	L2BlockNumber *big.Int
}

func FetchLocalInputs

func FetchLocalInputs(ctx context.Context, caller GameInputsSource, l2Client L2HeaderSource) (LocalGameInputs, error)

func FetchLocalInputsFromProposals

func FetchLocalInputsFromProposals(ctx context.Context, caller L1HeadSource, l2Client L2HeaderSource, agreedOutput contracts.Proposal, claimedOutput contracts.Proposal) (LocalGameInputs, error)

type ProofGenerator

type ProofGenerator interface {
	// GenerateProof executes cannon to generate a proof at the specified trace index in dataDir.
	GenerateProof(ctx context.Context, dataDir string, proofAt uint64) error
}