Burstcoin Software

Burstcoin software is developed by talented programmers who are active in the Burstcoin community.  As you may know from reading about Burstcoin’s history, its core blockchain technology is impressive.  Building upon this core, applications bring these impressive capabilities to real-world business and contribute to real-world consumer adoption.  The skill and dedication that Burstcoin development attracts and retains is a testament to its core underlying value and uniqueness.

Development contributions are appreciated.  To get involved, see the development section.

Please note: New users should review the guide entitled “Getting Started with Burstcoin” before installing or using any Burstcoin software.

This Burstcoin software library is organized by category.

Wallet Software

Phoenix - Use as a light node wallet or in combination with the BRS Software for full node functionality.

Phoenix is the newest and easiest wallet to install.  As a light node wallet, it references the blockchain through copies that are stored on network nodes rather than its own copy.  It can, however, reference a local copy of the blockchain in combination with the BRS software.  With the BRS software running, just select settings and enter http://localhost:8125 as the node.  Phoenix is a cross platform application and can be installed on all major operating systems.

A multi-platform application architecture is made possible through a few key front-end technologies: React Native, Angular, and Electron. By using these technologies in conjunction, Burst wallet developers will enjoy a modern application development workflow without sacrificing the quality of the end-product.  See  SIP-18  for more information.

 

Burst Reference Software - Windows - The main Burstcoin software, full node functionality, use with included wallet interface or with Phoenix.

Allows connection to the Burstcoin network.  This wallet version supports a multitude of database back ends.  H2 database is included by default.  

User Guide:  Following is a guide for installing the latest BRS wallet for Windows including instructions for operating the wallet as a full node. 

Please note:  Although the installation instructions are quite long, many of the steps are completely optional.  Synchronization with the blockchain is the most time consuming individual step.  Because of this, if your frequently reset your regular computer using the factory image, your may want to install the BRS wallet on a dedicated computer or 64 bit tablet so that your work is not lost each time, particularly if you are going to operate the wallet as a full node and/or as a mining wallet. 

System requirements: 

  • 64 bit version of Widows
  • 64 bit version of Java (Java 8 recommended): https://www.java.com/en/download/
  • Web browser capable of downloading and installing 64-bit java.  Browsers that work well include:  Google Chrome, Edge, and the ESR version of Firefox.  The regular version of Firefox is not supported.
  • Sufficient disk space for the full blockchain (~8Gb or so)
  • The ability to leave your computer up and running for several hours in order to allow the full blockchain to synchronize.

Preliminary installation instructions: 

  • Verify that that your computer meets all of the system requirements, including correct Java version.
  • Download the latest version of BRS (zip).
  • Extract the contents to a location of your choice.
  • In the conf directory, create a copy of the brs-default file and rename it brs.  (both files will have a “.properties” extension)

Installation using the included default H2 database (the easiest option).  Optional:  To use MariaDB rather than H2 (not generally recommended) proceed to the alternative instructions.

  • Run the burst.exe file.
  • Follow prompts to allow the installation program to make changes to your computer.
  • A window will appear with scrolling data show installation progress and the blockchain downloading.  May take several hours depending on internet connection and processor speed.

Start your wallet

  • Click on the button marked “Start Wallet”.  It may take several minutes for this button to become operational.
  • Your new wallet should appear in a browser tab.

Log into an existing account or create a new account.

To log into an existing account, enter the passphrase associated with that account and press enter.

To create a new account, click the link that says “DON’T HAVE AN ACCOUNT, CLICK HERE TO CREATE ONE”.  The wallet will generate a passphrase of 12 words. WRITE THESE WORDS DOWN AND DO NOT SHARE THEM. This passphrase is your private key.  It is required in order to access your wallet and Burst funds. Please review the security sections of the getting started guide for information on securing your Burst.  Follow the confirmation step on the next page and click Next.

You should now see the wallet dashboard.  The display of your balance and transaction details will update as blockchain synchronization progresses. 

Re: Full Nodes

Running a full node is one of the most important ways to support the Burst network. Full nodes maintain a complete copy of the blockchain and allow peers to connect in order to synchronize.  This contributes to the decentralization that is required for a crypto currency to operate successfully.  Lite wallets and clients do not maintain a complete copy of the blockchain and therefore cannot contribute to decentralization as effectively.  Although BRS is intended as a full node capable wallet, running a full node is completely optional.

Earn NDS-A rewards when your full node operates to current qualifying standards.  Please note:  Reward amounts and qualifying standards such as wallet version and uptime percentages are subject to change and are set by the program operators (currently the Burst Marketing Fund).

To earns NDS-A rewards, open the brs.properties file located in the installation folder under “conf” (use note pad if a program is requested).  Locate the following items, set the values, and then save and close the file.  You will receive rewards in burstcoin anytime your node qualifies.

  • P2P.myPlatform = Add your Burstcoin account number using the Reed Solomon Address Format (example: BURST-NMEA-GRHZ-BRFE-5SG6P).
  • P2P.shareMyAddress = Add YES

Verify that your full node is operational.

The BRS wallet includes UPnP (universal plug and play) and should operate as a full node automatically whenever it is running and port 8123 is open (externally accessible). To verify that port 8123 is open, enter 8123 into this open port checker and click “check”.  You can find your external IP address (ex. 193.182.13.162) by clicking on this external IP address checker

If port 8123 is open, wait a few hours and then verify that your full node is operational by locating your external IP address in this network explorer.  As a new node, it will initially appear near the end of the list, and then move up the list as time passes.  You can verify you participation in NDS-A award program here by checking the NDS-A column.  If your external IP address appears in the explorer, everything is setup correctly and you can disregard the remainder of this installation guide.  

If port 8123 is closed (not externally accessible), proceed to the section titled “reserve a static IP address for your computer” and “Configure port 8123 to allow port forwarding”. 

Reserve a static IP address for your computer.  (This prevents IP addresses from changing and negating port forwarding rules when a computer is restarted.)  Please note:  If you prefer to use the alternative method of port forwarding know as DHCP Reservation, skip this section. 

  • Open a “Command Prompt” by typing CMD into the Windows search field and clicking on “Command Prompt”
  • Type “ipconfig” and hit enter
  • Locate and record your “IPv4 Address”, “Subnet Mask” and “Default Gateway”.
    • Open “Control Panel”, “Network and Internet”,  “Network and Sharing Center”, “Change Adapter Settings”.
    • Right click your internet connection method (wi-fi or ethernet) and select “Properties”.
    • Remove the checkmark next to “Internet Protocol Version 6 (TCP/IPv6)” if present.
    • Add a checkmark next to “Internet Protocol Version 4 (TCP/IPv4)” if one is not there already.
    • With “Internet Protocol Version 4 (TCP/IPv4)” selected, click on “Properties”.
    • Select “Use the following IP address”.
    • In “IP address” type your computer’s IPv4 address.
    • In “Subnet Mask” type your computer’s “Subnet Mask”.
    • In “Default Gateway” type your computer’s “Dafault Gateway”.
    • Select “Use the following DNS server addresses”.
    • In “Preferred DNS server” type “8.8.8.8”.
    • In “Alternate DNS server” type “8.8.4.4”.
    • Check “Validate settings upon exit”.
    • Click “OK”.
    • If you receive a warning about “Multiple default gateways” select “Yes”.
    • Click “Close”.

    DHCP Reservation.  This is an alternative method for reserving a static address IP address.  If you followed the steps immediately above, skip this section.

    These step would only be followed if supported by your router.

    • Navigate to “Connected Devices” (terminology for your router may be different).
    • Click on the device that you are using to run your node.
    • Select “Edit”.
    • Change configuration to “Reserved IP”.
    • Verify that the IP is the same one you set in port forwarding.
    • Select Save.

    Configure port 8123 to allow port forwarding

    Configuring port 8123 would only be necessary if any of the following are true:

    • Your external IP address as found here ( external IP address checker ) does not show port 8123 as open here ( open port checker ).
    • Your external IP address does not appear here ( network explorer ) within 3 hours.
    • Neither “UPnP Mapping successful” or “Port was already mapped. Aborting test” can be found in the burstcoin GUI.

    Open your internet router’s settings by entering your default gateway into your browser’s URL field and hitting enter. Most ISPs have a default username and password combination.  If you do not know the login information, check for it on the side of your modem, locate it using an internet search, or contact your ISP.  If the login information has been changed previously and you cannot locate it, you will need to do a factory reset of your router.  Please note:  This recommendation does not contemplate the extent of your computer network setup.  Resetting your router may require you to redo your network setup.  For most users and for those who do not have an extensive computer network, this should not be a problem.

    Please note:  although port forwarding is a standard and common configuration, different modems may have different terminology and steps to effect this change.  It is not possible to provide the exact steps for each modem.  It may be necessary to reconcile the exact terminology and steps in order to effect the change from a closed port 8123 to an open port 8123.  If the following guidelines do not seem to make sense for your particular router, you might contact your internet service provider (ISP) for support. 

    Find the “Port Forwarding” option (may be under a “firewall” or “Advanced” tab)  Please note:  “Port Forwarding” and “Port Triggering” are NOT the same.  See Figure 1 below for an example of the port forwarding screen for an Actiontec T3200.  This area will be similar for many modems.

    General settings:  Most modems will need only these 3 items.  You may be asked to enter these directly or to add a service with these setting and activate the service in a separate step.

    • IP address:  Enter your IPv4 IP address manually, or select it from a drop down menu if one is available.
    • Internal WAN Start port, External WAN End port, Interal LAN Start port, External LAN End port:  Set all to 8123.  There will be either 2 or 4 such entries to make.
    • Protocol or Service Type:  set to use TCP and UDP.

    Some modems may ask you to add a “service” or a “rule” to be configured as above but activated in a separate step.

    Additional items that you may encounter depending on your router include:

    • Enable?:  Indicate “yes” by checking a box or making a selection.
    • Common Service:  Use “Other”
    • Service or Rule Name:  Use “Burstcoin”
    • IPv6 Address field:  The item can be ignored.

    You are now finished.  Close out of network settings.

    After a few hours check again to see if the your setup is correct by locating your external IP address in the explorer network status.

    Example of the port forwarding section for an Actiontec T3200 router: IP address redacted, should be your IPv4 IP address.

    Port Forwarding Settings

    Optional - Additional instructions for using MariaDB rather than the default H2 database - advanced users only.

    Installation using MariaDB (try this if you experience issues with H2, for more advance computer uses, linux machines with MariaDB already installed)

    • Download and install MariaDB: https://downloads.mariadb.org/
    • The MariaDb installation will ask to set up a password for the root user.  Open the brs.properties file created previously and locate the following section:
    • DB.Url=jdbc:mariadb://localhost:3306/burstdatabase DB.Username=root DB.Password=YOUR_PASSWORD
    • Replace “YOUR_PASSWORD” with the password for the root user.

    The MariaDB installation will install HeidiSQL, a graphical user interface (GUI) tool used for MariaDb administation.

    • Use it to connect to the newly created MariaDb server and create a new DB called ‘burstwallet’.

    Alternatively, you can use the following commands to create the database using the console to connect directly to mysql:  If you have already created the database using HeidiSQL or are not comfortable working in the console, skip to the final step in this section.

    • mysql -u root -p
    • CREATE DATABASE burstwallet;

    Create a user to be used by the wallet to access the database.  Replace with a password of your choice.

    • CREATE USER 'burstwallet'@'localhost' IDENTIFIED BY '';       

    Grant this user all privileges for the database burstwallet.

    • GRANT ALL PRIVILEGES ON burstwallet.* TO 'burstwallet'@'localhost';

    Run burst.cmd in the burstcoin folder. 

     

    Return to the Windows Installation Guide and continue with the section titled “Start your Wallet” to finish any steps that may be applicable.

    BRS - MacOS

    Allows connection to the Burstcoin network.  This wallet version supports a multitude of database back ends. 

    User Guide:  Following is a guide for installing the latest BRS wallet for MacOS including instructions for operating the wallet as a full node.

    System requirements:

    • OSX 10.10 or higher
    • Sufficient disk space for the full blockchain (~8Gb or so)
    • The ability to leave your computer up and running for several hours in order to allow the full blockchain to synchronize.

    Preliminary installation instructions:

    Note: A simple bash script is available to complete all of the steps for you if you prefer using a script. Simply download a .zip of the code located at https://github.com/beatsbears/macos_burst and follow the directions in the README file. If you prefer to execute each step without using a script, continue the process below.

    • Download the latest version of BRS (zip) using the download link at the top of this guide.
    • Extract the contents to a location of your choice.

    Install Homebrew

    Homebrew (brew) is an excellent package manager for MacOS.  To install, open a new terminal and run the following command.  You may be asked for your password.

    $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

    If you already have brew installed, make sure everything is up to date by entering

    $ brew update

    Install MariaDB

    MariaDB is an open-source fork of the MySQL relational database. It is used to store the blockchain and other wallet information.

    $ brew install mariadb

    Start MariaDB and create a user for the wallet

    $ brew services start mariadb

    Log into MariaDB to create a new wallet database and add a user to manage it. Your MariaDB server may not have a root password set. Consult google for instructions for setting a new root password.

    $ mysql -u root -p -h localhost

    While logged into MariaDB, execute the following SQL commands:

    CREATE DATABASE burstwallet; CREATE USER 'burstwallet'@'localhost' IDENTIFIED BY '<YOUR PASSWORD>'; GRANT ALL PRIVILEGES ON burstwallet.* TO 'burstwallet'@'localhost';

    Assuming these commands have executed successfully, exit the MariaDB console by typing q and hitting Enter.

     

    Install Java 8 SDK

    Brew gives you the latest version of all packages, but the latest version of Java may not work without issue. You can install the latest verified version (Java 8) by following these steps.

    Install brew cask.

    $ brew tap caskroom/cask

    Use brew cask to install a specific version of a package.

    $ brew cask install java8

    Add password to the nxt.properties file

    Locate and open the conf directory in the location where you unziped the installation package.

    Open the  nxt.properties  in a text editor.

    At the end of the file, add the following lines which tell Java where to find the MariaDB database.  Replace <YOUR PASSWORD> with the password created previosly.

    nxt.dbUrl=jdbc:mariadb://localhost:3306/burstwalletnxt.dbUsername=burstwalletnxt.dbPassword=<YOUR PASSWORD>

    Start the wallet

     

    In your terminal window verify that you are in the same directory as the burst.sh startup script.  If you run ls in your terminal window you should see a response similar to the following:

    Slow-Air:burstcoin-1.3.6cg andrewscott$ 1s

    Burst_Wallet.url          burst.sh         html

    MIT-license                  burst_db        lib

    burst.cmd                     conf

    burst.jar                       genscoop.c1

    In your terminal window, use the following command to verify that your permissions will allow you to execute the startup script.

    chmod +x burst.sh

    Launch the wallet script.  You will need to leave this terminal window running until the full blockchain has synchronized. This could take several hours or days depending on your processor speed and internet connection.

    ./burst.sh

    You should see a lot of output flying by as the wallet starts up.

     

    Create your account or sign in with an existing Burstcoin Account.

    Assuming that you see no obvious errors while the wallet is starting, verify that it is running successfully by entering the following in your browser’s URL field:

    “https://” “localhost:8125/index.htm”

    Your wallet should appear. 

    If you do not already have a Burstcoin account, click the button that says  New? Create Your Account!  The wallet will generate a passphrase of 12 words. WRITE THESE WORDS DOWN AND DO NOT SHARE THEM. This passphrase is your private key is required in order to access your wallet and Burst funds. Please review the security sections of the getting started guide for information on securing your Burst.  Follow the confirmation step on the next page and click Next .

    You should now see the wallet dashboard.

    If so, congratulations! You are up and running.

     

    Wait for the blockchain to download

    Now that you have your wallet running locally and have created an account, you will need to wait for the blockchain to fully synchronize before you can see your up-to-date Burst balance. This may take a few hours or a few days depending on your processor and internet connection speed. Please note: Your Account Id is listed in the top left corner of your wallet. This address is necessary for sending and receiving Burst.

     

    References

    How to run a full node on MacOS?

     

    Verify that your full node is operational.

    Running a full node is one of the most important ways to support the Burst network. Full nodes maintain a complete copy of the blockchain and allow peers to connect in order to synchronize.  This contributes to the decentralization that is required for a crypto currency to operate successfully.  Lite wallets and clients do not maintain a complete copy of the blockchain and therefore cannot contribute to decentralization as effectively.  Although BRS is intended as a full node capable wallet, running a full node is completely optional.

    With the BRS version installed, UPnP (universal plug and play) should be enabled and your wallet will probably already run as a full node.  BRS must remain running in order to be accessible to the network.  After a few hours, you can verify that your setup is correct by locating your external IP address in the explorer network status.  You can find your external IP address (ex. 193.182.13.162:8123) by clicking here:  your external IP.

     

    Router Settings

    • Once you have a local wallet installed and running you need to forward port 8123 to allow other peers to connect to your wallet.
    • Now you will set the machine to have a static IP address. This is so that if the machine restarts, it will not change IP addresses and negate the port forwarding rule we will set up later.

    Steps on MacOS

    If you have the latest BRS version, UPnP should be enabled and you already run a full node. Otherwise, following these steps:

    • Open “System Preferences”
    • Select “Network”
    • Select “Advanced”
    • Select “TCP/IP”
    • Note down your “IPv4 Address”
    • Note down the “Router” address, this is your default gateway.
    • Leave “Configure IPv6” set to “Automatic”.
    • Change “Configure IPv4” to “Manual”
    • Now in the “IPv4 Address” field, enter the IPv4 address you copied down before switching to manual.
    • Make sure “Subnet Mask” is still 255.255.255.0
    • Make sure “Router” still matches the router number you copied down before switching to manual.
    • Click “Ok”
    • Click “Apply”
    • Close “System Preferences”

    Router Settings

    Open your network router settings by entering your default gateway IP in the URL field of your browser. Login to your router.

    • If you have never used these settings before, most ISPs have default username/password combinations. A quick google search will help you find it.
    • If you do not remember your username/password combo, you will need to factory reset your router. Be mindful, this will force you to re-setup your entire network.

    Find the “Port Forwarding” option. Note, “Port Forwarding” and “Port Triggering” are NOT the same. “Port Forwarding” is generally under the “Advanced” tab.

    • Select “Add Service”, “Add Rule”, or anything along those lines.
    • Set “Common Service” as “Other”.
    • Set service name to “Burstcoin”.
    • Set “Service Type” to “TCP/UDP”.
    • Set IPv4 Address to your machines address which is the address you just made static.
    • Disregard the IPv6 Address field.
    • Set your “Start Port” and “End Port” to “8123”.
    • Save the new service.

    You are now finished.

    After a few hours check again to see if the your setup is correct by locating your external IP address in the explorer network status

     

     

     

    References:

    BRS - Linux

    Allows connection to the Burstcoin network. This wallet version supports a multitude of database back ends.

    Main Developer: Burst Alliance
    Download link: https://github.com/burst-apps-team/burstcoin/releases
    Platform: Linux

    User Guide: Following is a guide for installing the latest BRS wallet for Linux including instructions for operating the wallet as a full node.

    System requirements:

    • Sufficient disk space for the full blockchain (~8Gb or so)
    • The ability to leave your computer up and running for several hours in order to allow the full blockchain to synchronize.

    Ubuntu/Debian installation

    The following steps are to install BRS node on any recent installation of Unbuntu or other Debian based distros. Please be sure to check Git Repository for the latest release before proceeding.

    Note: Commands to be entered into the shell will be formatted in bold text, example:

    date

    Command outputs will not be bold, example:

    Wed 28 Nov 12:02:18 GMT 2018

    Installing BRS

    Make sure your installation is up to date

    apt update && apt upgrade

    Run the following command to install java:

    apt install default-jre-headless -y

    • Have the latest version of Java installed on your computer with the following command: apt install default-jre-headless -y
    • Download the latest version of BRS (zip) and extract it to where ever you like. Optionally, in the conf directory, copy brs-default.properties into a new file named brs.properties and edit it to suit your needs.
    • Inside the folder you extracted the zip contents run the following: java -jar burst.jar

    This will show you a GUI with logs and percentage of blockchain download. If you don’t want the GUI to be shown run as java -jar burst.jar –headless.

    Installing MariaDB (optional)

    By default, a file based database backend is used (store on folder burst_db). If you want to use MariaDB instead, in addition to the above steps, use the following procedure (stop BRS from running before going forward).

    Install MariaDB:

    apt install mariadb-server

    During installation you will be prompted to enter a password for the root user. Enter and remember this as we will need it later.

    Create a database(brs_master), user (brs_user) and assign a password to the user by running the following command:

    echo “CREATE DATABASE brs_master; CREATE USER ‘brs_user’@’localhost’ IDENTIFIED BY ‘yourpassword’; GRANT ALL PRIVILEGES ON brs_master.* TO ‘brs_user’@’localhost’;” | mysql -uroot -p mysql -uroot -p < init-mysql.sql

    This will prompt you for the password you entered for the root user when installing mariaDB

    Configuring BRS to use MariaDB

    Navigate to the conf subdirectory within your BRS directory:

    cd BRSWallet/conf

    Create a brs.properties file inside the conf folder:

    nano brs.properties

    Add the following lines:

    DB.Url=jdbc:mariadb://localhost:3306/brs_master DB.Username=brs_user DB.Password=yourpassword

    Run BRS again:

    java -jar burst.jar

    You will see something similar to the following output:

    Nov 29, 2018 4:28:33 PM brs.Burst loadProperties

    INFO: Initializing Burst Reference Software (BRS) version 2.5.0

    Nov 29, 2018 4:28:33 PM org.ehcache.core.EhcacheManager createCache

    INFO: Cache ‘account’ created in EhcacheManager.

    [INFO] 2018-11-29 16:28:33 brs.db.sql.Db – Using mariadb Backend

    Note: If closing the terminal or pressing Ctrl-c, the node will shutdown:

    [INFO] 2018-11-29 16:53:12 brs.Burst – Shutting down…

    Configure BRS to run as a service/daemon

    Closing the terminal or pressing Ctrl-c will result to a shutdown of the wallet. To avoid this, BRS should be run as a service. It is particularly helpful if you run BRS on a linux system using SSH.

    If systemd isn’t installed on your system, run the following command:

    sudo apt install systemd

    Then, you will have to create a new service file for BRS:

    sudo nano /etc/systemd/system/brs.service

    Add the following configuration (replace description, Exec, WorkingDirectory and User according to your setup):

    [Unit]

    Description=BRS Wallet

    After=network.target

    Wants=network.target

    [Service]

    ExecStart=/usr/bin/java -jar /home/burst/burst.jar

    WorkingDirectory=/home/burst/

    User=brs-mariadb

    Restart=always

    RestartSec=90

    [Install]

    WantedBy=multi-user.target

    After that, enable the service:

    sudo systemctl enable brs.service

    To start the service, type:

    systemctl start brs.service

    To get the status of the service:

    systemctl status brs.service

    BRS - Docker

    Allows connection to the Burstcoin network. This wallet version supports a multitude of database back ends.

    Main Developer: Burst Alliance
    Download link: https://github.com/burst-apps-team/burstcoin/releases
    Platform: Windows, Linux, MacOS, Docker

    User Guide: Following is a guide for installing the latest BRS wallet for Docker including instructions for operating the wallet as a full node.

     

    System requirements:

    • Sufficient disk space for the full blockchain (~8Gb or so)
    • The ability to leave your computer up and running for several hours in order to allow the full blockchain to synchronize.

    Introduction

    The Burst Reference Software can be run with Docker and Docker-Compose. Since Docker supports all major platforms, this can be an easy-to-setup alternative to a platform-dependent installation of the Burst Reference Software.

    Prerequisites

    Database

    Currently, Docker images for BRS version 2.3.0 with MariaDB (recommended) or H2 Database are available at Docker Hub. You have to choose one of them, which is used to store the blockchain.

    Configuration

    Please note: From this point on, this article may need to be updated by someone more familiar with docker.

    MariaDB

    The following docker-compose.yml file can be used to run the BRS with MariaDB database in containers.  Please note:  Indentation levels are 2, 4, and 5 characters

    version: ‘3’

    services:
       burstcoin:
         image: pocconsortium/burstcoin:2.2-mariadb
         restart: always
         depends_on:
          – mariadb
         ports:
          – 8123:8123
          – 8125:8125
       mariadb:
         image: mariadb:10
         environment:
          – MYSQL_ROOT_PASSWORD=burst
          – MYSQL_DATABASE=burst
         command: mysqld –character_set_server=utf8mb4
         volumes:
          – ./burst_db:/var/lib/mysql

    Save the file and run it.

    docker-compose up -d

    With the -d flag, both containers are started as background processes. A burst_db folder will be created in the directory of the docker-compose.yml file, if it was not created before. This folder is mounted to the MariaDB storage and holds the burst database containing the blockchain. The containers can be stopped and removed at any time via docker-compose down. With the next start, the burst_db folder will be mounted again and your previous blockchain status will be loaded.

    H2

    Alternatively, H2 can be used as database to store the blockchain. H2 is an embedded database, therefore one does not have to run it in a separate container. Simply run the following command.

    docker run -p 8123:8123 -p 8125:8125 -v“$(pwd)”/burst_db:/etc/burstcoin/burst_db -d pocconsortium/burstcoin:2.2-h2

    “$(pwd)”/burst_db is the path to the folder which is mounted to the H2 storage. If it does not exist a new burst_db folder is created in the current directory.

    Custom configuration

    In order to use a custom config – brs.properties file, you can simply mount a folder containing the brs-default.properties and the brs.properties to the /conf mount point.

    MariaDB

    version: ‘3’

    services:
    burstcoin:
    image: pocconsortium/burstcoin:2.2-mariadb
    restart: always
    depends_on:
    – mariadb
    ports:
    – 8123:8123
    – 8125:8125
    volumes:
    – ./conf:/etc/burstcoin/conf
    mariadb:
    image: mariadb:10
    environment:
    – MYSQL_ROOT_PASSWORD=burst
    – MYSQL_DATABASE=burst
    command: mysqld –character_set_server=utf8mb4
    volumes:
    – ./burst_db:/var/lib/mysql

    H2

    docker run -p 8123:8123 -p 8125:8125 -v“$(pwd)”/burst_db:/etc/burstcoin/burst_db -v“$(pwd)”/conf:/etc/burstcoin/conf -d pocconsortium/burstcoin:2.2-h2

    PaperBurst

    PaperBurst is a paper wallet generator for Burst.

    Guide:

    This tool is can be used to generate a new wallet or can be used with an existing wallet.

    Paper wallets can be used to transfer funds using public keys, or as a reference document for cold storage (the funds are still on the blockchain, but the paper document provides the required access information).

    In order to use the tool, populate all of the required fields and then click on the desired button.  The paper wallet will output as a printable .pdf file.

     

    Image showing the Burstcoin paper wallet generator integrated with QBundle

    Image of a Burstcoin paper wallet

    Burstpay Mobile Wallet (New!)

    Mobile wallet for Android and iOS which provides the following features:

    • Watch only addresses
    • Currency conversion
    • Client-side encryption and decryption
    • Encrypted / Unencrypted transaction messages
    • Contact book
    • QR code support
    • Secure and easy passphrase generation
    • Support for over 15 languages
    • Support for over 30 currencies 

    Burstcoin mobile wallet

    There are several mobile applications on Google Play for Burst, but some are outdated and some of dubious quality.  This is the only mobile wallet that is recommended.

    The mobile wallet for Android and iOS which provides the following features:

    • Watch only addresses
    • Currency conversion
    • Client-side encryption and decryption
    • Encrypted / Unencrypted transaction messages
    • Contact book
    • QR code support
    • Secure and easy passphrase generation
    • Support for over 15 languages
    • Support for over 30 currencies

     

    HotWallet

    A light-weight version of the current BURST wallet for easy access to send and receive BURST.

    I18N – Internationalization (mobile wallet)

    The major part of the wallet localization is done via a .json file containing definitions for text strings used in the wallet. The naming is such, that a 2-letter code denotes the language. en.json is the source file (see below).

    If you want to translate this file into some language, you need to translate the “Create New Account”, “Done” etc. not those in ALLCAPS. A major constraint is, that the translated text not only be correct and stylistic, but also of about the same length as the original content. It can be shorter, but not much longer. The 2-letter language code is ISO 639-1

    en.json localization file

    References

    https://bitcointalk.org/index.php?topic=2080040.0https://forums.getburst.net/t/one-month-of-pocc/603https://forums.getburst.net/t/burst-on-the-go-the-poc-consortium-releases-their-android-wallet/794

    Plotting Software

    ENGRAVER (Recommended)

    “POC 1, POC 2

    Engraver is a BURST plotter that natively generates optimized plot files.  It generates PoC2 files and is intended to work on most platforms.  BURST’s fastest plotter, it features: direct and async i/o, SIMD support (sse2, avx, avx2, avx512f), and gpu support.

    Basic Instructions for Windows:

    • Create an empty folder to hold your plot files on your local system or external drive.  Do not use spaces.  Example:  E:\PlotFiles  or  E:\Plot_Files
    • Download and unzip the latest version for your operating system.  Open the unzipped folder and double click on the Engraver application (EngraverGUI).  Follow your system’s prompts to install.
    • In the application, enter account’s numeric id, found in the upper left corner of your wallet.  (Note:  This is not the account address which begins with BURST) 
    • Output Folder:  Browse to the folder that you created to hold your plot files.
    • Start Nonce:  Use the default of zero if plotting for the first time.  Otherwise, click on “auto from last file” and browse to the last plot file that you created so that Engraver can determine the starting nonce for a new plotting session automatically.
    • Size to plot:  Choose “maximum” to fill your disk’s available space with individual plot files of a specific size.  Choose “value” to create a single file of a specific size.  Each nonce will use 256 KB of disk space.  Performance is no affected by the file size chosen, but dividing your plot files into several smaller files can be beneficial if you need to move them at some point, or if you need to delete a portion of them to free up space for another purpose later.
    • Click on Start Plotting.  Allow the plotting session to finish.  Depending on the amount of plots that you create, this process can take hours or days.  It can be interrupted by clicking on “Stop Plotting” and resumed later.  

    Notes:

    • To choose between using your CPU or GPU and to set limits on the of memory and cores used, make selection in the advanced settings tab.
    • Avoid overlapping plot files (duplicates).  Consider your starting nonce numbers carefully.  Duplicate plot files waste space that could be used for unique plots.  Duplicate plot files are of no value. 

    For a more detailed setup guide including additional advanced settings, select the help tab to be taken to  Home · PoC-Consortium/engraver Wiki · GitHub .

    Following is a guide for those who prefer to compile software from source code.

    Engraver – How To Compile From Source

    https://www.youtube.com/watch?v=hRuF0hn-A4k 

    Credits:  Sphinxicus

    Description: Engraver is the reference Burstcoin (or Burst) cross-platform plotting software created to further improve and optimize Burst plot file creation.

    The following steps are to install Engraver 2.2.0 by compiling from source on a fresh installation of Debian Linux version 9 “Stretch”. Please be sure to check Git Repository for the latest release before proceeding.

    Note: Commands to be entered into the shell will be formatted in bold text, e.g.:

    date

    example command outputs will not be bold, e.g.:

    Wed 28 Nov 12:02:18 GMT 2018

    Prerequisites

    Before you begin the installation, the following packages need to be installed:

    • curl
    • git
    • build-essential

    Change to root user:

    su

    Enter root password

    Install curl, git and build essential packages:

    apt install curl git build-essential -y

    Once the above packages have completed installation, its time to install Rust.

    Installing Rust (Stable)

    To install Rust, run the following command:

    curl https://sh.rustup.rs -sSf | sh

    You will be presented with three options (see below):

    Current installation options: default host triple: x86_64-unknown-linux-gnu default toolchain: stable modify PATH variable: yes1) Proceed with installation (default)2) Customize installation3) Cancel installation>

    Choose option 1 to install

    Once installation is complete, follow the instructions to configure your current terminal sessions’ environment variable so that you can run Rust related commands:

    source $HOME/.cargo/env

    To confirm the installation of the correct channel of Rust, type the following:

    rustc –version

    This should give you the output below:

    rustc 1.31.0 (abe02cefd 2018-12-04)

    Obtain the source files

    To download the source files from the Git repository, run the following command, (please make sure to check the exact path to the latest version) :

    git clone https://github.com/PoC-Consortium/engraver

    This will download and extract the files to the engraver sub directory (from where your present working directory is)

    Compiling the source files

    Navigate to the engraver directory:

    cd engraver

    build the application:

    cargo build –release

    Running Engraver

    Once the above has completed, navigate to the executable:

    cd /target/release

    From here you can run engraver and begin plotting. Example command:

    ./engraver –n 1000 –id 12345678912345678912 –path /home/burst/Burst –sn 0

    To understand the complete range of flags/options available for the engraver application, please read the Wiki page on GitHub.

    TurboPlotter 9000

    POC 1, POC 2
    TurboPlotter 9000 is a CPU/GPU PoC 1 + PoC 2 plotter and plot integrity checker.

    Note:  TurboPlotter 9000 is free to use.  However it is not open source.

    Mining Software

    Scavenger (Recommended)

    Scavenger is a burst miner written in Rust. It features direct io, avx512f, avx2, avx, sse, and opencl.

    Note: Use Version 1.7.8 for pool mining only.  For solo mining, use Version 1.7.6.

    Basic Instructions for Windows:

    Note:  Plot files are a prerequisite for Burstcoin mining.  If you have not already created your plot files, see the plotting software section of this library.    

    Download and unzip the latest version for your operating system.  Open the folder and double click on the Scavenger application.  Follow your system’s prompts to install.

    • Optional:  Double click on the Scavenger application file to test the installation using the included test data.
    • Optional:  Make a copy of the included config file (file type is YAML) in the same directory.  This is helpful for trouble shooting later if needed.

    Add your configuration details:  With scavenger closed, open the config file. ( It will likely open in notepad. )

    • For pool mining:  Comment out the 1st 3 lines by inserting a hash symbol ( # ) at the beginning of each.  These lines are not needed for pool mining.
    • For solo mining:  Replace the data on these lines with your account’s numeric id and passphrase.  Comment out any these lines that are not used.

    Add the path to the folder which contains your plot files under plot_dirs ( plot directories ).

    • Replace test_data with your path.  Example:   E:\burstcoinplotfiles

    Add URL:

    • For pool mining:  Replace the sample URL with the URL obtained from your mining pool.  If a port number is used, append it to the end of the URL separated by a colon.  ( Example:    URL:8080 ) 
    • For solo Mining:  Replace the sample URL with:  http://localhost:8125

    The remaining  items are default and advanced settings that you will not likely need to change.  Save and close the config file.

    Double click on scavenger to begin mining. 

    Notes:

    • If changes are made to the config file while Scavenger is running, Scavenger must be restarted in order for the configuration changes to take effect.
    • “HDD, wake up!”:  This powers-up your hard drive anticipating a new round so that your deadlines can be submitted as soon as possible after a round starts.
    • To verify that you are mining successfully on a pool, look for your miner on the pool’s website.  It should show your miner and mining share.
    • To verify your reward assignment setup, locate the reward assignment transaction in your wallet and verify the details listed.
    • Reward assignments become effective after 4 confirmations (4 blocks),  This takes an average of 16 minutes.
    • If your mining pool does not list block winners, you can find blocks that you won in a block explorer ( see online services ). 

    For more detailed instructions:  See  https://github.com/PoC-Consortium/scavenger/wiki

    GYRA ( a front-end tool that creates formally valid and logically consistent configurations for Scavenger )

    Gyra is a front-end tool that creates formally valid and logically consistent configurations for the Scavenger Proof-of-Capacity miner. The configuration file used by Scavenger and created by Gyra is a .yaml file, which users can download in their browser and save it in the root directory where the Scavenger executable is placed.

     

    Scavenger - Compile from Source

    https://www.youtube.com/watch?v=Zmk3-w9EhFE

    These instructions are only for those who prefer installing Scavenger by compiling from source.

    Description

    Scavenger is a burst miner developed by the PoC Consortiun and written in Rust. If features direct io, avx 512f, avx2, avx, sse and opencl support. At the time of writing this is the preferred miner of choice for both CPU and GPU mining.

    The following steps are to install Scavenger 1.6.4 by compiling from source on a fresh installation of Debian Linux version 9 “Stretch”. Please be sure to check Git Repository for the latest release before proceeding.

    Note: Commands to be entered into the shell will be formatted in bold text, e.g.:

    date

    example command outputs will not be bold, e.g.:

    Wed 28 Nov 12:02:18 GMT 2018

    Prerequisites

    Before you begin the installation, the following packages need to be installed:

    • curl
    • git
    • build-essential

    Change to root user:

    su

    Enter root password

    Install curl, git and build essential packages:

    apt install curl git build-essential -y

    Once the above packages have completed installation, its time to install Rust.

    Note: The features used when compiling Scavenger are not available on the stable release channel of rust, therefore the nightly channel needs to be installed.

    Installing Rust (nightly)

    To install Rust, run the following command:

    curl https://sh.rustup.rs -sSf | sh

    You will be presented with three options (see below):

    Current installation options: default host triple: x86_64-unknown-linux-gnu default toolchain: stable modify PATH variable: yes1) Proceed with installation (default)2) Customize installation3) Cancel installation>

    To install the nightly channel chose option 2, this will ask you additional questions, answer as per below:

    Q: Default host triple?A: Press enter to leave unchanged

    Q: Default toolchain? (stable/beta/nightly/none)A: nightly

    Q: Modify PATH variable? (y/n)A: y

    You will be presented with a summary of the current installation options as per your answers provided above:

    Current installation options: default host triple: x86_64-unknown-linux-gnu default toolchain: nightly modify PATH variable: yes1) Proceed with installation (default)2) Customize installation3) Cancel installation

    Chose option 1 to install

    Once installation is complete, follow the instructions to configure your current terminal sessions’ environment variable so that you can run Rust related commands:

    source $HOME/.cargo/env

    Switching from Rust (stable) to Rust (nightly)

    If you chose to or already have the stable channel of rust installed you can switch channels by using the following command:

    rustup default nightly

    To confirm the instalation of the correct channel of Rust, type the following:

    rustc –version

    This should give you the output below, note the “nightly” present (version correct at time of writing):

    rustc 1.32.0-nightly (6bfb46e4a 2018-11-26)

    Obtaining the source files

    To download the source files from the Git repository, run the following command, (please make sure to check the exact path to the latest version as this will change as later versions are released) :

    wget https://github.com/PoC-Consortium/scavenger/archive/1.6.4.zip

    This will download the file 1.6.4.zip to your current directory.

    Extract the contents of the zip file:

    unzip 1.6.4.zip

    This will create a new directory named scavenger-1.6.4.

    Compiling the source files

    Navigate to the scavenger-1.6.4 directory

    cd scavenger-1.6.4

    At this point it is worth deciding what you are going to use to do the mining, CPU/GPU and also what instruction sets are available on your device. See the README.md file located in the scavenger-1.6.4 directory for an overview of features to use.

    In this example, a CPU with the SSE2 instruction set will be used therefore the simd feature option is required (the same would work for AVX, AVX2 etc). Run the following command to compile the code:

    cargo build –release –features=simd

    Post compiling steps

    Copy the scavenger executable to the scavenger-1.6.4 directory (two levels up in this case). This placed it in the same directory as the config.yaml file which is required for it to run.

    cp scavenger ../../scavenger

    Navigate back to your scavenger-1.6.4 directory from the release directory

    cd ../..

    At this point you can run scavenger and it will make use of the test_data file to simulate mining on the dev.burst-test.net

    Once you know it will run you will need to configure the config.yaml file to your setup. The config file itself is well commented and the GitHub Wiki has further information if required.

    Additional notes

    If the above steps were followed verbatim, all the scavenger files will be owned by root. It is not recommended to run as root so we will change the owner to a normal user, “burst” in this case. From the directory a level up from your scavenger-1.6.4 directory run:

    chown -R burst:burst scavenger-1.6.4

    This will recursively change ownership to the user “burst” for all files and subdirectories within the scavenger-1.6.4 directory.

    to logout of root type:

    exit

    You are now back at the shell as your normal user (burst). You can now run scavenger by issuing the following command from the scavenger-1.6.4 directory:

    ./scavenger

    Example output from running scavenger

     

    Links

    Software

    https://github.com/PoC-Consortium/scavenger/releases/latest

    GitHub Documentation

    https://github.com/PoC-Consortium/scavenger/wiki

    Blagominer

    POC 1, POC 2

    A modified version based off of JohnnyFFM’s version of Blagominer. This version features collision free dual mining of Burstcoin and Bitcoin HD (configurable via priority) and tracking (and displaying) of possibly corrupted plot files. 

    • update with Collision free dual mining
    • Tracking (and displaying) of possibly corrupted plot files
    Guide:

    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:

    Blagominer modded

    POC 1, POC 2
    This is a modified version of Blagominer. This modification of Blagominer builds upon modifications previously made by Quibus.

     

    Blagominer quetzalcoatl

    A modified version based off of andzno1’s version of Blagominer. This version features major improvements and bug fixes.

     

    Burstcoin-jminer

    Burstcoin-jminer is a GPU assisted Proof of Capacity (PoC) Miner for Burstcoin.

     

    CreepMiner

    CreepMiner is a client application for mining Burst on a pool or solo. It supports CPU mining (SSE2/SSE4/AVX/AVX2) or GPU mining (OpenCL, CUDA).

    POC 1, POC 2

     

    foxy-miner

    A scavenger / conqueror wrapper for collision free multi-mining.

     

    The bencher

    A PoW miner for PoC. Its main purpose is to benchmark hashing devices for PoC and to make different hardware comparable. It also has an educational aspect as it shows how inefficient it is to mine a PoC coin without storage (a BIS GPU can emulate around 1TB).

     

    Development Library

    BlockTalk

    BlockTalk allows the user to write, debug, and deploy Burst smart contracts relying only on Java. You can use a simple text editor or your preferred IDE.

    Burstkit

    BurstKit simplifies integrating with the Burst API for iOS devices.  It provides wrappers for the Burst API’s and implements Crypto utilities needed for key generation and signing.

    Burstkit4j

    Burstkit4j is a BURST Java Development Framework.

    @burstjs

    A BURST JavaScript library to make it easier for developers to build apps using Angular/React/Node.js/JavaScript. The library is broken down into four packages:

    • @burstjs/core
    • @burstjs/crypto
    • @burstjs/http
    • @burstjs/util. 

    BurstLib

    BurstLib is a cross platform dynamic library to make developing applications and tools compatible with the Burst blockchain easier.  Written in C++.

    Pool Software

    BurstNeon Burst-Pool

    POC 2

     

    Nogrod

    Nogrod is the all-new PoCC pool software written in GO. It provides SSE4 + AVX2 support, a fair share system based on estimated capacity, grpc api, multiple wallets as backends using the wallet API, can talk directly to wallet database, and dynamic payout thresholds/intervals based on messages on the blockchain.

    dAPPS

    CloudBurst

    CloudBurst is a decentralized cloud storage application to upload & download files from the Burst blockchain.

     

    BurstCoupon

    BurstCoupon allows you to create and claim password protected coupons as extension for the Burst blockchain.

     

    The Burst dAppository

    The place to shop for burst related projects.

     

    Explorer Apps

    Burstcoin Explorer Mobile App

    Burstcoin explorer is a block explorer for the Burstcoin network

    Features include:

    • Search for and view blocks, accounts and transactions
    • Keep a list of accounts you are watching
    • Keep an eye on the current Burst price, both in BTC and USD
    • Observe the current status of the Burstcoin Network
    • Countdown upcoming events such as the Pre-Dymaxion Hard Fork

     

    Archon

    A collision free, multi-chain proof of capacity mining proxy.

     

    foxy-proxy

    A BHD, LHD, DISC, BOOM and BURST proxy which supports solo and pool mining upstreams

     

    Other Tools

    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

    Poc1to2Converter

    POC 1, POC 2
    Poc1to2Converter converts PoC1 plots to POC2 plots.

     

    PoC-Consortium Poc1to2 Converters

    POC 1, POC 2

    This Poc1to2 Converter for Linux converts PoC1 plots to POC2 plots. There is a rust binary converter (recommended) or a perl script version.

     

    Burstcoin Explorer

    Burstcoin explorer is a block explorer for the Burst network.

    Features include:

    • Search for and view blocks, accounts, and transactions
    • Keep a list of accounts you are watching
    • Keep an eye on the current Burst price, both in BTC and USD
    • Observe the current status of the Burst Network
    • Countdown upcoming events such as the Pre-Dymaxion Hard Fork

     

    Burst MemPool Monitor

    Explore unconfirmed transaction on the Burst blockchain.

     

    TurboSwizzler

    TurboSwizzler is an application to convert PoC 1 plots to the PoC 2 format. Currently supports drive to drive mode with plot merging.

     

    PoC-Consortium Poc1to2 Converters

    This Poc1to2 Converter for Linux converts PoC1 plots to POC2 plots. There is a rust binary converter (recommended) or a perl script version. 

     

     

    Archived

    QBundle - [ARCHIVED]

    Download and save the Burstcoin QBundle installation folder

    This software is end-of-life and is no longer updated nor supported. It remains archived online, but although the included wallet will connect to the network, many of the included components are no longer functional.  The same functionality is achieved by installing the latest version of the installed components until another all in one package is developed.

     

    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. 

    • Main Developers: Harry1453
    • Download link:  https://github.com/burst-apps-team/Qbundle/releases
    • Platform: Windows

    Installation guide: 

    Download and save the Burstcoin QBundle installation folder

     

    • The installation folder is located here:  https://github.com/burst-apps-team/Qbundle/releases.
    • 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.

    QBundle Installation downloaded

    Installation folder unzipped

     

    Install the Burstcoin QBundle 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”.

    Run the setup application

    More Information

    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”.

    Red (to be downloaded)

    Each component downloads

    Green (downloaded)

    New wallet (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”.

    Select Portable MariaDB

    Downloading . . .

    Select "no copy"

    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.

    Select "Use Portable Java"

     

     

    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.

    The initial download of the bootstrap will begin.  A percentage progress indicator and time remaining figure will be displayed:  When the 1st phase is complete (approximately 40 – 45 minutes), do not click on the grey button marked complete.  After a brief time, the status indicators will reset and the second phase, populating the database, will begin automatically.  After both of these processes have completed automatically, click on the “finished” button and proceed to the next step.

    Choose repository

    Import complete

    Wallet synchronizing

     

     

    Click on Wallet and then on Start Wallet

     

    • The wallet will now sync from peers the duration of time that was not included in the bootstrap file.  This will be the most time consuming step.

    Create a new account and passphrase if you do not yet have one, otherwise, skip the next steps and enter your existing account number and passphrase.

    • Please note: Before proceeding, it is important to fully understand the security features of Burstcoin passphrases. Review the getting started guide for information about 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.  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 Burstcoin QBundle applications

      Following are several useful programs that are included with QBundle.

      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

      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

    99

    Easy2Burst - [ARCHIVED]

    Easy2Burst was a Burst Wallet written in Rust, as the successor of QBundle. It is no longer being developed

     

    • Main Developer: HeosSacer
    • Github repository:  https://github.com/HeosSacer/Easy2Burst
    • Platform: Windows, Linux, MacOS

    Aspera [ARCHIVED]

    Aspera was a Burstcoin Wallet written in go. This wallet opens up a whole new dimension for Burstcoin with state-of-the-art technologies (partial blocks validation, new front-end, etc.).  This project is no longer being developed.

     

    • Main Developer: PoC-Consortium
    • Github repository: https://github.com/PoC-Consortium/Aspera
    • Platform: Windows, Linux, MacOS

    Burst Client For Windows All-In-One Wallet [ARCHIVED]

    Burst Win Client extends the original Burst Wallet (BRS) with Plotter and Miner software from other developers. It’s a helper tool for a Windows user. This software is End-of-Life and is no longer updated nor supported. It remains archived online, but will not connect to the Burst network.

     

    • Main Developer : daWallet

    • Website:  https://burstwallet.io/archived-pages-reference-only/dawallets-burst-windows-wallet/

    • Platform : Windows

    .NET Windows Chromium All-In-One Wallet [ARCHIVED]

    This all-in-one wrapper provides easy access to features and resources for Burst. For security conscious people, the passwords used to access the wallet can be encrypted. This wallet is no longer being developed, and is not recommended for use.  Archived.

     

    • Main Developer : Lexicon

    • Website:  https://burstwallet.io/archived-pages-reference-only/lexicons-net-windows-wallet/

    • Platform : Windows

    XPlotterGui

    POC 1POC 2
    XplotterGui is a GUI version of Xplotter with SSD Cache, File Merging, and POC2 Conversion features.

     

    XPlotter modded

    POC 1, POC 2
    XPlotter is the default plotter that comes with QBundle and provides CPU PoC 1 plotting with AVX support. This modified version supports PoC 2 plotting.

    Guide:

    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”.

    gpuPlotGenerator

    POC 1
    gpuPlotGenerator is a GPU plotter.

     

    5 + 4 =