machine

Documentation

Index

• type BlockInfo
• type BlockReason
• type BlockStore
• type BreakpointBlocked
  • func (b BreakpointBlocked) Equals(a BlockReason) bool
  • func (b BreakpointBlocked) IsBlocked(Machine, bool) bool
  • func (b BreakpointBlocked) String() string
• type CheckpointStorage
• type ErrorBlocked
  • func (b ErrorBlocked) Equals(a BlockReason) bool
  • func (b ErrorBlocked) IsBlocked(Machine, bool) bool
  • func (b ErrorBlocked) String() string
• type HaltBlocked
  • func (b HaltBlocked) Equals(a BlockReason) bool
  • func (b HaltBlocked) IsBlocked(Machine, bool) bool
  • func (b HaltBlocked) String() string
• type InboxBlocked
  • func (b InboxBlocked) Equals(a BlockReason) bool
  • func (b InboxBlocked) IsBlocked(_ Machine, newMessages bool) bool
  • func (b InboxBlocked) String() string
• type Machine
• type Status

Types

type BlockInfo

type BlockInfo struct {
	Hash     common.Hash
	BlockLog value.Value
	Bloom    types.Bloom
}

type BlockReason

type BlockReason interface {
	IsBlocked(m Machine, newMessages bool) bool
	Equals(b BlockReason) bool
}

type BlockStore

type BlockStore interface {
	PutBlock(id *common.BlockId, data []byte) error
	DeleteBlock(id *common.BlockId) error
	GetBlock(id *common.BlockId) ([]byte, error)
	BlocksAtHeight(height *common.TimeBlocks) []*common.BlockId
	IsBlockStoreEmpty() bool
	MaxBlockStoreHeight() *common.TimeBlocks
	MinBlockStoreHeight() *common.TimeBlocks
}

type BreakpointBlocked

type BreakpointBlocked struct {
}

func (BreakpointBlocked) Equals

func (b BreakpointBlocked) Equals(a BlockReason) bool

func (BreakpointBlocked) IsBlocked

func (b BreakpointBlocked) IsBlocked(Machine, bool) bool

func (BreakpointBlocked) String

func (b BreakpointBlocked) String() string

type CheckpointStorage

type CheckpointStorage interface {
	DeleteCheckpoint(machineHash common.Hash) bool
	Initialize(contractPath string) error
	Initialized() bool
	CloseCheckpointStorage() bool
	GetInitialMachine() (Machine, error)
	GetMachine(machineHash common.Hash) (Machine, error)
	SaveValue(val value.Value) bool
	GetValue(hashValue common.Hash) value.Value
	DeleteValue(hashValue common.Hash) bool
	SaveData(key []byte, serializedValue []byte) bool
	GetData(key []byte) []byte
	DeleteData(key []byte) bool
}

type ErrorBlocked

type ErrorBlocked struct {
}

func (ErrorBlocked) Equals

func (b ErrorBlocked) Equals(a BlockReason) bool

func (ErrorBlocked) IsBlocked

func (b ErrorBlocked) IsBlocked(Machine, bool) bool

func (ErrorBlocked) String

func (b ErrorBlocked) String() string

type HaltBlocked

type HaltBlocked struct {
}

func (HaltBlocked) Equals

func (b HaltBlocked) Equals(a BlockReason) bool

func (HaltBlocked) IsBlocked

func (b HaltBlocked) IsBlocked(Machine, bool) bool

func (HaltBlocked) String

func (b HaltBlocked) String() string

type InboxBlocked

type InboxBlocked struct {
}

func (InboxBlocked) Equals

func (b InboxBlocked) Equals(a BlockReason) bool

func (InboxBlocked) IsBlocked

func (b InboxBlocked) IsBlocked(_ Machine, newMessages bool) bool

func (InboxBlocked) String

func (b InboxBlocked) String() string

type Machine

type Machine interface {
	Hash() common.Hash
	Clone() Machine
	PrintState()

	CurrentStatus() Status
	IsBlocked(newMessages bool) BlockReason

	ExecuteAssertion(
		maxSteps uint64,
		messages []inbox.InboxMessage,
		maxWallTime time.Duration,
	) (*protocol.ExecutionAssertion, uint64)

	// Supply a value that the inbox peek opcode will return if the inbox
	// runs out of messages. For ArbOS, this can be used to simulate a message
	// from the next block arriving in order to trigger end-of-block processes
	// without waiting for the next block
	ExecuteCallServerAssertion(
		maxSteps uint64,
		inboxMessages []inbox.InboxMessage,
		fakeInboxPeekValue value.Value,
		maxWallTime time.Duration,
	) (*protocol.ExecutionAssertion, uint64)

	ExecuteSideloadedAssertion(
		maxSteps uint64,
		messages []inbox.InboxMessage,
		sideloadValue *value.TupleValue,
		maxWallTime time.Duration,
	) (*protocol.ExecutionAssertion, uint64)

	MarshalForProof() ([]byte, error)

	MarshalState() ([]byte, error)

	Checkpoint(storage CheckpointStorage) bool
}

type Status

type Status int

const (
	Extensive Status = iota
	ErrorStop
	Halt
)