From 785e9d634eea2c2c6d775ea6f9e95d72de0e7a84 Mon Sep 17 00:00:00 2001 From: thephez Date: Mon, 15 Jul 2024 14:20:43 -0400 Subject: [PATCH 1/9] docs: remove manual evonode setup These instructions were for Core-only evonodes which are going away with Platform's launch --- docs/user/masternodes/setup-evonode.rst | 196 ++---------------------- 1 file changed, 12 insertions(+), 184 deletions(-) diff --git a/docs/user/masternodes/setup-evonode.rst b/docs/user/masternodes/setup-evonode.rst index eea0f2ebc..f39f57d2c 100644 --- a/docs/user/masternodes/setup-evonode.rst +++ b/docs/user/masternodes/setup-evonode.rst @@ -208,10 +208,13 @@ operator key. Masternode Installation ======================= -The following options are available for installing Dash masternode software: +.. attention:: + + Dash Platform will include multiple services that must be configured properly + for an Evolution masternode to operate correctly. A :ref:`dashmate-based + installation ` is recommended to ensure + your configuration is functional. -- :ref:`Dashmate installation (recommended) ` -- :ref:`Manual installation ` .. _evonode-setup-install-dashmate: @@ -231,13 +234,13 @@ dashmate dependencies:: curl -fsSL https://get.docker.com -o get-docker.sh && sh ./get-docker.sh sudo usermod -aG docker $USER newgrp docker - curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash - source ~/.bashrc - nvm install 20 -Install dashmate:: +Download the dashmate installation package for your CPU architecture from the `GitHub releases page +`__ and install it using apt:: - npm install -g dashmate + wget https://github.com/dashpay/platform/releases/download/v0.25.22/dashmate_0.25.22.b143aee50-1_amd64.deb + sudo apt update + sudo apt install ./dashmate_0.25.22.b143aee50-1_amd64.deb Alternative installation options are available on the :hoverxref:`dashmate page `. @@ -247,140 +250,6 @@ collateral, keys and construct the ProTx transaction required to enable your masternode. -.. _evonode-setup-install-manual: - -Manual installation -------------------- - -.. attention:: - - Dash Platform will include multiple services that must be configured properly - for an Evolution masternode to operate correctly. A :ref:`dashmate-based - installation ` is recommended to ensure - your configuration is functional. - - -Dash Core -^^^^^^^^^ - -To manually download and install the components of your Dash Evolution masternode, -visit the `GitHub releases page `_ and -copy the link to the latest version appropriate for your CPU architecture, -e.g. ``x86_64-linux-gnu``. Go back to your terminal window and enter the following -command, pasting in the address to the latest version of Dash Core by right clicking -or pressing **Ctrl+ V**:: - - cd /tmp - wget https://github.com/dashpay/dash/releases/download/v20.1.1/dashcore-20.1.1-x86_64-linux-gnu.tar.gz - -Verify the authenticity of your download by checking its detached -signature against the public key published by the Dash Core development -team. All releases of Dash are signed using GPG with one of the -following keys: - -- Alexander Block (codablock) with the key ``63A9 6B40 6102 E091``, - `verifiable here on Keybase `__ -- Pasta (pasta) with the key ``5252 7BED ABE8 7984``, `verifiable here - on Keybase `__ - -:: - - curl https://keybase.io/codablock/pgp_keys.asc | gpg --import - curl https://keybase.io/pasta/pgp_keys.asc | gpg --import - wget https://github.com/dashpay/dash/releases/download/v20.1.1/dashcore-20.1.1-x86_64-linux-gnu.tar.gz.asc - gpg --verify dashcore-20.1.1-x86_64-linux-gnu.tar.gz.asc - -Create a working directory for Dash, extract the compressed archive and -copy the necessary files to the directory:: - - mkdir ~/.dashcore - tar xfv dashcore-20.1.1-x86_64-linux-gnu.tar.gz - cp -f dashcore-20.1.1/bin/dashd ~/.dashcore/ - cp -f dashcore-20.1.1/bin/dash-cli ~/.dashcore/ - -Create a configuration file using the following command:: - - nano ~/.dashcore/dash.conf - -An editor window will appear. We now need to create a configuration file -specifying several variables. Copy and paste the following text to get -started, then replace the variables specific to your configuration as -follows:: - - #---- - rpcuser=XXXXXXXXXXXXX - rpcpassword=XXXXXXXXXXXXXXXXXXXXXXXXXXXX - rpcallowip=127.0.0.1 - #---- - listen=1 - server=1 - daemon=1 - #---- - #masternodeblsprivkey= - externalip=XXX.XXX.XXX.XXX - #---- - -Replace the fields marked with ``XXXXXXX`` as follows: - -- ``rpcuser``: enter any string of numbers or letters, no special - characters allowed -- ``rpcpassword``: enter any string of numbers or letters, no special - characters allowed -- ``externalip``: this is the IP address of your VPS - -Leave the ``masternodeblsprivkey`` field commented out for now. The -result should look something like this: - -.. figure:: img/setup-manual-conf.png - :width: 400px - - Entering key data in dash.conf on the masternode - -Press **Ctrl + X** to close the editor and **Y** and **Enter** save the -file. You can now start running Dash on the masternode to begin -synchronization with the blockchain:: - - ~/.dashcore/dashd - -You will see a message reading **Dash Core server starting**. - -Add dashd to crontab to make sure it runs every minute to check on your -masternode:: - - crontab -e - -Choose nano as your editor and enter the following lines at the end of -the file:: - - * * * * * pidof dashd || ~/.dashcore/dashd - -Press enter to make sure there is a blank line at the end of the file, -then press **Ctrl + X** to close the editor and **Y** and **Enter** save -the file. We now need to wait for 15 confirmations of the collateral -transaction to complete, and wait for the blockchain to finish -synchronizing on the masternode. You can use the following commands to -monitor progress:: - - ~/.dashcore/dash-cli mnsync status - -When synchronisation is complete, you should see the following -response:: - - { - "AssetID": 999, - "AssetName": "MASTERNODE_SYNC_FINISHED", - "AssetStartTime": 1558596597, - "Attempt": 0, - "IsBlockchainSynced": true, - "IsSynced": true, - "IsFailed": false - } - -Continue with the :ref:`Registration step ` to setup the -collateral, keys and construct the ProTx transaction required to enable your -masternode. - - .. _register-evonode: Register your masternode @@ -439,8 +308,7 @@ and will cause it to start serving as a masternode when the signed ProRegTx is broadcast by the owner, as we just did above. Take note of your BLS private key and then proceed with the relevant -instructions below based on which :ref:`Software Installation option -` you are using. +instructions below. Dashmate ~~~~~~~~ @@ -470,46 +338,6 @@ from within dashmate. See the dashmate :hoverxref:`node operation documentation ` for details. -Manual -~~~~~~ - -For manual installations, log in to your masternode using ``ssh`` or PuTTY and -edit the configuration file as follows:: - - nano ~/.dashcore/dash.conf - -The editor appears with the existing masternode configuration. Add or -uncomment this lines in the file, replacing the key with your BLS -private key generated above:: - - masternodeblsprivkey=24c1fa3c22c6ea6b1cc68a37be18acb51042b19465fe0a26301c8717bf939805 - -Press enter to make sure there is a blank line at the end of the file, -then press **Ctrl + X** to close the editor and **Y** and **Enter** save -the file. Note that providing a ``masternodeblsprivkey`` enables -masternode mode, which will automatically force the ``txindex=1``, -``peerbloomfilters=1``, and ``prune=0`` settings necessary to provide -masternode service. We now need to restart the masternode for this -change to take effect. Enter the following commands, waiting a few -seconds in between to give Dash Core time to shut down:: - - ~/.dashcore/dash-cli stop - sleep 15 - ~/.dashcore/dashd - -At this point you can monitor your masternode by entering -``~/.dashcore/dash-cli masternode status`` or using the **Refresh status** -function in DMT. The final result should appear as follows: - -.. figure:: img/setup-dash-cli-start.png - :width: 400px - - dash-cli masternode status output showing successfully registered masternode - -At this point you can safely log out of your server by typing ``exit``. -Congratulations! Your masternode is now running. - - .. _evonode-dashcore-protx: .. _register-evonode-dashmate: From 9e5c03c01700cb3f20900be80197cd3d37adcdce Mon Sep 17 00:00:00 2001 From: thephez Date: Mon, 15 Jul 2024 14:22:08 -0400 Subject: [PATCH 2/9] docs: remove details not required when doing DMT or dashmate setup --- docs/user/masternodes/setup-evonode.rst | 186 +----------------------- 1 file changed, 2 insertions(+), 184 deletions(-) diff --git a/docs/user/masternodes/setup-evonode.rst b/docs/user/masternodes/setup-evonode.rst index f39f57d2c..e4ae44c04 100644 --- a/docs/user/masternodes/setup-evonode.rst +++ b/docs/user/masternodes/setup-evonode.rst @@ -415,8 +415,8 @@ Option 3: Registering from Dash Core wallet Tool to register as described in :ref:`Option 1: Registering from a hardware wallet `. -This option can be used without installing any applications other than Dash -Core; however, it requires the most technical skill. +If you prefer managing the collateral and keys using Dash Core, the following sections show how to +generate and retrieve information that may be required by dashmate or the Dash Masternode Tool. .. _evonode-mn-outputs: @@ -468,36 +468,6 @@ the following command:: **These keys are NOT stored by the wallet and must be backed up and kept secure.** -Add the private key to your masternode configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The public key will be used in following steps. The private key must be -entered in the ``dash.conf`` file on the masternode. This allows the -masternode to watch the blockchain for relevant Pro*Tx transactions, and -will cause it to start serving as a masternode when the signed ProRegTx -is broadcast by the owner (final step below). Log in to your masternode -using ``ssh`` or PuTTY and edit the configuration file as follows:: - - nano ~/.dashcore/dash.conf - -The editor appears with the existing masternode configuration. Add or -uncomment this line in the file, replacing the key with your BLS private -key generated above:: - - masternodeblsprivkey=395555d67d884364f9e37e7e1b29536519b74af2e5ff7b62122e62c2fffab35e - -Press enter to make sure there is a blank line at the end of the file, -then press **Ctrl + X** to close the editor and **Y** and **Enter** save -the file. Note that providing a ``masternodeblsprivkey`` enables -masternode mode, which will automatically force the ``txindex=1``, -``peerbloomfilters=1``, and ``prune=0`` settings necessary to provide -masternode service. We now need to restart the masternode for this -change to take effect. Enter the following commands, waiting a few -seconds in between to give Dash Core time to shut down:: - - ~/.dashcore/dash-cli stop - sleep 15 - ~/.dashcore/dashd .. _evonode-generate-platform-node-id: @@ -522,9 +492,6 @@ Alternatively, the following commands can be used generate P2P key, save it to 1e8e241c05ca350c8fe0b8ba4680e7652673dae2 -The platform node ID will be used in following steps. We will now prepare the -transaction used to register the masternode on the network. - .. warning:: **These keys are NOT stored by the wallet and must be backed up and kept @@ -571,152 +538,3 @@ external to the wallet:: yjZVt49WsQd6XSrPVAUGXtJccxviH9ZQpN - -Fee source address -~~~~~~~~~~~~~~~~~~ - -You can also optionally generate and fund another address as the **transaction -fee source** (``feeSourceAddress``). If you selected an external payout address, -you must specify a fee source address. - -Either the payout address or fee source address must have enough balance to pay -the transaction fee, or the ``register_prepare_hpmn`` transaction will fail. - - -Key access -~~~~~~~~~~ - -The private keys to the owner and fee source addresses must exist in the wallet -submitting the transaction to the network. If your wallet is protected by a -password, it must now be unlocked to perform the following commands. Unlock your -wallet for 5 minutes:: - - walletpassphrase yourSecretPassword 300 - - -.. _hmpn-prepare-proregtx: - -Prepare a ProRegTx transaction -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -We will now prepare an unsigned ProRegTx special transaction using the ``protx -register_prepare_hpmn`` command. This command has the following syntax:: - - protx register_prepare_hpmn collateralHash collateralIndex ipAndPort ownerKeyAddr - operatorPubKey votingKeyAddr operatorReward payoutAddress (feeSourceAddress) - -Open a text editor such as notepad to prepare this command. Replace each -argument to the command as follows: - -- ``collateralHash``: The txid of the 4000 Dash collateral funding transaction -- ``collateralIndex``: The output index of the 4000 Dash funding transaction -- ``ipAndPort``: Masternode IP address and port, in the format ``x.x.x.x:yyyy`` -- ``ownerKeyAddr``: The new Dash address generated above for the owner/voting - address -- ``operatorPubKey``: The BLS public key :hoverxref:`generated above - ` (or provided by your hosting service) -- ``votingKeyAddr``: The new Dash address generated above, or the address of a - delegate, used for proposal voting -- ``operatorReward``: The percentage of the block reward allocated to the - operator as payment -- ``payoutAddress``: A new or existing Dash address to receive the owner's - masternode rewards -- ``platformNodeID``: Platform P2P node ID :hoverxref:`generated above - ` -- ``platformP2PPort``: TCP port of Dash Platform peer-to-peer communication - between nodes. Must be 26656 for mainnet. -- ``platformHTTPPort``: TCP port of Platform HTTP/API interface. Must be 443 for - mainnet. -- ``feeSourceAddress``: An (optional) address used to fund ProTx fee. - ``payoutAddress`` will be used if not specified. - -Note that the operator is responsible for :ref:`specifying their own reward -` address in a separate ``update_service`` transaction if -you specify a non-zero ``operatorReward``. The owner of the masternode -collateral does not specify the operator's payout address. - -Example (remove line breaks if copying):: - - protx register_prepare_hpmn - 16347a28f4e5edf39f4dceac60e2327931a25fdee1fb4b94b63eeacf0d5879e3 - 1 - 45.76.230.239:19999 - yfgxFhqrdDG15ZWKJAN6dQvn6dZdgBPAip - 99f20ed1538e28259ff80044982372519a2e6e4cdedb01c96f8f22e755b2b3124fbeebdf6de3587189cf44b3c6e7670e - yfRaZN8c3Erpqj9iKnmQ9QDBeUuRhWV3Mg - 0 - yjZVt49WsQd6XSrPVAUGXtJccxviH9ZQpN - 1e8e241c05ca350c8fe0b8ba4680e7652673dae2 - 26656 - 443 - yR83WsikBaBaNusTnHZf28kAcL8oVmp1TE - -Output:: - - { - "tx": "030001000175c9d23c2710798ef0788e6a4d609460586a20e91a15f2097f56fc6e007c4f8e0000000000feffffff01a1949800000000001976a91434b09363474b14d02739a327fe76e6ea12deecad88ac00000000d1010000000000e379580dcfea3eb6944bfbe1de5fa2317932e260acce4d9ff3ede5f4287a34160100000000000000000000000000ffff2d4ce6ef4e1fd47babdb9092489c82426623299dde76b9c72d9799f20ed1538e28259ff80044982372519a2e6e4cdedb01c96f8f22e755b2b3124fbeebdf6de3587189cf44b3c6e7670ed1935246865dce1accce6c8691c8466bd67ebf1200001976a914fef33f56f709ba6b08d073932f925afedaa3700488acfdb281e134504145b5f8c7bd7b47fd241f3b7ea1f97ebf382249f601a0187f5300", - "collateralAddress": "yjSPYvgUiAQ9AFj5tKFA8thFLoLBUxQERb", - "signMessage": "yjZVt49WsQd6XSrPVAUGXtJccxviH9ZQpN|0|yfgxFhqrdDG15ZWKJAN6dQvn6dZdgBPAip|yfRaZN8c3Erpqj9iKnmQ9QDBeUuRhWV3Mg|ad5f82257bd00a5a1cb5da1a44a6eb8899cf096d3748d68b8ea6d6b10046a28e" - } - -Next we will use the ``collateralAddress`` and ``signMessage`` fields to sign -the transaction, and the output of the ``tx`` field to submit the transaction. - -Sign the ProRegTx transaction -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -We will now sign the content of the ``signMessage`` field using the private key -for the collateral address as specified in ``collateralAddress``. Note that no -internet connection is required for this step, meaning that the wallet can -remain disconnected from the internet in cold storage to sign the message. In -this example we will again use Dash Core, but it is equally possible to use the -signing function of a hardware wallet. The command takes the following syntax:: - - signmessage collateralAddress signMessage - -Example:: - - signmessage yjSPYvgUiAQ9AFj5tKFA8thFLoLBUxQERb yjZVt49WsQd6XSrPVAUGXtJccxviH9ZQpN|0|yfgxFhqrdDG15ZWKJAN6dQvn6dZdgBPAip|yfRaZN8c3Erpqj9iKnmQ9QDBeUuRhWV3Mg|ad5f82257bd00a5a1cb5da1a44a6eb8899cf096d3748d68b8ea6d6b10046a28e - -Output:: - - II8JvEBMj6I3Ws8wqxh0bXVds6Ny+7h5HAQhqmd5r/0lWBCpsxMJHJT3KBcZ23oUZtsa6gjgISf+a8GzJg1BfEg= - - -Submit the signed message -^^^^^^^^^^^^^^^^^^^^^^^^^ - -We will now submit the ProRegTx special transaction to the blockchain to -register the masternode. This command must be sent from a Dash Core wallet -holding a balance on either the ``feeSourceAddress`` or ``payoutAddress``, since -a standard transaction fee is involved. The command takes the following syntax:: - - protx register_submit tx sig - -Where: - -- ``tx``: The serialized transaction previously returned in the ``tx`` output - field from the ``protx register_prepare_hpmn`` command -- ``sig``: The message signed with the collateral key from the ``signmessage`` - command - -Example:: - - protx register_submit 030001000175c9d23c2710798ef0788e6a4d609460586a20e91a15f2097f56fc6e007c4f8e0000000000feffffff01a1949800000000001976a91434b09363474b14d02739a327fe76e6ea12deecad88ac00000000d1010000000000e379580dcfea3eb6944bfbe1de5fa2317932e260acce4d9ff3ede5f4287a34160100000000000000000000000000ffff2d4ce6ef4e1fd47babdb9092489c82426623299dde76b9c72d9799f20ed1538e28259ff80044982372519a2e6e4cdedb01c96f8f22e755b2b3124fbeebdf6de3587189cf44b3c6e7670ed1935246865dce1accce6c8691c8466bd67ebf1200001976a914fef33f56f709ba6b08d073932f925afedaa3700488acfdb281e134504145b5f8c7bd7b47fd241f3b7ea1f97ebf382249f601a0187f5300 II8JvEBMj6I3Ws8wqxh0bXVds6Ny+7h5HAQhqmd5r/0lWBCpsxMJHJT3KBcZ23oUZtsa6gjgISf+a8GzJg1BfEg= - -Output:: - - aba8c22f8992d78fd4ff0c94cb19a5c30e62e7587ee43d5285296a4e6e5af062 - -Your masternode is now registered and will appear on the Deterministic -Masternode List after the transaction is mined to a block. You can view this -list on the **Masternodes** tab of the Dash Core wallet, or -in the console using the command ``protx list valid``, where the txid of the -final ``protx register_submit`` transaction identifies your masternode. - -At this point you can go back to your terminal window and monitor your -masternode by entering ``~/.dashcore/dash-cli masternode status`` or -using the **Refresh status** function in DMT. - -At this point you can safely log out of your server by typing ``exit``. -Congratulations! Your masternode is now running. From e664371a9aff1e15f9ad5feddc0d93bf09db1849 Mon Sep 17 00:00:00 2001 From: thephez Date: Tue, 16 Jul 2024 11:01:39 -0400 Subject: [PATCH 3/9] docs: add callout about payout address --- docs/user/masternodes/setup-evonode.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/user/masternodes/setup-evonode.rst b/docs/user/masternodes/setup-evonode.rst index e4ae44c04..b7e9c8ee2 100644 --- a/docs/user/masternodes/setup-evonode.rst +++ b/docs/user/masternodes/setup-evonode.rst @@ -282,10 +282,18 @@ Click **Apply changes** when these fields have been set. Dash Masternode Tool ready to register a new masternode -Then click **MN actions** and select **Register masternode**. Optionally specify -a different **Payout address** and/or **Operator reward**, then click -**Continue**. Select **Remote Dash RPC Node (automatic method)**. (For details -about using your own local RPC node, see the `Dash Masternode Tool documentation +Then click **MN actions** and select **Register masternode**. Optionally specify a different +**Payout address** and/or **Operator reward**, then click **Continue**. + +.. important:: + + Assigning a payout address from a non-hardware wallet like :ref:`Dash Core + ` is recommended for the initial release of Dash Platform. Currently Dash + Masternode Tool does not support the credit withdraw process that will be used to transfer Dash + Platform rewards. + +Select **Remote Dash RPC Node (automatic method)**. (For details about using your own local RPC +node, see the `Dash Masternode Tool documentation `__.) Confirm the following two messages: From 1da17d8ef6eeb3dc2a9aef64de4d09c9405e445d Mon Sep 17 00:00:00 2001 From: thephez Date: Tue, 16 Jul 2024 11:43:50 -0400 Subject: [PATCH 4/9] docs: add evonode requirements based on dashmate checks Requirements from: https://github.com/dashpay/platform/pull/1914 --- docs/user/masternodes/understanding.rst | 40 +++++++++++++++---------- 1 file changed, 25 insertions(+), 15 deletions(-) diff --git a/docs/user/masternodes/understanding.rst b/docs/user/masternodes/understanding.rst index a0da17bb5..6a8a9de7e 100644 --- a/docs/user/masternodes/understanding.rst +++ b/docs/user/masternodes/understanding.rst @@ -297,11 +297,9 @@ Masternode requirements Arguably the hardest part. Dash can be obtained from exchanges such as Poloniex, Bittrex, Kraken and LiveCoin. Shapeshift's service is also an excellent way. -- A server or VPS running Linux: Most recent guides use Ubuntu 20.04 +- A server or VPS running Linux: Most recent guides use Ubuntu 22.04 LTS. We recommend VPS services such as Vultr and DigitalOcean, - although any decent provider will do. Generally an instance with low - to average specifications will do, although performance requirements - will increase according to this roadmap. + although any decent provider will do. - A dedicated IP address: These usually come with the VPS/server. In addition to the DASH held in collateral, masternodes also have @@ -310,6 +308,9 @@ requirements are as follows: .. _mn-hardware-reqs-table: +Regular masternodes +------------------- + +---------+------------------+------------------+ | | Minimum | Recommended | +=========+==================+==================+ @@ -322,16 +323,25 @@ requirements are as follows: | Network | 750 GB/mth | 1 TB/mth | +---------+------------------+------------------+ -Masternode bandwidth use ranges between 600-900 GB per month and will -grow as the network does. -Dash Evolution --------------- +.. _evonode-hardware-reqs-table: + +Evonodes +-------- + +Evonodes have higher hardware requirements since they host Dash Platform services along with Dash +Core. To support the network effectively, the following requirements are recommended: + ++---------+------------------+ +| | Recommended | ++=========+==================+ +| CPU | 4x 2.4 GHz | ++---------+------------------+ +| RAM | 8 GB + 2 GB swap | ++---------+------------------+ +| Disk | 200 GB | ++---------+------------------+ +| Network | 1 TB/mth | ++---------+------------------+ -The exact hardware requirements for Dash Evolution masternodes have yet -to be determined, although some pointers can be taken from the `roadmap -`_ and this `blog post -`_. -It should be possible to run Dash masternodes on normal VPS servers -until the block size reaches approximately 20 MB, after which custom -hardware such as GPUs and eventually ASICs may be required. +Masternode bandwidth use varies and will grow as the network does. From d35b1a78d8bffb49d26e0868fb2fed1234924776 Mon Sep 17 00:00:00 2001 From: thephez Date: Tue, 16 Jul 2024 11:54:23 -0400 Subject: [PATCH 5/9] docs: minor reword --- docs/user/masternodes/setup-evonode.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user/masternodes/setup-evonode.rst b/docs/user/masternodes/setup-evonode.rst index b7e9c8ee2..11f2b9961 100644 --- a/docs/user/masternodes/setup-evonode.rst +++ b/docs/user/masternodes/setup-evonode.rst @@ -40,8 +40,8 @@ For information about hosted masternodes, see the documentation listed below: - :ref:`Information for users of hosted masternodes ` - :ref:`Information for operators of hosted masternodes ` -This documentation describes the commands as if they were entered in the Dash -Core GUI by opening the console from **Window > Console**, but the same result +This documentation describes the Dash Core commands as if they were entered in +the GUI by opening the console from **Window > Console**, but the same result can be achieved on a masternode by entering the same commands and adding the prefix ``~/.dashcore/dash-cli`` to each command. From 8581e61021bcc8cb6a2f68cfeaa74c5723f88adb Mon Sep 17 00:00:00 2001 From: thephez Date: Tue, 16 Jul 2024 12:12:21 -0400 Subject: [PATCH 6/9] docs: update firewall info --- docs/user/masternodes/server-config.rst | 55 ++++++++++++++++--------- 1 file changed, 35 insertions(+), 20 deletions(-) diff --git a/docs/user/masternodes/server-config.rst b/docs/user/masternodes/server-config.rst index 5bd61ec14..4fdd9ec94 100644 --- a/docs/user/masternodes/server-config.rst +++ b/docs/user/masternodes/server-config.rst @@ -181,28 +181,43 @@ We will now install a firewall (and some other packages we will use later):: (press **Y** and **Enter** to confirm) -Choose the appropriate firewall configuration below based on which network your +Choose the appropriate firewall configuration below based on which network and masternode type your masternode will support: -.. code-block:: none - :caption: Mainnet configuration - - ufw allow ssh/tcp - ufw limit ssh/tcp - ufw allow 9999/tcp - ufw logging on - ufw enable - -.. code-block:: none - :caption: Testnet configuration - - ufw allow ssh/tcp - ufw limit ssh/tcp - ufw allow 19999/tcp - ufw allow 26656/tcp - ufw allow 3000/tcp - ufw logging on - ufw enable +.. tab-set:: + .. tab-item:: Mainnet masternode + + .. code-block:: shell + + ufw allow ssh/tcp + ufw limit ssh/tcp + ufw allow 9999/tcp + ufw logging on + ufw enable + + .. tab-item:: Mainnet evonode + + .. code-block:: shell + + ufw allow ssh/tcp + ufw limit ssh/tcp + ufw allow 443/tcp + ufw allow 9999/tcp + ufw allow 26656/tcp + ufw logging on + ufw enable + + .. tab-item:: Testnet + + .. code-block:: shell + + ufw allow ssh/tcp + ufw limit ssh/tcp + ufw allow 1443/tcp + ufw allow 19999/tcp + ufw allow 36656/tcp + ufw logging on + ufw enable (press **Y** and **Enter** to confirm) From a2e08e7ba62e0653ff0256e4f3f19daf42cf4eb0 Mon Sep 17 00:00:00 2001 From: thephez Date: Tue, 16 Jul 2024 13:58:38 -0400 Subject: [PATCH 7/9] docs: update mn/en table and description --- docs/user/introduction/features.rst | 41 ++++++++++++------------- docs/user/masternodes/understanding.rst | 32 +++++++++---------- 2 files changed, 35 insertions(+), 38 deletions(-) diff --git a/docs/user/introduction/features.rst b/docs/user/introduction/features.rst index 513510521..bfc9df931 100644 --- a/docs/user/introduction/features.rst +++ b/docs/user/introduction/features.rst @@ -59,12 +59,10 @@ Masternodes enable the following services: - **Dash Evolution** will make using cryptocurrency as easy as using PayPal. -Masternode owners must have possession of 1000 DASH, which they prove by -signing a message included in a special transaction written to the -blockchain. The Dash can be moved or spent at any time, but doing so -will cause the masternode to fall out of queue and stop earning rewards. -Masternode users are also given **voting rights** on proposals. Each -masternode has one vote and this vote can be used on budget proposals or +Masternode owners must have possession of 1000 DASH, which they prove by signing a message included +in a special transaction written to the blockchain. The Dash can be moved or spent at any time, but +doing so will cause the masternode to fall out of queue and stop earning rewards. Masternode users +are also given **voting rights** on proposals. Each masternode can vote on budget proposals or important decisions that affect Dash. Masternodes cost money and effort to host so they are paid a percentage @@ -78,22 +76,21 @@ possibility for masternodes to earn money from fees in the future. Evolution Masternodes (evonodes) -------------------------------- -Evolution Masternodes (evonodes) are a subset of Masternodes that have -been created to host the Dash Platform. An evonode is a lot like Masternodes -with these differences: - -+----------------+-----------------------------------+-----------------------------------------------------+ -| | Masternode | Evolution Masternode | -+================+===================================+=====================================================+ -| Collateral | 1000 DASH | 4000 DASH (4X the collateral for normal masternodes)| -+----------------+-----------------------------------+-----------------------------------------------------+ -| Specs | Lesser than evonodes | Higher than normal masternodes | -+----------------+-----------------------------------+-----------------------------------------------------+ -| Service | Only Dash Core | Both Dash Core and Platform | -+----------------+-----------------------------------+-----------------------------------------------------+ -| Voting Weight | 1 node gets 1 vote | Has 4 times the voting power of a normal masternode | -+----------------+-----------------------------------+-----------------------------------------------------+ - +Evolution Masternodes (evonodes) are a subset of masternodes that have been created to host Dash +Platform. Evonodes are similar to regular masternodes, but have these differences: + ++----------------+-----------------------------------+--------------------------------+ +| | Masternode | Evolution Masternode | ++================+===================================+================================+ +| Collateral | 1000 DASH | 4000 DASH | ++----------------+-----------------------------------+--------------------------------+ +| Service(s) | Only Dash Core | Both Dash Core and Platform | ++----------------+-----------------------------------+--------------------------------+ +| Voting Weight | 1 (collateral amount / 1000) | 4 (collateral amount / 1000) | ++----------------+-----------------------------------+--------------------------------+ + +Evonodes also have :ref:`higher hardware requirements ` +than regular masternodes due to the additional Dash Platform services they host. .. _coinjoin: diff --git a/docs/user/masternodes/understanding.rst b/docs/user/masternodes/understanding.rst index 6a8a9de7e..fb0bd1cc7 100644 --- a/docs/user/masternodes/understanding.rst +++ b/docs/user/masternodes/understanding.rst @@ -87,21 +87,21 @@ statistics on the masternode network. Evolution Masternodes (evonodes) -------------------------------- -Evolution Masternodes (evonodes) are a subset of masternodes that have -been created to host Dash Platform. An evonode is a lot like a regular masternode -with the following differences: - -+----------------+-----------------------------------+-----------------------------------------------------+ -| | Masternode | Evonode | -+================+===================================+=====================================================+ -| Collateral | 1000 DASH | 4000 DASH (4X the collateral for normal masternodes)| -+----------------+-----------------------------------+-----------------------------------------------------+ -| Specs | Lesser than evonode | Higher than normal masternodes | -+----------------+-----------------------------------+-----------------------------------------------------+ -| Service | Only Dash Core | Both Dash Core and Platform | -+----------------+-----------------------------------+-----------------------------------------------------+ -| Voting Weight | 1 node gets 1 vote | Has 4 times the voting power of a normal masternode | -+----------------+-----------------------------------+-----------------------------------------------------+ +Evolution Masternodes (evonodes) are a subset of masternodes that have been created to host Dash +Platform. Evonodes are similar to regular masternodes, but have these differences: + ++----------------+-----------------------------------+--------------------------------+ +| | Masternode | Evolution Masternode | ++================+===================================+================================+ +| Collateral | 1000 DASH | 4000 DASH | ++----------------+-----------------------------------+--------------------------------+ +| Service(s) | Only Dash Core | Both Dash Core and Platform | ++----------------+-----------------------------------+--------------------------------+ +| Voting Weight | 1 (collateral amount / 1000) | 4 (collateral amount / 1000) | ++----------------+-----------------------------------+--------------------------------+ + +Evonodes also have :hoverxref:`higher hardware requirements ` +than regular masternodes due to the additional Dash Platform services they host. .. _mn-concepts: @@ -293,7 +293,7 @@ described above. Masternode requirements ======================= -- DASH collateral: Hosting a master node requires a large amount of DASH collateral. +- DASH collateral: Hosting a masternode requires a large amount of DASH collateral. Arguably the hardest part. Dash can be obtained from exchanges such as Poloniex, Bittrex, Kraken and LiveCoin. Shapeshift's service is also an excellent way. From 92641d5367a04b059622c1887e727474ec3e2c70 Mon Sep 17 00:00:00 2001 From: thephez Date: Tue, 16 Jul 2024 14:29:44 -0400 Subject: [PATCH 8/9] docs: add warning and minimize core collateral storage by default --- docs/user/masternodes/setup-evonode.rst | 72 ++++++++++++++----------- 1 file changed, 40 insertions(+), 32 deletions(-) diff --git a/docs/user/masternodes/setup-evonode.rst b/docs/user/masternodes/setup-evonode.rst index 11f2b9961..d19010ef8 100644 --- a/docs/user/masternodes/setup-evonode.rst +++ b/docs/user/masternodes/setup-evonode.rst @@ -163,44 +163,52 @@ Leave DMT open and continue with the next step: :ref:`Software Installation Option 2: Holding collateral in Dash Core wallet ------------------------------------------------ -Open Dash Core wallet and wait for it to synchronize with the network. It should -look like this when ready: +.. attention:: -.. figure:: img/setup-collateral-dashcore.png - :width: 400px + Storing your collateral in a Dash Core wallet is **not** recommended. :ref:`Using a hardware + wallet ` is **highly recommended** to enhance security and + protect yourself against hacking. Only proceed with using Dash Core if you understand the risks. - Fully synchronized Dash Core wallet +.. dropdown:: Dash Core collateral instructions -Click **Window > Console** to open the console. Type the following command into -the console to generate a new Dash address for the collateral:: + Open Dash Core wallet and wait for it to synchronize with the network. It should + look like this when ready: - getnewaddress - yiFfzbwiN9oneftd7cEfr3kQLRwQ4kp7ue - -Take note of the collateral address, since we will need it later. The next step -is to secure your wallet (if you have not already done so). First, encrypt the -wallet by selecting **Settings > Encrypt wallet**. You should use a strong, new -password that you have never used somewhere else. Take note of your password and -store it somewhere safe or you will be permanently locked out of your wallet and -lose access to your funds. Next, back up your wallet file by selecting **File > -Backup Wallet**. Save the file to a secure location physically separate to your -computer, since this will be the only way you can access our funds if anything -happens to your computer. For more details on these steps, see :ref:`here -`. - -Now send exactly 4000 DASH in a single transaction to the new address you -generated in the previous step. This may be sent from another wallet, or from -funds already held in your current wallet. Once the transaction is complete, -view the transaction in a `blockchain explorer -`_ by searching for the address. You -will need 15 confirmations before you can register the masternode, but you can -continue with the next step at this point already: generating your masternode -operator key. + .. figure:: img/setup-collateral-dashcore.png + :width: 400px -.. figure:: img/setup-collateral-blocks.png - :width: 400px + Fully synchronized Dash Core wallet + + Click **Window > Console** to open the console. Type the following command into + the console to generate a new Dash address for the collateral:: + + getnewaddress + yiFfzbwiN9oneftd7cEfr3kQLRwQ4kp7ue + + Take note of the collateral address, since we will need it later. The next step + is to secure your wallet (if you have not already done so). First, encrypt the + wallet by selecting **Settings > Encrypt wallet**. You should use a strong, new + password that you have never used somewhere else. Take note of your password and + store it somewhere safe or you will be permanently locked out of your wallet and + lose access to your funds. Next, back up your wallet file by selecting **File > + Backup Wallet**. Save the file to a secure location physically separate to your + computer, since this will be the only way you can access our funds if anything + happens to your computer. For more details on these steps, see :ref:`here + `. + + Now send exactly 4000 DASH in a single transaction to the new address you + generated in the previous step. This may be sent from another wallet, or from + funds already held in your current wallet. Once the transaction is complete, + view the transaction in a `blockchain explorer + `_ by searching for the address. You + will need 15 confirmations before you can register the masternode, but you can + continue with the next step at this point already: generating your masternode + operator key. + + .. figure:: img/setup-collateral-blocks.png + :width: 400px - Trezor blockchain explorer showing 15 confirmations for collateral transfer + Trezor blockchain explorer showing 15 confirmations for collateral transfer .. _evonode-setup-install: From b7583191b8d570b8802e628a5bc5aa86827c1dc8 Mon Sep 17 00:00:00 2001 From: thephez Date: Tue, 16 Jul 2024 14:47:23 -0400 Subject: [PATCH 9/9] docs: minor cleanup --- docs/user/masternodes/setup-evonode.rst | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/user/masternodes/setup-evonode.rst b/docs/user/masternodes/setup-evonode.rst index d19010ef8..95c507d35 100644 --- a/docs/user/masternodes/setup-evonode.rst +++ b/docs/user/masternodes/setup-evonode.rst @@ -216,12 +216,9 @@ Option 2: Holding collateral in Dash Core wallet Masternode Installation ======================= -.. attention:: - - Dash Platform will include multiple services that must be configured properly - for an Evolution masternode to operate correctly. A :ref:`dashmate-based - installation ` is recommended to ensure - your configuration is functional. +Dash Platform will include multiple services that must be configured properly for an Evolution +masternode to operate correctly. A :ref:`dashmate-based installation +` is recommended to ensure your configuration is functional. .. _evonode-setup-install-dashmate: @@ -296,9 +293,9 @@ Then click **MN actions** and select **Register masternode**. Optionally specify .. important:: Assigning a payout address from a non-hardware wallet like :ref:`Dash Core - ` is recommended for the initial release of Dash Platform. Currently Dash - Masternode Tool does not support the credit withdraw process that will be used to transfer Dash - Platform rewards. + ` is recommended for the initial release of Dash Platform. Currently, the + Dash Masternode Tool does not support the credit withdraw process that will be used to transfer + Dash Platform rewards. Select **Remote Dash RPC Node (automatic method)**. (For details about using your own local RPC node, see the `Dash Masternode Tool documentation