store

Documentation

Overview

XXX: This package may be internalized (made private) in the future releases.

Index

• Constants
• func LoadBlockStoreState(db dbm.DB) cmtstore.BlockStoreState
• func SaveBlockStoreState(bsj *cmtstore.BlockStoreState, batch dbm.Batch)
• type BlockKeyLayout
• type BlockStore
  • func NewBlockStore(db dbm.DB, options ...BlockStoreOption) *BlockStore
  • func (bs *BlockStore) Base() int64
  • func (bs *BlockStore) Close() error
  • func (bs *BlockStore) DeleteLatestBlock() error
  • func (bs *BlockStore) GetVersion() string
  • func (bs *BlockStore) Height() int64
  • func (bs *BlockStore) IsEmpty() bool
  • func (bs *BlockStore) LoadBaseMeta() *types.BlockMeta
  • func (bs *BlockStore) LoadBlock(height int64) (*types.Block, *types.BlockMeta)
  • func (bs *BlockStore) LoadBlockByHash(hash []byte) (*types.Block, *types.BlockMeta)
  • func (bs *BlockStore) LoadBlockCommit(height int64) *types.Commit
  • func (bs *BlockStore) LoadBlockExtendedCommit(height int64) *types.ExtendedCommit
  • func (bs *BlockStore) LoadBlockMeta(height int64) *types.BlockMeta
  • func (bs *BlockStore) LoadBlockMetaByHash(hash []byte) *types.BlockMeta
  • func (bs *BlockStore) LoadBlockPart(height int64, index int) *types.Part
  • func (bs *BlockStore) LoadSeenCommit(height int64) *types.Commit
  • func (bs *BlockStore) PruneBlocks(height int64, state sm.State) (uint64, int64, error)
  • func (bs *BlockStore) SaveBlock(block *types.Block, blockParts *types.PartSet, seenCommit *types.Commit)
  • func (bs *BlockStore) SaveBlockWithExtendedCommit(block *types.Block, blockParts *types.PartSet, ...)
  • func (bs *BlockStore) SaveSeenCommit(height int64, seenCommit *types.Commit) error
  • func (bs *BlockStore) Size() int64
• type BlockStoreOption
  • func WithCompaction(compact bool, compactionInterval int64) BlockStoreOption
  • func WithDBKeyLayout(dbKeyLayout string) BlockStoreOption
  • func WithMetrics(metrics *Metrics) BlockStoreOption
• type Metrics
  • func NopMetrics() *Metrics
  • func PrometheusMetrics(namespace string, labelsAndValues ...string) *Metrics

Constants

const (
	// MetricsSubsystem is a subsystem shared by all metrics exposed by this
	// package.
	MetricsSubsystem = "store"
)

Functions

func LoadBlockStoreState

func LoadBlockStoreState(db dbm.DB) cmtstore.BlockStoreState

LoadBlockStoreState returns the BlockStoreState as loaded from disk. If no BlockStoreState was previously persisted, it returns the zero value.

func SaveBlockStoreState

func SaveBlockStoreState(bsj *cmtstore.BlockStoreState, batch dbm.Batch)

SaveBlockStoreState persists the blockStore state to the database.

Types

type BlockKeyLayout

type BlockKeyLayout interface {
	CalcBlockMetaKey(height int64) []byte

	CalcBlockPartKey(height int64, partIndex int) []byte

	CalcBlockCommitKey(height int64) []byte

	CalcSeenCommitKey(height int64) []byte

	CalcExtCommitKey(height int64) []byte

	CalcBlockHashKey(hash []byte) []byte
}

type BlockStore

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

BlockStore is a simple low level store for blocks.

There are three types of information stored:

• BlockMeta: Meta information about each block
• Block part: Parts of each block, aggregated w/ PartSet
• Commit: The commit part of each block, for gossiping precommit votes

Currently the precommit signatures are duplicated in the Block parts as well as the Commit. In the future this may change, perhaps by moving the Commit data outside the Block. (TODO)

The store can be assumed to contain all contiguous blocks between base and height (inclusive).

// NOTE: BlockStore methods will panic if they encounter errors // deserializing loaded data, indicating probable corruption on disk.

func NewBlockStore

func NewBlockStore(db dbm.DB, options ...BlockStoreOption) *BlockStore

NewBlockStore returns a new BlockStore with the given DB, initialized to the last height that was committed to the DB.

func (*BlockStore) Base

func (bs *BlockStore) Base() int64

Base returns the first known contiguous block height, or 0 for empty block stores.

func (*BlockStore) Close

func (bs *BlockStore) Close() error

func (*BlockStore) DeleteLatestBlock

func (bs *BlockStore) DeleteLatestBlock() error

DeleteLatestBlock removes the block pointed to by height, lowering height by one.

func (*BlockStore) GetVersion

func (bs *BlockStore) GetVersion() string

func (*BlockStore) Height

func (bs *BlockStore) Height() int64

Height returns the last known contiguous block height, or 0 for empty block stores.

func (*BlockStore) IsEmpty

func (bs *BlockStore) IsEmpty() bool

func (*BlockStore) LoadBaseMeta

func (bs *BlockStore) LoadBaseMeta() *types.BlockMeta

LoadBase atomically loads the base block meta, or returns nil if no base is found.

func (*BlockStore) LoadBlock

func (bs *BlockStore) LoadBlock(height int64) (*types.Block, *types.BlockMeta)

LoadBlock returns the block with the given height. If no block is found for that height, it returns nil.

func (*BlockStore) LoadBlockByHash

func (bs *BlockStore) LoadBlockByHash(hash []byte) (*types.Block, *types.BlockMeta)

LoadBlockByHash returns the block with the given hash. If no block is found for that hash, it returns nil. Panics if it fails to parse height associated with the given hash.

func (*BlockStore) LoadBlockCommit

func (bs *BlockStore) LoadBlockCommit(height int64) *types.Commit

LoadBlockCommit returns the Commit for the given height. This commit consists of the +2/3 and other Precommit-votes for block at `height`, and it comes from the block.LastCommit for `height+1`. If no commit is found for the given height, it returns nil.

func (*BlockStore) LoadBlockExtendedCommit

func (bs *BlockStore) LoadBlockExtendedCommit(height int64) *types.ExtendedCommit

LoadExtendedCommit returns the ExtendedCommit for the given height. The extended commit is not guaranteed to contain the same +2/3 precommits data as the commit in the block.

func (*BlockStore) LoadBlockMeta

func (bs *BlockStore) LoadBlockMeta(height int64) *types.BlockMeta

LoadBlockMeta returns the BlockMeta for the given height. If no block is found for the given height, it returns nil.

func (*BlockStore) LoadBlockMetaByHash

func (bs *BlockStore) LoadBlockMetaByHash(hash []byte) *types.BlockMeta

LoadBlockMetaByHash returns the blockmeta who's header corresponds to the given hash. If none is found, returns nil.

func (*BlockStore) LoadBlockPart

func (bs *BlockStore) LoadBlockPart(height int64, index int) *types.Part

LoadBlockPart returns the Part at the given index from the block at the given height. If no part is found for the given height and index, it returns nil.

func (*BlockStore) LoadSeenCommit

func (bs *BlockStore) LoadSeenCommit(height int64) *types.Commit

LoadSeenCommit returns the locally seen Commit for the given height. This is useful when we've seen a commit, but there has not yet been a new block at `height + 1` that includes this commit in its block.LastCommit.

func (*BlockStore) PruneBlocks

func (bs *BlockStore) PruneBlocks(height int64, state sm.State) (uint64, int64, error)

PruneBlocks removes block up to (but not including) a height. It returns the number of blocks pruned and the evidence retain height - the height at which data needed to prove evidence must not be removed.

func (*BlockStore) SaveBlock

func (bs *BlockStore) SaveBlock(block *types.Block, blockParts *types.PartSet, seenCommit *types.Commit)

SaveBlock persists the given block, blockParts, and seenCommit to the underlying db. blockParts: Must be parts of the block seenCommit: The +2/3 precommits that were seen which committed at height.

If all the nodes restart after committing a block,
we need this to reload the precommits to catch-up nodes to the
most recent height.  Otherwise they'd stall at H-1.

func (*BlockStore) SaveBlockWithExtendedCommit

func (bs *BlockStore) SaveBlockWithExtendedCommit(block *types.Block, blockParts *types.PartSet, seenExtendedCommit *types.ExtendedCommit)

SaveBlockWithExtendedCommit persists the given block, blockParts, and seenExtendedCommit to the underlying db. seenExtendedCommit is stored under two keys in the database: as the seenCommit and as the ExtendedCommit data for the height. This allows the vote extension data to be persisted for all blocks that are saved.

func (*BlockStore) SaveSeenCommit

func (bs *BlockStore) SaveSeenCommit(height int64, seenCommit *types.Commit) error

SaveSeenCommit saves a seen commit, used by e.g. the state sync reactor when bootstrapping node.

func (*BlockStore) Size

func (bs *BlockStore) Size() int64

Size returns the number of blocks in the block store.

type BlockStoreOption

type BlockStoreOption func(*BlockStore)

func WithCompaction

func WithCompaction(compact bool, compactionInterval int64) BlockStoreOption

WithCompaction sets the compaciton parameters.

func WithDBKeyLayout

func WithDBKeyLayout(dbKeyLayout string) BlockStoreOption

WithDBKeyLayout the metrics.

func WithMetrics

func WithMetrics(metrics *Metrics) BlockStoreOption

WithMetrics sets the metrics.

type Metrics

type Metrics struct {
	// The duration of accesses to the state store labeled by which method
	// was called on the store.
	BlockStoreAccessDurationSeconds metrics.Histogram `metrics_bucketsizes:"0.0002, 10, 5" metrics_buckettype:"exp" metrics_labels:"method"`
}

Metrics contains metrics exposed by this package.

func NopMetrics

func NopMetrics() *Metrics

func PrometheusMetrics

func PrometheusMetrics(namespace string, labelsAndValues ...string) *Metrics