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

feat: reenable paymaster for argent #917

Merged
merged 1 commit into from
Nov 19, 2024

Conversation

Marchand-Nicolas
Copy link
Collaborator

@Marchand-Nicolas Marchand-Nicolas commented Nov 18, 2024

Summary by CodeRabbit

  • New Features

    • Simplified logic for enabling the paymaster functionality, enhancing user experience.
  • Bug Fixes

    • Improved fetch operation for typed data, ensuring it only occurs when the paymaster is enabled.
  • Refactor

    • Streamlined conditions for signing typed data and managing loading states based on the paymaster's enabled status.

@Marchand-Nicolas Marchand-Nicolas added the 🔥 Ready for review This pull request needs a review label Nov 18, 2024
Copy link

vercel bot commented Nov 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
app-starknet-id ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 0:05am
sepolia-app-starknet-id ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 0:05am

Copy link
Contributor

coderabbitai bot commented Nov 18, 2024

Walkthrough

The pull request modifies the usePaymaster hook in hooks/paymaster.tsx by changing the paymasterEnabled variable from a conditional check based on wallet type to a static value of true. This adjustment simplifies the logic by removing wallet compatibility checks. The useEffect now fetches deployment typed data only if paymasterEnabled is true, and the handleRegister function's logic is updated to check for paymasterEnabled instead of wallet type. Additionally, the management of the loadingGas state is refined to align with these changes.

Changes

File Change Summary
hooks/paymaster.tsx - Changed paymasterEnabled from conditional to static true.
- Updated useEffect to fetch typed data only if paymasterEnabled is true.
- Modified handleRegister to check paymasterEnabled instead of wallet type.
- Adjusted loadingGas state management based on paymasterEnabled.

Possibly related PRs

  • fix: paymaster #907: The changes in this PR also modify the usePaymaster hook in hooks/paymaster.tsx, specifically affecting the logic around the typedData variable and the handleRegister function, which is closely related to the modifications made in the main PR regarding the paymasterEnabled variable and its implications on transaction signing.

Suggested reviewers

  • fricoben

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

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: 0

🧹 Outside diff range and nitpick comments (3)
hooks/paymaster.tsx (3)

67-67: Clarify the comment about conditional enabling

The comment suggests conditional enabling/disabling based on wallet and deployment info, but the code now always enables the paymaster. Consider either:

  1. Removing the comment since it doesn't reflect the current implementation, or
  2. Implementing the suggested conditional logic if there are specific cases where the paymaster should be disabled.

Line range hint 174-209: Enhance error handling for typed data fetch

While the paymaster enabling logic is correct, consider improving the error handling:

  1. The error is only logged to console, making it difficult for users to understand failures
  2. The error state isn't tracked, so the UI can't show appropriate feedback

Consider this enhancement:

  .catch((error) => {
+   setTypedData(null);
+   setTypedDataError({
+     message: error.message,
+     short: "Failed to prepare transaction"
+   });
    console.error("Error when fetching deployment typed data:", error);
  });

Line range hint 214-246: Consider splitting handleRegister into smaller functions

The function handles multiple responsibilities: signing data, making API calls, and error handling. Consider breaking it down for better maintainability:

const executeWithPaymaster = async (signature: Signature) => {
  const body = buildPaymasterRequestBody(signature);
  try {
    const response = await fetch(`${gaslessOptions.baseUrl}/gasless/v1/execute`, {
      method: "POST",
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify(body)
    });
    const data = await response.json();
    return then(data.transactionHash);
  } catch (error) {
    setPaymasterError({
      message: error.message,
      short: "Paymaster execution failed"
    });
    throw error;
  }
};

const handleRegister = useCallback(async () => {
  if (!account) return;
  try {
    if (typedData && paymasterEnabled) {
      const signature = await signTypedDataAsync(typedData);
      await executeWithPaymaster(signature);
    } else {
      const res = await execute();
      await then(res.transaction_hash);
    }
  } catch (error) {
    console.error("Transaction failed:", error);
  }
}, [/* ... dependencies ... */]);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between adf07a3 and 3e73a69.

📒 Files selected for processing (1)
  • hooks/paymaster.tsx (4 hunks)
🔇 Additional comments (2)
hooks/paymaster.tsx (2)

Line range hint 262-262: LGTM: Loading state correctly handles paymaster condition

The loading state correctly accounts for the paymaster being enabled, ensuring accurate UI feedback.


67-67: Verify impact of removing wallet-specific checks

Since we're removing the wallet-specific checks and enabling paymaster for all wallets, let's verify there are no assumptions about wallet types in dependent code.

✅ Verification successful

Based on the comprehensive analysis of the codebase, I can now generate the final response:

No impact from enabling paymaster for all wallets

The changes to enable paymaster for all wallets are safe because:

  • The paymaster functionality is self-contained within the usePaymaster hook
  • No other code in the codebase makes assumptions about wallet-specific paymaster behavior
  • The previous Argent-specific check was only used for enabling/disabling the feature, not for any wallet-specific logic
  • The paymaster implementation handles all wallets uniformly through standardized interfaces
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for code that might assume wallet-specific paymaster behavior
rg -l "argentX|argentMobile.*paymaster" --type typescript

# Search for potential wallet type checks in transaction handling
ast-grep --pattern 'if ($COND.includes("argent")) { $$$ }'

Length of output: 155


Script:

#!/bin/bash
# Search for code that might assume wallet-specific paymaster behavior
rg -l "argentX|argentMobile.*paymaster"

# Search for wallet-specific conditions related to paymaster
rg -A 2 "argent.*paymaster|paymaster.*argent" 

# Search for any wallet type checks in transaction handling
rg -A 2 "if.*argent.*\{|wallet.*argent"

Length of output: 691


Script:

#!/bin/bash
# Let's check the content of these files to understand the paymaster usage
cat hooks/paymaster.tsx
cat utils/connectorWrapper.ts

# Also check for any paymaster configuration or usage patterns
rg -A 3 "paymaster" 

Length of output: 34706

@fricoben fricoben merged commit 58149d6 into testnet Nov 19, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔥 Ready for review This pull request needs a review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants