refactor: remove V2 and obsolete references (#994)

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

* refactor: remove V2 from codebase
refactor: refer to Lockup contracts

* fix: make NFTDescriptor compatible with previous versions

* fix: use sablier as variabel name in tokenURI

* chore: update precompiles

* refactor: prefix Sablier in NFT mapsymbol

* refactor(periphery): order alphabetically functions in batch interfaces

style: center headers
style: improve the asci art
style: remove empty spaces
chore: add todos

* test: computing merkle proof for 1 leaf

* refactor: use lockup as variable in NFT Descriptor

* refactor: replace v2-core with lockup in urls

* test: add v1.2.0 to NFTDescriptor_Fork_Test
refactor: use package versions in NFTDescriptor_Fork_Test

* refactor: rename SablierNFTDescriptor to LockupNFTDescriptor

* docs(README): remove periphery reference

* test: add TODO over loadDependencies function

---------

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

CHANGELOG.md

@@ -4,101 +4,101 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Common Changelog](https://common-changelog.org/).
 
-[1.2.0]: https://github.com/sablier-labs/v2-core/compare/v1.1.2...v1.2.0
-[1.1.2]: https://github.com/sablier-labs/v2-core/compare/v1.1.1...v1.1.2
-[1.1.1]: https://github.com/sablier-labs/v2-core/compare/v1.1.0...v1.1.1
-[1.1.0]: https://github.com/sablier-labs/v2-core/compare/v1.0.2...v1.1.0
-[1.0.2]: https://github.com/sablier-labs/v2-core/compare/v1.0.1...v1.0.2
-[1.0.1]: https://github.com/sablier-labs/v2-core/compare/v1.0.0...v1.0.1
-[1.0.0]: https://github.com/sablier-labs/v2-core/releases/tag/v1.0.0
+[1.2.0]: https://github.com/sablier-labs/lockup/compare/v1.1.2...v1.2.0
+[1.1.2]: https://github.com/sablier-labs/lockup/compare/v1.1.1...v1.1.2
+[1.1.1]: https://github.com/sablier-labs/lockup/compare/v1.1.0...v1.1.1
+[1.1.0]: https://github.com/sablier-labs/lockup/compare/v1.0.2...v1.1.0
+[1.0.2]: https://github.com/sablier-labs/lockup/compare/v1.0.1...v1.0.2
+[1.0.1]: https://github.com/sablier-labs/lockup/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/sablier-labs/lockup/releases/tag/v1.0.0
 
 ## [1.2.0] - 2024-07-04
 
 ### Changed
 
-- **Breaking:** move common logic into `Lockup` contract ([#784](https://github.com/sablier-labs/v2-core/pull/784),
-  [#813](https://github.com/sablier-labs/v2-core/pull/813), [#850](https://github.com/sablier-labs/v2-core/pull/850),
-  [#941](https://github.com/sablier-labs/v2-core/pull/941))
-- **Breaking:** use a new hook system ([#951](https://github.com/sablier-labs/v2-core/pull/951))
+- **Breaking:** move common logic into `Lockup` contract ([#784](https://github.com/sablier-labs/lockup/pull/784),
+  [#813](https://github.com/sablier-labs/lockup/pull/813), [#850](https://github.com/sablier-labs/lockup/pull/850),
+  [#941](https://github.com/sablier-labs/lockup/pull/941))
+- **Breaking:** use a new hook system ([#951](https://github.com/sablier-labs/lockup/pull/951))
   - Replace `ISablierV2Recipient` with `ISablierLockupRecipient` hook interface
   - Remove `try..catch` block from hook calls
 - Allow only supported characters in NFT Descriptor asset symbols
-  ([#945](https://github.com/sablier-labs/v2-core/pull/945), [#960](https://github.com/sablier-labs/v2-core/pull/960),
-  [#949](https://github.com/sablier-labs/v2-core/pull/949))
-- Bump build dependencies ([#806](https://github.com/sablier-labs/v2-core/pull/806),
-  [#942](https://github.com/sablier-labs/v2-core/pull/942), [#944](https://github.com/sablier-labs/v2-core/pull/944))
-- Change permissions of `withdraw` function to public ([#785](https://github.com/sablier-labs/v2-core/pull/785))
-- Disallow zero `startTime` ([#813](https://github.com/sablier-labs/v2-core/pull/813),
-  [#852](https://github.com/sablier-labs/v2-core/pull/852))
+  ([#945](https://github.com/sablier-labs/lockup/pull/945), [#960](https://github.com/sablier-labs/lockup/pull/960),
+  [#949](https://github.com/sablier-labs/lockup/pull/949))
+- Bump build dependencies ([#806](https://github.com/sablier-labs/lockup/pull/806),
+  [#942](https://github.com/sablier-labs/lockup/pull/942), [#944](https://github.com/sablier-labs/lockup/pull/944))
+- Change permissions of `withdraw` function to public ([#785](https://github.com/sablier-labs/lockup/pull/785))
+- Disallow zero `startTime` ([#813](https://github.com/sablier-labs/lockup/pull/813),
+  [#852](https://github.com/sablier-labs/lockup/pull/852))
 - Rename create functions `createWithTimestamps` and `createWithDurations` across all lockup contracts
-  ([#798](https://github.com/sablier-labs/v2-core/pull/798))
-- Switch to Bun ([#775](https://github.com/sablier-labs/v2-core/pull/775))
-- Use Solidity v0.8.26 ([#944](https://github.com/sablier-labs/v2-core/pull/944))
+  ([#798](https://github.com/sablier-labs/lockup/pull/798))
+- Switch to Bun ([#775](https://github.com/sablier-labs/lockup/pull/775))
+- Use Solidity v0.8.26 ([#944](https://github.com/sablier-labs/lockup/pull/944))
 
 ### Added
 
-- Add Lockup Tranched contract ([#817](https://github.com/sablier-labs/v2-core/pull/817))
-- Add `precompiles` in the NPM release ([#841](https://github.com/sablier-labs/v2-core/pull/841))
+- Add Lockup Tranched contract ([#817](https://github.com/sablier-labs/lockup/pull/817))
+- Add `precompiles` in the NPM release ([#841](https://github.com/sablier-labs/lockup/pull/841))
 - Add return value in `withdrawMax` and `withdrawMaxAndTransfer`
-  ([#961](https://github.com/sablier-labs/v2-core/pull/961))
+  ([#961](https://github.com/sablier-labs/lockup/pull/961))
 
 ### Removed
 
-- **Breaking:** remove protocol fee ([#839](https://github.com/sablier-labs/v2-core/pull/839))
-- Remove flash loan abstract contract ([#779](https://github.com/sablier-labs/v2-core/pull/779))
-- Remove `to` from `withdrawMultiple` function ([#785](https://github.com/sablier-labs/v2-core/pull/785))
+- **Breaking:** remove protocol fee ([#839](https://github.com/sablier-labs/lockup/pull/839))
+- Remove flash loan abstract contract ([#779](https://github.com/sablier-labs/lockup/pull/779))
+- Remove `to` from `withdrawMultiple` function ([#785](https://github.com/sablier-labs/lockup/pull/785))
 
 ## [1.1.2] - 2023-12-19
 
 ### Changed
 
-- Use Solidity v0.8.23 ([#758](https://github.com/sablier-labs/v2-core/pull/758))
+- Use Solidity v0.8.23 ([#758](https://github.com/sablier-labs/lockup/pull/758))
 
 ## [1.1.1] - 2023-12-16
 
 ### Changed
 
 - Bump package version for NPM release
-  ([88db61](https://github.com/sablier-labs/v2-core/tree/88db61bcf193ef9494b31c883ed2c9ad997a1271))
+  ([88db61](https://github.com/sablier-labs/lockup/tree/88db61bcf193ef9494b31c883ed2c9ad997a1271))
 
 ## [1.1.0] - 2023-12-15
 
 ### Changed
 
-- **Breaking**: Remove ability to cancel for recipients ([#710](https://github.com/sablier-labs/v2-core/pull/710))
-- Move `isWarm` and `isCold` to `SablierV2Lockup` ([#664](https://github.com/sablier-labs/v2-core/pull/664))
+- **Breaking**: Remove ability to cancel for recipients ([#710](https://github.com/sablier-labs/lockup/pull/710))
+- Move `isWarm` and `isCold` to `SablierV2Lockup` ([#664](https://github.com/sablier-labs/lockup/pull/664))
 - Replace the streamed amount with the deposit amount in the NFT descriptor
-  ([#692](https://github.com/sablier-labs/v2-core/pull/692))
-- Simplify `renounce` and `withdraw` implementations ([#683](https://github.com/sablier-labs/v2-core/pull/683),
-  [#705](https://github.com/sablier-labs/v2-core/pull/705))
-- Update import paths to use Node.js dependencies ([#734](https://github.com/sablier-labs/v2-core/pull/734))
-- Use Solidity v0.8.21 ([#688](https://github.com/sablier-labs/v2-core/pull/688))
+  ([#692](https://github.com/sablier-labs/lockup/pull/692))
+- Simplify `renounce` and `withdraw` implementations ([#683](https://github.com/sablier-labs/lockup/pull/683),
+  [#705](https://github.com/sablier-labs/lockup/pull/705))
+- Update import paths to use Node.js dependencies ([#734](https://github.com/sablier-labs/lockup/pull/734))
+- Use Solidity v0.8.21 ([#688](https://github.com/sablier-labs/lockup/pull/688))
 
 ### Added
 
-- Add `ERC-4906` metadata update in `transferFrom` ([#686](https://github.com/sablier-labs/v2-core/pull/686))
-- Add `transferable` boolean flag ([#668](https://github.com/sablier-labs/v2-core/pull/668))
+- Add `ERC-4906` metadata update in `transferFrom` ([#686](https://github.com/sablier-labs/lockup/pull/686))
+- Add `transferable` boolean flag ([#668](https://github.com/sablier-labs/lockup/pull/668))
 
 ### Removed
 
 - Remove `@openzeppelin/contracts` from Node.js peer dependencies
-  ([#694](https://github.com/sablier-labs/v2-core/pull/694))
+  ([#694](https://github.com/sablier-labs/lockup/pull/694))
 
 ## [1.0.2] - 2023-08-14
 
 ### Changed
 
-- Update `@prb/math` import paths to contain `src/` ([#648](https://github.com/sablier-labs/v2-core/pull/648))
+- Update `@prb/math` import paths to contain `src/` ([#648](https://github.com/sablier-labs/lockup/pull/648))
 
 ## [1.0.1] - 2023-07-13
 
 ### Changed
 
-- Optimize use of variables in `tokenURI` ([#617](https://github.com/sablier-labs/v2-core/pull/617))
+- Optimize use of variables in `tokenURI` ([#617](https://github.com/sablier-labs/lockup/pull/617))
 
 ### Fixed
 
-- Fix data URI scheme in `tokenURI` ([#617](https://github.com/sablier-labs/v2-core/pull/617))
+- Fix data URI scheme in `tokenURI` ([#617](https://github.com/sablier-labs/lockup/pull/617))
 
 ## [1.0.0] - 2023-07-07
 

CONTRIBUTING.md

@@ -1,10 +1,10 @@
 # Contributing
 
-Feel free to dive in! [Open](https://github.com/sablier-labs/v2-core/issues/new) an issue,
-[start](https://github.com/sablier-labs/v2-core/discussions/new) a discussion or submit a PR. For any informal concerns
+Feel free to dive in! [Open](https://github.com/sablier-labs/lockup/issues/new) an issue,
+[start](https://github.com/sablier-labs/lockup/discussions/new) a discussion or submit a PR. For any informal concerns
 or feedback, please join our [Discord server](https://discord.gg/bSwRCwWRsT).
 
-Contributions to Sablier V2 Core are welcome by anyone interested in writing more tests, improving readability,
+Contributions to Sablier Lockup are welcome by anyone interested in writing more tests, improving readability,
 optimizing for gas efficiency, or extending the protocol via new features.
 
 ## Pre Requisites
@@ -23,7 +23,7 @@ In addition, familiarity with [Solidity](https://soliditylang.org/) is requisite
 Clone this repository including submodules:
 
 ```shell
-$ git clone --recurse-submodules -j8 git@github.com:sablier-labs/v2-core.git
+$ git clone --recurse-submodules -j8 git@github.com:sablier-labs/lockup.git
 ```
 
 Then, inside the project's directory, run this to install the Node.js dependencies and build the contracts:

LICENSE.md

@@ -9,7 +9,7 @@ Parameters
 
 Licensor: Sablier Labs Ltd
 
-Licensed Work: Sablier V2 Core The Licensed Work is (C) 2024 Sablier Labs Ltd
+Licensed Work: Sablier Lockup The Licensed Work is (C) 2024 Sablier Labs Ltd
 
 Additional Use Grant: Any uses listed and defined at v2-core-license-grants.sablier.eth
 

README.md

@@ -1,23 +1,20 @@
-# Sablier V2 Core [![Github Actions][gha-badge]][gha] [![Coverage][codecov-badge]][codecov] [![Foundry][foundry-badge]][foundry] [![Discord][discord-badge]][discord]
+# Sablier Lockup [![Github Actions][gha-badge]][gha] [![Coverage][codecov-badge]][codecov] [![Foundry][foundry-badge]][foundry] [![Discord][discord-badge]][discord]
 
-[gha]: https://github.com/sablier-labs/v2-core/actions
-[gha-badge]: https://github.com/sablier-labs/v2-core/actions/workflows/ci.yml/badge.svg
-[codecov]: https://codecov.io/gh/sablier-labs/v2-core
-[codecov-badge]: https://codecov.io/gh/sablier-labs/v2-core/branch/main/graph/badge.svg
+[gha]: https://github.com/sablier-labs/lockup/actions
+[gha-badge]: https://github.com/sablier-labs/lockup/actions/workflows/ci.yml/badge.svg
+[codecov]: https://codecov.io/gh/sablier-labs/lockup
+[codecov-badge]: https://codecov.io/gh/sablier-labs/lockup/branch/main/graph/badge.svg
 [discord]: https://discord.gg/bSwRCwWRsT
 [discord-badge]: https://dcbadge.vercel.app/api/server/bSwRCwWRsT?style=flat
 [foundry]: https://getfoundry.sh
 [foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg
 
-This repository contains the core smart contracts of the Sablier V2 Protocol. For higher-level logic, see the
-[sablier-labs/v2-periphery](https://github.com/sablier-labs/v2-periphery) repository.
-
 In-depth documentation is available at [docs.sablier.com](https://docs.sablier.com).
 
 ## Background
 
-Sablier V2 is a token distribution protocol used by DAOs and businesses for vesting, payroll, airdrops, and more. Our
-flagship model is the linear stream, which distributes assets on a continuous, by-the-second basis.
+Sablier Lockup Protocol is a token distribution protocol used by DAOs and businesses for vesting, payroll, airdrops, and
+more. Our flagship model is the linear stream, which distributes assets on a continuous, by-the-second basis.
 
 The way it works is that the sender of a payment stream first deposits a specific amount of ERC-20 tokens in a contract.
 Then, the contract progressively allocates the funds to the recipient, who can access them as they become available over
@@ -30,16 +27,16 @@ of tokens deposited.
 
 This is the recommended approach.
 
-Install Sablier V2 Core using your favorite package manager, e.g., with Bun:
+Install Lockup using your favorite package manager, e.g., with Bun:
 
 ```shell
-bun add @sablier/v2-core
+bun add @sablier/lockup
 ```
 
 Then, if you are using Foundry, you need to add these to your `remappings.txt` file:
 
 ```text
-@sablier/v2-core/=node_modules/@sablier/v2-core/
+@sablier/lockup/=node_modules/@sablier/lockup/
 @openzeppelin/contracts/=node_modules/@openzeppelin/contracts/
 @prb/math/=node_modules/@prb/math/
 ```
@@ -51,7 +48,7 @@ This installation method is not recommended, but it is available for those who p
 First, install the submodule using Forge:
 
 ```shell
-forge install --no-commit sablier-labs/v2-core
+forge install --no-commit sablier-labs/lockup
 ```
 
 Second, install the project's dependencies:
@@ -63,21 +60,21 @@ forge install --no-commit OpenZeppelin/openzeppelin-contracts@v5.0.2 PaulRBerg/p
 Finally, add these to your `remappings.txt` file:
 
 ```text
-@sablier/v2-core/=lib/v2-core/
+@sablier/lockup/=lib/lockup/
 @openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/
 @prb/math/=lib/prb-math/
 ```
 
 ## Usage
 
-This is just a glimpse of Sablier V2 Core. For more guides and examples, see the
+This is just a glimpse of Sablier Lockup. For more guides and examples, see the
 [documentation](https://docs.sablier.com).
 
 ```solidity
-import { ISablierV2LockupLinear } from "@sablier/v2-core/src/interfaces/ISablierV2LockupLinear.sol";
+import { ISablierLockupLinear } from "@sablier/lockup/src/interfaces/ISablierLockupLinear.sol";
 
 contract MyContract {
-  ISablierV2LockupLinear sablier;
+  ISablierLockupLinear lockup;
 
   function buildSomethingWithSablier() external {
     // ...
@@ -87,7 +84,7 @@ contract MyContract {
 
 ## Architecture
 
-V2 Core uses a singleton-style architecture, where all streams are managed in the `LockupLinear`, `LockupDynamic` and
+Lockup uses a singleton-style architecture, where all streams are managed in the `LockupLinear`, `LockupDynamic` and
 `LockupTranched` contracts. That is, Sablier does not deploy a new contract for each stream. It bundles all streams into
 a single contract, which is more gas-efficient and easier to maintain.
 
@@ -97,12 +94,12 @@ docs, as well as these [diagrams](https://docs.sablier.com/contracts/v2/referenc
 ### Branching Tree Technique
 
 You may notice that some test files are accompanied by `.tree` files. This is called the Branching Tree Technique, and
-it is explained in depth [here](https://github.com/sablier-labs/v2-core/wiki/Tests#branching-tree-technique).
+it is explained in depth [here](https://github.com/sablier-labs/lockup/wiki/Tests#branching-tree-technique).
 
 ## Deployments
 
 The list of all deployment addresses can be found [here](https://docs.sablier.com). For guidance on the deploy scripts,
-see the [Deployments wiki](https://github.com/sablier-labs/v2-core/wiki/Deployments).
+see the [Deployments wiki](https://github.com/sablier-labs/lockup/wiki/Deployments).
 
 ## Security
 
@@ -114,15 +111,15 @@ bug bounty program per the terms outlined in the aforementioned policy.
 
 ## Contributing
 
-Feel free to dive in! [Open](https://github.com/sablier-labs/v2-core/issues/new) an issue,
-[start](https://github.com/sablier-labs/v2-core/discussions/new) a discussion or submit a PR. For any informal concerns
+Feel free to dive in! [Open](https://github.com/sablier-labs/lockup/issues/new) an issue,
+[start](https://github.com/sablier-labs/lockup/discussions/new) a discussion or submit a PR. For any informal concerns
 or feedback, please join our [Discord server](https://discord.gg/bSwRCwWRsT).
 
 For guidance on how to create PRs, see the [CONTRIBUTING](./CONTRIBUTING.md) guide.
 
 ## License
 
-The primary license for Sablier V2 Core is the Business Source License 1.1 (`BUSL-1.1`), see
+The primary license for Sablier Lockup is the Business Source License 1.1 (`BUSL-1.1`), see
 [`LICENSE.md`](./LICENSE.md). However, there are exceptions:
 
 - All files in `src/interfaces/` and `src/types` are licensed under `GPL-3.0-or-later`, see

SECURITY.md

@@ -9,8 +9,8 @@ report it to us.
 
 ### Overview
 
-Starting on July 1, 2023, the [sablier-labs/v2-core](https://github.com/sablier-labs/v2-core) repository is subject to
-the Sablier V2 Bug Bounty (the "Program") to incentivize responsible bug disclosure.
+Starting on July 1, 2023, the [sablier-labs/lockup](https://github.com/sablier-labs/lockup) repository is subject to the
+Sablier Bug Bounty (the "Program") to incentivize responsible bug disclosure.
 
 We are limiting the scope of the Program to critical and high severity bugs, and are offering a reward of up to
 $100,000. Happy hunting!
@@ -25,8 +25,8 @@ The Program does NOT cover the following:
 - External code in `node_modules`, except for code that is explicitly used by a deployed contract located in the
   [src](./src) directory.
 - Contract deployments on test networks, such as Sepolia.
-- Bugs in third-party contracts or platforms interacting with Sablier V2 Core.
-- Previously reported or discovered vulnerabilities in contracts built by third parties on Sablier V2 Core.
+- Bugs in third-party contracts or platforms interacting with Sablier Lockup.
+- Previously reported or discovered vulnerabilities in contracts built by third parties on Sablier Lockup.
 - Bugs that have already been reported.
 
 Vulnerabilities contingent upon the occurrence of any of the following also are outside the scope of this Program:
@@ -42,7 +42,7 @@ Vulnerabilities contingent upon the occurrence of any of the following also are
 
 ### Assumptions
 
-Sablier V2 Core has been developed with a number of technical assumptions in mind. For a disclosure to qualify as a
+Sablier Lockup has been developed with a number of technical assumptions in mind. For a disclosure to qualify as a
 vulnerability, it must adhere to these assumptions as well:
 
 - The immutable variables `MAX_SEGMENT_COUNT` and `MAX_TRANCHE_COUNT` have values that cannot lead to an overflow of the
@@ -89,8 +89,8 @@ publicly for their contribution if they so choose.
 To qualify for a reward under this Program, you must adhere to the following criteria:
 
 - Identify a previously unreported, non-public vulnerability that could result in the loss or freeze of any ERC-20 asset
-  in Sablier V2 (but not on any third-party platform interacting with Sablier V2) and that is within the scope of this
-  Program.
+  in Sablier Lockup (but not on any third-party platform interacting with Sablier Lockup) and that is within the scope
+  of this Program.
 - The vulnerability must be distinct from the issues covered in the [Audits](https://github.com/sablier-labs/audits).
 - Be the first to report the unique vulnerability to [security@sablier.com](mailto:security@sablier.com) in accordance
   with the disclosure requirements specified above. If multiple similar vulnerabilities are reported within a 24-hour
@@ -101,7 +101,7 @@ To qualify for a reward under this Program, you must adhere to the following cri
 - Avoid exploiting the vulnerability in any manner, such as making it public or profiting from it (aside from the reward
   offered under this Program).
 - Make a genuine effort to prevent privacy violations, data destruction, and any interruption or degradation of Sablier
-  V2.
+  Lockup.
 - Submit only one vulnerability per submission, unless chaining vulnerabilities is necessary to demonstrate the impact
   of any of them.
 - Do not submit a vulnerability that stems from an underlying issue for which a reward has already been paid under this

benchmark/BatchLockup.Gas.t.sol

@@ -26,7 +26,7 @@ contract BatchLockup_Gas_Test is Benchmark_Test {
 
     function testGas_Implementations() external {
         // Set the file path.
-        benchmarkResultsFile = string.concat(benchmarkResults, "SablierV2BatchLockup.md");
+        benchmarkResultsFile = string.concat(benchmarkResults, "SablierBatchLockup.md");
 
         // Create the file if it doesn't exist, otherwise overwrite it.
         vm.writeFile({