STRATIS MASTERNODE. Windows Installation Guide

Size: px

Start display at page:

Download "STRATIS MASTERNODE. Windows Installation Guide"

Gary Bond
6 years ago
Views:

1 STRATIS MASTERNODE Windows Installation Guide

2 Table of Contents 1. Introduction Pre-Requisites... 5 i..net Core i. Downloading the installer... 5 ii. Run the.net Core SDK Installer... 5 ii. Tor Expert Bundle... 7 i. Download Tor... 7 iii. Stratis QT Wallet... 9 i. Download... 9 ii. Launch QT Wallet iv. Bitcoin Core i. Download ii. Install iii. Run Bitcoin Core v. Git i. Download ii. Install Install and Configure Stratis Masternode i. Clone BreezeProject ii. Configure Bitcoin Core configuration i. Server ii. Prune iii. Rpcuser iv. Rpcpassword iii. Bitcoin Core Configuration Summary iv. Configure Stratis QT configuration i. Server ii. Rpcuser iii. Rpcpassword v. Stratis QT Configuration Summary vi. Configure the Stratis Masternode vii. Breeze Server configuration i. network ii. rpc.user Page 2

3 iii. rpc.password iv. rpc.url v. tumbler.ecdsakeyaddress viii. Breeze.conf Summary ix. Server.config i. rpc.url ii. rpc.user iii. rpc.password iv. tumbler.fee v. cycle vi. tor.enabled=true vii. tor.server viii. tor.cookiefile x. Server.config Summary Running the Stratis Masternode i. Open Stratis QT Wallet ii. Running the Stratis MasterNode (Registration Phase) iii. Activating the Stratis Masternode i. Step ii. Step iii. Step Page 3

4 1. Introduction This document details the steps required to configure and run a Stratis Masternode. All installation steps have been carried out on a vanilla Window Server 2012 Virtual Machine hosted within Azure. It is recommended that you follow this guide on a vanilla platform. To progress through this document there is a requirement for you to have 250,000 STRAT available for collateral. The high STRATIS requirement is not something that is dictated by Stratis Group Ltd, it is dictated by the technology. The Stratis Masternode operates in a totally decentralized and trustless manner, meaning that no one can steal the funds trusted to the network. Additionally, the STRAT required to operate a node can be stored on a Ledger Wallet or on offline backup. The BTC in reserves will need to be in a wallet on the node, as it is required to sign the transactions when processing the tumbler transactions. Rewards to the operators will be paid in the form of a transaction fee paid by Breeze Privacy Protocol client users directly to the operator that processes their Privacy Protocol transaction. Depending on the operator s jurisdiction there may be legal and tax related specific requirements and/or restrictions. It is highly recommend all operators seek proper advice before operating a Stratis Masternode. This is a decentralized network that is not managed, controlled or administered by Stratis. Page 4

5 2. Pre-Requisites There are a number of applications that need to be installed prior to embarking on configuring the Stratis Masternode. The following section will provide details on where to obtain the installers and how to install the products. i..net Core 2.0.NET Core is the platform that the Stratis Masternode has been developed upon. Therefore, you will need to install the.net Core SDK or newer. i. Downloading the installer Links to the installers can be found below. Select the appropriate link to download.net Core SDK. ii. Run the.net Core SDK Installer After launching the installer, you will be presented with the following window. Select Install to progress with the installation. Page 5

6 Click the Close button to continue. Page 6

7 ii. Tor Expert Bundle Tor is an acronym for The Onion Router and is a free piece of software that enables anonymous communication on the internet. i. Download Tor Navigate to the below URL to download the Tor Expert Bundle ZIP archive. Once downloaded, open the ZIP archive and view the contents, as per the below screenshot. Page 7

8 Extract the contents of the ZIP archive to a location on the local disk of the desktop or server you are using. For this document the contents have been extracted to a folder on the desktop named Tor Important: This location is referenced later in this document, therefore, it is recommended you follow the same steps and store the Tor Expert Bundle on your desktop within the Tor folder. Page 8

9 iii. Stratis QT Wallet The Stratis QT Wallet is a forked instance of the Bitcoin Core Wallet, it serves as an interim staking wallet until the Stratis Full Node is ready for mainnet. i. Download Navigate to the below URL to download the Stratis QT Wallet. Once downloaded, open the ZIP archive and view the contents as per the below screenshot. Page 9

10 Extract the stratis-qt executable from the ZIP archive to a location on the local disk of the desktop or server you are using. For this document the contents have been extracted directly to the desktop. Important: This location is referenced later in this document, therefore, it is recommended you follow the same steps and store the Stratis-QT executbale on the desktop. ii. Launch QT Wallet Double-Click on the stratis-qt executable. You may receive a security warning, click the Run button to continue. Page 10

11 The wallet is now running; however, it needs to fully synchronize with the Stratis Blockchain, this can take some time. Progress is visible at the bottom of the application. You can continue through this document without the Stratis QT Wallet being fully synchronized, however, you will be unable to launch the Masternode until synchronization is complete. Page 11

12 The synchronization completion will be evident by the red (out of sync) text being no longer visible.. Page 12

13 iv. Bitcoin Core The Bitcoin Core wallet is required as it will be leveraged by the Stratis Masternode. When executing the privacy protocol, the transactions will be processed via the Bitcoin Core Wallet. i. Download Navigate to the appropriate URL below to download the Bitcoin Core Wallet. 32-bit Installer 64-bit Installer ii. Install Once downloaded, run the setup. Click the Next button to continue. Page 13

14 Click the Next button to continue. Click the Next button to continue. Page 14

15 The below dialog confirms that the installation has been successful. Page 15

16 Ensure that the checkbox is selected for Run Bitcoin Core and click the Finish button. Page 16

17 iii. Run Bitcoin Core Upon first running the Bitcoin Core Wallet, you are prompted as to where you would like to store the blockchain. Ensure Use the default data directory is selected and click the Ok button to continue. Do not be concerned by the warning of free space, later in the guide you will configure pruning that will reduce the storage requirement. Important: The data directory is referenced later in this document. It is recommended that you leave the value as default. Page 17

18 The Bitcoin Core Wallet is now running and synchronizing with the blockchain. You can continue through this document without the Bitcoin Core Wallet being fully synchronized, however, the Stratis Masternode will not be functional until synchronization has fully completed. This can take some time. Page 18

v. Git Git is required to clone the Stratis BreezeServer repository from GitHub. i. Download Click the below URL to download the Git Installer. https://github.

19 v. Git Git is required to clone the Stratis BreezeServer repository from GitHub. i. Download Click the below URL to download the Git Installer. ii. Install Once downloaded, run the Setup. Click the Next button to continue. Page 19

20 Click the Next button to continue. Click the Next button to continue. Page 20

21 Click the Next button to continue. Click the Next button to continue. Page 21

22 Click the Next button to continue. Click the Next button to continue. Page 22

23 Click the Next button to continue. Click the Next button to continue. Page 23

24 Click the Next button to continue. The installation is now in progress, wait for the progress bar to complete. Page 24

25 The installation process is now complete, click the Finish button to complete the installation. Page 25

26 3. Install and Configure Stratis Masternode You will now focus on obtaining the required code to run a Stratis Masternode, in addition, you will cover all the required configuration changes that are necessary to have a fully functional Stratis Masternode. i. Clone BreezeProject Executing the below PowerShell script-block will download the code and submodules required to run the Stratis Masternode. #Set Destination Directory $Path = "$env:userprofile\desktop\masternode" #Query Destination Directory and Create if not present. if (-Not (Get-Item -Path $Path)) { New-Item -ItemType Directory -Path $Path } #Move to Destination Directory Set-Location $Path #Obtain Code git clone " --recursive #Move to BreezeProject Directory Set-Location.\BreezeProject #Restore Dependencies dotnet restore Page 26

27 ii. Configure Bitcoin Core configuration Changes are required in the Bitcoin Core configuration for the Stratis Masternode to successfully communicate with it. Run the below PowerShell script-block to create a new bitcoin.conf configuration file and open it within Notepad. New-Item -Path $env:appdata\bitcoin\bitcoin.conf -ItemType File -Force Start-Process notepad -ArgumentList "$env:appdata\bitcoin\bitcoin.conf" The Bitcoin.conf file will now be open within a new instance of Notepad. There are a few lines that are required to be added, these are detailed below. i. Server This setting instructs the Bitcoin Core client to accept JSON-RPC commands via the Stratis Masternode. You need to set the value of this parameter to 1. Example: server=1 ii. Prune The Prune parameter defines how many blocks should be retained, this reduces storage requirements. It is recommended that this value is set to Example: prune=2000 iii. Rpcuser This determines the username portion of the Stratis daemon's RPC credentials. The Masternode connects to the daemon via RPC during the initial registration process Important: Please take note of the value entered here, this will be required later in this document when you configure the Masternode. Example: rpcuser=bitcoinuser iv. Rpcpassword The value should be a unique password for the user account provided in the rpc.user parameter. Set your unique password as the value. Important: Please take note of the value entered here, this will be required later on in this document when you configure the Masternode Example: rpcpassword=password Page 27

28 iii. Bitcoin Core Configuration Summary After completing the previous steps, you should now have a bitcoin.conf configuration with the following detail. server=1 prune=2000 rpcuser=bitcoinuser rpcpassword=password Your configuration should not match the above, your rpcuser and rpcpassword should be unique to you. Once you have confirmed the content, please save the file and close it. iv. Configure Stratis QT configuration In a similar manner to the Bitcoin Core changes you just made, changes are required in the Stratis QT Wallet configuration in order for the Stratis Masternode to successfully communicate with it. Run the below PowerShell script-block to create a new stratis.conf configuration file and open it within Notepad. New-Item -Path $env:appdata\stratis\stratis.conf -ItemType File -Force Start-Process notepad -ArgumentList "$env:appdata\stratis\stratis.conf" The stratis.conf file will now be open within a new instance of Notepad. There are a few lines that are required to be added, these are detailed below. i. Server This setting instructs the Stratis QT client to accept JSON-RPC commands via the Stratis Masternode. You need to set the value of this parameter to 1. Example: server=1 ii. Rpcuser This determines the username portion of the Stratis daemon's RPC credentials. The Masternode connects to the daemon via RPC during the initial registration process Important: Please take note of the value entered here, this will be required later in this document when you configure the Masternode. Example: rpcuser=stratisuser Page 28

29 iii. Rpcpassword The value should be a unique password for the user account provided in the rpc.user parameter. Set your unique password as the value. Important: Please take note of the value entered here, this will be required later on in this document when you configure the Masternode. Example: rpcpassword=password v. Stratis QT Configuration Summary After completing the previous steps, you should now have a stratis.conf Configuration with the following detail. server=1 rpcuser=stratisuser rpcpassword=password Your configuration should not match the above, your rpcuser and rpcpassword should be unique to you. Once you have confirmed the content, please save the file and close it. Page 29

30 vi. Configure the Stratis Masternode You can now begin to configure the individual components that make up the Stratis Masternode, this includes settings values for parameters for both BreezeServer and the NTumbleBitServer. vii. Breeze Server configuration You now need to create a configuration file for the BreezeServer, instructing which network to run on, which credentials to use to communicate with the Stratis QT Wallet and which port etc. Run the below PowerShell script-block to create a configuration file and open it within Notepad. New-Item -Path $env:appdata\breezeserver\breeze.conf -ItemType File -Force Start-Process notepad -ArgumentList "$env:appdata\breezeserver\breeze.conf" As previously done for both the Bitcoin Core configuration and the Stratis Wallet configuration, you need to include a number of parameters. These are detailed below. i. network This parameter defines what network the Masternode will operate on. For the purpose of this guide, you will be running on mainnet. Example: network=main ii. rpc.user This determines the username portion of the Stratis daemon's RPC credentials. The Masternode connects to the daemon via RPC during the initial registration process. Enter the same rpcuser that was entered for the stratis.conf Example: rpc.user=stratisuser iii. rpc.password The value should be a unique password for the user account provided in the rpc.user parameter. Enter the same rpcpassword that was entered for the stratis.conf Example: rpc.password=password iv. rpc.url This determines the IP address and port of the Stratis daemon's RPC interface. For additional security the port should be firewalled to prevent external access Set the parameter as the example below. Example: rpc.url= Page 30

31 v. tumbler.ecdsakeyaddress This determines the address that will be used to store the 250,000 STRAT collateral. For the Stratis Masternode registration process, the Stratis Masternode needs temporary access to the private key of the selected address. The key is used to sign the registration transaction to prove that the server owns the address in question. Once the registration is done the Stratis Masternode does not need further access to the private key unless the server needs to be re-registered. Also note that the 250,000 STRAT collateral does not need to be sent to the address yet, this is covered later in the guide. When first launching the Stratis Masternode, it enters a registration phase, this process advertises your Stratis Masternode to the Stratis Blockchain, however, the protocol still needs to validate that you have the 250,000 collateral before allowing your service to be utilized by users of the Breeze Wallet with Breeze Privacy Protocol client. More information regarding this process will be detailed later in the guide once the configuration is completed. Enter your address as the value of the parameter. Example: tumbler.ecdsakeyaddress=stratwalletaddress viii. Breeze.conf Summary After completing the previous steps, you will have a unique configuration file that resembles the below. network=main rpc.user=stratisuser rpc.password=password rpc.url= tumbler.ecdsakeyaddress=stratwalletaddress This completes the Breeze.conf configuration changes. Page 31

32 ix. Server.config You now need to create the NTumbleBitServer configuration, again, execute the below PowerShell script-block to create and open the configuration file. New-Item -Path $env:appdata\ntumblebitserver\main\server.config -ItemType File -Force Start-Process notepad -ArgumentList "$env:appdata\ntumblebitserver\main\server.config" As with the other configuration files, the critical parameters can be found below. i. rpc.url This determines the IP address and port of the Bitcoin daemon's RPC interface. For additional security the port should be firewalled to prevent external access Set the below parameter and value. Example: rpc.url= ii. rpc.user This determines the username portion of the Bitcoin daemon's RPC credentials. The Masternode connects to the daemon via RPC during the initial registration process Enter the same rpcuser value that was used in the bitcoin.conf Example: rpc.user=bitcoinuser iii. rpc.password The value should be a unique password for the user account provided in the rpc.user parameter. Enter the same rpcpassword that was entered for the bitcoin.conf Example: rpc.password=password iv. tumbler.fee This is a BTC value that determines the fee that will be imposed on users utilizing your Masternode instance, it is recommended that this value remains at This has been intentionally set low due to this being a beta release. Set the below parameter and value. Example: tumbler.fee= v. cycle To enhance the privacy provided by the protocol, it is necessary for all participants to use standard transaction amounts enforced by the Stratis Masternode. The cycle definitions have distinct names and lengths. Currently only the kotori cycle is usable on mainnet. Set the below parameter and value. Example: cycle=shorty2x Page 32

33 vi. tor.enabled=true This parameter enables Tor. Tor provides privacy to the user by routing their request through multiple intermediate nodes. This secure connectivity layer is used by the Stratis Masternode to allow clients to safely connect to it. This setting must be set to true. Set the below parameter and value. Example: tor.enabled=true vii. tor.server Tor provides privacy to the user by routing their request through multiple intermediate nodes. This secure connectivity layer is used by the Stratis Masternode to allow clients to safely connect to it. This setting must be set to true. Set the below parameter and value. Example: tor.server= :9051 viii. tor.cookiefile This parameter defines the path as to where the authentication cookie for Tor resides, by default, this will reside in the following directory: C:\Users\%USERNAME%\AppData\Roaming\Tor\control_auth_cookie Please replace the %USERNAME% value with your logged-on user, if in doubt, you can enter the below PowerShell script-block into a new PowerShell window to return the value. Write-Host "$env:appdata\tor\control_auth_cookie" Example: tor.cookiefile= C:\Users\TestVM\AppData\Roaming\Tor\control_auth_cookie x. Server.config Summary After completing the previous steps, you will now have a unique configuration file that resembles the below. rpc.url= rpc.user=bitcoinuser rpc.password=password tumbler.fee= cycle=shorty2x tor.enabled=true tor.server= :9051 tor.cookiefile= C:\Users\TestVM\AppData\Roaming\Tor\control_auth_cookie Page 33

4. Running the Stratis Masternode The configuration phase is now complete, you can now launch the Stratis Masternode and make it available to the network.

34 4. Running the Stratis Masternode The configuration phase is now complete, you can now launch the Stratis Masternode and make it available to the network. By this point, it is assumed that your Stratis QT Wallet has fully synchronied with the Stratis Blockchain. This is key as a small transaction will be made from this wallet to advertise the Stratis Masternode to the network. i. Open Stratis QT Wallet Execute the below PowerShell script-block to stop any existing Stratis-QT processes and re-launch the Stratis QT Wallet with the newly defined parameters you configured earlier in the guide. if (Get-Process -Name stratis-qt) { Stop-Process -Name stratis-qt -Force } Start-Process $env:userprofile\desktop\stratis-qt.exe The Stratis QT Wallet will now launch, navigate to the Receive menu. Highlight the address and click the Copy Address button. It is recommended to deposit 0.1 STRAT into this wallet as it will be utilized to perform the registration transaction upon launching the Stratis Masternode for the first time. Please leave the Stratis QT Wallet running in the background for the meanwhile. Important: Once the transaction has been confirmed and is spendable within the wallet, you can continue to the next step. Page 34

$.." -ForegroundColor Yellow if (-Not (Get-Process -Name tor)) { Start-Process $env:userprofile\desktop\tor\tor\tor.$

35 ii. Running the Stratis MasterNode (Registration Phase) To ensure consistency, it is advised that you launch the node via a script. The PowerShell script-block provided below is based upon all the steps followed in the document. #Launch Tor Write-Host "Checking for existing Tor Process..." -ForegroundColor Yellow if (-Not (Get-Process -Name tor)) { Start-Process $env:userprofile\desktop\tor\tor\tor.exe -ArgumentList "-controlport cookieauthentication 1" } #Check for Bitcoin Core Process Write-Host "Checking for existing Bitcoin Process..." -ForegroundColor Yellow if (-Not (Get-Process -Name bitcoin-qt)) { Start-Process $env:programfiles\bitcoin\bitcoin-qt.exe } #Wait 10 Seconds Write-Host "Waiting 30 Seconds before launching Stratis Masternode..." -ForegroundColor Yellow Start-Sleep 30 #Launch Stratis Masternode Write-Host "Launching Stratis Masternode" -ForegroundColor Cyan Set-Location $env:userprofile\desktop\masternode\breezeproject\breeze.breezeserver dotnet.exe run Open up PowerShell ISE and copy the above script-block into it. Save the script by selecting File > Save As and save it to an easily accessible location, in this example it has been saved it to the Desktop. Page 35

When running, be sure to accept any Security Warning dialogs by clicking the Run button to continue.

36 You can now run the Stratis Masternode by right-clicking the newly created PowerShell script named Run Stratis Masternode.PS1 You may receive the following prompt upon running the PowerShell script. Type Y and hit Enter to continue. When running, be sure to accept any Security Warning dialogs by clicking the Run button to continue. When the Stratis Masternode is run for the first time, it enters a registration mode, this process involves advertising your Stratis Masternode to the Stratis Blockchain. To do this, a number of small transactions ( STRAT) will be made from the Stratis QT Wallet you have running. This completes the registration phase. You should expect an output similar to the below. Page 36

37 iii. Activating the Stratis Masternode You are now running a Stratis Masternode, it has advertised itself to the network and is discoverable by users of the Breeze Privacy Protocol client, however, it requires activation. Earlier in this document, it was detailed that you create a new address to hold your 250,000 STRAT as collateral. Now the registration process is complete, the Breeze Clients with Breeze Privacy Protocol will monitor that address for a deposit of 250,000 STRAT. It will only monitor 30 Blocks from the moment it registered meaning the transaction must occur within approximately 30 minutes. If this is not done, the registration process will need to be repeated. To complete the activation process, you will need to send 250,000 (or more) STRAT to the address that was configured in the breeze.conf. Once that transaction has been confirmed, your Stratis Masternode will be activated and functional for users of the Breeze Privacy Protocol Client. i. Step 1 Confirm the address specified in the breeze.conf. In this guide, the example used was the value STRATWALLETADDRESS ii. Step 2 Perform a transaction of 250,000 or more to the address referenced in the breeze.conf. In this guide the example used was the value STRATWALLETADDRESS iii. Step 3 You will now have an activated Stratis Masternode and will receive your processing fees in the Bitcoin Core Wallet. Page 37

MASTERNODE Setup Guide

MASTERNODE Setup Guide Version 1.0 February 2018 Page 1 / 13 Table of Contents Table of Contents... 2 Linux Setup... 3 Prerequisites... 3 Updates and dependencies... 3 Building the wallet... 4 Starting