test: use mainnet addresses in fork tests (#1165)

* test: use mainnet address in fork testing

* script: fix run modifiers

* test: generate token holder locally in fork tests

* refactor: rename script file names

chore: use shorter version as amount

* test: use shorter form to represent large number

---------

Co-authored-by: Andrei Vlad Birgaoanu <andreivladbrg@gmail.com>

Author: smol-ninja

script/DeployBatchLockup.t.sol script/DeployBatchLockup.s.solscript/DeployBatchLockup.t.sol renamed to script/DeployBatchLockup.s.sol

@@ -7,7 +7,7 @@ import { BaseScript } from "./Base.s.sol";
 
 contract DeployBatchLockup is BaseScript {
     /// @dev Deploy via Forge.
-    function run() public virtual broadcast returns (SablierBatchLockup batchLockup) {
+    function run() public broadcast returns (SablierBatchLockup batchLockup) {
         batchLockup = new SablierBatchLockup();
     }
 }

…ipt/DeployDeterministicBatchLockup.t.sol …ipt/DeployDeterministicBatchLockup.s.solscript/DeployDeterministicBatchLockup.t.sol renamed to script/DeployDeterministicBatchLockup.s.sol script/DeployDeterministicBatchLockup.t.sol renamed to script/DeployDeterministicBatchLockup.s.sol

@@ -7,7 +7,7 @@ import { BaseScript } from "./Base.s.sol";
 
 contract DeployDeterministicBatchLockup is BaseScript {
     /// @dev Deploy via Forge.
-    function run() public virtual broadcast returns (SablierBatchLockup batchLockup) {
+    function run() public broadcast returns (SablierBatchLockup batchLockup) {
         batchLockup = new SablierBatchLockup{ salt: SALT }();
     }
 }

script/DeployDeterministicLockup.s.sol

@@ -13,7 +13,6 @@ contract DeployDeterministicLockup is BaseScript {
         ILockupNFTDescriptor nftDescriptor
     )
         public
-        virtual
         broadcast
         returns (SablierLockup lockup)
     {

script/DeployDeterministicNFTDescriptor.s.sol

@@ -8,7 +8,7 @@ import { BaseScript } from "./Base.s.sol";
 /// @dev Deploys {LockupNFTDescriptor} at a deterministic address across chains.
 /// @dev Reverts if the contract has already been deployed.
 contract DeployDeterministicNFTDescriptor is BaseScript {
-    function run() public virtual broadcast returns (LockupNFTDescriptor nftDescriptor) {
+    function run() public broadcast returns (LockupNFTDescriptor nftDescriptor) {
         nftDescriptor = new LockupNFTDescriptor{ salt: SALT }();
     }
 }

script/DeployDeterministicProtocol.s.sol

@@ -12,8 +12,6 @@ contract DeployDeterministicProtocol is BaseScript {
     /// @dev Deploys the protocol with the admin set in `adminMap`.
     function run()
         public
-        virtual
-        broadcast
         returns (LockupNFTDescriptor nftDescriptor, SablierLockup lockup, SablierBatchLockup batchLockup)
     {
         address initialAdmin = adminMap[block.chainid];
@@ -22,7 +20,7 @@ contract DeployDeterministicProtocol is BaseScript {
 
     /// @dev Deploys the protocol with the given `initialAdmin`.
     function run(address initialAdmin)
-        internal
+        public
         returns (LockupNFTDescriptor nftDescriptor, SablierLockup lockup, SablierBatchLockup batchLockup)
     {
         (nftDescriptor, lockup, batchLockup) = _run(initialAdmin);
@@ -31,6 +29,7 @@ contract DeployDeterministicProtocol is BaseScript {
     /// @dev Common logic for the run functions.
     function _run(address initialAdmin)
         internal
+        broadcast
         returns (LockupNFTDescriptor nftDescriptor, SablierLockup lockup, SablierBatchLockup batchLockup)
     {
         batchLockup = new SablierBatchLockup{ salt: SALT }();

script/DeployLockup.s.sol

@@ -13,7 +13,6 @@ contract DeployLockup is BaseScript {
         ILockupNFTDescriptor nftDescriptor
     )
         public
-        virtual
         broadcast
         returns (SablierLockup lockup)
     {

script/DeployNFTDescriptor.s.sol

@@ -7,7 +7,7 @@ import { BaseScript } from "./Base.s.sol";
 
 /// @notice Deploys {LockupNFTDescriptor} contract.
 contract DeployNFTDescriptor is BaseScript {
-    function run() public virtual broadcast returns (LockupNFTDescriptor nftDescriptor) {
+    function run() public broadcast returns (LockupNFTDescriptor nftDescriptor) {
         nftDescriptor = new LockupNFTDescriptor();
     }
 }

script/DeployProtocol.s.sol

@@ -12,8 +12,6 @@ contract DeployProtocol is BaseScript {
     /// @dev Deploys the protocol with the admin set in `adminMap`.
     function run()
         public
-        virtual
-        broadcast
         returns (LockupNFTDescriptor nftDescriptor, SablierLockup lockup, SablierBatchLockup batchLockup)
     {
         address initialAdmin = adminMap[block.chainid];
@@ -22,7 +20,7 @@ contract DeployProtocol is BaseScript {
 
     /// @dev Deploys the protocol with the given `initialAdmin`.
     function run(address initialAdmin)
-        internal
+        public
         returns (LockupNFTDescriptor nftDescriptor, SablierLockup lockup, SablierBatchLockup batchLockup)
     {
         (nftDescriptor, lockup, batchLockup) = _run(initialAdmin);
@@ -31,6 +29,7 @@ contract DeployProtocol is BaseScript {
     /// @dev Common logic for the run functions.
     function _run(address initialAdmin)
         internal
+        broadcast
         returns (LockupNFTDescriptor nftDescriptor, SablierLockup lockup, SablierBatchLockup batchLockup)
     {
         batchLockup = new SablierBatchLockup();

script/GenerateSVG.s.sol

@@ -26,7 +26,7 @@ contract GenerateSVG is BaseScript, LockupNFTDescriptor {
         uint256 duration
     )
         public
-        virtual
+        view
         returns (string memory svg)
     {
         svg = NFTSVG.generateSVG(

tests/fork/Fork.t.sol

@@ -3,6 +3,10 @@ pragma solidity >=0.8.22 <0.9.0;
 
 import { IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import { ILockupNFTDescriptor } from "src/interfaces/ILockupNFTDescriptor.sol";
+import { ISablierBatchLockup } from "src/interfaces/ISablierBatchLockup.sol";
+import { ISablierLockup } from "src/interfaces/ISablierLockup.sol";
+
 import { Base_Test } from "./../Base.t.sol";
 
 /// @notice Common logic needed by all fork tests.
@@ -12,16 +16,15 @@ abstract contract Fork_Test is Base_Test {
     //////////////////////////////////////////////////////////////////////////*/
 
     IERC20 internal immutable FORK_TOKEN;
-    address internal immutable FORK_TOKEN_HOLDER;
+    address internal forkTokenHolder;
     uint256 internal initialHolderBalance;
 
     /*//////////////////////////////////////////////////////////////////////////
                                     CONSTRUCTOR
     //////////////////////////////////////////////////////////////////////////*/
 
-    constructor(IERC20 forkToken, address forkTokenHolder) {
+    constructor(IERC20 forkToken) {
         FORK_TOKEN = forkToken;
-        FORK_TOKEN_HOLDER = forkTokenHolder;
     }
 
     /*//////////////////////////////////////////////////////////////////////////
@@ -30,19 +33,24 @@ abstract contract Fork_Test is Base_Test {
 
     function setUp() public virtual override {
         // Fork Ethereum Mainnet at a specific block number.
-        vm.createSelectFork({ blockNumber: 20_428_723, urlOrAlias: "mainnet" });
+        vm.createSelectFork({ blockNumber: 21_719_029, urlOrAlias: "mainnet" });
+
+        // Load deployed addresses from Ethereum mainnet.
+        batchLockup = ISablierBatchLockup(0x3F6E8a8Cffe377c4649aCeB01e6F20c60fAA356c);
+        nftDescriptor = ILockupNFTDescriptor(0xA9dC6878C979B5cc1d98a1803F0664ad725A1f56);
+        lockup = ISablierLockup(0x7C01AA3783577E15fD7e272443D44B92d5b21056);
 
-        // The base is set up after the fork is selected so that the base test contracts are deployed on the fork.
-        Base_Test.setUp();
+        // Create a custom user for this test suite.
+        forkTokenHolder = payable(makeAddr(string.concat(IERC20Metadata(address(FORK_TOKEN)).symbol(), "_HOLDER")));
 
-        // Label the contracts.
+        // Label the addresses.
         labelContracts();
 
-        // Make the forked token holder the caller in this test suite.
-        resetPrank({ msgSender: FORK_TOKEN_HOLDER });
+        // Deal token balance to the user.
+        initialHolderBalance = 1e7 * 10 ** IERC20Metadata(address(FORK_TOKEN)).decimals();
+        deal({ token: address(FORK_TOKEN), to: forkTokenHolder, give: initialHolderBalance });
 
-        // Query the initial balance of the forked token holder.
-        initialHolderBalance = FORK_TOKEN.balanceOf(FORK_TOKEN_HOLDER);
+        resetPrank({ msgSender: forkTokenHolder });
     }
 
     /*//////////////////////////////////////////////////////////////////////////
@@ -56,7 +64,7 @@ abstract contract Fork_Test is Base_Test {
 
         // The goal is to not have overlapping users because the forked token balance tests would fail otherwise.
         vm.assume(sender != recipient && sender != broker && recipient != broker);
-        vm.assume(sender != FORK_TOKEN_HOLDER && recipient != FORK_TOKEN_HOLDER && broker != FORK_TOKEN_HOLDER);
+        vm.assume(sender != forkTokenHolder && recipient != forkTokenHolder && broker != forkTokenHolder);
         vm.assume(sender != lockupContract && recipient != lockupContract && broker != lockupContract);
 
         // Avoid users blacklisted by USDC or USDT.
@@ -65,9 +73,9 @@ abstract contract Fork_Test is Base_Test {
         assumeNoBlacklisted(address(FORK_TOKEN), broker);
     }
 
-    /// @dev Labels the most relevant contracts.
+    /// @dev Labels the most relevant addresses.
     function labelContracts() internal {
         vm.label({ account: address(FORK_TOKEN), newLabel: IERC20Metadata(address(FORK_TOKEN)).symbol() });
-        vm.label({ account: FORK_TOKEN_HOLDER, newLabel: "FORK_TOKEN_HOLDER" });
+        vm.label({ account: forkTokenHolder, newLabel: "Fork Token Holder" });
     }
 }