đģManagement APIs
Besides the official dApp APIs interface, Elastos.ELA.SideChain.ESC has support for additional management APIs. Similar to the DApp APIs, these are also provided using JSON-RPC and follow exactly the same conventions. Geth comes with a console client which has support for all additional APIs described here.
Enabling the management APIs
To offer these APIs over the Geth RPC endpoints, please specify them with the --${interface}api command line argument (where ${interface} can be rpc for the HTTP endpoint, ws for the WebSocket endpoint and ipc for the unix socket (Unix) or named pipe (Windows) endpoint).
For example: geth --ipcapi admin,eth,miner --rpcapi eth,web3 --rpc
Enables the admin, official DApp and miner API over the IPC interface
Enables the official DApp and web3 API over the HTTP interface
The HTTP RPC interface must be explicitly enabled using the --rpc flag.
Please note, offering an API over the HTTP (rpc) or WebSocket (ws) interfaces will give everyone access to the APIs who can access this interface (DApps, browser tabs, etc). Be careful which APIs you enable. By default Geth enables all APIs over the IPC (ipc) interface and only the db, eth, net and web3 APIs over the HTTP and WebSocket interfaces.
To determine which APIs an interface provides, the modules JSON-RPC method can be invoked. For example over an ipc interface on unix systems:
will give all enabled modules including the version number:
Consuming the management APIs
The different functions are split into multiple smaller logically grouped APIs. Examples are given for the JavaScript console but can easily be converted to an RPC request.
2 examples:
Console:
miner.start()IPC:
echo '{"jsonrpc":"2.0","method":"miner_start","params":[],"id":1}' | nc -U $datadir/geth.ipcHTTP:
curl -X POST --data '{"jsonrpc":"2.0","method":"miner_start","params":[],"id":74}' localhost:20635
With the number of THREADS as an arguments:
Console:
miner.start(4)IPC:
echo '{"jsonrpc":"2.0","method":"miner_start","params":[4],"id":1}' | nc -U $datadir/geth.ipcHTTP:
curl -X POST --data '{"jsonrpc":"2.0","method":"miner_start","params":[4],"id":74}' localhost:20635
List of Management APIs
Besides the officially exposed dApp API namespaces (eth, shh, web3), Geth provides the following extra management API namespaces:
admin: Geth node managementdebug: Geth node debuggingminer: Miner and DAG managementpersonal: Account managementtxpool: Transaction pool inspection
admin
debug
miner
personal
txpool
addPeer
backtraceAt
setExtra
ecRecover
content
datadir
blockProfile
setGasPrice
importRawKey
inspect
nodeInfo
cpuProfile
start
listAccounts
status
peers
dumpBlock
stop
lockAccount
setSolc
gcStats
getHashrate
newAccount
startRPC
getBlockRlp
setEtherbase
unlockAccount
startWS
goTrace
sendTransaction
stopRPC
memStats
sign
stopWS
seedHashsign
setBlockProfileRate
setHead
stacks
startCPUProfile
startGoTrace
stopCPUProfile
stopGoTrace
traceBlock
traceBlockByNumber
traceBlockByHash
traceBlockFromFile
traceTransaction
verbosity
vmodule
writeBlockProfile
writeMemProfile
Admin
The admin API gives you access to several non-standard RPC methods, which will allow you to have a fine grained control over your Geth instance, including but not limited to network peer and RPC endpoint management.
admin_addPeer
The addPeer administrative method requests adding a new remote node to the list of tracked static nodes. The node will try to maintain connectivity to these nodes at all times, reconnecting every once in a while if the remote connection goes down.
The method accepts a single argument, the enode URL of the remote peer to start tracking and returns a BOOL indicating whether the peer was accepted for tracking or some error occurred.
Go
admin.AddPeer(url string) (bool, error)
Console
admin.addPeer(url)
RPC
{"method": "admin_addPeer", "params": [url]}
Example
admin_datadir
The datadir administrative property can be queried for the absolute path the running Geth node currently uses to store all its databases.
Go
admin.Datadir() (string, error)
Console
admin.datadir
RPC
{"method": "admin_datadir"}
Example
admin_peers
The peers administrative property can be queried for all the information known about the connected remote nodes at the networking granularity. These include general information about the nodes themselves as participants of the ÃÎVp2p P2P overlay protocol, as well as specialized information added by each of the running application protocols (e.g. eth, les, shh, bzz).
Go
admin.Peers() ([]*p2p.PeerInfo, error)
Console
admin.peers
RPC
{"method": "admin_peers"}
Example
admin_setSolc
The setSolc administrative method sets the Solidity compiler path to be used by the node when invoking the eth_compileSolidity RPC method. The Solidity compiler path defaults to /usr/bin/solc if not set, so you only need to change it for using a non-standard compiler location.
The method accepts an absolute path to the Solidity compiler to use (specifying a relative path would depend on the current â to the user unknown â working directory of Geth), and returns the version string reported by solc --version.
Go
admin.SetSolc(path string) (string, error)
Console
admin.setSolc(path)
RPC
{"method": "admin_setSolc", "params": [path]}
Example
admin_startRPC
The startRPC administrative method starts an HTTP based JSON RPC API webserver to handle client requests. All the parameters are optional:
host: network interface to open the listener socket on (defaults to"localhost")port: network port to open the listener socket on (defaults to20635)cors: cross-origin resource sharing header to use (defaults to"")apis: API modules to offer over this interface (defaults to"eth,net,web3")
The method returns a boolean flag specifying whether the HTTP RPC listener was opened or not. Please note, only one HTTP endpoint is allowed to be active at any time.
Go
admin.StartRPC(host *string, port *rpc.HexNumber, cors *string, apis *string) (bool, error)
Console
admin.startRPC(host, port, cors, apis)
RPC
{"method": "admin_startRPC", "params": [host, port, cors, apis]}
Example
admin_startWS
The startWS administrative method starts an WebSocket based JSON RPC API webserver to handle client requests. All the parameters are optional:
host: network interface to open the listener socket on (defaults to"localhost")port: network port to open the listener socket on (defaults to20635)cors: cross-origin resource sharing header to use (defaults to"")apis: API modules to offer over this interface (defaults to"eth,net,web3")
The method returns a boolean flag specifying whether the WebSocket RPC listener was opened or not. Please note, only one WebSocket endpoint is allowed to be active at any time.
Go
admin.StartWS(host *string, port *rpc.HexNumber, cors *string, apis *string) (bool, error)
Console
admin.startWS(host, port, cors, apis)
RPC
{"method": "admin_startWS", "params": [host, port, cors, apis]}
Example
admin_stopRPC
The stopRPC administrative method closes the currently open HTTP RPC endpoint. As the node can only have a single HTTP endpoint running, this method takes no parameters, returning a boolean whether the endpoint was closed or not.
Go
admin.StopRPC() (bool, error)
Console
admin.stopRPC()
RPC
{"method": "admin_stopRPC"
Example
admin_stopWS
The stopWS administrative method closes the currently open WebSocket RPC endpoint. As the node can only have a single WebSocket endpoint running, this method takes no parameters, returning a boolean whether the endpoint was closed or not.
Go
admin.StopWS() (bool, error)
Console
admin.stopWS()
RPC
{"method": "admin_stopWS"
Example
Debug
The debug API gives you access to several non-standard RPC methods, which will allow you to inspect, debug and set certain debugging flags during runtime.
debug_backtraceAt
Sets the logging backtrace location. When a backtrace location is set and a log message is emitted at that location, the stack of the goroutine executing the log statement will be printed to stderr.
The location is specified as <filename>:<line>.
Console
debug.backtraceAt(string)
RPC
{"method": "debug_backtraceAt", "params": [string]}
Example:
debug_blockProfile
Turns on block profiling for the given duration and writes profile data to disk. It uses a profile rate of 1 for most accurate information. If a different rate is desired, set the rate and write the profile manually using debug_writeBlockProfile.
Console
debug.blockProfile(file, seconds)
RPC
{"method": "debug_blockProfile", "params": [string, number]}
debug_cpuProfile
Turns on CPU profiling for the given duration and writes profile data to disk.
Console
debug.cpuProfile(file, seconds)
RPC
{"method": "debug_cpuProfile", "params": [string, number]}
debug_dumpBlock
Retrieves the state that corresponds to the block number and returns a list of accounts (including storage and code).
Go
debug.DumpBlock(number uint64) (state.World, error)
Console
debug.traceBlockByHash(number, [options])
RPC
{"method": "debug_dumpBlock", "params": [number]}
Example
debug_gcStats
Returns GC statistics.
See https://golang.org/pkg/runtime/debug/#GCStats for information about the fields of the returned object.
Console
debug.gcStats()
RPC
{"method": "debug_gcStats", "params": []}
debug_getBlockRlp
Retrieves and returns the RLP encoded block by number.
Go
debug.GetBlockRlp(number uint64) (string, error)
Console
debug.getBlockRlp(number, [options])
RPC
{"method": "debug_getBlockRlp", "params": [number]}
References: RLP
debug_goTrace
Turns on Go runtime tracing for the given duration and writes trace data to disk.
Console
debug.goTrace(file, seconds)
RPC
{"method": "debug_goTrace", "params": [string, number]}
debug_memStats
Returns detailed runtime memory statistics.
See https://golang.org/pkg/runtime/#MemStats for information about the fields of the returned object.
Console
debug.memStats()
RPC
{"method": "debug_memStats", "params": []}
debug_seedHash
Fetches and retrieves the seed hash of the block by number
Go
debug.SeedHash(number uint64) (string, error)
Console
debug.seedHash(number, [options])
RPC
{"method": "debug_seedHash", "params": [number]}
debug_setHead
Sets the current head of the local chain by block number. Note: this is a destructive action and may severely damage your chain. Use with extreme caution.
Go
debug.SetHead(number uint64)
Console
debug.setHead(number)
RPC
{"method": "debug_setHead", "params": [number]}
References: Ethash
debug_setBlockProfileRate
Sets the rate (in samples/sec) of goroutine block profile data collection. A non-zero rate enables block profiling, setting it to zero stops the profile. Collected profile data can be written using debug_writeBlockProfile.
Console
debug.setBlockProfileRate(rate)
RPC
{"method": "debug_setBlockProfileRate", "params": [number]}
debug_stacks
Returns a printed representation of the stacks of all goroutines. Note that the web3 wrapper for this method takes care of the printing and does not return the string.
Console
debug.stacks()
RPC
{"method": "debug_stacks", "params": []}
debug_startCPUProfile
Turns on CPU profiling indefinitely, writing to the given file.
Console
debug.startCPUProfile(file)
RPC
{"method": "debug_startCPUProfile", "params": [string]}
debug_startGoTrace
Starts writing a Go runtime trace to the given file.
Console
debug.startGoTrace(file)
RPC
{"method": "debug_startGoTrace", "params": [string]}
debug_stopCPUProfile
Stops an ongoing CPU profile.
Console
debug.stopCPUProfile()
RPC
{"method": "debug_stopCPUProfile", "params": []}
debug_stopGoTrace
Stops writing the Go runtime trace.
Console
debug.startGoTrace(file)
RPC
{"method": "debug_stopGoTrace", "params": []}
debug_traceBlock
The traceBlock method will return a full stack trace of all invoked opcodes of all transaction that were included included in this block. Note: the parent of this block must be present or it will fail.
Go
debug.TraceBlock(blockRlp []byte, config. *vm.Config) BlockTraceResult
Console
debug.traceBlock(tblockRlp, [options])
RPC
{"method": "debug_traceBlock", "params": [blockRlp, {}]}
References: RLP
Example
debug_traceBlockByNumber
Similar to debug_traceBlock, traceBlockByNumber accepts a block number and will replay the block that is already present in the database.
Go
debug.TraceBlockByNumber(number uint64, config. *vm.Config) BlockTraceResult
Console
debug.traceBlockByNumber(number, [options])
RPC
{"method": "debug_traceBlockByNumber", "params": [number, {}]}
References: RLP
debug_traceBlockByHash
Similar to debug_traceBlock, traceBlockByHash accepts a block hash and will replay the block that is already present in the database.
Go
debug.TraceBlockByHash(hash common.Hash, config. *vm.Config) BlockTraceResult
Console
debug.traceBlockByHash(hash, [options])
RPC
{"method": "debug_traceBlockByHash", "params": [hash {}]}
References: RLP
debug_traceBlockFromFile
Similar to debug_traceBlock, traceBlockFromFile accepts a file containing the RLP of the block.
Go
debug.TraceBlockFromFile(fileName string, config. *vm.Config) BlockTraceResult
Console
debug.traceBlockFromFile(fileName, [options])
RPC
{"method": "debug_traceBlockFromFile", "params": [fileName, {}]}
References: RLP
debug_traceTransaction
The traceTransaction debugging method will attempt to run the transaction in the exact same manner as it was executed on the network. It will replay any transaction that may have been executed prior to this one before it will finally attempt to execute the transaction that corresponds to the given hash.
In addition to the hash of the transaction you may give it a secondary optional argument, which specifies the options for this specific call. The possible options are:
disableStorage:BOOL. Setting this to true will disable storage capture (default = false).disableMemory:BOOL. Setting this to true will disable memory capture (default = false).disableStack:BOOL. Setting this to true will disable stack capture (default = false).tracer:STRING. Setting this will enable JavaScript-based transaction tracing, described below. If set, the previous four arguments will be ignored.timeout:STRING. Overrides the default timeout of 5 seconds for JavaScript-based tracing calls. Valid values are described here.
Go
debug.TraceTransaction(txHash common.Hash, logger *vm.LogConfig) (*ExecutionResurt, error)
Console
debug.traceTransaction(txHash, [options])
RPC
{"method": "debug_traceTransaction", "params": [txHash, {}]}
Example
JavaScript-based tracing
Specifying the tracer option in the second argument enables JavaScript-based tracing. In this mode, tracer is interpreted as a JavaScript expression that is expected to evaluate to an object with (at least) two methods, named step and result.
stepis a function that takes two arguments, log and db, and is called for each step of the EVM, or when an error occurs, as the specified transaction is traced.
log has the following fields:
pc: Number, the current program counterop: Object, an OpCode object representing the current opcodegas: Number, the amount of gas remaininggasPrice: Number, the cost in wei of each unit of gasmemory: Object, a structure representing the contract's memory spacestack: array[big.Int], the EVM execution stackdepth: The execution depthaccount: The address of the account executing the current operationerr: If an error occured, information about the error
If err is non-null, all other fields should be ignored.
For efficiency, the same log object is reused on each execution step, updated with current values; make sure to copy values you want to preserve beyond the current call. For instance, this step function will not work:
But this step function will:
log.op has the following methods:
isPush()- returns true iff the opcode is a PUSHntoString()- returns the string representation of the opcodetoNumber()- returns the opcode's number
log.memory has the following methods:
slice(start, stop)- returns the specified segment of memory as a byte slicelength()- returns the length of the memory
log.stack has the following methods:
peek(idx)- returns the idx-th element from the top of the stack (0 is the topmost element) as a big.Intlength()- returns the number of elements in the stack
db has the following methods:
getBalance(address)- returns abig.Intwith the specified account's balancegetNonce(address)- returns a Number with the specified account's noncegetCode(address)- returns a byte slice with the code for the specified accountgetState(address, hash)- returns the state value for the specified account and the specified hashexists(address)- returns true if the specified address exists
The second function, 'result', takes no arguments, and is expected to return a JSON-serializable value to return to the RPC caller.
If the step function throws an exception or executes an illegal operation at any point, it will not be called on any further VM steps, and the error will be returned to the caller.
Note that several values are Golang big.Int objects, not JavaScript numbers or JS bigints. As such, they have the same interface as described in the godocs. Their default serialization to JSON is as a Javascript number; to serialize large numbers accurately call .String() on them. For convenience, big.NewInt(x) is provided, and will convert a uint to a Go BigInt.
Usage example, returns the top element of the stack at each CALL opcode only:
debug_verbosity
Sets the logging verbosity ceiling. Log messages with level up to and including the given level will be printed.
The verbosity of individual packages and source files can be raised using debug_vmodule.
Console
debug.verbosity(level)
RPC
{"method": "debug_vmodule", "params": [number]}
debug_vmodule
Sets the logging verbosity pattern.
Console
debug.vmodule(string)
RPC
{"method": "debug_vmodule", "params": [string]}
Examples
If you want to see messages from a particular Go package (directory) and all subdirectories, use:
If you want to restrict messages to a particular package (e.g. p2p) but exclude subdirectories, use:
If you want to see log messages from a particular source file, use
You can compose these basic patterns. If you want to see all output from peer.go in a package below eth (eth/peer.go, eth/downloader/peer.go) as well as output from package p2p at level <= 5, use:
debug_writeBlockProfile
Writes a goroutine blocking profile to the given file.
Console
debug.writeBlockProfile(file)
RPC
{"method": "debug_writeBlockProfile", "params": [string]}
debug_writeMemProfile
Writes an allocation profile to the given file. Note that the profiling rate cannot be set through the API, it must be set on the command line using the --memprofilerate flag.
Console
debug.writeMemProfile(file string)
RPC
{"method": "debug_writeBlockProfile", "params": [string]}
Miner
The miner API allows you to remote control the node's mining operation and set various mining specific settings.
miner_setExtra
Sets the extra data a miner can include when miner blocks. This is capped at 32 bytes.
Go
miner.setExtra(extra string) (bool, error)
Console
miner.setExtra(string)
RPC
{"method": "miner_setExtra", "params": [string]}
miner_setGasPrice
Sets the minimal accepted gas price when mining transactions. Any transactions that are below this limit are excluded from the mining process.
Go
miner.setGasPrice(number *rpc.HexNumber) bool
Console
miner.setGasPrice(number)
RPC
{"method": "miner_setGasPrice", "params": [number]}
miner_start
Start the CPU mining process with the given number of threads and generate a new DAG if need be.
Go
miner.Start(threads *rpc.HexNumber) (bool, error)
Console
miner.start(number)
RPC
{"method": "miner_start", "params": [number]}
miner_stop
Stop the CPU mining operation.
Go
miner.Stop() bool
Console
miner.stop()
RPC
{"method": "miner_stop", "params": []}
miner_setEtherBase
Sets the etherbase, where mining rewards will go.
Go
miner.SetEtherbase(common.Address) bool
Console
miner.setEtherbase(address)
RPC
{"method": "miner_setEtherbase", "params": [address]}
Personal
The personal API manages private keys in the key store.
personal_importRawKey
Imports the given unencrypted private key (hex string) into the key store, encrypting it with the passphrase.
Returns the address of the new account.
Console
personal.importRawKey(keydata, passphrase)
RPC
{"method": "personal_importRawKey", "params": [string, string]}
personal_listAccounts
Returns all the Ethereum account addresses of all keys in the key store.
Console
personal.listAccounts
RPC
{"method": "personal_listAccounts", "params": []}
Example
personal_lockAccount
Removes the private key with given address from memory. The account can no longer be used to send transactions.
Console
personal.lockAccount(address)
RPC
{"method": "personal_lockAccount", "params": [string]}
personal_newAccount
Generates a new private key and stores it in the key store directory. The key file is encrypted with the given passphrase. Returns the address of the new account.
At the geth console, newAccount will prompt for a passphrase when it is not supplied as the argument.
Console
personal.newAccount()
RPC
{"method": "personal_newAccount", "params": [string]}
Example
The passphrase can also be supplied as a string.
personal_unlockAccount
Decrypts the key with the given address from the key store.
Both the passphrase and unlock duration are optional when using the JavaScript console. If the passphrase is not supplied as an argument, the console will prompt for the passphrase interactively.
The unencrypted key will be held in memory until the unlock duration expires. If the unlock duration defaults to 300 seconds. An explicit duration of zero seconds unlocks the key until geth exits.
The account can be used with eth_sign and eth_sendTransaction while it is unlocked.
Console
personal.unlockAccount(address, passphrase, duration)
RPC
{"method": "personal_unlockAccount", "params": [string, string, number]}
Examples
Supplying the passphrase and unlock duration as arguments:
If you want to type in the passphrase and stil override the default unlock duration, pass null as the passphrase.
personal_sendTransaction
Validate the given passphrase and submit transaction.
The transaction is the same argument as for eth_sendTransaction and contains the from address. If the passphrase can be used to decrypt the private key belogging to tx.from the transaction is verified, signed and send onto the network. The account is not unlocked globally in the node and cannot be used in other RPC calls.
Console
personal.sendTransaction(tx, passphrase)
RPC
{"method": "personal_sendTransaction", "params": [tx, string]}
Note, prior to Geth 1.5, please use personal_signAndSendTransaction as that was the original introductory name and only later renamed to the current final version.
Examples
personal_sign
The sign method calculates an Ethereum specific signature with: sign(keccack256("\x19Ethereum Signed Message:\n" + len(message) + message))).
By adding a prefix to the message makes the calculated signature recognisable as an Ethereum specific signature. This prevents misuse where a malicious DApp can sign arbitrary data (e.g. transaction) and use the signature to impersonate the victim.
See ecRecover to verify the signature.
Console
personal.sign(message, account, [password])
RPC
{"method": "personal_sign", "params": [message, account, password]}
Examples
personal_ecRecover
ecRecover returns the address associated with the private key that was used to calculate the signature in personal_sign.
Console
personal.ecRecover(message, signature)
RPC
{"method": "personal_ecRecover", "params": [message, signature]}
Examples
Txpool
The txpool API gives you access to several non-standard RPC methods to inspect the contents of the transaction pool containing all the currently pending transactions as well as the ones queued for future processing.
txpool_content
The content inspection property can be queried to list the exact details of all the transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.
The result is an object with two fields pending and queued. Each of these fields are associative arrays, in which each entry maps an origin-address to a batch of scheduled transactions. These batches themselves are maps associating nonces with actual transactions.
Please note, there may be multiple transactions associated with the same account and nonce. This can happen if the user broadcast mutliple ones with varying gas allowances (or even complerely different transactions).
Go
txpool.Content() (map[string]map[string]map[string][]*RPCTransaction)
Console
txpool.content
RPC
{"method": "txpool_content"}
Example
txpool_inspect
The inspect inspection property can be queried to list a textual summary of all the transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only. This is a method specifically tailored to developers to quickly see the transactions in the pool and find any potential issues.
The result is an object with two fields pending and queued. Each of these fields are associative arrays, in which each entry maps an origin-address to a batch of scheduled transactions. These batches themselves are maps associating nonces with transactions summary strings.
Please note, there may be multiple transactions associated with the same account and nonce. This can happen if the user broadcast mutliple ones with varying gas allowances (or even complerely different transactions).
Go
txpool.Inspect() (map[string]map[string]map[string][]string)
Console
txpool.inspect
RPC
{"method": "txpool_inspect"}
Example
txpool_status
The status inspection property can be queried for the number of transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.
The result is an object with two fields pending and queued, each of which is a counter representing the number of transactions in that particular state.
Go
txpool.Status() (map[string]*rpc.HexNumber)
Console
txpool.status
RPC
{"method": "txpool_status"}
Example
Last updated