Merge branch 'feature/atree-inlining-cadence-v0.42' into fxamacker/port-6063-to-atree-inlining-cadence-0.42

Author: fxamacker

cmd/util/ledger/migrations/atree_register_migration.go

@@ -91,6 +91,13 @@ func (m *AtreeRegisterMigrator) MigrateAccount(
 	address common.Address,
 	oldPayloads []*ledger.Payload,
 ) ([]*ledger.Payload, error) {
+
+	err := CheckDomainPayloads(oldPayloads)
+	if err != nil {
+		// Log domain payload error for now
+		m.log.Warn().Msgf("unexpected domain payloads: %s", err.Error())
+	}
+
 	// create all the runtime components we need for the migration
 	mr, err := NewAtreeRegisterMigratorRuntime(address, oldPayloads)
 	if err != nil {

cmd/util/ledger/migrations/utils.go

@@ -1,6 +1,7 @@
 package migrations
 
 import (
+	"errors"
 	"fmt"
 
 	"github.com/onflow/atree"
@@ -10,8 +11,56 @@ import (
 
 	"github.com/onflow/flow-go/ledger"
 	"github.com/onflow/flow-go/ledger/common/convert"
+	"github.com/onflow/flow-go/model/flow"
 )
 
+func getDomainPayloads(payloads []*ledger.Payload) (map[flow.RegisterID]*ledger.Payload, error) {
+	domains := make(map[flow.RegisterID]*ledger.Payload)
+
+	for _, payload := range payloads {
+		registerID, _, err := convert.PayloadToRegister(payload)
+		if err != nil {
+			return nil, fmt.Errorf("failed to convert payload to register: %w", err)
+		}
+
+		if registerID.IsInternalState() || registerID.IsSlabIndex() {
+			continue
+		}
+
+		domains[registerID] = payload
+	}
+
+	return domains, nil
+}
+
+func CheckDomainPayloads(payloads []*ledger.Payload) error {
+	domainPayloads, err := getDomainPayloads(payloads)
+	if err != nil {
+		return err
+	}
+
+	if len(domainPayloads) == 0 {
+		return nil
+	}
+
+	var errs []error
+
+	slabIndexLength := len(atree.SlabIndex{})
+
+	for id, p := range domainPayloads {
+		if _, exist := allStorageMapDomainsSet[id.Key]; !exist {
+			errs = append(errs, fmt.Errorf("found unexpected domain: %s", id.Key))
+			continue
+		}
+		v := p.Value()
+		if len(v) != slabIndexLength {
+			errs = append(errs, fmt.Errorf("domain payload contains unexpected value: %s %x", id.Key, v))
+		}
+	}
+
+	return errors.Join(errs...)
+}
+
 func getSlabIDsFromPayloads(payloads []*ledger.Payload) ([]atree.SlabID, error) {
 	slabIDs := make([]atree.SlabID, 0, len(payloads))
 

cmd/util/ledger/migrations/utils_test.go

@@ -0,0 +1,100 @@
+package migrations
+
+import (
+	"crypto/rand"
+	"encoding/binary"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/onflow/flow-go/ledger"
+)
+
+func TestCheckDomainPayloads(t *testing.T) {
+	t.Run("no storage domain payload", func(t *testing.T) {
+		var payloads []*ledger.Payload
+
+		// Add internal payload
+		payloads = append(payloads, getPayload("a.s", 16))
+
+		// Add atree paylaod
+		var index [9]byte
+		binary.BigEndian.PutUint64(index[:], 0)
+		index[0] = '$'
+
+		payloads = append(payloads, getPayload(string(index[:]), 16))
+
+		err := CheckDomainPayloads(payloads)
+		require.NoError(t, err)
+	})
+
+	t.Run("some storage domain payloads", func(t *testing.T) {
+		var payloads []*ledger.Payload
+
+		// Add internal payload
+		payloads = append(payloads, getPayload("a.s", 16))
+
+		// Add atree paylaod
+		var index [9]byte
+		binary.BigEndian.PutUint64(index[:], 0)
+		index[0] = '$'
+
+		payloads = append(payloads, getPayload(string(index[:]), 16))
+
+		// Add domain payload
+		payloads = append(payloads, getPayload(allStorageMapDomains[0], 8))
+
+		err := CheckDomainPayloads(payloads)
+		require.NoError(t, err)
+	})
+
+	t.Run("unexpected storage domain payloads", func(t *testing.T) {
+		var payloads []*ledger.Payload
+
+		// Add internal payload
+		payloads = append(payloads, getPayload("a.s", 16))
+
+		// Add atree paylaod
+		var index [9]byte
+		binary.BigEndian.PutUint64(index[:], 0)
+		index[0] = '$'
+
+		payloads = append(payloads, getPayload(string(index[:]), 16))
+
+		// Add domain payload
+		payloads = append(payloads, getPayload(allStorageMapDomains[0], 8))
+
+		// Add unexpected domain payload
+		payloads = append(payloads, getPayload("a", 8))
+
+		// Add domain payload with unexpected value
+		payloads = append(payloads, getPayload(allStorageMapDomains[1], 16))
+
+		err := CheckDomainPayloads(payloads)
+		errStrings := strings.Split(err.Error(), "\n")
+		require.Equal(t, 2, len(errStrings))
+		require.Equal(t, "found unexpected domain: a", errStrings[0])
+		require.True(t, strings.HasPrefix(errStrings[1], "domain payload contains unexpected value"))
+	})
+}
+
+func getPayload(key string, valueLength int) *ledger.Payload {
+	address := make([]byte, 8)
+	_, err := rand.Read(address)
+	if err != nil {
+		panic(err)
+	}
+	ledgerKey := ledger.Key{KeyParts: []ledger.KeyPart{
+		{Type: uint16(0), Value: address},
+		{Type: uint16(2), Value: []byte(key)},
+	}}
+
+	value := make([]byte, valueLength)
+	_, err = rand.Read(value)
+	if err != nil {
+		panic(err)
+	}
+
+	return ledger.NewPayload(ledgerKey, value)
+}