Skip to content

4 Command line client

wade edited this page Oct 15, 2020 · 5 revisions

Introduction

hallecli is a command line client for the HalleChain. HalleChain users can use hallecli to send transactions and query the blockchain data.

Working Directory

The default working directory for the hallecli is $HOME/.hallecli, which is mainly used to save configuration files and data. The HalleChain key data is saved in the working directory of hallecli. You can also specify the hallecli working directory by --home.

Connecting to a Full Node

The HalleChain node provides a RPC interface, transactions and query requests are sent to the process listening to it. The default rpc address the hallecli is connected to is tcp://localhost:26657, it can also be specified by --node.

Global Flags

All commands has the following global flags:

Name, shorthand type Required Default Value Description
--chain-id string Chain ID of tendermint node
--home string "/Users/a/.hallecli" Directory for config and data
--trace string Print out full stack trace on errors

all tx subcommand flags

All tx subcommand have the following global flags:

Name, shorthand type Required Default Description
--account-number int The account number of the signing account
--broadcast-mode string sync Transaction broadcasting mode (sync
--dry-run bool false Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it
--fees string Fees to pay along with transaction
--from string Name or address of private key with which to sign
--gas string 50000 Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically
--gas-adjustment float 1.5 Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set
--gas-prices string Gas prices to determine the tx fee.
--generate-only bool false Build an unsigned transaction and write it to STDOUT
--help, -h string Print help message
--indent Add indent to JSON response
--keyring-backend string os Select keyring's backend
--ledger Use a connected Ledger device
--memo string Memo to send along with transaction
--node string tcp://localhost:26657 <host>:<port> to tendermint rpc interface for this chain
--offline string Offline mode (does not allow any online functionality)
--sequence int The sequence number of the signing account
--sign-mode string Choose sign mode (direct | amino-json), this is an advanced feature
--trust-node bool true Trust connected full node (Don't verify proofs for responses)
--yes bool true Skip tx broadcasting prompt confirmation
--chain-id string Chain ID of tendermint node
--home string Directory for config and data (default "/Users/bianjie/.iris")
--trace string Print out full stack trace on errors

module commands

module Tx Query Description
auth account Authentication of accounts and transactions for Cosmos SDK application.
bank send bank Token transfer functionalities.
distribution distribution distribution Fee distribution, and staking token provision distribution.
evidence evidence evidence Evidence handling for double signing, misbehaviour, etc.
gov gov gov On-chain proposals and voting.
mint mint Creation of new units of staking token.
slashing slashing slashing Validator punishment mechanisms.
staking staking staking Proof-of-Stake layer for public blockchains.
supply supply Query total supply
escrow escrow escrow vests all coins after a specific time.
evm evm evm ethereum virtual machine.

auth

Usage:  hallecli query account [address] [flags]
e.g.    hallecli query account halle108vfhjtklgt8dm6rlk5e2enpe9n5pg0ugwue8w  

bank

Usage: hallecli tx send [from_key_or_address] [to_address] [amount] [flags]
e.g.   hallecli tx send mykey0 halle1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqh9dg42 100uhale --gas 100000 --gas-prices 5.1uhale -y -b block

Usage: hallecli query bank balances [address] [flags]
e.g.   hallecli query bank balances halle1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqh9dg42

distribution

Usage:
  hallecli tx distribution [flags]
  hallecli tx distribution [command]

Available Commands:
  withdraw-rewards     Withdraw rewards from a given delegation address, and optionally withdraw validator commission if the delegation address given is a validator operator
  set-withdraw-addr    change the default withdraw address for rewards associated with an address
  withdraw-all-rewards withdraw all delegations rewards for a delegator
  fund-community-pool  Funds the community pool with the specified amount

evidence

Usage:  hallecli query evidence params [flags]
e.g.    hallecli query  evidence params  

gov

Usage: hallecli tx gov submit-proposal software-upgrade [name] (--upgrade-height [height] | --upgrade-time [time]) (--upgrade-info [info]) [flags]
e.g.   hallecli tx gov submit-proposal software-upgrade enableResetLogsize  --upgrade-height 537666  --from node0   --title="Halle Chain Upgrade to v0.1.4"  --description="reset logSize in begin block" --gas 150000   --gas-prices  5.0uhale  -b block


hallecli q gov  proposals

Usage:  hallecli query gov tally [proposal-id] [flags]
e.g.    hallecli query gov tally 1

Usage:  hallecli tx gov deposit [proposal-id] [deposit] [flags]
e.g.    hallecli tx gov deposit 1  10000000uhale --from mykey0 --home ./clicfg/    --fees 100000000uhale  -b block  -y

Usage:  hallecli tx gov vote [proposal-id] [option] [flags]
e.g.    hallecli tx gov vote 1 Yes  --from mykey0 --home ./clicfg/    --fees 100000000uhale

slashing

Usage:  hallecli query slashing signing-info [validator-conspub] [flags]
e.g.    hallecli query slashing signing-info hallevalconspub1zcjduepqj2tdjrt5rwexdnj3lvssvml7669202kazj55d99l499r9jsxxtds8jmfj9

Usage:  hallecli tx slashing unjail [flags]
e.g.    hallecli tx slashing unjail --from node2 --gas 100000  --gas-prices 5.0uhale  

staking

Usage:
  hallecli tx staking delegate [validator-addr] [amount] [flags]

supply

Usage:  hallecli query supply total [denom] [flags]
e.g.    hallecli query supply total

escrow

Usage:  
  hallecli tx escrow send [from_key_or_address] [to_address] [amount] [unlock_time] [flags]

Usage:  
  hallecli tx escrow payout [from_key_or_address] [receiver_address] [day_id] [flags]

Usage:
  hallecli query escrow receiver [flags]