mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-23 23:06:44 +01:00
133 lines
4.1 KiB
JSON
133 lines
4.1 KiB
JSON
{
|
|
"$schema": "../rpc-schema-draft.json",
|
|
"type": "object",
|
|
"added": "v23.11",
|
|
"rpc": "addpsbtoutput",
|
|
"title": "Command to populate PSBT outputs from the wallet",
|
|
"description": [
|
|
"`addpsbtoutput` is a low-level RPC command which creates or modifies a PSBT by adding a single output of amount *satoshi*.",
|
|
"",
|
|
"This is used to receive funds into the on-chain wallet interactively using PSBTs."
|
|
],
|
|
"request": {
|
|
"required": [
|
|
"satoshi"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"satoshi": {
|
|
"type": "sat",
|
|
"description": [
|
|
"The satoshi value of the output. It can be a whole number, a whole number ending in *sat*, or a number with 1 to 8 decimal places ending in *btc*."
|
|
]
|
|
},
|
|
"initialpsbt": {
|
|
"type": "string",
|
|
"description": [
|
|
"Base 64 encoded PSBT to add the output to. If not specified, one will be generated automatically."
|
|
]
|
|
},
|
|
"locktime": {
|
|
"type": "u32",
|
|
"description": [
|
|
"If not set, it is set to a recent block height (if no initial psbt is specified)."
|
|
]
|
|
},
|
|
"destination": {
|
|
"type": "string",
|
|
"description": [
|
|
"If it is not set, an internal address is generated."
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"response": {
|
|
"required": [
|
|
"psbt",
|
|
"estimated_added_weight",
|
|
"outnum"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"psbt": {
|
|
"type": "string",
|
|
"description": [
|
|
"Unsigned PSBT which fulfills the parameters given."
|
|
]
|
|
},
|
|
"estimated_added_weight": {
|
|
"type": "u32",
|
|
"description": [
|
|
"The estimated weight of the added output."
|
|
]
|
|
},
|
|
"outnum": {
|
|
"type": "u32",
|
|
"description": [
|
|
"The 0-based number where the output was placed."
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"author": [
|
|
"Dusty <<@dusty_daemon>> is mainly responsible."
|
|
],
|
|
"see_also": [
|
|
"lightning-fundpsbt(7)",
|
|
"lightning-utxopsbt(7)"
|
|
],
|
|
"resources": [
|
|
"Main web site: <https://github.com/ElementsProject/lightning>"
|
|
],
|
|
"examples": [
|
|
{
|
|
"description": [
|
|
"Here is a command to make a PSBT with a 1,000,000 sat output that leads to the on-chain wallet:"
|
|
],
|
|
"request": {
|
|
"id": "example:addpsbtoutput#1",
|
|
"method": "addpsbtoutput",
|
|
"params": {
|
|
"satoshi": 1000000,
|
|
"locktime": 111
|
|
}
|
|
},
|
|
"response": {
|
|
"psbt": "cHNidP8BAgpsbt1001010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101",
|
|
"estimated_added_weight": 172,
|
|
"outnum": 1
|
|
}
|
|
},
|
|
{
|
|
"request": {
|
|
"id": "example:addpsbtoutput#2",
|
|
"method": "addpsbtoutput",
|
|
"params": [
|
|
3333333,
|
|
"cHNidP8BAgpsbt20020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202"
|
|
]
|
|
},
|
|
"response": {
|
|
"psbt": "cHNidP8BAgpsbt20020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202",
|
|
"estimated_added_weight": 172,
|
|
"outnum": 1
|
|
}
|
|
},
|
|
{
|
|
"request": {
|
|
"id": "example:addpsbtoutput#3",
|
|
"method": "addpsbtoutput",
|
|
"params": {
|
|
"satoshi": 3333333,
|
|
"initialpsbt": "cHNidP8BAgpsbt20020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202020202",
|
|
"destination": "bcrt1p5201010101010101010101010101010101010101010101010101010101"
|
|
}
|
|
},
|
|
"response": {
|
|
"psbt": "cHNidP8BAgpsbt300303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303030303",
|
|
"estimated_added_weight": 172,
|
|
"outnum": 1
|
|
}
|
|
}
|
|
]
|
|
}
|