feat(ext): add state override support for ERC20 balances and allowances

[shuhuiluo]

Introduces state_overrides module to compute ERC20 state overrides for balances and allowances, enabling simulation of state changes. Updates error handling with new error variants and resolves feature-flag reorganization. Bumps version to 3.1.1 to reflect the new functionality.

Summary by CodeRabbit

• New Features

  • Added state_overrides module for retrieving ERC20 token state overrides
  • Introduced new error handling capabilities for token-related operations
  • Implemented asynchronous function to fetch ERC20 state overrides

• Bug Fixes

  • Improved error handling for transaction and access list operations

• Chores

  • Updated package version from 3.1.0 to 3.1.1

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces several enhancements to the Uniswap V3 SDK, including an update to the uniswap-v3-sdk package version from 3.1.0 to 3.1.1. It modifies the Error enum in src/error.rs by reintroducing the TickListError variant, adding InvalidAccessList, and implementing a conversion from TransportError. Additionally, a new state_overrides module is added in src/extensions/mod.rs, along with an asynchronous function get_erc20_state_overrides in src/extensions/state_overrides.rs that retrieves ERC20 token state overrides.

Changes

File	Change Summary
Cargo.toml	Version bumped from 3.1.0 to 3.1.1
src/error.rs	- Added TickListError variant - Added InvalidAccessList variant - Added TransportError conversion implementation
src/extensions/mod.rs	- Added state_overrides module - Included public export for state_overrides
src/extensions/state_overrides.rs	- Introduced get_erc20_state_overrides async function - Added filter_access_list helper function - Included test module for state overrides

Sequence Diagram

sequenceDiagram
    participant User
    participant SDK
    participant Provider
    participant Token
    
    User->>SDK: Call get_erc20_state_overrides
    SDK->>Provider: Create access lists
    Provider-->>SDK: Return access lists
    SDK->>SDK: Filter and validate access lists
    SDK->>SDK: Compute state difference
    SDK-->>User: Return StateOverride

Loading

Possibly related PRs

• feat: sync with TypeScript SDK #86: Version update matching the current PR.
• refactor: add TickListError and refactor tick list handling methods #95: Similar error handling enhancements.
• feat: add support for custom fee tier #107: Enum modifications in the SDK.
• chore!: update dependencies and fix doc test #109: Continuous integration improvements.
• chore: upgrade dependencies and bump version to 2.9.0 #111: Cargo.toml version maintenance.

Poem

In the realm of code, where logic thrives,
New variants emerge, and the SDK strives.
With state overrides, we boldly explore,
Uniswap's brilliance, we can't ignore.
Errors refined, like a well-tuned string,
In this dance of code, let the triumphs ring!
🎉✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 51ac7ae and 8c9b88a.

📒 Files selected for processing (4)

• Cargo.toml (1 hunks)
• src/error.rs (3 hunks)
• src/extensions/mod.rs (2 hunks)
• src/extensions/state_overrides.rs (1 hunks)

---

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.

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.