ExBitcoin v0.4.0 ExBitcoin.Control View Source

Control how bitcoin node works

Link to this section Summary

Functions

getinfo

getmemoryinfo (“mode”) Returns an object containing information about memory usage. Arguments:

  1. “mode” determines what kind of information is returned. This argument is optional, the default mode is “stats”.

    • “stats” returns general statistics about memory usage in the daemon.
    • “mallocinfo” returns an XML string describing low-level heap state (only available if compiled with glibc 2.10+)

stop

uptime

Link to this section Functions

getinfo

DEPRECATED. Returns an object containing various state info.

Result: { “deprecation-warning”: “…” (string) warning that the getinfo command is deprecated and will be removed in 0.16 “version”: xxxxx, (numeric) the server version “protocolversion”: xxxxx, (numeric) the protocol version “walletversion”: xxxxx, (numeric) the wallet version “balance”: xxxxxxx, (numeric) the total bitcoin balance of the wallet “blocks”: xxxxxx, (numeric) the current number of blocks processed in the server “timeoffset”: xxxxx, (numeric) the time offset “connections”: xxxxx, (numeric) the number of connections “proxy”: “host:port”, (string, optional) the proxy used by the server “difficulty”: xxxxxx, (numeric) the current difficulty “testnet”: true|false, (boolean) if the server is using testnet or not “keypoololdest”: xxxxxx, (numeric) the timestamp (seconds since Unix epoch) of the oldest pre-generated key in the key pool “keypoolsize”: xxxx, (numeric) how many new keys are pre-generated “unlocked_until”: ttt, (numeric) the timestamp in seconds since epoch (midnight Jan 1 1970 GMT) that the wallet is unlocked for transfers, or 0 if the wallet is locked “paytxfee”: x.xxxx, (numeric) the transaction fee set in BTC/kB “relayfee”: x.xxxx, (numeric) minimum relay fee for transactions in BTC/kB “errors”: “…” (string) any error messages }

Examples:

bitcoin-cli getinfo curl —user myusername —data-binary ‘{“jsonrpc”: “1.0”, “id”:”curltest”, “method”: “getinfo”, “params”: [] }’ -H ‘content-type: text/plain;’ http://127.0.0.1:8332/

Link to this function getmemoryinfo(mode) View Source
getmemoryinfo(:"String.t") :: any()

getmemoryinfo (“mode”) Returns an object containing information about memory usage. Arguments:

  1. “mode” determines what kind of information is returned. This argument is optional, the default mode is “stats”.

    • “stats” returns general statistics about memory usage in the daemon.
    • “mallocinfo” returns an XML string describing low-level heap state (only available if compiled with glibc 2.10+).

Result (mode “stats”): { “locked”: { (json object) Information about locked memory manager

"used": xxxxx,          (numeric) Number of bytes used
"free": xxxxx,          (numeric) Number of bytes available in current arenas
"total": xxxxxxx,       (numeric) Total number of bytes managed
"locked": xxxxxx,       (numeric) Amount of bytes that succeeded locking. If this number is smaller than total, locking pages failed at some point and key data could be swapped to disk.
"chunks_used": xxxxx,   (numeric) Number allocated chunks
"chunks_free": xxxxx,   (numeric) Number unused chunks

} }

Result (mode “mallocinfo”): “…”

Examples:

bitcoin-cli getmemoryinfo curl —user myusername —data-binary ‘{“jsonrpc”: “1.0”, “id”:”curltest”, “method”: “getmemoryinfo”, “params”: [] }’ -H ‘content-type: text/plain;’ http://127.0.0.1:8332/

stop

Stop Bitcoin server.

uptime

Returns the total uptime of the server.

Result: ttt (numeric) The number of seconds that the server has been running

Examples:

bitcoin-cli uptime curl —user myusername —data-binary ‘{“jsonrpc”: “1.0”, “id”:”curltest”, “method”: “uptime”, “params”: [] }’ -H ‘content-type: text/plain;’ http://127.0.0.1:8332/