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

fix: fix v in self_permit and add example #120

Merged
merged 1 commit into from
Dec 26, 2024
Merged

fix: fix v in self_permit and add example #120

merged 1 commit into from
Dec 26, 2024

Conversation

shuhuiluo
Copy link
Owner

@shuhuiluo shuhuiluo commented Dec 26, 2024

Introduced a new self_permit example to demonstrate signing ERC20 permits and encoding selfPermit calls for Uniswap V3. Improved encoding logic in self_permit.rs by adding EIP-712 signing hash functionality and fixing signature encoding with +27 adjustment. Updated version to 3.1.0 to reflect new functionality.

Summary by CodeRabbit

  • New Features

    • Updated the package version of uniswap-v3-sdk to 3.1.0.
    • Introduced a new example demonstrating ERC20 permit signing with the self_permit feature.
  • Bug Fixes

    • Enhanced the encode_permit function for better token type flexibility and corrected encoding logic for permit calls.
  • Documentation

    • Updated comments and examples to reflect recent changes and improvements in functionality.

Introduced a new `self_permit` example to demonstrate signing ERC20 permits and encoding `selfPermit` calls for Uniswap V3. Improved encoding logic in `self_permit.rs` by adding EIP-712 signing hash functionality and fixing signature encoding with +27 adjustment. Updated version to 3.1.0 to reflect new functionality.
@shuhuiluo shuhuiluo requested a review from malik672 December 26, 2024 12:32
Copy link
Contributor

coderabbitai bot commented Dec 26, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

Adjusts glasses Fascinating! This pull request introduces a minor version update to the Uniswap V3 SDK, adding a new self_permit example that demonstrates ERC20 permit signing functionality. The changes primarily involve updating the Cargo.toml configuration, modifying interface declarations, and implementing a new method for EIP-712 signing hash computation.

Changes

File Change Summary
Cargo.toml - Version bumped from 3.0.0 to 3.1.0
- Added self_permit example with "extensions" feature
examples/self_permit.rs - New example demonstrating ERC20 permit signing
- Implements USDC token interface
examples/swap_router.rs - Converted IERC20 from contract to interface
src/self_permit.rs - Added eip712_signing_hash method
- Updated encode_permit function signature
- Modified permit encoding logic

Sequence Diagram

sequenceDiagram
    participant Signer
    participant USDC
    participant NonfungiblePositionManager
    
    Signer->>USDC: Generate Permit Signature
    Signer->>NonfungiblePositionManager: Send Signed Permit
    NonfungiblePositionManager-->>USDC: Verify Permit
    NonfungiblePositionManager-->>Signer: Update Allowance
Loading

Possibly Related PRs

Poem

Behold, the permit's cryptic dance
Where bytes and signatures entrance
A blockchain ballet, precise and neat
SDK magic, now complete! 🧪✨
Bazinga, smart contracts unite!

mic drop


📜 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 3ad643d and 3347116.

📒 Files selected for processing (4)
  • Cargo.toml (2 hunks)
  • examples/self_permit.rs (1 hunks)
  • examples/swap_router.rs (1 hunks)
  • src/self_permit.rs (8 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
🪧 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.

@shuhuiluo shuhuiluo merged commit da884b1 into master Dec 26, 2024
1 of 2 checks passed
@shuhuiluo shuhuiluo deleted the self-permit branch December 26, 2024 12:33
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.

1 participant