core-lightning/doc/schemas/lightning-sendpsbt.json
2024-08-09 23:56:45 -07:00

82 lines
3.5 KiB
JSON

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"additionalProperties": false,
"rpc": "sendpsbt",
"title": "Command to finalize, extract and send a partially signed bitcoin transaction (PSBT).",
"description": [
"The **sendpsbt** is a low-level RPC command which sends a fully-signed PSBT."
],
"request": {
"required": [
"psbt"
],
"properties": {
"psbt": {
"type": "string",
"description": [
"The fully signed psbt to be sent."
]
},
"reserve": {
"type": "u32",
"description": [
"Number of blocks to increase reservation of any of our inputs by."
],
"default": "72"
}
}
},
"response": {
"required": [
"tx",
"txid"
],
"properties": {
"tx": {
"type": "hex",
"description": [
"The raw transaction which was sent."
]
},
"txid": {
"type": "txid",
"description": [
"The txid of the **tx**."
]
}
}
},
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters or some error happened during the command process."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-fundpsbt(7)",
"lightning-signpsbt(7)",
"lightning-listtransactions(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:sendpsbt#1",
"method": "sendpsbt",
"params": {
"psbt": "cHNidP8BAHsCAAAAApYPhUDCjBy/IhQro1NgHyHktDtz752euhXVr901aH1zAAAAAAD9////pVexPrCyRyESCD3U1cC5oifK1QBxTxBSKMaWE8H/R3UAAAAAAP3///8Buuz6CwAAAAAWABTJCW1D9AjqUmAgJizNrXyFFrkqgQAAAAAAAQCJAgAAAAGdA6aKwu4U7Zes8OwDJHp4bI3maidtrjOK6N85klZucAAAAAAA/f///wKBbNwLAAAAACJRIDXxGE9rRwyd80faYsSyjn7J7hCyILrDrM0iIJ3vADbqQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzWwAAAABASuBbNwLAAAAACJRIDXxGE9rRwyd80faYsSyjn7J7hCyILrDrM0iIJ3vADbqARNAslo/GrzGxD6jx0S7hhxvKR8Eus+sP130lZLzFdEP0jIHUZnjDgbwVW/xgkL6M6xdWTIft2LwO6Jg/VxrnLUVniEWn8HNAfLSdwuCgeK6vBpMJF7dN7ty0S4gcjpp309fAfYJAMEg7UIAAAAAAAEAcQIAAAAB5PVQktBZBw4nvG06jM4bpxNyROmXxJnOR8qYKNgjGfwAAAAAAP3///8CgIQeAAAAAAAWABSftnv87+5st9tMflXZxr/XSeMdHoxyG+0AAAAAFgAUQudNVnkeDGRH67h8YS0ySo/R6flrAAAAAQEfgIQeAAAAAAAWABSftnv87+5st9tMflXZxr/XSeMdHiICAyjMj8l44gnxaV+ltWVQYdsaqyMRtSQXaUW/EBXvLUuJRzBEAiA9G0zR8z6JjbBAeg4wDezU0rLQB462lpdGQJwqrUxQFwIgL70Z0p7ASr4w+lDjPk0+m6WY5PafSiEiEO4tFuoHsHMBIgYDKMyPyXjiCfFpX6W1ZVBh2xqrIxG1JBdpRb8QFe8tS4kIn7Z7/AAAAAAAAA=="
}
},
"response": {
"tx": "02000000000102960f8540c28c1cbf22142ba353601f21e4b43b73ef9d9eba15d5afdd35687d730000000000fdffffffa557b13eb0b2472112083dd4d5c0b9a227cad500714f105228c69613c1ff47750000000000fdffffff01baecfa0b00000000160014c9096d43f408ea526020262ccdad7c8516b92a810140b25a3f1abcc6c43ea3c744bb861c6f291f04bacfac3f5df49592f315d10fd232075199e30e06f0556ff18242fa33ac5d59321fb762f03ba260fd5c6b9cb5159e0247304402203d1b4cd1f33e898db0407a0e300decd4d2b2d0078eb6969746409c2aad4c501702202fbd19d29ec04abe30fa50e33e4d3e9ba598e4f69f4a212210ee2d16ea07b07301210328cc8fc978e209f1695fa5b5655061db1aab2311b524176945bf1015ef2d4b8900000000",
"txid": "8861058bff4b5310d587d7a8b6936886a290b0bdaf2485b53c79972a32daa758"
}
}
]
}