Skip to content

Commit

Permalink
docs: Document oasis-node genesis CLI commands
Browse files Browse the repository at this point in the history
  • Loading branch information
tjanez committed Sep 21, 2020
1 parent 6b12e81 commit bf6f14f
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .changelog/3298.doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Document [`oasis-node genesis` CLI commands]

[`oasis-node genesis` CLI commands]: docs/oasis-node/cli.md#genesis
58 changes: 58 additions & 0 deletions docs/oasis-node/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,64 @@ node):
}
```

## `genesis`

### `check`

To check if a given [genesis file] is valid, run:

```sh
oasis-node genesis check --genesis.file /path/to/genesis.json
```

{% hint style="info" %}
This also checks if the genesis file is in the [canonical form].
{% endhint %}

### `dump`

To dump the state of the network at a specific block height, e.g. 717600, to a
[genesis file], run:

```sh
oasis-node genesis dump \
--address unix:/path/to/node/internal.sock \
--genesis.file /path/to/genesis_dump.json \
--height 717600
```

{% hint style="warning" %}
You must only run the following command after the given block height has been
reached on the network.
{% endhint %}

### `init`

To initialize a new [genesis file] with the given chain id and [staking token
symbol], run:

```sh
oasis-node genesis init --genesis.file /path/to/genesis.json \
--chain.id "name-of-my-network" \
--staking.token_symbol TEST
```

{% hint style="info" %}
You can set a lot of parameters for the various [consensus layer services].

To see the full list, run:

```sh
oasis-node genesis init --help
```

{% endhint %}

[genesis file]: ../consensus/genesis.md#genesis-file
[canonical form]: ../consensus/genesis.md#canonical-form
[consensus layer services]: ../consensus/index.md
[staking token symbol]: ../consensus/staking.md#tokens-and-base-units

## `stake`

### `account`
Expand Down

0 comments on commit bf6f14f

Please sign in to comment.