fix: getBalance fetching from supported chains

[fadeev]

• Switch from chain_name to name when fetching chains from supported chains endpoint (chain_name has been deprecated)
• Format ZRC-20 balances correctly using formatUnits

Summary by CodeRabbit

• Refactor
  • Updated how token chain information is retrieved for improved consistency.
  • Enhanced token balance formatting using a standardized approach to ensure reliable display.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates the getBalances function in packages/client/src/getBalances.ts. It changes the property accessed from the supportedChains array from chain_name to name when mapping tokens to chains. Additionally, it replaces a manual balance formatting logic (using BigInt arithmetic) with the formatUnits utility from the ethers library. No alterations were made to the exported or public entities.

Changes

File(s)	Change Summary
packages/client/src/getBalances.ts	- Changed property access from chain_name to name for supported chains. - Replaced manual balance formatting (division by BigInt) with formatUnits from ethers.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant getBalances
    participant ethers

    Client->>getBalances: Call getBalances(token)
    getBalances->>getBalances: Access supportedChains using property "name"
    getBalances->>getBalances: Retrieve token raw balance
    getBalances->>ethers: Format raw balance using formatUnits(token.rawBalance, token.decimals)
    ethers-->>getBalances: Return formatted balance
    getBalances-->>Client: Return processed balance

Loading

Possibly related PRs

• Support query solana balances #185: Updates the getBalances function for additional parameters and token handling, which aligns with the current changes.
• fix: getBalances should find chains based on ID not label #168: Modifies the same function focusing on how chain information is accessed, directly relating to the property change in this PR.
• feat: SPL token balances #204: Enhances the differentiation between ERC20 and SPL tokens within getBalances, sharing code-level modifications with this PR.

Suggested reviewers

• andresaiello

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 21a4c82 and 955d366.

📒 Files selected for processing (1)

• packages/client/src/getBalances.ts (2 hunks)

🔇 Additional comments (2)

packages/client/src/getBalances.ts (2)

139-141: Good addition of optional chaining and property name correction

The change from accessing chain_name to name properly fixes how the chain name is retrieved from the supported chains. The addition of the optional chaining operator (?.) is a good defensive programming practice that prevents potential errors if find() returns undefined.

---

203-206: Better balance formatting using ethers utility

Replacing the manual BigInt arithmetic with the formatUnits utility function from ethers is a good improvement. This approach:

1. Uses a well-tested library function designed specifically for this purpose
2. Is less error-prone than manual decimal calculations
3. Is more idiomatic for ethers-based applications

The commented code helps document the previous implementation, which is useful for context.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.

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.

[ronaldoguedess]

Great!

[fadeev]

@hernan-clich please, review.