Building Beam
This document will serve as a guide for building Beam and BeamUI projects. Users have the option to download the binaries directly from GitHub, however, for this walkthrough, users must have some technical knowledge, including basic knowledge of the Command-Line.
Things you'll need
To avoid any issues, have the following installed on your machine before starting your build:
The latest version of Git.
CMake (version 3.13 and newer to generate the build environment).
Boost library (version 1.66 and newer_)._
Microsoft Visual Studio (2017 and newer; Windows users only).
First steps
Downloading the binaries
Launch a terminal window and enter the following command:
Creating submodules
As a prerequisite, Beam requires the creation of submodules before starting the build. To create submodules, launch your terminal window and enter the following commands:
Branch Convention
Beam is entirely open-source, and we encourage users interested in contributing or testing our tech to follow the Branch convention below to avoid any issues.
Master
branch is for development.Testnet
branch is a sandbox for users interested in testing Beam.Mainnet
branch is the most recent version of each Beam project.
CMake Options
Beam uses CMake to generate the build environment with several options for building the project. Refer to CMakeLists.txt
file for more details.
Windows
This guide assumes you have the latest version Git installed on your machine.
Install Microsoft Visual Studio with CMake support.
Download and install the Boost prebuilt binaries, adding
BOOST_ROOT
to the Environment Variables.Download and install the OpenSSL prebuilt binaries (
Win64 OpenSSL v1.1.0h
for example). AddOPENSSL_ROOT_DIR
to the Environment Variables.Add
.../boost_1_68_0/lib64-msvc-14.1
to the System Path.Open project folder in Visual Studio, select your target (
Release-x64
for example, if you downloaded 64bit Boost and OpenSSL) and selectCMake -> Build All
.Open cache folder:
For Visual Studio 2017 users, go to CMake** > Cache > Open Cache Folder >
Beam
**For Visual Studio 2019 users**, Project > _CMake_ cache > Open in explorer** (the binaries can be found in
beam/..., wallet/cli/..., explorer/... subfolders
).
Linux
Locate the downloaded Beam node and Command Line (CLI) wallet in the beam/wallet/cli
folder.
Clone the Beam binaries from Github by entering the following command:
Please note: The above command will clone the latest master branch. The master branch is where the Beam team develops upcoming versions of Beam. Users should select the appropriate branch then
git checkout
after cloning the main Beam repository.To clone the
Double Doppler 4.0
release branch, enter the following:The standard tutorials for Building beam will create the latest Beam Masternet build (development version, development blockchain). Build the Testnet for testing and development or build the Mainnet for real-world blockchain utilization by editing the
beam/CMakeLists.txt
file lines 151-157. Uncomment (remove the '#' sign) respective definitions for the version Beam you wish to build.
Ubuntu and desktop server
Ubuntu 18.04
Desktop
The instructions below are valid for a default Ubuntu 18.04.03 Desktop LTS install. For older systems, verify that steps 1, 2 & 4 do not overwrite or conflict with more recent versions of CMake
and boost
previously installed on your machine.
Install dependencies:
Install
CMake
:Find your Beam project folder, start the release build:
Server
Install dependencies:
Install
CMake
:Find your Beam project folder, start the release build:
Ubuntu 19.10
Desktop
Instructions below are valid for a minimal Ubuntu 19.10 Desktop install ("update during install" option enabled).
Install dependencies:
Find your Beam project folder, start the release build:
Server
Install dependencies
Find your Beam project folder, start the release build:
CentOS
CentOS 7.0
The instructions below are valid for a default CentOS 7.0-1908 minimal install. For older systems, verify that steps two and three do not overwrite or conflict with more recent versions of CMake
and boost
previously installed on your machine.
Install dependencies:
Build & install boost. This step could take considerable amount of time
Install
CMake
:Find your Beam project folder, start the release build:
CentOS 8.0
The instructions below are valid for a default CentOS 8.0-1905 minimal install. For older systems, verify that step two does not overwrite or conflict with more recent versions of CMake
and boost
previously installed on your machine.
Install dependencies:
Install
CMake
:Find your Beam project folder, start the release build:
Fedora
Desktop
The instructions below are valid for a default Fedora 31-1.9 Workstation install.
Install dependencies:
Find your Beam project folder, start the release build:
Server
The instructions below are valid for a default Fedora 31-1.9 Headless Server install.
Install dependencies:
Find your Beam project folder, start the release build:
MacOS
Clone the Beam binaries from Github:
Please note: The Git command above will clone the latest master branch. The master branch is where the Beam team develops upcoming versions of the Beam.
To clone the
mainnet
, enter the following command:To clone the Beam
testnet
, use:Install
Brew
Package Manager.To install all necessary packages, enter:
Remove any existing
Brew
installations ofboost
:Download and install a compatible version of
boost
:To set your Environment Variables, enter:
Find your Beam project folder, then enter:
Use
cpack
to get.dmg file.
Find Beam project folder and then enter:Locate the completed Beam node in the
beam/wallet/cli
andbeam/explorer
subfolders
Last updated