▽

Documents Packages The Project Help Blog

Package blkstorage

Constants

constants for indexable attributes

const (
    IndexableAttrBlockNum         = IndexableAttr("BlockNum")
    IndexableAttrBlockHash        = IndexableAttr("BlockHash")
    IndexableAttrTxID             = IndexableAttr("TxID")
    IndexableAttrBlockNumTranNum  = IndexableAttr("BlockNumTranNum")
    IndexableAttrBlockTxID        = IndexableAttr("BlockTxID")
    IndexableAttrTxValidationCode = IndexableAttr("TxValidationCode")
)

Variables

var (
    // ErrNotFoundInIndex is used to indicate missing entry in the index
    ErrNotFoundInIndex = l.NotFoundInIndexErr("")

    // ErrAttrNotIndexed is used to indicate that an attribute is not indexed
    ErrAttrNotIndexed = errors.New("attribute not indexed")
)

type BlockStore ¶

BlockStore - an interface for persisting and retrieving blocks An implementation of this interface is expected to take an argument of type `IndexConfig` which configures the block store on what items should be indexed

type BlockStore interface {
    AddBlock(block *common.Block) error
    GetBlockchainInfo() (*common.BlockchainInfo, error)
    RetrieveBlocks(startNum uint64) (ledger.ResultsIterator, error)
    RetrieveBlockByHash(blockHash []byte) (*common.Block, error)
    RetrieveBlockByNumber(blockNum uint64) (*common.Block, error) // blockNum of  math.MaxUint64 will return last block
    RetrieveTxByID(txID string) (*common.Envelope, error)
    RetrieveTxByBlockNumTranNum(blockNum uint64, tranNum uint64) (*common.Envelope, error)
    RetrieveBlockByTxID(txID string) (*common.Block, error)
    RetrieveTxValidationCodeByTxID(txID string) (peer.TxValidationCode, error)
    Shutdown()
}

type BlockStoreProvider ¶

BlockStoreProvider provides an handle to a BlockStore

type BlockStoreProvider interface {
    CreateBlockStore(ledgerid string) (BlockStore, error)
    OpenBlockStore(ledgerid string) (BlockStore, error)
    Exists(ledgerid string) (bool, error)
    List() ([]string, error)
    Close()
}

type IndexConfig ¶

IndexConfig - a configuration that includes a list of attributes that should be indexed

type IndexConfig struct {
    AttrsToIndex []IndexableAttr
}

type IndexableAttr ¶

IndexableAttr represents an indexable attribute

type IndexableAttr string

Subdirectories