getchaintxstats - Hush 3.10.0 RPC

getchaintxstats

Compute statistics about the total number and rate of transactions in the chain.

This RPC will return a large amount of additional data if the shielded index (zindex) is enabled.

Arguments:
1. nblocks   (numeric, optional) Number of blocks in averaging window.
2. blockhash (string, optional) The hash of the block which ends the window.

Result:
{
  "time": xxxxx,                           (numeric) The timestamp for the final block in the window in UNIX format.
  "txcount": xxxxx,                        (numeric) The total number of transactions in the chain up to that point.
  "nullifiers": xxxxx,                     (numeric) The total number of shielded nullifiers in the chain up to that point.
  "shielded_txcount": xxxxx,               (numeric) The total number of shielded (containing a zaddr) transactions in the chain up to that point.
  "shielded_outputs": xxxxx,               (numeric) The total number of shielded outputs in the chain up to that point.
  "shielded_spends": xxxxx,                (numeric) The total number of shielded spends in the chain up to that point.
  "shielded_pool_size": xxxxx,             (numeric) The total number of unspent shielded outputs, i.e. the Shielded Pool or Anonymity Set (anonset).
  "shielding_txcount": xxxxx,              (numeric) The total number of shielding (containing a zaddr output) transactions in the chain up to that point.
  "deshielding_txcount": xxxxx,            (numeric) The total number of deshielding (containing a zaddr input) transactions in the chain up to that point.
  "fully_shielded_txcount": xxxxx,         (numeric) The total number of z2z, AKA fully-shielded (containing only zaddr inputs+outputs) transactions in the chain up to that point.
  "payments": xxxxx,                       (numeric) The total number of payments in the chain up to that point.
  "shielded_payments": xxxxx,              (numeric) The total number of shielded (containing a zaddr) payments in the chain up to that point.
  "shielding_payments": xxxxx,             (numeric) The total number of shielding (containing a zaddr output) payments in the chain up to that point.
  "deshielding_payments": xxxxx,           (numeric) The total number of deshielding (containing a zaddr input) payments in the chain up to that point.
  "fully_shielded_payments": xxxxx,        (numeric) The total number of z2z, AKA fully-shielded (containing only zaddr inputs+outputs) payments in the chain up to that point.
  "notarizations": xxxxx,                  (numeric) The total number of notarization transactions in the chain up to that point.
  "window_final_block_hash": "...",      (string) The hash of the final block in the window.
  "window_final_block_height": xxxxx,      (numeric) Block height of final block in window.
  "window_block_count": xxxxx,             (numeric) Size of the window in number of blocks.
  "window_tx_count": xxxxx,                (numeric) The number of transactions in the window. Only returned if "window_block_count" is > 0.
  "window_interval": xxxxx,                (numeric) The elapsed time in the window in seconds. Only returned if "window_block_count" is > 0.
  "window_shielded_txcount": xxxxx,        (numeric) The total number of shielded (containing a zaddr) transactions in the chain up to that point.
  "window_shielding_txcount": xxxxx,       (numeric) The total number of shielding (containing a zaddr output) transactions in the chain up to that point.
  "window_deshielding_txcount": xxxxx,     (numeric) The total number of deshielding (containing a zaddr input) transactions in the chain up to that point.
  "window_fully_shielded_txcount": xxxxx,  (numeric) The total number of z2z, AKA fully-shielded (containing only zaddr inputs+outputs) transactions in the chain up to that point.
  "window_shielded_payments": xxxxx,       (numeric) The total number of shielded (containing a zaddr) payments in the chain up to that point.
  "window_shielding_payments": xxxxx,      (numeric) The total number of shielding (containing a zaddr output) payments in the chain up to that point.
  "window_deshielding_payments": xxxxx,    (numeric) The total number of deshielding (containing a zaddr input) payments in the chain up to that point.
  "window_fully_shielded_payments": xxxxx, (numeric) The total number of z2z, AKA fully-shielded (containing only zaddr inputs+outputs) payments in the chain up to that point.
  "txrate": x.xx,                          (numeric) The average rate of transactions per second in the window. Only returned if "window_interval" is > 0.
  "shielded": {                            (string)  The set of stats specific to only shieled transactions. 
      "fully_shielded_tx_percent":         (numeric) The percentage of fully shielded transactions.
      "shielding_tx_percent":              (numeric) The percentage of shielding transactions.
      "deshielding_tx_percent":            (numeric) The percentage of deshielding transactions.
      "fully_shielded_payments_percent":   (numeric) The percentage of fully shielded payments.
      "shielding_payments_percent":        (numeric) The percentage of shielding payments.
      "deshielding_payments_percent":      (numeric) The percentage of deshielding payments.
  },
  "organic": {                             (string)  The set of stats about organic transactions, i.e. those that are not coinbase and not notarizations
      "fully_shielded_tx_percent":         (numeric) The percentage of fully shielded organic transactions.
      "shielding_tx_percent":              (numeric) The percentage of shielding organic transactions.
      "deshielding_tx_percent":            (numeric) The percentage of deshielding organic transactions.
      "fully_shielded_payments_percent":   (numeric) The percentage of fully shielded organic payments.
      "shielding_payments_percent":        (numeric) The percentage of shielding organic payments.
      "deshielding_payments_percent":      (numeric) The percentage of deshielding organic payments.
  }
}

Examples:
> hush-cli getchaintxstats 
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getchaintxstats", "params": [2016] }' -H 'content-type: text/plain;' http://127.0.0.1:18031/

Maintained by The Hush Developers

Welcome to the Hush full node RPC developer documentation!!! You finally made it.