@@ -9,37 +9,47 @@ import { links } from "@site/src/constants";
99
1010:::info[ Reach Out]
1111
12- We are unable to deploy the Sablier Protocol on every EVM chain. However, we would be happy to consider your project if
13- you fill out this <Link href = { links .forms .chains } >form</Link > and meet the requirements below.
12+ { /* prettier-ignore */ }
13+ Want to get Sablier deployed on your chain? If you meet the requirements listed below, feel out this <Link href = { links .forms .chains } >form</Link >
14+ and our team will get back to you.
1415
1516:::
1617
1718## Requirements
1819
19- - Blockchain explorer with instructions for verifying contracts
20- - Documentation site
21- - Bridge, with instructions for how to obtain the native token (e.g., ETH) and ERC-20 tokens to the target chain
22- - GraphQL solution, e.g., a deployment of [ The Graph] ( https://thegraph.com/ )
23- - Functional JSON-RPC endpoint, ideally listed on [ ChainList] ( https://chainlist.org/ )
20+ The Sablier Interface currently supports only The Graph and Envio indexer services. If you use a different indexer, you
21+ can schedule a call <Link href = { links .forms .call } >here</Link > to discuss integration.
2422
25- :::warning[ LEGAL]
23+ - [x] Blockchain explorer with instructions for verifying contracts
24+ - [x] Functional JSON-RPC endpoint, preferably listed on [ ChainList] ( https://chainlist.org )
25+ - [x] GraphQL indexer: specifically, either [ The Graph] ( https://thegraph.com ) or [ Envio] ( https://envio.dev )
26+ - [x] Bridge, and instructions for how to obtain gas tokens (e.g., ETH) and ERC-20 tokens to the target chain
27+ - [x] Foundry's [ Deterministic Deployer] ( https://github.com/Arachnid/deterministic-deployment-proxy ) contract at
28+ [ ` 0x4e59b44847b379578588920cA78FbF26c0B4956C ` ] ( https://etherscan.io/address/0x4e59b44847b379578588920cA78FbF26c0B4956C )
29+ - [x] [ Multicall3] ( https://github.com/mds1/multicall ) contract at
30+ [ ` 0xcA11bde05977b3631167028862bE2a173976CA11 ` ] ( https://etherscan.io/address/0xcA11bde05977b3631167028862bE2a173976CA11 )
2631
27- The following guidelines apply to you ONLY IF you have you been granted a
28- [ BUSL license] ( https://app.ens.domains/license-grants.sablier.eth?tab=records ) to deploy the protocol.
32+ ## Making a Deployment
33+
34+ :::warning[ NOTE]
35+
36+ The rest of the guide applies ONLY IF you have you been granted a
37+ [ BUSL license] ( https://app.ens.domains/license-grants.sablier.eth?tab=records ) to deploy the protocol. Otherwise, this
38+ section is not relevant to you.
2939
3040:::
3141
32- ## Prerequisites
42+ ### Prerequisites
3343
34- - Check if the deployment is not already made on [ your chain ] ( /guides/lockup/deployments )
44+ - Check [ here ] ( /guides/lockup/deployments ) if the deployment is not already made
3545- Follow the contributing guides for [ Lockup] ( https://github.com/sablier-labs/lockup/blob/main/CONTRIBUTING.md ) ,
3646 [ Airdrops] ( https://github.com/sablier-labs/airdrops/blob/main/CONTRIBUTING.md ) and
3747 [ Flow] ( https://github.com/sablier-labs/flow/blob/main/CONTRIBUTING.md ) .
3848- RPC endpoint, e.g., a paid [ Infura] ( https://www.infura.io/ ) or [ Alchemy] ( https://www.alchemy.com/ ) account
39- - Enough ETH in your deployer account
40- - Etherscan API key (for source code verification)
49+ - Have enough ETH in your deployer account
50+ - Have an Etherscan API key (for source code verification)
4151
42- ## Lockup Deployment Guide
52+ ### Lockup Deployment
4353
4454#### Step 1: Clone the [ Lockup repo] ( https://github.com/sablier-labs/lockup ) and checkout to the ` v2.0.0 ` tag
4555
@@ -114,7 +124,7 @@ forge script script/DeployProtocol.s.sol \
114124If you are using a mnemonic or a hardware device for your deployer address, refer to ` forge-script ` page from
115125[ foundry book] ( https://book.getfoundry.sh/reference/forge/forge-script#forge-script ) for different wallet options.
116126
117- ## Merkle Airdrops Deployment Guide
127+ ### Merkle Airdrops Deployment
118128
119129#### Step 1: Clone the [ Merkle Airdrops repo] ( https://github.com/sablier-labs/airdrops ) and checkout to ` v1.3.0 ` tag
120130
@@ -189,7 +199,7 @@ forge script script/DeployMerkleFactory.s.sol \
189199If you are using a mnemonic or a hardware device for your deployer address, refer to ` forge-script ` page from the
190200[ Foundry Book] ( https://book.getfoundry.sh/reference/forge/forge-script#forge-script ) .
191201
192- ## Flow Deployment Guide
202+ ### Flow Deployment
193203
194204#### Step 1: Clone the [ Flow repo] ( https://github.com/sablier-labs/flow ) and checkout to ` v1.1.0 ` tag
195205
@@ -264,10 +274,19 @@ forge script script/DeployFlow.s.sol \
264274If you are using a mnemonic or a hardware device for your deployer address, refer to ` forge-script ` page from
265275[ foundry book] ( https://book.getfoundry.sh/reference/forge/forge-script#forge-script ) for different wallet options.
266276
267- ## Submit your deployment
277+ ### List your deployment
268278
269- After the contracts are deployed, submit the deployment details :
279+ After the contracts are deployed, you can submit your deployment like so :
270280
271- 1 . Open a PR in the [ docs repo] ( https://github.com/sablier-labs/docs ) to add the deployment addresses .
281+ 1 . Open a PR in the [ docs repo] ( https://github.com/sablier-labs/docs ) by following the listing instructions below .
2722822 . Open a PR in the [ deployments repo] ( https://github.com/sablier-labs/deployments ) to add the broadcast file (JSON).
273283 You can find it in the ` broadcast ` directory.
284+
285+ #### Listing instructions
286+
287+ When listing a new chain, you need to update the following sections of this documentation site:
288+
289+ - Contract Deployments, e.g. for [ Lockup] ( /guides/lockup/deployments )
290+ - API Endpoints, e.g. for [ Lockup] ( /api/lockup/endpoints )
291+ - [ Governance] ( /concepts/governance )
292+ - [ Fees] ( /concepts/fees )
0 commit comments