fix(runtime/storage): support nested storage transactions (#3670)

Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Kirill <[email protected]> Co-authored-by: Diego Romero <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
ChainSafe · Jan 15, 2024 · 3e99f6d · 3e99f6d
1 parent f7e690f
commit 3e99f6d
Show file tree

Hide file tree

Showing 10 changed files with 276 additions and 163 deletions.
diff --git a/dot/core/service_test.go b/dot/core/service_test.go
@@ -126,7 +126,7 @@ func generateExtrinsic(t *testing.T) (extrinsic, externalExtrinsic types.Extrins
 func Test_Service_StorageRoot(t *testing.T) {
 	t.Parallel()
 
-	ts := rtstorage.NewTrieState(nil)
+	ts := rtstorage.NewTrieState(trie.NewEmptyTrie())
 
 	tests := []struct {
 		name          string
@@ -378,7 +378,7 @@ func Test_Service_handleBlock(t *testing.T) {
 
 	t.Run("storeTrie_error", func(t *testing.T) {
 		t.Parallel()
-		trieState := rtstorage.NewTrieState(nil)
+		trieState := rtstorage.NewTrieState(trie.NewEmptyTrie())
 
 		testHeader := types.NewEmptyHeader()
 		block := types.NewBlock(*testHeader, *types.NewBody([]types.Extrinsic{[]byte{21}}))
@@ -394,7 +394,7 @@ func Test_Service_handleBlock(t *testing.T) {
 
 	t.Run("addBlock_quit_error", func(t *testing.T) {
 		t.Parallel()
-		trieState := rtstorage.NewTrieState(nil)
+		trieState := rtstorage.NewTrieState(trie.NewEmptyTrie())
 
 		testHeader := types.NewEmptyHeader()
 		block := types.NewBlock(*testHeader, *types.NewBody([]types.Extrinsic{[]byte{21}}))
@@ -415,7 +415,7 @@ func Test_Service_handleBlock(t *testing.T) {
 
 	t.Run("addBlock_parent_not_found_error", func(t *testing.T) {
 		t.Parallel()
-		trieState := rtstorage.NewTrieState(nil)
+		trieState := rtstorage.NewTrieState(trie.NewEmptyTrie())
 
 		testHeader := types.NewEmptyHeader()
 		block := types.NewBlock(*testHeader, *types.NewBody([]types.Extrinsic{[]byte{21}}))
@@ -436,7 +436,7 @@ func Test_Service_handleBlock(t *testing.T) {
 
 	t.Run("addBlock_error_continue", func(t *testing.T) {
 		t.Parallel()
-		trieState := rtstorage.NewTrieState(nil)
+		trieState := rtstorage.NewTrieState(trie.NewEmptyTrie())
 
 		testHeader := types.NewEmptyHeader()
 		block := types.NewBlock(*testHeader, *types.NewBody([]types.Extrinsic{[]byte{21}}))
@@ -465,7 +465,7 @@ func Test_Service_handleBlock(t *testing.T) {
 
 	t.Run("handle_runtime_changes_error", func(t *testing.T) {
 		t.Parallel()
-		trieState := rtstorage.NewTrieState(nil)
+		trieState := rtstorage.NewTrieState(trie.NewEmptyTrie())
 
 		testHeader := types.NewEmptyHeader()
 		block := types.NewBlock(*testHeader, *types.NewBody([]types.Extrinsic{[]byte{21}}))
@@ -497,7 +497,7 @@ func Test_Service_handleBlock(t *testing.T) {
 
 	t.Run("code_substitution_ok", func(t *testing.T) {
 		t.Parallel()
-		trieState := rtstorage.NewTrieState(nil)
+		trieState := rtstorage.NewTrieState(trie.NewEmptyTrie())
 
 		testHeader := types.NewEmptyHeader()
 		block := types.NewBlock(*testHeader, *types.NewBody([]types.Extrinsic{[]byte{21}}))
@@ -544,7 +544,7 @@ func Test_Service_HandleBlockProduced(t *testing.T) {
 
 	t.Run("happy_path", func(t *testing.T) {
 		t.Parallel()
-		trieState := rtstorage.NewTrieState(nil)
+		trieState := rtstorage.NewTrieState(trie.NewEmptyTrie())
 
 		digest := types.NewDigest()
 		err := digest.Add(

diff --git a/dot/sync/chain_sync_test.go b/dot/sync/chain_sync_test.go
@@ -64,7 +64,7 @@ func Test_chainSync_onBlockAnnounce(t *testing.T) {
 	const somePeer = peer.ID("abc")
 
 	errTest := errors.New("test error")
-	emptyTrieState := storage.NewTrieState(nil)
+	emptyTrieState := storage.NewTrieState(trie.NewEmptyTrie())
 	block1AnnounceHeader := types.NewHeader(common.Hash{}, emptyTrieState.MustRoot(trie.NoMaxInlineValueSize),
 		common.Hash{}, 1, scale.VaryingDataTypeSlice{})
 	block2AnnounceHeader := types.NewHeader(block1AnnounceHeader.Hash(),
@@ -242,7 +242,7 @@ func Test_chainSync_onBlockAnnounceHandshake_tipModeNeedToCatchup(t *testing.T)
 	ctrl := gomock.NewController(t)
 	const somePeer = peer.ID("abc")
 
-	emptyTrieState := storage.NewTrieState(nil)
+	emptyTrieState := storage.NewTrieState(trie.NewEmptyTrie())
 	block1AnnounceHeader := types.NewHeader(common.Hash{}, emptyTrieState.MustRoot(trie.NoMaxInlineValueSize),
 		common.Hash{}, 1, scale.VaryingDataTypeSlice{})
 	block2AnnounceHeader := types.NewHeader(block1AnnounceHeader.Hash(),
@@ -1250,7 +1250,7 @@ func createSuccesfullBlockResponse(t *testing.T, parentHeader common.Hash,
 	response := new(network.BlockResponseMessage)
 	response.BlockData = make([]*types.BlockData, numBlocks)
 
-	emptyTrieState := storage.NewTrieState(nil)
+	emptyTrieState := storage.NewTrieState(trie.NewEmptyTrie())
 	tsRoot := emptyTrieState.MustRoot(trie.NoMaxInlineValueSize)
 
 	firstHeader := types.NewHeader(parentHeader, tsRoot, common.Hash{},
@@ -1303,7 +1303,7 @@ func ensureSuccessfulBlockImportFlow(t *testing.T, parentHeader *types.Header,
 		mockStorageState.EXPECT().Lock()
 		mockStorageState.EXPECT().Unlock()
 
-		emptyTrieState := storage.NewTrieState(nil)
+		emptyTrieState := storage.NewTrieState(trie.NewEmptyTrie())
 		parentStateRoot := previousHeader.StateRoot
 		mockStorageState.EXPECT().TrieState(&parentStateRoot).
 			Return(emptyTrieState, nil)

diff --git a/lib/runtime/interfaces.go b/lib/runtime/interfaces.go
@@ -30,9 +30,9 @@ type Storage interface {
 	ClearPrefix(prefix []byte) (err error)
 	ClearPrefixLimit(prefix []byte, limit uint32) (
 		deleted uint32, allDeleted bool, err error)
-	BeginStorageTransaction()
-	CommitStorageTransaction()
-	RollbackStorageTransaction()
+	StartTransaction()
+	CommitTransaction()
+	RollbackTransaction()
 	LoadCode() []byte
 }