⌨️CLI Commands
With the release of Quilibrium v2, the node application will come with the /client folder to have better visibility on your node's conditions, earned rewards and perform transfer transactions.
Installing qClient
Before you begin, ensure you have qClient installed on your system.
Go inside the client folder
Then download binary of cqlient
Please note that, you must downlod cqlient binary depends on your system architecture. There are 3 different binary option based on systems.
CLI Commands
1. General Command Syntax
The CLI tooling itself will be relatively simple, and the commands can be run as follows (assuming a build in the accompanying /client folder rather than go run ./...
:
2. Querying Balance
The command line tool takes arguments in either decimal (xx.xxxxx) format or raw unit (0x00000) format. Note that raw units are a multiple of QUIL: 1 QUIL = 0x1DCD65000 units Command:
Response:
3. Querying Individual Coins
Users may wish to view the individual coins: Command:
Response:
4. Creating a Pending Transaction
Quilibrium's token application has two modes: a two-stage transfer/accept (or reject), or a single-stage mutual transfer. Command:
Response: To perform a two-stage transfer, you have two options:
or
Omitting the RefundAccount will simply provide your own originating account. The option to specify exists so that you can maintain anonymity when sending by creating a fresh account to receive the refund. The RefundAccount cannot be the same as the ToAccount.
The first is a user-friendly version of a transfer, akin to what account-based networks like Ethereum and Solana do, where you operate on a balance. Behind the scenes, the client is actually splitting and/or merging coins as needed in order to create the requisite amount to send as a discrete coin. The second is an application-aware version of a transfer, akin to what UTXO-based networks like Bitcoin do, where you operate on the raw coin balance under a specific address. If you have good reason to manage coins separately (yet under the control of the same managing account), you will want to use the second option in conjunction with split/merge operations if needed:
5. Accepting a Pending Transaction
To accept a pending transaction, you simply run:
The same applies for rejecting a pending transaction
This creates a separate pending transaction because if the refund address is specified by the originator, and were they to specify another of your own addresses, it would be no different than accepting.
6. Performing a Mutual Transfer
Pending transactions introduce friction, but without that friction, users can be spammed coins they don't want, or sent coins from an address they do not wish to interact with. If both parties agree in advance to transact, they can perform a mutual transfer, where both parties must be online, but can avoid having to deal with the two-phase transaction. This is great for maintaining privacy (each party's account is private) as well as ensuring a timely completion of a transaction: On the receiver's side:
and after the sender connects:
On the sender's side:
or if using the raw Coin address:
This will likely be the first unique experience Quilibrium provides to users already familiar with other networks, as privacy preservation is an immediately obvious and first class experience here by showing the user what it can (or cannot) see.
7. Claiming Rewards
Claiming rewards as wQuil, please visit Claiming wQuil Token section.
Tokens issued after v2.0 are issued by nodes providing their proofs to the Mint Authority functionality of the token application. Claiming those rewards can be configured to be performed automatically (default, generates a new Coin every claim and merges them), or in lump sums at intervals, manually. It is recommended for ease of management that the defaults are applied, so that in the event of hardware failure no rewards go unclaimed. If you wish to do it manually however, you will need to run:
Last updated