[account] let LoadOrCreateAccount() return new account created flag

iotexproject · Apr 10, 2024 · ca514db · ca514db
1 parent 1791f82
commit ca514db
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 16 deletions.
diff --git a/action/protocol/account/transfer.go b/action/protocol/account/transfer.go
@@ -34,7 +34,7 @@ func (p *Protocol) handleTransfer(ctx context.Context, tsf *action.Transfer, sm
 		accountCreationOpts = append(accountCreationOpts, state.LegacyNonceAccountTypeOption())
 	}
 	// check sender
-	sender, err := accountutil.LoadOrCreateAccount(sm, actionCtx.Caller, accountCreationOpts...)
+	sender, _, err := accountutil.LoadOrCreateAccount(sm, actionCtx.Caller, accountCreationOpts...)
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to load or create the account of sender %s", actionCtx.Caller.String())
 	}
@@ -119,7 +119,7 @@ func (p *Protocol) handleTransfer(ctx context.Context, tsf *action.Transfer, sm
 	}
 
 	// check recipient
-	recipient, err := accountutil.LoadOrCreateAccount(sm, recipientAddr, accountCreationOpts...)
+	recipient, _, err := accountutil.LoadOrCreateAccount(sm, recipientAddr, accountCreationOpts...)
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to load or create the account of recipient %s", tsf.Recipient())
 	}

diff --git a/action/protocol/account/util/util.go b/action/protocol/account/util/util.go
@@ -18,26 +18,26 @@ import (
 )
 
 // LoadOrCreateAccount either loads an account state or creates an account state
-func LoadOrCreateAccount(sm protocol.StateManager, addr address.Address, opts ...state.AccountCreationOption) (*state.Account, error) {
+func LoadOrCreateAccount(sm protocol.StateManager, addr address.Address, opts ...state.AccountCreationOption) (*state.Account, bool, error) {
 	var (
 		account  = &state.Account{}
 		addrHash = hash.BytesToHash160(addr.Bytes())
 	)
 	_, err := sm.State(account, protocol.LegacyKeyOption(addrHash))
 	switch errors.Cause(err) {
 	case nil:
-		return account, nil
+		return account, false, nil
 	case state.ErrStateNotExist:
 		account, err := state.NewAccount(opts...)
 		if err != nil {
-			return nil, errors.Wrapf(err, "failed to create state account for %x", addrHash)
+			return nil, false, errors.Wrapf(err, "failed to create state account for %x", addrHash)
 		}
 		if _, err := sm.PutState(account, protocol.LegacyKeyOption(addrHash)); err != nil {
-			return nil, errors.Wrapf(err, "failed to put state for account %x", addrHash)
+			return nil, false, errors.Wrapf(err, "failed to put state for account %x", addrHash)
 		}
-		return account, nil
+		return account, true, nil
 	default:
-		return nil, err
+		return nil, false, err
 	}
 }
 

diff --git a/action/protocol/execution/evm/contract_test.go b/action/protocol/execution/evm/contract_test.go
@@ -61,8 +61,9 @@ func TestCreateContract(t *testing.T) {
 		}).AnyTimes()
 
 	addr := identityset.Address(28)
-	_, err = accountutil.LoadOrCreateAccount(sm, addr)
+	_, created, err := accountutil.LoadOrCreateAccount(sm, addr)
 	require.NoError(err)
+	require.True(created)
 	stateDB, err := NewStateDBAdapter(sm, 0, hash.ZeroHash256, NotFixTopicCopyBugOption())
 	require.NoError(err)
 
@@ -86,8 +87,9 @@ func TestCreateContract(t *testing.T) {
 	require.NoError(stateDB.CommitContracts())
 	stateDB.clear()
 	// reload same contract
-	contract1, err := accountutil.LoadOrCreateAccount(sm, addr)
+	contract1, created, err := accountutil.LoadOrCreateAccount(sm, addr)
 	require.NoError(err)
+	require.False(created)
 	require.Equal(codeHash[:], contract1.CodeHash)
 }
 

diff --git a/action/protocol/execution/evm/evmstatedbadapter.go b/action/protocol/execution/evm/evmstatedbadapter.go
@@ -245,7 +245,7 @@ func (stateDB *StateDBAdapter) CreateAccount(evmAddr common.Address) {
 	if stateDB.assertError(err, "Failed to convert evm address.", zap.Error(err)) {
 		return
 	}
-	_, err = accountutil.LoadOrCreateAccount(stateDB.sm, addr, stateDB.accountCreationOpts()...)
+	_, _, err = accountutil.LoadOrCreateAccount(stateDB.sm, addr, stateDB.accountCreationOpts()...)
 	if stateDB.assertError(err, "Failed to create account.", zap.Error(err), zap.String("address", evmAddr.Hex())) {
 		return
 	}
@@ -299,7 +299,7 @@ func (stateDB *StateDBAdapter) AddBalance(evmAddr common.Address, a256 *uint256.
 	if contract, ok := stateDB.cachedContract[addrHash]; ok {
 		state = contract.SelfState()
 	} else {
-		state, err = accountutil.LoadOrCreateAccount(stateDB.sm, addr, stateDB.accountCreationOpts()...)
+		state, _, err = accountutil.LoadOrCreateAccount(stateDB.sm, addr, stateDB.accountCreationOpts()...)
 		if stateDB.assertError(err, "Failed to get account.", zap.Error(err), zap.String("address", evmAddr.Hex())) {
 			return
 		}

diff --git a/action/protocol/poll/util.go b/action/protocol/poll/util.go
@@ -178,7 +178,7 @@ func setCandidates(
 		if err != nil {
 			return errors.Wrapf(err, "failed to decode delegate address %s", candidate.Address)
 		}
-		delegate, err := accountutil.LoadOrCreateAccount(sm, addr, accountCreationOpts...)
+		delegate, _, err := accountutil.LoadOrCreateAccount(sm, addr, accountCreationOpts...)
 		if err != nil {
 			return errors.Wrapf(err, "failed to load or create the account for delegate %s", candidate.Address)
 		}

diff --git a/action/protocol/rewarding/protocol.go b/action/protocol/rewarding/protocol.go
@@ -444,7 +444,7 @@ func (p *Protocol) increaseNonce(ctx context.Context, sm protocol.StateManager,
 	if protocol.MustGetFeatureCtx(ctx).CreateLegacyNonceAccount {
 		accountCreationOpts = append(accountCreationOpts, state.LegacyNonceAccountTypeOption())
 	}
-	acc, err := accountutil.LoadOrCreateAccount(sm, addr, accountCreationOpts...)
+	acc, _, err := accountutil.LoadOrCreateAccount(sm, addr, accountCreationOpts...)
 	if err != nil {
 		return err
 	}

diff --git a/action/protocol/rewarding/reward.go b/action/protocol/rewarding/reward.go
@@ -392,7 +392,7 @@ func (p *Protocol) claimFromAccount(ctx context.Context, sm protocol.StateManage
 		accountCreationOpts = append(accountCreationOpts, state.LegacyNonceAccountTypeOption())
 	}
 	// Update primary account
-	primAcc, err := accountutil.LoadOrCreateAccount(sm, addr, accountCreationOpts...)
+	primAcc, _, err := accountutil.LoadOrCreateAccount(sm, addr, accountCreationOpts...)
 	if err != nil {
 		return err
 	}

diff --git a/action/protocol/staking/handlers_test.go b/action/protocol/staking/handlers_test.go
@@ -3239,7 +3239,7 @@ func setupAccount(sm protocol.StateManager, addr address.Address, balance int64)
 	if balance < 0 {
 		return errors.New("balance cannot be negative")
 	}
-	account, err := accountutil.LoadOrCreateAccount(sm, addr, state.LegacyNonceAccountTypeOption())
+	account, _, err := accountutil.LoadOrCreateAccount(sm, addr, state.LegacyNonceAccountTypeOption())
 	if err != nil {
 		return err
 	}