refactor: restructure with lockup dir

README.md

@@ -1,14 +1,14 @@
-# Sablier V2 Deployments
+# Sablier Deployments
 
-This repository keeps track of Sablier V2 deployment bundles, each of which includes:
+This repository keeps track of Sablier deployment bundles, each of which includes:
 
 1. Contract artifacts and ABIs.
 2. The [broadcast](https://book.getfoundry.sh/tutorials/solidity-scripting) directories generated by Foundry upon
    running the deploy scripts.
 
 The deployments are indexed by:
 
-1. Repository ("core" or "periphery")
+1. Repository ("lockup" or "flow")
 2. Version name (e.g. "v1.0.0")
 3. Artifacts
 4. Broadcasts, which in turn are indexed by chain name.
@@ -18,8 +18,8 @@ If you need the deployment addresses, you can find them in the
 
 ## Background
 
-Sablier V2 has been built, tested, formatted, and deployed with the [Foundry](https://getfoundry.sh/) smart contract
-development toolchain.
+Sablier Protocols have been built, tested, formatted, and deployed with the [Foundry](https://getfoundry.sh/) smart
+contract development toolchain.
 
 To learn more about Foundry, see the [Foundry Book](https://book.getfoundry.sh/).
 
@@ -35,13 +35,15 @@ The contract artifacts and the ABIs are published as NPM packages:
 
 - [@sablier/v2-core](https://npmjs.com/package/@sablier/v2-core)
 - [@sablier/v2-periphery](https://npmjs.com/package/@sablier/v2-periphery)
+- [@sablier/flow](https://npmjs.com/package/@sablier/flow)
 
 ## Scripts
 
 The contracts have been deployed using these scripts:
 
 - [v2-core/script](https://github.com/sablier-labs/v2-core/tree/main/script)
 - [v2-periphery/script](https://github.com/sablier-labs/v2-periphery/tree/main/script)
+- [flow/script](https://github.com/sablier-labs/flow/tree/main/script)
 
 Specifically, with the "DeployDeterministic" scripts, which use this CREATE2 factory:
 

flow/v1.0.0/README.md

@@ -0,0 +1,109 @@
+# v1.0.0
+
+## Contract Deployed
+
+- SablierFlow
+- FlowNFTDescriptor
+
+## Sources
+
+- Commit: [ba8c67a](https://github.com/sablier-labs/flow/commit/ba8c67a35d9cfd4fe646c2ab7db2c40e93d7fd6f)
+- Package: [@sablier/flow@1.0.0](https://npmjs.com/package/@sablier/flow/v/1.0.0)
+
+## Compiler Settings
+
+| Setting        | Value    |
+| :------------- | :------- |
+| Version        | 0.8.26   |
+| EVM            | Shanghai |
+| Optimizer      | Yes      |
+| Optimizer Runs | 10,000   |
+| Via IR         | true     |
+
+### Linea Compiler Settings
+
+Due to the lack of [EIP-3855](https://eips.ethereum.org/EIPS/eip-3855) support, we had to use the following settings for
+Linea:
+
+| Setting        | Value  |
+| :------------- | :----- |
+| Version        | 0.8.26 |
+| EVM            | Paris  |
+| Optimizer      | Yes    |
+| Optimizer Runs | 10,000 |
+| Via IR         | true   |
+
+### IoTex and Tangle
+
+Due to the lack of Foundry support and for newer Solidity versions, we had to use the following settings for IoTex and
+Tangle:
+
+| Setting        | Value  |
+| :------------- | :----- |
+| Version        | 0.8.20 |
+| EVM            | Paris  |
+| Optimizer      | Yes    |
+| Optimizer Runs | 10,000 |
+| Via IR         | true   |
+
+### zkSync
+
+Since `zkSync` has its own VM, we needed to use their tools,
+[Hardhat zkSync](https://github.com/matter-labs/hardhat-zksync), to deploy the contracts with the following
+configuration:
+
+| Setting        | Value  |
+| :------------- | :----- |
+| Version        | 0.8.26 |
+| zkSolc         | 1.5.6  |
+| EVM            | Paris  |
+| Optimizer      | Yes    |
+| Optimizer Runs | 200    |
+| Via IR         | true   |
+
+## Salts
+
+The CREATE2 salts used during deployment:
+
+### Mainnets
+
+| Chain           | Salt                          |
+| :-------------- | :---------------------------- |
+| Arbitrum One    | ChainID 42161, Version 1.0.0  |
+| Avalanche       | ChainID 43114, Version 1.0.0  |
+| Base            | ChainID 8453, Version 1.0.0   |
+| Blast           | ChainID 81457, Version 1.0.0  |
+| BNB Smart Chain | ChainID 56, Version 1.0.0     |
+| Core Dao        | ChainID 1116, Version 1.0.0   |
+| Gnosis          | ChainID 100, Version 1.0.0    |
+| IoTex           | No Salt                       |
+| Lightlink       | No Salt                       |
+| Linea           | ChainID 59144, Version 1.0.0  |
+| Mainnet         | ChainID 1, Version 1.0.0      |
+| Meld            | No Salt                       |
+| Mode            | No Salt                       |
+| Morph           | No Salt                       |
+| Optimism        | ChainID 10, Version 1.0.0     |
+| Polygon         | ChainID 137, Version 1.0.0    |
+| Scroll          | ChainID 534352, Version 1.0.0 |
+| Superseed       | ChainID 5330, Version 1.0.0   |
+| Taiko Mainnet   | ChainID 167000, Version 1.0.0 |
+| Tangle          | No Salt                       |
+| zkSync Era      | No Salt                       |
+
+### Testnets
+
+| Chain             | Salt                             |
+| :---------------- | :------------------------------- |
+| Arbitrum Sepolia  | ChainID 421614, Version 1.0.0    |
+| Base Sepolia      | ChainID 84532, Version 1.0.0     |
+| Berachain Bartio  | ChainID 80084, Version 1.0.0     |
+| Blast Sepolia     | ChainID 168587773, Version 1.0.0 |
+| Linea Sepolia     | No Salt                          |
+| Mode Sepolia      | No Salt                          |
+| Morph Holesky     | No Salt                          |
+| Optimism Sepolia  | ChainID 11155420, Version 1.0.0  |
+| Sepolia           | ChainID 11155111, Version 1.0.0  |
+| Superseed Sepolia | ChainID 53302, Version 1.0.0     |
+| Taiko Hekla       | ChainID 167009, Version 1.0.0    |
+| zkSync Sepolia    | No Salt                          |