Documentation
¶
Overview ¶
Copyright IBM Corp. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0 Modifications Copyright National Payments Corporation of India
Index ¶
- func CreateNextBlock(rl Reader, messages []*cb.Envelope) *cb.Block
- func GetBlock(rl Reader, index uint64) *cb.Block
- func GetBlockByNumber(rl Reader, blockNum uint64) (*cb.Block, error)
- type Factory
- type Iterator
- type NotFoundErrorIterator
- type ReadWriter
- type Reader
- type SparseEnabledReadWriter
- type SparseMetadataReadWriter
- type Writer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateNextBlock ¶
CreateNextBlock provides a utility way to construct the next block from contents and metadata for a given ledger XXX This will need to be modified to accept marshaled envelopes
to accommodate non-deterministic marshaling
Types ¶
type Factory ¶
type Factory interface {
// GetOrCreate gets an existing ledger (if it exists)
// or creates it if it does not
GetOrCreate(channelID string) (ReadWriter, error)
// Remove removes an existing ledger
Remove(channelID string) error
// ChannelIDs returns the channel IDs the Factory is aware of
ChannelIDs() []string
// Close releases all resources acquired by the factory
Close()
}
Factory retrieves or creates new ledgers by channelID
type Iterator ¶
type Iterator interface {
// Next blocks until there is a new block available, or returns an error if
// the next block is no longer retrievable
Next() (*cb.Block, cb.Status)
// Close releases resources acquired by the Iterator
Close()
}
Iterator is useful for a chain Reader to stream blocks as they are created
type NotFoundErrorIterator ¶
type NotFoundErrorIterator struct{}
NotFoundErrorIterator simply always returns an error of cb.Status_NOT_FOUND, and is generally useful for implementations of the Reader interface
func (*NotFoundErrorIterator) Next ¶
func (nfei *NotFoundErrorIterator) Next() (*cb.Block, cb.Status)
Next returns nil, cb.Status_NOT_FOUND
func (*NotFoundErrorIterator) ReadyChan ¶
func (nfei *NotFoundErrorIterator) ReadyChan() <-chan struct{}
ReadyChan returns a closed channel
type ReadWriter ¶
ReadWriter encapsulates the read/write functions of the ledger
type Reader ¶
type Reader interface {
// Iterator returns an Iterator, as specified by an ab.SeekInfo message, and
// its starting block number
Iterator(startType *ab.SeekPosition) (Iterator, uint64)
// Height returns the number of blocks on the ledger
Height() uint64
// retrieve blockByNumber
RetrieveBlockByNumber(blockNumber uint64) (*cb.Block, error)
}
Reader allows the caller to inspect the ledger
type SparseEnabledReadWriter ¶
type SparseEnabledReadWriter interface {
ReadWriter
SparseMetadataReadWriter
}
type SparseMetadataReadWriter ¶
type SparseMetadataReadWriter interface {
AppendOrgMerkleInfo(key []byte, orgVal []byte) error
AppendOrgBlockIndex(key []byte, orgVal []byte) error
SaveChannelHeadInfo(key []byte, orgVal []byte) error
GetOrgMetaValue(key []byte) ([]byte, error)
AppendSavePoint(key []byte, num []byte) error
GetSavePoint(key []byte) ([]byte, error)
GetSparseChannel() (chan *cb.Block, error) //spbc
}
DRUNIX: