Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ermalkaleci committed Jun 4, 2024
1 parent 5e10a8c commit 7d45f6d
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,3 +221,6 @@ The subcommand arguments could be:
Please note that for both ways, fetched storages will be saved in the sqlite file specified by `--db` option (`db: ./acala.sqlite` in a config file), if not provided, it will default to `./db-{network}-{block}.sqlite`.
## Try-Runtime CLI
Documentation can be found [here](packages/chopsticks/src/plugins/try-runtime/README.md)
21 changes: 21 additions & 0 deletions packages/chopsticks/src/plugins/try-runtime/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Try-Runtime CLI

🚧 EXPERIMENTAL FEATURE 🚧

You can use Chopsticks to perform runtime migration checks. It doesn't support PoV measure yet, only weight check is support.

```bash
# try-runtime print help
npx @acala-network/chopsticks try-runtime --help
```

Basic example:

```bash
npx @acala-network/chopsticks try-runtime \
--endpoint <wss://remote.endpoint> \
--runtime <wasm_runtime_path> \
--checks PreAndPost
```

__NOTE__: You can also use `--config` to pass arguments
2 changes: 1 addition & 1 deletion packages/chopsticks/src/plugins/try-runtime/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const schema = z.object({
endpoint: configSchema.shape.endpoint,
block: configSchema.shape.block,
db: configSchema.shape.db,
['runtime-log-level']: configSchema.shape['runtime-log-level'],
['runtime-log-level']: configSchema.shape['runtime-log-level'].default(5),
['runtime']: z.string({
description: 'Path to WASM built with feature `try-runtime` enabled',
}),
Expand Down

0 comments on commit 7d45f6d

Please sign in to comment.