core-lightning/doc/schemas/lightning-txsend.json
ShahanaFarooqui 9592facf83 doc: Lock example values
Changelog-Added: Test script generates all RPC documentation examples now.
2024-11-26 21:45:19 +10:30

96 lines
3.8 KiB
JSON

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"rpc": "txsend",
"title": "Command to sign and send transaction from txprepare",
"description": [
"The **txsend** RPC command signs and broadcasts a transaction created by *txprepare* RPC command."
],
"request": {
"required": [
"txid"
],
"additionalProperties": false,
"properties": {
"txid": {
"type": "txid",
"description": [
"The transaction id of the transaction created by `txprepare` rpc command."
]
}
}
},
"response": {
"required": [
"psbt",
"tx",
"txid"
],
"additionalProperties": false,
"properties": {
"psbt": {
"type": "string",
"description": [
"The completed PSBT representing the signed transaction."
]
},
"tx": {
"type": "hex",
"description": [
"The fully signed transaction."
]
},
"txid": {
"type": "txid",
"description": [
"The transaction id of *tx*."
]
}
}
},
"errors": [
"On failure, an error is reported (from bitcoind), and the inputs from the transaction are unreserved.",
"",
"- -1: Catchall nonspecific error."
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-txprepare(7)",
"lightning-txdiscard(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:txsend#1",
"method": "txsend",
"params": [
"txidtxprep000200002000020000200002000020000200002000020000200002"
]
},
"response": {
"tx": "02000000000101txsend00011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011000110001100011",
"txid": "txidtxprep000200002000020000200002000020000200002000020000200002",
"psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100011100"
}
},
{
"request": {
"id": "example:txsend#2",
"method": "txsend",
"params": {
"txid": "txidtxprep000400004000040000400004000040000400004000040000400004"
}
},
"response": {
"tx": "02000000000101txsend00022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022",
"txid": "txidtxprep000400004000040000400004000040000400004000040000400004",
"psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200022200"
}
}
]
}