committee

Documentation

Index

• Constants
• Variables
• type CheckpointSyncConfig
  • func (cfg *CheckpointSyncConfig) Validate() error
• type Node
  • func NewNode(commonNode *committee.Node, fetchPool *workerpool.Pool, ...) (*Node, error)
  • func (n *Node) Cleanup()
  • func (n *Node) GetLastSynced() (uint64, storageApi.Root, storageApi.Root)
  • func (n *Node) GetLocalStorage() storageApi.LocalBackend
  • func (n *Node) GetStatus(ctx context.Context) (*api.Status, error)
  • func (n *Node) HandleEpochTransitionLocked(snapshot *committee.EpochSnapshot)
  • func (n *Node) HandleNewBlockEarlyLocked(*block.Block)
  • func (n *Node) HandleNewBlockLocked(blk *block.Block)
  • func (n *Node) HandleNewEventLocked(*roothashApi.Event)
  • func (n *Node) HandlePeerTx(ctx context.Context, tx []byte) error
  • func (n *Node) HandleRuntimeHostEventLocked(ev *host.Event)
  • func (n *Node) Initialized() <-chan struct{}
  • func (n *Node) Name() string
  • func (n *Node) PauseCheckpointer(pause bool) error
  • func (n *Node) Quit() <-chan struct{}
  • func (n *Node) Start() error
  • func (n *Node) Stop()

Constants

const (

	// LogEventCheckpointSyncSuccess is a log event value that signals that checkpoint sync was successful.
	LogEventCheckpointSyncSuccess = "worker/storage/checkpoint-sync-success"
)

const (
	// RoundLatest is a magic value for the latest round.
	RoundLatest = math.MaxUint64
)

Variables

var ErrNoUsableCheckpoints = errors.New("storage: no checkpoint could be synced")

ErrNoUsableCheckpoints is the error returned when none of the checkpoints could be synced.

var (

	// ErrNonLocalBackend is the error returned when the storage backend doesn't implement the LocalBackend interface.
	ErrNonLocalBackend = errors.New("storage: storage backend doesn't support local storage")
)

Types

type CheckpointSyncConfig

type CheckpointSyncConfig struct {
	// Disabled specifies whether checkpoint sync should be disabled. In this case the node will
	// only sync by applying all diffs from genesis.
	Disabled bool

	// ChunkFetcherCount specifies the number of parallel checkpoint chunk fetchers.
	ChunkFetcherCount uint
}

CheckpointSyncConfig is the checkpoint sync configuration.

func (*CheckpointSyncConfig) Validate

func (cfg *CheckpointSyncConfig) Validate() error

Validate performs configuration checks.

type Node

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

Node watches blocks for storage changes.

func NewNode

func NewNode(
	commonNode *committee.Node,
	fetchPool *workerpool.Pool,
	roleProvider registration.RoleProvider,
	rpcRoleProvider registration.RoleProvider,
	workerCommonCfg workerCommon.Config,
	localStorage storageApi.LocalBackend,
	checkpointerCfg *checkpoint.CheckpointerConfig,
	checkpointSyncCfg *CheckpointSyncConfig,
) (*Node, error)

func (*Node) Cleanup

func (n *Node) Cleanup()

Cleanup cleans up any leftover state after the worker is stopped.

func (*Node) GetLastSynced

func (n *Node) GetLastSynced() (uint64, storageApi.Root, storageApi.Root)

GetLastSynced returns the height, IORoot hash and StateRoot hash of the last block that was fully synced to.

func (*Node) GetLocalStorage

func (n *Node) GetLocalStorage() storageApi.LocalBackend

GetLocalStorage returns the local storage backend used by this storage node.

func (*Node) GetStatus

func (n *Node) GetStatus(ctx context.Context) (*api.Status, error)

GetStatus returns the storage committee node status.

func (*Node) HandleEpochTransitionLocked

func (n *Node) HandleEpochTransitionLocked(snapshot *committee.EpochSnapshot)

HandleEpochTransitionLocked is guarded by CrossNode.

func (*Node) HandleNewBlockEarlyLocked

func (n *Node) HandleNewBlockEarlyLocked(*block.Block)

HandleNewBlockEarlyLocked is guarded by CrossNode.

func (*Node) HandleNewBlockLocked

func (n *Node) HandleNewBlockLocked(blk *block.Block)

HandleNewBlockLocked is guarded by CrossNode.

func (*Node) HandleNewEventLocked

func (n *Node) HandleNewEventLocked(*roothashApi.Event)

HandleNewEventLocked is guarded by CrossNode.

func (*Node) HandlePeerTx

func (n *Node) HandlePeerTx(ctx context.Context, tx []byte) error

func (*Node) HandleRuntimeHostEventLocked

func (n *Node) HandleRuntimeHostEventLocked(ev *host.Event)

HandleRuntimeHostEventLocked is guarded by CrossNode.

func (*Node) Initialized

func (n *Node) Initialized() <-chan struct{}

Initialized returns a channel that will be closed once the worker finished starting up.

func (*Node) Name

func (n *Node) Name() string

Name returns the service name.

func (*Node) PauseCheckpointer

func (n *Node) PauseCheckpointer(pause bool) error

func (*Node) Quit

func (n *Node) Quit() <-chan struct{}

Quit returns a channel that will be closed when the worker stops.

func (*Node) Start

func (n *Node) Start() error

Start causes the worker to start responding to tendermint new block events.

func (*Node) Stop

func (n *Node) Stop()

Stop causes the worker to stop watching and shut down.