From c4e79198343b2d228479c6b6966d9ab46b251e4f Mon Sep 17 00:00:00 2001 From: Arnaud Mimart <33665250+amimart@users.noreply.github.com> Date: Fri, 2 Aug 2024 13:54:19 +0200 Subject: [PATCH 1/2] docs: remove operation doc from readme --- README.md | 54 ++++++++++-------------------------------------------- 1 file changed, 10 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 9d0f1195..aab2f6f0 100644 --- a/README.md +++ b/README.md @@ -59,58 +59,24 @@ All releases can be found [here](https://github.com/axone-protocol/axoned/releas `axoned` follows the [Semantic Versioning 2.0.0](https://semver.org/) to determine when and how the version changes, and we also apply the philosophical principles of [release early - release often](https://en.wikipedia.org/wiki/Release_early,_release_often). -## Docker image +## Install -For a quick start, a docker image is officially available on [Docker hub](https://hub.docker.com/r/axone-protocol/axoned). +### From release -```bash -docker pull axone-protocol/axoned:latest -``` - -### Get the documentation - -```bash -docker run axone-protocol/axoned:latest --help -``` - -### Query a running network - -Example: - -```bash -API_URL=https://api.devnet.okp4.network:443/rpc -WALLET=okp41pmkq300lrngpkeprygfrtag0xpgp9z92c7eskm - -docker run axone-protocol/axoned:latest query bank balances $WALLET --chain-id axone-devnet-1 --node $API_URL - ``` - -### Create a wallet - -```bash -docker run -v $(pwd)/home:/home axone-protocol/axoned:latest keys add my-wallet --keyring-backend test --home /home +```sh +curl https://i.jpillora.com/axone-protocol/axoned! | bash ``` -### Start a node - -Everything you need to start a node and more is explained here: +### From source -```bash -MONIKER=node-in-my-name -CHAIN_ID=localnet-axone-1 - -docker run -v $(pwd)/home:/home axone-protocol/axoned:latest init $MONIKER --chain-id $CHAIN_ID --home /home +```sh +make install ``` -This will create a home folder, you can then update the `config/genesis.json` with one of this ones : +### Using docker -#### Join a running network - -Set `persistent_peers` in `config/config.toml` file. - -#### Then start the node - -```bash -docker run -v $(pwd)/home:/home axone-protocol/axoned:latest start --home /home +```sh +docker run -ti --rm axoneprotocol/axoned --help ``` ## Developing & contributing From caaca2671c7f8001129ff9404b7a1260bf3c3c13 Mon Sep 17 00:00:00 2001 From: Arnaud Mimart <33665250+amimart@users.noreply.github.com> Date: Fri, 2 Aug 2024 14:25:06 +0200 Subject: [PATCH 2/2] docs: enhance contributors documentation in readme --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index aab2f6f0..99efbc8b 100644 --- a/README.md +++ b/README.md @@ -155,6 +155,28 @@ make build The binary will be generated under the folder `target/dist`. +### Run a local network + +To initialize a local network configuration, invoke the goal `chain-init` of the `Makefile`: + +```sh +make chain-init +``` + +The node home directory will be generated under the folder `target/deployment/localnet`. The configuration contains a single validator node. + +To start the network, invoke the goal `chain-start` of the `Makefile`: + +```sh +make chain-start +``` + +A wallet is preconfigured with some tokens, you can use it as follows: + +```sh +axoned --home target/deployment/localnet tx bank send validator [to_address] [amount] +``` + ## Bug reports & feature requests If you notice anything not behaving how you expected, if you would like to make a suggestion or would like