Skip to content

Commit

Permalink
feat: Add account entity init docs and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
matevz committed Nov 10, 2023
1 parent 2ef9413 commit 3c44163
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -519,6 +519,30 @@ transaction.

### Entity Management {#entity}

#### Initialize Entity {#entity-init}

When setting up a validator node for the first time, you will need to provide
the path to the file containing your entity descriptor in your Oasis node config
as well as register it in the network registry. Use `account entity init` to
generate the entity descriptor file containing the public key of the selected
account.

![code shell](../examples/account/entity-init.in.static)

![code](../examples/account/entity-init.out.static)

By default, the file content will be printed to the standard output. You can use
`-o` parameter to store it to a file, for example:

![code shell](../examples/account/entity-init-o.y.in)

:::info

[Account](#account) selector is available for the
`account entity init` command.

:::

#### Register your Entity {#entity-register}

In order for validators to become part of the validator set and/or the compute
Expand Down
1 change: 1 addition & 0 deletions examples/account/entity-init-o.y.in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
oasis account entity init -o entity.json
Empty file.
1 change: 1 addition & 0 deletions examples/account/entity-init.in.static
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
oasis account entity init
5 changes: 5 additions & 0 deletions examples/account/entity-init.out.static
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"id": "Bx6gOixnxy15tCs09ua5DcKyX9uo2Forb32O6Hyjoc8=",
"nodes": [],
"v": 2
}

0 comments on commit 3c44163

Please sign in to comment.