-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Adds docs dir for deployment and management
- Loading branch information
1 parent
512ddf0
commit 4501bf6
Showing
4 changed files
with
71 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Wallet Management | ||
export PRIVATE_KEY= | ||
|
||
# RPC URL | ||
export RPC_URL= | ||
|
||
# Etherscan Verification | ||
export ETHERSCAN_API_KEY= | ||
|
||
# Deployment Configuration | ||
export INITIAL_AUTHED= | ||
|
||
# Management Configurations | ||
export GREENHOUSE= | ||
export WHO= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Deployment | ||
|
||
This document describes how to deploy a new `Greenhouse` instance. | ||
|
||
## Environment Variables | ||
|
||
The following environment variables must be set: | ||
|
||
- `RPC_URL`: The RPC URL of an EVM node | ||
- `PRIVATE_KEY`: The private key to use | ||
- `ETHERSCAN_API_KEY`: The Etherscan API key for the Etherscan's chain instance | ||
- `INITIAL_AUTHED`: The address being auth'ed on the newly deployed `Scribe` instance | ||
|
||
Note that an `.env.example` file is provided in the project root. To set all environment variables at once, create a copy of the file and rename the copy to `.env`, adjust the variable's values', and run `source .env`. | ||
|
||
## Execution | ||
|
||
Run: | ||
|
||
```bash | ||
$ forge script \ | ||
--private-key $PRIVATE_KEY \ | ||
--broadcast \ | ||
--rpc-url $RPC_URL \ | ||
--etherscan-api-key $ETHERSCAN_API_KEY \ | ||
--verify \ | ||
--sig $(cast calldata "deploy(address)" $INITIAL_AUTHED) \ | ||
-vvv \ | ||
script/Greenhouse.s.sol:GreenhouseScript | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.