add deploy scripts

Author: dv3-000

.env-example

@@ -25,6 +25,8 @@ REFUEL_ERC20_ACTION_GAS_CONSTANT=
 SWEEP_ACTION_GAS_CONSTANT=
 SWEEP_CCTP_ACTION_GAS_CONSTANT=
 SWEEP_DEPOSIT_ERC4626_ACTION_GAS_CONSTANT=
+REQUEST_DEPOSIT_ERC7540_ACTION_GAS_CONSTANT=
+SWEEP_REQUEST_DEPOSIT_ERC7540_ACTION_GAS_CONSTANT=
 SWEEP_ERC20_ACTION_GAS_CONSTANT=
 SWEEP_UNISWAP_V3_ACTION_GAS_CONSTANT=
 SWEEP_WITHDRAW_ERC4626_ACTION_GAS_CONSTANT=
@@ -48,6 +50,8 @@ EXPECTED_SWEEP_ERC20_ACTION_ADDRESS=
 EXPECTED_CALL_ONCE_ACTION_ADDRESS=
 EXPECTED_DEPOSIT_ERC4626_ACTION_ADDRESS=
 EXPECTED_SWEEP_DEPOSIT_ERC4626_ACTION_ADDRESS=
+EXPECTED_REQUEST_DEPOSIT_ERC7540_ACTION_ADDRESS=
+EXPECTED_SWEEP_REQUEST_DEPOSIT_ERC7540_ACTION_ADDRESS=
 EXPECTED_WITHDRAW_ERC4626_ACTION_ADDRESS=
 EXPECTED_SWEEP_WITHDRAW_ERC4626_ACTION_ADDRESS=
 

.gas-snapshot

@@ -40,11 +40,11 @@ CrossRatePriceFeedTest:test_latestRoundData_invalidDenominatorPrice(int256) (run
 CrossRatePriceFeedTest:test_latestRoundData_invalidNumeratorPrice(int256) (runs: 256, μ: 907390, ~: 907952)
 CrossRatePriceFeedTest:test_latestRoundData_realValuesFork() (gas: 70243)
 CrossRatePriceFeedTest:test_latestRoundData_realValuesFuzz18(int256,int256) (runs: 256, μ: 1301519, ~: 1301597)
-CrossRatePriceFeedTest:test_latestRoundData_realValuesFuzz8(int256,int256) (runs: 256, μ: 1301315, ~: 1301621)
-CrossRatePriceFeedTest:test_latestRoundData_revertsOnOverflow(int256) (runs: 256, μ: 935243, ~: 935235)
+CrossRatePriceFeedTest:test_latestRoundData_realValuesFuzz8(int256,int256) (runs: 256, μ: 1301321, ~: 1301621)
+CrossRatePriceFeedTest:test_latestRoundData_revertsOnOverflow(int256) (runs: 256, μ: 935241, ~: 935235)
 CrossRatePriceFeedTest:test_latestRoundData_roundIdOne() (gas: 60318)
-CrossRatePriceFeedTest:test_latestRoundData_staleDenominatorPrice(uint256) (runs: 256, μ: 906854, ~: 907132)
-CrossRatePriceFeedTest:test_latestRoundData_staleNumeratorPrice(uint256) (runs: 256, μ: 906768, ~: 907046)
+CrossRatePriceFeedTest:test_latestRoundData_staleDenominatorPrice(uint256) (runs: 256, μ: 906856, ~: 907132)
+CrossRatePriceFeedTest:test_latestRoundData_staleNumeratorPrice(uint256) (runs: 256, μ: 906770, ~: 907046)
 CrossRatePriceFeedTest:test_latestRoundData_startedAtZero() (gas: 60332)
 CrossRatePriceFeedTest:test_latestRoundData_usesEarlierUpdatedAt() (gas: 68898)
 DeactivateInstruction:test_deactivateInstruction_alreadyDeactivated() (gas: 20424)
@@ -83,23 +83,23 @@ DepositERC4626Test:test_depositERC4626_recipientZero() (gas: 36769)
 DepositERC4626Test:test_depositERC4626_totalSharesTooLow() (gas: 39187)
 DepositERC4626Test:test_depositERC4626_valueZero() (gas: 36815)
 DepositERC4626Test:test_depositERC4626_vaultZero() (gas: 36798)
-EstimateCallOnceGasConstant:testFuzz_callOnce_gasConstant(uint256,(address,bool,uint256,uint256,uint16,bytes4,bytes,(address,uint256,uint256,uint256))) (runs: 256, μ: 4182, ~: 3876)
-EstimateDeactivateInstructionGasConstant:testFuzz_deactivateInstruction_gasConstant(uint256,(bytes32,(address,uint256,uint256,uint256))) (runs: 256, μ: 1957, ~: 1941)
+EstimateCallOnceGasConstant:testFuzz_callOnce_gasConstant(uint256,(address,bool,uint256,uint256,uint16,bytes4,bytes,(address,uint256,uint256,uint256))) (runs: 256, μ: 4185, ~: 3876)
+EstimateDeactivateInstructionGasConstant:testFuzz_deactivateInstruction_gasConstant(uint256,(bytes32,(address,uint256,uint256,uint256))) (runs: 256, μ: 1963, ~: 1959)
 EstimateDepositERC4626GasConstant:testFuzz_depositERC4626_gasConstant(uint256,uint256,(address,address,uint256,uint256,uint256,(uint256,uint256,uint256,uint256),(address,uint256,uint256,uint256))) (runs: 256, μ: 4505, ~: 4452)
-EstimateRefuelERC20GasConstant:testFuzz_refuelERC20_gasConstant(uint256,uint256,(address,address,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 3014, ~: 3006)
-EstimateRefuelGasConstant:testFuzz_refuel_gasConstant(uint256,uint256,(address,uint256,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 2897, ~: 2835)
-EstimateSweepCCTPGasConstant:testFuzz_sweepCCTP_gasConstant(uint256,uint256,(address,uint32,bytes32,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 3341, ~: 3306)
+EstimateRefuelERC20GasConstant:testFuzz_refuelERC20_gasConstant(uint256,uint256,(address,address,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 3021, ~: 3024)
+EstimateRefuelGasConstant:testFuzz_refuel_gasConstant(uint256,uint256,(address,uint256,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 2892, ~: 2835)
+EstimateSweepCCTPGasConstant:testFuzz_sweepCCTP_gasConstant(uint256,uint256,(address,uint32,bytes32,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 3336, ~: 3306)
 EstimateSweepDepositERC4626GasConstant:testFuzz_sweepDepositERC4626_gasConstant(uint256,uint256,(address,address,uint256,uint256,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 3537, ~: 3516)
-EstimateSweepERC20GasConstant:testFuzz_sweepERC20_gasConstant(uint256,uint256,(address,address,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 3025, ~: 3042)
-EstimateSweepGasConstant:testFuzz_sweep_gasConstant(uint256,uint256,(address,uint256,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 2853, ~: 2808)
-EstimateSweepUniswapV3GasConstant:testFuzz_sweepUniswapV3_gasConstant(uint256,uint256,(address,address,address,uint24,uint256,uint256,uint256,uint32,uint32,(address,uint256,uint256,uint256))) (runs: 256, μ: 4427, ~: 4425)
+EstimateSweepERC20GasConstant:testFuzz_sweepERC20_gasConstant(uint256,uint256,(address,address,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 3019, ~: 3024)
+EstimateSweepGasConstant:testFuzz_sweep_gasConstant(uint256,uint256,(address,uint256,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 2849, ~: 2808)
+EstimateSweepUniswapV3GasConstant:testFuzz_sweepUniswapV3_gasConstant(uint256,uint256,(address,address,address,uint24,uint256,uint256,uint256,uint32,uint32,(address,uint256,uint256,uint256))) (runs: 256, μ: 4421, ~: 4398)
 EstimateSweepWithdrawERC4626GasConstant:testFuzz_sweepWithdrawERC4626_gasConstant(uint256,uint256,(address,address,uint256,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 3285, ~: 3288)
-EstimateTransferCCTPGasConstant:testFuzz_transferCCTP_gasConstant(uint256,uint256,(address,uint256,uint32,bytes32,(uint256,uint256,uint256,uint256),(address,uint256,uint256,uint256))) (runs: 256, μ: 4222, ~: 4215)
-EstimateTransferERC20GasConstant:testFuzz_transferERC20_gasConstant(uint256,uint256,(address,address,uint256,(uint256,uint256,uint256,uint256),(address,uint256,uint256,uint256))) (runs: 256, μ: 3999, ~: 3942)
-EstimateTransferGasConstant:testFuzz_transfer_gasConstant(uint256,uint256,(address,uint256,uint256,(uint256,uint256,uint256,uint256),(address,uint256,uint256,uint256))) (runs: 256, μ: 3774, ~: 3762)
-EstimateTransferOnceERC20GasConstant:testFuzz_transferERC20Once_gasConstant(uint256,(address,address,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 2575, ~: 2586)
-EstimateTransferOnceGasConstant:testFuzz_transferOnce_gasConstant(uint256,(address,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 2323, ~: 2298)
-EstimateUniswapV3ExactInputGasConstant:testFuzz_uniswapV3ExactInput_gasConstant(uint256,uint256,(address,address,address,uint24,uint256,uint256,uint32,uint32,(uint256,uint256,uint256,uint256),(address,uint256,uint256,uint256))) (runs: 256, μ: 5348, ~: 5352)
+EstimateTransferCCTPGasConstant:testFuzz_transferCCTP_gasConstant(uint256,uint256,(address,uint256,uint32,bytes32,(uint256,uint256,uint256,uint256),(address,uint256,uint256,uint256))) (runs: 256, μ: 4225, ~: 4206)
+EstimateTransferERC20GasConstant:testFuzz_transferERC20_gasConstant(uint256,uint256,(address,address,uint256,(uint256,uint256,uint256,uint256),(address,uint256,uint256,uint256))) (runs: 256, μ: 4006, ~: 3978)
+EstimateTransferGasConstant:testFuzz_transfer_gasConstant(uint256,uint256,(address,uint256,uint256,(uint256,uint256,uint256,uint256),(address,uint256,uint256,uint256))) (runs: 256, μ: 3764, ~: 3762)
+EstimateTransferOnceERC20GasConstant:testFuzz_transferERC20Once_gasConstant(uint256,(address,address,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 2571, ~: 2586)
+EstimateTransferOnceGasConstant:testFuzz_transferOnce_gasConstant(uint256,(address,uint256,uint256,(address,uint256,uint256,uint256))) (runs: 256, μ: 2326, ~: 2289)
+EstimateUniswapV3ExactInputGasConstant:testFuzz_uniswapV3ExactInput_gasConstant(uint256,uint256,(address,address,address,uint24,uint256,uint256,uint32,uint32,(uint256,uint256,uint256,uint256),(address,uint256,uint256,uint256))) (runs: 256, μ: 5311, ~: 5316)
 EstimateWithdrawERC4626GasConstant:testFuzz_withdrawERC4626_gasConstant(uint256,uint256,(address,address,uint256,uint256,(uint256,uint256,uint256,uint256),(address,uint256,uint256,uint256))) (runs: 256, μ: 4226, ~: 4206)
 FeeTokenRegistryTest:test_addFeeToken_alreadyRegistered() (gas: 1898)
 FeeTokenRegistryTest:test_addFeeToken_happyPath() (gas: 37590)

.github/deployment/networks/.env-gas-constants

@@ -8,6 +8,8 @@ REFUEL_ERC20_ACTION_GAS_CONSTANT=104500
 SWEEP_ACTION_GAS_CONSTANT=104000
 SWEEP_CCTP_ACTION_GAS_CONSTANT=104500
 SWEEP_DEPOSIT_ERC4626_ACTION_GAS_CONSTANT=104500
+REQUEST_DEPOSIT_ERC7540_ACTION_GAS_CONSTANT=
+SWEEP_REQUEST_DEPOSIT_ERC7540_ACTION_GAS_CONSTANT=
 SWEEP_ERC20_ACTION_GAS_CONSTANT=104000
 SWEEP_UNISWAP_V3_ACTION_GAS_CONSTANT=106000
 SWEEP_WITHDRAW_ERC4626_ACTION_GAS_CONSTANT=104500

script/deployment/actions/DeployRequestDepositERC7540Action.s.sol

@@ -0,0 +1,86 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity ^0.8.26;
+
+import {Script, console2} from "forge-std/src/Script.sol";
+import {VmSafe} from "forge-std/src/Vm.sol";
+
+import {RequestDepositERC7540Action} from "../../../src/actions/RequestDepositERC7540Action.sol";
+
+contract DeployRequestDepositERC7540Action is Script {
+    /// @dev make sure to run `cp .env_example .env` and fill in each variable
+    /// then run `source .env` in your terminal before copying and pasting one of the commands below
+    /// @dev this script will deploy to the same address on every chain.
+    /// this deterministic address depend on a few things:
+    /// - the owner address
+    /// - the salt
+    /// - the creation code of the contract
+    ///     - **** the number of optimizer_runs will change the creation code (see foundry.toml) ****
+    ///     - **** the version of the Solidity compiler will change the creation code ****
+    ///     - **** the EVM version (cancun, prague, etc) will change the creation code ****
+    ///     - **** dependency versions can change the creation code ****
+    ///     - **** the forge version can change the creation code ****
+    ///     - **** compiler flags (--via-ir, --overwrite, etc) can change the creation code ****
+    /// - the address of the deployer (this won't change because we are using the cannoical Create2 factory 0x4e59b44847b379578588920ca78fbf26c0b4956c, but good to know)
+    ///
+    ///
+    /// if any of these values change, the addresses will change, so we must be careful to keep these values constant.
+    /// in order to help with this, a check is added here to ensure that the calculated address matches the expected address
+    /// before deploying. if the addresses do not match, the script will revert.
+    // command to generate the expected deployment address (without actually deploying):
+    //
+    // forge script DeployRequestDepositERC7540Action
+
+    // commands to deterministically deploy (and check the expected address before deploying):
+    //
+    // - with private key (on Anvil): forge script DeployRequestDepositERC7540Action --broadcast --fork-url http://localhost:8545 --private-key $ANVIL_DEPLOYER_PK
+    // - with private key:            forge script DeployRequestDepositERC7540Action --broadcast --rpc-url $RPC_URL --private-key $DEPLOYER_PK
+    // - with Ledger:                 forge script DeployRequestDepositERC7540Action --broadcast --rpc-url $RPC_URL --ledger
+    // - with AWS:                    forge script DeployRequestDepositERC7540Action --broadcast --rpc-url $RPC_URL --aws
+
+    bytes32 constant salt = keccak256("ON_TIME_INSTRUCTED_MONEY");
+
+    error ExpectedAddressMismatch();
+
+    function run() public {
+        address feeTokenRegistryAddress = vm.envAddress("EXPECTED_FEE_TOKEN_REGISTRY_ADDRESS");
+        address treasuryAddress = vm.envAddress("EXPECTED_TREASURY_ADDRESS");
+        uint256 gasConstant = vm.envUint("REQUEST_DEPOSIT_ERC7540_ACTION_GAS_CONSTANT");
+
+        // if this isn't a dry-run (aka we're using `--broadcast`), make sure to check the expected address
+        if (vm.isContext(VmSafe.ForgeContext.ScriptBroadcast)) {
+            checkExpectedAddress(feeTokenRegistryAddress, treasuryAddress, gasConstant);
+        }
+
+        vm.startBroadcast();
+
+        // deterministically deploy RequestDepositERC7540Action via canonical Create2 deployer
+        RequestDepositERC7540Action requestDepositERC7540Action =
+            new RequestDepositERC7540Action{salt: salt}(feeTokenRegistryAddress, treasuryAddress, gasConstant);
+
+        vm.stopBroadcast();
+
+        console2.log("RequestDepositERC7540Action deployed at:", address(requestDepositERC7540Action));
+    }
+
+    function checkExpectedAddress(address feeTokenRegistry, address treasuryAddress, uint256 gasConstant) public view {
+        /// @dev before deploying for the first time, generate this expected address by running this script in dry-run mode (see above).
+        /// once it has been deployed for the first time, that deployed address should be used as the expected address from then on.
+        address expectedAddress = vm.envAddress("EXPECTED_REQUEST_DEPOSIT_ERC7540_ACTION_ADDRESS");
+
+        // calculate the expected address using the current init code
+        address calculatedAddress = vm.computeCreate2Address(
+            salt,
+            keccak256(
+                abi.encodePacked(
+                    type(RequestDepositERC7540Action).creationCode,
+                    abi.encode(feeTokenRegistry, treasuryAddress, gasConstant)
+                )
+            )
+        );
+
+        // revert if the expected address does not match the calculated address
+        if (expectedAddress != calculatedAddress) {
+            revert ExpectedAddressMismatch();
+        }
+    }
+}

script/deployment/actions/DeploySweepRequestDepositERC7540Action.s.sol

@@ -0,0 +1,86 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity ^0.8.26;
+
+import {Script, console2} from "forge-std/src/Script.sol";
+import {VmSafe} from "forge-std/src/Vm.sol";
+
+import {SweepRequestDepositERC7540Action} from "../../../src/actions/SweepRequestDepositERC7540Action.sol";
+
+contract DeploySweepRequestDepositERC7540Action is Script {
+    /// @dev make sure to run `cp .env_example .env` and fill in each variable
+    /// then run `source .env` in your terminal before copying and pasting one of the commands below
+    /// @dev this script will deploy to the same address on every chain.
+    /// this deterministic address depend on a few things:
+    /// - the owner address
+    /// - the salt
+    /// - the creation code of the contract
+    ///     - **** the number of optimizer_runs will change the creation code (see foundry.toml) ****
+    ///     - **** the version of the Solidity compiler will change the creation code ****
+    ///     - **** the EVM version (cancun, prague, etc) will change the creation code ****
+    ///     - **** dependency versions can change the creation code ****
+    ///     - **** the forge version can change the creation code ****
+    ///     - **** compiler flags (--via-ir, --overwrite, etc) can change the creation code ****
+    /// - the address of the deployer (this won't change because we are using the cannoical Create2 factory 0x4e59b44847b379578588920ca78fbf26c0b4956c, but good to know)
+    ///
+    ///
+    /// if any of these values change, the addresses will change, so we must be careful to keep these values constant.
+    /// in order to help with this, a check is added here to ensure that the calculated address matches the expected address
+    /// before deploying. if the addresses do not match, the script will revert.
+    // command to generate the expected deployment address (without actually deploying):
+    //
+    // forge script DeploySweepRequestDepositERC7540Action
+
+    // commands to deterministically deploy (and check the expected address before deploying):
+    //
+    // - with private key (on Anvil): forge script DeploySweepRequestDepositERC7540Action --broadcast --fork-url http://localhost:8545 --private-key $ANVIL_DEPLOYER_PK
+    // - with private key:            forge script DeploySweepRequestDepositERC7540Action --broadcast --rpc-url $RPC_URL --private-key $DEPLOYER_PK
+    // - with Ledger:                 forge script DeploySweepRequestDepositERC7540Action --broadcast --rpc-url $RPC_URL --ledger
+    // - with AWS:                    forge script DeploySweepRequestDepositERC7540Action --broadcast --rpc-url $RPC_URL --aws
+
+    bytes32 constant salt = keccak256("ON_TIME_INSTRUCTED_MONEY");
+
+    error ExpectedAddressMismatch();
+
+    function run() public {
+        address feeTokenRegistryAddress = vm.envAddress("EXPECTED_FEE_TOKEN_REGISTRY_ADDRESS");
+        address treasuryAddress = vm.envAddress("EXPECTED_TREASURY_ADDRESS");
+        uint256 gasConstant = vm.envUint("SWEEP_REQUEST_DEPOSIT_ERC7540_ACTION_GAS_CONSTANT");
+
+        // if this isn't a dry-run (aka we're using `--broadcast`), make sure to check the expected address
+        if (vm.isContext(VmSafe.ForgeContext.ScriptBroadcast)) {
+            checkExpectedAddress(feeTokenRegistryAddress, treasuryAddress, gasConstant);
+        }
+
+        vm.startBroadcast();
+
+        // deterministically deploy SweepRequestDepositERC7540Action via canonical Create2 deployer
+        SweepRequestDepositERC7540Action sweepRequestDepositERC7540Action =
+            new SweepRequestDepositERC7540Action{salt: salt}(feeTokenRegistryAddress, treasuryAddress, gasConstant);
+
+        vm.stopBroadcast();
+
+        console2.log("SweepRequestDepositERC7540Action deployed at:", address(sweepRequestDepositERC7540Action));
+    }
+
+    function checkExpectedAddress(address feeTokenRegistry, address treasuryAddress, uint256 gasConstant) public view {
+        /// @dev before deploying for the first time, generate this expected address by running this script in dry-run mode (see above).
+        /// once it has been deployed for the first time, that deployed address should be used as the expected address from then on.
+        address expectedAddress = vm.envAddress("EXPECTED_SWEEP_REQUEST_DEPOSIT_ERC7540_ACTION_ADDRESS");
+
+        // calculate the expected address using the current init code
+        address calculatedAddress = vm.computeCreate2Address(
+            salt,
+            keccak256(
+                abi.encodePacked(
+                    type(SweepRequestDepositERC7540Action).creationCode,
+                    abi.encode(feeTokenRegistry, treasuryAddress, gasConstant)
+                )
+            )
+        );
+
+        // revert if the expected address does not match the calculated address
+        if (expectedAddress != calculatedAddress) {
+            revert ExpectedAddressMismatch();
+        }
+    }
+}