From 6db6443dbcf5994ad1f5ab60ebb020cdb300a734 Mon Sep 17 00:00:00 2001 From: pauldelucia Date: Tue, 29 Oct 2024 12:35:46 +0700 Subject: [PATCH 1/5] Update README.md --- README.md | 213 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 213 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..f9d9bfb3e --- /dev/null +++ b/README.md @@ -0,0 +1,213 @@ +# Dash Evo Tool + +**Dash Evo Tool** is a user interface for interacting with Dash Evolution. The current version enables the following actions: + +- Registering a DPNS username +- Viewing active DPNS username contests +- Voting on active DPNS username contests +- Decoding and viewing state transitions + +The tool supports both Mainnet and Testnet networks. + +## Table of Contents + +- [Prerequisites](#prerequisites) + - [Rust Installation](#rust-installation) + - [Dash Core Wallet Setup](#dash-core-wallet-setup) +- [Installation](#installation) +- [Getting Started](#getting-started) + - [Start the App](#start-the-app) + - [Connect to a Network](#connect-to-a-network) +- [Usage](#usage) + - [Register a DPNS Username](#register-a-dpns-username) + - [Vote on an Active DPNS Contest](#vote-on-an-active-dpns-contest) + - [View Decoded State Transition](#view-decoded-state-transition) +- [Switching Networks](#switching-networks) +- [Contributing](#contributing) +- [License](#license) +- [Support](#support) +- [Security Note](#security-note) + +## Prerequisites + +Before you begin, ensure you have met the following requirements: + +### Rust Installation + +- **Rust**: Install Rust using [rustup](https://rustup.rs/): + + <<< + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh + <<< + +- Update Rust to the latest version: + + <<< + rustup update + <<< + +### Dash Core Wallet Setup + +- **Dash Core Wallet**: Download and install from [dash.org/wallets](https://www.dash.org/wallets/). + +- **Synchronize Wallet**: Ensure the wallet is fully synced with the network you intend to use (Mainnet or Testnet). + +## Installation + +To install Dash Evo Tool: + +1. **Clone the repository**: + + <<< + git clone https://github.com/dashpay/dash-evo-tool.git + <<< + +2. **Navigate to the project directory**: + + <<< + cd dash-evo-tool + <<< + +3. **Build the project**: + + <<< + cargo build --release + <<< + + The executable will be in the `target/release` directory. + +## Getting Started + +### Start the App + +Run the application using: + +<<< +cargo run +<<< + +### Connect to a Network + +1. **Open Network Chooser**: In the app, navigate to the **Network Chooser** screen. + +2. **Select Network**: Choose **Mainnet** or **Testnet**. + +3. **Start Connection**: Click **Start** next to the selected network. + + - If Dash Core Wallet is running and synced, the status will show **Online**. + - If not, the app attempts to start Dash Core Wallet automatically. + +## Usage + +### Register a DPNS Username + +1. **Load User Identity**: + + - Go to the **Identity** screen. + - Click **Load Identity** at the top right. + - Fill in your user identity details: + - **Identity ID** (Hex or Base58) + - **Identity Type** should be "User" + - **Alias** (optional alias for use within Dash Evo Tool) + - **Private Keys** (only the authentication key that will be used to register the name is required for registering a username. Other keys can be added later.) + - Click **Submit**. + +2. **Register Username**: + + - Navigate to the **DPNS** screen. + - Click **Register Username** at the top right. + - Select the Identity you'd like to register the username for. + - Enter your desired username. + - Click **Register Name** + +### Vote on an Active DPNS Contest + +1. **Load HPMN Identity**: + + - Go to the **Identity** screen. + - Fill in your Masternode or HPMN (High Performance Masternode) identity details: + - For **Testnet**, you can click "Fill Random HPMN" or "Fill Random Masternode". + - For **Mainnet**, ensure you have valid Masternode or HPMN credentials. + - Click **Submit**. + +2. **Vote on Contest**: + + - Navigate to the **DPNS** screen. + - If no contests appear, click **Refresh**. If still no contests appear, there are probably no active contests. + - Locate the active contest you wish to vote on. + - Click the button for the option you'd like to vote for within the contest's row (Lock, Abstain, or an Identity ID). + - Choose the Masternode or HPMN identity to vote with or select **All** to vote with all loaded Masternodes and HPMNs. + - Confirm your vote. + +### View Decoded State Transition + +1. **Open State Transition Viewer**: + + - Navigate to the **State Transition Viewer** screen. + +2. **Decode State Transition**: + + - Paste a hex or base58 encoded state transition into the input box at the top. + - View the decoded details displayed below. + +## Switching Networks + +1. **Open Network Chooser**: + + - Go to the **Network Chooser** screen. + +2. **Select Network**: + + - Choose the network you'd like to interact with (**Mainnet** or **Testnet**). + +3. **Check Wallet Status**: + + - If Dash Core Wallet is already running on that network, the status column will show **Online**. + - If not, click **Start** to launch Dash Core Wallet on the selected network. + +4. **Wait for Sync**: + + - Ensure Dash Core Wallet is fully synchronized before proceeding. + +## Contributing + +Contributions are welcome! + +- **Fork the Repository**: Click the **Fork** button on the GitHub repository page. + +- **Create a Branch**: + + <<< + git checkout -b feature/YourFeatureName + <<< + +- **Commit Changes**: Make your changes and commit them with descriptive messages. + + <<< + git commit -m "Add feature: YourFeatureName" + <<< + +- **Push to Branch**: + + <<< + git push origin feature/YourFeatureName + <<< + +- **Submit Pull Request**: Open a pull request on GitHub and describe your changes. + +- **Follow Guidelines**: Please ensure your code adheres to the project's coding standards and passes all tests. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. + +## Support + +For assistance: + +- **Issues**: Open an issue on [GitHub Issues](https://github.com/dashpay/dash-evo-tool/issues). +- **Community**: Join the Dash community forums or Discord server for discussions. + +## Security Note + +Keep your private keys and identity information secure. Do not share them with untrusted parties or applications. From 21c23553003fdbc4c53acc98cbe618ea32404c1a Mon Sep 17 00:00:00 2001 From: pauldelucia Date: Tue, 29 Oct 2024 12:38:09 +0700 Subject: [PATCH 2/5] fix --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index f9d9bfb3e..5740ec447 100644 --- a/README.md +++ b/README.md @@ -36,15 +36,15 @@ Before you begin, ensure you have met the following requirements: - **Rust**: Install Rust using [rustup](https://rustup.rs/): - <<< + ``` curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh - <<< + ``` - Update Rust to the latest version: - <<< + ``` rustup update - <<< + ``` ### Dash Core Wallet Setup @@ -58,21 +58,21 @@ To install Dash Evo Tool: 1. **Clone the repository**: - <<< + ``` git clone https://github.com/dashpay/dash-evo-tool.git - <<< + ``` 2. **Navigate to the project directory**: - <<< + ``` cd dash-evo-tool - <<< + ``` 3. **Build the project**: - <<< + ``` cargo build --release - <<< + ``` The executable will be in the `target/release` directory. @@ -82,9 +82,9 @@ To install Dash Evo Tool: Run the application using: -<<< +``` cargo run -<<< +``` ### Connect to a Network @@ -177,21 +177,21 @@ Contributions are welcome! - **Create a Branch**: - <<< + ``` git checkout -b feature/YourFeatureName - <<< + ``` - **Commit Changes**: Make your changes and commit them with descriptive messages. - <<< + ``` git commit -m "Add feature: YourFeatureName" - <<< + ``` - **Push to Branch**: - <<< + ``` git push origin feature/YourFeatureName - <<< + ``` - **Submit Pull Request**: Open a pull request on GitHub and describe your changes. From 155c8905b7179fa22fb4f2cba04ad5c2e319e2d8 Mon Sep 17 00:00:00 2001 From: pauldelucia Date: Tue, 29 Oct 2024 12:41:44 +0700 Subject: [PATCH 3/5] fix --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 5740ec447..65efdb73c 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,10 @@ To install Dash Evo Tool: ## Getting Started +### Create `.env` File + +Create a new file in the root of the dash-evo-tool directory named `.env` and copy the contents of `.env.example` into it. No changes to the file are necessary in this version. + ### Start the App Run the application using: From 920dfdd73265a31e17274cc31da9d91dcf3b1fe3 Mon Sep 17 00:00:00 2001 From: pauldelucia Date: Tue, 29 Oct 2024 12:44:10 +0700 Subject: [PATCH 4/5] fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 65efdb73c..9f4e7d72d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Dash Evo Tool -**Dash Evo Tool** is a user interface for interacting with Dash Evolution. The current version enables the following actions: +**Dash Evo Tool** is a graphical user interface for easily interacting with Dash Evolution. The current version enables the following actions: - Registering a DPNS username - Viewing active DPNS username contests From ba1a9c4f998d163204ff02ee39ab9198f810a626 Mon Sep 17 00:00:00 2001 From: pauldelucia Date: Tue, 29 Oct 2024 12:45:45 +0700 Subject: [PATCH 5/5] fix --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 9f4e7d72d..c9452327f 100644 --- a/README.md +++ b/README.md @@ -74,8 +74,6 @@ To install Dash Evo Tool: cargo build --release ``` - The executable will be in the `target/release` directory. - ## Getting Started ### Create `.env` File