chore: add nonfungible position manager example

[shuhuiluo]

Introduce a new example demonstrating minting liquidity with the Uniswap Nonfungible Position Manager. Refactor transaction handling by replacing deprecated register() calls with watch() for better event monitoring. Adjust get_erc20_state_overrides to use provider references for improved API consistency.

Summary by CodeRabbit

Release Notes

• New Features

  • Added a new example for Non-Fungible Position Manager interactions
  • Enhanced blockchain interaction example with liquidity pool minting

• Improvements

  • Updated transaction monitoring approach in swap and permit examples
  • Optimized state override function parameter handling

• Code Quality

  • Refined provider reference management in state overrides function

[coderabbitai]

Walkthrough

The pull request introduces a new example for the Uniswap V3 SDK demonstrating interaction with the Non-Fungible Position Manager. It modifies transaction handling methods in existing examples from .register() to .watch() and updates a state override function to use a reference parameter. The changes expand the package's example set and refine transaction monitoring approaches.

Changes

File	Change Summary
Cargo.toml	Added new example nonfungible_position_manager with extensions feature
examples/nonfungible_position_manager.rs	New file implementing liquidity pool interaction and position minting
examples/self_permit.rs	Replaced .register() with .watch() for transaction handling
examples/swap_router.rs	Replaced .register() with .watch() for transaction handling
src/extensions/state_overrides.rs	Updated function signature to use provider reference

Sequence Diagram

sequenceDiagram
    participant User
    participant NPM as NonFungiblePositionManager
    participant Blockchain
    
    User->>NPM: Prepare Liquidity Position
    NPM->>Blockchain: Mint Liquidity
    Blockchain-->>NPM: Confirm Transaction
    NPM-->>User: Return Position Token ID

Loading

Possibly related PRs

• feat: Add EIP712 signing support for NFT permits #89: EIP712 signing for NFT permits
• doc: add example and documentation for pool creation with tick data #110: Pool creation with tick data provider example
• feat(ext): add state override support for ERC20 balances and allowances #121: State override support for ERC20 balances

Poem

Behold, the blockchain's dance divine,
Where tokens swap and liquidity aligns,
A Sheldon-esque precision so refined,
Non-fungible positions, perfectly designed!
🧪 Science triumphs in each line of code! 🔬

[Bazinga!]

---

📜 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 6f4da2d and b2631d9.

📒 Files selected for processing (5)

• Cargo.toml (1 hunks)
• examples/nonfungible_position_manager.rs (1 hunks)
• examples/self_permit.rs (1 hunks)
• examples/swap_router.rs (1 hunks)
• src/extensions/state_overrides.rs (2 hunks)

🔇 Additional comments (8)

examples/nonfungible_position_manager.rs (3)

26-33: Good usage of Anvil fork
I applaud your cunning. Using a fork at a specific block helps with reproducible results. No immediate concerns here.

---

54-75: Check for potential overflows
Your mint amounts might get astronomically large if we miscalculate. Kindly ensure bounds checks or safe math are in place.

---

92-132: Efficient liquidity minting
This minting helper is well-structured. Tidy code, minimal duplication, and a straightforward approach to transaction sending.

examples/swap_router.rs (1)

98-98: Smart switch to .watch()
Magnificent. This ensures updates on transaction status in real time. Lower chance of missing events.

examples/self_permit.rs (1)

96-96: Consistent transaction monitoring
Your updated .watch() usage reduces code duplication and adds consistent event checking logic across examples.

src/extensions/state_overrides.rs (2)

24-24: Avoid needless clones
Taking the provider by reference is more memory efficient—well done.

---

93-95: Unit test usage
Your test gracefully verifies both balance and allowance using the new reference signature. Looks splendid.

Cargo.toml (1)

76-78: Appreciate the new example
Adding nonfungible_position_manager example expands the user’s reference repertoire. Quite logical.

---

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.