Skip to content

Add logic to query account balances on RaindexVaultToken#2000

Merged
findolor merged 15 commits intomainfrom
2025-07-16-user-balance
Jul 16, 2025
Merged

Add logic to query account balances on RaindexVaultToken#2000
findolor merged 15 commits intomainfrom
2025-07-16-user-balance

Conversation

@findolor
Copy link
Copy Markdown
Collaborator

@findolor findolor commented Jul 16, 2025

Caution

Do not merge before #1994

Motivation

See issue: #1968

This PRs improves the usage of user balances in user facing applications by introducing a new wasm binding in RaindexVaultToken to fetch account balance

Solution

Checks

By submitting this for review, I'm confirming I've done the following:

  • made this PR as small as possible
  • unit-tested any new functionality
  • linked any relevant issues or PRs
  • included screenshots (if this involves a front-end change)

Summary by CodeRabbit

  • New Features

    • Added the ability to fetch and display user token balances with both raw and formatted values directly from the vault interface.
  • Refactor

    • Simplified balance retrieval in deposit and withdraw modals by using a unified method that returns both raw and formatted balances.
    • Updated UI components to display preformatted balance strings, improving clarity and consistency.
  • Bug Fixes

    • Improved error handling when retrieving user balances.
  • Tests

    • Enhanced and added tests to validate the new balance-fetching logic and formatted display.

@findolor findolor requested review from 0xgleb and hardyjosh July 16, 2025 06:59
@findolor findolor self-assigned this Jul 16, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 16, 2025

Walkthrough

This change introduces a new abstraction for retrieving ERC20 token balances, centralizing balance-fetching logic in the backend and exposing it through higher-level methods in the vault abstraction. UI components and tests are refactored to use this new approach, eliminating direct blockchain calls and formatting logic from the frontend.

Changes

File(s) Change Summary
crates/common/src/erc20.rs Added async method get_account_balance to ERC20 for querying ERC20 balances; added test for this method.
crates/common/src/raindex_client/vaults.rs Introduced AccountBalance struct; added async methods to RaindexVault for retrieving and formatting owner balances; added corresponding test.
packages/orderbook/test/js_api/raindexClient.test.ts Added test for fetching and formatting vault owner balance via new abstraction.
packages/ui-components/src/lib/services/historicalOrderCharts.ts Refactored to use preformatted balance strings instead of formatting BigInt amounts; updated test fixtures accordingly.
packages/webapp/src/tests/DepositModal.test.ts
packages/webapp/src/tests/WithdrawModal.test.ts
Refactored tests to mock balance retrieval via getOwnerBalance on the vault, removing all @wagmi/core and chain-switching mocks; removed related chain switch failure tests.
packages/webapp/src/lib/components/DepositModal.svelte
packages/webapp/src/lib/components/WithdrawModal.svelte
Refactored to fetch user balance via vault.getOwnerBalance(), using AccountBalance for both raw and formatted values; removed direct blockchain interaction and formatting logic from UI.
tauri-app/src/lib/components/ModalVaultDeposit.svelte Updated to use AccountBalance object from vault.getOwnerBalance() for balance retrieval and display; removed direct balance checking and formatting.

Sequence Diagram(s)

sequenceDiagram
    participant UI_Component as UI Component (Deposit/Withdraw Modal)
    participant Vault as RaindexVault
    participant ERC20 as ERC20 Helper
    participant ChainClient as RPC Client

    UI_Component->>Vault: getOwnerBalance()
    Vault->>ERC20: get_account_balance(owner_address)
    ERC20->>ChainClient: readContract(balanceOf, owner_address)
    ChainClient-->>ERC20: U256 balance
    ERC20-->>Vault: U256 balance
    Vault->>Vault: format balance (using decimals)
    Vault-->>UI_Component: AccountBalance { balance, formattedBalance }
    UI_Component->>UI_Component: Display formattedBalance
Loading

Suggested labels

rust

Suggested reviewers

  • 0xgleb
  • hardyjosh

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-07-16T12_37_06_924Z-debug-0.log

🔧 Clippy (1.86.0)
Updating crates.io index
Updating git repository `https://github.com/rainlanguage/rain.wasm`

error: failed to get wasm-bindgen-utils as a dependency of package rain_orderbook_bindings v0.0.0-alpha.0 (/crates/bindings)

Caused by:
failed to load source for dependency wasm-bindgen-utils

Caused by:
Unable to update https://github.com/rainlanguage/rain.wasm?rev=06990d85a0b7c55378a1c8cca4dd9e2bc34a596a#06990d85

Caused by:
failed to create directory /usr/local/git/db/rain.wasm-45eded9facc525c2

Caused by:
Permission denied (os error 13)

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@findolor findolor marked this pull request as ready for review July 16, 2025 10:32
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Comment thread crates/common/src/raindex_client/vaults.rs
@findolor findolor enabled auto-merge July 16, 2025 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants