node installation guide - fraxeum

Node Installation Guide Version 1.0

Release date: 24 July 2019

Node Installation Guide v1.0

Document History

Release Author Contribution Date Notes

v1.0 Llew Morkel

llew@Fraxeum.

org

Ernst Naude,

Avi Tenzer,

Others

24 July 2019 Initial release

1


Table of contents

Document History 1

Table of contents 2

Introduction 3 Essential reading 3

Mining requirements 4 Minimum system requirement 4 Indicative Mining Cost 4

Miner installation guide 6 The auto install shell script 6 Step 1: User identity verification 6 Step 2: Install your first node 6

What you need 6 Advanced users 8

Step-by-step node installation guide 10 Step-by-step mining node installation guide 10

Pre-requisites: 10 Step 1: Copy the startup script code 10 Step 2: Register a Vultr.com account 10 Step 3: Create a startup script 11 Step 4: Create your first node 13

Node wallet 15

2


Introduction Fraxeum implements a permissioned blockchain forked from the Multichain core source code. The

purpose of this document is to:

1. Provide step by step instructions on how to install and launch a Fraxeum miner node.

2. Understand the blockchain rewards structure.

Essential reading

Before continuing, please read the Fraxeum Whitepaper, with special focus on the following

sections:

1. The Fraxeum Blockchain: Pages 11 to 18

2. Coin types: Pages 25 to 27

Fraxeum whitepaper: https://fraxeum.org/whitepaper/Fraxeum_Whitepaper.pdf

3


Mining requirements

Minimum system requirement

Both Admin and Miner nodes run the same software.

Operating System Specification

Linux 64-bit Supports Ubuntu 12.04+, CentOS 6.2+, Debian 7+, Fedora

15+, RHEL 6.2+.

Windows: 64-bit 1 Supports Windows 7, 8, 10, Server 2008 or later.

Mac: 64-bit 2 Supports OS X 10.11 or later.

Hardware Specification

RAM 1 GB

Storage 2 GB (Will increase with time)

IP Addresses 1x Dedicated

Indicative Mining Cost

Virtual Hosting Aggregator

Specification Monthly cost (hourly cost)

Vultr.com 55GB SSD Storage, 1 CPU, 2GB RAM, 2TB

Bandwidth

$10 ($0.015)

DigitalOcean 50GB SSD Storage, 1 CPU, 2GB RAM, 2TB

Bandwidth

1 Not currently available. 2 Not currently available.

4


Kamatera 50GB SSD Storage, 1 CPU, 2GB RAM, 2TB

Bandwidth

$19 ($0.026)

Note: Quote based on 13 July 2019 pricing with 64-bit Ubuntu 18.04 operating system.

NOTE: Detail like how miners are rewarded, how miner rewards are claimed etc are

available in the Fraxeum whitepaper, here:

https://fraxeum.org/whitepaper/Fraxeum_Whitepaper.pdf

5


Miner installation guide

The auto install shell script

Shell script will attempt to run a basic server upgrade to ensure that the latest software and

security updates are installed. It will then download the latest version of the Multichain

blockchain from the Fraxeum Git repository, install it and configure it on the server. The

script will attempt to start and activate the node. Upon successful activation, the system will

register a function with the server that will restart the node automatically after a server

reboot.

● Errors will be logged in /tmp/firstboot.log

● An app directory will be created (if not errors are encountered): /apps

● A node activation log will be created: /apps/miner_activation_log.dat

Step 1: User identity verification

What you need: 1. Mobile phone

2. Telegram app

What you do: 1. Open the following link from your mobile phone: https://mine.fraxeum.org

2. Complete the Telegram basic user verification process.

Step 2: Install your first node

NOTE: This section is for experienced Linux users. If you are not confident in Linux system

administration then we recommend skipping past this section to the “Step-by-Step Node

Installation Guide” which follows after this section.

What you need

1. A virtual machine (or server) that matches or exceeds the minimum system

requirements - specified above.

6

https://mine.fraxeum.org/


(Don’t know what this is or how to get it? We’ll guide you with a step-by-step tutorial

at the end of this document.)

2. The Fraxeum Linux startup script located here (or follow link from Fraxeum.org

website):

https://raw.githubusercontent.com/Fraxeum/MiningNode/master/fraxeum-node-v01/n

ode-linux/linux_startup_script.sh

3. The same email address you used when you verified your identity.

7

https://raw.githubusercontent.com/Fraxeum/MiningNode/master/fraxeum-node-v01/node-linux/linux_startup_script.sh



Advanced users

Edit the install script:

● Review the install script and make changes to suit your environment.

● Add your verified email address to the script.

● Uncomment/Comment the Fraxeum target network that you want to connect to - by

default TESTNET is selected.

● Run the script.

If you make changes to the script or find errors which you are able to resolve, please send

us a the update script with a compatibility note. We’d like to share that on the Git to help

other users.

The node should startup by itself.

Nodes are assigned the following permissions:

Role Permissions Conditions

Observer Connect None

Node Connect, Send, Receive Fraxeum Clients

Miner Connect, Send, Receive, Mine

Telegram identity verification, max 5 per approved identity, requires admin approval vote.

Admin Full permissions Telegram identity verification, personally verified and appointed as admin.

Check if node installed properly: /apps/miner_activation_report.dat will contain information about your node deployment.

8


Basic commands NOTE: Assumes you are in /apps directory

Interactive mode

./multichain-cli

-datadir="./datadir"

[CHAINNAME]

You can work on normal mode or

interactive mode. Interactive mode

is easier.

Start node But a call to start_node in the

/apps directory will also start the

node.

Starts the node, if not already

running.

Stop node CHAINNAME=[Fr

axTest or

Fraxeum]

stop Stops the node, if not already

stopped.

Node status getinfo

Returns a list of general node and

blockchain information.

Node wallet balance

gettotalbalances

Returns all balances for all assets

held in all addresses in this node’s

wallet.

Node permissions

Listpermissions *

[address]

Where * is for all permission types

and address is the specific

address that you are querying.

Omit both for details about all

addresses.

Add address getnewaddress Adds an address to your wallet.

Send assets sendassetfrom [from-address]

[to-address] asset amount

(comment) (comment-to)

Sends assets (coins or tokens

from one address to another)

Node API: https://www.multichain.com/developers/json-rpc-api/

9

https://www.multichain.com/developers/json-rpc-api/


Step-by-step node installation guide The following guide will lead you to create a Vultr.com account - we chose Vultr simply

because their service is good and the install process is very simple. You can use any other

provider that you may choose.

Please note that we are not making any guarantees with regards to this script. If it fails to

install or if you get stuck, you may need to consult a Linux expert - there are quite few of

them on the Fraxeum Telegram Group (https://t.me/fraxeum). Depending on what you need

them to do it may end up costing you some money - please negotiate rates upfront.

Step-by-step mining node installation guide

Pre-requisites:

1. You have completed the Telegram identity verification process.

2. You know what email address you used during the Telegram identity verification

process.

Step 1: Copy the startup script code

1. Open this link:



2. Copy and paste the entire code - Click anywhere inside the screen, press CTRL-A,

press CTRL-C (CMD-A, CMD-C if on Mac).

3. Keep this window open, in case you need to copy this again.

STEP 1 COMPLETE

Step 2: Register a Vultr.com account

1. Open Vultr.com

2. Click/Tap the Sign Up button (top right of screen)

3. Complete the signup form and verify your email address.

STEP 2 COMPLETE

10

https://t.me/fraxeum


Step 3: Create a startup script

1. On the left menu, select “Products”.

2. Then select the fourth tab “Startup Scripts”.

3. At the top-right of the page (ABOVE the blue “+” button) is a blue “Add Startup Script”

button. Click it.

4. Delete everything in the text box. The text box must be completely empty before you

proceed (other than the placeholder text “Script”, see below:

5. Paste (CTRL-V or CMD-V) the contents of the clipboard to the Script textbox.

Ensure that the full content of this page has been pasted into the box:



11




6. Double check that the script is all there:

Top of script - script starts with the following text:

Bottom of script - script ends with the following text:

7. Look for Section 1 in the script code. Then add your verified email address between

the parenthesis in this statement:

○ BEFORE: email_address="YOUR_EMAIL_ADDY_HERE" &&

○ AFTER: email_address="[email protected]" &&

8. Enter an easily identifiable name for the script in the “name” text field, example:

Fraxeum TESTNET Script

9. Leave the “Type” as “boot”.

10. Click on the Add Script button.

STEP 3 COMPLETE

12


Step 4: Create your first node

1. Log into Vultr.com

2. Deploy new server: Click the blue circle with a white “+” icon (located on the right of

the screen to the top).

3. Choose server: Select the first item - Cloud Compute

4. Choose a server location: You can select any one of the available locations.

5. Choose server type: Stay on the first tab, look for UBUNTU and select one of the

dropdown options.

13


6. Choose server size: Select the $5 option for a TESTNET node or the $10 option (or

greater) for a MAINNET node.

7. Select startup script: The startup script you created earlier should appear here.

Select it. If it doesn’t you can click on the Manage link to create it again.

8. Scroll to the bottom and give your server a name: Keep it short with no spaces,

example: MyNode01

14


9. Finally, click the Deploy Now button.

STEP 4 COMPLETE

After about 3-minutes your server should be connected to the Fraxeum network. You will be

able to verify that your server is connected in the Fraxeum App, under “Mining”.

NOTE: Make sure that the Fraxeum App is connected to the same Fraxeum blockchain

(testnet or mainnet) you selected when you selected to install the node.

Check like this:

Node wallet Each node is provisioned with its own wallet. All your miner rewards are automatically

deposited into the node wallet.

The Fraxeum App will soon be available to download on the iOS Appstore and Google

Playstore.

15

node installation guide - fraxeum

Documents