asterisc

Documentation

Index

• type AsteriscMetricer
• type AsteriscPreStateProvider
  • func NewPrestateProvider(prestate string) *AsteriscPreStateProvider
  • func (p *AsteriscPreStateProvider) AbsolutePreStateCommitment(_ context.Context) (common.Hash, error)
• type AsteriscTraceProvider
  • func NewTraceProvider(logger log.Logger, m AsteriscMetricer, cfg *config.Config, ...) *AsteriscTraceProvider
  • func (p *AsteriscTraceProvider) AbsolutePreStateCommitment(_ context.Context) (common.Hash, error)
  • func (p *AsteriscTraceProvider) Get(ctx context.Context, pos types.Position) (common.Hash, error)
  • func (p *AsteriscTraceProvider) GetStepData(ctx context.Context, pos types.Position) ([]byte, []byte, *types.PreimageOracleData, error)
• type AsteriscTraceProviderForTest
  • func NewTraceProviderForTest(logger log.Logger, m AsteriscMetricer, cfg *config.Config, ...) *AsteriscTraceProviderForTest
  • func (p *AsteriscTraceProviderForTest) FindStep(ctx context.Context, start uint64, preimage utils.PreimageOpt) (uint64, error)
• type Executor
  • func NewExecutor(logger log.Logger, m AsteriscMetricer, cfg *config.Config, ...) *Executor
  • func (e *Executor) GenerateProof(ctx context.Context, dir string, i uint64) error
• type VMState

Types

type AsteriscMetricer

type AsteriscMetricer interface {
	RecordAsteriscExecutionTime(t float64)
}

type AsteriscPreStateProvider

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

func NewPrestateProvider

func NewPrestateProvider(prestate string) *AsteriscPreStateProvider

func (*AsteriscPreStateProvider) AbsolutePreStateCommitment

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

type AsteriscTraceProvider

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

func NewTraceProvider

func NewTraceProvider(logger log.Logger, m AsteriscMetricer, cfg *config.Config, localInputs utils.LocalGameInputs, dir string, gameDepth types.Depth) *AsteriscTraceProvider

func (*AsteriscTraceProvider) AbsolutePreStateCommitment

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

func (*AsteriscTraceProvider) Get

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

func (*AsteriscTraceProvider) GetStepData

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

type AsteriscTraceProviderForTest

type AsteriscTraceProviderForTest struct {
	*AsteriscTraceProvider
}

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

func NewTraceProviderForTest

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

func (*AsteriscTraceProviderForTest) FindStep

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

type Executor

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

func NewExecutor

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

func (*Executor) GenerateProof

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

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

type VMState

type VMState struct {
	PC        uint64   `json:"pc"`
	Exited    bool     `json:"exited"`
	Step      uint64   `json:"step"`
	Witness   []byte   `json:"witness"`
	StateHash [32]byte `json:"stateHash"`
}

The state struct will be read from json. other fields included in json are specific to FPVM implementation, and not required for trace provider.