Tui overview (#67)

* Add files via upload * Update index.md * Update index.md * Update index.md * Update index.md * Update index.md * Update index.md * Update docs/tutorials/tui/index.md Co-authored-by: thephez <[email protected]> * Apply suggestions from code review Co-authored-by: thephez <[email protected]> --------- Co-authored-by: thephez <[email protected]>
dashpay · Jul 25, 2024 · 968aa09 · 968aa09
1 parent fdee472
commit 968aa09
Show file tree

Hide file tree

Showing 2 changed files with 76 additions and 1 deletion.
diff --git a/docs/tutorials/tui/img/TUI-11-2.png b/docs/tutorials/tui/img/TUI-11-2.png
diff --git a/docs/tutorials/tui/index.md b/docs/tutorials/tui/index.md
@@ -2,6 +2,81 @@
 
 ## 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)
+
+Click an option below to jump to the section describing it in more detail:
+- [Identity management](#identity-management)
+- [Contracts](#contracts)
+- [Strategies](#strategies)
+- [Wallet](#wallet)
+- [Platform information](#platform-information)
+
+## 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 identities" is the number of identities present at the start of your strategy - 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/) for suggestions
+- "Start contract" is the number of contracts at the start of your strategy
+- "Identitiy inserts" is the number of identities inserted per block during the runtime of the strategy
+- "Operations" let you define the actions triggered during the runtime of the strategy
+
+![](./img/TUI-13.png)
+
+### Adding operations to a strategy
+
+If you select "Operations", you will be presented with the following screen.
+
+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.   
+
+![](./img/TUI-28.png)
+
+"Add" screen:
+
+![](./img/TUI-29.png)
+
+
+## Wallet
+
+This screen lets you see a loaded wallet's information. You can: 
+
+- Register identities
+- Load previously registered identities
+- Split the UTXOs currently in your wallet into a desired number of UTXOs with "Get more utxos". This is helpful for strategies that require many asset lock proofs.
+- Load evonode identities (identities capable of masternode voting)
+
+![](./img/TUI-43.png)
+
+
+## Platform information
+
+
+This screen lets you see information on the epochs and the current version voting
+
+![](./img/TUI-49.png)
+