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.

Sign up for GitHub

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

Jump to bottom

Update Faucet contract to use bridging on drip function #10621

Merged
merged 10 commits into from
May 29, 2024
Merged

Update Faucet contract to use bridging on drip function #10621

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
75ff32f
adding bridging to the faucet drip call
May 22, 2024
acb503a
updating the logic based on suggesstions
May 24, 2024
060b6f5
adding changeset
May 28, 2024
215d76b
fixing ci issue
May 28, 2024
0c593ea
update auth module tests
May 28, 2024
1b2c4d3
final fix
May 28, 2024
6ac95f2
lint fix
tremarkley May 28, 2024
017d17b
update snapshots
tremarkley May 28, 2024
958ff1d
update changeset
tremarkley May 28, 2024
039d2fd
change to patch
tremarkley May 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cold-frogs-join.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@eth-optimism/contracts-bedrock': major
---

Updating Faucet contract to allow bridging for recieving funds on other chains
10 changes: 8 additions & 2 deletions packages/contracts-bedrock/src/periphery/faucet/Faucet.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
pragma solidity 0.8.15;

import { IFaucetAuthModule } from "./authmodules/IFaucetAuthModule.sol";
import { SafeCall } from "../../libraries/SafeCall.sol";

/// @title SafeSend
/// @notice Sends ETH to a recipient account without triggering any code.
Expand All @@ -25,7 +26,9 @@ contract Faucet {
/// @notice Parameters for a drip.
struct DripParameters {
address payable recipient;
bytes data;
bytes32 nonce;
uint32 gasLimit;
}

/// @notice Parameters for authentication.
Expand Down Expand Up @@ -113,14 +116,17 @@ contract Faucet {
"Faucet: drip parameters could not be verified by security module"
);

// Verify recepient is not the faucet address.
require(_params.recipient != address(this), "Faucet: cannot drip to itself");

// Set the next timestamp at which this auth id can be used.
timeouts[_auth.module][_auth.id] = block.timestamp + config.ttl;

// Mark the nonce as used.
nonces[_auth.id][_params.nonce] = true;

// Execute a safe transfer of ETH to the recipient account.
new SafeSend{ value: config.amount }(_params.recipient);
// Execute transfer of ETH to the recipient account.
SafeCall.call(_params.recipient, _params.gasLimit, config.amount, _params.data);

emit Drip(config.name, _auth.id, config.amount, _params.recipient);
}
Expand Down
44 changes: 31 additions & 13 deletions packages/contracts-bedrock/test/periphery/faucet/Faucet.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@ contract FaucetTest is Faucet_Initializer {
function test_authAdmin_drip_succeeds() external {
_enableFaucetAuthModules();
bytes32 nonce = faucetHelper.consumeNonce();
bytes memory data = "0x";
uint32 gasLimit = 200000;
bytes memory signature = issueProofWithEIP712Domain(
faucetAuthAdminKey,
bytes(optimistNftFamName),
Expand All @@ -119,14 +121,16 @@ contract FaucetTest is Faucet_Initializer {

vm.prank(nonAdmin);
faucet.drip(
Faucet.DripParameters(payable(fundsReceiver), nonce),
Faucet.DripParameters(payable(fundsReceiver), data, nonce, gasLimit),
Faucet.AuthParameters(optimistNftFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
);
}

function test_nonAdmin_drip_fails() external {
_enableFaucetAuthModules();
bytes32 nonce = faucetHelper.consumeNonce();
bytes memory data = "0x";
uint32 gasLimit = 200000;
bytes memory signature = issueProofWithEIP712Domain(
nonAdminKey,
bytes(optimistNftFamName),
Expand All @@ -141,14 +145,16 @@ contract FaucetTest is Faucet_Initializer {
vm.prank(nonAdmin);
vm.expectRevert("Faucet: drip parameters could not be verified by security module");
faucet.drip(
Faucet.DripParameters(payable(fundsReceiver), nonce),
Faucet.DripParameters(payable(fundsReceiver), data, nonce, gasLimit),
Faucet.AuthParameters(optimistNftFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
);
}

function test_drip_optimistNftSendsCorrectAmount_succeeds() external {
_enableFaucetAuthModules();
bytes32 nonce = faucetHelper.consumeNonce();
bytes memory data = "0x";
uint32 gasLimit = 200000;
bytes memory signature = issueProofWithEIP712Domain(
faucetAuthAdminKey,
bytes(optimistNftFamName),
Expand All @@ -163,7 +169,7 @@ contract FaucetTest is Faucet_Initializer {
uint256 recipientBalanceBefore = address(fundsReceiver).balance;
vm.prank(nonAdmin);
faucet.drip(
Faucet.DripParameters(payable(fundsReceiver), nonce),
Faucet.DripParameters(payable(fundsReceiver), data, nonce, gasLimit),
Faucet.AuthParameters(optimistNftFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
);
uint256 recipientBalanceAfter = address(fundsReceiver).balance;
Expand All @@ -173,6 +179,8 @@ contract FaucetTest is Faucet_Initializer {
function test_drip_githubSendsCorrectAmount_succeeds() external {
_enableFaucetAuthModules();
bytes32 nonce = faucetHelper.consumeNonce();
bytes memory data = "0x";
uint32 gasLimit = 200000;
bytes memory signature = issueProofWithEIP712Domain(
faucetAuthAdminKey,
bytes(githubFamName),
Expand All @@ -187,7 +195,7 @@ contract FaucetTest is Faucet_Initializer {
uint256 recipientBalanceBefore = address(fundsReceiver).balance;
vm.prank(nonAdmin);
faucet.drip(
Faucet.DripParameters(payable(fundsReceiver), nonce),
Faucet.DripParameters(payable(fundsReceiver), data, nonce, gasLimit),
Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
);
uint256 recipientBalanceAfter = address(fundsReceiver).balance;
Expand All @@ -197,6 +205,8 @@ contract FaucetTest is Faucet_Initializer {
function test_drip_emitsEvent_succeeds() external {
_enableFaucetAuthModules();
bytes32 nonce = faucetHelper.consumeNonce();
bytes memory data = "0x";
uint32 gasLimit = 200000;
bytes memory signature = issueProofWithEIP712Domain(
faucetAuthAdminKey,
bytes(githubFamName),
Expand All @@ -213,14 +223,16 @@ contract FaucetTest is Faucet_Initializer {

vm.prank(nonAdmin);
faucet.drip(
Faucet.DripParameters(payable(fundsReceiver), nonce),
Faucet.DripParameters(payable(fundsReceiver), data, nonce, gasLimit),
Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
);
}

function test_drip_disabledModule_reverts() external {
_enableFaucetAuthModules();
bytes32 nonce = faucetHelper.consumeNonce();
bytes memory data = "0x";
uint32 gasLimit = 200000;
bytes memory signature = issueProofWithEIP712Domain(
faucetAuthAdminKey,
bytes(githubFamName),
Expand All @@ -234,15 +246,15 @@ contract FaucetTest is Faucet_Initializer {

vm.startPrank(faucetContractAdmin);
faucet.drip(
Faucet.DripParameters(payable(fundsReceiver), nonce),
Faucet.DripParameters(payable(fundsReceiver), data, nonce, gasLimit),
Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
);

faucet.configure(githubFam, Faucet.ModuleConfig("GithubModule", false, 1 days, 0.05 ether));

vm.expectRevert("Faucet: provided auth module is not supported by this faucet");
faucet.drip(
Faucet.DripParameters(payable(fundsReceiver), nonce),
Faucet.DripParameters(payable(fundsReceiver), data, nonce, gasLimit),
Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
);
vm.stopPrank();
Expand All @@ -251,6 +263,8 @@ contract FaucetTest is Faucet_Initializer {
function test_drip_preventsReplayAttacks_succeeds() external {
_enableFaucetAuthModules();
bytes32 nonce = faucetHelper.consumeNonce();
bytes memory data = "0x";
uint32 gasLimit = 200000;
bytes memory signature = issueProofWithEIP712Domain(
faucetAuthAdminKey,
bytes(githubFamName),
Expand All @@ -264,13 +278,13 @@ contract FaucetTest is Faucet_Initializer {

vm.startPrank(faucetContractAdmin);
faucet.drip(
Faucet.DripParameters(payable(fundsReceiver), nonce),
Faucet.DripParameters(payable(fundsReceiver), data, nonce, gasLimit),
Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
);

vm.expectRevert("Faucet: nonce has already been used");
faucet.drip(
Faucet.DripParameters(payable(fundsReceiver), nonce),
Faucet.DripParameters(payable(fundsReceiver), data, nonce, gasLimit),
Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
);
vm.stopPrank();
Expand All @@ -279,6 +293,8 @@ contract FaucetTest is Faucet_Initializer {
function test_drip_beforeTimeout_reverts() external {
_enableFaucetAuthModules();
bytes32 nonce0 = faucetHelper.consumeNonce();
bytes memory data = "0x";
uint32 gasLimit = 200000;
bytes memory signature0 = issueProofWithEIP712Domain(
faucetAuthAdminKey,
bytes(githubFamName),
Expand All @@ -292,7 +308,7 @@ contract FaucetTest is Faucet_Initializer {

vm.startPrank(faucetContractAdmin);
faucet.drip(
Faucet.DripParameters(payable(fundsReceiver), nonce0),
Faucet.DripParameters(payable(fundsReceiver), data, nonce0, gasLimit),
Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature0)
);

Expand All @@ -310,7 +326,7 @@ contract FaucetTest is Faucet_Initializer {

vm.expectRevert("Faucet: auth cannot be used yet because timeout has not elapsed");
faucet.drip(
Faucet.DripParameters(payable(fundsReceiver), nonce1),
Faucet.DripParameters(payable(fundsReceiver), data, nonce1, gasLimit),
Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature1)
);
vm.stopPrank();
Expand All @@ -319,6 +335,8 @@ contract FaucetTest is Faucet_Initializer {
function test_drip_afterTimeout_succeeds() external {
_enableFaucetAuthModules();
bytes32 nonce0 = faucetHelper.consumeNonce();
bytes memory data = "0x";
uint32 gasLimit = 200000;
bytes memory signature0 = issueProofWithEIP712Domain(
faucetAuthAdminKey,
bytes(githubFamName),
Expand All @@ -332,7 +350,7 @@ contract FaucetTest is Faucet_Initializer {

vm.startPrank(faucetContractAdmin);
faucet.drip(
Faucet.DripParameters(payable(fundsReceiver), nonce0),
Faucet.DripParameters(payable(fundsReceiver), data, nonce0, gasLimit),
Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature0)
);

Expand All @@ -350,7 +368,7 @@ contract FaucetTest is Faucet_Initializer {

vm.warp(startingTimestamp + 1 days + 1 seconds);
faucet.drip(
Faucet.DripParameters(payable(fundsReceiver), nonce1),
Faucet.DripParameters(payable(fundsReceiver), data, nonce1, gasLimit),
Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature1)
);
vm.stopPrank();
Expand Down
12 changes: 9 additions & 3 deletions packages/contracts-bedrock/test/periphery/faucet/authmodules/AdminFaucetAuthModule.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ contract AdminFaucetAuthModuleTest is Test {
/// @notice Assert that verify returns true for valid proofs signed by admins.
function test_adminProof_verify_succeeds() external {
bytes32 nonce = faucetHelper.consumeNonce();
bytes memory data = "0x";
uint32 gasLimit = 200000;
address fundsReceiver = makeAddr("fundsReceiver");
bytes memory proof = issueProofWithEIP712Domain(
adminKey,
Expand All @@ -96,7 +98,7 @@ contract AdminFaucetAuthModuleTest is Test {
vm.prank(nonAdmin);
assertEq(
adminFam.verify(
Faucet.DripParameters(payable(fundsReceiver), nonce), keccak256(abi.encodePacked(fundsReceiver)), proof
Faucet.DripParameters(payable(fundsReceiver), data, nonce, gasLimit), keccak256(abi.encodePacked(fundsReceiver)), proof
),
true
);
Expand All @@ -105,6 +107,8 @@ contract AdminFaucetAuthModuleTest is Test {
/// @notice Assert that verify returns false for proofs signed by nonadmins.
function test_nonAdminProof_verify_succeeds() external {
bytes32 nonce = faucetHelper.consumeNonce();
bytes memory data = "0x";
uint32 gasLimit = 200000;
address fundsReceiver = makeAddr("fundsReceiver");
bytes memory proof = issueProofWithEIP712Domain(
nonAdminKey,
Expand All @@ -120,7 +124,7 @@ contract AdminFaucetAuthModuleTest is Test {
vm.prank(admin);
assertEq(
adminFam.verify(
Faucet.DripParameters(payable(fundsReceiver), nonce), keccak256(abi.encodePacked(fundsReceiver)), proof
Faucet.DripParameters(payable(fundsReceiver), data, nonce, gasLimit), keccak256(abi.encodePacked(fundsReceiver)), proof
),
false
);
Expand All @@ -130,6 +134,8 @@ contract AdminFaucetAuthModuleTest is Test {
/// than the id in the call to verify.
function test_proofWithWrongId_verify_succeeds() external {
bytes32 nonce = faucetHelper.consumeNonce();
bytes memory data = "0x";
uint32 gasLimit = 200000;
address fundsReceiver = makeAddr("fundsReceiver");
address randomAddress = makeAddr("randomAddress");
bytes memory proof = issueProofWithEIP712Domain(
Expand All @@ -146,7 +152,7 @@ contract AdminFaucetAuthModuleTest is Test {
vm.prank(admin);
assertEq(
adminFam.verify(
Faucet.DripParameters(payable(fundsReceiver), nonce), keccak256(abi.encodePacked(randomAddress)), proof
Faucet.DripParameters(payable(fundsReceiver), data, nonce, gasLimit), keccak256(abi.encodePacked(fundsReceiver)), proof
tarunkhasnavis marked this conversation as resolved.
Show resolved Hide resolved
),
false
);
Expand Down