Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ out/
!/broadcast
/broadcast/*/31337/
/broadcast/**/dry-run/
/broadcast/

# Docs
docs/
Expand Down
14 changes: 14 additions & 0 deletions script/DeployFaucetFactory.s.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;
import {Script} from "forge-std/Script.sol";
import {FaucetFactory} from "../src/FaucetFactory.sol";
import {console} from "forge-std/console.sol";
contract DeployFaucetFactory is Script {
function run() external returns(address ) {
vm.startBroadcast();
FaucetFactory factory = new FaucetFactory();
vm.stopBroadcast();
console.log("Factory deployed to:", address(factory));
return address(factory);
}
}
21 changes: 21 additions & 0 deletions script/DeployPolicies.s.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;
import {GlobalCapPolicy} from "../src/GlobalCapPolicy.sol";
import {UserCapPolicy} from "../src/UserCapPolicy.sol";
import {MaxCooldownPolicy} from "../src/MaxCooldownPolicy.sol";
import {Script} from "forge-std/Script.sol";
import {console} from "forge-std/console.sol";

contract DeployPolicies is Script {
function run() external returns (address , address , address ) {
vm.startBroadcast();
GlobalCapPolicy globalCapPolicy = new GlobalCapPolicy(2 ether, 0.1 ether);
UserCapPolicy userCapPolicy = new UserCapPolicy(0.5 ether, 0.1 ether);
MaxCooldownPolicy maxCooldownPolicy = new MaxCooldownPolicy(1 hours);
vm.stopBroadcast();
console.log("GlobalCapPolicy deployed to: ", address(globalCapPolicy));
console.log("UserCapPolicy deployed to: ", address(userCapPolicy));
console.log("MaxCooldownPolicy deployed to: ", address(maxCooldownPolicy));
return (address(globalCapPolicy), address(userCapPolicy), address(maxCooldownPolicy));
}
}
8 changes: 6 additions & 2 deletions src/ERC20Faucet.sol
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ contract ERC20Faucet is ReentrancyGuard, Pausable, Initializable {
function initialize( address _token, uint256 _dripAmount, address[] memory _policies) external initializer {
token = IERC20(_token);
dripAmount = _dripAmount;
policies = IFaucetPolicy[](_policies);
for (uint256 i = 0; i < _policies.length; i++) {
policies.push(IFaucetPolicy(_policies[i]));
}
}

/*//////////////////////////////////////////////////////////////
Expand All @@ -55,7 +57,9 @@ contract ERC20Faucet is ReentrancyGuard, Pausable, Initializable {
hasClaimed[msg.sender] = true;

token.safeTransfer(msg.sender, dripAmount);

for (uint256 i = 0; i < policies.length; i++) {
policies[i].afterClaim(msg.sender);
}
emit Claimed(msg.sender, dripAmount);
}
}
10 changes: 8 additions & 2 deletions src/EthFaucet.sol
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,16 @@ contract EthFaucet is Pausable, ReentrancyGuard, Initializable {

function initialize(uint256 _dripAmount, address[] memory _policies) external initializer {
dripAmount = _dripAmount;
policies = IFaucetPolicy[](_policies);
for (uint256 i = 0; i < _policies.length; i++) {
policies.push(IFaucetPolicy(_policies[i]));
}
}

/*//////////////////////////////////////////////////////////////
FUNCTIONS
//////////////////////////////////////////////////////////////*/

function claimETH() external nonReentrant whenNotPaused {
function claim() external nonReentrant whenNotPaused {
for (uint256 i = 0; i < policies.length; i++) {
if (!policies[i].validateClaim(msg.sender)) revert EthFaucet__ValidationFailed();
}
Expand All @@ -52,6 +54,10 @@ contract EthFaucet is Pausable, ReentrancyGuard, Initializable {

(bool success,) = payable(msg.sender).call{value:dripAmount}("");
if (!success) revert EthFaucet__TransferFailed();
for (uint256 i = 0; i < policies.length; i++) {
policies[i].afterClaim(msg.sender);
}
emit Claimed(msg.sender, dripAmount);
}
receive() external payable {}
}
4 changes: 2 additions & 2 deletions src/FaucetFactory.sol
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,13 @@ contract FaucetFactory {

function createErc20Faucet(address _token, uint256 _dripAmount, address[] memory policies)
public
returns (address)
returns (address faucet)
{
if (userFaucetClone[msg.sender][1] != address(0)) revert FaucetFactory__FaucetAlreadyCreated();
bytes32 salt = keccak256(abi.encodePacked(msg.sender));
address predictedAddress = Clones.predictDeterministicAddress(i_Erc20FaucetImplementation, salt);
if (predictedAddress.code.length != 0) revert FaucetFactory__FaucetAlreadyCreated();
address faucet = Clones.cloneDeterministic(i_Erc20FaucetImplementation, salt);
faucet = Clones.cloneDeterministic(i_Erc20FaucetImplementation, salt);
userFaucetClone[msg.sender][1] = faucet;
try ERC20Faucet(payable(faucet)).initialize(_token, _dripAmount, policies) {}
catch {
Expand Down
9 changes: 4 additions & 5 deletions src/GlobalCapPolicy.sol
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;
import {IFaucetPolicy} from "./interfaces/IFaucetPolicy.sol";

contract GlobalCapPolicy is IFaucetPolicy {
/*//////////////////////////////////////////////////////////////
TYPES
//////////////////////////////////////////////////////////////*/


/*//////////////////////////////////////////////////////////////
STATE VARIABLES
//////////////////////////////////////////////////////////////*/
Expand All @@ -18,13 +18,11 @@ contract GlobalCapPolicy is IFaucetPolicy {
EVENTS
//////////////////////////////////////////////////////////////*/


/*//////////////////////////////////////////////////////////////
ERRORS
//////////////////////////////////////////////////////////////*/


/*CONSTRUCTOR*/
/*CONSTRUCTOR*/
constructor(uint256 _globalCap, uint256 _dripAmount) {
globalCap = _globalCap;
dripAmount = _dripAmount;
Expand All @@ -37,7 +35,8 @@ contract GlobalCapPolicy is IFaucetPolicy {
function validateClaim(address user) public view override returns (bool) {
return totalDistributed + dripAmount <= globalCap;
}

function afterClaim(address user) public override {
totalDistributed += dripAmount;
}
}
}
3 changes: 2 additions & 1 deletion src/MaxCooldownPolicy.sol
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;
import {IFaucetPolicy} from "./interfaces/IFaucetPolicy.sol";

contract MaxCoolDownPolicy is IFaucetPolicy {
contract MaxCooldownPolicy is IFaucetPolicy {
/*//////////////////////////////////////////////////////////////
TYPES
//////////////////////////////////////////////////////////////*/
Expand Down
1 change: 1 addition & 0 deletions src/UserCapPolicy.sol
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;
import {IFaucetPolicy} from "./interfaces/IFaucetPolicy.sol";

contract UserCapPolicy is IFaucetPolicy {
/*//////////////////////////////////////////////////////////////
Expand Down
Loading