refactor: update repo to latest version of the contracts (#18)

andreivladbrg · web-flow · commit 2038a6aa77d7 · 2025-10-23T08:47:00.000+02:00
diff --git a/.env.example b/.env.example
@@ -1 +1 @@
-export SEPOLIA_RPC_URL="YOUR_SEPOLIA_RPC_URL"
+MAINNET_RPC_URL="YOUR_MAINNET_RPC_URL"
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,7 +1,7 @@
 name: "CI"
 
 env:
-  SEPOLIA_RPC_URL: ${{ secrets.SEPOLIA_RPC_URL }}
+  MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
   FOUNDRY_PROFILE: "ci"
 
 on:
@@ -20,6 +20,8 @@ jobs:
 
       - name: "Install Foundry"
         uses: "foundry-rs/foundry-toolchain@v1"
+        with:
+          version: "v1.3.6"
 
       - name: "Install Bun"
         uses: "oven-sh/setup-bun@v1"
@@ -43,6 +45,8 @@ jobs:
 
       - name: "Install Foundry"
         uses: "foundry-rs/foundry-toolchain@v1"
+        with:
+          version: "v1.3.6"
 
       - name: "Install Bun"
         uses: "oven-sh/setup-bun@v1"
@@ -67,6 +71,8 @@ jobs:
 
       - name: "Install Foundry"
         uses: "foundry-rs/foundry-toolchain@v1"
+        with:
+          version: "v1.3.6"
 
       - name: "Install Bun"
         uses: "oven-sh/setup-bun@v1"
diff --git a/.gitignore b/.gitignore
@@ -8,12 +8,7 @@ out
 *.log
 .DS_Store
 .pnp.*
-lcov.info
+bun.lockb
 package-lock.json
 pnpm-lock.yaml
 yarn.lock
-
-# broadcasts
-!broadcast
-broadcast/*
-broadcast/*/31337/
diff --git a/.prettierrc.yml b/.prettierrc.yml
@@ -1,7 +1,6 @@
-bracketSpacing: true
 printWidth: 120
-proseWrap: "always"
-singleQuote: false
-tabWidth: 2
 trailingComma: "all"
-useTabs: false
+overrides:
+  - files: "*.md"
+    options:
+      proseWrap: "always"
diff --git a/.solhint.json b/.solhint.json
@@ -1,14 +1,24 @@
 {
   "extends": "solhint:recommended",
   "rules": {
-    "code-complexity": ["error", 8],
-    "compiler-version": ["error", ">=0.8.13"],
-    "contract-name-camelcase": "off",
-    "func-name-mixedcase": "off",
+    "avoid-low-level-calls": "off",
+    "code-complexity": ["error", 9],
+    "compiler-version": ["error", ">=0.8.22"],
     "func-visibility": ["error", { "ignoreConstructors": true }],
-    "max-line-length": ["error", 124],
-    "named-parameters-mapping": "warn",
-    "no-console": "off",
-    "not-rely-on-time": "off"
+    "func-name-mixedcase": "off",
+    "function-max-lines": "off",
+    "gas-custom-errors": "off",
+    "gas-increment-by-one": "off",
+    "gas-indexed-events": "off",
+    "gas-small-strings": "off",
+    "gas-strict-inequalities": "off",
+    "gas-struct-packing": "off",
+    "max-line-length": ["error", 128],
+    "max-states-count": ["warn", 20],
+    "one-contract-per-file": "off",
+    "no-empty-blocks": "off",
+    "not-rely-on-time": "off",
+    "use-natspec": "off",
+    "var-name-mixedcase": "warn"
   }
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,4 +1,7 @@
 {
+  "[json][jsonc][md][yml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
   "[solidity]": {
     "editor.defaultFormatter": "NomicFoundation.hardhat-solidity"
   },
diff --git a/bun.lockb b/bun.lockb
diff --git a/foundry.toml b/foundry.toml
@@ -8,10 +8,13 @@
   optimizer = true
   optimizer_runs = 5000
   out = "out"
-  solc = "0.8.26"
+  solc = "0.8.29"
   src = "src"
   test = "test"
 
+[lint]
+  lint_on_build = false
+
 [fmt]
   bracket_spacing = true
   int_types = "long"
@@ -23,4 +26,4 @@
   wrap_comments = true
 
 [rpc_endpoints]
-  sepolia = "${SEPOLIA_RPC_URL}"
+  mainnet = "${MAINNET_RPC_URL}"
diff --git a/package.json b/package.json
@@ -10,41 +10,50 @@
     "url": "https://github.com/sablier-labs/lockup-integration-template/issues"
   },
   "dependencies": {
-    "@openzeppelin/contracts": "5.0.2",
-    "@prb/math": "4.0.3",
-    "@sablier/lockup": "^2.0.0",
-    "@sablier/airdrops": "^1.3.0"
+    "@openzeppelin/contracts": "5.3.0",
+    "@prb/math": "4.1.0",
+    "@sablier/airdrops": "2.0.1",
+    "@sablier/evm-utils": "1.0.1",
+    "@sablier/flow": "2.0.0",
+    "@sablier/lockup": "3.0.1"
   },
   "devDependencies": {
-    "forge-std": "github:foundry-rs/forge-std#v1.8.1",
-    "prettier": "^2.8.8",
-    "solhint": "^4.0.0"
+    "forge-std": "github:foundry-rs/forge-std#v1.10.0",
+    "prettier": "^3.5",
+    "solhint": "^6.0"
   },
   "homepage": "https://github.com/sablier-labs/lockup-integration-template#readme",
   "keywords": [
-    "asset-streaming",
     "blockchain",
     "cryptoasset-streaming",
     "cryptoassets",
-    "cryptotoken-streaming",
-    "cryptotokens",
     "ethereum",
+    "evm",
     "foundry",
     "money-streaming",
     "real-time-finance",
     "sablier",
+    "sablier-airdrops",
+    "sablier-flow",
     "sablier-lockup",
     "smart-contracts",
     "solidity",
-    "token-streaming"
+    "token-distribution",
+    "token-streaming",
+    "token-vesting",
+    "vesting",
+    "web3"
   ],
   "license": "GPL-3.0-or-later",
   "private": true,
   "repository": "github.com:sablier-labs/lockup-integration-template",
   "scripts": {
     "clean": "rm -rf cache out",
+    "build": "forge build",
+    "forge-check": "forge fmt --check",
+    "forge-write": "forge fmt",
     "lint": "bun run lint:sol && bun run prettier:check",
-    "lint:sol": "forge fmt --check && bun solhint \"{script,src,test}/**/*.sol\"",
+    "lint:sol": "bun run forge-check && bun solhint \"{script,src,test}/**/*.sol\"",
     "prettier:check": "prettier --check \"**/*.{json,md,yml}\"",
     "prettier:write": "prettier --write \"**/*.{json,md,yml}\"",
     "test": "forge test"
diff --git a/remappings.txt b/remappings.txt
diff --git a/src/LockupStreamCreator.sol b/src/LockupStreamCreator.sol
@@ -2,51 +2,47 @@
 pragma solidity >=0.8.22;
 
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import { ud60x18 } from "@prb/math/src/UD60x18.sol";
 import { ISablierLockup } from "@sablier/lockup/src/interfaces/ISablierLockup.sol";
-import { Broker, Lockup, LockupLinear } from "@sablier/lockup/src/types/DataTypes.sol";
+import { Lockup } from "@sablier/lockup/src/types/Lockup.sol";
+import { LockupLinear } from "@sablier/lockup/src/types/LockupLinear.sol";
 
 /// @title LockupStreamCreator
 /// @dev This contract allows users to create Sablier lockup streams using the Lockup contract.
 contract LockupStreamCreator {
-    IERC20 public constant DAI = IERC20(0x68194a729C2450ad26072b3D33ADaCbcef39D574);
-
-    // Get the latest deployment address from the docs: https://docs.sablier.com/guides/lockup/deployments
-    ISablierLockup public constant LOCKUP = ISablierLockup(0xC2Da366fD67423b500cDF4712BdB41d0995b0794);
+    // Mainnet addresses
+    IERC20 public constant DAI = IERC20(0x6B175474E89094C44Da98b954EedeAC495271d0F);
+    ISablierLockup public constant LOCKUP = ISablierLockup(0xcF8ce57fa442ba50aCbC57147a62aD03873FfA73);
 
     /// @dev Before calling this function, the user must first approve this contract to spend the tokens from the user's
     /// address.
-    function createLinearStream(uint256 totalAmount) external returns (uint256 streamId) {
+    function createLinearStream() public returns (uint256 streamId) {
+        // Declare the total amount as 100 DAI
+        uint128 totalAmount = 100e18;
+
         // Transfer the provided amount of DAI tokens to this contract
         DAI.transferFrom(msg.sender, address(this), totalAmount);
 
-        // Approve the Lockup contract to spend DAI
+        // Approve the Sablier contract to spend DAI
         DAI.approve(address(LOCKUP), totalAmount);
 
         // Declare the params struct
         Lockup.CreateWithDurations memory params;
 
-        // Declare the umlockAmounts and durations structs
-        LockupLinear.UnlockAmounts memory unlockAmounts = LockupLinear.UnlockAmounts({
-            start: 1e18, // The amount to unlock at the start of the stream.
-            cliff: 10e18 // The amount to unlock after cliff period.
-         });
-        LockupLinear.Durations memory durations = LockupLinear.Durations({
-            cliff: 4 weeks, // Cliff tokens will be unlocked after 4 weeks
-            total: 52 weeks // Setting a total duration of ~1 year
-         });
-
         // Declare the function parameters
         params.sender = msg.sender; // The sender will be able to cancel the stream
-        params.recipient = address(0xcafe); // The recipient of the streamed tokens
-        params.totalAmount = uint128(totalAmount); // Total amount includes unlock amounts as well as the fees, if any
+        params.recipient = address(0xCAFE); // The recipient of the streamed tokens
+        params.depositAmount = totalAmount; // Total amount is the amount inclusive of all fees
         params.token = DAI; // The streaming token
         params.cancelable = true; // Whether the stream will be cancelable or not
         params.transferable = true; // Whether the stream will be transferable or not
-        params.shape = "cliff linear"; // Optional parameter for the shape of the stream
-        params.broker = Broker(address(0), ud60x18(0)); // Optional parameter for charging a fee
 
-        // Create the lockup linear stream using a function that sets the start time to `block.timestamp`
+        LockupLinear.UnlockAmounts memory unlockAmounts = LockupLinear.UnlockAmounts({ start: 0, cliff: 0 });
+        LockupLinear.Durations memory durations = LockupLinear.Durations({
+            cliff: 0, // Setting a cliff of 0
+            total: 100 days // Setting a total duration of 100 days
+         });
+
+        // Create the Lockup stream with Linear shape, no cliff and start time as `block.timestamp`
         streamId = LOCKUP.createWithDurationsLL(params, unlockAmounts, durations);
     }
 }
diff --git a/test/LockupStreamCreator.t.sol b/test/LockupStreamCreator.t.sol
@@ -12,7 +12,7 @@ contract LockupStreamCreatorTest is Test {
 
     function setUp() public {
         // Fork Ethereum Mainnet
-        vm.createSelectFork({ blockNumber: 7_499_730, urlOrAlias: "sepolia" });
+        vm.createSelectFork("mainnet");
 
         // Deploy the stream creator contract
         creator = new LockupStreamCreator();
@@ -34,8 +34,7 @@ contract LockupStreamCreatorTest is Test {
 
     function test_CreateLinearStream() public {
         uint256 expectedStreamId = creator.LOCKUP().nextStreamId();
-        // Create a linear stream. The amount provided must be more than `unlockAmounts.start + unlockAmounts.cliff`.
-        uint256 actualStreamId = creator.createLinearStream(1337e18);
+        uint256 actualStreamId = creator.createLinearStream();
 
         // Check that creating linear stream works by checking the stream id
         assertEq(actualStreamId, expectedStreamId);

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-export SEPOLIA_RPC_URL="YOUR_SEPOLIA_RPC_URL"`
	`1`	`+MAINNET_RPC_URL="YOUR_MAINNET_RPC_URL"`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,7 @@`
`1`	`1`	`{`
	`2`	`+ "[json][jsonc][md][yml]": {`
	`3`	`+ "editor.defaultFormatter": "esbenp.prettier-vscode"`
	`4`	`+ },`
`2`	`5`	`"[solidity]": {`
`3`	`6`	`"editor.defaultFormatter": "NomicFoundation.hardhat-solidity"`
`4`	`7`	`},`