block

package
v1.16.14 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 3, 2025 License: BSD-3-Clause Imports: 18 Imported by: 0

README

State Sync: Engine role and workflow

State sync promises to dramatically cut down the time it takes for a validator to join a chain by directly downloading and verifying the state of the chain, rather than rebuilding the state by processing all historical blocks.

Lux's approach to state sync leaves most of specifics to each VM, to allow maximal flexibility. However, the Lux engine plays a well defined role in selecting and validating state summaries, which are the state sync seeds used by a VM to kickstart its syncing process.

In this document, we outline the engine's role in state sync and the requirements for VMs implementing state sync.

StateSyncableVM Interface

The StateSyncableVM interface enumerates all the features a VM must implement to support state sync.

The Lux engine begins bootstrapping a VM through state-sync if StateSyncEnabled() returns true. Otherwise, the engine falls back to processing all historical blocks.

The Lux engine performs two state-syncing phases:

  • Frontier retrieval: retrieve the most recent state summaries from a random subset of validators
  • Frontier validation: the retrieved state summaries are voted on by all connected validators

Security is guaranteed by accepting the state summary if and only if a sufficient fraction of stake has validated them. This prevents malicious actors from poisoning a VM with a corrupt or unavailable state summary.

Frontier retrieval

The Lux engine waits to begin frontier retrieval until enough stake is connected.

The engine first calls GetOngoingSyncStateSummary() to retrieve a local state summary from the VM. If available, this state summary is added to the frontier.

A state summary may be locally available if the VM was previously shut down while state syncing. By revalidating this local summary, Lux engine helps the VM understand whether its local state summary is still widely supported by the network. If the local state summary is widely supported, the engine will allow the VM to resume state syncing from it. Otherwise the VM will be requested to drop it in favour of a fresher, more available state summary.

State summary frontier is collected as follows:

  1. The Lux engine samples a random subset of validators and sends each of them a GetStateSummaryFrontier message to retrieve the latest state summaries.
  2. Each target validator pulls its latest state summary from the VM via the GetLastStateSummary method, and responds with a StateSummaryFrontier message.
  3. StateSummaryFrontier responses are parsed via the ParseStateSummary method and added to the state summary frontier to be validated.

The Lux engine does not pose major constraints on the state summary structure; as its parsing is left to the VM to implement. However, the Lux engine does require each state summary to be uniquely described by two identifiers, Height and ID. The reason for this double identification will be clearer as we describe the state summary validation phase.

Height is a uint64 and represents the block height that the state summaries refers to. Height offers the most succinct way to address an accepted state summary.

ID is an ids.ID type and is the verifiable way to address a state summary, regardless of its status. In most implementations, a state summary ID is the hash of the state summary's bytes.

Frontier validation

Once the frontiers have been retrieved, a network wide voting round is initiated to validate them. Lux sends a GetAcceptedStateSummary message to each connected validator, containing a list of the state summary frontier's Heights. Heights provide a unique yet succinct way to identify state summaries, and they help reduce the size of the GetAcceptedStateSummary message.

When a validator receives a GetAcceptedStateSummary message, it will respond with IDs corresponding to the Heights sent in the message. This is done by calling GetStateSummary(summaryHeight uint64) on the VM for each Height. Unknown or unsupported state summary Heights are skipped. Responding with the summary IDs allows the client to verify votes easily and ensures the integrity of the state sync starting point.

AcceptedStateSummary messages returned to the state syncing node are validated by comparing responded state summaries IDs with the IDs calculated from state summary frontier previously retrieved. Valid responses are stored along with cumulative validator stake.

Once all validators respond or timeout, Lux will select all the state summaries with a sufficient stake verifying them.

If no state summary is backed by sufficient stake, the process of collecting a state frontier and validating it is restarted again, up to a configurable number of times.

Of all the valid state summaries, one is selected and passed to the VM by calling Summary.Accept(). The preferred state summary is selected as follows: if the locally available one is still valid and supported by the network it will be accepted to allow the VM to resume the previously interrupted state sync. Otherwise, the most recent state summary (with the highest Height value) is picked. Note that Lux engine will block upon Summary.Accept()'s response, hence the VM should perform actual state syncing asynchronously.

The Lux engine declares state syncing complete in the following cases:

  1. Summary.Accept() returns (StateSyncSkipped, nil) signalling that the VM considered the summary valid but skips the whole syncing process. This may happen if the VM estimates that bootstrapping would be faster than state syncing with the provided summary.
  2. The VM sends StateSyncDone via the Notify channel.

Note that any error returned from Summary.Accept() is considered fatal and causes the engine to shutdown.

If Summary.Accept() returns (StateSyncStatic, nil), Lux will wait until state synced is complete before continuing the bootstrapping process. If Summary.Accept() returns (StateSyncDynamic, nil), Lux will immediately continue the bootstrapping process. If bootstrapping finishes before the state sync has been completed, Chits messages will include the LastAcceptedID rather than the PreferredID.

Documentation

Overview

Package block is a generated GoMock package.

Index

Constants

This section is empty.

Variables

View Source 
var ErrRemoteVMNotImplemented = errors.New("vm does not implement RemoteVM interface")
View Source 
var ErrStateSyncableVMNotImplemented = errors.New("vm does not implement StateSyncableVM interface")

Functions

func BatchedParseBlock added in v0.15.6 

func BatchedParseBlock(
	ctx context.Context,
	vm Parser,
	blks [][]byte,
) ([]chain.Block, error)

func GetAncestors added in v0.15.6 

func GetAncestors(
	ctx context.Context,
	log log.Logger,
	vm Getter,
	blkID ids.ID,
	maxBlocksNum int,
	maxBlocksSize int,
	maxBlocksRetrivalTime time.Duration,
) ([][]byte, error)

Types

type BatchedChainVM 

type BatchedChainVM interface {
	GetAncestors(
		ctx context.Context,
		blkID ids.ID,
		maxBlocksNum int,
		maxBlocksSize int,
		maxBlocksRetrivalTime time.Duration,
	) ([][]byte, error)

	BatchedParseBlock(ctx context.Context, blks [][]byte) ([]chain.Block, error)
}

BatchedChainVM extends the minimal functionalities exposed by ChainVM for VMs communicating over network (gRPC in our case). This allows more efficient operations since calls over network can be duly batched

type BuildBlockWithContextChainVM 

type BuildBlockWithContextChainVM interface {
	// Attempt to build a new block given that the P-Chain height is
	// [blockCtx.PChainHeight].
	//
	// This method will be called if and only if the proposervm is activated.
	// Otherwise [BuildBlock] will be called.
	BuildBlockWithContext(ctx context.Context, blockCtx *Context) (chain.Block, error)
}

BuildBlockWithContextChainVM defines the interface a ChainVM can optionally implement to consider the P-Chain height when building blocks.

type ChainVM 

type ChainVM interface {
	core.VM

	Getter
	Parser

	// Attempt to create a new block from data contained in the VM.
	//
	// If the VM doesn't want to issue a new block, an error should be
	// returned.
	BuildBlock(context.Context) (chain.Block, error)

	// Notify the VM of the currently preferred block.
	//
	// This should always be a block that has no children known to consensus.
	SetPreference(ctx context.Context, blkID ids.ID) error

	// LastAccepted returns the ID of the last accepted block.
	//
	// If no blocks have been accepted by consensus yet, it is assumed there is
	// a definitionally accepted block, the Genesis block, that will be
	// returned.
	LastAccepted(context.Context) (ids.ID, error)

	// GetBlockIDAtHeight returns:
	// - The ID of the block that was accepted with [height].
	// - database.ErrNotFound if the [height] index is unknown.
	//
	// Note: A returned value of [database.ErrNotFound] typically means that the
	//       underlying VM was state synced and does not have access to the
	//       blockID at [height].
	GetBlockIDAtHeight(ctx context.Context, height uint64) (ids.ID, error)
}

ChainVM defines the required functionality of a Linear VM.

A Linear VM is responsible for defining the representation of state, the representation of operations on that state, the application of operations on that state, and the creation of the operations. Consensus will decide on if the operation is executed and the order operations are executed in.

For example, suppose we have a VM that tracks an increasing number that is agreed upon by the network. The state is a single number. The operation is setting the number to a new, larger value. Applying the operation will save to the database the new value. The VM can attempt to issue a new number, of larger value, at any time. Consensus will ensure the network agrees on the number at every block height.

type ChangeNotifier added in v0.15.6 

type ChangeNotifier struct {
	ChainVM

	// OnChange is used to signal the NotificationForwarder to stop its current subscription and re-subscribe.
	// This is needed in case a block has been accepted that changes when a VM considers the need to build a block.
	// In order for the subscription to be correlated to the latest data, it needs to be retried.
	OnChange func()
	// contains filtered or unexported fields
}

func (*ChangeNotifier) BatchedParseBlock added in v0.15.6 

func (cn *ChangeNotifier) BatchedParseBlock(ctx context.Context, blks [][]byte) ([]chain.Block, error)

func (*ChangeNotifier) BuildBlock added in v0.15.6 

func (cn *ChangeNotifier) BuildBlock(ctx context.Context) (chain.Block, error)

func (*ChangeNotifier) GetAncestors added in v0.15.6 

func (cn *ChangeNotifier) GetAncestors(ctx context.Context, blkID ids.ID, maxBlocksNum int, maxBlocksSize int, maxBlocksRetrivalTime time.Duration) ([][]byte, error)

func (*ChangeNotifier) GetLastStateSummary added in v0.15.6 

func (cn *ChangeNotifier) GetLastStateSummary(ctx context.Context) (StateSummary, error)

func (*ChangeNotifier) GetOngoingSyncStateSummary added in v0.15.6 

func (cn *ChangeNotifier) GetOngoingSyncStateSummary(ctx context.Context) (StateSummary, error)

func (*ChangeNotifier) GetStateSummary added in v0.15.6 

func (cn *ChangeNotifier) GetStateSummary(ctx context.Context, summaryHeight uint64) (StateSummary, error)

func (*ChangeNotifier) ParseStateSummary added in v0.15.6 

func (cn *ChangeNotifier) ParseStateSummary(ctx context.Context, summaryBytes []byte) (StateSummary, error)

func (*ChangeNotifier) SetPreference added in v0.15.6 

func (cn *ChangeNotifier) SetPreference(ctx context.Context, blkID ids.ID) error

func (*ChangeNotifier) SetState added in v0.15.6 

func (cn *ChangeNotifier) SetState(ctx context.Context, state consensus.State) error

func (*ChangeNotifier) StateSyncEnabled added in v0.15.6 

func (cn *ChangeNotifier) StateSyncEnabled(ctx context.Context) (bool, error)

type Context 

type Context struct {
	// PChainHeight is the height that this block will use to verify it's state.
	// In the proposervm, blocks verify the proposer based on the P-chain height
	// recorded in the parent block. However, the P-chain height provided here
	// is the P-chain height encoded into this block.
	//
	// Pre-Etna this value matched the parent block's P-chain height.
	//
	// Because PreForkBlocks and PostForkOptions do not verify their execution
	// against the P-chain's state, this context is undefined for those blocks.
	PChainHeight uint64 `canoto:"uint,1" json:"pChainHeight"`
	// contains filtered or unexported fields
}

Context defines the block context that will be optionally provided by the proposervm to an underlying vm.

func (*Context) CachedCanotoSize added in v0.15.6 

func (c *Context) CachedCanotoSize() uint64

CachedCanotoSize returns the previously calculated size of the Canoto representation from CalculateCanotoCache.

If CalculateCanotoCache has not yet been called, it will return 0.

If the struct has been modified since the last call to CalculateCanotoCache, the returned size may be incorrect.

func (*Context) CalculateCanotoCache added in v0.15.6 

func (c *Context) CalculateCanotoCache()

CalculateCanotoCache populates size and OneOf caches based on the current values in the struct.

It is not safe to copy this struct concurrently.

func (*Context) CanotoSpec added in v0.15.6 

func (*Context) CanotoSpec(...reflect.Type) *canoto.Spec

CanotoSpec returns the specification of this canoto message.

func (*Context) MakeCanoto added in v0.15.6 

func (*Context) MakeCanoto() *Context

MakeCanoto creates a new empty value.

func (*Context) MarshalCanoto added in v0.15.6 

func (c *Context) MarshalCanoto() []byte

MarshalCanoto returns the Canoto representation of this struct.

It is assumed that this struct is ValidCanoto.

It is not safe to copy this struct concurrently.

func (*Context) MarshalCanotoInto added in v0.15.6 

func (c *Context) MarshalCanotoInto(w canoto.Writer) canoto.Writer

MarshalCanotoInto writes the struct into a canoto.Writer and returns the resulting canoto.Writer. Most users should just use MarshalCanoto.

It is assumed that CalculateCanotoCache has been called since the last modification to this struct.

It is assumed that this struct is ValidCanoto.

It is not safe to copy this struct concurrently.

func (*Context) UnmarshalCanoto added in v0.15.6 

func (c *Context) UnmarshalCanoto(bytes []byte) error

UnmarshalCanoto unmarshals a Canoto-encoded byte slice into the struct.

During parsing, the canoto cache is saved.

func (*Context) UnmarshalCanotoFrom added in v0.15.6 

func (c *Context) UnmarshalCanotoFrom(r canoto.Reader) error

UnmarshalCanotoFrom populates the struct from a canoto.Reader. Most users should just use UnmarshalCanoto.

During parsing, the canoto cache is saved.

This function enables configuration of reader options.

func (*Context) ValidCanoto added in v0.15.6 

func (c *Context) ValidCanoto() bool

ValidCanoto validates that the struct can be correctly marshaled into the Canoto format.

Specifically, ValidCanoto ensures: 1. All OneOfs are specified at most once. 2. All strings are valid utf-8. 3. All custom fields are ValidCanoto.

type FullVM added in v0.15.6 

type FullVM interface {
	StateSyncableVM
	BatchedChainVM
	ChainVM
}

type Getter added in v0.15.6 

type Getter interface {
	// Attempt to load a block.
	//
	// If the block does not exist, database.ErrNotFound should be returned.
	//
	// It is expected that blocks that have been successfully verified should be
	// returned correctly. It is also expected that blocks that have been
	// accepted by the consensus engine should be able to be fetched. It is not
	// required for blocks that have been rejected by the consensus engine to be
	// able to be fetched.
	GetBlock(ctx context.Context, blkID ids.ID) (chain.Block, error)
}

Getter defines the functionality for fetching a block by its ID.

type MockChainVM added in v1.1.11 

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

MockChainVM is a mock of ChainVM interface.

func NewMockChainVM added in v1.1.11 

func NewMockChainVM(ctrl *gomock.Controller) *MockChainVM

NewMockChainVM creates a new mock instance.

func (*MockChainVM) AppGossip added in v1.1.11 

func (m *MockChainVM) AppGossip(ctx context.Context, nodeID ids.NodeID, msg []byte) error

AppGossip mocks base method.

func (*MockChainVM) AppRequest added in v1.1.11 

func (m *MockChainVM) AppRequest(ctx context.Context, nodeID ids.NodeID, requestID uint32, deadline time.Time, request []byte) error

AppRequest mocks base method.

func (*MockChainVM) AppRequestFailed added in v1.1.11 

func (m *MockChainVM) AppRequestFailed(ctx context.Context, nodeID ids.NodeID, requestID uint32, appErr *core.AppError) error

AppRequestFailed mocks base method.

func (*MockChainVM) AppResponse added in v1.1.11 

func (m *MockChainVM) AppResponse(ctx context.Context, nodeID ids.NodeID, requestID uint32, response []byte) error

AppResponse mocks base method.

func (*MockChainVM) BuildBlock added in v1.1.11 

func (m *MockChainVM) BuildBlock(arg0 context.Context) (chain.Block, error)

BuildBlock mocks base method.

func (*MockChainVM) Connected added in v1.1.11 

func (m *MockChainVM) Connected(ctx context.Context, nodeID ids.NodeID, nodeVersion *version.Application) error

Connected mocks base method.

func (*MockChainVM) CreateHandlers added in v1.1.11 

func (m *MockChainVM) CreateHandlers(arg0 context.Context) (map[string]http.Handler, error)

CreateHandlers mocks base method.

func (*MockChainVM) Disconnected added in v1.1.11 

func (m *MockChainVM) Disconnected(ctx context.Context, nodeID ids.NodeID) error

Disconnected mocks base method.

func (*MockChainVM) EXPECT added in v1.1.11 

func (m *MockChainVM) EXPECT() *MockChainVMMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockChainVM) GetBlock added in v1.1.11 

func (m *MockChainVM) GetBlock(ctx context.Context, blkID ids.ID) (chain.Block, error)

GetBlock mocks base method.

func (*MockChainVM) GetBlockIDAtHeight added in v1.1.11 

func (m *MockChainVM) GetBlockIDAtHeight(ctx context.Context, height uint64) (ids.ID, error)

GetBlockIDAtHeight mocks base method.

func (*MockChainVM) HealthCheck added in v1.1.11 

func (m *MockChainVM) HealthCheck(arg0 context.Context) (any, error)

HealthCheck mocks base method.

func (*MockChainVM) Initialize added in v1.1.11 

func (m *MockChainVM) Initialize(ctx context.Context, chainCtx *consensus.Context, db database.Database, genesisBytes, upgradeBytes, configBytes []byte, fxs []*core.Fx, appSender core.AppSender) error

Initialize mocks base method.

func (*MockChainVM) LastAccepted added in v1.1.11 

func (m *MockChainVM) LastAccepted(arg0 context.Context) (ids.ID, error)

LastAccepted mocks base method.

func (*MockChainVM) NewHTTPHandler added in v1.1.11 

func (m *MockChainVM) NewHTTPHandler(ctx context.Context) (http.Handler, error)

NewHTTPHandler mocks base method.

func (*MockChainVM) ParseBlock added in v1.1.11 

func (m *MockChainVM) ParseBlock(ctx context.Context, blockBytes []byte) (chain.Block, error)

ParseBlock mocks base method.

func (*MockChainVM) SetPreference added in v1.1.11 

func (m *MockChainVM) SetPreference(ctx context.Context, blkID ids.ID) error

SetPreference mocks base method.

func (*MockChainVM) SetState added in v1.1.11 

func (m *MockChainVM) SetState(ctx context.Context, state consensus.State) error

SetState mocks base method.

func (*MockChainVM) Shutdown added in v1.1.11 

func (m *MockChainVM) Shutdown(arg0 context.Context) error

Shutdown mocks base method.

func (*MockChainVM) Version added in v1.1.11 

func (m *MockChainVM) Version(arg0 context.Context) (string, error)

Version mocks base method.

func (*MockChainVM) WaitForEvent added in v1.1.11 

func (m *MockChainVM) WaitForEvent(ctx context.Context) (core.Message, error)

WaitForEvent mocks base method.

type MockChainVMMockRecorder added in v1.1.11 

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

MockChainVMMockRecorder is the mock recorder for MockChainVM.

func (*MockChainVMMockRecorder) AppGossip added in v1.1.11 

func (mr *MockChainVMMockRecorder) AppGossip(ctx, nodeID, msg any) *gomock.Call

AppGossip indicates an expected call of AppGossip.

func (*MockChainVMMockRecorder) AppRequest added in v1.1.11 

func (mr *MockChainVMMockRecorder) AppRequest(ctx, nodeID, requestID, deadline, request any) *gomock.Call

AppRequest indicates an expected call of AppRequest.

func (*MockChainVMMockRecorder) AppRequestFailed added in v1.1.11 

func (mr *MockChainVMMockRecorder) AppRequestFailed(ctx, nodeID, requestID, appErr any) *gomock.Call

AppRequestFailed indicates an expected call of AppRequestFailed.

func (*MockChainVMMockRecorder) AppResponse added in v1.1.11 

func (mr *MockChainVMMockRecorder) AppResponse(ctx, nodeID, requestID, response any) *gomock.Call

AppResponse indicates an expected call of AppResponse.

func (*MockChainVMMockRecorder) BuildBlock added in v1.1.11 

func (mr *MockChainVMMockRecorder) BuildBlock(arg0 any) *gomock.Call

BuildBlock indicates an expected call of BuildBlock.

func (*MockChainVMMockRecorder) Connected added in v1.1.11 

func (mr *MockChainVMMockRecorder) Connected(ctx, nodeID, nodeVersion any) *gomock.Call

Connected indicates an expected call of Connected.

func (*MockChainVMMockRecorder) CreateHandlers added in v1.1.11 

func (mr *MockChainVMMockRecorder) CreateHandlers(arg0 any) *gomock.Call

CreateHandlers indicates an expected call of CreateHandlers.

func (*MockChainVMMockRecorder) Disconnected added in v1.1.11 

func (mr *MockChainVMMockRecorder) Disconnected(ctx, nodeID any) *gomock.Call

Disconnected indicates an expected call of Disconnected.

func (*MockChainVMMockRecorder) GetBlock added in v1.1.11 

func (mr *MockChainVMMockRecorder) GetBlock(ctx, blkID any) *gomock.Call

GetBlock indicates an expected call of GetBlock.

func (*MockChainVMMockRecorder) GetBlockIDAtHeight added in v1.1.11 

func (mr *MockChainVMMockRecorder) GetBlockIDAtHeight(ctx, height any) *gomock.Call

GetBlockIDAtHeight indicates an expected call of GetBlockIDAtHeight.

func (*MockChainVMMockRecorder) HealthCheck added in v1.1.11 

func (mr *MockChainVMMockRecorder) HealthCheck(arg0 any) *gomock.Call

HealthCheck indicates an expected call of HealthCheck.

func (*MockChainVMMockRecorder) Initialize added in v1.1.11 

func (mr *MockChainVMMockRecorder) Initialize(ctx, chainCtx, db, genesisBytes, upgradeBytes, configBytes, fxs, appSender any) *gomock.Call

Initialize indicates an expected call of Initialize.

func (*MockChainVMMockRecorder) LastAccepted added in v1.1.11 

func (mr *MockChainVMMockRecorder) LastAccepted(arg0 any) *gomock.Call

LastAccepted indicates an expected call of LastAccepted.

func (*MockChainVMMockRecorder) NewHTTPHandler added in v1.1.11 

func (mr *MockChainVMMockRecorder) NewHTTPHandler(ctx any) *gomock.Call

NewHTTPHandler indicates an expected call of NewHTTPHandler.

func (*MockChainVMMockRecorder) ParseBlock added in v1.1.11 

func (mr *MockChainVMMockRecorder) ParseBlock(ctx, blockBytes any) *gomock.Call

ParseBlock indicates an expected call of ParseBlock.

func (*MockChainVMMockRecorder) SetPreference added in v1.1.11 

func (mr *MockChainVMMockRecorder) SetPreference(ctx, blkID any) *gomock.Call

SetPreference indicates an expected call of SetPreference.

func (*MockChainVMMockRecorder) SetState added in v1.1.11 

func (mr *MockChainVMMockRecorder) SetState(ctx, state any) *gomock.Call

SetState indicates an expected call of SetState.

func (*MockChainVMMockRecorder) Shutdown added in v1.1.11 

func (mr *MockChainVMMockRecorder) Shutdown(arg0 any) *gomock.Call

Shutdown indicates an expected call of Shutdown.

func (*MockChainVMMockRecorder) Version added in v1.1.11 

func (mr *MockChainVMMockRecorder) Version(arg0 any) *gomock.Call

Version indicates an expected call of Version.

func (*MockChainVMMockRecorder) WaitForEvent added in v1.1.11 

func (mr *MockChainVMMockRecorder) WaitForEvent(ctx any) *gomock.Call

WaitForEvent indicates an expected call of WaitForEvent.

type ParseFunc added in v0.15.6 

type ParseFunc func(context.Context, []byte) (chain.Block, error)

ParseFunc defines a function that parses raw bytes into a block.

func (ParseFunc) ParseBlock added in v0.15.6 

func (f ParseFunc) ParseBlock(ctx context.Context, blockBytes []byte) (chain.Block, error)

ParseBlock wraps a ParseFunc into a ParseBlock function, to be used by a Parser interface

type Parser added in v0.15.6 

type Parser interface {
	// Attempt to create a block from a stream of bytes.
	//
	// The block should be represented by the full byte array, without extra
	// bytes.
	//
	// It is expected for all historical blocks to be parseable.
	ParseBlock(ctx context.Context, blockBytes []byte) (chain.Block, error)
}

Parser defines the functionality for fetching a block by its bytes.

type StateSummary 

type StateSummary interface {
	// ID uniquely identifies this state summary, regardless of the chain state.
	ID() ids.ID

	// Height uniquely identifies this an accepted state summary.
	Height() uint64

	// Bytes returns a byte slice than can be used to reconstruct this summary.
	Bytes() []byte

	// Accept notifies the VM that this is a canonically accepted state summary.
	// The VM is expected to return how it plans on handling this summary via
	// the [StateSyncMode].
	//
	// Invariant: The VM must be able to correctly handle the acceptance of a
	// state summary that is older than its current state.
	//
	// See [StateSyncSkipped], [StateSyncStatic], and [StateSyncDynamic] for the
	// expected invariants the VM must maintain based on the return value.
	Accept(context.Context) (StateSyncMode, error)
}

StateSummary represents all the information needed to download, verify, and rebuild its state.

type StateSyncMode 

type StateSyncMode uint8

StateSyncMode is returned by the StateSyncableVM when a state summary is passed to it. It indicates which type of state sync the VM is performing. 

const (
	// StateSyncSkipped indicates that state sync won't be run by the VM. This
	// may happen if the VM decides that the state sync is too recent and it
	// would be faster to bootstrap the missing blocks.
	StateSyncSkipped StateSyncMode = iota + 1

	// StateSyncStatic indicates that engine should stop and wait for the VM to
	// complete state syncing before moving ahead with bootstrapping.
	StateSyncStatic

	// StateSyncDynamic indicates that engine should immediately transition
	// into bootstrapping and then normal consensus. State sync will proceed
	// asynchronously in the VM.
	//
	// Invariant: If this is returned it is assumed that the VM should be able
	// to handle requests from the engine as if the VM is fully synced.
	// Specifically, it is required that the invariants specified by
	// LastAccepted, GetBlock, ParseBlock, and Block.Verify are maintained. This
	// means that when StateSummary.Accept returns, the block that would become
	// the last accepted block must be immediately fetchable by the engine.
	StateSyncDynamic
)

func (StateSyncMode) String added in v0.15.6 

func (s StateSyncMode) String() string

type StateSyncableVM 

type StateSyncableVM interface {
	// StateSyncEnabled indicates whether the state sync is enabled for this VM.
	// If StateSyncableVM is not implemented, as it may happen with a wrapper
	// VM, StateSyncEnabled should return false, nil
	StateSyncEnabled(context.Context) (bool, error)

	// GetOngoingSyncStateSummary returns an in-progress state summary if it
	// exists.
	//
	// The engine can then ask the network if the ongoing summary is still
	// supported, thus helping the VM decide whether to continue an in-progress
	// sync or start over.
	//
	// Returns database.ErrNotFound if there is no in-progress sync.
	GetOngoingSyncStateSummary(context.Context) (StateSummary, error)

	// GetLastStateSummary returns the latest state summary.
	//
	// Returns database.ErrNotFound if no summary is available.
	GetLastStateSummary(context.Context) (StateSummary, error)

	// ParseStateSummary parses a state summary out of [summaryBytes].
	ParseStateSummary(ctx context.Context, summaryBytes []byte) (StateSummary, error)

	// GetStateSummary retrieves the state summary that was generated at height
	// [summaryHeight].
	//
	// Returns database.ErrNotFound if no summary is available at
	// [summaryHeight].
	GetStateSummary(ctx context.Context, summaryHeight uint64) (StateSummary, error)
}

StateSyncableVM contains the functionality to allow VMs to sync to a given state, rather then boostrapping from genesis.

type WithVerifyContext 

type WithVerifyContext interface {
	// Returns true if [VerifyWithContext] should be called.
	// Returns false if [Verify] should be called.
	//
	// This method will be called if and only if the proposervm is activated.
	// Otherwise [Verify] will be called.
	ShouldVerifyWithContext(context.Context) (bool, error)

	// Verify that the state transition this block would make if accepted is
	// valid. If the state transition is invalid, a non-nil error should be
	// returned.
	//
	// It is guaranteed that the Parent has been successfully verified.
	//
	// This method may be called again with a different context.
	//
	// If nil is returned, it is guaranteed that either Accept or Reject will be
	// called on this block, unless the VM is shut down.
	//
	// Note: During `Accept` the block context is not provided. This implies
	// that the block context provided here can not be used to alter any
	// potential state transition that assumes network agreement. The block
	// context should only be used to determine the validity of the block.
	VerifyWithContext(context.Context, *Context) error
}

WithVerifyContext defines the interface a Block can optionally implement to consider the P-Chain height when verifying itself.

As with all Blocks, it is guaranteed for verification to be called in topological order.

If the status of the block is Accepted or Rejected; VerifyWithContext will never be called.

Source Files

View all Source files

Directories

Path Synopsis
Package blockmock is a generated GoMock package.
 Package blockmock is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.