vm

Documentation

Index

• Constants
• func FindStartingSnapshot(logger log.Logger, snapDir string, absolutePreState string, traceIndex uint64) (string, error)
• func PreimageDir(dir string) string
• func RunCmd(ctx context.Context, l log.Logger, binary string, args ...string) error
• type CmdExecutor
• type Config
• type Executor
  • func NewExecutor(logger log.Logger, m Metricer, cfg Config, oracleServer OracleServerExecutor, ...) *Executor
  • func (e *Executor) DoGenerateProof(ctx context.Context, dir string, begin uint64, end uint64, ...) error
  • func (e *Executor) GenerateProof(ctx context.Context, dir string, i uint64) error
• type KonaVmConfig
  • func NewKonaVmConfig() *KonaVmConfig
  • func (s *KonaVmConfig) OracleCommand(cfg Config, dataDir string, inputs utils.LocalGameInputs) ([]string, error)
• type Metricer
• type OpProgramVmConfig
  • func NewOpProgramVmConfig() *OpProgramVmConfig
  • func (s *OpProgramVmConfig) OracleCommand(cfg Config, dataDir string, inputs utils.LocalGameInputs) ([]string, error)
• type OracleServerExecutor
• type SnapshotSelect

Constants

const (
	SnapsDir     = "snapshots"
	PreimagesDir = "preimages"
	FinalState   = "final.json.gz"
)

Functions

func FindStartingSnapshot

func FindStartingSnapshot(logger log.Logger, snapDir string, absolutePreState string, traceIndex uint64) (string, error)

FindStartingSnapshot finds the closest snapshot before the specified traceIndex in snapDir. If no suitable snapshot can be found it returns absolutePreState.

func PreimageDir

func PreimageDir(dir string) string

func RunCmd

func RunCmd(ctx context.Context, l log.Logger, binary string, args ...string) error

Types

type CmdExecutor

type CmdExecutor func(ctx context.Context, l log.Logger, binary string, args ...string) error

type Config

type Config struct {
	// VM Configuration
	VmType       types.TraceType
	VmBin        string // Path to the vm executable to run when generating trace data
	SnapshotFreq uint   // Frequency of snapshots to create when executing (in VM instructions)
	InfoFreq     uint   // Frequency of progress log messages (in VM instructions)
	DebugInfo    bool

	// Host Configuration
	L1               string
	L1Beacon         string
	L2               string
	Server           string // Path to the executable that provides the pre-image oracle server
	Network          string
	RollupConfigPath string
	L2GenesisPath    string
}

type Executor

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

func NewExecutor

func NewExecutor(logger log.Logger, m Metricer, cfg Config, oracleServer OracleServerExecutor, prestate string, inputs utils.LocalGameInputs) *Executor

func (*Executor) DoGenerateProof

func (e *Executor) DoGenerateProof(ctx context.Context, dir string, begin uint64, end uint64, extraVmArgs ...string) error

DoGenerateProof executes vm from the specified starting trace index until the end trace index. The proof is stored at the specified directory.

func (*Executor) GenerateProof

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

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

type KonaVmConfig

type KonaVmConfig struct {
}

func NewKonaVmConfig

func NewKonaVmConfig() *KonaVmConfig

func (*KonaVmConfig) OracleCommand

func (s *KonaVmConfig) OracleCommand(cfg Config, dataDir string, inputs utils.LocalGameInputs) ([]string, error)

type Metricer

type Metricer interface {
	RecordVmExecutionTime(vmType string, t time.Duration)
	RecordVmMemoryUsed(vmType string, memoryUsed uint64)
}

type OpProgramVmConfig

type OpProgramVmConfig struct {
}

func NewOpProgramVmConfig

func NewOpProgramVmConfig() *OpProgramVmConfig

func (*OpProgramVmConfig) OracleCommand

func (s *OpProgramVmConfig) OracleCommand(cfg Config, dataDir string, inputs utils.LocalGameInputs) ([]string, error)

type OracleServerExecutor

type OracleServerExecutor interface {
	OracleCommand(cfg Config, dataDir string, inputs utils.LocalGameInputs) ([]string, error)
}

type SnapshotSelect

type SnapshotSelect func(logger log.Logger, dir string, absolutePreState string, i uint64) (string, error)