diff --git a/example/README.md b/DEPLOYMENT.md similarity index 89% rename from example/README.md rename to DEPLOYMENT.md index 01d24115..87e9699a 100644 --- a/example/README.md +++ b/DEPLOYMENT.md @@ -57,15 +57,23 @@ deploy: hooks: default: - type: mock - - required: type: aggregate - # if you keep it as "", the script will identify this as deployer address owner: hooks: - type: merkle + - type: igp + owner: + configs: + 11155111: + exchange_rate: 3000 + gas_price: 5000 + default_gas_usage: 30000 + + required: + type: aggregate + owner: + hooks: - type: pausable owner: paused: false @@ -73,17 +81,7 @@ deploy: - type: fee owner: fee: - # if you didn't set the denom, it will be set as gas denom of network config - denom: uosmo amount: 1 - - - type: igp - owner: - configs: - 11155111: - exchange_rate: 3000 - gas_price: 5000 - default_gas_usage: 30000 ``` ## 2. Upload Contract Codes @@ -135,35 +133,38 @@ Replace every `{sepolia_private_key}` and `{osmosis_private_key}` from files bel - Sepolia Testnet (`{sepolia_private_key}`) -* [./hyperlane/relayer.json](./hyperlane/relayer.json) -* [./hyperlane/validator.sepolia.json](./hyperlane/validator.sepolia.json) + - [./example/hyperlane/relayer.json](./example/hyperlane/relayer.json) + - [./example/hyperlane/validator.sepolia.json](./example/hyperlane/validator.sepolia.json) - Osmosis Testnet (`{osmosis_private_key}`) -* [./hyperlane/relayer.json](./hyperlane/relayer.json) -* [./hyperlane/validator.osmotest5.json](./hyperlane/validator.osmotest5.json) + - [./example/hyperlane/relayer.json](./example/hyperlane/relayer.json) + - [./example/hyperlane/validator.osmotest5.json](./example/hyperlane/validator.osmotest5.json) And run with below command. ```bash # Merge osmo-test-5.config.json and agent-config.docker.json -$ OSMOSIS_TESTNET_AGENT_CONFIG=$(cat ../context/osmo-test-5.config.json) && \ +OSMOSIS_TESTNET_AGENT_CONFIG=$(cat ./context/osmo-test-5.config.json) && \ OSMOSIS_TESTNET_AGENT_CONFIG_NAME=$(echo $OSMOSIS_TESTNET_AGENT_CONFIG | jq -r '.name') && \ - cat ./hyperlane/agent-config.docker.json \ + cat ./example/hyperlane/agent-config.docker.json \ | jq ".chains.$OSMOSIS_TESTNET_AGENT_CONFIG_NAME=$(echo $OSMOSIS_TESTNET_AGENT_CONFIG)" > merge.tmp && \ - mv merge.tmp ./hyperlane/agent-config.docker.json + mv merge.tmp ./example/hyperlane/agent-config.docker.json + +# Change workdir to example +cd example # Run Hyperlane with docker-compose -$ docker compose up +docker compose up # Run this if you want to run in background -$ docker compose up -d +docker compose up -d # Run this if you want to see logs -$ docker compose logs -f +docker compose logs -f # Run this if you want to stop -$ docker compose down +docker compose down ``` ## 5. Deploy Test contracts on Sepolia diff --git a/README.md b/README.md index 01ff1552..9db08d65 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ - [Prerequisites](#prerequisites) - [How to build](#how-to-build) - [How to test](#how-to-test) +- [How to deploy](#how-to-deploy) ## Architecture @@ -37,11 +38,7 @@ cargo test --workspace --exclude hpl-tests cargo llvm-cov --workspace --exclude hpl-tests ``` -## How to deploy - -[Go to README of ./example](./example/README.md) - -[Go to README of ./script](./script/README.md) +## [How to deploy](./DEPLOYMENT.md) ## Project Structure