lance-web3 / fx-docs

FunctionX Technical Document

FunctionX Technical Document will cover the areas of f(x)Core command line interface, information on validators and delegators; technical set up, consensus, governance, security management etc. Also there are additional resources for users and general best practices within the document.

Additionally, there are developer commands and documents for querying the f(x)Core blockchain.

F(X)CORE

What is f(x)Core: Brief overview of f(x)Core including the various modules.

****Installation f(x)Core (technical): The hardware requirements and the technical setup for the f(x)Core command line interface (CLI).

Setup Node (technical)

• Full node with Binaries: Initialising the core (where your consensus keys are generated), configuring the necessary files, running the node with Daemon.
• Full node with Docker: Similar to setting it up using binaries, but using the docker container.
• Snapshot Guide: Downloading a snapshot of the blockchain data to enable a faster sync.
• Node Metrics: Setting up of Prometheus monitoring services and also creating alerts for telegram.
• Node Peers: Trustable nodes.
• EVM Upgrade Tutorial: How to upgrade your node's code to be compatible with the latest EVM module

VALIDATORS

Validator Overview: General overview and links to some of our forums and social media accounts.

****Setting Up a Validator for f(x)Core (technical): Creation of validator, edit validator description, unjailing your validator and some common problems.

****Validator Recovery (technical): Where your consensus key is stored and how to to do a recovery.

Validator FAQ: General concepts like what is a full-node, what is a validator, what is a delegator, What are the different states a validator can be in?, responsibilities, what are the slashing.conditions?, incentives...

Validator Security Notice: Key Management - HSM, Sentry Nodes (DDOS Protection).

DELEGATORS

Delegator FAQ: What is a delegator?, choosing a validator, directives of delegators, revenue, risks.

****Delegator CLI Guide (technical): f(x)Core Accounts, querying the state, sending transactions, Bonding FX and Withdrawing Rewards, Participating in Governance.

Delegator Security Notice: Social Engineering, Key Management, Software Vulnerabilities, Account Security.

RESOURCES

Cloud setup: how to remote ssh and connecting your localhost to the cloud instance for a specific port.

Testnet faucet: sorry, there isn't one for Mainnet.

f(x)cored Commands Documentation: Main structure of running fxcored commands, keys, send tokens, query transactions, slashing, staking, governance, fee distribution, multisig transactions.

Ledger Integration for fxcored: Installing cosmos ledger application, adding keys to your ledger using f(x)Core CLI.

STEP BY STEP SUMMARY OF HOW TO SET UP A VALIDATOR

Installation f(x)Core

1. Install the necessary dependencies and install Go
2. Install the binaries

Setup Node (you can choose to set it up using Binaries or Docker)

1. Initialize fxcore
2. Make sure you backup your consensus key❗
3. Before starting the node, you can choose to download the snapshot (recommended)
4. Start the node to sync, running server as a daemon is highly recommended

Setting Up a Validator for f(x)Core

1. Ensure your node is synced up, "catch_up"=false
2. You can use ledger to create your token holding account keys and add a layer of protection by using the keyring-backend flag (highly recommended), you can even use a multi-sig account but that will make transactions a hassle later, and do some test transactions to make sure everything works
3. Make sure you do the necessary checks before you create your validator❗
4. Also set up your node monitoring device on a separate server
5. Create your validator