burstappsteam/burstcoin repository overview

⁠Burstcoin Reference Software (Burstcoin Wallet)

The world's first HDD-mined cryptocurrency using an energy efficient and fair Proof-of-Capacity (PoC) consensus algorithm.

This wallet version is developed and maintained by the Burst Apps Team (BAT). The three supported database servers are:

• MariaDB (recommended)
• H2 (embedded, easier install)
• SQLite (embedded, easier install)

⁠Network Features

• Proof of Capacity - ASIC proof / Energy efficient mining
• No ICO/Airdrops/Premine
• Turing-complete smart contracts, via Automated Transactions (ATs)⁠
• Asset Exchange, Digital Goods Store, Crowdfunds (via ATs), and Alias system

⁠Network Specification

• 4 minute block time
• Total Supply: 2,158,812,800 BURST⁠
• Block reward starts at 10,000/block
• Block Reward Decreases at 5% each month

⁠BRS Features

• Decentralized Peer-to-Peer network with spam protection
• Built in Java - runs anywhere, from a Raspberry Pi to a Phone
• Fast sync with multithreaded CPU or, optionally, an OpenCL GPU
• HTTP and gRPC API for clients to interact with network

⁠Installation

⁠Prerequisites (All Platforms)

NOTE: burst.sh is now deprecated and will not be included with the next release.

⁠Java 8 (Required)

You need Java 8 installed. To check if it is, run java -version. You should get an output similar to the following:

java version "1.8.0_181"
Java(TM) SE Runtime Environment (build 1.8.0_181-b13)
Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)

The important part is that the Java version starts with 1.8 (Java 8)

If you do not have Java 8 installed, download it from Oracle's Website⁠

⁠MariaDB (Optional)

Download and install MariaDB⁠

The MariaDb installation will ask to setup a password for the root user. Add this password to the brs.properties file you will create when installing BRS:

DB.Url=jdbc:mariadb://localhost:3306/databasename
DB.Username=root
DB.Password=YOUR_PASSWORD

Please note that you will need to create a database and grant all priveleges to the user you specify, and substitute databasename in the above example with the name of your database.

⁠Installation

You can manually install using the following steps, or by using the pre-packaged options below.

⁠Manually installing - All Platforms

Grab the latest release (Or, if you prefer, compile yourself using the instructions below)

In the conf directory, copy brs-default.properties into a new file named brs.properties and modify this file to suit your needs (See "Configuration" section below)

To run BRS, run java -jar burst.jar. On MacOS and Windows this will create a tray icon to show that BRS is running. To disable this, instead run java -jar burst.jar --headless.

⁠Installation Packages

⁠Windows

QBundle⁠ is a tool which will automatically download any required files and tools and manage BRS for you. This is recommended for users who do not want to learn how to setup BRS.

⁠MacOS

BRS can be installed using a Homebrew formula⁠.

A number of other Homebrew formulas written by Nixops⁠ are also available for plotters and miners.

⁠Linux

⁠Debian

A .deb package is available here⁠.

⁠Docker

Docker repository⁠

latest : Latest version of BRS with H2 database

mariadb : Latest version of BRS with MariaDB database

2-h2 / 2-mariadb - Version 2.X.X (latest) with corresponding database

2.4-h2 / 2.4-mariadb - Version 2.4.X (latest) with corresponding database

2.4.2-h2 / 2.4.2-mariadb - Version 2.4.2 with corresponding database

edge-testnet - The latest snapshot development build

Docker Compose for use with MariaDB database

version: '3'

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

Docker command for use with H2 database

docker run -p 8123:8123 -p 8125:8125 -p 8121:8121 -v "$(pwd)"/burst_db:/db -d burstappsteam/burstcoin:2-h2

⁠Configuration

⁠Running on mainnet (unless you are developing or running on testnet, you will probably want this)

Add the following to your conf/brs.properties (as a minimum):

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

Once you have done this, look through the existing properties if there is anything you want to change.

⁠Testnet

Please see the Wiki article⁠ for details on how to setup a Testnet node.

⁠Building

⁠Build options

1. Enable Protobuf Compiler: ./gradlew -DrunProtoc=true ...

2. Enable jOOQ generator: ./gradlew -DrunJooq=true ...

3. Enable headless build (if you do not have JavaFX and get errors in BurstGUI.kt when compiling, this skips building the BurstGUI launcher): ./gradlew -Dheadless=true ...

⁠Building the latest stable release

Run these commands (master is always the latest stable release):

git fetch --all --tags --prune
git checkout origin/master
./gradlew buildPackage

If you get errors relating to BurstGUI.kt, try running a headless build as shown above.

Your package will now be available in dist/burstcoin.zip

⁠Building the latest development version

Run these commands (develop is always the latest development version):

git fetch --all --tags --prune
git checkout origin/develop
./gradlew buildPackage

If you get errors relating to BurstGUI.kt, try running a headless build as shown above.

Your package will now be available in dist/burstcoin.zip.

Please note that development builds will refuse to run on Mainnet.

⁠Running tests

./gradlew clean test

If you get errors relating to BurstGUI.kt, try running a headless build as shown above.

⁠Developers

Main Developer: Harry1453⁠. Donation address: BURST-W5YR-ZZQC-KUBJ-G78KB⁠

For more information, see Credits⁠

⁠Further Documentation

• Version History⁠

• Credits⁠

• References/Links⁠