refactor: prepare SingleRequestFactory for deployment with Request Deployer

[aimensahnoun]

Refactor the SingleRequestProxyFactory to be deployed by using the Request Deployer.

• Add transferOwnership to construct to have the correct owner of smart contract instead of Request Deployer.
• Add SingleRequestProxyFactory to verify method
• Update tests to reflect the changes in constructor.

Summary by CodeRabbit

• New Features

  • Enhanced SingleRequestProxyFactory contract now includes an owner parameter for improved ownership management.
  • Updated functionality to return admin wallet address alongside fee proxy addresses for the SingleRequestProxyFactory.

• Bug Fixes

  • Improved validation in the constructor to prevent zero address for the owner.

• Tests

  • Updated test cases to validate the new owner parameter during contract deployment and ensure ownership functionalities are correctly enforced.

[coderabbitai]

Walkthrough

The pull request introduces modifications to the SingleRequestProxyFactory contract and its associated functions in the smart contracts package. Key changes include the addition of an _owner parameter in the constructor of the SingleRequestProxyFactory, updates to the getConstructorArgs function to include the admin wallet address, and the integration of a new case for SingleRequestProxyFactory in the VerifyCreate2FromList function. The overall control flow and error handling mechanisms remain consistent throughout the changes.

Changes

File Path	Change Summary
packages/smart-contracts/scripts-create2/constructor-args.ts	Updated getConstructorArgs to include getAdminWalletAddress(contract) for SingleRequestProxyFactory.
packages/smart-contracts/scripts-create2/verify.ts	Added case for SingleRequestProxyFactory in VerifyCreate2FromList function.
packages/smart-contracts/src/contracts/SingleRequestProxyFactory.sol	Updated constructor to accept an additional _owner parameter and enforced ownership checks.
packages/smart-contracts/test/contracts/SingleRequestProxyFactory.test.ts	Modified tests to include ownerAddress during deployment of SingleRequestProxyFactory.

Possibly related PRs

• feat: Develop SingleRequestProxy Smart Contracts #1453: The changes in the main PR involve modifications to the SingleRequestProxyFactory, which is directly related to the development of the SingleRequestProxyFactory contract in PR feat: Develop SingleRequestProxy Smart Contracts #1453. Both PRs address the same contract and its functionality, including constructor updates and handling of specific contract types.

Suggested reviewers

• rodrigopavezi
• alexandre-abrioux
• kevindavee
• leoslr
• MantisClone
• sstefdev

---

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.

[coderabbitai]

Actionable comments posted: 4

🧹 Outside diff range comments (1)

packages/smart-contracts/test/contracts/SingleRequestProxyFactory.test.ts (1)

Line range hint 1-214: LGTM! Consider adding a test for the new constructor parameter.

The test file provides comprehensive coverage of the SingleRequestProxyFactory functionalities, including proxy creation, fee proxy updates, and ownership management. The existing tests align well with the contract's features and the recent changes.

For consistency and to fully cover the recent changes, consider adding a specific test case for the new constructor parameter. This test should verify that attempting to deploy the SingleRequestProxyFactory with an invalid owner address (e.g., zero address) results in a revert. For example:

it('should revert when deploying with zero address as owner', async () => {
  const SingleRequestProxyFactoryFactory = await ethers.getContractFactory(
    'SingleRequestProxyFactory',
  );
  await expect(
    SingleRequestProxyFactoryFactory.deploy(
      ethereumFeeProxy.address,
      erc20FeeProxy.address,
      ethers.constants.AddressZero
    )
  ).to.be.revertedWith('Owner address cannot be zero');
});

This addition would ensure that the new constructor parameter is thoroughly tested, including its error handling.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 0abba7f and 3c96183.

📒 Files selected for processing (4)

• packages/smart-contracts/scripts-create2/constructor-args.ts (1 hunks)
• packages/smart-contracts/scripts-create2/verify.ts (1 hunks)
• packages/smart-contracts/src/contracts/SingleRequestProxyFactory.sol (1 hunks)
• packages/smart-contracts/test/contracts/SingleRequestProxyFactory.test.ts (1 hunks)

🧰 Additional context used

📓 Learnings (1)

packages/smart-contracts/src/contracts/SingleRequestProxyFactory.sol (1)

Learnt from: MantisClone
PR: RequestNetwork/requestNetwork#1453
File: packages/smart-contracts/src/contracts/SingleRequestProxyFactory.sol:0-0
Timestamp: 2024-09-27T11:42:01.062Z
Learning: In the `createEthereumSingleRequestProxy` function, it's acceptable for `_feeAddress` to be the zero address, as setting the fee address to zero is a common practice. Adding zero address checks is unnecessary and adds extra gas cost.

🔇 Additional comments (1)

packages/smart-contracts/src/contracts/SingleRequestProxyFactory.sol (1)

Line range hint 44-120: LGTM! Unchanged parts are consistent with previous learnings.

The rest of the file remains unchanged, which is consistent with the PR objectives. I noticed that the createEthereumSingleRequestProxy function allows _feeAddress to be zero, which aligns with the previous learning:

In the createEthereumSingleRequestProxy function, it's acceptable for _feeAddress to be the zero address, as setting the fee address to zero is a common practice. Adding zero address checks is unnecessary and adds extra gas cost.

This approach maintains consistency and optimizes gas usage.

[MantisClone]

Nice work resolving the CodeRabbit comments with explanations!