Skip to content

Commit b10910f

Browse files
authored
Apply improvements to Zombienet docs (#511)
* Apply improvements * Apply suggestions
1 parent 8dfec79 commit b10910f

File tree

3 files changed

+54
-12
lines changed

3 files changed

+54
-12
lines changed

develop/toolkit/parachains/spawn-chains/zombienet/get-started.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -175,9 +175,6 @@ zombienet setup polkadot polkadot-parachain
175175

176176
This command will download and prepare the necessary binaries for Zombienet's use.
177177

178-
!!! warning
179-
The `polkadot` and `polkadot-parachain` binaries releases aren't compatible with macOS. As a result, macOS users will need to clone the [Polkadot repository](https://github.com/paritytech/polkadot-sdk){target=\_blank}, build the Polkadot binary, and manually add it to their PATH for `polkadot` and `polkadot-parachain` to work.
180-
181178
If you need to use a custom binary, ensure the binary is available in your PATH. You can also specify the binary path in the network configuration file. The following example uses the custom [OpenZeppelin template](https://github.com/OpenZeppelin/polkadot-runtime-templates){target=\_blank}:
182179

183180
First, clone the OpenZeppelin template repository using the following command:
@@ -244,9 +241,6 @@ The following sections will guide you through the primary usage of the Zombienet
244241

245242
- **`spawn <networkConfig>`** - spawn the network defined in the [configuration file](#configuration-files)
246243

247-
!!! warning
248-
The Polkadot binary is currently not compatible with macOS. For the `spawn` command to work on macOS, users will need to clone the [Polkadot repository](https://github.com/paritytech/polkadot-sdk){target=\_blank}, build the Polkadot binary, and manually add it to their PATH.
249-
250244
- **`test <testFile>`** - run tests on the spawned network using the assertions and tests defined in the [test file](/develop/toolkit/parachains/spawn-chains/zombienet/write-tests/#the-test-file){target=\_blank}
251245

252246

llms.txt

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10633,9 +10633,6 @@ zombienet setup polkadot polkadot-parachain
1063310633

1063410634
This command will download and prepare the necessary binaries for Zombienet's use.
1063510635

10636-
!!! warning
10637-
The `polkadot` and `polkadot-parachain` binaries releases aren't compatible with macOS. As a result, macOS users will need to clone the [Polkadot repository](https://github.com/paritytech/polkadot-sdk){target=\_blank}, build the Polkadot binary, and manually add it to their PATH for `polkadot` and `polkadot-parachain` to work.
10638-
1063910636
If you need to use a custom binary, ensure the binary is available in your PATH. You can also specify the binary path in the network configuration file. The following example uses the custom [OpenZeppelin template](https://github.com/OpenZeppelin/polkadot-runtime-templates){target=\_blank}:
1064010637

1064110638
First, clone the OpenZeppelin template repository using the following command:
@@ -10702,9 +10699,6 @@ The following sections will guide you through the primary usage of the Zombienet
1070210699

1070310700
- **`spawn <networkConfig>`** - spawn the network defined in the [configuration file](#configuration-files)
1070410701

10705-
!!! warning
10706-
The Polkadot binary is currently not compatible with macOS. For the `spawn` command to work on macOS, users will need to clone the [Polkadot repository](https://github.com/paritytech/polkadot-sdk){target=\_blank}, build the Polkadot binary, and manually add it to their PATH.
10707-
1070810702
- **`test <testFile>`** - run tests on the spawned network using the assertions and tests defined in the [test file](/develop/toolkit/parachains/spawn-chains/zombienet/write-tests/#the-test-file){target=\_blank}
1070910703

1071010704

@@ -27977,6 +27971,33 @@ To successfully complete this tutorial, you must ensure you've first:
2797727971
- [Installed Zombienet](/develop/toolkit/parachains/spawn-chains/zombienet/get-started/#install-zombienet){target=\_blank}. This tutorial requires Zombienet version `{{ dependencies.repositories.zombienet.version }}`. Verify that you're using the specified version to ensure compatibility with the instructions.
2797827972
- Reviewed the information in [Configure Zombienet](/develop/toolkit/parachains/spawn-chains/zombienet/get-started/#configure-zombienet){target=\_blank} and understand how to customize a spawned network
2797927973

27974+
## Set Up Local Provider
27975+
27976+
In this tutorial, you will use the Zombienet [local provider](/develop/toolkit/parachains/spawn-chains/zombienet/get-started/#local-provider){target=\_blank} (also called native provider) that enables you to run nodes as local processes in your development environment.
27977+
27978+
You must have the necessary binaries installed (such as `polkadot` and `polkadot-parachain`) to spin up your network successfully.
27979+
27980+
To install the required binaries, use the following Zombienet CLI command:
27981+
27982+
```bash
27983+
zombienet setup polkadot polkadot-parachain
27984+
```
27985+
27986+
This command downloads the following binaries:
27987+
27988+
- `polkadot`
27989+
- `polkadot-execute-worker`
27990+
- `polkadot-parachain`
27991+
- `polkadot-prepare-worker`
27992+
27993+
Finally, add these binaries to your PATH environment variable to ensure Zombienet can locate them when spawning the network.
27994+
27995+
For example, you can move the binaries to a directory in your PATH, such as `/usr/local/bin`:
27996+
27997+
```bash
27998+
sudo mv ./polkadot ./polkadot-execute-worker ./polkadot-parachain ./polkadot-prepare-worker /usr/local/bin
27999+
```
28000+
2798028001
## Define the Network
2798128002

2798228003
Zombienet uses a [configuration file](/develop/toolkit/parachains/spawn-chains/zombienet/get-started/#configuration-files){target=\_blank} to define the ephemeral network that will be spawned. Follow these steps to create and define the configuration file:

tutorials/polkadot-sdk/testing/spawn-basic-chain.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,33 @@ To successfully complete this tutorial, you must ensure you've first:
2020
- [Installed Zombienet](/develop/toolkit/parachains/spawn-chains/zombienet/get-started/#install-zombienet){target=\_blank}. This tutorial requires Zombienet version `{{ dependencies.repositories.zombienet.version }}`. Verify that you're using the specified version to ensure compatibility with the instructions.
2121
- Reviewed the information in [Configure Zombienet](/develop/toolkit/parachains/spawn-chains/zombienet/get-started/#configure-zombienet){target=\_blank} and understand how to customize a spawned network
2222

23+
## Set Up Local Provider
24+
25+
In this tutorial, you will use the Zombienet [local provider](/develop/toolkit/parachains/spawn-chains/zombienet/get-started/#local-provider){target=\_blank} (also called native provider) that enables you to run nodes as local processes in your development environment.
26+
27+
You must have the necessary binaries installed (such as `polkadot` and `polkadot-parachain`) to spin up your network successfully.
28+
29+
To install the required binaries, use the following Zombienet CLI command:
30+
31+
```bash
32+
zombienet setup polkadot polkadot-parachain
33+
```
34+
35+
This command downloads the following binaries:
36+
37+
- `polkadot`
38+
- `polkadot-execute-worker`
39+
- `polkadot-parachain`
40+
- `polkadot-prepare-worker`
41+
42+
Finally, add these binaries to your PATH environment variable to ensure Zombienet can locate them when spawning the network.
43+
44+
For example, you can move the binaries to a directory in your PATH, such as `/usr/local/bin`:
45+
46+
```bash
47+
sudo mv ./polkadot ./polkadot-execute-worker ./polkadot-parachain ./polkadot-prepare-worker /usr/local/bin
48+
```
49+
2350
## Define the Network
2451

2552
Zombienet uses a [configuration file](/develop/toolkit/parachains/spawn-chains/zombienet/get-started/#configuration-files){target=\_blank} to define the ephemeral network that will be spawned. Follow these steps to create and define the configuration file:

0 commit comments

Comments
 (0)