Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The scripts are located in `/script` folder, deployed contract address can be fo
// set script config: /script/config/{SCRIPT_CONFIG}.json
export SCRIPT_CONFIG=ethereum-sepolia

// set rpc url
// set rpc url
export RPC_URL=https://

// private key need to be prefixed with 0x
Expand All @@ -33,14 +33,16 @@ export ETHERSCAN_API_KEY=xx

### Execute

Refer to the script source code for the exact command
Refer to the script source code for the exact command

Example. within `script/01_DeployVault.s.sol`
```
// remove --verify flag if etherscan_api_key is set
// remove --verify flag if etherscan_api_key is not set
forge script script/01_DeployVault.s.sol:DeployVaultScript -vvv \
--rpc-url $RPC_URL \
--broadcast \
--slow \
--verify
```

Note you will need to update the `script/config/xxx.json` file to set the vault address that was created in order to deploy the PoolManagers.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for raisng PR. Would you mind removing this line?

Thinking of placing this line within the deployment script as each script would have different pre-requisite note. thanks

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

تع