chore: return spendable and actual balance in rpc api getErc20Balance

[khanti42]

Description

This pull request enhances the getErc20Balance function to return both the spendable balance and the actual balance of an ERC-20 token. The primary goal is to provide users with a more accurate representation of their available funds by distinguishing between confirmed (actual) balances and spendable balances, taking into account any pending transactions.

Changes

Function Update

The getErc20Balance function now calculates and returns two balances:

• Spendable Balance: The minimum of the confirmed balance and the latest state balance (considering pending transactions).
• Actual Balance: The confirmed balance without considering pending transactions.

Balance Calculation

• Confirmed Balance: The balance after all confirmed transactions.
• Latest State Balance: The balance considering pending transactions (both incoming and outgoing).
• Spendable Balance: Calculated as the minimum of the confirmed balance and the latest state balance.

Motivation

• User Experience: By showing the spendable balance, users are provided with a clearer picture of the amount they can actually use, preventing confusion and potential transaction failures due to pending transactions.
• Accuracy: Ensures that the displayed balance reflects the true spendable amount, avoiding scenarios where users see tokens that are not yet confirmed and therefore not spendable.

Testing

• Updated unit tests to cover scenarios with pending transactions.
• Verified that the function correctly returns both the spendable and actual balances.

Impact

• Backward Compatibility: The function signature changes to return two balances instead of one, which may require updates in the consuming code.
• User Interface: UIs displaying the token balance will need to be updated to show both the spendable and actual balances.

Requirement:

Requires this PR to be merged first:

• fix: allow multiple consecutive transactions in estimateFee(Bulk) #289

[sonarqubecloud]

Quality Gate passed for 'consensys_starknet-snap-starknet-snap'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[sonarqubecloud]

Quality Gate passed for 'consensys_starknet-snap-wallet-ui'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud