Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: tui page updates #83

Merged
merged 4 commits into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/tutorials/tui/img/TUI-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/tutorials/tui/img/TUI-2.png
Binary file not shown.
Binary file removed docs/tutorials/tui/img/TUI-8.png
Binary file not shown.
Binary file removed docs/tutorials/tui/img/TUI-dpns.png
Binary file not shown.
Binary file added docs/tutorials/tui/img/contracts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/tutorials/tui/img/dpns/dpns.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/tutorials/tui/img/identities/identities.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/tutorials/tui/img/platform-info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
84 changes: 80 additions & 4 deletions docs/tutorials/tui/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@ Click an option below to jump to the section describing it in more detail:

This screen is where identity operations are done, including requesting identities, transferring credits, and registering [DPNS names](https://docs.dash.org/projects/platform/en/stable/docs/explanations/dpns.html). Press `p` to enable proofs.

![Identities screen](./img/TUI-2.png)
![Identities screen](./img/identities/identities.png)

## Name Service (DPNS)

This screen view information related to your identities and any names linked to them. It also provides access to the voting screen where masternodes can vote on [requests for premium names](../../explanations/dpns.md#conflict-resolution).

![DPNS screen](./img/TUI-dpns.png)
![DPNS screen](./img/dpns/dpns.png)

## Contracts

This screen is where you will add, manage and remove [contracts](https://docs.dash.org/projects/platform/en/stable/docs/tutorials/contracts-and-documents.html). System contracts encompass [Dashpay](https://docs.dash.org/projects/platform/en/stable/docs/explanations/dashpay.html) and [DPNS](https://docs.dash.org/projects/platform/en/stable/docs/explanations/dpns.html) contracts as of today, other contracts must be fetched by ID.

![Contracts screen](./img/TUI-8.png)
![Contracts screen](./img/contracts.png)

## Wallet

Expand All @@ -57,7 +57,7 @@ This screen also provides options for you to:

This screen lets you see information on the epochs and the current version voting

![Platform information screen](./img/TUI-49.png)
![Platform information screen](./img/platform-info.png)

## Strategies

Expand Down Expand Up @@ -90,3 +90,79 @@ Remember that when adding a number of operations to the strategy, it is the numb
#### Add strategy operation

![Add strategy screen](./img/TUI-29.png)

## Name voting

:::{tip}
Masternode and evonode owners that want to participate in voting should [load their masternode identity](#load-masternode-identity) before continuing.
:::

Since some names may be popular, the DPNS name registration process includes a voting mechanism to
resolve conflicts when multiple identities request the same name. Anyone can view the contested
resources screen and vote status; however, voting can only be done by masternodes and evonodes.

### DPNS Contested resources

The following sections describe how to [view](#viewing) and [vote](#voting) on contested resources.

#### Viewing

From the [DPNS main screen](#name-service-dpns), press `v` to open the voting screen.

![DPNS screen](./img/dpns/dpns.png)

The left side of the contested resources screen lists all names requiring votes. Scroll up or down
to select a name, then press `s` to see the current voting status.

![DPNS contested resources screen](./img/dpns/dpns-contested-resources.png)

The vote status lists all identities currently requesting the name and the number of votes for each
one. Vote count for the abstain and lock categories are also shown.

![DPNS contested resources screen showing status](./img/dpns/dpns-contested-resources-status.png)

#### Voting

:::{attention}
Voting can only be done by masternodes and evonodes, and each node can only modify its vote four
times. See the [load masternode identity section](#load-masternode-identity) for instructions on
importing your masternode voting key to vote using the TUI.
:::

To vote on a contested resource, press `v` to open the voting screen, select your preferred option, and press `Enter` to submit your response.

![DPNS contested resources voting screen](./img/dpns/dpns-contested-resources-vote.png)

You will be returned to the contested resources screen and should see "Vote cast successfully".

![DPNS contested resources vote success](./img/dpns/dpns-contested-resources-vote-success.png)

Check the status again to confirm that your vote was successful.

![DPNS contested resources screen showing status after vote](./img/dpns/dpns-contested-resources-status2.png)

### Load masternode identity

:::{note}
A bug in the Platform TUI currently requires a wallet to be loaded before a masternode identity can
be loaded. Go to the [wallet screen](#wallet) and press `r` to create a random wallet if you have
not already created one.
:::

From the [Identities main screen](#identity-management), press `m` to load a masternode or evonode
identity. Paste the node's protx hash and press `Enter`.

![Load masternode protx](./img/identities/identity-load-mn-1-protx.png)

On the next screen, paste the node's voting private key and press `Enter`.

![Load masternode voting key](./img/identities/identity-load-mn-2-key.png)

You will be returned to the Identities main screen and should see "Loaded Evonode Identity".

![Load masternode success](./img/identities/identity-load-mn-3-success.png)

Refresh the screen to see the identity by pressing `q` to return to the main screen, and then reopen
the Identities screen by pressing `i`.

![Load masternode refreshed screen](./img/identities/identity-load-mn-4-refresh.png)