From 436d6bd964a91db0285d0580b4ded7641c8615c1 Mon Sep 17 00:00:00 2001 From: Matt Date: Wed, 28 Aug 2024 18:13:29 -0700 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6a03b7d9..b25dac16 100644 --- a/README.md +++ b/README.md @@ -201,14 +201,11 @@ Next, consider further extending the functionality of the custom pool contract w ## 🚢 Deploy the Contracts -The deploy scripts are located in the [foundry/script/](https://github.com/balancer/scaffold-balancer-v3/tree/main/packages/foundry/script) directory. All deploy scripts should be run inside of `Deploy.s.sol` so that the `export` modifier can automate the transfer of deployed contract info to `nextjs/contracts/depoloyedContracts.ts`. To add a new deploy script, import it into `Deploy.s.sol`, create a new instance of it, and run it +The deploy scripts are located in the [foundry/script/](https://github.com/balancer/scaffold-balancer-v3/tree/main/packages/foundry/script) directory. + -``` - DeployYourContract deployYourContract = new DeployYourContract(); - deployYourContract.run(); -``` -### 1. Examine the Example Deploy Scripts 🕵️ +### 1. Examine the Deploy Scripts 🕵️ #### [00_DeployMockTokens.s.sol](https://github.com/balancer/scaffold-balancer-v3/blob/main/packages/foundry/script/00_DeployMockTokens.s.sol) @@ -235,7 +232,16 @@ The deploy scripts are located in the [foundry/script/](https://github.com/balan 3. Deploys and registers a `WeightedPool` with 80/20 weights 4. Initializes the `WeightedPool` using mock tokens -### 2. Broadcast the Transactions 📡 +### 2. Modify the Deploy Scripts 🛠️ + +Each deploy scripts should be run inside of `Deploy.s.sol` so that the `scaffoldExport` modifier can automate the transfer of deployed contract info to the nextjs front-end. To add a new deploy script, import it into `Deploy.s.sol`, create a new instance of it, and run it + +``` + DeployYourContract deployYourContract = new DeployYourContract(); + deployYourContract.run(); +``` + +### 3. Broadcast the Transactions 📡 To run all the deploy scripts