Skip to content

Commit 05da76d

Browse files
committed
rename warcli cmd to warnet
1 parent 20da5b4 commit 05da76d

20 files changed

+110
-110
lines changed

docs/connecting-local-nodes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
### Run Warnet network
88

99
```shell
10-
warcli cluster deploy
11-
warcli network start
10+
warnet cluster deploy
11+
warnet network start
1212
```
1313

1414
### Install Telepresence
@@ -71,9 +71,9 @@ telepresence intercept local-bitcoind --port 18444 -- bitcoind --regtest --datad
7171
### Connect to local bitcoind from cluster
7272

7373
```shell
74-
warcli bitcoin rpc 0 addnode "local-bitcoind:18444" "onetry"
74+
warnet bitcoin rpc 0 addnode "local-bitcoind:18444" "onetry"
7575
# Check that the local node was added
76-
warcli bitcoin rpc 0 getpeerinfo
76+
warnet bitcoin rpc 0 getpeerinfo
7777
```
7878

7979
### Disconnect and remove Telepresence
@@ -85,4 +85,4 @@ telepresence quit -s
8585
telepresent helm uninstall
8686
# Remove Telepresence from your computer
8787
sudo rm /usr/local/bin/telepresence
88-
```
88+
```

docs/lightning.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,22 +42,22 @@ data directory: [ln.graphml](../test/data/ln.graphml)
4242

4343
## Running the Lightning network
4444

45-
When warnet is started with `warcli network start` the bitcoin containers will
45+
When warnet is started with `warnet network start` the bitcoin containers will
4646
be started first followed by the lightning node containers. It may require a few
4747
automatic restarts before the lightning nodes start up and connect to their
48-
corresponding bitcoin nodes. Use `warcli network status` to monitor container status
48+
corresponding bitcoin nodes. Use `warnet network status` to monitor container status
4949
and wait for all containers to be `running`.
5050

5151
To create the lightning channels specified in the graph file, run the included
5252
scenario:
5353

54-
`warcli scenarios run ln_init`
54+
`warnet scenarios run ln_init`
5555

5656
This [scenario](../src/scenarios/ln_init.py) will generate blocks, fund the wallets
5757
in the bitcoin nodes, and open the channels from the graph. Each of these steps
5858
requires some waiting as transactions are confirmed in the warnet blockchain
5959
and lightning nodes gossip their channel announcements to each other.
60-
Use `warcli scenarios active` to monitor the status of the scenario. When it is
60+
Use `warnet scenarios active` to monitor the status of the scenario. When it is
6161
complete the subprocess will exit and it will indicate `Active: False`. At that
6262
point, the lightning network is ready for activity.
6363

@@ -66,15 +66,15 @@ point, the lightning network is ready for activity.
6666
Warnet can export data required to run [sim-ln](https://github.com/bitcoin-dev-project/sim-ln)
6767
with a warnet network.
6868

69-
With a network running, execute: `warcli network export` with optional argument
69+
With a network running, execute: `warnet network export` with optional argument
7070
`--network=<network name>` (default is "warnet"). This will copy all lightning
7171
node credentials like SSL certificates and macaroons into a local directory as
7272
well as generate a JSON file required by sim-ln.
7373

7474
Example (see sim-ln docs for exact API):
7575

7676
```
77-
$ warcli network export
77+
$ warnet network export
7878
/Users/bitcoin-dev-project/.warnet/warnet/warnet/simln
7979
8080
$ ls /Users/bitcoin-dev-project/.warnet/warnet/warnet/simln

docs/logging_monitoring.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Examples of information provided:
1414
- what scenarios are running
1515
- warnet RPC requests
1616

17-
Commands: `warcli network logs` or `warcli network logs --follow`.
17+
Commands: `warnet network logs` or `warnet network logs --follow`.
1818

1919
See more details in [warcli](/docs/warcli.md#warcli-network-logs)
2020

@@ -25,7 +25,7 @@ These are tank level or pod level log output from a Bitcoin Core node, useful fo
2525
Example:
2626

2727
```sh
28-
$ warcli bitcoin debug-log 0
28+
$ warnet bitcoin debug-log 0
2929

3030

3131
2023-10-11T17:54:39.616974Z Bitcoin Core version v25.0.0 (release build)
@@ -38,12 +38,12 @@ For logs of lightning nodes, kubectl is required.
3838

3939
### Aggregated logs from all nodes
4040

41-
Aggregated logs can be searched using `warcli bitcoin grep-logs` with regex patterns.
41+
Aggregated logs can be searched using `warnet bitcoin grep-logs` with regex patterns.
4242

4343
Example:
4444

4545
```sh
46-
$ warcli bitcoin grep-logs 94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d
46+
$ warnet bitcoin grep-logs 94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d
4747

4848
warnet_test_uhynisdj_tank_000001: 2023-10-11T17:44:48.716582Z [miner] AddToWallet 94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d newupdate
4949
warnet_test_uhynisdj_tank_000001: 2023-10-11T17:44:48.717787Z [miner] Submitting wtx 94cacabc09b024b56dcbed9ccad15c90340c596e883159bcb5f1d2152997322d to mempool for relay
@@ -77,7 +77,7 @@ It might take a couple minutes to get the pod running. If you see `error: unable
7777
The Grafana dashboard (and API) will be accessible without requiring authentication
7878
at `http://localhost:3000`.
7979

80-
The `install_logging` script will need to be installed before starting the network in order to collect the information for monitoring and metrics. Restart the network with `warcli network down && warcli network up` if necessary.
80+
The `install_logging` script will need to be installed before starting the network in order to collect the information for monitoring and metrics. Restart the network with `warnet network down && warnet network up` if necessary.
8181

8282
### Prometheus
8383

docs/quickrun.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,36 +29,36 @@ pip install -e .
2929
## Running
3030

3131
> [!TIP]
32-
> When developing locally add the `--dev` flag to `warcli cluster deploy` to enable dev mode with hot-reloading server.
32+
> When developing locally add the `--dev` flag to `warnet cluster deploy` to enable dev mode with hot-reloading server.
3333
3434
### Using minikube
3535

3636
To run a local cluster using minikube:
3737

3838
```bash
39-
warcli cluster setup-minikube
39+
warnet cluster setup-minikube
4040

41-
warcli cluster deploy
41+
warnet cluster deploy
4242
```
4343

4444
### Other cluster types
4545

46-
If not using minikube (e.g. using Docker Desktop or a managed cluster), `warcli` commands will operate natively on the current Kubernetes context, so you can simply run:
46+
If not using minikube (e.g. using Docker Desktop or a managed cluster), `warnet` commands will operate natively on the current Kubernetes context, so you can simply run:
4747

4848
```bash
49-
warcli cluster deploy
49+
warnet cluster deploy
5050
```
5151

5252
...to deploy warnet to your cluster.
5353

54-
`warcli cluster deploy` also automatically configures port forwarding to the Server in the cluster.
54+
`warnet cluster deploy` also automatically configures port forwarding to the Server in the cluster.
5555

5656
## Stopping
5757

5858
To tear down the cluster:
5959

6060
```bash
61-
warcli cluster teardown
61+
warnet cluster teardown
6262
```
6363

6464
## Log location

docs/running.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,31 @@ See more details in [warcli](/docs/warcli.md), examples:
88
To start the server run:
99

1010
```bash
11-
warcli cluster deploy
11+
warnet cluster deploy
1212
```
1313

1414
Start a network from a graph file:
1515

1616
```bash
17-
warcli network start resources/graphs/default.graphml
17+
warnet network start resources/graphs/default.graphml
1818
```
1919

2020
Make sure all tanks are running with:
2121

2222
```bash
23-
warcli network status
23+
warnet network status
2424
```
2525

2626
Check if the edges of the graph (bitcoin p2p connections) are complete:
2727

2828
```bash
29-
warcli network connected
29+
warnet network connected
3030
```
3131

3232
_Optional_ Check out the logs with:
3333

3434
```bash
35-
warcli network logs -f
35+
warnet network logs -f
3636
```
3737

3838
If that looks all good, give [scenarios](/docs/scenarios.md) a try.

docs/scenarios.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,37 +10,37 @@ See [`src/warnet/scenarios`](../src/warnet/scenarios) for examples of how these
1010
To see available scenarios (loaded from the default directory):
1111

1212
```bash
13-
warcli scenarios available
13+
warnet scenarios available
1414
```
1515

16-
Once a scenario is selected it can be run with `warcli scenarios run [--network=warnet] <scenario_name> [scenario_params]`.
16+
Once a scenario is selected it can be run with `warnet scenarios run [--network=warnet] <scenario_name> [scenario_params]`.
1717

1818
The [`miner_std`](../src/warnet/scenarios/miner_std.py) scenario is a good one to start with as it automates block generation:
1919

2020
```bash
2121
# Have all nodes generate a block 5 seconds apart in a round-robin
22-
warcli scenarios run miner_std --allnodes --interval=5
22+
warnet scenarios run miner_std --allnodes --interval=5
2323
```
2424

2525
This will run the scenario in a background thread on the server until it exits or is stopped by the user.
2626

2727
Active scenarios can be listed and terminated by PID:
2828

2929
```bash
30-
$ warcli scenarios available
30+
$ warnet scenarios available
3131
miner_std Generate blocks over time. Options: [--allnodes | --interval=<number> | --mature]
3232
sens_relay Send a transaction using sensitive relay
3333
tx_flood Generate 100 blocks with 100 TXs each
3434

35-
$ warcli scenarios run tx_flood
35+
$ warnet scenarios run tx_flood
3636
Running scenario tx_flood with PID 14683 in the background...
3737

38-
$ warcli scenarios active
38+
$ warnet scenarios active
3939
┃ Active ┃ Cmd ┃ Network ┃ Pid ┃ Return_code ┃
4040
┡━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━━━━━━━┩
4141
│ True │ tx_flood │ warnet │ 14683 │ None ┃
4242

43-
$ warcli scenarios stop 14683
43+
$ warnet scenarios stop 14683
4444
Stopped scenario with PID 14683.
4545
```
4646

@@ -50,5 +50,5 @@ You can write your own scenario file locally and upload it to the server with
5050
the [run-file](/docs/warcli.md#warcli-scenarios-run-file) command (example):
5151

5252
```bash
53-
warcli scenarios run-file /home/me/bitcoin_attack.py
53+
warnet scenarios run-file /home/me/bitcoin_attack.py
5454
```

0 commit comments

Comments
 (0)