factory

Documentation

Index

• Constants
• Variables
• func NewHistoryStateReader(sf Factory, h uint64) protocol.StateReader
• func NewMinter(f Factory, ap actpool.ActPool) blockchain.BlockBuilderFactory
• type Factory
  • func NewFactory(cfg config.Config, opts ...Option) (Factory, error)
  • func NewStateDB(cfg config.Config, opts ...StateDBOption) (Factory, error)
• type Option
  • func DefaultTrieOption() Option
  • func InMemTrieOption() Option
  • func PrecreatedTrieDBOption(kv db.KVStore) Option
  • func RegistryOption(reg *protocol.Registry) Option
  • func SkipBlockValidationOption() Option
• type StateDBOption
  • func DefaultStateDBOption() StateDBOption
  • func InMemStateDBOption() StateDBOption
  • func PrecreatedStateDBOption(kv db.KVStore) StateDBOption
  • func RegistryStateDBOption(reg *protocol.Registry) StateDBOption
  • func SkipBlockValidationStateDBOption() StateDBOption

Constants

const (
	// AccountKVNamespace is the bucket name for account
	AccountKVNamespace = "Account"
	// ArchiveNamespacePrefix is the prefix of the buckets storing history data
	ArchiveNamespacePrefix = "Archive"
	// CurrentHeightKey indicates the key of current factory height in underlying DB
	CurrentHeightKey = "currentHeight"
	// ArchiveTrieNamespace is the bucket for the latest state view
	ArchiveTrieNamespace = "AccountTrie"
	// ArchiveTrieRootKey indicates the key of accountTrie root hash in underlying DB
	ArchiveTrieRootKey = "archiveTrieRoot"
)

Variables

var (
	// ErrNotSupported is the error that the statedb is not for archive mode
	ErrNotSupported = errors.New("not supported")
	// ErrNoArchiveData is the error that the node have no archive data
	ErrNoArchiveData = errors.New("no archive data")
)

Functions

func NewHistoryStateReader

func NewHistoryStateReader(sf Factory, h uint64) protocol.StateReader

NewHistoryStateReader creates new history state reader by given state factory and height

func NewMinter

func NewMinter(f Factory, ap actpool.ActPool) blockchain.BlockBuilderFactory

NewMinter creates a wrapper instance

Types

type Factory

type Factory interface {
	lifecycle.StartStopper
	protocol.StateReader
	Register(protocol.Protocol) error
	Validate(context.Context, *block.Block) error
	// NewBlockBuilder creates block builder
	NewBlockBuilder(context.Context, actpool.ActPool, func(action.Envelope) (action.SealedEnvelope, error)) (*block.Builder, error)
	SimulateExecution(context.Context, address.Address, *action.Execution, evm.GetBlockHash) ([]byte, *action.Receipt, error)
	PutBlock(context.Context, *block.Block) error
	DeleteTipBlock(*block.Block) error
	StateAtHeight(uint64, interface{}, ...protocol.StateOption) error
	StatesAtHeight(uint64, ...protocol.StateOption) (state.Iterator, error)
}

Factory defines an interface for managing states

func NewFactory

func NewFactory(cfg config.Config, opts ...Option) (Factory, error)

NewFactory creates a new state factory

func NewStateDB

func NewStateDB(cfg config.Config, opts ...StateDBOption) (Factory, error)

NewStateDB creates a new state db

type Option

type Option func(*factory, config.Config) error

Option sets Factory construction parameter

func DefaultTrieOption

func DefaultTrieOption() Option

DefaultTrieOption creates trie from config for state factory

func InMemTrieOption

func InMemTrieOption() Option

InMemTrieOption creates in memory trie for state factory

func PrecreatedTrieDBOption

func PrecreatedTrieDBOption(kv db.KVStore) Option

PrecreatedTrieDBOption uses pre-created trie DB for state factory

func RegistryOption

func RegistryOption(reg *protocol.Registry) Option

RegistryOption sets the registry in state db

func SkipBlockValidationOption

func SkipBlockValidationOption() Option

SkipBlockValidationOption skips block validation on PutBlock

type StateDBOption

type StateDBOption func(*stateDB, config.Config) error

StateDBOption sets stateDB construction parameter

func DefaultStateDBOption

func DefaultStateDBOption() StateDBOption

DefaultStateDBOption creates default state db from config

func InMemStateDBOption

func InMemStateDBOption() StateDBOption

InMemStateDBOption creates in memory state db

func PrecreatedStateDBOption

func PrecreatedStateDBOption(kv db.KVStore) StateDBOption

PrecreatedStateDBOption uses pre-created state db

func RegistryStateDBOption

func RegistryStateDBOption(reg *protocol.Registry) StateDBOption

RegistryStateDBOption sets the registry in state db

func SkipBlockValidationStateDBOption

func SkipBlockValidationStateDBOption() StateDBOption

SkipBlockValidationStateDBOption skips block validation on PutBlock