internal/ethapi: recover GetDiffAccounts and GetDiffAccountsWithScope by allformless · Pull Request #3516 · bnb-chain/bsc

allformless · 2026-01-12T10:38:54Z

Description

internal/ethapi: recover GetDiffAccounts and GetDiffAccountsWithScope

Rationale

GetDiffAccounts was removed during v1.2.15...v1.3.0
GetDiffAccountsWithScope was removed in PR #3199
It's useful for some users, so I put them back but not based on the diff sync feature which is also removed.

Example

curl -X POST http://127.0.0.1:8545 \
  -H "Content-Type: application/json" \
  --data '{
    "jsonrpc": "2.0",
    "method": "eth_getDiffAccounts",
    "params": ["0x300"],
    "id": 1
  }'
{"jsonrpc":"2.0","id":1,"result":["0x04d63abcd2b9b1baa327f2dda0f873f197ccd186","0xfffffffffffffffffffffffffffffffffffffffe","0x000000000000000000000000000000000000dead","0x0000000000000000000000000000000000001000","0x3ad55d1d552cc55dee90c0faf0335383b2e6c5ce","0x0000000000000000000000000000000000001002"]}

curl -X POST http://127.0.0.1:8545 \
  -H "Content-Type: application/json" \
  --data '{
    "jsonrpc": "2.0",
    "method": "eth_getDiffAccountsWithScope",
    "params": [
      "0x500",
      ["0x0000000000000000000000000000000000001000"]
    ],
    "id": 1
  }'
{"jsonrpc":"2.0","id":1,"result":{"Number":1280,"BlockHash":"0x1ef2195f5073c21d3cd0e797de60421b45719d56d841bc5de75808fa6d3300c2","Transactions":[]}}

Changes

Notable changes:

add each change in a bullet point here
...

Copilot

Pull request overview

This pull request recovers two previously removed API functions: GetDiffAccounts and GetDiffAccountsWithScope. These functions provide account difference information for specific blocks by replaying transactions and tracking state changes. The PR also adds a new GetDirtyAccounts method to the StateDB to support retrieving modified accounts.

Changes:

Recovers GetDiffAccounts and GetDiffAccountsWithScope API methods for tracking account state changes
Adds helper functions needToReplay and replay for transaction replay logic
Introduces new struct types DiffAccountsInTx and DiffAccountsInBlock for result formatting
Adds GetDirtyAccounts method to StateDB to expose mutated accounts

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 12 comments.

File	Description
internal/ethapi/api.go	Adds GetDiffAccounts and GetDiffAccountsWithScope API methods along with supporting replay and needToReplay helper functions
core/state/statedb.go	Adds GetDirtyAccounts method to expose accounts with pending mutations

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-12T11:20:13Z

internal/ethapi/api.go

+	BlockHash    common.Hash
+	Transactions []DiffAccountsInTx
+}
+


Missing documentation for the replay helper function. This is a complex function that performs block replay and computes account diffs. It should have documentation explaining its purpose, parameters, and return values.

Suggested change

// replay re-executes the given block on top of its parent state and computes

// per-transaction balance diffs for the specified accounts.

//

// The ctx parameter controls cancellation of the replay operation. The block

// parameter is the block to be replayed, and accounts is the list of account

// addresses for which balance changes should be tracked.

//

// It returns:

// - *DiffAccountsInBlock containing the per-transaction balance deltas for

// the requested accounts within the given block;

// - *state.StateDB representing the post-state after successfully replaying

// the block;

// - error if the parent block or its state cannot be retrieved, or if the

// replay itself fails.

Copilot · 2026-01-12T11:20:14Z

core/state/statedb.go


 	return &blockAccessList
 }
+


Missing documentation for the GetDirtyAccounts function. Public methods should have documentation explaining their purpose and return values.

Suggested change

// GetDirtyAccounts returns the set of accounts that have pending mutations

// in the current state, as a slice of their addresses.

Copilot · 2026-01-12T11:20:14Z

internal/ethapi/api.go

+			spendValueMap[from] += receipt.GasUsed * tx.GasPrice().Uint64()
+			if receipt.Status == types.ReceiptStatusSuccessful {
+				spendValueMap[from] += tx.Value().Uint64()
+			}
+		}
+
+		if tx.To() == nil {
+			continue
+		}
+
+		if _, exists := accountSet[*tx.To()]; exists && receipt.Status == types.ReceiptStatusSuccessful {
+			receiveValueMap[*tx.To()] += tx.Value().Uint64()
+		}


Potential uint64 overflow when converting big.Int values to uint64. The GasPrice and Value can exceed uint64 limits, and multiplying GasUsed by GasPrice().Uint64() can also overflow. This could lead to incorrect calculation of spendValueMap and receiveValueMap, causing the needToReplay function to return incorrect results.

Copilot · 2026-01-12T11:20:14Z

internal/ethapi/api.go

+		parentBalance := parentState.GetBalance(account).Uint64()
+		currentBalance := currentState.GetBalance(account).Uint64()
+		if receiveValueMap[account]-spendValueMap[account] != currentBalance-parentBalance {


Potential uint64 overflow when converting account balances. The GetBalance() returns a uint256 value which can exceed uint64 limits. This could lead to incorrect overflow/underflow in the comparison on line 1271, causing needToReplay to return incorrect results when dealing with accounts that have large balances.

Copilot · 2026-01-12T11:20:15Z

internal/ethapi/api.go

+// GetDiffAccountsWithScope returns detailed changes of some interested accounts in a specific block number.
+func (api *BlockChainAPI) GetDiffAccountsWithScope(ctx context.Context, blockNr rpc.BlockNumber, accounts []common.Address) (*DiffAccountsInBlock, error) {
+	if api.b.Chain() == nil {
+		return nil, errors.New("blockchain not support get diff accounts")


Inconsistent error message format. This error uses errors.New() while the similar error on line 1204 uses fmt.Errorf(). For consistency, both should use the same approach, preferably fmt.Errorf() to match the codebase pattern.

Suggested change

return nil, errors.New("blockchain not support get diff accounts")

return nil, fmt.Errorf("blockchain not support get diff accounts")

Copilot · 2026-01-12T11:20:15Z

internal/ethapi/api.go

+	TxHash   common.Hash
+	Accounts map[common.Address]*big.Int
+}
+
+type DiffAccountsInBlock struct {
+	Number       uint64
+	BlockHash    common.Hash


Missing documentation for the DiffAccountsInTx struct fields. Public structs should have documentation for each exported field explaining their purpose and format.

Suggested change

TxHash common.Hash

Accounts map[common.Address]*big.Int

}

type DiffAccountsInBlock struct {

Number uint64

BlockHash common.Hash

// TxHash is the hash of the transaction whose account balance differences are recorded.

TxHash common.Hash

// Accounts maps account addresses to their net balance change (in wei) caused by the transaction.

// A positive value indicates a gain in balance; a negative value indicates a loss.

Accounts map[common.Address]*big.Int

}

type DiffAccountsInBlock struct {

// Number is the number of the block for which account differences are reported.

Number uint64

// BlockHash is the hash of the block corresponding to this diff information.

BlockHash common.Hash

// Transactions contains per-transaction account balance differences within the block.

Copilot · 2026-01-12T11:20:16Z

internal/ethapi/api.go

+	TxHash   common.Hash
+	Accounts map[common.Address]*big.Int
+}
+
+type DiffAccountsInBlock struct {
+	Number       uint64
+	BlockHash    common.Hash


Missing documentation for the DiffAccountsInBlock struct fields. Public structs should have documentation for each exported field explaining their purpose and format.

Suggested change

TxHash common.Hash

Accounts map[common.Address]*big.Int

}

type DiffAccountsInBlock struct {

Number uint64

BlockHash common.Hash

// TxHash is the hash of the transaction whose account balance diffs are reported.

TxHash common.Hash

// Accounts maps each tracked account address to its balance difference caused by the transaction.

Accounts map[common.Address]*big.Int

}

type DiffAccountsInBlock struct {

// Number is the height of the block that was replayed.

Number uint64

// BlockHash is the hash of the block whose transactions were replayed.

BlockHash common.Hash

// Transactions contains the per-transaction account balance diffs within the block.

Copilot · 2026-01-12T11:20:16Z

internal/ethapi/api.go

+	}
+	return statedb.GetDirtyAccounts(), nil
+}
+


Missing documentation for the needToReplay helper function. This is a complex helper function with non-trivial logic that should have documentation explaining its purpose, parameters, and return values.

Suggested change

// needToReplay determines whether a full state replay is required for the given block

// in order to accurately compute the balance changes of the specified accounts.

//

// It inspects the block's transactions and their receipts, aggregating the gas costs and

// transferred values for any account in the provided list, both as senders and recipients.

// If receipts are missing or inconsistent with the block's transactions, or if a sender

// cannot be derived, an error is returned and the helper signals that replay is not

// possible based solely on receipts.

//

// Parameters:

// - ctx: context used when querying receipts or other chain data, allowing cancellation.

// - block: the block whose transactions and receipts are inspected.

// - accounts: the set of accounts for which potential balance changes are evaluated.

//

// Returns:

// - bool: true if a state replay is required to obtain accurate account changes, false if

// replay is not needed or cannot be determined from receipts alone.

// - error: non-nil if receipts are inconsistent or if any unexpected failure occurs while

// processing the block.

Copilot · 2026-01-12T11:20:17Z

internal/ethapi/api.go

+// GetDiffAccounts returns changed accounts in a specific block number.
+func (api *BlockChainAPI) GetDiffAccounts(ctx context.Context, blockNr rpc.BlockNumber) ([]common.Address, error) {
+	if api.b.Chain() == nil {
+		return nil, fmt.Errorf("blockchain not support get diff accounts")


The error message is grammatically incorrect. It should read "blockchain does not support get diff accounts" instead of "blockchain not support get diff accounts".

Suggested change

return nil, fmt.Errorf("blockchain not support get diff accounts")

return nil, fmt.Errorf("blockchain does not support get diff accounts")

Copilot · 2026-01-12T11:20:17Z

internal/ethapi/api.go

+		}
+
+		// Apply transaction
+		msg, _ := core.TransactionToMessage(tx, signer, parent.Header().BaseFee)


The error from TransactionToMessage is silently ignored. While other similar code in the codebase also ignores this error, in the context of a replay function that's computing account differences, a failure to convert a transaction could lead to incorrect results. Consider handling this error explicitly.

Suggested change

msg, _ := core.TransactionToMessage(tx, signer, parent.Header().BaseFee)

msg, err := core.TransactionToMessage(tx, signer, parent.Header().BaseFee)

if err != nil {

return nil, nil, fmt.Errorf("failed to convert transaction %#x to message: %v", tx.Hash(), err)

}

allformless added 2 commits January 12, 2026 18:37

internal/ethapi: recover GetDiffAccounts and GetDiffAccountsWithScope

5ccb004

internal/ethapi: fix receiver name

18383ad

NathanBSC approved these changes Jan 12, 2026

View reviewed changes

allformless marked this pull request as ready for review January 12, 2026 11:12

buddh0 requested a review from Copilot January 12, 2026 11:13

Copilot started reviewing on behalf of buddh0 January 12, 2026 11:13 View session

Copilot AI reviewed Jan 12, 2026

View reviewed changes

rekyyang previously approved these changes Jan 12, 2026

View reviewed changes

internal/ethapi: fix uint64 overflow

e897465

allformless dismissed rekyyang’s stale review via e897465 January 13, 2026 01:58

internal/ethapi: fix method handler crashed

9abef37

rekyyang approved these changes Jan 13, 2026

View reviewed changes

buddh0 approved these changes Jan 13, 2026

View reviewed changes

buddh0 merged commit 98bb3e9 into bnb-chain:develop Jan 13, 2026
7 checks passed

allformless added this to the 1.7.0 milestone Jan 19, 2026

allformless mentioned this pull request Jan 19, 2026

release: prepare for release v1.7.0-alpha #3523

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

internal/ethapi: recover GetDiffAccounts and GetDiffAccountsWithScope#3516

internal/ethapi: recover GetDiffAccounts and GetDiffAccountsWithScope#3516
buddh0 merged 4 commits intobnb-chain:developfrom
allformless:recover-GetDiffAccountsX

allformless commented Jan 12, 2026 •

edited by buddh0

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

+// replay re-executes the given block on top of its parent state and computes
+// per-transaction balance diffs for the specified accounts.
+//
+// The ctx parameter controls cancellation of the replay operation. The block
+// parameter is the block to be replayed, and accounts is the list of account
+// addresses for which balance changes should be tracked.
+//
+// It returns:
+//   - *DiffAccountsInBlock containing the per-transaction balance deltas for
+//     the requested accounts within the given block;
+//   - *state.StateDB representing the post-state after successfully replaying
+//     the block;
+//   - error if the parent block or its state cannot be retrieved, or if the
+//     replay itself fails.



	// GetDirtyAccounts returns the set of accounts that have pending mutations
	// in the current state, as a slice of their addresses.

	return nil, errors.New("blockchain not support get diff accounts")
	return nil, fmt.Errorf("blockchain not support get diff accounts")

+// needToReplay determines whether a full state replay is required for the given block
+// in order to accurately compute the balance changes of the specified accounts.
+//
+// It inspects the block's transactions and their receipts, aggregating the gas costs and
+// transferred values for any account in the provided list, both as senders and recipients.
+// If receipts are missing or inconsistent with the block's transactions, or if a sender
+// cannot be derived, an error is returned and the helper signals that replay is not
+// possible based solely on receipts.
+//
+// Parameters:
+//   - ctx: context used when querying receipts or other chain data, allowing cancellation.
+//   - block: the block whose transactions and receipts are inspected.
+//   - accounts: the set of accounts for which potential balance changes are evaluated.
+//
+// Returns:
+//   - bool: true if a state replay is required to obtain accurate account changes, false if
+//     replay is not needed or cannot be determined from receipts alone.
+//   - error: non-nil if receipts are inconsistent or if any unexpected failure occurs while
+//     processing the block.

	return nil, fmt.Errorf("blockchain not support get diff accounts")
	return nil, fmt.Errorf("blockchain does not support get diff accounts")

-		msg, _ := core.TransactionToMessage(tx, signer, parent.Header().BaseFee)
+		msg, err := core.TransactionToMessage(tx, signer, parent.Header().BaseFee)
+		if err != nil {
+			return nil, nil, fmt.Errorf("failed to convert transaction %#x to message: %v", tx.Hash(), err)
+		}

Conversation

allformless commented Jan 12, 2026 • edited by buddh0 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Rationale

Example

Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

allformless commented Jan 12, 2026 •

edited by buddh0

Loading