QBundle Installation and User Guide

Download and save the installation folder

  • The installation folder is located here:  QBundle Software on GitHub.
  • GitHub is a software development platform and hosts the files needed for installation. Future releases will be located here as well.
  • Download and save the latest release. As of the writing, the latest release is version 2.5.0.
  • When asked what you want to do with the folder, choose “save”.
  • Locate the saved file in your downloads. A common location is C: Users/”user name”/downloads.
  • Move the file to a permanent location.  (C:Burstcoin or C:QBundle are good choices)

Image showing the latest release section on the Burstcoin github page
Image showing a download dialog box for download the Burstcoin installation files

Extract the installation files 

  • Select the zipped QBundle folder and extract (unzip) the contents using the “Extract all” button. 
  • After the unzipped version appears, you can delete the zipped folder, but this is not necessary.

Install the software

  • Launch setup by opening the unzipped installation folder and double clicking on the following file: Name: BurstWallet Type: Application.
  • Proceed through the warnings related to protecting your computer by clicking on “More Info”, followed by “Run Anyway”.

Download missing components

  • The installation utility will check for portable Java and the BRS wallet.
  • Verify that the check box for “allow connection to remote resources for verifications and updates” is checked.
  • Click on “Download missing components”
  • Several windows will appear as each component is downloaded and extracted.  There may be several minutes between processes where your computer may seem inactive.  Do not interrupt the process.  The components are as follows:  Portable Java, BRS – Core Wallet, and Chromium Pocket Browser. 
  • When all of the components have downloaded. Click on “Continue”.
  • Setup will complete and a new wallet will be displayed showing “Wallet is stopped”.

Change database to Portable MariaDB

  • Select “Database” from the wallet’s top menu and select “Change Database”.
  • Select the radio button next to “Portable MariaDB” and Click “Next”.
  • Click “Yes” when asked if you want to download and install MariaDB.
  • After installation is complete, select “Database” from the top menu and verify that “No Copy” is selected.
  • Click “Save and close”.

Java settings

  • Select “edit” from the top menu.  The “settings” window will appear.
  • Select “Java” in the left menu bar. Verify that the radio button for “Use Portable java” is selected.
  • Save and exit.

Populate the database

  • Select “Database” from the top menu bar.
  • Select “Bootstrap Chain”.
  • In “Settings”, verify that “Cryptoguru repository” is selected.
  • Click “Start Import”.
  • You will receive a notice that all existing data in your database will be erased.
  • Click “Yes” to continue.
  • Synchronization will begin. Wait for it to complete.  Current block time will appear in orange while synchronizing, and green when compete.

Create a new account and passphrase

  • Please note: Before proceeding, it is important to fully understand the security features of Burstcoin passphrases. Review Securing your Burstcoin.
  • Click on “New? Create Your Account”.
  • A 12 word passphrase will be generated.  This is the only opportunity that you will have to modify this passphrase.  It is not necessary but additional characters or numbers can be added.  Do not make modifications without consulting this article:  “Securing your Burstcoin“.  Never shorten the passphrase or change the random words provided.
  • Record the passphrase on paper, including any modifications that you have made.  Click “Next”.
  • Type the passphrase, exactly as you have recorded it in the verification box.
  • Click “Next” to open wallet.
  • Record the account number from the top left corner. Account numbers are alphanumeric and have five segments starting with “BURST”.
  • Click on “Wallet” and then on “Stop Wallet”.
  • Restart wallet by clicking on “Wallet” and “Start Wallet”.
  • Test your passphrase.  Clicking on “Returning user?” and enter your passphrase.  Click on the arrow to the right.
  • The account number displayed should match your account number.  If it does, you have successfully completed setup.  If it does not, you have entered your passphrase incorrectly and should try again.
  • Please note: An Incorrect passphrase will generate a new account number.  If this occurs, simply close the wallet and try again.

Install additional QBundle applications

Blago’s Miner

Blago’s miner (modified by Quibus and JohnnyFFM) is the default mining software packaged with QBundle. It can be used for pool mining or for solo mining.

Please note: If solo mining, running a fully synchronized local wallet is required. The passphrase for the mining account associated with your plot files must be provided and will be stored in plain text in QBundle/BlagoMiner/miner.conf. If desired, you can create an account specifically for mining rather than using a single wallet for both mining and maintaining significant balances.

 

  • To install, click on “File” and then “Application Manager”.
  • Place a check mark in the box next to “Blago’s Miner”.
  • Click on “Install/Update”
  • After the software downloads and extracts, verify that an extracted (unzipped) folder with the name “BlagoMiner” is located in the main QBundle folder. If the file does not appear, locate it a sub folder of the zipped version and copy it into the main folder (same level as zipped version) as the final installation step.
  • Open the miner by clicking “Tools” and the “Miner”. The following screen will appear.

All settings provided in the interface shown above will be passed to the miner.conf file. This file is located in the Qbundle/BlagoMiner folder. Users can edit this file directly.

  • If you will be solo mining, click on the “solo mining” radio button.
  • If you will be pool mining, click on “Select predefined pool”. Required configuration data will be populated automatically. If your desired pool is not listed, obtain the configuration information directly from the pool operator and enter it manually (mining server, update server, info server, deadline limit, and port information).
  • Set the deadline limit. Calculators for this purpose are provided by each pool. If your calculated deadline (based on your available plot size) exceeds your pool’s maximum deadline, this limit should be reduced to the maximum accepted by the pool.

Optional setup:

“Use HDD wakeup” – a script will run which prevents your hard drives from entering sleep mode. “Show winner information” – the account which forges each block will be displayed in the miner console. The info server does not support HTTPS so the address of the local wallet (localhost or 127.0.0.1) and port number 8125 should be provided. “Use multithreading” – Multithreading may improve usage of CPU resources when calculating deadlines.

  • Add your plotfile paths to “My Plotfiles” by clicking on “Import Plotfiles” and locating each plotfile or folder containing plotfiles. The miner will use all plot files that are found in configured folders. It is best if the folders used only contain individual plot files. Plotfiles that are removed using the “Remove Plotfiles” button are not
    deleted from storage, only their path in the list of plot files is removed.
  • To start the miner, click on the “Start mining” button.

When the miner is running, pool and plot file information is displayed in the mining console. The miner receives mining information (block height, base target, etc.) and reads through the configured plot files to locate deadlines. Deadlines found are sent to the pool if they are less than or equal to the configured deadline limit. The miner displays “Confirmed DL” if the deadline is accepted by the pool. After all plot files have been read, the miner displays the amount of time taken to read the plot files.

The miner logs are stored in QBundle/BlagoMiner/Logs. These are useful for debugging purposes. The best deadline found for each block is stored in  QBundle/BlagoMiner/stat.csv.

When the miner is running, the console window will appears as follows:

All settings provided in the interface shown above will be passed to the miner.conf file. This file is located in the Qbundle/BlagoMiner folder. Users can edit this file directly.

  • If you will be solo mining, click on the “solo mining” radio button.
  • If you will be pool mining, click on “Select predefined pool”. Required configuration data will be populated automatically. If your desired pool is not listed, obtain the configuration information directly from the pool operator and enter it manually (mining server, update server, info server, deadline limit, and port information).
  • Set the deadline limit. Calculators for this purpose are provided by each pool. If your calculated deadline (based on your available plot size) exceeds your pool’s maximum deadline, this limit should be reduced to the maximum accepted by the pool.

Optional setup:

“Use HDD wakeup” – a script will run which prevents your hard drives from entering sleep mode. “Show winner information” – the account which forges each block will be displayed in the miner console. The info server does not support HTTPS so the address of the local wallet (localhost or 127.0.0.1) and port number 8125 should be provided. “Use multithreading” – Multithreading may improve usage of CPU resources when calculating deadlines.

  • Add your plotfile paths to “My Plotfiles” by clicking on “Import Plotfiles” and locating each plotfile or folder containing plotfiles. The miner will use all plot files that are found in configured folders. It is best if the folders used only contain individual plot files. Plotfiles that are removed using the “Remove Plotfiles” button are not
    deleted from storage, only their path in the list of plot files is removed.
  • To start the miner, click on the “Start mining” button.

When the miner is running, pool and plot file information is displayed in the mining console. The miner receives mining information (block height, base target, etc.) and reads through the configured plot files to locate deadlines. Deadlines found are sent to the pool if they are less than or equal to the configured deadline limit. The miner displays “Confirmed DL” if the deadline is accepted by the pool. After all plot files have been read, the miner displays the amount of time taken to read the plot files.

The miner logs are stored in QBundle/BlagoMiner/Logs. These are useful for debugging purposes. The best deadline found for each block is stored in  QBundle/BlagoMiner/stat.csv.

When the miner is running, the console window will appears as follows:

Xplotter

Plotting is the process of pre-computing hash functions and saving them onto storage units (HDDs). XPlotter is included with QBundle and no additional installation is required. There are however options that need to be configured.

  • Click on Tools: Plotting: Plotter
  • Add any plotfiles that you already have. Use the “Import Plotfile” button.
  • Provide the following information in “Basic settings” before starting the plotter:

Location for saving plot files

Numeric account ID to be associated with the generated plots. Click the selector to the right of the form field to select from a list of accounts. If you enter the ID number manually, be absolutely sure that it is entered correctly. If not, your plot files will be unusable. Be sure that no trailing spaces are included, particularly if you use a copy and paste function to enter the ID.

  • Set plot file size using the slider. For easier maintenance, limit plot size to 1 or 2 Terra bytes.

Adding files to “My Plotfiles” and clicking on “Start plotting” will allow the miner to begin using the plots as soon as a scoop has been plotted, it is not necessary to wait until the entire plot file is complete.

Advanced settings for Xplotter allow the user to:

  • Set the start nonce of the new plot file. If all existing plots have been imported (recommended) the plotter will continue plotting using the number after the highest existing nonce. Leaving gaps between nonces does not improve mining. If no plot file has been created, the plotter will start with a nonce number of 0.
  • Set the number of CPU threads to be used.
  • Set the amount of memory to be used.
  • For Plot type, use PoC2 (mandatory). Do not use POC1 as it is no longer supported.
  • After all settings have been submitted, click “Start Plotting”.

Vanity address generator

The vanity address generator is a tool for creating vanity or branded Burst account addresses. All address must have “BURST” for the first five leading characters. The capital letter “i” (I), the capital letter “o” (O), zero (0), and the number one (1) are not permitted. To generate a vanity address, enter characters into the form provided. Set the resources that should be used (number of CPU threads) and desired length of the passphrase.

The algorithm which seeks for the account with the desired string is a brute force algorithm, which checks every Burst account and passphrase combination sequentially. The time it takes to find a particular string increases significantly with every additional character. A string of 5 characters at the end takes approximately 4 minutes (more or less depending on computer resources). Each additional character increases the time required exponentially. A string of 8 would take approximately one hour. Longer strings could take weeks.

Image showing the fields in the Burstcoin vanity address generator

Dynamic plotting

Dynamic plotting creates and deletes plot files automatically while allowing for normal usage of a hard drive. It will check every minute for space pressure. A limited but dynamic amount of space on the hard drive is reserved for normal usage. A user can set specify the amount to be reserved. If users often move or create files that are large, they should set a greater amount of space to be reserved.

Image showing the fields for dynamic plotting using the Burstcoin wallet integrated plotting software included with QBundle

Paperburst

The Paperburst tool can be used to generate a new wallet or to use an existing wallet. In order to use the tool, provide information as shown:

After all required fields of the form have been populated, clicking the desired button. The paper wallet is output as an easily printable .pdf file.

Paper wallets can be used to transfer funds using public keys, to store funds (the funds are still on the blockchain rather than on the paper). Paperburst can be used as a reference document for cold storage.

Image showing the Burstcoin paper wallet generator integrated with QBundle
Image of a Burstcoin paper wallet

Plot converter

Johnny’s POC1 -> POC2 converter is a tool for converting POC1 plot files into POC2 plot files. New users will not need to use this tool. The POC1 to POC2 conversion completed at block height 502000. POC1 plot are no longer supported for mining. Users who have existing POC1 plots can use them for mining if they use a POC2 compliant miner which can perform on-the-fly conversion. Read speeds will be 50% slower using POC1. Plots that are being converted must be temporarily excluded from mining. Usage of the plot converter is straightforward: First, select plot files for conversion and then click on “Start conversion”. Note: The application will not allow plot files of other types to be added to the conversion queue.

Users can perform inline conversion, which does not require additional free space, or can save the converted plot file to a new location. To save to a new location, use the “Output Folder” setting. Once the “Start conversion” has been activated, stopping the conversion process may lead to damaged plots which cannot be repaired. Many miners have chosen to re plot their drives for POC2 rather than use the conversion process.

 

Image showing the fields for configuring the POC1 to POC2 Burstcoin plot converter