Documentation
¶
Index ¶
Constants ¶
const ( // AccountKVNamespace is the bucket name for account AccountKVNamespace = state.AccountKVNamespace // CurrentHeightKey indicates the key of current factory height in underlying DB CurrentHeightKey = "currentHeight" )
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") //DefaultConfig is the default config for state factory DefaultConfig = Config{ Chain: blockchain.DefaultConfig, Genesis: genesis.Default, } )
Functions ¶
func SetDiffCallback ¶ added in v2.3.7
func SetDiffCallback(f Factory, cb StateDiffCallback) bool
SetDiffCallback sets the state diff callback on a Factory. Returns false if the factory is not a stateDB (e.g., in-memory test factory).
Types ¶
type Config ¶
type Config struct {
Chain blockchain.Config
Genesis genesis.Genesis
}
Config contains the config for factory
func GenerateConfig ¶
func GenerateConfig(chain blockchain.Config, g genesis.Genesis) Config
GenerateConfig generates the factory config
type Factory ¶
type Factory interface {
lifecycle.StartStopper
protocol.StateReader
AddDependency(blockdao.BlockIndexer)
Register(protocol.Protocol) error
Validate(context.Context, *block.Block) error
Mint(context.Context, actpool.ActPool, crypto.PrivateKey) (*block.Block, error)
PutBlock(context.Context, *block.Block) error
WorkingSet(context.Context) (protocol.StateManagerWithCloser, error)
WorkingSetAtHeight(context.Context, uint64) (protocol.StateManagerWithCloser, error)
WorkingSetAtTransaction(context.Context, uint64, ...*action.SealedEnvelope) (protocol.StateManagerWithCloser, error)
StateReaderAt(blkHeight uint64, blkHash hash.Hash256) (protocol.StateReader, error)
}
Factory defines an interface for managing states
func NewStateDB ¶
NewStateDB creates a new state db
type MintOption ¶ added in v2.0.8
type MintOption func(*Minter)
MintOption defines an option to configure Minter
func WithTimeoutOption ¶ added in v2.0.8
func WithTimeoutOption(timeout time.Duration) MintOption
WithTimeoutOption sets the timeout for NewBlockBuilder
type Minter ¶ added in v2.2.0
type Minter struct {
// contains filtered or unexported fields
}
Minter is a wrapper of Factory to mint blocks
func NewMinter ¶
func NewMinter(f Factory, ap actpool.ActPool, opts ...MintOption) *Minter
NewMinter creates a wrapper instance
type StateDBOption ¶
StateDBOption sets stateDB construction parameter
func DiffCallbackStateDBOption ¶ added in v2.3.7
func DiffCallbackStateDBOption(cb StateDiffCallback) StateDBOption
DiffCallbackStateDBOption sets a callback invoked after each block commit with the block's state diff entries. Used by ioSwarm for state diff streaming.
func DisableWorkingSetCacheOption ¶
func DisableWorkingSetCacheOption() StateDBOption
DisableWorkingSetCacheOption disable workingset cache
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
type StateDiffCallback ¶ added in v2.3.7
type StateDiffCallback func(height uint64, entries []WriteQueueEntry, digest []byte)
StateDiffCallback is called after a block is committed with the captured state diff entries.
Source Files
Directories