feat: platform tui overview (#68)

* feat: add start of tui details * docs: add tui screenshots * 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]> * chore: lint fixes FIx whitespace lint * chore: add descriptions to all images * docs(tui): add description * refactor: put some content below image instead of above * docs(tui): update --------- Co-authored-by: VirgileBa <[email protected]>
dashpay · Jul 25, 2024 · 82db6f3 · 82db6f3
1 parent 2cb5198
commit 82db6f3
Show file tree

Hide file tree

Showing 52 changed files with 86 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -117,6 +117,7 @@ tutorials/contracts-and-documents
 tutorials/send-funds
 tutorials/use-dapi-client-methods
 tutorials/setup-a-node
+tutorials/tui/index
 ```
 
 ```{toctree}

diff --git a/docs/tutorials/tui/img/TUI-1.png b/docs/tutorials/tui/img/TUI-1.png
diff --git a/docs/tutorials/tui/img/TUI-10.png b/docs/tutorials/tui/img/TUI-10.png
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/img/TUI-11.png b/docs/tutorials/tui/img/TUI-11.png
diff --git a/docs/tutorials/tui/img/TUI-12.png b/docs/tutorials/tui/img/TUI-12.png
diff --git a/docs/tutorials/tui/img/TUI-13.png b/docs/tutorials/tui/img/TUI-13.png
diff --git a/docs/tutorials/tui/img/TUI-14.png b/docs/tutorials/tui/img/TUI-14.png
diff --git a/docs/tutorials/tui/img/TUI-15.png b/docs/tutorials/tui/img/TUI-15.png
diff --git a/docs/tutorials/tui/img/TUI-16.png b/docs/tutorials/tui/img/TUI-16.png
diff --git a/docs/tutorials/tui/img/TUI-17.png b/docs/tutorials/tui/img/TUI-17.png
diff --git a/docs/tutorials/tui/img/TUI-18.png b/docs/tutorials/tui/img/TUI-18.png
diff --git a/docs/tutorials/tui/img/TUI-19.png b/docs/tutorials/tui/img/TUI-19.png
diff --git a/docs/tutorials/tui/img/TUI-2.png b/docs/tutorials/tui/img/TUI-2.png
diff --git a/docs/tutorials/tui/img/TUI-20.png b/docs/tutorials/tui/img/TUI-20.png
diff --git a/docs/tutorials/tui/img/TUI-21.png b/docs/tutorials/tui/img/TUI-21.png
diff --git a/docs/tutorials/tui/img/TUI-22.png b/docs/tutorials/tui/img/TUI-22.png
diff --git a/docs/tutorials/tui/img/TUI-23.png b/docs/tutorials/tui/img/TUI-23.png
diff --git a/docs/tutorials/tui/img/TUI-24.png b/docs/tutorials/tui/img/TUI-24.png
diff --git a/docs/tutorials/tui/img/TUI-25.png b/docs/tutorials/tui/img/TUI-25.png
diff --git a/docs/tutorials/tui/img/TUI-26.png b/docs/tutorials/tui/img/TUI-26.png
diff --git a/docs/tutorials/tui/img/TUI-27.png b/docs/tutorials/tui/img/TUI-27.png
diff --git a/docs/tutorials/tui/img/TUI-28.png b/docs/tutorials/tui/img/TUI-28.png
diff --git a/docs/tutorials/tui/img/TUI-29.png b/docs/tutorials/tui/img/TUI-29.png
diff --git a/docs/tutorials/tui/img/TUI-3.png b/docs/tutorials/tui/img/TUI-3.png
diff --git a/docs/tutorials/tui/img/TUI-30.png b/docs/tutorials/tui/img/TUI-30.png
diff --git a/docs/tutorials/tui/img/TUI-31.png b/docs/tutorials/tui/img/TUI-31.png
diff --git a/docs/tutorials/tui/img/TUI-32.png b/docs/tutorials/tui/img/TUI-32.png
diff --git a/docs/tutorials/tui/img/TUI-33.png b/docs/tutorials/tui/img/TUI-33.png
diff --git a/docs/tutorials/tui/img/TUI-34.png b/docs/tutorials/tui/img/TUI-34.png
diff --git a/docs/tutorials/tui/img/TUI-35.png b/docs/tutorials/tui/img/TUI-35.png
diff --git a/docs/tutorials/tui/img/TUI-36.png b/docs/tutorials/tui/img/TUI-36.png
diff --git a/docs/tutorials/tui/img/TUI-37.png b/docs/tutorials/tui/img/TUI-37.png
diff --git a/docs/tutorials/tui/img/TUI-38.png b/docs/tutorials/tui/img/TUI-38.png
diff --git a/docs/tutorials/tui/img/TUI-39.png b/docs/tutorials/tui/img/TUI-39.png
diff --git a/docs/tutorials/tui/img/TUI-4.png b/docs/tutorials/tui/img/TUI-4.png
diff --git a/docs/tutorials/tui/img/TUI-40.png b/docs/tutorials/tui/img/TUI-40.png
diff --git a/docs/tutorials/tui/img/TUI-41.png b/docs/tutorials/tui/img/TUI-41.png
diff --git a/docs/tutorials/tui/img/TUI-42.png b/docs/tutorials/tui/img/TUI-42.png
diff --git a/docs/tutorials/tui/img/TUI-43.png b/docs/tutorials/tui/img/TUI-43.png
diff --git a/docs/tutorials/tui/img/TUI-44.png b/docs/tutorials/tui/img/TUI-44.png
diff --git a/docs/tutorials/tui/img/TUI-45.png b/docs/tutorials/tui/img/TUI-45.png
diff --git a/docs/tutorials/tui/img/TUI-46.png b/docs/tutorials/tui/img/TUI-46.png
diff --git a/docs/tutorials/tui/img/TUI-47.png b/docs/tutorials/tui/img/TUI-47.png
diff --git a/docs/tutorials/tui/img/TUI-48.png b/docs/tutorials/tui/img/TUI-48.png
diff --git a/docs/tutorials/tui/img/TUI-49.png b/docs/tutorials/tui/img/TUI-49.png
diff --git a/docs/tutorials/tui/img/TUI-5.png b/docs/tutorials/tui/img/TUI-5.png
diff --git a/docs/tutorials/tui/img/TUI-6.png b/docs/tutorials/tui/img/TUI-6.png
diff --git a/docs/tutorials/tui/img/TUI-7.png b/docs/tutorials/tui/img/TUI-7.png
diff --git a/docs/tutorials/tui/img/TUI-8.png b/docs/tutorials/tui/img/TUI-8.png
diff --git a/docs/tutorials/tui/img/TUI-9.png b/docs/tutorials/tui/img/TUI-9.png
diff --git a/docs/tutorials/tui/index.md b/docs/tutorials/tui/index.md
@@ -0,0 +1,85 @@
+# Terminal user interface (TUI)
+
+The Dash Platform [Terminal User Interface (TUI)](https://github.com/dashpay/platform-tui) is a
+Rust-based application for interacting with Dash Platform in the terminal. Its purpose is to enable
+users to perform all actions permitted by Dash Platform, which, broadly speaking, means broadcasting
+state transitions and querying the network. The repository can be [cloned from
+GitHub](https://github.com/dashpay/platform-tui) and built according to the instructions found
+there.
+
+## Main screen
+
+This screen is the application's main menu. The interface provides quick navigation options and a summary of essential information.
+
+![Main screen](./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 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)
+
+## 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)
+
+## Strategies
+
+This screen is where you can add, select, import and export [strategies](https://www.dash.org/blog/strategy-tests-usage-guide/).
+
+![Strategies screen](./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.
+
+![Strategy management screen](./img/TUI-13.png)
+
+- "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
+
+### Adding operations to a strategy
+
+If you select "Operations", you will be presented with the following screen.
+
+![Operations screen](./img/TUI-28.png)
+
+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 [screenshot below](#add-strategy-operation)
+- "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.
+
+#### Add strategy operation
+
+![Add strategy screen](./img/TUI-29.png)
+
+## Wallet
+
+This screen lets you see a loaded wallet's information, including wallet type, public key, address, balance and number of UTXOs.
+
+![Wallet screen](./img/TUI-43.png)
+
+This screen also provides options for you to:
+
+- 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)
+
+## Platform information
+
+This screen lets you see information on the epochs and the current version voting
+
+![Platform information screen](./img/TUI-49.png)