Merge branch 'master' into sre/jp/remove-unnecessary-env-check

Author: sjonpaulbrown

cmd/util/ledger/migrations/add_key_migration.go

@@ -149,12 +149,12 @@ func (m *AddKeyMigration) MigrateAccount(
 
 	flowAddress := flow.ConvertAddress(address)
 
-	keyIndex, err := migrationRuntime.Accounts.GetPublicKeyCount(flowAddress)
+	keyIndex, err := migrationRuntime.Accounts.GetAccountPublicKeyCount(flowAddress)
 	if err != nil {
 		return fmt.Errorf("failed to get public key count: %w", err)
 	}
 
-	err = migrationRuntime.Accounts.AppendPublicKey(flowAddress, key)
+	err = migrationRuntime.Accounts.AppendAccountPublicKey(flowAddress, key)
 	if err != nil {
 		return fmt.Errorf("failed to append public key: %w", err)
 	}

cmd/util/ledger/migrations/storage_used_migration_test.go

@@ -95,7 +95,7 @@ func TestAccountStatusMigration(t *testing.T) {
 
 		require.Equal(t, sizeOfTheStatusPayload, accountStatus.StorageUsed())
 		require.Equal(t, atree.SlabIndex{0, 0, 0, 0, 0, 0, 0, 6}, accountStatus.SlabIndex())
-		require.Equal(t, uint32(5), accountStatus.PublicKeyCount())
+		require.Equal(t, uint32(5), accountStatus.AccountPublicKeyCount())
 		require.Equal(t, uint64(0), accountStatus.AccountIdCounter())
 	})
 	t.Run("status register v2", func(t *testing.T) {
@@ -123,7 +123,7 @@ func TestAccountStatusMigration(t *testing.T) {
 
 		require.Equal(t, sizeOfTheStatusPayload, accountStatus.StorageUsed())
 		require.Equal(t, atree.SlabIndex{0, 0, 0, 0, 0, 0, 0, 6}, accountStatus.SlabIndex())
-		require.Equal(t, uint32(5), accountStatus.PublicKeyCount())
+		require.Equal(t, uint32(5), accountStatus.AccountPublicKeyCount())
 		require.Equal(t, uint64(3), accountStatus.AccountIdCounter())
 	})
 
@@ -152,7 +152,7 @@ func TestAccountStatusMigration(t *testing.T) {
 
 		require.Equal(t, sizeOfTheStatusPayload, accountStatus.StorageUsed())
 		require.Equal(t, atree.SlabIndex{0, 0, 0, 0, 0, 0, 0, 6}, accountStatus.SlabIndex())
-		require.Equal(t, uint32(5), accountStatus.PublicKeyCount())
+		require.Equal(t, uint32(5), accountStatus.AccountPublicKeyCount())
 		require.Equal(t, uint64(3), accountStatus.AccountIdCounter())
 	})
 
@@ -202,7 +202,7 @@ func TestAccountStatusMigration(t *testing.T) {
 
 		require.Equal(t, sizeOfTheStatusPayload+dataRegisterSize, accountStatus.StorageUsed())
 		require.Equal(t, atree.SlabIndex{0, 0, 0, 0, 0, 0, 0, 6}, accountStatus.SlabIndex())
-		require.Equal(t, uint32(5), accountStatus.PublicKeyCount())
+		require.Equal(t, uint32(5), accountStatus.AccountPublicKeyCount())
 		require.Equal(t, uint64(3), accountStatus.AccountIdCounter())
 	})
 }

fvm/environment/account_info.go

@@ -312,7 +312,7 @@ func (info *accountInfo) GetAccountKeys(
 ) {
 	defer info.tracer.StartChildSpan(trace.FVMEnvGetAccountKeys).End()
 
-	accountKeys, err := info.accounts.GetPublicKeys(address)
+	accountKeys, err := info.accounts.GetAccountPublicKeys(address)
 
 	if err != nil {
 		return nil, err
@@ -330,7 +330,7 @@ func (info *accountInfo) GetAccountKeyByIndex(
 ) {
 	defer info.tracer.StartChildSpan(trace.FVMEnvGetAccountKey).End()
 
-	accountKey, err := info.accounts.GetPublicKey(address, index)
+	accountKey, err := info.accounts.GetAccountPublicKey(address, index)
 
 	if err != nil {
 		return nil, err

fvm/environment/account_key_reader.go

@@ -120,7 +120,7 @@ func (reader *accountKeyReader) GetAccountKey(
 	address := flow.ConvertAddress(runtimeAddress)
 
 	// address verification is also done in this step
-	accountPublicKey, err := reader.accounts.GetPublicKey(
+	accountPublicKey, err := reader.accounts.GetAccountPublicKey(
 		address,
 		keyIndex)
 	if err != nil {
@@ -167,7 +167,7 @@ func (reader *accountKeyReader) AccountKeysCount(
 	}
 
 	// address verification is also done in this step
-	keyCount, err := reader.accounts.GetPublicKeyCount(
+	keyCount, err := reader.accounts.GetAccountPublicKeyCount(
 		flow.ConvertAddress(runtimeAddress))
 
 	return keyCount, err

fvm/environment/account_key_updater.go

@@ -237,7 +237,7 @@ func (updater *accountKeyUpdater) addAccountKey(
 			errors.NewAccountNotFoundError(address))
 	}
 
-	keyIndex, err := updater.accounts.GetPublicKeyCount(address)
+	keyIndex, err := updater.accounts.GetAccountPublicKeyCount(address)
 	if err != nil {
 		return nil, fmt.Errorf("adding account key failed: %w", err)
 	}
@@ -251,7 +251,7 @@ func (updater *accountKeyUpdater) addAccountKey(
 		return nil, fmt.Errorf("adding account key failed: %w", err)
 	}
 
-	err = updater.accounts.AppendPublicKey(address, *accountPublicKey)
+	err = updater.accounts.AppendAccountPublicKey(address, *accountPublicKey)
 	if err != nil {
 		return nil, fmt.Errorf("adding account key failed: %w", err)
 	}
@@ -293,7 +293,7 @@ func (updater *accountKeyUpdater) revokeAccountKey(
 	}
 
 	var publicKey flow.AccountPublicKey
-	publicKey, err = updater.accounts.GetPublicKey(
+	publicKey, err = updater.accounts.GetAccountPublicKey(
 		address,
 		keyIndex)
 	if err != nil {
@@ -310,7 +310,7 @@ func (updater *accountKeyUpdater) revokeAccountKey(
 	// mark this key as revoked
 	publicKey.Revoked = true
 
-	_, err = updater.accounts.SetPublicKey(
+	_, err = updater.accounts.SetAccountPublicKey(
 		address,
 		keyIndex,
 		publicKey)

fvm/environment/account_key_updater_test.go

@@ -151,21 +151,23 @@ var _ environment.Accounts = &FakeAccounts{}
 
 func (f FakeAccounts) Exists(address flow.Address) (bool, error)       { return true, nil }
 func (f FakeAccounts) Get(address flow.Address) (*flow.Account, error) { return &flow.Account{}, nil }
-func (f FakeAccounts) GetPublicKeyCount(_ flow.Address) (uint32, error) {
+func (f FakeAccounts) GetAccountPublicKeyCount(_ flow.Address) (uint32, error) {
 	return f.keyCount, nil
 }
-func (f FakeAccounts) AppendPublicKey(_ flow.Address, _ flow.AccountPublicKey) error { return nil }
-func (f FakeAccounts) GetPublicKey(address flow.Address, keyIndex uint32) (flow.AccountPublicKey, error) {
+func (f FakeAccounts) AppendAccountPublicKey(_ flow.Address, _ flow.AccountPublicKey) error {
+	return nil
+}
+func (f FakeAccounts) GetAccountPublicKey(address flow.Address, keyIndex uint32) (flow.AccountPublicKey, error) {
 	if keyIndex >= f.keyCount {
 		return flow.AccountPublicKey{}, errors.NewAccountPublicKeyNotFoundError(address, keyIndex)
 	}
 	return FakePublicKey{}.toAccountPublicKey(), nil
 }
 
-func (f FakeAccounts) SetPublicKey(_ flow.Address, _ uint32, _ flow.AccountPublicKey) ([]byte, error) {
+func (f FakeAccounts) SetAccountPublicKey(_ flow.Address, _ uint32, _ flow.AccountPublicKey) ([]byte, error) {
 	return nil, nil
 }
-func (f FakeAccounts) GetPublicKeys(address flow.Address) ([]flow.AccountPublicKey, error) {
+func (f FakeAccounts) GetAccountPublicKeys(address flow.Address) ([]flow.AccountPublicKey, error) {
 	return make([]flow.AccountPublicKey, f.keyCount), nil
 }
 func (f FakeAccounts) GetContractNames(_ flow.Address) ([]string, error)      { return nil, nil }

fvm/environment/accounts.go

@@ -23,11 +23,11 @@ const (
 type Accounts interface {
 	Exists(address flow.Address) (bool, error)
 	Get(address flow.Address) (*flow.Account, error)
-	GetPublicKeyCount(address flow.Address) (uint32, error)
-	AppendPublicKey(address flow.Address, key flow.AccountPublicKey) error
-	GetPublicKey(address flow.Address, keyIndex uint32) (flow.AccountPublicKey, error)
-	SetPublicKey(address flow.Address, keyIndex uint32, publicKey flow.AccountPublicKey) ([]byte, error)
-	GetPublicKeys(address flow.Address) ([]flow.AccountPublicKey, error)
+	GetAccountPublicKeyCount(address flow.Address) (uint32, error)
+	AppendAccountPublicKey(address flow.Address, key flow.AccountPublicKey) error
+	GetAccountPublicKey(address flow.Address, keyIndex uint32) (flow.AccountPublicKey, error)
+	SetAccountPublicKey(address flow.Address, keyIndex uint32, publicKey flow.AccountPublicKey) ([]byte, error)
+	GetAccountPublicKeys(address flow.Address) ([]flow.AccountPublicKey, error)
 	GetContractNames(address flow.Address) ([]string, error)
 	GetContract(contractName string, address flow.Address) ([]byte, error)
 	ContractExists(contractName string, address flow.Address) (bool, error)
@@ -124,7 +124,7 @@ func (a *StatefulAccounts) Get(address flow.Address) (*flow.Account, error) {
 	}
 
 	var publicKeys []flow.AccountPublicKey
-	publicKeys, err = a.GetPublicKeys(address)
+	publicKeys, err = a.GetAccountPublicKeys(address)
 	if err != nil {
 		return nil, err
 	}
@@ -181,10 +181,10 @@ func (a *StatefulAccounts) Create(
 		return fmt.Errorf("failed to create a new account: %w", err)
 	}
 
-	return a.SetAllPublicKeys(newAddress, publicKeys)
+	return a.SetAllAccountPublicKeys(newAddress, publicKeys)
 }
 
-func (a *StatefulAccounts) GetPublicKey(
+func (a *StatefulAccounts) GetAccountPublicKey(
 	address flow.Address,
 	keyIndex uint32,
 ) (
@@ -212,7 +212,7 @@ func (a *StatefulAccounts) GetPublicKey(
 	return decodedPublicKey, nil
 }
 
-func (a *StatefulAccounts) GetPublicKeyCount(
+func (a *StatefulAccounts) GetAccountPublicKeyCount(
 	address flow.Address,
 ) (
 	uint32,
@@ -222,7 +222,7 @@ func (a *StatefulAccounts) GetPublicKeyCount(
 	if err != nil {
 		return 0, fmt.Errorf("failed to get public key count: %w", err)
 	}
-	return status.PublicKeyCount(), nil
+	return status.AccountPublicKeyCount(), nil
 }
 
 func (a *StatefulAccounts) setPublicKeyCount(
@@ -237,7 +237,7 @@ func (a *StatefulAccounts) setPublicKeyCount(
 			err)
 	}
 
-	status.SetPublicKeyCount(count)
+	status.SetAccountPublicKeyCount(count)
 
 	err = a.setAccountStatus(address, status)
 	if err != nil {
@@ -249,20 +249,20 @@ func (a *StatefulAccounts) setPublicKeyCount(
 	return nil
 }
 
-func (a *StatefulAccounts) GetPublicKeys(
+func (a *StatefulAccounts) GetAccountPublicKeys(
 	address flow.Address,
 ) (
 	publicKeys []flow.AccountPublicKey,
 	err error,
 ) {
-	count, err := a.GetPublicKeyCount(address)
+	count, err := a.GetAccountPublicKeyCount(address)
 	if err != nil {
 		return nil, err
 	}
 	publicKeys = make([]flow.AccountPublicKey, count)
 
 	for i := uint32(0); i < count; i++ {
-		publicKey, err := a.GetPublicKey(address, i)
+		publicKey, err := a.GetAccountPublicKey(address, i)
 		if err != nil {
 			return nil, err
 		}
@@ -273,7 +273,7 @@ func (a *StatefulAccounts) GetPublicKeys(
 	return publicKeys, nil
 }
 
-func (a *StatefulAccounts) SetPublicKey(
+func (a *StatefulAccounts) SetAccountPublicKey(
 	address flow.Address,
 	keyIndex uint32,
 	publicKey flow.AccountPublicKey,
@@ -303,7 +303,7 @@ func (a *StatefulAccounts) SetPublicKey(
 	return encodedPublicKey, err
 }
 
-func (a *StatefulAccounts) SetAllPublicKeys(
+func (a *StatefulAccounts) SetAllAccountPublicKeys(
 	address flow.Address,
 	publicKeys []flow.AccountPublicKey,
 ) error {
@@ -318,7 +318,7 @@ func (a *StatefulAccounts) SetAllPublicKeys(
 	}
 
 	for i, publicKey := range publicKeys {
-		_, err := a.SetPublicKey(address, uint32(i), publicKey)
+		_, err := a.SetAccountPublicKey(address, uint32(i), publicKey)
 		if err != nil {
 			return err
 		}
@@ -327,7 +327,7 @@ func (a *StatefulAccounts) SetAllPublicKeys(
 	return a.setPublicKeyCount(address, count)
 }
 
-func (a *StatefulAccounts) AppendPublicKey(
+func (a *StatefulAccounts) AppendAccountPublicKey(
 	address flow.Address,
 	publicKey flow.AccountPublicKey,
 ) error {
@@ -344,7 +344,7 @@ func (a *StatefulAccounts) AppendPublicKey(
 			"signature algorithm type not found")
 	}
 
-	count, err := a.GetPublicKeyCount(address)
+	count, err := a.GetAccountPublicKeyCount(address)
 	if err != nil {
 		return err
 	}
@@ -356,7 +356,7 @@ func (a *StatefulAccounts) AppendPublicKey(
 			MaxPublicKeyCount)
 	}
 
-	_, err = a.SetPublicKey(address, count, publicKey)
+	_, err = a.SetAccountPublicKey(address, count, publicKey)
 	if err != nil {
 		return err
 	}

fvm/environment/accounts_status.go

@@ -11,20 +11,20 @@ import (
 )
 
 const (
-	flagSize               = 1
-	storageUsedSize        = 8
-	storageIndexSize       = 8
-	oldPublicKeyCountsSize = 8
-	publicKeyCountsSize    = 4
-	addressIdCounterSize   = 8
+	flagSize                      = 1
+	storageUsedSize               = 8
+	storageIndexSize              = 8
+	oldAccountPublicKeyCountsSize = 8
+	accountPublicKeyCountsSize    = 4
+	addressIdCounterSize          = 8
 
 	// accountStatusSizeV1 is the size of the account status before the address
 	// id counter was added. After Crescendo check if it can be removed as all accounts
 	// should then have the new status sile len.
 	accountStatusSizeV1 = flagSize +
 		storageUsedSize +
 		storageIndexSize +
-		oldPublicKeyCountsSize
+		oldAccountPublicKeyCountsSize
 
 	// accountStatusSizeV2 is the size of the account status before
 	// the public key count was changed from 8 to 4 bytes long.
@@ -33,20 +33,20 @@ const (
 	accountStatusSizeV2 = flagSize +
 		storageUsedSize +
 		storageIndexSize +
-		oldPublicKeyCountsSize +
+		oldAccountPublicKeyCountsSize +
 		addressIdCounterSize
 
 	accountStatusSizeV3 = flagSize +
 		storageUsedSize +
 		storageIndexSize +
-		publicKeyCountsSize +
+		accountPublicKeyCountsSize +
 		addressIdCounterSize
 
-	flagIndex                  = 0
-	storageUsedStartIndex      = flagIndex + flagSize
-	storageIndexStartIndex     = storageUsedStartIndex + storageUsedSize
-	publicKeyCountsStartIndex  = storageIndexStartIndex + storageIndexSize
-	addressIdCounterStartIndex = publicKeyCountsStartIndex + publicKeyCountsSize
+	flagIndex                        = 0
+	storageUsedStartIndex            = flagIndex + flagSize
+	storageIndexStartIndex           = storageUsedStartIndex + storageUsedSize
+	accountPublicKeyCountsStartIndex = storageIndexStartIndex + storageIndexSize
+	addressIdCounterStartIndex       = accountPublicKeyCountsStartIndex + accountPublicKeyCountsSize
 )
 
 // AccountStatus holds meta information about an account
@@ -118,7 +118,7 @@ func AccountStatusFromBytes(inp []byte) (*AccountStatus, error) {
 		cutEnd := flagSize +
 			storageUsedSize +
 			storageIndexSize +
-			(oldPublicKeyCountsSize - publicKeyCountsSize)
+			(oldAccountPublicKeyCountsSize - accountPublicKeyCountsSize)
 
 		// check if the public key count is larger than 4 bytes
 		for i := cutStart; i < cutEnd; i++ {
@@ -128,7 +128,7 @@ func AccountStatusFromBytes(inp []byte) (*AccountStatus, error) {
 					storageIndexSize:flagSize+
 					storageUsedSize+
 					storageIndexSize+
-					oldPublicKeyCountsSize]), inp2[i])
+					oldAccountPublicKeyCountsSize]), inp2[i])
 			}
 		}
 
@@ -192,14 +192,14 @@ func (a *AccountStatus) SlabIndex() atree.SlabIndex {
 	return index
 }
 
-// SetPublicKeyCount updates the public key count of the account
-func (a *AccountStatus) SetPublicKeyCount(count uint32) {
-	binary.BigEndian.PutUint32(a[publicKeyCountsStartIndex:publicKeyCountsStartIndex+publicKeyCountsSize], count)
+// SetAccountPublicKeyCount updates the account public key count of the account
+func (a *AccountStatus) SetAccountPublicKeyCount(count uint32) {
+	binary.BigEndian.PutUint32(a[accountPublicKeyCountsStartIndex:accountPublicKeyCountsStartIndex+accountPublicKeyCountsSize], count)
 }
 
-// PublicKeyCount returns the public key count of the account
-func (a *AccountStatus) PublicKeyCount() uint32 {
-	return binary.BigEndian.Uint32(a[publicKeyCountsStartIndex : publicKeyCountsStartIndex+publicKeyCountsSize])
+// AccountPublicKeyCount returns the account public key count of the account
+func (a *AccountStatus) AccountPublicKeyCount() uint32 {
+	return binary.BigEndian.Uint32(a[accountPublicKeyCountsStartIndex : accountPublicKeyCountsStartIndex+accountPublicKeyCountsSize])
 }
 
 // SetAccountIdCounter updates id counter of the account