state

Documentation

Index

• Variables
• func CommitDelta(ldg ledger.Ledger, ruh RegisterUpdatesHolder, ...) (flow.StateCommitment, *ledger.TrieUpdate, execution.ExtendableStorageSnapshot, ...)
• func IsParentExecuted(state ReadOnlyExecutionState, header *flow.Header) (bool, error)
• func NewLedgerStorageSnapshot(ldg ledger.Ledger, commitment flow.StateCommitment) snapshot.StorageSnapshot
• func RegisterEntriesToKeysValues(entries flow.RegisterEntries) ([]ledger.Key, []ledger.Value)
• type ExecutionState
  • func NewExecutionState(ls ledger.Ledger, commits storage.Commits, blocks storage.Blocks, ...) ExecutionState
• type FinalizedExecutionState
• type LedgerStorageSnapshot
  • func (storage *LedgerStorageSnapshot) Get(id flow.RegisterID) (flow.RegisterValue, error)
• type ReadOnlyExecutionState
• type RegisterUpdatesHolder
• type ScriptExecutionState

Variables

var ErrExecutionStatePruned = fmt.Errorf("execution state is pruned")

var ErrNotExecuted = fmt.Errorf("block not executed")

Functions

func CommitDelta

func CommitDelta(
	ldg ledger.Ledger,
	ruh RegisterUpdatesHolder,
	baseStorageSnapshot execution.ExtendableStorageSnapshot,
) (flow.StateCommitment, *ledger.TrieUpdate, execution.ExtendableStorageSnapshot, error)

CommitDelta takes a base storage snapshot and creates a new storage snapshot with the register updates from the given RegisterUpdatesHolder a new statecommitment is returned from the ledger, along with the trie update any error returned are exceptions

func IsParentExecuted

func IsParentExecuted(state ReadOnlyExecutionState, header *flow.Header) (bool, error)

func NewLedgerStorageSnapshot

func NewLedgerStorageSnapshot(
	ldg ledger.Ledger,
	commitment flow.StateCommitment,
) snapshot.StorageSnapshot

func RegisterEntriesToKeysValues

func RegisterEntriesToKeysValues(
	entries flow.RegisterEntries,
) (
	[]ledger.Key,
	[]ledger.Value,
)

Types

type ExecutionState

type ExecutionState interface {
	ReadOnlyExecutionState

	UpdateHighestExecutedBlockIfHigher(context.Context, *flow.Header) error

	SaveExecutionResults(
		ctx context.Context,
		result *execution.ComputationResult,
	) error

	// only available with storehouse enabled
	// panic when called with storehouse disabled (which should be a bug)
	GetHighestFinalizedExecuted() (uint64, error)
}

ExecutionState is an interface used to access and mutate the execution state of the blockchain.

func NewExecutionState

func NewExecutionState(
	ls ledger.Ledger,
	commits storage.Commits,
	blocks storage.Blocks,
	headers storage.Headers,
	collections storage.Collections,
	chunkDataPacks storage.ChunkDataPacks,
	results storage.ExecutionResults,
	myReceipts storage.MyExecutionReceipts,
	events storage.Events,
	serviceEvents storage.ServiceEvents,
	transactionResults storage.TransactionResults,
	db *badger.DB,
	tracer module.Tracer,
	registerStore execution.RegisterStore,
	enableRegisterStore bool,
) ExecutionState

NewExecutionState returns a new execution state access layer for the given ledger storage.

type FinalizedExecutionState

type FinalizedExecutionState interface {
	GetHighestFinalizedExecuted() (uint64, error)
}

FinalizedExecutionState is an interface used to access the finalized execution state

type LedgerStorageSnapshot

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

func (*LedgerStorageSnapshot) Get

func (storage *LedgerStorageSnapshot) Get(
	id flow.RegisterID,
) (
	flow.RegisterValue,
	error,
)

type ReadOnlyExecutionState

type ReadOnlyExecutionState interface {
	ScriptExecutionState

	// ChunkDataPackByChunkID retrieve a chunk data pack given the chunk ID.
	ChunkDataPackByChunkID(flow.Identifier) (*flow.ChunkDataPack, error)

	GetExecutionResultID(context.Context, flow.Identifier) (flow.Identifier, error)

	GetHighestExecutedBlockID(context.Context) (uint64, flow.Identifier, error)
}

ReadOnlyExecutionState allows to read the execution state

type RegisterUpdatesHolder

type RegisterUpdatesHolder interface {
	UpdatedRegisters() flow.RegisterEntries
	UpdatedRegisterSet() map[flow.RegisterID]flow.RegisterValue
}

type ScriptExecutionState

type ScriptExecutionState interface {
	// NewStorageSnapshot creates a new ready-only view at the given block.
	NewStorageSnapshot(commit flow.StateCommitment, blockID flow.Identifier, height uint64) snapshot.StorageSnapshot

	// CreateStorageSnapshot creates a new ready-only view at the given block.
	// It returns:
	// - (nil, nil, storage.ErrNotFound) if block is unknown
	// - (nil, nil, state.ErrNotExecuted) if block is not executed
	// - (nil, nil, state.ErrExecutionStatePruned) if the execution state has been pruned
	CreateStorageSnapshot(blockID flow.Identifier) (snapshot.StorageSnapshot, *flow.Header, error)

	// StateCommitmentByBlockID returns the final state commitment for the provided block ID.
	StateCommitmentByBlockID(flow.Identifier) (flow.StateCommitment, error)

	// Any error returned is exception
	IsBlockExecuted(height uint64, blockID flow.Identifier) (bool, error)
}

ScriptExecutionState is a subset of the `state.ExecutionState` interface purposed to only access the state used for script execution and not mutate the execution state of the blockchain.