Installation f(x)Core

This guide will explain how to install the fxcored CLI onto your system. With this installed on a server, you can participate on the mainnet as either a Full Node or a Validator.

Additionally, you may refer to this YouTube tutorial video to set up your validator.

Hardware Requirements

We recommend the following for running f(x)Core:

• 4 or more CPU cores

• At least 500G of disk storage

• At least 8G of memory

• At least 10mbps network bandwidth

To see a quick cloud setup on how to setup and deploy it on the cloud.

Install build requirements

Install make and gcc.

On Ubuntu this can be done with the following commands:

Ubuntu

sudo apt-get update

sudo apt-get install -y make gcc

Ps: sudo apt-get install -y make gcc may have encountered a problem with locked files, just try sudo apt-get install -y make gcc again.

Mac

Ensure you have Homebrew installed.

Once you have Homebrew installed, you may run the following commands to install make :

brew install make

and gcc:

brew install gcc

We'll be needing these commands later so let's install the necessary packages:

brew install git

brew install wget

Windows

You will need to run git bash. You may find the installation link here.

Ensure you have make and gcc installed and that the paths are set correctly for git bash.

One option for installing gcc can be found here.

You may select tdm64-gcc-10.3.0-2

Restart gitbash after installing

One option for installing make is using chocolate , more information can be found here.

Once you have chocolate installed, run this command:

make sure to run gitbash as administrator mode if the following commands do not work

choco install make

Ensure you have all the necessary dependencies and compilers.

gcc --version

will return:

gcc.exe (tdm64-1) 10.3.0
Copyright (C) 2020 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE

and for make:

make --version

will return:

GNU Make 4.3
Built for Windows32
Copyright (C) 1988-2020 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Install Go

All other environments

Install go by following the official docs. Please select your respective environment❗

For Ubuntu environment, there may be permissions denied issues with unzipping the go zip file, try using sudo su to resolve it.

If you are remoting into a terminal

Especially if you are remoting into a Ubuntu terminal, run this command to download the go installer:

wget -c https://dl.google.com/go/go1.20.3.linux-amd64.tar.gz

After you have downloaded the package and you may proceed to step 2 of the official docs. Choose your system OS and follow the instructions stated.

Go 1.19+ or later is required for the f(x)Core. If you are remoting into a terminal, you may input the following command:

Setting environment variables:

mkdir -p $HOME/go/bin
echo "export PATH=$PATH:/usr/local/go/bin" >> ~/.profile
echo "export PATH=$PATH:$(go env GOPATH)/bin" >> ~/.profile
source ~/.profile

Install the binaries

Next, let's install the latest version of f(x)Core. Make sure you have git installed if not you will be prompted to install git. Follow the instruction in the terminal.

Mainnet

git clone --branch release/v3.1.x https://github.com/functionx/fx-core.git

cd fx-core

Testnet

git clone --branch release/v3.1.x https://github.com/functionx/fx-core.git

cd fx-core

Windows

You should run your commands in gitbash. But open fxcored.exe file using cmd prompt

Make sure the name of your folder does not have whitespaces!

git clone --branch release/v3.1.x https://github.com/functionx/fx-core.git

cd fx-core

You may find the latest branches here: https://github.com/FunctionX/fx-core/branches

All Other Environments

make go.sum

make install

Windows

make go.sum

make build-win

use cmd prompt to open the fxcored.exe file

in the path ./build/bin/fxcored.exe

That will install the fxcored binary. Verify version:

Long version

fxcored version --long

Short version

fxcored version

fxcored version --long should output something similar to:

name: fxcore
server_name: fxcored
version: release/vx.x.x xxx
commit: xxx
build_tags: netgo,ledger
go: go version go1.19 darwin/amd64
build_deps:
...
cosmos_sdk_version: v0.xx.x

Build Tags

Build tags indicate special features that have been enabled in the binary.

Build Tag	Description
netgo	Name resolution will use pure Go code
ledger	Ledger devices are supported (hardware wallets)