Goloop CLI
goloop
Manage chains
goloop chain TASK CID PARAM
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Command
Description
goloop
Goloop CLI
Start to backup the channel
goloop chain backup CID [flags]
Name,shorthand
Environment Variable
Required
Default
Description
--manual
false
false
Manual backup mode (just release database)
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Configure chain
goloop chain config CID KEY VALUE [flags]
Name,shorthand
Environment Variable
Required
Default
Description
--value
false
use if value starts with '-'.
(if the third arg is used, this flag will be ignored)
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Download chain genesis file
goloop chain genesis CID FILE
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Start to import legacy database
goloop chain import CID [flags]
Name,shorthand
Environment Variable
Required
Default
Description
--db_path
true
Database path
--height
true
0
Block Height
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Inspect chain
goloop chain inspect CID [flags]
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
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Join chain
goloop chain join [flags]
Name,shorthand
Environment Variable
Required
Default
Description
--auto_start
false
false
Auto start
--channel
false
Channel
--children_limit
false
-1
Maximum number of child connections (-1: uses system default value)
--concurrency
false
1
Maximum number of executors to be used for concurrency
--db_type
false
goleveldb
Name of database system(goleveldb, mapdb, rocksdb)
--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)
--nephews_limit
false
-1
Maximum number of nephew connections (-1: uses system default value)
--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)
--validate_tx_on_send
false
false
Validate transaction on send
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Leave chain
goloop chain leave CID
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
List chains
goloop chain ls
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Start to prune the database based on the height
goloop chain prune CID [flags]
Name,shorthand
Environment Variable
Required
Default
Description
--db_type
false
Database type(default:original database type)
--height
true
0
Block Height
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Chain data reset
goloop chain reset CID
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Chain start
goloop chain start CID
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Chain stop
goloop chain stop CID
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Chain data verify
goloop chain verify CID
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
DEBUG API
goloop debug
Name,shorthand
Environment Variable
Required
Default
Description
--uri
GOLOOP_DEBUG_URI
true
URI of DEBUG API
Command
Description
goloop
Goloop CLI
Get trace of the transaction
goloop debug trace HASH
Name,shorthand
Environment Variable
Required
Default
Description
--uri
GOLOOP_DEBUG_URI
true
URI of DEBUG API
Genesis transaction manipulation
goloop gn
Command
Description
goloop
Goloop CLI
Edit genesis transaction
goloop gn edit [genesis file]
Name,shorthand
Environment Variable
Required
Default
Description
--god, -g
false
Address or keystore of GOD
--validator, -v
false
[]
Address or keystore of Validator, [Validator...]
Command
Description
goloop gn
Genesis transaction manipulation
Generate genesis transaction
goloop gn gen [address or keystore...]
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
Command
Description
goloop gn
Genesis transaction manipulation
Genesis storage manipulation
goloop gs
Command
Description
goloop
Goloop CLI
Create genesis storage from the template
goloop gs gen
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
Command
Description
goloop gs
Genesis storage manipulation
Show genesis storage information
goloop gs info genesis_storage.zip [flags]
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
Command
Description
goloop gs
Genesis storage manipulation
Keystore manipulation
goloop ks
Command
Description
goloop
Goloop CLI
Generate keystore
goloop ks gen
Name,shorthand
Environment Variable
Required
Default
Description
--out, -o
false
keystore.json
Output file path
--password, -p
false
gochain
Password for the keystore
Command
Description
goloop ks
Keystore manipulation
JSON-RPC API
goloop rpc
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
Command
Description
goloop
Goloop CLI
GetBalance
goloop rpc balance ADDRESS
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
GetBlockByHash
goloop rpc blockbyhash HASH
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
GetBlockByHeight
goloop rpc blockbyheight HEIGHT
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
GetBlockHeaderByHeight
goloop rpc blockheaderbyheight HEIGHT
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
Call
goloop rpc call [flags]
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
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
GetDataByHash
goloop rpc databyhash HASH
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
GetLastBlock
goloop rpc lastblock
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
Monitor
goloop rpc monitor
Name,shorthand
Environment Variable
Required
Default
Description
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
MonitorBlock
goloop rpc monitor block HEIGHT [flags]
Name,shorthand
Environment Variable
Required
Default
Description
--filter
false
[]
EventFilter raw json file or json string
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
MonitorEvent
goloop rpc monitor event HEIGHT [flags]
Name,shorthand
Environment Variable
Required
Default
Description
--addr
false
SCORE Address
--data
false
[]
Not indexed Arguments of Event, comma-separated string
--event
false
Signature of Event
--indexed
false
[]
Indexed Arguments of Event, comma-separated string
--raw
false
EventFilter raw json file or json-string
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 proofforevents
GetProofForEvents
goloop rpc proofforevents BLOCK_HASH TX_INDEX EVENT_INDEXES
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 proofforresult
GetProofForResult
goloop rpc proofforresult HASH INDEX
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
Rpc with raw json file
goloop rpc raw FILE
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
GetScoreApi
goloop rpc scoreapi ADDRESS
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
SendTransaction
goloop rpc sendtx
Name,shorthand
Environment Variable
Required
Default
Description
--estimate
GOLOOP_RPC_ESTIMATE
false
false
Just estimate steps for the tx
--key_password
GOLOOP_RPC_KEY_PASSWORD
false
Password for the KeyStore file
--key_secret
GOLOOP_RPC_KEY_SECRET
false
Secret(password) file for KeyStore
--key_store
GOLOOP_RPC_KEY_STORE
true
KeyStore file for wallet
--nid
GOLOOP_RPC_NID
true
Network ID
--save
GOLOOP_RPC_SAVE
false
Store transaction to the file
--step_limit
GOLOOP_RPC_STEP_LIMIT
false
0
StepLimit
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
SmartContract Call Transaction
goloop rpc sendtx call [flags]
Name,shorthand
Environment Variable
Required
Default
Description
--method
true
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
--value
false
Value of transfer
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
--estimate
GOLOOP_RPC_ESTIMATE
false
false
Just estimate steps for the tx
--key_password
GOLOOP_RPC_KEY_PASSWORD
false
Password for the KeyStore file
--key_secret
GOLOOP_RPC_KEY_SECRET
false
Secret(password) file for KeyStore
--key_store
GOLOOP_RPC_KEY_STORE
true
KeyStore file for wallet
--nid
GOLOOP_RPC_NID
true
Network ID
--save
GOLOOP_RPC_SAVE
false
Store transaction to the file
--step_limit
GOLOOP_RPC_STEP_LIMIT
false
0
StepLimit
--uri
GOLOOP_RPC_URI
true
URI of JSON-RPC API
Deploy Transaction
goloop rpc sendtx deploy SCORE_ZIP_FILE [flags]
Name,shorthand
Environment Variable
Required
Default
Description
--content_type
false
application/zip
Mime-type of the content
--param
false
[]
key=value, Function parameters will be delivered to on_install() or on_update()
--to
false
cx0000000000000000000000000000000000000000
ToAddress
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
--estimate
GOLOOP_RPC_ESTIMATE
false
false
Just estimate steps for the tx
--key_password
GOLOOP_RPC_KEY_PASSWORD
false
Password for the KeyStore file
--key_secret
GOLOOP_RPC_KEY_SECRET
false
Secret(password) file for KeyStore
--key_store
GOLOOP_RPC_KEY_STORE
true
KeyStore file for wallet
--nid
GOLOOP_RPC_NID
true
Network ID
--save
GOLOOP_RPC_SAVE
false
Store transaction to the file
--step_limit
GOLOOP_RPC_STEP_LIMIT
false
0
StepLimit
--uri
GOLOOP_RPC_URI
true
URI of JSON-RPC API
Send transaction with json file filling nid,version,stepLimit,from and overwriting timestamp and signature
goloop rpc sendtx raw FILE
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
--estimate
GOLOOP_RPC_ESTIMATE
false
false
Just estimate steps for the tx
--key_password
GOLOOP_RPC_KEY_PASSWORD
false
Password for the KeyStore file
--key_secret
GOLOOP_RPC_KEY_SECRET
false
Secret(password) file for KeyStore
--key_store
GOLOOP_RPC_KEY_STORE
true
KeyStore file for wallet
--nid
GOLOOP_RPC_NID
true
Network ID
--save
GOLOOP_RPC_SAVE
false
Store transaction to the file
--step_limit
GOLOOP_RPC_STEP_LIMIT
false
0
StepLimit
--uri
GOLOOP_RPC_URI
true
URI of JSON-RPC API
Send transaction with json file overwriting timestamp and signature
goloop rpc sendtx raw2 FILE
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
--estimate
GOLOOP_RPC_ESTIMATE
false
false
Just estimate steps for the tx
--key_password
GOLOOP_RPC_KEY_PASSWORD
false
Password for the KeyStore file
--key_secret
GOLOOP_RPC_KEY_SECRET
false
Secret(password) file for KeyStore
--key_store
GOLOOP_RPC_KEY_STORE
true
KeyStore file for wallet
--nid
GOLOOP_RPC_NID
true
Network ID
--save
GOLOOP_RPC_SAVE
false
Store transaction to the file
--step_limit
GOLOOP_RPC_STEP_LIMIT
false
0
StepLimit
--uri
GOLOOP_RPC_URI
true
URI of JSON-RPC API
Send transaction with json file
goloop rpc sendtx raw3 FILE
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
--estimate
GOLOOP_RPC_ESTIMATE
false
false
Just estimate steps for the tx
--key_password
GOLOOP_RPC_KEY_PASSWORD
false
Password for the KeyStore file
--key_secret
GOLOOP_RPC_KEY_SECRET
false
Secret(password) file for KeyStore
--key_store
GOLOOP_RPC_KEY_STORE
true
KeyStore file for wallet
--nid
GOLOOP_RPC_NID
true
Network ID
--save
GOLOOP_RPC_SAVE
false
Store transaction to the file
--step_limit
GOLOOP_RPC_STEP_LIMIT
false
0
StepLimit
--uri
GOLOOP_RPC_URI
true
URI of JSON-RPC API
goloop rpc sendtx transfer
Coin Transfer Transaction
goloop rpc sendtx transfer [flags]
Name,shorthand
Environment Variable
Required
Default
Description
--message
false
Message
--to
true
ToAddress
--value
true
Value
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
--estimate
GOLOOP_RPC_ESTIMATE
false
false
Just estimate steps for the tx
--key_password
GOLOOP_RPC_KEY_PASSWORD
false
Password for the KeyStore file
--key_secret
GOLOOP_RPC_KEY_SECRET
false
Secret(password) file for KeyStore
--key_store
GOLOOP_RPC_KEY_STORE
true
KeyStore file for wallet
--nid
GOLOOP_RPC_NID
true
Network ID
--save
GOLOOP_RPC_SAVE
false
Store transaction to the file
--step_limit
GOLOOP_RPC_STEP_LIMIT
false
0
StepLimit
--uri
GOLOOP_RPC_URI
true
URI of JSON-RPC API
GetTotalSupply
goloop rpc totalsupply
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
GetTransactionByHash
goloop rpc txbyhash HASH
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
GetTransactionResult
goloop rpc txresult HASH
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
GetVotesByHeight
goloop rpc votesbyheight HEIGHT
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
Server management
goloop server
Name,shorthand
Environment Variable
Required
Default
Description
--backup_dir
GOLOOP_BACKUP_DIR
false
Node backup directory (default: [node_dir]/backup
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--console_level
GOLOOP_CONSOLE_LEVEL
false
trace
Console log level (trace,debug,info,warn,error,fatal,panic)
--ee_socket
GOLOOP_EE_SOCKET
false
Execution engine socket path
--engines
GOLOOP_ENGINES
false
python
Execution engines, comma-separated (python,java)
--key_password
GOLOOP_KEY_PASSWORD
false
Password for the KeyStore file
--key_plugin
GOLOOP_KEY_PLUGIN
false
KeyPlugin file for wallet
--key_plugin_options
GOLOOP_KEY_PLUGIN_OPTIONS
false
[]
KeyPlugin options
--key_secret
GOLOOP_KEY_SECRET
false
Secret (password) file for KeyStore
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--log_forwarder_address
GOLOOP_LOG_FORWARDER_ADDRESS
false
LogForwarder address
--log_forwarder_level
GOLOOP_LOG_FORWARDER_LEVEL
false
info
LogForwarder level
--log_forwarder_name
GOLOOP_LOG_FORWARDER_NAME
false
LogForwarder name
--log_forwarder_options
GOLOOP_LOG_FORWARDER_OPTIONS
false
[]
LogForwarder options, comma-separated 'key=value'
--log_forwarder_vendor
GOLOOP_LOG_FORWARDER_VENDOR
false
LogForwarder vendor (fluentd,logstash)
--log_level
GOLOOP_LOG_LEVEL
false
debug
Global log level (trace,debug,info,warn,error,fatal,panic)
--log_writer_compress
GOLOOP_LOG_WRITER_COMPRESS
false
false
Use gzip on rotated log file
--log_writer_filename
GOLOOP_LOG_WRITER_FILENAME
false
Log filename (rotated files resides in same directory)
--log_writer_localtime
GOLOOP_LOG_WRITER_LOCALTIME
false
false
Use localtime on rotated log file instead of UTC
--log_writer_maxage
GOLOOP_LOG_WRITER_MAXAGE
false
0
Maximum age of log file in day
--log_writer_maxbackups
GOLOOP_LOG_WRITER_MAXBACKUPS
false
0
Maximum number of backups
--log_writer_maxsize
GOLOOP_LOG_WRITER_MAXSIZE
false
100
Maximum log file size in MiB
--node_dir
GOLOOP_NODE_DIR
false
Node data directory (default: [configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
false
Node Command Line Interface socket path (default: [node_dir]/cli.sock)
--p2p
GOLOOP_P2P
false
127.0.0.1:8080
Advertise ip-port of P2P
--p2p_listen
GOLOOP_P2P_LISTEN
false
Listen ip-port of P2P
--rpc_addr
GOLOOP_RPC_ADDR
false
:9080
Listen ip-port of JSON-RPC
--rpc_dump
GOLOOP_RPC_DUMP
false
false
JSON-RPC Request, Response Dump flag
Command
Description
goloop
Goloop CLI
Save configuration
goloop server save [file] [flags]
Name,shorthand
Environment Variable
Required
Default
Description
--save_key_store
false
KeyStore File path to save
Name,shorthand
Environment Variable
Required
Default
Description
--backup_dir
GOLOOP_BACKUP_DIR
false
Node backup directory (default: [node_dir]/backup
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--console_level
GOLOOP_CONSOLE_LEVEL
false
trace
Console log level (trace,debug,info,warn,error,fatal,panic)
--ee_socket
GOLOOP_EE_SOCKET
false
Execution engine socket path
--engines
GOLOOP_ENGINES
false
python
Execution engines, comma-separated (python,java)
--key_password
GOLOOP_KEY_PASSWORD
false
Password for the KeyStore file
--key_plugin
GOLOOP_KEY_PLUGIN
false
KeyPlugin file for wallet
--key_plugin_options
GOLOOP_KEY_PLUGIN_OPTIONS
false
[]
KeyPlugin options
--key_secret
GOLOOP_KEY_SECRET
false
Secret (password) file for KeyStore
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--log_forwarder_address
GOLOOP_LOG_FORWARDER_ADDRESS
false
LogForwarder address
--log_forwarder_level
GOLOOP_LOG_FORWARDER_LEVEL
false
info
LogForwarder level
--log_forwarder_name
GOLOOP_LOG_FORWARDER_NAME
false
LogForwarder name
--log_forwarder_options
GOLOOP_LOG_FORWARDER_OPTIONS
false
[]
LogForwarder options, comma-separated 'key=value'
--log_forwarder_vendor
GOLOOP_LOG_FORWARDER_VENDOR
false
LogForwarder vendor (fluentd,logstash)
--log_level
GOLOOP_LOG_LEVEL
false
debug
Global log level (trace,debug,info,warn,error,fatal,panic)
--log_writer_compress
GOLOOP_LOG_WRITER_COMPRESS
false
false
Use gzip on rotated log file
--log_writer_filename
GOLOOP_LOG_WRITER_FILENAME
false
Log filename (rotated files resides in same directory)
--log_writer_localtime
GOLOOP_LOG_WRITER_LOCALTIME
false
false
Use localtime on rotated log file instead of UTC
--log_writer_maxage
GOLOOP_LOG_WRITER_MAXAGE
false
0
Maximum age of log file in day
--log_writer_maxbackups
GOLOOP_LOG_WRITER_MAXBACKUPS
false
0
Maximum number of backups
--log_writer_maxsize
GOLOOP_LOG_WRITER_MAXSIZE
false
100
Maximum log file size in MiB
--node_dir
GOLOOP_NODE_DIR
false
Node data directory (default: [configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
false
Node Command Line Interface socket path (default: [node_dir]/cli.sock)
--p2p
GOLOOP_P2P
false
127.0.0.1:8080
Advertise ip-port of P2P
--p2p_listen
GOLOOP_P2P_LISTEN
false
Listen ip-port of P2P
--rpc_addr
GOLOOP_RPC_ADDR
false
:9080
Listen ip-port of JSON-RPC
--rpc_dump
GOLOOP_RPC_DUMP
false
false
JSON-RPC Request, Response Dump flag
Start server
goloop server start [flags]
Name,shorthand
Environment Variable
Required
Default
Description
--cpuprofile
false
CPU Profiling data file
--memprofile
false
Memory Profiling data file
Name,shorthand
Environment Variable
Required
Default
Description
--backup_dir
GOLOOP_BACKUP_DIR
false
Node backup directory (default: [node_dir]/backup
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--console_level
GOLOOP_CONSOLE_LEVEL
false
trace
Console log level (trace,debug,info,warn,error,fatal,panic)
--ee_socket
GOLOOP_EE_SOCKET
false
Execution engine socket path
--engines
GOLOOP_ENGINES
false
python
Execution engines, comma-separated (python,java)
--key_password
GOLOOP_KEY_PASSWORD
false
Password for the KeyStore file
--key_plugin
GOLOOP_KEY_PLUGIN
false
KeyPlugin file for wallet
--key_plugin_options
GOLOOP_KEY_PLUGIN_OPTIONS
false
[]
KeyPlugin options
--key_secret
GOLOOP_KEY_SECRET
false
Secret (password) file for KeyStore
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--log_forwarder_address
GOLOOP_LOG_FORWARDER_ADDRESS
false
LogForwarder address
--log_forwarder_level
GOLOOP_LOG_FORWARDER_LEVEL
false
info
LogForwarder level
--log_forwarder_name
GOLOOP_LOG_FORWARDER_NAME
false
LogForwarder name
--log_forwarder_options
GOLOOP_LOG_FORWARDER_OPTIONS
false
[]
LogForwarder options, comma-separated 'key=value'
--log_forwarder_vendor
GOLOOP_LOG_FORWARDER_VENDOR
false
LogForwarder vendor (fluentd,logstash)
--log_level
GOLOOP_LOG_LEVEL
false
debug
Global log level (trace,debug,info,warn,error,fatal,panic)
--log_writer_compress
GOLOOP_LOG_WRITER_COMPRESS
false
false
Use gzip on rotated log file
--log_writer_filename
GOLOOP_LOG_WRITER_FILENAME
false
Log filename (rotated files resides in same directory)
--log_writer_localtime
GOLOOP_LOG_WRITER_LOCALTIME
false
false
Use localtime on rotated log file instead of UTC
--log_writer_maxage
GOLOOP_LOG_WRITER_MAXAGE
false
0
Maximum age of log file in day
--log_writer_maxbackups
GOLOOP_LOG_WRITER_MAXBACKUPS
false
0
Maximum number of backups
--log_writer_maxsize
GOLOOP_LOG_WRITER_MAXSIZE
false
100
Maximum log file size in MiB
--node_dir
GOLOOP_NODE_DIR
false
Node data directory (default: [configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
false
Node Command Line Interface socket path (default: [node_dir]/cli.sock)
--p2p
GOLOOP_P2P
false
127.0.0.1:8080
Advertise ip-port of P2P
--p2p_listen
GOLOOP_P2P_LISTEN
false
Listen ip-port of P2P
--rpc_addr
GOLOOP_RPC_ADDR
false
:9080
Listen ip-port of JSON-RPC
--rpc_dump
GOLOOP_RPC_DUMP
false
false
JSON-RPC Request, Response Dump flag
Display a live streams of chains metric-statistics
goloop stats
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--interval
GOLOOP_INTERVAL
false
1
Pull interval
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--no-stream
GOLOOP_NO-STREAM
false
false
Only pull the first metric-statistics
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Command
Description
goloop
Goloop CLI
System info
goloop system
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Command
Description
goloop
Goloop CLI
Manage stored backups
goloop system backup
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
List current backups
goloop system backup ls
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)
Configure system
goloop system config KEY VALUE
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Get system information
goloop system info [flags]
Name,shorthand
Environment Variable
Required
Default
Description
--format, -f
false
Format the output using the given Go template
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Restore chain from a backup
goloop system restore
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop system restore start
Start to restore the specified backup
goloop system restore start [NAME]
Name,shorthand
Environment Variable
Required
Default
Description
--overwrite
false
false
Overwrite existing chain
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 system restore status
Get restore status
goloop system restore status
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 system restore stop
Stop current restoring job
goloop system restore stop
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)
User management
goloop user
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Command
Description
goloop
Goloop CLI
Add user
goloop user add ADDRESS
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
List users
goloop user ls
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Remove user
goloop user rm ADDRESS
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
GOLOOP_CONFIG
false
Parsing configuration file
--key_store
GOLOOP_KEY_STORE
false
KeyStore file for wallet
--node_dir
GOLOOP_NODE_DIR
false
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
GOLOOP_NODE_SOCK
true
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Print goloop version
goloop version
Command
Description
goloop
Goloop CLI