Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axonweb3/axon-cli
A command line interface to manage Axon chain config, deploy and DevOps.
https://github.com/axonweb3/axon-cli
axon blockchain ckb cli crosschain devops web3
Last synced: about 2 months ago
JSON representation
A command line interface to manage Axon chain config, deploy and DevOps.
- Host: GitHub
- URL: https://github.com/axonweb3/axon-cli
- Owner: axonweb3
- License: mit
- Created: 2022-08-26T07:02:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-30T01:55:08.000Z (almost 2 years ago)
- Last Synced: 2023-03-05T17:45:27.829Z (almost 2 years ago)
- Topics: axon, blockchain, ckb, cli, crosschain, devops, web3
- Language: Rust
- Homepage:
- Size: 1.43 MB
- Stars: 3
- Watchers: 6
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Axon CLI
You need to take the following steps to run axon and benchmark with axon-cli.
## 1. Build axon-cli
Under the axon-cli directory, run the following command:
`cargo build --release` Or `cargo build`
## 2. Run axon-cli
For example,
`./target/debug/axon-cli` in case you run the command `cargo build`.
## 3. Interactive Commands
Before the execution of axon commands, you have to enable tcp port for docker(0.0.0.0:2375 in this case).
Moreover, to execute the following commands successfully, you need to copy the dir `axon-cli/devtools` in this repository into dir `$HOME/.axon/` in your local machine. If `$HOME/.axon` does not exist, please create it mannully.
If you start axon without copying the config files to `$HOME/.axon`, this command will create `$HOME/.axon` for you. But, the axon process in the docker won't work. In fact, the axon process will panic due to lack of config files. You can run `docker logs axon1` to have a look, the output will be similar to the following:
>thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: IO(Os { code: 2, kind: NotFound, message: "No such file or directory" })', core/cli/src/lib.rs:43:65
After axon-cli gets run. You have 5 commands to execute.
- start
You can start 1 or 4 docker axon nodes. The default is 1, you can start 4 by `axon start --number=4`.
Also, you can specify the axon dir by adding things like `-d=/root/.axon`.
- stop
stop the 4 docker nodes just started.
- rm
remove the 4 docker containers just created.
- del
delete chain data under the path specified by parameter --data-dir. If not specified, it will be the dir specified by `axon start -d` plus `devtools/chain`.
- bm
start benchmark, transactions will be sent to the axon nodes.
Please clone repository `https://github.com/axonweb3/axon-devops` beforehand, because benchmark related files are maintained here. After the download, please refer to the readme of benchmark to modify config.jason. Here is the current one:
```conf
{
"http_endpoint": "http://127.0.0.1:8000",
"chain_id": 2022,
"mnemonic": "test test test test test test test test test test test junk",
"mnemonic_index": 0,
"continuous_benchmark": false,
"benchmark_time": 60000,
"batch_size": 100,
"thread_num": 10,
"id": "936501604767629344",
"token": "Fha8Hn6C31VEu3wL5XejIVGocTXiQbJ6HabAC5sLtHHwvqQ63iXj1FmOkH_FVN4mTZwQ",
"benchmark_cases": ["./benchmark", "./contract_benchmark"]
}
```
This config is not working now, please wait for update. Error messages like the following will be printted:
> BigNumber.toString does not accept any parameters; base-10 is assumed.
You must specify benchmark dir by --data-dir like `axon bm --data-dir=/home/wenyuan/git/axon-devops/benchmark/benchmark`. Please replace `/home/wenyuan/git/axon-devops/benchmark/benchmark` with your local benchamark dir.
## 4. Check axon status
To be sure of the correctness. You can check by the following commands:
### 1．check the liveness of axon nodes
>root@yoga:# docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
d82bf78d05cc axon:v1 "./axon -c=/app/devt…" 41 seconds ago Up 38 seconds axon1
3cdd6cab7077 axon:v1 "./axon -c=/app/devt…" 41 seconds ago Up 38 seconds axon3
303bd01e6bd6 axon:v1 "./axon -c=/app/devt…" 41 seconds ago Up 37 seconds axon2
e54ad14dbb24 axon:v1 "./axon -c=/app/devt…" 41 seconds ago Up 37 seconds axon4
### 2．check the axon logs
>root@yoga:~# docker logs axon4 | grep height
[2022-04-12T00:58:52.340656848+00:00 INFO core_network::outbound::gossip] no trace id found for gossip /gossip/consensus/broadcast_height
[2022-04-12T00:58:52.341000035+00:00 INFO overlord::state::process] overlord: start from wal wal info height 472, round 1, step Propose
[2022-04-12T00:58:52.341056842+00:00 INFO overlord::state::process] Overlord: "027ffd6a6a231561f2afe5878b1c743323b34263d16787130b1815fe35649b0bf5" become leader, height 472, round 1
[2022-04-12T00:58:54.342405157+00:00 INFO core_network::outbound::gossip] no trace id found for gossip /gossip/consensus/broadcast_height
It's easy to find the chain height has grown to height 472, and if you check it later, you can find the height is larger than the current 472.
### 3．check the network connect between the nodes.
```
docker exec -it axon1 /bin/bash
apt install net-tools
apt install iputils-ping
```
`ping axon2` without timeout like following:
>root@6f816d8be4b7:/app# ping axon2
PING axon2 (172.18.0.2) 56(84) bytes of data.
64 bytes from axon2.axon-cli_axon-net (172.18.0.2): icmp_seq=1 ttl=64 time=0.298 ms
64 bytes from axon2.axon-cli_axon-net (172.18.0.2): icmp_seq=2 ttl=64 time=0.074 ms
or
>netstat -tnp | grep axon show 3 other nodes like following:
root@6f816d8be4b7:/app# netstat -tnp | grep axon
tcp 0 0 172.18.0.3:8001 172.18.0.2:8001 ESTABLISHED 1/./axon
tcp 0 0 172.18.0.3:8001 172.18.0.5:8001 ESTABLISHED 1/./axon
tcp 0 0 172.18.0.3:8001 172.18.0.4:8001 ESTABLISHED 1/./axon
## 5. Start Benchmark
`bm` is short for benchmark, this command will start benchmark. You can run `docker logs bm` to have a look at the benchmark status.
For example:
>root@yoga:~# docker logs bm
/////////////////////////////////////////////////////
benchmark time: 60000 ms
endpoint: http://172.17.0.1:8000
/////////////////////////////////////////////////////
>
>waiting...
preparing...
>
>deploying contract: ERC20
contract ERC20 deployed to 0xF67Bc4E50d1df92b0E4C61794A4517AF6a995CB2
>
>prepared
benchmark case 0: ./benchmark
>
>/////////////////////////////////////////////////////
benchmark time: 64650.558417998254 ms
transaction count: 7200
TPS: 111.3679475658724 ms
transfer rate: 98.83
/////////////////////////////////////////////////////
You can check the result by the end of the output.
## 6. start apm
We offer `apm start` and `apm stop` commands to start and stop apm features respectively.
However, before you start, you need to get some configs prepared.
- In `apm/deploy/hosts`, change ip of axon_node to your own ip. In my case, it is `172.19.86.210`.
- In `apm/deploy/roles/monitor/vars/main.yaml`, change `monitor_dir` to your dir.
All monitor related files willed be moved here, the data will be stored under `monitor_dir/data`. Please use absolute path, pathes like `~/.axon` are illegal.
- In `apm/deploy/roles/agent/vars/main.yaml`.
First, set `monitor_agent_dir` to your dir. All agent related files willed be moved here, the data will be stored under `monitor_agent_dir/data`.
Second, set `log_path`.
At present, there is no need to modify `monitor_address` and `es_address`.
- The correct execution of `apm start` now depends on the apm path. You need commands like this:
`apm start -p=/home/wenyuan/git/axon-cli/apm` or
`apm stop`
Please replace `/home/wenyuan/git/axon-cli/apm` with your own apm dir.
If `apm start` returns the following message of `filebeat`, don't mind, this won't affect the following actions.
>Start err error 400 Bad Request - failed to create shim: OCI runtime create failed: container_linux.go:380: starting container process caused: process_linux.go:545: container init caused: rootfs_linux.go:75: mounting "/root/.axon/agent/config/filebeat/filebeat.yml" to rootfs at "/usr/share/filebeat/filebeat.yml" caused: mount through procfd: not a directory: unknown: Are you trying to mount a directory onto a file (or vice-versa)? Check if the specified host path exists and is the expected type
- To clean data, you need command `clean` like this:
`apm clean -p=/home/wenyuan/git/axon-cli/apm`.
Remeber, `apm start` may take a long time to complete due to heavy underground jobs, please be patient.
After the right config and the successful start of apm, you can visit Grafana by `localhost:8600` in your browser. The default user name and password of grafana is `admin` and `admin`.
You can take a look at the `axon-node` Dashboard. The default time range may be 7 days, you need to change it to `Last 1 hour` or similar time ranges to observe the data clearly.
If you just run the benchmark, you can have a look at the `axon-benchmark` Dashboard.
# 7. CKB -> AXON tx
## 1. deploy crosschain metadata
`cs --sender-key=dd50cac37ec6dd12539a968c1a2cbedda75bd8724f7bcad486548eaabb87fc8b --capacity=1000 --tx-type=0`
## 2. transfer token from CKB to AXON
`cs --sender-key=dd50cac37ec6dd12539a968c1a2cbedda75bd8724f7bcad486548eaabb87fc8b --capacity=1000 --tx-type=1`