feat: create `deploySingleRequestProxy` functionality in the sdk

[aimensahnoun]

Description of the changes

[coderabbitai[bot]]

Walkthrough

The changes in this pull request introduce a new module for managing Single Request Proxy contracts within the payment-processor package. Key additions include the implementation of multiple asynchronous functions for deploying and processing payments through Single Request Proxy contracts, alongside comprehensive unit tests for these functionalities. The export capabilities of the payment-processor module are enhanced to include the new proxy functionalities. Additionally, updates to the RequestNetwork class improve payment request handling by incorporating fee information.

Changes

File	Change Summary
packages/payment-processor/src/index.ts	Added export statement for single-request-proxy.
packages/payment-processor/src/payment/single-request-proxy.ts	Introduced multiple async functions: deploySingleRequestProxy, validateSingleRequestProxy, payWithERC20SingleRequestProxy, payWithEthereumSingleRequestProxy, and payRequestWithSingleRequestProxy.
packages/payment-processor/test/payment/single-request-proxy.test.ts	Created unit tests for the new functions, covering various payment scenarios and error handling.
packages/request-client.js/src/api/request-network.ts	Modified prepareRequestDataForPayment to include feeAddress and feeAmount.
packages/smart-contracts/scripts/test-deploy-all.ts	Added import and call to deploySingleRequestProxyFactory in the deployment sequence.
packages/smart-contracts/scripts/test-deploy-single-request-proxy.ts	Introduced deploySingleRequestProxyFactory function for deploying the SingleRequestProxyFactory contract.
packages/smart-contracts/src/lib/artifacts/SingleRequestProxyFactory/0.1.0.json	Added ABI definition for SingleRequestProxyFactory with relevant functions and events.
packages/smart-contracts/src/lib/artifacts/SingleRequestProxyFactory/index.ts	Created index file exporting singleRequestProxyFactoryArtifact.
packages/smart-contracts/src/lib/artifacts/index.ts	Added export statement for SingleRequestProxyFactory.
packages/smart-contracts/src/contracts/SingleRequestProxyFactory.sol	Updated event signatures for EthereumSingleRequestProxyCreated and ERC20SingleRequestProxyCreated.

Assessment against linked issues

Objective	Addressed	Explanation
Support SingleRequestProxy in payment-processor package (#[1396])	✅

Possibly related PRs

• #1453: Develops the SingleRequestProxy smart contracts, directly related to the new export statement for the single-request-proxy module.
• #1473: Refactors the SingleRequestProxyFactory, relevant to the same functionality being exported in the main PR.

Suggested reviewers

• yomarion
• kevindavee
• MantisClone
• sstefdev
• alexandre-abrioux

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 47afd3b3b9f836e4491ba07faad7bd13a4c01ec1 and 958ebf186763bc9185fe3886fb771481ff1dfde8.

📒 Files selected for processing (1)

• packages/payment-processor/src/payment/single-request-proxy.ts (1 hunks)

🧰 Additional context used

📓 Learnings (1)

packages/payment-processor/src/payment/single-request-proxy.ts (3)

Learnt from: MantisClone
PR: RequestNetwork/requestNetwork#1474
File: packages/payment-processor/src/payment/single-request-proxy.ts:156-160
Timestamp: 2024-10-28T15:52:05.032Z
Learning: When determining if a `SingleRequestProxy` is an `ERC20SingleRequestProxy` or an `EthereumSingleRequestProxy`, include a comment explaining that the presence of `tokenAddress` distinguishes between the two.

Learnt from: aimensahnoun
PR: RequestNetwork/requestNetwork#1474
File: packages/payment-processor/src/payment/single-request-proxy.ts:202-209
Timestamp: 2024-10-29T09:00:54.169Z
Learning: In the `packages/payment-processor/src/payment/single-request-proxy.ts` file, within the `payWithEthereumSingleRequestProxy` function, the current error handling is acceptable as per the project's expectations.

Learnt from: MantisClone
PR: RequestNetwork/requestNetwork#1474
File: packages/payment-processor/src/payment/single-request-proxy.ts:156-160
Timestamp: 2024-10-28T15:52:05.032Z
Learning: In the `payRequestWithSingleRequestProxy` function of `single-request-proxy.ts`, failing to retrieve `tokenAddress()` is expected for `EthereumSingleRequestProxy` contracts and is not an error.

🔇 Additional comments (5)

packages/payment-processor/src/payment/single-request-proxy.ts (5)

24-107: Function deploySingleRequestProxy is well-implemented

The function correctly handles the deployment of Single Request Proxy contracts, including validation of payment networks, error handling, and transaction management.

---

115-135: Function validateSingleRequestProxy performs necessary contract validation

The validation logic ensures that the proxy contract has the required methods, enhancing the reliability of the system.

---

144-179: Function payWithERC20SingleRequestProxy correctly processes ERC20 payments

The function handles ERC20 token transfers and triggers the proxy's receive function appropriately.

---

188-222: Function payWithEthereumSingleRequestProxy correctly processes Ethereum payments

The function handles ETH transfers to the proxy contract, ensuring proper execution of Ethereum payments.

---

240-271: Function payRequestWithSingleRequestProxy accurately delegates to appropriate payment functions

The function determines the proxy type and calls the correct payment function, enhancing usability and maintaining code modularity.

---

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