Update Faucet contract to use bridging on drip function #10621

tarunkhasnavis · 2024-05-22T21:33:26Z

This PR aims to update our Faucet contract design by modifying the drip function.

We introduce a new parameter to the drip function _bridge which is expected to be an address to the L1Standard bridge for a given OP Chain.
We then create an interface for the L1StandardBridge and utilize the depositETHTo function within the drip function. the specified bridge address is the target contract for the function.
In the case that the recipient is expecting to receive test ETH on L1 Sepolia itself we expect a null address (address(0)). The backend will supply a null address as the bridge param for this case
We have updated the unit tests to reflect these changes

More context: https://www.notion.so/oplabs/Superchain-Faucet-in-Dev-Console-dea77a1062b24b40abc0f0752c111dc1?pvs=4#7a7014cac2b34560893115ebe4e2e6a2

coderabbitai · 2024-05-22T21:33:35Z

Walkthrough

The updates primarily enhance the Faucet.sol contract by adding support for bridging funds to other chains, introducing new parameters (data and gasLimit) to the DripParameters struct, and ensuring safe ETH transfers using SafeCall.call. Additionally, corresponding tests have been updated to reflect these changes, ensuring comprehensive verification of the new functionalities.

Changes

Files/Paths	Change Summaries
`packages/contracts-bedrock/src/periphery/faucet/Faucet.sol`	Added `SafeCall` import, modified `DripParameters` struct, added recipient check, updated `drip` function, and modified `Drip` event.
`packages/contracts-bedrock/test/periphery/faucet/Faucet.t.sol`	Introduced `bridgeAddress` variable and updated `faucet.drip` function calls to include new parameters.
`packages/contracts-bedrock/test/periphery/faucet/authmodules/AdminFaucetAuthModule.t.sol`	Updated test functions to include `data` and `gasLimit` variables in `Faucet.DripParameters` struct.
`.changeset/selfish-donuts-camp.md`, `.changeset/cold-frogs-join.md`, `.changeset/...`	Introduced changesets documenting the updates to the `@eth-optimism/contracts-bedrock` package.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant Faucet
    participant SafeCall
    participant Bridge

    User->>Faucet: Call drip(recipient, amount, bridge, data, gasLimit)
    Faucet->>Faucet: Check recipient != faucet address
    Faucet->>SafeCall: SafeCall.call{value: amount}(recipient, data, gasLimit)
    SafeCall-->>Faucet: Transfer status
    Faucet->>Bridge: Log Drip event with bridge parameter
    Faucet-->>User: Drip transaction completed

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 958ff1d and 039d2fd.

Files selected for processing (1)

.changeset/witty-pants-move.md (1 hunks)

Additional comments not posted (1)

.changeset/witty-pants-move.md (1)

1-5: The changeset documentation is clear and aligns well with the PR's objectives.

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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 full the 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

packages/contracts-bedrock/src/periphery/faucet/Faucet.sol

tremarkley

I think you will need to add a changeset to this, but would confirm with member of the smart contracts team

semgrep-app · 2024-05-24T22:42:55Z

Semgrep found 2 invalid-usage-of-modified-variable findings:

op-conductor/conductor/service.go
- L668-678 - Triage
- L668-678 - Triage

Variable unsafeInNode is likely modified and later used on error. In some cases this could result in panics due to a nil dereference

_{Ignore this finding from invalid-usage-of-modified-variable.}

coderabbitai

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

.changeset/cold-frogs-join.md (1)

5-5: Typographical error in the description. Consider correcting "recieving" to "receiving".

smartcontracts

Nice work

packages/contracts-bedrock/test/periphery/faucet/authmodules/AdminFaucetAuthModule.t.sol

semgrep-app · 2024-05-28T18:34:03Z

Semgrep found 2 invalid-usage-of-modified-variable findings:

op-conductor/conductor/service.go
- L668-678 - Triage
- L668-678 - Triage

Variable unsafeInNode is likely modified and later used on error. In some cases this could result in panics due to a nil dereference

_{Ignore this finding from invalid-usage-of-modified-variable.}

codecov · 2024-05-28T18:46:26Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 39.26%. Comparing base (3b374c2) to head (039d2fd).
Report is 30 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff              @@
##           develop   #10621       +/-   ##
============================================
- Coverage    55.13%   39.26%   -15.88%     
============================================
  Files           37       27       -10     
  Lines         2900     1821     -1079     
  Branches       415      415               
============================================
- Hits          1599      715      -884     
+ Misses        1269     1106      -163     
+ Partials        32        0       -32

Flag	Coverage Δ
cannon-go-tests	`?`
chain-mon-tests	`27.14% <ø> (ø)`
sdk-tests	`40.27% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

see 10 files with indirect coverage changes

magkooh

packages/contracts-bedrock/snapshots/abi/AdminFaucetAuthModule.json

…imism#10621) * adding bridging to the faucet drip call * updating the logic based on suggesstions * adding changeset * fixing ci issue * update auth module tests * final fix * lint fix * update snapshots * update changeset * change to patch --------- Co-authored-by: Tarun Khasnavis <tarunkhasnavis@Taruns-MacBook-Pro.local> Co-authored-by: tre <tremarkley@gmail.com>

adding bridging to the faucet drip call

75ff32f

tarunkhasnavis requested a review from a team as a code owner May 22, 2024 21:33

tarunkhasnavis requested a review from maurelian May 22, 2024 21:33

tarunkhasnavis changed the title ~~adding bridging to the faucet drip call~~ Update Faucet contract to use bridging on drip function May 22, 2024

tarunkhasnavis requested a review from tremarkley May 22, 2024 21:33

semgrep-app bot reviewed May 22, 2024

View reviewed changes

packages/contracts-bedrock/src/periphery/faucet/Faucet.sol Outdated Show resolved Hide resolved

tremarkley approved these changes May 22, 2024

View reviewed changes

tarunkhasnavis requested a review from tynes May 22, 2024 21:50

smartcontracts reviewed May 23, 2024

View reviewed changes

packages/contracts-bedrock/src/periphery/faucet/Faucet.sol Outdated Show resolved Hide resolved

tremarkley reviewed May 23, 2024

View reviewed changes

updating the logic based on suggesstions

acb503a

tremarkley requested a review from smartcontracts May 25, 2024 03:50

tremarkley approved these changes May 25, 2024

View reviewed changes

adding changeset

060b6f5

tarunkhasnavis force-pushed the faucet_bridging_implementation branch from 95e0c9d to 060b6f5 Compare May 28, 2024 05:48

coderabbitai bot reviewed May 28, 2024

View reviewed changes

smartcontracts approved these changes May 28, 2024

View reviewed changes

tremarkley approved these changes May 28, 2024

View reviewed changes

packages/contracts-bedrock/test/periphery/faucet/authmodules/AdminFaucetAuthModule.t.sol Outdated Show resolved Hide resolved

tarunkhasnavis requested review from a team, 0x00101010, zhwrd, mslipper, protolambda, trianglesphere and ajsutton as code owners May 28, 2024 18:13

tarunkhasnavis force-pushed the faucet_bridging_implementation branch from b5d433f to 060b6f5 Compare May 28, 2024 18:25

fixing ci issue

215d76b

Tarun Khasnavis and others added 3 commits May 28, 2024 11:48

update auth module tests

0c593ea

final fix

1b2c4d3

lint fix

6ac95f2

tremarkley enabled auto-merge May 28, 2024 22:27

update snapshots

017d17b

tremarkley added this pull request to the merge queue May 28, 2024

tremarkley removed this pull request from the merge queue due to a manual request May 28, 2024

tremarkley added 2 commits May 28, 2024 16:23

update changeset

958ff1d

change to patch

039d2fd

tremarkley enabled auto-merge May 28, 2024 23:27

tremarkley added this pull request to the merge queue May 28, 2024

Merged via the queue into develop with commit eb454ac May 29, 2024
69 checks passed

tremarkley deleted the faucet_bridging_implementation branch May 29, 2024 00:07

This was referenced May 29, 2024

Version Packages #10672

Closed

Version Packages #10673

Closed

magkooh reviewed Jun 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Faucet contract to use bridging on drip function #10621

Update Faucet contract to use bridging on drip function #10621

tarunkhasnavis commented May 22, 2024 •

edited

Loading

coderabbitai bot commented May 22, 2024 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s) (Beta)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

tremarkley left a comment

semgrep-app bot commented May 24, 2024

coderabbitai bot left a comment

smartcontracts left a comment

semgrep-app bot commented May 28, 2024

codecov bot commented May 28, 2024 •

edited

Loading

magkooh left a comment

Update Faucet contract to use bridging on drip function #10621

Update Faucet contract to use bridging on drip function #10621

Conversation

tarunkhasnavis commented May 22, 2024 • edited Loading

coderabbitai bot commented May 22, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s) (Beta)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

tremarkley left a comment

Choose a reason for hiding this comment

semgrep-app bot commented May 24, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

smartcontracts left a comment

Choose a reason for hiding this comment

semgrep-app bot commented May 28, 2024

codecov bot commented May 28, 2024 • edited Loading

Codecov Report

magkooh left a comment

Choose a reason for hiding this comment

tarunkhasnavis commented May 22, 2024 •

edited

Loading

coderabbitai bot commented May 22, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

codecov bot commented May 28, 2024 •

edited

Loading