Skip to content

Commit f593960

Browse files
committed
chore(readme): reflect current code (CLI flags, archive-ahm reference, parachain examples)
1 parent 7db62b2 commit f593960

1 file changed

Lines changed: 27 additions & 27 deletions

File tree

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,23 @@
66

77
## :warning: :construction: Under Active Development :construction: :warning:
88

9-
> Currently this tool is focused in the AH migration project and isn't ready to use as general purpouse tool without customization.
9+
`zombie-bite` is a CLI tool that allows you to spawn a new network based on a live one. It orchestrates the `sync` prior to `bite` and spawns a new network with the live state using `doppelganger` binaries. The tool supports overriding/injecting keys during block import.
1010

11+
### Requirements
1112

12-
`zombie-bite` is a simple _cli_ tool that allow you to spawn a new network based on a live one (e.g kusama/polkadot/ paseo). Under the hood we orchestrate the `sync` prior to _bite_ and spawn a new network with the _live state_ using `doppelganger` (based on https://github.com/paritytech/polkadot-sdk/issues/4230) as family of binaries that allow us to _inject_ some _keys_ using a custom `block_import` on top of the regular one.
13+
You need these binaries available in your `PATH`:
1314

14-
15-
### Requerimients
16-
17-
In order to use this tool you will need this binaries available in your `PATH`
18-
19-
- [Doppelganger binaries](https://github.com/paritytech/doppelganger-wrapper) (doppelganger, doppelganger-parachain, workers)
15+
- [Doppelganger binaries](https://github.com/paritytech/doppelganger-wrapper) (doppelganger, doppelganger-parachain, workers)
2016

2117
### Logical steps: Bite, Spawn, Post
2218

23-
`zombie-bite` was designed focused on creating reusble artifacts on each step, the expected flow of usage is:
19+
`zombie-bite` is designed to create reusable artifacts at each step. The typical flow is:
2420

25-
- `bite` the desired network, this will run the _biting_ process and generate the _artifacts_ to `spawn` the _bited_ network as many times you want.
21+
- `bite` the desired network, this runs the _biting_ process and generates _artifacts_ to `spawn` the _bited_ network multiple times.
2622

27-
- `spawn` the network, reutilizing the _artifacts_ from the _bitting_ process. Ones the network is running you can [signal](#signal-stop) `zombie-bite` to stop it and generate the _artifacts_ for the `post` state.
28-
(e.g: Is expected to run the AH migration as part of this step).
23+
- `spawn` a network reusing artifacts from `bite`. When running, you can [signal](#signal-stop) `zombie-bite` to stop and pack the artifacts for the `post` step (e.g., run the AH migration during spawn).
2924

30-
- `post` step it utilized when you want to reuse a network from the _artifacts_ generated by the `spawn` step. (e.g: Is expected to run the _post_ migration test using this step)
25+
- `post` is used to run post-migration tests or other logic using artifacts generated by the `spawn` step.
3126

3227
#### Concepts
3328
- <a id="base_path"></a> __Base Path__ (base_path): `zombie_bite` encapsulate all the intermedia and generated files in this directory, using three main subdirectories (`bite`, `spawn` and `post`).
@@ -60,7 +55,8 @@ Options:
6055

6156
### AHM flow
6257

63-
As this tool is primarily for the AHM project, we will focus in this section on how to use it to bite a live network (e.g: polakadot) with asset-hub. Then spawn a new instance of the network, run the migration and _stop_ the network to later spawn for running the _post_ migration test.
58+
`zombie-bite` was originally created to support the Asset-Hub Migration (AHM) workflow. The initial AHM-focused implementation is available in the [archive-ahm](https://github.com/paritytech/zombie-bite/tree/archive-ahm).
59+
Now supports all system chains (asset-hub, coretime, people, colletives).
6460

6561
#### Base path
6662

@@ -69,24 +65,30 @@ The order of resolution that `zombie-bite` use is:
6965
- If the option is not passed as _cli args_, use the env var 'ZOMBIE_BITE_BASE_PATH'.
7066
- If the env var is not provided, fallback to use `<cwd>_timestamp`.
7167

72-
#### Bite usage (with override runtimes):
68+
#### Bite usage
7369

74-
First we need to have compiled the runtimes we want to override for the rc and ah, then we can start the `bite` process by running.
70+
Compile any runtime WASM you want to override (optional), then start the `bite` process. Examples:
71+
72+
- Override the relay runtime:
7573

7674
```sh
77-
zombie-bite bite -d /tmp/ahm-migration -r polkadot --rc-override ./runtime_wasm/polkadot_runtime.compact.compressed.wasm --ah-override ./runtime_wasm/asset_hub_polkadot_runtime.compact.compressed.wasm
75+
zombie-bite bite -d /tmp/base_path -r polkadot --rc-override ./runtime_wasm/polkadot_runtime.compact.compressed.wasm
7876
```
7977

80-
_Note_: We will using this path `/tmp/ahm-migration` for the whole flow.
78+
- Include only specific parachains (comma-separated):
8179

82-
Ones this process completed, we will have all the needed _artifacts_ to spawn a new instance of the _bited_ network
80+
```sh
81+
zombie-bite bite -d /tmp/base_path -r polkadot --parachains people,bridge-hub,coretime,collectives
82+
```
83+
84+
You can combine both options to override runtimes and select parachains in the same command. On success you'll have all artifacts needed to spawn the _bitten_ network.
8385

8486
#### Spawn
8587

86-
The next step is to _spawn_ the network, and _run the runtime migration_. We can `spawn` a new instance of the _bited_ network with the following cmd:
88+
Spawn a new instance of the _bited_ network with the following cmd:
8789

8890
```bash
89-
zombie-bite spawn -d /tmp/ahm-migration
91+
zombie-bite spawn -d /tmp/base_path
9092
```
9193

9294
This will spawn the network and print direct links to connect to the nodes using both `pjs` or `papi`. Also, where the logs are stored and the command usage for spawn each node:
@@ -120,7 +122,7 @@ For __AHM__, this is the moment to run the migration and ones is completed you c
120122
To __signal__ the teardown, you should create a fila called __stop.txt__ in the _base_path_
121123

122124
```bash
123-
touch /parity/zombie-bite_1754046046/stop.txt
125+
touch /tmp/base_path/stop.txt
124126
```
125127

126128
This will automatically teardown the network and generate the artifacts.
@@ -131,20 +133,18 @@ The `post` step is mainly thought to run _post migration_ test or any other logi
131133
To _spawn_ the network as part of the `post` step you can run
132134

133135
```bash
134-
zombie-bite spawn -d /tmp/ahm-migration -s post
136+
zombie-bite spawn -d /tmp/base_path -s post
135137
```
136138

137139
Again, this will print network information and you can __signal__ to teardown by creating the `stop.txt` file inside the _base_path_
138140

139141
```bash
140-
touch /parity/zombie-bite_1754046046/stop.txt
142+
touch /tmp/base_path/stop.txt
141143
```
142144

143-
144-
145145
##### Log level:
146146

147-
By default the relaychain nodes are spawned with this log levesl:
147+
By default the relaychain nodes are spawned with this log levels:
148148

149149
```sh
150150
babe=trace,grandpa=trace,runtime=debug,consensus::common=trace,parachain=debug,sync=debug

0 commit comments

Comments
 (0)