repo.build_repay_release

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

repo.build_repay_release "id" Construct the repayment PSBT Arguments: 1. id 2. options { "vault_txid": "hex", "vault_vout": n, "vault_amount": n, "collateral_address": "manual_inputs": bool, "inputs": [ { "txid": "hex", "vout": n, }, ... ], "locktime": n, "fee_rate": n, } Result: { "psbt" : "str", "fee" : n, "changepos" : n, "vault_input_index" : n, "principal_output_index" : n, "interest_output_index" : n, "repay_output_index" : n, "collateral_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, "hex" : "hex", "txid" : "hex" } Examples: > bitcoin-cli repo.build_repay_release ( {"vault_txid":"hex","vault_vout":n,"vault_amount":n,"collateral_address":"str","manual_inputs":bool,"inputs":[{"txid":"hex","vout":n},...],"locktime":n,"fee_rate":n} ) for an accepted repo contract. The PSBT spends the vault via the repay leaf, pays the lender the fixed repay amount, and releases collateral back to the borrower. (string, required) Repo offer identifier (json object, optional) Optional builder settings (string, optional) Override vault outpoint txid (used if wallet registry is unaware) (numeric, optional) Override vault outpoint index (numeric, optional) Vault amount (BTC) when tx not yet known to wallet "str", (string, optional) Destination for released collateral (defaults to fresh wallet address) (boolean, optional) Disable automatic asset input selection and use options.inputs (json array, optional) Manual additional inputs (requires manual_inputs=true) (json object, required) (string, required) Input txid (numeric, required) Input vout (numeric, optional) Override transaction nLockTime (numeric, optional) Override fee rate in sat/vB (wallet estimate if omitted) (json object) (string) Base64-encoded PSBT (numeric) Wallet-computed fee (in BTC) (numeric) Index of wallet change output or -1 if none (numeric) Index of the covenant input within the PSBT (numeric) Index of the principal payment output to lender (numeric) Index of the interest payment output to lender (numeric) Index of the repay output (legacy, points to principal) (numeric) Index of the collateral release output (numeric) Index of the asset change output or -1 if none (json object) Taproot spend data (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 (string, optional) Signed transaction hex (present when complete=true) (string, optional) Transaction identifier (present when complete=true) "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Signature

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

Code samples

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

bitcoin-cli repo.build_repay_release "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_repay_release",
        "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_repay_release",
    params: ["\"<id>\"",{}],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
id	`string`	yes	Repo offer identifier
options	`object`	—	Optional builder settings { "vault_txid": "hex", (string, optional) Override vault outpoint txid (used if wallet registry is unaware) "vault_vout": n, (numeric, optional) Override vault outpoint index "vault_amount": n, (numeric, optional) Vault amount (BTC) when tx not yet known to wallet "collateral_address": "str", (string, optional) Destination for released collateral (defaults to fresh wallet address) "manual_inputs": bool, (boolean, optional) Disable automatic asset input selection and use options.inputs "inputs": [ (json array, optional) Manual additional inputs (requires manual_inputs=true) { (json object, required) "txid": "hex", (string, required) Input txid "vout": n, (numeric, required) Input vout }, ... ], "locktime": n, (numeric, optional) Override transaction nLockTime "fee_rate": n, (numeric, optional) Override fee rate in sat/vB (wallet estimate if omitted) }

Result

Type: any

{ (json object) "psbt" : "str", (string) Base64-encoded PSBT "fee" : n, (numeric) Wallet-computed fee (in BTC) "changepos" : n, (numeric) Index of wallet change output or -1 if none "vault_input_index" : n, (numeric) Index of the covenant input within the PSBT "principal_output_index" : n, (numeric) Index of the principal payment output to lender "interest_output_index" : n, (numeric) Index of the interest payment output to lender "repay_output_index" : n, (numeric) Index of the repay output (legacy, points to principal) "collateral_output_index" : n, (numeric) Index of the collateral release output "asset_change_output_index" : n, (numeric) Index of the asset change output or -1 if none "taproot" : { (json object) Taproot spend data "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 "hex" : "hex", (string, optional) Signed transaction hex (present when complete=true) "txid" : "hex" (string, optional) Transaction identifier (present when complete=true) }

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

C++ symbol: repo_build_repay_release

Code samples

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

bitcoin-cli repo.build_repay_release "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_repay_release",
        "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_repay_release",
    params: ["\"<id>\"",{}],
  }),
});
console.log(await res.json());