▽

Documents Packages The Project Help Blog

Package ledger

type Ledger ¶

Ledger captures the methods that are common across the 'PeerLedger', 'OrdererLedger', and 'ValidatedLedger'

type Ledger interface {
    // GetBlockchainInfo returns basic info about blockchain
    GetBlockchainInfo() (*common.BlockchainInfo, error)
    // GetBlockByNumber returns block at a given height
    // blockNumber of  math.MaxUint64 will return last block
    GetBlockByNumber(blockNumber uint64) (*common.Block, error)
    // GetBlocksIterator returns an iterator that starts from `startBlockNumber`(inclusive).
    // The iterator is a blocking iterator i.e., it blocks till the next block gets available in the ledger
    // ResultsIterator contains type BlockHolder
    GetBlocksIterator(startBlockNumber uint64) (ResultsIterator, error)
    // Close closes the ledger
    Close()
}

type PrunePolicy ¶

PrunePolicy - a general interface for supporting different pruning policies

type PrunePolicy interface{}

type QueryResult ¶

QueryResult - a general interface for supporting different types of query results. Actual types differ for different queries

type QueryResult interface{}

type QueryResultsIterator ¶

QueryResultsIterator - an iterator for query result set

type QueryResultsIterator interface {
    ResultsIterator
    GetBookmarkAndClose() string
}

type ResultsIterator ¶

ResultsIterator - an iterator for query result set

type ResultsIterator interface {
    // Next returns the next item in the result set. The `QueryResult` is expected to be nil when
    // the iterator gets exhausted
    Next() (QueryResult, error)
    // Close releases resources occupied by the iterator
    Close()
}

Subdirectories