docs: Migrate oasis-node setup section, more commands #5281
Conversation
matevz
requested review from
kostko,
peterjgilbert,
pro-wh,
ptrus and
peternose
as code owners
matevz
force-pushed
the
matevz/docs/oasis-node-cli
branch
from
558d15e
to
3d9dde1
Compare
matevz
force-pushed
the
matevz/docs/oasis-node-cli
branch
from
3d9dde1
to
914f7c4
Compare
|
There are two sections referenced from the other parts of docs as I noticed:
We could remove other token management sections I guess, but these still exist in the current oasis-core master and 22.x branches right so why not document them? |
The node operator docs should be migrated to use the CLI as well because all of this is clunky as hell, but ok let's leave them for now.
This should be easy to add to the CLI, but ok let's leave it for now.
Yes we should remove them. The reason is that we should be directing people to use the CLI instead and not having these in docs allows us to remove them from master at any point. Also the CLI already supports 22.x so we should push people to use it now not later. |
|
|
||
| - `oasis-node stake info`: Shows general staking information. | ||
| - `oasis-node stake list`: Lists all accounts with positive balance. | ||
| - `oasis-node stake account info`: Shows detailed information for an account. |
There was a problem hiding this comment.
level=error ts=2023-06-09T11:32:52.580181299Z caller=account.go:143 module=cmd/stake msg="failed to parse account address" err="address: decoding from bech32 failed: decoding bech32 failed: invalid bech32 string length 0"
Some commands fail by default as not all parameters are set/correct. This could confuse users. We could add required flags (too much work, too long) or just mention somewhere that commands might need extra flags to work and direct user to help.
| located (e.g. `/serverdir/node/`) before executing the command, or | ||
| - pass the `-a $ADDR` flag where `ADDR` represents the path to the internal | ||
| Oasis node UNIX socket prefixed with `unix:` | ||
| (e.g.`unix:/serverdir/node/internal.sock`). |
There was a problem hiding this comment.
| (e.g.`unix:/serverdir/node/internal.sock`). | |
| (e.g. `unix:/serverdir/node/internal.sock`). |
| need access to the [network's current genesis file] and your signer's private | ||
| key: | ||
|
|
||
| - `oasis-node stake account gen_transfer` |
There was a problem hiding this comment.
If you want to be consistent with the previous list, the descriptions should be added.
| - `--signer.backend file`: Specifies use of the file signer. | ||
|
|
||
| [Oasis Core Ledger]: https://github.com/oasisprotocol/oasis-core-ledger/blob/master/docs/usage/transactions.md | ||
| [Running a Node on the Network]: https://github.com/oasisprotocol/docs/blob/main/docs/node/run-your-node/validator-node.mdx#creating-your-entity |
There was a problem hiding this comment.
This hasn't been merged yet: oasisprotocol/docs#399
|
|
||
| - `--genesis.file`: Path to the genesis file, e.g. `/localhostdir/genesis.json`. | ||
|
|
||
| For convenience, set the `GENESIS_FILE` environment value to its value, e.g.: |
There was a problem hiding this comment.
It is not obvious (until you get to the TX_FLAGS) why would one set this env value. This paragraph also splits enumeration into 2 parts, so one option would be to move it to the section Storing Base and Signer flags in an Environment Variable.
| 11450.384816640 / 10,185,014,125,910 which is 1.124238481664054 * 10^-9 token | ||
| per share. | ||
|
|
||
| For 357 billion shares, the amount of tokens that will be reclaimed is thu |
There was a problem hiding this comment.
| For 357 billion shares, the amount of tokens that will be reclaimed is thu | |
| For 357 billion shares, the amount of tokens that will be reclaimed is thus |
| command: | ||
|
|
||
| ```bash | ||
| oasis-node governance list_proposals --address unix:/path/to/node/internal.sock |
There was a problem hiding this comment.
Should we split this into multiple subsections, e.g. list_proposals, proposal_votes, ...?
|
|
||
| :::info | ||
|
|
||
| At this time only entities which have active validator nodes scheduled in the |
There was a problem hiding this comment.
Is there a command/script to check that?
| - `oasis1qr6swa6gsp2ukfjcdmka8wrkrwz294t7ev39nrw6`is our staking account | ||
| address. | ||
|
|
||
| We're not allowed to change the commission bounds too close in near future, so |
There was a problem hiding this comment.
Could also explain with few words why.
| advance (`rate_bound_lead`) and that we can change a commission rate on every | ||
| epoch (`rate_change_interval`). | ||
|
|
||
| The `max_rate_steps` and `max_bound_steps` determine the maximum number of |
There was a problem hiding this comment.
Doesn't explain anything.
Part of oasisprotocol/docs#399. This PR migrates a number of
oasis-nodecommands previously described inside thegeneral/manage-tokens/advanced/oasis-cli-toolssection to this repository where they should probably be in the first place.