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
+13-10Lines changed: 13 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,12 @@
4
4
5
5
## Intro
6
6
7
-
srtool is a collection of dockerized tools helping with [Substrate](https://substrate.dev) & [Polkadot](https://polkadot.network) Runtime development.
7
+
`srtool` is a collection of dockerized tools helping with [Substrate](https://substrate.dev) & [Polkadot](https://polkadot.network) Runtime development. The project was initially developped from [my Gitlab account](https://gitlab.com/chevdor).
8
+
The project now moved to Github under the [Parity Technologies](https://www.github.com/paritytech) organisation to simplify the developement and the integration with other Parity products such as Polkadot and Kusama.
8
9
9
-
It especially helps with building and verifying Wasm Runtime Blobs. The Docker image is `chevdor/srtool`. You can find it at <https://hub.docker.com/r/chevdor/srtool>.
10
+
The last version hosted on Gitlab has been built using Rust Stable 1.53.0. It is tagged as v0.9.14 and there is no plan on updating the Gitlab repository further. New versions will be available from <https://www.github.com/paritytech/srtool>. The functionnalities remain the same so you can (and should!) simply swap `chevdor/srtool` for `paritytech/srtool` in your workflows. The [srtool-actions](https://github.com/chevdor/srtool-actions) will remain available as `chevdor/srtool-actions@<version>` and will be updated to point at the paritytech image.
11
+
12
+
`srtool` especially helps with building and verifying WASM Runtimes. The Docker image is `paritytech/srtool`. You can find it at <https://hub.docker.com/r/paritytech/srtool>.
10
13
11
14
There are a few other helpers you may want to chcek out when using `srtool`:
12
15
@@ -20,27 +23,27 @@ There are a few other helpers you may want to chcek out when using `srtool`:
20
23
21
24

22
25
23
-
`srtool` is a tool for chain builders, it is widely used in CI such as Github Actions, it can also be used by anyone who wants to indenpendantly check and audit a chain or parachain.
26
+
`srtool` is a tool for chain builders, it is widely used in CI such as Github Actions, it can also be used by anyone who wants to indenpendantly check and audit a chain or a parachain.
24
27
25
28
You may also want to have a look at [subwasm](https://github.com/chevdor/subwasm) as it is now part of the tooling included in `srtool`. `subwasm` can also be used independantly upon building your wasm with `srtool`.
26
29
27
30
## Install
28
31
29
32
### Install the srtool-cli
30
33
31
-
Since the `srtool-cli` (<https://gitlab.com/chevdor/srtool-cli>) exists, there is no reason to be using an alias. Using the cli over the alias brings many advantages and will save you time.
34
+
Since the `srtool-cli` (<https://github.com/chevdor/srtool-cli>) exists, there is no reason to be using an alias. Using the cli over the alias brings many advantages and will save you time.
32
35
33
-
The `srtool-cli` is a command line utility written in Rust, you can read more in [its repository](https://gitlab.com/chevdor/srtool-cli), the installation process is described in more details there. In short:
36
+
The `srtool-cli` is a command line utility written in Rust, you can read more in [its repository](https://github.com/chevdor/srtool-cli), the installation process is described in more details there. In short:
This method is legacy and deprecated, prefer the `srtool-cli` utility mentioned above. This information is left here however for documentation purpose but all the functions are now availabe in the `srtool-cli`.
40
43
41
44
Creating an alias helps hiding the docker complexity behind one simple command. We will see more powerful options but this one is simple enough.
42
45
43
-
export RUSTC_VERSION=1.53.0; export PACKAGE=kusama-runtime; alias srtool='docker run --rm -it -e PACKAGE=$PACKAGE -v $PWD:/build -v $TMPDIR/cargo:/cargo-home chevdor/srtool:$RUSTC_VERSION'
46
+
export RUSTC_VERSION=1.53.0; export PACKAGE=kusama-runtime; alias srtool='docker run --rm -it -e PACKAGE=$PACKAGE -v $PWD:/build -v $TMPDIR/cargo:/cargo-home paritytech/srtool:$RUSTC_VERSION'
44
47
45
48
Note that defining the alias as done above will hardcode the runtime. Using `kusama-runtime` as show above means you will **always** check the kusama runtime. If you need more, check the next chapter.
46
49
@@ -271,12 +274,12 @@ If you are using `zsh` and `zinit`, you may benefit from using the srtool snippe
srtool is a collection of dockerized tools helping with https://substrate.dev[Substrate] & https://polkadot.network[Polkadot] Runtime development.
13
+
`srtool` is a collection of dockerized tools helping with https://substrate.dev[Substrate] & https://polkadot.network[Polkadot] Runtime development. The project was initially developped from https://gitlab.com/chevdor[my Gitlab account].
14
+
The project now moved to Github under the https://www.github.com/paritytech[Parity Technologies] organisation to simplify the developement and the integration with other Parity products such as Polkadot and Kusama.
14
15
15
-
It especially helps with building and verifying Wasm Runtime Blobs. The Docker image is `{name}`. You can find it at https://hub.docker.com/r/{name}.
16
+
The last version hosted on Gitlab has been built using Rust Stable 1.53.0. It is tagged as v0.9.14 and there is no plan on updating the Gitlab repository further. New versions will be available from https://www.github.com/paritytech/srtool. The functionnalities remain the same so you can (and should!) simply swap `chevdor/srtool` for `paritytech/srtool` in your workflows. The https://github.com/chevdor/srtool-actions[srtool-actions] will remain available as `chevdor/srtool-actions@<version>` and will be updated to point at the paritytech image.
17
+
18
+
`srtool` especially helps with building and verifying WASM Runtimes. The Docker image is `{name}`. You can find it at https://hub.docker.com/r/{name}.
16
19
17
20
There are a few other helpers you may want to chcek out when using `srtool`:
18
21
@@ -23,19 +26,19 @@ There are a few other helpers you may want to chcek out when using `srtool`:
23
26
24
27
image::resources/Frame 1_256.png[align=center]
25
28
26
-
`srtool` is a tool for chain builders, it is widely used in CI such as Github Actions, it can also be used by anyone who wants to indenpendantly check and audit a chain or parachain.
29
+
`srtool` is a tool for chain builders, it is widely used in CI such as Github Actions, it can also be used by anyone who wants to indenpendantly check and audit a chain or a parachain.
27
30
28
31
You may also want to have a look at https://github.com/chevdor/subwasm[subwasm] as it is now part of the tooling included in `srtool`. `subwasm` can also be used independantly upon building your wasm with `srtool`.
29
32
30
33
== Install
31
34
32
35
=== Install the srtool-cli
33
36
34
-
Since the `srtool-cli` (https://gitlab.com/chevdor/srtool-cli) exists, there is no reason to be using an alias. Using the cli over the alias brings many advantages and will save you time.
37
+
Since the `srtool-cli` (https://github.com/chevdor/srtool-cli) exists, there is no reason to be using an alias. Using the cli over the alias brings many advantages and will save you time.
35
38
36
-
The `srtool-cli` is a command line utility written in Rust, you can read more in https://gitlab.com/chevdor/srtool-cli[its repository], the installation process is described in more details there. In short:
39
+
The `srtool-cli` is a command line utility written in Rust, you can read more in https://github.com/chevdor/srtool-cli[its repository], the installation process is described in more details there. In short:
0 commit comments