repo.build_open

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

repo.build_open "id" Construct the opening PSBT for Arguments: 1. id 2. options { "locktime": n, "auto_fund_principal": bool, "auto_fund_collateral": bool, "psbt": "str", } Result: { "psbt" : "str", "fee" : n, "changepos" : n, "principal_output_index" : n, "covenant_output_index" : n, "asset_change_output_index" : n, "taproot" : { "output_key" : "hex", "internal_key" : "hex", "script_pubkey" : "hex", "tree" : [ { "depth" : n, "leaf_version" : n, "script" : "hex" }, ... ] }, "complete" : true|false } Examples: > bitcoin-cli repo.build_open ( {"locktime":n,"auto_fund_principal":bool,"auto_fund_collateral":bool,"psbt":"str"} ) a repo offer, funding the collateral vault and including the lender's principal payout. Two-party workflow: Lender calls with auto_fund_principal=true, borrower receives PSBT and calls with psbt= and auto_fund_collateral=true to add collateral funding. (string, required) Repo offer identifier (json object, optional) Optional funding overrides (numeric, optional) Override transaction nLockTime (boolean, optional) Lender mode: automatically attach wallet-controlled asset inputs for principal (boolean, optional) Borrower mode: automatically attach wallet-controlled BTC inputs for collateral (string, optional) Existing PSBT to add funding to (used with auto_fund_collateral) (json object) (string) Base64-encoded PSBT containing the funded covenant transaction (numeric) Fee (in BTC) paid by the wallet to fund this PSBT (numeric) Index of the change output or -1 if none (numeric) Index of the principal asset output within the PSBT (numeric) Index of the covenant Taproot output within the PSBT (numeric) Index of the asset change output when auto_fund_principal is used, otherwise -1 (json object) Taproot construction details (string) Tweaked Taproot output key (string) Internal Taproot key (string) Hex-encoded covenant scriptPubKey (json array) Taproot script tree (json object) (numeric) Depth of the leaf (numeric) Taproot leaf version (string) Hex-encoded leaf script (boolean) Whether the PSBT already contains all signatures "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Signature

repo.build_open(id: string, options?: object) → any

Code samples

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

bitcoin-cli repo.build_open "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

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

Parameters

Name	Type	Req.	Description
id	`string`	yes	Repo offer identifier
options	`object`	—	Optional funding overrides { "locktime": n, (numeric, optional) Override transaction nLockTime "auto_fund_principal": bool, (boolean, optional) Lender mode: automatically attach wallet-controlled asset inputs for principal "auto_fund_collateral": bool, (boolean, optional) Borrower mode: automatically attach wallet-controlled BTC inputs for collateral "psbt": "str", (string, optional) Existing PSBT to add funding to (used with auto_fund_collateral) }

Result

Type: any

{ (json object) "psbt" : "str", (string) Base64-encoded PSBT containing the funded covenant transaction "fee" : n, (numeric) Fee (in BTC) paid by the wallet to fund this PSBT "changepos" : n, (numeric) Index of the change output or -1 if none "principal_output_index" : n, (numeric) Index of the principal asset output within the PSBT "covenant_output_index" : n, (numeric) Index of the covenant Taproot output within the PSBT "asset_change_output_index" : n, (numeric) Index of the asset change output when auto_fund_principal is used, otherwise -1 "taproot" : { (json object) Taproot construction details "output_key" : "hex", (string) Tweaked Taproot output key "internal_key" : "hex", (string) Internal Taproot key "script_pubkey" : "hex", (string) Hex-encoded covenant scriptPubKey "tree" : [ (json array) Taproot script tree { (json object) "depth" : n, (numeric) Depth of the leaf "leaf_version" : n, (numeric) Taproot leaf version "script" : "hex" (string) Hex-encoded leaf script }, ... ] }, "complete" : true|false (boolean) Whether the PSBT already contains all signatures }

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

C++ symbol: repo_build_open

Code samples

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

bitcoin-cli repo.build_open "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

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