You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-27Lines changed: 27 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,28 +6,23 @@
6
6
7
7
## :warning::construction: Under Active Development :construction::warning:
8
8
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.
10
10
11
+
### Requirements
11
12
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`:
13
14
14
-
15
-
### Requerimients
16
-
17
-
In order to use this tool you will need this binaries available in your `PATH`
`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:
24
20
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.
26
22
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).
29
24
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.
31
26
32
27
#### Concepts
33
28
- <aid="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:
60
55
61
56
### AHM flow
62
57
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).
64
60
65
61
#### Base path
66
62
@@ -69,24 +65,30 @@ The order of resolution that `zombie-bite` use is:
69
65
- If the option is not passed as _cli args_, use the env var 'ZOMBIE_BITE_BASE_PATH'.
70
66
- If the env var is not provided, fallback to use `<cwd>_timestamp`.
71
67
72
-
#### Bite usage (with override runtimes):
68
+
#### Bite usage
73
69
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:
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.
83
85
84
86
#### Spawn
85
87
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:
87
89
88
90
```bash
89
-
zombie-bite spawn -d /tmp/ahm-migration
91
+
zombie-bite spawn -d /tmp/base_path
90
92
```
91
93
92
94
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
120
122
To __signal__ the teardown, you should create a fila called __stop.txt__ in the _base_path_
121
123
122
124
```bash
123
-
touch /parity/zombie-bite_1754046046/stop.txt
125
+
touch /tmp/base_path/stop.txt
124
126
```
125
127
126
128
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
131
133
To _spawn_ the network as part of the `post` step you can run
132
134
133
135
```bash
134
-
zombie-bite spawn -d /tmp/ahm-migration -s post
136
+
zombie-bite spawn -d /tmp/base_path -s post
135
137
```
136
138
137
139
Again, this will print network information and you can __signal__ to teardown by creating the `stop.txt` file inside the _base_path_
138
140
139
141
```bash
140
-
touch /parity/zombie-bite_1754046046/stop.txt
142
+
touch /tmp/base_path/stop.txt
141
143
```
142
144
143
-
144
-
145
145
##### Log level:
146
146
147
-
By default the relaychain nodes are spawned with this log levesl:
147
+
By default the relaychain nodes are spawned with this log levels:
0 commit comments