vaultinfo

vaultinfo "address" Returns detailed information about Arguments: 1. address (string, required) The Result: { (json "registered" : true|false, "address" : "str", "scriptPubKey" : "hex", "output_key" : "hex", "internal_key" : "hex", "merkle_root" : "hex", "contract_id" : "hex", "role" : "str", "version" : n, "leaves" : [ { (json "script" : "hex", "leaf_version" : n, "signing_key" : "hex", "purpose" : "str", "timelock" : n }, ... ] } Examples: > bitcoin-cli vaultinfo "bcrt1p...& > curl --user myusername --data-binary a registered vault. taproot address of the vault object) (boolean) Whether the vault is registered (string) The vault address (string) The vault scriptPubKey (string) The taproot output key (32-byte x-only pubkey) (string) The taproot internal key (string) The tapscript merkle root (string) The contract or offer ID (string) The vault role (REPO_BORROWER, REPO_LENDER, etc.) (numeric) Vault metadata version (json array) Array of tapscript leaves object) (string) The leaf script (numeric) The leaf version (usually 0xc0 for tapscript) (string) The x-only pubkey that can sign this leaf (string) Human-readable purpose (repay, default, timeout, etc.) (numeric, optional) CLTV/CSV timelock value if applicable quot; '{"jsonrpc": "2.0", "id": "curltest", "method": "vaultinfo", "params": ["bcrt1p..."]}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

vaultinfo(address: string) → any

Code samples

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

bitcoin-cli vaultinfo "bcrt1p..."

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "vaultinfo", "params": ["bcrt1p..."]}' -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": "vaultinfo",
        "params": ["\"<address>\""],
    },
    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: "vaultinfo",
    params: ["\"<address>\""],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
address	`string`	yes	The taproot address of the vault

Result

Type: any

{ (json object) "registered" : true|false, (boolean) Whether the vault is registered "address" : "str", (string) The vault address "scriptPubKey" : "hex", (string) The vault scriptPubKey "output_key" : "hex", (string) The taproot output key (32-byte x-only pubkey) "internal_key" : "hex", (string) The taproot internal key "merkle_root" : "hex", (string) The tapscript merkle root "contract_id" : "hex", (string) The contract or offer ID "role" : "str", (string) The vault role (REPO_BORROWER, REPO_LENDER, etc.) "version" : n, (numeric) Vault metadata version "leaves" : [ (json array) Array of tapscript leaves { (json object) "script" : "hex", (string) The leaf script "leaf_version" : n, (numeric) The leaf version (usually 0xc0 for tapscript) "signing_key" : "hex", (string) The x-only pubkey that can sign this leaf "purpose" : "str", (string) Human-readable purpose (repay, default, timeout, etc.) "timelock" : n (numeric, optional) CLTV/CSV timelock value if applicable }, ... ] }

Source: services/core-node/bcore/src/wallet/rpc/vaults.cpp:16

C++ symbol: vaultinfo

Code samples

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

bitcoin-cli vaultinfo "bcrt1p..."

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "vaultinfo", "params": ["bcrt1p..."]}' -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": "vaultinfo",
        "params": ["\"<address>\""],
    },
    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: "vaultinfo",
    params: ["\"<address>\""],
  }),
});
console.log(await res.json());