diff --git a/docs/guides/03-custom-deployments.mdx b/docs/guides/03-custom-deployments.mdx index 2321f14..40f8a5d 100644 --- a/docs/guides/03-custom-deployments.mdx +++ b/docs/guides/03-custom-deployments.mdx @@ -16,7 +16,7 @@ you fill out this form and meet the requi ## Requirements -- Blockchain explorer +- Blockchain explorer with instructions for verifying contracts - Documentation site - Bridge, with instructions for how to obtain the native token (e.g., ETH) and ERC-20 tokens to the target chain - GraphQL solution, e.g., a deployment of [The Graph](https://thegraph.com/) @@ -174,17 +174,17 @@ forge script script/DeployPeriphery.s.sol \ ``` If you are using a mnemonic or a hardware device for your deployer address, refer to `forge-script` page from the -[Foundry Book](https://book.getfoundry.sh/reference/forge/forge-script#forge-script) for different wallet options. +[Foundry Book](https://book.getfoundry.sh/reference/forge/forge-script#forge-script). -### Steps for listing the deployments +### Steps for adding the deployments -Once the contracts are deployed, the final step is to list the deployment addresses and artifacts in the Lockup docs: +Once the contracts are deployed, the final step is to add the deployment addresses and broadcast files in the Sablier +docs: -1. List the deployment addresses by opening a PR in the - [docs repo](https://github.com/sablier-labs/docs/blob/main/docs/contracts/v2/02-deployments.md) -2. List the deployment artifacts by opening a PR in the [deployments repo](https://github.com/sablier-labs/deployments) - - Copy the generated artifact files (ABIs) from the `artifacts` directory. - - Copy the latest broadcast file from the `broadcast` directory. +1. Add the deployment addresses by opening a PR in the + [docs repo](https://github.com/sablier-labs/docs/blob/main/docs/guides/lockup/02-deployments.md). +2. Copy the latest broadcast files (JSON) from your project's `broadcast` directory, and proceed with opening the PR in + the [deployments repo](https://github.com/sablier-labs/deployments). ## Flow Deployment Guide @@ -272,3 +272,12 @@ forge script script/DeployFlow.s.sol \ If you are using a mnemonic or a hardware device for your deployer address, refer to `forge-script` page from [foundry book](https://book.getfoundry.sh/reference/forge/forge-script#forge-script) for different wallet options. + +### Steps for adding the deployments + +Once the contracts are deployed, the final step is to add the deployment addresses and broadcast file in the docs: + +1. Add the deployment addresses by opening a PR in the + [docs repo](https://github.com/sablier-labs/docs/blob/main/docs/guides/flow/02-deployments.md) +2. Copy the latest broadcast file (JSON) from the `broadcast` directory and open a PR in the + [deployments repo](https://github.com/sablier-labs/deployments) diff --git a/docs/reference/01-overview.md b/docs/reference/01-overview.md index dccc17e..a7b0c65 100644 --- a/docs/reference/01-overview.md +++ b/docs/reference/01-overview.md @@ -26,7 +26,7 @@ The design of the Sablier smart contracts draws inspiration from the architectur > [**Core Source Code**](https://github.com/sablier-labs/v2-core/tree/v1.2.0) -Core consists of the distribution contracts (LockupLinear, LockupDynamic and LockupTranched), and an NFT descriptor. +The Core consists of the distribution contracts (LockupLinear, LockupDynamic and LockupTranched), and an NFT descriptor. ### LockupLinear @@ -78,4 +78,18 @@ contracts (such as MerkleLockupFactory, MerkleLL and MerkleLT). ## Flow -Coming soon. +> [**Flow Source Code**](https://github.com/sablier-labs/flow/tree/v1.0.0) + +The Flow repo consists of the monolith Sablier Flow contract, and an NFT descriptor. + +### NFTDescriptor + +> [**FlowNFTDescriptor Reference**](./flow/contracts/contract.FlowNFTDescriptor) + +Generates the URI describing the Sablier Flow stream NFTs which, currently, is the Sablier logo. + +### SablierFlow + +> [**SablierFlow Reference**](./flow/contracts/contract.SablierFlow) + +Creates and manages payment streams.