contract.status

workflowrepo-lifecycle·step 7 of 10Workflow: repo-lifecycle · step 7 of 10

contract.status "id" Return the current wallet Arguments: 1. id (string, required) Result: { "id" : "hex", "kind" : "str", "state" : "str", "offer" : { ... }, "deadlines" : { ... }, "utxos" : [ { "txid" : "hex", "vout" : n, "amount" : n, "role" : "str" }, ... ], "closure" : { "type" : "str", "txid" : "hex", "height" : n, "time" : xxx }, "confs" : n, "vault_script_hex" } Examples: > bitcoin-cli contract.status view of a financing contract. Contract identifier (json object) Contract status payload (string) Contract identifier (string) Contract type (repo, spot, forward) (string) Contract state (proposed, accepted, opened, repaid, defaulted, closed) (json object) Offer details (json object) Contract deadlines (json array) Associated UTXOs (json object) (string) Transaction ID (numeric) Output index (numeric) Output amount (string) UTXO classification (vault, long_vault, short_vault, escrow) (json object, optional) Closure metadata when contract is repaid or defaulted (string) Lifecycle outcome (repaid or defaulted) (string) Lifecycle transaction id (numeric) Block height of lifecycle transaction (numeric) Block time of lifecycle transaction (numeric) Confirmations since creation : "hex" (string, optional) Vault covenant script when available "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Signature

contract.status(id: string) → any

Code samples

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

bitcoin-cli contract.status "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "contract.status",
        "params": ["\"<id>\""],
    },
    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: "contract.status",
    params: ["\"<id>\""],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
id	`string`	yes	Contract identifier

Result

Type: any

{ (json object) Contract status payload "id" : "hex", (string) Contract identifier "kind" : "str", (string) Contract type (repo, spot, forward) "state" : "str", (string) Contract state (proposed, accepted, opened, repaid, defaulted, closed) "offer" : { (json object) Offer details ... }, "deadlines" : { (json object) Contract deadlines ... }, "utxos" : [ (json array) Associated UTXOs { (json object) "txid" : "hex", (string) Transaction ID "vout" : n, (numeric) Output index "amount" : n, (numeric) Output amount "role" : "str" (string) UTXO classification (vault, long_vault, short_vault, escrow) }, ... ], "closure" : { (json object, optional) Closure metadata when contract is repaid or defaulted "type" : "str", (string) Lifecycle outcome (repaid or defaulted) "txid" : "hex", (string) Lifecycle transaction id "height" : n, (numeric) Block height of lifecycle transaction "time" : xxx (numeric) Block time of lifecycle transaction }, "confs" : n, (numeric) Confirmations since creation "vault_script_hex" : "hex" (string, optional) Vault covenant script when available }

Source: services/core-node/bcore/src/wallet/rpc/contracts.cpp:7397

C++ symbol: contract_status

Code samples

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

bitcoin-cli contract.status "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "contract.status",
        "params": ["\"<id>\""],
    },
    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: "contract.status",
    params: ["\"<id>\""],
  }),
});
console.log(await res.json());