RWSet Preparation

Resolves hyperledger#3025 Signed-off-by: Julian Castrence <juliancastrence@ibm.com>
stanaly · Jun 30, 2022 · e235d41 · e235d41
1 parent d2f0adb
commit e235d41
Show file tree

Hide file tree

Showing 10 changed files with 373 additions and 1 deletion.
diff --git a/core/chaincode/mock/tx_simulator.go b/core/chaincode/mock/tx_simulator.go
diff --git a/core/endorser/fake/tx_simulator.go b/core/endorser/fake/tx_simulator.go
diff --git a/core/ledger/kvledger/txmgmt/rwsetutil/rwset_builder.go b/core/ledger/kvledger/txmgmt/rwsetutil/rwset_builder.go
@@ -116,6 +116,12 @@ func (b *RWSetBuilder) AddToPvtAndHashedWriteSet(ns string, coll string, key str
 	b.getOrCreateCollHashedRwBuilder(ns, coll).writeMap[key] = kvWriteHash
 }
 
+// AddToHashedWriteSetPurge adds a purge key to the hashed write-set
+func (b *RWSetBuilder) AddToHashedWriteSetPurge(ns string, coll string, key string) {
+	kvWriteHashPurge := newKVWriteHashPurge(key)
+	b.getOrCreateCollHashedRwBuilder(ns, coll).writeMap[key] = kvWriteHashPurge
+}
+
 // AddToHashedMetadataWriteSet adds a metadata to a key in the hashed write-set
 func (b *RWSetBuilder) AddToHashedMetadataWriteSet(ns, coll, key string, metadata map[string][]byte) {
 	// pvt write set just need the key; not the entire metadata. The metadata is stored only

diff --git a/core/ledger/kvledger/txmgmt/rwsetutil/rwset_builder_test.go b/core/ledger/kvledger/txmgmt/rwsetutil/rwset_builder_test.go
@@ -99,6 +99,9 @@ func TestTxSimulationResultWithPvtData(t *testing.T) {
 	rwSetBuilder.AddToHashedReadSet("ns2", "coll1", "key2", version.NewHeight(1, 1))
 	rwSetBuilder.AddToPvtAndHashedWriteSet("ns2", "coll2", "key1", []byte("pvt-ns2-coll2-key1-value"))
 
+	// pvt rwset ns3
+	rwSetBuilder.AddToHashedWriteSetPurge("ns3", "coll1", "key1")
+
 	actualSimRes, err := rwSetBuilder.GetTxSimulationResults()
 	require.NoError(t, err)
 
@@ -151,6 +154,8 @@ func TestTxSimulationResultWithPvtData(t *testing.T) {
 		Writes: []*kvrwset.KVWrite{newKVWrite("key1", []byte("ns2-key1-value"))},
 	}
 
+	pubNs3 := &kvrwset.KVRWSet{}
+
 	hashedNs1Coll1 := &kvrwset.HashedRWSet{
 		HashedReads: []*kvrwset.KVReadHash{
 			constructTestPvtKVReadHash(t, "key1", version.NewHeight(1, 1)),
@@ -179,6 +184,12 @@ func TestTxSimulationResultWithPvtData(t *testing.T) {
 		},
 	}
 
+	hashedNs3Coll1 := &kvrwset.HashedRWSet{
+		HashedWrites: []*kvrwset.KVWriteHash{
+			constructTestKVWriteHashPurge(t, "key1"),
+		},
+	}
+
 	combinedNs1 := &rwset.NsReadWriteSet{
 		Namespace: "ns1",
 		Rwset:     serializeTestProtoMsg(t, pubNs1),
@@ -212,9 +223,22 @@ func TestTxSimulationResultWithPvtData(t *testing.T) {
 		},
 	}
 	require.Equal(t, combinedNs2, actualSimRes.PubSimulationResults.NsRwset[1])
+
+	combinedNs3 := &rwset.NsReadWriteSet{
+		Namespace: "ns3",
+		Rwset:     serializeTestProtoMsg(t, pubNs3),
+		CollectionHashedRwset: []*rwset.CollectionHashedReadWriteSet{
+			{
+				CollectionName: "coll1",
+				HashedRwset:    serializeTestProtoMsg(t, hashedNs3Coll1),
+			},
+		},
+	}
+	require.Equal(t, combinedNs3, actualSimRes.PubSimulationResults.NsRwset[2])
+
 	expectedPubRWSet := &rwset.TxReadWriteSet{
 		DataModel: rwset.TxReadWriteSet_KV,
-		NsRwset:   []*rwset.NsReadWriteSet{combinedNs1, combinedNs2},
+		NsRwset:   []*rwset.NsReadWriteSet{combinedNs1, combinedNs2, combinedNs3},
 	}
 	require.Equal(t, expectedPubRWSet, actualSimRes.PubSimulationResults)
 }
@@ -356,6 +380,10 @@ func constructTestPvtKVWriteHash(t *testing.T, key string, value []byte) *kvrwse
 	return kvWriteHash
 }
 
+func constructTestKVWriteHashPurge(t *testing.T, key string) *kvrwset.KVWriteHash {
+	return newKVWriteHashPurge(key)
+}
+
 func serializeTestProtoMsg(t *testing.T, protoMsg proto.Message) []byte {
 	msgBytes, err := proto.Marshal(protoMsg)
 	require.NoError(t, err)

diff --git a/core/ledger/kvledger/txmgmt/rwsetutil/rwset_proto_util.go b/core/ledger/kvledger/txmgmt/rwsetutil/rwset_proto_util.go
@@ -362,6 +362,11 @@ func newPvtKVWriteAndHash(key string, value []byte) (*kvrwset.KVWrite, *kvrwset.
 	return kvWrite, &kvrwset.KVWriteHash{KeyHash: keyHash, IsDelete: kvWrite.IsDelete, ValueHash: valueHash}
 }
 
+func newKVWriteHashPurge(key string) *kvrwset.KVWriteHash {
+	keyHash := util.ComputeStringHash(key)
+	return &kvrwset.KVWriteHash{KeyHash: keyHash, IsDelete: true, IsPurge: true}
+}
+
 // IsKVWriteDelete returns true if the kvWrite indicates a delete operation. See FAB-18386 for details.
 func IsKVWriteDelete(kvWrite *kvrwset.KVWrite) bool {
 	return kvWrite.IsDelete || len(kvWrite.Value) == 0

diff --git a/core/ledger/kvledger/txmgmt/rwsetutil/rwset_proto_util_test.go b/core/ledger/kvledger/txmgmt/rwsetutil/rwset_proto_util_test.go
@@ -245,6 +245,16 @@ func TestVersionConversion(t *testing.T) {
 	require.Equal(t, protoVer, newProtoVersion(internalVer))
 }
 
+func TestNewKVWriteHashPurge(t *testing.T) {
+	sampleKey := "purge-key1"
+	sampleKVWriteHash := &kvrwset.KVWriteHash{
+		KeyHash:  util.ComputeStringHash(sampleKey),
+		IsDelete: true,
+		IsPurge:  true,
+	}
+	require.Equal(t, sampleKVWriteHash, newKVWriteHashPurge(sampleKey))
+}
+
 func TestIsDelete(t *testing.T) {
 	t.Run("kvWrite", func(t *testing.T) {
 		kvWritesToBeInterpretedAsDelete := []*kvrwset.KVWrite{

diff --git a/core/ledger/kvledger/txmgmt/txmgr/tx_simulator.go b/core/ledger/kvledger/txmgmt/txmgr/tx_simulator.go
@@ -118,6 +118,19 @@ func (s *txSimulator) DeletePrivateData(ns, coll, key string) error {
 	return s.SetPrivateData(ns, coll, key, nil)
 }
 
+// PurgePrivateData implements method in interface `ledger.TxSimulator`
+func (s *txSimulator) PurgePrivateData(ns, coll, key string) error {
+	if err := s.queryExecutor.validateCollName(ns, coll); err != nil {
+		return err
+	}
+	if err := s.checkWritePrecondition(key, nil); err != nil {
+		return err
+	}
+	s.writePerformed = true
+	s.rwsetBuilder.AddToHashedWriteSetPurge(ns, coll, key)
+	return nil
+}
+
 // SetPrivateDataMultipleKeys implements method in interface `ledger.TxSimulator`
 func (s *txSimulator) SetPrivateDataMultipleKeys(ns, coll string, kvs map[string][]byte) error {
 	for k, v := range kvs {