f(x)Cored CLI Commands
f(x)Core Daemon
fxcored is the tool that enables you to interact with the node that runs on the f(x)Core network. In order to install it, follow the installation procedure.
Main structure of running fxcored commands
The
fxcoredhelp commands are nested. So$ fxcoredwill output docs for the top level commands (status, config, query, and tx). You can access documentation for sub commands with further help commands.
The very first command to generate a list of available commands:
Return:
The return value will include:
a header which explains what the command is, for example
FunctionX Core Chain Appthe usage for example
fxcored [command]where you will need to input fxcored and a follow up command likefxcored txall available commands
and all flags which might be needed for commands
We will be going through a common command along with the various sub commands and flags. Selecting the tx command:
Return:
You may either choose to insert a flag or a command after fxcored tx:
the latter will return:
continuing:
return:
now if you use the --help flag:
return:
following the prompt:
In this case, a transaction fee must be paid! So do remember to add --fees XXXXXFX in your command. If you did not input the --fees flag, you will be prompted to add --fees 1200000000000000000FX in your command.
The minimum fee for this transaction is 1.2FX which after multiplying by 10^18 is 1200000000000000000FX.
Alternatively, a more universal command is --gas=auto --gas-adjustment=1.25 --gas-prices=4000000000000FX. --gas=auto automatically assesses the gas used for that transaction. This depends on the transaction itself and also the state of the blockchain. --gas-adjustment=1.25 means that there will be a 25% buffer added to the automatically assessed gas amount. --gas-prices=4000000000000FX is the gas price you will be paying for. For more details on gas, kindly refer to the section on gas below.
return:
after inputting y:
Setting up fxcored
The main command used to set up fxcored is the following:
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:
If 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:
Finally, let us set the chain-id of the blockchain we want to interact with:
for Mainnet the ChainId should be fxcore
Keys
Key Types
There are three types of key representations that are used:
fxDerived from account keys generated by
fxcored keys addUsed to receive funds
Addresses that only have a preceding
fxare wallet addressese.g.
fx15h6vd5f0wqps26zjlwrc6chah08ryu4hzzdwhc
fxvaloperUsed to associate a validator to it's operator
Used to invoke staking commands
Addresses preceding with
fxvaloperare validator consensus addresse.g.
fxvaloper1carzvgq3e6y3z5kz5y6gxp3wpy3qdrv928vyah
fxpubDerived from account keys generated by
fxcored keys addAddresses that precede with
fxpubare the wallet public keye.g.
fxpub1zcjduc3q7fu03jnlu2xpl75s2nkt7krm6grh4cc5aqth73v0zwmea25wj2hsqhlqzm
fxvalconspubGenerated when the node is created with
fxcored init.Get this value with
fxcored tendermint show-validatorAddresses preceding
fxvalconspubare validator consensus public keye.g.
fxvalconspub1zcjduepq0ms2738680y72v44tfyqm3c9ppduku8fs6sr73fx7m666sjztznqzp2emf
Migrate Keys From Legacy On-Disk Keybase To OS Built-in Secret Store
Older versions of fxcored used store keys in the user's home directory. If you are migrating from an old version of fxcored you will need to migrate your old keys into your operating system's credentials storage by running the following command:
The command will prompt for each passphrase. If a passphrase is incorrect, it will skip the respective key.
Generate Keys
You'll need an account with a private and public key pair (a.k.a. sk, pk respectively) to be able to receive funds, send txs, bond tx, etc.
To generate an old secp256k1 key, follow this guide. New eth_secp256k1 will be the default key generation scheme when f(x)Core becomes EVM compatible.
To generate a new eth_secp256k1 key:
The output of the above command will contain a seed phrase. It is recommended to save the seed phrase in a safe place so that in case you forget the password of the operating system's credentials store, you could eventually regenerate the key from the seed phrase with the following command:
If you check your private keys, you'll now see <account_name>:
Additionally and ⚠⚠ importantly, if you wish to have an added layer of protection on your keys, you may add the --keyring-backend flag and specify the file name. Setting your key up this way will ensure another layer of protection for signing any transactions.
--keyring-backend string Select keyring's backend (os|file|test) (default "file")
for example:
you will be prompted for a keyring passphrase (password must be at least 8 characters) :
In the future, whenever you use this account to sign off on a transaction, you will have to add the --keyring-backend <file_name> flag and enter the keyring passphrase.
Save a backup of your keyring passphrase in a secure place. Losing your keyring passphrase will result in the lost of all your funds created using the keyring passphrase❗
Also to access your keys in the keyring file do not forget to add the --keyring flag
View the validator operator's address via:
You can see all your available keys by typing:
View the validator pubkey for your node by typing:
Note that this is the Tendermint signing key, not the operator key you will use in delegation transactions. Warning: We strongly recommend NOT using the same passphrase for multiple keys. The Function X team will not be responsible for the loss of funds.
Generate Multisig Public Keys
You can generate and print a multisig public key by typing:
Be sure to note that for multisig accounts, if you were to create any transaction, for example
--from=<multisig_account>your<multisig_account>needs to be the wallet address iefx123l3kjltjwlfgjslfg..... Only for those non-multisig accounts can you use the name of the account ie--from=sheldoncooper.
K is the minimum number of private keys that must have signed the transactions that carry the public key's address as signer.
The --multisig flag must contain the name of public keys that will be combined into a public key that will be generated and stored as new_key_name in the local database. All names supplied through --multisig must already exist in the local database. Unless the flag --nosort is set, the order in which the keys are supplied on the command line does not matter, i.e. the following commands generate two identical keys:
Multisig addresses can also be generated on-the-fly and printed through the which command:
For more information regarding how to generate, sign and broadcast transactions with a multi signature account see Multisig Transactions.
Tx Broadcasting
When broadcasting transactions, fxcored accepts a --broadcast-mode flag. This flag can have a value of sync (default), async, or block, where sync makes the client return a CheckTx response, async makes the client return immediately, and block makes the client wait for the tx to be committed (or timing out).
It is important to note that the block mode should not be used in most circumstances. This is because broadcasting can timeout but the tx may still be included in a block. This can result in many undesirable situations. Therefore, it is best to use sync or async and query by tx hash to determine when the tx is included in a block.
Fees & Gas
Each transaction may either use the --fees or --gas flags, but not both.
Validator's have a minimum gas price (multi-denom) configuration and they use this value when determining if they should include the transaction in a block during CheckTx, where gasPrices >= minGasPrices. Note, your transaction must use fees that are greater than or equal to any of the denominations the validator requires.
Note: With such a mechanism in place, validators may start to prioritize txs by gasPrice in the mempool, so providing higher fees or gas prices may yield higher tx priority.
e.g.
or
To query the gas price of your current node:
Note: You may want to cap the maximum gas that can be consumed by the transaction via the --gas flag. If you pass --gas=auto, the gas supply will be automatically estimated before executing the transaction. Gas estimate might be inaccurate as state changes could occur in between the end of the simulation and the actual execution of a transaction, thus an adjustment is applied on top of the original estimate in order to ensure the transaction is broadcasted successfully. The adjustment can be controlled via the --gas-adjustment flag. The default value is 1.0.
Account
Get Tokens
On a testnet, getting tokens is usually done via a faucet. You may refer to this link.
Query Account Balance
After receiving tokens to your address, you can view your account's balance by typing:
Note When you query an account balance with zero tokens, you will get this error: No account with address <account_fx> was found in the state. This can also happen if you fund the account before your node has fully synced with the chain. These are both normal.
Send Tokens
The following command could be used to send coins from one account to another:
Note: The amount argument accepts the format <value|coin_name>. For example, 10000000000000000000FX which is equivalent to 10FX
Now, view the updated balances of the origin and destination accounts:
You can also check your balance at a given block by using the --height flag:
You can simulate a transaction without actually broadcasting it by appending the --dry-run flag to the command line (this is to return a gas estimate):
Furthermore, you can build a transaction and print its JSON format to STDOUT by appending --generate-only to the list of the command line arguments. Running the following command will store build the transaction and store it in a file named "unsignedSendTx.json":
The
--generate-onlyflag preventsfxcoredfrom accessing the local keybase. Thus when such flag is supplied<sender_key_name_or_address>must be an address.
You can validate the transaction's signatures by typing the following:
You can broadcast the signed transaction to a node by providing the JSON file to the following command:
Query Transactions
Matching a Set of Events
You can use the transaction search command to query for transactions that match a specific set of events, which are added on every transaction.
Each event is composed by a key-value pair in the form of {eventType}.{eventAttribute}={value}. Events can also be combined to query for a more specific result using the & symbol.
You can query transactions by events as follows:
And for using multiple events:
The pagination is supported as well via page and limit:
The action tag always equals the message type returned by the
Type()function of the relevant message.You can find a list of available
eventson each of the SDK modules:
Matching a Transaction's Hash
You can also query a single transaction by its hash using the following command:
tx hash on the block explorer are preceded with 0x. please omit the 0x from the tx hash
Slashing
Unjailing
To unjail your jailed validator
Signing Info
To retrieve a validator's signing info:
Query Parameters
You can get the current slashing parameters via:
Minting
You can query for the minting/inflation parameters via:
To query for the current inflation value:
To query for the current annual provisions value:
Checking block information and validators signatures
The following command will query for a transaction by hash in a committed block:
The following command will get verified data for a the block at given height:
Using these commands and filtering out the necessary information, you will be able to deduce the uptime of other validators by checking if they missed any signatures for that block.
A sample query to check for any missing validator signature given a particular block height:
Staking
Set up a Validator
Please refer to the Validator Setup section for a more complete guide on how to set up a validator.
Delegate to a Validator
On the upcoming mainnet, you can delegate FX to a validator. These delegators can receive part of the validator's fee revenue. Read more about the incentives.
Query Validators
You can query the list of all validators of a specific chain:
If you want to get the information of a single validator you can check it with:
Bond Tokens
On the f(x)Core mainnet, we delegate FX. Here's how you can bond tokens to a testnet validator (i.e. delegate):
<validator> is the operator address of the validator to which you intend to delegate. If you are running a local testnet, you can find this with:
where [name] is the name of the key you specified when you initialized fxcored.
While tokens are bonded, they are pooled with all the other bonded tokens in the network. Validators and delegators obtain a percentage of shares that equal their stake in this pool.
Query Delegations
In this section and the next, do make sure you check if the command has a plural form or not. Adding an (s) behind delegation to delegations results in a different command.
Once submitted a delegation to a validator, you can see it's information by using the following command:
Or if you want to check all your current delegations with disctinct validators:
You can also query all of the delegations to a particular validator:
Unbond Tokens
If for any reason the validator misbehaves, or you just want to unbond a certain amount of tokens, use this following command.
The unbonding will be automatically completed when the unbonding period has passed.
Query Unbonding-Delegations
Once you begin an unbonding-delegation, you can see it's information by using the following command:
Or if you want to check all your current unbonding-delegations with disctinct validators:
Additionally, as you can get all the unbonding-delegations from a particular validator:
Redelegate Tokens
A redelegation is a type delegation that allows you to bond illiquid tokens from one validator to another:
Here you can also redelegate a specific shares-amount or a shares-fraction with the corresponding flags.
The redelegation will be automatically completed when the unbonding period has passed.
Query Redelegations
Once you begin a redelegation, you can see it's information by using the following command:
Or if you want to check all your current unbonding-delegations with distinct validators:
Additionally, as you can get all the outgoing redelegations from a particular validator:
However, there is a limit to how frequent you can redelegate. For more information on redelegation.
Query Parameters
Parameters define high level settings for staking. You can get the current values by using:
With the above command you will get the values for:
Unbonding time
Maximum numbers of validators
Coin denomination for staking
All these values will be subject to updates through a governance process by ParameterChange proposals.
Query Pool
A staking Pool defines the dynamic parameters of the current state. You can query them with the following command:
With the pool command you will get the values for:
Bonded tokens
Not-bonded tokens
Governance
Governance is the process from which users in the f(x)Core can come to consensus on software upgrades, parameters of the mainnet or signaling mechanisms through text proposals. This is done through voting on proposals, which will be submitted by FX holders on the mainnet.
Some considerations about the voting process:
Voting is done by bonded
FXholders on a 100 bondedFX1 vote basisDelegators who do not vote will inherit the vote of their validator
Votes are tallied at the end of the voting period (2 weeks on mainnet). Addresses can vote multiple times before the end of the voting period to update their
Optionvalue (incurring transaction fees each time), only the most recently casted vote will count as validVoters can choose between options
Yes,No,NoWithVetoandAbstainBy the end of the voting period, a proposal is accepted if:
(YesVotes / (YesVotes+NoVotes+NoWithVetoVotes)) > 1/2(NoWithVetoVotes / (YesVotes+NoVotes+NoWithVetoVotes)) < 1/3((YesVotes+NoVotes+NoWithVetoVotes) / totalBondedStake) >= quorum
For more information about the governance process and how it works, please check out the Governance module specification.
The minimum deposit for a governance proposal is 10,000FX (through the command line, this amounts to 10000000000000000000000FX after multiplying by 10^18).
Create a Governance Proposal
In order to create a governance proposal, you must submit an initial deposit along with a title and description. Various modules outside of governance may implement their own proposal types and handlers (eg. parameter changes), where the governance module itself supports Text proposals. Any module outside of governance has it's command mounted on top of submit-proposal.
To submit a Text proposal (the title and description fields will be string input so enclose the input in ""):
You may also provide the proposal directly through the --proposal flag which points to a JSON file containing the proposal.
To submit a parameter change proposal, you must provide a proposal file as its contents are less friendly to CLI input:
Where proposal.json contains the following:
Currently parameter changes are evaluated but not validated, so it is very important that any value change is valid (ie. correct type and within bounds) for its respective parameter, eg. MaxValidators should be an integer and not a decimal.
Proper vetting of a parameter change proposal should prevent this from happening (no deposits should occur during the governance process), but it should be noted regardless.
The
SoftwareUpgradecommand is currently not supported as it's not implemented and currently does not differ from the semantics of aTextproposal.
Query Proposals
Once created, you can now query information of the proposal:
Or query all available proposals:
You can also query proposals filtered by voter or depositor by using the corresponding flags.
To query for the proposer of a given governance proposal:
Increase Deposit
In order for a proposal to be broadcasted to the network, the amount deposited must be above a minDeposit value (initial value: 10000000000000000000000FX). If the proposal you previously created didn't meet this requirement, you can still increase the total amount deposited to activate it. Once the minimum deposit is reached, the proposal enters voting period:
NOTE: Proposals that don't meet this requirement will be deleted after
MaxDepositPeriodis reached.
Query Deposits
Once a new proposal is created, you can query all the deposits submitted to it:
You can also query a deposit submitted by a specific address:
Vote on a Proposal
After a proposal's deposit reaches the MinDeposit value, the voting period opens. Bonded FX holders can then cast vote on it:
Query Votes
Check the vote with the option you just submitted:
You can also get all the previous votes submitted to the proposal with:
Query proposal tally results
To check the current tally of a given proposal you can use the tally command:
Query Governance Parameters
To check the current governance parameters run:
To query subsets of the governance parameters run:
Fee Distribution
Query Distribution Parameters
To check the current distribution parameters, run:
Query distribution Community Pool
To query all coins in the community pool which is under Governance control:
Query outstanding rewards
To check the current total outstanding (un-withdrawn) rewards of a particular validator (validator's+delegators' rewards), run:
Query Validator Commission
To check the current outstanding commission for a validator (excluding the rewards of the wallet tied to that validator address), run:
Query Validator Slashes
To check historical slashes for a validator, run:
Query Delegator Rewards
To check current rewards for a delegation (were they to be withdrawn), run:
Query All Delegator Rewards
To check all current rewards for a delegation (were they to be withdrawn), run:
Claiming Rewards
Claiming rewards for delegators and validators
Withdraw rewards from a given delegation address, and optionally withdraw validator commission (by adding in a --commission flag, see below) if the delegation address given is a validator operator:
Withdraw the validator's commission in addition to the rewards:
Multisig Transactions
Multisig transactions require signatures of multiple private keys. Thus, generating and signing a transaction from a multisig account involve cooperation among the parties involved. A multisig transaction can be initiated by any of the key holders, and at least one of them would need to import other parties' public keys into their Keybase and generate a multisig public key in order to finalize and broadcast the transaction.
For example, given a multisig key comprising the keys p1, p2, and p3, each of which is held by a distinct party, the user holding p1 would require to import both p2 and p3 in order to generate the multisig account public key:
A new multisig public key p1p2p3 has been stored, and its address will be used as signer of multisig transactions:
You may also view multisig threshold, pubkey constituents and respective weights by viewing the JSON output of the key or passing the --show-multisig flag:
The first step to create a multisig transaction is to initiate it on behalf of the multisig address created above:
Be sure to note that for multisig accounts, if you were to create any transaction, for example
--from=<multisig_account>your<multisig_account>needs to be the wallet address iefx123l3kjltjwlfgjslfg..... Only for those non-multisig accounts can you use the name of the account ie--from=heimendinger.
The file unsignedTx.json contains the unsigned transaction encoded in JSON. p1 can now sign the transaction with its own private key:
Once the signature is generated, p1 transmits both unsignedTx.json and p1signature.json to p2 or p3, which in turn will generate their respective signature:
for Mainnet the ChainId should be fxcore
p1p2p3 is a 2-of-3 multisig key, therefore one additional signature is sufficient. Any the key holders can now generate the multisig transaction by combining the required signature files:
The transaction can now be sent to the node:
Shells Completion Scripts
Completion scripts for popular UNIX shell interpreters such as Bash and Zsh can be generated through the completion command, which is available for both fxcored and fxcored.
If you want to generate Bash completion scripts run the following command:
If you want to generate Zsh completion scripts run the following command:
Note: On most UNIX systems, such scripts may be loaded in
.bashrcor.bash_profileto enable Bash autocompletion:
Refer to the user's manual of your interpreter provided by your operating system for information on how to enable shell autocompletion.
Last updated