fabric: github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/privacyenabledstate Index | Files

package privacyenabledstate

import "github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/privacyenabledstate"

Package privacyenabledstate is a generated protocol buffer package.

It is generated from these files:

update_batch.proto

It has these top-level messages:

KVWriteProto
KVWritesBatchProto

Index

Package Files

common_storage_db.go db.go optimization.go test_exports.go update_batch.pb.go update_batch_bytes.go

type CommonStorageDB Uses

type CommonStorageDB struct {
    statedb.VersionedDB
    // contains filtered or unexported fields
}

CommonStorageDB implements interface DB. This implementation uses a single database to maintain both the public and private data

func (*CommonStorageDB) ApplyPrivacyAwareUpdates Uses

func (s *CommonStorageDB) ApplyPrivacyAwareUpdates(updates *UpdateBatch, height *version.Height) error

ApplyPrivacyAwareUpdates implements corresponding function in interface DB

func (*CommonStorageDB) ApplyUpdates Uses

func (s *CommonStorageDB) ApplyUpdates(batch *statedb.UpdateBatch, height *version.Height) error

ApplyUpdates overrides the function in statedb.VersionedDB and throws appropriate error message Otherwise, somewhere in the code, usage of this function could lead to updating only public data.

func (*CommonStorageDB) ChaincodeDeployDone Uses

func (s *CommonStorageDB) ChaincodeDeployDone(succeeded bool)

ChaincodeDeployDone is a noop for couchdb state impl

func (*CommonStorageDB) ClearCachedVersions Uses

func (s *CommonStorageDB) ClearCachedVersions()

ClearCachedVersions implements corresponding function in interface DB

func (CommonStorageDB) ExecuteQueryOnPrivateData Uses

func (s CommonStorageDB) ExecuteQueryOnPrivateData(namespace, collection, query string) (statedb.ResultsIterator, error)

ExecuteQueryOnPrivateData implements corresponding function in interface DB

func (*CommonStorageDB) GetCachedKeyHashVersion Uses

func (s *CommonStorageDB) GetCachedKeyHashVersion(namespace, collection string, keyHash []byte) (*version.Height, bool)

GetCachedKeyHashVersion retrieves the keyhash version from cache

func (*CommonStorageDB) GetChaincodeEventListener Uses

func (s *CommonStorageDB) GetChaincodeEventListener() cceventmgmt.ChaincodeLifecycleEventListener

GetChaincodeEventListener implements corresponding function in interface DB

func (*CommonStorageDB) GetKeyHashVersion Uses

func (s *CommonStorageDB) GetKeyHashVersion(namespace, collection string, keyHash []byte) (*version.Height, error)

GetKeyHashVersion implements corresponding function in interface DB

func (*CommonStorageDB) GetPrivateData Uses

func (s *CommonStorageDB) GetPrivateData(namespace, collection, key string) (*statedb.VersionedValue, error)

GetPrivateData implements corresponding function in interface DB

func (*CommonStorageDB) GetPrivateDataMetadataByHash Uses

func (s *CommonStorageDB) GetPrivateDataMetadataByHash(namespace, collection string, keyHash []byte) ([]byte, error)

GetPrivateDataMetadataByHash implements corresponding function in interface DB. For additional details, see description of the similar function 'GetStateMetadata'

func (*CommonStorageDB) GetPrivateDataMultipleKeys Uses

func (s *CommonStorageDB) GetPrivateDataMultipleKeys(namespace, collection string, keys []string) ([]*statedb.VersionedValue, error)

GetPrivateDataMultipleKeys implements corresponding function in interface DB

func (*CommonStorageDB) GetPrivateDataRangeScanIterator Uses

func (s *CommonStorageDB) GetPrivateDataRangeScanIterator(namespace, collection, startKey, endKey string) (statedb.ResultsIterator, error)

GetPrivateDataRangeScanIterator implements corresponding function in interface DB

func (*CommonStorageDB) GetStateMetadata Uses

func (s *CommonStorageDB) GetStateMetadata(namespace, key string) ([]byte, error)

GetStateMetadata implements corresponding function in interface DB. This implementation provides an optimization such that it keeps track if a namespaces has never stored metadata for any of its items, the value 'nil' is returned without going to the db. This is intended to be invoked in the validation and commit path. This saves the chaincodes from paying unnecessary performance penalty if they do not use features that leverage metadata (such as key-level endorsement),

func (*CommonStorageDB) GetValueHash Uses

func (s *CommonStorageDB) GetValueHash(namespace, collection string, keyHash []byte) (*statedb.VersionedValue, error)

GetValueHash implements corresponding function in interface DB

func (*CommonStorageDB) HandleChaincodeDeploy Uses

func (s *CommonStorageDB) HandleChaincodeDeploy(chaincodeDefinition *cceventmgmt.ChaincodeDefinition, dbArtifactsTar []byte) error

HandleChaincodeDeploy initializes database artifacts for the database associated with the namespace This function deliberately suppresses the errors that occur during the creation of the indexes on couchdb. This is because, in the present code, we do not differentiate between the errors because of couchdb interaction and the errors because of bad index files - the later being unfixable by the admin. Note that the error suppression is acceptable since peer can continue in the committing role without the indexes. However, executing chaincode queries may be affected, until a new chaincode with fixed indexes is installed and instantiated

func (*CommonStorageDB) IsBulkOptimizable Uses

func (s *CommonStorageDB) IsBulkOptimizable() bool

IsBulkOptimizable implements corresponding function in interface DB

func (*CommonStorageDB) LoadCommittedVersionsOfPubAndHashedKeys Uses

func (s *CommonStorageDB) LoadCommittedVersionsOfPubAndHashedKeys(pubKeys []*statedb.CompositeKey,
    hashedKeys []*HashedCompositeKey) error

LoadCommittedVersionsOfPubAndHashedKeys implements corresponding function in interface DB

type CommonStorageDBProvider Uses

type CommonStorageDBProvider struct {
    statedb.VersionedDBProvider
    HealthCheckRegistry ledger.HealthCheckRegistry
    // contains filtered or unexported fields
}

CommonStorageDBProvider implements interface DBProvider

func (*CommonStorageDBProvider) Close Uses

func (p *CommonStorageDBProvider) Close()

Close implements function from interface DBProvider

func (*CommonStorageDBProvider) GetDBHandle Uses

func (p *CommonStorageDBProvider) GetDBHandle(id string) (DB, error)

GetDBHandle implements function from interface DBProvider

func (*CommonStorageDBProvider) RegisterHealthChecker Uses

func (p *CommonStorageDBProvider) RegisterHealthChecker() error

type CouchDBCommonStorageTestEnv Uses

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

CouchDBCommonStorageTestEnv implements TestEnv interface for couchdb based storage

func (*CouchDBCommonStorageTestEnv) Cleanup Uses

func (env *CouchDBCommonStorageTestEnv) Cleanup()

Cleanup implements corresponding function from interface TestEnv

func (*CouchDBCommonStorageTestEnv) GetDBHandle Uses

func (env *CouchDBCommonStorageTestEnv) GetDBHandle(id string) DB

GetDBHandle implements corresponding function from interface TestEnv

func (*CouchDBCommonStorageTestEnv) GetName Uses

func (env *CouchDBCommonStorageTestEnv) GetName() string

GetName implements corresponding function from interface TestEnv

func (*CouchDBCommonStorageTestEnv) Init Uses

func (env *CouchDBCommonStorageTestEnv) Init(t testing.TB)

Init implements corresponding function from interface TestEnv

type DB Uses

type DB interface {
    statedb.VersionedDB
    IsBulkOptimizable() bool
    LoadCommittedVersionsOfPubAndHashedKeys(pubKeys []*statedb.CompositeKey, hashedKeys []*HashedCompositeKey) error
    GetCachedKeyHashVersion(namespace, collection string, keyHash []byte) (*version.Height, bool)
    ClearCachedVersions()
    GetChaincodeEventListener() cceventmgmt.ChaincodeLifecycleEventListener
    GetPrivateData(namespace, collection, key string) (*statedb.VersionedValue, error)
    GetValueHash(namespace, collection string, keyHash []byte) (*statedb.VersionedValue, error)
    GetKeyHashVersion(namespace, collection string, keyHash []byte) (*version.Height, error)
    GetPrivateDataMultipleKeys(namespace, collection string, keys []string) ([]*statedb.VersionedValue, error)
    GetPrivateDataRangeScanIterator(namespace, collection, startKey, endKey string) (statedb.ResultsIterator, error)
    GetStateMetadata(namespace, key string) ([]byte, error)
    GetPrivateDataMetadataByHash(namespace, collection string, keyHash []byte) ([]byte, error)
    ExecuteQueryOnPrivateData(namespace, collection, query string) (statedb.ResultsIterator, error)
    ApplyPrivacyAwareUpdates(updates *UpdateBatch, height *version.Height) error
}

DB extends VersionedDB interface. This interface provides additional functions for managing private data state

func NewCommonStorageDB Uses

func NewCommonStorageDB(vdb statedb.VersionedDB, ledgerid string, metadataHint *metadataHint) (DB, error)

NewCommonStorageDB wraps a VersionedDB instance. The public data is managed directly by the wrapped versionedDB. For managing the hashed data and private data, this implementation creates separate namespaces in the wrapped db

type DBProvider Uses

type DBProvider interface {
    // GetDBHandle returns a handle to a PvtVersionedDB
    GetDBHandle(id string) (DB, error)
    // Close closes all the PvtVersionedDB instances and releases any resources held by VersionedDBProvider
    Close()
}

DBProvider provides handle to a PvtVersionedDB

func NewCommonStorageDBProvider Uses

func NewCommonStorageDBProvider(bookkeeperProvider bookkeeping.Provider, metricsProvider metrics.Provider, healthCheckRegistry ledger.HealthCheckRegistry) (DBProvider, error)

NewCommonStorageDBProvider constructs an instance of DBProvider

type HashedCompositeKey Uses

type HashedCompositeKey struct {
    Namespace      string
    CollectionName string
    KeyHash        string
}

HashedCompositeKey encloses Namespace, CollectionName and KeyHash components

func (*HashedCompositeKey) String Uses

func (hck *HashedCompositeKey) String() string

String returns a print friendly form of HashedCompositeKey

type HashedUpdateBatch Uses

type HashedUpdateBatch struct {
    UpdateMap
}

HashedUpdateBatch contains updates for the hashes of the private data

func NewHashedUpdateBatch Uses

func NewHashedUpdateBatch() *HashedUpdateBatch

NewHashedUpdateBatch creates an empty HashedUpdateBatch

func (HashedUpdateBatch) Contains Uses

func (h HashedUpdateBatch) Contains(ns, coll string, keyHash []byte) bool

Contains returns true if the given <ns,coll,keyHash> tuple is present in the batch

func (HashedUpdateBatch) Delete Uses

func (h HashedUpdateBatch) Delete(ns, coll string, key []byte, version *version.Height)

Delete overrides the function in UpdateMap for allowing the key to be a []byte instead of a string

func (HashedUpdateBatch) Put Uses

func (h HashedUpdateBatch) Put(ns, coll string, key []byte, value []byte, version *version.Height)

Put overrides the function in UpdateMap for allowing the key to be a []byte instead of a string

func (HashedUpdateBatch) PutValHashAndMetadata Uses

func (h HashedUpdateBatch) PutValHashAndMetadata(ns, coll string, key []byte, value []byte, metadata []byte, version *version.Height)

PutValHashAndMetadata adds a key with value and metadata TODO introducing a new function to limit the refactoring. Later in a separate CR, the 'Put' function above should be removed

func (HashedUpdateBatch) ToCompositeKeyMap Uses

func (h HashedUpdateBatch) ToCompositeKeyMap() map[HashedCompositeKey]*statedb.VersionedValue

ToCompositeKeyMap rearranges the update batch data in the form of a single map

type KVWriteProto Uses

type KVWriteProto struct {
    Namespace    string `protobuf:"bytes,1,opt,name=namespace" json:"namespace,omitempty"`
    Collection   string `protobuf:"bytes,2,opt,name=collection" json:"collection,omitempty"`
    Key          []byte `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"`
    IsDelete     bool   `protobuf:"varint,4,opt,name=isDelete" json:"isDelete,omitempty"`
    Value        []byte `protobuf:"bytes,5,opt,name=value,proto3" json:"value,omitempty"`
    VersionBytes []byte `protobuf:"bytes,6,opt,name=version_bytes,json=versionBytes,proto3" json:"version_bytes,omitempty"`
}

func (*KVWriteProto) Descriptor Uses

func (*KVWriteProto) Descriptor() ([]byte, []int)

func (*KVWriteProto) GetCollection Uses

func (m *KVWriteProto) GetCollection() string

func (*KVWriteProto) GetIsDelete Uses

func (m *KVWriteProto) GetIsDelete() bool

func (*KVWriteProto) GetKey Uses

func (m *KVWriteProto) GetKey() []byte

func (*KVWriteProto) GetNamespace Uses

func (m *KVWriteProto) GetNamespace() string

func (*KVWriteProto) GetValue Uses

func (m *KVWriteProto) GetValue() []byte

func (*KVWriteProto) GetVersionBytes Uses

func (m *KVWriteProto) GetVersionBytes() []byte

func (*KVWriteProto) ProtoMessage Uses

func (*KVWriteProto) ProtoMessage()

func (*KVWriteProto) Reset Uses

func (m *KVWriteProto) Reset()

func (*KVWriteProto) String Uses

func (m *KVWriteProto) String() string

type KVWritesBatchProto Uses

type KVWritesBatchProto struct {
    Kvwrites []*KVWriteProto `protobuf:"bytes,1,rep,name=kvwrites" json:"kvwrites,omitempty"`
}

func (*KVWritesBatchProto) Descriptor Uses

func (*KVWritesBatchProto) Descriptor() ([]byte, []int)

func (*KVWritesBatchProto) GetKvwrites Uses

func (m *KVWritesBatchProto) GetKvwrites() []*KVWriteProto

func (*KVWritesBatchProto) ProtoMessage Uses

func (*KVWritesBatchProto) ProtoMessage()

func (*KVWritesBatchProto) Reset Uses

func (m *KVWritesBatchProto) Reset()

func (*KVWritesBatchProto) String Uses

func (m *KVWritesBatchProto) String() string

type LevelDBCommonStorageTestEnv Uses

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

LevelDBCommonStorageTestEnv implements TestEnv interface for leveldb based storage

func (*LevelDBCommonStorageTestEnv) Cleanup Uses

func (env *LevelDBCommonStorageTestEnv) Cleanup()

Cleanup implements corresponding function from interface TestEnv

func (*LevelDBCommonStorageTestEnv) GetDBHandle Uses

func (env *LevelDBCommonStorageTestEnv) GetDBHandle(id string) DB

GetDBHandle implements corresponding function from interface TestEnv

func (*LevelDBCommonStorageTestEnv) GetName Uses

func (env *LevelDBCommonStorageTestEnv) GetName() string

GetName implements corresponding function from interface TestEnv

func (*LevelDBCommonStorageTestEnv) Init Uses

func (env *LevelDBCommonStorageTestEnv) Init(t testing.TB)

Init implements corresponding function from interface TestEnv

type PubUpdateBatch Uses

type PubUpdateBatch struct {
    *statedb.UpdateBatch
}

PubUpdateBatch contains update for the public data

func NewPubUpdateBatch Uses

func NewPubUpdateBatch() *PubUpdateBatch

NewPubUpdateBatch creates an empty PubUpdateBatch

type PvtKVWrite Uses

type PvtKVWrite struct {
    Key      string
    IsDelete bool
    Value    []byte
    Version  *version.Height
}

PvtKVWrite encloses Key, IsDelete, Value, and Version components

type PvtUpdateBatch Uses

type PvtUpdateBatch struct {
    UpdateMap
}

PvtUpdateBatch contains updates for the private data

func NewPvtUpdateBatch Uses

func NewPvtUpdateBatch() *PvtUpdateBatch

NewPvtUpdateBatch creates an empty PvtUpdateBatch

func (PvtUpdateBatch) ToCompositeKeyMap Uses

func (p PvtUpdateBatch) ToCompositeKeyMap() PvtdataCompositeKeyMap

ToCompositeKeyMap rearranges the update batch data in the form of a single map

type PvtdataCompositeKey Uses

type PvtdataCompositeKey struct {
    Namespace      string
    CollectionName string
    Key            string
}

PvtdataCompositeKey encloses Namespace, CollectionName and Key components

type PvtdataCompositeKeyMap Uses

type PvtdataCompositeKeyMap map[PvtdataCompositeKey]*statedb.VersionedValue

PvtdataCompositeKeyMap is a map of PvtdataCompositeKey to VersionedValue

type TestEnv Uses

type TestEnv interface {
    Init(t testing.TB)
    GetDBHandle(id string) DB
    GetName() string
    Cleanup()
}

TestEnv - an interface that a test environment implements

type UpdateBatch Uses

type UpdateBatch struct {
    PubUpdates  *PubUpdateBatch
    HashUpdates *HashedUpdateBatch
    PvtUpdates  *PvtUpdateBatch
}

UpdateBatch encapsulates the updates to Public, Private, and Hashed data. This is expected to contain a consistent set of updates

func NewUpdateBatch Uses

func NewUpdateBatch() *UpdateBatch

NewUpdateBatch creates and empty UpdateBatch

type UpdateMap Uses

type UpdateMap map[string]nsBatch

UpdateMap maintains entries of tuple <Namespace, UpdatesForNamespace>

func (UpdateMap) Contains Uses

func (b UpdateMap) Contains(ns, coll, key string) bool

Contains returns true if the given <ns,coll,key> tuple is present in the batch

func (UpdateMap) Delete Uses

func (b UpdateMap) Delete(ns, coll, key string, version *version.Height)

Delete adds a delete marker in the batch for a given combination of namespace and collection name

func (UpdateMap) Get Uses

func (b UpdateMap) Get(ns, coll, key string) *statedb.VersionedValue

Get retrieves the value from the batch for a given combination of namespace and collection name

func (UpdateMap) IsEmpty Uses

func (b UpdateMap) IsEmpty() bool

IsEmpty returns true if there exists any updates

func (UpdateMap) Put Uses

func (b UpdateMap) Put(ns, coll, key string, value []byte, version *version.Height)

Put sets the value in the batch for a given combination of namespace and collection name

func (UpdateMap) PutValAndMetadata Uses

func (b UpdateMap) PutValAndMetadata(ns, coll, key string, value []byte, metadata []byte, version *version.Height)

PutValAndMetadata adds a key with value and metadata

type UpdatesBytesBuilder Uses

type UpdatesBytesBuilder struct {
}

func (*UpdatesBytesBuilder) DeterministicBytesForPubAndHashUpdates Uses

func (bb *UpdatesBytesBuilder) DeterministicBytesForPubAndHashUpdates(u *UpdateBatch) ([]byte, error)

DeterministicBytesForPubAndHashUpdates constructs the bytes for a given UpdateBatch while constructing the bytes, it considers only public writes and hashed writes for the collections. For achieving the determinism, it constructs a slice of proto messages of type 'KVWriteProto'. In the slice, all the writes for a namespace "ns1" appear before the writes for another namespace "ns2" if "ns1" < "ns2" (lexicographically). Within a namespace, all the public writes appear before the collection writes. Like namespaces, the collections writes within a namespace appear in the order of lexicographical order. If an entry has the same namespace as its preceding entry, the namespace field is skipped. A Similar treatment is given to the repetitive entries for a collection within a namespace. For illustration, see the corresponding unit tests

Package privacyenabledstate imports 29 packages (graph) and is imported by 8 packages. Updated 2019-10-01. Refresh now. Tools for package owners.