Inherit SablierV2Blast in Batch and Factory (#341)

* feat: inherit SablierV2Blast in Batch and Factory contracts * feat: update scripts with admin param feat: configure blast settings in scripts * test: add constructor test in batch and factory * refactor: update precompiles * refactor: blast related changes --------- Co-authored-by: smol-ninja <[email protected]>
sablier-labs · Jul 4, 2024 · 36587a2 · 36587a2
1 parent 62cb598
commit 36587a2
Show file tree

Hide file tree

Showing 21 changed files with 200 additions and 49 deletions.
diff --git a/bun.lockb b/bun.lockb
diff --git a/foundry.toml b/foundry.toml
@@ -66,7 +66,7 @@
   arbitrum = "https://arbitrum-mainnet.infura.io/v3/${API_KEY_INFURA}"
   avalanche = "https://avalanche-mainnet.infura.io/v3/${API_KEY_INFURA}"
   base = "https://mainnet.base.org"
-  blast = "https://rpc.blast.io"
+  blast = "${RPC_URL_BLAST}"
   bnb = "https://bsc-dataseed.binance.org"
   ethereum = "${RPC_URL_MAINNET}"
   gnosis = "https://rpc.gnosischain.com"

diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
   "dependencies": {
     "@openzeppelin/contracts": "5.0.2",
     "@prb/math": "4.0.3",
-    "@sablier/v2-core": "1.2.0"
+    "@sablier/v2-core": "github:sablier-labs/v2-core#blast-l2"
   },
   "devDependencies": {
     "forge-std": "github:foundry-rs/forge-std#v1.8.2",
@@ -51,7 +51,7 @@
     "web3"
   ],
   "peerDependencies": {
-    "@sablier/v2-core": "1.2.0"
+    "@sablier/v2-core": "github:sablier-labs/v2-core#blast-l2"
   },
   "publishConfig": {
     "access": "public"

diff --git a/precompiles/Precompiles.sol b/precompiles/Precompiles.sol
diff --git a/script/Base.s.sol b/script/Base.s.sol
@@ -3,6 +3,8 @@
 pragma solidity >=0.8.22 <0.9.0;
 
 import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
+import { IBlast, YieldMode, GasMode } from "@sablier/v2-core/src/interfaces/blast/IBlast.sol";
+import { IERC20Rebasing } from "@sablier/v2-core/src/interfaces/blast/IERC20Rebasing.sol";
 
 import { console2 } from "forge-std/src/console2.sol";
 import { Script } from "forge-std/src/Script.sol";
@@ -12,6 +14,13 @@ contract BaseScript is Script {
     using Strings for uint256;
     using stdJson for string;
 
+    /// @dev Blast mainnet configuration variables.
+    IBlast public constant BLAST = IBlast(0x4300000000000000000000000000000000000002);
+    GasMode public constant GAS_MODE = GasMode.CLAIMABLE;
+    YieldMode public constant YIELD_MODE = YieldMode.CLAIMABLE;
+    IERC20Rebasing public constant WETH = IERC20Rebasing(0x4300000000000000000000000000000000000004);
+    IERC20Rebasing public constant USDB = IERC20Rebasing(0x4300000000000000000000000000000000000003);
+
     /// @dev Included to enable compilation of the script without a $MNEMONIC environment variable.
     string internal constant TEST_MNEMONIC = "test test test test test test test test test test test junk";
 

diff --git a/script/DeployBatchLockup.t.sol b/script/DeployBatchLockup.t.sol
@@ -7,7 +7,13 @@ import { SablierV2BatchLockup } from "../src/SablierV2BatchLockup.sol";
 
 contract DeployBatchLockup is BaseScript {
     /// @dev Deploy via Forge.
-    function run() public virtual broadcast returns (SablierV2BatchLockup batchLockup) {
-        batchLockup = new SablierV2BatchLockup();
+    function run(address admin) public virtual broadcast returns (SablierV2BatchLockup batchLockup) {
+        batchLockup = new SablierV2BatchLockup(msg.sender);
+
+        // Configure Blast mainnet yield and gas modes.
+        batchLockup.configureRebasingAsset({ asset: USDB, yieldMode: YIELD_MODE });
+        batchLockup.configureRebasingAsset({ asset: WETH, yieldMode: YIELD_MODE });
+        batchLockup.configureYieldAndGas({ blast: BLAST, yieldMode: YIELD_MODE, gasMode: GAS_MODE, governor: admin });
+        batchLockup.transferAdmin(admin);
     }
 }
diff --git a/script/DeployDeterministicBatchLockup.s.sol b/script/DeployDeterministicBatchLockup.s.sol
@@ -9,8 +9,14 @@ import { SablierV2BatchLockup } from "../src/SablierV2BatchLockup.sol";
 /// @dev Reverts if the contract has already been deployed.
 contract DeployDeterministicBatchLockup is BaseScript {
     /// @dev Deploy via Forge.
-    function run() public virtual broadcast returns (SablierV2BatchLockup batchLockup) {
+    function run(address admin) public virtual broadcast returns (SablierV2BatchLockup batchLockup) {
         bytes32 salt = constructCreate2Salt();
-        batchLockup = new SablierV2BatchLockup{ salt: salt }();
+
+        // Configure Blast mainnet yield and gas modes.
+        batchLockup = new SablierV2BatchLockup{ salt: salt }(msg.sender);
+        batchLockup.configureRebasingAsset({ asset: USDB, yieldMode: YIELD_MODE });
+        batchLockup.configureRebasingAsset({ asset: WETH, yieldMode: YIELD_MODE });
+        batchLockup.configureYieldAndGas({ blast: BLAST, yieldMode: YIELD_MODE, gasMode: GAS_MODE, governor: admin });
+        batchLockup.transferAdmin(admin);
     }
 }
diff --git a/script/DeployDeterministicPeriphery.s.sol b/script/DeployDeterministicPeriphery.s.sol
@@ -14,14 +14,33 @@ import { SablierV2MerkleLockupFactory } from "../src/SablierV2MerkleLockupFactor
 /// @dev Reverts if any contract has already been deployed.
 contract DeployDeterministicPeriphery is BaseScript {
     /// @dev Deploy via Forge.
-    function run()
+    function run(address admin)
         public
         virtual
         broadcast
         returns (SablierV2BatchLockup batchLockup, SablierV2MerkleLockupFactory merkleLockupFactory)
     {
         bytes32 salt = constructCreate2Salt();
-        batchLockup = new SablierV2BatchLockup{ salt: salt }();
-        merkleLockupFactory = new SablierV2MerkleLockupFactory{ salt: salt }();
+
+        batchLockup = new SablierV2BatchLockup{ salt: salt }(msg.sender);
+
+        // Configure Blast mainnet yield and gas modes.
+        batchLockup.configureRebasingAsset({ asset: USDB, yieldMode: YIELD_MODE });
+        batchLockup.configureRebasingAsset({ asset: WETH, yieldMode: YIELD_MODE });
+        batchLockup.configureYieldAndGas({ blast: BLAST, yieldMode: YIELD_MODE, gasMode: GAS_MODE, governor: admin });
+        batchLockup.transferAdmin(admin);
+
+        merkleLockupFactory = new SablierV2MerkleLockupFactory{ salt: salt }(msg.sender);
+
+        // Configure Blast mainnet yield and gas modes.
+        merkleLockupFactory.configureRebasingAsset({ asset: USDB, yieldMode: YIELD_MODE });
+        merkleLockupFactory.configureRebasingAsset({ asset: WETH, yieldMode: YIELD_MODE });
+        merkleLockupFactory.configureYieldAndGas({
+            blast: BLAST,
+            yieldMode: YIELD_MODE,
+            gasMode: GAS_MODE,
+            governor: admin
+        });
+        merkleLockupFactory.transferAdmin(admin);
     }
 }
diff --git a/script/DeployMerkleLockupFactory.s.sol b/script/DeployMerkleLockupFactory.s.sol
@@ -7,7 +7,18 @@ import { SablierV2MerkleLockupFactory } from "../src/SablierV2MerkleLockupFactor
 
 contract DeployMerkleLockupFactory is BaseScript {
     /// @dev Deploy via Forge.
-    function run() public virtual broadcast returns (SablierV2MerkleLockupFactory merkleLockupFactory) {
-        merkleLockupFactory = new SablierV2MerkleLockupFactory();
+    function run(address admin) public virtual broadcast returns (SablierV2MerkleLockupFactory merkleLockupFactory) {
+        merkleLockupFactory = new SablierV2MerkleLockupFactory(msg.sender);
+
+        // Configure Blast mainnet yield and gas modes.
+        merkleLockupFactory.configureRebasingAsset({ asset: USDB, yieldMode: YIELD_MODE });
+        merkleLockupFactory.configureRebasingAsset({ asset: WETH, yieldMode: YIELD_MODE });
+        merkleLockupFactory.configureYieldAndGas({
+            blast: BLAST,
+            yieldMode: YIELD_MODE,
+            gasMode: GAS_MODE,
+            governor: admin
+        });
+        merkleLockupFactory.transferAdmin(admin);
     }
 }
diff --git a/script/DeployPeriphery.s.sol b/script/DeployPeriphery.s.sol
@@ -12,13 +12,31 @@ import { SablierV2BatchLockup } from "../src/SablierV2BatchLockup.sol";
 /// 2. {SablierV2MerkleLockupFactory}
 contract DeployPeriphery is BaseScript {
     /// @dev Deploy via Forge.
-    function run()
+    function run(address admin)
         public
         virtual
         broadcast
         returns (SablierV2BatchLockup batchLockup, SablierV2MerkleLockupFactory merkleLockupFactory)
     {
-        batchLockup = new SablierV2BatchLockup();
-        merkleLockupFactory = new SablierV2MerkleLockupFactory();
+        batchLockup = new SablierV2BatchLockup(msg.sender);
+
+        // Configure Blast mainnet yield and gas modes.
+        batchLockup.configureRebasingAsset({ asset: USDB, yieldMode: YIELD_MODE });
+        batchLockup.configureRebasingAsset({ asset: WETH, yieldMode: YIELD_MODE });
+        batchLockup.configureYieldAndGas({ blast: BLAST, yieldMode: YIELD_MODE, gasMode: GAS_MODE, governor: admin });
+        batchLockup.transferAdmin(admin);
+
+        merkleLockupFactory = new SablierV2MerkleLockupFactory(msg.sender);
+
+        // Configure Blast mainnet yield and gas modes.
+        merkleLockupFactory.configureRebasingAsset({ asset: USDB, yieldMode: YIELD_MODE });
+        merkleLockupFactory.configureRebasingAsset({ asset: WETH, yieldMode: YIELD_MODE });
+        merkleLockupFactory.configureYieldAndGas({
+            blast: BLAST,
+            yieldMode: YIELD_MODE,
+            gasMode: GAS_MODE,
+            governor: admin
+        });
+        merkleLockupFactory.transferAdmin(admin);
     }
 }
diff --git a/script/DeployProtocol.s.sol b/script/DeployProtocol.s.sol
@@ -37,7 +37,7 @@ contract DeployProtocol is BaseScript {
         lockupTranched = new SablierV2LockupTranched(initialAdmin, nftDescriptor, maxTrancheCount);
 
         // Deploy V2 Periphery.
-        batchLockup = new SablierV2BatchLockup();
-        merkleLockupFactory = new SablierV2MerkleLockupFactory();
+        batchLockup = new SablierV2BatchLockup(initialAdmin);
+        merkleLockupFactory = new SablierV2MerkleLockupFactory(initialAdmin);
     }
 }
diff --git a/src/SablierV2BatchLockup.sol b/src/SablierV2BatchLockup.sol
@@ -3,6 +3,7 @@ pragma solidity >=0.8.22;
 
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import { SablierV2Blast } from "@sablier/v2-core/src/abstracts/SablierV2Blast.sol";
 import { ISablierV2LockupDynamic } from "@sablier/v2-core/src/interfaces/ISablierV2LockupDynamic.sol";
 import { ISablierV2LockupLinear } from "@sablier/v2-core/src/interfaces/ISablierV2LockupLinear.sol";
 import { ISablierV2LockupTranched } from "@sablier/v2-core/src/interfaces/ISablierV2LockupTranched.sol";
@@ -14,9 +15,20 @@ import { BatchLockup } from "./types/DataTypes.sol";
 
 /// @title SablierV2BatchLockup
 /// @notice See the documentation in {ISablierV2BatchLockup}.
-contract SablierV2BatchLockup is ISablierV2BatchLockup {
+contract SablierV2BatchLockup is ISablierV2BatchLockup, SablierV2Blast {
     using SafeERC20 for IERC20;
 
+    /*//////////////////////////////////////////////////////////////////////////
+                                    CONSTRUCTOR
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @dev Emits a {TransferAdmin} event.
+    /// @param initialAdmin The address of the initial contract admin.
+    constructor(address initialAdmin) {
+        admin = initialAdmin;
+        emit TransferAdmin({ oldAdmin: address(0), newAdmin: initialAdmin });
+    }
+
     /*//////////////////////////////////////////////////////////////////////////
                              SABLIER-V2-LOCKUP-DYNAMIC
     //////////////////////////////////////////////////////////////////////////*/

diff --git a/src/SablierV2MerkleLockupFactory.sol b/src/SablierV2MerkleLockupFactory.sol
@@ -2,6 +2,7 @@
 pragma solidity >=0.8.22;
 
 import { uUNIT } from "@prb/math/src/UD2x18.sol";
+import { SablierV2Blast } from "@sablier/v2-core/src/abstracts/SablierV2Blast.sol";
 import { ISablierV2LockupLinear } from "@sablier/v2-core/src/interfaces/ISablierV2LockupLinear.sol";
 import { ISablierV2LockupTranched } from "@sablier/v2-core/src/interfaces/ISablierV2LockupTranched.sol";
 import { LockupLinear } from "@sablier/v2-core/src/types/DataTypes.sol";
@@ -15,7 +16,18 @@ import { MerkleLockup, MerkleLT } from "./types/DataTypes.sol";
 
 /// @title SablierV2MerkleLockupFactory
 /// @notice See the documentation in {ISablierV2MerkleLockupFactory}.
-contract SablierV2MerkleLockupFactory is ISablierV2MerkleLockupFactory {
+contract SablierV2MerkleLockupFactory is ISablierV2MerkleLockupFactory, SablierV2Blast {
+    /*//////////////////////////////////////////////////////////////////////////
+                                    CONSTRUCTOR
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @dev Emits a {TransferAdmin} event.
+    /// @param initialAdmin The address of the initial contract admin.
+    constructor(address initialAdmin) {
+        admin = initialAdmin;
+        emit TransferAdmin({ oldAdmin: address(0), newAdmin: initialAdmin });
+    }
+
     /*//////////////////////////////////////////////////////////////////////////
                            USER-FACING CONSTANT FUNCTIONS
     //////////////////////////////////////////////////////////////////////////*/

diff --git a/src/interfaces/ISablierV2BatchLockup.sol b/src/interfaces/ISablierV2BatchLockup.sol
@@ -2,6 +2,7 @@
 pragma solidity >=0.8.22;
 
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import { ISablierV2Blast } from "@sablier/v2-core/src/interfaces/blast/ISablierV2Blast.sol";
 import { ISablierV2LockupDynamic } from "@sablier/v2-core/src/interfaces/ISablierV2LockupDynamic.sol";
 import { ISablierV2LockupLinear } from "@sablier/v2-core/src/interfaces/ISablierV2LockupLinear.sol";
 import { ISablierV2LockupTranched } from "@sablier/v2-core/src/interfaces/ISablierV2LockupTranched.sol";
@@ -10,7 +11,7 @@ import { BatchLockup } from "../types/DataTypes.sol";
 
 /// @title ISablierV2BatchLockup
 /// @notice Helper to batch create Sablier V2 Lockup streams.
-interface ISablierV2BatchLockup {
+interface ISablierV2BatchLockup is ISablierV2Blast {
     /*//////////////////////////////////////////////////////////////////////////
                               SABLIER-V2-LOCKUP-LINEAR
     //////////////////////////////////////////////////////////////////////////*/

diff --git a/src/interfaces/ISablierV2MerkleLockupFactory.sol b/src/interfaces/ISablierV2MerkleLockupFactory.sol
@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: GPL-3.0-or-later
 pragma solidity >=0.8.22;
 
+import { ISablierV2Blast } from "@sablier/v2-core/src/interfaces/blast/ISablierV2Blast.sol";
 import { ISablierV2LockupLinear } from "@sablier/v2-core/src/interfaces/ISablierV2LockupLinear.sol";
 import { ISablierV2LockupTranched } from "@sablier/v2-core/src/interfaces/ISablierV2LockupTranched.sol";
 import { LockupLinear } from "@sablier/v2-core/src/types/DataTypes.sol";
@@ -11,7 +12,7 @@ import { MerkleLockup, MerkleLT } from "../types/DataTypes.sol";
 
 /// @title ISablierV2MerkleLockupFactory
 /// @notice Deploys MerkleLockup campaigns with CREATE2.
-interface ISablierV2MerkleLockupFactory {
+interface ISablierV2MerkleLockupFactory is ISablierV2Blast {
     /*//////////////////////////////////////////////////////////////////////////
                                        EVENTS
     //////////////////////////////////////////////////////////////////////////*/

diff --git a/test/Base.t.sol b/test/Base.t.sol
@@ -108,10 +108,10 @@ abstract contract Base_Test is
     /// @dev Conditionally deploy V2 Periphery normally or from an optimized source compiled with `--via-ir`.
     function deployPeripheryConditionally() internal {
         if (!isTestOptimizedProfile()) {
-            batchLockup = new SablierV2BatchLockup();
-            merkleLockupFactory = new SablierV2MerkleLockupFactory();
+            batchLockup = new SablierV2BatchLockup(users.admin);
+            merkleLockupFactory = new SablierV2MerkleLockupFactory(users.admin);
         } else {
-            (batchLockup, merkleLockupFactory) = deployOptimizedPeriphery();
+            (batchLockup, merkleLockupFactory) = deployOptimizedPeriphery(users.admin);
         }
     }
 

diff --git a/test/integration/batch-lockup/constructor/constructor.t.sol b/test/integration/batch-lockup/constructor/constructor.t.sol
@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { SablierV2BatchLockup } from "src/SablierV2BatchLockup.sol";
+
+import { Integration_Test } from "../../Integration.t.sol";
+
+contract Constructor_BatchLockup_Integration_Test is Integration_Test {
+    function setUp() public virtual override {
+        Integration_Test.setUp();
+    }
+
+    function test_Constructor() external {
+        vm.expectEmit();
+        emit TransferAdmin({ oldAdmin: address(0), newAdmin: users.admin });
+        SablierV2BatchLockup batchLockup = new SablierV2BatchLockup(users.admin);
+
+        address actualAdmin = batchLockup.admin();
+        address expectedAdmin = users.admin;
+        assertEq(actualAdmin, expectedAdmin, "admin mismatch");
+    }
+}
diff --git a/test/integration/merkle-lockup/factory/constructor/constructor.t.sol b/test/integration/merkle-lockup/factory/constructor/constructor.t.sol
@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { SablierV2MerkleLockupFactory } from "src/SablierV2MerkleLockupFactory.sol";
+
+import { MerkleLockup_Integration_Test } from "../../MerkleLockup.t.sol";
+
+contract Constructor_BatchLockup_Integration_Test is MerkleLockup_Integration_Test {
+    function setUp() public virtual override {
+        MerkleLockup_Integration_Test.setUp();
+    }
+
+    function test_Constructor() external {
+        vm.expectEmit();
+        emit TransferAdmin({ oldAdmin: address(0), newAdmin: users.admin });
+        SablierV2MerkleLockupFactory merkleLockupFactory = new SablierV2MerkleLockupFactory(users.admin);
+
+        address actualAdmin = merkleLockupFactory.admin();
+        address expectedAdmin = users.admin;
+        assertEq(actualAdmin, expectedAdmin, "admin mismatch");
+    }
+}
diff --git a/test/utils/DeployOptimized.sol b/test/utils/DeployOptimized.sol
@@ -8,22 +8,33 @@ import { ISablierV2MerkleLockupFactory } from "../../src/interfaces/ISablierV2Me
 
 abstract contract DeployOptimized is StdCheats {
     /// @dev Deploys {SablierV2BatchLockup} from an optimized source compiled with `--via-ir`.
-    function deployOptimizedBatchLockup() internal returns (ISablierV2BatchLockup) {
-        return ISablierV2BatchLockup(deployCode("out-optimized/SablierV2BatchLockup.sol/SablierV2BatchLockup.json"));
+    function deployOptimizedBatchLockup(address initialAdmin) internal returns (ISablierV2BatchLockup) {
+        return ISablierV2BatchLockup(
+            deployCode("out-optimized/SablierV2BatchLockup.sol/SablierV2BatchLockup.json", abi.encode(initialAdmin))
+        );
     }
 
     /// @dev Deploys {SablierV2MerkleLockupFactory} from an optimized source compiled with `--via-ir`.
-    function deployOptimizedMerkleLockupFactory() internal returns (ISablierV2MerkleLockupFactory) {
+    function deployOptimizedMerkleLockupFactory(address initialAdmin)
+        internal
+        returns (ISablierV2MerkleLockupFactory)
+    {
         return ISablierV2MerkleLockupFactory(
-            deployCode("out-optimized/SablierV2MerkleLockupFactory.sol/SablierV2MerkleLockupFactory.json")
+            deployCode(
+                "out-optimized/SablierV2MerkleLockupFactory.sol/SablierV2MerkleLockupFactory.json",
+                abi.encode(initialAdmin)
+            )
         );
     }
 
     /// @notice Deploys all V2 Periphery contracts from an optimized source in the following order:
     ///
     /// 1. {SablierV2BatchLockup}
     /// 2. {SablierV2MerkleLockupFactory}
-    function deployOptimizedPeriphery() internal returns (ISablierV2BatchLockup, ISablierV2MerkleLockupFactory) {
-        return (deployOptimizedBatchLockup(), deployOptimizedMerkleLockupFactory());
+    function deployOptimizedPeriphery(address initialAdmin)
+        internal
+        returns (ISablierV2BatchLockup, ISablierV2MerkleLockupFactory)
+    {
+        return (deployOptimizedBatchLockup(initialAdmin), deployOptimizedMerkleLockupFactory(initialAdmin));
     }
 }
diff --git a/test/utils/Events.sol b/test/utils/Events.sol
@@ -30,4 +30,5 @@ abstract contract Events {
         uint256 aggregateAmount,
         uint256 recipientCount
     );
+    event TransferAdmin(address indexed oldAdmin, address indexed newAdmin);
 }