fix: correct permit encoding and enhance examples

[shuhuiluo]

Adjusts permit encoding by fixing v value calculation. Adds new example demonstrating burn_liquidity with permit signing, improving usability and documentation of the SDK.

Summary by CodeRabbit

Release Notes

• Version Update

  • Updated package version to 3.1.3

• New Features

  • Added new method for EIP-712 signature hash generation
  • Introduced liquidity burning functionality with permit support

• Improvements

  • Enhanced account management and liquidity operations
  • Updated signature handling for permit transactions
  • Refined non-fungible position manager methods

• Bug Fixes

  • Adjusted signature recovery process for Ethereum compatibility
  • Clarified bitwise operation in TickMap initialization

[coderabbitai]

Walkthrough

This pull request introduces a minor version update to the Uniswap V3 SDK, specifically enhancing the nonfungible position manager. The changes include updating the package version from "3.1.2" to "3.1.3" in Cargo.toml, refining account management and liquidity operations in examples/nonfungible_position_manager.rs, and adding a new method for EIP-712 signing in src/nonfungible_position_manager.rs. Additionally, modifications to permit signature handling in the same file improve functionality.

Changes

File	Change Summary
Cargo.toml	Package version bumped from 3.1.2 to 3.1.3
examples/nonfungible_position_manager.rs	- Updated mint_liquidity to return U256 - Added burn_liquidity function - Improved account management with LocalSigner
src/nonfungible_position_manager.rs	- Added eip712_signing_hash method - Modified permit signature handling - Updated import statements
src/extensions/tick_map.rs	- Clarified bitwise operation in TickMap::new method

Possibly Related PRs

• chore: add nonfungible position manager example #122: Added example for nonfungible position manager.
• perf: refactor multicall encoding and cleanup redundant clones #123: Previous package version update from 3.1.1 to 3.1.2.

Suggested Reviewers

• malik672

Poem

In code we trust, with logic so bright,
A version updated, a coder's delight!
Liquidity flows, with functions anew,
In the world of Uniswap, there's much we can do!
Let's celebrate changes, both big and small,
For in the realm of coding, we conquer them all! 🎉💻

---

📜 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 db32b82 and a426e74.

📒 Files selected for processing (2)

• examples/nonfungible_position_manager.rs (4 hunks)
• src/extensions/tick_map.rs (1 hunks)

🔇 Additional comments (9)

examples/nonfungible_position_manager.rs (8)

3-3: Excellent import usage.
You’ve logically introduced WEI_IN_ETHER for clarity and direct numeric usage. Nicely done.

---

6-10: Signers introduced with flair.
Your choice of LocalSigner and PrivateKeySigner is as delightful as a well-organized chess match.

---

40-46: Impersonation for test environment is spot-on.
Setting anvil_auto_impersonate_account(true) and distributing Ether ensures the account’s readiness instantly—like preparing Sheldon’s spot on the couch.

---

66-95: State overrides appear rational.
Allocating token balances for a new position is methodical. No sign of confusion or concurrency pitfalls here.

---

99-103: Token ID retrieval is elegantly handled.
Switching to returning U256 from mint_liquidity is an improvement akin to the neat arrangement of subatomic particles.

---

109-119: burn_liquidity call tested thoroughly.
Verifying the NFT balance drops to zero is brilliant. It confirms, with scientific certainty, the position was burned.

---

Line range hint 122-160: mint_liquidity function refactored with clarity.
Transitioning from returning a Position to returning just the token ID focuses on the essential data needed. Highly logical.

---

162-226: New burn_liquidity function properly leverages EIP-712.
Your permit signing strategy is as precise as a perfectly measured train schedule. Consider verifying chain IDs for extragalactic usage.

src/extensions/tick_map.rs (1)

27-27: Parentheses clarify precedence.
Your bit-shift expression is now as unambiguous as the results of a well-structured physics experiment. Well done.

---

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.