getpendingreorg

getpendingreorg Returns the pending reorg awaiting operator decision, or null if none. This only returns a value when -reorgadvisorygating=1 is set and a deep reorg has been detected that requires operator approval. Result (If no pending reorg): null (json null) Result (Otherwise): { (json object) "pending" : true|false, (boolean) Whether there is a pending reorg "candidate_tip" : "hex", (string) Hash of the candidate (fork) tip "current_tip" : "hex", (string) Hash of the current chain tip "pending_since" : n, (numeric) Unix timestamp when pending state was set "timeout_remaining" : n, (numeric) Seconds remaining until timeout "depth_current" : n, (numeric) Reorg depth on current chain "depth_fork" : n, (numeric) Reorg depth on fork chain "tx_overlap_pct" : n, (numeric) Transaction overlap percentage "hashrate_current_pct" : n, (numeric) Hashrate on current chain as % of baseline "hashrate_fork_pct" : n (numeric) Hashrate on fork chain as % of baseline } Examples: > bitcoin-cli getpendingreorg > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getpendingreorg", "params": []}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

getpendingreorg() → any

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"getpendingreorg","params":[]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli getpendingreorg

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getpendingreorg", "params": []}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "getpendingreorg",
        "params": [],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "getpendingreorg",
    params: [],
  }),
});
console.log(await res.json());

Parameters

No parameters.

Result

Type: any

null (json null) { (json object) "pending" : true|false, (boolean) Whether there is a pending reorg "candidate_tip" : "hex", (string) Hash of the candidate (fork) tip "current_tip" : "hex", (string) Hash of the current chain tip "pending_since" : n, (numeric) Unix timestamp when pending state was set "timeout_remaining" : n, (numeric) Seconds remaining until timeout "depth_current" : n, (numeric) Reorg depth on current chain "depth_fork" : n, (numeric) Reorg depth on fork chain "tx_overlap_pct" : n, (numeric) Transaction overlap percentage "hashrate_current_pct" : n, (numeric) Hashrate on current chain as % of baseline "hashrate_fork_pct" : n (numeric) Hashrate on fork chain as % of baseline }

Source: services/core-node/bcore/src/rpc/blockchain.cpp:3689

C++ symbol: getpendingreorg

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"getpendingreorg","params":[]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli getpendingreorg

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getpendingreorg", "params": []}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "getpendingreorg",
        "params": [],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "getpendingreorg",
    params: [],
  }),
});
console.log(await res.json());