This document contains all the necessary information for delegators to interact with the f(x)Core through the Command-Line Interface (CLI).
It also contains instructions on how to manage accounts, restore accounts from the fundraiser and use a ledger nano device.
Very Important: Please ensure that you follow the steps hereinafter carefully, as negligence in this process could result in a loss of your FX. Therefore, do read through the following instructions in their entirety before proceeding and reach out to us in case you need any support.
Please also note that you are about to interact with the f(x)Core, a blockchain technology containing highly experimental software. While the blockchain has been developed with state of the art technology and audited with utmost care, we may still expect to have issues, updates and bugs. Furthermore, interaction with blockchain technology requires advanced technical skills and always involves risks that are outside our control. By using the software, you confirm that you understand the inherent risks associated with cryptographic software and that the FunctionX team will not be held liable for potential damages arising out of the use of the software. Any use of this open source software released under the Apache 2.0 license is done at your own risk and on an "AS IS" basis, without warranties or conditions of any kind.
Please exercise extreme caution!
- Installing
fxcored - f(x)Core Accounts
- Accessing the f(x)Core Network
- Setting Up
fxcored - Querying the State
- Sending Transactions
fxcored: This is the command-line interface (CLI) to interact with a fxcored full-node.
Please check that you have downloaded the latest stable release of
fxcored
[Download the binaries]
fxcoredcan be interacted with via a terminal. To open the terminal, follow these steps:
- Windows:
Start>All Programs>Accessories>Command Prompt - MacOS:
Finder>Applications>Utilities>Terminal - Linux:
Ctrl+Alt+T
At the core of every f(x)Core account, there is a seed, which takes the form of a 12 or 24-words mnemonic. From this mnemonic, it is possible to create multiple f(x)Core accounts, i.e. pairs of private key/public key. This is called an HD wallet (see BIP32 for more information on the HD wallet specification).
Account 0 Account 1 Account 2
+------------------+ +------------------+ +------------------+
| | | | | |
| Address 0 | | Address 1 | | Address 2 |
| ^ | | ^ | | ^ |
| | | | | | | | |
| | | | | | | | |
| | | | | | | | |
| + | | + | | + |
| Public key 0 | | Public key 1 | | Public key 2 |
| ^ | | ^ | | ^ |
| | | | | | | | |
| | | | | | | | |
| | | | | | | | |
| + | | + | | + |
| Private key 0 | | Private key 1 | | Private key 2 |
| ^ | | ^ | | ^ |
+------------------+ +------------------+ +------------------+
| | |
| | |
| | |
+--------------------------------------------------------------------+
|
|
+---------+---------+
| |
| Mnemonic (Seed) |
| |
+-------------------+
The funds stored in an account are controlled by the private key. This private key is generated from the mnemonic using a one-way function. If you lose the private key, you can retrieve it using the mnemonic. However, if you lose the mnemonic, you will lose access to all the derived private keys. Likewise, if someone gains access to your mnemonic, they gain access to all the associated accounts.
Do not lose or share your 24-word mnemonic with anyone. To prevent theft or loss of funds, it is best to ensure that you keep multiple copies of your mnemonic, and store it in a safe, secure place that only you have access to. If someone has your mnemonic, they will be able to gain access to your private keys and control the accounts associated with them.
The address is a public string with a human-readable prefix (e.g. fx1hs3tfedle32zzr5dh38gzzfn9ak2f4a9je4pf6) that identifies your account. When someone wants to send you funds, they send it to your address. It is virtually computationally impossible to derive the private key from a public address.
At the core of a ledger device, there is a mnemonic used to generate accounts on multiple blockchains (including the f(x)Core). When you first initialize your ledger device, you will create a new mnemonic. It is possible to import an existing mnemonic into a ledger device instead. Let us go ahead and see how you can import a mnemonic into your ledger device. For more on how to restore from a recovery phrase, refer here.
NOTE: To import a mnemonic into a ledger, it is preferable to use a brand new ledger device. There can only be one mnemonic per ledger device. If you want to use a ledger that is already initialized with a seed, you can reset it by going into
Control Center>Settings>Security>Reset Device. More on how to reset your ledger device can be found here. Please note that this will wipe out the seed currently stored on the device. If you have not properly secured the associated mnemonic, you could lose your funds!!!
The following steps need to be performed on an un-initialized ledger device:
- Ensure ledger live is downloaded and installed.
- Press the button next to the USB port until the Ledger logo appears to turn on the device.
- Read the on-screen instructions. Press the right button to proceed or the left button to go back.
- Press both simultaneously when Set up as new device is displayed.
- Do NOT choose the "Config as a new device" option. Instead, choose "Restore Configuration"
- Choose a PIN
- Choose the 24 words option
- Input each of the words in the correct order.
Your ledger is now correctly set up with your imported mnemonic! Do not lose this mnemonic! If your ledger is compromised, you can always restore a new device again using the same mnemonic.
Next, click here to learn how to generate an account.
NOTE: It is more secure to perform this action on an offline computer
To restore an account using a mnemonic and store the associated encrypted private key on a computer, use the following command:
{% tabs %} {% tab title="recover fx address" %}
fxcored keys add <fx_key_name> --algo secp256k1 --coin-type 118 --index <index_number> --recover{% endtab %}
{% tab title="recover fx-evm wallet" %}
fxcored keys add <0x_key_name> --algo eth_secp256k1 --coin-type 60 --index <index_number> --recover{% endtab %} {% endtabs %}
<_key_name>is the name of the account. It is a reference to the account number used to derive the key pair from the mnemonic. You will use this name to identify your account when you want to send a transaction.- You can add the optional
--indexflag to specify the path (0,1,2, ...) you want to use to generate your account. By default, account0is generated.
The private key of account 0 will be saved in your operating system's credentials storage. Each time you want to send a transaction, you will need to unlock your system's credentials store. If you lose access to your credentials storage, you can always recover the private key with the mnemonic.
You may not be prompted for a password each time you send a transaction since most operating systems unlock a user's credentials store upon login by default. If you want to change your credentials store security policies please refer to your operating system manual.
To create an account, you just need to have fxcored installed. Before creating it, you need to know where you intend to store and interact with your private keys. The best options are to store them in a dedicated offline computer or a ledger device. Storing them on your regular online computer involves more risk, since anyone who infiltrates your computer through the internet could gain access to your private keys and steal your funds.
Only use Ledger devices that you bought brand new or that you know is not compromised
When you initialize your ledger, a 24-word mnemonic is generated and stored in the device. This mnemonic is compatible with f(x)Core and f(x)Core accounts can be derived from it. All you have to do is make your ledger compatible with fxcored. To do so, you need to go through the following steps:
- Download the Ledger Live app here.
- Connect your ledger via USB and update to the latest firmware
- Go to the ledger live app store, and download the "Cosmos" application (this can take a while). Note: You may have to enable
Dev Modein theSettingsof Ledger Live to be able to download the "Cosmos" application. - Navigate to the Cosmos app on your ledger device
Then, to create an account, run the following command:
{% tabs %} {% tab title="create fx address" %}
fxcored keys add <fx_key_name> --algo secp256k1 --coin-type 118 --ledger --index <index_number>{% endtab %} {% endtabs %}
This command will only work while the Ledger is plugged in and unlocked
<_key_name>is the name of the account. It is a reference to the account number used to derive the key pair from the mnemonic. You will use this name to identify your account when you want to send a transaction.- You can add the optional
--indexflag to specify the path (0,1,2, ...) you want to use to generate your account. By default, account0is generated. Just remember to take note of the accounts and index you have stored the keys in your ledger.
You can generate more accounts from the same mnemonic using the following command:
fxcored keys add brucebanner<0x_key_name> --algo secp256k1 --coin-type 118 --ledger --index 2This command will prompt you to input a passphrase as well as your mnemonic. Change the account number to generate an account with a different index.
Do not lose or share your 24 word mnemonics with anyone. To prevent theft or loss of funds, it is best to ensure that you keep multiple copies of your mnemonic, and store it in a secure place that only you know how to access. If someone is able to gain access to your mnemonic, they will be able to gain access to your private keys and control the accounts associated with them.
After you have secured your mnemonic (triple check!), you can delete bash history to ensure no one can retrieve it:
history -c
rm ~/.bash_historyIn order to query the state and send transactions, you need a way to access the network. To do so, you can either run your own full-node, or connect to an available public node.
NOTE: Do not share your mnemonic (24 words) with anyone. The only person who should ever need to know it is you. Do not that no one from the FunctionX team will ever send an email that asks for you to share any kind of account credentials or your mnemonics.".
This is the most secure option, but comes with relatively high resource requirements and costs. In order to run your own full-node, you need good bandwidth and at least 500GB of disk space.
You will find the tutorial on how to install fxcored here, and the guide to run a full-node here.
If you do not want or cannot run your own node, you can connect to someone else's full-node. You should pick a full-node operator that you trust, because a malicious operator could return incorrect query results or censor your transactions. However, they will never be able to steal your funds, as your private keys are stored locally on your computer or ledger device. Possible options for full-node operators include validators, wallet providers or exchanges.
In order to connect to a full-node, you will need an address in the form of: https://127.0.0.1:26657 (Note: This is a placeholder). This address has to be provided by the full-node operator you choose to trust. You will use this address in the following section.
Before setting up
fxcored, ensure that you have found a way to access the f(x)Core network
Please check that you are always using the latest stable release of
fxcored
fxcored is the tool that enables you to interact with the node that runs on the f(x)Core network.
In order to set up fxcored, use the following command:
fxcored config <config file name> <host>:<port>It allows you to set a default value for each given flag.
First, set up the address of the full-node you want to connect to:
fxcored config <config file name> <host>:<port>
# example: fxcored config config.toml rpc.laddr https://77.87.106.33:26657If you run your own full-node, just use tcp://localhost:26657 as the address.
Then, let us set the default value of the --trust-node flag:
fxcored config trust-node false
# Set to true if you trust the full-node you are connecting to, false otherwiseFinally, let us set the chain-id of the blockchain we want to interact with (chain-id for testnet is dhobyghaut):
fxcored config config.toml chain-id fxcoreBefore you can bond FX and withdraw rewards, you need to set up
fxcored
fxcored lets you query all relevant information from the blockchain, like account balances, amount of bonded tokens, outstanding rewards, governance proposals and more. Next is a list of the most useful commands for delegators.
// query account balances and other account-related information
fxcored query account <yourAddress>
// query the list of validators
fxcored query staking validators
// query the information of a validator given their address (e.g. fxvaloper1hs3tfedle32zzr5dh38gzzfn9ak2f4a96gg7h6)
fxcored query staking validator <validatorAddress>
// query all delegations made from a delegator given their address (e.g. fx1hs3tfedle32zzr5dh38gzzfn9ak2f4a9je4pf6)
fxcored query staking delegations <delegatorAddress>
// query a specific delegation made from a delegator (e.g. fx1hs3tfedle32zzr5dh38gzzfn9ak2f4a9je4pf6) to a validator (e.g. fxvaloper1hs3tfedle32zzr5dh38gzzfn9ak2f4a96gg7h6) given their addresses
fxcored query staking delegation <delegatorAddress> <validatorAddress>
// query the rewards of a delegator given a delegator address (e.g. fx1hs3tfedle32zzr5dh38gzzfn9ak2f4a9je4pf6)
fxcored query distribution rewards <delegatorAddress>
// query all proposals currently open for depositing
fxcored query gov proposals --status deposit_period
// query all proposals currently open for voting
fxcored query gov proposals --status voting_period
// query a proposal given its proposalID
fxcored query gov proposal <proposalID>For more commands, just type:
fxcored queryFor each command, you can use the -h or --help flag to get more information.
Transactions on the f(x)Core network need to include a transaction fee in order to be processed. This fee pays for the gas required to run the transaction. The formula is as such:
fees = ceil(gas * gasPrices)
The gas is dependent on the transaction. Different transactions require a different amount of gas. The amount of gas needed for a transaction is calculated when it is being processed, but there is a way to estimate it beforehand by using the auto value for the gas flag. Of course, this only fills in an estimate for the gas of that particular transaction. You can adjust this estimate with the flag --gas-adjustment (default 1.0) if you want to be sure you have provided enough gas for the transaction. For the remainder of this tutorial, we will use a --gas-adjustment of 1.5.
The gasPrice is the price of each unit of gas. Each validator sets a min-gas-price value, and will only include transactions that have a gasPrice greater than the min-gas-price they have set initially.
Transaction fees is the product of gas and gasPrice. As a user, you can either just fill in the fees required or you have to fill in both the gas and gasPrice. The higher the gasPrice/fees, the higher the chance that your transaction will be included in a block.
For mainnet, the recommended
gas-pricesis4000000000000FX.
Before you can bond FX and withdraw rewards, you need to set up
fxcoredand create an account
Note: These commands need to run on an online computer. It is more secure to perform these commands using a Ledger device. For the offline procedure, click here.
// Send a certain amount of tokens to an address
// These are just examples values to input (do not use these values in your tx!!): <to_address>=fx1hs3tfedle32zzr5dh38gzzfn9ak2f4a9je4pf6 <amount>=1000000FX
// Example value for flags: <gasPrice>=4000000000000FX
fxcored tx bank send <from_key_or_address> <to_address> <amount> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice>Before you can bond FX and withdraw rewards, you need to set up
fxcoredand create an account
Before bonding FX, please read the delegator faq to understand the risk and responsibilities involved with delegating
Note: These commands need to run on an online computer. It is more secure to perform them commands using a ledger device. For the offline procedure, click here.
// Bond a certain amount of FX to a given validator
fxcored tx staking delegate <validatorAddress> <amountToBond> --from <delegatorKeyName> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice>
// Redelegate a certain amount of FX from one validator to another
// Can only be used if already bonded to a validator
// Redelegation takes effect immediately, there is no waiting period to redelegate
// After a redelegation, no other redelegation can be made from the account for the next 3 weeks
fxcored tx staking redelegate <srcValidatorAddress> <destValidatorAddress> <amountToRedelegate> --from <delegatorKeyName> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice>
// Withdraw all rewards
fxcored tx distribution withdraw-all-rewards --from <delegatorKeyName> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice>
// Unbond a certain amount of FX from a given validator
// You will have to wait 3 weeks before your FX is fully unbonded and transferrable
fxcored tx staking unbond <validatorAddress> <amountToUnbond> --from <delegatorKeyName> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice>{% hint style="info" %} However,there is a limit to how frequent you can redelegate. For more information on redelegation. {% endhint %}
If you are using a Ledger, you will be asked to confirm the transaction on the device before it is signed and broadcast to the network. Note that the command will only work while the Ledger is plugged in and unlocked.
To confirm that your transaction went through, you can use the following queries:
// your balance should change after you bond FX or withdraw rewards
fxcored query account <account_fx>
// you should have delegations after you bond FX
fxcored query staking delegations <delegatorAddress>
// this returns your tx if it has been included
// use the tx hash that was displayed when you created the tx
fxcored query tx <txHash>Double check with a block explorer if you interact with the network through a trusted full-node.
The f(x)Core has a built-in governance system that lets bonded FX holders vote on proposals. There are three types of proposal:
Text Proposals: These are the most basic type of proposals. They can be used to get the opinion of the network on a given topic.Parameter Proposals: These are used to update the value of an existing parameter.Software Upgrade Proposal: These are used to propose an upgrade of the Hub's software.Cancel-software-upgrade: These are used to cancel the current software upgrade proposal.community-pool-spend: These are used to submit a a community pool spend proposal.
Any FX holder can submit a proposal. In order for the proposal to be open for voting, it needs to come with a deposit that is greater than a parameter called minDeposit. The deposit need not be provided in its entirety by the submitter. If the initial proposer's deposit is not sufficient, the proposal enters the deposit_period status. Then, any FX holder can increase the deposit by sending a depositTx.
Once the deposit reaches minDeposit, the proposal enters the voting_period, which lasts 2 weeks. Any bonded FX holder can then cast a vote on this proposal. The options are Yes, No, NoWithVeto and Abstain. The weight of the vote is based on the amount of bonded FX of the sender. If a delegator doesn't vote, they would inherit the vote of their validator. However, delegators can override their validator's vote by sending a vote themselves.
At the end of the voting period, the proposal is accepted if there are more than 50% Yes votes (excluding Abstain votes) and less than 33.33% of NoWithVeto votes (excluding Abstain votes).
Note: These commands need to be run on an online computer. It is more secure to perform them commands using a ledger device. For the offline procedure, click here.
// Submit a Proposal
// <type>=text/parameter_change/software_upgrade/Cancel-software-upgrade
// ex value for flag: <gasPrice>=4000000000000FX
fxcored tx gov submit-proposal --title "Test Proposal" --description "My awesome proposal" --type <type> --deposit=10000000FX --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice> --from <delegatorKeyName>
// Increase deposit of a proposal
// Retrieve proposalID from $fxcored query gov proposals --status deposit_period
// ex value for parameter: <deposit>=10000000FX
fxcored tx gov deposit <proposalID> <deposit> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice> --from <delegatorKeyName>
// Vote on a proposal
// Retrieve proposalID from $fxcored query gov proposals --status voting_period
// <option>=yes/no/no_with_veto/abstain
fxcored tx gov vote <proposalID> <option> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice> --from <delegatorKeyName>If you do not have a ledger device and want to interact with your private key on an offline computer, you can use the following procedure. First, generate an unsigned transaction on an online computer with the following command (example with a bonding transaction):
fxcored tx staking delegate <validatorAddress> <amountToBond> --from <delegatorAddress> \
--gas auto --gas-adjustment 1.5 --gas-prices <gasPrice> --generate-only > unsignedTX.jsonIn order to sign, you will also need the chain-id, account-number and sequence. The chain-id is a unique identifier for the blockchain on which you are submitting the transaction. The account-number is an identifier generated when your account first receives funds. The sequence number is used to keep track of the number of transactions you have sent and prevent replay attacks.
Get the chain-id from the genesis file, and the two other fields using the account query:
fxcored query account <yourAddress> --chain-id dhobyghautThen, copy unsignedTx.json and transfer it (e.g. via USB) to the offline computer. If it is not done already, create an account on the offline computer. For additional security, you can double check the parameters of your transaction before signing it using the following command:
cat unsignedTx.jsonNow, sign the transaction using the following command. You will need the chain-id, sequence and account-number obtained earlier:
fxcored tx sign unsignedTx.json --from <delegatorKeyName> --offline --chain-id dhobyghaut --sequence <sequence> --account-number <account-number> > signedTx.jsonCopy signedTx.json and transfer it back to the online computer. Finally, use the following command to broadcast the transaction:
fxcored tx broadcast signedTx.json