vaultlist

vaultlist ( "contract_id" ) Lists all registered vaults, optionally filtered by contract ID. Arguments: 1. contract_id (string, optional) Optional contract ID to filter by Result: [ (json array) { (json object) "address" : "str", (string) The vault address "scriptPubKey" : "hex", (string) The vault scriptPubKey "output_key" : "hex", (string) The taproot output key "contract_id" : "hex", (string) The contract or offer ID "role" : "str", (string) The vault role "num_leaves" : n (numeric) Number of tapscript leaves }, ... ] Examples: > bitcoin-cli vaultlist > bitcoin-cli vaultlist "abc123..." > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "vaultlist", "params": []}' -H 'content-type: application/json' http://127.0.0.1:8332/ > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "vaultlist", "params": ["abc123..."]}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

vaultlist(contract_id?: string) → any

Code samples

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

bitcoin-cli vaultlist

bitcoin-cli vaultlist "abc123..."

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

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

Parameters

Name	Type	Req.	Description
contract_id	`string`	—	Optional contract ID to filter by

Result

Type: any

[ (json array) { (json object) "address" : "str", (string) The vault address "scriptPubKey" : "hex", (string) The vault scriptPubKey "output_key" : "hex", (string) The taproot output key "contract_id" : "hex", (string) The contract or offer ID "role" : "str", (string) The vault role "num_leaves" : n (numeric) Number of tapscript leaves }, ... ]

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

C++ symbol: vaultlist

Code samples

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

bitcoin-cli vaultlist

bitcoin-cli vaultlist "abc123..."

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

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