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.
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 make and gcc.
On Ubuntu this can be done with the following commands:
{% tabs %} {% tab title="Ubuntu" %}
sudo apt-get update
sudo apt-get install -y make gcc
Ps:
sudo apt-get install -y make gccmay have encountered a problem with locked files, just trysudo apt-get install -y make gccagain. {% endtab %}
{% tab title="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
{% endtab %}
{% tab title="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.
{% hint style="info" %} You may select tdm64-gcc-10.3.0-2
Restart gitbash after installing {% endhint %}
One option for installing make is using chocolate , more information can be found here.
Once you have chocolate installed, run this command:
{% hint style="info" %} make sure to run gitbash as administrator mode if the following commands do not work {% endhint %}
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.
{% endtab %} {% endtabs %}
{% tabs %}
{% tab title="All other environments" %}
Install go by following the official docs. Please select your respective environment❗
For Ubuntu environment, there may be
permissions deniedissues with unzipping the go zip file, try usingsudo suto resolve it. {% endtab %}
{% tab title="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
{% hint style="info" %} 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. {% endhint %} {% endtab %} {% endtabs %}
{% hint style="info" %} 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: {% endhint %}
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
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.
{% tabs %} {% tab title="Mainnet" %}
git clone --branch release/v3.1.x https://github.com/functionx/fx-core.git
cd fx-core
{% endtab %}
{% tab title="Testnet" %}
git clone --branch release/v3.1.x https://github.com/functionx/fx-core.git
cd fx-core
{% endtab %}
{% tab title="Windows" %} {% hint style="info" %} 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! {% endhint %}
git clone --branch release/v3.1.x https://github.com/functionx/fx-core.git
cd fx-core
{% endtab %} {% endtabs %}
{% hint style="info" %} You may find the latest branches here: https://github.com/FunctionX/fx-core/branches {% endhint %}
{% tabs %} {% tab title="All Other Environments " %}
make go.sum
make install
{% endtab %}
{% tab title="Windows " %}
make go.sum
make build-win
{% hint style="info" %} use cmd prompt to open the fxcored.exe file
in the path ./build/bin/fxcored.exe {% endhint %} {% endtab %} {% endtabs %}
That will install the fxcored binary. Verify version:
{% tabs %} {% tab title="Short version" %}
fxcored version
{% endtab %}
{% tab title="Long version" %}
fxcored version --long
{% endtab %} {% endtabs %}
fxcored version --long should output something similar to:
build_deps:
- cloud.google.com/[email protected]
- cloud.google.com/go/compute/[email protected]
- cloud.google.com/go/[email protected]
- cloud.google.com/go/[email protected]
- cosmossdk.io/[email protected]
- cosmossdk.io/[email protected]
- cosmossdk.io/[email protected]
- cosmossdk.io/[email protected]
- cosmossdk.io/[email protected]
- cosmossdk.io/[email protected]
- cosmossdk.io/tools/[email protected]
- filippo.io/[email protected]
- github.com/99designs/[email protected] => github.com/cosmos/[email protected]
- github.com/ChainSafe/[email protected]
- github.com/DataDog/[email protected]
- github.com/VictoriaMetrics/[email protected]
- github.com/armon/[email protected]
- github.com/aws/[email protected]
- github.com/beorn7/[email protected]
- github.com/bgentry/[email protected]
- github.com/bgentry/[email protected]
- github.com/btcsuite/[email protected]
- github.com/btcsuite/btcd/btcec/[email protected]
- github.com/btcsuite/btcd/[email protected]
- github.com/btcsuite/btcd/chaincfg/[email protected]
- github.com/btcsuite/[email protected]
- github.com/cenkalti/backoff/[email protected]
- github.com/cespare/xxhash/[email protected]
- github.com/chzyer/[email protected]
- github.com/cockroachdb/apd/[email protected]
- github.com/cockroachdb/[email protected]
- github.com/cockroachdb/[email protected]
- github.com/cockroachdb/[email protected]
- github.com/cockroachdb/[email protected]
- github.com/coinbase/[email protected]
- github.com/cometbft/[email protected]
- github.com/cometbft/[email protected]
- github.com/confio/ics23/[email protected]
- github.com/cosmos/[email protected]
- github.com/cosmos/[email protected]
- github.com/cosmos/[email protected]
- github.com/cosmos/[email protected]
- github.com/cosmos/[email protected]
- github.com/cosmos/[email protected] => github.com/cosmos/[email protected]
- github.com/cosmos/[email protected] => github.com/cosmos/[email protected]
- github.com/cosmos/ibc-go/[email protected]
- github.com/cosmos/ics23/[email protected]
- github.com/cosmos/[email protected] => github.com/cosmos/[email protected]
- github.com/cosmos/[email protected]
- github.com/creachadair/[email protected]
- github.com/davecgh/[email protected]
- github.com/deckarep/golang-set/[email protected]
- github.com/decred/dcrd/dcrec/secp256k1/[email protected]
- github.com/desertbit/[email protected]
- github.com/dlclark/[email protected]
- github.com/dop251/[email protected]
- github.com/dvsekhvalnov/[email protected]
- github.com/edsrzf/[email protected]
- github.com/ethereum/[email protected] => github.com/functionx/[email protected]
- github.com/evmos/[email protected] => github.com/functionx/[email protected]
- github.com/fbsobreira/[email protected]
- github.com/felixge/[email protected]
- github.com/fsnotify/[email protected]
- github.com/gballet/[email protected]
- github.com/getsentry/[email protected]
- github.com/go-kit/[email protected]
- github.com/go-kit/[email protected]
- github.com/go-logfmt/[email protected]
- github.com/go-logr/[email protected]
- github.com/go-logr/[email protected]
- github.com/go-sourcemap/[email protected]+incompatible
- github.com/go-stack/[email protected]
- github.com/godbus/[email protected]
- github.com/gofrs/[email protected]
- github.com/gogo/[email protected]
- github.com/gogo/[email protected]
- github.com/golang/[email protected]
- github.com/golang/[email protected]
- github.com/golang/[email protected]
- github.com/golang/[email protected]
- github.com/google/[email protected]
- github.com/google/[email protected]
- github.com/google/[email protected]
- github.com/google/[email protected]
- github.com/google/[email protected]
- github.com/googleapis/[email protected]
- github.com/googleapis/gax-go/[email protected]
- github.com/gorilla/[email protected]
- github.com/gorilla/[email protected]
- github.com/gorilla/[email protected]
- github.com/grpc-ecosystem/[email protected]
- github.com/grpc-ecosystem/[email protected]
- github.com/gsterjov/[email protected]
- github.com/gtank/[email protected]
- github.com/gtank/[email protected]
- github.com/hashicorp/[email protected]
- github.com/hashicorp/[email protected]
- github.com/hashicorp/[email protected]
- github.com/hashicorp/[email protected]
- github.com/hashicorp/[email protected]
- github.com/hashicorp/[email protected]
- github.com/hashicorp/golang-lru/[email protected]
- github.com/hashicorp/[email protected]
- github.com/hdevalence/[email protected]
- github.com/holiman/bloomfilter/[email protected]
- github.com/holiman/[email protected]
- github.com/huandu/[email protected]
- github.com/huin/[email protected]
- github.com/improbable-eng/[email protected]
- github.com/jackpal/[email protected]
- github.com/jmespath/[email protected]
- github.com/klauspost/[email protected]
- github.com/kr/[email protected]
- github.com/kr/[email protected]
- github.com/lib/[email protected]
- github.com/magiconair/[email protected]
- github.com/manifoldco/[email protected]
- github.com/mattn/[email protected]
- github.com/mattn/[email protected]
- github.com/mattn/[email protected]
- github.com/matttproud/[email protected]
- github.com/mimoo/[email protected]
- github.com/minio/[email protected]
- github.com/mitchellh/[email protected]
- github.com/mitchellh/[email protected]
- github.com/mitchellh/[email protected]
- github.com/mtibben/[email protected]
- github.com/olekukonko/[email protected]
- github.com/pelletier/go-toml/[email protected]
- github.com/pkg/[email protected]
- github.com/pmezard/[email protected]
- github.com/prometheus/[email protected]
- github.com/prometheus/[email protected]
- github.com/prometheus/[email protected]
- github.com/prometheus/[email protected]
- github.com/rakyll/[email protected]
- github.com/rcrowley/[email protected]
- github.com/rogpeppe/[email protected]
- github.com/rs/[email protected]
- github.com/rs/[email protected]
- github.com/sagikazarmark/[email protected]
- github.com/shengdoushi/[email protected]
- github.com/shirou/[email protected]+incompatible
- github.com/shirou/gopsutil/[email protected]
- github.com/spf13/[email protected]
- github.com/spf13/[email protected]
- github.com/spf13/[email protected]
- github.com/spf13/[email protected]
- github.com/spf13/[email protected]
- github.com/status-im/[email protected]
- github.com/stretchr/[email protected]
- github.com/subosito/[email protected]
- github.com/syndtr/[email protected] => github.com/syndtr/[email protected]
- github.com/tendermint/[email protected]
- github.com/tidwall/[email protected]
- github.com/tidwall/[email protected]
- github.com/tidwall/[email protected]
- github.com/tidwall/[email protected]
- github.com/tidwall/[email protected]
- github.com/tklauser/[email protected]
- github.com/tklauser/[email protected]
- github.com/tyler-smith/[email protected]
- github.com/ulikunitz/[email protected]
- github.com/zondax/[email protected]
- github.com/zondax/[email protected]
- [email protected]
- go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/[email protected]
- go.opentelemetry.io/contrib/instrumentation/net/http/[email protected]
- go.opentelemetry.io/[email protected]
- go.opentelemetry.io/otel/[email protected]
- go.opentelemetry.io/otel/[email protected]
- golang.org/x/[email protected]
- golang.org/x/[email protected] => golang.org/x/[email protected]
- golang.org/x/[email protected]
- golang.org/x/[email protected]
- golang.org/x/[email protected]
- golang.org/x/[email protected]
- golang.org/x/[email protected]
- golang.org/x/[email protected]
- golang.org/x/[email protected]
- google.golang.org/[email protected]
- google.golang.org/[email protected]
- google.golang.org/genproto/googleapis/[email protected]
- google.golang.org/genproto/googleapis/[email protected]
- google.golang.org/[email protected]
- google.golang.org/[email protected]
- gopkg.in/[email protected]
- gopkg.in/[email protected]
- gopkg.in/[email protected]
- nhooyr.io/[email protected]
- pgregory.net/[email protected]
- sigs.k8s.io/[email protected]
build_tags: netgo,ledger
commit: 9794ab0b8944c7bd0d7099a6eff7a2a3b4cdf0f3
cosmos_sdk_version: v0.47.13
go: go version go1.21.0 linux/amd64
name: fxcore
server_name: fxcored
version: v7.5.0
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) |