fix: update out of date abi for single request proxy factory

[aimensahnoun]

Description of the changes

• Update abi in artifact for a more up to date abi.

Summary by CodeRabbit

• New Features

  • Updated event parameters in the SingleRequestProxyFactory contract for improved clarity in event logging.

• Bug Fixes

  • Adjusted indexed properties for specific event parameters to enhance query capabilities on the blockchain.

[coderabbitai]

Walkthrough

The pull request modifies the ABI of the SingleRequestProxyFactory contract, specifically changing the indexed property of the proxyAddress and payee parameters in the ERC20SingleRequestProxyCreated and EthereumSingleRequestProxyCreated events from true to false. This change means these parameters will not be indexed in event logs, impacting their queryability on the blockchain. Other elements such as function signatures and event definitions remain unchanged.

Changes

File	Change Summary
packages/smart-contracts/src/lib/artifacts/SingleRequestProxyFactory/0.1.0.json	Updated indexed property from true to false for proxyAddress and payee in two events.

Possibly related PRs

• feat: Develop SingleRequestProxy Smart Contracts #1453: Involves the development of the SingleRequestProxy smart contracts related to the SingleRequestProxyFactory ABI modifications.
• refactor: prepare SingleRequestFactory for deployment with Request Deployer #1473: Refactors the SingleRequestProxyFactory, including changes to the constructor and ownership management relevant to the event parameter updates.
• feat: create deploySingleRequestProxy functionality in the sdk #1474: Introduces functionalities for deploying and managing Single Request Proxy contracts, relevant to event logging changes in the main PR.

Suggested reviewers

• kevindavee
• rodrigopavezi
• sstefdev
• MantisClone

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between e91492c and e1223e3.

📒 Files selected for processing (1)

• packages/smart-contracts/src/lib/artifacts/SingleRequestProxyFactory/0.1.0.json (2 hunks)

🧰 Additional context used

📓 Learnings (1)

packages/smart-contracts/src/lib/artifacts/SingleRequestProxyFactory/0.1.0.json (2)

Learnt from: MantisClone
PR: RequestNetwork/requestNetwork#1474
File: packages/smart-contracts/src/lib/artifacts/SingleRequestProxyFactory/0.1.0.json:24-124
Timestamp: 2024-10-28T20:00:53.026Z
Learning: In our smart contracts, we should remove the `indexed` keyword from all event parameters except for `paymentReference`, as we use the payment-subgraph for indexing and this reduces gas costs.

Learnt from: MantisClone
PR: RequestNetwork/requestNetwork#1453
File: packages/smart-contracts/src/contracts/SingleRequestProxyFactory.sol:22-27
Timestamp: 2024-10-15T07:50:58.094Z
Learning: In the `SingleRequestProxyFactory` contract, the `paymentReference` parameter in events should remain `indexed`, even if removing `indexed` could reduce gas costs.

🔇 Additional comments (3)

packages/smart-contracts/src/lib/artifacts/SingleRequestProxyFactory/0.1.0.json (3)

41-47: LGTM! Changes align with indexing strategy.

Removing indexed from proxyAddress and payee parameters while keeping paymentReference indexed is the correct approach. This change:

• Reduces gas costs
• Maintains compatibility with the payment-subgraph indexing strategy

---

85-91: LGTM! Consistent with ERC20 event changes.

The changes to proxyAddress and payee parameters mirror those made to the ERC20 event, maintaining a consistent indexing strategy across both event types while preserving gas optimization benefits.

---

Line range hint 1-300: Verify no other indexed parameters need updating.

Let's ensure we haven't missed any parameters that should have their indexed property updated.

✅ Verification successful

All indexed parameters are correctly set in the ABI

The verification shows that the indexed parameters are properly set and consistent:

• Payment-related: paymentReference is correctly indexed in both events
• Proxy-related: newERC20FeeProxy and newEthereumFeeProxy are indexed in their respective update events
• Ownership-related: previousOwner and newOwner are indexed in the ownership transfer event

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining indexed parameters except paymentReference
# Expected: Only paymentReference and ownership-related parameters should be indexed

# Search for indexed parameters in the ABI
jq -r '.abi[] | select(.type=="event") | .inputs[] | select(.indexed==true) | "\(.name) in \(.type)"' "packages/smart-contracts/src/lib/artifacts/SingleRequestProxyFactory/0.1.0.json"

Length of output: 339

---

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.