cannon

Documentation

Index

• Variables
• type CannonMetricer
• type CannonPrestateProvider
  • func NewPrestateProvider(prestate string) *CannonPrestateProvider
  • func (p *CannonPrestateProvider) AbsolutePreStateCommitment(_ context.Context) (common.Hash, error)
• 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 types.Depth)
• type CannonTraceProviderForTest
  • func NewTraceProviderForTest(logger log.Logger, m CannonMetricer, cfg *config.Config, ...) *CannonTraceProviderForTest
  • func (p *CannonTraceProviderForTest) FindStep(ctx context.Context, start uint64, preimage PreimageOpt) (uint64, error)
• 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, l1Head common.Hash, l2Client L2HeaderSource, ...) (LocalGameInputs, error)
• type PreimageOpt
  • func FirstKeccakPreimageLoad() PreimageOpt
  • func FirstPrecompilePreimageLoad() PreimageOpt
  • func FirstPreimageLoadOfType(preimageType string) PreimageOpt
  • func PreimageLargerThan(size int) PreimageOpt
  • func PreimageLoad(key preimage.Key, offset uint32) PreimageOpt
• type ProofGenerator

Variables

var (
	ErrInvalidScalarValue     = errors.New("invalid scalar value")
	ErrInvalidBlobKeyPreimage = errors.New("invalid blob key preimage")
)

Types

type CannonMetricer

type CannonMetricer interface {
	RecordCannonExecutionTime(t float64)
}

type CannonPrestateProvider

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

func NewPrestateProvider

func NewPrestateProvider(prestate string) *CannonPrestateProvider

func (*CannonPrestateProvider) AbsolutePreStateCommitment

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

type CannonTraceProvider

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

func NewTraceProvider

func NewTraceProvider(logger log.Logger, m CannonMetricer, cfg *config.Config, localInputs LocalGameInputs, dir string, gameDepth types.Depth) *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 types.Depth)

type CannonTraceProviderForTest

type CannonTraceProviderForTest struct {
	*CannonTraceProvider
}

CannonTraceProviderForTest is a CannonTraceProvider that can find the step referencing the preimage read Only to be used for testing

func NewTraceProviderForTest

func NewTraceProviderForTest(logger log.Logger, m CannonMetricer, cfg *config.Config, localInputs LocalGameInputs, dir string, gameDepth types.Depth) *CannonTraceProviderForTest

func (*CannonTraceProviderForTest) FindStep

func (p *CannonTraceProviderForTest) FindStep(ctx context.Context, start uint64, preimage PreimageOpt) (uint64, error)

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

GenerateProof executes cannon to generate a proof at the specified trace index. The proof is stored at the specified directory.

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, l1Head common.Hash, l2Client L2HeaderSource, agreedOutput contracts.Proposal, claimedOutput contracts.Proposal) (LocalGameInputs, error)

type PreimageOpt

type PreimageOpt func() preimageOpts

func FirstKeccakPreimageLoad

func FirstKeccakPreimageLoad() PreimageOpt

func FirstPrecompilePreimageLoad

func FirstPrecompilePreimageLoad() PreimageOpt

func FirstPreimageLoadOfType

func FirstPreimageLoadOfType(preimageType string) PreimageOpt

func PreimageLargerThan

func PreimageLargerThan(size int) PreimageOpt

func PreimageLoad

func PreimageLoad(key preimage.Key, offset uint32) PreimageOpt

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
}