Add support for BEAM

[blackmennewstyle]

Commit 99d3777 officially adds support for BEAM 🔥 🚀

In order to work properly the following procedure details how to install and setup a BEAM node for pool mining.

Node installation/update

(with root privileges)

apt-get install g++ git make cmake libboost-all-dev zlib1g-dev libssl-dev

(without root privileges)

git clone https://github.com/BeamMW/beam.git
cd ~/beam/

(TESTNET)
(without root privileges)

git checkout testnet

(MAINNET)
(without root privileges)

git checkout <tag-release>

Replace <tag-release> with the correct release to install: https://github.com/BeamMW/beam/releases

(without root privileges)

git submodule update --init --recursive
vim CMakeLists.txt

(TESTNET)
Modify the CMakeLists.txt file accordingly:

# uncomment next line for testnet
set(BEAM_TESTNET TRUE CACHE INTERNAL "")
# uncomment next line for mainnet
#set(BEAM_MAINNET TRUE CACHE INTERNAL "")
# uncomment next line for dappnet
#set(BEAM_DAPPNET TRUE CACHE INTERNAL "")

# uncomment next line for swap mainnet
#set(SWAP_MAINNET TRUE)

(MAINNET)
Modify the CMakeLists.txt file accordingly:

# uncomment next line for testnet
#set(BEAM_TESTNET TRUE CACHE INTERNAL "")
# uncomment next line for mainnet
set(BEAM_MAINNET TRUE CACHE INTERNAL "")
# uncomment next line for dappnet
#set(BEAM_DAPPNET TRUE CACHE INTERNAL "")

# uncomment next line for swap mainnet
#set(SWAP_MAINNET TRUE)

(without root privileges)

cmake -DCMAKE_BUILD_TYPE=Release . && make -j2

(TESTNET)
(with root privileges)

cp -rf /home/<user>/beam/beam/beam-node-testnet /usr/local/bin/.
cp -rf /home/<user>/beam/wallet/cli/beam-wallet-testnet /usr/local/bin/.
cp -rf /home/<user>/beam/wallet/api/wallet-api-testnet /usr/local/bin/.
cp -rf /home/<user>/beam/explorer/explorer-node-testnet /usr/local/bin/.

Replace <user> with the one used for cloning the beam repository.

(MAINNET)
(with root privileges)

cp -rf /home/<user>/beam/beam/beam-node /usr/local/bin/.
cp -rf /home/<user>/beam/wallet/cli/beam-wallet /usr/local/bin/.
cp -rf /home/<user>/beam/wallet/api/wallet-api /usr/local/bin/.
cp -rf /home/<user>/beam/explorer/explorer-node /usr/local/bin/.

Replace <user> with the one used for cloning the beam repository.

(TESTNET)

(without root privileges)

mkdir -p /home/<user>/.beam/testnet/secrets
chmod -R 700 /<user>/ceedii/.beam/testnet/secrets

Replace <user> with the one used for cloning the beam repository.

(MAINNET)
(without root privileges)

mkdir -p /home/<user>/.beam/mainnet/secrets
chmod -R 700 /home/<user>/.beam/mainnet/secrets

Replace <user> with the one used for cloning the beam repository.

In order to upgrade the node, just repeat the same procedure in the future.

Node configuration

BEAM node is actually composed of 4 daemons called respectively: beam-node, beam-wallet, wallet-api and explorer-node. In order to run BEAM mining pool in miningcore, you only need to use 3 daemons: beam-node, wallet-api and explorer-node.
But all the 4 daemons must be configured properly.

beam-wallet daemon
(TESTNET)
(without root privileges)

cd
vim ~/.beam/beam-wallet-testnet.cfg

This file must contain the following:

################################################################################
# General options:
################################################################################

# log level [info|debug|verbose]
log_level=debug

# file log level [info|debug|verbose]
file_log_level=debug

# old logs cleanup period (days)
log_cleanup_days=1

################################################################################
# Wallet options:
################################################################################

# password for the wallet
pass=<password>

# phrase to generate secret key according to BIP-39.
# seed_phrase=

# address of node
node_addr=127.0.0.1:11000

# path to wallet file
wallet_path=/home/<user>/.beam/testnet/wallet.db

# command to execute [new_addr|send|receive|listen|init|info|export_miner_key|export_owner_key|generate_phrase]
command=listen

Replace respectively <password> with a password of your choice (only alphanumeric characters) and <user> with the one used for cloning the beam repository.

(MAINNET)
(without root privileges)

cd
vim ~/.beam/beam-wallet.cfg

This file must contain the following:

################################################################################
# General options:
################################################################################

# log level [info|debug|verbose]
log_level=info

# file log level [info|debug|verbose]
file_log_level=info

# old logs cleanup period (days)
log_cleanup_days=1

################################################################################
# Wallet options:
################################################################################

# password for the wallet
pass=<password>

# phrase to generate secret key according to BIP-39.
# seed_phrase=

# address of node
node_addr=127.0.0.1:8100

# path to wallet file
wallet_path=/home/<user>/.beam/mainnet/wallet.db

# command to execute [new_addr|send|receive|listen|init|info|export_miner_key|export_owner_key|generate_phrase]
command=listen

Replace respectively <password> with a password of your choice (only alphanumeric characters) and <user> with the one used for cloning the beam repository.

Create new pool wallet

(TESTNET)
(without root privileges)

cd /home/<user>/.beam/testnet/ && beam-wallet-testnet --config_file=/home/<user>/.beam/beam-wallet-testnet.cfg init

Replace <user> with the one used for cloning the beam repository.

(MAINNET)
(without root privileges)

cd /home/<user>/.beam/mainnet/ && beam-wallet --config_file=/home/<user>/.beam/beam-wallet.cfg init

Replace <user> with the one used for cloning the beam repository.

MANDATORY: Set default address to never expire

Once you created a new pool wallet, you will receive a default wallet, it must be configured to never expire.

(TESTNET)
(without root privileges)

cd /home/<user>/.beam/testnet/ && beam-wallet-testnet --config_file=/home/<user>/.beam/beam-wallet-testnet.cfg change_address_expiration --address=<default_address> --expiration_time=never

Replace respectively <default_address> with the default wallet address received when previously created and <user> with the one used for cloning the beam repository.

(MAINNET)
(without root privileges)

cd /home/<user>/.beam/mainnet/ && beam-wallet --config_file=/home/<user>/.beam/beam-wallet.cfg change_address_expiration --address=<default_address> --expiration_time=never

Replace respectively <default_address> with the default wallet address received when previously created and <user> with the one used for cloning the beam repository.

Generate miner_key
It will be used later when configuring beam-node daemon.

(TESTNET)
(without root privileges)

cd /home/<user>/.beam/testnet/ && beam-wallet-testnet --config_file=/home/<user>/.beam/beam-wallet-testnet.cfg export_miner_key --subkey=1

Replace <user> with the one used for cloning the beam repository.

(MAINNET)
(without root privileges)

cd /home/<user>/.beam/mainnet/ && beam-wallet --config_file=/home/<user>/.beam/beam-wallet.cfg export_miner_key --subkey=1

Replace <user> with the one used for cloning the beam repository.

Generate owner_key
It will be used later when configuring beam-node daemon.

(TESTNET)
(without root privileges)

cd /home/<user>/.beam/testnet/ && beam-wallet-testnet --config_file=/home/<user>/.beam/beam-wallet-testnet.cfg export_owner_key

Replace <user> with the one used for cloning the beam repository.

(MAINNET)
(without root privileges)

cd /home/<user>/.beam/mainnet/ && beam-wallet --config_file=/home/<user>/.beam/beam-wallet.cfg export_owner_key

Replace <user> with the one used for cloning the beam repository.

beam-node daemon
(TESTNET)
(without root privileges)

cd
vim ~/.beam/beam-node-testnet.cfg

This file must contain the following:

################################################################################
# General options:
################################################################################

# port to start server on
port=11000

# log level [info|debug|verbose]
log_level=verbose

# file log level [info|debug|verbose]
file_log_level=verbose

# old logs cleanup period (days)
log_cleanup_days=1

peers_persistent=1
mining_threads=1
verification_threads=0
#FakePoW=1
miner_job_latency=250

################################################################################
# Node options:
################################################################################

# node storage path
storage=/home/<user>/.beam/testnet/node.db

# nodes to connect to
#peer=testnet.raskul.com:10127
peer=ap-nodes.testnet.beam.mw:8100
#peer=ap-hk-nodes.testnet.beam.mw:8100
peer=eu-nodes.testnet.beam.mw:8100
peer=us-nodes.testnet.beam.mw:8100

# port to start stratum server on
stratum_port=11001

# path to stratum server api keys file, and tls certificate and private key
stratum_secrets_path=/home/<user>/.beam/testnet/secrets/

# enable TLS on startum server
stratum_use_tls=0

# port to start websocket server on, it allows to communicate with node from web browser
# websocket_port=11001

# path to websocket server api keys file, and tls certificate and private key
# websocket_secrets_path=/home/<user>/.beam/testnet/secrets/

# enable TLS on websocket server
# websocket_use_tls=0

# Enforce re-synchronization (soft reset)
# resync=0

# Owner viewer key
owner_key=<owner_key>

# Standalone miner key
miner_key=<miner_key>

# password for keys
pass=<password>

# Fork1 height
# Fork1=

# Path to treasury for testing
# treasury_path=

Replace respectively <password>, <owner_key> and <miner_key> with the same values previously used in the beam-wallet daemon .cfg file. Replace <user> with the one used for cloning the beam repository.

(MAINNET)
(without root privileges)

cd
vim ~/.beam/beam-node.cfg

This file must contain the following:

################################################################################
# General options:
################################################################################

# port to start server on
port=8100

# log level [info|debug|verbose]
log_level=info

# file log level [info|debug|verbose]
file_log_level=info

# old logs cleanup period (days)
log_cleanup_days=1

peers_persistent=1
mining_threads=1
verification_threads=0
#FakePoW=1
miner_job_latency=250

################################################################################
# Node options:
################################################################################

# node storage path
storage=/home/<user>/.beam/mainnet/node.db

# nodes to connect to
peer=eu-nodes.mainnet.beam.mw:8100
peer=us-nodes.mainnet.beam.mw:8100
peer=ap-nodes.mainnet.beam.mw:8100
peer=ap-hk-nodes.mainnet.beam.mw:8100

# port to start stratum server on
stratum_port=8101

# path to stratum server api keys file, and tls certificate and private key
stratum_secrets_path=/home/<user>/.beam/mainnet/secrets/

# enable TLS on startum server
stratum_use_tls=0

# port to start websocket server on, it allows to communicate with node from web browser
# websocket_port=8101

# path to websocket server api keys file, and tls certificate and private key
# websocket_secrets_path=/home/<user>/.beam/mainnet/secrets/

# enable TLS on websocket server
# websocket_use_tls=0

# Enforce re-synchronization (soft reset)
# resync=0

# Owner viewer key
owner_key=<owner_key>

# Standalone miner key
miner_key=<miner_key>

# password for keys
pass=<password>

Replace respectively <password>, <owner_key> and <miner_key> with the same values previously used in the beam-wallet daemon .cfg file. Replace <user> with the one used for cloning the beam repository.

wallet-api daemon
(TESTNET)
(without root privileges)

cd
vim ~/.beam/wallet-api-testnet.cfg

This file must contain the following:

################################################################################
# Wallet API general options:
################################################################################

# log level [info|debug|verbose]
log_level=verbose

# file log level [info|debug|verbose]
file_log_level=verbose

# old logs cleanup period (days)
log_cleanup_days=1

# password for the wallet
pass=<password>

# address of node
node_addr=127.0.0.1:11000

# path to wallet file
wallet_path=/home/<user>/.beam/testnet/wallet.db

# port to start server on
port=10000

# use JSON RPC over HTTP
use_http=1

# IP whitelist (comma separated)
# ip_whitelist=127.0.0.1,...

################################################################################
# User authorization options:
################################################################################

# use Access Control List (ACL)
# use_acl=0

# path to ACL file
# acl_path=wallet_api.acl

################################################################################
# TLS protocol options:
################################################################################

# use TLS protocol
# use_tls=0

# path to TLS certificate
# tls_cert=wallet_api.crt

# path to TLS private key
# tls_key=wallet_api.key

Replace <password> with the same value previously used in the beam-wallet daemon .cfg file and <user> with the one used for cloning the beam repository.

(MAINNET)
(without root privileges)

cd
vim ~/.beam/wallet-api.cfg

This file must contain the following:

################################################################################
# Wallet API general options:
################################################################################

# log level [info|debug|verbose]
log_level=info

# file log level [info|debug|verbose]
file_log_level=info

# old logs cleanup period (days)
log_cleanup_days=1

# password for the wallet
pass=<password>

# address of node
node_addr=127.0.0.1:8100

# path to wallet file
wallet_path=/home/<user>/.beam/mainnet/wallet.db

# port to start server on
port=10000

# use JSON RPC over HTTP
use_http=1

# IP whitelist (comma separated)
# ip_whitelist=127.0.0.1,...

################################################################################
# User authorization options:
################################################################################

# use Access Control List (ACL)
# use_acl=0

# path to ACL file
# acl_path=wallet_api.acl

################################################################################
# TLS protocol options:
################################################################################

# use TLS protocol
# use_tls=0

# path to TLS certificate
# tls_cert=wallet_api.crt

# path to TLS private key
# tls_key=wallet_api.key

Replace <password> with the same value previously used in the beam-wallet daemon .cfg file and <user> with the one used for cloning the beam repository.

explorer-node daemon
(TESTNET)
(without root privileges)

cd
vim ~/.beam/explorer-node-testnet.cfg

This file must contain the following:

################################################################################
# Node explorer options:
################################################################################

# peer address
peer=127.0.0.1:11000

# port to start the local node on
port=10001

# port to start the local api server on
api_port=10002

# owner viewer key
key_owner=<owner_key>

# password for owner key
pass=<password>

# IP whitelist (comma separated)
# ip_whitelist=127.0.0.1

# old logs cleanup period (days)
log_cleanup_days=1

Replace respectively <password> and <owner_key> with the same values previously used in the beam-wallet daemon .cfg file. Replace <user> with the one used for cloning the beam repository.

(MAINNET)
(without root privileges)

cd
vim ~/.beam/explorer-node.cfg

This file must contain the following:

################################################################################
# Node explorer options:
################################################################################

# peer address
peer=127.0.0.1:8100

# port to start the local node on
port=10001

# port to start the local api server on
api_port=10002

# owner viewer key
key_owner=<owner_key>

# password for owner key
pass=<password>

# IP whitelist (comma separated)
# ip_whitelist=127.0.0.1

# old logs cleanup period (days)
log_cleanup_days=1

Replace respectively <password> and <owner_key> with the same values previously used in the beam-wallet daemon .cfg file. Replace <user> with the one used for cloning the beam repository.

How to run the daemons?

The daemons should always be ran respecting the following command-lines and also specific order.

(TESTNET)
(without root privileges)

cd /home/<user>/.beam/testnet/ && beam-node-testnet --config_file=/home/<user>/.beam/beam-node-testnet.cfg
cd /home/<user>/.beam/testnet/ && wallet-api-testnet --config_file=/home/<user>/.beam/wallet-api-testnet.cfg --enable_lelantus
cd /home/<user>/.beam/testnet/ && explorer-node-testnet --config_file=/home/<user>/.beam/explorer-node-testnet.cfg

Replace <user> with the one used for cloning the beam repository.

(MAINNET)
(without root privileges)

cd /home/<user>/.beam/mainnet/ && beam-node --config_file=/home/<user>/.beam/beam-node.cfg
cd /home/<user>/mainnet/ && wallet-api --config_file=/home/<user>/.beam/wallet-api.cfg --enable_lelantus
cd /home/<user>/.beam/mainnet/ && explorer-node --config_file=/home/<user>/.beam/explorer-node.cfg

Replace <user> with the one used for cloning the beam repository.

How to configure confg.json for BEAM?

A pool configuration for BEAM can be found inside the examples folder: https://github.com/blackmennewstyle/miningcore/blob/dev/examples/beam_pool.json

Replace all the specific options with the correct values for each required daemon. <Miner registration key <api_key> should be replaced with the same value for miner_key= used in the beam-node daemon .cfg file.

Although the pool configuration has a wallet daemon type, it's actually the values from the wallet-api daemon .cfg file which should be used for that section.

[blackmennewstyle]

Commit 5bb86a0 improves the implementation of libbeamhash C++ POW library, thanks to https://gitlab.mmpos.eu/ddobreff/libbeamhash/-/tree/main for the contribution.