|Credits||Feyd, Umbrellacorp03, Dan Dares, decrescedo|
- 1 Description
- 2 Initial installation guide
- 3 Frequently Asked Questions (FAQ)
- 3.1 What is Wallet Mode?
- 3.2 How is QBundle software updated?
- 3.3 How can I view logs for Burst Reference Software (BRS)?
- 3.4 How do I change the QBundle settings?
- 3.5 How can I resolve connection problems?
- 3.6 Where is the information about my account stored?
- 3.7 What other tools are included with QBundle?
The easiest choice for beginners using Windows is to download Qbundle. QBundle is a convenient launcher which installs the BRS local wallet, plotting software, and mining software with a few clicks.
Initial installation guide
This page is a guide for downloading and installing QBundle. After downloading the installation files, return here to complete the installation. Sets of instructions are grouped logically, with reference images of installation screens immediately following each section. Images may vary from the actual installation screens depending on your version of Windows and internet browser.
The QBundle installation files are located here: https://www.burst-coin.org/download-wallet . Try to open this link in a new browser tab if possible. After following this link:
- Select your operating system: (Please note: If your operating system is not Windows, QBundle will not be available and you will need to choose an option specific to your operating system.)
- Select Qbundle to be redirected to the PoC Consortium GitHub site. 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, identified by a green indicator. As of the writing of this guide, the latest release is Version 2.5.0. The installation file is QBundle2.5.0_final.zip. (Make a note of the saved location)
- Locate the saved file. A common location is C: Users/"user name"/Downloads. You may move this file to another location if you wish.
- Extract the included files using Windows "Extract all" button if available. If you do not have this functionality, you may need a utility to "unzip" the folder.
- Launch the setup of QBundle by clicking on the extracted version of the following file. Name: BurstWallet Type: Application.
- Proceed through Windows warnings related to protecting your computer by clicking on "More Info" followed by "Run Anyway".
- The installation utility will check for portable Java and the BRS wallet.
- Click on "Download missing components"
- The check box for "allow connection to remote resources for verifications and updates" should be checked.
- Several windows will appear as each component and is downloaded and extracted.
- When all of the components have downloaded. Click on "continue".
- Setup will complete and a new wallet will be displayed showing a status of "stopped".
- Click on "Database" on the wallet's top menu bar 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, click "Database" on the wallets to menu bar, verify that "No Copy" is selected.
- Click "Save and close".
- Change Java settings by clicking on "edit" in the top menu bar. Select "settings". The settings window will appear.
- Select "Java" in the left menu bar. Verify that the radio button for "Use Portable java" is selected. Save your change and exit.
- Please note: the next few steps (marked H2 only) are not relevant for wallets running MariaDB. These step should only be followed for installations retaining the native H2 database.
- H2 Only: Populate the database by downloading a "bootstrap" copy containing blocks from the genesis block through the time that the bootstrap file was created. More recent blocks will be added using the regular peer to peer synchronization process.
- H2 Only: To begin the bootstrap process, click on "database" in the top menu bar.
- H2 Only: Select "Database": Select "Bootstrap Chain".
- H2 Only: In "Settings", verify that "Cryptoguru repository (H2) is selected.
- H2 Only: Click "Start Import". You will receive a notice that all existing data in your database will be erased.
- H2 Only: Click "Yes" to continue.
- The new wallet will immediately begin synchronizing from peers. Block time will appear in orange while syncing and green when fully synchronized. It is not necessary to wait for full synchronization. This may take many hours depending on bandwidth and the speed of your computer.
- If you are a new user and do not yet have an account, you will need to create passphrase. Click on "New? Create Your Account"
- A 12 word passphrase will be generated for you. Write this passphrase on paper for now. You can store this passphrase more securely later. Click "Next".
- Type the 12 word passphrase that you wrote down into the verification box that appears. Click "Next".
- If the wallet opens, you have successfully completed the setup process.
- Click on "Wallet" and then click on "Stop Wallet".
- When the wallet shows a status of "Stopped", click on "Wallet" and then click on "Start Wallet".
- Test your passphrase a 2nd time by typing it into the passphrase box and clicking the arrow to the right of the box.
Frequently Asked Questions (FAQ)
What is Wallet Mode?
There are two ways users can run the BRS wallet. Wallet Mode loads the complete interface allowing users to issue transactions and see blocks as they are forged on the network. Launcher mode opens a minimal interface and can only be accessed through a browser.
How is QBundle software updated?
The application manager lists applications delivered with QBundle that are available for installation, as well as those that are installed on the system, together with version information. Users are notified of available updates when they are available for these applications through the Application Manager window. Not all of the component applications of QBundle are installed by default. A user can add a component by checking the box next to the desired application and clicking on "Install/Update". Note that currently unavailable applications (i.e. not installed on the system), will be installed once the QBundle is opened for the first time. When new updates are available, a "New update available" message will appear at the top of the wallet. By clicking on this message, the application manager will be displayed and the update can be installed by clinking on "Update/Install". The wallet will be stopped during all software updates. The following figures show an application manager before and after and update has taken place.
How can I view logs for Burst Reference Software (BRS)?
View Console provides a pop up window with the Wallet log and the MariaDB log (if applicable). This is useful for troubleshooting and the output is often requested when obtaining technical support from the community.
How do I change the QBundle settings?
Users are generally advised not to change any of the default settings. Changes might be made if synchronization is causing computer system to lag. In this case decreasing the number of cores may help. Otherwise most setting are used only for troubleshooting.
If OpenCL is correctly installed, using GPU Acceleration will greatly improve performance.
To allow external access to the wallet, add 0.0.0.0 to the ‘Allow API traffic from’ list.
For troubleshooting, the "Debug mode" option can be useful.
How can I resolve connection problems?
If the "Configure Windows firewall" is clicked, user will be asked to confirm they wish to change the Windows firewall to allow access locally and over WAN to the program.
Where is the information about my account stored?
The account manager can be used to manage multiple accounts. A short PIN number can be used for each.
The account Manager is accessible here:
Users can easily manage all their BURST accounts with this software. It provides the Reed-Solomon address and the numeric account number of their Burst Wallet. The Public Key for each of those accounts is also shown.
Passphrases and private keys are also available (it is enough to set up one PIN to control multiple accounts)
What other tools are included with QBundle?
The "Tools" section of the QBundle wallet contains a plotter, a plot converter, a miner, a reward assignment tool, a vanity address generator, and a paper Burst wallet.
Plotting is the process of calculating hashes and saving them onto storage units (HDDs). Click on Tools: Plotting: Plotter
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
- Set plot file size using slider
- Adding files to "My Plotfiles" at "Start plotting" will allow the miner to use plots as soon as a scoop has been plotted i.e. it won't wait until the entire plot file is completed.
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 have been created, the plotter will start with nonce number 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".
The plotter show information about the current nonce being generated: (From- to), % completed ([%]), rate per minute (nonces/min) and writing speed.
The "My plotfiles" section allows the users to import or remove plot files.
Dynamic plotting allows for the normal usage of a hard drive. It will check every minute for space pressure (i.e. a limited amount of space on the drive because of files created/copied).
Dynamic plotting creates and deletes plot files automatically to maintain a set amount of free space as determined by the user. If users often move or create files that are large, they should set a greater space and plot size to efficiently handle sudden changes.
Johnny's POC1 -> POC2 converter is a tool for converting POC1 plot files into POC2 plot files. 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. When using the converter on a particular plot files, the plot file must be temporarily excluded from mining. Usage of the plot converter is straightforward: First, select plot files for conversion. Note: The application will not allow other plot file 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 in which case the "Output Folder" setting is mandatory. Once the "Start conversion" has been activated, stopping the conversion process may lead to damaged plots which cannot be repaired. Many miners have chosne to re plot their drives for POC2 rather than use the conversion process.
Blago's miner (modified by Quibus and JohnnyFFM) can be set for pool mining or solo mining by selecting the appropriate radio button:
If set to solo mine, a fully synchronized locally running wallet is required. The account passphrase must be provided for the account associated with the plot file(s). The passphrase will be saved in the miner.conf file which is located in the QBundle/BlagoMiner folder.
For pool mining, users can either select a predefined pool (by clicking the "Select predefined pool" button) or manually insert mining and server information. This information refer to the pool where deadlines will be submitted and from where the mining information will be received. For pools that are mot listed under predefined pools, uses must receive this information directly from the pool operator (including the port number on pool site). The deadline limit can be calculated using calculators provided on pool websites. In case the calculated deadline, which is based on available plot size, exceeds the pool deadline, the deadline limit should be the maximum deadline accepted by the pool (a pool will not accept deadlines that exceed the defined maximum). The information server parameter is used to get winner information such as the account that forged a block. 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.
If the "Use HDD wakeup" option is checked, a script will be executed in order to prevent the HDD from entering sleep mode. If the "Info server" has been set, the "Show winner information" will be the account unt that forged the block. "Use multithreading" refers to CPU resources usage - if checked, multithreading will be used for deadline calculation.
Users can import or remove plot files used for mining by selecting files from the "My plotfiles" list. Note that the miner will use all plot files that are found in configured folders.
All settings provided in the interface shown above will be passed on to the miner.conf file, which is located in the Qbundle/BlagoMiner folder. Users can also set or edit the miner configuration by directly editing the .conf file.
The miner will start after the "Start mining" button has been clicked.
Once the miner has been started, users can see the configuration (pool and plot file information). Upon receiving mining information (block height, base target etc), the miner will read the configured plot files. Whenever a deadline is found, if it is within configured deadline limit, it will be sent to the pool. The miner will also display if a deadline was accepted by the pool or not ("Confirmed DL"). After all plot files have been read, the miner will display the duration of the round (how much time did it take to read all plot files).
The Blago miner creates logs which are stored in the QBundle/BlagoMiner/Logs folder. These can be useful for debugging observed issues. The miner records the best deadline found for each block in the stat.csv file which is saved in the QBundle/BlagoMiner folder.
Set Reward Recipient
Setting the reward recipient is a mandatory action for all miners. For pool mining, provide the pool's Burst numerical account ID. For solo mining, use your account's numerical ID as the reward recipient.
In the pool you wish to join is not listed within QBundle, insert the pool's Burst numerical account ID manually. The reward recipient transaction requires 4 blocks to complete before deadlines whe miner will be accepted.
Vanity Address Generator
The vanity address generator is a tool for create vanity or branded Burst account addresses. All address must start with "BURST" for the first five leading characters. The capital letter "i" (I), the capital letter "o" (O), zero (0), and one (1) are all disallowed. 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 as shown in the image below:
The algorithm which seeks for the account with the desired string is a brute force algorithm, which checks every Burst account + passphrase combination sequentially. The time it takes to find a particular string increases significantly with every additional character. A fixed strings of 5 characters at the end took 4 minutes with given resources, while adding ‘DAN’ (to output DANDARES) at the end, resulted in an hour long wait. It is possible that setting certain strings could take weeks.
The Paperburst tool can be used to generate a new wallet or to use an existing wallet. In order to use the tool, users will provide information as shown below:
After all required fields of the form have been populated, by clicking the desired button, users can create a new Burst wallet or a paper wallet. The paper wallet is output as an easily printable .pdf file printed.
Paper wallets can be used to transfer funds (using public key to provide details of the wallet to transfer to) or to store funds (the funds are still on the blockchain, not on the paper. This can be a reference document for storage.
The "Help" tab in the BRS wallet contains links to official Burstcoin resources.
If you are unable to open your wallet, these same resources can be found on the main page under the about Burst section.