From 4576a54c43f954dafa9800ad600e8a27c346eaa6 Mon Sep 17 00:00:00 2001 From: Shawn <44221603+shaspitz@users.noreply.github.com> Date: Fri, 5 Jan 2024 23:42:54 -0800 Subject: [PATCH] docs adjustment --- geth-poa/Makefile | 20 ++++++-------------- geth-poa/README.md | 34 ++++++++++++---------------------- 2 files changed, 18 insertions(+), 36 deletions(-) diff --git a/geth-poa/Makefile b/geth-poa/Makefile index 281eba33e8..ecacb64368 100644 --- a/geth-poa/Makefile +++ b/geth-poa/Makefile @@ -3,31 +3,23 @@ up-prod-settlement: @if [ ! -f .env ]; then echo "Error: .env file not found. Please populate the .env file before running this command."; exit 1; fi - AGENT_BASE_IMAGE=nil SETTLEMENT_RPC_URL=nil docker compose --profile settlement up -d --build + docker compose --profile settlement up -d --build up-dev-settlement: @if [ ! -f .env ]; then echo "Error: .env file not found. Please populate the .env file before running this command."; exit 1; fi - AGENT_BASE_IMAGE=nil SETTLEMENT_RPC_URL=nil docker compose --profile settlement up -d --build - -up-dev-bridge: - @if [ ! -f .env ]; then echo "Error: .env file not found. Please populate the .env file before running this command."; exit 1; fi - AGENT_BASE_IMAGE=shaspitz/hyperlane-agent-mac:6985064 SETTLEMENT_RPC_URL=http://172.29.0.98:8545 docker compose --profile bridge up -d --build - -up-prod-bridge: - @if [ ! -f .env ]; then echo "Error: .env file not found. Please populate the .env file before running this command."; exit 1; fi - AGENT_BASE_IMAGE=gcr.io/abacus-labs-dev/hyperlane-agent@sha256:854f92966eac6b49e5132e152cc58168ecdddc76c2d390e657b81bdaf1396af0 SETTLEMENT_RPC_URL=http://172.29.0.98:8545 docker compose --profile bridge up -d --build + docker compose --profile settlement up -d --build up-dev-local-l1: @if [ ! -f .env ]; then echo "Error: .env file not found. Please populate the .env file before running this command."; exit 1; fi - AGENT_BASE_IMAGE=nil SETTLEMENT_RPC_URL=nil docker compose --profile settlement --profile local_l1 up -d + docker compose --profile settlement --profile local_l1 up -d down: - AGENT_BASE_IMAGE=nil SETTLEMENT_RPC_URL=nil docker compose --profile settlement --profile bridge --profile prod_agents --profile local_l1 down + docker compose --profile settlement --profile prod_agents --profile local_l1 down clean-dbs: @read -p "WARNING: This command will wipe all persistent disk data relevant to the containers. Press enter to continue or Ctrl+C to cancel." _ - -docker compose --profile settlement --profile bridge --profile local_l1 down --rmi all --volumes - -docker compose --profile settlement --profile bridge --profile local_l1 rm -fv + -docker compose --profile settlement --profile local_l1 down --rmi all --volumes + -docker compose --profile settlement --profile local_l1 rm -fv docker image prune -f pull-image: diff --git a/geth-poa/README.md b/geth-poa/README.md index ddbc0a92ec..1199636bd6 100644 --- a/geth-poa/README.md +++ b/geth-poa/README.md @@ -1,6 +1,6 @@ # geth-poa -Tool for spinning up a POA ethereum sidechain bridged to sepolia via [hyperlane](https://www.hyperlane.xyz/) token warp route. +Tool for spinning up a POA ethereum sidechain. ## Metrics @@ -10,22 +10,7 @@ Metrics recorded by bootnode are exposed to host at http://127.0.0.1:6060/debug/ All relevant accounts are funded on sidechain genesis, you may need to fund these accounts on L1 with faucets. See [hyperlane docs](https://docs.hyperlane.xyz/docs/deploy/deploy-hyperlane#1.-setup-keys). -## Hyperlane Contract deployer - -Address: `0xBcA333b67fb805aB18B4Eb7aa5a0B09aB25E5ce2` - -Note if the relayer is emitting errors related to unexpected contract routing, try redeploying the hyperlane contracts using a new key pair. It's likely the current deployments are clashing with previous deployments on Sepolia. - -To properly set a new hyperlane deployer: -* Generate a new key pair (ex: `cast wallet new`) -* Send or [mine](https://sepolia-faucet.pk910.de/) some Sepolia ETH to `Address` -* replace `Address` above for book keeping -* replace `CONTRACT_DEPLOYER_PRIVATE_KEY` in `.env` -* allocate funds to `Address` in the allocs field of `genesis.json` - -Note the deployer of [primev contracts](https://github.com/primevprotocol/contracts) can be a separate account. - -## Validator Accounts (also POA signers) +## POA signers ### Node1 @@ -35,10 +20,6 @@ Address: `0xd9cd8E5DE6d55f796D980B818D350C0746C25b97` Address: `0x788EBABe5c3dD422Ef92Ca6714A69e2eabcE1Ee4` -## Relayer - -Address: `0x0DCaa27B9E4Db92F820189345792f8eC5Ef148F6` - ## Create2 Deployment Proxy A Create2 deployment proxy is can be deployed to this chain at `0x4e59b44847b379578588920ca78fbf26c0b4956c`. see more [here](https://github.com/primevprotocol/deterministic-deployment-proxy). Note this proxy is required to deploy the whitelist bridge contract, and is consistent to foundry's suggested process for create2 deployment. The deployment signer, `0x3fab184622dc19b6109349b94811493bf2a45362` is funded on genesis. @@ -49,4 +30,13 @@ A Create2 deployment proxy is can be deployed to this chain at `0x4e59b44847b379 2. Run `$ make up-dev-build` to run the whole stack including bridge, or `$ make up-dev-settlement` to bring up only the settlement layer. ## Starter .env file -To get a standard starter .env file from primev internal development, [click here.](https://www.notion.so/Private-keys-and-env-for-settlement-layer-245a4f3f4fe040a7b72a6be91131d9c2?pvs=4) + +The chain must be started with two private keys for POA signers. + +.env file should look like: +``` +NODE1_PRIVATE_KEY=0xpk1 +NODE2_PRIVATE_KEY=0xpk2 +``` + +To get a standard starter .env file from primev internal development, [click here.](https://www.notion.so/Private-keys-and-env-for-settlement-layer-245a4f3f4fe040a7b72a6be91131d9c2?pvs=4), populate only the `NODE1_PRIVATE_KEY` and `NODE2_PRIVATE_KEY` fields.