refactor: update templates (#17)

* refactor: update templates

* renames v2-core to lockup

* andrei's feedback

Co-authored-by: Andrei Vlad Birgaoanu <99738872+andreivladbrg@users.noreply.github.com>

* test: remove unneeded variable

chore: rename env var

* chore: update keywords

* fix ci

* style: prettier

* ci: fix

* rename test function

* use npm version for lockup

* build: add airdrops npm package

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

---------

Co-authored-by: Andrei Vlad Birgaoanu <99738872+andreivladbrg@users.noreply.github.com>
Co-authored-by: Andrei Vlad Birgaoanu <andreivladbrg@gmail.com>

Author: smol-ninja

.env.example

@@ -1 +1 @@
-export RPC_URL_SEPOLIA="YOUR_RPC_URL_SEPOLIA"
+export SEPOLIA_RPC_URL="YOUR_SEPOLIA_RPC_URL"

.github/workflows/ci.yml

@@ -1,7 +1,7 @@
 name: "CI"
 
 env:
-  RPC_URL_SEPOLIA: ${{ secrets.RPC_URL_SEPOLIA }}
+  SEPOLIA_RPC_URL: ${{ secrets.SEPOLIA_RPC_URL }}
   FOUNDRY_PROFILE: "ci"
 
 on:

README.md

@@ -1,13 +1,13 @@
 # Lockup Integration Template
 
 This repository contains templates for building integrations with
-[Sablier Lockup](https://github.com/sablier-labs/v2-core).
+[Sablier Lockup](https://github.com/sablier-labs/lockup).
 
-- **LockupStreamCreator**: A template for creating a Lockup Linear stream.
+- **LockupStreamCreator**: A template for creating a Lockup stream using Linear model.
 
 For more information, refer to this guide on our documentation website:
 
-https://docs.sablier.com/contracts/v2/guides/local-environment
+https://docs.sablier.com/guides/lockup/examples/local-environment
 
 ## License
 

bun.lockb

@@ -23,4 +23,4 @@
   wrap_comments = true
 
 [rpc_endpoints]
-  sepolia = "${RPC_URL_SEPOLIA}"
+  sepolia = "${SEPOLIA_RPC_URL}"

foundry.toml

@@ -1,6 +1,6 @@
 {
   "name": "lockup-integration-template",
-  "description": "Template for making on-chain integrations with Sablier Lockup V2",
+  "description": "Template for making on-chain integrations with Sablier Lockup",
   "version": "1.0.0",
   "author": {
     "name": "Sablier Labs Ltd",
@@ -12,8 +12,8 @@
   "dependencies": {
     "@openzeppelin/contracts": "5.0.2",
     "@prb/math": "4.0.3",
-    "@sablier/v2-core": "1.2.0",
-    "@sablier/v2-periphery": "1.2.0"
+    "@sablier/lockup": "2.0.0",
+    "@sablier/airdrops": "1.3.0"
   },
   "devDependencies": {
     "forge-std": "github:foundry-rs/forge-std#v1.8.1",
@@ -26,12 +26,14 @@
     "blockchain",
     "cryptoasset-streaming",
     "cryptoassets",
+    "cryptotoken-streaming",
+    "cryptotokens",
     "ethereum",
     "foundry",
     "money-streaming",
     "real-time-finance",
     "sablier",
-    "sablier-v2",
+    "sablier-lockup",
     "smart-contracts",
     "solidity",
     "token-streaming"

package.json

@@ -1,5 +1,4 @@
 @openzeppelin/contracts/=node_modules/@openzeppelin/contracts/
 @prb/math/=node_modules/@prb/math/
-@sablier/v2-core/=node_modules/@sablier/v2-core/
-@sablier/v2-periphery/=node_modules/@sablier/v2-periphery/
+@sablier/lockup/=node_modules/@sablier/lockup/
 forge-std/=node_modules/forge-std/

remappings.txt

@@ -3,45 +3,50 @@ pragma solidity >=0.8.22;
 
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import { ud60x18 } from "@prb/math/src/UD60x18.sol";
-import { ISablierV2LockupLinear } from "@sablier/v2-core/src/interfaces/ISablierV2LockupLinear.sol";
-import { Broker, LockupLinear } from "@sablier/v2-core/src/types/DataTypes.sol";
+import { ISablierLockup } from "@sablier/lockup/src/interfaces/ISablierLockup.sol";
+import { Broker, Lockup, LockupLinear } from "@sablier/lockup/src/types/DataTypes.sol";
 
 /// @title LockupStreamCreator
-/// @dev This contract allows users to create Sablier lockup streams using the Lockup Linear contract.
+/// @dev This contract allows users to create Sablier lockup streams using the Lockup contract.
 contract LockupStreamCreator {
     IERC20 public constant DAI = IERC20(0x68194a729C2450ad26072b3D33ADaCbcef39D574);
-    ISablierV2LockupLinear public immutable LOCKUP;
 
-    constructor(ISablierV2LockupLinear lockup) {
-        LOCKUP = lockup;
-    }
+    // Get the latest deployment address from the docs: https://docs.sablier.com/guides/lockup/deployments
+    ISablierLockup public constant LOCKUP = ISablierLockup(0xC2Da366fD67423b500cDF4712BdB41d0995b0794);
 
     /// @dev Before calling this function, the user must first approve this contract to spend the tokens from the user's
     /// address.
-    function createLockupLinearStream(uint256 totalAmount) external returns (uint256 streamId) {
+    function createLinearStream(uint256 totalAmount) external returns (uint256 streamId) {
         // Transfer the provided amount of DAI tokens to this contract
         DAI.transferFrom(msg.sender, address(this), totalAmount);
 
         // Approve the Lockup contract to spend DAI
         DAI.approve(address(LOCKUP), totalAmount);
 
         // Declare the params struct
-        LockupLinear.CreateWithDurations memory params;
+        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 assets
-        params.totalAmount = uint128(totalAmount); // Total amount is the amount inclusive of all fees
-        params.asset = DAI; // The streaming asset
+        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.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.durations = LockupLinear.Durations({
-            cliff: 4 weeks, // Assets will be unlocked only after 4 weeks
-            total: 52 weeks // Setting a total duration of ~1 year
-         });
+        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 stream using a function that sets the start time to `block.timestamp`
-        streamId = LOCKUP.createWithDurations(params);
+        // Create the lockup linear stream using a function that sets the start time to `block.timestamp`
+        streamId = LOCKUP.createWithDurationsLL(params, unlockAmounts, durations);
     }
 }

src/LockupStreamCreator.sol

@@ -2,34 +2,27 @@
 pragma solidity >=0.8.22;
 
 import { Test } from "forge-std/src/Test.sol";
-import { ISablierV2LockupLinear } from "@sablier/v2-core/src/interfaces/ISablierV2LockupLinear.sol";
 
 import { LockupStreamCreator } from "../src/LockupStreamCreator.sol";
 
 contract LockupStreamCreatorTest is Test {
-    // Get the latest deployment address from the docs: https://docs.sablier.com/contracts/v2/deployments
-    address internal constant LOCKUP_LINEAR_ADDRESS = address(0x3E435560fd0a03ddF70694b35b673C25c65aBB6C);
-
     // Test contracts
     LockupStreamCreator internal creator;
-    ISablierV2LockupLinear internal lockup;
     address internal user;
 
     function setUp() public {
         // Fork Ethereum Mainnet
-        vm.createSelectFork({ blockNumber: 6_239_031, urlOrAlias: "sepolia" });
-
-        // Load the lockup linear contract from Ethereum Sepolia
-        lockup = ISablierV2LockupLinear(LOCKUP_LINEAR_ADDRESS);
+        vm.createSelectFork({ blockNumber: 7_499_730, urlOrAlias: "sepolia" });
 
         // Deploy the stream creator contract
-        creator = new LockupStreamCreator(lockup);
+        creator = new LockupStreamCreator();
 
         // Create a test user
         user = payable(makeAddr("User"));
         vm.deal({ account: user, newBalance: 1 ether });
 
-        // Mint some DAI tokens to the test user, which will be pulled by the creator contract
+        // Mint some DAI tokens to the test user, which will be pulled by the creator contract. Make sure its more than
+        // `params.totalAmount`.
         deal({ token: address(creator.DAI()), to: user, give: 1337e18 });
 
         // Make the test user the `msg.sender` in all following calls
@@ -39,9 +32,10 @@ contract LockupStreamCreatorTest is Test {
         creator.DAI().approve({ spender: address(creator), value: 1337e18 });
     }
 
-    function test_CreateLockupLinearStream() public {
-        uint256 expectedStreamId = lockup.nextStreamId();
-        uint256 actualStreamId = creator.createLockupLinearStream(1337e18);
+    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);
 
         // Check that creating linear stream works by checking the stream id
         assertEq(actualStreamId, expectedStreamId);