Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(getBalances): Use multicall3 to reduce numer of RPC calls #162

Merged
merged 4 commits into from
Jul 18, 2024

Conversation

fadeev
Copy link
Member

@fadeev fadeev commented Jul 14, 2024

  • use multicall3
  • fix BTC balance fetching with --mainnet

Before, 160 requests:

Screenshot 2024-07-14 at 17 07 41

After, 76 requests:

Screenshot 2024-07-14 at 17 06 00

Seems like a solid 2x performance improvement. We can now use public RPC endpoints for the component library and not be rate-limited.

Summary by CodeRabbit

  • New Features

    • Enhanced balance retrieval with multicall functionality for more efficient token balance updates.
    • Bitcoin address generation now supports specifying network type (testnet or mainnet).
  • Improvements

    • Streamlined token balance retrieval process by grouping tokens by chain and using multicall with fallback for individual calls.
    • Improved clarity in specifying network type for Bitcoin address generation based on environment (testnet or mainnet).

@fadeev fadeev requested review from andresaiello, lucas-janon and a team as code owners July 14, 2024 14:02
Copy link
Contributor

coderabbitai bot commented Jul 14, 2024

Warning

Rate limit exceeded

@fadeev has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 15 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 1c6064c and a29aa7e.

Walkthrough

The recent changes enhance efficiency and flexibility in multiple areas of the project. The balance retrieval logic in getBalances.ts now uses a multicall contract, while the bitcoinAddress function has been updated to support both testnet and mainnet networks. These modifications improve performance and adaptability for handling different blockchain networks.

Changes

Files Change Summaries
packages/client/src/getBalances.ts Refactored to use a multicall contract for efficient token balance retrieval, with a fallback mechanism.
packages/tasks/src/account.ts Updated bitcoinAddress call to include "testnet" parameter.
packages/tasks/src/balances.ts Modified to pass network argument (mainnet or testnet) to bitcoinAddress based on args.mainnet.
packages/tasks/src/bitcoinAddress.ts Enhanced bitcoinAddress to accept a network parameter, dynamically selecting between testnet and mainnet.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant MulticallContract
    participant TokenContract

    Client->>MulticallContract: Request balances for multiple tokens
    MulticallContract->>TokenContract: Batch request for token balances
    TokenContract-->>MulticallContract: Return token balances
    MulticallContract-->>Client: Return aggregated balances

    Note over Client,TokenContract: If multicall fails:
    Client->>TokenContract: Request individual token balances
    TokenContract-->>Client: Return individual token balances
Loading

Poem

When tokens call in multitude,
Efficiency's our attitude.
With multicall, we scale the heights,
And balance checks reach new delights.
For Bitcoin's paths, testnet or main,
Our addresses now span the chain. 🚀


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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link
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: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0113af5 and 1c6064c.

Files selected for processing (4)
  • packages/client/src/getBalances.ts (2 hunks)
  • packages/tasks/src/account.ts (1 hunks)
  • packages/tasks/src/balances.ts (1 hunks)
  • packages/tasks/src/bitcoinAddress.ts (1 hunks)
Additional context used
GitHub Check: build
packages/tasks/src/bitcoinAddress.ts

[failure] 5-5:
Union type members must be sorted

packages/client/src/getBalances.ts

[failure] 142-142:
Expected object keys to be in ascending order. 'callData' should be before 'target'

Additional comments not posted (3)
packages/tasks/src/account.ts (1)

73-73: LGTM!

The additional argument "testnet" in the bitcoinAddress function call is correctly integrated.

packages/tasks/src/balances.ts (1)

50-50: LGTM!

The additional argument based on the value of args.mainnet in the bitcoinAddress function call is correctly integrated.

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

Line range hint 23-248:
LGTM!

The refactor to use multicall for more efficient token balance retrieval is correctly integrated and improves efficiency.

Tools
GitHub Check: build

[failure] 142-142:
Expected object keys to be in ascending order. 'callData' should be before 'target'

packages/tasks/src/bitcoinAddress.ts Outdated Show resolved Hide resolved
packages/client/src/getBalances.ts Show resolved Hide resolved
fadeev and others added 3 commits July 14, 2024 17:10
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@fadeev
Copy link
Member Author

fadeev commented Jul 17, 2024

@andresaiello @lucas-janon @zeta-chain/fullstack please, review.

Copy link
Collaborator

@GMaiolo GMaiolo left a comment

Choose a reason for hiding this comment

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

utACK

@fadeev fadeev merged commit 2bd1297 into main Jul 18, 2024
6 checks passed
@fadeev fadeev deleted the mutlicall3 branch July 18, 2024 16:00
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.

2 participants