docs: update docs (#75)

velodrome-finance · Dec 6, 2024 · d9a2969 · d9a2969
1 parent 6326e91
commit d9a2969
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,8 @@
-# Slipstream
+# Velodrome Superchain Slipstream Contracts
 
-This repository contains the smart contracts for the Slipstream Concentrated Liquidity contracts. It contains
-the core concentrated liquidity contracts, adapted from UniswapV3's core contracts. It contains the higher level
-periphery contracts, adapted from UniswapV3's periphery contracts. It also contains gauges designed to operate
-within the Velodrome ecosystem.  
+This repository contains the smart contracts for the Velodrome Superchain Slipstream. It is adapted from the original Slipstream contracts for use on the Velodrome Superchain.
 
-See `SPECIFICATION.md` and `CHANGELOG.md` for more information. 
+See `SPECIFICATION.md` for more information. See the original [Slipstream](https://github.com/velodrome-finance/slipstream) repository for more information about Slipstream.
 
 ## Installation
 
@@ -28,28 +25,25 @@ echidna test/invariants/E2E_mint_burn.sol --config test/invariants/E2E_mint_burn
 echidna test/invariants/E2E_swap.sol --config test/invariants/E2E_swap.config.yaml --contract E2E_swap
 ```
 
+## Deployment
+
+See `script/README.md` for deployment instructions.
+
 ## Licensing
 
 This project follows the [Apache Foundation](https://infra.apache.org/licensing-howto.html)
 guideline for licensing. See LICENSE and NOTICE files.
 
-
 ## Bug Bounty
 Velodrome has a live bug bounty hosted on ([Immunefi](https://immunefi.com/bounty/velodromefinance/)).
 
 ## Deployment
 
-| Name               | Address                                                                                                                               |
-| :----------------- | :------------------------------------------------------------------------------------------------------------------------------------ |
-| GaugeFactory               | [0x327147eE440252b893A771345025B41A267Ad985](https://optimistic.etherscan.io/address/0x327147eE440252b893A771345025B41A267Ad985#code) |
-| GaugeImplementation               | [0x7155b84A704F0657975827c65Ff6fe42e3A962bb](https://optimistic.etherscan.io/address/0x7155b84A704F0657975827c65Ff6fe42e3A962bb#code) |
-| MixedQuoter               | [0xFF79ec912bA114FD7989b9A2b90C65f0c1b44722](https://optimistic.etherscan.io/address/0xFF79ec912bA114FD7989b9A2b90C65f0c1b44722#code) |
-| NonfungiblePositionManager               | [0x416b433906b1B72FA758e166e239c43d68dC6F29](https://optimistic.etherscan.io/address/0x416b433906b1B72FA758e166e239c43d68dC6F29#code) |
-| NonfungibleTokenPositionDescriptor               | [0xccDf417f49a14bC2b23c71684de0304C56DEA165](https://optimistic.etherscan.io/address/0xccDf417f49a14bC2b23c71684de0304C56DEA165#code) |
-| PoolFactory               | [0xCc0bDDB707055e04e497aB22a59c2aF4391cd12F](https://optimistic.etherscan.io/address/0xCc0bDDB707055e04e497aB22a59c2aF4391cd12F#code) |
-| PoolImplementation               | [0xc28aD28853A547556780BEBF7847628501A3bCbb](https://optimistic.etherscan.io/address/0xc28aD28853A547556780BEBF7847628501A3bCbb#code) |
-| QuoterV2               | [0x89D8218ed5fF1e46d8dcd33fb0bbeE3be1621466](https://optimistic.etherscan.io/address/0x89D8218ed5fF1e46d8dcd33fb0bbeE3be1621466#code) |
-| CustomSwapFeeModule               | [0x7361E9079920fb75496E9764A2665d8ee5049D5f](https://optimistic.etherscan.io/address/0x7361E9079920fb75496E9764A2665d8ee5049D5f#code) |
-| CustomUnstakedFeeModule               | [0xC565F7ba9c56b157Da983c4Db30e13F5f06C59D9](https://optimistic.etherscan.io/address/0xC565F7ba9c56b157Da983c4Db30e13F5f06C59D9#code) |
-| Swap Router               | [0x0792a633F0c19c351081CF4B211F68F79bCc9676](http://optimistic.etherscan.io/address/0x0792a633F0c19c351081CF4B211F68F79bCc9676#code) |
-| LpMigrator                | [0x3Fdb481B25b24824A2339a4A1AbD0B0BC7534e71](http://optimistic.etherscan.io/address/0x3Fdb481B25b24824A2339a4A1AbD0B0BC7534e71#code) |
+| Chain      | Addresses          | Deployment Commit |
+|------------|--------------------|-------------------|
+| Optimism   | [Addresses](https://github.com/velodrome-finance/superchain-slipstream/blob/main/deployment-addresses/root-optimism.json)           | [v1.0](https://github.com/velodrome-finance/superchain-slipstream/commit/63b2e08a11f42d91dc6f8487643ecb3d79e745c4)      |
+| Mode       | [Addresses](https://github.com/velodrome-finance/superchain-slipstream/blob/main/deployment-addresses/mode.json)           | [v1.0](https://github.com/velodrome-finance/superchain-slipstream/commit/63b2e08a11f42d91dc6f8487643ecb3d79e745c4)      |
+| Lisk       | [Addresses](https://github.com/velodrome-finance/superchain-slipstream/blob/main/deployment-addresses/lisk.json)           | [v1.0](https://github.com/velodrome-finance/superchain-slipstream/commit/63b2e08a11f42d91dc6f8487643ecb3d79e745c4)      |
+| Fraxtal    | [Addresses](https://github.com/velodrome-finance/superchain-slipstream/blob/main/deployment-addresses/fraxtal.json)           | [v1.0](https://github.com/velodrome-finance/superchain-slipstream/commit/63b2e08a11f42d91dc6f8487643ecb3d79e745c4)      | 
+
+See the main [Superchain repository](https://github.com/velodrome-finance/superchain-contracts) for the core root contracts.
diff --git a/script/README.md b/script/README.md
@@ -1,30 +1,25 @@
-## Deploy CL
+## Deploy 
 
-Deployment is straightforward. Hardhat scripts for deployment on tenderly are provided in script/hardhat.
-This deployment assumes an existing Velodrome deployment exists.
-
-### Environment Setup
-1. Copy `.env.example` into a new `.env` file and set the environment variables. `PRIVATE_KEY_DEPLOY` is the private key to deploy all scripts.
-2. Copy `script/constants/TEMPLATE.json` into a new file `script/constants/{CONSTANTS_FILENAME}`. For example, "Optimism.json" in the .env would be a file at location `script/constants/Optimism.json`. Set the variables in the new file.
-3. Run tests to ensure deployment state is configured correctly:
-```
-forge init
-forge build
-forge test
-```
+Fill out the parameters as required in `foundry.toml`.
 
 ### Deployment
 
 Deploy Root Contracts
 
 ```
 forge script script/deployParameters/optimism/DeployRootCL.s.sol:DeployRootCL --slow --rpc-url optimism -vvvv 
-forge script script/deployParameters/optimism/DeployRootCL.s.sol:DeployRootCL --broadcast --slow --rpc-url optimism --broadcast --verify -vvvv 
+forge script script/deployParameters/optimism/DeployRootCL.s.sol:DeployRootCL --broadcast --slow --rpc-url optimism --verify -vvvv 
 ```
 
 Deploy Leaf Contracts
 
+Replace `leaf` with the chain you are deploying to.
+
 ```
-forge script script/deployParameters/mode/DeployLeafCL.s.sol:DeployLeafCL --slow --rpc-url mode -vvvv 
-forge script script/deployParameters/mode/DeployLeafCL.s.sol:DeployLeafCL --broadcast --slow --rpc-url mode --broadcast --verify --verifier blockscout --verifier-url https://explorer.mode.network/api\? -vvvv 
-```
+forge script script/deployParameters/leaf/DeployLeafCL.s.sol:DeployLeafCL --slow --rpc-url leaf -vvvv 
+forge script script/deployParameters/leaf/DeployLeafCL.s.sol:DeployLeafCL --broadcast --slow --rpc-url leaf --verify -vvvv 
+```
+
+If there is a verification failure, simply remove `--broadcast` and add `--resume`.
+
+For blockscout verifications, append `--verifier blockscout` after `--verify`