Tool for managing Dash masternodes with a hardware wallet (Trezor, Keepkey, Ledger Nano S)
Clone or download

README.md

Dash Masternode Tool (DMT)

Contents

Masternodes

Dash masternodes are full nodes which are incentivized by receiving a share of the block reward as payment in return for the tasks they perform for the network, of which the most important include participation in InstantSend and PrivateSend transactions. In order to run a masternode, apart from setting up a server which runs the software, you must dedicate 1000 Dash as collateral, which is "tied up" in your node as long as you want it to be considered a masternode by the network. It is worth mentioning that the private key controlling the funds can (and for security reasons, should) be kept separately from the masternode server itself.

A server with the Dash daemon software installed will operate as a Dash full node, but before the rest of the network accepts it as a legitimate masternode, one more thing must happen: the person controlling the node must prove that they are also in control of the private key to the node's 1000 Dash collateral. This is achieved by sending a special message to the network (start masternode message), signed by this private key.

This action can be carried out using the Dash Core reference software client. As can be expected, this requires sending 1000 Dash to an address controlled by the Dash Core wallet. After the recent increase in the value of Dash and a burst in the amount of malware distributed over the Internet, you do not have to be paranoid to conclude that keeping large amounts of funds in a software wallet is not the most secure option. For these reasons, it is highly recommended to use a hardware wallet for this purpose.

Dash Masternode Tool

The main purpose of the application is to give masternode operators (MNOs) the ability to send the start masternode command through an easy to use a graphical user interface if the masternode collateral is controlled by a hardware wallet such as Trezor, KeepKey or Ledger.

Feature list

  • Sending the start masternode command if the collateral is controlled by a hardware wallet
  • Transferring masternode earnings safely, without touching the 1000 Dash funding transaction
  • Signing messages with a hardware wallet
  • Voting on proposals
  • Initialization/recovery of hardware wallets seeds
  • Updating of hardware wallets firmware (Trezor/KeepKey)
  • Support for Dash Testnet

Supported hardware wallets

  • Trezor (model One and T)
  • KeepKey
  • Ledger Nano S

Most of the application features are accessible from the main program window:
Main window

Configuration

Setting up the hardware wallet type

  • Click the Configure button.
  • Select the Miscellaneous tab in the configuration dialog that appears.
  • Depending on the type of your hardware wallet, select the Trezor, KeepKey or Ledger Nano S option.
    Configuration window

Connection setup

Most of the application features involve exchanging data between the application itself and the Dash network. To do this, DMT needs to connect to one of the full nodes on the network, specifically one which can handle JSON-RPC requests. This node plays the role of a gateway for DMT to the Dash network. It does not matter which full node node provides the service, because all nodes reach consensus by synchronizing information between each other on the Dash network.

Depending on your preferences (and skills) you can choose one of three possible connection types:

Masternode setup

Here we make the following assumptions:

  • You already have a server running the Dash daemon software (dashd) that you want to use as a masternode. If you don't, you will need to install and configure one first by following the guide on the Dash Wiki.
  • We occasionally refer to the dashd configuration file, so it is assumed that dashd is running under a Linux operating system (OS), which is the most popular and recommended OS for this purpose.
  • Your server has a public IP address that will be visible on the Internet.
  • You have set up a TCP port on which your dashd listens for incoming connections (usually 9999).

Further configuration steps depend on whether you already have a masternode controlled by Dash Core which you want to migrate to a hardware wallet managed by DMT, or if you are setting up a new masternode.

Scenario A - moving masternode management from Dash Core
Scenario B - configuration of a new masternode

Command line parameters

The application currently supports the following command-line parameters:

  • --data-dir: a path to a directory in which the application will create all the needed files, such as: configuration file, cache and log files; it can be useful for users who want to avoid leaving any of the application files on the computer - which by default are created in the user's home directory - and insted to keep them on an external drive
  • --config: a non-standard path to a configuration file. Example: DashMasternodeTool.exe --config=C:\dmt-configs\config1.ini

Features

Starting a masternode

Once you set up the Dash daemon and perform the required DMT configuration, you need to broadcast the start masternode message to the Dash network, so the other Dash nodes recognize your daemon as a masternode and add it to the payment queue.

To do this, click the Start Masternode using Hardware wallet button.

Sequence of actions

This section describes the steps taken by the application while starting the masternode, and possible errors that may occur during the process.

The steps are as follows:

  1. Verification that all the required fields are filled with correct values. These fields are: IP, port, MN private key, Collateral, Collateral TX ID and TX index. An example message in case of errors:
    Invalid collateral transaction id

  2. Opening a connection to the Dash network and verifying if the Dash daemon to which it is connected is not still waiting for synchronization to complete. Message in case of failure:
    Dash daemon synchronizing

  3. Verification that the masternode status is not already ENABLED or PRE_ENABLED. If it is, the following warning appears:
    Warning: masternode state is enabled
    If your masternode is running and you decide to send a start masternode message anyway, your masternode's payment queue position will be reset.

  4. Opening a connection to the hardware wallet. Message in case of failure:
    Cannot find Trezor device

  5. If the BIP32 path value is empty, DMT uses the collateral address to read the BIP32 path from the hardware wallet.

  6. Retrieving the Dash address from the hardware wallet for the BIP32 path specified in the configuration. If it differs from the collateral address provided in the configuration, the following warning appears:
    Dash address mismatch
    The most common reason for this error is mistyping the hardware wallet passphrase. Remember that different passphrases result in different Dash addresses for the same BIP32 path.

  7. Verification that the specified transaction ID exists, points to your collateral address, is unspent and is equal to exactly 1000 Dash. Messages in case of failure:
    Could not find the specified transaction id
    Collateral transaction output should equal 1000 Dash
    If you decide to continue anyway, you probably won't be able to successfully start your masternode.

  8. Verification at the Dash network level that the specified transaction ID is valid. Message in case of failure:
    Masternode broadcast message decode failed

  9. After completing all pre-verification, the application will ask you whether you want to continue:
    Press OK to broadcast transaction
    This is the last chance to stop the process.

  10. Sending the start masternode message. Success returns the following message:
    Successfully relayed broadcast message
    In case of failure, the message text may vary, depending on the nature of the problem. Example:
    Failed to start masternode

Transferring masternode earnings

DMT version 0.9.4 and above allows you to transfer your masternode earnings. Unlike other Dash wallets, DMT gives you a 100% control over which unspent transaction outputs (utxo) you want to transfer. This has the same effect as the Coin control functionality implemented in the Dash Core wallet.

The Transfer funds window shows all UTXOs of the currently selected Masternode (mode 1), all Masternodes in current configuration (mode 2) or any address controlled by a hardware wallet (mode 3). All UTXOs not used as collateral are initially selected. All collateral UTXOs (1000 Dash) are initially hidden to avoid unintentionally spending collateral funds and thus breaking MN. You can show these hidden entries by unchecking the Hide collateral utxos option.

To show the Transfer funds window, click the Tools menu. Then, from the popup menu choose:

  • Transfer funds from current Masternode's address (mode 1)
  • Transfer funds from all Masternodes addresses (mode 2)
  • Transfer funds from any address (mode 3)

The same you can achieve by clicking of the three buttons from the right side of the app's toolbar: Transfer masternode funds window

Transferring funds from masternode collateral addresses (mode 2):
Transfer masternode funds window

Transferring funds from any address controlled by a hardware wallet, using BIP32 path as an input (mode 3):
Transfer funds from any address window

and using wallet account as an input (mode 3):
Transfer funds from any address window

Important: rows with a red font in the Confirmations column and a gray background are related to so-called coinbase transactions, that don't have the required number of confirmations to forward them. You should restrain from sending them and wait for them to receive at least 100 confirmations.

To send funds, select all UTXOs you wish to include in your transaction, enter the details of the recipient(s), verify the transaction fee and click the Prepare Transaction button on the bottom: Broadcast signed transaction confirmation

After signing the transaction with your hardware wallet, the application will display a summary and will ask you for confirmation for broadcasting the signed transaction to the Dash network.
Broadcast signed transaction confirmation

After clicking Send Transaction, the application broadcasts the transaction and then shows a confirmation with a transaction ID as a hyperlink directing to a Dash block explorer:
Transaction sent

Signing messages with a hardware wallet

To sign a message with your hardware wallet, click the Tools button and then select the Sign message with HW for current Masternode's address menu item. The Sign message window appears:
Sign message window

Changing hardware wallet PIN/passphrase

Click the Tools button and select the Hardware wallet PIN/Passphrase configuration item. The following window will appear to guide you through the steps of changing the PIN/passphrase:
Hardware wallet setup window

Downloads

This application is written in Python 3, but requires several additional libraries to run. These libraries in turn require the installation of a C++ compiler. All in all, compiling DMT from source is not trivial for non-technical people, especially the steps carried out under Linux (though this will be documented soon).

For this reason, in addition to providing the source code on GitHub, binary versions for all three major operating systems - macOS, Windows (32 and 64-bit) and Linux - are available for download directly. The binaries are compiled and tested under the following OS distributions:

  • Windows 7 64-bit
  • macOS 10.13.2 High Sierra
  • Linux Debian Jessie

Binary versions of the latest release can be downloaded from: https://github.com/Bertrand256/dash-masternode-tool/releases/latest.

Verification of the application binary files

Beginning with version 0.9.15, each binary file forming part of a release has a corresponding signature file that you can use to verify the authenticity of the downloaded binary file (to ensure it has not been corrupted or replaced with a counterfeit) and confirm that it has been signed by the application author (Keybase user: bertrand256).

The verification method described below is based on use of the Keybase application, so if you have not already done so, download the installer from https://keybase.io/download and install the app.

Verification steps

  1. Open your OS command line terminal

  2. Change the current directory to the folder where the DMT release files were downloaded:

    cd /Users/<username>/dmt-dist

    After invoking the list directory command (ls for Mac/Linux, dir for Windows ) you should see both the archived executable (.tar.gz, .zip) and the corresponding signature file (.asc):

    <username>: ls
    DashMasternodeTool_0.9.15.mac.zip    DashMasternodeTool_0.9.15.mac.zip.asc
    
  3. Verify the signature by executing the following command:

    keybase pgp verify -d DashMasternodeTool_0.9.15.mac.zip.asc -i DashMasternodeTool_0.9.15.mac.zip -S bertrand256
    

    You should see something similar to the following if verification was successful:

    ▶ INFO Identifying bertrand256
    ✔ public key fingerprint: 8044 DCB5 D241 349F 815F 9522 0D8F 46CA A62F 7EFD
    ฿  bitcoin 1BkMySjL6K72LWX82SVVmgCuZCuZ3DfuxS
    ฿  zcash t1byMTzteuJ8n1XUwxBzYXXV8qVv5kh3bFn
    ✔ "bertrand256" on reddit: https://www.reddit.com/r/KeybaseProofs/comments/688799/my_keybase_proof_redditbertrand256/ [cached 2018-01-19 10:27:37 CET]
    ✔ "bertrand256" on github: https://gist.github.com/781be961e33042c68d617782b0060844 [cached 2018-01-19 10:27:37 CET]
    Signature verified. Signed by bertrand256 1 hour ago (2018-01-19 11:46:05 +0100 CET).
    PGP Fingerprint: 8044dcb5d241349f815f95220d8f46caa62f7efd.