CLI - ICON DevPortal

Search…
CLI
CLI
goloop
Description
Goloop CLI
Usage
goloop
Child commands
Command
Description
​goloop chain​
Manage chains
​goloop debug​
DEBUG API
​goloop gn​
Genesis transaction manipulation
​goloop gs​
Genesis storage manipulation
​goloop ks​
Keystore manipulation
​goloop rpc​
JSON-RPC API
​goloop server​
Server management
​goloop stats​
Display a live streams of chains metric-statistics
​goloop system​
System info
​goloop user​
User management
​goloop version​
Print goloop version
goloop chain
Description
Manage chains
Usage
goloop chain TASK CID PARAM
Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Child commands
Command
Description
​goloop chain backup​
Start to backup the channel
​goloop chain config​
Configure chain
​goloop chain genesis​
Download chain genesis file
​goloop chain import​
Start to import legacy database
​goloop chain inspect​
Inspect chain
​goloop chain join​
Join chain
​goloop chain leave​
Leave chain
​goloop chain ls​
List chains
​goloop chain prune​
Start to prune the database based on the height
​goloop chain reset​
Chain data reset
​goloop chain start​
Chain start
​goloop chain stop​
Chain stop
​goloop chain verify​
Chain data verify
goloop chain backup
Description
Start to backup the channel
Usage
goloop chain backup CID
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain config
Description
Configure chain
Usage
goloop chain config CID KEY VALUE
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain genesis
Description
Download chain genesis file
Usage
goloop chain genesis CID FILE
Inherited Options
goloop chain import
Description
Start to import legacy database
Usage
goloop chain import CID [flags]
Options
Name,shorthand
Environment Variable
Required
Default
Description
--db_path
​
true
​
Database path
--height
​
true
0
Block Height
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain inspect
Description
Inspect chain
Usage
goloop chain inspect CID [flags]
Options
Name,shorthand
Environment Variable
Required
Default
Description
--format, -f
​
false
​
Format the output using the given Go template
--informal
​
false
false
Inspect with informal data
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain join
Description
Join chain
Usage
goloop chain join [flags]
Options
Name,shorthand
Environment Variable
Required
Default
Description
--auto_start
​
false
false
Auto start
--channel
​
false
​
Channel
--concurrency
​
false
1
Maximum number of executors to be used for concurrency
--db_type
​
false
goleveldb
Name of database system(*badgerdb, goleveldb, boltdb, mapdb)
--default_wait_timeout
​
false
0
Default wait timeout in milli-second (0: disable)
--genesis
​
false
​
Genesis storage path
--genesis_template
​
false
​
Genesis template directory or file
--max_block_tx_bytes
​
false
0
Max size of transactions in a block
--max_wait_timeout
​
false
0
Max wait timeout in milli-second (0: uses same value of default_wait_timeout)
--node_cache
​
false
none
Node cache (none,small,large)
--normal_tx_pool
​
false
0
Size of normal transaction pool
--patch_tx_pool
​
false
0
Size of patch transaction pool
--platform
​
false
​
Name of service platform
--role
​
false
3
[0:None, 1:Seed, 2:Validator, 3:Both]
--secure_aeads
​
false
chacha,aes128,aes256
Supported Secure AEAD with order (chacha,aes128,aes256) - Comma separated string
--secure_suites
​
false
none,tls,ecdhe
Supported Secure suites with order (none,tls,ecdhe) - Comma separated string
--seed
​
false
​
List of trust-seed ip-port, Comma separated string
--tx_timeout
​
false
0
Transaction timeout in milli-second (0: uses system default value)
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain leave
Description
Leave chain
Usage
goloop chain leave CID
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain ls
Description
List chains
Usage
goloop chain ls
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain prune
Description
Start to prune the database based on the height
Usage
goloop chain prune CID [flags]
Options
Name,shorthand
Environment Variable
Required
Default
Description
--db_type
​
false
​
Database type(default:original database type)
--height
​
true
0
Block Height
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain reset
Description
Chain data reset
Usage
goloop chain reset CID
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain start
Description
Chain start
Usage
goloop chain start CID
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain stop
Description
Chain stop
Usage
goloop chain stop CID
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain verify
Description
Chain data verify
Usage
goloop chain verify CID
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop debug
Description
DEBUG API
Usage
goloop debug
Options
Name,shorthand
Environment Variable
Required
Default
Description
--uri
GOLOOP_DEBUG_URI
true
​
URI of DEBUG API
Child commands
Command
Description
​goloop debug trace​
Get trace of the transaction
goloop debug trace
Description
Get trace of the transaction
Usage
goloop debug trace HASH
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--uri
GOLOOP_DEBUG_URI
true
​
URI of DEBUG API
goloop gn
Description
Genesis transaction manipulation
Usage
goloop gn
Child commands
Command
Description
​goloop gn edit​
Edit genesis transaction
​goloop gn gen​
Generate genesis transaction
goloop gn edit
Description
Edit genesis transaction
Usage
goloop gn edit [genesis file]
Options
Name,shorthand
Environment Variable
Required
Default
Description
--god, -g
​
false
​
Address or keystore of GOD
--validator, -v
​
false
[]
Address or keystore of Validator, [Validator...]
goloop gn gen
Description
Generate genesis transaction
Usage
goloop gn gen [address or keystore...]
Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
[]
Chain configuration
--fee
​
false
none
Fee configuration (none,icon)
--god, -g
​
false
​
Address or keystore of GOD
--out, -o
​
false
genesis.json
Output file path
--supply, -s
​
false
0x2961fff8ca4a62327800000
Total supply of the chain
--treasury, -t
​
false
hx1000000000000000000000000000000000000000
Treasury address
goloop gs
Description
Genesis storage manipulation
Usage
goloop gs
Child commands
Command
Description
​goloop gs gen​
Create genesis storage from the template
​goloop gs info​
Show genesis storage information
goloop gs gen
Description
Create genesis storage from the template
Usage
goloop gs gen
Options
Name,shorthand
Environment Variable
Required
Default
Description
--input, -i
​
false
genesis.json
Input file or directory path
--out, -o
​
false
gs.zip
Output file path
goloop gs info
Description
Show genesis storage information
Usage
goloop gs info genesis_storage.zip [flags]
Options
Name,shorthand
Environment Variable
Required
Default
Description
--cid_only, -c
​
false
false
Showing chain ID only
--nid_only, -n
​
false
false
Showing network ID only
goloop ks
Description
Keystore manipulation
Usage
goloop ks
Child commands
Command
Description
​goloop ks gen​
Generate keystore
goloop ks gen
Description
Generate keystore
Usage
goloop ks gen
Options
Name,shorthand
Environment Variable
Required
Default
Description
--out, -o
​
false
keystore.json
Output file path
--password, -p
​
false
gochain
Password for the keystore
goloop rpc
Description
JSON-RPC AP
Usage
goloop rpc
Options
Name,shorthand
Environment Variable
Required
Default
Description
--debug
GOLOOP_RPC_DEBUG
false
false
JSON-RPC Response with detail information
--debug_uri
GOLOOP_RPC_DEBUG_URI
false
​
URI of JSON-RPC Debug API
--uri
GOLOOP_RPC_URI
true
​
URI of JSON-RPC API
Child commands
Command
Description
​goloop rpc balance​
GetBalance
​goloop rpc blockbyhash​
GetBlockByHash
​goloop rpc blockbyheight​
GetBlockByHeight
​goloop rpc blockheaderbyheight​
GetBlockHeaderByHeight
​goloop rpc call​
Call
​goloop rpc databyhash​
GetDataByHash
​goloop rpc lastblock​
GetLastBlock
​goloop rpc monitor​
Monitor
​goloop rpc proofforevents​
GetProofForEvents
​goloop rpc proofforresult​
GetProofForResult
​goloop rpc raw​
Rpc with raw json file
​goloop rpc scoreapi​
GetScoreApi
​goloop rpc sendtx​
SendTransaction
​goloop rpc totalsupply​
GetTotalSupply
​goloop rpc txbyhash​
GetTransactionByHash
​goloop rpc txresult​
GetTransactionResult
​goloop rpc votesbyheight​
GetVotesByHeight
goloop rpc balance
Description
GetBalance
Usage
goloop rpc balance ADDRESS
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--debug
GOLOOP_RPC_DEBUG
false
false
JSON-RPC Response with detail information
--debug_uri
GOLOOP_RPC_DEBUG_URI
false
​
URI of JSON-RPC Debug API
--uri
GOLOOP_RPC_URI
true
​
URI of JSON-RPC API
goloop rpc blockbyhash
Description
GetBlockByHash
Usage
goloop rpc blockbyhash HASH
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--debug
GOLOOP_RPC_DEBUG
false
false
JSON-RPC Response with detail information
--debug_uri
GOLOOP_RPC_DEBUG_URI
false
​
URI of JSON-RPC Debug API
--uri
GOLOOP_RPC_URI
true
​
URI of JSON-RPC API
goloop rpc blockbyheight
Description
GetBlockByHeight
Usage
goloop rpc blockbyheight HEIGHT
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--debug
GOLOOP_RPC_DEBUG
false
false
JSON-RPC Response with detail information
--debug_uri
GOLOOP_RPC_DEBUG_URI
false
​
URI of JSON-RPC Debug API
--uri
GOLOOP_RPC_URI
true
​
URI of JSON-RPC API
goloop rpc blockheaderbyheight
Description
GetBlockHeaderByHeight
Usage
goloop rpc blockheaderbyheight HEIGHT
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--debug
GOLOOP_RPC_DEBUG
false
false
JSON-RPC Response with detail information
--debug_uri
GOLOOP_RPC_DEBUG_URI
false
​
URI of JSON-RPC Debug API
--uri
GOLOOP_RPC_URI
true
​
URI of JSON-RPC API
goloop rpc call
Description
Call
Usage
goloop rpc call [flags]
Options
Name,shorthand
Environment Variable
Required
Default
Description
--from
​
false
​
FromAddress
--method
​
false
​
Name of the function to invoke in SCORE, if '--raw' used, will overwrite
--param
​
false
[]
key=value, Function parameters, if '--raw' used, will overwrite
--raw
​
false
​
call with 'data' using raw json file or json-string
--to
​
true
​
ToAddress
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--debug
GOLOOP_RPC_DEBUG
false
false
JSON-RPC Response with detail information
--debug_uri
GOLOOP_RPC_DEBUG_URI
false
​
URI of JSON-RPC Debug API
--uri
GOLOOP_RPC_URI
true
​
URI of JSON-RPC API
goloop rpc databyhash
Description
GetDataByHash
Usage
goloop rpc databyhash HASH
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--debug
GOLOOP_RPC_DEBUG
false
false
JSON-RPC Response with detail information
--debug_uri
GOLOOP_RPC_DEBUG_URI
false
​
URI of JSON-RPC Debug API
--uri
GOLOOP_RPC_URI
true
​
URI of JSON-RPC API
goloop rpc lastblock
Description
GetLastBlock
Usage
goloop rpc lastblock
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--debug
GOLOOP_RPC_DEBUG
false
false
JSON-RPC Response with detail information
--debug_uri
GOLOOP_RPC_DEBUG_URI
false
​
URI of JSON-RPC Debug API
--uri
GOLOOP_RPC_URI
true
​
URI of JSON-RPC API
goloop rpc monitor
Description
Monitor
Usage
goloop rpc monitor
Options
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--debug
GOLOOP_RPC_DEBUG
false
false
JSON-RPC Response with detail information
--debug_uri
GOLOOP_RPC_DEBUG_URI
false
​
URI of JSON-RPC Debug API
--uri
GOLOOP_RPC_URI
true
​
URI of JSON-RPC API