Skip to content

Commit

Permalink
chore(contracts): update .env files and README for deployment
Browse files Browse the repository at this point in the history
Updated the .env.localhost and .env.example with new keys and URLs. Enhanced the README to clarify deployment commands. Added the `EntitlementsManager` facet address to deployments.
  • Loading branch information
shuhuiluo committed Sep 9, 2024
1 parent 8bbec46 commit 8924f8a
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 15 deletions.
19 changes: 14 additions & 5 deletions contracts/.env.example
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
# RPC_URL is the URL of the Ethereum node to use for deployment
BASE_ANVIL_RPC_URL="http://127.0.0.1:8545"
BASE_SEPOLIA_RPC_URL=
BASE_ANVIL_RPC_URL="${BASE_ANVIL_RPC_URL:-http://127.0.0.1:8545}"
RIVER_ANVIL_RPC_URL="${RIVER_ANVIL_RPC_URL:-http://127.0.0.1:8546}"

# PRIVATE_KEY is the private key of the account to use for deployment
LOCAL_PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
PRODUCTION_ADDRESS=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
SENDER_ADDRESS=
HD_PATH="m/44\'/60\'/0\'/0/0"

# ETHERSCAN_API_KEY is the API key for Etherscan
# API Keys to use when verifying contracts on etherscan
ETHERSCAN_API_KEY=
BASESCAN_URL=
BASESCAN_API_KEY=

BLOCKSCOUT_SEPOLIA_URL=
BASESCAN_SEPOLIA_API_KEY=
BLOCKSCOUT_BASE_API_KEY=
BLOCKSCOUT_SEPOLIA_API_KEY=
RIVERSCAN_API_KEY=

# URLs foundry will use to verify contracts
BASESCAN_URL="https://api.basescan.org/api"
BASESCAN_SEPOLIA_URL="https://api-sepolia.basescan.org/api/v2"
BLOCKSCOUT_BASE_URL="https://base.blockscout.com/api"
BLOCKSCOUT_SEPOLIA_URL="https://base-sepolia.blockscout.com/api/v2"
RIVERSCAN_URL=
RIVERSCAN_API_KEY=
RIVERSCAN_DEVNET_URL=
13 changes: 6 additions & 7 deletions contracts/.env.localhost
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,21 @@ RIVER_ANVIL_RPC_URL="${RIVER_ANVIL_RPC_URL:-http://127.0.0.1:8546}"
LOCAL_PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
TESTNET_PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
SENDER_ADDRESS=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
HD_PATH=
HD_PATH="m/44\'/60\'/0\'/0/0"

# ETHERSCAN_API_KEY is the API key for Etherscan
# API Keys to use when verifying contracts on etherscan
ETHERSCAN_API_KEY=
BASESCAN_API_KEY=
BASESCAN_SEPOLIA_API_KEY=
BLOCKSCOUT_SEPOLIA_API_KEY=
BLOCKSCOUT_BASE_API_KEY=
BASESCAN_API_KEY=
BLOCKSCOUT_SEPOLIA_API_KEY=
RIVERSCAN_API_KEY=

# URLs foundry will use to verify contracts
BASESCAN_URL=
BASESCAN_SEPOLIA_URL=
BLOCKSCOUT_SEPOLIA_URL=
BLOCKSCOUT_BASE_URL=
BASESCAN_URL=
RIVERSCAN_DEVNET_URL=
BLOCKSCOUT_SEPOLIA_URL=
RIVERSCAN_URL=
ETHERSCAN_SEPOLIA_URL=
RIVERSCAN_DEVNET_URL=
11 changes: 8 additions & 3 deletions contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,16 @@ with `ChainID=1337`
and river-anvil chains.

<b>To deploy a single diamond base contract to your local anvil instance</b>\
from within the `contracts/` folder you can run `make deploy-base-anvil contract=Deploy[Contract]` you will replace
from within the `contracts/` folder you can run `make deploy-base-anvil contract=Deploy[Contract] type=diamonds` you will replace
the `[Contract]` part with the contract you want to deploy, you can see all the contracts available for deployment
in [this](./scripts/deployments) part of the project.
in [this](./scripts/deployments/diamonds) part of the project.

<b>To deploy a facet base contract to your local anvil instance</b>\
from within the `contracts/` folder you can run `make deploy-base-anvil contract=Deploy[Facet] type=facet` you will
from within the `contracts/` folder you can run `make deploy-base-anvil contract=Deploy[Facet] type=facets` you will
replace the `[Facet]` part with the contract you want to deploy, you can see all the facets available for deployment
in [this](./scripts/deployments/facets) part of the project.

<b>To deploy our contracts to a live network</b>\
from within the `contracts/` folder you can run `make deploy-base-sepolia contract=Deploy[Facet] type=facets context=[context]` you will
replace the `[Facet]` part with the contract you want to deploy, you can see all the facets available for deployment
in [this](./scripts/deployments/facets) part of the project.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"address": "0x629EF193c7d626EC7C6AEf4c650c8fe268b1d21f"
}

0 comments on commit 8924f8a

Please sign in to comment.