For the complete documentation index, see llms.txt. This page is also available as Markdown.
AnchorCLI
anchorcli is a command-line interface for Anchor Protocol on Terra and allows more advanced users to perform operations directly from their shell or terminal without having to interact with a graphical interface. anchorcli is built on top of terracli and allows you to use keys saved in its keychain.
This section provides a brief guide on how to interact with Anchor Protocol via anchorcli. For further information, please check its GitHub and Readme.
Installation
Requirements
Node.js 12+
NPM
terracli in your path
anchorcli can be installed through NPM:
$ npm install -g @anchor-protocol/anchorcli
The entrypoint anchorcli should then be available in your path:
$ anchorcli
Usage: anchorcli [options] [command]
Command-line interface for interacting with Anchor Protocol on Terra
Options:
-V, --version output the version number
-v,--verbose Show verbose error logs
-h, --help display help for command
Commands:
exec|x Execute a function on a smart contract
query|q Run a smart contract query function
help [command] display help for command
Configuration
By default, anchorcli works with the default configuration which is set to be for contracts on bombay-12. This setting provides the address of contracts and specifies the setting for LCD provider, gas prices for fee estimation. anchorcli will create two configuration files in your home directory: $HOME/anchorcliTestnet.json and $HOME/anchorcliMainnet.json.
Specifying LCD settings
Each network configuration should define how to connect to the Terra blockchain via LCD parameters.
columbus-5:
bombay-12:
Specifying Contracts
Each address configuration should point to the correct Anchor core contract addresses.
columbus-5:
bombay-12:
Specifying the Network [IMPORTANT]
By default, anchorcli will use the network setting for columbus-5 configured in $HOME/anchorcliMainnet.json. You can direct anchorcli to use a different network configuration by changing the value of the ANCHORCLI_NETWORK environment variable.
Example
OR
Usage
anchorcli allows you to:
execute state-changing functions on Anchor smart contracts
query read-only data endpoints on Anchor smart contracts
Execute
USAGE: anchorcli exec|x [options] [command]
Query
USAGE: anchorcli query|q [options] [command]
Examples
This section illustrates the usage of anchorcli through some use cases. All examples assume you have a key in terracli keychain called test1.
Bond Luna to mint bLuna
Anchor protocol requires you to provide bAsset collaterals to borrow Terra stablecoins. bLuna tokens which are whitelisted as an eligible collateral can be used.
In order to obtain bLuna tokens, a user needs to bond Luna first, which then the contract will issue bLuna for the user. The following example is the way a user can bond Luna to gain bLuna (in response to which the contract will issue bLuna for the user):
Query bLuna Balance
After bonding your Luna, you can get your bLuna balance with the following query:
"lcd": {
"chainID": "columbus-5",
"URL": "https://lcd.terra.dev",
"gasPrices": {
"uluna": 0.15, // example value
"usdr": 0.1018, // example value
"uusd": 0.15, // example value
"ukrw": 178.05, // example value
"umnt": 431.6259 // example value
},
"gasAdjustment": 1.2
},
ANCHORCLI_NETWORK=bombay-12 anchorcli x basset-hub bond ...
export ANCHORCLI_NETWORK=bombay-12
anchorcli x basset-hub bond ...
Execute a function on a smart contract
Options:
--yaml Encode result as YAML instead of JSON
-y,--yes Sign transaction without confirming (yes)
--home <string> Directory for config of terracli
--from <key-name> *Name of key in terracli keyring
--generate-only Build an unsigned transaction and write it to stdout
-G,--generate-msg Build an ExecuteMsg (good for including in poll)
--base64 For --generate-msg: returns msg as base64
-b,--broadcast-mode <string> Transaction broadcasting mode (sync|async|block) (default: sync) (default: "sync")
--chain-id <string> Chain ID of Terra node
-a,--account-number <int> The account number of the signing account (offline mode)
-s,--sequence <int> The sequence number of the signing account (offline mode)
--memo <string> Memo to send along with transaction
--fees <coins> Fees to pay along with transaction
--gas <int|auto> *Gas limit to set per-transaction; set to "auto" to calculate required gas automatically
--gas-adjustment <float> Adjustment factor to be multiplied against the estimate returned by the tx simulation
--gas-prices <coins> Gas prices to determine the transaction fee (e.g. 10uluna,12.5ukrw)
-h, --help display help for command
Commands:
basset-hub [options] Anchor bAsset Hub contract functions
basset-reward [options] Anchor bAsset reward contract functions
basset-token [options] Anchor bAsset token contract functions
liquidation [options] Anchor Money Market Liquidation contract functions
oracle [options] Anchor Money Market Liquidation contract functions
market [options] Anchor Money Market Market contract functions
custody-bluna [options] Anchor Money Market Custody contract functions
overseer [options] Anchor Money Market Overseer contract functions
interest [options] Anchor Money Market Interest contract functions
terraswap [options] terraswap, anchor related contract functions
gov [options] ANC Gov contract functions
airdrop [options] Anchor Airdrop contract functions [mainnet only]
collector [options] Anchor Collector contract functions
investor-vesting [options] Anchor Investor Vesting contract functions
team-vesting [options] Anchor Team Vesting contract functions
staking [options] Anchor Staking contract functions
anc [options] Anchor ANC token contract functions
aust [options] Anchor aUST token contract functions
help [command] display help for command
