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

Tui overview #67

Merged
merged 9 commits into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from 7 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 added docs/tutorials/tui/img/TUI-11-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
86 changes: 85 additions & 1 deletion docs/tutorials/tui/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,91 @@
# Platform TUI

- [Main screen](#main-screen)

- [Identity management](#identity-management)

- [Contracts](#contracts)

- [Strategies](#strategies)

- [Wallet](#wallet)

- [Platform information](#platform-information)


VirgileBa marked this conversation as resolved.
Show resolved Hide resolved
## Main screen

This screen represents the application's main menu. The interface provides quick navigation options and a summary of essential information.
This screen is the application's main menu. The interface provides quick navigation options and a summary of essential information.


![](./img/TUI-1.png)


VirgileBa marked this conversation as resolved.
Show resolved Hide resolved
## Identity management

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

![](./img/TUI-2.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.

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


## Strategies

This screen is where you can add, select, import and export [strategies](https://www.dash.org/blog/strategy-tests-usage-guide/).

![](./img/TUI-11-2.png)

### Strategy management

If you select or create a strategy, you are taken to the following screen. Here you can manage the selected strategy.

- "Start contract" is the number of contracts at the start of your strategy
- "start identities" is the number of identity present at the start" - it is recommended to have a sufficient number of identities. See the end of the [strategy guide](https://www.dash.org/blog/strategy-tests-usage-guide/)
- "identitiy inserts" is the number of identity inserted per block during the runtime of the strategy.
- "operations" let you define the actions triggered during the runtime of the strategy.
VirgileBa marked this conversation as resolved.
Show resolved Hide resolved

![](./img/TUI-13.png)

### adding operations to a strategy
VirgileBa marked this conversation as resolved.
Show resolved Hide resolved
If you select "operations", you will be presented with the following screen.
VirgileBa marked this conversation as resolved.
Show resolved Hide resolved

Remember that when adding a number of operations to the strategy, it is the number of operation *per block*. If the strategy runs for 12 blocks, and 5 operations are defined in the strategy, it will total to 5 operations each block for 12 blocks = 60 operations.

- "add" lets you add specific documents, identity topups, key adds,... a specified number of time per block as shown in the second screenshot below
- "register x documents to all contracts" will register x document each block to every contract that has been created in the strategy so far. Adding 3 documents to 4 contracts will result to 12 documents being added per block. This includes both "start contracts" and contracts added by the "add" option thereabove.
VirgileBa marked this conversation as resolved.
Show resolved Hide resolved

![](./img/TUI-28.png)

the "add" screen:
VirgileBa marked this conversation as resolved.
Show resolved Hide resolved

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


## Wallet

This screen lets you see a loaded wallet's information. You can:

- register identities here as well as and getting more utxos and loading an evonode identity

- loading previously registered identities

- load evonode identities (identities capable of masternode voting)

- split down the current utxos in your wallet into a desired amount of utxos with "get more utxos". (This comes in handy for strategies which require a lot of asset lock proofs)
VirgileBa marked this conversation as resolved.
Show resolved Hide resolved

![](./img/TUI-43.png)


## Platform information


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

![](./img/TUI-49.png)

Loading