From 9e782f491b2b53a8f98968486eb51d0730250d80 Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Wed, 27 Mar 2024 18:45:18 -0700 Subject: [PATCH] doc: updated schemas for json_examples --- contrib/msggen/msggen/schema.json | 10753 ++++++++-------- doc/rpc-schema-draft.json | 54 +- doc/schemas/lightning-addgossip.json | 32 +- doc/schemas/lightning-addpsbtoutput.json | 82 +- doc/schemas/lightning-autoclean-once.json | 56 +- doc/schemas/lightning-autoclean-status.json | 94 +- doc/schemas/lightning-autocleaninvoice.json | 40 +- doc/schemas/lightning-batching.json | 18 +- doc/schemas/lightning-bkpr-channelsapy.json | 104 +- doc/schemas/lightning-bkpr-dumpincomecsv.json | 26 +- doc/schemas/lightning-bkpr-inspect.json | 52 +- .../lightning-bkpr-listaccountevents.json | 438 +- doc/schemas/lightning-bkpr-listbalances.json | 38 +- doc/schemas/lightning-bkpr-listincome.json | 144 +- doc/schemas/lightning-blacklistrune.json | 90 +- doc/schemas/lightning-check.json | 92 +- doc/schemas/lightning-checkmessage.json | 48 +- doc/schemas/lightning-checkrune.json | 82 +- doc/schemas/lightning-close.json | 90 +- doc/schemas/lightning-commando-blacklist.json | 90 +- doc/schemas/lightning-commando-listrunes.json | 226 +- doc/schemas/lightning-commando-rune.json | 100 +- doc/schemas/lightning-commando.json | 172 +- doc/schemas/lightning-connect.json | 68 +- doc/schemas/lightning-createonion.json | 114 +- doc/schemas/lightning-createrune.json | 70 +- doc/schemas/lightning-datastore.json | 112 +- doc/schemas/lightning-datastoreusage.json | 76 +- doc/schemas/lightning-decode.json | 122 +- doc/schemas/lightning-decodepay.json | 46 +- doc/schemas/lightning-deldatastore.json | 58 +- doc/schemas/lightning-delforward.json | 40 +- doc/schemas/lightning-delinvoice.json | 70 +- doc/schemas/lightning-delpay.json | 148 +- doc/schemas/lightning-deprecations.json | 18 +- doc/schemas/lightning-dev-forget-channel.json | 55 +- doc/schemas/lightning-disableoffer.json | 28 +- doc/schemas/lightning-disconnect.json | 36 +- doc/schemas/lightning-emergencyrecover.json | 36 +- doc/schemas/lightning-feerates.json | 190 +- doc/schemas/lightning-fetchinvoice.json | 64 +- doc/schemas/lightning-fundchannel.json | 114 +- doc/schemas/lightning-fundchannel_cancel.json | 36 +- .../lightning-fundchannel_complete.json | 24 +- doc/schemas/lightning-fundchannel_start.json | 86 +- doc/schemas/lightning-funderupdate.json | 94 +- doc/schemas/lightning-fundpsbt.json | 152 +- doc/schemas/lightning-getinfo.json | 88 +- doc/schemas/lightning-getlog.json | 48 +- doc/schemas/lightning-getroute.json | 132 +- doc/schemas/lightning-help.json | 68 +- doc/schemas/lightning-invoice.json | 92 +- doc/schemas/lightning-invoicerequest.json | 32 +- doc/schemas/lightning-keysend.json | 158 +- doc/schemas/lightning-listchannels.json | 118 +- doc/schemas/lightning-listconfigs.json | 886 +- doc/schemas/lightning-listdatastore.json | 58 +- doc/schemas/lightning-listforwards.json | 144 +- doc/schemas/lightning-listfunds.json | 64 +- doc/schemas/lightning-listhtlcs.json | 258 +- .../lightning-listinvoicerequests.json | 38 +- doc/schemas/lightning-listinvoices.json | 56 +- doc/schemas/lightning-listnodes.json | 132 +- doc/schemas/lightning-listoffers.json | 84 +- doc/schemas/lightning-listpays.json | 82 +- doc/schemas/lightning-listpeerchannels.json | 394 +- doc/schemas/lightning-listpeers.json | 78 +- doc/schemas/lightning-listsendpays.json | 138 +- doc/schemas/lightning-listsqlschemas.json | 326 +- doc/schemas/lightning-listtransactions.json | 74 +- doc/schemas/lightning-makesecret.json | 42 +- doc/schemas/lightning-multifundchannel.json | 180 +- doc/schemas/lightning-multiwithdraw.json | 116 +- doc/schemas/lightning-newaddr.json | 36 +- doc/schemas/lightning-notifications.json | 32 +- doc/schemas/lightning-offer.json | 62 +- doc/schemas/lightning-openchannel_abort.json | 24 +- doc/schemas/lightning-openchannel_init.json | 130 +- doc/schemas/lightning-openchannel_update.json | 90 +- doc/schemas/lightning-parsefeerate.json | 76 +- doc/schemas/lightning-pay.json | 56 +- doc/schemas/lightning-ping.json | 42 +- doc/schemas/lightning-plugin.json | 196 +- doc/schemas/lightning-recover.json | 34 +- doc/schemas/lightning-recoverchannel.json | 28 +- doc/schemas/lightning-renepay.json | 66 +- doc/schemas/lightning-reserveinputs.json | 230 +- doc/schemas/lightning-sendcustommsg.json | 22 +- doc/schemas/lightning-sendinvoice.json | 46 +- doc/schemas/lightning-sendonion.json | 62 +- doc/schemas/lightning-sendpay.json | 166 +- doc/schemas/lightning-sendpsbt.json | 42 +- doc/schemas/lightning-setchannel.json | 104 +- doc/schemas/lightning-setconfig.json | 92 +- doc/schemas/lightning-setpsbtversion.json | 42 +- doc/schemas/lightning-showrunes.json | 132 +- doc/schemas/lightning-signinvoice.json | 22 +- doc/schemas/lightning-signmessage.json | 44 +- doc/schemas/lightning-signpsbt.json | 44 +- doc/schemas/lightning-splice_init.json | 48 +- doc/schemas/lightning-splice_signed.json | 24 +- doc/schemas/lightning-splice_update.json | 24 +- doc/schemas/lightning-sql-template.json | 88 +- doc/schemas/lightning-staticbackup.json | 22 +- doc/schemas/lightning-stop.json | 18 +- doc/schemas/lightning-txdiscard.json | 20 +- doc/schemas/lightning-txprepare.json | 72 +- doc/schemas/lightning-txsend.json | 24 +- doc/schemas/lightning-unreserveinputs.json | 54 +- doc/schemas/lightning-upgradewallet.json | 42 +- doc/schemas/lightning-utxopsbt.json | 122 +- doc/schemas/lightning-wait.json | 92 +- doc/schemas/lightning-waitanyinvoice.json | 92 +- doc/schemas/lightning-waitblockheight.json | 40 +- doc/schemas/lightning-waitinvoice.json | 48 +- doc/schemas/lightning-waitsendpay.json | 48 +- doc/schemas/lightning-withdraw.json | 64 +- tools/fromschema.py | 35 +- 118 files changed, 11012 insertions(+), 10549 deletions(-) diff --git a/contrib/msggen/msggen/schema.json b/contrib/msggen/msggen/schema.json index 302e36200b01..a14cb18eeb91 100644 --- a/contrib/msggen/msggen/schema.json +++ b/contrib/msggen/msggen/schema.json @@ -28,26 +28,28 @@ "response": { "properties": {} }, - "example_json_request": [ + "json_example": [ { - "id": "example:addgossip#1", - "method": "addgossip", - "params": { - "message": "010078c3314666731e339c0b8434f7824797a084ed7ca3655991a672da068e2c44cb53b57b53a296c133bc879109a8931dc31e6913a4bda3d58559b99b95663e6d52775579447ef5526300e1bb89bc6af8557aa1c3810a91814eafad6d103f43182e17b16644cb38c1d58a8edd094303959a9f1f9d42ff6c32a21f9c118531f512c8679cabaccc6e39dbd95a4dac90e75a258893c3aa3f733d1b8890174d5ddea8003cadffe557773c54d2c07ca1d535c4bf85885f879ae466c16a516e8ffcfec1740e3f5c98ca9ce13f452e867befef5517f306ed6aa5119b79059bcc6f68f329986b665d16de7bc7df64e3537504c91eeabe0e59d3a2b68e4216ead2b0f6e3ef7c000006226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f0000670000010000022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d590266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c0351802e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5702324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b" - } + "request": { + "id": "example:addgossip#1", + "method": "addgossip", + "params": { + "message": "010078c3314666731e339c0b8434f7824797a084ed7ca3655991a672da068e2c44cb53b57b53a296c133bc879109a8931dc31e6913a4bda3d58559b99b95663e6d52775579447ef5526300e1bb89bc6af8557aa1c3810a91814eafad6d103f43182e17b16644cb38c1d58a8edd094303959a9f1f9d42ff6c32a21f9c118531f512c8679cabaccc6e39dbd95a4dac90e75a258893c3aa3f733d1b8890174d5ddea8003cadffe557773c54d2c07ca1d535c4bf85885f879ae466c16a516e8ffcfec1740e3f5c98ca9ce13f452e867befef5517f306ed6aa5119b79059bcc6f68f329986b665d16de7bc7df64e3537504c91eeabe0e59d3a2b68e4216ead2b0f6e3ef7c000006226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f0000670000010000022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d590266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c0351802e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5702324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b" + } + }, + "response": {} }, { - "id": "example:addgossip#2", - "method": "addgossip", - "params": { - "message": "0102420526c8eb62ec6999bbee5f1de4841cab734374ec642b7deeb0259e76220bf82e97a241c907d5ff52019655f7f9a614c285bb35690f3a1a2b928d7b2349a79e06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f000067000001000065b32a0e010100060000000000000000000000010000000a000000003b023380" - } + "request": { + "id": "example:addgossip#2", + "method": "addgossip", + "params": { + "message": "0102420526c8eb62ec6999bbee5f1de4841cab734374ec642b7deeb0259e76220bf82e97a241c907d5ff52019655f7f9a614c285bb35690f3a1a2b928d7b2349a79e06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f000067000001000065b32a0e010100060000000000000000000000010000000a000000003b023380" + } + }, + "response": {} } ], - "example_json_response": [ - {}, - {} - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -135,55 +137,59 @@ "lightning-cli addpsbtoutput 100000sat", "```" ], - "example_json_request": [ + "json_example": [ { - "id": "example:addpsbtoutput#1", - "method": "addpsbtoutput", - "params": { - "satoshi": 100000, - "initialpsbt": null, - "locktime": null, - "destination": null + "request": { + "id": "example:addpsbtoutput#1", + "method": "addpsbtoutput", + "params": { + "satoshi": 100000, + "initialpsbt": null, + "locktime": null, + "destination": null + } + }, + "response": { + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIoIYBAAAAAAABBCJRIHg2NV/cioLcTLAKdyxVVBUdBjhKTdZejT9orAhWa4S+AA==", + "estimated_added_weight": 172, + "outnum": 0 } }, { - "id": "example:addpsbtoutput#2", - "method": "addpsbtoutput", - "params": { - "satoshi": 1000000, - "initialpsbt": null, - "locktime": 111, - "destination": null + "request": { + "id": "example:addpsbtoutput#2", + "method": "addpsbtoutput", + "params": { + "satoshi": 1000000, + "initialpsbt": null, + "locktime": 111, + "destination": null + } + }, + "response": { + "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIQEIPAAAAAAABBCJRIJd6ICNAQALFOMhoUHuSVSuzcaUdkDKlk4K+A+DR9+4uAA==", + "estimated_added_weight": 172, + "outnum": 0 } }, { - "id": "example:addpsbtoutput#3", - "method": "addpsbtoutput", - "params": { - "satoshi": 974343, - "initialpsbt": "cHNidP8BAF4CAAAAAfwbEpvpi6D14YV4VLnuVB47Y0uF41kXEyJRL4IusySSAQAAAAD9////ASICAAAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5nAAAAAAEA9gIAAAAAAQFEkxvLatohY6mw5gr5qG1aiArSrziFPR2YoqD21Hv+RAAAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNrz8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIEu1nfVRt9i+rFM219mwhMqdwJsqygWSWTFUS+cemdh6AiBG3Qo8g9J/aAMO2RHDsIBScscj6pTTIwZp7Gw8G3EOKAEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPZgAAAAEBK68/DwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", - "locktime": null, - "destination": "bcrt1q9tc6q49l6wrrtp8ul45rj92hsleehwwxty32zu" + "request": { + "id": "example:addpsbtoutput#3", + "method": "addpsbtoutput", + "params": { + "satoshi": 974343, + "initialpsbt": "cHNidP8BAF4CAAAAAfwbEpvpi6D14YV4VLnuVB47Y0uF41kXEyJRL4IusySSAQAAAAD9////ASICAAAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5nAAAAAAEA9gIAAAAAAQFEkxvLatohY6mw5gr5qG1aiArSrziFPR2YoqD21Hv+RAAAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNrz8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIEu1nfVRt9i+rFM219mwhMqdwJsqygWSWTFUS+cemdh6AiBG3Qo8g9J/aAMO2RHDsIBScscj6pTTIwZp7Gw8G3EOKAEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPZgAAAAEBK68/DwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", + "locktime": null, + "destination": "bcrt1q9tc6q49l6wrrtp8ul45rj92hsleehwwxty32zu" + } + }, + "response": { + "psbt": "cHNidP8BAH0CAAAAAfwbEpvpi6D14YV4VLnuVB47Y0uF41kXEyJRL4IusySSAQAAAAD9////AiICAAAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4H3g4AAAAAABYAFCrxoFS/04Y1hPz9aDkVV4fzm7nGZwAAAAABAPYCAAAAAAEBRJMby2raIWOpsOYK+ahtWogK0q84hT0dmKKg9tR7/kQAAAAAAP3///8CQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAza8/DwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oCRzBEAiBLtZ31UbfYvqxTNtfZsITKncCbKsoFklkxVEvnHpnYegIgRt0KPIPSf2gDDtkRw7CAUnLHI+qU0yMGaexsPBtxDigBIQPXRURck2JmXyLg2W6edm8nPzJg3qOcina/oF3SaE3cz2YAAAABASuvPw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAAAA", + "estimated_added_weight": 172, + "outnum": 1 } } ], - "example_json_response": [ - { - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIoIYBAAAAAAABBCJRIHg2NV/cioLcTLAKdyxVVBUdBjhKTdZejT9orAhWa4S+AA==", - "estimated_added_weight": 172, - "outnum": 0 - }, - { - "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIQEIPAAAAAAABBCJRIJd6ICNAQALFOMhoUHuSVSuzcaUdkDKlk4K+A+DR9+4uAA==", - "estimated_added_weight": 172, - "outnum": 0 - }, - { - "psbt": "cHNidP8BAH0CAAAAAfwbEpvpi6D14YV4VLnuVB47Y0uF41kXEyJRL4IusySSAQAAAAD9////AiICAAAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4H3g4AAAAAABYAFCrxoFS/04Y1hPz9aDkVV4fzm7nGZwAAAAABAPYCAAAAAAEBRJMby2raIWOpsOYK+ahtWogK0q84hT0dmKKg9tR7/kQAAAAAAP3///8CQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAza8/DwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oCRzBEAiBLtZ31UbfYvqxTNtfZsITKncCbKsoFklkxVEvnHpnYegIgRt0KPIPSf2gDDtkRw7CAUnLHI+qU0yMGaexsPBtxDigBIQPXRURck2JmXyLg2W6edm8nPzJg3qOcina/oF3SaE3cz2YAAAABASuvPw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAAAA", - "estimated_added_weight": 172, - "outnum": 1 - } - ], "author": [ "Dusty <<@dusty_daemon>> is mainly responsible." ], @@ -383,38 +389,40 @@ } } }, - "example_json_request": [ - { - "id": "example:autoclean-once#1", - "method": "autoclean-once", - "params": [ - "failedpays", - 1 - ] - }, - { - "id": "example:autoclean-once#2", - "method": "autoclean-once", - "params": [ - "succeededpays", - 1 - ] - } - ], - "example_json_response": [ + "json_example": [ { - "autoclean": { - "failedpays": { - "cleaned": 1, - "uncleaned": 1 + "request": { + "id": "example:autoclean-once#1", + "method": "autoclean-once", + "params": [ + "failedpays", + 1 + ] + }, + "response": { + "autoclean": { + "failedpays": { + "cleaned": 1, + "uncleaned": 1 + } } } }, { - "autoclean": { - "succeededpays": { - "cleaned": 1, - "uncleaned": 0 + "request": { + "id": "example:autoclean-once#2", + "method": "autoclean-once", + "params": [ + "succeededpays", + 1 + ] + }, + "response": { + "autoclean": { + "succeededpays": { + "cleaned": 1, + "uncleaned": 0 + } } } } @@ -846,57 +854,59 @@ "Note that the ages parameters are set by various `autoclean-...-age` parameters in your configuration: see lightningd-config(5)." ] }, - "example_json_request": [ - { - "id": "example:autoclean-status#1", - "method": "autoclean-status", - "params": { - "subsystem": "expiredinvoices" - } - }, - { - "id": "example:autoclean-status#2", - "method": "autoclean-status", - "params": { - "subsystem": null - } - } - ], - "example_json_response": [ + "json_example": [ { - "autoclean": { - "expiredinvoices": { - "enabled": false, - "cleaned": 0 + "request": { + "id": "example:autoclean-status#1", + "method": "autoclean-status", + "params": { + "subsystem": "expiredinvoices" + } + }, + "response": { + "autoclean": { + "expiredinvoices": { + "enabled": false, + "cleaned": 0 + } } } }, { - "autoclean": { - "succeededforwards": { - "enabled": false, - "cleaned": 0 - }, - "failedforwards": { - "enabled": false, - "cleaned": 0 - }, - "succeededpays": { - "enabled": false, - "cleaned": 0 - }, - "failedpays": { - "enabled": false, - "cleaned": 0 - }, - "paidinvoices": { - "enabled": false, - "cleaned": 0 - }, - "expiredinvoices": { - "enabled": true, - "age": 2, - "cleaned": 0 + "request": { + "id": "example:autoclean-status#2", + "method": "autoclean-status", + "params": { + "subsystem": null + } + }, + "response": { + "autoclean": { + "succeededforwards": { + "enabled": false, + "cleaned": 0 + }, + "failedforwards": { + "enabled": false, + "cleaned": 0 + }, + "succeededpays": { + "enabled": false, + "cleaned": 0 + }, + "failedpays": { + "enabled": false, + "cleaned": 0 + }, + "paidinvoices": { + "enabled": false, + "cleaned": 0 + }, + "expiredinvoices": { + "enabled": true, + "age": 2, + "cleaned": 0 + } } } } @@ -993,36 +1003,38 @@ } ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:autocleaninvoice#1", - "method": "autocleaninvoice", - "params": { + "request": { + "id": "example:autocleaninvoice#1", + "method": "autocleaninvoice", + "params": { + "cycle_seconds": 8, + "expired_by": 2 + } + }, + "response": { + "enabled": true, "cycle_seconds": 8, "expired_by": 2 } }, { - "id": "example:autocleaninvoice#2", - "method": "autocleaninvoice", - "params": { + "request": { + "id": "example:autocleaninvoice#2", + "method": "autocleaninvoice", + "params": { + "cycle_seconds": 1, + "expired_by": 1 + } + }, + "response": { + "enabled": true, "cycle_seconds": 1, "expired_by": 1 } } ], - "example_json_response": [ - { - "enabled": true, - "cycle_seconds": 8, - "expired_by": 2 - }, - { - "enabled": true, - "cycle_seconds": 1, - "expired_by": 1 - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -1060,18 +1072,18 @@ "response": { "properties": {} }, - "example_json_request": [ + "json_example": [ { - "id": "example:batching#1", - "method": "batching", - "params": { - "enable": true - } + "request": { + "id": "example:batching#1", + "method": "batching", + "params": { + "enable": true + } + }, + "response": {} } ], - "example_json_response": [ - {} - ], "errors": [ "On failure, one of the following error codes may be returned:", "", @@ -1277,59 +1289,59 @@ } } }, - "example_json_request": [ - { - "id": "example:bkpr-channelsapy#1", - "method": "bkpr-channelsapy", - "params": "{}" - } - ], - "example_json_response": [ + "json_example": [ { - "channels_apy": [ - { - "account": "e41b2ec83e9139a9fd8f1d89b01e5d7df73099494e6b91504c39445e37485b0d", - "routed_out_msat": 1431440, - "routed_in_msat": 0, - "lease_fee_paid_msat": 0, - "lease_fee_earned_msat": 0, - "pushed_out_msat": 0, - "pushed_in_msat": 0, - "our_start_balance_msat": 1000000000, - "channel_start_balance_msat": 1000000000, - "fees_out_msat": 0, - "fees_in_msat": 0, - "utilization_out": "0.1431%", - "utilization_out_initial": "0.1431%", - "utilization_in": "0.0000%", - "apy_out": "0.0000%", - "apy_out_initial": "0.0000%", - "apy_in": "0.0000%", - "apy_total": "0.0000%", - "apy_total_initial": "0.0000%" - }, - { - "account": "net", - "routed_out_msat": 1431440, - "routed_in_msat": 0, - "lease_fee_paid_msat": 0, - "lease_fee_earned_msat": 0, - "pushed_out_msat": 0, - "pushed_in_msat": 0, - "our_start_balance_msat": 1000000000, - "channel_start_balance_msat": 1000000000, - "fees_out_msat": 0, - "fees_in_msat": 0, - "utilization_out": "0.1431%", - "utilization_out_initial": "0.1431%", - "utilization_in": "0.0000%", - "apy_out": "0.0000%", - "apy_out_initial": "0.0000%", - "apy_in": "0.0000%", - "apy_total": "0.0000%", - "apy_total_initial": "0.0000%" - } - ] + "request": { + "id": "example:bkpr-channelsapy#1", + "method": "bkpr-channelsapy", + "params": "{}" + }, + "response": { + "channels_apy": [ + { + "account": "e41b2ec83e9139a9fd8f1d89b01e5d7df73099494e6b91504c39445e37485b0d", + "routed_out_msat": 1431440, + "routed_in_msat": 0, + "lease_fee_paid_msat": 0, + "lease_fee_earned_msat": 0, + "pushed_out_msat": 0, + "pushed_in_msat": 0, + "our_start_balance_msat": 1000000000, + "channel_start_balance_msat": 1000000000, + "fees_out_msat": 0, + "fees_in_msat": 0, + "utilization_out": "0.1431%", + "utilization_out_initial": "0.1431%", + "utilization_in": "0.0000%", + "apy_out": "0.0000%", + "apy_out_initial": "0.0000%", + "apy_in": "0.0000%", + "apy_total": "0.0000%", + "apy_total_initial": "0.0000%" + }, + { + "account": "net", + "routed_out_msat": 1431440, + "routed_in_msat": 0, + "lease_fee_paid_msat": 0, + "lease_fee_earned_msat": 0, + "pushed_out_msat": 0, + "pushed_in_msat": 0, + "our_start_balance_msat": 1000000000, + "channel_start_balance_msat": 1000000000, + "fees_out_msat": 0, + "fees_in_msat": 0, + "utilization_out": "0.1431%", + "utilization_out_initial": "0.1431%", + "utilization_in": "0.0000%", + "apy_out": "0.0000%", + "apy_out_initial": "0.0000%", + "apy_in": "0.0000%", + "apy_total": "0.0000%", + "apy_total_initial": "0.0000%" + } + ] + } } ], "author": [ @@ -1421,20 +1433,20 @@ } } }, - "example_json_request": [ - { - "id": "example:bkpr-dumpincomecsv#1", - "method": "bkpr-dumpincomecsv", - "params": [ - "koinly", - "koinly.csv" - ] - } - ], - "example_json_response": [ + "json_example": [ { - "csv_file": "koinly.csv", - "csv_format": "koinly" + "request": { + "id": "example:bkpr-dumpincomecsv#1", + "method": "bkpr-dumpincomecsv", + "params": [ + "koinly", + "koinly.csv" + ] + }, + "response": { + "csv_file": "koinly.csv", + "csv_format": "koinly" + } } ], "author": [ @@ -1648,33 +1660,33 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:bkpr-inspect#1", - "method": "bkpr-inspect", - "params": [ - "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab" - ] - } - ], - "example_json_response": [ - { - "txs": [ - { - "txid": "abb283035e569c190696d42a1208bb38ddc64b6377e88f2d6277c01eab7b0af3", - "fees_paid_msat": 0, - "outputs": [ - { - "account": "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab", - "outnum": 0, - "output_tag": "channel_proposed", - "output_value_msat": 996363000, - "credit_msat": 996363000, - "currency": "bcrt" - } - ] - } - ] + "request": { + "id": "example:bkpr-inspect#1", + "method": "bkpr-inspect", + "params": [ + "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab" + ] + }, + "response": { + "txs": [ + { + "txid": "abb283035e569c190696d42a1208bb38ddc64b6377e88f2d6277c01eab7b0af3", + "fees_paid_msat": 0, + "outputs": [ + { + "account": "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab", + "outnum": 0, + "output_tag": "channel_proposed", + "output_value_msat": 996363000, + "credit_msat": 996363000, + "currency": "bcrt" + } + ] + } + ] + } } ], "author": [ @@ -1934,227 +1946,229 @@ } } }, - "example_json_request": [ - { - "id": "example:bkpr-listaccountevents#1", - "method": "bkpr-listaccountevents", - "params": "{}" - }, - { - "id": "example:bkpr-listaccountevents#2", - "method": "bkpr-listaccountevents", - "params": [ - "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab" - ] - } - ], - "example_json_response": [ + "json_example": [ { - "events": [ - { - "account": "wallet", - "type": "channel", - "tag": "journal_entry", - "credit_msat": 0, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706152911, - "is_rebalance": false - }, - { - "account": "wallet", - "type": "chain", - "tag": "deposit", - "credit_msat": 2000000000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "7e202b3b1016e8eb6f4e936215ed6b5bdc63c17e6ebb5e6bce2f98e6757ba44c:0", - "timestamp": 1706152914, - "blockheight": 102 - }, - { - "account": "wallet", - "type": "chain", - "tag": "withdrawal", - "credit_msat": 0, - "debit_msat": 2000000000, - "currency": "bcrt", - "outpoint": "7e202b3b1016e8eb6f4e936215ed6b5bdc63c17e6ebb5e6bce2f98e6757ba44c:0", - "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b", - "timestamp": 1706152921, - "blockheight": 103 - }, - { - "account": "wallet", - "type": "chain", - "tag": "deposit", - "credit_msat": 995073000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b:1", - "timestamp": 1706152921, - "blockheight": 103 - }, - { - "account": "wallet", - "type": "onchain_fee", - "tag": "onchain_fee", - "credit_msat": 1004927000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706152921, - "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b" - }, - { - "account": "wallet", - "type": "onchain_fee", - "tag": "onchain_fee", - "credit_msat": 0, - "debit_msat": 1004927000, - "currency": "bcrt", - "timestamp": 1706152921, - "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b" - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "chain", - "tag": "channel_open", - "credit_msat": 1000000000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b:0", - "timestamp": 1706152922, - "blockheight": 103 - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "onchain_fee", - "tag": "onchain_fee", - "credit_msat": 4927000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706152922, - "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b" - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "channel", - "tag": "invoice", - "credit_msat": 0, - "debit_msat": 11000000, - "currency": "bcrt", - "payment_id": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "part_id": 0, - "timestamp": 1706152934, - "description": [ - "XEoCR94SIz6UIRUEkxum." - ], - "is_rebalance": false - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "chain", - "tag": "channel_close", - "credit_msat": 0, - "debit_msat": 989000000, - "currency": "bcrt", - "outpoint": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b:0", - "txid": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998", - "timestamp": 1706152938, - "blockheight": 104 - }, - { - "account": "external", - "origin": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "chain", - "tag": "to_them", - "credit_msat": 10899000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998:0", - "timestamp": 1706152938, - "blockheight": 104 - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "onchain_fee", - "tag": "onchain_fee", - "credit_msat": 7967000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706152938, - "txid": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998" - }, - { - "account": "wallet", - "type": "chain", - "tag": "deposit", - "credit_msat": 980912000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "85477738281c1afd652c350025f1d28658fe541c83adc9a7d5276c30cf715a11:0", - "timestamp": 1706152941, - "blockheight": 109 - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "chain", - "tag": "delayed_to_us", - "credit_msat": 981033000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998:1", - "timestamp": 1706152941, - "blockheight": 104 - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "chain", - "tag": "to_wallet", - "credit_msat": 0, - "debit_msat": 981033000, - "currency": "bcrt", - "outpoint": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998:1", - "txid": "85477738281c1afd652c350025f1d28658fe541c83adc9a7d5276c30cf715a11", - "timestamp": 1706152941, - "blockheight": 109 - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "onchain_fee", - "tag": "onchain_fee", - "credit_msat": 121000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706152941, - "txid": "85477738281c1afd652c350025f1d28658fe541c83adc9a7d5276c30cf715a11" - } - ] + "request": { + "id": "example:bkpr-listaccountevents#1", + "method": "bkpr-listaccountevents", + "params": "{}" + }, + "response": { + "events": [ + { + "account": "wallet", + "type": "channel", + "tag": "journal_entry", + "credit_msat": 0, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706152911, + "is_rebalance": false + }, + { + "account": "wallet", + "type": "chain", + "tag": "deposit", + "credit_msat": 2000000000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "7e202b3b1016e8eb6f4e936215ed6b5bdc63c17e6ebb5e6bce2f98e6757ba44c:0", + "timestamp": 1706152914, + "blockheight": 102 + }, + { + "account": "wallet", + "type": "chain", + "tag": "withdrawal", + "credit_msat": 0, + "debit_msat": 2000000000, + "currency": "bcrt", + "outpoint": "7e202b3b1016e8eb6f4e936215ed6b5bdc63c17e6ebb5e6bce2f98e6757ba44c:0", + "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b", + "timestamp": 1706152921, + "blockheight": 103 + }, + { + "account": "wallet", + "type": "chain", + "tag": "deposit", + "credit_msat": 995073000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b:1", + "timestamp": 1706152921, + "blockheight": 103 + }, + { + "account": "wallet", + "type": "onchain_fee", + "tag": "onchain_fee", + "credit_msat": 1004927000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706152921, + "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b" + }, + { + "account": "wallet", + "type": "onchain_fee", + "tag": "onchain_fee", + "credit_msat": 0, + "debit_msat": 1004927000, + "currency": "bcrt", + "timestamp": 1706152921, + "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b" + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "chain", + "tag": "channel_open", + "credit_msat": 1000000000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b:0", + "timestamp": 1706152922, + "blockheight": 103 + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "onchain_fee", + "tag": "onchain_fee", + "credit_msat": 4927000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706152922, + "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b" + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "channel", + "tag": "invoice", + "credit_msat": 0, + "debit_msat": 11000000, + "currency": "bcrt", + "payment_id": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", + "part_id": 0, + "timestamp": 1706152934, + "description": [ + "XEoCR94SIz6UIRUEkxum." + ], + "is_rebalance": false + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "chain", + "tag": "channel_close", + "credit_msat": 0, + "debit_msat": 989000000, + "currency": "bcrt", + "outpoint": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b:0", + "txid": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998", + "timestamp": 1706152938, + "blockheight": 104 + }, + { + "account": "external", + "origin": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "chain", + "tag": "to_them", + "credit_msat": 10899000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998:0", + "timestamp": 1706152938, + "blockheight": 104 + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "onchain_fee", + "tag": "onchain_fee", + "credit_msat": 7967000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706152938, + "txid": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998" + }, + { + "account": "wallet", + "type": "chain", + "tag": "deposit", + "credit_msat": 980912000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "85477738281c1afd652c350025f1d28658fe541c83adc9a7d5276c30cf715a11:0", + "timestamp": 1706152941, + "blockheight": 109 + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "chain", + "tag": "delayed_to_us", + "credit_msat": 981033000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998:1", + "timestamp": 1706152941, + "blockheight": 104 + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "chain", + "tag": "to_wallet", + "credit_msat": 0, + "debit_msat": 981033000, + "currency": "bcrt", + "outpoint": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998:1", + "txid": "85477738281c1afd652c350025f1d28658fe541c83adc9a7d5276c30cf715a11", + "timestamp": 1706152941, + "blockheight": 109 + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "onchain_fee", + "tag": "onchain_fee", + "credit_msat": 121000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706152941, + "txid": "85477738281c1afd652c350025f1d28658fe541c83adc9a7d5276c30cf715a11" + } + ] + } }, { - "events": [ - { - "account": "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab", - "type": "chain", - "tag": "channel_proposed", - "credit_msat": 996363000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "abb283035e569c190696d42a1208bb38ddc64b6377e88f2d6277c01eab7b0af3:0", - "timestamp": 1706246949, - "blockheight": 0 - }, - { - "account": "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab", - "type": "channel", - "tag": "pushed", - "credit_msat": 0, - "debit_msat": 20000000, - "currency": "bcrt", - "timestamp": 1706246949, - "is_rebalance": false - } - ] + "request": { + "id": "example:bkpr-listaccountevents#2", + "method": "bkpr-listaccountevents", + "params": [ + "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab" + ] + }, + "response": { + "events": [ + { + "account": "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab", + "type": "chain", + "tag": "channel_proposed", + "credit_msat": 996363000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "abb283035e569c190696d42a1208bb38ddc64b6377e88f2d6277c01eab7b0af3:0", + "timestamp": 1706246949, + "blockheight": 0 + }, + { + "account": "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab", + "type": "channel", + "tag": "pushed", + "credit_msat": 0, + "debit_msat": 20000000, + "currency": "bcrt", + "timestamp": 1706246949, + "is_rebalance": false + } + ] + } } ], "author": [ @@ -2294,26 +2308,26 @@ } } }, - "example_json_request": [ - { - "id": "example:bkpr-listbalances#1", - "method": "bkpr-listbalances", - "params": "{}" - } - ], - "example_json_response": [ + "json_example": [ { - "accounts": [ - { - "account": "wallet", - "balances": [ - { - "balance_msat": 2222222000, - "coin_type": "bcrt" - } - ] - } - ] + "request": { + "id": "example:bkpr-listbalances#1", + "method": "bkpr-listbalances", + "params": "{}" + }, + "response": { + "accounts": [ + { + "account": "wallet", + "balances": [ + { + "balance_msat": 2222222000, + "coin_type": "bcrt" + } + ] + } + ] + } } ], "author": [ @@ -2450,82 +2464,84 @@ } } }, - "example_json_request": [ - { - "id": "example:bkpr-listincome#1", - "method": "bkpr-listincome", - "params": "{}" - }, + "json_example": [ { - "id": "example:bkpr-listincome#2", - "method": "bkpr-listincome", - "params": { - "consolidate_fees": false + "request": { + "id": "example:bkpr-listincome#1", + "method": "bkpr-listincome", + "params": "{}" + }, + "response": { + "income_events": [ + { + "account": "wallet", + "tag": "deposit", + "credit_msat": 1111111000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706153060, + "outpoint": "6d813d2e99ae7181b61e59ff224c43de698bd08b8ca5b8034ccc13aa7b6428ef:0" + }, + { + "account": "wallet", + "tag": "deposit", + "credit_msat": 1111111000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706153060, + "outpoint": "0bbbe965f76525af3876ae6f1520d91047d4be04cb4e46b7229120a60c5dc9c5:0" + } + ] } - } - ], - "example_json_response": [ - { - "income_events": [ - { - "account": "wallet", - "tag": "deposit", - "credit_msat": 1111111000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706153060, - "outpoint": "6d813d2e99ae7181b61e59ff224c43de698bd08b8ca5b8034ccc13aa7b6428ef:0" - }, - { - "account": "wallet", - "tag": "deposit", - "credit_msat": 1111111000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706153060, - "outpoint": "0bbbe965f76525af3876ae6f1520d91047d4be04cb4e46b7229120a60c5dc9c5:0" - } - ] }, { - "income_events": [ - { - "account": "wallet", - "tag": "deposit", - "credit_msat": 1111111000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1708624181, - "outpoint": "895b5eaad4544d24c99628883b4d84b2c6024d6a2da4c1de54098d985f280943:1" - }, - { - "account": "wallet", - "tag": "withdrawal", - "credit_msat": 0, - "debit_msat": 555555000, - "currency": "bcrt", - "timestamp": 1708624182, - "outpoint": "d28a2cba55da10700ddd7f1f23618160dafb3134650055654551d9b0382dcd71:0" - }, - { - "account": "wallet", - "tag": "onchain_fee", - "credit_msat": 0, - "debit_msat": 555556000, - "currency": "bcrt", - "timestamp": 1708624183, - "txid": "d28a2cba55da10700ddd7f1f23618160dafb3134650055654551d9b0382dcd71" - }, - { - "account": "wallet", - "tag": "onchain_fee", - "credit_msat": 554947000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1708624183, - "txid": "d28a2cba55da10700ddd7f1f23618160dafb3134650055654551d9b0382dcd71" + "request": { + "id": "example:bkpr-listincome#2", + "method": "bkpr-listincome", + "params": { + "consolidate_fees": false } - ] + }, + "response": { + "income_events": [ + { + "account": "wallet", + "tag": "deposit", + "credit_msat": 1111111000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1708624181, + "outpoint": "895b5eaad4544d24c99628883b4d84b2c6024d6a2da4c1de54098d985f280943:1" + }, + { + "account": "wallet", + "tag": "withdrawal", + "credit_msat": 0, + "debit_msat": 555555000, + "currency": "bcrt", + "timestamp": 1708624182, + "outpoint": "d28a2cba55da10700ddd7f1f23618160dafb3134650055654551d9b0382dcd71:0" + }, + { + "account": "wallet", + "tag": "onchain_fee", + "credit_msat": 0, + "debit_msat": 555556000, + "currency": "bcrt", + "timestamp": 1708624183, + "txid": "d28a2cba55da10700ddd7f1f23618160dafb3134650055654551d9b0382dcd71" + }, + { + "account": "wallet", + "tag": "onchain_fee", + "credit_msat": 554947000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1708624183, + "txid": "d28a2cba55da10700ddd7f1f23618160dafb3134650055654551d9b0382dcd71" + } + ] + } } ], "author": [ @@ -2611,59 +2627,63 @@ } } }, - "example_json_request": [ - { - "id": "example:blacklistrune#1", - "method": "blacklistrune", - "params": { - "start": 2 - } - }, + "json_example": [ { - "id": "example:blacklistrune#2", - "method": "blacklistrune", - "params": { - "start": 5, - "end": 7 - } - }, - { - "id": "example:blacklistrune#3", - "method": "blacklistrune", - "params": { - "start": 3, - "end": 4 - } - } - ], - "example_json_response": [ - { - "blacklist": [ - { - "start": 2, - "end": 2 + "request": { + "id": "example:blacklistrune#1", + "method": "blacklistrune", + "params": { + "start": 2 } - ] + }, + "response": { + "blacklist": [ + { + "start": 2, + "end": 2 + } + ] + } }, { - "blacklist": [ - { - "start": 2, - "end": 2 - }, - { + "request": { + "id": "example:blacklistrune#2", + "method": "blacklistrune", + "params": { "start": 5, "end": 7 } - ] + }, + "response": { + "blacklist": [ + { + "start": 2, + "end": 2 + }, + { + "start": 5, + "end": 7 + } + ] + } }, { - "blacklist": [ - { - "start": 2, - "end": 7 + "request": { + "id": "example:blacklistrune#3", + "method": "blacklistrune", + "params": { + "start": 3, + "end": 4 } - ] + }, + "response": { + "blacklist": [ + { + "start": 2, + "end": 7 + } + ] + } } ], "author": [ @@ -2716,60 +2736,64 @@ "command_to_check" ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:check#1", - "method": "check", - "params": { - "command_to_check": "sendpay", - "route": [ - { - "amount_msat": 1011, - "msatoshi": 1011, - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "delay": 20, - "channel": "1x1x1" - }, - { - "amount_msat": 1000, - "msatoshi": 1000, - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "delay": 10, - "channel": "2x2x2" - } - ], - "payment_hash": "0000000000000000000000000000000000000000000000000000000000000000" + "request": { + "id": "example:check#1", + "method": "check", + "params": { + "command_to_check": "sendpay", + "route": [ + { + "amount_msat": 1011, + "msatoshi": 1011, + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "delay": 20, + "channel": "1x1x1" + }, + { + "amount_msat": 1000, + "msatoshi": 1000, + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "delay": 10, + "channel": "2x2x2" + } + ], + "payment_hash": "0000000000000000000000000000000000000000000000000000000000000000" + } + }, + "response": { + "command_to_check": "sendpay" } }, { - "id": "example:check#2", - "method": "check", - "params": { - "command_to_check": "dev", - "subcommand": "slowcmd", - "msec": 1000 + "request": { + "id": "example:check#2", + "method": "check", + "params": { + "command_to_check": "dev", + "subcommand": "slowcmd", + "msec": 1000 + } + }, + "response": { + "command_to_check": "dev" } }, { - "id": "example:check#3", - "method": "check", - "params": { - "command_to_check": "recover", - "hsmsecret": "6c696768746e696e672d31000000000000000000000000000000000000000000" + "request": { + "id": "example:check#3", + "method": "check", + "params": { + "command_to_check": "recover", + "hsmsecret": "6c696768746e696e672d31000000000000000000000000000000000000000000" + } + }, + "response": { + "command_to_check": "recover" } } ], - "example_json_response": [ - { - "command_to_check": "sendpay" - }, - { - "command_to_check": "dev" - }, - { - "command_to_check": "recover" - } - ], "author": [ "Mark Beckwith <> and Rusty Russell <> are mainly responsible." ], @@ -2837,36 +2861,38 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:checkmessage#1", - "method": "checkmessage", - "params": { - "message": "testcase to check new rpc error", - "zbase": "d66bqz3qsku5fxtqsi37j11pci47ydxa95iusphutggz9ezaxt56neh77kxe5hyr41kwgkncgiu94p9ecxiexgpgsz8daoq4tw8kj8yx", - "pubkey": "03be3b0e9992153b1d5a6e1623670b6c3663f72ce6cf2e0dd39c0a373a7de5a3b7" + "request": { + "id": "example:checkmessage#1", + "method": "checkmessage", + "params": { + "message": "testcase to check new rpc error", + "zbase": "d66bqz3qsku5fxtqsi37j11pci47ydxa95iusphutggz9ezaxt56neh77kxe5hyr41kwgkncgiu94p9ecxiexgpgsz8daoq4tw8kj8yx", + "pubkey": "03be3b0e9992153b1d5a6e1623670b6c3663f72ce6cf2e0dd39c0a373a7de5a3b7" + } + }, + "response": { + "pubkey": "03be3b0e9992153b1d5a6e1623670b6c3663f72ce6cf2e0dd39c0a373a7de5a3b7", + "verified": true } }, { - "id": "example:checkmessage#2", - "method": "checkmessage", - "params": { - "message": "this is a test!", - "zbase": "d6tqaeuonjhi98mmont9m4wag7gg4krg1f4txonug3h31e9h6p6k6nbwjondnj46dkyausobstnk7fhyy998bhgc1yr98dfmhb4k54d7", - "pubkey": null + "request": { + "id": "example:checkmessage#2", + "method": "checkmessage", + "params": { + "message": "this is a test!", + "zbase": "d6tqaeuonjhi98mmont9m4wag7gg4krg1f4txonug3h31e9h6p6k6nbwjondnj46dkyausobstnk7fhyy998bhgc1yr98dfmhb4k54d7", + "pubkey": null + } + }, + "response": { + "pubkey": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "verified": true } } ], - "example_json_response": [ - { - "pubkey": "03be3b0e9992153b1d5a6e1623670b6c3663f72ce6cf2e0dd39c0a373a7de5a3b7", - "verified": true - }, - { - "pubkey": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "verified": true - } - ], "errors": [ "On failure, an error is returned and core lightning exit with the following error code:", "", @@ -2958,59 +2984,63 @@ "- 1502 (RUNE_NOT_PERMITTED): rune does not allow this usage (includes a detailed reason why)", "- 1503 (RUNE_BLACKLISTED): rune has been explicitly blacklisted." ], - "example_json_request": [ + "json_example": [ { - "id": "example:checkrune#1", - "method": "checkrune", - "params": { - "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "rune": "617Obfct0oRBj_uqGFQxDk3XZ1sDFiC2Q5ltm5z1i_k9NSZtZXRob2Q9aW52b2ljZSZwbmFtZWRlc2NyaXB0aW9uPUB0aXBqYXJcfGpiNTVAc2VuZHNhdHMubG9s", - "method": "invoice", + "request": { + "id": "example:checkrune#1", + "method": "checkrune", "params": { - "amount_msat": "any", - "label": "lbl", - "description": [ - "@tipjar|jb55@sendsats.lol." - ] + "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "rune": "617Obfct0oRBj_uqGFQxDk3XZ1sDFiC2Q5ltm5z1i_k9NSZtZXRob2Q9aW52b2ljZSZwbmFtZWRlc2NyaXB0aW9uPUB0aXBqYXJcfGpiNTVAc2VuZHNhdHMubG9s", + "method": "invoice", + "params": { + "amount_msat": "any", + "label": "lbl", + "description": [ + "@tipjar|jb55@sendsats.lol." + ] + } } + }, + "response": { + "valid": true } }, { - "id": "example:checkrune#2", - "method": "checkrune", - "params": { - "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", - "method": "listpeers", - "params": {} + "request": { + "id": "example:checkrune#2", + "method": "checkrune", + "params": { + "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", + "method": "listpeers", + "params": {} + } + }, + "response": { + "valid": true } }, { - "id": "example:checkrune#3", - "method": "checkrune", - "params": { - "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "rune": "617Obfct0oRBj_uqGFQxDk3XZ1sDFiC2Q5ltm5z1i_k9NSZtZXRob2Q9aW52b2ljZSZwbmFtZWRlc2NyaXB0aW9uPUB0aXBqYXJcfGpiNTVAc2VuZHNhdHMubG9s", - "method": "invoice", + "request": { + "id": "example:checkrune#3", + "method": "checkrune", "params": { - "amount_msat": "any", - "label": "lbl", - "description": "@tipjar|jb55@sendsats.lol" + "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "rune": "617Obfct0oRBj_uqGFQxDk3XZ1sDFiC2Q5ltm5z1i_k9NSZtZXRob2Q9aW52b2ljZSZwbmFtZWRlc2NyaXB0aW9uPUB0aXBqYXJcfGpiNTVAc2VuZHNhdHMubG9s", + "method": "invoice", + "params": { + "amount_msat": "any", + "label": "lbl", + "description": "@tipjar|jb55@sendsats.lol" + } } + }, + "response": { + "valid": true } } ], - "example_json_response": [ - { - "valid": true - }, - { - "valid": true - }, - { - "valid": true - } - ], "author": [ "Shahana Farooqui <> is mainly responsible for consolidating logic from commando." ], @@ -3167,56 +3197,60 @@ "notifications": [ "Notifications may be returned indicating what is going on, especially if the peer is offline and we are waiting." ], - "example_json_request": [ + "json_example": [ { - "id": "example:close#1", - "method": "close", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "unilateraltimeout": 1, - "destination": null, - "fee_negotiation_step": null, - "force_lease_closed": null, - "feerange": null + "request": { + "id": "example:close#1", + "method": "close", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "unilateraltimeout": 1, + "destination": null, + "fee_negotiation_step": null, + "force_lease_closed": null, + "feerange": null + } + }, + "response": { + "tx": "020000000001018d388ffcd216c92d25163a62096ce47d5c9bbd6270ced51c5a1484f89df33e5700000000009db0e28002a00f00000000000016001445503fa4b65ade3ffdb1a92057688456c9ffae1380130f0000000000220020be82765fdb17fd5568f2dd31c6cf1aabc620ef338995ec5d9a2f3e42f43ae4870400473044022058dcde893655f40fc8162a79596440ef3e304273f8d530401fc17bc92c58159b0220428900ca6537538ba237d569a4a09003d663a991aeb331a9f18dfe807ee78806014730440220111270eeed8b4b1a231d3ce6e0e0daad718623ad159a0fd3781fb18118a8fec70220539826ee7c76cad4116d1d8852329f80314b3434cf21c765d8004186451a4cd50147522102324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b2102e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5752ae9c3ed620", + "txid": "5d8d917dd7d39fe5a12f121457fc6d712b5e393ed4f16bc8f5976fc08cbbfecd", + "type": "unilateral" } }, { - "id": "example:close#2", - "method": "close", - "params": { - "id": "103x1x0", - "unilateraltimeout": null, - "destination": "bcrt1qeyyk6sl5pr49ycpqyckvmttus5ttj25pd0zpvg", - "fee_negotiation_step": null, - "force_lease_closed": null, - "feerange": null + "request": { + "id": "example:close#2", + "method": "close", + "params": { + "id": "103x1x0", + "unilateraltimeout": null, + "destination": "bcrt1qeyyk6sl5pr49ycpqyckvmttus5ttj25pd0zpvg", + "fee_negotiation_step": null, + "force_lease_closed": null, + "feerange": null + } + }, + "response": { + "tx": "0200000000010132cbce7d5f96b4003c3b5c0eab2a29fef90bb6abb833ff312fa122f31e8301810000000000ffffffff02a0860100000000002251205779a060f200d40e8f871a40eb91614cc5bfa6d0a5f852e053400a7feff8615005b10d0000000000160014c9096d43f408ea526020262ccdad7c8516b92a81040047304402207e171d056e81cf8ad2d5a613ecbaa212d5dcbd0bf713145d18911d2cbe9d858802206222911660a26d7ffddc2563ae6d41d6ffad9fbd2fc26cf40eab501a31153b9e0147304402204ae7cdc68dc7966eab73f16a1978643336333d54ae0b6f87bc11a2c19174a9710220601e5276aee0825466cc272c4eb7d353b393ef0dd230d303f46772790dee19190147522102324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b2102e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5752ae00000000", + "txid": "4a08e0508e2e39ea033fab5f77b318337f345550421799f6e0eb1b15a892eda4", + "type": "mutual" } }, { - "id": "example:close#3", - "method": "close", - "params": [ - "107x1x0", - null, - "bcrt1qeyyk6sl5pr49ycpqyckvmttus5ttj25pd0zpvg" - ] - } - ], - "example_json_response": [ - { - "tx": "020000000001018d388ffcd216c92d25163a62096ce47d5c9bbd6270ced51c5a1484f89df33e5700000000009db0e28002a00f00000000000016001445503fa4b65ade3ffdb1a92057688456c9ffae1380130f0000000000220020be82765fdb17fd5568f2dd31c6cf1aabc620ef338995ec5d9a2f3e42f43ae4870400473044022058dcde893655f40fc8162a79596440ef3e304273f8d530401fc17bc92c58159b0220428900ca6537538ba237d569a4a09003d663a991aeb331a9f18dfe807ee78806014730440220111270eeed8b4b1a231d3ce6e0e0daad718623ad159a0fd3781fb18118a8fec70220539826ee7c76cad4116d1d8852329f80314b3434cf21c765d8004186451a4cd50147522102324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b2102e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5752ae9c3ed620", - "txid": "5d8d917dd7d39fe5a12f121457fc6d712b5e393ed4f16bc8f5976fc08cbbfecd", - "type": "unilateral" - }, - { - "tx": "0200000000010132cbce7d5f96b4003c3b5c0eab2a29fef90bb6abb833ff312fa122f31e8301810000000000ffffffff02a0860100000000002251205779a060f200d40e8f871a40eb91614cc5bfa6d0a5f852e053400a7feff8615005b10d0000000000160014c9096d43f408ea526020262ccdad7c8516b92a81040047304402207e171d056e81cf8ad2d5a613ecbaa212d5dcbd0bf713145d18911d2cbe9d858802206222911660a26d7ffddc2563ae6d41d6ffad9fbd2fc26cf40eab501a31153b9e0147304402204ae7cdc68dc7966eab73f16a1978643336333d54ae0b6f87bc11a2c19174a9710220601e5276aee0825466cc272c4eb7d353b393ef0dd230d303f46772790dee19190147522102324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b2102e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5752ae00000000", - "txid": "4a08e0508e2e39ea033fab5f77b318337f345550421799f6e0eb1b15a892eda4", - "type": "mutual" - }, - { - "tx": "02000000000101233b513665836d240423f45ffcd1fe19aeb08d62303fa5382ad3285f770683a60000000000ffffffff02a086010000000000225120b47216ab60a0fad97de0ba9b8b370d281dfe55f552d82034e2a8d054c2246e4405b10d0000000000160014c9096d43f408ea526020262ccdad7c8516b92a81040047304402207a9e3ca258861b33827d91514690a757e76730ba8c15dd222340bb13d993a1a502204d0ae329273b69abe62df1ffccce808d5f1a29101a8ee95dae99888376dbaef801473044022033c03f406db9f1c9d924cfd8f6ea42d0962f0ab02e3217aef518aea517ca5ba40220076e2af9d40c676316a2765a86f9efd481de3fc4465ceba33b0782c505ae3452014752210212284c004a3d24146e54b2a24db48f650370a08e1fe9abe8ff41f92b09cd50542102a3032ef980cc735579aa5295d927b9a1bdbafc459f2da14163dc9bd530e0a21152ae00000000", - "txid": "d44a1374a30c1a936d2d4fdbe73c0ffff42fec8c27c6cbaec2758b3042f61d08", - "type": "mutual" + "request": { + "id": "example:close#3", + "method": "close", + "params": [ + "107x1x0", + null, + "bcrt1qeyyk6sl5pr49ycpqyckvmttus5ttj25pd0zpvg" + ] + }, + "response": { + "tx": "02000000000101233b513665836d240423f45ffcd1fe19aeb08d62303fa5382ad3285f770683a60000000000ffffffff02a086010000000000225120b47216ab60a0fad97de0ba9b8b370d281dfe55f552d82034e2a8d054c2246e4405b10d0000000000160014c9096d43f408ea526020262ccdad7c8516b92a81040047304402207a9e3ca258861b33827d91514690a757e76730ba8c15dd222340bb13d993a1a502204d0ae329273b69abe62df1ffccce808d5f1a29101a8ee95dae99888376dbaef801473044022033c03f406db9f1c9d924cfd8f6ea42d0962f0ab02e3217aef518aea517ca5ba40220076e2af9d40c676316a2765a86f9efd481de3fc4465ceba33b0782c505ae3452014752210212284c004a3d24146e54b2a24db48f650370a08e1fe9abe8ff41f92b09cd50542102a3032ef980cc735579aa5295d927b9a1bdbafc459f2da14163dc9bd530e0a21152ae00000000", + "txid": "d44a1374a30c1a936d2d4fdbe73c0ffff42fec8c27c6cbaec2758b3042f61d08", + "type": "mutual" + } } ], "author": [ @@ -3304,59 +3338,63 @@ } } }, - "example_json_request": [ - { - "id": "example:commando-blacklist#1", - "method": "commando-blacklist", - "params": { - "start": 2 - } - }, - { - "id": "example:commando-blacklist#2", - "method": "commando-blacklist", - "params": { - "start": 5, - "end": 7 - } - }, - { - "id": "example:commando-blacklist#3", - "method": "commando-blacklist", - "params": { - "start": 3, - "end": 4 - } - } - ], - "example_json_response": [ + "json_example": [ { - "blacklist": [ - { - "start": 2, - "end": 2 + "request": { + "id": "example:commando-blacklist#1", + "method": "commando-blacklist", + "params": { + "start": 2 } - ] + }, + "response": { + "blacklist": [ + { + "start": 2, + "end": 2 + } + ] + } }, { - "blacklist": [ - { - "start": 2, - "end": 2 - }, - { + "request": { + "id": "example:commando-blacklist#2", + "method": "commando-blacklist", + "params": { "start": 5, "end": 7 } - ] + }, + "response": { + "blacklist": [ + { + "start": 2, + "end": 2 + }, + { + "start": 5, + "end": 7 + } + ] + } }, { - "blacklist": [ - { - "start": 2, - "end": 7 + "request": { + "id": "example:commando-blacklist#3", + "method": "commando-blacklist", + "params": { + "start": 3, + "end": 4 } - ] + }, + "response": { + "blacklist": [ + { + "start": 2, + "end": 7 + } + ] + } } ], "author": [ @@ -3531,127 +3569,131 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:commando-listrunes#1", - "method": "commando-listrunes", - "params": "{}" + "request": { + "id": "example:commando-listrunes#1", + "method": "commando-listrunes", + "params": "{}" + }, + "response": { + "runes": [ + { + "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", + "unique_id": "0", + "restrictions": [], + "restrictions_as_english": "" + }, + { + "rune": "Am3W_wI0PRn4qVNEsJ2iInHyFPQK8wfdqEXztm8-icQ9MA==", + "stored": false, + "our_rune": false, + "unique_id": "1", + "restrictions": [], + "restrictions_as_english": "" + } + ] + } }, { - "id": "example:commando-listrunes#2", - "method": "commando-listrunes", - "params": { - "rune": "Am3W_wI0PRn4qVNEsJ2iInHyFPQK8wfdqEXztm8-icQ9MA==" + "request": { + "id": "example:commando-listrunes#2", + "method": "commando-listrunes", + "params": { + "rune": "Am3W_wI0PRn4qVNEsJ2iInHyFPQK8wfdqEXztm8-icQ9MA==" + } + }, + "response": { + "runes": [ + { + "rune": "Am3W_wI0PRn4qVNEsJ2iInHyFPQK8wfdqEXztm8-icQ9MA==", + "stored": false, + "our_rune": false, + "unique_id": "1", + "restrictions": [], + "restrictions_as_english": "" + } + ] } }, { - "id": "example:commando-listrunes#3", - "method": "commando-listrunes", - "params": { - "rune": "m_tyR0qqHUuLEbFJW6AhmBg-9npxVX2yKocQBFi9cvY9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJzJnBuYW1lbGV2ZWwhfHBuYW1lbGV2ZWwvaW8mcGFycjEhfHBhcnIxL2lv" + "request": { + "id": "example:commando-listrunes#3", + "method": "commando-listrunes", + "params": { + "rune": "m_tyR0qqHUuLEbFJW6AhmBg-9npxVX2yKocQBFi9cvY9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJzJnBuYW1lbGV2ZWwhfHBuYW1lbGV2ZWwvaW8mcGFycjEhfHBhcnIxL2lv" + } + }, + "response": { + "runes": [ + { + "rune": "m_tyR0qqHUuLEbFJW6AhmBg-9npxVX2yKocQBFi9cvY9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJzJnBuYW1lbGV2ZWwhfHBuYW1lbGV2ZWwvaW8mcGFycjEhfHBhcnIxL2lv", + "stored": false, + "unique_id": "3", + "restrictions": [ + { + "alternatives": [ + { + "fieldname": "id", + "value": "022d223620a359a47ff7", + "condition": "^", + "english": "id starts with 022d223620a359a47ff7" + } + ], + "english": "id starts with 022d223620a359a47ff7" + }, + { + "alternatives": [ + { + "fieldname": "method", + "value": "listpeers", + "condition": "=", + "english": "method equal to listpeers" + } + ], + "english": "method equal to listpeers" + }, + { + "alternatives": [ + { + "fieldname": "pnamelevel", + "value": "", + "condition": "!", + "english": "pnamelevel is missing" + }, + { + "fieldname": "pnamelevel", + "value": "io", + "condition": "/", + "english": "pnamelevel unequal to io" + } + ], + "english": "pnamelevel is missing OR pnamelevel unequal to io" + }, + { + "alternatives": [ + { + "fieldname": "parr1", + "value": "", + "condition": "!", + "english": "parr1 is missing" + }, + { + "fieldname": "parr1", + "value": "io", + "condition": "/", + "english": "parr1 unequal to io" + } + ], + "english": "parr1 is missing OR parr1 unequal to io" + } + ], + "restrictions_as_english": "id starts with 022d223620a359a47ff7 AND method equal to listpeers AND pnamelevel is missing OR pnamelevel unequal to io AND parr1 is missing OR parr1 unequal to io" + } + ] } } ], - "example_json_response": [ - { - "runes": [ - { - "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", - "unique_id": "0", - "restrictions": [], - "restrictions_as_english": "" - }, - { - "rune": "Am3W_wI0PRn4qVNEsJ2iInHyFPQK8wfdqEXztm8-icQ9MA==", - "stored": false, - "our_rune": false, - "unique_id": "1", - "restrictions": [], - "restrictions_as_english": "" - } - ] - }, - { - "runes": [ - { - "rune": "Am3W_wI0PRn4qVNEsJ2iInHyFPQK8wfdqEXztm8-icQ9MA==", - "stored": false, - "our_rune": false, - "unique_id": "1", - "restrictions": [], - "restrictions_as_english": "" - } - ] - }, - { - "runes": [ - { - "rune": "m_tyR0qqHUuLEbFJW6AhmBg-9npxVX2yKocQBFi9cvY9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJzJnBuYW1lbGV2ZWwhfHBuYW1lbGV2ZWwvaW8mcGFycjEhfHBhcnIxL2lv", - "stored": false, - "unique_id": "3", - "restrictions": [ - { - "alternatives": [ - { - "fieldname": "id", - "value": "022d223620a359a47ff7", - "condition": "^", - "english": "id starts with 022d223620a359a47ff7" - } - ], - "english": "id starts with 022d223620a359a47ff7" - }, - { - "alternatives": [ - { - "fieldname": "method", - "value": "listpeers", - "condition": "=", - "english": "method equal to listpeers" - } - ], - "english": "method equal to listpeers" - }, - { - "alternatives": [ - { - "fieldname": "pnamelevel", - "value": "", - "condition": "!", - "english": "pnamelevel is missing" - }, - { - "fieldname": "pnamelevel", - "value": "io", - "condition": "/", - "english": "pnamelevel unequal to io" - } - ], - "english": "pnamelevel is missing OR pnamelevel unequal to io" - }, - { - "alternatives": [ - { - "fieldname": "parr1", - "value": "", - "condition": "!", - "english": "parr1 is missing" - }, - { - "fieldname": "parr1", - "value": "io", - "condition": "/", - "english": "parr1 unequal to io" - } - ], - "english": "parr1 is missing OR parr1 unequal to io" - } - ], - "restrictions_as_english": "id starts with 022d223620a359a47ff7 AND method equal to listpeers AND pnamelevel is missing OR pnamelevel unequal to io AND parr1 is missing OR parr1 unequal to io" - } - ] - } - ], "author": [ "Shahana Farooqui <> is mainly responsible." ], @@ -3885,67 +3927,73 @@ "", "If a rune has a ratelimit, any derived rune will have the same id, and thus will compete for that ratelimit. You might want to consider adding a tighter ratelimit to a rune before sharing it, so you will keep the remainder. For example, if you rune has a limit of 60 times per minute, adding a limit of 5 times per minute and handing that rune out means you can still use your original rune 55 times per minute." ], - "example_json_request": [ + "json_example": [ { - "id": "example:commando-rune#1", - "method": "commando-rune", - "params": "{}" + "request": { + "id": "example:commando-rune#1", + "method": "commando-rune", + "params": "{}" + }, + "response": { + "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", + "unique_id": "0", + "warning_unrestricted_rune": "WARNING: This rune has no restrictions! Anyone who has access to this rune could drain funds from your node. Be careful when giving this to apps that you don't trust. Consider using the restrictions parameter to only allow access to specific rpc methods." + } }, { - "id": "example:commando-rune#2", - "method": "commando-rune", - "params": { - "restrictions": "readonly" + "request": { + "id": "example:commando-rune#2", + "method": "commando-rune", + "params": { + "restrictions": "readonly" + } + }, + "response": { + "rune": "zm0x_eLgHexaTvZn3Cz7gb_YlvrlYGDo_w4BYlR9SS09MSZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl", + "unique_id": "1" } }, { - "id": "example:commando-rune#3", - "method": "commando-rune", - "params": { - "restrictions": [ - [ - "id^022d223620a359a47ff7" - ], - [ - "method=listpeers" + "request": { + "id": "example:commando-rune#3", + "method": "commando-rune", + "params": { + "restrictions": [ + [ + "id^022d223620a359a47ff7" + ], + [ + "method=listpeers" + ] ] - ] + } + }, + "response": { + "rune": "YPojv9qgHPa3im0eiqRb-g8aRq76OasyfltGGqdFUOU9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJz", + "unique_id": "2" } }, { - "id": "example:commando-rune#4", - "method": "commando-rune", - "params": { - "restrictions": [ - [ - "method=pay" - ], - [ - "pnameamountmsat<10000" + "request": { + "id": "example:commando-rune#4", + "method": "commando-rune", + "params": { + "restrictions": [ + [ + "method=pay" + ], + [ + "pnameamountmsat<10000" + ] ] - ] + } + }, + "response": { + "rune": "b3hXuEM7Pqzk-C7HUw83xzvHOV7fmuGaWjdo-wHdfg89MCZtZXRob2Q9cGF5JnBuYW1lYW1vdW50bXNhdDwxMDAwMA==", + "unique_id": "3" } } ], - "example_json_response": [ - { - "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", - "unique_id": "0", - "warning_unrestricted_rune": "WARNING: This rune has no restrictions! Anyone who has access to this rune could drain funds from your node. Be careful when giving this to apps that you don't trust. Consider using the restrictions parameter to only allow access to specific rpc methods." - }, - { - "rune": "zm0x_eLgHexaTvZn3Cz7gb_YlvrlYGDo_w4BYlR9SS09MSZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl", - "unique_id": "1" - }, - { - "rune": "YPojv9qgHPa3im0eiqRb-g8aRq76OasyfltGGqdFUOU9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJz", - "unique_id": "2" - }, - { - "rune": "b3hXuEM7Pqzk-C7HUw83xzvHOV7fmuGaWjdo-wHdfg89MCZtZXRob2Q9cGF5JnBuYW1lYW1vdW50bXNhdDwxMDAwMA==", - "unique_id": "3" - } - ], "author": [ "Rusty Russell <> wrote the original Python commando.py plugin, the in-tree commando plugin, and this manual page.", "", @@ -4033,101 +4081,105 @@ "", "It can also fail if the peer does not respond, in which case it will simply hang awaiting a response." ], - "example_json_request": [ - { - "id": "example:commando#1", - "method": "commando", - "params": { - "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "rune": "zm0x_eLgHexaTvZn3Cz7gb_YlvrlYGDo_w4BYlR9SS09MSZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl", - "method": "getinfo", - "params": {} - } - }, - { - "id": "example:commando#2", - "method": "commando", - "params": { - "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "rune": "m_tyR0qqHUuLEbFJW6AhmBg-9npxVX2yKocQBFi9cvY9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJzJnBuYW1lbGV2ZWwhfHBuYW1lbGV2ZWwvaW8mcGFycjEhfHBhcnIxL2lv", - "method": "listpeers", - "params": [ - "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "broken" - ] - } - }, + "json_example": [ { - "id": "example:commando#3", - "method": "commando", - "params": { - "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "rune": "b3hXuEM7Pqzk-C7HUw83xzvHOV7fmuGaWjdo-wHdfg89MCZtZXRob2Q9cGF5JnBuYW1lYW1vdW50bXNhdDwxMDAwMA==", - "method": "pay", + "request": { + "id": "example:commando#1", + "method": "commando", "params": { - "bolt11": "lnbcrt1pja05v6sp5n6gnm380ckkrnhzvytz0hvym0vcf0mlrk586nlp72cq7e2hhhffspp5cwhuvl4jhlqep3st2703z89jp7j6wucm8ytlj7rk9ckk0mv7whysdq5v3jhxcmjd9c8g6t0dceqxqyjw5qcqp99qxpqysgq40udwjtktkry0yyq9408q5vtmj534h88j5nn562lamam0rtfqfu3093t2dhhc63qnqe5maa5jc9ad5pm08q2k2udvp6skw9f6ez9c9qptatlau", - "amount_msat": 9999 + "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "rune": "zm0x_eLgHexaTvZn3Cz7gb_YlvrlYGDo_w4BYlR9SS09MSZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl", + "method": "getinfo", + "params": {} } - } - } - ], - "example_json_response": [ - { - "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "alias": "JUNIORBEAM-v23.11-415-gd120eba", - "color": "0266e4", - "num_peers": 1, - "num_pending_channels": 0, - "num_active_channels": 0, - "num_inactive_channels": 0, - "address": [], - "binding": [ - { - "type": "ipv4", - "address": "127.0.0.1", - "port": 42513 + }, + "response": { + "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "alias": "JUNIORBEAM-v23.11-415-gd120eba", + "color": "0266e4", + "num_peers": 1, + "num_pending_channels": 0, + "num_active_channels": 0, + "num_inactive_channels": 0, + "address": [], + "binding": [ + { + "type": "ipv4", + "address": "127.0.0.1", + "port": 42513 + } + ], + "version": "v23.11-415-gd120eba", + "blockheight": 101, + "network": "regtest", + "fees_collected_msat": 0, + "lightning-dir": "/tmp/ltests-7u_8_rtu/test_commando_rune_1/lightning-1/regtest", + "our_features": { + "init": "08a0000a8a5961", + "node": "88a0000a8a5961", + "channel": "", + "invoice": "02000002024100" } - ], - "version": "v23.11-415-gd120eba", - "blockheight": 101, - "network": "regtest", - "fees_collected_msat": 0, - "lightning-dir": "/tmp/ltests-7u_8_rtu/test_commando_rune_1/lightning-1/regtest", - "our_features": { - "init": "08a0000a8a5961", - "node": "88a0000a8a5961", - "channel": "", - "invoice": "02000002024100" } }, { - "peers": [ - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "connected": true, - "num_channels": 0, - "netaddr": [ - "127.0.0.1:40119" - ], - "features": "08a0000a8a5961", - "log": [ - { - "type": "SKIPPED", - "num_skipped": 30 - } + "request": { + "id": "example:commando#2", + "method": "commando", + "params": { + "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "rune": "m_tyR0qqHUuLEbFJW6AhmBg-9npxVX2yKocQBFi9cvY9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJzJnBuYW1lbGV2ZWwhfHBuYW1lbGV2ZWwvaW8mcGFycjEhfHBhcnIxL2lv", + "method": "listpeers", + "params": [ + "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "broken" ] } - ] + }, + "response": { + "peers": [ + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "connected": true, + "num_channels": 0, + "netaddr": [ + "127.0.0.1:40119" + ], + "features": "08a0000a8a5961", + "log": [ + { + "type": "SKIPPED", + "num_skipped": 30 + } + ] + } + ] + } }, { - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "payment_hash": "c3afc67eb2bfc190c60b579f111cb20fa5a7731b3917f978762e2d67ed9e75c9", - "created_at": 1708642714.8110592, - "parts": 1, - "amount_msat": 9999, - "amount_sent_msat": 9999, - "payment_preimage": "17632717785b1a833a296ba1831cb968602872e68881c2f324e06e87979296dc", - "status": "complete" + "request": { + "id": "example:commando#3", + "method": "commando", + "params": { + "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "rune": "b3hXuEM7Pqzk-C7HUw83xzvHOV7fmuGaWjdo-wHdfg89MCZtZXRob2Q9cGF5JnBuYW1lYW1vdW50bXNhdDwxMDAwMA==", + "method": "pay", + "params": { + "bolt11": "lnbcrt1pja05v6sp5n6gnm380ckkrnhzvytz0hvym0vcf0mlrk586nlp72cq7e2hhhffspp5cwhuvl4jhlqep3st2703z89jp7j6wucm8ytlj7rk9ckk0mv7whysdq5v3jhxcmjd9c8g6t0dceqxqyjw5qcqp99qxpqysgq40udwjtktkry0yyq9408q5vtmj534h88j5nn562lamam0rtfqfu3093t2dhhc63qnqe5maa5jc9ad5pm08q2k2udvp6skw9f6ez9c9qptatlau", + "amount_msat": 9999 + } + } + }, + "response": { + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "payment_hash": "c3afc67eb2bfc190c60b579f111cb20fa5a7731b3917f978762e2d67ed9e75c9", + "created_at": 1708642714.8110592, + "parts": 1, + "amount_msat": 9999, + "amount_sent_msat": 9999, + "payment_preimage": "17632717785b1a833a296ba1831cb968602872e68881c2f324e06e87979296dc", + "status": "complete" + } } ], "author": [ @@ -4315,45 +4367,47 @@ "- 402: If the peer disconnected while we were connecting", "- -32602: If the given parameters are wrong" ], - "example_json_request": [ + "json_example": [ { - "id": "example:connect#1", - "method": "connect", - "params": { + "request": { + "id": "example:connect#1", + "method": "connect", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "host": "localhost", + "port": 44619 + } + }, + "response": { "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "host": "localhost", - "port": 44619 + "features": "08a0000a0a69a2", + "direction": "out", + "address": { + "type": "ipv4", + "address": "127.0.0.1", + "port": 44619 + } } }, { - "id": "example:connect#2", - "method": "connect", - "params": { + "request": { + "id": "example:connect#2", + "method": "connect", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "host": "127.0.0.1", + "port": 42839 + } + }, + "response": { "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "host": "127.0.0.1", - "port": 42839 - } - } - ], - "example_json_response": [ - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "features": "08a0000a0a69a2", - "direction": "out", - "address": { - "type": "ipv4", - "address": "127.0.0.1", - "port": 44619 - } - }, - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "features": "08a0000a8a5961", - "direction": "out", - "address": { - "type": "ipv4", - "address": "127.0.0.1", - "port": 42839 + "features": "08a0000a8a5961", + "direction": "out", + "address": { + "type": "ipv4", + "address": "127.0.0.1", + "port": 42839 + } } } ], @@ -4734,69 +4788,71 @@ "", "The `onion` corresponds to 1366 hex-encoded bytes. Each shared secret consists of 32 hex-encoded bytes. Both arguments can be passed on to **sendonion**." ], - "example_json_request": [ + "json_example": [ { - "id": "example:createonion#1", - "method": "createonion", - "params": { - "hops": [ - { - "pubkey": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "payload": "e4000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" - }, - { - "pubkey": "0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c", - "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" - }, - { - "pubkey": "027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007", - "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" - }, - { - "pubkey": "032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991", - "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" - }, - { - "pubkey": "02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145", - "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" - } - ], - "assocdata": "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", - "onion_size": 1301 + "request": { + "id": "example:createonion#1", + "method": "createonion", + "params": { + "hops": [ + { + "pubkey": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "payload": "e4000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + }, + { + "pubkey": "0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c", + "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + }, + { + "pubkey": "027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007", + "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + }, + { + "pubkey": "032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991", + "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + }, + { + "pubkey": "02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145", + "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + } + ], + "assocdata": "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", + "onion_size": 1301 + } + }, + "response": { + "onion": "00034c3f9e11d92555260db3ee4ba0378a645d01c2556451f4289a1d9b43c7afa9a4f9ecc7010dafb26787bb583c514c3b3990d40c8168b1046659d7bc2512d2f1ee0afd2b87c42de2b70102b649634d211b38049593dbb6ed8ee8f93f0b9ff23cd9654c1341137711ce67751d40867cc90c290a9446be2b8a5a43641d4549505b13e807b4240b5b82ffaf22cb534cff01be46db3985ac83b7db465fbd86d4c8d472f60678946c71eca97dd5db732fe5a6d3765e5a5afad72f035207173e7eaaa0da4f0a4540472c7dd269a030428ae586a61b2a70a428055c3848427d2a2e8bd521aadbaf79d56ea39df63c059772e026d57f0b6844c1ab99e936beadf42aaa78193b05f7380e242258deeaa90db316a943d311ef4f2a08f422422c9da454f9666742ad61c6ae003bce83cf6243adf64a728ea50bdaf129ab2ac70e1988a117609cbefc01c884f86b2494349d1067f5cf17760cdab6ae076631693147e8712412d4f0b17cf288b394fd9e29419156ee629966553c2e7598631cbf7493820388eef1ae9f4d2f9da88872e8afbbedb3b46cd7c461cbe4c5491dc6f4a68bc244584bc79b1bb227c869fae16dab4b16412523c984d3ed2b872f63b95a62f66563d2b03c3d1b5fff0290411b293569ce8435b96b447be776b49395a8d94f48cb2f7699a38e8de58d6fff04075d226dcac07668512b6d2c20d4c49d03ad300a52769e4ebbacf97378633126958df1817effc12fd679723123df244fd9b5421f8a2aedb9a8b6fb4049e3a7cae3985059081239bea38351f0c90ed5a0ff45cc492e6ab353e4c13d22ff48912d6ecfda711edfb88dc0767ecfc5dddf8fb0e112a538aeee55c0f73b3b8afc4f40ef3588eabde5b95344a4525adf67841dd67b1db10da180fb346e0bd2958f095d011827063c42361964f8ac2c356d2ec1868a9498dcd6b5915a4df4601c58fcbeb688e14de61300f13183c154b3320cc8e80042a46f22d796f56ff1fdd7e28440c05f14b960c1d0a7c627b09295112bcb635b0e2447a9374fafc4a23ceaf9de4d10b29b2f6cabd7f0c7706cf0404452681d7372d559b644627b2695960deb3b4ae57028e0164b29d5ef9e701d3122b6a5715c502e1dca5252e8c215ed754b01a193041ad9751ed2fff1b55991e256edd6099a38004a367ad097c7caf953da302201263715517f6d32cff57969be994df42fd6cadb649e3c738be798f779aaf4c07cada6bf1e4115b74e2670baf4b1592c70b10a6c043b6606b428b3f79545dc8e9783c876e5402909858f9c604963c37fbc477137c8908e6cfa11ece18c8784a6f25428a5ee1e91d0095fe310d6a91139a7c5c6624bbfcaa15ee847a25b06f57332917f68526a6317f575792e9bcba8576a96bc5859b1f2a00fd8ab08a5ac4ab71833b0b711d1f120cbdb374bcedcdcbeba3806644f5082ec737a945221f5d99562fcbb02a43beeafb16ceecd4e35f06a04c9ff9f4f33725ab62cf22c36650280e4cfb9e150a2c4ebee7785108522e8ecb4682d2d751168e7597299346c3a5e885e36eda66b9a1112997111135767972d771b02c1a36c1d1fb1ce539ecfb98e9e1d8f8fdbf89aec28ad34ff5c00c1a4a8c59848dc8b64c0e65f6f10122e60b4adc1cfc602f49d6cfbdd54be6b0951d3f9cafe8cdd0428f9ce6994844e92d8b72d44edda623bad428b398f88643c3904bda16dd15e886ca4ef6ea7f1450744ac38ffce902569d2e9026bcedd6d0ee54aceabda22bf2de72cba89e6c274064619e32a1192cf2d78b56cf497f7785a6d599de9f8383d1f66f47fc385dc569ee1f08ddbbc7f1aeb0a0126fc4020d948dda10255f11e776db7a037059a40fde38a2ee0c0ce49c7f3df175881bf12371fa72fec3fba657107892a97efe41dcc18aeecd99f3e46c33cf42c2a0ba8b75cf000", + "shared_secrets": [ + "ccf2512684e2508cb4a842393757e6040b7d25e29d3a2031f29d00a000af6128", + "d4cec39fe6287d41165bf5c608b0c720a411208a83c64c805a012c86662a2e5a", + "91bc712ebd4a900e05830394ca8b1f1168777ecdd6996029d96ec8838b9903b9", + "93c373dcb14dc36ababa3e0c5c55869a667ca175e09913a98c3be67e6af97e16", + "b2642a5770a6b61ade071fdf69d3ea365cf48434fc2a2c399512778821a33e5c" + ] } }, { - "id": "example:createonion#2", - "method": "createonion", - "params": { - "hops": [ - { - "pubkey": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "payload": "0cfdb000084869207468657265" - } - ], - "assocdata": "36bf44cc8d80498b95eb05e36ae5811206d3a1d8b5c8d59bbcad035d386a4de8" + "request": { + "id": "example:createonion#2", + "method": "createonion", + "params": { + "hops": [ + { + "pubkey": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "payload": "0cfdb000084869207468657265" + } + ], + "assocdata": "36bf44cc8d80498b95eb05e36ae5811206d3a1d8b5c8d59bbcad035d386a4de8" + } + }, + "response": { + "onion": "0002cdce4bfaa9faa2c060afafe001b80bde07fc670e882c063a80b4738d5f78c9351825c6461cdfcd4fe4144d3b51f63da6351b28dd49c7bfdb0b4f7d8bda4ad0d99699eda39e551084c0a095746c358d1dc6d2eec8082f2aa2f69ae8f61b1f1437ae0ed673078fec6c0510a34058167ad1a34e819a3813d4cf27b2c4917a8c6ca3d70c3381a2a41b4c1b4540adf0e922e25f57d1cfc3064f29cfec4c17244160121975cab59b44c83b4a4905bf7ebfbd308de376334bf86d8aa92c674f7bcfec85680d73e9fee72642c98c603128e358c86e0bc88a60aaebc2637441a57261c61c6be145f00f2fc56164a6495f4b52d3172cb0ef52e91fa0d32a9ae2502d17433bda58d93fbc24a70ec6b5e740952a61404c7370eafe52599c7ee52e77b1cda87c46da98d2ff0d02fe09db5adcb2d2e9bcd083ef58392907b8a21681fa4ea1e4806b4676656457fea000fa504f9b4d159fe8b241266ac91dcc0351053c6dcc1493a6b02bed652cc8b92a8470c98924ebfde6ddc5cf7fd75f6e83a7350642053b70d4834179c30eb56d8c86656cda784daf3b6cd125779bec51099301e3f79f78d85d0454aef8bf5f9058491881b73e99b662b64080cd3eb16fd7f9d9640c18738736cfc15f391232b7df92f46ceb5abf08732ff833e9409ee541d7c926f7a0fe3e233d3eee4a63b65ab23b7c835b7cdd809ddfac8abb1df471fa66a54092815aa41e6fc1a026b86c5675d39c4e8c5c4b4acd48534165239f5634b9e828a7f9df94efcd2a39045efdee4d2f006a63ae828e6e90e3610c522085da6e0198141d6e501d83aba32057f4e59f9b7dfb0bf949c5ef91917cb54561d45a9e7ead049c57deb62d14ba6e18f5d7b0fb9f15e97bf5bd9f909f99c86c787357946654b87c489d34245d07fbb72119166e338b608a4178b452695235dd96bf7fd338e29a9f054ec1a63a442e12602d2329834297f6a197d8a377d608f402f0bcc936f45f33c8d2f9d40e5aef41816dd883add81ca20f1e0631457fe00aa2bd75c9165ffcd96c100c1db83a53aeee23d59f2a542ee3ba39ba62298ddfbd9ecfafd6b5d2121eb003ee23a2ebb8c6b6b687f42492c962510c5acf5231ff96635eba37354559ba39b042d9b6883cac662f418d7c62f9908b2a67964af5e5471804f7684e0d582b8bfec99816bb3442cca1d1fe4efd75d573ebf09fa9cad811063864fb14be4a7768ec2ddb118a77969e986c6584c4b20f8622941ca73d73562857d36e17a46a68d6e10147aaefff1ffb9809f0652a5f760148ed33550661b63c8176d5679e701c221d8a49d4062eb04010ea74cc1132fbeb8934c6e582ba2a16162b7e9171f95bce4ec3e339e70c781f95aaca406cd718b74397658fdefdd093486664be7ed13efa437012f1f57f9f1f4fb4eef7501ccf0e0ac4edc01fde138038c4dd65cb5c3291ad02a6728d6761b1afa35d49bd6ef117012bdd9bd6ee8a175620feb2249aa18d6175351b4bfc2b2b4fd57ff52f5969b109aa9b6cb2cde8f350917c0da2da1bc3d52eb0c7e6080b8f69c5783f2ed26feceb05ba4e7ed66676041d03d0acd3dd6343a85ac0b9c36f9640ddd0db884822f98dc42ea7911a6938dc14ba19d3d25a2b2f82794a2b5dd751dc856d7a9ccdb2d351a0b84e7030fa925ac949a37594f3aa2ba28ae5155b0aaac9c6820b8888d0b8a9db148513b9e3dbde68333ac30a0720289b6a0145d88629d49e76a6d3538330c5aececc9d54127b0a5a0e92d5a5a73beb71132c208b589cab61d53ed357c907929198c559426ae729b374a803dd3321a45ccca39efd39eddaba6e79a2f8911bdf74e18733dc7efc51132b5608d97fd2d0f22fa8961de04cdf6d0dbfbab21e362e7abaef3976f993088aa97ed3f1f4bcf3fffb012f583558bd2f15face9cba20b3e6754b70", + "shared_secrets": [ + "3f53c03f98eb83db88ff97c2c4004051ce23265ed2414a7aebf7a3e7078839ab" + ] } } ], - "example_json_response": [ - { - "onion": "00034c3f9e11d92555260db3ee4ba0378a645d01c2556451f4289a1d9b43c7afa9a4f9ecc7010dafb26787bb583c514c3b3990d40c8168b1046659d7bc2512d2f1ee0afd2b87c42de2b70102b649634d211b38049593dbb6ed8ee8f93f0b9ff23cd9654c1341137711ce67751d40867cc90c290a9446be2b8a5a43641d4549505b13e807b4240b5b82ffaf22cb534cff01be46db3985ac83b7db465fbd86d4c8d472f60678946c71eca97dd5db732fe5a6d3765e5a5afad72f035207173e7eaaa0da4f0a4540472c7dd269a030428ae586a61b2a70a428055c3848427d2a2e8bd521aadbaf79d56ea39df63c059772e026d57f0b6844c1ab99e936beadf42aaa78193b05f7380e242258deeaa90db316a943d311ef4f2a08f422422c9da454f9666742ad61c6ae003bce83cf6243adf64a728ea50bdaf129ab2ac70e1988a117609cbefc01c884f86b2494349d1067f5cf17760cdab6ae076631693147e8712412d4f0b17cf288b394fd9e29419156ee629966553c2e7598631cbf7493820388eef1ae9f4d2f9da88872e8afbbedb3b46cd7c461cbe4c5491dc6f4a68bc244584bc79b1bb227c869fae16dab4b16412523c984d3ed2b872f63b95a62f66563d2b03c3d1b5fff0290411b293569ce8435b96b447be776b49395a8d94f48cb2f7699a38e8de58d6fff04075d226dcac07668512b6d2c20d4c49d03ad300a52769e4ebbacf97378633126958df1817effc12fd679723123df244fd9b5421f8a2aedb9a8b6fb4049e3a7cae3985059081239bea38351f0c90ed5a0ff45cc492e6ab353e4c13d22ff48912d6ecfda711edfb88dc0767ecfc5dddf8fb0e112a538aeee55c0f73b3b8afc4f40ef3588eabde5b95344a4525adf67841dd67b1db10da180fb346e0bd2958f095d011827063c42361964f8ac2c356d2ec1868a9498dcd6b5915a4df4601c58fcbeb688e14de61300f13183c154b3320cc8e80042a46f22d796f56ff1fdd7e28440c05f14b960c1d0a7c627b09295112bcb635b0e2447a9374fafc4a23ceaf9de4d10b29b2f6cabd7f0c7706cf0404452681d7372d559b644627b2695960deb3b4ae57028e0164b29d5ef9e701d3122b6a5715c502e1dca5252e8c215ed754b01a193041ad9751ed2fff1b55991e256edd6099a38004a367ad097c7caf953da302201263715517f6d32cff57969be994df42fd6cadb649e3c738be798f779aaf4c07cada6bf1e4115b74e2670baf4b1592c70b10a6c043b6606b428b3f79545dc8e9783c876e5402909858f9c604963c37fbc477137c8908e6cfa11ece18c8784a6f25428a5ee1e91d0095fe310d6a91139a7c5c6624bbfcaa15ee847a25b06f57332917f68526a6317f575792e9bcba8576a96bc5859b1f2a00fd8ab08a5ac4ab71833b0b711d1f120cbdb374bcedcdcbeba3806644f5082ec737a945221f5d99562fcbb02a43beeafb16ceecd4e35f06a04c9ff9f4f33725ab62cf22c36650280e4cfb9e150a2c4ebee7785108522e8ecb4682d2d751168e7597299346c3a5e885e36eda66b9a1112997111135767972d771b02c1a36c1d1fb1ce539ecfb98e9e1d8f8fdbf89aec28ad34ff5c00c1a4a8c59848dc8b64c0e65f6f10122e60b4adc1cfc602f49d6cfbdd54be6b0951d3f9cafe8cdd0428f9ce6994844e92d8b72d44edda623bad428b398f88643c3904bda16dd15e886ca4ef6ea7f1450744ac38ffce902569d2e9026bcedd6d0ee54aceabda22bf2de72cba89e6c274064619e32a1192cf2d78b56cf497f7785a6d599de9f8383d1f66f47fc385dc569ee1f08ddbbc7f1aeb0a0126fc4020d948dda10255f11e776db7a037059a40fde38a2ee0c0ce49c7f3df175881bf12371fa72fec3fba657107892a97efe41dcc18aeecd99f3e46c33cf42c2a0ba8b75cf000", - "shared_secrets": [ - "ccf2512684e2508cb4a842393757e6040b7d25e29d3a2031f29d00a000af6128", - "d4cec39fe6287d41165bf5c608b0c720a411208a83c64c805a012c86662a2e5a", - "91bc712ebd4a900e05830394ca8b1f1168777ecdd6996029d96ec8838b9903b9", - "93c373dcb14dc36ababa3e0c5c55869a667ca175e09913a98c3be67e6af97e16", - "b2642a5770a6b61ade071fdf69d3ea365cf48434fc2a2c399512778821a33e5c" - ] - }, - { - "onion": "0002cdce4bfaa9faa2c060afafe001b80bde07fc670e882c063a80b4738d5f78c9351825c6461cdfcd4fe4144d3b51f63da6351b28dd49c7bfdb0b4f7d8bda4ad0d99699eda39e551084c0a095746c358d1dc6d2eec8082f2aa2f69ae8f61b1f1437ae0ed673078fec6c0510a34058167ad1a34e819a3813d4cf27b2c4917a8c6ca3d70c3381a2a41b4c1b4540adf0e922e25f57d1cfc3064f29cfec4c17244160121975cab59b44c83b4a4905bf7ebfbd308de376334bf86d8aa92c674f7bcfec85680d73e9fee72642c98c603128e358c86e0bc88a60aaebc2637441a57261c61c6be145f00f2fc56164a6495f4b52d3172cb0ef52e91fa0d32a9ae2502d17433bda58d93fbc24a70ec6b5e740952a61404c7370eafe52599c7ee52e77b1cda87c46da98d2ff0d02fe09db5adcb2d2e9bcd083ef58392907b8a21681fa4ea1e4806b4676656457fea000fa504f9b4d159fe8b241266ac91dcc0351053c6dcc1493a6b02bed652cc8b92a8470c98924ebfde6ddc5cf7fd75f6e83a7350642053b70d4834179c30eb56d8c86656cda784daf3b6cd125779bec51099301e3f79f78d85d0454aef8bf5f9058491881b73e99b662b64080cd3eb16fd7f9d9640c18738736cfc15f391232b7df92f46ceb5abf08732ff833e9409ee541d7c926f7a0fe3e233d3eee4a63b65ab23b7c835b7cdd809ddfac8abb1df471fa66a54092815aa41e6fc1a026b86c5675d39c4e8c5c4b4acd48534165239f5634b9e828a7f9df94efcd2a39045efdee4d2f006a63ae828e6e90e3610c522085da6e0198141d6e501d83aba32057f4e59f9b7dfb0bf949c5ef91917cb54561d45a9e7ead049c57deb62d14ba6e18f5d7b0fb9f15e97bf5bd9f909f99c86c787357946654b87c489d34245d07fbb72119166e338b608a4178b452695235dd96bf7fd338e29a9f054ec1a63a442e12602d2329834297f6a197d8a377d608f402f0bcc936f45f33c8d2f9d40e5aef41816dd883add81ca20f1e0631457fe00aa2bd75c9165ffcd96c100c1db83a53aeee23d59f2a542ee3ba39ba62298ddfbd9ecfafd6b5d2121eb003ee23a2ebb8c6b6b687f42492c962510c5acf5231ff96635eba37354559ba39b042d9b6883cac662f418d7c62f9908b2a67964af5e5471804f7684e0d582b8bfec99816bb3442cca1d1fe4efd75d573ebf09fa9cad811063864fb14be4a7768ec2ddb118a77969e986c6584c4b20f8622941ca73d73562857d36e17a46a68d6e10147aaefff1ffb9809f0652a5f760148ed33550661b63c8176d5679e701c221d8a49d4062eb04010ea74cc1132fbeb8934c6e582ba2a16162b7e9171f95bce4ec3e339e70c781f95aaca406cd718b74397658fdefdd093486664be7ed13efa437012f1f57f9f1f4fb4eef7501ccf0e0ac4edc01fde138038c4dd65cb5c3291ad02a6728d6761b1afa35d49bd6ef117012bdd9bd6ee8a175620feb2249aa18d6175351b4bfc2b2b4fd57ff52f5969b109aa9b6cb2cde8f350917c0da2da1bc3d52eb0c7e6080b8f69c5783f2ed26feceb05ba4e7ed66676041d03d0acd3dd6343a85ac0b9c36f9640ddd0db884822f98dc42ea7911a6938dc14ba19d3d25a2b2f82794a2b5dd751dc856d7a9ccdb2d351a0b84e7030fa925ac949a37594f3aa2ba28ae5155b0aaac9c6820b8888d0b8a9db148513b9e3dbde68333ac30a0720289b6a0145d88629d49e76a6d3538330c5aececc9d54127b0a5a0e92d5a5a73beb71132c208b589cab61d53ed357c907929198c559426ae729b374a803dd3321a45ccca39efd39eddaba6e79a2f8911bdf74e18733dc7efc51132b5608d97fd2d0f22fa8961de04cdf6d0dbfbab21e362e7abaef3976f993088aa97ed3f1f4bcf3fffb012f583558bd2f15face9cba20b3e6754b70", - "shared_secrets": [ - "3f53c03f98eb83db88ff97c2c4004051ce23265ed2414a7aebf7a3e7078839ab" - ] - } - ], "author": [ "Christian Decker <> is mainly responsible." ], @@ -5035,50 +5091,54 @@ "", "If a rune has a ratelimit, any derived rune will have the same id, and thus will compete for that ratelimit. You might want to consider adding a tighter ratelimit to a rune before sharing it, so you will keep the remainder. For example, if you rune has a limit of 60 times per minute, adding a limit of 5 times per minute and handing that rune out means you can still use your original rune 55 times per minute." ], - "example_json_request": [ + "json_example": [ { - "id": "example:createrune#1", - "method": "createrune", - "params": { - "restrictions": [ - [ - "method/getinfo" + "request": { + "id": "example:createrune#1", + "method": "createrune", + "params": { + "restrictions": [ + [ + "method/getinfo" + ] ] - ] + } + }, + "response": { + "rune": "S5f-BKt3rR-cvJmujdpDCUQm_XLahfB4iQuDlwqMJiQ9MCZtZXRob2QvZ2V0aW5mbw==", + "unique_id": "0" } }, { - "id": "example:createrune#2", - "method": "createrune", - "params": { - "restrictions": "readonly" + "request": { + "id": "example:createrune#2", + "method": "createrune", + "params": { + "restrictions": "readonly" + } + }, + "response": { + "rune": "oVkzoiQ67VCU1h_aRjPqCeWktGX54ARDsqqQgDL-uMs9MCZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl", + "unique_id": "1" } }, { - "id": "example:createrune#3", - "method": "createrune", - "params": [ - "enX0sTpHB8y1ktyTAF80CnEvGetG340Ne3AGItudBS49NCZwbnVtPTA=", - [ + "request": { + "id": "example:createrune#3", + "method": "createrune", + "params": [ + "enX0sTpHB8y1ktyTAF80CnEvGetG340Ne3AGItudBS49NCZwbnVtPTA=", [ - "rate=3" + [ + "rate=3" + ] ] ] - ] - } - ], - "example_json_response": [ - { - "rune": "S5f-BKt3rR-cvJmujdpDCUQm_XLahfB4iQuDlwqMJiQ9MCZtZXRob2QvZ2V0aW5mbw==", - "unique_id": "0" - }, - { - "rune": "oVkzoiQ67VCU1h_aRjPqCeWktGX54ARDsqqQgDL-uMs9MCZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl", - "unique_id": "1" - }, - { - "rune": "_h2eKjoK7ITAF-JQ1S5oum9oMQesrz-t1FR9kDChRB49NCZwbnVtPTAmcmF0ZT0z", - "unique_id": "2" + }, + "response": { + "rune": "_h2eKjoK7ITAF-JQ1S5oum9oMQesrz-t1FR9kDChRB49NCZwbnVtPTAmcmF0ZT0z", + "unique_id": "2" + } } ], "author": [ @@ -5210,36 +5270,72 @@ "- 1206: One of the parents already exists with a value.", "- -32602: invalid parameters" ], - "example_json_request": [ + "json_example": [ { - "id": "example:datastore#1", - "method": "datastore", - "params": { + "request": { + "id": "example:datastore#1", + "method": "datastore", + "params": { + "key": [ + "test_libplugin", + "name" + ], + "string": "foobar", + "hex": null, + "mode": "must-replace", + "generation": null + } + }, + "response": { "key": [ "test_libplugin", "name" ], - "string": "foobar", - "hex": null, - "mode": "must-replace", - "generation": null + "generation": 1, + "hex": "666f6f626172", + "string": "foobar" } }, { - "id": "example:datastore#2", - "method": "datastore", - "params": { - "key": "somekey", - "string": null, - "hex": "61", - "mode": "create-or-append", - "generation": null + "request": { + "id": "example:datastore#2", + "method": "datastore", + "params": { + "key": "somekey", + "string": null, + "hex": "61", + "mode": "create-or-append", + "generation": null + } + }, + "response": { + "key": [ + "somekey" + ], + "generation": 3, + "hex": "736f6d6564617461", + "string": "somedata" } }, { - "id": "example:datastore#3", - "method": "datastore", - "params": { + "request": { + "id": "example:datastore#3", + "method": "datastore", + "params": { + "key": [ + "a", + "d", + "e", + "f", + "g" + ], + "string": "somedatatostoreinthedatastore", + "hex": null, + "mode": null, + "generation": null + } + }, + "response": { "key": [ "a", "d", @@ -5247,44 +5343,12 @@ "f", "g" ], - "string": "somedatatostoreinthedatastore", - "hex": null, - "mode": null, - "generation": null + "generation": 0, + "hex": "736f6d6564617461746f73746f7265696e7468656461746173746f7265", + "string": "somedatatostoreinthedatastore" } } ], - "example_json_response": [ - { - "key": [ - "test_libplugin", - "name" - ], - "generation": 1, - "hex": "666f6f626172", - "string": "foobar" - }, - { - "key": [ - "somekey" - ], - "generation": 3, - "hex": "736f6d6564617461", - "string": "somedata" - }, - { - "key": [ - "a", - "d", - "e", - "f", - "g" - ], - "generation": 0, - "hex": "736f6d6564617461746f73746f7265696e7468656461746173746f7265", - "string": "somedatatostoreinthedatastore" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -5361,49 +5425,53 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:datastoreusage#1", - "method": "datastoreusage", - "params": { - "key": null + "request": { + "id": "example:datastoreusage#1", + "method": "datastoreusage", + "params": { + "key": null + } + }, + "response": { + "datastoreusage": { + "key": "[]", + "total_bytes": 0 + } } }, { - "id": "example:datastoreusage#2", - "method": "datastoreusage", - "params": { - "key": "a" + "request": { + "id": "example:datastoreusage#2", + "method": "datastoreusage", + "params": { + "key": "a" + } + }, + "response": { + "datastoreusage": { + "key": "[a]", + "total_bytes": 32 + } } }, { - "id": "example:datastoreusage#3", - "method": "datastoreusage", - "params": { - "key": [ - "a", - "thisissomelongkeythattriestostore46bytesofdata" - ] - } - } - ], - "example_json_response": [ - { - "datastoreusage": { - "key": "[]", - "total_bytes": 0 - } - }, - { - "datastoreusage": { - "key": "[a]", - "total_bytes": 32 - } - }, - { - "datastoreusage": { - "key": "[a,thisissomelongkeythattriestostore46bytesofdata]", - "total_bytes": 77 + "request": { + "id": "example:datastoreusage#3", + "method": "datastoreusage", + "params": { + "key": [ + "a", + "thisissomelongkeythattriestostore46bytesofdata" + ] + } + }, + "response": { + "datastoreusage": { + "key": "[a,thisissomelongkeythattriestostore46bytesofdata]", + "total_bytes": 77 + } } } ], @@ -7430,70 +7498,72 @@ } ] }, - "example_json_request": [ - { - "id": "example:decode#1", - "method": "decode", - "params": [ - "zm0x_eLgHexaTvZn3Cz7gb_YlvrlYGDo_w4BYlR9SS09MSZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl" - ] - }, + "json_example": [ { - "id": "example:decode#2", - "method": "decode", - "params": [ - "lnbcrt1m1pja0f2hsp5xyssdvdsu24dmmesrt6x84wfrm4mscsnzq7hl2suzeu90wy6g53qpp5zyyu3anwfsfl64pewe0tg7j28map2wwnhvaam5nt70rlwxa0cegqdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqgqqqqqqqlgqqqq86qqqc9qxpqysgq7u4f99u4kepagme27t5c3gdl7czlnjaw7kxryxgm87w2j02j3g94r2vrukhpgedhcdkcdec27m7jrl2lvcr6uh3rdv9lgpz0vc0zcfcqnugjdw" - ] - } - ], - "example_json_response": [ - { - "type": "rune", - "unique_id": "1", - "string": "ce6d31fde2e01dec5a4ef667dc2cfb81bfd896fae56060e8ff0e0162547d492d:=1&method^list|method^get|method=summary&method/listdatastore", - "restrictions": [ - { - "alternatives": [ - "method^list", - "method^get", - "method=summary" - ], - "summary": "method (of command) starts with 'list' OR method (of command) starts with 'get' OR method (of command) equal to 'summary'" - }, - { - "alternatives": [ - "method/listdatastore" - ], - "summary": "method (of command) unequal to 'listdatastore'" - } - ], - "valid": true - }, - { - "type": "bolt11 invoice", - "currency": "bcrt", - "created_at": 1708631383, - "expiry": 604800, - "payee": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "amount_msat": 100000000, - "description": "description", - "min_final_cltv_expiry": 5, - "payment_secret": "312106b1b0e2aaddef301af463d5c91eebb86213103d7faa1c167857b89a4522", - "features": "02024100", - "routes": [ - [ + "request": { + "id": "example:decode#1", + "method": "decode", + "params": [ + "zm0x_eLgHexaTvZn3Cz7gb_YlvrlYGDo_w4BYlR9SS09MSZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl" + ] + }, + "response": { + "type": "rune", + "unique_id": "1", + "string": "ce6d31fde2e01dec5a4ef667dc2cfb81bfd896fae56060e8ff0e0162547d492d:=1&method^list|method^get|method=summary&method/listdatastore", + "restrictions": [ { - "pubkey": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "short_channel_id": "103x1x0", - "fee_base_msat": 1000, - "fee_proportional_millionths": 1000, - "cltv_expiry_delta": 6 + "alternatives": [ + "method^list", + "method^get", + "method=summary" + ], + "summary": "method (of command) starts with 'list' OR method (of command) starts with 'get' OR method (of command) equal to 'summary'" + }, + { + "alternatives": [ + "method/listdatastore" + ], + "summary": "method (of command) unequal to 'listdatastore'" } - ] - ], - "payment_hash": "1109c8f66e4c13fd5439765eb47a4a3efa1539d3bb3bddd26bf3c7f71bafc650", - "signature": "3045022100f72a929795b643d46f2af2e988a1bff605f9cbaef58c32191b3f9ca93d528a0b022051a983e5ae1465b7c36d86e70af6fd21fd5f6607ae5e236b0bf4044f661e2c27", - "valid": true + ], + "valid": true + } + }, + { + "request": { + "id": "example:decode#2", + "method": "decode", + "params": [ + "lnbcrt1m1pja0f2hsp5xyssdvdsu24dmmesrt6x84wfrm4mscsnzq7hl2suzeu90wy6g53qpp5zyyu3anwfsfl64pewe0tg7j28map2wwnhvaam5nt70rlwxa0cegqdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqgqqqqqqqlgqqqq86qqqc9qxpqysgq7u4f99u4kepagme27t5c3gdl7czlnjaw7kxryxgm87w2j02j3g94r2vrukhpgedhcdkcdec27m7jrl2lvcr6uh3rdv9lgpz0vc0zcfcqnugjdw" + ] + }, + "response": { + "type": "bolt11 invoice", + "currency": "bcrt", + "created_at": 1708631383, + "expiry": 604800, + "payee": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "amount_msat": 100000000, + "description": "description", + "min_final_cltv_expiry": 5, + "payment_secret": "312106b1b0e2aaddef301af463d5c91eebb86213103d7faa1c167857b89a4522", + "features": "02024100", + "routes": [ + [ + { + "pubkey": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "short_channel_id": "103x1x0", + "fee_base_msat": 1000, + "fee_proportional_millionths": 1000, + "cltv_expiry_delta": 6 + } + ] + ], + "payment_hash": "1109c8f66e4c13fd5439765eb47a4a3efa1539d3bb3bddd26bf3c7f71bafc650", + "signature": "3045022100f72a929795b643d46f2af2e988a1bff605f9cbaef58c32191b3f9ca93d528a0b022051a983e5ae1465b7c36d86e70af6fd21fd5f6607ae5e236b0bf4044f661e2c27", + "valid": true + } } ], "author": [ @@ -7764,33 +7834,33 @@ "Technically, the *description* field is optional if a *description_hash* field is given, but in this case **decodepay** will only succeed if the optional *description* field is passed and matches the *description_hash*. In practice, these are currently unused." ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:decodepay#1", - "method": "decodepay", - "params": { - "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", - "description": null + "request": { + "id": "example:decodepay#1", + "method": "decodepay", + "params": { + "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", + "description": null + } + }, + "response": { + "currency": "bcrt", + "created_at": 1706152930, + "expiry": 604800, + "payee": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount_msat": 11000000, + "description": [ + "XEoCR94SIz6UIRUEkxum." + ], + "min_final_cltv_expiry": 5, + "payment_secret": "82644944d3f70d42aad1d5f7b5d7a629e7afa30b529cc952a4c59fc0e3790ea2", + "features": "02024100", + "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", + "signature": "3045022100e3b7d8886eae1a7c9e55e1797aa0dcb77b8c5a19d56c657cad030e360c90682802203a35713acb098245e53a37faeac98754a29a7078db5ed6f2166f917e55b94484" } } ], - "example_json_response": [ - { - "currency": "bcrt", - "created_at": 1706152930, - "expiry": 604800, - "payee": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount_msat": 11000000, - "description": [ - "XEoCR94SIz6UIRUEkxum." - ], - "min_final_cltv_expiry": 5, - "payment_secret": "82644944d3f70d42aad1d5f7b5d7a629e7afa30b529cc952a4c59fc0e3790ea2", - "features": "02024100", - "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "signature": "3045022100e3b7d8886eae1a7c9e55e1797aa0dcb77b8c5a19d56c657cad030e360c90682802203a35713acb098245e53a37faeac98754a29a7078db5ed6f2166f917e55b94484" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -7886,44 +7956,46 @@ "- 1201: the key does exist, but the generation is wrong", "- -32602: invalid parameters" ], - "example_json_request": [ + "json_example": [ { - "id": "example:deldatastore#1", - "method": "deldatastore", - "params": { - "key": "otherkey", - "generation": 1 + "request": { + "id": "example:deldatastore#1", + "method": "deldatastore", + "params": { + "key": "otherkey", + "generation": 1 + } + }, + "response": { + "key": [ + "otherkey" + ], + "generation": 1, + "hex": "6f746865726461746161", + "string": "otherdataa" } }, { - "id": "example:deldatastore#2", - "method": "deldatastore", - "params": { + "request": { + "id": "example:deldatastore#2", + "method": "deldatastore", + "params": { + "key": [ + "a" + ], + "generation": null + } + }, + "response": { "key": [ "a" ], - "generation": null + "generation": 0, + "hex": "6176616c", + "string": "aval" } } ], - "example_json_response": [ - { - "key": [ - "otherkey" - ], - "generation": 1, - "hex": "6f746865726461746161", - "string": "otherdataa" - }, - { - "key": [ - "a" - ], - "generation": 0, - "hex": "6176616c", - "string": "aval" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -7988,30 +8060,32 @@ "", "- 1401: The forward specified does not exist." ], - "example_json_request": [ + "json_example": [ { - "id": "example:delforward#1", - "method": "delforward", - "params": { - "in_channel": "103x1x0", - "in_htlc_id": 2, - "status": "local_failed" - } + "request": { + "id": "example:delforward#1", + "method": "delforward", + "params": { + "in_channel": "103x1x0", + "in_htlc_id": 2, + "status": "local_failed" + } + }, + "response": {} }, { - "id": "example:delforward#2", - "method": "delforward", - "params": [ - "103x1x0", - 1, - "failed" - ] + "request": { + "id": "example:delforward#2", + "method": "delforward", + "params": [ + "103x1x0", + 1, + "failed" + ] + }, + "response": {} } ], - "example_json_response": [ - {}, - {} - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -8301,51 +8375,53 @@ "- 906: The invoice *status* does not match the parameter. An error object will be returned as error *data*, containing *current_status* and *expected_status* fields. This is most likely due to the *status* of the invoice changing just before this command is invoked.", "- 908: The invoice already has no description, and *desconly* was set." ], - "example_json_request": [ + "json_example": [ { - "id": "example:delinvoice#1", - "method": "delinvoice", - "params": { + "request": { + "id": "example:delinvoice#1", + "method": "delinvoice", + "params": { + "label": "invlabel2", + "status": "unpaid", + "desconly": true + } + }, + "response": { "label": "invlabel2", + "bolt11": "lnbcrt420p1pja0tefsp5vvzg40t4g24l0eqk0jch7mc6jm3ec52ts8w8gwzpwtx9c8nv05rspp533e9csxurt7j9sn2cx7hsn6m00475qgrau8sux5r7djpdedwy2fshp5xqsmrtgfcwsnhxcxmf3tuc65kl6fxvqhvujfmxw2kpeh95yy2x8sxqyjw5qcqp99qxpqysgqgfjrz4q5zcq2lluxxg9h475mq2d3w0tpdstm5274zmhadjl8cqapylfskzk96apka5599a2flm90rmavsk7q8mhh87yle3sgh5vrlycq72fern", + "payment_hash": "8c725c40dc1afd22c26ac1bd784f5b7bebea0103ef0f0e1a83f36416e5ae2293", + "amount_msat": 42, "status": "unpaid", - "desconly": true + "expires_at": 1709238697, + "created_index": 3 } }, { - "id": "example:delinvoice#2", - "method": "delinvoice", - "params": { + "request": { + "id": "example:delinvoice#2", + "method": "delinvoice", + "params": { + "label": "keysend-1708640419.666098582", + "status": "paid", + "desconly": null + } + }, + "response": { "label": "keysend-1708640419.666098582", + "bolt11": "lnbcrt1pja0j9rsp5tg3zvj846gcdzw394njazq40s946sq2ur3hkl4xu4xudtjdtckxspp5fuunrfzsnyz2uxjmg2n95mqhghv4fpvv2kud3kvq4fkys3vmzu5sdqvddjhjum9dejqxqyjw5qcqp99qxpqysgqwt7r0gjlgt7zrfldc3um9myfc36acpqnsdn77c2m42facjtps30yufc5nsmwzhgexlj59f6xa5hess6e3tqrxynt9fejzj3rrshddtcqnappmj", + "payment_hash": "4f3931a4509904ae1a5b42a65a6c1745d954858c55b8d8d980aa6c48459b1729", "status": "paid", - "desconly": null + "pay_index": 1, + "amount_received_msat": 10000000, + "paid_at": 1708640419, + "payment_preimage": "b760af47f456a217e8dfda21a282f1f78c903487c1b21b3b318135f75aa3bf11", + "description": "keysend", + "expires_at": 1709245219, + "created_index": 1, + "updated_index": 1 } } ], - "example_json_response": [ - { - "label": "invlabel2", - "bolt11": "lnbcrt420p1pja0tefsp5vvzg40t4g24l0eqk0jch7mc6jm3ec52ts8w8gwzpwtx9c8nv05rspp533e9csxurt7j9sn2cx7hsn6m00475qgrau8sux5r7djpdedwy2fshp5xqsmrtgfcwsnhxcxmf3tuc65kl6fxvqhvujfmxw2kpeh95yy2x8sxqyjw5qcqp99qxpqysgqgfjrz4q5zcq2lluxxg9h475mq2d3w0tpdstm5274zmhadjl8cqapylfskzk96apka5599a2flm90rmavsk7q8mhh87yle3sgh5vrlycq72fern", - "payment_hash": "8c725c40dc1afd22c26ac1bd784f5b7bebea0103ef0f0e1a83f36416e5ae2293", - "amount_msat": 42, - "status": "unpaid", - "expires_at": 1709238697, - "created_index": 3 - }, - { - "label": "keysend-1708640419.666098582", - "bolt11": "lnbcrt1pja0j9rsp5tg3zvj846gcdzw394njazq40s946sq2ur3hkl4xu4xudtjdtckxspp5fuunrfzsnyz2uxjmg2n95mqhghv4fpvv2kud3kvq4fkys3vmzu5sdqvddjhjum9dejqxqyjw5qcqp99qxpqysgqwt7r0gjlgt7zrfldc3um9myfc36acpqnsdn77c2m42facjtps30yufc5nsmwzhgexlj59f6xa5hess6e3tqrxynt9fejzj3rrshddtcqnappmj", - "payment_hash": "4f3931a4509904ae1a5b42a65a6c1745d954858c55b8d8d980aa6c48459b1729", - "status": "paid", - "pay_index": 1, - "amount_received_msat": 10000000, - "paid_at": 1708640419, - "payment_preimage": "b760af47f456a217e8dfda21a282f1f78c903487c1b21b3b318135f75aa3bf11", - "description": "keysend", - "expires_at": 1709245219, - "created_index": 1, - "updated_index": 1 - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -8546,88 +8622,92 @@ "The returned format is the same as lightning-listsendpays(7). If the payment is a multi-part payment (MPP) the command return a list of payments will be returned -- one payment object for each partid." ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:delpay#1", - "method": "delpay", - "params": { - "payment_hash": "4fa2f1b001067ec06d7f95b8695b8acd9ef04c1b4d1110e3b94e1fa0687bb1e0", - "status": "complete" + "request": { + "id": "example:delpay#1", + "method": "delpay", + "params": { + "payment_hash": "4fa2f1b001067ec06d7f95b8695b8acd9ef04c1b4d1110e3b94e1fa0687bb1e0", + "status": "complete" + } + }, + "response": { + "payments": [ + { + "id": 1, + "payment_hash": "8dfd6538eeb33811c9114a75f792a143728d7f05643f38c3d574d3097e8910c0", + "destination": "0219f8900ee78a89f050c24d8b69492954f9fdbabed753710845eb75d3a75a5880", + "msatoshi": 1000, + "amount_msat": "1000msat", + "msatoshi_sent": 1000, + "amount_sent_msat": "1000msat", + "created_at": 1596224858, + "status": "complete", + "payment_preimage": "35bd4e2b481a1a84a22215b5372672cf81460a671816960ddb206464359e1822", + "bolt11": "lntb10n1p0jga20pp53h7k2w8wkvuprjg3ff6l0y4pgdeg6lc9vsln3s74wnfsjl5fzrqqdqdw3jhxazldahx2xqyjw5qcqp2sp5wut5jnhr6n7jd5747ky2g5flmw7hgx9yjnqzu60ps2jf6f7tc0us9qy9qsqu2a0k37nckl62005p69xavlkydkvhnypk4dphffy4x09zltwh9437ad7xkl83tefdarzhu5t30ju5s56wlrg97qkx404pq3srfc425cq3ke9af" + } + ] } }, { - "id": "example:delpay#2", - "method": "delpay", - "params": [ - "c9d4547473d0d646f1fdd8ca7f01803e4d31ceab01df33c79456f9c24b04034e", - "failed" - ] - }, - { - "id": "example:delpay#3", - "method": "delpay", - "params": { - "payment_hash": "bbc35e0a46d1483292a4ff8d4daaceaab8c3c084dd835be4128785b52e469c64", - "status": "complete", - "groupid": 1, - "partid": 1 + "request": { + "id": "example:delpay#2", + "method": "delpay", + "params": [ + "c9d4547473d0d646f1fdd8ca7f01803e4d31ceab01df33c79456f9c24b04034e", + "failed" + ] + }, + "response": { + "payments": [ + { + "created_index": 2, + "id": 2, + "payment_hash": "c9d4547473d0d646f1fdd8ca7f01803e4d31ceab01df33c79456f9c24b04034e", + "groupid": 1, + "updated_index": 2, + "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "amount_msat": 100000, + "amount_sent_msat": 100002, + "created_at": 1706316468, + "completed_at": 1706316471, + "status": "failed", + "bolt11": "lnbcrt1u1pjmg54nsp5ke626txv6wwwmqmpuy63t3jnu9hqxwj880zsfkkj7jjqagdaz2sqpp5e829garn6rtydu0amr987qvq8exnrn4tq80n83u52muuyjcyqd8qdq8v3jhxccxqyjw5qcqp99qxpqysgqalktfwy9svsamvvvrzzzzpdaa4rh7n6s5p7t9lx7qv0raz4vnm9knkh5ury3u5cmnhx2gms98nxkclm3833uhjrlnzmftc685vz2f0gpfnjy4y" + } + ] } - } - ], - "example_json_response": [ - { - "payments": [ - { - "id": 1, - "payment_hash": "8dfd6538eeb33811c9114a75f792a143728d7f05643f38c3d574d3097e8910c0", - "destination": "0219f8900ee78a89f050c24d8b69492954f9fdbabed753710845eb75d3a75a5880", - "msatoshi": 1000, - "amount_msat": "1000msat", - "msatoshi_sent": 1000, - "amount_sent_msat": "1000msat", - "created_at": 1596224858, - "status": "complete", - "payment_preimage": "35bd4e2b481a1a84a22215b5372672cf81460a671816960ddb206464359e1822", - "bolt11": "lntb10n1p0jga20pp53h7k2w8wkvuprjg3ff6l0y4pgdeg6lc9vsln3s74wnfsjl5fzrqqdqdw3jhxazldahx2xqyjw5qcqp2sp5wut5jnhr6n7jd5747ky2g5flmw7hgx9yjnqzu60ps2jf6f7tc0us9qy9qsqu2a0k37nckl62005p69xavlkydkvhnypk4dphffy4x09zltwh9437ad7xkl83tefdarzhu5t30ju5s56wlrg97qkx404pq3srfc425cq3ke9af" - } - ] - }, - { - "payments": [ - { - "created_index": 2, - "id": 2, - "payment_hash": "c9d4547473d0d646f1fdd8ca7f01803e4d31ceab01df33c79456f9c24b04034e", - "groupid": 1, - "updated_index": 2, - "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "amount_msat": 100000, - "amount_sent_msat": 100002, - "created_at": 1706316468, - "completed_at": 1706316471, - "status": "failed", - "bolt11": "lnbcrt1u1pjmg54nsp5ke626txv6wwwmqmpuy63t3jnu9hqxwj880zsfkkj7jjqagdaz2sqpp5e829garn6rtydu0amr987qvq8exnrn4tq80n83u52muuyjcyqd8qdq8v3jhxccxqyjw5qcqp99qxpqysgqalktfwy9svsamvvvrzzzzpdaa4rh7n6s5p7t9lx7qv0raz4vnm9knkh5ury3u5cmnhx2gms98nxkclm3833uhjrlnzmftc685vz2f0gpfnjy4y" - } - ] }, { - "payments": [ - { - "created_index": 3, - "id": 3, + "request": { + "id": "example:delpay#3", + "method": "delpay", + "params": { "payment_hash": "bbc35e0a46d1483292a4ff8d4daaceaab8c3c084dd835be4128785b52e469c64", - "groupid": 1, - "updated_index": 3, - "partid": 1, - "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "amount_msat": 100000, - "amount_sent_msat": 102100, - "created_at": 1708641193, - "completed_at": 1708641194, "status": "complete", - "payment_preimage": "a6ebb1cfbf69e76200f196f1eafd28a3d850633499c223a7eb7a7dba3b995286" + "groupid": 1, + "partid": 1 } - ] + }, + "response": { + "payments": [ + { + "created_index": 3, + "id": 3, + "payment_hash": "bbc35e0a46d1483292a4ff8d4daaceaab8c3c084dd835be4128785b52e469c64", + "groupid": 1, + "updated_index": 3, + "partid": 1, + "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "amount_msat": 100000, + "amount_sent_msat": 102100, + "created_at": 1708641193, + "completed_at": 1708641194, + "status": "complete", + "payment_preimage": "a6ebb1cfbf69e76200f196f1eafd28a3d850633499c223a7eb7a7dba3b995286" + } + ] + } } ], "errors": [ @@ -8678,18 +8758,18 @@ "response": { "properties": {} }, - "example_json_request": [ + "json_example": [ { - "id": "example:deprecations#1", - "method": "deprecations", - "params": { - "enable": false - } + "request": { + "id": "example:deprecations#1", + "method": "deprecations", + "params": { + "enable": false + } + }, + "response": {} } ], - "example_json_response": [ - {} - ], "errors": [ "On failure, one of the following error codes may be returned:", "", @@ -8783,36 +8863,45 @@ "- -32602: If the given parameters are missing or wrong.", "- -1: Catch all nonspecific errors, eg. `Multiple channels: please specify short_channel_id.` OR `No channels matching that peer_id and that short_channel_id.`, etc." ], - "example_json_request": [ + "json_example": [ { - "id": "example:dev-forget-channel#1", - "method": "dev-forget-channel", - "params": { - "id": "023d28435ce4b49f068c964aacbcb6dd114317a70f03e5a731ea72d25df1cff35b" + "description": [ + "Forget a channel by peer pubkey when only one channel exists with the peer." + ], + "request": { + "id": "example:dev-forget-channel#1", + "method": "dev-forget-channel", + "params": { + "id": "023d28435ce4b49f068c964aacbcb6dd114317a70f03e5a731ea72d25df1cff35b" + }, + "test": "test" + }, + "response": { + "forced": false, + "funding_unspent": true, + "funding_txid": "g6efdfb11bee25aa8b2249055a4162e4bd5fa9134bc865c3f054ca666d7ab744" } }, { - "id": "example:dev-forget-channel#2", - "method": "dev-forget-channel", - "params": { - "id": "0348e58210bbc128b1cc3cc1a520a654aaa01e5fe65c65341e21b61a1f09da94d5", - "short_channel_id": "337x1x0", - "force": true + "description": [ + "Forget a channel by short channel id when peer has multiple channels." + ], + "request": { + "id": "example:dev-forget-channel#2", + "method": "dev-forget-channel", + "params": { + "id": "0348e58210bbc128b1cc3cc1a520a654aaa01e5fe65c65341e21b61a1f09da94d5", + "short_channel_id": "337x1x0", + "force": true + } + }, + "response": { + "forced": true, + "funding_unspent": true, + "funding_txid": "b254f30a58adde9326b7e8a701f9d5b3c4db2160b58c5378afbe04448018ec8a" } } ], - "example_json_response": [ - { - "forced": false, - "funding_unspent": true, - "funding_txid": "g6efdfb11bee25aa8b2249055a4162e4bd5fa9134bc865c3f054ca666d7ab744" - }, - { - "forced": true, - "funding_unspent": true, - "funding_txid": "b254f30a58adde9326b7e8a701f9d5b3c4db2160b58c5378afbe04448018ec8a" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -8994,24 +9083,24 @@ "Note: the returned object is the same format as **listoffers**." ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:disableoffer#1", - "method": "disableoffer", - "params": { - "offer_id": "713a16ccd4eb10438bdcfbc2c8276be301020dd9d489c530773ba64f3b33307d" + "request": { + "id": "example:disableoffer#1", + "method": "disableoffer", + "params": { + "offer_id": "713a16ccd4eb10438bdcfbc2c8276be301020dd9d489c530773ba64f3b33307d" + } + }, + "response": { + "offer_id": "053a5c566fbea2681a5ff9c05a913da23e45b95d09ef5bd25d7d408f23da7084", + "active": false, + "single_use": false, + "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqvqcdgq2z9pk7enxv4jjqen0wgs8yatnw3ujz83qkc6rvp4j28rt3dtrn32zkvdy7efhnlrpr5rp5geqxs783wtlj550qs8czzku4nk3pqp6m593qxgunzuqcwkmgqkmp6ty0wyvjcqdguv3pnpukedwn6cr87m89t74h3auyaeg89xkvgzpac70z3m9rn5xzu28c", + "used": false } } ], - "example_json_response": [ - { - "offer_id": "053a5c566fbea2681a5ff9c05a913da23e45b95d09ef5bd25d7d408f23da7084", - "active": false, - "single_use": false, - "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqvqcdgq2z9pk7enxv4jjqen0wgs8yatnw3ujz83qkc6rvp4j28rt3dtrn32zkvdy7efhnlrpr5rp5geqxs783wtlj550qs8czzku4nk3pqp6m593qxgunzuqcwkmgqkmp6ty0wyvjcqdguv3pnpukedwn6cr87m89t74h3auyaeg89xkvgzpac70z3m9rn5xzu28c", - "used": false - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -9070,28 +9159,30 @@ "- -32602: If the given parameters are wrong.", "- -1: Catchall nonspecific error." ], - "example_json_request": [ + "json_example": [ { - "id": "example:disconnect#1", - "method": "disconnect", - "params": { - "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "force": false - } + "request": { + "id": "example:disconnect#1", + "method": "disconnect", + "params": { + "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "force": false + } + }, + "response": {} }, { - "id": "example:disconnect#2", - "method": "disconnect", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "force": true - } + "request": { + "id": "example:disconnect#2", + "method": "disconnect", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "force": true + } + }, + "response": {} } ], - "example_json_response": [ - {}, - {} - ], "author": [ "Michael Hawkins <>." ], @@ -9134,26 +9225,28 @@ } } }, - "example_json_request": [ - { - "id": "example:emergencyrecover#1", - "method": "emergencyrecover", - "params": "{}" - }, + "json_example": [ { - "id": "example:emergencyrecover#2", - "method": "emergencyrecover", - "params": "{}" - } - ], - "example_json_response": [ - { - "stubs": [] + "request": { + "id": "example:emergencyrecover#1", + "method": "emergencyrecover", + "params": "{}" + }, + "response": { + "stubs": [] + } }, { - "stubs": [ - "c00734472f344fdadd0bf787de182e5cf144ccda5d731b0f7c75befd1f1eff52" - ] + "request": { + "id": "example:emergencyrecover#2", + "method": "emergencyrecover", + "params": "{}" + }, + "response": { + "stubs": [ + "c00734472f344fdadd0bf787de182e5cf144ccda5d731b0f7c75befd1f1eff52" + ] + } } ], "author": [ @@ -9537,106 +9630,108 @@ "trivia": [ "In C-lightning we like to call the weight unit \"sipa\" in honor of Pieter Wuille, who uses the name \"sipa\" on IRC and elsewhere. Internally we call the *perkw* style as \"feerate per kilosipa\"." ], - "example_json_request": [ + "json_example": [ { - "id": "example:feerates#1", - "method": "feerates", - "params": { - "style": "perkw", - "urgent": null, - "normal": null, - "slow": null + "request": { + "id": "example:feerates#1", + "method": "feerates", + "params": { + "style": "perkw", + "urgent": null, + "normal": null, + "slow": null + } + }, + "response": { + "perkw": { + "opening": 1000000, + "mutual_close": 26362, + "unilateral_close": 26362, + "unilateral_anchor_close": 1000000, + "penalty": 26362, + "min_acceptable": 3750, + "max_acceptable": 10000000, + "floor": 253, + "estimates": [ + { + "blockcount": 2, + "feerate": 1000000, + "smoothed_feerate": 26362 + }, + { + "blockcount": 6, + "feerate": 1000000, + "smoothed_feerate": 26362 + }, + { + "blockcount": 12, + "feerate": 1000000, + "smoothed_feerate": 26362 + }, + { + "blockcount": 100, + "feerate": 1000000, + "smoothed_feerate": 26362 + } + ] + }, + "onchain_fee_estimates": { + "opening_channel_satoshis": 702000, + "mutual_close_satoshis": 17741, + "unilateral_close_satoshis": 1112000, + "unilateral_close_nonanchor_satoshis": 15764, + "htlc_timeout_satoshis": 17478, + "htlc_success_satoshis": 18532 + } } }, { - "id": "example:feerates#2", - "method": "feerates", - "params": { - "style": "perkb", - "urgent": null, - "normal": null, - "slow": null - } - } - ], - "example_json_response": [ - { - "perkw": { - "opening": 1000000, - "mutual_close": 26362, - "unilateral_close": 26362, - "unilateral_anchor_close": 1000000, - "penalty": 26362, - "min_acceptable": 3750, - "max_acceptable": 10000000, - "floor": 253, - "estimates": [ - { - "blockcount": 2, - "feerate": 1000000, - "smoothed_feerate": 26362 - }, - { - "blockcount": 6, - "feerate": 1000000, - "smoothed_feerate": 26362 - }, - { - "blockcount": 12, - "feerate": 1000000, - "smoothed_feerate": 26362 - }, - { - "blockcount": 100, - "feerate": 1000000, - "smoothed_feerate": 26362 - } - ] - }, - "onchain_fee_estimates": { - "opening_channel_satoshis": 702000, - "mutual_close_satoshis": 17741, - "unilateral_close_satoshis": 1112000, - "unilateral_close_nonanchor_satoshis": 15764, - "htlc_timeout_satoshis": 17478, - "htlc_success_satoshis": 18532 - } - }, - { - "perkb": { - "opening": 25000, - "mutual_close": 25000, - "unilateral_close": 44000, - "unilateral_anchor_close": 25000, - "penalty": 25000, - "min_acceptable": 12500, - "max_acceptable": 600000, - "floor": 1012, - "estimates": [ - { - "blockcount": 2, - "feerate": 60000, - "smoothed_feerate": 60000 - }, - { - "blockcount": 6, - "feerate": 44000, - "smoothed_feerate": 44000 - }, - { - "blockcount": 12, - "feerate": 25000, - "smoothed_feerate": 25000 - } - ] - }, - "onchain_fee_estimates": { - "opening_channel_satoshis": 4387, - "mutual_close_satoshis": 4206, - "unilateral_close_satoshis": 6578, - "unilateral_close_nonanchor_satoshis": 6578, - "htlc_timeout_satoshis": 7293, - "htlc_success_satoshis": 7733 + "request": { + "id": "example:feerates#2", + "method": "feerates", + "params": { + "style": "perkb", + "urgent": null, + "normal": null, + "slow": null + } + }, + "response": { + "perkb": { + "opening": 25000, + "mutual_close": 25000, + "unilateral_close": 44000, + "unilateral_anchor_close": 25000, + "penalty": 25000, + "min_acceptable": 12500, + "max_acceptable": 600000, + "floor": 1012, + "estimates": [ + { + "blockcount": 2, + "feerate": 60000, + "smoothed_feerate": 60000 + }, + { + "blockcount": 6, + "feerate": 44000, + "smoothed_feerate": 44000 + }, + { + "blockcount": 12, + "feerate": 25000, + "smoothed_feerate": 25000 + } + ] + }, + "onchain_fee_estimates": { + "opening_channel_satoshis": 4387, + "mutual_close_satoshis": 4206, + "unilateral_close_satoshis": 6578, + "unilateral_close_nonanchor_satoshis": 6578, + "htlc_timeout_satoshis": 7293, + "htlc_success_satoshis": 7733 + } } } ], @@ -9830,46 +9925,50 @@ "- 1004: The node making the offer returned an error message.", "- 1005: We timed out trying to fetch an invoice." ], - "example_json_request": [ + "json_example": [ { - "id": "example:fetchinvoice#1", - "method": "fetchinvoice", - "params": { - "offer": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqypq5zmnd9khqmr9yp6x2um5zcssxhftzxfdlwsnfcgw2sy8t5mxa0ytcdfat2nkdwqvpy9nnsa9mzza", - "payer_note": "Thanks for the fish!" + "request": { + "id": "example:fetchinvoice#1", + "method": "fetchinvoice", + "params": { + "offer": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqypq5zmnd9khqmr9yp6x2um5zcssxhftzxfdlwsnfcgw2sy8t5mxa0ytcdfat2nkdwqvpy9nnsa9mzza", + "payer_note": "Thanks for the fish!" + } + }, + "response": { + "invoice": "lni1qqgvcm9h7yakcmw4mzazspu8vfgpwq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqgzpg9hx6tdwpkx2gr5v4ehg93pqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky965pqqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy84sggren772kj8mau5jp86nc6fszx48rv7ep0quszyyls8rlld3sshjr94j9z5dpsku6mnypnx7u3qw35x2grxd9eksgdqnqp462c3jt0m5y6wzrj5pp6axehtez7r20265antsrqfpvuu8fwcshgr0tsv8e6829e8xmv7laz0kwhtlx6vtk8q3d6rtthdhtwvnn6j585szquc2t7us8kguxypzasg8ewkakgx2ny5ugks0f32x67sm9e5fms4asqrylajc2dqh8ag55mv5p5ghy3e2z8zwmllle8uu7jsxv5ke8d6rr5h7kthmz7ya0hxp4nt7elvw7vghcl6fgsuqqqqqqqqqqqqqqq9qqqqqqqqqqqqq8fykt06c5sqqqqqpfqyvhtunn4gyzy0lphn4wn6ctzlsajy46wscjcglf3hxcnvlaxqs3ydkhgaklsc42spq2czzq6a9vge9ha6zd8ppe2qsawnvm4u30p484d2we4cpsyskwwr5hvgthcyqyuen02ejwpa9cjjrttvp223yxsqkrwnlaszkhas84w0ape300ued4p75xu3cqtcg0cslsx9fvh7dhdqx565t6wa0alf6u2hug90j2hs", + "changes": {} } }, { - "id": "example:fetchinvoice#2", - "method": "fetchinvoice", - "params": { - "offer": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqypq5zmnd9khqmr9yp6x2um5zcssxhftzxfdlwsnfcgw2sy8t5mxa0ytcdfat2nkdwqvpy9nnsa9mzza", - "amount_msat": 3 + "request": { + "id": "example:fetchinvoice#2", + "method": "fetchinvoice", + "params": { + "offer": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqypq5zmnd9khqmr9yp6x2um5zcssxhftzxfdlwsnfcgw2sy8t5mxa0ytcdfat2nkdwqvpy9nnsa9mzza", + "amount_msat": 3 + } + }, + "response": { + "invoice": "lni1qqg0mfchkz0gkmn8zzu5zaxd0qvlzq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqgzpg9hx6tdwpkx2gr5v4ehg93pqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky965pqqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy84yqgrtqss8d4vgzd3286u9rk0zg9qr7a6z2xm6mjnz9pydztcn0j74tjvch0f5zvqxhftzxfdlwsnfcgw2sy8t5mxa0ytcdfat2nkdwqvpy9nnsa9mzzaqth4fzjqxxmsaxvc4v2urs6hsh6k0e564x00g68vuyp5w7yjedzxvqgr8ltzmj0n7ltxr0tz9rafn9zcy9jldjqfuf20w6gjmr7nj04d360sqvkdwprxn22dlp3xay9yq4nhrw2jm0c8t6r7japhdad6leawxyqzkg92tx8gqxp9f2d8j5k2axta0gr7yr9zrsqqqqqqqqqqqqqqq5qqqqqqqqqqqqqayjedltzjqqqqqq9yq3ja0jwj4qswt3kgs9mxq7gck66x60m5rndykpw3a7hf4ntlp9qe2vgwzzrvcwd2qypmqggrt543ryklhgf5uy89gzr46dnwhj9ux5744fmxhqxqjzeecwja3pwlqsxyjcdwur4hl4qf7nsjgg8euvy45lznufh5kydkwz6llsucuhvwp9ezeggaj3k057ge6ftvaffjkwn6j3y7faeuysrx3m2xccphu65sx", + "changes": {} } }, { - "id": "example:fetchinvoice#3", - "method": "fetchinvoice", - "params": { - "offer": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqypq5zmnd9khqmr9yp6x2um5zsqs593pqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4j", - "quantity": 2 + "request": { + "id": "example:fetchinvoice#3", + "method": "fetchinvoice", + "params": { + "offer": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqypq5zmnd9khqmr9yp6x2um5zsqs593pqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4j", + "quantity": 2 + } + }, + "response": { + "invoice": "lni1qqgd508mv9rpjg2ec8dr8qcslf2cjq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqgzpg9hx6tdwpkx2gr5v4ehg9qppgtzzq3dygmzpg6e53ll0aavg37gt3rvjg762vufygdqq4xprs0regcat9gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02cqsykppqfkyy6q8ry9pchxtuajh456hhcf7dxx733cx76etuv5ftfmfa2ymhgycqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jq6uhkeymz26zx7zgw4gdmw2vj9xqn4hu2sqxhp0pcgt87pf9chyfvqsywtejxjh603kx7am3zaf6d6xuumw30p8zmcdz7r95nn4lr92exk3qqe2x6xqwpdzh2zwq3vnyra8nfc6d7y6hegpkvc7p2nulj7hvhwl5hjfr23wn60mjftqspn7d4ejhrpsr5m2y8qqqqqqqqqqqqqqqpgqqqqqqqqqqqqp6f9jm7k9yqqqqqq2gpr96l9mt2pqxuyr0gqw92h0xz2y2uy5uxss4ujcac5jehj9ay2sxkapr80t5ha65qgykqssytfzxcs2xkdy0lml0tzy0jzugmyj8kjn8zfzrgq9fsgurc72x82e7pqxhl4u29cjluw5s8fwa9wtvh0qytr7vqk0vtndsz07mrrtmjw629m8mnqkjaf43kt889qeq2f7deu6t853lngpzclapt8nj0g528v9ay", + "changes": {} } } ], - "example_json_response": [ - { - "invoice": "lni1qqgvcm9h7yakcmw4mzazspu8vfgpwq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqgzpg9hx6tdwpkx2gr5v4ehg93pqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky965pqqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy84sggren772kj8mau5jp86nc6fszx48rv7ep0quszyyls8rlld3sshjr94j9z5dpsku6mnypnx7u3qw35x2grxd9eksgdqnqp462c3jt0m5y6wzrj5pp6axehtez7r20265antsrqfpvuu8fwcshgr0tsv8e6829e8xmv7laz0kwhtlx6vtk8q3d6rtthdhtwvnn6j585szquc2t7us8kguxypzasg8ewkakgx2ny5ugks0f32x67sm9e5fms4asqrylajc2dqh8ag55mv5p5ghy3e2z8zwmllle8uu7jsxv5ke8d6rr5h7kthmz7ya0hxp4nt7elvw7vghcl6fgsuqqqqqqqqqqqqqqq9qqqqqqqqqqqqq8fykt06c5sqqqqqpfqyvhtunn4gyzy0lphn4wn6ctzlsajy46wscjcglf3hxcnvlaxqs3ydkhgaklsc42spq2czzq6a9vge9ha6zd8ppe2qsawnvm4u30p484d2we4cpsyskwwr5hvgthcyqyuen02ejwpa9cjjrttvp223yxsqkrwnlaszkhas84w0ape300ued4p75xu3cqtcg0cslsx9fvh7dhdqx565t6wa0alf6u2hug90j2hs", - "changes": {} - }, - { - "invoice": "lni1qqg0mfchkz0gkmn8zzu5zaxd0qvlzq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqgzpg9hx6tdwpkx2gr5v4ehg93pqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky965pqqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy84yqgrtqss8d4vgzd3286u9rk0zg9qr7a6z2xm6mjnz9pydztcn0j74tjvch0f5zvqxhftzxfdlwsnfcgw2sy8t5mxa0ytcdfat2nkdwqvpy9nnsa9mzzaqth4fzjqxxmsaxvc4v2urs6hsh6k0e564x00g68vuyp5w7yjedzxvqgr8ltzmj0n7ltxr0tz9rafn9zcy9jldjqfuf20w6gjmr7nj04d360sqvkdwprxn22dlp3xay9yq4nhrw2jm0c8t6r7japhdad6leawxyqzkg92tx8gqxp9f2d8j5k2axta0gr7yr9zrsqqqqqqqqqqqqqqq5qqqqqqqqqqqqqayjedltzjqqqqqq9yq3ja0jwj4qswt3kgs9mxq7gck66x60m5rndykpw3a7hf4ntlp9qe2vgwzzrvcwd2qypmqggrt543ryklhgf5uy89gzr46dnwhj9ux5744fmxhqxqjzeecwja3pwlqsxyjcdwur4hl4qf7nsjgg8euvy45lznufh5kydkwz6llsucuhvwp9ezeggaj3k057ge6ftvaffjkwn6j3y7faeuysrx3m2xccphu65sx", - "changes": {} - }, - { - "invoice": "lni1qqgd508mv9rpjg2ec8dr8qcslf2cjq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqgzpg9hx6tdwpkx2gr5v4ehg9qppgtzzq3dygmzpg6e53ll0aavg37gt3rvjg762vufygdqq4xprs0regcat9gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02cqsykppqfkyy6q8ry9pchxtuajh456hhcf7dxx733cx76etuv5ftfmfa2ymhgycqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jq6uhkeymz26zx7zgw4gdmw2vj9xqn4hu2sqxhp0pcgt87pf9chyfvqsywtejxjh603kx7am3zaf6d6xuumw30p8zmcdz7r95nn4lr92exk3qqe2x6xqwpdzh2zwq3vnyra8nfc6d7y6hegpkvc7p2nulj7hvhwl5hjfr23wn60mjftqspn7d4ejhrpsr5m2y8qqqqqqqqqqqqqqqpgqqqqqqqqqqqqp6f9jm7k9yqqqqqq2gpr96l9mt2pqxuyr0gqw92h0xz2y2uy5uxss4ujcac5jehj9ay2sxkapr80t5ha65qgykqssytfzxcs2xkdy0lml0tzy0jzugmyj8kjn8zfzrgq9fsgurc72x82e7pqxhl4u29cjluw5s8fwa9wtvh0qytr7vqk0vtndsz07mrrtmjw629m8mnqkjaf43kt889qeq2f7deu6t853lngpzclapt8nj0g528v9ay", - "changes": {} - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -10105,67 +10204,69 @@ "lightning-cli -k fundchannel id=03f...fc1 amount=all feerate=normal utxos='[\"bcc1...39c:0\"]'", "```" ], - "example_json_request": [ + "json_example": [ { - "id": "example:fundchannel#1", - "method": "fundchannel", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount": 1000000, - "feerate": null, - "announce": true, - "minconf": null, - "utxos": null, - "push_msat": null, - "close_to": null, - "request_amt": null, - "compact_lease": null, - "mindepth": null, - "reserve": null + "request": { + "id": "example:fundchannel#1", + "method": "fundchannel", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount": 1000000, + "feerate": null, + "announce": true, + "minconf": null, + "utxos": null, + "push_msat": null, + "close_to": null, + "request_amt": null, + "compact_lease": null, + "mindepth": null, + "reserve": null + } + }, + "response": { + "tx": "020000000001014ca47b75e6982fce6b5ebb6e7ec163dc5b6bed1562934e6febe816103b2b207e0000000000fdffffff0240420f00000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd012f0f000000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a02473044022058fc4d51c8254d37b266d3db3f8fda7420882b6ec9226d66b8c0139f2707c09602205798d8ce23d4c692a7384362a2e0afd9703f062239a786d7a1840a28d3a1152e012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", + "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b", + "channel_id": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "outnum": 0 } }, { - "id": "example:fundchannel#2", - "method": "fundchannel", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount": 10000000, - "feerate": null, - "announce": true, - "minconf": null, - "utxos": null, - "push_msat": 1000000000, - "close_to": null, - "request_amt": null, - "compact_lease": null, - "mindepth": null, - "reserve": null, - "channel_type": null - } - } - ], - "example_json_response": [ - { - "tx": "020000000001014ca47b75e6982fce6b5ebb6e7ec163dc5b6bed1562934e6febe816103b2b207e0000000000fdffffff0240420f00000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd012f0f000000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a02473044022058fc4d51c8254d37b266d3db3f8fda7420882b6ec9226d66b8c0139f2707c09602205798d8ce23d4c692a7384362a2e0afd9703f062239a786d7a1840a28d3a1152e012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", - "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b", - "channel_id": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "outnum": 0 - }, - { - "tx": "0200000000010141cfa0e9957c7c6d0bb5069d92937f9545e6e6ee9b4650f47f509d5ea65df4690100000000fdffffff0280969800000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd4118530b0000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a0247304402206488c7dfbc4180781ed0d5ca7ff2c8ce134480c349d03978765053a393229d9a022066c75dee1f19b410ea1c7756d0cb2c097e52b13f4d9bbd033efa4ed95d817e14012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", - "txid": "6aa1231b6356777468a55aea1f49dad6415592aef6c1e652f8a64357c7235301", - "channel_id": "015323c75743a6f852e6c1f6ae925541d6da491fea5aa568747756631b23a16a", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] + "request": { + "id": "example:fundchannel#2", + "method": "fundchannel", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount": 10000000, + "feerate": null, + "announce": true, + "minconf": null, + "utxos": null, + "push_msat": 1000000000, + "close_to": null, + "request_amt": null, + "compact_lease": null, + "mindepth": null, + "reserve": null, + "channel_type": null + } }, - "outnum": 0 + "response": { + "tx": "0200000000010141cfa0e9957c7c6d0bb5069d92937f9545e6e6ee9b4650f47f509d5ea65df4690100000000fdffffff0280969800000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd4118530b0000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a0247304402206488c7dfbc4180781ed0d5ca7ff2c8ce134480c349d03978765053a393229d9a022066c75dee1f19b410ea1c7756d0cb2c097e52b13f4d9bbd033efa4ed95d817e14012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", + "txid": "6aa1231b6356777468a55aea1f49dad6415592aef6c1e652f8a64357c7235301", + "channel_id": "015323c75743a6f852e6c1f6ae925541d6da491fea5aa568747756631b23a16a", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "outnum": 0 + } } ], "errors": [ @@ -10230,30 +10331,32 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:fundchannel_cancel#1", - "method": "fundchannel_cancel", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" + "request": { + "id": "example:fundchannel_cancel#1", + "method": "fundchannel_cancel", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" + } + }, + "response": { + "cancelled": "Channel open canceled by RPC" } }, { - "id": "example:fundchannel_cancel#2", - "method": "fundchannel_cancel", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" + "request": { + "id": "example:fundchannel_cancel#2", + "method": "fundchannel_cancel", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" + } + }, + "response": { + "cancelled": "Channel open canceled by RPC(after fundchannel_complete)" } } ], - "example_json_response": [ - { - "cancelled": "Channel open canceled by RPC" - }, - { - "cancelled": "Channel open canceled by RPC(after fundchannel_complete)" - } - ], "errors": [ "On error the returned object will contain `code` and `message` properties, with `code` being one of the following:", "", @@ -10343,22 +10446,22 @@ "- 306: Unknown peer id.", "- 309: PSBT does not have a unique, correct output to fund the channel." ], - "example_json_request": [ + "json_example": [ { - "id": "example:fundchannel_complete#1", - "method": "fundchannel_complete", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "psbt": "cHNidP8BAIkCAAAAASYd4TeOHEIzrUbbELM2DK0IX09WaXqWsJFlLD455MPPAAAAAAD9////Av///wAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM1c8QUpAQAAACJRIH8AZYBKMKON4/oVmJVsVt6zy/+PkBPzziE+LtkuFvWXAAAAAAABAIMCAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/////wJRAP////8CAPIFKgEAAAAWABQ5FIjuMd8ar9WFRV9eGNLF+3RMcAAAAAAAAAAAJmokqiGp7eL2HD9x0d79P6mZ36NpU3VcaQaJeZlitIvr2DaXToz5AAAAAAEBHwDyBSoBAAAAFgAUORSI7jHfGq/VhUVfXhjSxft0THAiBgMegIxEPDa2OseVTaV6ANtSwQuoj/j2an7X/Is2EekvWBhhFDNgVAAAgAEAAIAAAACAAAAAAAAAAAAAAAEFIEm9AFgqUlJwbPFtyt3a9dzvb+nAGZiQ3CT1CImhjBFpIQdJvQBYKlJScGzxbcrd2vXc72/pwBmYkNwk9QiJoYwRaRkAYRQzYFYAAIABAACAAAAAgAEAAAAAAAAAAA==" + "request": { + "id": "example:fundchannel_complete#1", + "method": "fundchannel_complete", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "psbt": "cHNidP8BAIkCAAAAASYd4TeOHEIzrUbbELM2DK0IX09WaXqWsJFlLD455MPPAAAAAAD9////Av///wAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM1c8QUpAQAAACJRIH8AZYBKMKON4/oVmJVsVt6zy/+PkBPzziE+LtkuFvWXAAAAAAABAIMCAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/////wJRAP////8CAPIFKgEAAAAWABQ5FIjuMd8ar9WFRV9eGNLF+3RMcAAAAAAAAAAAJmokqiGp7eL2HD9x0d79P6mZ36NpU3VcaQaJeZlitIvr2DaXToz5AAAAAAEBHwDyBSoBAAAAFgAUORSI7jHfGq/VhUVfXhjSxft0THAiBgMegIxEPDa2OseVTaV6ANtSwQuoj/j2an7X/Is2EekvWBhhFDNgVAAAgAEAAIAAAACAAAAAAAAAAAAAAAEFIEm9AFgqUlJwbPFtyt3a9dzvb+nAGZiQ3CT1CImhjBFpIQdJvQBYKlJScGzxbcrd2vXc72/pwBmYkNwk9QiJoYwRaRkAYRQzYFYAAIABAACAAAAAgAEAAAAAAAAAAA==" + } + }, + "response": { + "channel_id": "049217e5035a4a60449c6382c445b5c105bd63588d66137ad0511c57a16db6d9", + "commitments_secured": true } } ], - "example_json_response": [ - { - "channel_id": "049217e5035a4a60449c6382c445b5c105bd63588d66137ad0511c57a16db6d9", - "commitments_secured": true - } - ], "author": [ "Lisa Neigut <> is mainly responsible." ], @@ -10566,53 +10669,55 @@ "- 306: Unknown peer id.", "- 312: Peer negotiated `option_dual_fund`, must use `openchannel_init` not `fundchannel_start`. (Only if ``experimental-dual-fund` is enabled)" ], - "example_json_request": [ - { - "id": "example:fundchannel_start#1", - "method": "fundchannel_start", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount": 16777216, - "feerate": null, - "announce": true, - "close_to": null, - "mindepth": null - } - }, + "json_example": [ { - "id": "example:fundchannel_start#2", - "method": "fundchannel_start", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount": "100000sat", - "feerate": null, - "announce": true, - "close_to": null, - "mindepth": null, - "channel_type": null + "request": { + "id": "example:fundchannel_start#1", + "method": "fundchannel_start", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount": 16777216, + "feerate": null, + "announce": true, + "close_to": null, + "mindepth": null + } + }, + "response": { + "funding_address": "bcrt1qtwxd8wg5eanumk86vfeujvp48hfkgannf77evggzct048wggsrxsum2pmm", + "scriptpubkey": "00205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd", + "warning_usage": "The funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed by running `fundchannel_complete`" } - } - ], - "example_json_response": [ - { - "funding_address": "bcrt1qtwxd8wg5eanumk86vfeujvp48hfkgannf77evggzct048wggsrxsum2pmm", - "scriptpubkey": "00205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd", - "warning_usage": "The funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed by running `fundchannel_complete`" }, { - "funding_address": "bcrt1qtwxd8wg5eanumk86vfeujvp48hfkgannf77evggzct048wggsrxsum2pmm", - "scriptpubkey": "00205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] + "request": { + "id": "example:fundchannel_start#2", + "method": "fundchannel_start", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount": "100000sat", + "feerate": null, + "announce": true, + "close_to": null, + "mindepth": null, + "channel_type": null + } }, - "warning_usage": "The funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed by running `fundchannel_complete`" + "response": { + "funding_address": "bcrt1qtwxd8wg5eanumk86vfeujvp48hfkgannf77evggzct048wggsrxsum2pmm", + "scriptpubkey": "00205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "warning_usage": "The funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed by running `fundchannel_complete`" + } } ], "author": [ @@ -10903,61 +11008,63 @@ "", "- -32602: If the given parameters are invalid." ], - "example_json_request": [ - { - "id": "example:funderupdate#1", - "method": "funderupdate", - "params": "{}" + "json_example": [ + { + "request": { + "id": "example:funderupdate#1", + "method": "funderupdate", + "params": "{}" + }, + "response": { + "summary": "match (100%)", + "policy": "match", + "policy_mod": 100, + "leases_only": true, + "min_their_funding_msat": 10000000, + "max_their_funding_msat": 4294967295000, + "per_channel_min_msat": 10000000, + "per_channel_max_msat": 4294967295000, + "reserve_tank_msat": 0, + "fuzz_percent": 0, + "fund_probability": 100, + "lease_fee_base_msat": 100000, + "lease_fee_basis": 100, + "funding_weight": 666, + "channel_fee_max_base_msat": 5000000, + "channel_fee_max_proportional_thousandths": 100, + "compact_lease": "029a00640064000000644c4b40" + } }, { - "id": "example:funderupdate#2", - "method": "funderupdate", - "params": { + "request": { + "id": "example:funderupdate#2", + "method": "funderupdate", + "params": { + "policy": "fixed", + "policy_mod": "50000sat", + "min_their_funding_msat": 1000, + "per_channel_min_msat": "1000sat", + "per_channel_max_msat": "500000sat", + "fund_probability": 100, + "fuzz_percent": 0, + "leases_only": false + } + }, + "response": { + "summary": "fixed (50000sat)", "policy": "fixed", - "policy_mod": "50000sat", + "policy_mod": 50000, + "leases_only": false, "min_their_funding_msat": 1000, - "per_channel_min_msat": "1000sat", - "per_channel_max_msat": "500000sat", - "fund_probability": 100, + "max_their_funding_msat": 4294967295000, + "per_channel_min_msat": 1000000, + "per_channel_max_msat": 500000000, + "reserve_tank_msat": 0, "fuzz_percent": 0, - "leases_only": false + "fund_probability": 100 } } ], - "example_json_response": [ - { - "summary": "match (100%)", - "policy": "match", - "policy_mod": 100, - "leases_only": true, - "min_their_funding_msat": 10000000, - "max_their_funding_msat": 4294967295000, - "per_channel_min_msat": 10000000, - "per_channel_max_msat": 4294967295000, - "reserve_tank_msat": 0, - "fuzz_percent": 0, - "fund_probability": 100, - "lease_fee_base_msat": 100000, - "lease_fee_basis": 100, - "funding_weight": 666, - "channel_fee_max_base_msat": 5000000, - "channel_fee_max_proportional_thousandths": 100, - "compact_lease": "029a00640064000000644c4b40" - }, - { - "summary": "fixed (50000sat)", - "policy": "fixed", - "policy_mod": 50000, - "leases_only": false, - "min_their_funding_msat": 1000, - "max_their_funding_msat": 4294967295000, - "per_channel_min_msat": 1000000, - "per_channel_max_msat": 500000000, - "reserve_tank_msat": 0, - "fuzz_percent": 0, - "fund_probability": 100 - } - ], "author": [ "Lisa Neigut <> is mainly responsible." ], @@ -11166,88 +11273,92 @@ "- -1: Catchall nonspecific error.", "- 301: Insufficient UTXOs to meet *satoshi* value." ], - "example_json_request": [ - { - "id": "example:fundpsbt#1", - "method": "fundpsbt", - "params": { - "satoshi": 16777216, - "feerate": "253perkw", - "startweight": 250, - "minconf": null, - "reserve": 0, - "locktime": null, - "min_witness_weight": null, - "excess_as_change": false - } - }, - { - "id": "example:fundpsbt#2", - "method": "fundpsbt", - "params": { - "satoshi": "all", - "feerate": "1000perkw", - "startweight": 1000, - "minconf": null, - "reserve": null, - "locktime": null, - "min_witness_weight": null, - "excess_as_change": false - } - }, + "json_example": [ { - "id": "example:fundpsbt#3", - "method": "fundpsbt", - "params": { - "satoshi": "109000sat", - "feerate": "slow", - "startweight": 166, - "minconf": null, - "reserve": null, - "locktime": null, - "min_witness_weight": null, - "excess_as_change": true + "request": { + "id": "example:fundpsbt#1", + "method": "fundpsbt", + "params": { + "satoshi": 16777216, + "feerate": "253perkw", + "startweight": 250, + "minconf": null, + "reserve": 0, + "locktime": null, + "min_witness_weight": null, + "excess_as_change": false + } + }, + "response": { + "psbt": "cHNidP8BADMCAAAAAWzmSFzhTtXBnQewytc32WaMwJSunScwsYndBNdU80JqAAAAAAD9////AGYAAAAAAQDeAgAAAAABAU1MpIJeOOzqAYVkZaytJCmzUadBVltKar8kWtzKSVeYAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFD8W5uBNZAxN6n1jqU62dxWQbyGAAkcwRAIgUK+vMOeWiDPiJM8fpgKCjjwXog4yfWPvtKES1ZZPaM8CIB3cgouGpV6Gc7nEvAu28Mg9tkAWt/Xl5FDOseEyeZqHASECTwjR0I3gLHdSW7jRmnVXdm0+MgJ1hihnqEfXYeFWA/NlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", + "feerate_per_kw": 253, + "estimated_final_weight": 521, + "excess_msat": 9999869000 } - } - ], - "example_json_response": [ - { - "psbt": "cHNidP8BADMCAAAAAWzmSFzhTtXBnQewytc32WaMwJSunScwsYndBNdU80JqAAAAAAD9////AGYAAAAAAQDeAgAAAAABAU1MpIJeOOzqAYVkZaytJCmzUadBVltKar8kWtzKSVeYAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFD8W5uBNZAxN6n1jqU62dxWQbyGAAkcwRAIgUK+vMOeWiDPiJM8fpgKCjjwXog4yfWPvtKES1ZZPaM8CIB3cgouGpV6Gc7nEvAu28Mg9tkAWt/Xl5FDOseEyeZqHASECTwjR0I3gLHdSW7jRmnVXdm0+MgJ1hihnqEfXYeFWA/NlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", - "feerate_per_kw": 253, - "estimated_final_weight": 521, - "excess_msat": 9999869000 }, { - "psbt": "cHNidP8BAF4CAAAAAfwbEpvpi6D14YV4VLnuVB47Y0uF41kXEyJRL4IusySSAQAAAAD9////ASICAAAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5nAAAAAAEA9gIAAAAAAQFEkxvLatohY6mw5gr5qG1aiArSrziFPR2YoqD21Hv+RAAAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNrz8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIEu1nfVRt9i+rFM219mwhMqdwJsqygWSWTFUS+cemdh6AiBG3Qo8g9J/aAMO2RHDsIBScscj6pTTIwZp7Gw8G3EOKAEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPZgAAAAEBK68/DwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", - "feerate_per_kw": 1000, - "estimated_final_weight": 1443, - "excess_msat": 997354000, - "change_outnum": 0, - "reservations": [ - { - "txid": "9224b32e822f5122131759e3854b633b1e54eeb9547885e1f5a08be99b121bfc", - "vout": 1, - "was_reserved": false, - "reserved": true, - "reserved_to_block": 175 + "request": { + "id": "example:fundpsbt#2", + "method": "fundpsbt", + "params": { + "satoshi": "all", + "feerate": "1000perkw", + "startweight": 1000, + "minconf": null, + "reserve": null, + "locktime": null, + "min_witness_weight": null, + "excess_as_change": false } - ] + }, + "response": { + "psbt": "cHNidP8BAF4CAAAAAfwbEpvpi6D14YV4VLnuVB47Y0uF41kXEyJRL4IusySSAQAAAAD9////ASICAAAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5nAAAAAAEA9gIAAAAAAQFEkxvLatohY6mw5gr5qG1aiArSrziFPR2YoqD21Hv+RAAAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNrz8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIEu1nfVRt9i+rFM219mwhMqdwJsqygWSWTFUS+cemdh6AiBG3Qo8g9J/aAMO2RHDsIBScscj6pTTIwZp7Gw8G3EOKAEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPZgAAAAEBK68/DwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", + "feerate_per_kw": 1000, + "estimated_final_weight": 1443, + "excess_msat": 997354000, + "change_outnum": 0, + "reservations": [ + { + "txid": "9224b32e822f5122131759e3854b633b1e54eeb9547885e1f5a08be99b121bfc", + "vout": 1, + "was_reserved": false, + "reserved": true, + "reserved_to_block": 175 + } + ] + } }, { - "psbt": "cHNidP8BAF4CAAAAAbEf44mT/BPDxLkUjKy1byWksyLyuM6hbe8shzEbbXhGAQAAAAD9////AU58DQAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5sAAAAAAEA9gIAAAAAAQEV9Sj1wfHqO/ECZeHp/u7cFL5eRaa1Vu4hXWbwH72pxgEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIGILT3DrcNn6/WKOhsxxKq7lDWq47dV0IjRhj0bYHs4yAiApzODtmrz7ifK32G81A2XbBxWboFk2vN4T3ng/hYmb1wEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPZgAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", - "feerate_per_kw": 3750, - "estimated_final_weight": 609, - "excess_msat": 0, - "change_outnum": 0, - "reservations": [ - { - "txid": "46786d1b31872cef6da1ceb8f222b3a4256fb5ac8c14b9c4c313fc9389e31fb1", - "vout": 1, - "was_reserved": false, - "reserved": true, - "reserved_to_block": 180 + "request": { + "id": "example:fundpsbt#3", + "method": "fundpsbt", + "params": { + "satoshi": "109000sat", + "feerate": "slow", + "startweight": 166, + "minconf": null, + "reserve": null, + "locktime": null, + "min_witness_weight": null, + "excess_as_change": true } - ] + }, + "response": { + "psbt": "cHNidP8BAF4CAAAAAbEf44mT/BPDxLkUjKy1byWksyLyuM6hbe8shzEbbXhGAQAAAAD9////AU58DQAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5sAAAAAAEA9gIAAAAAAQEV9Sj1wfHqO/ECZeHp/u7cFL5eRaa1Vu4hXWbwH72pxgEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIGILT3DrcNn6/WKOhsxxKq7lDWq47dV0IjRhj0bYHs4yAiApzODtmrz7ifK32G81A2XbBxWboFk2vN4T3ng/hYmb1wEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPZgAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", + "feerate_per_kw": 3750, + "estimated_final_weight": 609, + "excess_msat": 0, + "change_outnum": 0, + "reservations": [ + { + "txid": "46786d1b31872cef6da1ceb8f222b3a4256fb5ac8c14b9c4c313fc9389e31fb1", + "vout": 1, + "was_reserved": false, + "reserved": true, + "reserved_to_block": 180 + } + ] + } } ], "author": [ @@ -11626,52 +11737,52 @@ } } }, - "example_json_request": [ - { - "id": "example:getinfo#1", - "method": "getinfo", - "params": {} - } - ], - "example_json_response": [ + "json_example": [ { - "id": "02bf811f7571754f0b51e6d41a8885f5561041a7b14fac093e4cffb95749de1a8d", - "alias": "SLICKERGOPHER", - "color": "02bf81", - "num_peers": 0, - "num_pending_channels": 0, - "num_active_channels": 0, - "num_inactive_channels": 0, - "address": [ - { - "type": "torv3", - "address": "fp463inc4w3lamhhduytrwdwq6q6uzugtaeapylqfc43agrdnnqsheyd.onion", - "port": 9736 - }, - { - "type": "torv3", - "address": "ifnntp5ak4homxrti2fp6ckyllaqcike447ilqfrgdw64ayrmkyashid.onion", - "port": 9736 - } - ], - "binding": [ - { - "type": "ipv4", - "address": "127.0.0.1", - "port": 9736 + "request": { + "id": "example:getinfo#1", + "method": "getinfo", + "params": {} + }, + "response": { + "id": "02bf811f7571754f0b51e6d41a8885f5561041a7b14fac093e4cffb95749de1a8d", + "alias": "SLICKERGOPHER", + "color": "02bf81", + "num_peers": 0, + "num_pending_channels": 0, + "num_active_channels": 0, + "num_inactive_channels": 0, + "address": [ + { + "type": "torv3", + "address": "fp463inc4w3lamhhduytrwdwq6q6uzugtaeapylqfc43agrdnnqsheyd.onion", + "port": 9736 + }, + { + "type": "torv3", + "address": "ifnntp5ak4homxrti2fp6ckyllaqcike447ilqfrgdw64ayrmkyashid.onion", + "port": 9736 + } + ], + "binding": [ + { + "type": "ipv4", + "address": "127.0.0.1", + "port": 9736 + } + ], + "version": "v0.10.2", + "blockheight": 724302, + "network": "bitcoin", + "msatoshi_fees_collected": 0, + "fees_collected_msat": "0msat", + "lightning-dir": "/media/vincent/Maxtor/C-lightning/node/bitcoin", + "our_features": { + "init": "8828226aa2", + "node": "80008828226aa2", + "channel": "", + "invoice": "20024200" } - ], - "version": "v0.10.2", - "blockheight": 724302, - "network": "bitcoin", - "msatoshi_fees_collected": 0, - "fees_collected_msat": "0msat", - "lightning-dir": "/media/vincent/Maxtor/C-lightning/node/bitcoin", - "our_features": { - "init": "8828226aa2", - "node": "80008828226aa2", - "channel": "", - "invoice": "20024200" } } ], @@ -11907,12 +12018,31 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:getlog#1", - "method": "getlog", - "params": { - "level": "debug" + "request": { + "id": "example:getlog#1", + "method": "getlog", + "params": { + "level": "debug" + } + }, + "response": { + "created_at": "1598192543.820753463", + "bytes_used": 89285843, + "bytes_max": 104857600, + "log": [ + { + "type": "SKIPPED", + "num_skipped": 45 + }, + { + "type": "INFO", + "time": "0.453627568", + "source": "plugin-autopilot.py", + "log": "RPCmethod'autopilot-run-once'doesnothaveadocstring." + } + ] } } ], @@ -11921,25 +12051,6 @@ "", "- -32602: Error in given parameters." ], - "example_json_response": [ - { - "created_at": "1598192543.820753463", - "bytes_used": 89285843, - "bytes_max": 104857600, - "log": [ - { - "type": "SKIPPED", - "num_skipped": 45 - }, - { - "type": "INFO", - "time": "0.453627568", - "source": "plugin-autopilot.py", - "log": "RPCmethod'autopilot-run-once'doesnothaveadocstring." - } - ] - } - ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." @@ -12302,79 +12413,81 @@ "", "The default for lightning-pay(7) is 10, which starts to become a major factor for larger amounts, and is basically ignored for tiny ones." ], - "example_json_request": [ - { - "id": "example:getroute#1", - "method": "getroute", - "params": { - "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "amount_msat": 50000000, - "riskfactor": 1, - "cltv": 9, - "fromid": null, - "fuzzpercent": null, - "exclude": null, - "maxhops": null - } - }, - { - "id": "example:getroute#2", - "method": "getroute", - "params": { - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "amount_msat": "50000sat", - "riskfactor": 10 - } - } - ], - "example_json_response": [ + "json_example": [ { - "route": [ - { - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "channel": "103x3x0", - "direction": 1, - "amount_msat": 50001002, - "delay": 21, - "style": "tlv" - }, - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "channel": "103x1x0", - "direction": 1, - "amount_msat": 50000501, - "delay": 15, - "style": "tlv" - }, - { + "request": { + "id": "example:getroute#1", + "method": "getroute", + "params": { "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "channel": "103x2x0", - "direction": 0, "amount_msat": 50000000, - "delay": 9, - "style": "tlv" + "riskfactor": 1, + "cltv": 9, + "fromid": null, + "fuzzpercent": null, + "exclude": null, + "maxhops": null } - ] + }, + "response": { + "route": [ + { + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "channel": "103x3x0", + "direction": 1, + "amount_msat": 50001002, + "delay": 21, + "style": "tlv" + }, + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "channel": "103x1x0", + "direction": 1, + "amount_msat": 50000501, + "delay": 15, + "style": "tlv" + }, + { + "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "channel": "103x2x0", + "direction": 0, + "amount_msat": 50000000, + "delay": 9, + "style": "tlv" + } + ] + } }, { - "route": [ - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "channel": "103x2x0", - "direction": 1, - "amount_msat": 50051000, - "delay": 15, - "style": "tlv" - }, - { + "request": { + "id": "example:getroute#2", + "method": "getroute", + "params": { "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "channel": "103x1x0", - "direction": 0, - "amount_msat": 50000000, - "delay": 9, - "style": "tlv" + "amount_msat": "50000sat", + "riskfactor": 10 } - ] + }, + "response": { + "route": [ + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "channel": "103x2x0", + "direction": 1, + "amount_msat": 50051000, + "delay": 15, + "style": "tlv" + }, + { + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "channel": "103x1x0", + "direction": 0, + "amount_msat": 50000000, + "delay": 9, + "style": "tlv" + } + ] + } } ], "author": [ @@ -12465,19 +12578,45 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:help#1", - "method": "help", - "params": { - "command": "pay" + "request": { + "id": "example:help#1", + "method": "help", + "params": { + "command": "pay" + } + }, + "response": { + "help": [ + { + "command": "pay bolt11 [amount_msat] [label] [riskfactor] [maxfeepercent] [retry_for] [maxdelay] [exemptfee] [localinvreqid] [exclude] [maxfee] [description] [dev_use_shadow]", + "category": "plugin", + "description": "Send payment specified by {bolt11}", + "verbose": "Attempt to pay the {bolt11} invoice." + } + ], + "format-hint": "simple" } }, { - "id": "example:help#2", - "method": "help", - "params": { - "command": "dev" + "request": { + "id": "example:help#2", + "method": "help", + "params": { + "command": "dev" + } + }, + "response": { + "help": [ + { + "command": "dev subcommand=crash|rhash|slowcmd", + "category": "developer", + "description": "Developer command test multiplexer", + "verbose": "dev rhash {secret}\n\tShow SHA256 of {secret}\ndev crash\n\tCrash lightningd by calling fatal()\ndev slowcmd {msec}\n\tTorture test for slow commands, optional {msec}\n" + } + ], + "format-hint": "simple" } } ], @@ -12486,30 +12625,6 @@ "", "- -32602: Error in given parameters." ], - "example_json_response": [ - { - "help": [ - { - "command": "pay bolt11 [amount_msat] [label] [riskfactor] [maxfeepercent] [retry_for] [maxdelay] [exemptfee] [localinvreqid] [exclude] [maxfee] [description] [dev_use_shadow]", - "category": "plugin", - "description": "Send payment specified by {bolt11}", - "verbose": "Attempt to pay the {bolt11} invoice." - } - ], - "format-hint": "simple" - }, - { - "help": [ - { - "command": "dev subcommand=crash|rhash|slowcmd", - "category": "developer", - "description": "Developer command test multiplexer", - "verbose": "dev rhash {secret}\n\tShow SHA256 of {secret}\ndev crash\n\tCrash lightningd by calling fatal()\ndev slowcmd {msec}\n\tTorture test for slow commands, optional {msec}\n" - } - ], - "format-hint": "simple" - } - ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." @@ -12708,58 +12823,60 @@ "- 901: An invoice with the given *preimage* already exists.", "- 902: None of the specified *exposeprivatechannels* were usable." ], - "example_json_request": [ + "json_example": [ { - "id": "example:invoice#1", - "method": "invoice", - "params": { - "amount_msat": 11000000, - "label": "xEoCR94SIz6UIRUEkxum", - "description": [ - "XEoCR94SIz6UIRUEkxum." - ], - "expiry": null, - "fallbacks": null, - "preimage": null, - "exposeprivatechannels": null, - "cltv": null, - "deschashonly": null + "request": { + "id": "example:invoice#1", + "method": "invoice", + "params": { + "amount_msat": 11000000, + "label": "xEoCR94SIz6UIRUEkxum", + "description": [ + "XEoCR94SIz6UIRUEkxum." + ], + "expiry": null, + "fallbacks": null, + "preimage": null, + "exposeprivatechannels": null, + "cltv": null, + "deschashonly": null + } + }, + "response": { + "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", + "expires_at": 1706757730, + "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", + "payment_secret": "82644944d3f70d42aad1d5f7b5d7a629e7afa30b529cc952a4c59fc0e3790ea2", + "created_index": 1, + "warning_deadends": "Insufficient incoming capacity, once dead-end peers were excluded" } }, { - "id": "example:invoice#2", - "method": "invoice", - "params": { - "amount_msat": 100, - "label": "8", - "description": "inv", - "expiry": null, - "fallbacks": null, - "preimage": null, - "exposeprivatechannels": null, - "cltv": null, - "deschashonly": null + "request": { + "id": "example:invoice#2", + "method": "invoice", + "params": { + "amount_msat": 100, + "label": "8", + "description": "inv", + "expiry": null, + "fallbacks": null, + "preimage": null, + "exposeprivatechannels": null, + "cltv": null, + "deschashonly": null + } + }, + "response": { + "payment_hash": "f59ae0204dfe8e913207ea36646255b9d2c7c8229e8693d30547fc622eddb6b4", + "expires_at": 1709229182, + "bolt11": "lnbcrt1n1pja0z07sp5n8fk890nrq7zlcue0lgu7cduaaz765u5rg0kcud4amphuppu8wxspp57kdwqgzdl68fzvs8agmxgcj4h8fv0jpzn6rf85c9gl7xytkak66qdq9d9h8vxqyjw5qcqp99qxpqysgqrneaxh0plvjft457yv3q92rak57a6xw33m6phr0mrsy69sudzgez3adkzdsgwzy32z5usjpxm4rjgcg70h047wf0pgc4l9gyaj2h9ssqcrtv32", + "payment_secret": "99d36395f3183c2fe3997fd1cf61bcef45ed53941a1f6c71b5eec37e043c3b8d", + "created_index": 9, + "warning_capacity": "Insufficient incoming channel capacity to pay invoice" } } ], - "example_json_response": [ - { - "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "expires_at": 1706757730, - "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", - "payment_secret": "82644944d3f70d42aad1d5f7b5d7a629e7afa30b529cc952a4c59fc0e3790ea2", - "created_index": 1, - "warning_deadends": "Insufficient incoming capacity, once dead-end peers were excluded" - }, - { - "payment_hash": "f59ae0204dfe8e913207ea36646255b9d2c7c8229e8693d30547fc622eddb6b4", - "expires_at": 1709229182, - "bolt11": "lnbcrt1n1pja0z07sp5n8fk890nrq7zlcue0lgu7cduaaz765u5rg0kcud4amphuppu8wxspp57kdwqgzdl68fzvs8agmxgcj4h8fv0jpzn6rf85c9gl7xytkak66qdq9d9h8vxqyjw5qcqp99qxpqysgqrneaxh0plvjft457yv3q92rak57a6xw33m6phr0mrsy69sudzgez3adkzdsgwzy32z5usjpxm4rjgcg70h047wf0pgc4l9gyaj2h9ssqcrtv32", - "payment_secret": "99d36395f3183c2fe3997fd1cf61bcef45ed53941a1f6c71b5eec37e043c3b8d", - "created_index": 9, - "warning_capacity": "Insufficient incoming channel capacity to pay invoice" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -12881,26 +12998,26 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:invoicerequest#1", - "method": "invoicerequest", - "params": { - "amount": "10000sat", - "description": "simple test", - "issuer": "clightning test suite" + "request": { + "id": "example:invoicerequest#1", + "method": "invoicerequest", + "params": { + "amount": "10000sat", + "description": "simple test", + "issuer": "clightning test suite" + } + }, + "response": { + "invreq_id": "715484ead84bcdae5b33e3015c686fa1bdd4ae9ade3c4729b58257a98cfcd9b5", + "active": true, + "single_use": true, + "bolt12": "lnr1qqgteyhfyp40c79a5y3gfe33nxfs6zstwd5k6urvv5s8getnwsfp2cmvd9nksarwd9hxwgr5v4ehggrnw45hge2syqrzymjxzydqkkw24ufxqslttwlj3s608f0rx2slc7etw0833zgs75srnztgqkppqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq633uzq99smfawuu6pz0zh9jl6dl8v25u3kzes975x2j9tr0qp0ux0tlzcxjrgehxh9luz5vwjpk92tys9f9zlm038krcz4uqfxgelwf43tgfc", + "used": false } } ], - "example_json_response": [ - { - "invreq_id": "715484ead84bcdae5b33e3015c686fa1bdd4ae9ade3c4729b58257a98cfcd9b5", - "active": true, - "single_use": true, - "bolt12": "lnr1qqgteyhfyp40c79a5y3gfe33nxfs6zstwd5k6urvv5s8getnwsfp2cmvd9nksarwd9hxwgr5v4ehggrnw45hge2syqrzymjxzydqkkw24ufxqslttwlj3s608f0rx2slc7etw0833zgs75srnztgqkppqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq633uzq99smfawuu6pz0zh9jl6dl8v25u3kzes975x2j9tr0qp0ux0tlzcxjrgehxh9luz5vwjpk92tys9f9zlm038krcz4uqfxgelwf43tgfc", - "used": false - } - ], "errors": [ "On failure, an error is returned and no `invoice_request` is created. If the lightning process fails before responding, the caller should use lightning-listinvoicerequests(7) to query whether it was created or not.", "", @@ -13128,99 +13245,103 @@ "*failcode*: The failure code, as per BOLT #4.", "*channel_update*: The hex string of the *channel_update* message received from the remote node. Only present if error is from the remote node and the *failcode* has the `UPDATE` bit set, as per BOLT #4." ], - "example_json_request": [ + "json_example": [ { - "id": "example:keysend#1", - "method": "keysend", - "params": { + "request": { + "id": "example:keysend#1", + "method": "keysend", + "params": { + "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "amount_msat": 10000, + "label": null, + "maxfeepercent": null, + "retry_for": null, + "maxdelay": null, + "exemptfee": null, + "extratlvs": null + } + }, + "response": { "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "payment_hash": "b6f88603008a9f7dd84b1b94c7b972c8efbaf0b86c8d3c04512955992da9028e", + "created_at": 1706315742.6861734, + "parts": 1, "amount_msat": 10000, - "label": null, - "maxfeepercent": null, - "retry_for": null, - "maxdelay": null, - "exemptfee": null, - "extratlvs": null + "amount_sent_msat": 10001, + "payment_preimage": "7178cf708e34dce816fc35aa692a65e1f85b92ae03bbc8ae6543302511823174", + "status": "complete" } }, { - "id": "example:keysend#2", - "method": "keysend", - "params": { + "request": { + "id": "example:keysend#2", + "method": "keysend", + "params": { + "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "amount_msat": 10000000, + "label": null, + "maxfeepercent": null, + "retry_for": null, + "maxdelay": null, + "exemptfee": null, + "extratlvs": { + "133773310": "68656c6c6f776f726c64", + "133773312": "66696c7465726d65" + } + } + }, + "response": { "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "payment_hash": "e8474eea8d5673e8407ef5f4924e58479b51a68afd136384683d5d6a97c9520d", + "created_at": 1708640424.1810749, + "parts": 1, "amount_msat": 10000000, - "label": null, - "maxfeepercent": null, - "retry_for": null, - "maxdelay": null, - "exemptfee": null, - "extratlvs": { - "133773310": "68656c6c6f776f726c64", - "133773312": "66696c7465726d65" - } + "amount_sent_msat": 10000000, + "payment_preimage": "40e47272ea7da20c57a2381d81a5513ec03bd8ead9d51fbd2a91ec76d3f4bcbf", + "status": "complete" } }, { - "id": "example:keysend#3", - "method": "keysend", - "params": { + "request": { + "id": "example:keysend#3", + "method": "keysend", + "params": { + "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "amount_msat": 10000, + "routehints": [ + [ + { + "scid": "4615051x2233541x57738", + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "feebase": 1, + "feeprop": 10, + "expirydelta": 9 + } + ], + [ + { + "scid": "1x2x3", + "id": "020202020202020202020202020202020202020202020202020202020202020202", + "feebase": 1, + "feeprop": 1, + "expirydelta": 9 + } + ] + ] + } + }, + "response": { "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "payment_hash": "56e12e6f45120bef7385c9bf307319eaa6a1b9160cdb3e62a3f492abf5bfa4bc", + "created_at": 1708640437.2895157, + "parts": 1, "amount_msat": 10000, - "routehints": [ - [ - { - "scid": "4615051x2233541x57738", - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "feebase": 1, - "feeprop": 10, - "expirydelta": 9 - } - ], - [ - { - "scid": "1x2x3", - "id": "020202020202020202020202020202020202020202020202020202020202020202", - "feebase": 1, - "feeprop": 1, - "expirydelta": 9 - } - ] - ] + "amount_sent_msat": 10001, + "payment_preimage": "682870b8f96e2aed1c86694dbb2c3e64cd396b9bba9fafd824d90eb0bd371b85", + "status": "complete" } } ], - "example_json_response": [ - { - "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "payment_hash": "b6f88603008a9f7dd84b1b94c7b972c8efbaf0b86c8d3c04512955992da9028e", - "created_at": 1706315742.6861734, - "parts": 1, - "amount_msat": 10000, - "amount_sent_msat": 10001, - "payment_preimage": "7178cf708e34dce816fc35aa692a65e1f85b92ae03bbc8ae6543302511823174", - "status": "complete" - }, - { - "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "payment_hash": "e8474eea8d5673e8407ef5f4924e58479b51a68afd136384683d5d6a97c9520d", - "created_at": 1708640424.1810749, - "parts": 1, - "amount_msat": 10000000, - "amount_sent_msat": 10000000, - "payment_preimage": "40e47272ea7da20c57a2381d81a5513ec03bd8ead9d51fbd2a91ec76d3f4bcbf", - "status": "complete" - }, - { - "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "payment_hash": "56e12e6f45120bef7385c9bf307319eaa6a1b9160cdb3e62a3f492abf5bfa4bc", - "created_at": 1708640437.2895157, - "parts": 1, - "amount_msat": 10000, - "amount_sent_msat": 10001, - "payment_preimage": "682870b8f96e2aed1c86694dbb2c3e64cd396b9bba9fafd824d90eb0bd371b85", - "status": "complete" - } - ], "author": [ "Christian Decker <> is mainly responsible." ], @@ -13407,69 +13528,71 @@ "", "- -32602: If the given parameters are wrong." ], - "example_json_request": [ - { - "id": "example:listchannels#1", - "method": "listchannels", - "params": { - "short_channel_id": "103x1x0", - "source": null, - "destination": null - } - }, + "json_example": [ { - "id": "example:listchannels#2", - "method": "listchannels", - "params": { - "short_channel_id": null, - "source": null, - "destination": null + "request": { + "id": "example:listchannels#1", + "method": "listchannels", + "params": { + "short_channel_id": "103x1x0", + "source": null, + "destination": null + } + }, + "response": { + "channels": [] } - } - ], - "example_json_response": [ - { - "channels": [] }, { - "channels": [ - { - "source": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "short_channel_id": "103x1x0", - "direction": 0, - "public": true, - "amount_msat": 1000000000, - "message_flags": 1, - "channel_flags": 0, - "active": true, - "last_update": 1706153393, - "base_fee_millisatoshi": 1, - "fee_per_millionth": 10, - "delay": 6, - "htlc_minimum_msat": 0, - "htlc_maximum_msat": 990000000, - "features": "" - }, - { - "source": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "short_channel_id": "103x1x0", - "direction": 1, - "public": true, - "amount_msat": 1000000000, - "message_flags": 1, - "channel_flags": 1, - "active": true, - "last_update": 1706153393, - "base_fee_millisatoshi": 1, - "fee_per_millionth": 10, - "delay": 6, - "htlc_minimum_msat": 0, - "htlc_maximum_msat": 990000000, - "features": "" + "request": { + "id": "example:listchannels#2", + "method": "listchannels", + "params": { + "short_channel_id": null, + "source": null, + "destination": null } - ] + }, + "response": { + "channels": [ + { + "source": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "short_channel_id": "103x1x0", + "direction": 0, + "public": true, + "amount_msat": 1000000000, + "message_flags": 1, + "channel_flags": 0, + "active": true, + "last_update": 1706153393, + "base_fee_millisatoshi": 1, + "fee_per_millionth": 10, + "delay": 6, + "htlc_minimum_msat": 0, + "htlc_maximum_msat": 990000000, + "features": "" + }, + { + "source": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "short_channel_id": "103x1x0", + "direction": 1, + "public": true, + "amount_msat": 1000000000, + "message_flags": 1, + "channel_flags": 1, + "active": true, + "last_update": 1706153393, + "base_fee_millisatoshi": 1, + "fee_per_millionth": 10, + "delay": 6, + "htlc_minimum_msat": 0, + "htlc_maximum_msat": 990000000, + "features": "" + } + ] + } } ], "author": [ @@ -16208,462 +16331,466 @@ "- **value_bool** (boolean, optional): for boolean options" ] }, - "example_json_request": [ - { - "id": "example:listconfigs#1", - "method": "listconfigs", - "params": { - "config": "network" - } - }, - { - "id": "example:listconfigs#2", - "method": "listconfigs", - "params": { - "config": null - } - }, - { - "id": "example:listconfigs#3", - "method": "listconfigs", - "params": { - "config": "experimental-dual-fund" - } - } - ], - "errors": [ - "On failure, one of the following error codes may be returned:", - "", - "- -32602: Error in given parameters or field with *config* name doesn't exist." - ], - "example_json_response": [ + "json_example": [ { - "#version": "v0.9.0-1", - "lightning-dir": "/media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev", - "network": "testnet", - "allow-deprecated-apis": true, - "rpc-file": "lightning-rpc", - "plugins": [ - { - "path": "/home/vincent/Github/plugins/sauron/sauron.py", - "name": "sauron.py", - "options": { - "sauron-api-endpoint": "http://blockstream.info/testnet/api/", - "sauron-tor-proxy": "" - } - }, - { - "path": "/home/vincent/Github/reckless/reckless.py", - "name": "reckless.py" + "request": { + "id": "example:listconfigs#1", + "method": "listconfigs", + "params": { + "config": "network" } - ], - "important-plugins": [ - { - "path": "/home/vincent/Github/lightning/lightningd/../plugins/autoclean", - "name": "autoclean", - "options": { - "autocleaninvoice-cycle": null, - "autocleaninvoice-expired-by": null + }, + "response": { + "#version": "v0.9.0-1", + "lightning-dir": "/media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev", + "network": "testnet", + "allow-deprecated-apis": true, + "rpc-file": "lightning-rpc", + "plugins": [ + { + "path": "/home/vincent/Github/plugins/sauron/sauron.py", + "name": "sauron.py", + "options": { + "sauron-api-endpoint": "http://blockstream.info/testnet/api/", + "sauron-tor-proxy": "" + } + }, + { + "path": "/home/vincent/Github/reckless/reckless.py", + "name": "reckless.py" } - }, - { - "path": "/home/vincent/Github/lightning/lightningd/../plugins/fundchannel", - "name": "fundchannel" - }, - { - "path": "/home/vincent/Github/lightning/lightningd/../plugins/keysend", - "name": "keysend" - }, - { - "path": "/home/vincent/Github/lightning/lightningd/../plugins/pay", - "name": "pay", - "options": { - "disable-mpp": false + ], + "important-plugins": [ + { + "path": "/home/vincent/Github/lightning/lightningd/../plugins/autoclean", + "name": "autoclean", + "options": { + "autocleaninvoice-cycle": null, + "autocleaninvoice-expired-by": null + } + }, + { + "path": "/home/vincent/Github/lightning/lightningd/../plugins/fundchannel", + "name": "fundchannel" + }, + { + "path": "/home/vincent/Github/lightning/lightningd/../plugins/keysend", + "name": "keysend" + }, + { + "path": "/home/vincent/Github/lightning/lightningd/../plugins/pay", + "name": "pay", + "options": { + "disable-mpp": false + } } + ], + "important-plugin": "/home/vincent/Github/lightning/lightningd/../plugins/pay", + "plugin": "/home/vincent/Github/reckless/reckless.py", + "disable-plugin": [ + "bcli" + ], + "always-use-proxy": false, + "daemon": "false", + "wallet": "sqlite3:///media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev/testnet/lightningd.sqlite3", + "wumbo": true, + "rgb": "03ad98", + "alias": "BRUCEWAYN-TES-DEV", + "pid-file": "/media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev/lightningd-testne...", + "ignore-fee-limits": true, + "watchtime-blocks": 6, + "max-locktime-blocks": 2016, + "funding-confirms": 1, + "commit-fee-min": 0, + "commit-fee-max": 0, + "cltv-delta": 6, + "cltv-final": 10, + "commit-time": 10, + "fee-base": 1, + "rescan": 30, + "fee-per-satoshi": 10, + "max-concurrent-htlcs": 483, + "min-capacity-sat": 10000, + "addr": "autotor:127.0.0.1:9051", + "bind-addr": "127.0.0.1:9735", + "announce-addr": "fp463inc4w3lamhhduytrwdwq6q6uzugtaeapylqfc43agrdnnqsheyd.onion:9735", + "offline": "false", + "autolisten": true, + "proxy": "127.0.0.1:9050", + "disable-dns": "false", + "encrypted-hsm": false, + "rpc-file-mode": "0600", + "log-level": "DEBUG", + "log-prefix": "lightningd" + } + }, + { + "request": { + "id": "example:listconfigs#2", + "method": "listconfigs", + "params": { + "config": null } - ], - "important-plugin": "/home/vincent/Github/lightning/lightningd/../plugins/pay", - "plugin": "/home/vincent/Github/reckless/reckless.py", - "disable-plugin": [ - "bcli" - ], - "always-use-proxy": false, - "daemon": "false", - "wallet": "sqlite3:///media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev/testnet/lightningd.sqlite3", - "wumbo": true, - "rgb": "03ad98", - "alias": "BRUCEWAYN-TES-DEV", - "pid-file": "/media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev/lightningd-testne...", - "ignore-fee-limits": true, - "watchtime-blocks": 6, - "max-locktime-blocks": 2016, - "funding-confirms": 1, - "commit-fee-min": 0, - "commit-fee-max": 0, - "cltv-delta": 6, - "cltv-final": 10, - "commit-time": 10, - "fee-base": 1, - "rescan": 30, - "fee-per-satoshi": 10, - "max-concurrent-htlcs": 483, - "min-capacity-sat": 10000, - "addr": "autotor:127.0.0.1:9051", - "bind-addr": "127.0.0.1:9735", - "announce-addr": "fp463inc4w3lamhhduytrwdwq6q6uzugtaeapylqfc43agrdnnqsheyd.onion:9735", - "offline": "false", - "autolisten": true, - "proxy": "127.0.0.1:9050", - "disable-dns": "false", - "encrypted-hsm": false, - "rpc-file-mode": "0600", - "log-level": "DEBUG", - "log-prefix": "lightningd" - }, - { - "configs": { - "developer": { - "set": true, - "source": "cmdline" - }, - "lightning-dir": { - "value_str": "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/", - "source": "cmdline" - }, - "network": { - "value_str": "regtest", - "source": "cmdline" - }, - "testnet": { - "set": false, - "source": "default" - }, - "signet": { - "set": false, - "source": "default" - }, - "mainnet": { - "set": false, - "source": "default" - }, - "regtest": { - "set": false, - "source": "default" - }, - "rpc-file": { - "value_str": "lightning-rpc", - "source": "default" - }, - "allow-deprecated-apis": { - "value_bool": false, - "source": "cmdline" - }, - "plugin": { - "values_str": [ - "~/lightning/target/debug/examples/cln-plugin-startup" - ], - "sources": [ - "cmdline" - ] - }, - "plugin-dir": { - "values_str": [], - "sources": [] - }, - "clear-plugins": { - "set": false, - "source": "default" - }, - "disable-plugin": { - "values_str": [], - "sources": [] - }, - "important-plugin": { - "values_str": [], - "sources": [] - }, - "always-use-proxy": { - "value_bool": false, - "source": "default" - }, - "daemon": { - "set": false, - "source": "default" - }, - "experimental-dual-fund": { - "set": false, - "source": "default" - }, - "experimental-splicing": { - "set": false, - "source": "default" - }, - "experimental-onion-messages": { - "set": false, - "source": "default" - }, - "experimental-offers": { - "set": false, - "source": "default" - }, - "experimental-shutdown-wrong-funding": { - "set": false, - "source": "default" - }, - "experimental-peer-storage": { - "set": false, - "source": "default" - }, - "experimental-quiesce": { - "set": false, - "source": "default" - }, - "experimental-anchors": { - "set": false, - "source": "default" - }, - "rgb": { - "value_str": "0266e4", - "source": "default" - }, - "alias": { - "value_str": "JUNIORBEAM-1-102-g7549e10-modded", - "source": "default" - }, - "pid-file": { - "value_str": "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/lightningd-regtest.pid", - "source": "default" - }, - "ignore-fee-limits": { - "value_bool": false, - "source": "cmdline" - }, - "watchtime-blocks": { - "value_int": 5, - "source": "cmdline" - }, - "max-locktime-blocks": { - "value_int": 2016, - "source": "default" - }, - "funding-confirms": { - "value_int": 1, - "source": "default" - }, - "require-confirmed-inputs": { - "value_bool": false, - "source": "default" - }, - "cltv-delta": { - "value_int": 6, - "source": "cmdline" - }, - "cltv-final": { - "value_int": 5, - "source": "cmdline" - }, - "commit-time": { - "value_int": 10, - "source": "default" - }, - "fee-base": { - "value_int": 1, - "source": "default" - }, - "rescan": { - "value_int": 1, - "source": "cmdline" - }, - "fee-per-satoshi": { - "value_int": 10, - "source": "default" - }, - "htlc-minimum-msat": { - "value_msat": 0, - "source": "default" - }, - "htlc-maximum-msat": { - "value_msat": 18446744073709552000, - "source": "default" - }, - "max-concurrent-htlcs": { - "value_int": 483, - "source": "default" - }, - "max-dust-htlc-exposure-msat": { - "value_msat": 50000000, - "source": "default" - }, - "min-capacity-sat": { - "value_int": 10000, - "source": "default", - "dynamic": true - }, - "addr": { - "values_str": [ - "127.0.0.1:33157" - ], - "sources": [ - "cmdline" - ] - }, - "bind-addr": { - "values_str": [], - "sources": [] - }, - "announce-addr": { - "values_str": [], - "sources": [] - }, - "announce-addr-discovered": { - "value_str": "auto", - "source": "default" - }, - "announce-addr-discovered-port": { - "value_int": 19846, - "source": "default" - }, - "offline": { - "set": false, - "source": "default" - }, - "autolisten": { - "value_bool": false, - "source": "default" - }, - "accept-htlc-tlv-type": { - "values_int": [], - "sources": [] - }, - "disable-dns": { - "set": true, - "source": "cmdline" - }, - "encrypted-hsm": { - "set": false, - "source": "default" - }, - "rpc-file-mode": { - "value_str": "0600", - "source": "default" - }, - "commit-fee": { - "value_int": 100, - "source": "default" - }, - "commit-feerate-offset": { - "value_int": 5, - "source": "default" - }, - "min-emergency-msat": { - "value_msat": 25000000, - "source": "default" - }, - "subdaemon": { - "values_str": [], - "sources": [] - }, - "experimental-upgrade-protocol": { - "set": false, - "source": "default" - }, - "invoices-onchain-fallback": { - "set": false, - "source": "default" - }, - "log-level": { - "value_str": "debug", - "source": "cmdline" - }, - "log-timestamps": { - "value_bool": true, - "source": "default" - }, - "log-prefix": { - "value_str": "lightningd-1 ", - "source": "cmdline" - }, - "log-file": { - "values_str": [ - "-", - "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/log" - ], - "sources": [ - "cmdline", - "cmdline" - ] - }, - "dev-no-plugin-checksum": { - "set": true, - "source": "cmdline" - }, - "dev-no-reconnect": { - "set": true, - "source": "cmdline" - }, - "dev-fail-on-subdaemon-fail": { - "set": true, - "source": "cmdline" - }, - "dev-bitcoind-poll": { - "value_int": 1, - "source": "cmdline" - }, - "dev-fast-gossip": { - "set": true, - "source": "cmdline" - }, - "renepay-debug-mcf": { - "set": false, - "source": "default", - "plugin": "~/lightning/plugins/cln-renepay" - }, - "renepay-debug-payflow": { - "set": false, - "source": "default", - "plugin": "~/lightning/plugins/cln-renepay" - }, - "test-option": { - "value_int": 31337, - "source": "cmdline", - "plugin": "~/lightning/target/debug/examples/cln-plugin-startup" - }, - "bitcoin-datadir": { - "value_str": "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/", - "source": "cmdline", - "plugin": "~/lightning/plugins/bcli" - }, - "bitcoin-rpcuser": { - "value_str": "rpcuser", - "source": "cmdline", - "plugin": "~/lightning/plugins/bcli" - }, - "bitcoin-rpcpassword": { - "value_str": "rpcpass", - "source": "cmdline", - "plugin": "~/lightning/plugins/bcli" - }, - "bitcoin-rpcport": { - "value_int": 51309, - "source": "cmdline", - "plugin": "~/lightning/plugins/bcli" - }, - "disable-mpp": { - "set": false, - "source": "default", - "plugin": "~/lightning/plugins/pay" + }, + "response": { + "configs": { + "developer": { + "set": true, + "source": "cmdline" + }, + "lightning-dir": { + "value_str": "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/", + "source": "cmdline" + }, + "network": { + "value_str": "regtest", + "source": "cmdline" + }, + "testnet": { + "set": false, + "source": "default" + }, + "signet": { + "set": false, + "source": "default" + }, + "mainnet": { + "set": false, + "source": "default" + }, + "regtest": { + "set": false, + "source": "default" + }, + "rpc-file": { + "value_str": "lightning-rpc", + "source": "default" + }, + "allow-deprecated-apis": { + "value_bool": false, + "source": "cmdline" + }, + "plugin": { + "values_str": [ + "~/lightning/target/debug/examples/cln-plugin-startup" + ], + "sources": [ + "cmdline" + ] + }, + "plugin-dir": { + "values_str": [], + "sources": [] + }, + "clear-plugins": { + "set": false, + "source": "default" + }, + "disable-plugin": { + "values_str": [], + "sources": [] + }, + "important-plugin": { + "values_str": [], + "sources": [] + }, + "always-use-proxy": { + "value_bool": false, + "source": "default" + }, + "daemon": { + "set": false, + "source": "default" + }, + "experimental-dual-fund": { + "set": false, + "source": "default" + }, + "experimental-splicing": { + "set": false, + "source": "default" + }, + "experimental-onion-messages": { + "set": false, + "source": "default" + }, + "experimental-offers": { + "set": false, + "source": "default" + }, + "experimental-shutdown-wrong-funding": { + "set": false, + "source": "default" + }, + "experimental-peer-storage": { + "set": false, + "source": "default" + }, + "experimental-quiesce": { + "set": false, + "source": "default" + }, + "experimental-anchors": { + "set": false, + "source": "default" + }, + "rgb": { + "value_str": "0266e4", + "source": "default" + }, + "alias": { + "value_str": "JUNIORBEAM-1-102-g7549e10-modded", + "source": "default" + }, + "pid-file": { + "value_str": "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/lightningd-regtest.pid", + "source": "default" + }, + "ignore-fee-limits": { + "value_bool": false, + "source": "cmdline" + }, + "watchtime-blocks": { + "value_int": 5, + "source": "cmdline" + }, + "max-locktime-blocks": { + "value_int": 2016, + "source": "default" + }, + "funding-confirms": { + "value_int": 1, + "source": "default" + }, + "require-confirmed-inputs": { + "value_bool": false, + "source": "default" + }, + "cltv-delta": { + "value_int": 6, + "source": "cmdline" + }, + "cltv-final": { + "value_int": 5, + "source": "cmdline" + }, + "commit-time": { + "value_int": 10, + "source": "default" + }, + "fee-base": { + "value_int": 1, + "source": "default" + }, + "rescan": { + "value_int": 1, + "source": "cmdline" + }, + "fee-per-satoshi": { + "value_int": 10, + "source": "default" + }, + "htlc-minimum-msat": { + "value_msat": 0, + "source": "default" + }, + "htlc-maximum-msat": { + "value_msat": 18446744073709552000, + "source": "default" + }, + "max-concurrent-htlcs": { + "value_int": 483, + "source": "default" + }, + "max-dust-htlc-exposure-msat": { + "value_msat": 50000000, + "source": "default" + }, + "min-capacity-sat": { + "value_int": 10000, + "source": "default", + "dynamic": true + }, + "addr": { + "values_str": [ + "127.0.0.1:33157" + ], + "sources": [ + "cmdline" + ] + }, + "bind-addr": { + "values_str": [], + "sources": [] + }, + "announce-addr": { + "values_str": [], + "sources": [] + }, + "announce-addr-discovered": { + "value_str": "auto", + "source": "default" + }, + "announce-addr-discovered-port": { + "value_int": 19846, + "source": "default" + }, + "offline": { + "set": false, + "source": "default" + }, + "autolisten": { + "value_bool": false, + "source": "default" + }, + "accept-htlc-tlv-type": { + "values_int": [], + "sources": [] + }, + "disable-dns": { + "set": true, + "source": "cmdline" + }, + "encrypted-hsm": { + "set": false, + "source": "default" + }, + "rpc-file-mode": { + "value_str": "0600", + "source": "default" + }, + "commit-fee": { + "value_int": 100, + "source": "default" + }, + "commit-feerate-offset": { + "value_int": 5, + "source": "default" + }, + "min-emergency-msat": { + "value_msat": 25000000, + "source": "default" + }, + "subdaemon": { + "values_str": [], + "sources": [] + }, + "experimental-upgrade-protocol": { + "set": false, + "source": "default" + }, + "invoices-onchain-fallback": { + "set": false, + "source": "default" + }, + "log-level": { + "value_str": "debug", + "source": "cmdline" + }, + "log-timestamps": { + "value_bool": true, + "source": "default" + }, + "log-prefix": { + "value_str": "lightningd-1 ", + "source": "cmdline" + }, + "log-file": { + "values_str": [ + "-", + "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/log" + ], + "sources": [ + "cmdline", + "cmdline" + ] + }, + "dev-no-plugin-checksum": { + "set": true, + "source": "cmdline" + }, + "dev-no-reconnect": { + "set": true, + "source": "cmdline" + }, + "dev-fail-on-subdaemon-fail": { + "set": true, + "source": "cmdline" + }, + "dev-bitcoind-poll": { + "value_int": 1, + "source": "cmdline" + }, + "dev-fast-gossip": { + "set": true, + "source": "cmdline" + }, + "renepay-debug-mcf": { + "set": false, + "source": "default", + "plugin": "~/lightning/plugins/cln-renepay" + }, + "renepay-debug-payflow": { + "set": false, + "source": "default", + "plugin": "~/lightning/plugins/cln-renepay" + }, + "test-option": { + "value_int": 31337, + "source": "cmdline", + "plugin": "~/lightning/target/debug/examples/cln-plugin-startup" + }, + "bitcoin-datadir": { + "value_str": "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/", + "source": "cmdline", + "plugin": "~/lightning/plugins/bcli" + }, + "bitcoin-rpcuser": { + "value_str": "rpcuser", + "source": "cmdline", + "plugin": "~/lightning/plugins/bcli" + }, + "bitcoin-rpcpassword": { + "value_str": "rpcpass", + "source": "cmdline", + "plugin": "~/lightning/plugins/bcli" + }, + "bitcoin-rpcport": { + "value_int": 51309, + "source": "cmdline", + "plugin": "~/lightning/plugins/bcli" + }, + "disable-mpp": { + "set": false, + "source": "default", + "plugin": "~/lightning/plugins/pay" + } } } }, { - "configs": { - "experimental-dual-fund": { - "set": false, - "source": "default" + "request": { + "id": "example:listconfigs#3", + "method": "listconfigs", + "params": { + "config": "experimental-dual-fund" + } + }, + "response": { + "configs": { + "experimental-dual-fund": { + "set": false, + "source": "default" + } } } } ], + "errors": [ + "On failure, one of the following error codes may be returned:", + "", + "- -32602: Error in given parameters or field with *config* name doesn't exist." + ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." @@ -16759,39 +16886,41 @@ "", "- -32602: invalid parameters." ], - "example_json_request": [ + "json_example": [ { - "id": "example:listdatastore#1", - "method": "listdatastore", - "params": { - "key": [ - "commando" - ] - } - }, - { - "id": "example:listdatastore#2", - "method": "listdatastore", - "params": { - "key": "otherkey" + "request": { + "id": "example:listdatastore#1", + "method": "listdatastore", + "params": { + "key": [ + "commando" + ] + } + }, + "response": { + "datastore": [] } - } - ], - "example_json_response": [ - { - "datastore": [] }, { - "datastore": [ - { - "key": [ - "otherkey" - ], - "generation": 0, - "hex": "6f7468657264617461", - "string": "otherdata" + "request": { + "id": "example:listdatastore#2", + "method": "listdatastore", + "params": { + "key": "otherkey" } - ] + }, + "response": { + "datastore": [ + { + "key": [ + "otherkey" + ], + "generation": 0, + "hex": "6f7468657264617461", + "string": "otherdata" + } + ] + } } ], "author": [ @@ -17163,89 +17292,91 @@ "out_msat": {}, "resolved_time": {} } - } - } - ] - } - } - } - }, - "example_json_request": [ - { - "id": "example:listforwards#1", - "method": "listforwards", - "params": { - "status": null, - "in_channel": null, - "out_channel": null, - "index": null, - "start": null, - "limit": null - } - }, - { - "id": "example:listforwards#2", - "method": "listforwards", - "params": { - "in_channel": "0x1x2", - "out_channel": "0x2x3", - "status": "settled" + } + } + ] + } } } - ], - "example_json_response": [ + }, + "json_example": [ { - "forwards": [ - { - "created_index": 1, - "updated_index": 1, - "in_channel": "103x1x0", - "in_htlc_id": 0, - "out_channel": "104x1x0", - "out_htlc_id": 0, - "in_msat": 100001001, - "out_msat": 100000000, - "fee_msat": 1001, - "status": "settled", - "style": "tlv", - "received_time": 1706229285.5934534, - "resolved_time": 1706229288.830004 - }, - { - "created_index": 2, - "updated_index": 2, - "in_channel": "103x1x0", - "in_htlc_id": 1, - "out_channel": "105x1x0", - "out_htlc_id": 0, - "in_msat": 100001001, - "out_msat": 100000000, - "fee_msat": 1001, - "status": "failed", - "style": "tlv", - "received_time": 1706229290.0289993, - "resolved_time": 1706229292.9487684 - }, - { - "created_index": 3, - "updated_index": 3, - "in_channel": "103x1x0", - "in_htlc_id": 2, - "out_channel": "106x1x0", - "out_htlc_id": 0, - "in_msat": 100001000, - "out_msat": 99999999, - "fee_msat": 1001, - "status": "local_failed", - "failcode": 16392, - "failreason": "WIRE_PERMANENT_CHANNEL_FAILURE", - "style": "tlv", - "received_time": 1706229295.3175724 + "request": { + "id": "example:listforwards#1", + "method": "listforwards", + "params": { + "status": null, + "in_channel": null, + "out_channel": null, + "index": null, + "start": null, + "limit": null } - ] + }, + "response": { + "forwards": [ + { + "created_index": 1, + "updated_index": 1, + "in_channel": "103x1x0", + "in_htlc_id": 0, + "out_channel": "104x1x0", + "out_htlc_id": 0, + "in_msat": 100001001, + "out_msat": 100000000, + "fee_msat": 1001, + "status": "settled", + "style": "tlv", + "received_time": 1706229285.5934534, + "resolved_time": 1706229288.830004 + }, + { + "created_index": 2, + "updated_index": 2, + "in_channel": "103x1x0", + "in_htlc_id": 1, + "out_channel": "105x1x0", + "out_htlc_id": 0, + "in_msat": 100001001, + "out_msat": 100000000, + "fee_msat": 1001, + "status": "failed", + "style": "tlv", + "received_time": 1706229290.0289993, + "resolved_time": 1706229292.9487684 + }, + { + "created_index": 3, + "updated_index": 3, + "in_channel": "103x1x0", + "in_htlc_id": 2, + "out_channel": "106x1x0", + "out_htlc_id": 0, + "in_msat": 100001000, + "out_msat": 99999999, + "fee_msat": 1001, + "status": "local_failed", + "failcode": 16392, + "failreason": "WIRE_PERMANENT_CHANNEL_FAILURE", + "style": "tlv", + "received_time": 1706229295.3175724 + } + ] + } }, { - "forwards": [] + "request": { + "id": "example:listforwards#2", + "method": "listforwards", + "params": { + "in_channel": "0x1x2", + "out_channel": "0x2x3", + "status": "settled" + } + }, + "response": { + "forwards": [] + } } ], "author": [ @@ -17590,40 +17721,40 @@ } } }, - "example_json_request": [ - { - "id": "example:listfunds#1", - "method": "listfunds", - "params": { - "spent": null - } - } - ], - "example_json_response": [ + "json_example": [ { - "outputs": [ - { - "txid": "0f184b101569bf777af3449fa266948a9d55768f97867e48416a2c92858dd1bc", - "output": 1, - "amount_msat": 1111111000, - "scriptpubkey": "001401fad90abcd66697e2592164722de4a95ebee165", - "address": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf", - "status": "confirmed", - "blockheight": 102, - "reserved": false - }, - { - "txid": "4bee7dc3a28f2434e9bb3e9aaab418dd276485a8705b0f787bf741d3f979ec3b", - "output": 1, - "amount_msat": 1111111000, - "scriptpubkey": "001401fad90abcd66697e2592164722de4a95ebee165", - "address": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf", - "status": "confirmed", - "blockheight": 102, - "reserved": false + "request": { + "id": "example:listfunds#1", + "method": "listfunds", + "params": { + "spent": null } - ], - "channels": [] + }, + "response": { + "outputs": [ + { + "txid": "0f184b101569bf777af3449fa266948a9d55768f97867e48416a2c92858dd1bc", + "output": 1, + "amount_msat": 1111111000, + "scriptpubkey": "001401fad90abcd66697e2592164722de4a95ebee165", + "address": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf", + "status": "confirmed", + "blockheight": 102, + "reserved": false + }, + { + "txid": "4bee7dc3a28f2434e9bb3e9aaab418dd276485a8705b0f787bf741d3f979ec3b", + "output": 1, + "amount_msat": 1111111000, + "scriptpubkey": "001401fad90abcd66697e2592164722de4a95ebee165", + "address": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf", + "status": "confirmed", + "blockheight": 102, + "reserved": false + } + ], + "channels": [] + } } ], "author": [ @@ -17752,138 +17883,142 @@ } } }, - "example_json_request": [ - { - "id": "example:listhtlcs#1", - "method": "listhtlcs", - "params": "{}" - }, + "json_example": [ { - "id": "example:listhtlcs#2", - "method": "listhtlcs", - "params": [ - "103x2x0" - ] - }, - { - "id": "example:listhtlcs#3", - "method": "listhtlcs", - "params": [ - "436c2658eb4f4689b42ff11b8b05f31ba09860d0df7168085e0796cdf40f85e0" - ] - } - ], - "example_json_response": [ - { - "htlcs": [ - { - "short_channel_id": "103x1x0", - "id": 0, - "expiry": 117, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "d2668e77c5a2220496e813de36f1fc09ba804b16af4c6bb38299d8a6eb8a5f10", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x1x0", - "id": 1, - "expiry": 117, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "286e08ac8f575f10508d751fcfc93871b4344271967c7b9e5eacb3f3573b8307", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x1x0", - "id": 2, - "expiry": 135, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "3e4baa750ee3dfb934578f041ccb40b87432bf37ec65c9d7bce5ff28fecbd95f", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x1x0", - "id": 3, - "expiry": 135, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "4c3ce32565dc10ef2bd230c32802ce2fe8b007208c0a90757aa289f75c994d49", - "state": "SENT_REMOVE_REVOCATION" - } - ] + "request": { + "id": "example:listhtlcs#1", + "method": "listhtlcs", + "params": "{}" + }, + "response": { + "htlcs": [ + { + "short_channel_id": "103x1x0", + "id": 0, + "expiry": 117, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "d2668e77c5a2220496e813de36f1fc09ba804b16af4c6bb38299d8a6eb8a5f10", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x1x0", + "id": 1, + "expiry": 117, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "286e08ac8f575f10508d751fcfc93871b4344271967c7b9e5eacb3f3573b8307", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x1x0", + "id": 2, + "expiry": 135, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "3e4baa750ee3dfb934578f041ccb40b87432bf37ec65c9d7bce5ff28fecbd95f", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x1x0", + "id": 3, + "expiry": 135, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "4c3ce32565dc10ef2bd230c32802ce2fe8b007208c0a90757aa289f75c994d49", + "state": "SENT_REMOVE_REVOCATION" + } + ] + } }, { - "htlcs": [ - { - "short_channel_id": "103x2x0", - "id": 0, - "expiry": 117, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "12bb14b1d119e1ae0759e5ff6f1f6653e3fd8f71ea59411500d2871404a47a98", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x2x0", - "id": 1, - "expiry": 117, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "57d950209cc0b4fcc5e3027569232f96cf83ef85314c6b139a5713848d811a66", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x2x0", - "id": 2, - "expiry": 135, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "45ad4654715411a07a0ad6ec3f4bfaa918c90e3d1934b10b1c1c5846523ddd7f", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x2x0", - "id": 3, - "expiry": 135, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "cc0dcd214aa71c62bfba711a0746da821f2cdba1770b11c225920bdde12c931e", - "state": "RCVD_REMOVE_ACK_REVOCATION" - } - ] + "request": { + "id": "example:listhtlcs#2", + "method": "listhtlcs", + "params": [ + "103x2x0" + ] + }, + "response": { + "htlcs": [ + { + "short_channel_id": "103x2x0", + "id": 0, + "expiry": 117, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "12bb14b1d119e1ae0759e5ff6f1f6653e3fd8f71ea59411500d2871404a47a98", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x2x0", + "id": 1, + "expiry": 117, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "57d950209cc0b4fcc5e3027569232f96cf83ef85314c6b139a5713848d811a66", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x2x0", + "id": 2, + "expiry": 135, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "45ad4654715411a07a0ad6ec3f4bfaa918c90e3d1934b10b1c1c5846523ddd7f", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x2x0", + "id": 3, + "expiry": 135, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "cc0dcd214aa71c62bfba711a0746da821f2cdba1770b11c225920bdde12c931e", + "state": "RCVD_REMOVE_ACK_REVOCATION" + } + ] + } }, { - "htlcs": [ - { - "short_channel_id": "103x1x0", - "id": 0, - "expiry": 124, - "direction": "out", - "amount_msat": 1001, - "payment_hash": "2ab653668c8017ff2f36ac36678a8da04e11380bd9580a2926b170523b0c6e3b", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x1x0", - "id": 1, - "expiry": 124, - "direction": "out", - "amount_msat": 2001, - "payment_hash": "92f889cb2e48aa28e1e577228b907cdbcc371a2c018e9c8f60fa7036e232cf1d", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x1x0", - "id": 2, - "expiry": 128, - "direction": "out", - "amount_msat": 4001, - "payment_hash": "14ef01c9fb12d7dcac288f48ce87b19a7d5c3d5779aaed1e4adcb5c5d0e9fa45", - "state": "RCVD_REMOVE_ACK_REVOCATION" - } - ] + "request": { + "id": "example:listhtlcs#3", + "method": "listhtlcs", + "params": [ + "436c2658eb4f4689b42ff11b8b05f31ba09860d0df7168085e0796cdf40f85e0" + ] + }, + "response": { + "htlcs": [ + { + "short_channel_id": "103x1x0", + "id": 0, + "expiry": 124, + "direction": "out", + "amount_msat": 1001, + "payment_hash": "2ab653668c8017ff2f36ac36678a8da04e11380bd9580a2926b170523b0c6e3b", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x1x0", + "id": 1, + "expiry": 124, + "direction": "out", + "amount_msat": 2001, + "payment_hash": "92f889cb2e48aa28e1e577228b907cdbcc371a2c018e9c8f60fa7036e232cf1d", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x1x0", + "id": 2, + "expiry": 128, + "direction": "out", + "amount_msat": 4001, + "payment_hash": "14ef01c9fb12d7dcac288f48ce87b19a7d5c3d5779aaed1e4adcb5c5d0e9fa45", + "state": "RCVD_REMOVE_ACK_REVOCATION" + } + ] + } } ], "author": [ @@ -17983,26 +18118,26 @@ } } }, - "example_json_request": [ - { - "id": "example:listinvoicerequests#1", - "method": "listinvoicerequests", - "params": [ - "cf0b41d4eb248d975909deb9accf9722b1c86839de80ee8815ce907bbb700a1d" - ] - } - ], - "example_json_response": [ + "json_example": [ { - "invoicerequests": [ - { - "invreq_id": "cf0b41d4eb248d975909deb9accf9722b1c86839de80ee8815ce907bbb700a1d", - "active": true, - "single_use": true, - "bolt12": "lnr1qqgx9ag7nmtns87htndlgcfndlq0wzstwd5k6urvv5s8getnw3gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02gzqta0pqpvzzqnxu3vc68fug904w25y3zpskc8huazwmy34av93h2fjswe3tsp4rrcyps5sf5jwnn2tr3ghn32mdta8jvax62pwzhna8sktmaezl3f4s3zy35gx6dfay7r8zn299uwr7ugpze74zft4m8q3fnk2sr0ljqpve3jq", - "used": false - } - ] + "request": { + "id": "example:listinvoicerequests#1", + "method": "listinvoicerequests", + "params": [ + "cf0b41d4eb248d975909deb9accf9722b1c86839de80ee8815ce907bbb700a1d" + ] + }, + "response": { + "invoicerequests": [ + { + "invreq_id": "cf0b41d4eb248d975909deb9accf9722b1c86839de80ee8815ce907bbb700a1d", + "active": true, + "single_use": true, + "bolt12": "lnr1qqgx9ag7nmtns87htndlgcfndlq0wzstwd5k6urvv5s8getnw3gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02gzqta0pqpvzzqnxu3vc68fug904w25y3zpskc8huazwmy34av93h2fjswe3tsp4rrcyps5sf5jwnn2tr3ghn32mdta8jvax62pwzhna8sktmaezl3f4s3zy35gx6dfay7r8zn299uwr7ugpze74zft4m8q3fnk2sr0ljqpve3jq", + "used": false + } + ] + } } ], "author": [ @@ -18305,37 +18440,37 @@ } } }, - "example_json_request": [ - { - "id": "example:listinvoices#1", - "method": "listinvoices", - "params": { - "label": "xEoCR94SIz6UIRUEkxum", - "payment_hash": null, - "invstring": null, - "offer_id": null, - "index": null, - "start": null, - "limit": null - } - } - ], - "example_json_response": [ + "json_example": [ { - "invoices": [ - { + "request": { + "id": "example:listinvoices#1", + "method": "listinvoices", + "params": { "label": "xEoCR94SIz6UIRUEkxum", - "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", - "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "amount_msat": 11000000, - "status": "unpaid", - "description": [ - "XEoCR94SIz6UIRUEkxum." - ], - "expires_at": 1706757730, - "created_index": 1 + "payment_hash": null, + "invstring": null, + "offer_id": null, + "index": null, + "start": null, + "limit": null } - ] + }, + "response": { + "invoices": [ + { + "label": "xEoCR94SIz6UIRUEkxum", + "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", + "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", + "amount_msat": 11000000, + "status": "unpaid", + "description": [ + "XEoCR94SIz6UIRUEkxum." + ], + "expires_at": 1706757730, + "created_index": 1 + } + ] + } } ], "author": [ @@ -18596,76 +18731,78 @@ } } }, - "example_json_request": [ - { - "id": "example:listnodes#1", - "method": "listnodes", - "params": { - "id": "02e29856dab8ddd9044c18486e4cab79ec717b490447af2d4831e290e48d57638a" - } - }, - { - "id": "example:listnodes#2", - "method": "listnodes", - "params": { - "id": null - } - } - ], - "example_json_response": [ + "json_example": [ { - "nodes": [ - { - "nodeid": "02e29856dab8ddd9044c14586e4cab79ec717b490447af2d4831e290e48d58638a", - "alias": "some_alias", - "color": "68f442", - "last_timestamp": 1597213741, - "features": "02a2a1", - "addresses": [ - { - "type": "ipv4", - "address": "zzz.yy.xx.xx", - "port": 9735 - } - ] + "request": { + "id": "example:listnodes#1", + "method": "listnodes", + "params": { + "id": "02e29856dab8ddd9044c18486e4cab79ec717b490447af2d4831e290e48d57638a" } - ] + }, + "response": { + "nodes": [ + { + "nodeid": "02e29856dab8ddd9044c14586e4cab79ec717b490447af2d4831e290e48d58638a", + "alias": "some_alias", + "color": "68f442", + "last_timestamp": 1597213741, + "features": "02a2a1", + "addresses": [ + { + "type": "ipv4", + "address": "zzz.yy.xx.xx", + "port": 9735 + } + ] + } + ] + } }, { - "nodes": [ - { - "nodeid": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "alias": "SILENTARTIST-v23.11-415-gd120eba", - "color": "022d22", - "last_timestamp": 1708624765, - "features": "88a0000a8a5961", - "addresses": [] - }, - { - "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "alias": "JUNIORBEAM-v23.11-415-gd120eba", - "color": "0266e4", - "last_timestamp": 1708624765, - "features": "88a0000a8a5961", - "addresses": [] - }, - { - "nodeid": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "alias": "HOPPINGFIRE-v23.11-415-gd120eba", - "color": "035d2b", - "last_timestamp": 1708624765, - "features": "88a0000a8a5961", - "addresses": [] - }, - { - "nodeid": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", - "alias": "JUNIORFELONY-v23.11-415-gd120eba", - "color": "0382ce", - "last_timestamp": 1708624766, - "features": "88a0000a8a5961", - "addresses": [] + "request": { + "id": "example:listnodes#2", + "method": "listnodes", + "params": { + "id": null } - ] + }, + "response": { + "nodes": [ + { + "nodeid": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "alias": "SILENTARTIST-v23.11-415-gd120eba", + "color": "022d22", + "last_timestamp": 1708624765, + "features": "88a0000a8a5961", + "addresses": [] + }, + { + "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "alias": "JUNIORBEAM-v23.11-415-gd120eba", + "color": "0266e4", + "last_timestamp": 1708624765, + "features": "88a0000a8a5961", + "addresses": [] + }, + { + "nodeid": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "alias": "HOPPINGFIRE-v23.11-415-gd120eba", + "color": "035d2b", + "last_timestamp": 1708624765, + "features": "88a0000a8a5961", + "addresses": [] + }, + { + "nodeid": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", + "alias": "JUNIORFELONY-v23.11-415-gd120eba", + "color": "0382ce", + "last_timestamp": 1708624766, + "features": "88a0000a8a5961", + "addresses": [] + } + ] + } } ], "errors": [ @@ -18770,51 +18907,53 @@ } } }, - "example_json_request": [ - { - "id": "example:listoffers#1", - "method": "listoffers", - "params": { - "active_only": true - } - }, - { - "id": "example:listoffers#2", - "method": "listoffers", - "params": [ - "f61cca153d1948dade19349792d9bcdc9cef687fd27db0b553a67979f55aae48" - ] - } - ], - "example_json_response": [ + "json_example": [ { - "offers": [ - { - "offer_id": "053a5c566fbea2681a5ff9c05a913da23e45b95d09ef5bd25d7d408f23da7084", - "active": true, - "single_use": false, - "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqvqcdgq2z9pk7enxv4jjqen0wgs8yatnw3ujz83qkc6rvp4j28rt3dtrn32zkvdy7efhnlrpr5rp5geqxs783wtlj550qs8czzku4nk3pqp6m593qxgunzuqcwkmgqkmp6ty0wyvjcqdguv3pnpukedwn6cr87m89t74h3auyaeg89xkvgzpac70z3m9rn5xzu28c", - "used": false - }, - { - "offer_id": "3247d3597fec19e362ca683416a48a0f76a44c1600725a7ee1936548feadacca", - "active": true, - "single_use": false, - "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcxqd24x3qgqgqlgzs3gdhkven9v5sxvmmjype82um50ys3ug9kxsmqdvj3c6ut2cuu2s4nrf8k2dulccgaqcdzxgp583utjlu49rcyqt8hc3s797umxn3r9367rdqc577rma7key58fywkajxnuzyapge86hj2pg80rjrma40xdqrxnsnva5l3ce7hz4ua8wf755dees4y9vnq", - "used": true + "request": { + "id": "example:listoffers#1", + "method": "listoffers", + "params": { + "active_only": true } - ] + }, + "response": { + "offers": [ + { + "offer_id": "053a5c566fbea2681a5ff9c05a913da23e45b95d09ef5bd25d7d408f23da7084", + "active": true, + "single_use": false, + "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqvqcdgq2z9pk7enxv4jjqen0wgs8yatnw3ujz83qkc6rvp4j28rt3dtrn32zkvdy7efhnlrpr5rp5geqxs783wtlj550qs8czzku4nk3pqp6m593qxgunzuqcwkmgqkmp6ty0wyvjcqdguv3pnpukedwn6cr87m89t74h3auyaeg89xkvgzpac70z3m9rn5xzu28c", + "used": false + }, + { + "offer_id": "3247d3597fec19e362ca683416a48a0f76a44c1600725a7ee1936548feadacca", + "active": true, + "single_use": false, + "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcxqd24x3qgqgqlgzs3gdhkven9v5sxvmmjype82um50ys3ug9kxsmqdvj3c6ut2cuu2s4nrf8k2dulccgaqcdzxgp583utjlu49rcyqt8hc3s797umxn3r9367rdqc577rma7key58fywkajxnuzyapge86hj2pg80rjrma40xdqrxnsnva5l3ce7hz4ua8wf755dees4y9vnq", + "used": true + } + ] + } }, { - "offers": [ - { - "offer_id": "f61cca153d1948dade19349792d9bcdc9cef687fd27db0b553a67979f55aae48", - "active": true, - "single_use": false, - "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqyqs5rn5v4ehggrxdaezqvtdwdshg93pqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq63s", - "used": false - } - ] + "request": { + "id": "example:listoffers#2", + "method": "listoffers", + "params": [ + "f61cca153d1948dade19349792d9bcdc9cef687fd27db0b553a67979f55aae48" + ] + }, + "response": { + "offers": [ + { + "offer_id": "f61cca153d1948dade19349792d9bcdc9cef687fd27db0b553a67979f55aae48", + "active": true, + "single_use": false, + "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqyqs5rn5v4ehggrxdaezqvtdwdshg93pqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq63s", + "used": false + } + ] + } } ], "author": [ @@ -19039,53 +19178,55 @@ "The returned array is ordered by increasing **created_at** fields." ] }, - "example_json_request": [ - { - "id": "example:listpays#1", - "method": "listpays", - "params": { - "bolt11": "lnbcrt123n1pjmxp7qsp5hxu7u28y0nx4v689u3hwzdzse2w9yaylhheavf9dxvwtdup7pvespp5ha66gxse68j4n6755v7299dnmq4w34gp0znxu0xzahdc43zrg40qdq5v3jhxcmjd9c8g6t0dc6sxqrp7scqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqsqqqqqqqqpqqqqqzsqqc9qxpqysgqk74dvqlvr92ayy5s7x0r0u9xywez6wu4h8pfta386cw6x7cdrvn8pz87kyg5c930aent423gm9ylpaw5p35k72f02hg0s9dulg4d8fqpgj7gpm", - "payment_hash": null, - "status": null - } - }, - { - "id": "example:listpays#2", - "method": "listpays", - "params": { - "bolt11": "lnbcrt123n1pjmxp7qsp5u84368dz7yhzcqm955h96wdqch7uarasun45cr0vs5d8t0cv5avqpp5r9p0dp92guaatrmhf302m0dyj4n79gk93qu2l5tagfxq3dedgfqsdq5v3jhxcmjd9c8g6t0dc6qxqrp7scqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqsqqqqqqqqpqqqqqzsqqc9qxpqysgq46wu0fznfx27rcnyzhcttf8yqx3lwqs482yxlead0fyt8mefrrrj5m379fa5qukgquf9tnwsuj3nnfmwkzkfg6pyhzq6w8gauuh6m5cqgur64n", - "payment_hash": null, - "status": null - } - } - ], - "example_json_response": [ + "json_example": [ { - "pays": [ - { + "request": { + "id": "example:listpays#1", + "method": "listpays", + "params": { "bolt11": "lnbcrt123n1pjmxp7qsp5hxu7u28y0nx4v689u3hwzdzse2w9yaylhheavf9dxvwtdup7pvespp5ha66gxse68j4n6755v7299dnmq4w34gp0znxu0xzahdc43zrg40qdq5v3jhxcmjd9c8g6t0dc6sxqrp7scqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqsqqqqqqqqpqqqqqzsqqc9qxpqysgqk74dvqlvr92ayy5s7x0r0u9xywez6wu4h8pfta386cw6x7cdrvn8pz87kyg5c930aent423gm9ylpaw5p35k72f02hg0s9dulg4d8fqpgj7gpm", - "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "payment_hash": "bf75a41a19d1e559ebd4a33ca295b3d82ae8d50178a66e3cc2eddb8ac443455e", - "status": "failed", - "created_at": 1706231854, - "amount_sent_msat": 0 + "payment_hash": null, + "status": null } - ] + }, + "response": { + "pays": [ + { + "bolt11": "lnbcrt123n1pjmxp7qsp5hxu7u28y0nx4v689u3hwzdzse2w9yaylhheavf9dxvwtdup7pvespp5ha66gxse68j4n6755v7299dnmq4w34gp0znxu0xzahdc43zrg40qdq5v3jhxcmjd9c8g6t0dc6sxqrp7scqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqsqqqqqqqqpqqqqqzsqqc9qxpqysgqk74dvqlvr92ayy5s7x0r0u9xywez6wu4h8pfta386cw6x7cdrvn8pz87kyg5c930aent423gm9ylpaw5p35k72f02hg0s9dulg4d8fqpgj7gpm", + "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "payment_hash": "bf75a41a19d1e559ebd4a33ca295b3d82ae8d50178a66e3cc2eddb8ac443455e", + "status": "failed", + "created_at": 1706231854, + "amount_sent_msat": 0 + } + ] + } }, { - "pays": [ - { + "request": { + "id": "example:listpays#2", + "method": "listpays", + "params": { "bolt11": "lnbcrt123n1pjmxp7qsp5u84368dz7yhzcqm955h96wdqch7uarasun45cr0vs5d8t0cv5avqpp5r9p0dp92guaatrmhf302m0dyj4n79gk93qu2l5tagfxq3dedgfqsdq5v3jhxcmjd9c8g6t0dc6qxqrp7scqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqsqqqqqqqqpqqqqqzsqqc9qxpqysgq46wu0fznfx27rcnyzhcttf8yqx3lwqs482yxlead0fyt8mefrrrj5m379fa5qukgquf9tnwsuj3nnfmwkzkfg6pyhzq6w8gauuh6m5cqgur64n", - "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "payment_hash": "1942f684aa473bd58f774c5eadbda49567e2a2c58838afd17d424c08b72d4241", - "status": "complete", - "created_at": 1706231849, - "completed_at": 1706231854, - "preimage": "89ce412a2089cbcb72a73ce755337cf693859ea58f21ef0d1caf286a9b0f2a7c", - "amount_msat": 12300, - "amount_sent_msat": 12301 + "payment_hash": null, + "status": null } - ] + }, + "response": { + "pays": [ + { + "bolt11": "lnbcrt123n1pjmxp7qsp5u84368dz7yhzcqm955h96wdqch7uarasun45cr0vs5d8t0cv5avqpp5r9p0dp92guaatrmhf302m0dyj4n79gk93qu2l5tagfxq3dedgfqsdq5v3jhxcmjd9c8g6t0dc6qxqrp7scqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqsqqqqqqqqpqqqqqzsqqc9qxpqysgq46wu0fznfx27rcnyzhcttf8yqx3lwqs482yxlead0fyt8mefrrrj5m379fa5qukgquf9tnwsuj3nnfmwkzkfg6pyhzq6w8gauuh6m5cqgur64n", + "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "payment_hash": "1942f684aa473bd58f774c5eadbda49567e2a2c58838afd17d424c08b72d4241", + "status": "complete", + "created_at": 1706231849, + "completed_at": 1706231854, + "preimage": "89ce412a2089cbcb72a73ce755337cf693859ea58f21ef0d1caf286a9b0f2a7c", + "amount_msat": 12300, + "amount_sent_msat": 12301 + } + ] + } } ], "author": [ @@ -20488,208 +20629,210 @@ "", "- -32602: If the given parameters are wrong." ], - "example_json_request": [ + "json_example": [ { - "id": "example:listpeerchannels#1", - "method": "listpeerchannels", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" + "request": { + "id": "example:listpeerchannels#1", + "method": "listpeerchannels", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" + } + }, + "response": { + "channels": [ + { + "peer_id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "peer_connected": true, + "channel_type": { + "bits": [ + 12 + ], + "names": [ + "static_remotekey/even" + ] + }, + "updates": { + "local": { + "htlc_minimum_msat": 0, + "htlc_maximum_msat": 990000000, + "cltv_expiry_delta": 6, + "fee_base_msat": 1, + "fee_proportional_millionths": 10 + } + }, + "state": "CHANNELD_AWAITING_LOCKIN", + "scratch_txid": "4e9c2866b9ae1f765b89ea7ec37428c900ea97f717f85f00e3db852cb6aea3a8", + "last_tx_fee_msat": 5430000, + "feerate": { + "perkw": 7500, + "perkb": 30000 + }, + "owner": "channeld", + "direction": 1, + "channel_id": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "funding_txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b", + "funding_outnum": 0, + "close_to_addr": "bcrt1pamt5tqzd49uyessr7437l2vllf20muqmzdauje8x8scjgpc0l0nqhyqcyp", + "close_to": "5120eed745804da9784cc203f563efa99ffa54fdf01b137bc964e63c3124070ffbe6", + "private": false, + "opener": "local", + "alias": { + "local": "5589251x14022525x17398" + }, + "features": [ + "option_static_remotekey" + ], + "funding": { + "local_funds_msat": 1000000000, + "remote_funds_msat": 0, + "pushed_msat": 0 + }, + "to_us_msat": 1000000000, + "min_to_us_msat": 1000000000, + "max_to_us_msat": 1000000000, + "total_msat": 1000000000, + "fee_base_msat": 1, + "fee_proportional_millionths": 10, + "dust_limit_msat": 546000, + "max_total_htlc_in_msat": 18446744073709552000, + "their_reserve_msat": 10000000, + "our_reserve_msat": 10000000, + "spendable_msat": 973980000, + "receivable_msat": 0, + "minimum_htlc_in_msat": 0, + "minimum_htlc_out_msat": 0, + "maximum_htlc_out_msat": 990000000, + "their_to_self_delay": 5, + "our_to_self_delay": 5, + "max_accepted_htlcs": 483, + "state_changes": [], + "status": [], + "in_payments_offered": 0, + "in_offered_msat": 0, + "in_payments_fulfilled": 0, + "in_fulfilled_msat": 0, + "out_payments_offered": 0, + "out_offered_msat": 0, + "out_payments_fulfilled": 0, + "out_fulfilled_msat": 0, + "htlcs": [] + } + ] } }, { - "id": "example:listpeerchannels#2", - "method": "listpeerchannels", - "params": { - "id": null - } - } - ], - "example_json_response": [ - { - "channels": [ - { - "peer_id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "peer_connected": true, - "channel_type": { - "bits": [ - 12 - ], - "names": [ - "static_remotekey/even" - ] - }, - "updates": { - "local": { - "htlc_minimum_msat": 0, - "htlc_maximum_msat": 990000000, - "cltv_expiry_delta": 6, - "fee_base_msat": 1, - "fee_proportional_millionths": 10 - } - }, - "state": "CHANNELD_AWAITING_LOCKIN", - "scratch_txid": "4e9c2866b9ae1f765b89ea7ec37428c900ea97f717f85f00e3db852cb6aea3a8", - "last_tx_fee_msat": 5430000, - "feerate": { - "perkw": 7500, - "perkb": 30000 - }, - "owner": "channeld", - "direction": 1, - "channel_id": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "funding_txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b", - "funding_outnum": 0, - "close_to_addr": "bcrt1pamt5tqzd49uyessr7437l2vllf20muqmzdauje8x8scjgpc0l0nqhyqcyp", - "close_to": "5120eed745804da9784cc203f563efa99ffa54fdf01b137bc964e63c3124070ffbe6", - "private": false, - "opener": "local", - "alias": { - "local": "5589251x14022525x17398" - }, - "features": [ - "option_static_remotekey" - ], - "funding": { - "local_funds_msat": 1000000000, - "remote_funds_msat": 0, - "pushed_msat": 0 - }, - "to_us_msat": 1000000000, - "min_to_us_msat": 1000000000, - "max_to_us_msat": 1000000000, - "total_msat": 1000000000, - "fee_base_msat": 1, - "fee_proportional_millionths": 10, - "dust_limit_msat": 546000, - "max_total_htlc_in_msat": 18446744073709552000, - "their_reserve_msat": 10000000, - "our_reserve_msat": 10000000, - "spendable_msat": 973980000, - "receivable_msat": 0, - "minimum_htlc_in_msat": 0, - "minimum_htlc_out_msat": 0, - "maximum_htlc_out_msat": 990000000, - "their_to_self_delay": 5, - "our_to_self_delay": 5, - "max_accepted_htlcs": 483, - "state_changes": [], - "status": [], - "in_payments_offered": 0, - "in_offered_msat": 0, - "in_payments_fulfilled": 0, - "in_fulfilled_msat": 0, - "out_payments_offered": 0, - "out_offered_msat": 0, - "out_payments_fulfilled": 0, - "out_fulfilled_msat": 0, - "htlcs": [] + "request": { + "id": "example:listpeerchannels#2", + "method": "listpeerchannels", + "params": { + "id": null } - ] - }, - { - "channels": [ - { - "peer_id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "peer_connected": true, - "reestablished": true, - "channel_type": { - "bits": [ - 12, - 22 + }, + "response": { + "channels": [ + { + "peer_id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "peer_connected": true, + "reestablished": true, + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "updates": { + "local": { + "htlc_minimum_msat": 0, + "htlc_maximum_msat": 990000000, + "cltv_expiry_delta": 6, + "fee_base_msat": 1, + "fee_proportional_millionths": 10 + }, + "remote": { + "htlc_minimum_msat": 0, + "htlc_maximum_msat": 990000000, + "cltv_expiry_delta": 6, + "fee_base_msat": 1, + "fee_proportional_millionths": 10 + } + }, + "state": "CHANNELD_NORMAL", + "scratch_txid": "ece66657d6203a4ea77807f566fd5b98a78b659f0cd59ce9200aa3bd6875ee25", + "last_tx_fee_msat": 4545000, + "lost_state": false, + "feerate": { + "perkw": 3750, + "perkb": 15000 + }, + "owner": "channeld", + "short_channel_id": "103x1x0", + "direction": 1, + "channel_id": "def5ef03e0d36ed65de814c0a8d6599a502fe1afb8e956529320bb350e876b5f", + "funding_txid": "5f6b870e35bb20935256e9b8afe12f509a59d6a8c014e85dd66ed3e003eff5de", + "funding_outnum": 0, + "close_to_addr": "bcrt1pamt5tqzd49uyessr7437l2vllf20muqmzdauje8x8scjgpc0l0nqhyqcyp", + "close_to": "5120eed745804da9784cc203f563efa99ffa54fdf01b137bc964e63c3124070ffbe6", + "private": false, + "opener": "local", + "alias": { + "local": "15447035x5589520x8959", + "remote": "6036590x13481428x5501" + }, + "features": [ + "option_static_remotekey", + "option_anchors_zero_fee_htlc_tx" ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] - }, - "updates": { - "local": { - "htlc_minimum_msat": 0, - "htlc_maximum_msat": 990000000, - "cltv_expiry_delta": 6, - "fee_base_msat": 1, - "fee_proportional_millionths": 10 - }, - "remote": { - "htlc_minimum_msat": 0, - "htlc_maximum_msat": 990000000, - "cltv_expiry_delta": 6, - "fee_base_msat": 1, - "fee_proportional_millionths": 10 - } - }, - "state": "CHANNELD_NORMAL", - "scratch_txid": "ece66657d6203a4ea77807f566fd5b98a78b659f0cd59ce9200aa3bd6875ee25", - "last_tx_fee_msat": 4545000, - "lost_state": false, - "feerate": { - "perkw": 3750, - "perkb": 15000 - }, - "owner": "channeld", - "short_channel_id": "103x1x0", - "direction": 1, - "channel_id": "def5ef03e0d36ed65de814c0a8d6599a502fe1afb8e956529320bb350e876b5f", - "funding_txid": "5f6b870e35bb20935256e9b8afe12f509a59d6a8c014e85dd66ed3e003eff5de", - "funding_outnum": 0, - "close_to_addr": "bcrt1pamt5tqzd49uyessr7437l2vllf20muqmzdauje8x8scjgpc0l0nqhyqcyp", - "close_to": "5120eed745804da9784cc203f563efa99ffa54fdf01b137bc964e63c3124070ffbe6", - "private": false, - "opener": "local", - "alias": { - "local": "15447035x5589520x8959", - "remote": "6036590x13481428x5501" - }, - "features": [ - "option_static_remotekey", - "option_anchors_zero_fee_htlc_tx" - ], - "funding": { - "local_funds_msat": 1000000000, - "remote_funds_msat": 0, - "pushed_msat": 0 - }, - "to_us_msat": 1000000000, - "min_to_us_msat": 1000000000, - "max_to_us_msat": 1000000000, - "total_msat": 1000000000, - "fee_base_msat": 1, - "fee_proportional_millionths": 10, - "dust_limit_msat": 546000, - "max_total_htlc_in_msat": 18446744073709552000, - "their_reserve_msat": 10000000, - "our_reserve_msat": 10000000, - "spendable_msat": 978330000, - "receivable_msat": 0, - "minimum_htlc_in_msat": 0, - "minimum_htlc_out_msat": 0, - "maximum_htlc_out_msat": 990000000, - "their_to_self_delay": 5, - "our_to_self_delay": 5, - "max_accepted_htlcs": 483, - "state_changes": [ - { - "timestamp": "2024-02-22T17:48:57.127Z", - "old_state": "CHANNELD_AWAITING_LOCKIN", - "new_state": "CHANNELD_NORMAL", - "cause": "user", - "message": "Lockin complete" - } - ], - "status": [ - "CHANNELD_NORMAL:Channel ready for use." - ], - "in_payments_offered": 0, - "in_offered_msat": 0, - "in_payments_fulfilled": 0, - "in_fulfilled_msat": 0, - "out_payments_offered": 0, - "out_offered_msat": 0, - "out_payments_fulfilled": 0, - "out_fulfilled_msat": 0, - "htlcs": [] - } - ] + "funding": { + "local_funds_msat": 1000000000, + "remote_funds_msat": 0, + "pushed_msat": 0 + }, + "to_us_msat": 1000000000, + "min_to_us_msat": 1000000000, + "max_to_us_msat": 1000000000, + "total_msat": 1000000000, + "fee_base_msat": 1, + "fee_proportional_millionths": 10, + "dust_limit_msat": 546000, + "max_total_htlc_in_msat": 18446744073709552000, + "their_reserve_msat": 10000000, + "our_reserve_msat": 10000000, + "spendable_msat": 978330000, + "receivable_msat": 0, + "minimum_htlc_in_msat": 0, + "minimum_htlc_out_msat": 0, + "maximum_htlc_out_msat": 990000000, + "their_to_self_delay": 5, + "our_to_self_delay": 5, + "max_accepted_htlcs": 483, + "state_changes": [ + { + "timestamp": "2024-02-22T17:48:57.127Z", + "old_state": "CHANNELD_AWAITING_LOCKIN", + "new_state": "CHANNELD_NORMAL", + "cause": "user", + "message": "Lockin complete" + } + ], + "status": [ + "CHANNELD_NORMAL:Channel ready for use." + ], + "in_payments_offered": 0, + "in_offered_msat": 0, + "in_payments_fulfilled": 0, + "in_fulfilled_msat": 0, + "out_payments_offered": 0, + "out_offered_msat": 0, + "out_payments_fulfilled": 0, + "out_fulfilled_msat": 0, + "htlcs": [] + } + ] + } } ], "author": [ @@ -21008,50 +21151,52 @@ "", "- -32602: If the given parameters are wrong." ], - "example_json_request": [ - { - "id": "example:listpeers#1", - "method": "listpeers", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "level": null - } - }, - { - "id": "example:listpeers#2", - "method": "listpeers", - "params": { - "id": null, - "level": null - } - } - ], - "example_json_response": [ + "json_example": [ { - "peers": [ - { + "request": { + "id": "example:listpeers#1", + "method": "listpeers", + "params": { "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "connected": true, - "num_channels": 1, - "netaddr": [ - "127.0.0.1:44619" - ], - "features": "08a0000a0a69a2" + "level": null } - ] + }, + "response": { + "peers": [ + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "connected": true, + "num_channels": 1, + "netaddr": [ + "127.0.0.1:44619" + ], + "features": "08a0000a0a69a2" + } + ] + } }, { - "peers": [ - { - "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "connected": true, - "num_channels": 1, - "netaddr": [ - "127.0.0.1:48862" - ], - "features": "08a0000a0a69a2" + "request": { + "id": "example:listpeers#2", + "method": "listpeers", + "params": { + "id": null, + "level": null } - ] + }, + "response": { + "peers": [ + { + "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "connected": true, + "num_channels": 1, + "netaddr": [ + "127.0.0.1:48862" + ], + "features": "08a0000a0a69a2" + } + ] + } } ], "author": [ @@ -21392,79 +21537,81 @@ "Note that the returned array is ordered by increasing *id*." ] }, - "example_json_request": [ - { - "id": "example:listsendpays#1", - "method": "listsendpays", - "params": { - "bolt11": null, - "payment_hash": null, - "status": null, - "index": null, - "start": null, - "limit": null - } - }, + "json_example": [ { - "id": "example:listsendpays#2", - "method": "listsendpays", - "params": { - "bolt11": "lnbcrt1230n1pja03q9sp5xu9aypccf3n6vld2waxcysy47ct2wl5x5adtm7k8u30knqes22lspp5duw2v8csh0zh4xg9ql3amem98avlkc2ecre99tgmr2340amf9kmsdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqwh78s8wqg0kepspw0epcxmxteh5wu8n6ddlwdnyj758fqxpqk8ejf597x8ju3r32xqgae3yzjjz9e5s6l2vs5zxvkayhmemmx74wvyqqyqf8c9", - "payment_hash": null, - "status": null, - "index": null, - "start": null, - "limit": null - } - } - ], - "example_json_response": [ - { - "payments": [ - { - "created_index": 1, - "id": 1, - "payment_hash": "e3b43574acd074b0c4ba1b13b5155ff5f9c76742e643ed003e17301c5a2db149", - "groupid": 1, - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount_msat": 20000, - "amount_sent_msat": 20000, - "created_at": 1706225269, - "status": "pending", - "bolt11": "lnbcrt200n1pjm9mn5sp5gq84lgga959m6gg4g0kj29ypwjaxxnm4cu5csymq8p6nqxv800mspp5uw6r2a9v6p6tp396rvfm292l7huuwe6zuep76qp7zucpck3dk9ysdpqf9grgmt62fmk5stswefh23n2tpykvcmzxqyjw5qcqp99qxpqysgqz8s496zmwed278jvp075zlhrnj0ncg45kcfw5s2lkhtxd3wc39f8wflp5gmd827dk470xpasfpx0azsfu0k8ttwae7620h8d050w28cqan776g" - }, - { - "created_index": 2, - "id": 2, - "payment_hash": "f55d92cfe019b5a015f5e5956e9255053cda14786171d5002feb12ae5254e5a5", - "groupid": 1, - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount_msat": 30000, - "amount_sent_msat": 30000, - "created_at": 1706225269, - "status": "pending", - "bolt11": "lnbcrt300n1pjm9mn5sp5zqfkr93rp92mdyj6m8lzpcu90rfefcaqff8fxdd2sc5mace23ujspp574we9nlqrx66q904uk2kayj4q57d59rcv9ca2qp0avf2u5j5ukjsdpq29j55nfcgfcnsvzw2er57knhwcmhzwt0xqyjw5qcqp99qxpqysgq76p2jpnegtzlxmn0aqt6d3f89q4p6y5v3v2qz7t2mm6xt90nt324cq400tl82k28562aux8jxs57d603g7s0q4g3dapu9a7vln94j7spsut799" + "request": { + "id": "example:listsendpays#1", + "method": "listsendpays", + "params": { + "bolt11": null, + "payment_hash": null, + "status": null, + "index": null, + "start": null, + "limit": null } - ] + }, + "response": { + "payments": [ + { + "created_index": 1, + "id": 1, + "payment_hash": "e3b43574acd074b0c4ba1b13b5155ff5f9c76742e643ed003e17301c5a2db149", + "groupid": 1, + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount_msat": 20000, + "amount_sent_msat": 20000, + "created_at": 1706225269, + "status": "pending", + "bolt11": "lnbcrt200n1pjm9mn5sp5gq84lgga959m6gg4g0kj29ypwjaxxnm4cu5csymq8p6nqxv800mspp5uw6r2a9v6p6tp396rvfm292l7huuwe6zuep76qp7zucpck3dk9ysdpqf9grgmt62fmk5stswefh23n2tpykvcmzxqyjw5qcqp99qxpqysgqz8s496zmwed278jvp075zlhrnj0ncg45kcfw5s2lkhtxd3wc39f8wflp5gmd827dk470xpasfpx0azsfu0k8ttwae7620h8d050w28cqan776g" + }, + { + "created_index": 2, + "id": 2, + "payment_hash": "f55d92cfe019b5a015f5e5956e9255053cda14786171d5002feb12ae5254e5a5", + "groupid": 1, + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount_msat": 30000, + "amount_sent_msat": 30000, + "created_at": 1706225269, + "status": "pending", + "bolt11": "lnbcrt300n1pjm9mn5sp5zqfkr93rp92mdyj6m8lzpcu90rfefcaqff8fxdd2sc5mace23ujspp574we9nlqrx66q904uk2kayj4q57d59rcv9ca2qp0avf2u5j5ukjsdpq29j55nfcgfcnsvzw2er57knhwcmhzwt0xqyjw5qcqp99qxpqysgq76p2jpnegtzlxmn0aqt6d3f89q4p6y5v3v2qz7t2mm6xt90nt324cq400tl82k28562aux8jxs57d603g7s0q4g3dapu9a7vln94j7spsut799" + } + ] + } }, { - "payments": [ - { - "created_index": 1, - "id": 1, - "payment_hash": "6f1ca61f10bbc57a990507e3dde7653f59fb6159c0f252ad1b1aa357f7692db7", - "groupid": 1, - "updated_index": 1, - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount_msat": 123000, - "amount_sent_msat": 123000, - "created_at": 1708639237, - "completed_at": 1708639238, - "status": "complete", - "payment_preimage": "91f8366681fdfd309c048082fcde81a79116f85a7b2dd09aef1e34f5f7c3397b", - "bolt11": "lnbcrt1230n1pja03q9sp5xu9aypccf3n6vld2waxcysy47ct2wl5x5adtm7k8u30knqes22lspp5duw2v8csh0zh4xg9ql3amem98avlkc2ecre99tgmr2340amf9kmsdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqwh78s8wqg0kepspw0epcxmxteh5wu8n6ddlwdnyj758fqxpqk8ejf597x8ju3r32xqgae3yzjjz9e5s6l2vs5zxvkayhmemmx74wvyqqyqf8c9" + "request": { + "id": "example:listsendpays#2", + "method": "listsendpays", + "params": { + "bolt11": "lnbcrt1230n1pja03q9sp5xu9aypccf3n6vld2waxcysy47ct2wl5x5adtm7k8u30knqes22lspp5duw2v8csh0zh4xg9ql3amem98avlkc2ecre99tgmr2340amf9kmsdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqwh78s8wqg0kepspw0epcxmxteh5wu8n6ddlwdnyj758fqxpqk8ejf597x8ju3r32xqgae3yzjjz9e5s6l2vs5zxvkayhmemmx74wvyqqyqf8c9", + "payment_hash": null, + "status": null, + "index": null, + "start": null, + "limit": null } - ] + }, + "response": { + "payments": [ + { + "created_index": 1, + "id": 1, + "payment_hash": "6f1ca61f10bbc57a990507e3dde7653f59fb6159c0f252ad1b1aa357f7692db7", + "groupid": 1, + "updated_index": 1, + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount_msat": 123000, + "amount_sent_msat": 123000, + "created_at": 1708639237, + "completed_at": 1708639238, + "status": "complete", + "payment_preimage": "91f8366681fdfd309c048082fcde81a79116f85a7b2dd09aef1e34f5f7c3397b", + "bolt11": "lnbcrt1230n1pja03q9sp5xu9aypccf3n6vld2waxcysy47ct2wl5x5adtm7k8u30knqes22lspp5duw2v8csh0zh4xg9ql3amem98avlkc2ecre99tgmr2340amf9kmsdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqwh78s8wqg0kepspw0epcxmxteh5wu8n6ddlwdnyj758fqxpqk8ejf597x8ju3r32xqgae3yzjjz9e5s6l2vs5zxvkayhmemmx74wvyqqyqf8c9" + } + ] + } } ], "author": [ @@ -21577,173 +21724,175 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:listsqlschemas#1", - "method": "listsqlschemas", - "params": { - "table": "offers" + "request": { + "id": "example:listsqlschemas#1", + "method": "listsqlschemas", + "params": { + "table": "offers" + } + }, + "response": { + "schemas": [ + { + "tablename": "offers", + "columns": [ + { + "name": "offer_id", + "type": "BLOB" + }, + { + "name": "active", + "type": "INTEGER" + }, + { + "name": "single_use", + "type": "INTEGER" + }, + { + "name": "bolt12", + "type": "TEXT" + }, + { + "name": "bolt12_unsigned", + "type": "TEXT" + }, + { + "name": "used", + "type": "INTEGER" + }, + { + "name": "label", + "type": "TEXT" + } + ], + "indices": [ + [ + "offer_id" + ] + ] + } + ] } }, { - "id": "example:listsqlschemas#2", - "method": "listsqlschemas", - "params": [ - "closedchannels" - ] - } - ], - "example_json_response": [ - { - "schemas": [ - { - "tablename": "offers", - "columns": [ - { - "name": "offer_id", - "type": "BLOB" - }, - { - "name": "active", - "type": "INTEGER" - }, - { - "name": "single_use", - "type": "INTEGER" - }, - { - "name": "bolt12", - "type": "TEXT" - }, - { - "name": "bolt12_unsigned", - "type": "TEXT" - }, - { - "name": "used", - "type": "INTEGER" - }, - { - "name": "label", - "type": "TEXT" - } - ], - "indices": [ - [ - "offer_id" + "request": { + "id": "example:listsqlschemas#2", + "method": "listsqlschemas", + "params": [ + "closedchannels" + ] + }, + "response": { + "schemas": [ + { + "tablename": "closedchannels", + "columns": [ + { + "name": "rowid", + "type": "INTEGER" + }, + { + "name": "peer_id", + "type": "BLOB" + }, + { + "name": "channel_id", + "type": "BLOB" + }, + { + "name": "short_channel_id", + "type": "TEXT" + }, + { + "name": "alias_local", + "type": "TEXT" + }, + { + "name": "alias_remote", + "type": "TEXT" + }, + { + "name": "opener", + "type": "TEXT" + }, + { + "name": "closer", + "type": "TEXT" + }, + { + "name": "private", + "type": "INTEGER" + }, + { + "name": "total_local_commitments", + "type": "INTEGER" + }, + { + "name": "total_remote_commitments", + "type": "INTEGER" + }, + { + "name": "total_htlcs_sent", + "type": "INTEGER" + }, + { + "name": "funding_txid", + "type": "BLOB" + }, + { + "name": "funding_outnum", + "type": "INTEGER" + }, + { + "name": "leased", + "type": "INTEGER" + }, + { + "name": "funding_fee_paid_msat", + "type": "INTEGER" + }, + { + "name": "funding_fee_rcvd_msat", + "type": "INTEGER" + }, + { + "name": "funding_pushed_msat", + "type": "INTEGER" + }, + { + "name": "total_msat", + "type": "INTEGER" + }, + { + "name": "final_to_us_msat", + "type": "INTEGER" + }, + { + "name": "min_to_us_msat", + "type": "INTEGER" + }, + { + "name": "max_to_us_msat", + "type": "INTEGER" + }, + { + "name": "last_commitment_txid", + "type": "BLOB" + }, + { + "name": "last_commitment_fee_msat", + "type": "INTEGER" + }, + { + "name": "close_cause", + "type": "TEXT" + } ] - ] - } - ] - }, - { - "schemas": [ - { - "tablename": "closedchannels", - "columns": [ - { - "name": "rowid", - "type": "INTEGER" - }, - { - "name": "peer_id", - "type": "BLOB" - }, - { - "name": "channel_id", - "type": "BLOB" - }, - { - "name": "short_channel_id", - "type": "TEXT" - }, - { - "name": "alias_local", - "type": "TEXT" - }, - { - "name": "alias_remote", - "type": "TEXT" - }, - { - "name": "opener", - "type": "TEXT" - }, - { - "name": "closer", - "type": "TEXT" - }, - { - "name": "private", - "type": "INTEGER" - }, - { - "name": "total_local_commitments", - "type": "INTEGER" - }, - { - "name": "total_remote_commitments", - "type": "INTEGER" - }, - { - "name": "total_htlcs_sent", - "type": "INTEGER" - }, - { - "name": "funding_txid", - "type": "BLOB" - }, - { - "name": "funding_outnum", - "type": "INTEGER" - }, - { - "name": "leased", - "type": "INTEGER" - }, - { - "name": "funding_fee_paid_msat", - "type": "INTEGER" - }, - { - "name": "funding_fee_rcvd_msat", - "type": "INTEGER" - }, - { - "name": "funding_pushed_msat", - "type": "INTEGER" - }, - { - "name": "total_msat", - "type": "INTEGER" - }, - { - "name": "final_to_us_msat", - "type": "INTEGER" - }, - { - "name": "min_to_us_msat", - "type": "INTEGER" - }, - { - "name": "max_to_us_msat", - "type": "INTEGER" - }, - { - "name": "last_commitment_txid", - "type": "BLOB" - }, - { - "name": "last_commitment_fee_msat", - "type": "INTEGER" - }, - { - "name": "close_cause", - "type": "TEXT" - } - ] - } - ] + } + ] + } } ], "author": [ @@ -21901,11 +22050,44 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:listtransactions#1", - "method": "listtransactions", - "params": {} + "request": { + "id": "example:listtransactions#1", + "method": "listtransactions", + "params": {} + }, + "response": { + "transactions": [ + { + "hash": "05985072bbe20747325e69a159fe08176cc1bbc96d25e8848edad2dddc1165d0", + "rawtx": "02000000027032912651fc25a3e0893acd5f9640598707e2dfef92143bb5a4020e335442800100000017160014a5f48b9aa3cb8ca6cc1040c11e386745bb4dc932ffffffffd229a4b4f78638ebcac10a68b0561585a5d6e4d3b769ad0a909e9b9afaeae24e00000000171600145c83da9b685f9142016c6f5eb5f98a45cfa6f686ffffffff01915a01000000000017a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf8700000000", + "blockheight": 0, + "txindex": 0, + "locktime": 0, + "version": 2, + "inputs": [ + { + "txid": "804254330e02a4b53b1492efdfe207875940965fcd3a89e0a325fc5126913270", + "index": 1, + "sequence": 4294967295 + }, + { + "txid": "4ee2eafa9a9b9e900aad69b7d3e4d6a5851556b0680ac1caeb3886f7b4a429d2", + "index": 0, + "sequence": 4294967295 + } + ], + "outputs": [ + { + "index": 0, + "satoshis": "88721000msat", + "scriptPubKey": "a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf87" + } + ] + } + ] + } } ], "errors": [ @@ -21913,39 +22095,6 @@ "", "- -32602: Error in given parameters." ], - "example_json_response": [ - { - "transactions": [ - { - "hash": "05985072bbe20747325e69a159fe08176cc1bbc96d25e8848edad2dddc1165d0", - "rawtx": "02000000027032912651fc25a3e0893acd5f9640598707e2dfef92143bb5a4020e335442800100000017160014a5f48b9aa3cb8ca6cc1040c11e386745bb4dc932ffffffffd229a4b4f78638ebcac10a68b0561585a5d6e4d3b769ad0a909e9b9afaeae24e00000000171600145c83da9b685f9142016c6f5eb5f98a45cfa6f686ffffffff01915a01000000000017a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf8700000000", - "blockheight": 0, - "txindex": 0, - "locktime": 0, - "version": 2, - "inputs": [ - { - "txid": "804254330e02a4b53b1492efdfe207875940965fcd3a89e0a325fc5126913270", - "index": 1, - "sequence": 4294967295 - }, - { - "txid": "4ee2eafa9a9b9e900aad69b7d3e4d6a5851556b0680ac1caeb3886f7b4a429d2", - "index": 0, - "sequence": 4294967295 - } - ], - "outputs": [ - { - "index": 0, - "satoshis": "88721000msat", - "scriptPubKey": "a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf87" - } - ] - } - ] - } - ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." @@ -22002,29 +22151,31 @@ "", "- -1: Catchall nonspecific error." ], - "example_json_request": [ - { - "id": "example:makesecret#1", - "method": "makesecret", - "params": [ - "73636220736563726574" - ] - }, - { - "id": "example:makesecret#2", - "method": "makesecret", - "params": [ - null, - "scb secret" - ] - } - ], - "example_json_response": [ + "json_example": [ { - "secret": "a9a2e742405c28f059349132923a99337ae7f71168b7485496e3365f5bc664ed" + "request": { + "id": "example:makesecret#1", + "method": "makesecret", + "params": [ + "73636220736563726574" + ] + }, + "response": { + "secret": "a9a2e742405c28f059349132923a99337ae7f71168b7485496e3365f5bc664ed" + } }, { - "secret": "a9a2e742405c28f059349132923a99337ae7f71168b7485496e3365f5bc664ed" + "request": { + "id": "example:makesecret#2", + "method": "makesecret", + "params": [ + null, + "scb secret" + ] + }, + "response": { + "secret": "a9a2e742405c28f059349132923a99337ae7f71168b7485496e3365f5bc664ed" + } } ], "author": [ @@ -22382,110 +22533,112 @@ "}", "```" ], - "example_json_request": [ + "json_example": [ { - "id": "example:multifundchannel#1", - "method": "multifundchannel", - "params": { - "destinations": [ + "request": { + "id": "example:multifundchannel#1", + "method": "multifundchannel", + "params": { + "destinations": [ + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59@localhost:41939", + "amount": 50000 + } + ], + "feerate": "10000perkw", + "minconf": null, + "utxos": null, + "minchannels": null, + "commitment_feerate": "2000perkw" + } + }, + "response": { + "tx": "0200000000010100a8ceb6f76c49c8c0c809ca359461540708a9a5ac56e56e6a7aaafb35f4d3850000000000fdffffff0250c30000000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd0623ff030000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a02473044022064763837f2cc84507eb1fc28c9e95d51174e1da4b8755da8e67fe21e37d0a8b402206295d0f19625f014819361a20572b936d81f6c5ba419e56997e882f3a7be094a012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", + "txid": "ecba36e93bcf40542d43a05ef550bb0e4be51d766aa2ec8c5640a0d431ab0d06", + "channel_ids": [ { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59@localhost:41939", - "amount": 50000 + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "channel_id": "060dab31d4a040568ceca26a761de54b0ebb50f55ea0432d5440cf3be936baec", + "channel_type": { + "bits": [ + 12 + ], + "names": [ + "static_remotekey/even" + ] + }, + "outnum": 0 } ], - "feerate": "10000perkw", - "minconf": null, - "utxos": null, - "minchannels": null, - "commitment_feerate": "2000perkw" + "failed": [] } }, { - "id": "example:multifundchannel#2", - "method": "multifundchannel", - "params": { - "destinations": [ + "request": { + "id": "example:multifundchannel#2", + "method": "multifundchannel", + "params": { + "destinations": [ + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59@localhost:44663", + "amount": 50000 + }, + { + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d@localhost:34631", + "amount": 50000 + }, + { + "id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199@localhost:34617", + "amount": 50000 + } + ], + "feerate": null, + "minconf": null, + "utxos": null, + "minchannels": 1 + } + }, + "response": { + "tx": "020000000001023041611dac05004825ab64781b4a33bf622380bf90196fae689196b1850a1f8f0000000000fdffffff5646519c565466c9588a88400ec71a39a2c0b6988beadb32491a13d9b89f85360100000000fdffffff0250c3000000000000220020181492c29a989f099fd2cf412c74b192dd095e81f4e4f6bec45bd1fbfdd2cfd983720000000000002251203e8a03f678bb7ca048baecc39788530560ea049816d604f72925e425288446c80140caa3b93c6667e4fe0026417cc87ae9dfd16d80018e7c6dcd6dfcee4d6cab7c7e84181baeb95ba25934ad1aa6b57f83c8287bf1b727123350b35549a3abe15b060140b3c6626b9b57081cc7eb5e4f518669764d265fb84316d8fb610e19ede13c5a370c1072861b909ec923acec980adb4a3e488ee3c6f9c49164bd4596945b52f62678000000", + "txid": "1fcc6d46200443ad21e3a1a1628b862bafd0d75c0b4454f5494957097bc7930d", + "channel_ids": [ { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59@localhost:44663", - "amount": 50000 - }, + "id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", + "channel_id": "0d93c77b09574949f554440b5cd7d0af2b868b62a1a1e321ad430420466dcc1f", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "outnum": 0 + } + ], + "failed": [ { - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d@localhost:34631", - "amount": 50000 + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "method": "connect", + "error": { + "code": 401, + "message": "All addresses failed: 127.0.0.1:44663: Connection establishment: Connection refused. " + } }, { - "id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199@localhost:34617", - "amount": 50000 + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "method": "connect", + "error": { + "code": 401, + "message": "All addresses failed: 127.0.0.1:34631: Connection establishment: Connection refused. " + } } - ], - "feerate": null, - "minconf": null, - "utxos": null, - "minchannels": 1 + ] } } ], - "example_json_response": [ - { - "tx": "0200000000010100a8ceb6f76c49c8c0c809ca359461540708a9a5ac56e56e6a7aaafb35f4d3850000000000fdffffff0250c30000000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd0623ff030000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a02473044022064763837f2cc84507eb1fc28c9e95d51174e1da4b8755da8e67fe21e37d0a8b402206295d0f19625f014819361a20572b936d81f6c5ba419e56997e882f3a7be094a012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", - "txid": "ecba36e93bcf40542d43a05ef550bb0e4be51d766aa2ec8c5640a0d431ab0d06", - "channel_ids": [ - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "channel_id": "060dab31d4a040568ceca26a761de54b0ebb50f55ea0432d5440cf3be936baec", - "channel_type": { - "bits": [ - 12 - ], - "names": [ - "static_remotekey/even" - ] - }, - "outnum": 0 - } - ], - "failed": [] - }, - { - "tx": "020000000001023041611dac05004825ab64781b4a33bf622380bf90196fae689196b1850a1f8f0000000000fdffffff5646519c565466c9588a88400ec71a39a2c0b6988beadb32491a13d9b89f85360100000000fdffffff0250c3000000000000220020181492c29a989f099fd2cf412c74b192dd095e81f4e4f6bec45bd1fbfdd2cfd983720000000000002251203e8a03f678bb7ca048baecc39788530560ea049816d604f72925e425288446c80140caa3b93c6667e4fe0026417cc87ae9dfd16d80018e7c6dcd6dfcee4d6cab7c7e84181baeb95ba25934ad1aa6b57f83c8287bf1b727123350b35549a3abe15b060140b3c6626b9b57081cc7eb5e4f518669764d265fb84316d8fb610e19ede13c5a370c1072861b909ec923acec980adb4a3e488ee3c6f9c49164bd4596945b52f62678000000", - "txid": "1fcc6d46200443ad21e3a1a1628b862bafd0d75c0b4454f5494957097bc7930d", - "channel_ids": [ - { - "id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", - "channel_id": "0d93c77b09574949f554440b5cd7d0af2b868b62a1a1e321ad430420466dcc1f", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] - }, - "outnum": 0 - } - ], - "failed": [ - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "method": "connect", - "error": { - "code": 401, - "message": "All addresses failed: 127.0.0.1:44663: Connection establishment: Connection refused. " - } - }, - { - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "method": "connect", - "error": { - "code": 401, - "message": "All addresses failed: 127.0.0.1:34631: Connection establishment: Connection refused. " - } - } - ] - } - ], "author": [ "ZmnSCPxj <> is mainly responsible." ], @@ -22567,70 +22720,72 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:multiwithdraw#1", - "method": "multiwithdraw", - "params": { - "outputs": [ - { - "bcrt1qyusnugshkn6kh5vmdjpe8hylvxlxjy3ns0hmrs": "2222000msat" - }, - { - "bcrt1q6r4vvt7uack33qf9n05umfxy8h5s2rdcmq7ra3": "3333000msat" - } - ], - "feerate": null, - "minconf": null, - "utxos": null + "request": { + "id": "example:multiwithdraw#1", + "method": "multiwithdraw", + "params": { + "outputs": [ + { + "bcrt1qyusnugshkn6kh5vmdjpe8hylvxlxjy3ns0hmrs": "2222000msat" + }, + { + "bcrt1q6r4vvt7uack33qf9n05umfxy8h5s2rdcmq7ra3": "3333000msat" + } + ], + "feerate": null, + "minconf": null, + "utxos": null + } + }, + "response": { + "tx": "02000000000101b75863b811587b4c15bb94d9285c31d6369b8ff609e44de399936f8acb268f600000000000fdffffff03050d000000000000160014d0eac62fdcee2d1881259be9cda4c43de9050db8ae0800000000000016001427213e2217b4f56bd19b6c8393dc9f61be691233d4b5f5050000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a0247304402203a001463da125de5615ff1c18f9cd4a1d2a138c91d40189d350821ac8fb3ae4f02207a507eec27e15fe43476233cd9fe8b690ebd265073a58ed18ff79a1416886f18012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", + "txid": "94e803b98257855569d35b675d65fb4fa0061a8b5f828992e2104a2882bb18bf" } }, { - "id": "example:multiwithdraw#2", - "method": "multiwithdraw", - "params": { - "outputs": [ - { - "BCRT1QW508D6QEJXTDG4Y5R3ZARVARY0C5XW7KYGT080": 1000 - }, - { - "bcrt1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3qzf4jry": 1000 - }, - { - "bcrt1pw508d6qejxtdg4y5r3zarvary0c5xw7kw508d6qejxtdg4y5r3zarvary0c5xw7k0ylj56": 1000 - }, - { - "BCRT1SW50QT2UWHA": 1000 - }, - { - "bcrt1zw508d6qejxtdg4y5r3zarvaryv2wuatf": 1000 - }, - { - "bcrt1qqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvseswlauz7": 1000 - }, - { - "bcrt1pqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvsesyga46z": 1000 - }, - { - "bcrt1p0xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vqc8gma6": 1000 - } - ], - "feerate": null, - "minconf": null, - "utxos": null + "request": { + "id": "example:multiwithdraw#2", + "method": "multiwithdraw", + "params": { + "outputs": [ + { + "BCRT1QW508D6QEJXTDG4Y5R3ZARVARY0C5XW7KYGT080": 1000 + }, + { + "bcrt1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3qzf4jry": 1000 + }, + { + "bcrt1pw508d6qejxtdg4y5r3zarvary0c5xw7kw508d6qejxtdg4y5r3zarvary0c5xw7k0ylj56": 1000 + }, + { + "BCRT1SW50QT2UWHA": 1000 + }, + { + "bcrt1zw508d6qejxtdg4y5r3zarvaryv2wuatf": 1000 + }, + { + "bcrt1qqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvseswlauz7": 1000 + }, + { + "bcrt1pqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvsesyga46z": 1000 + }, + { + "bcrt1p0xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vqc8gma6": 1000 + } + ], + "feerate": null, + "minconf": null, + "utxos": null + } + }, + "response": { + "tx": "02000000000101dc5a50dfbafc30697b930b44e763ff7a255475d17d975fa0e2003431312098cf0100000000fdffffff09e803000000000000225120000000c4a5cad46221b2a187905e5266362b99d5e91c6ce24d165dab93e86433e803000000000000046002751ee8030000000000002a5128751e76e8199196d454941c45d1b3a323f1433bd6751e76e8199196d454941c45d1b3a323f1433bd6e80300000000000022512079be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f817983b939700000000002251200518e92cd94e0f62c06f126dff98b9abe79b7ed845a156d5245678e26554475de803000000000000160014751e76e8199196d454941c45d1b3a323f1433bd6e8030000000000002200201863143c14c5166804bd19203356da136c985678cd4d27a1b8c6329604903262e803000000000000125210751e76e8199196d454941c45d1b3a323e803000000000000220020000000c4a5cad46221b2a187905e5266362b99d5e91c6ce24d165dab93e8643301407f0d9bc098c5439ff611507b6a7d403047ed4e0b883f293db19d4e109d350a24f790acb55547384ff2a23fcfde0eba9af7cebc321c19cfc4817ecd47d50c2cd854000000", + "txid": "062383a7c9a19a2768939087a5c89826a4ea3531080f20cc06aa1cbf431be505" } } ], - "example_json_response": [ - { - "tx": "02000000000101b75863b811587b4c15bb94d9285c31d6369b8ff609e44de399936f8acb268f600000000000fdffffff03050d000000000000160014d0eac62fdcee2d1881259be9cda4c43de9050db8ae0800000000000016001427213e2217b4f56bd19b6c8393dc9f61be691233d4b5f5050000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a0247304402203a001463da125de5615ff1c18f9cd4a1d2a138c91d40189d350821ac8fb3ae4f02207a507eec27e15fe43476233cd9fe8b690ebd265073a58ed18ff79a1416886f18012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", - "txid": "94e803b98257855569d35b675d65fb4fa0061a8b5f828992e2104a2882bb18bf" - }, - { - "tx": "02000000000101dc5a50dfbafc30697b930b44e763ff7a255475d17d975fa0e2003431312098cf0100000000fdffffff09e803000000000000225120000000c4a5cad46221b2a187905e5266362b99d5e91c6ce24d165dab93e86433e803000000000000046002751ee8030000000000002a5128751e76e8199196d454941c45d1b3a323f1433bd6751e76e8199196d454941c45d1b3a323f1433bd6e80300000000000022512079be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f817983b939700000000002251200518e92cd94e0f62c06f126dff98b9abe79b7ed845a156d5245678e26554475de803000000000000160014751e76e8199196d454941c45d1b3a323f1433bd6e8030000000000002200201863143c14c5166804bd19203356da136c985678cd4d27a1b8c6329604903262e803000000000000125210751e76e8199196d454941c45d1b3a323e803000000000000220020000000c4a5cad46221b2a187905e5266362b99d5e91c6ce24d165dab93e8643301407f0d9bc098c5439ff611507b6a7d403047ed4e0b883f293db19d4e109d350a24f790acb55547384ff2a23fcfde0eba9af7cebc321c19cfc4817ecd47d50c2cd854000000", - "txid": "062383a7c9a19a2768939087a5c89826a4ea3531080f20cc06aa1cbf431be505" - } - ], "errors": [ "On failure, an error is reported and the withdrawal transaction is not created.", "", @@ -22703,30 +22858,32 @@ "errors": [ "If an unrecognized address type is requested an error message will be returned." ], - "example_json_request": [ + "json_example": [ { - "id": "example:newaddr#1", - "method": "newaddr", - "params": { - "addresstype": null + "request": { + "id": "example:newaddr#1", + "method": "newaddr", + "params": { + "addresstype": null + } + }, + "response": { + "bech32": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf" } }, { - "id": "example:newaddr#2", - "method": "newaddr", - "params": { - "addresstype": "bech32" + "request": { + "id": "example:newaddr#2", + "method": "newaddr", + "params": { + "addresstype": "bech32" + } + }, + "response": { + "bech32": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf" } } ], - "example_json_response": [ - { - "bech32": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf" - }, - { - "bech32": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf" - } - ], "author": [ "Felix <> is mainly responsible." ], @@ -22806,26 +22963,28 @@ } } ], - "example_json_request": [ + "json_example": [ { - "id": "example:notifications#1", - "method": "notifications", - "params": { - "enable": true - } + "request": { + "id": "example:notifications#1", + "method": "notifications", + "params": { + "enable": true + } + }, + "response": {} }, { - "id": "example:notifications#2", - "method": "notifications", - "params": { - "enable": false - } + "request": { + "id": "example:notifications#2", + "method": "notifications", + "params": { + "enable": false + } + }, + "response": {} } ], - "example_json_response": [ - {}, - {} - ], "author": [ "Rusty Russell <> wrote the initial version of this man page." ], @@ -23000,43 +23159,45 @@ "- -1: Catchall nonspecific error.", "- 1000: Offer with this offer_id already exists (but is not active)." ], - "example_json_request": [ + "json_example": [ { - "id": "example:offer#1", - "method": "offer", - "params": { - "amount": "1msat", - "description": "test for 1msat" + "request": { + "id": "example:offer#1", + "method": "offer", + "params": { + "amount": "1msat", + "description": "test for 1msat" + } + }, + "response": { + "offer_id": "f61cca153d1948dade19349792d9bcdc9cef687fd27db0b553a67979f55aae48", + "active": true, + "single_use": false, + "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqyqs5rn5v4ehggrxdaezqvtdwdshg93pqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq63s", + "used": false, + "created": true } }, { - "id": "example:offer#2", - "method": "offer", - "params": { - "amount": "100000sat", - "description": "quantity_max test", - "recurrence": "1week" + "request": { + "id": "example:offer#2", + "method": "offer", + "params": { + "amount": "100000sat", + "description": "quantity_max test", + "recurrence": "1week" + } + }, + "response": { + "offer_id": "f7a501e51e2a90d032150b9100b1977c625f05cfda22469bdc81d8a20b1e303f", + "active": true, + "single_use": false, + "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqszltcgqpgghzatpde6xjaretakkz7pqw3jhxaqkyypxdeze35wncs2l2u4gfzyrpds00e6yakfrt6ctrw5n9qanzhqr2xq6qgqsw", + "used": false, + "created": true } } ], - "example_json_response": [ - { - "offer_id": "f61cca153d1948dade19349792d9bcdc9cef687fd27db0b553a67979f55aae48", - "active": true, - "single_use": false, - "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqyqs5rn5v4ehggrxdaezqvtdwdshg93pqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq63s", - "used": false, - "created": true - }, - { - "offer_id": "f7a501e51e2a90d032150b9100b1977c625f05cfda22469bdc81d8a20b1e303f", - "active": true, - "single_use": false, - "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqszltcgqpgghzatpde6xjaretakkz7pqw3jhxaqkyypxdeze35wncs2l2u4gfzyrpds00e6yakfrt6ctrw5n9qanzhqr2xq6qgqsw", - "used": false, - "created": true - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -23107,22 +23268,22 @@ "- 311: Unknown channel id.", "- 312: Channel in an invalid state" ], - "example_json_request": [ + "json_example": [ { - "id": "example:openchannel_abort#1", - "method": "openchannel_abort", - "params": { - "channel_id": "aec3dfd0c7643a23b679cd2e493c053f8fdf621ff2624949f9582c4118b818c6" + "request": { + "id": "example:openchannel_abort#1", + "method": "openchannel_abort", + "params": { + "channel_id": "aec3dfd0c7643a23b679cd2e493c053f8fdf621ff2624949f9582c4118b818c6" + } + }, + "response": { + "channel_id": "aec3dfd0c7643a23b679cd2e493c053f8fdf621ff2624949f9582c4118b818c6", + "channel_canceled": true, + "reason": "Abort requested" } } ], - "example_json_response": [ - { - "channel_id": "aec3dfd0c7643a23b679cd2e493c053f8fdf621ff2624949f9582c4118b818c6", - "channel_canceled": true, - "reason": "Abort requested" - } - ], "author": [ "Lisa Neigut <> is mainly responsible." ], @@ -23495,75 +23656,77 @@ "If you sent a *request_amt* and the peer supports `option_will_fund` and is interested in leasing you liquidity in this channel, returns their updated channel fee max (*channel_fee_proportional_basis*, *channel_fee_base_msat*), updated rate card for the lease fee (*lease_fee_proportional_basis*, *lease_fee_base_sat*) and their on-chain weight *weight_charge*, which will be added to the lease fee at a rate of *funding_feerate* * *weight_charge* / 1000." ] }, - "example_json_request": [ - { - "id": "example:openchannel_init#1", - "method": "openchannel_init", - "params": { - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "amount": 999000, - "initialpsbt": "cHNidP8BADMCAAAAAYbThUhSzYr7ph6Z434bdcW7eoirYOFMmUt2GXZ79sF/AQAAAAD9////AGYAAAAAAQDeAgAAAAABARVD4QKlmwy8SNcNypf1o9TzbIFZjj4dqVzHAL0SLDoTAAAAAAD9////AjOv9ikBAAAAFgAUXJGglH7At5HOVY4ZHp0+19kv655AQg8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgVIxRXqIykOOxm/6YPaFFx2Qh1618qlXPUhDiliVQ2KUCIHQcHniUTcm1XT8SyRE8ev52jm0uiIYum15XcR/tPh+NASEC3Pby7xL4+Ig/Z8TchQ0QT1upLGet3da8qjSjgHO9LOJlAAAAAQEfQEIPAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", - "commitment_feerate": null, - "funding_feerate": null, - "announce": true, - "close_to": null, - "request_amt": null, - "channel_type": [ - 12, - 22 - ] - } - }, - { - "id": "example:openchannel_init#2", - "method": "openchannel_init", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount": 16777216, - "initialpsbt": "cHNidP8BADMCAAAAAQVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAAAAAAD9////AGYAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", - "commitment_feerate": null, - "funding_feerate": null, - "announce": true, - "close_to": null, - "request_amt": null, - "channel_type": null - } - } - ], - "example_json_response": [ + "json_example": [ { - "channel_id": "53fa2b1ca0d8f21abeaaac0495ab9925cdfaf2ca8b04dbe4aeb061823e1ff2c8", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABARVD4QKlmwy8SNcNypf1o9TzbIFZjj4dqVzHAL0SLDoTAAAAAAD9////AjOv9ikBAAAAFgAUXJGglH7At5HOVY4ZHp0+19kv655AQg8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgVIxRXqIykOOxm/6YPaFFx2Qh1618qlXPUhDiliVQ2KUCIHQcHniUTcm1XT8SyRE8ev52jm0uiIYum15XcR/tPh+NASEC3Pby7xL4+Ig/Z8TchQ0QT1upLGet3da8qjSjgHO9LOJlAAAAAQEfQEIPAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIIbThUhSzYr7ph6Z434bdcW7eoirYOFMmUt2GXZ79sF/AQ8EAQAAAAEQBP3///8M/AlsaWdodG5pbmcBCMCDK/6LyRi8AAEDCFg+DwAAAAAAAQQiACDYM+8ZRsbTj0OCG/yzqLt2buFQn9LuMPDZqFFcgmCmfAz8CWxpZ2h0bmluZwEIchtFHfZ5FBgA", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] + "request": { + "id": "example:openchannel_init#1", + "method": "openchannel_init", + "params": { + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "amount": 999000, + "initialpsbt": "cHNidP8BADMCAAAAAYbThUhSzYr7ph6Z434bdcW7eoirYOFMmUt2GXZ79sF/AQAAAAD9////AGYAAAAAAQDeAgAAAAABARVD4QKlmwy8SNcNypf1o9TzbIFZjj4dqVzHAL0SLDoTAAAAAAD9////AjOv9ikBAAAAFgAUXJGglH7At5HOVY4ZHp0+19kv655AQg8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgVIxRXqIykOOxm/6YPaFFx2Qh1618qlXPUhDiliVQ2KUCIHQcHniUTcm1XT8SyRE8ev52jm0uiIYum15XcR/tPh+NASEC3Pby7xL4+Ig/Z8TchQ0QT1upLGet3da8qjSjgHO9LOJlAAAAAQEfQEIPAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", + "commitment_feerate": null, + "funding_feerate": null, + "announce": true, + "close_to": null, + "request_amt": null, + "channel_type": [ + 12, + 22 + ] + } }, - "commitments_secured": false, - "funding_serial": 8222241539686471000, - "requires_confirmed_inputs": false + "response": { + "channel_id": "53fa2b1ca0d8f21abeaaac0495ab9925cdfaf2ca8b04dbe4aeb061823e1ff2c8", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABARVD4QKlmwy8SNcNypf1o9TzbIFZjj4dqVzHAL0SLDoTAAAAAAD9////AjOv9ikBAAAAFgAUXJGglH7At5HOVY4ZHp0+19kv655AQg8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgVIxRXqIykOOxm/6YPaFFx2Qh1618qlXPUhDiliVQ2KUCIHQcHniUTcm1XT8SyRE8ev52jm0uiIYum15XcR/tPh+NASEC3Pby7xL4+Ig/Z8TchQ0QT1upLGet3da8qjSjgHO9LOJlAAAAAQEfQEIPAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIIbThUhSzYr7ph6Z434bdcW7eoirYOFMmUt2GXZ79sF/AQ8EAQAAAAEQBP3///8M/AlsaWdodG5pbmcBCMCDK/6LyRi8AAEDCFg+DwAAAAAAAQQiACDYM+8ZRsbTj0OCG/yzqLt2buFQn9LuMPDZqFFcgmCmfAz8CWxpZ2h0bmluZwEIchtFHfZ5FBgA", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "commitments_secured": false, + "funding_serial": 8222241539686471000, + "requires_confirmed_inputs": false + } }, { - "channel_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCLR8RjOq9lmcAAEDCAAAAAEAAAAAAQQiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQz8CWxpZ2h0bmluZwEIZZtc7LD4y9YA", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] + "request": { + "id": "example:openchannel_init#2", + "method": "openchannel_init", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount": 16777216, + "initialpsbt": "cHNidP8BADMCAAAAAQVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAAAAAAD9////AGYAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", + "commitment_feerate": null, + "funding_feerate": null, + "announce": true, + "close_to": null, + "request_amt": null, + "channel_type": null + } }, - "commitments_secured": false, - "funding_serial": 7321547790872006000, - "requires_confirmed_inputs": false + "response": { + "channel_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCLR8RjOq9lmcAAEDCAAAAAEAAAAAAQQiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQz8CWxpZ2h0bmluZwEIZZtc7LD4y9YA", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "commitments_secured": false, + "funding_serial": 7321547790872006000, + "requires_confirmed_inputs": false + } } ], "errors": [ @@ -23875,57 +24038,59 @@ "- 311: Unknown channel id.", "- 312: Channel in an invalid state" ], - "example_json_request": [ - { - "id": "example:openchannel_update#1", - "method": "openchannel_update", - "params": { - "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA" - } - }, - { - "id": "example:openchannel_update#2", - "method": "openchannel_update", - "params": { - "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA" - } - } - ], - "example_json_response": [ + "json_example": [ { - "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] + "request": { + "id": "example:openchannel_update#1", + "method": "openchannel_update", + "params": { + "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA" + } }, - "commitments_secured": true, - "funding_outnum": 0 + "response": { + "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "commitments_secured": true, + "funding_outnum": 0 + } }, { - "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] + "request": { + "id": "example:openchannel_update#2", + "method": "openchannel_update", + "params": { + "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA" + } }, - "commitments_secured": true, - "funding_outnum": 0, - "close_to": "5120eed745804da9784cc203f563efa99ffa54fdf01b137bc964e63c3124070ffbe6" + "response": { + "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "commitments_secured": true, + "funding_outnum": 0, + "close_to": "5120eed745804da9784cc203f563efa99ffa54fdf01b137bc964e63c3124070ffbe6" + } } ], "author": [ @@ -23981,48 +24146,54 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:parsefeerate#1", - "method": "parsefeerate", - "params": [ - "unilateral_close" - ] - }, - { - "id": "example:parsefeerate#2", - "method": "parsefeerate", - "params": [ - "9999perkw" - ] - }, - { - "id": "example:parsefeerate#3", - "method": "parsefeerate", - "params": [ - 10000 - ] - }, - { - "id": "example:parsefeerate#4", - "method": "parsefeerate", - "params": [ - "urgent" - ] - } - ], - "example_json_response": [ - { - "perkw": 11000 + "request": { + "id": "example:parsefeerate#1", + "method": "parsefeerate", + "params": [ + "unilateral_close" + ] + }, + "response": { + "perkw": 11000 + } }, { - "perkw": 9999 + "request": { + "id": "example:parsefeerate#2", + "method": "parsefeerate", + "params": [ + "9999perkw" + ] + }, + "response": { + "perkw": 9999 + } }, { - "perkw": 2500 + "request": { + "id": "example:parsefeerate#3", + "method": "parsefeerate", + "params": [ + 10000 + ] + }, + "response": { + "perkw": 2500 + } }, { - "perkw": 11000 + "request": { + "id": "example:parsefeerate#4", + "method": "parsefeerate", + "params": [ + "urgent" + ] + }, + "response": { + "perkw": 11000 + } } ], "errors": [ @@ -24262,36 +24433,36 @@ "", "The *data* field of errors will include statistics *getroute_tries* and *sendpay_tries*. It will also contain a *failures* field with detailed data about routing errors." ], - "example_json_request": [ - { - "id": "example:pay#1", - "method": "pay", - "params": { - "bolt11": "lni1qqgxr7gha7gusyg83lsr8qcqg4axgq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqtypg3hgetnwsszycn0d36rzv3zypjx2umrwf5hqarfdahzcg8sn7jmpuyl423pvggzvmj9nrga83q474e2sjygxzmq7ln5fmvjxh4skxafx2pmx9wqx5v9qgqxyfhyvyg6pdvu4tcjvpp7kkal9rp57wj7xv4pl3ajku70rzy3pavzzqjz06c8s2vvmrpjlkcse0txx0gmc6jalqqxmeyjm75qcnfnqxwyt2sfsqnxu3vc68fug904w25y3zpskc8huazwmy34av93h2fjswe3tsp4rqpe8qlx9xssexfc0aguke3q6u0jgw2qmn008mzu04mkmqmjmhes3gcpqdqdnzl270s48vsp635rd4jm04snvgkcp65qlkgp8qztu2mdp7c5uqpj2rll3pzu56st537rct3v62gfqeamzthjuwkr0pkvsdnnffpn4sq9sz0lryaufktx0nfxlffum3yesqev5gwqqqqqqqqqqqqqqqzsqqqqqqqqqqqqr5jt9hav2gqqqqqq5szxtvwkyz5zq2000hlwvadejz366lqjt9sd2j4rf5tfd9rgmmyegt4dqd34cf6v4gqkfvppqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq633uzqn3n74ccym4wcvq20vsx7lmk450kprpvlrh4cukk8xy9ptjcef4rnhytnkyn4vnxxtd57yeaksze2s30y26cs6u3rjd9322eg9puk24q", - "amount_msat": null, - "label": null, - "riskfactor": null, - "maxfeepercent": null, - "retry_for": null, - "maxdelay": null, - "exemptfee": null, - "localinvreqid": null, - "exclude": null, - "maxfee": null, - "description": null - } - } - ], - "example_json_response": [ + "json_example": [ { - "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "payment_hash": "29ef7dfee675b990a3ad7c125960d54aa34d16969468dec9942ead03635c274c", - "created_at": 1706153504.76628, - "parts": 1, - "amount_msat": 100, - "amount_sent_msat": 100, - "payment_preimage": "6634c1b549c6615d234832f377e06d5a5ab088c40cebdc5cfb8c1262030abcad", - "status": "complete" + "request": { + "id": "example:pay#1", + "method": "pay", + "params": { + "bolt11": "lni1qqgxr7gha7gusyg83lsr8qcqg4axgq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqtypg3hgetnwsszycn0d36rzv3zypjx2umrwf5hqarfdahzcg8sn7jmpuyl423pvggzvmj9nrga83q474e2sjygxzmq7ln5fmvjxh4skxafx2pmx9wqx5v9qgqxyfhyvyg6pdvu4tcjvpp7kkal9rp57wj7xv4pl3ajku70rzy3pavzzqjz06c8s2vvmrpjlkcse0txx0gmc6jalqqxmeyjm75qcnfnqxwyt2sfsqnxu3vc68fug904w25y3zpskc8huazwmy34av93h2fjswe3tsp4rqpe8qlx9xssexfc0aguke3q6u0jgw2qmn008mzu04mkmqmjmhes3gcpqdqdnzl270s48vsp635rd4jm04snvgkcp65qlkgp8qztu2mdp7c5uqpj2rll3pzu56st537rct3v62gfqeamzthjuwkr0pkvsdnnffpn4sq9sz0lryaufktx0nfxlffum3yesqev5gwqqqqqqqqqqqqqqqzsqqqqqqqqqqqqr5jt9hav2gqqqqqq5szxtvwkyz5zq2000hlwvadejz366lqjt9sd2j4rf5tfd9rgmmyegt4dqd34cf6v4gqkfvppqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq633uzqn3n74ccym4wcvq20vsx7lmk450kprpvlrh4cukk8xy9ptjcef4rnhytnkyn4vnxxtd57yeaksze2s30y26cs6u3rjd9322eg9puk24q", + "amount_msat": null, + "label": null, + "riskfactor": null, + "maxfeepercent": null, + "retry_for": null, + "maxdelay": null, + "exemptfee": null, + "localinvreqid": null, + "exclude": null, + "maxfee": null, + "description": null + } + }, + "response": { + "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "payment_hash": "29ef7dfee675b990a3ad7c125960d54aa34d16969468dec9942ead03635c274c", + "created_at": 1706153504.76628, + "parts": 1, + "amount_msat": 100, + "amount_sent_msat": 100, + "payment_preimage": "6634c1b549c6615d234832f377e06d5a5ab088c40cebdc5cfb8c1262030abcad", + "status": "complete" + } } ], "author": [ @@ -24358,22 +24529,32 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:ping#1", - "method": "ping", - "params": { - "len": 128, - "pongbytes": 128 + "request": { + "id": "example:ping#1", + "method": "ping", + "params": { + "len": 128, + "pongbytes": 128 + } + }, + "response": { + "totlen": 132 } }, { - "id": "example:ping#2", - "method": "ping", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "len": 1000, - "pongbytes": 65535 + "request": { + "id": "example:ping#2", + "method": "ping", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "len": 1000, + "pongbytes": 65535 + } + }, + "response": { + "totlen": 0 } } ], @@ -24382,14 +24563,6 @@ "", "- -32602: Error in given parameters or we're already waiting for a ping response from peer." ], - "example_json_response": [ - { - "totlen": 132 - }, - { - "totlen": 0 - } - ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." @@ -24575,107 +24748,109 @@ "errors": [ "On error, the reason why the action could not be taken upon the plugin is returned." ], - "example_json_request": [ - { - "id": "example:plugin#1", - "method": "plugin", - "params": [ - "list" - ] - }, + "json_example": [ { - "id": "example:plugin#2", - "method": "plugin", - "params": { - "subcommand": "stop", - "plugin": "fail_htlcs.py" + "request": { + "id": "example:plugin#1", + "method": "plugin", + "params": [ + "list" + ] + }, + "response": { + "command": "list", + "plugins": [ + { + "name": "~/lightning/plugins/autoclean", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/chanbackup", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/bcli", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/commando", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/funder", + "active": true, + "dynamic": true + }, + { + "name": "~/lightning/plugins/topology", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/keysend", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/offers", + "active": true, + "dynamic": true + }, + { + "name": "~/lightning/plugins/pay", + "active": true, + "dynamic": true + }, + { + "name": "~/lightning/plugins/txprepare", + "active": true, + "dynamic": true + }, + { + "name": "~/lightning/plugins/cln-renepay", + "active": true, + "dynamic": true + }, + { + "name": "~/lightning/plugins/spenderp", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/sql", + "active": true, + "dynamic": true + }, + { + "name": "~/lightning/plugins/bookkeeper", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/target/debug/examples/cln-plugin-startup", + "active": true, + "dynamic": false + } + ] } - } - ], - "example_json_response": [ - { - "command": "list", - "plugins": [ - { - "name": "~/lightning/plugins/autoclean", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/chanbackup", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/bcli", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/commando", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/funder", - "active": true, - "dynamic": true - }, - { - "name": "~/lightning/plugins/topology", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/keysend", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/offers", - "active": true, - "dynamic": true - }, - { - "name": "~/lightning/plugins/pay", - "active": true, - "dynamic": true - }, - { - "name": "~/lightning/plugins/txprepare", - "active": true, - "dynamic": true - }, - { - "name": "~/lightning/plugins/cln-renepay", - "active": true, - "dynamic": true - }, - { - "name": "~/lightning/plugins/spenderp", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/sql", - "active": true, - "dynamic": true - }, - { - "name": "~/lightning/plugins/bookkeeper", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/target/debug/examples/cln-plugin-startup", - "active": true, - "dynamic": false - } - ] }, { - "command": "stop", - "result": "Successfully stopped fail_htlcs.py." + "request": { + "id": "example:plugin#2", + "method": "plugin", + "params": { + "subcommand": "stop", + "plugin": "fail_htlcs.py" + } + }, + "response": { + "command": "stop", + "result": "Successfully stopped fail_htlcs.py." + } } ], "author": [ @@ -24840,28 +25015,30 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:recover#1", - "method": "recover", - "params": { - "hsmsecret": "cl10leetsd35kw6r5de5kueedxgqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqdeuq7xuh94k9g" - } + "request": { + "id": "example:recover#1", + "method": "recover", + "params": { + "hsmsecret": "cl10leetsd35kw6r5de5kueedxgqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqdeuq7xuh94k9g" + } + }, + "response": {} }, { - "id": "example:recover#2", - "method": "recover", - "params": { - "hsmsecret": "6c696768746e696e672d31000000000000000000000000000000000000000000" + "request": { + "id": "example:recover#2", + "method": "recover", + "params": { + "hsmsecret": "6c696768746e696e672d31000000000000000000000000000000000000000000" + } + }, + "response": { + "result": "Recovery restart in progress" } } ], - "example_json_response": [ - {}, - { - "result": "Recovery restart in progress" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -24915,22 +25092,22 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:recoverchannel#1", - "method": "recoverchannel", - "params": [ - [ - "0000000000000001c3a7b9d74a174497122bc52d74d6d69836acadc77e0429c6d8b68b48d5c9139a022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d5904017f0000019f0bc3a7b9d74a174497122bc52d74d6d69836acadc77e0429c6d8b68b48d5c9139a0000000000000000000186a000021000" + "request": { + "id": "example:recoverchannel#1", + "method": "recoverchannel", + "params": [ + [ + "0000000000000001c3a7b9d74a174497122bc52d74d6d69836acadc77e0429c6d8b68b48d5c9139a022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d5904017f0000019f0bc3a7b9d74a174497122bc52d74d6d69836acadc77e0429c6d8b68b48d5c9139a0000000000000000000186a000021000" + ] ] - ] - } - ], - "example_json_response": [ - { - "stubs": [ - "c3a7b9d74a174497122bc52d74d6d69836acadc77e0429c6d8b68b48d5c9139a" - ] + }, + "response": { + "stubs": [ + "c3a7b9d74a174497122bc52d74d6d69836acadc77e0429c6d8b68b48d5c9139a" + ] + } } ], "author": [ @@ -25106,45 +25283,47 @@ "- 210: Payment timed out without a payment in progress.", "- 212: Invoice is invalid." ], - "example_json_request": [ + "json_example": [ { - "id": "example:renepay#1", - "method": "renepay", - "params": { - "invstring": "lnbcrt1230n1pjmxj9jsp5suc4cag0lv3wemllkvms56e6ll0w867cczqfttuu8cpfl089f9kspp56wvxtdh8fxg5r5y3kg3klxceakqaydskwzatga25v95da8nzkmwqdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqkmyhymt0j7hy38vzqxx465s4ys0fg78flnjqfx4clvdq9mrmgglpcnjrrnhtk7maa87pfvjez88hke8w97zvuecwswaf9gzyqlsthegpza67eu" + "request": { + "id": "example:renepay#1", + "method": "renepay", + "params": { + "invstring": "lnbcrt1230n1pjmxj9jsp5suc4cag0lv3wemllkvms56e6ll0w867cczqfttuu8cpfl089f9kspp56wvxtdh8fxg5r5y3kg3klxceakqaydskwzatga25v95da8nzkmwqdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqkmyhymt0j7hy38vzqxx465s4ys0fg78flnjqfx4clvdq9mrmgglpcnjrrnhtk7maa87pfvjez88hke8w97zvuecwswaf9gzyqlsthegpza67eu" + } + }, + "response": { + "payment_preimage": "0a3fd704b34f47d6e306dbac78141753be83848d3a19725c972abfc367dcc591", + "payment_hash": "d39865b6e7499141d091b2236f9b19ed81d2361670bab475546168de9e62b6dc", + "created_at": 1706248370.6267352, + "parts": 1, + "amount_msat": 123000, + "amount_sent_msat": 123000, + "status": "complete", + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" } }, { - "id": "example:renepay#2", - "method": "renepay", - "params": { - "invstring": "lnbcrt1pja0f9asp50kzadmeyy78eymjvhnlk5dznl3g5k5x8agh52ewjtg0jclas4ylspp5crsutd9hg05lxyhzphdcuyng6z3knrsdae83mxwawa842gz3vj3sdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqr5yzhxmup4muyaz6x8u2dy4qyu9t5qzuf5k9xayvj5kg7tve60gjk4jrv2l76exnj2xkuzhtwky23pkkxedzy6p9yrsgyqdwj7dv5gsp4zcw6v", - "amount_msat": 548925 + "request": { + "id": "example:renepay#2", + "method": "renepay", + "params": { + "invstring": "lnbcrt1pja0f9asp50kzadmeyy78eymjvhnlk5dznl3g5k5x8agh52ewjtg0jclas4ylspp5crsutd9hg05lxyhzphdcuyng6z3knrsdae83mxwawa842gz3vj3sdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqr5yzhxmup4muyaz6x8u2dy4qyu9t5qzuf5k9xayvj5kg7tve60gjk4jrv2l76exnj2xkuzhtwky23pkkxedzy6p9yrsgyqdwj7dv5gsp4zcw6v", + "amount_msat": 548925 + } + }, + "response": { + "payment_preimage": "a635e92d024beebfc58519e6544888aa560ba3bcaba7e74924e4b8432eaa56f5", + "payment_hash": "c0e1c5b4b743e9f312e20ddb8e1268d0a3698e0dee4f1d99dd774f55205164a3", + "created_at": 1708631229.7841823, + "parts": 1, + "amount_msat": 548925, + "amount_sent_msat": 548925, + "status": "complete", + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" } } ], - "example_json_response": [ - { - "payment_preimage": "0a3fd704b34f47d6e306dbac78141753be83848d3a19725c972abfc367dcc591", - "payment_hash": "d39865b6e7499141d091b2236f9b19ed81d2361670bab475546168de9e62b6dc", - "created_at": 1706248370.6267352, - "parts": 1, - "amount_msat": 123000, - "amount_sent_msat": 123000, - "status": "complete", - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" - }, - { - "payment_preimage": "a635e92d024beebfc58519e6544888aa560ba3bcaba7e74924e4b8432eaa56f5", - "payment_hash": "c0e1c5b4b743e9f312e20ddb8e1268d0a3698e0dee4f1d99dd774f55205164a3", - "created_at": 1708631229.7841823, - "parts": 1, - "amount_msat": 548925, - "amount_sent_msat": 548925, - "status": "complete", - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" - } - ], "author": [ "Eduardo Quintana-Miranda <> is mainly responsible." ], @@ -25395,125 +25574,127 @@ "", "- -32602: Invalid parameter, such as specifying a spent/reserved input in *psbt*." ], - "example_json_request": [ + "json_example": [ { - "id": "example:reserveinputs#1", - "method": "reserveinputs", - "params": { - "psbt": "cHNidP8BAFwCAAAAAkwJVUqB0xXTO7JZ3PnPdGnxoYfQxhU+xqXGFYXsyX0RAAAAAAD9////TAlVSoHTFdM7slnc+c90afGhh9DGFT7GpcYVhezJfREBAAAAAP3///8AAAAAAAAAAA==", - "exclusive": true, - "reserve": null - } - }, - { - "id": "example:reserveinputs#2", - "method": "reserveinputs", - "params": { - "psbt": "cHNidP8BAP32AQIAAAAMgnW099dbh1uD153ih5eU5WhluynLxekXjAOjkEdNBg8BAAAAAP3///9FWKQt8C+1y4741+beFSqWAaj9DuvzHNpxvpxS+GB8lwEAAAAA/f///6E5TAGqktI29Oso6b9kZZoAFFGGvpJQUM8VO+3LMTlmAAAAAAD9////nSDT7hrkuoQtAV1yNnbpkJsB5ifKoM2zP+CcLPfis1gBAAAAAP3///+P1rW90UXfD0gIk58h3sXxxy3ZfJJLP0H1I4Jpzy/87QEAAAAA/f///w0UKZ/s9DnPpV+FJ8h2BEI7tl+qVxSGRFRv9FYw4girAQAAAAD9////EPNsUFrEOZyfjbqbh8rfHQ4C9RQECw12n3c1yhFqkzoAAAAAAP3///8QW9LEsSmuvSnvVzy+FDktM7ewQmZnIJI/TJMahLmSzwEAAAAA/f///+4edbWRHDdRJcMeHHElgSmb+nENPsz/g/0AmAEU6hXeAAAAAAD9////T15YLGmk7HBsrL+awdcxi3db3esp8AcCTS9XGrEnfoAAAAAAAP3///8q7xInvEk7J0Ir9cpKXqU2lArUskkYLrimIE0+Yb6a2QEAAAAA/f///8hBLKyMa2zRJqwNOk7DmsDIfG7IvJtQiJ+QnkkHl6atAAAAAAD9////AAAAAAAAAAAAAAAAAAAAAAAA", - "exclusive": false, - "reserve": null - } - } - ], - "example_json_response": [ - { - "reservations": [ - { - "txid": "117dc9ec8515c6a5c63e15c6d087a1f16974cff9dc59b23bd315d3814a55094c", - "vout": 1, - "was_reserved": false, - "reserved": true, - "reserved_to_block": 175 + "request": { + "id": "example:reserveinputs#1", + "method": "reserveinputs", + "params": { + "psbt": "cHNidP8BAFwCAAAAAkwJVUqB0xXTO7JZ3PnPdGnxoYfQxhU+xqXGFYXsyX0RAAAAAAD9////TAlVSoHTFdM7slnc+c90afGhh9DGFT7GpcYVhezJfREBAAAAAP3///8AAAAAAAAAAA==", + "exclusive": true, + "reserve": null } - ] + }, + "response": { + "reservations": [ + { + "txid": "117dc9ec8515c6a5c63e15c6d087a1f16974cff9dc59b23bd315d3814a55094c", + "vout": 1, + "was_reserved": false, + "reserved": true, + "reserved_to_block": 175 + } + ] + } }, { - "reservations": [ - { - "txid": "0f064d4790a3038c17e9c5cb29bb6568e5949787e29dd7835b875bd7f7b47582", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "977c60f8529cbe71da1cf3eb0efda801962a15dee6d7f88ecbb52ff02da45845", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "663931cbed3b15cf505092be865114009a6564bfe928ebf436d292aa014c39a1", - "vout": 0, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "58b3e2f72c9ce03fb3cda0ca27e6019b90e97636725d012d84bae41aeed3209d", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "edfc2fcf698223f5413f4b927cd92dc7f1c5de219f9308480fdf45d1bdb5d68f", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "ab08e23056f46f5444861457aa5fb63b420476c827855fa5cf39f4ec9f29140d", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "3a936a11ca35779f760d0b0414f5020e1ddfca879bba8d9f9c39c45a506cf310", - "vout": 0, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "cf92b9841a934c3f9220676642b0b7332d3914be3c57ef29bdae29b1c4d25b10", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "de15ea14019800fd83ffcc3e0d71fa9b298125711c1ec32551371c91b5751eee", - "vout": 0, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "807e27b11a572f4d0207f029ebdd5b778b31d7c19abfac6c70eca4692c585e4f", - "vout": 0, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "d99abe613e4d20a6b82e1849b2d40a9436a55e4acaf52b42273b49bc2712ef2a", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "ada69707499e909f88509bbcc86e7cc8c09ac34e3a0dac26d16c6b8cac2c41c8", - "vout": 0, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 + "request": { + "id": "example:reserveinputs#2", + "method": "reserveinputs", + "params": { + "psbt": "cHNidP8BAP32AQIAAAAMgnW099dbh1uD153ih5eU5WhluynLxekXjAOjkEdNBg8BAAAAAP3///9FWKQt8C+1y4741+beFSqWAaj9DuvzHNpxvpxS+GB8lwEAAAAA/f///6E5TAGqktI29Oso6b9kZZoAFFGGvpJQUM8VO+3LMTlmAAAAAAD9////nSDT7hrkuoQtAV1yNnbpkJsB5ifKoM2zP+CcLPfis1gBAAAAAP3///+P1rW90UXfD0gIk58h3sXxxy3ZfJJLP0H1I4Jpzy/87QEAAAAA/f///w0UKZ/s9DnPpV+FJ8h2BEI7tl+qVxSGRFRv9FYw4girAQAAAAD9////EPNsUFrEOZyfjbqbh8rfHQ4C9RQECw12n3c1yhFqkzoAAAAAAP3///8QW9LEsSmuvSnvVzy+FDktM7ewQmZnIJI/TJMahLmSzwEAAAAA/f///+4edbWRHDdRJcMeHHElgSmb+nENPsz/g/0AmAEU6hXeAAAAAAD9////T15YLGmk7HBsrL+awdcxi3db3esp8AcCTS9XGrEnfoAAAAAAAP3///8q7xInvEk7J0Ir9cpKXqU2lArUskkYLrimIE0+Yb6a2QEAAAAA/f///8hBLKyMa2zRJqwNOk7DmsDIfG7IvJtQiJ+QnkkHl6atAAAAAAD9////AAAAAAAAAAAAAAAAAAAAAAAA", + "exclusive": false, + "reserve": null } - ] + }, + "response": { + "reservations": [ + { + "txid": "0f064d4790a3038c17e9c5cb29bb6568e5949787e29dd7835b875bd7f7b47582", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "977c60f8529cbe71da1cf3eb0efda801962a15dee6d7f88ecbb52ff02da45845", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "663931cbed3b15cf505092be865114009a6564bfe928ebf436d292aa014c39a1", + "vout": 0, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "58b3e2f72c9ce03fb3cda0ca27e6019b90e97636725d012d84bae41aeed3209d", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "edfc2fcf698223f5413f4b927cd92dc7f1c5de219f9308480fdf45d1bdb5d68f", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "ab08e23056f46f5444861457aa5fb63b420476c827855fa5cf39f4ec9f29140d", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "3a936a11ca35779f760d0b0414f5020e1ddfca879bba8d9f9c39c45a506cf310", + "vout": 0, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "cf92b9841a934c3f9220676642b0b7332d3914be3c57ef29bdae29b1c4d25b10", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "de15ea14019800fd83ffcc3e0d71fa9b298125711c1ec32551371c91b5751eee", + "vout": 0, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "807e27b11a572f4d0207f029ebdd5b778b31d7c19abfac6c70eca4692c585e4f", + "vout": 0, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "d99abe613e4d20a6b82e1849b2d40a9436a55e4acaf52b42273b49bc2712ef2a", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "ada69707499e909f88509bbcc86e7cc8c09ac34e3a0dac26d16c6b8cac2c41c8", + "vout": 0, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + } + ] + } } ], "author": [ @@ -25578,21 +25759,21 @@ "If any of the above limitations is not respected the method returns an explicit error message stating the issue." ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:sendcustommsg#5", - "method": "sendcustommsg", - "params": { - "node_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "msg": "77770012" + "request": { + "id": "example:sendcustommsg#5", + "method": "sendcustommsg", + "params": { + "node_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "msg": "77770012" + } + }, + "response": { + "status": "Message sent to connectd for delivery" } } ], - "example_json_response": [ - { - "status": "Message sent to connectd for delivery" - } - ], "author": [ "Christian Decker <> is mainly responsible." ], @@ -25804,33 +25985,33 @@ "- 1004: The node making the offer returned an error message.", "- 1005: We timed out waiting for the invoice to be paid" ], - "example_json_request": [ + "json_example": [ { - "id": "example:sendinvoice#1", - "method": "sendinvoice", - "params": { - "invreq": "lnr1qqg804wzdsyn8g4mf2yc22k8xvjpjzstwd5k6urvv5s8getnw3gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02gqsykppqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4nuzqw5w7y7xqm2rushk5a5n3mcuvqel954raykd5nqa830nq9hpd4s4fcnxw266vp9d5c8f3m3w40hmm6gm8akxx3rsnr7d4usunv0x3q8q", - "label": "payme for real!" + "request": { + "id": "example:sendinvoice#1", + "method": "sendinvoice", + "params": { + "invreq": "lnr1qqg804wzdsyn8g4mf2yc22k8xvjpjzstwd5k6urvv5s8getnw3gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02gqsykppqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4nuzqw5w7y7xqm2rushk5a5n3mcuvqel954raykd5nqa830nq9hpd4s4fcnxw266vp9d5c8f3m3w40hmm6gm8akxx3rsnr7d4usunv0x3q8q", + "label": "payme for real!" + } + }, + "response": { + "label": "payme for real!", + "bolt12": "lni1qqg804wzdsyn8g4mf2yc22k8xvjpjzstwd5k6urvv5s8getnw3gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02gqsykppqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4ngycqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky96qmcmtl30xtt7jdakfyhzm8f0gny6f4d2ukx5gurem04z8lfd2wza5qs9pz6wp9vu7cm6n4wmmrz77y4w6z5xv4q93yudkdtkl5zmzdzuawzqqex7gd5v0x0r83pqj82udd542fl4krh50s0dkx47d0hd5wh77g52xxl75ccpkt35mc8n282wslju9ufyys2y8qqqqqqqqqqqqqqqpgqqqqqqqqqqqqp6f9jm7k9yqqqqqq2gpr96l99lfspt25zqnyfgu7hznmt2tzkjdt92d2wc3dsq7keph7w8gudjs46spfzqrlu4gqs9vppqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky9muzqpze8kk43g0wh4h8qlac5lswwesrvsaxcza2f5j90c2h3ts8yzmn9g4mxqe89fngrqny8nf52xxuxep6548etda8lp876jr0nnxgdkdq", + "payment_hash": "4c89473d714f6b52c56935655354ec45b007ad90dfce3a38d942ba8052200ffc", + "amount_msat": 2, + "status": "paid", + "pay_index": 1, + "amount_received_msat": 2, + "paid_at": 1708640865, + "payment_preimage": "305951ab02cb2ea5eb884dbfd8fb110b4e088ecb8338b3e84e8f9c70919c19bf", + "description": "simple test", + "expires_at": 1708640953, + "created_index": 2, + "updated_index": 1 } } ], - "example_json_response": [ - { - "label": "payme for real!", - "bolt12": "lni1qqg804wzdsyn8g4mf2yc22k8xvjpjzstwd5k6urvv5s8getnw3gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02gqsykppqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4ngycqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky96qmcmtl30xtt7jdakfyhzm8f0gny6f4d2ukx5gurem04z8lfd2wza5qs9pz6wp9vu7cm6n4wmmrz77y4w6z5xv4q93yudkdtkl5zmzdzuawzqqex7gd5v0x0r83pqj82udd542fl4krh50s0dkx47d0hd5wh77g52xxl75ccpkt35mc8n282wslju9ufyys2y8qqqqqqqqqqqqqqqpgqqqqqqqqqqqqp6f9jm7k9yqqqqqq2gpr96l99lfspt25zqnyfgu7hznmt2tzkjdt92d2wc3dsq7keph7w8gudjs46spfzqrlu4gqs9vppqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky9muzqpze8kk43g0wh4h8qlac5lswwesrvsaxcza2f5j90c2h3ts8yzmn9g4mxqe89fngrqny8nf52xxuxep6548etda8lp876jr0nnxgdkdq", - "payment_hash": "4c89473d714f6b52c56935655354ec45b007ad90dfce3a38d942ba8052200ffc", - "amount_msat": 2, - "status": "paid", - "pay_index": 1, - "amount_received_msat": 2, - "paid_at": 1708640865, - "payment_preimage": "305951ab02cb2ea5eb884dbfd8fb110b4e088ecb8338b3e84e8f9c70919c19bf", - "description": "simple test", - "expires_at": 1708640953, - "created_index": 2, - "updated_index": 1 - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -26155,42 +26336,42 @@ "", "the error details are decrypted and presented here, if *shared_secrets* was provided and an error was returned by one of the intermediate nodes" ], - "example_json_request": [ + "json_example": [ { - "id": "example:sendonion#1", - "method": "sendonion", - "params": { - "onion": "00034928294556b10308f9aeac7a240223d4d5f72097db1ef36a36b10cab937f2f205ed7218b47d4600eaf7fd390940bf9a6cdac99aafdb4783c468150eeeab9b57e56a06778d023ffb3bb84c7d8c2ad8868b61c28b566634af52c288ed6569583db66f5bd0edfb801c252f078020e1df6359af5969296b4698a71d17c5ca6e5ee4b64b7cce3ad0a1aa31e6be4d5fe3a31fa7a25259c640716020a9a248ca3ebb68eb823f8884b5df3710969f4c2ffb153779a923bab946ed43c1f6658d7f8e7e25303bb78ef4862fb550b8b1c79d522b035eedfda9ab70a61322522acf7233bb8ea2423958448fc8ac3d000835fda04bf661f1bf2ad2d091f506840bb2f10f82c0812149d99267a47824defe90877ed70db526b2200e18dccb92b17516de3778c055645728eadf4c74375aa0aae80a7773a536a908ca1e25c0fdca90e50ce0be05eeb973ec5e83ce3ab6b35818e021780428af81320a694483c1c15f64e685ba1fd3b1e1b926e6b4ec9eeeac8aca60c60e0f0f583e35e7f081dc6f4c64157e100c79c4c25101bed77cd9f93416f9a67d9f1916a782c498c38365af4a5fabb1b745fa840a054a06564c3f4b376aeb72cdd059d3794c82bbbf12a1f62234016a6912b384e7e4cebbd39ee4395aeff43c461e226d1e0151cce508a181a9c61275bf4b89e4556cf24df13b993dec96541555f8b9a699be9488568a11ac7f25849da62765472511ad74a6660c10e37f5fa13d4e4665ef7825ae1f2da4a86d5581912262de89b4b11a722fd127b31aa0d7fab8c679b07bf95e65cb80b2dacb5b90794399fb8f23823f68058431aa1c399b5baceccaf8521d004f45dba6ec1fddc54473343e9e67cd50cc3f2f3d8a5dab8a7ab9ae553dc3cd34e74b858da75975265f7c673a25e8d01a5130ab40eaba712b80c608cd0431b4b45ea0d81af595e21f24976608429127bf586f7507666500bc7245cf9266fa0bd0e58404c496e190c873cd143ace9048e9d5021c23967a24e09f2e54166e54b4ee8888dc1af535624e7ee8b426c1628175017a9e8a73eb1d0d49028a4f4d77897f3c08f1cd7bdee2b00f9bb9eadc49a69bf4f6c0cb2c95a16f03d7958f1b8f83cb40ae87ddf75f26050e2c2ed9f8f8523b3d389a50b217bda651dc21f095fe7d2d3851a0a6cf01051f3f3c6f1ad59ed46d44928d15a0e6e1bd4df4c99bdb82a05b0e781b69a73bc30fe579c8ac9fe8aeb6beb1c0f44def2775b7341af37e6ef58ceb34958b29d3e36112b78644612228761b8badc802f0b2b8fcaeb1db8f3a8db4afa2d7b4540a7c331db6f5141fa3909a513df875ff8a63f5b542d662781ca96a69e3b2925d6a63555b2c5825ffb2ad848d71122f54110e0d203000f3e9cc23b793c3540dfb8d881caedd25055a8f495e9e7a0391dbf9cbd9344f7df659ee8d3ce5ec16217ab83e1394ba991eb8ffd9a869f8ebb2e2428845e779979c57b5f8875f502728229a55ce87b3eba85c75264d30eaf7b373f6b09ba3086d9e98348d87b049468c2c30a6501cb2a3862f1703bbf29895e8b4262353eae720ed8ae678750011e2eb51f4800d3f4725fa873d7deec1c46f77a5f61c73dc938239e77f432bcc245c7b935413c51c0bc92bdaae144452aa95910909e46e500557961203f4e1483b9c09c124464907825e1ff74c87c58d6e2e91970baac9b89a554beca6df9acee16d77dd929d0caa7797e06f2c384c03fdedc89c697b9c34787a50cf399a8d7f195e79b347efc8267c474a477ce210f11049d432b280eaf3fccd451f6218d35c64cbd1006bcc54eeea8b856855c9aa92bc3adc6900a7c7a0eee09834c5a1f2da3d8ea9a478aea90c954952ad2a72d3856350ac3132d17e1e8116fa774066a22c857a827699c98285111a405e74685a3ae579ae78c545774f45491e4935bf4", - "first_hop": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "channel": "103x3x0", - "direction": 1, - "amount_msat": 1002, - "delay": 21, - "style": "tlv" - }, + "request": { + "id": "example:sendonion#1", + "method": "sendonion", + "params": { + "onion": "00034928294556b10308f9aeac7a240223d4d5f72097db1ef36a36b10cab937f2f205ed7218b47d4600eaf7fd390940bf9a6cdac99aafdb4783c468150eeeab9b57e56a06778d023ffb3bb84c7d8c2ad8868b61c28b566634af52c288ed6569583db66f5bd0edfb801c252f078020e1df6359af5969296b4698a71d17c5ca6e5ee4b64b7cce3ad0a1aa31e6be4d5fe3a31fa7a25259c640716020a9a248ca3ebb68eb823f8884b5df3710969f4c2ffb153779a923bab946ed43c1f6658d7f8e7e25303bb78ef4862fb550b8b1c79d522b035eedfda9ab70a61322522acf7233bb8ea2423958448fc8ac3d000835fda04bf661f1bf2ad2d091f506840bb2f10f82c0812149d99267a47824defe90877ed70db526b2200e18dccb92b17516de3778c055645728eadf4c74375aa0aae80a7773a536a908ca1e25c0fdca90e50ce0be05eeb973ec5e83ce3ab6b35818e021780428af81320a694483c1c15f64e685ba1fd3b1e1b926e6b4ec9eeeac8aca60c60e0f0f583e35e7f081dc6f4c64157e100c79c4c25101bed77cd9f93416f9a67d9f1916a782c498c38365af4a5fabb1b745fa840a054a06564c3f4b376aeb72cdd059d3794c82bbbf12a1f62234016a6912b384e7e4cebbd39ee4395aeff43c461e226d1e0151cce508a181a9c61275bf4b89e4556cf24df13b993dec96541555f8b9a699be9488568a11ac7f25849da62765472511ad74a6660c10e37f5fa13d4e4665ef7825ae1f2da4a86d5581912262de89b4b11a722fd127b31aa0d7fab8c679b07bf95e65cb80b2dacb5b90794399fb8f23823f68058431aa1c399b5baceccaf8521d004f45dba6ec1fddc54473343e9e67cd50cc3f2f3d8a5dab8a7ab9ae553dc3cd34e74b858da75975265f7c673a25e8d01a5130ab40eaba712b80c608cd0431b4b45ea0d81af595e21f24976608429127bf586f7507666500bc7245cf9266fa0bd0e58404c496e190c873cd143ace9048e9d5021c23967a24e09f2e54166e54b4ee8888dc1af535624e7ee8b426c1628175017a9e8a73eb1d0d49028a4f4d77897f3c08f1cd7bdee2b00f9bb9eadc49a69bf4f6c0cb2c95a16f03d7958f1b8f83cb40ae87ddf75f26050e2c2ed9f8f8523b3d389a50b217bda651dc21f095fe7d2d3851a0a6cf01051f3f3c6f1ad59ed46d44928d15a0e6e1bd4df4c99bdb82a05b0e781b69a73bc30fe579c8ac9fe8aeb6beb1c0f44def2775b7341af37e6ef58ceb34958b29d3e36112b78644612228761b8badc802f0b2b8fcaeb1db8f3a8db4afa2d7b4540a7c331db6f5141fa3909a513df875ff8a63f5b542d662781ca96a69e3b2925d6a63555b2c5825ffb2ad848d71122f54110e0d203000f3e9cc23b793c3540dfb8d881caedd25055a8f495e9e7a0391dbf9cbd9344f7df659ee8d3ce5ec16217ab83e1394ba991eb8ffd9a869f8ebb2e2428845e779979c57b5f8875f502728229a55ce87b3eba85c75264d30eaf7b373f6b09ba3086d9e98348d87b049468c2c30a6501cb2a3862f1703bbf29895e8b4262353eae720ed8ae678750011e2eb51f4800d3f4725fa873d7deec1c46f77a5f61c73dc938239e77f432bcc245c7b935413c51c0bc92bdaae144452aa95910909e46e500557961203f4e1483b9c09c124464907825e1ff74c87c58d6e2e91970baac9b89a554beca6df9acee16d77dd929d0caa7797e06f2c384c03fdedc89c697b9c34787a50cf399a8d7f195e79b347efc8267c474a477ce210f11049d432b280eaf3fccd451f6218d35c64cbd1006bcc54eeea8b856855c9aa92bc3adc6900a7c7a0eee09834c5a1f2da3d8ea9a478aea90c954952ad2a72d3856350ac3132d17e1e8116fa774066a22c857a827699c98285111a405e74685a3ae579ae78c545774f45491e4935bf4", + "first_hop": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "channel": "103x3x0", + "direction": 1, + "amount_msat": 1002, + "delay": 21, + "style": "tlv" + }, + "payment_hash": "f584c14bb23506acdd94cf3cea377f3cc5805f3cba5430bc3756ef83ede1a0dc", + "label": null, + "shared_secrets": null, + "partid": null, + "bolt11": null, + "amount_msat": null, + "destination": null + } + }, + "response": { + "message": "Monitor status with listpays or waitsendpay", + "created_index": 1, + "id": 1, "payment_hash": "f584c14bb23506acdd94cf3cea377f3cc5805f3cba5430bc3756ef83ede1a0dc", - "label": null, - "shared_secrets": null, - "partid": null, - "bolt11": null, - "amount_msat": null, - "destination": null + "groupid": 1, + "amount_sent_msat": 1002, + "created_at": 1706315098, + "status": "pending" } } ], - "example_json_response": [ - { - "message": "Monitor status with listpays or waitsendpay", - "created_index": 1, - "id": 1, - "payment_hash": "f584c14bb23506acdd94cf3cea377f3cc5805f3cba5430bc3756ef83ede1a0dc", - "groupid": 1, - "amount_sent_msat": 1002, - "created_at": 1706315098, - "status": "pending" - } - ], "author": [ "Christian Decker <> is mainly responsible." ], @@ -26620,97 +26801,99 @@ "*failcode*: The failure code, as per BOLT #4.", "*channel_update*: The hex string of the *channel_update* message received from the remote node. Only present if error is from the remote node and the *failcode* has the UPDATE bit set, as per BOLT #4." ], - "example_json_request": [ + "json_example": [ { - "id": "example:sendpay#1", - "method": "sendpay", - "params": { - "route": [ - { - "amount_msat": 11000000, - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "delay": 5, - "channel": "103x1x0" - } - ], + "request": { + "id": "example:sendpay#1", + "method": "sendpay", + "params": { + "route": [ + { + "amount_msat": 11000000, + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "delay": 5, + "channel": "103x1x0" + } + ], + "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", + "label": null, + "amount_msat": null, + "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", + "payment_secret": "82644944d3f70d42aad1d5f7b5d7a629e7afa30b529cc952a4c59fc0e3790ea2", + "partid": null, + "groupid": null, + "payment_metadata": null + } + }, + "response": { + "message": "Monitor status with listpays or waitsendpay", + "created_index": 1, + "id": 1, "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "label": null, - "amount_msat": null, - "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", - "payment_secret": "82644944d3f70d42aad1d5f7b5d7a629e7afa30b529cc952a4c59fc0e3790ea2", - "partid": null, - "groupid": null, - "payment_metadata": null + "groupid": 1, + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount_msat": 11000000, + "amount_sent_msat": 11000000, + "created_at": 1706152930, + "status": "pending", + "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk" } }, { - "id": "example:sendpay#2", - "method": "sendpay", - "params": { - "route": [ - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "channel": "103x1x0", - "direction": 1, - "amount_msat": 4211, - "style": "tlv", - "delay": 24 - }, - { - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "channel": "105x1x0", - "direction": 0, - "amount_msat": 3710, - "style": "tlv", - "delay": 16 - }, - { - "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "channel": "107x1x0", - "direction": 1, - "amount_msat": 3210, - "style": "tlv", - "delay": 8 - } - ], + "request": { + "id": "example:sendpay#2", + "method": "sendpay", + "params": { + "route": [ + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "channel": "103x1x0", + "direction": 1, + "amount_msat": 4211, + "style": "tlv", + "delay": 24 + }, + { + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "channel": "105x1x0", + "direction": 0, + "amount_msat": 3710, + "style": "tlv", + "delay": 16 + }, + { + "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "channel": "107x1x0", + "direction": 1, + "amount_msat": 3210, + "style": "tlv", + "delay": 8 + } + ], + "payment_hash": "bc747053329402620a26bdc187cd134cdb699130d85be499ecd24160aff04c5c", + "label": null, + "amount_msat": null, + "bolt11": null, + "payment_secret": "c36a2fe9aced78c06960e2f21b369ed03f0492c97e53ba3b662163bcdaf1d7fa", + "partid": null, + "groupid": null, + "payment_metadata": null + } + }, + "response": { + "message": "Monitor status with listpays or waitsendpay", + "created_index": 2, + "id": 2, "payment_hash": "bc747053329402620a26bdc187cd134cdb699130d85be499ecd24160aff04c5c", - "label": null, - "amount_msat": null, - "bolt11": null, - "payment_secret": "c36a2fe9aced78c06960e2f21b369ed03f0492c97e53ba3b662163bcdaf1d7fa", - "partid": null, - "groupid": null, - "payment_metadata": null + "groupid": 1, + "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "amount_msat": 3210, + "amount_sent_msat": 4211, + "created_at": 1708624260, + "status": "pending" } } ], - "example_json_response": [ - { - "message": "Monitor status with listpays or waitsendpay", - "created_index": 1, - "id": 1, - "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "groupid": 1, - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount_msat": 11000000, - "amount_sent_msat": 11000000, - "created_at": 1706152930, - "status": "pending", - "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk" - }, - { - "message": "Monitor status with listpays or waitsendpay", - "created_index": 2, - "id": 2, - "payment_hash": "bc747053329402620a26bdc187cd134cdb699130d85be499ecd24160aff04c5c", - "groupid": 1, - "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "amount_msat": 3210, - "amount_sent_msat": 4211, - "created_at": 1708624260, - "status": "pending" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -26775,20 +26958,32 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:sendpsbt#1", - "method": "sendpsbt", - "params": { - "psbt": "some_psbt" + "request": { + "id": "example:sendpsbt#1", + "method": "sendpsbt", + "params": { + "psbt": "some_psbt" + } + }, + "response": { + "txid": "05985072bbe20747325e69a159fe08176cc1bbc96d25e8848edad2dddc1165d0", + "tx": "02000000027032912651fc25a3e0893acd5f9640598707e2dfef92143bb5a4020e335442800100000017160014a5f48b9aa3cb8ca6cc1040c11e386745bb4dc932ffffffffd229a4b4f78638ebcac10a68b0561585a5d6e4d3b769ad0a909e9b9afaeae24e00000000171600145c83da9b685f9142016c6f5eb5f98a45cfa6f686ffffffff01915a01000000000017a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf8700000000" } }, { - "id": "example:sendpsbt#2", - "method": "sendpsbt", - "params": { - "psbt": "cHNidP8BAM0CAAAABEV+dnFRINmyeHxi4Id0OrcuzI5au5/BlPtTfu7E2m3EAAAAAAD9////cv8oioDx+0NCEnjBSYtnwF0H4VR13j+bkyb5gOOQLUUBAAAAAP3///8ehOrKm7JEq6zflkp9+zmSwE1iPe1yh3KTXvk+om/legEAAAAA/f///2s31wNrI1UavMgjC1GyrOHNbxOm68KYa13WX/mGfmjcAQAAAAD9////AcEAPQAAAAAAFgAUyQltQ/QI6lJgICYsza18hRa5KoEAAAAAAAEAcQIAAAABTzfqjIqV1wPpqc/3/Cb+tMX5EDrLmnhb5BMNx3aB/hYAAAAAAP3///8CQEIPAAAAAAAWABR9CNmX36nN45+GhjqvD4LjLMMMg/+juSkBAAAAFgAUJB0adsMdjkacZWrLwyteqfOaTrRlAAAAAQEfQEIPAAAAAAAWABR9CNmX36nN45+GhjqvD4LjLMMMgyICA1p5u7tAbUvCjfBfpqhzKM+wKn4TdDvs3NHfz+BxwuAQRzBEAiBwFb9rA0nUVlIPGd2aaiRbJ+KH4MLM3Bu+f0JuXB/hwAIgT2rrIUG9gXBZoH9fcPjCnbbM1SR4GiLYGLeALB8yENoBIgYDWnm7u0BtS8KN8F+mqHMoz7AqfhN0O+zc0d/P4HHC4BAIfQjZlwAAAAAAAQBxAgAAAAGANpEFI+CgfALTim/MWsAa62g+EmFWrFrzBDBCmCB3MgAAAAAA/f///wKZKdgpAQAAABYAFB+xhfU1pgl9WIvDKzAHZp8UeNkzQEIPAAAAAAAWABQHHEnK0vQg88gF+fa5ilcmnLFBUGUAAAABAR9AQg8AAAAAABYAFAccScrS9CDzyAX59rmKVyacsUFQIgICXTcoCCnxhsuZXNzL8jirRWQBOTlzUTljJKNldd803f9HMEQCIDtx/kEoc4PHDDm4eX5SEOmuRGu7ShpEG7xKBbuD/NjiAiBYkIKod39dcBarCT7Dbchkuwx70tJhOxQSJi2EMioGrwEiBgJdNygIKfGGy5lc3MvyOKtFZAE5OXNROWMko2V13zTd/wgHHEnKAAAAAAABAHECAAAAAVHU7RCZylzRMdlMBJ2ba4XKxv0l7LdWVnPYS6mhkf60AAAAAAD9////Av5VbSkBAAAAFgAU0BhRKzRbIC6H+s6j86d6cMpTNNhAQg8AAAAAABYAFD1D0ia8wnAZreUtej3FKnrBvii4ZQAAAAEBH0BCDwAAAAAAFgAUPUPSJrzCcBmt5S16PcUqesG+KLgiAgKKWZFo08l968cbxm5icOzwVPMA2Igwm6BUcaSCF13ZMEcwRAIgNAeIVGvUj9MWM18am0dx3JtEf79iQMX7Rqz1tttes3ICIAtNCglUlvpSidAxc/xoiy9cA13bgimJx25G+eZXfYJeASIGAopZkWjTyX3rxxvGbmJw7PBU8wDYiDCboFRxpIIXXdkwCD1D0iYAAAAAAAEAcQIAAAABRX52cVEg2bJ4fGLgh3Q6ty7Mjlq7n8GU+1N+7sTabcQBAAAAAP3///8CMmGqKQEAAAAWABSxLq0p9YAKl+hX7pFc0K/X+PIWmUBCDwAAAAAAFgAUZhwjt5DdNJE3OvCx2L7Qh31c3iJlAAAAAQEfQEIPAAAAAAAWABRmHCO3kN00kTc68LHYvtCHfVzeIiICA/qclQheQrHlADzR9BgXjDDJbkrneVTKD8SMWIJv9OsORzBEAiBKABqNV7cF5DKhtd+m+ZEmWF21vBt2uBKnzeDuUFqvDwIgJc6+/6GQqIfz869kJpUFTAMYTeL2qWR6d28EQEOJgkMBIgYD+pyVCF5CseUAPNH0GBeMMMluSud5VMoPxIxYgm/06w4IZhwjtwAAAAAAAA==", - "reserve": null + "request": { + "id": "example:sendpsbt#2", + "method": "sendpsbt", + "params": { + "psbt": "cHNidP8BAM0CAAAABEV+dnFRINmyeHxi4Id0OrcuzI5au5/BlPtTfu7E2m3EAAAAAAD9////cv8oioDx+0NCEnjBSYtnwF0H4VR13j+bkyb5gOOQLUUBAAAAAP3///8ehOrKm7JEq6zflkp9+zmSwE1iPe1yh3KTXvk+om/legEAAAAA/f///2s31wNrI1UavMgjC1GyrOHNbxOm68KYa13WX/mGfmjcAQAAAAD9////AcEAPQAAAAAAFgAUyQltQ/QI6lJgICYsza18hRa5KoEAAAAAAAEAcQIAAAABTzfqjIqV1wPpqc/3/Cb+tMX5EDrLmnhb5BMNx3aB/hYAAAAAAP3///8CQEIPAAAAAAAWABR9CNmX36nN45+GhjqvD4LjLMMMg/+juSkBAAAAFgAUJB0adsMdjkacZWrLwyteqfOaTrRlAAAAAQEfQEIPAAAAAAAWABR9CNmX36nN45+GhjqvD4LjLMMMgyICA1p5u7tAbUvCjfBfpqhzKM+wKn4TdDvs3NHfz+BxwuAQRzBEAiBwFb9rA0nUVlIPGd2aaiRbJ+KH4MLM3Bu+f0JuXB/hwAIgT2rrIUG9gXBZoH9fcPjCnbbM1SR4GiLYGLeALB8yENoBIgYDWnm7u0BtS8KN8F+mqHMoz7AqfhN0O+zc0d/P4HHC4BAIfQjZlwAAAAAAAQBxAgAAAAGANpEFI+CgfALTim/MWsAa62g+EmFWrFrzBDBCmCB3MgAAAAAA/f///wKZKdgpAQAAABYAFB+xhfU1pgl9WIvDKzAHZp8UeNkzQEIPAAAAAAAWABQHHEnK0vQg88gF+fa5ilcmnLFBUGUAAAABAR9AQg8AAAAAABYAFAccScrS9CDzyAX59rmKVyacsUFQIgICXTcoCCnxhsuZXNzL8jirRWQBOTlzUTljJKNldd803f9HMEQCIDtx/kEoc4PHDDm4eX5SEOmuRGu7ShpEG7xKBbuD/NjiAiBYkIKod39dcBarCT7Dbchkuwx70tJhOxQSJi2EMioGrwEiBgJdNygIKfGGy5lc3MvyOKtFZAE5OXNROWMko2V13zTd/wgHHEnKAAAAAAABAHECAAAAAVHU7RCZylzRMdlMBJ2ba4XKxv0l7LdWVnPYS6mhkf60AAAAAAD9////Av5VbSkBAAAAFgAU0BhRKzRbIC6H+s6j86d6cMpTNNhAQg8AAAAAABYAFD1D0ia8wnAZreUtej3FKnrBvii4ZQAAAAEBH0BCDwAAAAAAFgAUPUPSJrzCcBmt5S16PcUqesG+KLgiAgKKWZFo08l968cbxm5icOzwVPMA2Igwm6BUcaSCF13ZMEcwRAIgNAeIVGvUj9MWM18am0dx3JtEf79iQMX7Rqz1tttes3ICIAtNCglUlvpSidAxc/xoiy9cA13bgimJx25G+eZXfYJeASIGAopZkWjTyX3rxxvGbmJw7PBU8wDYiDCboFRxpIIXXdkwCD1D0iYAAAAAAAEAcQIAAAABRX52cVEg2bJ4fGLgh3Q6ty7Mjlq7n8GU+1N+7sTabcQBAAAAAP3///8CMmGqKQEAAAAWABSxLq0p9YAKl+hX7pFc0K/X+PIWmUBCDwAAAAAAFgAUZhwjt5DdNJE3OvCx2L7Qh31c3iJlAAAAAQEfQEIPAAAAAAAWABRmHCO3kN00kTc68LHYvtCHfVzeIiICA/qclQheQrHlADzR9BgXjDDJbkrneVTKD8SMWIJv9OsORzBEAiBKABqNV7cF5DKhtd+m+ZEmWF21vBt2uBKnzeDuUFqvDwIgJc6+/6GQqIfz869kJpUFTAMYTeL2qWR6d28EQEOJgkMBIgYD+pyVCF5CseUAPNH0GBeMMMluSud5VMoPxIxYgm/06w4IZhwjtwAAAAAAAA==", + "reserve": null + } + }, + "response": { + "tx": "02000000000104457e76715120d9b2787c62e087743ab72ecc8e5abb9fc194fb537eeec4da6dc40000000000fdffffff72ff288a80f1fb43421278c1498b67c05d07e15475de3f9b9326f980e3902d450100000000fdffffff1e84eaca9bb244abacdf964a7dfb3992c04d623ded728772935ef93ea26fe57a0100000000fdffffff6b37d7036b23551abcc8230b51b2ace1cd6f13a6ebc2986b5dd65ff9867e68dc0100000000fdffffff01c1003d0000000000160014c9096d43f408ea526020262ccdad7c8516b92a810247304402207015bf6b0349d456520f19dd9a6a245b27e287e0c2ccdc1bbe7f426e5c1fe1c002204f6aeb2141bd817059a07f5f70f8c29db6ccd524781a22d818b7802c1f3210da0121035a79bbbb406d4bc28df05fa6a87328cfb02a7e13743becdcd1dfcfe071c2e0100247304402203b71fe41287383c70c39b8797e5210e9ae446bbb4a1a441bbc4a05bb83fcd8e20220589082a8777f5d7016ab093ec36dc864bb0c7bd2d2613b1412262d84322a06af0121025d37280829f186cb995cdccbf238ab45640139397351396324a36575df34ddff024730440220340788546bd48fd316335f1a9b4771dc9b447fbf6240c5fb46acf5b6db5eb37202200b4d0a095496fa5289d03173fc688b2f5c035ddb822989c76e46f9e6577d825e0121028a599168d3c97debc71bc66e6270ecf054f300d888309ba05471a482175dd9300247304402204a001a8d57b705e432a1b5dfa6f99126585db5bc1b76b812a7cde0ee505aaf0f022025cebeffa190a887f3f3af642695054c03184de2f6a9647a776f044043898243012103fa9c95085e42b1e5003cd1f418178c30c96e4ae77954ca0fc48c58826ff4eb0e00000000", + "txid": "43bb1c1bce6763ffe4d5df6b49f152f907f36f7849e55bb56075e2b256d17502" } } ], @@ -26797,16 +26992,6 @@ "", "- -32602: Error in given parameters or some error happened during the command process." ], - "example_json_response": [ - { - "txid": "05985072bbe20747325e69a159fe08176cc1bbc96d25e8848edad2dddc1165d0", - "tx": "02000000027032912651fc25a3e0893acd5f9640598707e2dfef92143bb5a4020e335442800100000017160014a5f48b9aa3cb8ca6cc1040c11e386745bb4dc932ffffffffd229a4b4f78638ebcac10a68b0561585a5d6e4d3b769ad0a909e9b9afaeae24e00000000171600145c83da9b685f9142016c6f5eb5f98a45cfa6f686ffffffff01915a01000000000017a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf8700000000" - }, - { - "tx": "02000000000104457e76715120d9b2787c62e087743ab72ecc8e5abb9fc194fb537eeec4da6dc40000000000fdffffff72ff288a80f1fb43421278c1498b67c05d07e15475de3f9b9326f980e3902d450100000000fdffffff1e84eaca9bb244abacdf964a7dfb3992c04d623ded728772935ef93ea26fe57a0100000000fdffffff6b37d7036b23551abcc8230b51b2ace1cd6f13a6ebc2986b5dd65ff9867e68dc0100000000fdffffff01c1003d0000000000160014c9096d43f408ea526020262ccdad7c8516b92a810247304402207015bf6b0349d456520f19dd9a6a245b27e287e0c2ccdc1bbe7f426e5c1fe1c002204f6aeb2141bd817059a07f5f70f8c29db6ccd524781a22d818b7802c1f3210da0121035a79bbbb406d4bc28df05fa6a87328cfb02a7e13743becdcd1dfcfe071c2e0100247304402203b71fe41287383c70c39b8797e5210e9ae446bbb4a1a441bbc4a05bb83fcd8e20220589082a8777f5d7016ab093ec36dc864bb0c7bd2d2613b1412262d84322a06af0121025d37280829f186cb995cdccbf238ab45640139397351396324a36575df34ddff024730440220340788546bd48fd316335f1a9b4771dc9b447fbf6240c5fb46acf5b6db5eb37202200b4d0a095496fa5289d03173fc688b2f5c035ddb822989c76e46f9e6577d825e0121028a599168d3c97debc71bc66e6270ecf054f300d888309ba05471a482175dd9300247304402204a001a8d57b705e432a1b5dfa6f99126585db5bc1b76b812a7cde0ee505aaf0f022025cebeffa190a887f3f3af642695054c03184de2f6a9647a776f044043898243012103fa9c95085e42b1e5003cd1f418178c30c96e4ae77954ca0fc48c58826ff4eb0e00000000", - "txid": "43bb1c1bce6763ffe4d5df6b49f152f907f36f7849e55bb56075e2b256d17502" - } - ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." @@ -26979,62 +27164,64 @@ "- -1: Channel is in incorrect state, i.e. Catchall nonspecific error.", "- -32602: JSONRPC2_INVALID_PARAMS, i.e. Given id is not a channel ID or short channel ID." ], - "example_json_request": [ - { - "id": "example:setchannel#1", - "method": "setchannel", - "params": { - "id": "103x1x0", - "feebase": null, - "feeppm": null, - "htlcmin": null, - "htlcmax": null, - "enforcedelay": null, - "ignorefeelimits": true - } - }, - { - "id": "example:setchannel#2", - "method": "setchannel", - "params": { - "id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", - "feebase": 4000, - "feeppm": 300, - "htlcmin": null, - "htlcmax": null, - "enforcedelay": 0, - "ignorefeelimits": null - } - } - ], - "example_json_response": [ + "json_example": [ { - "channels": [ - { - "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "channel_id": "90210d39d12a65d239ece267c5f48e0a82e7cb95724e658f6d99f370064faad1", - "short_channel_id": "103x1x0", - "fee_base_msat": 1, - "fee_proportional_millionths": 10, - "minimum_htlc_out_msat": 0, - "maximum_htlc_out_msat": 990000000, - "ignore_fee_limits": true + "request": { + "id": "example:setchannel#1", + "method": "setchannel", + "params": { + "id": "103x1x0", + "feebase": null, + "feeppm": null, + "htlcmin": null, + "htlcmax": null, + "enforcedelay": null, + "ignorefeelimits": true } - ] + }, + "response": { + "channels": [ + { + "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "channel_id": "90210d39d12a65d239ece267c5f48e0a82e7cb95724e658f6d99f370064faad1", + "short_channel_id": "103x1x0", + "fee_base_msat": 1, + "fee_proportional_millionths": 10, + "minimum_htlc_out_msat": 0, + "maximum_htlc_out_msat": 990000000, + "ignore_fee_limits": true + } + ] + } }, { - "channels": [ - { - "peer_id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", - "channel_id": "9c54c71bbbe59591cc3162e14fc4ff58c146f085c07d0f206ea679a8231d03ab", - "short_channel_id": "103x3x0", - "fee_base_msat": 4000, - "fee_proportional_millionths": 300, - "minimum_htlc_out_msat": 0, - "maximum_htlc_out_msat": 990000000, - "ignore_fee_limits": false + "request": { + "id": "example:setchannel#2", + "method": "setchannel", + "params": { + "id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", + "feebase": 4000, + "feeppm": 300, + "htlcmin": null, + "htlcmax": null, + "enforcedelay": 0, + "ignorefeelimits": null } - ] + }, + "response": { + "channels": [ + { + "peer_id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", + "channel_id": "9c54c71bbbe59591cc3162e14fc4ff58c146f085c07d0f206ea679a8231d03ab", + "short_channel_id": "103x3x0", + "fee_base_msat": 4000, + "fee_proportional_millionths": 300, + "minimum_htlc_out_msat": 0, + "maximum_htlc_out_msat": 990000000, + "ignore_fee_limits": false + } + ] + } } ], "author": [ @@ -27176,57 +27363,61 @@ "", "- -32602: JSONRPC2_INVALID_PARAMS, i.e. the parameter is not dynamic, or the val was invalid." ], - "example_json_request": [ - { - "id": "example:setconfig#1", - "method": "setconfig", - "params": [ - "autoclean-paidinvoices-age", - 1 - ] - }, - { - "id": "example:setconfig#2", - "method": "setconfig", - "params": [ - "test-dynamic-config", - "changed" - ] - }, - { - "id": "example:setconfig#3", - "method": "setconfig", - "params": { - "config": "min-capacity-sat", - "val": 500000 - } - } - ], - "example_json_response": [ + "json_example": [ { - "config": { - "config": "autoclean-paidinvoices-age", - "value_int": 1, - "source": "/tmp/ltests-7u_8_rtu/test_autoclean_1/lightning-3/regtest/config:6", - "plugin": "~/lightning/plugins/autoclean", - "dynamic": true + "request": { + "id": "example:setconfig#1", + "method": "setconfig", + "params": [ + "autoclean-paidinvoices-age", + 1 + ] + }, + "response": { + "config": { + "config": "autoclean-paidinvoices-age", + "value_int": 1, + "source": "/tmp/ltests-7u_8_rtu/test_autoclean_1/lightning-3/regtest/config:6", + "plugin": "~/lightning/plugins/autoclean", + "dynamic": true + } } }, { - "config": { - "config": "test-dynamic-config", - "value_str": "changed", - "source": "/tmp/ltests-7u_8_rtu/test_dynamic_option_python_plugin_1/lightning-1/regtest/config:2", - "plugin": "~/lightning/tests/plugins/dynamic_option.py", - "dynamic": true + "request": { + "id": "example:setconfig#2", + "method": "setconfig", + "params": [ + "test-dynamic-config", + "changed" + ] + }, + "response": { + "config": { + "config": "test-dynamic-config", + "value_str": "changed", + "source": "/tmp/ltests-7u_8_rtu/test_dynamic_option_python_plugin_1/lightning-1/regtest/config:2", + "plugin": "~/lightning/tests/plugins/dynamic_option.py", + "dynamic": true + } } }, { - "config": { - "config": "min-capacity-sat", - "value_int": 500000, - "source": "/tmp/ltests-nvfdbou2/test_setconfig_1/lightning-2/regtest/config:2", - "dynamic": true + "request": { + "id": "example:setconfig#3", + "method": "setconfig", + "params": { + "config": "min-capacity-sat", + "val": 500000 + } + }, + "response": { + "config": { + "config": "min-capacity-sat", + "value_int": 500000, + "source": "/tmp/ltests-nvfdbou2/test_setconfig_1/lightning-2/regtest/config:2", + "dynamic": true + } } } ], @@ -27283,22 +27474,32 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:setpsbtversion#1", - "method": "setpsbtversion", - "params": { - "psbt": "cHNidP8BAAoCAAAAAAAAAAAAAA==", - "version": "2" + "request": { + "id": "example:setpsbtversion#1", + "method": "setpsbtversion", + "params": { + "psbt": "cHNidP8BAAoCAAAAAAAAAAAAAA==", + "version": "2" + } + }, + "response": { + "psbt": "cHNidP8BAgQCAAAAAQQBAAEFAQABBgEDAfsEAgAAAAA=" } }, { - "id": "example:setpsbtversion#2", - "method": "setpsbtversion", - "params": [ - "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIQEIPAAAAAAABBCJRIJd6ICNAQALFOMhoUHuSVSuzcaUdkDKlk4K+A+DR9+4uAA==", - 0 - ] + "request": { + "id": "example:setpsbtversion#2", + "method": "setpsbtversion", + "params": [ + "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIQEIPAAAAAAABBCJRIJd6ICNAQALFOMhoUHuSVSuzcaUdkDKlk4K+A+DR9+4uAA==", + 0 + ] + }, + "response": { + "psbt": "cHNidP8BADUCAAAAAAFAQg8AAAAAACJRIJd6ICNAQALFOMhoUHuSVSuzcaUdkDKlk4K+A+DR9+4ubwAAAAAA" + } } ], "errors": [ @@ -27306,14 +27507,6 @@ "", "- -32602: Parameter missed or malformed." ], - "example_json_response": [ - { - "psbt": "cHNidP8BAgQCAAAAAQQBAAEFAQABBgEDAfsEAgAAAAA=" - }, - { - "psbt": "cHNidP8BADUCAAAAAAFAQg8AAAAAACJRIJd6ICNAQALFOMhoUHuSVSuzcaUdkDKlk4K+A+DR9+4ubwAAAAAA" - } - ], "author": [ "Gregory Sanders <> is mainly responsible." ], @@ -27482,76 +27675,78 @@ } } }, - "example_json_request": [ - { - "id": "example:showrunes#1", - "method": "showrunes", - "params": "{}" - }, + "json_example": [ { - "id": "example:showrunes#2", - "method": "showrunes", - "params": { - "rune": "Bl0V_vkVkGr4h356JbCMCcoDyyKE8djkoQ2156iPB509MCZwZXI9MTAwMDAwMDAwMG5zZWM=" + "request": { + "id": "example:showrunes#1", + "method": "showrunes", + "params": "{}" + }, + "response": { + "runes": [ + { + "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", + "unique_id": "0", + "restrictions": [], + "restrictions_as_english": "" + }, + { + "rune": "geZmO6U7yqpHn-moaX93FVMVWrDRfSNY4AXx9ypLcqg9MQ==", + "unique_id": "1", + "restrictions": [], + "restrictions_as_english": "" + }, + { + "rune": "Bl0V_vkVkGr4h356JbCMCcoDyyKE8djkoQ2156iPB509MCZwZXI9MTAwMDAwMDAwMG5zZWM=", + "unique_id": "2", + "restrictions": [ + { + "alternatives": [ + { + "fieldname": "per", + "value": "1000000000nsec", + "condition": "=", + "english": "per equal to 1000000000nsec" + } + ], + "english": "per equal to 1000000000nsec" + } + ], + "restrictions_as_english": "per equal to 1000000000nsec" + } + ] } - } - ], - "example_json_response": [ - { - "runes": [ - { - "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", - "unique_id": "0", - "restrictions": [], - "restrictions_as_english": "" - }, - { - "rune": "geZmO6U7yqpHn-moaX93FVMVWrDRfSNY4AXx9ypLcqg9MQ==", - "unique_id": "1", - "restrictions": [], - "restrictions_as_english": "" - }, - { - "rune": "Bl0V_vkVkGr4h356JbCMCcoDyyKE8djkoQ2156iPB509MCZwZXI9MTAwMDAwMDAwMG5zZWM=", - "unique_id": "2", - "restrictions": [ - { - "alternatives": [ - { - "fieldname": "per", - "value": "1000000000nsec", - "condition": "=", - "english": "per equal to 1000000000nsec" - } - ], - "english": "per equal to 1000000000nsec" - } - ], - "restrictions_as_english": "per equal to 1000000000nsec" - } - ] }, { - "runes": [ - { - "rune": "Bl0V_vkVkGr4h356JbCMCcoDyyKE8djkoQ2156iPB509MCZwZXI9MTAwMDAwMDAwMG5zZWM=", - "unique_id": "2", - "restrictions": [ - { - "alternatives": [ - { - "fieldname": "per", - "value": "1000000000nsec", - "condition": "=", - "english": "per equal to 1000000000nsec" - } - ], - "english": "per equal to 1000000000nsec" - } - ], - "restrictions_as_english": "per equal to 1000000000nsec" + "request": { + "id": "example:showrunes#2", + "method": "showrunes", + "params": { + "rune": "Bl0V_vkVkGr4h356JbCMCcoDyyKE8djkoQ2156iPB509MCZwZXI9MTAwMDAwMDAwMG5zZWM=" } - ] + }, + "response": { + "runes": [ + { + "rune": "Bl0V_vkVkGr4h356JbCMCcoDyyKE8djkoQ2156iPB509MCZwZXI9MTAwMDAwMDAwMG5zZWM=", + "unique_id": "2", + "restrictions": [ + { + "alternatives": [ + { + "fieldname": "per", + "value": "1000000000nsec", + "condition": "=", + "english": "per equal to 1000000000nsec" + } + ], + "english": "per equal to 1000000000nsec" + } + ], + "restrictions_as_english": "per equal to 1000000000nsec" + } + ] + } } ], "author": [ @@ -27606,18 +27801,18 @@ "", "- -1: Catchall nonspecific error." ], - "example_json_request": [ - { - "id": "example:signinvoice#1", - "method": "signinvoice", - "params": [ - "lnbcrt10n1pjmxt3lsp5jumuz2sv3ca68kzd92hp3wdtpx8ghnxur65fs6maw6dyxsleqd0spp5nadvvh7uzk2qzh8d9d7tsxr08l9uaz2vjeuuahqtufjv52d0eassdq8d9h8vvgxqyjw5qcqp99qxpqysgq4rrn702eum6c9ld9khlz39vdyd8zcwrav5ygqvu6w54aep6yarkyfrnk990yf5prpasgzmj52stektf6mzwdl5hc6qlsglt2a0pwp0spwww44w" - ] - } - ], - "example_json_response": [ + "json_example": [ { - "bolt11": "lnbcrt10n1pjmxt3lsp5jumuz2sv3ca68kzd92hp3wdtpx8ghnxur65fs6maw6dyxsleqd0spp5nadvvh7uzk2qzh8d9d7tsxr08l9uaz2vjeuuahqtufjv52d0eassdq8d9h8vvgxqyjw5qcqp99qxpqysgq3nhrd72qe7wmc2hvwhaqnx05y6dzxh2tal02kw055er7uutkkrcreccm37ce6wv7ee8q70ktlr9fy3fd635hc2k98a4svd9c8v4cpjsppm2eee" + "request": { + "id": "example:signinvoice#1", + "method": "signinvoice", + "params": [ + "lnbcrt10n1pjmxt3lsp5jumuz2sv3ca68kzd92hp3wdtpx8ghnxur65fs6maw6dyxsleqd0spp5nadvvh7uzk2qzh8d9d7tsxr08l9uaz2vjeuuahqtufjv52d0eassdq8d9h8vvgxqyjw5qcqp99qxpqysgq4rrn702eum6c9ld9khlz39vdyd8zcwrav5ygqvu6w54aep6yarkyfrnk990yf5prpasgzmj52stektf6mzwdl5hc6qlsglt2a0pwp0spwww44w" + ] + }, + "response": { + "bolt11": "lnbcrt10n1pjmxt3lsp5jumuz2sv3ca68kzd92hp3wdtpx8ghnxur65fs6maw6dyxsleqd0spp5nadvvh7uzk2qzh8d9d7tsxr08l9uaz2vjeuuahqtufjv52d0eassdq8d9h8vvgxqyjw5qcqp99qxpqysgq3nhrd72qe7wmc2hvwhaqnx05y6dzxh2tal02kw055er7uutkkrcreccm37ce6wv7ee8q70ktlr9fy3fd635hc2k98a4svd9c8v4cpjsppm2eee" + } } ], "author": [ @@ -27689,34 +27884,36 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:signmessage#1", - "method": "signmessage", - "params": { - "message": "this is a test!" + "request": { + "id": "example:signmessage#1", + "method": "signmessage", + "params": { + "message": "this is a test!" + } + }, + "response": { + "signature": "a2ec227012795f9d6b80a3f5ea98374c6d2886917517c05336799923fcf37caf08344c0431275e1a8189da01b444ae978007fe70f0cc9009f38cabe074ade87d", + "recid": "00", + "zbase": "d6tqaeuonjhi98mmont9m4wag7gg4krg1f4txonug3h31e9h6p6k6nbwjondnj46dkyausobstnk7fhyy998bhgc1yr98dfmhb4k54d7" } }, { - "id": "example:signmessage#2", - "method": "signmessage", - "params": { - "message": "message for you" + "request": { + "id": "example:signmessage#2", + "method": "signmessage", + "params": { + "message": "message for you" + } + }, + "response": { + "signature": "85843b010bc517b32eaafe70232e2c44bb5a354c74d2202390af1b272e4c6ac23ac3f97ea663d8b49116ad6c2d080515b43bcdf1ea4f38cdb18af0edf8209cd8", + "recid": "00", + "zbase": "d6naeqabbxntxc3qim98ye3qftnmsstijt4prebd1nztsj3qjticrqsd9f9kca6as1etpmmcfwrykfpw8xg9d41x8dg5dnzo7zhnb8ga" } } ], - "example_json_response": [ - { - "signature": "a2ec227012795f9d6b80a3f5ea98374c6d2886917517c05336799923fcf37caf08344c0431275e1a8189da01b444ae978007fe70f0cc9009f38cabe074ade87d", - "recid": "00", - "zbase": "d6tqaeuonjhi98mmont9m4wag7gg4krg1f4txonug3h31e9h6p6k6nbwjondnj46dkyausobstnk7fhyy998bhgc1yr98dfmhb4k54d7" - }, - { - "signature": "85843b010bc517b32eaafe70232e2c44bb5a354c74d2202390af1b272e4c6ac23ac3f97ea663d8b49116ad6c2d080515b43bcdf1ea4f38cdb18af0edf8209cd8", - "recid": "00", - "zbase": "d6naeqabbxntxc3qim98ye3qftnmsstijt4prebd1nztsj3qjticrqsd9f9kca6as1etpmmcfwrykfpw8xg9d41x8dg5dnzo7zhnb8ga" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -27777,23 +27974,33 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:signpsbt#1", - "method": "signpsbt", - "params": { - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////DPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4M/AlsaWdodG5pbmcBCMbeD+3qn9/kAAEDCODIEAAAAAAAAQQiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQz8CWxpZ2h0bmluZwEI4upB+mjl6AIA", - "signonly": null + "request": { + "id": "example:signpsbt#1", + "method": "signpsbt", + "params": { + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////DPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4M/AlsaWdodG5pbmcBCMbeD+3qn9/kAAEDCODIEAAAAAAAAQQiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQz8CWxpZ2h0bmluZwEI4upB+mjl6AIA", + "signonly": null + } + }, + "response": { + "signed_psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////ARNACI9TcWG+6uC9ElBFN3qhND7amsor/dtBhJ5ujEQAT/80548avrt7d7IJiOAaCNzzYLSXITdL2xjx6mhbBi9hTiEWkUUygSpECk12bHHNORk2lKNArhHgEuW6Gtnvum52ylMJAMLMqxcAAAAADPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4hB7nAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXCQDWuWnTBAAAAAz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMI4MgQAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" } }, { - "id": "example:signpsbt#2", - "method": "signpsbt", - "params": { - "psbt": "cHNidP8BAP1xAQIAAAAIFTef27H2GAJBzP4UZMeDePsDVkglO47/q4jqK18ibCYAAAAAAP3///+axwap6WKnEHvLjIJZX0ZeJ87cs7PKkXBfwvbGVmjpTQEAAAAA/f///wQ1cVzb9NR7nXadyRuhQBv+2iqhZkhvUA+sPo5z/SsSAQAAAAD9////lXQ788meUtSxhBX13mx2XhyM3Ddo30QtmNW0YuE2TDABAAAAAP3///8Kr4BwElAScx3bA5ZdavrHwh4Zh+rFNvkE/+7gu1WbngEAAAAA/f///3Uei7j3k/b5tnjFGvNZhe2iWz8O6FQjTEpM5XIoduNsAQAAAAD9////fm5Om4MojcnfZiTmrwb4b5Byw9emrjITi/nkEqTK9MsBAAAAAP3///8lwdpZqt3ILPRwhINY4PGvkg2CSw7agcMPSuFoHDDkIQAAAAAA/f///wGCAXoAAAAAABYAFMkJbUP0COpSYCAmLM2tfIUWuSqBAAAAAAABAHECAAAAAZVxzFxyEg7tiQTgRHwGleR8Srxw6taAGOoEpJK/Xj5sAAAAAAD9////AkBCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYzr/YpAQAAABYAFKmkod5S53U4m5tKFApyeC35UbnbZwAAAAEBH0BCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYAAQBxAgAAAAEVN5/bsfYYAkHM/hRkx4N4+wNWSCU7jv+riOorXyJsJgEAAAAA/f///wJmbOcpAQAAABYAFCCSJBD9wY/VwxnBcnFiu1tA6CGTQEIPAAAAAAAWABSjI8KCqaGX/BGOwJza8hyiuxuIcmcAAAABAR9AQg8AAAAAABYAFKMjwoKpoZf8EY7AnNryHKK7G4hyAAEAcQIAAAAB98EwKZMOHiyRYWyToae6Kce3gCwqUvnVXXHlB/ps9ocBAAAAAP3///8CmNuLKQEAAAAWABQ4roxw+phYHelaRr71DYB3FEy/30BCDwAAAAAAFgAUwSDtQiY7PVvBc7ww56Y72YIQdjllAAAAAQEfQEIPAAAAAAAWABTBIO1CJjs9W8FzvDDnpjvZghB2OQABAHECAAAAAZH/SvCXvDW7b8qb55CDC4M+jgZ61H/e8rZnAGaXp+Z+AAAAAAD9////Apkp2CkBAAAAFgAUc/Y+sIq3oYyEe40GkKJsXawkzwFAQg8AAAAAABYAFLdt1h5Bte8FKvIc2jJgiIwHC7mvZwAAAAEBH0BCDwAAAAAAFgAUt23WHkG17wUq8hzaMmCIjAcLua8AAQBxAgAAAAETC3wMCv9qK3lvVkVJu9b/v2VgMepZtnfngMp2xMXRnwAAAAAA/f///wJk0E4pAQAAABYAFEIsc4cBl+BTN33Kn80+YYfkMt+cQEIPAAAAAAAWABT2/7RIxKohhGbacpBz0BZNYcnfsGUAAAABAR9AQg8AAAAAABYAFPb/tEjEqiGEZtpykHPQFk1hyd+wAAEAcQIAAAABA8J/OnC+cuH79Z6wZmzwdAjhBDaPHavh3yvhr4odDXQBAAAAAP3///8CykowKQEAAAAWABTVHuO8cKOOX/JlmMU66on6Uc54mkBCDwAAAAAAFgAUunZMZryWMqCTiMuVWNF/cleg6dVnAAAAAQEfQEIPAAAAAAAWABS6dkxmvJYyoJOIy5VY0X9yV6Dp1QABAHECAAAAAfRxBaZZ3FfDGwxhZQLYCurN+7kJj0x6nzChg434dnjRAAAAAAD9////AszmyCkBAAAAFgAULSqRp54barF/7R9XOmsLDCVWdAFAQg8AAAAAABYAFNa5adNt/9rZhpGT9mPuSA39xzSIZQAAAAEBH0BCDwAAAAAAFgAU1rlp023/2tmGkZP2Y+5IDf3HNIgAAQBxAgAAAAEgk1JYyP4oIoPoYYcTPPDvZynVfXWINJnBEFBsLv0MtAAAAAAA/f///wJAQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iMmGqKQEAAAAWABT5XKNwVIFsUKh26sqHFSlOLq5TFGUAAAABAR9AQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iAAA=", - "signonly": [ - 7 - ] + "request": { + "id": "example:signpsbt#2", + "method": "signpsbt", + "params": { + "psbt": "cHNidP8BAP1xAQIAAAAIFTef27H2GAJBzP4UZMeDePsDVkglO47/q4jqK18ibCYAAAAAAP3///+axwap6WKnEHvLjIJZX0ZeJ87cs7PKkXBfwvbGVmjpTQEAAAAA/f///wQ1cVzb9NR7nXadyRuhQBv+2iqhZkhvUA+sPo5z/SsSAQAAAAD9////lXQ788meUtSxhBX13mx2XhyM3Ddo30QtmNW0YuE2TDABAAAAAP3///8Kr4BwElAScx3bA5ZdavrHwh4Zh+rFNvkE/+7gu1WbngEAAAAA/f///3Uei7j3k/b5tnjFGvNZhe2iWz8O6FQjTEpM5XIoduNsAQAAAAD9////fm5Om4MojcnfZiTmrwb4b5Byw9emrjITi/nkEqTK9MsBAAAAAP3///8lwdpZqt3ILPRwhINY4PGvkg2CSw7agcMPSuFoHDDkIQAAAAAA/f///wGCAXoAAAAAABYAFMkJbUP0COpSYCAmLM2tfIUWuSqBAAAAAAABAHECAAAAAZVxzFxyEg7tiQTgRHwGleR8Srxw6taAGOoEpJK/Xj5sAAAAAAD9////AkBCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYzr/YpAQAAABYAFKmkod5S53U4m5tKFApyeC35UbnbZwAAAAEBH0BCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYAAQBxAgAAAAEVN5/bsfYYAkHM/hRkx4N4+wNWSCU7jv+riOorXyJsJgEAAAAA/f///wJmbOcpAQAAABYAFCCSJBD9wY/VwxnBcnFiu1tA6CGTQEIPAAAAAAAWABSjI8KCqaGX/BGOwJza8hyiuxuIcmcAAAABAR9AQg8AAAAAABYAFKMjwoKpoZf8EY7AnNryHKK7G4hyAAEAcQIAAAAB98EwKZMOHiyRYWyToae6Kce3gCwqUvnVXXHlB/ps9ocBAAAAAP3///8CmNuLKQEAAAAWABQ4roxw+phYHelaRr71DYB3FEy/30BCDwAAAAAAFgAUwSDtQiY7PVvBc7ww56Y72YIQdjllAAAAAQEfQEIPAAAAAAAWABTBIO1CJjs9W8FzvDDnpjvZghB2OQABAHECAAAAAZH/SvCXvDW7b8qb55CDC4M+jgZ61H/e8rZnAGaXp+Z+AAAAAAD9////Apkp2CkBAAAAFgAUc/Y+sIq3oYyEe40GkKJsXawkzwFAQg8AAAAAABYAFLdt1h5Bte8FKvIc2jJgiIwHC7mvZwAAAAEBH0BCDwAAAAAAFgAUt23WHkG17wUq8hzaMmCIjAcLua8AAQBxAgAAAAETC3wMCv9qK3lvVkVJu9b/v2VgMepZtnfngMp2xMXRnwAAAAAA/f///wJk0E4pAQAAABYAFEIsc4cBl+BTN33Kn80+YYfkMt+cQEIPAAAAAAAWABT2/7RIxKohhGbacpBz0BZNYcnfsGUAAAABAR9AQg8AAAAAABYAFPb/tEjEqiGEZtpykHPQFk1hyd+wAAEAcQIAAAABA8J/OnC+cuH79Z6wZmzwdAjhBDaPHavh3yvhr4odDXQBAAAAAP3///8CykowKQEAAAAWABTVHuO8cKOOX/JlmMU66on6Uc54mkBCDwAAAAAAFgAUunZMZryWMqCTiMuVWNF/cleg6dVnAAAAAQEfQEIPAAAAAAAWABS6dkxmvJYyoJOIy5VY0X9yV6Dp1QABAHECAAAAAfRxBaZZ3FfDGwxhZQLYCurN+7kJj0x6nzChg434dnjRAAAAAAD9////AszmyCkBAAAAFgAULSqRp54barF/7R9XOmsLDCVWdAFAQg8AAAAAABYAFNa5adNt/9rZhpGT9mPuSA39xzSIZQAAAAEBH0BCDwAAAAAAFgAU1rlp023/2tmGkZP2Y+5IDf3HNIgAAQBxAgAAAAEgk1JYyP4oIoPoYYcTPPDvZynVfXWINJnBEFBsLv0MtAAAAAAA/f///wJAQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iMmGqKQEAAAAWABT5XKNwVIFsUKh26sqHFSlOLq5TFGUAAAABAR9AQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iAAA=", + "signonly": [ + 7 + ] + } + }, + "response": { + "signed_psbt": "cHNidP8BAP1xAQIAAAAIFTef27H2GAJBzP4UZMeDePsDVkglO47/q4jqK18ibCYAAAAAAP3///+axwap6WKnEHvLjIJZX0ZeJ87cs7PKkXBfwvbGVmjpTQEAAAAA/f///wQ1cVzb9NR7nXadyRuhQBv+2iqhZkhvUA+sPo5z/SsSAQAAAAD9////lXQ788meUtSxhBX13mx2XhyM3Ddo30QtmNW0YuE2TDABAAAAAP3///8Kr4BwElAScx3bA5ZdavrHwh4Zh+rFNvkE/+7gu1WbngEAAAAA/f///3Uei7j3k/b5tnjFGvNZhe2iWz8O6FQjTEpM5XIoduNsAQAAAAD9////fm5Om4MojcnfZiTmrwb4b5Byw9emrjITi/nkEqTK9MsBAAAAAP3///8lwdpZqt3ILPRwhINY4PGvkg2CSw7agcMPSuFoHDDkIQAAAAAA/f///wGCAXoAAAAAABYAFMkJbUP0COpSYCAmLM2tfIUWuSqBAAAAAAABAHECAAAAAZVxzFxyEg7tiQTgRHwGleR8Srxw6taAGOoEpJK/Xj5sAAAAAAD9////AkBCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYzr/YpAQAAABYAFKmkod5S53U4m5tKFApyeC35UbnbZwAAAAEBH0BCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYAAQBxAgAAAAEVN5/bsfYYAkHM/hRkx4N4+wNWSCU7jv+riOorXyJsJgEAAAAA/f///wJmbOcpAQAAABYAFCCSJBD9wY/VwxnBcnFiu1tA6CGTQEIPAAAAAAAWABSjI8KCqaGX/BGOwJza8hyiuxuIcmcAAAABAR9AQg8AAAAAABYAFKMjwoKpoZf8EY7AnNryHKK7G4hyAAEAcQIAAAAB98EwKZMOHiyRYWyToae6Kce3gCwqUvnVXXHlB/ps9ocBAAAAAP3///8CmNuLKQEAAAAWABQ4roxw+phYHelaRr71DYB3FEy/30BCDwAAAAAAFgAUwSDtQiY7PVvBc7ww56Y72YIQdjllAAAAAQEfQEIPAAAAAAAWABTBIO1CJjs9W8FzvDDnpjvZghB2OQABAHECAAAAAZH/SvCXvDW7b8qb55CDC4M+jgZ61H/e8rZnAGaXp+Z+AAAAAAD9////Apkp2CkBAAAAFgAUc/Y+sIq3oYyEe40GkKJsXawkzwFAQg8AAAAAABYAFLdt1h5Bte8FKvIc2jJgiIwHC7mvZwAAAAEBH0BCDwAAAAAAFgAUt23WHkG17wUq8hzaMmCIjAcLua8AAQBxAgAAAAETC3wMCv9qK3lvVkVJu9b/v2VgMepZtnfngMp2xMXRnwAAAAAA/f///wJk0E4pAQAAABYAFEIsc4cBl+BTN33Kn80+YYfkMt+cQEIPAAAAAAAWABT2/7RIxKohhGbacpBz0BZNYcnfsGUAAAABAR9AQg8AAAAAABYAFPb/tEjEqiGEZtpykHPQFk1hyd+wAAEAcQIAAAABA8J/OnC+cuH79Z6wZmzwdAjhBDaPHavh3yvhr4odDXQBAAAAAP3///8CykowKQEAAAAWABTVHuO8cKOOX/JlmMU66on6Uc54mkBCDwAAAAAAFgAUunZMZryWMqCTiMuVWNF/cleg6dVnAAAAAQEfQEIPAAAAAAAWABS6dkxmvJYyoJOIy5VY0X9yV6Dp1QABAHECAAAAAfRxBaZZ3FfDGwxhZQLYCurN+7kJj0x6nzChg434dnjRAAAAAAD9////AszmyCkBAAAAFgAULSqRp54barF/7R9XOmsLDCVWdAFAQg8AAAAAABYAFNa5adNt/9rZhpGT9mPuSA39xzSIZQAAAAEBH0BCDwAAAAAAFgAU1rlp023/2tmGkZP2Y+5IDf3HNIgAAQBxAgAAAAEgk1JYyP4oIoPoYYcTPPDvZynVfXWINJnBEFBsLv0MtAAAAAAA/f///wJAQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iMmGqKQEAAAAWABT5XKNwVIFsUKh26sqHFSlOLq5TFGUAAAABAR9AQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iIgID+pyVCF5CseUAPNH0GBeMMMluSud5VMoPxIxYgm/06w5HMEQCIG90DSr+fGNoWhCrgLbJG3Wt8PJNMWYqaa5MLWRwA0oTAiA9rsLEqqVhjV6wENfzzpudaE949uLlVqWgDjE/FSgKNAEiBgP6nJUIXkKx5QA80fQYF4wwyW5K53lUyg/EjFiCb/TrDghmHCO3AAAAAAAA" } } ], @@ -27802,14 +28009,6 @@ "", "- -32602: Error in given parameters, or there aren't wallet's inputs to sign, or we couldn't sign all of *signonly*, or inputs are not reserved." ], - "example_json_response": [ - { - "signed_psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////ARNACI9TcWG+6uC9ElBFN3qhND7amsor/dtBhJ5ujEQAT/80548avrt7d7IJiOAaCNzzYLSXITdL2xjx6mhbBi9hTiEWkUUygSpECk12bHHNORk2lKNArhHgEuW6Gtnvum52ylMJAMLMqxcAAAAADPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4hB7nAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXCQDWuWnTBAAAAAz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMI4MgQAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" - }, - { - "signed_psbt": "cHNidP8BAP1xAQIAAAAIFTef27H2GAJBzP4UZMeDePsDVkglO47/q4jqK18ibCYAAAAAAP3///+axwap6WKnEHvLjIJZX0ZeJ87cs7PKkXBfwvbGVmjpTQEAAAAA/f///wQ1cVzb9NR7nXadyRuhQBv+2iqhZkhvUA+sPo5z/SsSAQAAAAD9////lXQ788meUtSxhBX13mx2XhyM3Ddo30QtmNW0YuE2TDABAAAAAP3///8Kr4BwElAScx3bA5ZdavrHwh4Zh+rFNvkE/+7gu1WbngEAAAAA/f///3Uei7j3k/b5tnjFGvNZhe2iWz8O6FQjTEpM5XIoduNsAQAAAAD9////fm5Om4MojcnfZiTmrwb4b5Byw9emrjITi/nkEqTK9MsBAAAAAP3///8lwdpZqt3ILPRwhINY4PGvkg2CSw7agcMPSuFoHDDkIQAAAAAA/f///wGCAXoAAAAAABYAFMkJbUP0COpSYCAmLM2tfIUWuSqBAAAAAAABAHECAAAAAZVxzFxyEg7tiQTgRHwGleR8Srxw6taAGOoEpJK/Xj5sAAAAAAD9////AkBCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYzr/YpAQAAABYAFKmkod5S53U4m5tKFApyeC35UbnbZwAAAAEBH0BCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYAAQBxAgAAAAEVN5/bsfYYAkHM/hRkx4N4+wNWSCU7jv+riOorXyJsJgEAAAAA/f///wJmbOcpAQAAABYAFCCSJBD9wY/VwxnBcnFiu1tA6CGTQEIPAAAAAAAWABSjI8KCqaGX/BGOwJza8hyiuxuIcmcAAAABAR9AQg8AAAAAABYAFKMjwoKpoZf8EY7AnNryHKK7G4hyAAEAcQIAAAAB98EwKZMOHiyRYWyToae6Kce3gCwqUvnVXXHlB/ps9ocBAAAAAP3///8CmNuLKQEAAAAWABQ4roxw+phYHelaRr71DYB3FEy/30BCDwAAAAAAFgAUwSDtQiY7PVvBc7ww56Y72YIQdjllAAAAAQEfQEIPAAAAAAAWABTBIO1CJjs9W8FzvDDnpjvZghB2OQABAHECAAAAAZH/SvCXvDW7b8qb55CDC4M+jgZ61H/e8rZnAGaXp+Z+AAAAAAD9////Apkp2CkBAAAAFgAUc/Y+sIq3oYyEe40GkKJsXawkzwFAQg8AAAAAABYAFLdt1h5Bte8FKvIc2jJgiIwHC7mvZwAAAAEBH0BCDwAAAAAAFgAUt23WHkG17wUq8hzaMmCIjAcLua8AAQBxAgAAAAETC3wMCv9qK3lvVkVJu9b/v2VgMepZtnfngMp2xMXRnwAAAAAA/f///wJk0E4pAQAAABYAFEIsc4cBl+BTN33Kn80+YYfkMt+cQEIPAAAAAAAWABT2/7RIxKohhGbacpBz0BZNYcnfsGUAAAABAR9AQg8AAAAAABYAFPb/tEjEqiGEZtpykHPQFk1hyd+wAAEAcQIAAAABA8J/OnC+cuH79Z6wZmzwdAjhBDaPHavh3yvhr4odDXQBAAAAAP3///8CykowKQEAAAAWABTVHuO8cKOOX/JlmMU66on6Uc54mkBCDwAAAAAAFgAUunZMZryWMqCTiMuVWNF/cleg6dVnAAAAAQEfQEIPAAAAAAAWABS6dkxmvJYyoJOIy5VY0X9yV6Dp1QABAHECAAAAAfRxBaZZ3FfDGwxhZQLYCurN+7kJj0x6nzChg434dnjRAAAAAAD9////AszmyCkBAAAAFgAULSqRp54barF/7R9XOmsLDCVWdAFAQg8AAAAAABYAFNa5adNt/9rZhpGT9mPuSA39xzSIZQAAAAEBH0BCDwAAAAAAFgAU1rlp023/2tmGkZP2Y+5IDf3HNIgAAQBxAgAAAAEgk1JYyP4oIoPoYYcTPPDvZynVfXWINJnBEFBsLv0MtAAAAAAA/f///wJAQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iMmGqKQEAAAAWABT5XKNwVIFsUKh26sqHFSlOLq5TFGUAAAABAR9AQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iIgID+pyVCF5CseUAPNH0GBeMMMluSud5VMoPxIxYgm/06w5HMEQCIG90DSr+fGNoWhCrgLbJG3Wt8PJNMWYqaa5MLWRwA0oTAiA9rsLEqqVhjV6wENfzzpudaE949uLlVqWgDjE/FSgKNAEiBgP6nJUIXkKx5QA80fQYF4wwyW5K53lUyg/EjFiCb/TrDghmHCO3AAAAAAAA" - } - ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." @@ -27933,36 +28132,38 @@ "lightning-cli splice_signed $CHANNEL_ID $PSBT", "```" ], - "example_json_request": [ + "json_example": [ { - "id": "example:splice_init#1", - "method": "splice_init", - "params": { - "channel_id": "5677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc", - "relative_amount": 100000, - "initialpsbt": "cHNidP8BAF4CAAAAAVZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQAAAAD9////AU58DQAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5sAAAAAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", - "feerate_per_kw": null + "request": { + "id": "example:splice_init#1", + "method": "splice_init", + "params": { + "channel_id": "5677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc", + "relative_amount": 100000, + "initialpsbt": "cHNidP8BAF4CAAAAAVZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQAAAAD9////AU58DQAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5sAAAAAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", + "feerate_per_kw": null + } + }, + "response": { + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEFR1IhAjJCZt6EA7OrFXoJ8feE1YevYYMcmYwVG8whu3TCsjFLIQLjvTgAmGbJ2o7EqpnMTqnGwN1G3xXGHvDOHycSkXFOV1KuAQ4gVndyHDWkJKI9bcx8kJA25QWuaGUOCdWXM7S35zADpNwBDwQAAAAAARAEAAAAAAz8CWxpZ2h0bmluZwEIK/Jiqp0i3SYAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAQAAAAEQBP3///8M/AlsaWdodG5pbmcBCDmPhBY5ChQUAAEDCE58DQAAAAAAAQQiUSB4NjVf3IqC3EywCncsVVQVHQY4Sk3WXo0/aKwIVmuEvgz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMIAAAAAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" } }, { - "id": "example:splice_init#2", - "method": "splice_init", - "params": { - "channel_id": "a40bb442dab0231b51d8f842d95aad548aa35e1d13c4cfcf2997344f805453a1", - "relative_amount": -105000, - "initialpsbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIoIYBAAAAAAABBCJRIHg2NV/cioLcTLAKdyxVVBUdBjhKTdZejT9orAhWa4S+AA==", - "feerate_per_kw": null + "request": { + "id": "example:splice_init#2", + "method": "splice_init", + "params": { + "channel_id": "a40bb442dab0231b51d8f842d95aad548aa35e1d13c4cfcf2997344f805453a1", + "relative_amount": -105000, + "initialpsbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIoIYBAAAAAAABBCJRIHg2NV/cioLcTLAKdyxVVBUdBjhKTdZejT9orAhWa4S+AA==", + "feerate_per_kw": null + } + }, + "response": { + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABARzi7RBt64yrfqRL2p+KiUw8cYtiKICRFHmp/4eCSemSAQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgTCjR9L+TfzP7pLJVVto5egTRbRNj/RaBhyrA3UW0aEcCIAJO5FZjXvdpRcGR949C4DnfHs3soklTjn/1upkia+TgASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M9mAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEFR1IhAjJCZt6EA7OrFXoJ8feE1YevYYMcmYwVG8whu3TCsjFLIQLjvTgAmGbJ2o7EqpnMTqnGwN1G3xXGHvDOHycSkXFOV1KuAQ4gpAu0QtqwIxtR2PhC2VqtVIqjXh0TxM/PKZc0T4BUU6EBDwQAAAAAARAEAAAAAAz8CWxpZ2h0bmluZwEIn2Ac8fyFEJwAAQMIAAAAAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQgu7JK9IpBWOAABAwighgEAAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4M/AlsaWdodG5pbmcBCOZ1GpRwbKfuAA==" } } ], - "example_json_response": [ - { - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEFR1IhAjJCZt6EA7OrFXoJ8feE1YevYYMcmYwVG8whu3TCsjFLIQLjvTgAmGbJ2o7EqpnMTqnGwN1G3xXGHvDOHycSkXFOV1KuAQ4gVndyHDWkJKI9bcx8kJA25QWuaGUOCdWXM7S35zADpNwBDwQAAAAAARAEAAAAAAz8CWxpZ2h0bmluZwEIK/Jiqp0i3SYAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAQAAAAEQBP3///8M/AlsaWdodG5pbmcBCDmPhBY5ChQUAAEDCE58DQAAAAAAAQQiUSB4NjVf3IqC3EywCncsVVQVHQY4Sk3WXo0/aKwIVmuEvgz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMIAAAAAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" - }, - { - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABARzi7RBt64yrfqRL2p+KiUw8cYtiKICRFHmp/4eCSemSAQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgTCjR9L+TfzP7pLJVVto5egTRbRNj/RaBhyrA3UW0aEcCIAJO5FZjXvdpRcGR949C4DnfHs3soklTjn/1upkia+TgASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M9mAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEFR1IhAjJCZt6EA7OrFXoJ8feE1YevYYMcmYwVG8whu3TCsjFLIQLjvTgAmGbJ2o7EqpnMTqnGwN1G3xXGHvDOHycSkXFOV1KuAQ4gpAu0QtqwIxtR2PhC2VqtVIqjXh0TxM/PKZc0T4BUU6EBDwQAAAAAARAEAAAAAAz8CWxpZ2h0bmluZwEIn2Ac8fyFEJwAAQMIAAAAAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQgu7JK9IpBWOAABAwighgEAAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4M/AlsaWdodG5pbmcBCOZ1GpRwbKfuAA==" - } - ], "author": [ "Dusty <<@dusty_daemon>> is mainly responsible." ], @@ -28074,20 +28275,20 @@ "lightning-cli splice_signed $CHANNEL_ID $PSBT", "```" ], - "example_json_request": [ + "json_example": [ { - "id": "example:splice_signed#1", - "method": "splice_signed", - "params": { - "channel_id": "5677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc", - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////ARNACI9TcWG+6uC9ElBFN3qhND7amsor/dtBhJ5ujEQAT/80548avrt7d7IJiOAaCNzzYLSXITdL2xjx6mhbBi9hTiEWkUUygSpECk12bHHNORk2lKNArhHgEuW6Gtnvum52ylMJAMLMqxcAAAAADPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4hB7nAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXCQDWuWnTBAAAAAz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMI4MgQAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" - } - } - ], - "example_json_response": [ - { - "tx": "020000000001025677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc0000000000000000005677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc0100000000fdffffff024e7c0d00000000002251207836355fdc8a82dc4cb00a772c5554151d06384a4dd65e8d3f68ac08566b84bee0c81000000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd0400473044022053269f3951a1fc942174ac0dde8462405a86c89b31b444890664ee9735872cff02204cd822c4456c15e90ad342b23e9bb252d383d4e17a8a04818c4919e4fd61efd80147304402205ac0787c79e74ebfa0eaf18964625c53eb672cc4bed2c65303bd9cc192dad6f902206c6c0cded47201dae0020f50a8998555e654d3420c64e801fc668238e3c1cdfa0147522102324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b2102e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5752ae0140088f537161beeae0bd125045377aa1343eda9aca2bfddb41849e6e8c44004fff34e78f1abebb7b77b20988e01a08dcf360b49721374bdb18f1ea685b062f614e6c000000", - "txid": "f00d5e230b401274c88d3e6205e2c6117028cb9878b7d2bc52b1441f0b589427" + "request": { + "id": "example:splice_signed#1", + "method": "splice_signed", + "params": { + "channel_id": "5677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc", + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////ARNACI9TcWG+6uC9ElBFN3qhND7amsor/dtBhJ5ujEQAT/80548avrt7d7IJiOAaCNzzYLSXITdL2xjx6mhbBi9hTiEWkUUygSpECk12bHHNORk2lKNArhHgEuW6Gtnvum52ylMJAMLMqxcAAAAADPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4hB7nAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXCQDWuWnTBAAAAAz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMI4MgQAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" + } + }, + "response": { + "tx": "020000000001025677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc0000000000000000005677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc0100000000fdffffff024e7c0d00000000002251207836355fdc8a82dc4cb00a772c5554151d06384a4dd65e8d3f68ac08566b84bee0c81000000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd0400473044022053269f3951a1fc942174ac0dde8462405a86c89b31b444890664ee9735872cff02204cd822c4456c15e90ad342b23e9bb252d383d4e17a8a04818c4919e4fd61efd80147304402205ac0787c79e74ebfa0eaf18964625c53eb672cc4bed2c65303bd9cc192dad6f902206c6c0cded47201dae0020f50a8998555e654d3420c64e801fc668238e3c1cdfa0147522102324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b2102e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5752ae0140088f537161beeae0bd125045377aa1343eda9aca2bfddb41849e6e8c44004fff34e78f1abebb7b77b20988e01a08dcf360b49721374bdb18f1ea685b062f614e6c000000", + "txid": "f00d5e230b401274c88d3e6205e2c6117028cb9878b7d2bc52b1441f0b589427" + } } ], "author": [ @@ -28205,22 +28406,22 @@ "lightning-cli splice_signed $CHANNEL_ID $PSBT", "```" ], - "example_json_request": [ + "json_example": [ { - "id": "example:splice_update#1", - "method": "splice_update", - "params": { - "channel_id": "5677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc", - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEFR1IhAjJCZt6EA7OrFXoJ8feE1YevYYMcmYwVG8whu3TCsjFLIQLjvTgAmGbJ2o7EqpnMTqnGwN1G3xXGHvDOHycSkXFOV1KuAQ4gVndyHDWkJKI9bcx8kJA25QWuaGUOCdWXM7S35zADpNwBDwQAAAAAARAEAAAAAAz8CWxpZ2h0bmluZwEIK/Jiqp0i3SYAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAQAAAAEQBP3///8M/AlsaWdodG5pbmcBCDmPhBY5ChQUAAEDCE58DQAAAAAAAQQiUSB4NjVf3IqC3EywCncsVVQVHQY4Sk3WXo0/aKwIVmuEvgz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMIAAAAAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" + "request": { + "id": "example:splice_update#1", + "method": "splice_update", + "params": { + "channel_id": "5677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc", + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEFR1IhAjJCZt6EA7OrFXoJ8feE1YevYYMcmYwVG8whu3TCsjFLIQLjvTgAmGbJ2o7EqpnMTqnGwN1G3xXGHvDOHycSkXFOV1KuAQ4gVndyHDWkJKI9bcx8kJA25QWuaGUOCdWXM7S35zADpNwBDwQAAAAAARAEAAAAAAz8CWxpZ2h0bmluZwEIK/Jiqp0i3SYAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAQAAAAEQBP3///8M/AlsaWdodG5pbmcBCDmPhBY5ChQUAAEDCE58DQAAAAAAAQQiUSB4NjVf3IqC3EywCncsVVQVHQY4Sk3WXo0/aKwIVmuEvgz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMIAAAAAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" + } + }, + "response": { + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////DPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4M/AlsaWdodG5pbmcBCMbeD+3qn9/kAAEDCODIEAAAAAAAAQQiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQz8CWxpZ2h0bmluZwEI4upB+mjl6AIA", + "commitments_secured": true } } ], - "example_json_response": [ - { - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////DPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4M/AlsaWdodG5pbmcBCMbeD+3qn9/kAAEDCODIEAAAAAAAAQQiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQz8CWxpZ2h0bmluZwEI4upB+mjl6AIA", - "commitments_secured": true - } - ], "author": [ "Dusty <<@dusty_daemon>> is mainly responsible." ], @@ -28434,53 +28635,55 @@ "}", "```" ], - "example_json_request": [ - { - "id": "example:sql#1", - "method": "sql", - "params": [ - "SELECT * FROM forwards;" - ] - }, - { - "id": "example:sql#2", - "method": "sql", - "params": [ - "SELECT * from peerchannels_features" - ] - } - ], - "example_json_response": [ + "json_example": [ { - "rows": [] + "request": { + "id": "example:sql#1", + "method": "sql", + "params": [ + "SELECT * FROM forwards;" + ] + }, + "response": { + "rows": [] + } }, { - "rows": [ - [ - 6, - 1, - 0, - "option_static_remotekey" - ], - [ - 7, - 1, - 1, - "option_anchors_zero_fee_htlc_tx" - ], - [ - 16, - 11, - 0, - "option_static_remotekey" - ], - [ - 17, - 11, - 1, - "option_anchors_zero_fee_htlc_tx" + "request": { + "id": "example:sql#2", + "method": "sql", + "params": [ + "SELECT * from peerchannels_features" ] - ] + }, + "response": { + "rows": [ + [ + 6, + 1, + 0, + "option_static_remotekey" + ], + [ + 7, + 1, + 1, + "option_anchors_zero_fee_htlc_tx" + ], + [ + 16, + 11, + 0, + "option_static_remotekey" + ], + [ + 17, + 11, + 1, + "option_anchors_zero_fee_htlc_tx" + ] + ] + } } ], "author": [ @@ -28526,18 +28729,18 @@ } } }, - "example_json_request": [ - { - "id": "example:staticbackup#1", - "method": "staticbackup", - "params": "{}" - } - ], - "example_json_response": [ + "json_example": [ { - "scb": [ - "0000000000000001c707da9b230e1655b0a6c082b8daf4fa44d9d1f68163ed4d531d45cf453dc651022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d5900017f000001b2e3c707da9b230e1655b0a6c082b8daf4fa44d9d1f68163ed4d531d45cf453dc6510000000000000000000186a000021000" - ] + "request": { + "id": "example:staticbackup#1", + "method": "staticbackup", + "params": "{}" + }, + "response": { + "scb": [ + "0000000000000001c707da9b230e1655b0a6c082b8daf4fa44d9d1f68163ed4d531d45cf453dc651022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d5900017f000001b2e3c707da9b230e1655b0a6c082b8daf4fa44d9d1f68163ed4d531d45cf453dc6510000000000000000000186a000021000" + ] + } } ], "author": [ @@ -28577,16 +28780,16 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:stop#1", - "method": "stop", - "params": {} - } - ], - "example_json_response": [ - { - "result": "Shutdown complete" + "request": { + "id": "example:stop#1", + "method": "stop", + "params": {} + }, + "response": { + "result": "Shutdown complete" + } } ], "author": [ @@ -28647,21 +28850,21 @@ "", "- -1: An unknown *txid*." ], - "example_json_request": [ + "json_example": [ { - "id": "example:txdiscard#1", - "method": "txdiscard", - "params": { + "request": { + "id": "example:txdiscard#1", + "method": "txdiscard", + "params": { + "txid": "6e680cb76077f11c838cc7aee0c0aa360f9857f00856bb1614025a1af53739fc" + } + }, + "response": { + "unsigned_tx": "020000000142dc00d81359c3a551e170e3bf5262fa9cacc2eb2e283a10e579491cd86dce4b0000000000fdffffff02ffffff00000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd42839800000000002251207836355fdc8a82dc4cb00a772c5554151d06384a4dd65e8d3f68ac08566b84be66000000", "txid": "6e680cb76077f11c838cc7aee0c0aa360f9857f00856bb1614025a1af53739fc" } } ], - "example_json_response": [ - { - "unsigned_tx": "020000000142dc00d81359c3a551e170e3bf5262fa9cacc2eb2e283a10e579491cd86dce4b0000000000fdffffff02ffffff00000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd42839800000000002251207836355fdc8a82dc4cb00a772c5554151d06384a4dd65e8d3f68ac08566b84be66000000", - "txid": "6e680cb76077f11c838cc7aee0c0aa360f9857f00856bb1614025a1af53739fc" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -28757,48 +28960,50 @@ "- 301: There are not enough funds in the internal wallet (including fees) to create the transaction.", "- 302: The dust limit is not met." ], - "example_json_request": [ + "json_example": [ { - "id": "example:txprepare#1", - "method": "txprepare", - "params": { - "outputs": [ - { - "bcrt1qtwxd8wg5eanumk86vfeujvp48hfkgannf77evggzct048wggsrxsum2pmm": 16777215 - } - ], - "feerate": null, - "minconf": null, - "utxos": null + "request": { + "id": "example:txprepare#1", + "method": "txprepare", + "params": { + "outputs": [ + { + "bcrt1qtwxd8wg5eanumk86vfeujvp48hfkgannf77evggzct048wggsrxsum2pmm": 16777215 + } + ], + "feerate": null, + "minconf": null, + "utxos": null + } + }, + "response": { + "unsigned_tx": "020000000142dc00d81359c3a551e170e3bf5262fa9cacc2eb2e283a10e579491cd86dce4b0000000000fdffffff02ffffff00000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd42839800000000002251207836355fdc8a82dc4cb00a772c5554151d06384a4dd65e8d3f68ac08566b84be66000000", + "txid": "6e680cb76077f11c838cc7aee0c0aa360f9857f00856bb1614025a1af53739fc", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABATRHoQ9tEMHRHpf06v5uTEdjdMk1rccIaA6MNGMipNQWAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFLnqitWTi465LGxeucwoSAj16NGbAkcwRAIgVtOsUaQaPgH86aW6e6qmJa1xVb8KWvc+HALGosqVVmQCIFi4JU8Gy+vl2a2/frY+71hitYIBB/tjsRP7fpgb8b9TASECHUIV5q1r2ownjOlAFPQASTlZxxNgBvi5O3hCRvajwdJlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIELcANgTWcOlUeFw479SYvqcrMLrLig6EOV5SRzYbc5LAQ8EAAAAAAEQBP3///8AAQMI////AAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAAEDCEKDmAAAAAAAAQQiUSB4NjVf3IqC3EywCncsVVQVHQY4Sk3WXo0/aKwIVmuEvgA=" } }, { - "id": "example:txprepare#2", - "method": "txprepare", - "params": { - "outputs": [ - { - "bcrt1qyhu7rxj3rrlcj84jtzp2mk9d89xm9v2rx4d4h8au830axugx6mmqsuplng": "100000sat" - } - ], - "feerate": null, - "minconf": null, - "utxos": null + "request": { + "id": "example:txprepare#2", + "method": "txprepare", + "params": { + "outputs": [ + { + "bcrt1qyhu7rxj3rrlcj84jtzp2mk9d89xm9v2rx4d4h8au830axugx6mmqsuplng": "100000sat" + } + ], + "feerate": null, + "minconf": null, + "utxos": null + } + }, + "response": { + "unsigned_tx": "0200000001a91077a134fb9fe4a8d13a482b718368bfd9ce3eff61ff7d96549480a1f97dca0100000000fdffffff02a08601000000000022002025f9e19a5118ff891eb25882add8ad394db2b143355b5b9fbc3c5fd37106d6f66173010000000000225120a2a01c7965289eee56b5cfcddb9856c70fa476c264d21f711c6a69af776ae40366000000", + "txid": "f11d436054607603e903fc69c4bd9b39ce97421341c7cf814ad025cb5bf59c1c", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABAYZ4QwAgPq6Os8kk073f5Yx4T9LXYfbOjAdkzMXfuBQdAAAAAAD9////AjPkAioBAAAAFgAUeOeqzyifepeJAMCl4vnnJ/TRptRADQMAAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgYBFwmqWCrVkxxZ0/tte3z4lIem0L7MkhXzGAOvBWa6YCIFx7H4zOzxjixlZMi0DYYbIEflDjYHJXLfN1wVcXYuekASEDgztw/3Rks6vKGYMXJ83VEvQcNIjg3rJW6KdxEh26uwplAAAAAQEfQA0DAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIKkQd6E0+5/kqNE6SCtxg2i/2c4+/2H/fZZUlICh+X3KAQ8EAQAAAAEQBP3///8AAQMIoIYBAAAAAAABBCIAICX54ZpRGP+JHrJYgq3YrTlNsrFDNVtbn7w8X9NxBtb2AAEDCGFzAQAAAAAAAQQiUSCioBx5ZSie7la1z83bmFbHD6R2wmTSH3Ecammvd2rkAwA=" } } ], - "example_json_response": [ - { - "unsigned_tx": "020000000142dc00d81359c3a551e170e3bf5262fa9cacc2eb2e283a10e579491cd86dce4b0000000000fdffffff02ffffff00000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd42839800000000002251207836355fdc8a82dc4cb00a772c5554151d06384a4dd65e8d3f68ac08566b84be66000000", - "txid": "6e680cb76077f11c838cc7aee0c0aa360f9857f00856bb1614025a1af53739fc", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABATRHoQ9tEMHRHpf06v5uTEdjdMk1rccIaA6MNGMipNQWAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFLnqitWTi465LGxeucwoSAj16NGbAkcwRAIgVtOsUaQaPgH86aW6e6qmJa1xVb8KWvc+HALGosqVVmQCIFi4JU8Gy+vl2a2/frY+71hitYIBB/tjsRP7fpgb8b9TASECHUIV5q1r2ownjOlAFPQASTlZxxNgBvi5O3hCRvajwdJlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIELcANgTWcOlUeFw479SYvqcrMLrLig6EOV5SRzYbc5LAQ8EAAAAAAEQBP3///8AAQMI////AAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAAEDCEKDmAAAAAAAAQQiUSB4NjVf3IqC3EywCncsVVQVHQY4Sk3WXo0/aKwIVmuEvgA=" - }, - { - "unsigned_tx": "0200000001a91077a134fb9fe4a8d13a482b718368bfd9ce3eff61ff7d96549480a1f97dca0100000000fdffffff02a08601000000000022002025f9e19a5118ff891eb25882add8ad394db2b143355b5b9fbc3c5fd37106d6f66173010000000000225120a2a01c7965289eee56b5cfcddb9856c70fa476c264d21f711c6a69af776ae40366000000", - "txid": "f11d436054607603e903fc69c4bd9b39ce97421341c7cf814ad025cb5bf59c1c", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABAYZ4QwAgPq6Os8kk073f5Yx4T9LXYfbOjAdkzMXfuBQdAAAAAAD9////AjPkAioBAAAAFgAUeOeqzyifepeJAMCl4vnnJ/TRptRADQMAAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgYBFwmqWCrVkxxZ0/tte3z4lIem0L7MkhXzGAOvBWa6YCIFx7H4zOzxjixlZMi0DYYbIEflDjYHJXLfN1wVcXYuekASEDgztw/3Rks6vKGYMXJ83VEvQcNIjg3rJW6KdxEh26uwplAAAAAQEfQA0DAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIKkQd6E0+5/kqNE6SCtxg2i/2c4+/2H/fZZUlICh+X3KAQ8EAQAAAAEQBP3///8AAQMIoIYBAAAAAAABBCIAICX54ZpRGP+JHrJYgq3YrTlNsrFDNVtbn7w8X9NxBtb2AAEDCGFzAQAAAAAAAQQiUSCioBx5ZSie7la1z83bmFbHD6R2wmTSH3Ecammvd2rkAwA=" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -28866,22 +29071,22 @@ "", "- -1: Catchall nonspecific error." ], - "example_json_request": [ + "json_example": [ { - "id": "example:txsend#1", - "method": "txsend", - "params": { - "txid": "c9f59ba6bda8e095bb43ecabfa37de8d5194e5c839b6b63be4e29bceaae483ce" + "request": { + "id": "example:txsend#1", + "method": "txsend", + "params": { + "txid": "c9f59ba6bda8e095bb43ecabfa37de8d5194e5c839b6b63be4e29bceaae483ce" + } + }, + "response": { + "tx": "020000000142dc00d81359c3a551e170e3bf5262fa9cacc2eb2e283a10e579491cd86dce4b0000000000fdffffff020000000100000000220020b636f07026ea64952ece5b7620a9337d9ac2321c796a499260994d1b373667504183980000000000225120754a77b503fcba0fd80f0a1a8226ed6764ff9a9d9bb61b485d40d4c9f4be245966000000", + "txid": "c9f59ba6bda8e095bb43ecabfa37de8d5194e5c839b6b63be4e29bceaae483ce", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABATRHoQ9tEMHRHpf06v5uTEdjdMk1rccIaA6MNGMipNQWAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFLnqitWTi465LGxeucwoSAj16NGbAkcwRAIgVtOsUaQaPgH86aW6e6qmJa1xVb8KWvc+HALGosqVVmQCIFi4JU8Gy+vl2a2/frY+71hitYIBB/tjsRP7fpgb8b9TASECHUIV5q1r2ownjOlAFPQASTlZxxNgBvi5O3hCRvajwdJlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZSICA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPRzBEAiBp/HPhg1ObOXqTr5rIjUYLMspGLz+sk1pjD9pjRFzf3wIgWycOB/dQPzwZAK3OXYs269h8o85ucDpdVhH4AyX69a0BIgYD10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8IAfrZCgAAAAABDiBC3ADYE1nDpVHhcOO/UmL6nKzC6y4oOhDleUkc2G3OSwEPBAAAAAABEAT9////AAEDCAAAAAEAAAAAAQQiACC2NvBwJupklS7OW3YgqTN9msIyHHlqSZJgmU0bNzZnUAABAwhBg5gAAAAAAAEEIlEgdUp3tQP8ug/YDwoagibtZ2T/mp2bthtIXUDUyfS+JFkhBycqmiXx/+1S+rBKLMiK6rE1tTcjhWqPFIHCZBf4ipIuCQDVXEk5CwAAAAA=" } } ], - "example_json_response": [ - { - "tx": "020000000142dc00d81359c3a551e170e3bf5262fa9cacc2eb2e283a10e579491cd86dce4b0000000000fdffffff020000000100000000220020b636f07026ea64952ece5b7620a9337d9ac2321c796a499260994d1b373667504183980000000000225120754a77b503fcba0fd80f0a1a8226ed6764ff9a9d9bb61b485d40d4c9f4be245966000000", - "txid": "c9f59ba6bda8e095bb43ecabfa37de8d5194e5c839b6b63be4e29bceaae483ce", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABATRHoQ9tEMHRHpf06v5uTEdjdMk1rccIaA6MNGMipNQWAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFLnqitWTi465LGxeucwoSAj16NGbAkcwRAIgVtOsUaQaPgH86aW6e6qmJa1xVb8KWvc+HALGosqVVmQCIFi4JU8Gy+vl2a2/frY+71hitYIBB/tjsRP7fpgb8b9TASECHUIV5q1r2ownjOlAFPQASTlZxxNgBvi5O3hCRvajwdJlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZSICA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPRzBEAiBp/HPhg1ObOXqTr5rIjUYLMspGLz+sk1pjD9pjRFzf3wIgWycOB/dQPzwZAK3OXYs269h8o85ucDpdVhH4AyX69a0BIgYD10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8IAfrZCgAAAAABDiBC3ADYE1nDpVHhcOO/UmL6nKzC6y4oOhDleUkc2G3OSwEPBAAAAAABEAT9////AAEDCAAAAAEAAAAAAQQiACC2NvBwJupklS7OW3YgqTN9msIyHHlqSZJgmU0bNzZnUAABAwhBg5gAAAAAAAEEIlEgdUp3tQP8ug/YDwoagibtZ2T/mp2bthtIXUDUyfS+JFkhBycqmiXx/+1S+rBKLMiK6rE1tTcjhWqPFIHCZBf4ipIuCQDVXEk5CwAAAAA=" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -29004,37 +29209,39 @@ "", "- -32602: Invalid parameter, i.e. an unparseable PSBT." ], - "example_json_request": [ + "json_example": [ { - "id": "example:unreserveinputs#1", - "method": "unreserveinputs", - "params": { - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABAXyy20ynmOFyRbegGyApk50yNIAb4C+RKV5c2n5VKL3lAAAAAAD9////Akf0EAAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUs/fQpAQAAABYAFN9HebR4q6498ytdeRKjC64CkCOMAkcwRAIgSTJCpWVH1FLZYPdwFe7gZckxCtk+AxPp20KUVKqPIdUCIA3hkoUco68vffiwt6TrE3KgX09JE9m7PDUUgrHQANMRASEDBOBlCza/8qXE5q8uJ+OWsKscDERWfdA+LLCa/lwMH0BlAAAAAQEfR/QQAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZSICA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPRzBEAiBKjSasyN29ODqXSemEQCZfRIvbJP8thKRBrd4e+NLEMQIgMGNz3+DWDnLmjnIDCaVcC7BKxuycwvtJq1qlKFtTaXcBIgYD10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8IAfrZCgAAAAABDiAoXS6QUlCcOApG/j+hr4OhNt0tT4GvCzI6z16Hepi7OwEPBAAAAAABEAT9////AAEDCCN6CAAAAAAAAQQWABQfJ4Qjje0sa2yGBz++6jkM2hGRmAz8CWxpZ2h0bmluZwQCAAEAAQMIinkIAAAAAAABBCJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aIQeRRTKBKkQKTXZscc05GTaUo0CuEeAS5boa2e+6bnbKUwkAwsyrFwIAAAAA", - "reserve": 200 + "request": { + "id": "example:unreserveinputs#1", + "method": "unreserveinputs", + "params": { + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABAXyy20ynmOFyRbegGyApk50yNIAb4C+RKV5c2n5VKL3lAAAAAAD9////Akf0EAAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUs/fQpAQAAABYAFN9HebR4q6498ytdeRKjC64CkCOMAkcwRAIgSTJCpWVH1FLZYPdwFe7gZckxCtk+AxPp20KUVKqPIdUCIA3hkoUco68vffiwt6TrE3KgX09JE9m7PDUUgrHQANMRASEDBOBlCza/8qXE5q8uJ+OWsKscDERWfdA+LLCa/lwMH0BlAAAAAQEfR/QQAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZSICA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPRzBEAiBKjSasyN29ODqXSemEQCZfRIvbJP8thKRBrd4e+NLEMQIgMGNz3+DWDnLmjnIDCaVcC7BKxuycwvtJq1qlKFtTaXcBIgYD10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8IAfrZCgAAAAABDiAoXS6QUlCcOApG/j+hr4OhNt0tT4GvCzI6z16Hepi7OwEPBAAAAAABEAT9////AAEDCCN6CAAAAAAAAQQWABQfJ4Qjje0sa2yGBz++6jkM2hGRmAz8CWxpZ2h0bmluZwQCAAEAAQMIinkIAAAAAAABBCJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aIQeRRTKBKkQKTXZscc05GTaUo0CuEeAS5boa2e+6bnbKUwkAwsyrFwIAAAAA", + "reserve": 200 + } + }, + "response": { + "reservations": [ + { + "txid": "3bbb987a875ecf3a320baf814f2ddd36a183afa13ffe460a389c5052902e5d28", + "vout": 0, + "was_reserved": true, + "reserved": false + } + ] } }, { - "id": "example:unreserveinputs#2", - "method": "unreserveinputs", - "params": { - "psbt": "cHNidP8BAF4CAAAAAVa79WPJoiYrzo/RgzIAn5HanoBFZo0vZvEjxPAVwLv4AAAAAAD9////AXzpHAAAAAAAIlEgBRjpLNlOD2LAbxJt/5i5q+ebfthFoVbVJFZ44mVUR11mAAAAAAEA3gIAAAAAAQENwcSElLyC0jcwUHiODBhtapHyzIdiwytOGiu/Raf4BwAAAAAA/f///wKAhB4AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFl82znKQEAAAAWABQyIWyAI6LDf6dJ58BDPdkh+PWUZwJHMEQCIGiJFhVi/d/Hz19Cz48uHTjhgBJ6WAlgl/bLVS7A6VtxAiAwlb7xYzIM4uopFvMnpOmGIOp3+upOPPF2F8VaB8U/HQEhA6BAjey7RADP4ifoh2VXhX7QXkh+sZqozv1EPuU5TxZmZQAAAAEBH4CEHgAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUAAA==", - "reserve": null - } - } - ], - "example_json_response": [ - { - "reservations": [ - { - "txid": "3bbb987a875ecf3a320baf814f2ddd36a183afa13ffe460a389c5052902e5d28", - "vout": 0, - "was_reserved": true, - "reserved": false + "request": { + "id": "example:unreserveinputs#2", + "method": "unreserveinputs", + "params": { + "psbt": "cHNidP8BAF4CAAAAAVa79WPJoiYrzo/RgzIAn5HanoBFZo0vZvEjxPAVwLv4AAAAAAD9////AXzpHAAAAAAAIlEgBRjpLNlOD2LAbxJt/5i5q+ebfthFoVbVJFZ44mVUR11mAAAAAAEA3gIAAAAAAQENwcSElLyC0jcwUHiODBhtapHyzIdiwytOGiu/Raf4BwAAAAAA/f///wKAhB4AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFl82znKQEAAAAWABQyIWyAI6LDf6dJ58BDPdkh+PWUZwJHMEQCIGiJFhVi/d/Hz19Cz48uHTjhgBJ6WAlgl/bLVS7A6VtxAiAwlb7xYzIM4uopFvMnpOmGIOp3+upOPPF2F8VaB8U/HQEhA6BAjey7RADP4ifoh2VXhX7QXkh+sZqozv1EPuU5TxZmZQAAAAEBH4CEHgAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUAAA==", + "reserve": null } - ] - }, - { - "reservations": [] + }, + "response": { + "reservations": [] + } } ], "author": [ @@ -29118,30 +29325,32 @@ "", "The caller can call `upgradewallet` to convert their funds to native segwit outputs, which are valid for liquidity ad buys." ], - "example_json_request": [ - { - "id": "example:upgradewallet#1", - "method": "upgradewallet", - "params": "{}" - }, + "json_example": [ { - "id": "example:upgradewallet#2", - "method": "upgradewallet", - "params": { - "feerate": "urgent", - "reservedok": true + "request": { + "id": "example:upgradewallet#1", + "method": "upgradewallet", + "params": "{}" + }, + "response": { + "upgraded_outs": 0 } - } - ], - "example_json_response": [ - { - "upgraded_outs": 0 }, { - "tx": "0200000001c08ce0a9ea1e00179ea603cb8619ec2a2df990ef931e1ccd87fa7a0e271ed8370100000000fdffffff013514310100000000225120888ab14b6e1655d1d00039b836d70b66e3351543ab6cd2f94166255f3d5e6cb5cf000000", - "txid": "de5f1d6f0b2f95cfe5cfbf8cc33bd3f279a8f800ee0efc27bbfafb2b6ead9560", - "psbt": "cHNidP8BAgQCAAAAAQMEzwAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDgAgAAAAABAZRZ0m0kaJA+ubJw1eYurGROu1BYc0i7l9xbyG06R6uZAQAAAAD9////AmQtPCgBAAAAF6kUnoGu9IUv0FGnzol3Lb/BNBNkOViHAC0xAQAAAAAXqRRlVyjzbP420BqlDTI2cERp+EpVQIcCRzBEAiBliJpjBsipwFgsLZMlzbESZ6hMTh+pgKQlXUIL0nLb3wIga/xwr/IJgEc7Ie6ApS4aVDr9xr1TZ3wj+8bRvI6WqScBIQPgYuc48PzUufScX6A6YOsdmJwn+bAQjLZ/g9jhQYduHM4AAAABASAALTEBAAAAABepFGVXKPNs/jbQGqUNMjZwRGn4SlVAhyICArnAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXRzBEAiBlTUNYfS5n5rGRVmoNb0z3AMGJjHijwpXROGIVxfoBnQIgeTx32KY3CcfYTYzXUIRQAMUQB7rlPWRptWMDD3UttkcBAQQWABTWuWnTbf/a2YaRk/Zj7kgN/cc0iCIGArnAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXCNa5adMAAAAAAQ4gwIzgqeoeABeepgPLhhnsKi35kO+THhzNh/p6Dice2DcBDwQBAAAAARAE/f///wABAwg1FDEBAAAAAAEEIlEgiIqxS24WVdHQADm4NtcLZuM1FUOrbNL5QWYlXz1ebLUhByjMj8l44gnxaV+ltWVQYdsaqyMRtSQXaUW/EBXvLUuJCQCftnv8BwAAAAA=", - "upgraded_outs": 1 + "request": { + "id": "example:upgradewallet#2", + "method": "upgradewallet", + "params": { + "feerate": "urgent", + "reservedok": true + } + }, + "response": { + "tx": "0200000001c08ce0a9ea1e00179ea603cb8619ec2a2df990ef931e1ccd87fa7a0e271ed8370100000000fdffffff013514310100000000225120888ab14b6e1655d1d00039b836d70b66e3351543ab6cd2f94166255f3d5e6cb5cf000000", + "txid": "de5f1d6f0b2f95cfe5cfbf8cc33bd3f279a8f800ee0efc27bbfafb2b6ead9560", + "psbt": "cHNidP8BAgQCAAAAAQMEzwAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDgAgAAAAABAZRZ0m0kaJA+ubJw1eYurGROu1BYc0i7l9xbyG06R6uZAQAAAAD9////AmQtPCgBAAAAF6kUnoGu9IUv0FGnzol3Lb/BNBNkOViHAC0xAQAAAAAXqRRlVyjzbP420BqlDTI2cERp+EpVQIcCRzBEAiBliJpjBsipwFgsLZMlzbESZ6hMTh+pgKQlXUIL0nLb3wIga/xwr/IJgEc7Ie6ApS4aVDr9xr1TZ3wj+8bRvI6WqScBIQPgYuc48PzUufScX6A6YOsdmJwn+bAQjLZ/g9jhQYduHM4AAAABASAALTEBAAAAABepFGVXKPNs/jbQGqUNMjZwRGn4SlVAhyICArnAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXRzBEAiBlTUNYfS5n5rGRVmoNb0z3AMGJjHijwpXROGIVxfoBnQIgeTx32KY3CcfYTYzXUIRQAMUQB7rlPWRptWMDD3UttkcBAQQWABTWuWnTbf/a2YaRk/Zj7kgN/cc0iCIGArnAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXCNa5adMAAAAAAQ4gwIzgqeoeABeepgPLhhnsKi35kO+THhzNh/p6Dice2DcBDwQBAAAAARAE/f///wABAwg1FDEBAAAAAAEEIlEgiIqxS24WVdHQADm4NtcLZuM1FUOrbNL5QWYlXz1ebLUhByjMj8l44gnxaV+ltWVQYdsaqyMRtSQXaUW/EBXvLUuJCQCftnv8BwAAAAA=", + "upgraded_outs": 1 + } } ], "author": [ @@ -29350,71 +29559,73 @@ "- -1: Catchall nonspecific error.", "- 301: Insufficient UTXOs to meet *satoshi* value." ], - "example_json_request": [ - { - "id": "example:utxopsbt#1", - "method": "utxopsbt", - "params": { - "satoshi": 0, - "feerate": "253perkw", - "startweight": 0, - "utxos": [ - "d82a99192fb333106ea8d08f5231ed45f2ed5b1ef9eb81b0fef8f9ea354d2637:1" - ], - "reserve": 0, - "reservedok": true, - "locktime": null, - "min_witness_weight": null, - "excess_as_change": false - } - }, + "json_example": [ { - "id": "example:utxopsbt#2", - "method": "utxopsbt", - "params": { - "satoshi": 1000000, - "feerate": "7500perkw", - "startweight": 0, - "utxos": [ - "2fc3b9f8d4aed120f6d9a6f206f07c35ef4d518ec0305d1d974873d256e38ca7:1", - "2f669f6a605ee5c7ddd2abb753bc64b1a90bd1b7448264f5d78a7ca823c00a1b:1" - ], - "reserve": null, - "reservedok": true, - "locktime": null, - "min_witness_weight": null, - "excess_as_change": false + "request": { + "id": "example:utxopsbt#1", + "method": "utxopsbt", + "params": { + "satoshi": 0, + "feerate": "253perkw", + "startweight": 0, + "utxos": [ + "d82a99192fb333106ea8d08f5231ed45f2ed5b1ef9eb81b0fef8f9ea354d2637:1" + ], + "reserve": 0, + "reservedok": true, + "locktime": null, + "min_witness_weight": null, + "excess_as_change": false + } + }, + "response": { + "psbt": "cHNidP8BADMCAAAAATcmTTXq+fj+sIHr+R5b7fJF7TFSj9CobhAzsy8ZmSrYAQAAAAD9////AGYAAAAAAQDeAgAAAAABAWQACJva49ga8OCYXvPRWQRhoXndrJykwjgXbwT251dEAAAAAAD9////AiOI9ikBAAAAFgAU3gClv/YpAKRpfDuiFu6mIL2E4+5QaQ8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgUXIQFs7oRkorVThUn3sLj7WI7g8c8RHai4ChoCvIkWsCICp1CqHl4BlMJCKFHRWHXhhekaj0r1EFSNrh8UnvysQPASEDqHIAEdaH3H6pb3VJzbJNDG4lL8PTfsheL+h2p6baK3JlAAAAAQEfUGkPAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", + "feerate_per_kw": 253, + "estimated_final_weight": 271, + "excess_msat": 1009932000 } - } - ], - "example_json_response": [ - { - "psbt": "cHNidP8BADMCAAAAATcmTTXq+fj+sIHr+R5b7fJF7TFSj9CobhAzsy8ZmSrYAQAAAAD9////AGYAAAAAAQDeAgAAAAABAWQACJva49ga8OCYXvPRWQRhoXndrJykwjgXbwT251dEAAAAAAD9////AiOI9ikBAAAAFgAU3gClv/YpAKRpfDuiFu6mIL2E4+5QaQ8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgUXIQFs7oRkorVThUn3sLj7WI7g8c8RHai4ChoCvIkWsCICp1CqHl4BlMJCKFHRWHXhhekaj0r1EFSNrh8UnvysQPASEDqHIAEdaH3H6pb3VJzbJNDG4lL8PTfsheL+h2p6baK3JlAAAAAQEfUGkPAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", - "feerate_per_kw": 253, - "estimated_final_weight": 271, - "excess_msat": 1009932000 }, { - "psbt": "cHNidP8BAFwCAAAAAqeM41bSc0iXHV0wwI5RTe81fPAG8qbZ9iDRrtT4ucMvAQAAAAD9////GwrAI6h8itf1ZIJEt9ELqbFkvFO3q9Ldx+VeYGqfZi8BAAAAAP3///8AZgAAAAABAN4CAAAAAAEBEaK0TQ97IsrzuO1gLt+vYbvLBG90NrCOZp7SCgrRknYAAAAAAP3///8CM6/2KQEAAAAWABQ1B/KkIVbg7yFRcCEN/VOptfOX/EBCDwAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUCRzBEAiA1oI1us81XEa/DRlvcP2qnbWLsV5pZcRfvj9MLyT202gIgb7noMqHYWMmm7H7VNEfWa29jjtuV9yrrSc9ui11ECQ0BIQKhZOHR4gFKMu2EKKgZ/7qnhzq9PvhtnAW2sxPZ4c9RIWUAAAABAR9AQg8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAAEA3gIAAAAAAQGnjONW0nNIlx1dMMCOUU3vNXzwBvKm2fYg0a7U+LnDLwAAAAAA/f///wJmbOcpAQAAABYAFOwPo5eUrDF7UgZBFQLRHOeX6PiGQEIPAAAAAAAWABTCzKsXHCpb6dq1LsQbglhjAkxUZgJHMEQCICgjGlauGj2eiMS4MWUK6zAWqMe1OuidQR+Hy9ZgSTuzAiA8JTb9OrLqS3hiWtT+TQ/NBsKJ2hhHLDaKUUNdgi4OkAEhA9g3oH5ejmGIqUY2ZWxc8YWF2+T+XpE/6oC40Cx3+e97ZQAAAAEBH0BCDwAAAAAAFgAUwsyrFxwqW+natS7EG4JYYwJMVGYA", - "feerate_per_kw": 7500, - "estimated_final_weight": 542, - "excess_msat": 995935000, - "reservations": [ - { - "txid": "2fc3b9f8d4aed120f6d9a6f206f07c35ef4d518ec0305d1d974873d256e38ca7", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "2f669f6a605ee5c7ddd2abb753bc64b1a90bd1b7448264f5d78a7ca823c00a1b", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 + "request": { + "id": "example:utxopsbt#2", + "method": "utxopsbt", + "params": { + "satoshi": 1000000, + "feerate": "7500perkw", + "startweight": 0, + "utxos": [ + "2fc3b9f8d4aed120f6d9a6f206f07c35ef4d518ec0305d1d974873d256e38ca7:1", + "2f669f6a605ee5c7ddd2abb753bc64b1a90bd1b7448264f5d78a7ca823c00a1b:1" + ], + "reserve": null, + "reservedok": true, + "locktime": null, + "min_witness_weight": null, + "excess_as_change": false } - ] + }, + "response": { + "psbt": "cHNidP8BAFwCAAAAAqeM41bSc0iXHV0wwI5RTe81fPAG8qbZ9iDRrtT4ucMvAQAAAAD9////GwrAI6h8itf1ZIJEt9ELqbFkvFO3q9Ldx+VeYGqfZi8BAAAAAP3///8AZgAAAAABAN4CAAAAAAEBEaK0TQ97IsrzuO1gLt+vYbvLBG90NrCOZp7SCgrRknYAAAAAAP3///8CM6/2KQEAAAAWABQ1B/KkIVbg7yFRcCEN/VOptfOX/EBCDwAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUCRzBEAiA1oI1us81XEa/DRlvcP2qnbWLsV5pZcRfvj9MLyT202gIgb7noMqHYWMmm7H7VNEfWa29jjtuV9yrrSc9ui11ECQ0BIQKhZOHR4gFKMu2EKKgZ/7qnhzq9PvhtnAW2sxPZ4c9RIWUAAAABAR9AQg8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAAEA3gIAAAAAAQGnjONW0nNIlx1dMMCOUU3vNXzwBvKm2fYg0a7U+LnDLwAAAAAA/f///wJmbOcpAQAAABYAFOwPo5eUrDF7UgZBFQLRHOeX6PiGQEIPAAAAAAAWABTCzKsXHCpb6dq1LsQbglhjAkxUZgJHMEQCICgjGlauGj2eiMS4MWUK6zAWqMe1OuidQR+Hy9ZgSTuzAiA8JTb9OrLqS3hiWtT+TQ/NBsKJ2hhHLDaKUUNdgi4OkAEhA9g3oH5ejmGIqUY2ZWxc8YWF2+T+XpE/6oC40Cx3+e97ZQAAAAEBH0BCDwAAAAAAFgAUwsyrFxwqW+natS7EG4JYYwJMVGYA", + "feerate_per_kw": 7500, + "estimated_final_weight": 542, + "excess_msat": 995935000, + "reservations": [ + { + "txid": "2fc3b9f8d4aed120f6d9a6f206f07c35ef4d518ec0305d1d974873d256e38ca7", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "2f669f6a605ee5c7ddd2abb753bc64b1a90bd1b7448264f5d78a7ca823c00a1b", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + } + ] + } } ], "author": [ @@ -29720,60 +29931,64 @@ "", "- -32602: If the given parameters are wrong." ], - "example_json_request": [ + "json_example": [ { - "id": "example:wait#1", - "method": "wait", - "params": { + "request": { + "id": "example:wait#1", + "method": "wait", + "params": { + "subsystem": "invoices", + "indexname": "created", + "nextvalue": 1 + } + }, + "response": { "subsystem": "invoices", - "indexname": "created", - "nextvalue": 1 + "created": 1, + "details": { + "status": "unpaid", + "label": "invlabel", + "bolt11": "lnbcrt420p1pjmxtevsp5d8c6gnaj8lyjy2qly783vklda9dfaqeyzyc37agxxp8h3uguv8pqpp5w6lhwxhqnuew4hle5h7qwjm27zz784mvsrzhmayhscy5t2hy5c4qdqvd9h8ver9wd3sxqyjw5qcqp99qxpqysgq09gxhjhwu9u3z6dlt5ln5f4g8zl78wz4pgh0am3kz54m9lllhqckf4gmhmt2ftrclq5x62zkqmggc7y0ju0ghdfwjz8hyd8l5cqvemgpyyhm6w" + } } }, { - "id": "example:wait#2", - "method": "wait", - "params": { + "request": { + "id": "example:wait#2", + "method": "wait", + "params": { + "subsystem": "invoices", + "indexname": "updated", + "nextvalue": 2 + } + }, + "response": { "subsystem": "invoices", - "indexname": "updated", - "nextvalue": 2 + "updated": 2, + "details": { + "status": "expired" + } } }, { - "id": "example:wait#3", - "method": "wait", - "params": { + "request": { + "id": "example:wait#3", + "method": "wait", + "params": { + "subsystem": "sendpays", + "indexname": "updated", + "nextvalue": 2 + } + }, + "response": { "subsystem": "sendpays", - "indexname": "updated", - "nextvalue": 2 - } - } - ], - "example_json_response": [ - { - "subsystem": "invoices", - "created": 1, - "details": { - "status": "unpaid", - "label": "invlabel", - "bolt11": "lnbcrt420p1pjmxtevsp5d8c6gnaj8lyjy2qly783vklda9dfaqeyzyc37agxxp8h3uguv8pqpp5w6lhwxhqnuew4hle5h7qwjm27zz784mvsrzhmayhscy5t2hy5c4qdqvd9h8ver9wd3sxqyjw5qcqp99qxpqysgq09gxhjhwu9u3z6dlt5ln5f4g8zl78wz4pgh0am3kz54m9lllhqckf4gmhmt2ftrclq5x62zkqmggc7y0ju0ghdfwjz8hyd8l5cqvemgpyyhm6w" - } - }, - { - "subsystem": "invoices", - "updated": 2, - "details": { - "status": "expired" - } - }, - { - "subsystem": "sendpays", - "updated": 2, - "details": { - "status": "complete", - "partid": 0, - "groupid": 1, - "payment_hash": "220dcfcf43e1fab3ce30f70eb943c3ce962393f5a65ced52d749e324b443d19e" + "updated": 2, + "details": { + "status": "complete", + "partid": 0, + "groupid": 1, + "payment_hash": "220dcfcf43e1fab3ce30f70eb943c3ce962393f5a65ced52d749e324b443d19e" + } } } ], @@ -30004,58 +30219,60 @@ "", "- 904: The *timeout* was reached without an invoice being paid." ], - "example_json_request": [ + "json_example": [ { - "id": "example:waitanyinvoice#1", - "method": "waitanyinvoice", - "params": { - "lastpay_index": null, - "timeout": null + "request": { + "id": "example:waitanyinvoice#1", + "method": "waitanyinvoice", + "params": { + "lastpay_index": null, + "timeout": null + } + }, + "response": { + "label": "inv1", + "bolt11": "lnbcrt10n1pjmxtsxsp56sn02x8lccjfsvunnhz5858zuyxztug9luy226w4qsmfm4r8pkcspp5gw5r0dw99yf3zqxrg24l8g9m9hun9cu06ldg4rga8s9t9kv8z45sdq8d9h8vvgxqyjw5qcqp99qxpqysgqv537uh2sx8ch640mf4t43t8qjtpg3z7gukgm07tlyq986m7nvsnxkapg37z4vsxtl4thfqzc64anqr83geygkc2xaftxgr97dltqfjqpe3mhja", + "payment_hash": "43a837b5c529131100c342abf3a0bb2df932e38fd7da8a8d1d3c0ab2d9871569", + "amount_msat": 1000, + "status": "paid", + "pay_index": 1, + "amount_received_msat": 1000, + "paid_at": 1706241546, + "payment_preimage": "a0c668998de14b975f33e1060b3efd7efc0bde784ac266ab667a1b2fddab3cd1", + "description": [ + "Inv1." + ], + "expires_at": 1706846342, + "created_index": 1, + "updated_index": 1 } }, { - "id": "example:waitanyinvoice#2", - "method": "waitanyinvoice", - "params": { - "lastpay_index": 3, - "timeout": 0 + "request": { + "id": "example:waitanyinvoice#2", + "method": "waitanyinvoice", + "params": { + "lastpay_index": 3, + "timeout": 0 + } + }, + "response": { + "label": "inv4", + "bolt11": "lnbcrt10n1pja0tkmsp57j4z9zwvdsyh57unh3da7aac5z20clfnrwy5nqm6wujaelduw23qpp580mdrwakz9xewc2vhvpucset9gjkgdvyhw7h9frcy2d6p2lwdw2qdq8d9h8vdqxqyjw5qcqp99qxpqysgqtgyzhtxs3p2dyk8wk9q028033303702d2hml4frmu38qe79mrkgzgxvyjmq2q4nhjgcuz3uhmlda3jnhf9w6mj8mj97pkgnda9l5kdcqsdgewf", + "payment_hash": "3bf6d1bbb6114d97614cbb03cc432b2a25643584bbbd72a478229ba0abee6b94", + "amount_msat": 1000, + "status": "paid", + "pay_index": 4, + "amount_received_msat": 1000, + "paid_at": 1708633825, + "payment_preimage": "77336a342dde76050c7ee7fc18599e407dfc1edad3c784ba68e9603004365b94", + "description": "inv4", + "expires_at": 1709238619, + "created_index": 4, + "updated_index": 4 } } ], - "example_json_response": [ - { - "label": "inv1", - "bolt11": "lnbcrt10n1pjmxtsxsp56sn02x8lccjfsvunnhz5858zuyxztug9luy226w4qsmfm4r8pkcspp5gw5r0dw99yf3zqxrg24l8g9m9hun9cu06ldg4rga8s9t9kv8z45sdq8d9h8vvgxqyjw5qcqp99qxpqysgqv537uh2sx8ch640mf4t43t8qjtpg3z7gukgm07tlyq986m7nvsnxkapg37z4vsxtl4thfqzc64anqr83geygkc2xaftxgr97dltqfjqpe3mhja", - "payment_hash": "43a837b5c529131100c342abf3a0bb2df932e38fd7da8a8d1d3c0ab2d9871569", - "amount_msat": 1000, - "status": "paid", - "pay_index": 1, - "amount_received_msat": 1000, - "paid_at": 1706241546, - "payment_preimage": "a0c668998de14b975f33e1060b3efd7efc0bde784ac266ab667a1b2fddab3cd1", - "description": [ - "Inv1." - ], - "expires_at": 1706846342, - "created_index": 1, - "updated_index": 1 - }, - { - "label": "inv4", - "bolt11": "lnbcrt10n1pja0tkmsp57j4z9zwvdsyh57unh3da7aac5z20clfnrwy5nqm6wujaelduw23qpp580mdrwakz9xewc2vhvpucset9gjkgdvyhw7h9frcy2d6p2lwdw2qdq8d9h8vdqxqyjw5qcqp99qxpqysgqtgyzhtxs3p2dyk8wk9q028033303702d2hml4frmu38qe79mrkgzgxvyjmq2q4nhjgcuz3uhmlda3jnhf9w6mj8mj97pkgnda9l5kdcqsdgewf", - "payment_hash": "3bf6d1bbb6114d97614cbb03cc432b2a25643584bbbd72a478229ba0abee6b94", - "amount_msat": 1000, - "status": "paid", - "pay_index": 4, - "amount_received_msat": 1000, - "paid_at": 1708633825, - "payment_preimage": "77336a342dde76050c7ee7fc18599e407dfc1edad3c784ba68e9603004365b94", - "description": "inv4", - "expires_at": 1709238619, - "created_index": 4, - "updated_index": 4 - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], @@ -30119,32 +30336,34 @@ "", "- 2000: Timed out." ], - "example_json_request": [ + "json_example": [ { - "id": "example:waitblockheight#1", - "method": "waitblockheight", - "params": { - "blockheight": 99, - "timeout": null + "request": { + "id": "example:waitblockheight#1", + "method": "waitblockheight", + "params": { + "blockheight": 99, + "timeout": null + } + }, + "response": { + "blockheight": 99 } }, { - "id": "example:waitblockheight#2", - "method": "waitblockheight", - "params": { - "blockheight": 103, - "timeout": 600 + "request": { + "id": "example:waitblockheight#2", + "method": "waitblockheight", + "params": { + "blockheight": 103, + "timeout": 600 + } + }, + "response": { + "blockheight": 103 } } ], - "example_json_response": [ - { - "blockheight": 99 - }, - { - "blockheight": 103 - } - ], "author": [ "ZmnSCPxj <> is mainly responsible." ], @@ -30370,34 +30589,34 @@ "- -1: If the invoice is deleted while unpaid, or the invoice does not exist.", "- 903: If the invoice expires before being paid, or is already expired." ], - "example_json_request": [ + "json_example": [ { - "id": "example:waitinvoice#1", - "method": "waitinvoice", - "params": { - "label": "inv2" + "request": { + "id": "example:waitinvoice#1", + "method": "waitinvoice", + "params": { + "label": "inv2" + } + }, + "response": { + "label": "inv2", + "bolt11": "lnbcrt10n1pjmxtwjsp5mzvdu6v8hqsf2tlj0nlyks23afqp7ejs444syjxf74p60ztmld8qpp5q4ayz5pys3t0yj0dmkmh7ctarkv9z434paz4u9rdwnj4f43thhaqdq8d9h8vvsxqyjw5qcqp99qxpqysgqn0055ttns6pafsxh6xuqce6e4vz8gtxlzqx0l9d9f5crmqx4jymh4zy9jdaszm0dj89sq39fvhpwcs626dt0n3gw8kassfdehp5sy3sq7fzy3w", + "payment_hash": "057a4150248456f249edddb77f617d1d985156350f455e146d74e554d62bbdfa", + "amount_msat": 1000, + "status": "paid", + "pay_index": 1, + "amount_received_msat": 1000, + "paid_at": 1706241494, + "payment_preimage": "34ccd37cc85e067cb376f9ea8c70d70469f58bf296f2566ed9ad4dfb70971a26", + "description": [ + "Inv2." + ], + "expires_at": 1706846290, + "created_index": 2, + "updated_index": 1 } } ], - "example_json_response": [ - { - "label": "inv2", - "bolt11": "lnbcrt10n1pjmxtwjsp5mzvdu6v8hqsf2tlj0nlyks23afqp7ejs444syjxf74p60ztmld8qpp5q4ayz5pys3t0yj0dmkmh7ctarkv9z434paz4u9rdwnj4f43thhaqdq8d9h8vvsxqyjw5qcqp99qxpqysgqn0055ttns6pafsxh6xuqce6e4vz8gtxlzqx0l9d9f5crmqx4jymh4zy9jdaszm0dj89sq39fvhpwcs626dt0n3gw8kassfdehp5sy3sq7fzy3w", - "payment_hash": "057a4150248456f249edddb77f617d1d985156350f455e146d74e554d62bbdfa", - "amount_msat": 1000, - "status": "paid", - "pay_index": 1, - "amount_received_msat": 1000, - "paid_at": 1706241494, - "payment_preimage": "34ccd37cc85e067cb376f9ea8c70d70469f58bf296f2566ed9ad4dfb70971a26", - "description": [ - "Inv2." - ], - "expires_at": 1706846290, - "created_index": 2, - "updated_index": 1 - } - ], "author": [ "Christian Decker <> is mainly responsible." ], @@ -30631,35 +30850,35 @@ "*failcode*: The failure code, as per BOLT #4.", "*failcodename*: The human-readable name corresponding to *failcode*, if known." ], - "example_json_request": [ + "json_example": [ { - "id": "example:waitsendpay#1", - "method": "waitsendpay", - "params": { + "request": { + "id": "example:waitsendpay#1", + "method": "waitsendpay", + "params": { + "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", + "timeout": null, + "partid": null, + "groupid": null + } + }, + "response": { + "created_index": 1, + "id": 1, "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "timeout": null, - "partid": null, - "groupid": null + "groupid": 1, + "updated_index": 1, + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount_msat": 11000000, + "amount_sent_msat": 11000000, + "created_at": 1706152930, + "completed_at": 1706152933, + "status": "complete", + "payment_preimage": "af7ba559629f719c04c43a82767fe3622790a539164d6270db07f765203e574b", + "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk" } } ], - "example_json_response": [ - { - "created_index": 1, - "id": 1, - "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "groupid": 1, - "updated_index": 1, - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount_msat": 11000000, - "amount_sent_msat": 11000000, - "created_at": 1706152930, - "completed_at": 1706152933, - "status": "complete", - "payment_preimage": "af7ba559629f719c04c43a82767fe3622790a539164d6270db07f765203e574b", - "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk" - } - ], "author": [ "ZmnSCPxj <> is mainly responsible." ], @@ -30758,44 +30977,46 @@ "- 302: The dust limit is not met.", "- 313: The `min-emergency-msat` reserve not be preserved (and we have anchor channels)." ], - "example_json_request": [ + "json_example": [ { - "id": "example:withdraw#1", - "method": "withdraw", - "params": { - "destination": "bcrt1qjc7j2l5es4haw35c9jzm8dfm763ng5djp8f0s0", - "satoshi": 555555, - "feerate": null, - "minconf": null, - "utxos": null + "request": { + "id": "example:withdraw#1", + "method": "withdraw", + "params": { + "destination": "bcrt1qjc7j2l5es4haw35c9jzm8dfm763ng5djp8f0s0", + "satoshi": 555555, + "feerate": null, + "minconf": null, + "utxos": null + } + }, + "response": { + "tx": "0200000001ef28647baa13cc4c03b8a58c8bd08b69de434c22ff591eb68171ae992e3d816d0000000000fdffffff02237a080000000000160014963d257e99856fd746982c85b3b53bf6a33451b24d6808000000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a66000000", + "txid": "ccb97d7dc695cabb78b217c0b27d7d00d2941966199480e6443e0680d24d69eb", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABAWPCRda9hy4QKqUEmtb7gK7SAqzh1xBP8nZ7PCj+7+JDAAAAAAD9////Akf0EAAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUs/fQpAQAAABYAFOIj6yaI/g85utJBtkPPdK1X59cfAkcwRAIgH7J57HuUTpnCbDrDqE8W7ryuCXk+i/TszQ/NF55lWncCIDeN4y+EzIDP3l2XO5/wjk98krYqnzvEhrStk+0+fTowASEC6Ng5r5KTNIXBRRvjivsd8SKnHF59r/ViDj2+CLJVb75lAAAAAQEfR/QQAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZSICA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPRzBEAiBY0urYSHLnnXaAJH7yaGfvGmm+VuNCNIBhQaJU6iDNEgIgA7EASW+V00Su+lRQAE3Qbe4wavLq7l6Jn2vR+6Snyd0BIgYD10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8IAfrZCgAAAAABDiDvKGR7qhPMTAO4pYyL0Itp3kNMIv9ZHraBca6ZLj2BbQEPBAAAAAABEAT9////AAEDCCN6CAAAAAAAAQQWABSWPSV+mYVv10aYLIWztTv2ozRRsgz8CWxpZ2h0bmluZwQCAAEAAQMITWgIAAAAAAABBCJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aIQeRRTKBKkQKTXZscc05GTaUo0CuEeAS5boa2e+6bnbKUwkAwsyrFwIAAAAA" } }, { - "id": "example:withdraw#2", - "method": "withdraw", - "params": { - "destination": "bcrt1q66ukn5mdllddnp53j0mx8mjgph7uwdygn0uy45", - "satoshi": "all", - "feerate": "20000perkb", - "minconf": 0, - "utxos": [ - "218390859cf94d869e33f69161f4187a98f691afe868c20811528f589e90a61f:1" - ] + "request": { + "id": "example:withdraw#2", + "method": "withdraw", + "params": { + "destination": "bcrt1q66ukn5mdllddnp53j0mx8mjgph7uwdygn0uy45", + "satoshi": "all", + "feerate": "20000perkb", + "minconf": 0, + "utxos": [ + "218390859cf94d869e33f69161f4187a98f691afe868c20811528f589e90a61f:1" + ] + } + }, + "response": { + "tx": "02000000011fa6909e588f521108c268e8af91f6987a18f46191f6339e864df99c859083210100000000fdffffff0158070f0000000000160014d6b969d36dffdad9869193f663ee480dfdc7348867000000", + "txid": "ad9a712a201214c68c39ca5be68c9d153d1cac91e540d88aa3207b241e23acf8", + "psbt": "cHNidP8BAgQCAAAAAQMEZwAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQD9ZQECAAAAAAEBVa+m1d1amChv4Dwq1rVoS4KSm0BUUnVa3fUYcB3dH9oAAAAAAP////8CECcAAAAAAAAiUSBXeaBg8gDUDo+HGkDrkWFMxb+m0KX4UuBTQAp/7/hhUOEPDwAAAAAAIlEg7tdFgE2peEzCA/Vj76mf+lT98BsTe8lk5jwxJAcP++YEAEcwRAIgPsWO/4IxeW6OclDdXVnwL99X7B18sRlxgFqyvUAzN7gCIGOQOq0wZ6bV+wdYQP+9sH8IkfmqWZbQRRDkZEgfcprMAUcwRAIgb5/dI4+uVhluQjSA2q/3oAGxZd4vYzQWexfmcRQML7ECIFfgRwCaHYdyu5/H5moOPlfQlLc2gPgB6bgtfNSfRA6jAUdSIQIyQmbehAOzqxV6CfH3hNWHr2GDHJmMFRvMIbt0wrIxSyEC4704AJhmydqOxKqZzE6pxsDdRt8Vxh7wzh8nEpFxTldSrgAAAAABASvhDw8AAAAAACJRIO7XRYBNqXhMwgP1Y++pn/pU/fAbE3vJZOY8MSQHD/vmAQ4gH6aQnliPUhEIwmjor5H2mHoY9GGR9jOehk35nIWQgyEBDwQBAAAAARAE/f///wETQL0MqyYsx9Z9q14BhByMgWLW4oJHOqED5qcZ3wyJ4eDuLYfNGq6Ck30dAqFzJL4VhZLSuv87zN/1AEDNMl2DmTohFl03KAgp8YbLmVzcy/I4q0VkATk5c1E5YySjZXXfNN3/CQAHHEnKAAAAAAAiAgK5wMaEThKlMclo5VxVB47BbZv3a+kpD9h9HMpytIOaFwjWuWnTBAAAAAEDCFgHDwAAAAAAAQQWABTWuWnTbf/a2YaRk/Zj7kgN/cc0iAz8CWxpZ2h0bmluZwQCAAEA" } } ], - "example_json_response": [ - { - "tx": "0200000001ef28647baa13cc4c03b8a58c8bd08b69de434c22ff591eb68171ae992e3d816d0000000000fdffffff02237a080000000000160014963d257e99856fd746982c85b3b53bf6a33451b24d6808000000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a66000000", - "txid": "ccb97d7dc695cabb78b217c0b27d7d00d2941966199480e6443e0680d24d69eb", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABAWPCRda9hy4QKqUEmtb7gK7SAqzh1xBP8nZ7PCj+7+JDAAAAAAD9////Akf0EAAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUs/fQpAQAAABYAFOIj6yaI/g85utJBtkPPdK1X59cfAkcwRAIgH7J57HuUTpnCbDrDqE8W7ryuCXk+i/TszQ/NF55lWncCIDeN4y+EzIDP3l2XO5/wjk98krYqnzvEhrStk+0+fTowASEC6Ng5r5KTNIXBRRvjivsd8SKnHF59r/ViDj2+CLJVb75lAAAAAQEfR/QQAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZSICA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPRzBEAiBY0urYSHLnnXaAJH7yaGfvGmm+VuNCNIBhQaJU6iDNEgIgA7EASW+V00Su+lRQAE3Qbe4wavLq7l6Jn2vR+6Snyd0BIgYD10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8IAfrZCgAAAAABDiDvKGR7qhPMTAO4pYyL0Itp3kNMIv9ZHraBca6ZLj2BbQEPBAAAAAABEAT9////AAEDCCN6CAAAAAAAAQQWABSWPSV+mYVv10aYLIWztTv2ozRRsgz8CWxpZ2h0bmluZwQCAAEAAQMITWgIAAAAAAABBCJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aIQeRRTKBKkQKTXZscc05GTaUo0CuEeAS5boa2e+6bnbKUwkAwsyrFwIAAAAA" - }, - { - "tx": "02000000011fa6909e588f521108c268e8af91f6987a18f46191f6339e864df99c859083210100000000fdffffff0158070f0000000000160014d6b969d36dffdad9869193f663ee480dfdc7348867000000", - "txid": "ad9a712a201214c68c39ca5be68c9d153d1cac91e540d88aa3207b241e23acf8", - "psbt": "cHNidP8BAgQCAAAAAQMEZwAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQD9ZQECAAAAAAEBVa+m1d1amChv4Dwq1rVoS4KSm0BUUnVa3fUYcB3dH9oAAAAAAP////8CECcAAAAAAAAiUSBXeaBg8gDUDo+HGkDrkWFMxb+m0KX4UuBTQAp/7/hhUOEPDwAAAAAAIlEg7tdFgE2peEzCA/Vj76mf+lT98BsTe8lk5jwxJAcP++YEAEcwRAIgPsWO/4IxeW6OclDdXVnwL99X7B18sRlxgFqyvUAzN7gCIGOQOq0wZ6bV+wdYQP+9sH8IkfmqWZbQRRDkZEgfcprMAUcwRAIgb5/dI4+uVhluQjSA2q/3oAGxZd4vYzQWexfmcRQML7ECIFfgRwCaHYdyu5/H5moOPlfQlLc2gPgB6bgtfNSfRA6jAUdSIQIyQmbehAOzqxV6CfH3hNWHr2GDHJmMFRvMIbt0wrIxSyEC4704AJhmydqOxKqZzE6pxsDdRt8Vxh7wzh8nEpFxTldSrgAAAAABASvhDw8AAAAAACJRIO7XRYBNqXhMwgP1Y++pn/pU/fAbE3vJZOY8MSQHD/vmAQ4gH6aQnliPUhEIwmjor5H2mHoY9GGR9jOehk35nIWQgyEBDwQBAAAAARAE/f///wETQL0MqyYsx9Z9q14BhByMgWLW4oJHOqED5qcZ3wyJ4eDuLYfNGq6Ck30dAqFzJL4VhZLSuv87zN/1AEDNMl2DmTohFl03KAgp8YbLmVzcy/I4q0VkATk5c1E5YySjZXXfNN3/CQAHHEnKAAAAAAAiAgK5wMaEThKlMclo5VxVB47BbZv3a+kpD9h9HMpytIOaFwjWuWnTBAAAAAEDCFgHDwAAAAAAAQQWABTWuWnTbf/a2YaRk/Zj7kgN/cc0iAz8CWxpZ2h0bmluZwQCAAEA" - } - ], "author": [ "Felix <> is mainly responsible." ], diff --git a/doc/rpc-schema-draft.json b/doc/rpc-schema-draft.json index 5365d1beed09..fefa82ba2170 100644 --- a/doc/rpc-schema-draft.json +++ b/doc/rpc-schema-draft.json @@ -389,16 +389,50 @@ "type": "string" } }, - "example_json_request": { + "json_example": { "type": "array", "items": { - "id": { - "type": "integer" - }, - "method": { - "type": "string" + "type": "object", + "additionalProperties": false, + "properties": { + "description": { + "type": "array", + "items": { + "type": "string" + } + }, + "request": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "method": { + "type": "string" + }, + "params": {} + }, + "required": [ + "id", + "method", + "params" + ] + }, + "response": { + "type": "object", + "properties": { + "patternProperties": { + "^[a-zA-Z_][a-zA-Z0-9_]*$": { + "$ref": "#/definitions/schemaArray" + } + } + } + } }, - "params": {} + "required": [ + "request", + "response" + ] } }, "notes": { @@ -464,10 +498,6 @@ "type": "string" } }, - "example_json_response": { - "type": "array", - "items": {} - }, "example_json_notifications": { "type": "array", "items": { @@ -517,4 +547,4 @@ "request", "response" ] -} +} \ No newline at end of file diff --git a/doc/schemas/lightning-addgossip.json b/doc/schemas/lightning-addgossip.json index 49fa79684482..7609ecf26ed6 100644 --- a/doc/schemas/lightning-addgossip.json +++ b/doc/schemas/lightning-addgossip.json @@ -27,26 +27,28 @@ "response": { "properties": {} }, - "example_json_request": [ + "json_example": [ { - "id": "example:addgossip#1", - "method": "addgossip", - "params": { - "message": "010078c3314666731e339c0b8434f7824797a084ed7ca3655991a672da068e2c44cb53b57b53a296c133bc879109a8931dc31e6913a4bda3d58559b99b95663e6d52775579447ef5526300e1bb89bc6af8557aa1c3810a91814eafad6d103f43182e17b16644cb38c1d58a8edd094303959a9f1f9d42ff6c32a21f9c118531f512c8679cabaccc6e39dbd95a4dac90e75a258893c3aa3f733d1b8890174d5ddea8003cadffe557773c54d2c07ca1d535c4bf85885f879ae466c16a516e8ffcfec1740e3f5c98ca9ce13f452e867befef5517f306ed6aa5119b79059bcc6f68f329986b665d16de7bc7df64e3537504c91eeabe0e59d3a2b68e4216ead2b0f6e3ef7c000006226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f0000670000010000022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d590266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c0351802e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5702324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b" - } + "request": { + "id": "example:addgossip#1", + "method": "addgossip", + "params": { + "message": "010078c3314666731e339c0b8434f7824797a084ed7ca3655991a672da068e2c44cb53b57b53a296c133bc879109a8931dc31e6913a4bda3d58559b99b95663e6d52775579447ef5526300e1bb89bc6af8557aa1c3810a91814eafad6d103f43182e17b16644cb38c1d58a8edd094303959a9f1f9d42ff6c32a21f9c118531f512c8679cabaccc6e39dbd95a4dac90e75a258893c3aa3f733d1b8890174d5ddea8003cadffe557773c54d2c07ca1d535c4bf85885f879ae466c16a516e8ffcfec1740e3f5c98ca9ce13f452e867befef5517f306ed6aa5119b79059bcc6f68f329986b665d16de7bc7df64e3537504c91eeabe0e59d3a2b68e4216ead2b0f6e3ef7c000006226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f0000670000010000022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d590266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c0351802e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5702324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b" + } + }, + "response": {} }, { - "id": "example:addgossip#2", - "method": "addgossip", - "params": { - "message": "0102420526c8eb62ec6999bbee5f1de4841cab734374ec642b7deeb0259e76220bf82e97a241c907d5ff52019655f7f9a614c285bb35690f3a1a2b928d7b2349a79e06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f000067000001000065b32a0e010100060000000000000000000000010000000a000000003b023380" - } + "request": { + "id": "example:addgossip#2", + "method": "addgossip", + "params": { + "message": "0102420526c8eb62ec6999bbee5f1de4841cab734374ec642b7deeb0259e76220bf82e97a241c907d5ff52019655f7f9a614c285bb35690f3a1a2b928d7b2349a79e06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f000067000001000065b32a0e010100060000000000000000000000010000000a000000003b023380" + } + }, + "response": {} } ], - "example_json_response": [ - {}, - {} - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-addpsbtoutput.json b/doc/schemas/lightning-addpsbtoutput.json index 2d40e4f1130c..84da0a382db9 100644 --- a/doc/schemas/lightning-addpsbtoutput.json +++ b/doc/schemas/lightning-addpsbtoutput.json @@ -75,55 +75,59 @@ "lightning-cli addpsbtoutput 100000sat", "```" ], - "example_json_request": [ + "json_example": [ { - "id": "example:addpsbtoutput#1", - "method": "addpsbtoutput", - "params": { - "satoshi": 100000, - "initialpsbt": null, - "locktime": null, - "destination": null + "request": { + "id": "example:addpsbtoutput#1", + "method": "addpsbtoutput", + "params": { + "satoshi": 100000, + "initialpsbt": null, + "locktime": null, + "destination": null + } + }, + "response": { + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIoIYBAAAAAAABBCJRIHg2NV/cioLcTLAKdyxVVBUdBjhKTdZejT9orAhWa4S+AA==", + "estimated_added_weight": 172, + "outnum": 0 } }, { - "id": "example:addpsbtoutput#2", - "method": "addpsbtoutput", - "params": { - "satoshi": 1000000, - "initialpsbt": null, - "locktime": 111, - "destination": null + "request": { + "id": "example:addpsbtoutput#2", + "method": "addpsbtoutput", + "params": { + "satoshi": 1000000, + "initialpsbt": null, + "locktime": 111, + "destination": null + } + }, + "response": { + "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIQEIPAAAAAAABBCJRIJd6ICNAQALFOMhoUHuSVSuzcaUdkDKlk4K+A+DR9+4uAA==", + "estimated_added_weight": 172, + "outnum": 0 } }, { - "id": "example:addpsbtoutput#3", - "method": "addpsbtoutput", - "params": { - "satoshi": 974343, - "initialpsbt": "cHNidP8BAF4CAAAAAfwbEpvpi6D14YV4VLnuVB47Y0uF41kXEyJRL4IusySSAQAAAAD9////ASICAAAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5nAAAAAAEA9gIAAAAAAQFEkxvLatohY6mw5gr5qG1aiArSrziFPR2YoqD21Hv+RAAAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNrz8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIEu1nfVRt9i+rFM219mwhMqdwJsqygWSWTFUS+cemdh6AiBG3Qo8g9J/aAMO2RHDsIBScscj6pTTIwZp7Gw8G3EOKAEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPZgAAAAEBK68/DwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", - "locktime": null, - "destination": "bcrt1q9tc6q49l6wrrtp8ul45rj92hsleehwwxty32zu" + "request": { + "id": "example:addpsbtoutput#3", + "method": "addpsbtoutput", + "params": { + "satoshi": 974343, + "initialpsbt": "cHNidP8BAF4CAAAAAfwbEpvpi6D14YV4VLnuVB47Y0uF41kXEyJRL4IusySSAQAAAAD9////ASICAAAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5nAAAAAAEA9gIAAAAAAQFEkxvLatohY6mw5gr5qG1aiArSrziFPR2YoqD21Hv+RAAAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNrz8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIEu1nfVRt9i+rFM219mwhMqdwJsqygWSWTFUS+cemdh6AiBG3Qo8g9J/aAMO2RHDsIBScscj6pTTIwZp7Gw8G3EOKAEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPZgAAAAEBK68/DwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", + "locktime": null, + "destination": "bcrt1q9tc6q49l6wrrtp8ul45rj92hsleehwwxty32zu" + } + }, + "response": { + "psbt": "cHNidP8BAH0CAAAAAfwbEpvpi6D14YV4VLnuVB47Y0uF41kXEyJRL4IusySSAQAAAAD9////AiICAAAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4H3g4AAAAAABYAFCrxoFS/04Y1hPz9aDkVV4fzm7nGZwAAAAABAPYCAAAAAAEBRJMby2raIWOpsOYK+ahtWogK0q84hT0dmKKg9tR7/kQAAAAAAP3///8CQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAza8/DwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oCRzBEAiBLtZ31UbfYvqxTNtfZsITKncCbKsoFklkxVEvnHpnYegIgRt0KPIPSf2gDDtkRw7CAUnLHI+qU0yMGaexsPBtxDigBIQPXRURck2JmXyLg2W6edm8nPzJg3qOcina/oF3SaE3cz2YAAAABASuvPw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAAAA", + "estimated_added_weight": 172, + "outnum": 1 } } ], - "example_json_response": [ - { - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIoIYBAAAAAAABBCJRIHg2NV/cioLcTLAKdyxVVBUdBjhKTdZejT9orAhWa4S+AA==", - "estimated_added_weight": 172, - "outnum": 0 - }, - { - "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIQEIPAAAAAAABBCJRIJd6ICNAQALFOMhoUHuSVSuzcaUdkDKlk4K+A+DR9+4uAA==", - "estimated_added_weight": 172, - "outnum": 0 - }, - { - "psbt": "cHNidP8BAH0CAAAAAfwbEpvpi6D14YV4VLnuVB47Y0uF41kXEyJRL4IusySSAQAAAAD9////AiICAAAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4H3g4AAAAAABYAFCrxoFS/04Y1hPz9aDkVV4fzm7nGZwAAAAABAPYCAAAAAAEBRJMby2raIWOpsOYK+ahtWogK0q84hT0dmKKg9tR7/kQAAAAAAP3///8CQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAza8/DwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oCRzBEAiBLtZ31UbfYvqxTNtfZsITKncCbKsoFklkxVEvnHpnYegIgRt0KPIPSf2gDDtkRw7CAUnLHI+qU0yMGaexsPBtxDigBIQPXRURck2JmXyLg2W6edm8nPzJg3qOcina/oF3SaE3cz2YAAAABASuvPw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAAAA", - "estimated_added_weight": 172, - "outnum": 1 - } - ], "author": [ "Dusty <<@dusty_daemon>> is mainly responsible." ], diff --git a/doc/schemas/lightning-autoclean-once.json b/doc/schemas/lightning-autoclean-once.json index d6b656ec35d1..8ccf56227f70 100644 --- a/doc/schemas/lightning-autoclean-once.json +++ b/doc/schemas/lightning-autoclean-once.json @@ -186,38 +186,40 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:autoclean-once#1", - "method": "autoclean-once", - "params": [ - "failedpays", - 1 - ] - }, - { - "id": "example:autoclean-once#2", - "method": "autoclean-once", - "params": [ - "succeededpays", - 1 - ] - } - ], - "example_json_response": [ - { - "autoclean": { - "failedpays": { - "cleaned": 1, - "uncleaned": 1 + "request": { + "id": "example:autoclean-once#1", + "method": "autoclean-once", + "params": [ + "failedpays", + 1 + ] + }, + "response": { + "autoclean": { + "failedpays": { + "cleaned": 1, + "uncleaned": 1 + } } } }, { - "autoclean": { - "succeededpays": { - "cleaned": 1, - "uncleaned": 0 + "request": { + "id": "example:autoclean-once#2", + "method": "autoclean-once", + "params": [ + "succeededpays", + 1 + ] + }, + "response": { + "autoclean": { + "succeededpays": { + "cleaned": 1, + "uncleaned": 0 + } } } } diff --git a/doc/schemas/lightning-autoclean-status.json b/doc/schemas/lightning-autoclean-status.json index 2841fc54a113..04c711ff49ca 100644 --- a/doc/schemas/lightning-autoclean-status.json +++ b/doc/schemas/lightning-autoclean-status.json @@ -414,57 +414,59 @@ "Note that the ages parameters are set by various `autoclean-...-age` parameters in your configuration: see lightningd-config(5)." ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:autoclean-status#1", - "method": "autoclean-status", - "params": { - "subsystem": "expiredinvoices" - } - }, - { - "id": "example:autoclean-status#2", - "method": "autoclean-status", - "params": { - "subsystem": null - } - } - ], - "example_json_response": [ - { - "autoclean": { - "expiredinvoices": { - "enabled": false, - "cleaned": 0 + "request": { + "id": "example:autoclean-status#1", + "method": "autoclean-status", + "params": { + "subsystem": "expiredinvoices" + } + }, + "response": { + "autoclean": { + "expiredinvoices": { + "enabled": false, + "cleaned": 0 + } } } }, { - "autoclean": { - "succeededforwards": { - "enabled": false, - "cleaned": 0 - }, - "failedforwards": { - "enabled": false, - "cleaned": 0 - }, - "succeededpays": { - "enabled": false, - "cleaned": 0 - }, - "failedpays": { - "enabled": false, - "cleaned": 0 - }, - "paidinvoices": { - "enabled": false, - "cleaned": 0 - }, - "expiredinvoices": { - "enabled": true, - "age": 2, - "cleaned": 0 + "request": { + "id": "example:autoclean-status#2", + "method": "autoclean-status", + "params": { + "subsystem": null + } + }, + "response": { + "autoclean": { + "succeededforwards": { + "enabled": false, + "cleaned": 0 + }, + "failedforwards": { + "enabled": false, + "cleaned": 0 + }, + "succeededpays": { + "enabled": false, + "cleaned": 0 + }, + "failedpays": { + "enabled": false, + "cleaned": 0 + }, + "paidinvoices": { + "enabled": false, + "cleaned": 0 + }, + "expiredinvoices": { + "enabled": true, + "age": 2, + "cleaned": 0 + } } } } diff --git a/doc/schemas/lightning-autocleaninvoice.json b/doc/schemas/lightning-autocleaninvoice.json index 3b6a86acadf5..92db833699b7 100644 --- a/doc/schemas/lightning-autocleaninvoice.json +++ b/doc/schemas/lightning-autocleaninvoice.json @@ -77,36 +77,38 @@ } ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:autocleaninvoice#1", - "method": "autocleaninvoice", - "params": { + "request": { + "id": "example:autocleaninvoice#1", + "method": "autocleaninvoice", + "params": { + "cycle_seconds": 8, + "expired_by": 2 + } + }, + "response": { + "enabled": true, "cycle_seconds": 8, "expired_by": 2 } }, { - "id": "example:autocleaninvoice#2", - "method": "autocleaninvoice", - "params": { + "request": { + "id": "example:autocleaninvoice#2", + "method": "autocleaninvoice", + "params": { + "cycle_seconds": 1, + "expired_by": 1 + } + }, + "response": { + "enabled": true, "cycle_seconds": 1, "expired_by": 1 } } ], - "example_json_response": [ - { - "enabled": true, - "cycle_seconds": 8, - "expired_by": 2 - }, - { - "enabled": true, - "cycle_seconds": 1, - "expired_by": 1 - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-batching.json b/doc/schemas/lightning-batching.json index fc0b1804bdd8..2c36a5da2b58 100644 --- a/doc/schemas/lightning-batching.json +++ b/doc/schemas/lightning-batching.json @@ -24,18 +24,18 @@ "response": { "properties": {} }, - "example_json_request": [ + "json_example": [ { - "id": "example:batching#1", - "method": "batching", - "params": { - "enable": true - } + "request": { + "id": "example:batching#1", + "method": "batching", + "params": { + "enable": true + } + }, + "response": {} } ], - "example_json_response": [ - {} - ], "errors": [ "On failure, one of the following error codes may be returned:", "", diff --git a/doc/schemas/lightning-bkpr-channelsapy.json b/doc/schemas/lightning-bkpr-channelsapy.json index 72208f781005..9d56ffbda7b4 100644 --- a/doc/schemas/lightning-bkpr-channelsapy.json +++ b/doc/schemas/lightning-bkpr-channelsapy.json @@ -191,59 +191,59 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:bkpr-channelsapy#1", - "method": "bkpr-channelsapy", - "params": "{}" - } - ], - "example_json_response": [ - { - "channels_apy": [ - { - "account": "e41b2ec83e9139a9fd8f1d89b01e5d7df73099494e6b91504c39445e37485b0d", - "routed_out_msat": 1431440, - "routed_in_msat": 0, - "lease_fee_paid_msat": 0, - "lease_fee_earned_msat": 0, - "pushed_out_msat": 0, - "pushed_in_msat": 0, - "our_start_balance_msat": 1000000000, - "channel_start_balance_msat": 1000000000, - "fees_out_msat": 0, - "fees_in_msat": 0, - "utilization_out": "0.1431%", - "utilization_out_initial": "0.1431%", - "utilization_in": "0.0000%", - "apy_out": "0.0000%", - "apy_out_initial": "0.0000%", - "apy_in": "0.0000%", - "apy_total": "0.0000%", - "apy_total_initial": "0.0000%" - }, - { - "account": "net", - "routed_out_msat": 1431440, - "routed_in_msat": 0, - "lease_fee_paid_msat": 0, - "lease_fee_earned_msat": 0, - "pushed_out_msat": 0, - "pushed_in_msat": 0, - "our_start_balance_msat": 1000000000, - "channel_start_balance_msat": 1000000000, - "fees_out_msat": 0, - "fees_in_msat": 0, - "utilization_out": "0.1431%", - "utilization_out_initial": "0.1431%", - "utilization_in": "0.0000%", - "apy_out": "0.0000%", - "apy_out_initial": "0.0000%", - "apy_in": "0.0000%", - "apy_total": "0.0000%", - "apy_total_initial": "0.0000%" - } - ] + "request": { + "id": "example:bkpr-channelsapy#1", + "method": "bkpr-channelsapy", + "params": "{}" + }, + "response": { + "channels_apy": [ + { + "account": "e41b2ec83e9139a9fd8f1d89b01e5d7df73099494e6b91504c39445e37485b0d", + "routed_out_msat": 1431440, + "routed_in_msat": 0, + "lease_fee_paid_msat": 0, + "lease_fee_earned_msat": 0, + "pushed_out_msat": 0, + "pushed_in_msat": 0, + "our_start_balance_msat": 1000000000, + "channel_start_balance_msat": 1000000000, + "fees_out_msat": 0, + "fees_in_msat": 0, + "utilization_out": "0.1431%", + "utilization_out_initial": "0.1431%", + "utilization_in": "0.0000%", + "apy_out": "0.0000%", + "apy_out_initial": "0.0000%", + "apy_in": "0.0000%", + "apy_total": "0.0000%", + "apy_total_initial": "0.0000%" + }, + { + "account": "net", + "routed_out_msat": 1431440, + "routed_in_msat": 0, + "lease_fee_paid_msat": 0, + "lease_fee_earned_msat": 0, + "pushed_out_msat": 0, + "pushed_in_msat": 0, + "our_start_balance_msat": 1000000000, + "channel_start_balance_msat": 1000000000, + "fees_out_msat": 0, + "fees_in_msat": 0, + "utilization_out": "0.1431%", + "utilization_out_initial": "0.1431%", + "utilization_in": "0.0000%", + "apy_out": "0.0000%", + "apy_out_initial": "0.0000%", + "apy_in": "0.0000%", + "apy_total": "0.0000%", + "apy_total_initial": "0.0000%" + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-bkpr-dumpincomecsv.json b/doc/schemas/lightning-bkpr-dumpincomecsv.json index a5064aaf5f83..2d18bbf7b311 100644 --- a/doc/schemas/lightning-bkpr-dumpincomecsv.json +++ b/doc/schemas/lightning-bkpr-dumpincomecsv.json @@ -73,20 +73,20 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:bkpr-dumpincomecsv#1", - "method": "bkpr-dumpincomecsv", - "params": [ - "koinly", - "koinly.csv" - ] - } - ], - "example_json_response": [ - { - "csv_file": "koinly.csv", - "csv_format": "koinly" + "request": { + "id": "example:bkpr-dumpincomecsv#1", + "method": "bkpr-dumpincomecsv", + "params": [ + "koinly", + "koinly.csv" + ] + }, + "response": { + "csv_file": "koinly.csv", + "csv_format": "koinly" + } } ], "author": [ diff --git a/doc/schemas/lightning-bkpr-inspect.json b/doc/schemas/lightning-bkpr-inspect.json index ffd615a4b6de..877eae0ad1fd 100644 --- a/doc/schemas/lightning-bkpr-inspect.json +++ b/doc/schemas/lightning-bkpr-inspect.json @@ -195,33 +195,33 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:bkpr-inspect#1", - "method": "bkpr-inspect", - "params": [ - "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab" - ] - } - ], - "example_json_response": [ - { - "txs": [ - { - "txid": "abb283035e569c190696d42a1208bb38ddc64b6377e88f2d6277c01eab7b0af3", - "fees_paid_msat": 0, - "outputs": [ - { - "account": "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab", - "outnum": 0, - "output_tag": "channel_proposed", - "output_value_msat": 996363000, - "credit_msat": 996363000, - "currency": "bcrt" - } - ] - } - ] + "request": { + "id": "example:bkpr-inspect#1", + "method": "bkpr-inspect", + "params": [ + "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab" + ] + }, + "response": { + "txs": [ + { + "txid": "abb283035e569c190696d42a1208bb38ddc64b6377e88f2d6277c01eab7b0af3", + "fees_paid_msat": 0, + "outputs": [ + { + "account": "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab", + "outnum": 0, + "output_tag": "channel_proposed", + "output_value_msat": 996363000, + "credit_msat": 996363000, + "currency": "bcrt" + } + ] + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-bkpr-listaccountevents.json b/doc/schemas/lightning-bkpr-listaccountevents.json index 7a55c7f89c6e..fc73dcfe887e 100644 --- a/doc/schemas/lightning-bkpr-listaccountevents.json +++ b/doc/schemas/lightning-bkpr-listaccountevents.json @@ -243,227 +243,229 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:bkpr-listaccountevents#1", - "method": "bkpr-listaccountevents", - "params": "{}" - }, - { - "id": "example:bkpr-listaccountevents#2", - "method": "bkpr-listaccountevents", - "params": [ - "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab" - ] - } - ], - "example_json_response": [ - { - "events": [ - { - "account": "wallet", - "type": "channel", - "tag": "journal_entry", - "credit_msat": 0, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706152911, - "is_rebalance": false - }, - { - "account": "wallet", - "type": "chain", - "tag": "deposit", - "credit_msat": 2000000000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "7e202b3b1016e8eb6f4e936215ed6b5bdc63c17e6ebb5e6bce2f98e6757ba44c:0", - "timestamp": 1706152914, - "blockheight": 102 - }, - { - "account": "wallet", - "type": "chain", - "tag": "withdrawal", - "credit_msat": 0, - "debit_msat": 2000000000, - "currency": "bcrt", - "outpoint": "7e202b3b1016e8eb6f4e936215ed6b5bdc63c17e6ebb5e6bce2f98e6757ba44c:0", - "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b", - "timestamp": 1706152921, - "blockheight": 103 - }, - { - "account": "wallet", - "type": "chain", - "tag": "deposit", - "credit_msat": 995073000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b:1", - "timestamp": 1706152921, - "blockheight": 103 - }, - { - "account": "wallet", - "type": "onchain_fee", - "tag": "onchain_fee", - "credit_msat": 1004927000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706152921, - "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b" - }, - { - "account": "wallet", - "type": "onchain_fee", - "tag": "onchain_fee", - "credit_msat": 0, - "debit_msat": 1004927000, - "currency": "bcrt", - "timestamp": 1706152921, - "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b" - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "chain", - "tag": "channel_open", - "credit_msat": 1000000000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b:0", - "timestamp": 1706152922, - "blockheight": 103 - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "onchain_fee", - "tag": "onchain_fee", - "credit_msat": 4927000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706152922, - "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b" - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "channel", - "tag": "invoice", - "credit_msat": 0, - "debit_msat": 11000000, - "currency": "bcrt", - "payment_id": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "part_id": 0, - "timestamp": 1706152934, - "description": [ - "XEoCR94SIz6UIRUEkxum." - ], - "is_rebalance": false - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "chain", - "tag": "channel_close", - "credit_msat": 0, - "debit_msat": 989000000, - "currency": "bcrt", - "outpoint": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b:0", - "txid": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998", - "timestamp": 1706152938, - "blockheight": 104 - }, - { - "account": "external", - "origin": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "chain", - "tag": "to_them", - "credit_msat": 10899000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998:0", - "timestamp": 1706152938, - "blockheight": 104 - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "onchain_fee", - "tag": "onchain_fee", - "credit_msat": 7967000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706152938, - "txid": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998" - }, - { - "account": "wallet", - "type": "chain", - "tag": "deposit", - "credit_msat": 980912000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "85477738281c1afd652c350025f1d28658fe541c83adc9a7d5276c30cf715a11:0", - "timestamp": 1706152941, - "blockheight": 109 - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "chain", - "tag": "delayed_to_us", - "credit_msat": 981033000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998:1", - "timestamp": 1706152941, - "blockheight": 104 - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "chain", - "tag": "to_wallet", - "credit_msat": 0, - "debit_msat": 981033000, - "currency": "bcrt", - "outpoint": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998:1", - "txid": "85477738281c1afd652c350025f1d28658fe541c83adc9a7d5276c30cf715a11", - "timestamp": 1706152941, - "blockheight": 109 - }, - { - "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "type": "onchain_fee", - "tag": "onchain_fee", - "credit_msat": 121000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706152941, - "txid": "85477738281c1afd652c350025f1d28658fe541c83adc9a7d5276c30cf715a11" - } - ] + "request": { + "id": "example:bkpr-listaccountevents#1", + "method": "bkpr-listaccountevents", + "params": "{}" + }, + "response": { + "events": [ + { + "account": "wallet", + "type": "channel", + "tag": "journal_entry", + "credit_msat": 0, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706152911, + "is_rebalance": false + }, + { + "account": "wallet", + "type": "chain", + "tag": "deposit", + "credit_msat": 2000000000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "7e202b3b1016e8eb6f4e936215ed6b5bdc63c17e6ebb5e6bce2f98e6757ba44c:0", + "timestamp": 1706152914, + "blockheight": 102 + }, + { + "account": "wallet", + "type": "chain", + "tag": "withdrawal", + "credit_msat": 0, + "debit_msat": 2000000000, + "currency": "bcrt", + "outpoint": "7e202b3b1016e8eb6f4e936215ed6b5bdc63c17e6ebb5e6bce2f98e6757ba44c:0", + "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b", + "timestamp": 1706152921, + "blockheight": 103 + }, + { + "account": "wallet", + "type": "chain", + "tag": "deposit", + "credit_msat": 995073000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b:1", + "timestamp": 1706152921, + "blockheight": 103 + }, + { + "account": "wallet", + "type": "onchain_fee", + "tag": "onchain_fee", + "credit_msat": 1004927000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706152921, + "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b" + }, + { + "account": "wallet", + "type": "onchain_fee", + "tag": "onchain_fee", + "credit_msat": 0, + "debit_msat": 1004927000, + "currency": "bcrt", + "timestamp": 1706152921, + "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b" + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "chain", + "tag": "channel_open", + "credit_msat": 1000000000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b:0", + "timestamp": 1706152922, + "blockheight": 103 + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "onchain_fee", + "tag": "onchain_fee", + "credit_msat": 4927000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706152922, + "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b" + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "channel", + "tag": "invoice", + "credit_msat": 0, + "debit_msat": 11000000, + "currency": "bcrt", + "payment_id": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", + "part_id": 0, + "timestamp": 1706152934, + "description": [ + "XEoCR94SIz6UIRUEkxum." + ], + "is_rebalance": false + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "chain", + "tag": "channel_close", + "credit_msat": 0, + "debit_msat": 989000000, + "currency": "bcrt", + "outpoint": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b:0", + "txid": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998", + "timestamp": 1706152938, + "blockheight": 104 + }, + { + "account": "external", + "origin": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "chain", + "tag": "to_them", + "credit_msat": 10899000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998:0", + "timestamp": 1706152938, + "blockheight": 104 + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "onchain_fee", + "tag": "onchain_fee", + "credit_msat": 7967000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706152938, + "txid": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998" + }, + { + "account": "wallet", + "type": "chain", + "tag": "deposit", + "credit_msat": 980912000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "85477738281c1afd652c350025f1d28658fe541c83adc9a7d5276c30cf715a11:0", + "timestamp": 1706152941, + "blockheight": 109 + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "chain", + "tag": "delayed_to_us", + "credit_msat": 981033000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998:1", + "timestamp": 1706152941, + "blockheight": 104 + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "chain", + "tag": "to_wallet", + "credit_msat": 0, + "debit_msat": 981033000, + "currency": "bcrt", + "outpoint": "7178638c13a0573f440d9516a23901874b6138338d378b3291cb306c90b3f998:1", + "txid": "85477738281c1afd652c350025f1d28658fe541c83adc9a7d5276c30cf715a11", + "timestamp": 1706152941, + "blockheight": 109 + }, + { + "account": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "type": "onchain_fee", + "tag": "onchain_fee", + "credit_msat": 121000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706152941, + "txid": "85477738281c1afd652c350025f1d28658fe541c83adc9a7d5276c30cf715a11" + } + ] + } }, { - "events": [ - { - "account": "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab", - "type": "chain", - "tag": "channel_proposed", - "credit_msat": 996363000, - "debit_msat": 0, - "currency": "bcrt", - "outpoint": "abb283035e569c190696d42a1208bb38ddc64b6377e88f2d6277c01eab7b0af3:0", - "timestamp": 1706246949, - "blockheight": 0 - }, - { - "account": "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab", - "type": "channel", - "tag": "pushed", - "credit_msat": 0, - "debit_msat": 20000000, - "currency": "bcrt", - "timestamp": 1706246949, - "is_rebalance": false - } - ] + "request": { + "id": "example:bkpr-listaccountevents#2", + "method": "bkpr-listaccountevents", + "params": [ + "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab" + ] + }, + "response": { + "events": [ + { + "account": "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab", + "type": "chain", + "tag": "channel_proposed", + "credit_msat": 996363000, + "debit_msat": 0, + "currency": "bcrt", + "outpoint": "abb283035e569c190696d42a1208bb38ddc64b6377e88f2d6277c01eab7b0af3:0", + "timestamp": 1706246949, + "blockheight": 0 + }, + { + "account": "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab", + "type": "channel", + "tag": "pushed", + "credit_msat": 0, + "debit_msat": 20000000, + "currency": "bcrt", + "timestamp": 1706246949, + "is_rebalance": false + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-bkpr-listbalances.json b/doc/schemas/lightning-bkpr-listbalances.json index 6da79d8ce76b..a0584eb192a5 100644 --- a/doc/schemas/lightning-bkpr-listbalances.json +++ b/doc/schemas/lightning-bkpr-listbalances.json @@ -122,26 +122,26 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:bkpr-listbalances#1", - "method": "bkpr-listbalances", - "params": "{}" - } - ], - "example_json_response": [ - { - "accounts": [ - { - "account": "wallet", - "balances": [ - { - "balance_msat": 2222222000, - "coin_type": "bcrt" - } - ] - } - ] + "request": { + "id": "example:bkpr-listbalances#1", + "method": "bkpr-listbalances", + "params": "{}" + }, + "response": { + "accounts": [ + { + "account": "wallet", + "balances": [ + { + "balance_msat": 2222222000, + "coin_type": "bcrt" + } + ] + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-bkpr-listincome.json b/doc/schemas/lightning-bkpr-listincome.json index 94cd6ec133cc..e2b2d49aeba7 100644 --- a/doc/schemas/lightning-bkpr-listincome.json +++ b/doc/schemas/lightning-bkpr-listincome.json @@ -118,82 +118,84 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:bkpr-listincome#1", - "method": "bkpr-listincome", - "params": "{}" - }, - { - "id": "example:bkpr-listincome#2", - "method": "bkpr-listincome", - "params": { - "consolidate_fees": false + "request": { + "id": "example:bkpr-listincome#1", + "method": "bkpr-listincome", + "params": "{}" + }, + "response": { + "income_events": [ + { + "account": "wallet", + "tag": "deposit", + "credit_msat": 1111111000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706153060, + "outpoint": "6d813d2e99ae7181b61e59ff224c43de698bd08b8ca5b8034ccc13aa7b6428ef:0" + }, + { + "account": "wallet", + "tag": "deposit", + "credit_msat": 1111111000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1706153060, + "outpoint": "0bbbe965f76525af3876ae6f1520d91047d4be04cb4e46b7229120a60c5dc9c5:0" + } + ] } - } - ], - "example_json_response": [ - { - "income_events": [ - { - "account": "wallet", - "tag": "deposit", - "credit_msat": 1111111000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706153060, - "outpoint": "6d813d2e99ae7181b61e59ff224c43de698bd08b8ca5b8034ccc13aa7b6428ef:0" - }, - { - "account": "wallet", - "tag": "deposit", - "credit_msat": 1111111000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1706153060, - "outpoint": "0bbbe965f76525af3876ae6f1520d91047d4be04cb4e46b7229120a60c5dc9c5:0" - } - ] }, { - "income_events": [ - { - "account": "wallet", - "tag": "deposit", - "credit_msat": 1111111000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1708624181, - "outpoint": "895b5eaad4544d24c99628883b4d84b2c6024d6a2da4c1de54098d985f280943:1" - }, - { - "account": "wallet", - "tag": "withdrawal", - "credit_msat": 0, - "debit_msat": 555555000, - "currency": "bcrt", - "timestamp": 1708624182, - "outpoint": "d28a2cba55da10700ddd7f1f23618160dafb3134650055654551d9b0382dcd71:0" - }, - { - "account": "wallet", - "tag": "onchain_fee", - "credit_msat": 0, - "debit_msat": 555556000, - "currency": "bcrt", - "timestamp": 1708624183, - "txid": "d28a2cba55da10700ddd7f1f23618160dafb3134650055654551d9b0382dcd71" - }, - { - "account": "wallet", - "tag": "onchain_fee", - "credit_msat": 554947000, - "debit_msat": 0, - "currency": "bcrt", - "timestamp": 1708624183, - "txid": "d28a2cba55da10700ddd7f1f23618160dafb3134650055654551d9b0382dcd71" + "request": { + "id": "example:bkpr-listincome#2", + "method": "bkpr-listincome", + "params": { + "consolidate_fees": false } - ] + }, + "response": { + "income_events": [ + { + "account": "wallet", + "tag": "deposit", + "credit_msat": 1111111000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1708624181, + "outpoint": "895b5eaad4544d24c99628883b4d84b2c6024d6a2da4c1de54098d985f280943:1" + }, + { + "account": "wallet", + "tag": "withdrawal", + "credit_msat": 0, + "debit_msat": 555555000, + "currency": "bcrt", + "timestamp": 1708624182, + "outpoint": "d28a2cba55da10700ddd7f1f23618160dafb3134650055654551d9b0382dcd71:0" + }, + { + "account": "wallet", + "tag": "onchain_fee", + "credit_msat": 0, + "debit_msat": 555556000, + "currency": "bcrt", + "timestamp": 1708624183, + "txid": "d28a2cba55da10700ddd7f1f23618160dafb3134650055654551d9b0382dcd71" + }, + { + "account": "wallet", + "tag": "onchain_fee", + "credit_msat": 554947000, + "debit_msat": 0, + "currency": "bcrt", + "timestamp": 1708624183, + "txid": "d28a2cba55da10700ddd7f1f23618160dafb3134650055654551d9b0382dcd71" + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-blacklistrune.json b/doc/schemas/lightning-blacklistrune.json index 5b8fe5bee61a..6580eaf5e937 100644 --- a/doc/schemas/lightning-blacklistrune.json +++ b/doc/schemas/lightning-blacklistrune.json @@ -69,59 +69,63 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:blacklistrune#1", - "method": "blacklistrune", - "params": { - "start": 2 - } - }, - { - "id": "example:blacklistrune#2", - "method": "blacklistrune", - "params": { - "start": 5, - "end": 7 - } - }, - { - "id": "example:blacklistrune#3", - "method": "blacklistrune", - "params": { - "start": 3, - "end": 4 - } - } - ], - "example_json_response": [ - { - "blacklist": [ - { - "start": 2, - "end": 2 + "request": { + "id": "example:blacklistrune#1", + "method": "blacklistrune", + "params": { + "start": 2 } - ] + }, + "response": { + "blacklist": [ + { + "start": 2, + "end": 2 + } + ] + } }, { - "blacklist": [ - { - "start": 2, - "end": 2 - }, - { + "request": { + "id": "example:blacklistrune#2", + "method": "blacklistrune", + "params": { "start": 5, "end": 7 } - ] + }, + "response": { + "blacklist": [ + { + "start": 2, + "end": 2 + }, + { + "start": 5, + "end": 7 + } + ] + } }, { - "blacklist": [ - { - "start": 2, - "end": 7 + "request": { + "id": "example:blacklistrune#3", + "method": "blacklistrune", + "params": { + "start": 3, + "end": 4 } - ] + }, + "response": { + "blacklist": [ + { + "start": 2, + "end": 7 + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-check.json b/doc/schemas/lightning-check.json index e8458d91b352..82989b1a1b8e 100644 --- a/doc/schemas/lightning-check.json +++ b/doc/schemas/lightning-check.json @@ -37,60 +37,64 @@ "command_to_check" ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:check#1", - "method": "check", - "params": { - "command_to_check": "sendpay", - "route": [ - { - "amount_msat": 1011, - "msatoshi": 1011, - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "delay": 20, - "channel": "1x1x1" - }, - { - "amount_msat": 1000, - "msatoshi": 1000, - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "delay": 10, - "channel": "2x2x2" - } - ], - "payment_hash": "0000000000000000000000000000000000000000000000000000000000000000" + "request": { + "id": "example:check#1", + "method": "check", + "params": { + "command_to_check": "sendpay", + "route": [ + { + "amount_msat": 1011, + "msatoshi": 1011, + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "delay": 20, + "channel": "1x1x1" + }, + { + "amount_msat": 1000, + "msatoshi": 1000, + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "delay": 10, + "channel": "2x2x2" + } + ], + "payment_hash": "0000000000000000000000000000000000000000000000000000000000000000" + } + }, + "response": { + "command_to_check": "sendpay" } }, { - "id": "example:check#2", - "method": "check", - "params": { - "command_to_check": "dev", - "subcommand": "slowcmd", - "msec": 1000 + "request": { + "id": "example:check#2", + "method": "check", + "params": { + "command_to_check": "dev", + "subcommand": "slowcmd", + "msec": 1000 + } + }, + "response": { + "command_to_check": "dev" } }, { - "id": "example:check#3", - "method": "check", - "params": { - "command_to_check": "recover", - "hsmsecret": "6c696768746e696e672d31000000000000000000000000000000000000000000" + "request": { + "id": "example:check#3", + "method": "check", + "params": { + "command_to_check": "recover", + "hsmsecret": "6c696768746e696e672d31000000000000000000000000000000000000000000" + } + }, + "response": { + "command_to_check": "recover" } } ], - "example_json_response": [ - { - "command_to_check": "sendpay" - }, - { - "command_to_check": "dev" - }, - { - "command_to_check": "recover" - } - ], "author": [ "Mark Beckwith <> and Rusty Russell <> are mainly responsible." ], diff --git a/doc/schemas/lightning-checkmessage.json b/doc/schemas/lightning-checkmessage.json index 275c22acd4e7..e7757f1ff672 100644 --- a/doc/schemas/lightning-checkmessage.json +++ b/doc/schemas/lightning-checkmessage.json @@ -58,36 +58,38 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:checkmessage#1", - "method": "checkmessage", - "params": { - "message": "testcase to check new rpc error", - "zbase": "d66bqz3qsku5fxtqsi37j11pci47ydxa95iusphutggz9ezaxt56neh77kxe5hyr41kwgkncgiu94p9ecxiexgpgsz8daoq4tw8kj8yx", - "pubkey": "03be3b0e9992153b1d5a6e1623670b6c3663f72ce6cf2e0dd39c0a373a7de5a3b7" + "request": { + "id": "example:checkmessage#1", + "method": "checkmessage", + "params": { + "message": "testcase to check new rpc error", + "zbase": "d66bqz3qsku5fxtqsi37j11pci47ydxa95iusphutggz9ezaxt56neh77kxe5hyr41kwgkncgiu94p9ecxiexgpgsz8daoq4tw8kj8yx", + "pubkey": "03be3b0e9992153b1d5a6e1623670b6c3663f72ce6cf2e0dd39c0a373a7de5a3b7" + } + }, + "response": { + "pubkey": "03be3b0e9992153b1d5a6e1623670b6c3663f72ce6cf2e0dd39c0a373a7de5a3b7", + "verified": true } }, { - "id": "example:checkmessage#2", - "method": "checkmessage", - "params": { - "message": "this is a test!", - "zbase": "d6tqaeuonjhi98mmont9m4wag7gg4krg1f4txonug3h31e9h6p6k6nbwjondnj46dkyausobstnk7fhyy998bhgc1yr98dfmhb4k54d7", - "pubkey": null + "request": { + "id": "example:checkmessage#2", + "method": "checkmessage", + "params": { + "message": "this is a test!", + "zbase": "d6tqaeuonjhi98mmont9m4wag7gg4krg1f4txonug3h31e9h6p6k6nbwjondnj46dkyausobstnk7fhyy998bhgc1yr98dfmhb4k54d7", + "pubkey": null + } + }, + "response": { + "pubkey": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "verified": true } } ], - "example_json_response": [ - { - "pubkey": "03be3b0e9992153b1d5a6e1623670b6c3663f72ce6cf2e0dd39c0a373a7de5a3b7", - "verified": true - }, - { - "pubkey": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "verified": true - } - ], "errors": [ "On failure, an error is returned and core lightning exit with the following error code:", "", diff --git a/doc/schemas/lightning-checkrune.json b/doc/schemas/lightning-checkrune.json index b9dd44d91d95..eb5919be6c99 100644 --- a/doc/schemas/lightning-checkrune.json +++ b/doc/schemas/lightning-checkrune.json @@ -73,59 +73,63 @@ "- 1502 (RUNE_NOT_PERMITTED): rune does not allow this usage (includes a detailed reason why)", "- 1503 (RUNE_BLACKLISTED): rune has been explicitly blacklisted." ], - "example_json_request": [ + "json_example": [ { - "id": "example:checkrune#1", - "method": "checkrune", - "params": { - "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "rune": "617Obfct0oRBj_uqGFQxDk3XZ1sDFiC2Q5ltm5z1i_k9NSZtZXRob2Q9aW52b2ljZSZwbmFtZWRlc2NyaXB0aW9uPUB0aXBqYXJcfGpiNTVAc2VuZHNhdHMubG9s", - "method": "invoice", + "request": { + "id": "example:checkrune#1", + "method": "checkrune", "params": { - "amount_msat": "any", - "label": "lbl", - "description": [ - "@tipjar|jb55@sendsats.lol." - ] + "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "rune": "617Obfct0oRBj_uqGFQxDk3XZ1sDFiC2Q5ltm5z1i_k9NSZtZXRob2Q9aW52b2ljZSZwbmFtZWRlc2NyaXB0aW9uPUB0aXBqYXJcfGpiNTVAc2VuZHNhdHMubG9s", + "method": "invoice", + "params": { + "amount_msat": "any", + "label": "lbl", + "description": [ + "@tipjar|jb55@sendsats.lol." + ] + } } + }, + "response": { + "valid": true } }, { - "id": "example:checkrune#2", - "method": "checkrune", - "params": { - "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", - "method": "listpeers", - "params": {} + "request": { + "id": "example:checkrune#2", + "method": "checkrune", + "params": { + "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", + "method": "listpeers", + "params": {} + } + }, + "response": { + "valid": true } }, { - "id": "example:checkrune#3", - "method": "checkrune", - "params": { - "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "rune": "617Obfct0oRBj_uqGFQxDk3XZ1sDFiC2Q5ltm5z1i_k9NSZtZXRob2Q9aW52b2ljZSZwbmFtZWRlc2NyaXB0aW9uPUB0aXBqYXJcfGpiNTVAc2VuZHNhdHMubG9s", - "method": "invoice", + "request": { + "id": "example:checkrune#3", + "method": "checkrune", "params": { - "amount_msat": "any", - "label": "lbl", - "description": "@tipjar|jb55@sendsats.lol" + "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "rune": "617Obfct0oRBj_uqGFQxDk3XZ1sDFiC2Q5ltm5z1i_k9NSZtZXRob2Q9aW52b2ljZSZwbmFtZWRlc2NyaXB0aW9uPUB0aXBqYXJcfGpiNTVAc2VuZHNhdHMubG9s", + "method": "invoice", + "params": { + "amount_msat": "any", + "label": "lbl", + "description": "@tipjar|jb55@sendsats.lol" + } } + }, + "response": { + "valid": true } } ], - "example_json_response": [ - { - "valid": true - }, - { - "valid": true - }, - { - "valid": true - } - ], "author": [ "Shahana Farooqui <> is mainly responsible for consolidating logic from commando." ], diff --git a/doc/schemas/lightning-close.json b/doc/schemas/lightning-close.json index 37ec85f60100..cc4a4882487d 100644 --- a/doc/schemas/lightning-close.json +++ b/doc/schemas/lightning-close.json @@ -143,56 +143,60 @@ "notifications": [ "Notifications may be returned indicating what is going on, especially if the peer is offline and we are waiting." ], - "example_json_request": [ + "json_example": [ { - "id": "example:close#1", - "method": "close", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "unilateraltimeout": 1, - "destination": null, - "fee_negotiation_step": null, - "force_lease_closed": null, - "feerange": null + "request": { + "id": "example:close#1", + "method": "close", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "unilateraltimeout": 1, + "destination": null, + "fee_negotiation_step": null, + "force_lease_closed": null, + "feerange": null + } + }, + "response": { + "tx": "020000000001018d388ffcd216c92d25163a62096ce47d5c9bbd6270ced51c5a1484f89df33e5700000000009db0e28002a00f00000000000016001445503fa4b65ade3ffdb1a92057688456c9ffae1380130f0000000000220020be82765fdb17fd5568f2dd31c6cf1aabc620ef338995ec5d9a2f3e42f43ae4870400473044022058dcde893655f40fc8162a79596440ef3e304273f8d530401fc17bc92c58159b0220428900ca6537538ba237d569a4a09003d663a991aeb331a9f18dfe807ee78806014730440220111270eeed8b4b1a231d3ce6e0e0daad718623ad159a0fd3781fb18118a8fec70220539826ee7c76cad4116d1d8852329f80314b3434cf21c765d8004186451a4cd50147522102324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b2102e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5752ae9c3ed620", + "txid": "5d8d917dd7d39fe5a12f121457fc6d712b5e393ed4f16bc8f5976fc08cbbfecd", + "type": "unilateral" } }, { - "id": "example:close#2", - "method": "close", - "params": { - "id": "103x1x0", - "unilateraltimeout": null, - "destination": "bcrt1qeyyk6sl5pr49ycpqyckvmttus5ttj25pd0zpvg", - "fee_negotiation_step": null, - "force_lease_closed": null, - "feerange": null + "request": { + "id": "example:close#2", + "method": "close", + "params": { + "id": "103x1x0", + "unilateraltimeout": null, + "destination": "bcrt1qeyyk6sl5pr49ycpqyckvmttus5ttj25pd0zpvg", + "fee_negotiation_step": null, + "force_lease_closed": null, + "feerange": null + } + }, + "response": { + "tx": "0200000000010132cbce7d5f96b4003c3b5c0eab2a29fef90bb6abb833ff312fa122f31e8301810000000000ffffffff02a0860100000000002251205779a060f200d40e8f871a40eb91614cc5bfa6d0a5f852e053400a7feff8615005b10d0000000000160014c9096d43f408ea526020262ccdad7c8516b92a81040047304402207e171d056e81cf8ad2d5a613ecbaa212d5dcbd0bf713145d18911d2cbe9d858802206222911660a26d7ffddc2563ae6d41d6ffad9fbd2fc26cf40eab501a31153b9e0147304402204ae7cdc68dc7966eab73f16a1978643336333d54ae0b6f87bc11a2c19174a9710220601e5276aee0825466cc272c4eb7d353b393ef0dd230d303f46772790dee19190147522102324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b2102e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5752ae00000000", + "txid": "4a08e0508e2e39ea033fab5f77b318337f345550421799f6e0eb1b15a892eda4", + "type": "mutual" } }, { - "id": "example:close#3", - "method": "close", - "params": [ - "107x1x0", - null, - "bcrt1qeyyk6sl5pr49ycpqyckvmttus5ttj25pd0zpvg" - ] - } - ], - "example_json_response": [ - { - "tx": "020000000001018d388ffcd216c92d25163a62096ce47d5c9bbd6270ced51c5a1484f89df33e5700000000009db0e28002a00f00000000000016001445503fa4b65ade3ffdb1a92057688456c9ffae1380130f0000000000220020be82765fdb17fd5568f2dd31c6cf1aabc620ef338995ec5d9a2f3e42f43ae4870400473044022058dcde893655f40fc8162a79596440ef3e304273f8d530401fc17bc92c58159b0220428900ca6537538ba237d569a4a09003d663a991aeb331a9f18dfe807ee78806014730440220111270eeed8b4b1a231d3ce6e0e0daad718623ad159a0fd3781fb18118a8fec70220539826ee7c76cad4116d1d8852329f80314b3434cf21c765d8004186451a4cd50147522102324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b2102e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5752ae9c3ed620", - "txid": "5d8d917dd7d39fe5a12f121457fc6d712b5e393ed4f16bc8f5976fc08cbbfecd", - "type": "unilateral" - }, - { - "tx": "0200000000010132cbce7d5f96b4003c3b5c0eab2a29fef90bb6abb833ff312fa122f31e8301810000000000ffffffff02a0860100000000002251205779a060f200d40e8f871a40eb91614cc5bfa6d0a5f852e053400a7feff8615005b10d0000000000160014c9096d43f408ea526020262ccdad7c8516b92a81040047304402207e171d056e81cf8ad2d5a613ecbaa212d5dcbd0bf713145d18911d2cbe9d858802206222911660a26d7ffddc2563ae6d41d6ffad9fbd2fc26cf40eab501a31153b9e0147304402204ae7cdc68dc7966eab73f16a1978643336333d54ae0b6f87bc11a2c19174a9710220601e5276aee0825466cc272c4eb7d353b393ef0dd230d303f46772790dee19190147522102324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b2102e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5752ae00000000", - "txid": "4a08e0508e2e39ea033fab5f77b318337f345550421799f6e0eb1b15a892eda4", - "type": "mutual" - }, - { - "tx": "02000000000101233b513665836d240423f45ffcd1fe19aeb08d62303fa5382ad3285f770683a60000000000ffffffff02a086010000000000225120b47216ab60a0fad97de0ba9b8b370d281dfe55f552d82034e2a8d054c2246e4405b10d0000000000160014c9096d43f408ea526020262ccdad7c8516b92a81040047304402207a9e3ca258861b33827d91514690a757e76730ba8c15dd222340bb13d993a1a502204d0ae329273b69abe62df1ffccce808d5f1a29101a8ee95dae99888376dbaef801473044022033c03f406db9f1c9d924cfd8f6ea42d0962f0ab02e3217aef518aea517ca5ba40220076e2af9d40c676316a2765a86f9efd481de3fc4465ceba33b0782c505ae3452014752210212284c004a3d24146e54b2a24db48f650370a08e1fe9abe8ff41f92b09cd50542102a3032ef980cc735579aa5295d927b9a1bdbafc459f2da14163dc9bd530e0a21152ae00000000", - "txid": "d44a1374a30c1a936d2d4fdbe73c0ffff42fec8c27c6cbaec2758b3042f61d08", - "type": "mutual" + "request": { + "id": "example:close#3", + "method": "close", + "params": [ + "107x1x0", + null, + "bcrt1qeyyk6sl5pr49ycpqyckvmttus5ttj25pd0zpvg" + ] + }, + "response": { + "tx": "02000000000101233b513665836d240423f45ffcd1fe19aeb08d62303fa5382ad3285f770683a60000000000ffffffff02a086010000000000225120b47216ab60a0fad97de0ba9b8b370d281dfe55f552d82034e2a8d054c2246e4405b10d0000000000160014c9096d43f408ea526020262ccdad7c8516b92a81040047304402207a9e3ca258861b33827d91514690a757e76730ba8c15dd222340bb13d993a1a502204d0ae329273b69abe62df1ffccce808d5f1a29101a8ee95dae99888376dbaef801473044022033c03f406db9f1c9d924cfd8f6ea42d0962f0ab02e3217aef518aea517ca5ba40220076e2af9d40c676316a2765a86f9efd481de3fc4465ceba33b0782c505ae3452014752210212284c004a3d24146e54b2a24db48f650370a08e1fe9abe8ff41f92b09cd50542102a3032ef980cc735579aa5295d927b9a1bdbafc459f2da14163dc9bd530e0a21152ae00000000", + "txid": "d44a1374a30c1a936d2d4fdbe73c0ffff42fec8c27c6cbaec2758b3042f61d08", + "type": "mutual" + } } ], "author": [ diff --git a/doc/schemas/lightning-commando-blacklist.json b/doc/schemas/lightning-commando-blacklist.json index cc06fb7786c1..2e091e04c47d 100644 --- a/doc/schemas/lightning-commando-blacklist.json +++ b/doc/schemas/lightning-commando-blacklist.json @@ -71,59 +71,63 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:commando-blacklist#1", - "method": "commando-blacklist", - "params": { - "start": 2 - } - }, - { - "id": "example:commando-blacklist#2", - "method": "commando-blacklist", - "params": { - "start": 5, - "end": 7 - } - }, - { - "id": "example:commando-blacklist#3", - "method": "commando-blacklist", - "params": { - "start": 3, - "end": 4 - } - } - ], - "example_json_response": [ - { - "blacklist": [ - { - "start": 2, - "end": 2 + "request": { + "id": "example:commando-blacklist#1", + "method": "commando-blacklist", + "params": { + "start": 2 } - ] + }, + "response": { + "blacklist": [ + { + "start": 2, + "end": 2 + } + ] + } }, { - "blacklist": [ - { - "start": 2, - "end": 2 - }, - { + "request": { + "id": "example:commando-blacklist#2", + "method": "commando-blacklist", + "params": { "start": 5, "end": 7 } - ] + }, + "response": { + "blacklist": [ + { + "start": 2, + "end": 2 + }, + { + "start": 5, + "end": 7 + } + ] + } }, { - "blacklist": [ - { - "start": 2, - "end": 7 + "request": { + "id": "example:commando-blacklist#3", + "method": "commando-blacklist", + "params": { + "start": 3, + "end": 4 } - ] + }, + "response": { + "blacklist": [ + { + "start": 2, + "end": 7 + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-commando-listrunes.json b/doc/schemas/lightning-commando-listrunes.json index 254436850d2c..d2536795886f 100644 --- a/doc/schemas/lightning-commando-listrunes.json +++ b/doc/schemas/lightning-commando-listrunes.json @@ -160,125 +160,129 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:commando-listrunes#1", - "method": "commando-listrunes", - "params": "{}" - }, - { - "id": "example:commando-listrunes#2", - "method": "commando-listrunes", - "params": { - "rune": "Am3W_wI0PRn4qVNEsJ2iInHyFPQK8wfdqEXztm8-icQ9MA==" + "request": { + "id": "example:commando-listrunes#1", + "method": "commando-listrunes", + "params": "{}" + }, + "response": { + "runes": [ + { + "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", + "unique_id": "0", + "restrictions": [], + "restrictions_as_english": "" + }, + { + "rune": "Am3W_wI0PRn4qVNEsJ2iInHyFPQK8wfdqEXztm8-icQ9MA==", + "stored": false, + "our_rune": false, + "unique_id": "1", + "restrictions": [], + "restrictions_as_english": "" + } + ] } }, { - "id": "example:commando-listrunes#3", - "method": "commando-listrunes", - "params": { - "rune": "m_tyR0qqHUuLEbFJW6AhmBg-9npxVX2yKocQBFi9cvY9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJzJnBuYW1lbGV2ZWwhfHBuYW1lbGV2ZWwvaW8mcGFycjEhfHBhcnIxL2lv" - } - } - ], - "example_json_response": [ - { - "runes": [ - { - "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", - "unique_id": "0", - "restrictions": [], - "restrictions_as_english": "" - }, - { - "rune": "Am3W_wI0PRn4qVNEsJ2iInHyFPQK8wfdqEXztm8-icQ9MA==", - "stored": false, - "our_rune": false, - "unique_id": "1", - "restrictions": [], - "restrictions_as_english": "" + "request": { + "id": "example:commando-listrunes#2", + "method": "commando-listrunes", + "params": { + "rune": "Am3W_wI0PRn4qVNEsJ2iInHyFPQK8wfdqEXztm8-icQ9MA==" } - ] + }, + "response": { + "runes": [ + { + "rune": "Am3W_wI0PRn4qVNEsJ2iInHyFPQK8wfdqEXztm8-icQ9MA==", + "stored": false, + "our_rune": false, + "unique_id": "1", + "restrictions": [], + "restrictions_as_english": "" + } + ] + } }, { - "runes": [ - { - "rune": "Am3W_wI0PRn4qVNEsJ2iInHyFPQK8wfdqEXztm8-icQ9MA==", - "stored": false, - "our_rune": false, - "unique_id": "1", - "restrictions": [], - "restrictions_as_english": "" + "request": { + "id": "example:commando-listrunes#3", + "method": "commando-listrunes", + "params": { + "rune": "m_tyR0qqHUuLEbFJW6AhmBg-9npxVX2yKocQBFi9cvY9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJzJnBuYW1lbGV2ZWwhfHBuYW1lbGV2ZWwvaW8mcGFycjEhfHBhcnIxL2lv" } - ] - }, - { - "runes": [ - { - "rune": "m_tyR0qqHUuLEbFJW6AhmBg-9npxVX2yKocQBFi9cvY9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJzJnBuYW1lbGV2ZWwhfHBuYW1lbGV2ZWwvaW8mcGFycjEhfHBhcnIxL2lv", - "stored": false, - "unique_id": "3", - "restrictions": [ - { - "alternatives": [ - { - "fieldname": "id", - "value": "022d223620a359a47ff7", - "condition": "^", - "english": "id starts with 022d223620a359a47ff7" - } - ], - "english": "id starts with 022d223620a359a47ff7" - }, - { - "alternatives": [ - { - "fieldname": "method", - "value": "listpeers", - "condition": "=", - "english": "method equal to listpeers" - } - ], - "english": "method equal to listpeers" - }, - { - "alternatives": [ - { - "fieldname": "pnamelevel", - "value": "", - "condition": "!", - "english": "pnamelevel is missing" - }, - { - "fieldname": "pnamelevel", - "value": "io", - "condition": "/", - "english": "pnamelevel unequal to io" - } - ], - "english": "pnamelevel is missing OR pnamelevel unequal to io" - }, - { - "alternatives": [ - { - "fieldname": "parr1", - "value": "", - "condition": "!", - "english": "parr1 is missing" - }, - { - "fieldname": "parr1", - "value": "io", - "condition": "/", - "english": "parr1 unequal to io" - } - ], - "english": "parr1 is missing OR parr1 unequal to io" - } - ], - "restrictions_as_english": "id starts with 022d223620a359a47ff7 AND method equal to listpeers AND pnamelevel is missing OR pnamelevel unequal to io AND parr1 is missing OR parr1 unequal to io" - } - ] + }, + "response": { + "runes": [ + { + "rune": "m_tyR0qqHUuLEbFJW6AhmBg-9npxVX2yKocQBFi9cvY9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJzJnBuYW1lbGV2ZWwhfHBuYW1lbGV2ZWwvaW8mcGFycjEhfHBhcnIxL2lv", + "stored": false, + "unique_id": "3", + "restrictions": [ + { + "alternatives": [ + { + "fieldname": "id", + "value": "022d223620a359a47ff7", + "condition": "^", + "english": "id starts with 022d223620a359a47ff7" + } + ], + "english": "id starts with 022d223620a359a47ff7" + }, + { + "alternatives": [ + { + "fieldname": "method", + "value": "listpeers", + "condition": "=", + "english": "method equal to listpeers" + } + ], + "english": "method equal to listpeers" + }, + { + "alternatives": [ + { + "fieldname": "pnamelevel", + "value": "", + "condition": "!", + "english": "pnamelevel is missing" + }, + { + "fieldname": "pnamelevel", + "value": "io", + "condition": "/", + "english": "pnamelevel unequal to io" + } + ], + "english": "pnamelevel is missing OR pnamelevel unequal to io" + }, + { + "alternatives": [ + { + "fieldname": "parr1", + "value": "", + "condition": "!", + "english": "parr1 is missing" + }, + { + "fieldname": "parr1", + "value": "io", + "condition": "/", + "english": "parr1 unequal to io" + } + ], + "english": "parr1 is missing OR parr1 unequal to io" + } + ], + "restrictions_as_english": "id starts with 022d223620a359a47ff7 AND method equal to listpeers AND pnamelevel is missing OR pnamelevel unequal to io AND parr1 is missing OR parr1 unequal to io" + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-commando-rune.json b/doc/schemas/lightning-commando-rune.json index 10da1ee92edb..4b7a2523e04d 100644 --- a/doc/schemas/lightning-commando-rune.json +++ b/doc/schemas/lightning-commando-rune.json @@ -220,67 +220,73 @@ "", "If a rune has a ratelimit, any derived rune will have the same id, and thus will compete for that ratelimit. You might want to consider adding a tighter ratelimit to a rune before sharing it, so you will keep the remainder. For example, if you rune has a limit of 60 times per minute, adding a limit of 5 times per minute and handing that rune out means you can still use your original rune 55 times per minute." ], - "example_json_request": [ + "json_example": [ { - "id": "example:commando-rune#1", - "method": "commando-rune", - "params": "{}" + "request": { + "id": "example:commando-rune#1", + "method": "commando-rune", + "params": "{}" + }, + "response": { + "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", + "unique_id": "0", + "warning_unrestricted_rune": "WARNING: This rune has no restrictions! Anyone who has access to this rune could drain funds from your node. Be careful when giving this to apps that you don't trust. Consider using the restrictions parameter to only allow access to specific rpc methods." + } }, { - "id": "example:commando-rune#2", - "method": "commando-rune", - "params": { - "restrictions": "readonly" + "request": { + "id": "example:commando-rune#2", + "method": "commando-rune", + "params": { + "restrictions": "readonly" + } + }, + "response": { + "rune": "zm0x_eLgHexaTvZn3Cz7gb_YlvrlYGDo_w4BYlR9SS09MSZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl", + "unique_id": "1" } }, { - "id": "example:commando-rune#3", - "method": "commando-rune", - "params": { - "restrictions": [ - [ - "id^022d223620a359a47ff7" - ], - [ - "method=listpeers" + "request": { + "id": "example:commando-rune#3", + "method": "commando-rune", + "params": { + "restrictions": [ + [ + "id^022d223620a359a47ff7" + ], + [ + "method=listpeers" + ] ] - ] + } + }, + "response": { + "rune": "YPojv9qgHPa3im0eiqRb-g8aRq76OasyfltGGqdFUOU9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJz", + "unique_id": "2" } }, { - "id": "example:commando-rune#4", - "method": "commando-rune", - "params": { - "restrictions": [ - [ - "method=pay" - ], - [ - "pnameamountmsat<10000" + "request": { + "id": "example:commando-rune#4", + "method": "commando-rune", + "params": { + "restrictions": [ + [ + "method=pay" + ], + [ + "pnameamountmsat<10000" + ] ] - ] + } + }, + "response": { + "rune": "b3hXuEM7Pqzk-C7HUw83xzvHOV7fmuGaWjdo-wHdfg89MCZtZXRob2Q9cGF5JnBuYW1lYW1vdW50bXNhdDwxMDAwMA==", + "unique_id": "3" } } ], - "example_json_response": [ - { - "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", - "unique_id": "0", - "warning_unrestricted_rune": "WARNING: This rune has no restrictions! Anyone who has access to this rune could drain funds from your node. Be careful when giving this to apps that you don't trust. Consider using the restrictions parameter to only allow access to specific rpc methods." - }, - { - "rune": "zm0x_eLgHexaTvZn3Cz7gb_YlvrlYGDo_w4BYlR9SS09MSZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl", - "unique_id": "1" - }, - { - "rune": "YPojv9qgHPa3im0eiqRb-g8aRq76OasyfltGGqdFUOU9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJz", - "unique_id": "2" - }, - { - "rune": "b3hXuEM7Pqzk-C7HUw83xzvHOV7fmuGaWjdo-wHdfg89MCZtZXRob2Q9cGF5JnBuYW1lYW1vdW50bXNhdDwxMDAwMA==", - "unique_id": "3" - } - ], "author": [ "Rusty Russell <> wrote the original Python commando.py plugin, the in-tree commando plugin, and this manual page.", "", diff --git a/doc/schemas/lightning-commando.json b/doc/schemas/lightning-commando.json index ed6a29174178..488e55d3f532 100644 --- a/doc/schemas/lightning-commando.json +++ b/doc/schemas/lightning-commando.json @@ -72,101 +72,105 @@ "", "It can also fail if the peer does not respond, in which case it will simply hang awaiting a response." ], - "example_json_request": [ + "json_example": [ { - "id": "example:commando#1", - "method": "commando", - "params": { - "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "rune": "zm0x_eLgHexaTvZn3Cz7gb_YlvrlYGDo_w4BYlR9SS09MSZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl", - "method": "getinfo", - "params": {} - } - }, - { - "id": "example:commando#2", - "method": "commando", - "params": { - "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "rune": "m_tyR0qqHUuLEbFJW6AhmBg-9npxVX2yKocQBFi9cvY9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJzJnBuYW1lbGV2ZWwhfHBuYW1lbGV2ZWwvaW8mcGFycjEhfHBhcnIxL2lv", - "method": "listpeers", - "params": [ - "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "broken" - ] - } - }, - { - "id": "example:commando#3", - "method": "commando", - "params": { - "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "rune": "b3hXuEM7Pqzk-C7HUw83xzvHOV7fmuGaWjdo-wHdfg89MCZtZXRob2Q9cGF5JnBuYW1lYW1vdW50bXNhdDwxMDAwMA==", - "method": "pay", + "request": { + "id": "example:commando#1", + "method": "commando", "params": { - "bolt11": "lnbcrt1pja05v6sp5n6gnm380ckkrnhzvytz0hvym0vcf0mlrk586nlp72cq7e2hhhffspp5cwhuvl4jhlqep3st2703z89jp7j6wucm8ytlj7rk9ckk0mv7whysdq5v3jhxcmjd9c8g6t0dceqxqyjw5qcqp99qxpqysgq40udwjtktkry0yyq9408q5vtmj534h88j5nn562lamam0rtfqfu3093t2dhhc63qnqe5maa5jc9ad5pm08q2k2udvp6skw9f6ez9c9qptatlau", - "amount_msat": 9999 + "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "rune": "zm0x_eLgHexaTvZn3Cz7gb_YlvrlYGDo_w4BYlR9SS09MSZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl", + "method": "getinfo", + "params": {} } - } - } - ], - "example_json_response": [ - { - "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "alias": "JUNIORBEAM-v23.11-415-gd120eba", - "color": "0266e4", - "num_peers": 1, - "num_pending_channels": 0, - "num_active_channels": 0, - "num_inactive_channels": 0, - "address": [], - "binding": [ - { - "type": "ipv4", - "address": "127.0.0.1", - "port": 42513 + }, + "response": { + "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "alias": "JUNIORBEAM-v23.11-415-gd120eba", + "color": "0266e4", + "num_peers": 1, + "num_pending_channels": 0, + "num_active_channels": 0, + "num_inactive_channels": 0, + "address": [], + "binding": [ + { + "type": "ipv4", + "address": "127.0.0.1", + "port": 42513 + } + ], + "version": "v23.11-415-gd120eba", + "blockheight": 101, + "network": "regtest", + "fees_collected_msat": 0, + "lightning-dir": "/tmp/ltests-7u_8_rtu/test_commando_rune_1/lightning-1/regtest", + "our_features": { + "init": "08a0000a8a5961", + "node": "88a0000a8a5961", + "channel": "", + "invoice": "02000002024100" } - ], - "version": "v23.11-415-gd120eba", - "blockheight": 101, - "network": "regtest", - "fees_collected_msat": 0, - "lightning-dir": "/tmp/ltests-7u_8_rtu/test_commando_rune_1/lightning-1/regtest", - "our_features": { - "init": "08a0000a8a5961", - "node": "88a0000a8a5961", - "channel": "", - "invoice": "02000002024100" } }, { - "peers": [ - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "connected": true, - "num_channels": 0, - "netaddr": [ - "127.0.0.1:40119" - ], - "features": "08a0000a8a5961", - "log": [ - { - "type": "SKIPPED", - "num_skipped": 30 - } + "request": { + "id": "example:commando#2", + "method": "commando", + "params": { + "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "rune": "m_tyR0qqHUuLEbFJW6AhmBg-9npxVX2yKocQBFi9cvY9MyZpZF4wMjJkMjIzNjIwYTM1OWE0N2ZmNyZtZXRob2Q9bGlzdHBlZXJzJnBuYW1lbGV2ZWwhfHBuYW1lbGV2ZWwvaW8mcGFycjEhfHBhcnIxL2lv", + "method": "listpeers", + "params": [ + "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "broken" ] } - ] + }, + "response": { + "peers": [ + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "connected": true, + "num_channels": 0, + "netaddr": [ + "127.0.0.1:40119" + ], + "features": "08a0000a8a5961", + "log": [ + { + "type": "SKIPPED", + "num_skipped": 30 + } + ] + } + ] + } }, { - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "payment_hash": "c3afc67eb2bfc190c60b579f111cb20fa5a7731b3917f978762e2d67ed9e75c9", - "created_at": 1708642714.8110592, - "parts": 1, - "amount_msat": 9999, - "amount_sent_msat": 9999, - "payment_preimage": "17632717785b1a833a296ba1831cb968602872e68881c2f324e06e87979296dc", - "status": "complete" + "request": { + "id": "example:commando#3", + "method": "commando", + "params": { + "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "rune": "b3hXuEM7Pqzk-C7HUw83xzvHOV7fmuGaWjdo-wHdfg89MCZtZXRob2Q9cGF5JnBuYW1lYW1vdW50bXNhdDwxMDAwMA==", + "method": "pay", + "params": { + "bolt11": "lnbcrt1pja05v6sp5n6gnm380ckkrnhzvytz0hvym0vcf0mlrk586nlp72cq7e2hhhffspp5cwhuvl4jhlqep3st2703z89jp7j6wucm8ytlj7rk9ckk0mv7whysdq5v3jhxcmjd9c8g6t0dceqxqyjw5qcqp99qxpqysgq40udwjtktkry0yyq9408q5vtmj534h88j5nn562lamam0rtfqfu3093t2dhhc63qnqe5maa5jc9ad5pm08q2k2udvp6skw9f6ez9c9qptatlau", + "amount_msat": 9999 + } + } + }, + "response": { + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "payment_hash": "c3afc67eb2bfc190c60b579f111cb20fa5a7731b3917f978762e2d67ed9e75c9", + "created_at": 1708642714.8110592, + "parts": 1, + "amount_msat": 9999, + "amount_sent_msat": 9999, + "payment_preimage": "17632717785b1a833a296ba1831cb968602872e68881c2f324e06e87979296dc", + "status": "complete" + } } ], "author": [ diff --git a/doc/schemas/lightning-connect.json b/doc/schemas/lightning-connect.json index a830bc4c30b6..5d369ae2a854 100644 --- a/doc/schemas/lightning-connect.json +++ b/doc/schemas/lightning-connect.json @@ -171,45 +171,47 @@ "- 402: If the peer disconnected while we were connecting", "- -32602: If the given parameters are wrong" ], - "example_json_request": [ + "json_example": [ { - "id": "example:connect#1", - "method": "connect", - "params": { + "request": { + "id": "example:connect#1", + "method": "connect", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "host": "localhost", + "port": 44619 + } + }, + "response": { "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "host": "localhost", - "port": 44619 + "features": "08a0000a0a69a2", + "direction": "out", + "address": { + "type": "ipv4", + "address": "127.0.0.1", + "port": 44619 + } } }, { - "id": "example:connect#2", - "method": "connect", - "params": { + "request": { + "id": "example:connect#2", + "method": "connect", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "host": "127.0.0.1", + "port": 42839 + } + }, + "response": { "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "host": "127.0.0.1", - "port": 42839 - } - } - ], - "example_json_response": [ - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "features": "08a0000a0a69a2", - "direction": "out", - "address": { - "type": "ipv4", - "address": "127.0.0.1", - "port": 44619 - } - }, - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "features": "08a0000a8a5961", - "direction": "out", - "address": { - "type": "ipv4", - "address": "127.0.0.1", - "port": 42839 + "features": "08a0000a8a5961", + "direction": "out", + "address": { + "type": "ipv4", + "address": "127.0.0.1", + "port": 42839 + } } } ], diff --git a/doc/schemas/lightning-createonion.json b/doc/schemas/lightning-createonion.json index 277aa8578f2f..a574929d6663 100644 --- a/doc/schemas/lightning-createonion.json +++ b/doc/schemas/lightning-createonion.json @@ -155,69 +155,71 @@ "", "The `onion` corresponds to 1366 hex-encoded bytes. Each shared secret consists of 32 hex-encoded bytes. Both arguments can be passed on to **sendonion**." ], - "example_json_request": [ + "json_example": [ { - "id": "example:createonion#1", - "method": "createonion", - "params": { - "hops": [ - { - "pubkey": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "payload": "e4000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" - }, - { - "pubkey": "0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c", - "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" - }, - { - "pubkey": "027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007", - "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" - }, - { - "pubkey": "032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991", - "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" - }, - { - "pubkey": "02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145", - "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" - } - ], - "assocdata": "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", - "onion_size": 1301 + "request": { + "id": "example:createonion#1", + "method": "createonion", + "params": { + "hops": [ + { + "pubkey": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "payload": "e4000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + }, + { + "pubkey": "0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c", + "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + }, + { + "pubkey": "027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007", + "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + }, + { + "pubkey": "032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991", + "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + }, + { + "pubkey": "02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145", + "payload": "e30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + } + ], + "assocdata": "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", + "onion_size": 1301 + } + }, + "response": { + "onion": "00034c3f9e11d92555260db3ee4ba0378a645d01c2556451f4289a1d9b43c7afa9a4f9ecc7010dafb26787bb583c514c3b3990d40c8168b1046659d7bc2512d2f1ee0afd2b87c42de2b70102b649634d211b38049593dbb6ed8ee8f93f0b9ff23cd9654c1341137711ce67751d40867cc90c290a9446be2b8a5a43641d4549505b13e807b4240b5b82ffaf22cb534cff01be46db3985ac83b7db465fbd86d4c8d472f60678946c71eca97dd5db732fe5a6d3765e5a5afad72f035207173e7eaaa0da4f0a4540472c7dd269a030428ae586a61b2a70a428055c3848427d2a2e8bd521aadbaf79d56ea39df63c059772e026d57f0b6844c1ab99e936beadf42aaa78193b05f7380e242258deeaa90db316a943d311ef4f2a08f422422c9da454f9666742ad61c6ae003bce83cf6243adf64a728ea50bdaf129ab2ac70e1988a117609cbefc01c884f86b2494349d1067f5cf17760cdab6ae076631693147e8712412d4f0b17cf288b394fd9e29419156ee629966553c2e7598631cbf7493820388eef1ae9f4d2f9da88872e8afbbedb3b46cd7c461cbe4c5491dc6f4a68bc244584bc79b1bb227c869fae16dab4b16412523c984d3ed2b872f63b95a62f66563d2b03c3d1b5fff0290411b293569ce8435b96b447be776b49395a8d94f48cb2f7699a38e8de58d6fff04075d226dcac07668512b6d2c20d4c49d03ad300a52769e4ebbacf97378633126958df1817effc12fd679723123df244fd9b5421f8a2aedb9a8b6fb4049e3a7cae3985059081239bea38351f0c90ed5a0ff45cc492e6ab353e4c13d22ff48912d6ecfda711edfb88dc0767ecfc5dddf8fb0e112a538aeee55c0f73b3b8afc4f40ef3588eabde5b95344a4525adf67841dd67b1db10da180fb346e0bd2958f095d011827063c42361964f8ac2c356d2ec1868a9498dcd6b5915a4df4601c58fcbeb688e14de61300f13183c154b3320cc8e80042a46f22d796f56ff1fdd7e28440c05f14b960c1d0a7c627b09295112bcb635b0e2447a9374fafc4a23ceaf9de4d10b29b2f6cabd7f0c7706cf0404452681d7372d559b644627b2695960deb3b4ae57028e0164b29d5ef9e701d3122b6a5715c502e1dca5252e8c215ed754b01a193041ad9751ed2fff1b55991e256edd6099a38004a367ad097c7caf953da302201263715517f6d32cff57969be994df42fd6cadb649e3c738be798f779aaf4c07cada6bf1e4115b74e2670baf4b1592c70b10a6c043b6606b428b3f79545dc8e9783c876e5402909858f9c604963c37fbc477137c8908e6cfa11ece18c8784a6f25428a5ee1e91d0095fe310d6a91139a7c5c6624bbfcaa15ee847a25b06f57332917f68526a6317f575792e9bcba8576a96bc5859b1f2a00fd8ab08a5ac4ab71833b0b711d1f120cbdb374bcedcdcbeba3806644f5082ec737a945221f5d99562fcbb02a43beeafb16ceecd4e35f06a04c9ff9f4f33725ab62cf22c36650280e4cfb9e150a2c4ebee7785108522e8ecb4682d2d751168e7597299346c3a5e885e36eda66b9a1112997111135767972d771b02c1a36c1d1fb1ce539ecfb98e9e1d8f8fdbf89aec28ad34ff5c00c1a4a8c59848dc8b64c0e65f6f10122e60b4adc1cfc602f49d6cfbdd54be6b0951d3f9cafe8cdd0428f9ce6994844e92d8b72d44edda623bad428b398f88643c3904bda16dd15e886ca4ef6ea7f1450744ac38ffce902569d2e9026bcedd6d0ee54aceabda22bf2de72cba89e6c274064619e32a1192cf2d78b56cf497f7785a6d599de9f8383d1f66f47fc385dc569ee1f08ddbbc7f1aeb0a0126fc4020d948dda10255f11e776db7a037059a40fde38a2ee0c0ce49c7f3df175881bf12371fa72fec3fba657107892a97efe41dcc18aeecd99f3e46c33cf42c2a0ba8b75cf000", + "shared_secrets": [ + "ccf2512684e2508cb4a842393757e6040b7d25e29d3a2031f29d00a000af6128", + "d4cec39fe6287d41165bf5c608b0c720a411208a83c64c805a012c86662a2e5a", + "91bc712ebd4a900e05830394ca8b1f1168777ecdd6996029d96ec8838b9903b9", + "93c373dcb14dc36ababa3e0c5c55869a667ca175e09913a98c3be67e6af97e16", + "b2642a5770a6b61ade071fdf69d3ea365cf48434fc2a2c399512778821a33e5c" + ] } }, { - "id": "example:createonion#2", - "method": "createonion", - "params": { - "hops": [ - { - "pubkey": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "payload": "0cfdb000084869207468657265" - } - ], - "assocdata": "36bf44cc8d80498b95eb05e36ae5811206d3a1d8b5c8d59bbcad035d386a4de8" + "request": { + "id": "example:createonion#2", + "method": "createonion", + "params": { + "hops": [ + { + "pubkey": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "payload": "0cfdb000084869207468657265" + } + ], + "assocdata": "36bf44cc8d80498b95eb05e36ae5811206d3a1d8b5c8d59bbcad035d386a4de8" + } + }, + "response": { + "onion": "0002cdce4bfaa9faa2c060afafe001b80bde07fc670e882c063a80b4738d5f78c9351825c6461cdfcd4fe4144d3b51f63da6351b28dd49c7bfdb0b4f7d8bda4ad0d99699eda39e551084c0a095746c358d1dc6d2eec8082f2aa2f69ae8f61b1f1437ae0ed673078fec6c0510a34058167ad1a34e819a3813d4cf27b2c4917a8c6ca3d70c3381a2a41b4c1b4540adf0e922e25f57d1cfc3064f29cfec4c17244160121975cab59b44c83b4a4905bf7ebfbd308de376334bf86d8aa92c674f7bcfec85680d73e9fee72642c98c603128e358c86e0bc88a60aaebc2637441a57261c61c6be145f00f2fc56164a6495f4b52d3172cb0ef52e91fa0d32a9ae2502d17433bda58d93fbc24a70ec6b5e740952a61404c7370eafe52599c7ee52e77b1cda87c46da98d2ff0d02fe09db5adcb2d2e9bcd083ef58392907b8a21681fa4ea1e4806b4676656457fea000fa504f9b4d159fe8b241266ac91dcc0351053c6dcc1493a6b02bed652cc8b92a8470c98924ebfde6ddc5cf7fd75f6e83a7350642053b70d4834179c30eb56d8c86656cda784daf3b6cd125779bec51099301e3f79f78d85d0454aef8bf5f9058491881b73e99b662b64080cd3eb16fd7f9d9640c18738736cfc15f391232b7df92f46ceb5abf08732ff833e9409ee541d7c926f7a0fe3e233d3eee4a63b65ab23b7c835b7cdd809ddfac8abb1df471fa66a54092815aa41e6fc1a026b86c5675d39c4e8c5c4b4acd48534165239f5634b9e828a7f9df94efcd2a39045efdee4d2f006a63ae828e6e90e3610c522085da6e0198141d6e501d83aba32057f4e59f9b7dfb0bf949c5ef91917cb54561d45a9e7ead049c57deb62d14ba6e18f5d7b0fb9f15e97bf5bd9f909f99c86c787357946654b87c489d34245d07fbb72119166e338b608a4178b452695235dd96bf7fd338e29a9f054ec1a63a442e12602d2329834297f6a197d8a377d608f402f0bcc936f45f33c8d2f9d40e5aef41816dd883add81ca20f1e0631457fe00aa2bd75c9165ffcd96c100c1db83a53aeee23d59f2a542ee3ba39ba62298ddfbd9ecfafd6b5d2121eb003ee23a2ebb8c6b6b687f42492c962510c5acf5231ff96635eba37354559ba39b042d9b6883cac662f418d7c62f9908b2a67964af5e5471804f7684e0d582b8bfec99816bb3442cca1d1fe4efd75d573ebf09fa9cad811063864fb14be4a7768ec2ddb118a77969e986c6584c4b20f8622941ca73d73562857d36e17a46a68d6e10147aaefff1ffb9809f0652a5f760148ed33550661b63c8176d5679e701c221d8a49d4062eb04010ea74cc1132fbeb8934c6e582ba2a16162b7e9171f95bce4ec3e339e70c781f95aaca406cd718b74397658fdefdd093486664be7ed13efa437012f1f57f9f1f4fb4eef7501ccf0e0ac4edc01fde138038c4dd65cb5c3291ad02a6728d6761b1afa35d49bd6ef117012bdd9bd6ee8a175620feb2249aa18d6175351b4bfc2b2b4fd57ff52f5969b109aa9b6cb2cde8f350917c0da2da1bc3d52eb0c7e6080b8f69c5783f2ed26feceb05ba4e7ed66676041d03d0acd3dd6343a85ac0b9c36f9640ddd0db884822f98dc42ea7911a6938dc14ba19d3d25a2b2f82794a2b5dd751dc856d7a9ccdb2d351a0b84e7030fa925ac949a37594f3aa2ba28ae5155b0aaac9c6820b8888d0b8a9db148513b9e3dbde68333ac30a0720289b6a0145d88629d49e76a6d3538330c5aececc9d54127b0a5a0e92d5a5a73beb71132c208b589cab61d53ed357c907929198c559426ae729b374a803dd3321a45ccca39efd39eddaba6e79a2f8911bdf74e18733dc7efc51132b5608d97fd2d0f22fa8961de04cdf6d0dbfbab21e362e7abaef3976f993088aa97ed3f1f4bcf3fffb012f583558bd2f15face9cba20b3e6754b70", + "shared_secrets": [ + "3f53c03f98eb83db88ff97c2c4004051ce23265ed2414a7aebf7a3e7078839ab" + ] } } ], - "example_json_response": [ - { - "onion": "00034c3f9e11d92555260db3ee4ba0378a645d01c2556451f4289a1d9b43c7afa9a4f9ecc7010dafb26787bb583c514c3b3990d40c8168b1046659d7bc2512d2f1ee0afd2b87c42de2b70102b649634d211b38049593dbb6ed8ee8f93f0b9ff23cd9654c1341137711ce67751d40867cc90c290a9446be2b8a5a43641d4549505b13e807b4240b5b82ffaf22cb534cff01be46db3985ac83b7db465fbd86d4c8d472f60678946c71eca97dd5db732fe5a6d3765e5a5afad72f035207173e7eaaa0da4f0a4540472c7dd269a030428ae586a61b2a70a428055c3848427d2a2e8bd521aadbaf79d56ea39df63c059772e026d57f0b6844c1ab99e936beadf42aaa78193b05f7380e242258deeaa90db316a943d311ef4f2a08f422422c9da454f9666742ad61c6ae003bce83cf6243adf64a728ea50bdaf129ab2ac70e1988a117609cbefc01c884f86b2494349d1067f5cf17760cdab6ae076631693147e8712412d4f0b17cf288b394fd9e29419156ee629966553c2e7598631cbf7493820388eef1ae9f4d2f9da88872e8afbbedb3b46cd7c461cbe4c5491dc6f4a68bc244584bc79b1bb227c869fae16dab4b16412523c984d3ed2b872f63b95a62f66563d2b03c3d1b5fff0290411b293569ce8435b96b447be776b49395a8d94f48cb2f7699a38e8de58d6fff04075d226dcac07668512b6d2c20d4c49d03ad300a52769e4ebbacf97378633126958df1817effc12fd679723123df244fd9b5421f8a2aedb9a8b6fb4049e3a7cae3985059081239bea38351f0c90ed5a0ff45cc492e6ab353e4c13d22ff48912d6ecfda711edfb88dc0767ecfc5dddf8fb0e112a538aeee55c0f73b3b8afc4f40ef3588eabde5b95344a4525adf67841dd67b1db10da180fb346e0bd2958f095d011827063c42361964f8ac2c356d2ec1868a9498dcd6b5915a4df4601c58fcbeb688e14de61300f13183c154b3320cc8e80042a46f22d796f56ff1fdd7e28440c05f14b960c1d0a7c627b09295112bcb635b0e2447a9374fafc4a23ceaf9de4d10b29b2f6cabd7f0c7706cf0404452681d7372d559b644627b2695960deb3b4ae57028e0164b29d5ef9e701d3122b6a5715c502e1dca5252e8c215ed754b01a193041ad9751ed2fff1b55991e256edd6099a38004a367ad097c7caf953da302201263715517f6d32cff57969be994df42fd6cadb649e3c738be798f779aaf4c07cada6bf1e4115b74e2670baf4b1592c70b10a6c043b6606b428b3f79545dc8e9783c876e5402909858f9c604963c37fbc477137c8908e6cfa11ece18c8784a6f25428a5ee1e91d0095fe310d6a91139a7c5c6624bbfcaa15ee847a25b06f57332917f68526a6317f575792e9bcba8576a96bc5859b1f2a00fd8ab08a5ac4ab71833b0b711d1f120cbdb374bcedcdcbeba3806644f5082ec737a945221f5d99562fcbb02a43beeafb16ceecd4e35f06a04c9ff9f4f33725ab62cf22c36650280e4cfb9e150a2c4ebee7785108522e8ecb4682d2d751168e7597299346c3a5e885e36eda66b9a1112997111135767972d771b02c1a36c1d1fb1ce539ecfb98e9e1d8f8fdbf89aec28ad34ff5c00c1a4a8c59848dc8b64c0e65f6f10122e60b4adc1cfc602f49d6cfbdd54be6b0951d3f9cafe8cdd0428f9ce6994844e92d8b72d44edda623bad428b398f88643c3904bda16dd15e886ca4ef6ea7f1450744ac38ffce902569d2e9026bcedd6d0ee54aceabda22bf2de72cba89e6c274064619e32a1192cf2d78b56cf497f7785a6d599de9f8383d1f66f47fc385dc569ee1f08ddbbc7f1aeb0a0126fc4020d948dda10255f11e776db7a037059a40fde38a2ee0c0ce49c7f3df175881bf12371fa72fec3fba657107892a97efe41dcc18aeecd99f3e46c33cf42c2a0ba8b75cf000", - "shared_secrets": [ - "ccf2512684e2508cb4a842393757e6040b7d25e29d3a2031f29d00a000af6128", - "d4cec39fe6287d41165bf5c608b0c720a411208a83c64c805a012c86662a2e5a", - "91bc712ebd4a900e05830394ca8b1f1168777ecdd6996029d96ec8838b9903b9", - "93c373dcb14dc36ababa3e0c5c55869a667ca175e09913a98c3be67e6af97e16", - "b2642a5770a6b61ade071fdf69d3ea365cf48434fc2a2c399512778821a33e5c" - ] - }, - { - "onion": "0002cdce4bfaa9faa2c060afafe001b80bde07fc670e882c063a80b4738d5f78c9351825c6461cdfcd4fe4144d3b51f63da6351b28dd49c7bfdb0b4f7d8bda4ad0d99699eda39e551084c0a095746c358d1dc6d2eec8082f2aa2f69ae8f61b1f1437ae0ed673078fec6c0510a34058167ad1a34e819a3813d4cf27b2c4917a8c6ca3d70c3381a2a41b4c1b4540adf0e922e25f57d1cfc3064f29cfec4c17244160121975cab59b44c83b4a4905bf7ebfbd308de376334bf86d8aa92c674f7bcfec85680d73e9fee72642c98c603128e358c86e0bc88a60aaebc2637441a57261c61c6be145f00f2fc56164a6495f4b52d3172cb0ef52e91fa0d32a9ae2502d17433bda58d93fbc24a70ec6b5e740952a61404c7370eafe52599c7ee52e77b1cda87c46da98d2ff0d02fe09db5adcb2d2e9bcd083ef58392907b8a21681fa4ea1e4806b4676656457fea000fa504f9b4d159fe8b241266ac91dcc0351053c6dcc1493a6b02bed652cc8b92a8470c98924ebfde6ddc5cf7fd75f6e83a7350642053b70d4834179c30eb56d8c86656cda784daf3b6cd125779bec51099301e3f79f78d85d0454aef8bf5f9058491881b73e99b662b64080cd3eb16fd7f9d9640c18738736cfc15f391232b7df92f46ceb5abf08732ff833e9409ee541d7c926f7a0fe3e233d3eee4a63b65ab23b7c835b7cdd809ddfac8abb1df471fa66a54092815aa41e6fc1a026b86c5675d39c4e8c5c4b4acd48534165239f5634b9e828a7f9df94efcd2a39045efdee4d2f006a63ae828e6e90e3610c522085da6e0198141d6e501d83aba32057f4e59f9b7dfb0bf949c5ef91917cb54561d45a9e7ead049c57deb62d14ba6e18f5d7b0fb9f15e97bf5bd9f909f99c86c787357946654b87c489d34245d07fbb72119166e338b608a4178b452695235dd96bf7fd338e29a9f054ec1a63a442e12602d2329834297f6a197d8a377d608f402f0bcc936f45f33c8d2f9d40e5aef41816dd883add81ca20f1e0631457fe00aa2bd75c9165ffcd96c100c1db83a53aeee23d59f2a542ee3ba39ba62298ddfbd9ecfafd6b5d2121eb003ee23a2ebb8c6b6b687f42492c962510c5acf5231ff96635eba37354559ba39b042d9b6883cac662f418d7c62f9908b2a67964af5e5471804f7684e0d582b8bfec99816bb3442cca1d1fe4efd75d573ebf09fa9cad811063864fb14be4a7768ec2ddb118a77969e986c6584c4b20f8622941ca73d73562857d36e17a46a68d6e10147aaefff1ffb9809f0652a5f760148ed33550661b63c8176d5679e701c221d8a49d4062eb04010ea74cc1132fbeb8934c6e582ba2a16162b7e9171f95bce4ec3e339e70c781f95aaca406cd718b74397658fdefdd093486664be7ed13efa437012f1f57f9f1f4fb4eef7501ccf0e0ac4edc01fde138038c4dd65cb5c3291ad02a6728d6761b1afa35d49bd6ef117012bdd9bd6ee8a175620feb2249aa18d6175351b4bfc2b2b4fd57ff52f5969b109aa9b6cb2cde8f350917c0da2da1bc3d52eb0c7e6080b8f69c5783f2ed26feceb05ba4e7ed66676041d03d0acd3dd6343a85ac0b9c36f9640ddd0db884822f98dc42ea7911a6938dc14ba19d3d25a2b2f82794a2b5dd751dc856d7a9ccdb2d351a0b84e7030fa925ac949a37594f3aa2ba28ae5155b0aaac9c6820b8888d0b8a9db148513b9e3dbde68333ac30a0720289b6a0145d88629d49e76a6d3538330c5aececc9d54127b0a5a0e92d5a5a73beb71132c208b589cab61d53ed357c907929198c559426ae729b374a803dd3321a45ccca39efd39eddaba6e79a2f8911bdf74e18733dc7efc51132b5608d97fd2d0f22fa8961de04cdf6d0dbfbab21e362e7abaef3976f993088aa97ed3f1f4bcf3fffb012f583558bd2f15face9cba20b3e6754b70", - "shared_secrets": [ - "3f53c03f98eb83db88ff97c2c4004051ce23265ed2414a7aebf7a3e7078839ab" - ] - } - ], "author": [ "Christian Decker <> is mainly responsible." ], diff --git a/doc/schemas/lightning-createrune.json b/doc/schemas/lightning-createrune.json index baf4d00af419..0ba22090ddf7 100644 --- a/doc/schemas/lightning-createrune.json +++ b/doc/schemas/lightning-createrune.json @@ -223,50 +223,54 @@ "", "If a rune has a ratelimit, any derived rune will have the same id, and thus will compete for that ratelimit. You might want to consider adding a tighter ratelimit to a rune before sharing it, so you will keep the remainder. For example, if you rune has a limit of 60 times per minute, adding a limit of 5 times per minute and handing that rune out means you can still use your original rune 55 times per minute." ], - "example_json_request": [ + "json_example": [ { - "id": "example:createrune#1", - "method": "createrune", - "params": { - "restrictions": [ - [ - "method/getinfo" + "request": { + "id": "example:createrune#1", + "method": "createrune", + "params": { + "restrictions": [ + [ + "method/getinfo" + ] ] - ] + } + }, + "response": { + "rune": "S5f-BKt3rR-cvJmujdpDCUQm_XLahfB4iQuDlwqMJiQ9MCZtZXRob2QvZ2V0aW5mbw==", + "unique_id": "0" } }, { - "id": "example:createrune#2", - "method": "createrune", - "params": { - "restrictions": "readonly" + "request": { + "id": "example:createrune#2", + "method": "createrune", + "params": { + "restrictions": "readonly" + } + }, + "response": { + "rune": "oVkzoiQ67VCU1h_aRjPqCeWktGX54ARDsqqQgDL-uMs9MCZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl", + "unique_id": "1" } }, { - "id": "example:createrune#3", - "method": "createrune", - "params": [ - "enX0sTpHB8y1ktyTAF80CnEvGetG340Ne3AGItudBS49NCZwbnVtPTA=", - [ + "request": { + "id": "example:createrune#3", + "method": "createrune", + "params": [ + "enX0sTpHB8y1ktyTAF80CnEvGetG340Ne3AGItudBS49NCZwbnVtPTA=", [ - "rate=3" + [ + "rate=3" + ] ] ] - ] - } - ], - "example_json_response": [ - { - "rune": "S5f-BKt3rR-cvJmujdpDCUQm_XLahfB4iQuDlwqMJiQ9MCZtZXRob2QvZ2V0aW5mbw==", - "unique_id": "0" - }, - { - "rune": "oVkzoiQ67VCU1h_aRjPqCeWktGX54ARDsqqQgDL-uMs9MCZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl", - "unique_id": "1" - }, - { - "rune": "_h2eKjoK7ITAF-JQ1S5oum9oMQesrz-t1FR9kDChRB49NCZwbnVtPTAmcmF0ZT0z", - "unique_id": "2" + }, + "response": { + "rune": "_h2eKjoK7ITAF-JQ1S5oum9oMQesrz-t1FR9kDChRB49NCZwbnVtPTAmcmF0ZT0z", + "unique_id": "2" + } } ], "author": [ diff --git a/doc/schemas/lightning-datastore.json b/doc/schemas/lightning-datastore.json index 87d70d3ac1b5..1841fb1a0714 100644 --- a/doc/schemas/lightning-datastore.json +++ b/doc/schemas/lightning-datastore.json @@ -114,36 +114,72 @@ "- 1206: One of the parents already exists with a value.", "- -32602: invalid parameters" ], - "example_json_request": [ + "json_example": [ { - "id": "example:datastore#1", - "method": "datastore", - "params": { + "request": { + "id": "example:datastore#1", + "method": "datastore", + "params": { + "key": [ + "test_libplugin", + "name" + ], + "string": "foobar", + "hex": null, + "mode": "must-replace", + "generation": null + } + }, + "response": { "key": [ "test_libplugin", "name" ], - "string": "foobar", - "hex": null, - "mode": "must-replace", - "generation": null + "generation": 1, + "hex": "666f6f626172", + "string": "foobar" } }, { - "id": "example:datastore#2", - "method": "datastore", - "params": { - "key": "somekey", - "string": null, - "hex": "61", - "mode": "create-or-append", - "generation": null + "request": { + "id": "example:datastore#2", + "method": "datastore", + "params": { + "key": "somekey", + "string": null, + "hex": "61", + "mode": "create-or-append", + "generation": null + } + }, + "response": { + "key": [ + "somekey" + ], + "generation": 3, + "hex": "736f6d6564617461", + "string": "somedata" } }, { - "id": "example:datastore#3", - "method": "datastore", - "params": { + "request": { + "id": "example:datastore#3", + "method": "datastore", + "params": { + "key": [ + "a", + "d", + "e", + "f", + "g" + ], + "string": "somedatatostoreinthedatastore", + "hex": null, + "mode": null, + "generation": null + } + }, + "response": { "key": [ "a", "d", @@ -151,44 +187,12 @@ "f", "g" ], - "string": "somedatatostoreinthedatastore", - "hex": null, - "mode": null, - "generation": null + "generation": 0, + "hex": "736f6d6564617461746f73746f7265696e7468656461746173746f7265", + "string": "somedatatostoreinthedatastore" } } ], - "example_json_response": [ - { - "key": [ - "test_libplugin", - "name" - ], - "generation": 1, - "hex": "666f6f626172", - "string": "foobar" - }, - { - "key": [ - "somekey" - ], - "generation": 3, - "hex": "736f6d6564617461", - "string": "somedata" - }, - { - "key": [ - "a", - "d", - "e", - "f", - "g" - ], - "generation": 0, - "hex": "736f6d6564617461746f73746f7265696e7468656461746173746f7265", - "string": "somedatatostoreinthedatastore" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-datastoreusage.json b/doc/schemas/lightning-datastoreusage.json index 92ef6e9c09d4..f040c536b2f3 100644 --- a/doc/schemas/lightning-datastoreusage.json +++ b/doc/schemas/lightning-datastoreusage.json @@ -62,49 +62,53 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:datastoreusage#1", - "method": "datastoreusage", - "params": { - "key": null - } - }, - { - "id": "example:datastoreusage#2", - "method": "datastoreusage", - "params": { - "key": "a" - } - }, - { - "id": "example:datastoreusage#3", - "method": "datastoreusage", - "params": { - "key": [ - "a", - "thisissomelongkeythattriestostore46bytesofdata" - ] - } - } - ], - "example_json_response": [ - { - "datastoreusage": { - "key": "[]", - "total_bytes": 0 + "request": { + "id": "example:datastoreusage#1", + "method": "datastoreusage", + "params": { + "key": null + } + }, + "response": { + "datastoreusage": { + "key": "[]", + "total_bytes": 0 + } } }, { - "datastoreusage": { - "key": "[a]", - "total_bytes": 32 + "request": { + "id": "example:datastoreusage#2", + "method": "datastoreusage", + "params": { + "key": "a" + } + }, + "response": { + "datastoreusage": { + "key": "[a]", + "total_bytes": 32 + } } }, { - "datastoreusage": { - "key": "[a,thisissomelongkeythattriestostore46bytesofdata]", - "total_bytes": 77 + "request": { + "id": "example:datastoreusage#3", + "method": "datastoreusage", + "params": { + "key": [ + "a", + "thisissomelongkeythattriestostore46bytesofdata" + ] + } + }, + "response": { + "datastoreusage": { + "key": "[a,thisissomelongkeythattriestostore46bytesofdata]", + "total_bytes": 77 + } } } ], diff --git a/doc/schemas/lightning-decode.json b/doc/schemas/lightning-decode.json index 2cdef3ad1007..8698f31e5b85 100644 --- a/doc/schemas/lightning-decode.json +++ b/doc/schemas/lightning-decode.json @@ -2009,70 +2009,72 @@ } ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:decode#1", - "method": "decode", - "params": [ - "zm0x_eLgHexaTvZn3Cz7gb_YlvrlYGDo_w4BYlR9SS09MSZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl" - ] - }, - { - "id": "example:decode#2", - "method": "decode", - "params": [ - "lnbcrt1m1pja0f2hsp5xyssdvdsu24dmmesrt6x84wfrm4mscsnzq7hl2suzeu90wy6g53qpp5zyyu3anwfsfl64pewe0tg7j28map2wwnhvaam5nt70rlwxa0cegqdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqgqqqqqqqlgqqqq86qqqc9qxpqysgq7u4f99u4kepagme27t5c3gdl7czlnjaw7kxryxgm87w2j02j3g94r2vrukhpgedhcdkcdec27m7jrl2lvcr6uh3rdv9lgpz0vc0zcfcqnugjdw" - ] - } - ], - "example_json_response": [ - { - "type": "rune", - "unique_id": "1", - "string": "ce6d31fde2e01dec5a4ef667dc2cfb81bfd896fae56060e8ff0e0162547d492d:=1&method^list|method^get|method=summary&method/listdatastore", - "restrictions": [ - { - "alternatives": [ - "method^list", - "method^get", - "method=summary" - ], - "summary": "method (of command) starts with 'list' OR method (of command) starts with 'get' OR method (of command) equal to 'summary'" - }, - { - "alternatives": [ - "method/listdatastore" - ], - "summary": "method (of command) unequal to 'listdatastore'" - } - ], - "valid": true - }, - { - "type": "bolt11 invoice", - "currency": "bcrt", - "created_at": 1708631383, - "expiry": 604800, - "payee": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "amount_msat": 100000000, - "description": "description", - "min_final_cltv_expiry": 5, - "payment_secret": "312106b1b0e2aaddef301af463d5c91eebb86213103d7faa1c167857b89a4522", - "features": "02024100", - "routes": [ - [ + "request": { + "id": "example:decode#1", + "method": "decode", + "params": [ + "zm0x_eLgHexaTvZn3Cz7gb_YlvrlYGDo_w4BYlR9SS09MSZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl" + ] + }, + "response": { + "type": "rune", + "unique_id": "1", + "string": "ce6d31fde2e01dec5a4ef667dc2cfb81bfd896fae56060e8ff0e0162547d492d:=1&method^list|method^get|method=summary&method/listdatastore", + "restrictions": [ + { + "alternatives": [ + "method^list", + "method^get", + "method=summary" + ], + "summary": "method (of command) starts with 'list' OR method (of command) starts with 'get' OR method (of command) equal to 'summary'" + }, { - "pubkey": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "short_channel_id": "103x1x0", - "fee_base_msat": 1000, - "fee_proportional_millionths": 1000, - "cltv_expiry_delta": 6 + "alternatives": [ + "method/listdatastore" + ], + "summary": "method (of command) unequal to 'listdatastore'" } + ], + "valid": true + } + }, + { + "request": { + "id": "example:decode#2", + "method": "decode", + "params": [ + "lnbcrt1m1pja0f2hsp5xyssdvdsu24dmmesrt6x84wfrm4mscsnzq7hl2suzeu90wy6g53qpp5zyyu3anwfsfl64pewe0tg7j28map2wwnhvaam5nt70rlwxa0cegqdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqgqqqqqqqlgqqqq86qqqc9qxpqysgq7u4f99u4kepagme27t5c3gdl7czlnjaw7kxryxgm87w2j02j3g94r2vrukhpgedhcdkcdec27m7jrl2lvcr6uh3rdv9lgpz0vc0zcfcqnugjdw" ] - ], - "payment_hash": "1109c8f66e4c13fd5439765eb47a4a3efa1539d3bb3bddd26bf3c7f71bafc650", - "signature": "3045022100f72a929795b643d46f2af2e988a1bff605f9cbaef58c32191b3f9ca93d528a0b022051a983e5ae1465b7c36d86e70af6fd21fd5f6607ae5e236b0bf4044f661e2c27", - "valid": true + }, + "response": { + "type": "bolt11 invoice", + "currency": "bcrt", + "created_at": 1708631383, + "expiry": 604800, + "payee": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "amount_msat": 100000000, + "description": "description", + "min_final_cltv_expiry": 5, + "payment_secret": "312106b1b0e2aaddef301af463d5c91eebb86213103d7faa1c167857b89a4522", + "features": "02024100", + "routes": [ + [ + { + "pubkey": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "short_channel_id": "103x1x0", + "fee_base_msat": 1000, + "fee_proportional_millionths": 1000, + "cltv_expiry_delta": 6 + } + ] + ], + "payment_hash": "1109c8f66e4c13fd5439765eb47a4a3efa1539d3bb3bddd26bf3c7f71bafc650", + "signature": "3045022100f72a929795b643d46f2af2e988a1bff605f9cbaef58c32191b3f9ca93d528a0b022051a983e5ae1465b7c36d86e70af6fd21fd5f6607ae5e236b0bf4044f661e2c27", + "valid": true + } } ], "author": [ diff --git a/doc/schemas/lightning-decodepay.json b/doc/schemas/lightning-decodepay.json index f2792eb1a9f5..8f6d9258b2a6 100644 --- a/doc/schemas/lightning-decodepay.json +++ b/doc/schemas/lightning-decodepay.json @@ -247,33 +247,33 @@ "Technically, the *description* field is optional if a *description_hash* field is given, but in this case **decodepay** will only succeed if the optional *description* field is passed and matches the *description_hash*. In practice, these are currently unused." ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:decodepay#1", - "method": "decodepay", - "params": { - "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", - "description": null + "request": { + "id": "example:decodepay#1", + "method": "decodepay", + "params": { + "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", + "description": null + } + }, + "response": { + "currency": "bcrt", + "created_at": 1706152930, + "expiry": 604800, + "payee": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount_msat": 11000000, + "description": [ + "XEoCR94SIz6UIRUEkxum." + ], + "min_final_cltv_expiry": 5, + "payment_secret": "82644944d3f70d42aad1d5f7b5d7a629e7afa30b529cc952a4c59fc0e3790ea2", + "features": "02024100", + "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", + "signature": "3045022100e3b7d8886eae1a7c9e55e1797aa0dcb77b8c5a19d56c657cad030e360c90682802203a35713acb098245e53a37faeac98754a29a7078db5ed6f2166f917e55b94484" } } ], - "example_json_response": [ - { - "currency": "bcrt", - "created_at": 1706152930, - "expiry": 604800, - "payee": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount_msat": 11000000, - "description": [ - "XEoCR94SIz6UIRUEkxum." - ], - "min_final_cltv_expiry": 5, - "payment_secret": "82644944d3f70d42aad1d5f7b5d7a629e7afa30b529cc952a4c59fc0e3790ea2", - "features": "02024100", - "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "signature": "3045022100e3b7d8886eae1a7c9e55e1797aa0dcb77b8c5a19d56c657cad030e360c90682802203a35713acb098245e53a37faeac98754a29a7078db5ed6f2166f917e55b94484" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-deldatastore.json b/doc/schemas/lightning-deldatastore.json index d5055cb615c0..fdd317dc4b27 100644 --- a/doc/schemas/lightning-deldatastore.json +++ b/doc/schemas/lightning-deldatastore.json @@ -79,44 +79,46 @@ "- 1201: the key does exist, but the generation is wrong", "- -32602: invalid parameters" ], - "example_json_request": [ + "json_example": [ { - "id": "example:deldatastore#1", - "method": "deldatastore", - "params": { - "key": "otherkey", - "generation": 1 + "request": { + "id": "example:deldatastore#1", + "method": "deldatastore", + "params": { + "key": "otherkey", + "generation": 1 + } + }, + "response": { + "key": [ + "otherkey" + ], + "generation": 1, + "hex": "6f746865726461746161", + "string": "otherdataa" } }, { - "id": "example:deldatastore#2", - "method": "deldatastore", - "params": { + "request": { + "id": "example:deldatastore#2", + "method": "deldatastore", + "params": { + "key": [ + "a" + ], + "generation": null + } + }, + "response": { "key": [ "a" ], - "generation": null + "generation": 0, + "hex": "6176616c", + "string": "aval" } } ], - "example_json_response": [ - { - "key": [ - "otherkey" - ], - "generation": 1, - "hex": "6f746865726461746161", - "string": "otherdataa" - }, - { - "key": [ - "a" - ], - "generation": 0, - "hex": "6176616c", - "string": "aval" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-delforward.json b/doc/schemas/lightning-delforward.json index 268496ba8366..a2ba4ee2b702 100644 --- a/doc/schemas/lightning-delforward.json +++ b/doc/schemas/lightning-delforward.json @@ -50,30 +50,32 @@ "", "- 1401: The forward specified does not exist." ], - "example_json_request": [ + "json_example": [ { - "id": "example:delforward#1", - "method": "delforward", - "params": { - "in_channel": "103x1x0", - "in_htlc_id": 2, - "status": "local_failed" - } + "request": { + "id": "example:delforward#1", + "method": "delforward", + "params": { + "in_channel": "103x1x0", + "in_htlc_id": 2, + "status": "local_failed" + } + }, + "response": {} }, { - "id": "example:delforward#2", - "method": "delforward", - "params": [ - "103x1x0", - 1, - "failed" - ] + "request": { + "id": "example:delforward#2", + "method": "delforward", + "params": [ + "103x1x0", + 1, + "failed" + ] + }, + "response": {} } ], - "example_json_response": [ - {}, - {} - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-delinvoice.json b/doc/schemas/lightning-delinvoice.json index 96941a10593a..026b6b46c440 100644 --- a/doc/schemas/lightning-delinvoice.json +++ b/doc/schemas/lightning-delinvoice.json @@ -277,51 +277,53 @@ "- 906: The invoice *status* does not match the parameter. An error object will be returned as error *data*, containing *current_status* and *expected_status* fields. This is most likely due to the *status* of the invoice changing just before this command is invoked.", "- 908: The invoice already has no description, and *desconly* was set." ], - "example_json_request": [ + "json_example": [ { - "id": "example:delinvoice#1", - "method": "delinvoice", - "params": { + "request": { + "id": "example:delinvoice#1", + "method": "delinvoice", + "params": { + "label": "invlabel2", + "status": "unpaid", + "desconly": true + } + }, + "response": { "label": "invlabel2", + "bolt11": "lnbcrt420p1pja0tefsp5vvzg40t4g24l0eqk0jch7mc6jm3ec52ts8w8gwzpwtx9c8nv05rspp533e9csxurt7j9sn2cx7hsn6m00475qgrau8sux5r7djpdedwy2fshp5xqsmrtgfcwsnhxcxmf3tuc65kl6fxvqhvujfmxw2kpeh95yy2x8sxqyjw5qcqp99qxpqysgqgfjrz4q5zcq2lluxxg9h475mq2d3w0tpdstm5274zmhadjl8cqapylfskzk96apka5599a2flm90rmavsk7q8mhh87yle3sgh5vrlycq72fern", + "payment_hash": "8c725c40dc1afd22c26ac1bd784f5b7bebea0103ef0f0e1a83f36416e5ae2293", + "amount_msat": 42, "status": "unpaid", - "desconly": true + "expires_at": 1709238697, + "created_index": 3 } }, { - "id": "example:delinvoice#2", - "method": "delinvoice", - "params": { + "request": { + "id": "example:delinvoice#2", + "method": "delinvoice", + "params": { + "label": "keysend-1708640419.666098582", + "status": "paid", + "desconly": null + } + }, + "response": { "label": "keysend-1708640419.666098582", + "bolt11": "lnbcrt1pja0j9rsp5tg3zvj846gcdzw394njazq40s946sq2ur3hkl4xu4xudtjdtckxspp5fuunrfzsnyz2uxjmg2n95mqhghv4fpvv2kud3kvq4fkys3vmzu5sdqvddjhjum9dejqxqyjw5qcqp99qxpqysgqwt7r0gjlgt7zrfldc3um9myfc36acpqnsdn77c2m42facjtps30yufc5nsmwzhgexlj59f6xa5hess6e3tqrxynt9fejzj3rrshddtcqnappmj", + "payment_hash": "4f3931a4509904ae1a5b42a65a6c1745d954858c55b8d8d980aa6c48459b1729", "status": "paid", - "desconly": null + "pay_index": 1, + "amount_received_msat": 10000000, + "paid_at": 1708640419, + "payment_preimage": "b760af47f456a217e8dfda21a282f1f78c903487c1b21b3b318135f75aa3bf11", + "description": "keysend", + "expires_at": 1709245219, + "created_index": 1, + "updated_index": 1 } } ], - "example_json_response": [ - { - "label": "invlabel2", - "bolt11": "lnbcrt420p1pja0tefsp5vvzg40t4g24l0eqk0jch7mc6jm3ec52ts8w8gwzpwtx9c8nv05rspp533e9csxurt7j9sn2cx7hsn6m00475qgrau8sux5r7djpdedwy2fshp5xqsmrtgfcwsnhxcxmf3tuc65kl6fxvqhvujfmxw2kpeh95yy2x8sxqyjw5qcqp99qxpqysgqgfjrz4q5zcq2lluxxg9h475mq2d3w0tpdstm5274zmhadjl8cqapylfskzk96apka5599a2flm90rmavsk7q8mhh87yle3sgh5vrlycq72fern", - "payment_hash": "8c725c40dc1afd22c26ac1bd784f5b7bebea0103ef0f0e1a83f36416e5ae2293", - "amount_msat": 42, - "status": "unpaid", - "expires_at": 1709238697, - "created_index": 3 - }, - { - "label": "keysend-1708640419.666098582", - "bolt11": "lnbcrt1pja0j9rsp5tg3zvj846gcdzw394njazq40s946sq2ur3hkl4xu4xudtjdtckxspp5fuunrfzsnyz2uxjmg2n95mqhghv4fpvv2kud3kvq4fkys3vmzu5sdqvddjhjum9dejqxqyjw5qcqp99qxpqysgqwt7r0gjlgt7zrfldc3um9myfc36acpqnsdn77c2m42facjtps30yufc5nsmwzhgexlj59f6xa5hess6e3tqrxynt9fejzj3rrshddtcqnappmj", - "payment_hash": "4f3931a4509904ae1a5b42a65a6c1745d954858c55b8d8d980aa6c48459b1729", - "status": "paid", - "pay_index": 1, - "amount_received_msat": 10000000, - "paid_at": 1708640419, - "payment_preimage": "b760af47f456a217e8dfda21a282f1f78c903487c1b21b3b318135f75aa3bf11", - "description": "keysend", - "expires_at": 1709245219, - "created_index": 1, - "updated_index": 1 - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-delpay.json b/doc/schemas/lightning-delpay.json index 7978b1d7ab16..c41ecb85eddc 100644 --- a/doc/schemas/lightning-delpay.json +++ b/doc/schemas/lightning-delpay.json @@ -185,88 +185,92 @@ "The returned format is the same as lightning-listsendpays(7). If the payment is a multi-part payment (MPP) the command return a list of payments will be returned -- one payment object for each partid." ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:delpay#1", - "method": "delpay", - "params": { - "payment_hash": "4fa2f1b001067ec06d7f95b8695b8acd9ef04c1b4d1110e3b94e1fa0687bb1e0", - "status": "complete" + "request": { + "id": "example:delpay#1", + "method": "delpay", + "params": { + "payment_hash": "4fa2f1b001067ec06d7f95b8695b8acd9ef04c1b4d1110e3b94e1fa0687bb1e0", + "status": "complete" + } + }, + "response": { + "payments": [ + { + "id": 1, + "payment_hash": "8dfd6538eeb33811c9114a75f792a143728d7f05643f38c3d574d3097e8910c0", + "destination": "0219f8900ee78a89f050c24d8b69492954f9fdbabed753710845eb75d3a75a5880", + "msatoshi": 1000, + "amount_msat": "1000msat", + "msatoshi_sent": 1000, + "amount_sent_msat": "1000msat", + "created_at": 1596224858, + "status": "complete", + "payment_preimage": "35bd4e2b481a1a84a22215b5372672cf81460a671816960ddb206464359e1822", + "bolt11": "lntb10n1p0jga20pp53h7k2w8wkvuprjg3ff6l0y4pgdeg6lc9vsln3s74wnfsjl5fzrqqdqdw3jhxazldahx2xqyjw5qcqp2sp5wut5jnhr6n7jd5747ky2g5flmw7hgx9yjnqzu60ps2jf6f7tc0us9qy9qsqu2a0k37nckl62005p69xavlkydkvhnypk4dphffy4x09zltwh9437ad7xkl83tefdarzhu5t30ju5s56wlrg97qkx404pq3srfc425cq3ke9af" + } + ] } }, { - "id": "example:delpay#2", - "method": "delpay", - "params": [ - "c9d4547473d0d646f1fdd8ca7f01803e4d31ceab01df33c79456f9c24b04034e", - "failed" - ] - }, - { - "id": "example:delpay#3", - "method": "delpay", - "params": { - "payment_hash": "bbc35e0a46d1483292a4ff8d4daaceaab8c3c084dd835be4128785b52e469c64", - "status": "complete", - "groupid": 1, - "partid": 1 + "request": { + "id": "example:delpay#2", + "method": "delpay", + "params": [ + "c9d4547473d0d646f1fdd8ca7f01803e4d31ceab01df33c79456f9c24b04034e", + "failed" + ] + }, + "response": { + "payments": [ + { + "created_index": 2, + "id": 2, + "payment_hash": "c9d4547473d0d646f1fdd8ca7f01803e4d31ceab01df33c79456f9c24b04034e", + "groupid": 1, + "updated_index": 2, + "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "amount_msat": 100000, + "amount_sent_msat": 100002, + "created_at": 1706316468, + "completed_at": 1706316471, + "status": "failed", + "bolt11": "lnbcrt1u1pjmg54nsp5ke626txv6wwwmqmpuy63t3jnu9hqxwj880zsfkkj7jjqagdaz2sqpp5e829garn6rtydu0amr987qvq8exnrn4tq80n83u52muuyjcyqd8qdq8v3jhxccxqyjw5qcqp99qxpqysgqalktfwy9svsamvvvrzzzzpdaa4rh7n6s5p7t9lx7qv0raz4vnm9knkh5ury3u5cmnhx2gms98nxkclm3833uhjrlnzmftc685vz2f0gpfnjy4y" + } + ] } - } - ], - "example_json_response": [ - { - "payments": [ - { - "id": 1, - "payment_hash": "8dfd6538eeb33811c9114a75f792a143728d7f05643f38c3d574d3097e8910c0", - "destination": "0219f8900ee78a89f050c24d8b69492954f9fdbabed753710845eb75d3a75a5880", - "msatoshi": 1000, - "amount_msat": "1000msat", - "msatoshi_sent": 1000, - "amount_sent_msat": "1000msat", - "created_at": 1596224858, - "status": "complete", - "payment_preimage": "35bd4e2b481a1a84a22215b5372672cf81460a671816960ddb206464359e1822", - "bolt11": "lntb10n1p0jga20pp53h7k2w8wkvuprjg3ff6l0y4pgdeg6lc9vsln3s74wnfsjl5fzrqqdqdw3jhxazldahx2xqyjw5qcqp2sp5wut5jnhr6n7jd5747ky2g5flmw7hgx9yjnqzu60ps2jf6f7tc0us9qy9qsqu2a0k37nckl62005p69xavlkydkvhnypk4dphffy4x09zltwh9437ad7xkl83tefdarzhu5t30ju5s56wlrg97qkx404pq3srfc425cq3ke9af" - } - ] - }, - { - "payments": [ - { - "created_index": 2, - "id": 2, - "payment_hash": "c9d4547473d0d646f1fdd8ca7f01803e4d31ceab01df33c79456f9c24b04034e", - "groupid": 1, - "updated_index": 2, - "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "amount_msat": 100000, - "amount_sent_msat": 100002, - "created_at": 1706316468, - "completed_at": 1706316471, - "status": "failed", - "bolt11": "lnbcrt1u1pjmg54nsp5ke626txv6wwwmqmpuy63t3jnu9hqxwj880zsfkkj7jjqagdaz2sqpp5e829garn6rtydu0amr987qvq8exnrn4tq80n83u52muuyjcyqd8qdq8v3jhxccxqyjw5qcqp99qxpqysgqalktfwy9svsamvvvrzzzzpdaa4rh7n6s5p7t9lx7qv0raz4vnm9knkh5ury3u5cmnhx2gms98nxkclm3833uhjrlnzmftc685vz2f0gpfnjy4y" - } - ] }, { - "payments": [ - { - "created_index": 3, - "id": 3, + "request": { + "id": "example:delpay#3", + "method": "delpay", + "params": { "payment_hash": "bbc35e0a46d1483292a4ff8d4daaceaab8c3c084dd835be4128785b52e469c64", - "groupid": 1, - "updated_index": 3, - "partid": 1, - "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "amount_msat": 100000, - "amount_sent_msat": 102100, - "created_at": 1708641193, - "completed_at": 1708641194, "status": "complete", - "payment_preimage": "a6ebb1cfbf69e76200f196f1eafd28a3d850633499c223a7eb7a7dba3b995286" + "groupid": 1, + "partid": 1 } - ] + }, + "response": { + "payments": [ + { + "created_index": 3, + "id": 3, + "payment_hash": "bbc35e0a46d1483292a4ff8d4daaceaab8c3c084dd835be4128785b52e469c64", + "groupid": 1, + "updated_index": 3, + "partid": 1, + "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "amount_msat": 100000, + "amount_sent_msat": 102100, + "created_at": 1708641193, + "completed_at": 1708641194, + "status": "complete", + "payment_preimage": "a6ebb1cfbf69e76200f196f1eafd28a3d850633499c223a7eb7a7dba3b995286" + } + ] + } } ], "errors": [ diff --git a/doc/schemas/lightning-deprecations.json b/doc/schemas/lightning-deprecations.json index 919b047f1701..def7ccce0a4a 100644 --- a/doc/schemas/lightning-deprecations.json +++ b/doc/schemas/lightning-deprecations.json @@ -24,18 +24,18 @@ "response": { "properties": {} }, - "example_json_request": [ + "json_example": [ { - "id": "example:deprecations#1", - "method": "deprecations", - "params": { - "enable": false - } + "request": { + "id": "example:deprecations#1", + "method": "deprecations", + "params": { + "enable": false + } + }, + "response": {} } ], - "example_json_response": [ - {} - ], "errors": [ "On failure, one of the following error codes may be returned:", "", diff --git a/doc/schemas/lightning-dev-forget-channel.json b/doc/schemas/lightning-dev-forget-channel.json index cf2842330efb..e0d2f672d97c 100644 --- a/doc/schemas/lightning-dev-forget-channel.json +++ b/doc/schemas/lightning-dev-forget-channel.json @@ -75,36 +75,45 @@ "- -32602: If the given parameters are missing or wrong.", "- -1: Catch all nonspecific errors, eg. `Multiple channels: please specify short_channel_id.` OR `No channels matching that peer_id and that short_channel_id.`, etc." ], - "example_json_request": [ + "json_example": [ { - "id": "example:dev-forget-channel#1", - "method": "dev-forget-channel", - "params": { - "id": "023d28435ce4b49f068c964aacbcb6dd114317a70f03e5a731ea72d25df1cff35b" + "description": [ + "Forget a channel by peer pubkey when only one channel exists with the peer." + ], + "request": { + "id": "example:dev-forget-channel#1", + "method": "dev-forget-channel", + "params": { + "id": "023d28435ce4b49f068c964aacbcb6dd114317a70f03e5a731ea72d25df1cff35b" + }, + "test": "test" + }, + "response": { + "forced": false, + "funding_unspent": true, + "funding_txid": "g6efdfb11bee25aa8b2249055a4162e4bd5fa9134bc865c3f054ca666d7ab744" } }, { - "id": "example:dev-forget-channel#2", - "method": "dev-forget-channel", - "params": { - "id": "0348e58210bbc128b1cc3cc1a520a654aaa01e5fe65c65341e21b61a1f09da94d5", - "short_channel_id": "337x1x0", - "force": true + "description": [ + "Forget a channel by short channel id when peer has multiple channels." + ], + "request": { + "id": "example:dev-forget-channel#2", + "method": "dev-forget-channel", + "params": { + "id": "0348e58210bbc128b1cc3cc1a520a654aaa01e5fe65c65341e21b61a1f09da94d5", + "short_channel_id": "337x1x0", + "force": true + } + }, + "response": { + "forced": true, + "funding_unspent": true, + "funding_txid": "b254f30a58adde9326b7e8a701f9d5b3c4db2160b58c5378afbe04448018ec8a" } } ], - "example_json_response": [ - { - "forced": false, - "funding_unspent": true, - "funding_txid": "g6efdfb11bee25aa8b2249055a4162e4bd5fa9134bc865c3f054ca666d7ab744" - }, - { - "forced": true, - "funding_unspent": true, - "funding_txid": "b254f30a58adde9326b7e8a701f9d5b3c4db2160b58c5378afbe04448018ec8a" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-disableoffer.json b/doc/schemas/lightning-disableoffer.json index 600aaa21dda4..48646d95af76 100644 --- a/doc/schemas/lightning-disableoffer.json +++ b/doc/schemas/lightning-disableoffer.json @@ -76,24 +76,24 @@ "Note: the returned object is the same format as **listoffers**." ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:disableoffer#1", - "method": "disableoffer", - "params": { - "offer_id": "713a16ccd4eb10438bdcfbc2c8276be301020dd9d489c530773ba64f3b33307d" + "request": { + "id": "example:disableoffer#1", + "method": "disableoffer", + "params": { + "offer_id": "713a16ccd4eb10438bdcfbc2c8276be301020dd9d489c530773ba64f3b33307d" + } + }, + "response": { + "offer_id": "053a5c566fbea2681a5ff9c05a913da23e45b95d09ef5bd25d7d408f23da7084", + "active": false, + "single_use": false, + "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqvqcdgq2z9pk7enxv4jjqen0wgs8yatnw3ujz83qkc6rvp4j28rt3dtrn32zkvdy7efhnlrpr5rp5geqxs783wtlj550qs8czzku4nk3pqp6m593qxgunzuqcwkmgqkmp6ty0wyvjcqdguv3pnpukedwn6cr87m89t74h3auyaeg89xkvgzpac70z3m9rn5xzu28c", + "used": false } } ], - "example_json_response": [ - { - "offer_id": "053a5c566fbea2681a5ff9c05a913da23e45b95d09ef5bd25d7d408f23da7084", - "active": false, - "single_use": false, - "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqvqcdgq2z9pk7enxv4jjqen0wgs8yatnw3ujz83qkc6rvp4j28rt3dtrn32zkvdy7efhnlrpr5rp5geqxs783wtlj550qs8czzku4nk3pqp6m593qxgunzuqcwkmgqkmp6ty0wyvjcqdguv3pnpukedwn6cr87m89t74h3auyaeg89xkvgzpac70z3m9rn5xzu28c", - "used": false - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-disconnect.json b/doc/schemas/lightning-disconnect.json index ea39855dc58a..75fe6ff817bf 100644 --- a/doc/schemas/lightning-disconnect.json +++ b/doc/schemas/lightning-disconnect.json @@ -45,28 +45,30 @@ "- -32602: If the given parameters are wrong.", "- -1: Catchall nonspecific error." ], - "example_json_request": [ + "json_example": [ { - "id": "example:disconnect#1", - "method": "disconnect", - "params": { - "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "force": false - } + "request": { + "id": "example:disconnect#1", + "method": "disconnect", + "params": { + "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "force": false + } + }, + "response": {} }, { - "id": "example:disconnect#2", - "method": "disconnect", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "force": true - } + "request": { + "id": "example:disconnect#2", + "method": "disconnect", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "force": true + } + }, + "response": {} } ], - "example_json_response": [ - {}, - {} - ], "author": [ "Michael Hawkins <>." ], diff --git a/doc/schemas/lightning-emergencyrecover.json b/doc/schemas/lightning-emergencyrecover.json index 77295cbac911..37f187f579c6 100644 --- a/doc/schemas/lightning-emergencyrecover.json +++ b/doc/schemas/lightning-emergencyrecover.json @@ -29,26 +29,28 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:emergencyrecover#1", - "method": "emergencyrecover", - "params": "{}" - }, - { - "id": "example:emergencyrecover#2", - "method": "emergencyrecover", - "params": "{}" - } - ], - "example_json_response": [ - { - "stubs": [] + "request": { + "id": "example:emergencyrecover#1", + "method": "emergencyrecover", + "params": "{}" + }, + "response": { + "stubs": [] + } }, { - "stubs": [ - "c00734472f344fdadd0bf787de182e5cf144ccda5d731b0f7c75befd1f1eff52" - ] + "request": { + "id": "example:emergencyrecover#2", + "method": "emergencyrecover", + "params": "{}" + }, + "response": { + "stubs": [ + "c00734472f344fdadd0bf787de182e5cf144ccda5d731b0f7c75befd1f1eff52" + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-feerates.json b/doc/schemas/lightning-feerates.json index 70bdc6c84fac..4fb63d30444d 100644 --- a/doc/schemas/lightning-feerates.json +++ b/doc/schemas/lightning-feerates.json @@ -369,106 +369,108 @@ "trivia": [ "In C-lightning we like to call the weight unit \"sipa\" in honor of Pieter Wuille, who uses the name \"sipa\" on IRC and elsewhere. Internally we call the *perkw* style as \"feerate per kilosipa\"." ], - "example_json_request": [ + "json_example": [ { - "id": "example:feerates#1", - "method": "feerates", - "params": { - "style": "perkw", - "urgent": null, - "normal": null, - "slow": null - } - }, - { - "id": "example:feerates#2", - "method": "feerates", - "params": { - "style": "perkb", - "urgent": null, - "normal": null, - "slow": null - } - } - ], - "example_json_response": [ - { - "perkw": { - "opening": 1000000, - "mutual_close": 26362, - "unilateral_close": 26362, - "unilateral_anchor_close": 1000000, - "penalty": 26362, - "min_acceptable": 3750, - "max_acceptable": 10000000, - "floor": 253, - "estimates": [ - { - "blockcount": 2, - "feerate": 1000000, - "smoothed_feerate": 26362 - }, - { - "blockcount": 6, - "feerate": 1000000, - "smoothed_feerate": 26362 - }, - { - "blockcount": 12, - "feerate": 1000000, - "smoothed_feerate": 26362 - }, - { - "blockcount": 100, - "feerate": 1000000, - "smoothed_feerate": 26362 - } - ] + "request": { + "id": "example:feerates#1", + "method": "feerates", + "params": { + "style": "perkw", + "urgent": null, + "normal": null, + "slow": null + } }, - "onchain_fee_estimates": { - "opening_channel_satoshis": 702000, - "mutual_close_satoshis": 17741, - "unilateral_close_satoshis": 1112000, - "unilateral_close_nonanchor_satoshis": 15764, - "htlc_timeout_satoshis": 17478, - "htlc_success_satoshis": 18532 + "response": { + "perkw": { + "opening": 1000000, + "mutual_close": 26362, + "unilateral_close": 26362, + "unilateral_anchor_close": 1000000, + "penalty": 26362, + "min_acceptable": 3750, + "max_acceptable": 10000000, + "floor": 253, + "estimates": [ + { + "blockcount": 2, + "feerate": 1000000, + "smoothed_feerate": 26362 + }, + { + "blockcount": 6, + "feerate": 1000000, + "smoothed_feerate": 26362 + }, + { + "blockcount": 12, + "feerate": 1000000, + "smoothed_feerate": 26362 + }, + { + "blockcount": 100, + "feerate": 1000000, + "smoothed_feerate": 26362 + } + ] + }, + "onchain_fee_estimates": { + "opening_channel_satoshis": 702000, + "mutual_close_satoshis": 17741, + "unilateral_close_satoshis": 1112000, + "unilateral_close_nonanchor_satoshis": 15764, + "htlc_timeout_satoshis": 17478, + "htlc_success_satoshis": 18532 + } } }, { - "perkb": { - "opening": 25000, - "mutual_close": 25000, - "unilateral_close": 44000, - "unilateral_anchor_close": 25000, - "penalty": 25000, - "min_acceptable": 12500, - "max_acceptable": 600000, - "floor": 1012, - "estimates": [ - { - "blockcount": 2, - "feerate": 60000, - "smoothed_feerate": 60000 - }, - { - "blockcount": 6, - "feerate": 44000, - "smoothed_feerate": 44000 - }, - { - "blockcount": 12, - "feerate": 25000, - "smoothed_feerate": 25000 - } - ] + "request": { + "id": "example:feerates#2", + "method": "feerates", + "params": { + "style": "perkb", + "urgent": null, + "normal": null, + "slow": null + } }, - "onchain_fee_estimates": { - "opening_channel_satoshis": 4387, - "mutual_close_satoshis": 4206, - "unilateral_close_satoshis": 6578, - "unilateral_close_nonanchor_satoshis": 6578, - "htlc_timeout_satoshis": 7293, - "htlc_success_satoshis": 7733 + "response": { + "perkb": { + "opening": 25000, + "mutual_close": 25000, + "unilateral_close": 44000, + "unilateral_anchor_close": 25000, + "penalty": 25000, + "min_acceptable": 12500, + "max_acceptable": 600000, + "floor": 1012, + "estimates": [ + { + "blockcount": 2, + "feerate": 60000, + "smoothed_feerate": 60000 + }, + { + "blockcount": 6, + "feerate": 44000, + "smoothed_feerate": 44000 + }, + { + "blockcount": 12, + "feerate": 25000, + "smoothed_feerate": 25000 + } + ] + }, + "onchain_fee_estimates": { + "opening_channel_satoshis": 4387, + "mutual_close_satoshis": 4206, + "unilateral_close_satoshis": 6578, + "unilateral_close_nonanchor_satoshis": 6578, + "htlc_timeout_satoshis": 7293, + "htlc_success_satoshis": 7733 + } } } ], diff --git a/doc/schemas/lightning-fetchinvoice.json b/doc/schemas/lightning-fetchinvoice.json index 487d2ae98e88..b3a44f69817f 100644 --- a/doc/schemas/lightning-fetchinvoice.json +++ b/doc/schemas/lightning-fetchinvoice.json @@ -174,46 +174,50 @@ "- 1004: The node making the offer returned an error message.", "- 1005: We timed out trying to fetch an invoice." ], - "example_json_request": [ + "json_example": [ { - "id": "example:fetchinvoice#1", - "method": "fetchinvoice", - "params": { - "offer": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqypq5zmnd9khqmr9yp6x2um5zcssxhftzxfdlwsnfcgw2sy8t5mxa0ytcdfat2nkdwqvpy9nnsa9mzza", - "payer_note": "Thanks for the fish!" + "request": { + "id": "example:fetchinvoice#1", + "method": "fetchinvoice", + "params": { + "offer": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqypq5zmnd9khqmr9yp6x2um5zcssxhftzxfdlwsnfcgw2sy8t5mxa0ytcdfat2nkdwqvpy9nnsa9mzza", + "payer_note": "Thanks for the fish!" + } + }, + "response": { + "invoice": "lni1qqgvcm9h7yakcmw4mzazspu8vfgpwq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqgzpg9hx6tdwpkx2gr5v4ehg93pqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky965pqqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy84sggren772kj8mau5jp86nc6fszx48rv7ep0quszyyls8rlld3sshjr94j9z5dpsku6mnypnx7u3qw35x2grxd9eksgdqnqp462c3jt0m5y6wzrj5pp6axehtez7r20265antsrqfpvuu8fwcshgr0tsv8e6829e8xmv7laz0kwhtlx6vtk8q3d6rtthdhtwvnn6j585szquc2t7us8kguxypzasg8ewkakgx2ny5ugks0f32x67sm9e5fms4asqrylajc2dqh8ag55mv5p5ghy3e2z8zwmllle8uu7jsxv5ke8d6rr5h7kthmz7ya0hxp4nt7elvw7vghcl6fgsuqqqqqqqqqqqqqqq9qqqqqqqqqqqqq8fykt06c5sqqqqqpfqyvhtunn4gyzy0lphn4wn6ctzlsajy46wscjcglf3hxcnvlaxqs3ydkhgaklsc42spq2czzq6a9vge9ha6zd8ppe2qsawnvm4u30p484d2we4cpsyskwwr5hvgthcyqyuen02ejwpa9cjjrttvp223yxsqkrwnlaszkhas84w0ape300ued4p75xu3cqtcg0cslsx9fvh7dhdqx565t6wa0alf6u2hug90j2hs", + "changes": {} } }, { - "id": "example:fetchinvoice#2", - "method": "fetchinvoice", - "params": { - "offer": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqypq5zmnd9khqmr9yp6x2um5zcssxhftzxfdlwsnfcgw2sy8t5mxa0ytcdfat2nkdwqvpy9nnsa9mzza", - "amount_msat": 3 + "request": { + "id": "example:fetchinvoice#2", + "method": "fetchinvoice", + "params": { + "offer": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqypq5zmnd9khqmr9yp6x2um5zcssxhftzxfdlwsnfcgw2sy8t5mxa0ytcdfat2nkdwqvpy9nnsa9mzza", + "amount_msat": 3 + } + }, + "response": { + "invoice": "lni1qqg0mfchkz0gkmn8zzu5zaxd0qvlzq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqgzpg9hx6tdwpkx2gr5v4ehg93pqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky965pqqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy84yqgrtqss8d4vgzd3286u9rk0zg9qr7a6z2xm6mjnz9pydztcn0j74tjvch0f5zvqxhftzxfdlwsnfcgw2sy8t5mxa0ytcdfat2nkdwqvpy9nnsa9mzzaqth4fzjqxxmsaxvc4v2urs6hsh6k0e564x00g68vuyp5w7yjedzxvqgr8ltzmj0n7ltxr0tz9rafn9zcy9jldjqfuf20w6gjmr7nj04d360sqvkdwprxn22dlp3xay9yq4nhrw2jm0c8t6r7japhdad6leawxyqzkg92tx8gqxp9f2d8j5k2axta0gr7yr9zrsqqqqqqqqqqqqqqq5qqqqqqqqqqqqqayjedltzjqqqqqq9yq3ja0jwj4qswt3kgs9mxq7gck66x60m5rndykpw3a7hf4ntlp9qe2vgwzzrvcwd2qypmqggrt543ryklhgf5uy89gzr46dnwhj9ux5744fmxhqxqjzeecwja3pwlqsxyjcdwur4hl4qf7nsjgg8euvy45lznufh5kydkwz6llsucuhvwp9ezeggaj3k057ge6ftvaffjkwn6j3y7faeuysrx3m2xccphu65sx", + "changes": {} } }, { - "id": "example:fetchinvoice#3", - "method": "fetchinvoice", - "params": { - "offer": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqypq5zmnd9khqmr9yp6x2um5zsqs593pqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4j", - "quantity": 2 + "request": { + "id": "example:fetchinvoice#3", + "method": "fetchinvoice", + "params": { + "offer": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqypq5zmnd9khqmr9yp6x2um5zsqs593pqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4j", + "quantity": 2 + } + }, + "response": { + "invoice": "lni1qqgd508mv9rpjg2ec8dr8qcslf2cjq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqgzpg9hx6tdwpkx2gr5v4ehg9qppgtzzq3dygmzpg6e53ll0aavg37gt3rvjg762vufygdqq4xprs0regcat9gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02cqsykppqfkyy6q8ry9pchxtuajh456hhcf7dxx733cx76etuv5ftfmfa2ymhgycqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jq6uhkeymz26zx7zgw4gdmw2vj9xqn4hu2sqxhp0pcgt87pf9chyfvqsywtejxjh603kx7am3zaf6d6xuumw30p8zmcdz7r95nn4lr92exk3qqe2x6xqwpdzh2zwq3vnyra8nfc6d7y6hegpkvc7p2nulj7hvhwl5hjfr23wn60mjftqspn7d4ejhrpsr5m2y8qqqqqqqqqqqqqqqpgqqqqqqqqqqqqp6f9jm7k9yqqqqqq2gpr96l9mt2pqxuyr0gqw92h0xz2y2uy5uxss4ujcac5jehj9ay2sxkapr80t5ha65qgykqssytfzxcs2xkdy0lml0tzy0jzugmyj8kjn8zfzrgq9fsgurc72x82e7pqxhl4u29cjluw5s8fwa9wtvh0qytr7vqk0vtndsz07mrrtmjw629m8mnqkjaf43kt889qeq2f7deu6t853lngpzclapt8nj0g528v9ay", + "changes": {} } } ], - "example_json_response": [ - { - "invoice": "lni1qqgvcm9h7yakcmw4mzazspu8vfgpwq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqgzpg9hx6tdwpkx2gr5v4ehg93pqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky965pqqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy84sggren772kj8mau5jp86nc6fszx48rv7ep0quszyyls8rlld3sshjr94j9z5dpsku6mnypnx7u3qw35x2grxd9eksgdqnqp462c3jt0m5y6wzrj5pp6axehtez7r20265antsrqfpvuu8fwcshgr0tsv8e6829e8xmv7laz0kwhtlx6vtk8q3d6rtthdhtwvnn6j585szquc2t7us8kguxypzasg8ewkakgx2ny5ugks0f32x67sm9e5fms4asqrylajc2dqh8ag55mv5p5ghy3e2z8zwmllle8uu7jsxv5ke8d6rr5h7kthmz7ya0hxp4nt7elvw7vghcl6fgsuqqqqqqqqqqqqqqq9qqqqqqqqqqqqq8fykt06c5sqqqqqpfqyvhtunn4gyzy0lphn4wn6ctzlsajy46wscjcglf3hxcnvlaxqs3ydkhgaklsc42spq2czzq6a9vge9ha6zd8ppe2qsawnvm4u30p484d2we4cpsyskwwr5hvgthcyqyuen02ejwpa9cjjrttvp223yxsqkrwnlaszkhas84w0ape300ued4p75xu3cqtcg0cslsx9fvh7dhdqx565t6wa0alf6u2hug90j2hs", - "changes": {} - }, - { - "invoice": "lni1qqg0mfchkz0gkmn8zzu5zaxd0qvlzq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqgzpg9hx6tdwpkx2gr5v4ehg93pqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky965pqqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy84yqgrtqss8d4vgzd3286u9rk0zg9qr7a6z2xm6mjnz9pydztcn0j74tjvch0f5zvqxhftzxfdlwsnfcgw2sy8t5mxa0ytcdfat2nkdwqvpy9nnsa9mzzaqth4fzjqxxmsaxvc4v2urs6hsh6k0e564x00g68vuyp5w7yjedzxvqgr8ltzmj0n7ltxr0tz9rafn9zcy9jldjqfuf20w6gjmr7nj04d360sqvkdwprxn22dlp3xay9yq4nhrw2jm0c8t6r7japhdad6leawxyqzkg92tx8gqxp9f2d8j5k2axta0gr7yr9zrsqqqqqqqqqqqqqqq5qqqqqqqqqqqqqayjedltzjqqqqqq9yq3ja0jwj4qswt3kgs9mxq7gck66x60m5rndykpw3a7hf4ntlp9qe2vgwzzrvcwd2qypmqggrt543ryklhgf5uy89gzr46dnwhj9ux5744fmxhqxqjzeecwja3pwlqsxyjcdwur4hl4qf7nsjgg8euvy45lznufh5kydkwz6llsucuhvwp9ezeggaj3k057ge6ftvaffjkwn6j3y7faeuysrx3m2xccphu65sx", - "changes": {} - }, - { - "invoice": "lni1qqgd508mv9rpjg2ec8dr8qcslf2cjq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqgzpg9hx6tdwpkx2gr5v4ehg9qppgtzzq3dygmzpg6e53ll0aavg37gt3rvjg762vufygdqq4xprs0regcat9gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02cqsykppqfkyy6q8ry9pchxtuajh456hhcf7dxx733cx76etuv5ftfmfa2ymhgycqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jq6uhkeymz26zx7zgw4gdmw2vj9xqn4hu2sqxhp0pcgt87pf9chyfvqsywtejxjh603kx7am3zaf6d6xuumw30p8zmcdz7r95nn4lr92exk3qqe2x6xqwpdzh2zwq3vnyra8nfc6d7y6hegpkvc7p2nulj7hvhwl5hjfr23wn60mjftqspn7d4ejhrpsr5m2y8qqqqqqqqqqqqqqqpgqqqqqqqqqqqqp6f9jm7k9yqqqqqq2gpr96l9mt2pqxuyr0gqw92h0xz2y2uy5uxss4ujcac5jehj9ay2sxkapr80t5ha65qgykqssytfzxcs2xkdy0lml0tzy0jzugmyj8kjn8zfzrgq9fsgurc72x82e7pqxhl4u29cjluw5s8fwa9wtvh0qytr7vqk0vtndsz07mrrtmjw629m8mnqkjaf43kt889qeq2f7deu6t853lngpzclapt8nj0g528v9ay", - "changes": {} - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-fundchannel.json b/doc/schemas/lightning-fundchannel.json index 6e6003d1f58a..6e4a1cb4023d 100644 --- a/doc/schemas/lightning-fundchannel.json +++ b/doc/schemas/lightning-fundchannel.json @@ -222,67 +222,69 @@ "lightning-cli -k fundchannel id=03f...fc1 amount=all feerate=normal utxos='[\"bcc1...39c:0\"]'", "```" ], - "example_json_request": [ + "json_example": [ { - "id": "example:fundchannel#1", - "method": "fundchannel", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount": 1000000, - "feerate": null, - "announce": true, - "minconf": null, - "utxos": null, - "push_msat": null, - "close_to": null, - "request_amt": null, - "compact_lease": null, - "mindepth": null, - "reserve": null - } - }, - { - "id": "example:fundchannel#2", - "method": "fundchannel", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount": 10000000, - "feerate": null, - "announce": true, - "minconf": null, - "utxos": null, - "push_msat": 1000000000, - "close_to": null, - "request_amt": null, - "compact_lease": null, - "mindepth": null, - "reserve": null, - "channel_type": null + "request": { + "id": "example:fundchannel#1", + "method": "fundchannel", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount": 1000000, + "feerate": null, + "announce": true, + "minconf": null, + "utxos": null, + "push_msat": null, + "close_to": null, + "request_amt": null, + "compact_lease": null, + "mindepth": null, + "reserve": null + } + }, + "response": { + "tx": "020000000001014ca47b75e6982fce6b5ebb6e7ec163dc5b6bed1562934e6febe816103b2b207e0000000000fdffffff0240420f00000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd012f0f000000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a02473044022058fc4d51c8254d37b266d3db3f8fda7420882b6ec9226d66b8c0139f2707c09602205798d8ce23d4c692a7384362a2e0afd9703f062239a786d7a1840a28d3a1152e012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", + "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b", + "channel_id": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "outnum": 0 } - } - ], - "example_json_response": [ - { - "tx": "020000000001014ca47b75e6982fce6b5ebb6e7ec163dc5b6bed1562934e6febe816103b2b207e0000000000fdffffff0240420f00000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd012f0f000000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a02473044022058fc4d51c8254d37b266d3db3f8fda7420882b6ec9226d66b8c0139f2707c09602205798d8ce23d4c692a7384362a2e0afd9703f062239a786d7a1840a28d3a1152e012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", - "txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b", - "channel_id": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "outnum": 0 }, { - "tx": "0200000000010141cfa0e9957c7c6d0bb5069d92937f9545e6e6ee9b4650f47f509d5ea65df4690100000000fdffffff0280969800000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd4118530b0000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a0247304402206488c7dfbc4180781ed0d5ca7ff2c8ce134480c349d03978765053a393229d9a022066c75dee1f19b410ea1c7756d0cb2c097e52b13f4d9bbd033efa4ed95d817e14012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", - "txid": "6aa1231b6356777468a55aea1f49dad6415592aef6c1e652f8a64357c7235301", - "channel_id": "015323c75743a6f852e6c1f6ae925541d6da491fea5aa568747756631b23a16a", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] + "request": { + "id": "example:fundchannel#2", + "method": "fundchannel", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount": 10000000, + "feerate": null, + "announce": true, + "minconf": null, + "utxos": null, + "push_msat": 1000000000, + "close_to": null, + "request_amt": null, + "compact_lease": null, + "mindepth": null, + "reserve": null, + "channel_type": null + } }, - "outnum": 0 + "response": { + "tx": "0200000000010141cfa0e9957c7c6d0bb5069d92937f9545e6e6ee9b4650f47f509d5ea65df4690100000000fdffffff0280969800000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd4118530b0000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a0247304402206488c7dfbc4180781ed0d5ca7ff2c8ce134480c349d03978765053a393229d9a022066c75dee1f19b410ea1c7756d0cb2c097e52b13f4d9bbd033efa4ed95d817e14012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", + "txid": "6aa1231b6356777468a55aea1f49dad6415592aef6c1e652f8a64357c7235301", + "channel_id": "015323c75743a6f852e6c1f6ae925541d6da491fea5aa568747756631b23a16a", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "outnum": 0 + } } ], "errors": [ diff --git a/doc/schemas/lightning-fundchannel_cancel.json b/doc/schemas/lightning-fundchannel_cancel.json index a42ef609e690..0a1ca38f70ed 100644 --- a/doc/schemas/lightning-fundchannel_cancel.json +++ b/doc/schemas/lightning-fundchannel_cancel.json @@ -37,30 +37,32 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:fundchannel_cancel#1", - "method": "fundchannel_cancel", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" + "request": { + "id": "example:fundchannel_cancel#1", + "method": "fundchannel_cancel", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" + } + }, + "response": { + "cancelled": "Channel open canceled by RPC" } }, { - "id": "example:fundchannel_cancel#2", - "method": "fundchannel_cancel", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" + "request": { + "id": "example:fundchannel_cancel#2", + "method": "fundchannel_cancel", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" + } + }, + "response": { + "cancelled": "Channel open canceled by RPC(after fundchannel_complete)" } } ], - "example_json_response": [ - { - "cancelled": "Channel open canceled by RPC" - }, - { - "cancelled": "Channel open canceled by RPC(after fundchannel_complete)" - } - ], "errors": [ "On error the returned object will contain `code` and `message` properties, with `code` being one of the following:", "", diff --git a/doc/schemas/lightning-fundchannel_complete.json b/doc/schemas/lightning-fundchannel_complete.json index 89b74575e5ab..fa73da316aaf 100644 --- a/doc/schemas/lightning-fundchannel_complete.json +++ b/doc/schemas/lightning-fundchannel_complete.json @@ -61,22 +61,22 @@ "- 306: Unknown peer id.", "- 309: PSBT does not have a unique, correct output to fund the channel." ], - "example_json_request": [ + "json_example": [ { - "id": "example:fundchannel_complete#1", - "method": "fundchannel_complete", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "psbt": "cHNidP8BAIkCAAAAASYd4TeOHEIzrUbbELM2DK0IX09WaXqWsJFlLD455MPPAAAAAAD9////Av///wAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM1c8QUpAQAAACJRIH8AZYBKMKON4/oVmJVsVt6zy/+PkBPzziE+LtkuFvWXAAAAAAABAIMCAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/////wJRAP////8CAPIFKgEAAAAWABQ5FIjuMd8ar9WFRV9eGNLF+3RMcAAAAAAAAAAAJmokqiGp7eL2HD9x0d79P6mZ36NpU3VcaQaJeZlitIvr2DaXToz5AAAAAAEBHwDyBSoBAAAAFgAUORSI7jHfGq/VhUVfXhjSxft0THAiBgMegIxEPDa2OseVTaV6ANtSwQuoj/j2an7X/Is2EekvWBhhFDNgVAAAgAEAAIAAAACAAAAAAAAAAAAAAAEFIEm9AFgqUlJwbPFtyt3a9dzvb+nAGZiQ3CT1CImhjBFpIQdJvQBYKlJScGzxbcrd2vXc72/pwBmYkNwk9QiJoYwRaRkAYRQzYFYAAIABAACAAAAAgAEAAAAAAAAAAA==" + "request": { + "id": "example:fundchannel_complete#1", + "method": "fundchannel_complete", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "psbt": "cHNidP8BAIkCAAAAASYd4TeOHEIzrUbbELM2DK0IX09WaXqWsJFlLD455MPPAAAAAAD9////Av///wAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM1c8QUpAQAAACJRIH8AZYBKMKON4/oVmJVsVt6zy/+PkBPzziE+LtkuFvWXAAAAAAABAIMCAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/////wJRAP////8CAPIFKgEAAAAWABQ5FIjuMd8ar9WFRV9eGNLF+3RMcAAAAAAAAAAAJmokqiGp7eL2HD9x0d79P6mZ36NpU3VcaQaJeZlitIvr2DaXToz5AAAAAAEBHwDyBSoBAAAAFgAUORSI7jHfGq/VhUVfXhjSxft0THAiBgMegIxEPDa2OseVTaV6ANtSwQuoj/j2an7X/Is2EekvWBhhFDNgVAAAgAEAAIAAAACAAAAAAAAAAAAAAAEFIEm9AFgqUlJwbPFtyt3a9dzvb+nAGZiQ3CT1CImhjBFpIQdJvQBYKlJScGzxbcrd2vXc72/pwBmYkNwk9QiJoYwRaRkAYRQzYFYAAIABAACAAAAAgAEAAAAAAAAAAA==" + } + }, + "response": { + "channel_id": "049217e5035a4a60449c6382c445b5c105bd63588d66137ad0511c57a16db6d9", + "commitments_secured": true } } ], - "example_json_response": [ - { - "channel_id": "049217e5035a4a60449c6382c445b5c105bd63588d66137ad0511c57a16db6d9", - "commitments_secured": true - } - ], "author": [ "Lisa Neigut <> is mainly responsible." ], diff --git a/doc/schemas/lightning-fundchannel_start.json b/doc/schemas/lightning-fundchannel_start.json index a4fbee579ebb..e135b9daa6b1 100644 --- a/doc/schemas/lightning-fundchannel_start.json +++ b/doc/schemas/lightning-fundchannel_start.json @@ -186,53 +186,55 @@ "- 306: Unknown peer id.", "- 312: Peer negotiated `option_dual_fund`, must use `openchannel_init` not `fundchannel_start`. (Only if ``experimental-dual-fund` is enabled)" ], - "example_json_request": [ + "json_example": [ { - "id": "example:fundchannel_start#1", - "method": "fundchannel_start", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount": 16777216, - "feerate": null, - "announce": true, - "close_to": null, - "mindepth": null - } - }, - { - "id": "example:fundchannel_start#2", - "method": "fundchannel_start", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount": "100000sat", - "feerate": null, - "announce": true, - "close_to": null, - "mindepth": null, - "channel_type": null + "request": { + "id": "example:fundchannel_start#1", + "method": "fundchannel_start", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount": 16777216, + "feerate": null, + "announce": true, + "close_to": null, + "mindepth": null + } + }, + "response": { + "funding_address": "bcrt1qtwxd8wg5eanumk86vfeujvp48hfkgannf77evggzct048wggsrxsum2pmm", + "scriptpubkey": "00205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd", + "warning_usage": "The funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed by running `fundchannel_complete`" } - } - ], - "example_json_response": [ - { - "funding_address": "bcrt1qtwxd8wg5eanumk86vfeujvp48hfkgannf77evggzct048wggsrxsum2pmm", - "scriptpubkey": "00205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd", - "warning_usage": "The funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed by running `fundchannel_complete`" }, { - "funding_address": "bcrt1qtwxd8wg5eanumk86vfeujvp48hfkgannf77evggzct048wggsrxsum2pmm", - "scriptpubkey": "00205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] + "request": { + "id": "example:fundchannel_start#2", + "method": "fundchannel_start", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount": "100000sat", + "feerate": null, + "announce": true, + "close_to": null, + "mindepth": null, + "channel_type": null + } }, - "warning_usage": "The funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed by running `fundchannel_complete`" + "response": { + "funding_address": "bcrt1qtwxd8wg5eanumk86vfeujvp48hfkgannf77evggzct048wggsrxsum2pmm", + "scriptpubkey": "00205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "warning_usage": "The funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed by running `fundchannel_complete`" + } } ], "author": [ diff --git a/doc/schemas/lightning-funderupdate.json b/doc/schemas/lightning-funderupdate.json index 0475eb2834ae..496124b0e1af 100644 --- a/doc/schemas/lightning-funderupdate.json +++ b/doc/schemas/lightning-funderupdate.json @@ -267,61 +267,63 @@ "", "- -32602: If the given parameters are invalid." ], - "example_json_request": [ + "json_example": [ { - "id": "example:funderupdate#1", - "method": "funderupdate", - "params": "{}" + "request": { + "id": "example:funderupdate#1", + "method": "funderupdate", + "params": "{}" + }, + "response": { + "summary": "match (100%)", + "policy": "match", + "policy_mod": 100, + "leases_only": true, + "min_their_funding_msat": 10000000, + "max_their_funding_msat": 4294967295000, + "per_channel_min_msat": 10000000, + "per_channel_max_msat": 4294967295000, + "reserve_tank_msat": 0, + "fuzz_percent": 0, + "fund_probability": 100, + "lease_fee_base_msat": 100000, + "lease_fee_basis": 100, + "funding_weight": 666, + "channel_fee_max_base_msat": 5000000, + "channel_fee_max_proportional_thousandths": 100, + "compact_lease": "029a00640064000000644c4b40" + } }, { - "id": "example:funderupdate#2", - "method": "funderupdate", - "params": { + "request": { + "id": "example:funderupdate#2", + "method": "funderupdate", + "params": { + "policy": "fixed", + "policy_mod": "50000sat", + "min_their_funding_msat": 1000, + "per_channel_min_msat": "1000sat", + "per_channel_max_msat": "500000sat", + "fund_probability": 100, + "fuzz_percent": 0, + "leases_only": false + } + }, + "response": { + "summary": "fixed (50000sat)", "policy": "fixed", - "policy_mod": "50000sat", + "policy_mod": 50000, + "leases_only": false, "min_their_funding_msat": 1000, - "per_channel_min_msat": "1000sat", - "per_channel_max_msat": "500000sat", - "fund_probability": 100, + "max_their_funding_msat": 4294967295000, + "per_channel_min_msat": 1000000, + "per_channel_max_msat": 500000000, + "reserve_tank_msat": 0, "fuzz_percent": 0, - "leases_only": false + "fund_probability": 100 } } ], - "example_json_response": [ - { - "summary": "match (100%)", - "policy": "match", - "policy_mod": 100, - "leases_only": true, - "min_their_funding_msat": 10000000, - "max_their_funding_msat": 4294967295000, - "per_channel_min_msat": 10000000, - "per_channel_max_msat": 4294967295000, - "reserve_tank_msat": 0, - "fuzz_percent": 0, - "fund_probability": 100, - "lease_fee_base_msat": 100000, - "lease_fee_basis": 100, - "funding_weight": 666, - "channel_fee_max_base_msat": 5000000, - "channel_fee_max_proportional_thousandths": 100, - "compact_lease": "029a00640064000000644c4b40" - }, - { - "summary": "fixed (50000sat)", - "policy": "fixed", - "policy_mod": 50000, - "leases_only": false, - "min_their_funding_msat": 1000, - "max_their_funding_msat": 4294967295000, - "per_channel_min_msat": 1000000, - "per_channel_max_msat": 500000000, - "reserve_tank_msat": 0, - "fuzz_percent": 0, - "fund_probability": 100 - } - ], "author": [ "Lisa Neigut <> is mainly responsible." ], diff --git a/doc/schemas/lightning-fundpsbt.json b/doc/schemas/lightning-fundpsbt.json index 97955ee6410b..6acd81892fb7 100644 --- a/doc/schemas/lightning-fundpsbt.json +++ b/doc/schemas/lightning-fundpsbt.json @@ -195,88 +195,92 @@ "- -1: Catchall nonspecific error.", "- 301: Insufficient UTXOs to meet *satoshi* value." ], - "example_json_request": [ + "json_example": [ { - "id": "example:fundpsbt#1", - "method": "fundpsbt", - "params": { - "satoshi": 16777216, - "feerate": "253perkw", - "startweight": 250, - "minconf": null, - "reserve": 0, - "locktime": null, - "min_witness_weight": null, - "excess_as_change": false - } - }, - { - "id": "example:fundpsbt#2", - "method": "fundpsbt", - "params": { - "satoshi": "all", - "feerate": "1000perkw", - "startweight": 1000, - "minconf": null, - "reserve": null, - "locktime": null, - "min_witness_weight": null, - "excess_as_change": false + "request": { + "id": "example:fundpsbt#1", + "method": "fundpsbt", + "params": { + "satoshi": 16777216, + "feerate": "253perkw", + "startweight": 250, + "minconf": null, + "reserve": 0, + "locktime": null, + "min_witness_weight": null, + "excess_as_change": false + } + }, + "response": { + "psbt": "cHNidP8BADMCAAAAAWzmSFzhTtXBnQewytc32WaMwJSunScwsYndBNdU80JqAAAAAAD9////AGYAAAAAAQDeAgAAAAABAU1MpIJeOOzqAYVkZaytJCmzUadBVltKar8kWtzKSVeYAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFD8W5uBNZAxN6n1jqU62dxWQbyGAAkcwRAIgUK+vMOeWiDPiJM8fpgKCjjwXog4yfWPvtKES1ZZPaM8CIB3cgouGpV6Gc7nEvAu28Mg9tkAWt/Xl5FDOseEyeZqHASECTwjR0I3gLHdSW7jRmnVXdm0+MgJ1hihnqEfXYeFWA/NlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", + "feerate_per_kw": 253, + "estimated_final_weight": 521, + "excess_msat": 9999869000 } }, { - "id": "example:fundpsbt#3", - "method": "fundpsbt", - "params": { - "satoshi": "109000sat", - "feerate": "slow", - "startweight": 166, - "minconf": null, - "reserve": null, - "locktime": null, - "min_witness_weight": null, - "excess_as_change": true - } - } - ], - "example_json_response": [ - { - "psbt": "cHNidP8BADMCAAAAAWzmSFzhTtXBnQewytc32WaMwJSunScwsYndBNdU80JqAAAAAAD9////AGYAAAAAAQDeAgAAAAABAU1MpIJeOOzqAYVkZaytJCmzUadBVltKar8kWtzKSVeYAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFD8W5uBNZAxN6n1jqU62dxWQbyGAAkcwRAIgUK+vMOeWiDPiJM8fpgKCjjwXog4yfWPvtKES1ZZPaM8CIB3cgouGpV6Gc7nEvAu28Mg9tkAWt/Xl5FDOseEyeZqHASECTwjR0I3gLHdSW7jRmnVXdm0+MgJ1hihnqEfXYeFWA/NlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", - "feerate_per_kw": 253, - "estimated_final_weight": 521, - "excess_msat": 9999869000 - }, - { - "psbt": "cHNidP8BAF4CAAAAAfwbEpvpi6D14YV4VLnuVB47Y0uF41kXEyJRL4IusySSAQAAAAD9////ASICAAAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5nAAAAAAEA9gIAAAAAAQFEkxvLatohY6mw5gr5qG1aiArSrziFPR2YoqD21Hv+RAAAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNrz8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIEu1nfVRt9i+rFM219mwhMqdwJsqygWSWTFUS+cemdh6AiBG3Qo8g9J/aAMO2RHDsIBScscj6pTTIwZp7Gw8G3EOKAEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPZgAAAAEBK68/DwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", - "feerate_per_kw": 1000, - "estimated_final_weight": 1443, - "excess_msat": 997354000, - "change_outnum": 0, - "reservations": [ - { - "txid": "9224b32e822f5122131759e3854b633b1e54eeb9547885e1f5a08be99b121bfc", - "vout": 1, - "was_reserved": false, - "reserved": true, - "reserved_to_block": 175 + "request": { + "id": "example:fundpsbt#2", + "method": "fundpsbt", + "params": { + "satoshi": "all", + "feerate": "1000perkw", + "startweight": 1000, + "minconf": null, + "reserve": null, + "locktime": null, + "min_witness_weight": null, + "excess_as_change": false } - ] + }, + "response": { + "psbt": "cHNidP8BAF4CAAAAAfwbEpvpi6D14YV4VLnuVB47Y0uF41kXEyJRL4IusySSAQAAAAD9////ASICAAAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5nAAAAAAEA9gIAAAAAAQFEkxvLatohY6mw5gr5qG1aiArSrziFPR2YoqD21Hv+RAAAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNrz8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIEu1nfVRt9i+rFM219mwhMqdwJsqygWSWTFUS+cemdh6AiBG3Qo8g9J/aAMO2RHDsIBScscj6pTTIwZp7Gw8G3EOKAEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPZgAAAAEBK68/DwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", + "feerate_per_kw": 1000, + "estimated_final_weight": 1443, + "excess_msat": 997354000, + "change_outnum": 0, + "reservations": [ + { + "txid": "9224b32e822f5122131759e3854b633b1e54eeb9547885e1f5a08be99b121bfc", + "vout": 1, + "was_reserved": false, + "reserved": true, + "reserved_to_block": 175 + } + ] + } }, { - "psbt": "cHNidP8BAF4CAAAAAbEf44mT/BPDxLkUjKy1byWksyLyuM6hbe8shzEbbXhGAQAAAAD9////AU58DQAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5sAAAAAAEA9gIAAAAAAQEV9Sj1wfHqO/ECZeHp/u7cFL5eRaa1Vu4hXWbwH72pxgEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIGILT3DrcNn6/WKOhsxxKq7lDWq47dV0IjRhj0bYHs4yAiApzODtmrz7ifK32G81A2XbBxWboFk2vN4T3ng/hYmb1wEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPZgAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", - "feerate_per_kw": 3750, - "estimated_final_weight": 609, - "excess_msat": 0, - "change_outnum": 0, - "reservations": [ - { - "txid": "46786d1b31872cef6da1ceb8f222b3a4256fb5ac8c14b9c4c313fc9389e31fb1", - "vout": 1, - "was_reserved": false, - "reserved": true, - "reserved_to_block": 180 + "request": { + "id": "example:fundpsbt#3", + "method": "fundpsbt", + "params": { + "satoshi": "109000sat", + "feerate": "slow", + "startweight": 166, + "minconf": null, + "reserve": null, + "locktime": null, + "min_witness_weight": null, + "excess_as_change": true } - ] + }, + "response": { + "psbt": "cHNidP8BAF4CAAAAAbEf44mT/BPDxLkUjKy1byWksyLyuM6hbe8shzEbbXhGAQAAAAD9////AU58DQAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5sAAAAAAEA9gIAAAAAAQEV9Sj1wfHqO/ECZeHp/u7cFL5eRaa1Vu4hXWbwH72pxgEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIGILT3DrcNn6/WKOhsxxKq7lDWq47dV0IjRhj0bYHs4yAiApzODtmrz7ifK32G81A2XbBxWboFk2vN4T3ng/hYmb1wEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPZgAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", + "feerate_per_kw": 3750, + "estimated_final_weight": 609, + "excess_msat": 0, + "change_outnum": 0, + "reservations": [ + { + "txid": "46786d1b31872cef6da1ceb8f222b3a4256fb5ac8c14b9c4c313fc9389e31fb1", + "vout": 1, + "was_reserved": false, + "reserved": true, + "reserved_to_block": 180 + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-getinfo.json b/doc/schemas/lightning-getinfo.json index 60c74a06ccc0..0d3a58f383fe 100644 --- a/doc/schemas/lightning-getinfo.json +++ b/doc/schemas/lightning-getinfo.json @@ -362,52 +362,52 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:getinfo#1", - "method": "getinfo", - "params": {} - } - ], - "example_json_response": [ - { - "id": "02bf811f7571754f0b51e6d41a8885f5561041a7b14fac093e4cffb95749de1a8d", - "alias": "SLICKERGOPHER", - "color": "02bf81", - "num_peers": 0, - "num_pending_channels": 0, - "num_active_channels": 0, - "num_inactive_channels": 0, - "address": [ - { - "type": "torv3", - "address": "fp463inc4w3lamhhduytrwdwq6q6uzugtaeapylqfc43agrdnnqsheyd.onion", - "port": 9736 - }, - { - "type": "torv3", - "address": "ifnntp5ak4homxrti2fp6ckyllaqcike447ilqfrgdw64ayrmkyashid.onion", - "port": 9736 - } - ], - "binding": [ - { - "type": "ipv4", - "address": "127.0.0.1", - "port": 9736 + "request": { + "id": "example:getinfo#1", + "method": "getinfo", + "params": {} + }, + "response": { + "id": "02bf811f7571754f0b51e6d41a8885f5561041a7b14fac093e4cffb95749de1a8d", + "alias": "SLICKERGOPHER", + "color": "02bf81", + "num_peers": 0, + "num_pending_channels": 0, + "num_active_channels": 0, + "num_inactive_channels": 0, + "address": [ + { + "type": "torv3", + "address": "fp463inc4w3lamhhduytrwdwq6q6uzugtaeapylqfc43agrdnnqsheyd.onion", + "port": 9736 + }, + { + "type": "torv3", + "address": "ifnntp5ak4homxrti2fp6ckyllaqcike447ilqfrgdw64ayrmkyashid.onion", + "port": 9736 + } + ], + "binding": [ + { + "type": "ipv4", + "address": "127.0.0.1", + "port": 9736 + } + ], + "version": "v0.10.2", + "blockheight": 724302, + "network": "bitcoin", + "msatoshi_fees_collected": 0, + "fees_collected_msat": "0msat", + "lightning-dir": "/media/vincent/Maxtor/C-lightning/node/bitcoin", + "our_features": { + "init": "8828226aa2", + "node": "80008828226aa2", + "channel": "", + "invoice": "20024200" } - ], - "version": "v0.10.2", - "blockheight": 724302, - "network": "bitcoin", - "msatoshi_fees_collected": 0, - "fees_collected_msat": "0msat", - "lightning-dir": "/media/vincent/Maxtor/C-lightning/node/bitcoin", - "our_features": { - "init": "8828226aa2", - "node": "80008828226aa2", - "channel": "", - "invoice": "20024200" } } ], diff --git a/doc/schemas/lightning-getlog.json b/doc/schemas/lightning-getlog.json index 9d8d02166c83..e179cfe75fc7 100644 --- a/doc/schemas/lightning-getlog.json +++ b/doc/schemas/lightning-getlog.json @@ -212,12 +212,31 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:getlog#1", - "method": "getlog", - "params": { - "level": "debug" + "request": { + "id": "example:getlog#1", + "method": "getlog", + "params": { + "level": "debug" + } + }, + "response": { + "created_at": "1598192543.820753463", + "bytes_used": 89285843, + "bytes_max": 104857600, + "log": [ + { + "type": "SKIPPED", + "num_skipped": 45 + }, + { + "type": "INFO", + "time": "0.453627568", + "source": "plugin-autopilot.py", + "log": "RPCmethod'autopilot-run-once'doesnothaveadocstring." + } + ] } } ], @@ -226,25 +245,6 @@ "", "- -32602: Error in given parameters." ], - "example_json_response": [ - { - "created_at": "1598192543.820753463", - "bytes_used": 89285843, - "bytes_max": 104857600, - "log": [ - { - "type": "SKIPPED", - "num_skipped": 45 - }, - { - "type": "INFO", - "time": "0.453627568", - "source": "plugin-autopilot.py", - "log": "RPCmethod'autopilot-run-once'doesnothaveadocstring." - } - ] - } - ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." diff --git a/doc/schemas/lightning-getroute.json b/doc/schemas/lightning-getroute.json index ea8d43907d67..8e31009f3aa2 100644 --- a/doc/schemas/lightning-getroute.json +++ b/doc/schemas/lightning-getroute.json @@ -352,79 +352,81 @@ "", "The default for lightning-pay(7) is 10, which starts to become a major factor for larger amounts, and is basically ignored for tiny ones." ], - "example_json_request": [ + "json_example": [ { - "id": "example:getroute#1", - "method": "getroute", - "params": { - "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "amount_msat": 50000000, - "riskfactor": 1, - "cltv": 9, - "fromid": null, - "fuzzpercent": null, - "exclude": null, - "maxhops": null - } - }, - { - "id": "example:getroute#2", - "method": "getroute", - "params": { - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "amount_msat": "50000sat", - "riskfactor": 10 - } - } - ], - "example_json_response": [ - { - "route": [ - { - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "channel": "103x3x0", - "direction": 1, - "amount_msat": 50001002, - "delay": 21, - "style": "tlv" - }, - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "channel": "103x1x0", - "direction": 1, - "amount_msat": 50000501, - "delay": 15, - "style": "tlv" - }, - { + "request": { + "id": "example:getroute#1", + "method": "getroute", + "params": { "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "channel": "103x2x0", - "direction": 0, "amount_msat": 50000000, - "delay": 9, - "style": "tlv" + "riskfactor": 1, + "cltv": 9, + "fromid": null, + "fuzzpercent": null, + "exclude": null, + "maxhops": null } - ] + }, + "response": { + "route": [ + { + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "channel": "103x3x0", + "direction": 1, + "amount_msat": 50001002, + "delay": 21, + "style": "tlv" + }, + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "channel": "103x1x0", + "direction": 1, + "amount_msat": 50000501, + "delay": 15, + "style": "tlv" + }, + { + "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "channel": "103x2x0", + "direction": 0, + "amount_msat": 50000000, + "delay": 9, + "style": "tlv" + } + ] + } }, { - "route": [ - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "channel": "103x2x0", - "direction": 1, - "amount_msat": 50051000, - "delay": 15, - "style": "tlv" - }, - { + "request": { + "id": "example:getroute#2", + "method": "getroute", + "params": { "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "channel": "103x1x0", - "direction": 0, - "amount_msat": 50000000, - "delay": 9, - "style": "tlv" + "amount_msat": "50000sat", + "riskfactor": 10 } - ] + }, + "response": { + "route": [ + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "channel": "103x2x0", + "direction": 1, + "amount_msat": 50051000, + "delay": 15, + "style": "tlv" + }, + { + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "channel": "103x1x0", + "direction": 0, + "amount_msat": 50000000, + "delay": 9, + "style": "tlv" + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-help.json b/doc/schemas/lightning-help.json index c33480de923b..0caf7dc9184f 100644 --- a/doc/schemas/lightning-help.json +++ b/doc/schemas/lightning-help.json @@ -75,19 +75,45 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:help#1", - "method": "help", - "params": { - "command": "pay" + "request": { + "id": "example:help#1", + "method": "help", + "params": { + "command": "pay" + } + }, + "response": { + "help": [ + { + "command": "pay bolt11 [amount_msat] [label] [riskfactor] [maxfeepercent] [retry_for] [maxdelay] [exemptfee] [localinvreqid] [exclude] [maxfee] [description] [dev_use_shadow]", + "category": "plugin", + "description": "Send payment specified by {bolt11}", + "verbose": "Attempt to pay the {bolt11} invoice." + } + ], + "format-hint": "simple" } }, { - "id": "example:help#2", - "method": "help", - "params": { - "command": "dev" + "request": { + "id": "example:help#2", + "method": "help", + "params": { + "command": "dev" + } + }, + "response": { + "help": [ + { + "command": "dev subcommand=crash|rhash|slowcmd", + "category": "developer", + "description": "Developer command test multiplexer", + "verbose": "dev rhash {secret}\n\tShow SHA256 of {secret}\ndev crash\n\tCrash lightningd by calling fatal()\ndev slowcmd {msec}\n\tTorture test for slow commands, optional {msec}\n" + } + ], + "format-hint": "simple" } } ], @@ -96,30 +122,6 @@ "", "- -32602: Error in given parameters." ], - "example_json_response": [ - { - "help": [ - { - "command": "pay bolt11 [amount_msat] [label] [riskfactor] [maxfeepercent] [retry_for] [maxdelay] [exemptfee] [localinvreqid] [exclude] [maxfee] [description] [dev_use_shadow]", - "category": "plugin", - "description": "Send payment specified by {bolt11}", - "verbose": "Attempt to pay the {bolt11} invoice." - } - ], - "format-hint": "simple" - }, - { - "help": [ - { - "command": "dev subcommand=crash|rhash|slowcmd", - "category": "developer", - "description": "Developer command test multiplexer", - "verbose": "dev rhash {secret}\n\tShow SHA256 of {secret}\ndev crash\n\tCrash lightningd by calling fatal()\ndev slowcmd {msec}\n\tTorture test for slow commands, optional {msec}\n" - } - ], - "format-hint": "simple" - } - ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." diff --git a/doc/schemas/lightning-invoice.json b/doc/schemas/lightning-invoice.json index d32b93e5d49f..9c9a4a3a7c79 100644 --- a/doc/schemas/lightning-invoice.json +++ b/doc/schemas/lightning-invoice.json @@ -188,58 +188,60 @@ "- 901: An invoice with the given *preimage* already exists.", "- 902: None of the specified *exposeprivatechannels* were usable." ], - "example_json_request": [ + "json_example": [ { - "id": "example:invoice#1", - "method": "invoice", - "params": { - "amount_msat": 11000000, - "label": "xEoCR94SIz6UIRUEkxum", - "description": [ - "XEoCR94SIz6UIRUEkxum." - ], - "expiry": null, - "fallbacks": null, - "preimage": null, - "exposeprivatechannels": null, - "cltv": null, - "deschashonly": null + "request": { + "id": "example:invoice#1", + "method": "invoice", + "params": { + "amount_msat": 11000000, + "label": "xEoCR94SIz6UIRUEkxum", + "description": [ + "XEoCR94SIz6UIRUEkxum." + ], + "expiry": null, + "fallbacks": null, + "preimage": null, + "exposeprivatechannels": null, + "cltv": null, + "deschashonly": null + } + }, + "response": { + "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", + "expires_at": 1706757730, + "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", + "payment_secret": "82644944d3f70d42aad1d5f7b5d7a629e7afa30b529cc952a4c59fc0e3790ea2", + "created_index": 1, + "warning_deadends": "Insufficient incoming capacity, once dead-end peers were excluded" } }, { - "id": "example:invoice#2", - "method": "invoice", - "params": { - "amount_msat": 100, - "label": "8", - "description": "inv", - "expiry": null, - "fallbacks": null, - "preimage": null, - "exposeprivatechannels": null, - "cltv": null, - "deschashonly": null + "request": { + "id": "example:invoice#2", + "method": "invoice", + "params": { + "amount_msat": 100, + "label": "8", + "description": "inv", + "expiry": null, + "fallbacks": null, + "preimage": null, + "exposeprivatechannels": null, + "cltv": null, + "deschashonly": null + } + }, + "response": { + "payment_hash": "f59ae0204dfe8e913207ea36646255b9d2c7c8229e8693d30547fc622eddb6b4", + "expires_at": 1709229182, + "bolt11": "lnbcrt1n1pja0z07sp5n8fk890nrq7zlcue0lgu7cduaaz765u5rg0kcud4amphuppu8wxspp57kdwqgzdl68fzvs8agmxgcj4h8fv0jpzn6rf85c9gl7xytkak66qdq9d9h8vxqyjw5qcqp99qxpqysgqrneaxh0plvjft457yv3q92rak57a6xw33m6phr0mrsy69sudzgez3adkzdsgwzy32z5usjpxm4rjgcg70h047wf0pgc4l9gyaj2h9ssqcrtv32", + "payment_secret": "99d36395f3183c2fe3997fd1cf61bcef45ed53941a1f6c71b5eec37e043c3b8d", + "created_index": 9, + "warning_capacity": "Insufficient incoming channel capacity to pay invoice" } } ], - "example_json_response": [ - { - "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "expires_at": 1706757730, - "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", - "payment_secret": "82644944d3f70d42aad1d5f7b5d7a629e7afa30b529cc952a4c59fc0e3790ea2", - "created_index": 1, - "warning_deadends": "Insufficient incoming capacity, once dead-end peers were excluded" - }, - { - "payment_hash": "f59ae0204dfe8e913207ea36646255b9d2c7c8229e8693d30547fc622eddb6b4", - "expires_at": 1709229182, - "bolt11": "lnbcrt1n1pja0z07sp5n8fk890nrq7zlcue0lgu7cduaaz765u5rg0kcud4amphuppu8wxspp57kdwqgzdl68fzvs8agmxgcj4h8fv0jpzn6rf85c9gl7xytkak66qdq9d9h8vxqyjw5qcqp99qxpqysgqrneaxh0plvjft457yv3q92rak57a6xw33m6phr0mrsy69sudzgez3adkzdsgwzy32z5usjpxm4rjgcg70h047wf0pgc4l9gyaj2h9ssqcrtv32", - "payment_secret": "99d36395f3183c2fe3997fd1cf61bcef45ed53941a1f6c71b5eec37e043c3b8d", - "created_index": 9, - "warning_capacity": "Insufficient incoming channel capacity to pay invoice" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-invoicerequest.json b/doc/schemas/lightning-invoicerequest.json index 6c56511c5baf..5c8bd4b0bebf 100644 --- a/doc/schemas/lightning-invoicerequest.json +++ b/doc/schemas/lightning-invoicerequest.json @@ -107,26 +107,26 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:invoicerequest#1", - "method": "invoicerequest", - "params": { - "amount": "10000sat", - "description": "simple test", - "issuer": "clightning test suite" + "request": { + "id": "example:invoicerequest#1", + "method": "invoicerequest", + "params": { + "amount": "10000sat", + "description": "simple test", + "issuer": "clightning test suite" + } + }, + "response": { + "invreq_id": "715484ead84bcdae5b33e3015c686fa1bdd4ae9ade3c4729b58257a98cfcd9b5", + "active": true, + "single_use": true, + "bolt12": "lnr1qqgteyhfyp40c79a5y3gfe33nxfs6zstwd5k6urvv5s8getnwsfp2cmvd9nksarwd9hxwgr5v4ehggrnw45hge2syqrzymjxzydqkkw24ufxqslttwlj3s608f0rx2slc7etw0833zgs75srnztgqkppqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq633uzq99smfawuu6pz0zh9jl6dl8v25u3kzes975x2j9tr0qp0ux0tlzcxjrgehxh9luz5vwjpk92tys9f9zlm038krcz4uqfxgelwf43tgfc", + "used": false } } ], - "example_json_response": [ - { - "invreq_id": "715484ead84bcdae5b33e3015c686fa1bdd4ae9ade3c4729b58257a98cfcd9b5", - "active": true, - "single_use": true, - "bolt12": "lnr1qqgteyhfyp40c79a5y3gfe33nxfs6zstwd5k6urvv5s8getnwsfp2cmvd9nksarwd9hxwgr5v4ehggrnw45hge2syqrzymjxzydqkkw24ufxqslttwlj3s608f0rx2slc7etw0833zgs75srnztgqkppqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq633uzq99smfawuu6pz0zh9jl6dl8v25u3kzes975x2j9tr0qp0ux0tlzcxjrgehxh9luz5vwjpk92tys9f9zlm038krcz4uqfxgelwf43tgfc", - "used": false - } - ], "errors": [ "On failure, an error is returned and no `invoice_request` is created. If the lightning process fails before responding, the caller should use lightning-listinvoicerequests(7) to query whether it was created or not.", "", diff --git a/doc/schemas/lightning-keysend.json b/doc/schemas/lightning-keysend.json index 06f7f1ef4274..537811b5c521 100644 --- a/doc/schemas/lightning-keysend.json +++ b/doc/schemas/lightning-keysend.json @@ -209,99 +209,103 @@ "*failcode*: The failure code, as per BOLT #4.", "*channel_update*: The hex string of the *channel_update* message received from the remote node. Only present if error is from the remote node and the *failcode* has the `UPDATE` bit set, as per BOLT #4." ], - "example_json_request": [ + "json_example": [ { - "id": "example:keysend#1", - "method": "keysend", - "params": { + "request": { + "id": "example:keysend#1", + "method": "keysend", + "params": { + "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "amount_msat": 10000, + "label": null, + "maxfeepercent": null, + "retry_for": null, + "maxdelay": null, + "exemptfee": null, + "extratlvs": null + } + }, + "response": { "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "payment_hash": "b6f88603008a9f7dd84b1b94c7b972c8efbaf0b86c8d3c04512955992da9028e", + "created_at": 1706315742.6861734, + "parts": 1, "amount_msat": 10000, - "label": null, - "maxfeepercent": null, - "retry_for": null, - "maxdelay": null, - "exemptfee": null, - "extratlvs": null + "amount_sent_msat": 10001, + "payment_preimage": "7178cf708e34dce816fc35aa692a65e1f85b92ae03bbc8ae6543302511823174", + "status": "complete" } }, { - "id": "example:keysend#2", - "method": "keysend", - "params": { + "request": { + "id": "example:keysend#2", + "method": "keysend", + "params": { + "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "amount_msat": 10000000, + "label": null, + "maxfeepercent": null, + "retry_for": null, + "maxdelay": null, + "exemptfee": null, + "extratlvs": { + "133773310": "68656c6c6f776f726c64", + "133773312": "66696c7465726d65" + } + } + }, + "response": { "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "payment_hash": "e8474eea8d5673e8407ef5f4924e58479b51a68afd136384683d5d6a97c9520d", + "created_at": 1708640424.1810749, + "parts": 1, "amount_msat": 10000000, - "label": null, - "maxfeepercent": null, - "retry_for": null, - "maxdelay": null, - "exemptfee": null, - "extratlvs": { - "133773310": "68656c6c6f776f726c64", - "133773312": "66696c7465726d65" - } + "amount_sent_msat": 10000000, + "payment_preimage": "40e47272ea7da20c57a2381d81a5513ec03bd8ead9d51fbd2a91ec76d3f4bcbf", + "status": "complete" } }, { - "id": "example:keysend#3", - "method": "keysend", - "params": { + "request": { + "id": "example:keysend#3", + "method": "keysend", + "params": { + "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "amount_msat": 10000, + "routehints": [ + [ + { + "scid": "4615051x2233541x57738", + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "feebase": 1, + "feeprop": 10, + "expirydelta": 9 + } + ], + [ + { + "scid": "1x2x3", + "id": "020202020202020202020202020202020202020202020202020202020202020202", + "feebase": 1, + "feeprop": 1, + "expirydelta": 9 + } + ] + ] + } + }, + "response": { "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "payment_hash": "56e12e6f45120bef7385c9bf307319eaa6a1b9160cdb3e62a3f492abf5bfa4bc", + "created_at": 1708640437.2895157, + "parts": 1, "amount_msat": 10000, - "routehints": [ - [ - { - "scid": "4615051x2233541x57738", - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "feebase": 1, - "feeprop": 10, - "expirydelta": 9 - } - ], - [ - { - "scid": "1x2x3", - "id": "020202020202020202020202020202020202020202020202020202020202020202", - "feebase": 1, - "feeprop": 1, - "expirydelta": 9 - } - ] - ] + "amount_sent_msat": 10001, + "payment_preimage": "682870b8f96e2aed1c86694dbb2c3e64cd396b9bba9fafd824d90eb0bd371b85", + "status": "complete" } } ], - "example_json_response": [ - { - "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "payment_hash": "b6f88603008a9f7dd84b1b94c7b972c8efbaf0b86c8d3c04512955992da9028e", - "created_at": 1706315742.6861734, - "parts": 1, - "amount_msat": 10000, - "amount_sent_msat": 10001, - "payment_preimage": "7178cf708e34dce816fc35aa692a65e1f85b92ae03bbc8ae6543302511823174", - "status": "complete" - }, - { - "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "payment_hash": "e8474eea8d5673e8407ef5f4924e58479b51a68afd136384683d5d6a97c9520d", - "created_at": 1708640424.1810749, - "parts": 1, - "amount_msat": 10000000, - "amount_sent_msat": 10000000, - "payment_preimage": "40e47272ea7da20c57a2381d81a5513ec03bd8ead9d51fbd2a91ec76d3f4bcbf", - "status": "complete" - }, - { - "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "payment_hash": "56e12e6f45120bef7385c9bf307319eaa6a1b9160cdb3e62a3f492abf5bfa4bc", - "created_at": 1708640437.2895157, - "parts": 1, - "amount_msat": 10000, - "amount_sent_msat": 10001, - "payment_preimage": "682870b8f96e2aed1c86694dbb2c3e64cd396b9bba9fafd824d90eb0bd371b85", - "status": "complete" - } - ], "author": [ "Christian Decker <> is mainly responsible." ], diff --git a/doc/schemas/lightning-listchannels.json b/doc/schemas/lightning-listchannels.json index cce3488ec0ab..4ba307f56a02 100644 --- a/doc/schemas/lightning-listchannels.json +++ b/doc/schemas/lightning-listchannels.json @@ -169,69 +169,71 @@ "", "- -32602: If the given parameters are wrong." ], - "example_json_request": [ + "json_example": [ { - "id": "example:listchannels#1", - "method": "listchannels", - "params": { - "short_channel_id": "103x1x0", - "source": null, - "destination": null + "request": { + "id": "example:listchannels#1", + "method": "listchannels", + "params": { + "short_channel_id": "103x1x0", + "source": null, + "destination": null + } + }, + "response": { + "channels": [] } }, { - "id": "example:listchannels#2", - "method": "listchannels", - "params": { - "short_channel_id": null, - "source": null, - "destination": null - } - } - ], - "example_json_response": [ - { - "channels": [] - }, - { - "channels": [ - { - "source": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "short_channel_id": "103x1x0", - "direction": 0, - "public": true, - "amount_msat": 1000000000, - "message_flags": 1, - "channel_flags": 0, - "active": true, - "last_update": 1706153393, - "base_fee_millisatoshi": 1, - "fee_per_millionth": 10, - "delay": 6, - "htlc_minimum_msat": 0, - "htlc_maximum_msat": 990000000, - "features": "" - }, - { - "source": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "short_channel_id": "103x1x0", - "direction": 1, - "public": true, - "amount_msat": 1000000000, - "message_flags": 1, - "channel_flags": 1, - "active": true, - "last_update": 1706153393, - "base_fee_millisatoshi": 1, - "fee_per_millionth": 10, - "delay": 6, - "htlc_minimum_msat": 0, - "htlc_maximum_msat": 990000000, - "features": "" + "request": { + "id": "example:listchannels#2", + "method": "listchannels", + "params": { + "short_channel_id": null, + "source": null, + "destination": null } - ] + }, + "response": { + "channels": [ + { + "source": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "short_channel_id": "103x1x0", + "direction": 0, + "public": true, + "amount_msat": 1000000000, + "message_flags": 1, + "channel_flags": 0, + "active": true, + "last_update": 1706153393, + "base_fee_millisatoshi": 1, + "fee_per_millionth": 10, + "delay": 6, + "htlc_minimum_msat": 0, + "htlc_maximum_msat": 990000000, + "features": "" + }, + { + "source": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "short_channel_id": "103x1x0", + "direction": 1, + "public": true, + "amount_msat": 1000000000, + "message_flags": 1, + "channel_flags": 1, + "active": true, + "last_update": 1706153393, + "base_fee_millisatoshi": 1, + "fee_per_millionth": 10, + "delay": 6, + "htlc_minimum_msat": 0, + "htlc_maximum_msat": 990000000, + "features": "" + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-listconfigs.json b/doc/schemas/lightning-listconfigs.json index 2f0406f28147..2015f53f7d87 100644 --- a/doc/schemas/lightning-listconfigs.json +++ b/doc/schemas/lightning-listconfigs.json @@ -2436,26 +2436,458 @@ "- **value_bool** (boolean, optional): for boolean options" ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:listconfigs#1", - "method": "listconfigs", - "params": { - "config": "network" + "request": { + "id": "example:listconfigs#1", + "method": "listconfigs", + "params": { + "config": "network" + } + }, + "response": { + "#version": "v0.9.0-1", + "lightning-dir": "/media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev", + "network": "testnet", + "allow-deprecated-apis": true, + "rpc-file": "lightning-rpc", + "plugins": [ + { + "path": "/home/vincent/Github/plugins/sauron/sauron.py", + "name": "sauron.py", + "options": { + "sauron-api-endpoint": "http://blockstream.info/testnet/api/", + "sauron-tor-proxy": "" + } + }, + { + "path": "/home/vincent/Github/reckless/reckless.py", + "name": "reckless.py" + } + ], + "important-plugins": [ + { + "path": "/home/vincent/Github/lightning/lightningd/../plugins/autoclean", + "name": "autoclean", + "options": { + "autocleaninvoice-cycle": null, + "autocleaninvoice-expired-by": null + } + }, + { + "path": "/home/vincent/Github/lightning/lightningd/../plugins/fundchannel", + "name": "fundchannel" + }, + { + "path": "/home/vincent/Github/lightning/lightningd/../plugins/keysend", + "name": "keysend" + }, + { + "path": "/home/vincent/Github/lightning/lightningd/../plugins/pay", + "name": "pay", + "options": { + "disable-mpp": false + } + } + ], + "important-plugin": "/home/vincent/Github/lightning/lightningd/../plugins/pay", + "plugin": "/home/vincent/Github/reckless/reckless.py", + "disable-plugin": [ + "bcli" + ], + "always-use-proxy": false, + "daemon": "false", + "wallet": "sqlite3:///media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev/testnet/lightningd.sqlite3", + "wumbo": true, + "rgb": "03ad98", + "alias": "BRUCEWAYN-TES-DEV", + "pid-file": "/media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev/lightningd-testne...", + "ignore-fee-limits": true, + "watchtime-blocks": 6, + "max-locktime-blocks": 2016, + "funding-confirms": 1, + "commit-fee-min": 0, + "commit-fee-max": 0, + "cltv-delta": 6, + "cltv-final": 10, + "commit-time": 10, + "fee-base": 1, + "rescan": 30, + "fee-per-satoshi": 10, + "max-concurrent-htlcs": 483, + "min-capacity-sat": 10000, + "addr": "autotor:127.0.0.1:9051", + "bind-addr": "127.0.0.1:9735", + "announce-addr": "fp463inc4w3lamhhduytrwdwq6q6uzugtaeapylqfc43agrdnnqsheyd.onion:9735", + "offline": "false", + "autolisten": true, + "proxy": "127.0.0.1:9050", + "disable-dns": "false", + "encrypted-hsm": false, + "rpc-file-mode": "0600", + "log-level": "DEBUG", + "log-prefix": "lightningd" } }, { - "id": "example:listconfigs#2", - "method": "listconfigs", - "params": { - "config": null + "request": { + "id": "example:listconfigs#2", + "method": "listconfigs", + "params": { + "config": null + } + }, + "response": { + "configs": { + "developer": { + "set": true, + "source": "cmdline" + }, + "lightning-dir": { + "value_str": "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/", + "source": "cmdline" + }, + "network": { + "value_str": "regtest", + "source": "cmdline" + }, + "testnet": { + "set": false, + "source": "default" + }, + "signet": { + "set": false, + "source": "default" + }, + "mainnet": { + "set": false, + "source": "default" + }, + "regtest": { + "set": false, + "source": "default" + }, + "rpc-file": { + "value_str": "lightning-rpc", + "source": "default" + }, + "allow-deprecated-apis": { + "value_bool": false, + "source": "cmdline" + }, + "plugin": { + "values_str": [ + "~/lightning/target/debug/examples/cln-plugin-startup" + ], + "sources": [ + "cmdline" + ] + }, + "plugin-dir": { + "values_str": [], + "sources": [] + }, + "clear-plugins": { + "set": false, + "source": "default" + }, + "disable-plugin": { + "values_str": [], + "sources": [] + }, + "important-plugin": { + "values_str": [], + "sources": [] + }, + "always-use-proxy": { + "value_bool": false, + "source": "default" + }, + "daemon": { + "set": false, + "source": "default" + }, + "experimental-dual-fund": { + "set": false, + "source": "default" + }, + "experimental-splicing": { + "set": false, + "source": "default" + }, + "experimental-onion-messages": { + "set": false, + "source": "default" + }, + "experimental-offers": { + "set": false, + "source": "default" + }, + "experimental-shutdown-wrong-funding": { + "set": false, + "source": "default" + }, + "experimental-peer-storage": { + "set": false, + "source": "default" + }, + "experimental-quiesce": { + "set": false, + "source": "default" + }, + "experimental-anchors": { + "set": false, + "source": "default" + }, + "rgb": { + "value_str": "0266e4", + "source": "default" + }, + "alias": { + "value_str": "JUNIORBEAM-1-102-g7549e10-modded", + "source": "default" + }, + "pid-file": { + "value_str": "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/lightningd-regtest.pid", + "source": "default" + }, + "ignore-fee-limits": { + "value_bool": false, + "source": "cmdline" + }, + "watchtime-blocks": { + "value_int": 5, + "source": "cmdline" + }, + "max-locktime-blocks": { + "value_int": 2016, + "source": "default" + }, + "funding-confirms": { + "value_int": 1, + "source": "default" + }, + "require-confirmed-inputs": { + "value_bool": false, + "source": "default" + }, + "cltv-delta": { + "value_int": 6, + "source": "cmdline" + }, + "cltv-final": { + "value_int": 5, + "source": "cmdline" + }, + "commit-time": { + "value_int": 10, + "source": "default" + }, + "fee-base": { + "value_int": 1, + "source": "default" + }, + "rescan": { + "value_int": 1, + "source": "cmdline" + }, + "fee-per-satoshi": { + "value_int": 10, + "source": "default" + }, + "htlc-minimum-msat": { + "value_msat": 0, + "source": "default" + }, + "htlc-maximum-msat": { + "value_msat": 18446744073709552000, + "source": "default" + }, + "max-concurrent-htlcs": { + "value_int": 483, + "source": "default" + }, + "max-dust-htlc-exposure-msat": { + "value_msat": 50000000, + "source": "default" + }, + "min-capacity-sat": { + "value_int": 10000, + "source": "default", + "dynamic": true + }, + "addr": { + "values_str": [ + "127.0.0.1:33157" + ], + "sources": [ + "cmdline" + ] + }, + "bind-addr": { + "values_str": [], + "sources": [] + }, + "announce-addr": { + "values_str": [], + "sources": [] + }, + "announce-addr-discovered": { + "value_str": "auto", + "source": "default" + }, + "announce-addr-discovered-port": { + "value_int": 19846, + "source": "default" + }, + "offline": { + "set": false, + "source": "default" + }, + "autolisten": { + "value_bool": false, + "source": "default" + }, + "accept-htlc-tlv-type": { + "values_int": [], + "sources": [] + }, + "disable-dns": { + "set": true, + "source": "cmdline" + }, + "encrypted-hsm": { + "set": false, + "source": "default" + }, + "rpc-file-mode": { + "value_str": "0600", + "source": "default" + }, + "commit-fee": { + "value_int": 100, + "source": "default" + }, + "commit-feerate-offset": { + "value_int": 5, + "source": "default" + }, + "min-emergency-msat": { + "value_msat": 25000000, + "source": "default" + }, + "subdaemon": { + "values_str": [], + "sources": [] + }, + "experimental-upgrade-protocol": { + "set": false, + "source": "default" + }, + "invoices-onchain-fallback": { + "set": false, + "source": "default" + }, + "log-level": { + "value_str": "debug", + "source": "cmdline" + }, + "log-timestamps": { + "value_bool": true, + "source": "default" + }, + "log-prefix": { + "value_str": "lightningd-1 ", + "source": "cmdline" + }, + "log-file": { + "values_str": [ + "-", + "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/log" + ], + "sources": [ + "cmdline", + "cmdline" + ] + }, + "dev-no-plugin-checksum": { + "set": true, + "source": "cmdline" + }, + "dev-no-reconnect": { + "set": true, + "source": "cmdline" + }, + "dev-fail-on-subdaemon-fail": { + "set": true, + "source": "cmdline" + }, + "dev-bitcoind-poll": { + "value_int": 1, + "source": "cmdline" + }, + "dev-fast-gossip": { + "set": true, + "source": "cmdline" + }, + "renepay-debug-mcf": { + "set": false, + "source": "default", + "plugin": "~/lightning/plugins/cln-renepay" + }, + "renepay-debug-payflow": { + "set": false, + "source": "default", + "plugin": "~/lightning/plugins/cln-renepay" + }, + "test-option": { + "value_int": 31337, + "source": "cmdline", + "plugin": "~/lightning/target/debug/examples/cln-plugin-startup" + }, + "bitcoin-datadir": { + "value_str": "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/", + "source": "cmdline", + "plugin": "~/lightning/plugins/bcli" + }, + "bitcoin-rpcuser": { + "value_str": "rpcuser", + "source": "cmdline", + "plugin": "~/lightning/plugins/bcli" + }, + "bitcoin-rpcpassword": { + "value_str": "rpcpass", + "source": "cmdline", + "plugin": "~/lightning/plugins/bcli" + }, + "bitcoin-rpcport": { + "value_int": 51309, + "source": "cmdline", + "plugin": "~/lightning/plugins/bcli" + }, + "disable-mpp": { + "set": false, + "source": "default", + "plugin": "~/lightning/plugins/pay" + } + } } }, { - "id": "example:listconfigs#3", - "method": "listconfigs", - "params": { - "config": "experimental-dual-fund" + "request": { + "id": "example:listconfigs#3", + "method": "listconfigs", + "params": { + "config": "experimental-dual-fund" + } + }, + "response": { + "configs": { + "experimental-dual-fund": { + "set": false, + "source": "default" + } + } } } ], @@ -2464,434 +2896,6 @@ "", "- -32602: Error in given parameters or field with *config* name doesn't exist." ], - "example_json_response": [ - { - "#version": "v0.9.0-1", - "lightning-dir": "/media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev", - "network": "testnet", - "allow-deprecated-apis": true, - "rpc-file": "lightning-rpc", - "plugins": [ - { - "path": "/home/vincent/Github/plugins/sauron/sauron.py", - "name": "sauron.py", - "options": { - "sauron-api-endpoint": "http://blockstream.info/testnet/api/", - "sauron-tor-proxy": "" - } - }, - { - "path": "/home/vincent/Github/reckless/reckless.py", - "name": "reckless.py" - } - ], - "important-plugins": [ - { - "path": "/home/vincent/Github/lightning/lightningd/../plugins/autoclean", - "name": "autoclean", - "options": { - "autocleaninvoice-cycle": null, - "autocleaninvoice-expired-by": null - } - }, - { - "path": "/home/vincent/Github/lightning/lightningd/../plugins/fundchannel", - "name": "fundchannel" - }, - { - "path": "/home/vincent/Github/lightning/lightningd/../plugins/keysend", - "name": "keysend" - }, - { - "path": "/home/vincent/Github/lightning/lightningd/../plugins/pay", - "name": "pay", - "options": { - "disable-mpp": false - } - } - ], - "important-plugin": "/home/vincent/Github/lightning/lightningd/../plugins/pay", - "plugin": "/home/vincent/Github/reckless/reckless.py", - "disable-plugin": [ - "bcli" - ], - "always-use-proxy": false, - "daemon": "false", - "wallet": "sqlite3:///media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev/testnet/lightningd.sqlite3", - "wumbo": true, - "rgb": "03ad98", - "alias": "BRUCEWAYN-TES-DEV", - "pid-file": "/media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev/lightningd-testne...", - "ignore-fee-limits": true, - "watchtime-blocks": 6, - "max-locktime-blocks": 2016, - "funding-confirms": 1, - "commit-fee-min": 0, - "commit-fee-max": 0, - "cltv-delta": 6, - "cltv-final": 10, - "commit-time": 10, - "fee-base": 1, - "rescan": 30, - "fee-per-satoshi": 10, - "max-concurrent-htlcs": 483, - "min-capacity-sat": 10000, - "addr": "autotor:127.0.0.1:9051", - "bind-addr": "127.0.0.1:9735", - "announce-addr": "fp463inc4w3lamhhduytrwdwq6q6uzugtaeapylqfc43agrdnnqsheyd.onion:9735", - "offline": "false", - "autolisten": true, - "proxy": "127.0.0.1:9050", - "disable-dns": "false", - "encrypted-hsm": false, - "rpc-file-mode": "0600", - "log-level": "DEBUG", - "log-prefix": "lightningd" - }, - { - "configs": { - "developer": { - "set": true, - "source": "cmdline" - }, - "lightning-dir": { - "value_str": "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/", - "source": "cmdline" - }, - "network": { - "value_str": "regtest", - "source": "cmdline" - }, - "testnet": { - "set": false, - "source": "default" - }, - "signet": { - "set": false, - "source": "default" - }, - "mainnet": { - "set": false, - "source": "default" - }, - "regtest": { - "set": false, - "source": "default" - }, - "rpc-file": { - "value_str": "lightning-rpc", - "source": "default" - }, - "allow-deprecated-apis": { - "value_bool": false, - "source": "cmdline" - }, - "plugin": { - "values_str": [ - "~/lightning/target/debug/examples/cln-plugin-startup" - ], - "sources": [ - "cmdline" - ] - }, - "plugin-dir": { - "values_str": [], - "sources": [] - }, - "clear-plugins": { - "set": false, - "source": "default" - }, - "disable-plugin": { - "values_str": [], - "sources": [] - }, - "important-plugin": { - "values_str": [], - "sources": [] - }, - "always-use-proxy": { - "value_bool": false, - "source": "default" - }, - "daemon": { - "set": false, - "source": "default" - }, - "experimental-dual-fund": { - "set": false, - "source": "default" - }, - "experimental-splicing": { - "set": false, - "source": "default" - }, - "experimental-onion-messages": { - "set": false, - "source": "default" - }, - "experimental-offers": { - "set": false, - "source": "default" - }, - "experimental-shutdown-wrong-funding": { - "set": false, - "source": "default" - }, - "experimental-peer-storage": { - "set": false, - "source": "default" - }, - "experimental-quiesce": { - "set": false, - "source": "default" - }, - "experimental-anchors": { - "set": false, - "source": "default" - }, - "rgb": { - "value_str": "0266e4", - "source": "default" - }, - "alias": { - "value_str": "JUNIORBEAM-1-102-g7549e10-modded", - "source": "default" - }, - "pid-file": { - "value_str": "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/lightningd-regtest.pid", - "source": "default" - }, - "ignore-fee-limits": { - "value_bool": false, - "source": "cmdline" - }, - "watchtime-blocks": { - "value_int": 5, - "source": "cmdline" - }, - "max-locktime-blocks": { - "value_int": 2016, - "source": "default" - }, - "funding-confirms": { - "value_int": 1, - "source": "default" - }, - "require-confirmed-inputs": { - "value_bool": false, - "source": "default" - }, - "cltv-delta": { - "value_int": 6, - "source": "cmdline" - }, - "cltv-final": { - "value_int": 5, - "source": "cmdline" - }, - "commit-time": { - "value_int": 10, - "source": "default" - }, - "fee-base": { - "value_int": 1, - "source": "default" - }, - "rescan": { - "value_int": 1, - "source": "cmdline" - }, - "fee-per-satoshi": { - "value_int": 10, - "source": "default" - }, - "htlc-minimum-msat": { - "value_msat": 0, - "source": "default" - }, - "htlc-maximum-msat": { - "value_msat": 18446744073709552000, - "source": "default" - }, - "max-concurrent-htlcs": { - "value_int": 483, - "source": "default" - }, - "max-dust-htlc-exposure-msat": { - "value_msat": 50000000, - "source": "default" - }, - "min-capacity-sat": { - "value_int": 10000, - "source": "default", - "dynamic": true - }, - "addr": { - "values_str": [ - "127.0.0.1:33157" - ], - "sources": [ - "cmdline" - ] - }, - "bind-addr": { - "values_str": [], - "sources": [] - }, - "announce-addr": { - "values_str": [], - "sources": [] - }, - "announce-addr-discovered": { - "value_str": "auto", - "source": "default" - }, - "announce-addr-discovered-port": { - "value_int": 19846, - "source": "default" - }, - "offline": { - "set": false, - "source": "default" - }, - "autolisten": { - "value_bool": false, - "source": "default" - }, - "accept-htlc-tlv-type": { - "values_int": [], - "sources": [] - }, - "disable-dns": { - "set": true, - "source": "cmdline" - }, - "encrypted-hsm": { - "set": false, - "source": "default" - }, - "rpc-file-mode": { - "value_str": "0600", - "source": "default" - }, - "commit-fee": { - "value_int": 100, - "source": "default" - }, - "commit-feerate-offset": { - "value_int": 5, - "source": "default" - }, - "min-emergency-msat": { - "value_msat": 25000000, - "source": "default" - }, - "subdaemon": { - "values_str": [], - "sources": [] - }, - "experimental-upgrade-protocol": { - "set": false, - "source": "default" - }, - "invoices-onchain-fallback": { - "set": false, - "source": "default" - }, - "log-level": { - "value_str": "debug", - "source": "cmdline" - }, - "log-timestamps": { - "value_bool": true, - "source": "default" - }, - "log-prefix": { - "value_str": "lightningd-1 ", - "source": "cmdline" - }, - "log-file": { - "values_str": [ - "-", - "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/log" - ], - "sources": [ - "cmdline", - "cmdline" - ] - }, - "dev-no-plugin-checksum": { - "set": true, - "source": "cmdline" - }, - "dev-no-reconnect": { - "set": true, - "source": "cmdline" - }, - "dev-fail-on-subdaemon-fail": { - "set": true, - "source": "cmdline" - }, - "dev-bitcoind-poll": { - "value_int": 1, - "source": "cmdline" - }, - "dev-fast-gossip": { - "set": true, - "source": "cmdline" - }, - "renepay-debug-mcf": { - "set": false, - "source": "default", - "plugin": "~/lightning/plugins/cln-renepay" - }, - "renepay-debug-payflow": { - "set": false, - "source": "default", - "plugin": "~/lightning/plugins/cln-renepay" - }, - "test-option": { - "value_int": 31337, - "source": "cmdline", - "plugin": "~/lightning/target/debug/examples/cln-plugin-startup" - }, - "bitcoin-datadir": { - "value_str": "/tmp/ltests-giwf5tc7/test_plugin_start_1/lightning-1/", - "source": "cmdline", - "plugin": "~/lightning/plugins/bcli" - }, - "bitcoin-rpcuser": { - "value_str": "rpcuser", - "source": "cmdline", - "plugin": "~/lightning/plugins/bcli" - }, - "bitcoin-rpcpassword": { - "value_str": "rpcpass", - "source": "cmdline", - "plugin": "~/lightning/plugins/bcli" - }, - "bitcoin-rpcport": { - "value_int": 51309, - "source": "cmdline", - "plugin": "~/lightning/plugins/bcli" - }, - "disable-mpp": { - "set": false, - "source": "default", - "plugin": "~/lightning/plugins/pay" - } - } - }, - { - "configs": { - "experimental-dual-fund": { - "set": false, - "source": "default" - } - } - } - ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." diff --git a/doc/schemas/lightning-listdatastore.json b/doc/schemas/lightning-listdatastore.json index 6517ddef8dcc..726afb88c5d6 100644 --- a/doc/schemas/lightning-listdatastore.json +++ b/doc/schemas/lightning-listdatastore.json @@ -81,39 +81,41 @@ "", "- -32602: invalid parameters." ], - "example_json_request": [ + "json_example": [ { - "id": "example:listdatastore#1", - "method": "listdatastore", - "params": { - "key": [ - "commando" - ] - } - }, - { - "id": "example:listdatastore#2", - "method": "listdatastore", - "params": { - "key": "otherkey" + "request": { + "id": "example:listdatastore#1", + "method": "listdatastore", + "params": { + "key": [ + "commando" + ] + } + }, + "response": { + "datastore": [] } - } - ], - "example_json_response": [ - { - "datastore": [] }, { - "datastore": [ - { - "key": [ - "otherkey" - ], - "generation": 0, - "hex": "6f7468657264617461", - "string": "otherdata" + "request": { + "id": "example:listdatastore#2", + "method": "listdatastore", + "params": { + "key": "otherkey" } - ] + }, + "response": { + "datastore": [ + { + "key": [ + "otherkey" + ], + "generation": 0, + "hex": "6f7468657264617461", + "string": "otherdata" + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-listforwards.json b/doc/schemas/lightning-listforwards.json index 5a1d3aa6fb89..3784ef74c6b7 100644 --- a/doc/schemas/lightning-listforwards.json +++ b/doc/schemas/lightning-listforwards.json @@ -362,82 +362,84 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:listforwards#1", - "method": "listforwards", - "params": { - "status": null, - "in_channel": null, - "out_channel": null, - "index": null, - "start": null, - "limit": null + "request": { + "id": "example:listforwards#1", + "method": "listforwards", + "params": { + "status": null, + "in_channel": null, + "out_channel": null, + "index": null, + "start": null, + "limit": null + } + }, + "response": { + "forwards": [ + { + "created_index": 1, + "updated_index": 1, + "in_channel": "103x1x0", + "in_htlc_id": 0, + "out_channel": "104x1x0", + "out_htlc_id": 0, + "in_msat": 100001001, + "out_msat": 100000000, + "fee_msat": 1001, + "status": "settled", + "style": "tlv", + "received_time": 1706229285.5934534, + "resolved_time": 1706229288.830004 + }, + { + "created_index": 2, + "updated_index": 2, + "in_channel": "103x1x0", + "in_htlc_id": 1, + "out_channel": "105x1x0", + "out_htlc_id": 0, + "in_msat": 100001001, + "out_msat": 100000000, + "fee_msat": 1001, + "status": "failed", + "style": "tlv", + "received_time": 1706229290.0289993, + "resolved_time": 1706229292.9487684 + }, + { + "created_index": 3, + "updated_index": 3, + "in_channel": "103x1x0", + "in_htlc_id": 2, + "out_channel": "106x1x0", + "out_htlc_id": 0, + "in_msat": 100001000, + "out_msat": 99999999, + "fee_msat": 1001, + "status": "local_failed", + "failcode": 16392, + "failreason": "WIRE_PERMANENT_CHANNEL_FAILURE", + "style": "tlv", + "received_time": 1706229295.3175724 + } + ] } }, { - "id": "example:listforwards#2", - "method": "listforwards", - "params": { - "in_channel": "0x1x2", - "out_channel": "0x2x3", - "status": "settled" - } - } - ], - "example_json_response": [ - { - "forwards": [ - { - "created_index": 1, - "updated_index": 1, - "in_channel": "103x1x0", - "in_htlc_id": 0, - "out_channel": "104x1x0", - "out_htlc_id": 0, - "in_msat": 100001001, - "out_msat": 100000000, - "fee_msat": 1001, - "status": "settled", - "style": "tlv", - "received_time": 1706229285.5934534, - "resolved_time": 1706229288.830004 - }, - { - "created_index": 2, - "updated_index": 2, - "in_channel": "103x1x0", - "in_htlc_id": 1, - "out_channel": "105x1x0", - "out_htlc_id": 0, - "in_msat": 100001001, - "out_msat": 100000000, - "fee_msat": 1001, - "status": "failed", - "style": "tlv", - "received_time": 1706229290.0289993, - "resolved_time": 1706229292.9487684 - }, - { - "created_index": 3, - "updated_index": 3, - "in_channel": "103x1x0", - "in_htlc_id": 2, - "out_channel": "106x1x0", - "out_htlc_id": 0, - "in_msat": 100001000, - "out_msat": 99999999, - "fee_msat": 1001, - "status": "local_failed", - "failcode": 16392, - "failreason": "WIRE_PERMANENT_CHANNEL_FAILURE", - "style": "tlv", - "received_time": 1706229295.3175724 + "request": { + "id": "example:listforwards#2", + "method": "listforwards", + "params": { + "in_channel": "0x1x2", + "out_channel": "0x2x3", + "status": "settled" } - ] - }, - { - "forwards": [] + }, + "response": { + "forwards": [] + } } ], "author": [ diff --git a/doc/schemas/lightning-listfunds.json b/doc/schemas/lightning-listfunds.json index 1d4d2e56aeb4..147ce9dc0851 100644 --- a/doc/schemas/lightning-listfunds.json +++ b/doc/schemas/lightning-listfunds.json @@ -329,40 +329,40 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:listfunds#1", - "method": "listfunds", - "params": { - "spent": null - } - } - ], - "example_json_response": [ - { - "outputs": [ - { - "txid": "0f184b101569bf777af3449fa266948a9d55768f97867e48416a2c92858dd1bc", - "output": 1, - "amount_msat": 1111111000, - "scriptpubkey": "001401fad90abcd66697e2592164722de4a95ebee165", - "address": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf", - "status": "confirmed", - "blockheight": 102, - "reserved": false - }, - { - "txid": "4bee7dc3a28f2434e9bb3e9aaab418dd276485a8705b0f787bf741d3f979ec3b", - "output": 1, - "amount_msat": 1111111000, - "scriptpubkey": "001401fad90abcd66697e2592164722de4a95ebee165", - "address": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf", - "status": "confirmed", - "blockheight": 102, - "reserved": false + "request": { + "id": "example:listfunds#1", + "method": "listfunds", + "params": { + "spent": null } - ], - "channels": [] + }, + "response": { + "outputs": [ + { + "txid": "0f184b101569bf777af3449fa266948a9d55768f97867e48416a2c92858dd1bc", + "output": 1, + "amount_msat": 1111111000, + "scriptpubkey": "001401fad90abcd66697e2592164722de4a95ebee165", + "address": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf", + "status": "confirmed", + "blockheight": 102, + "reserved": false + }, + { + "txid": "4bee7dc3a28f2434e9bb3e9aaab418dd276485a8705b0f787bf741d3f979ec3b", + "output": 1, + "amount_msat": 1111111000, + "scriptpubkey": "001401fad90abcd66697e2592164722de4a95ebee165", + "address": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf", + "status": "confirmed", + "blockheight": 102, + "reserved": false + } + ], + "channels": [] + } } ], "author": [ diff --git a/doc/schemas/lightning-listhtlcs.json b/doc/schemas/lightning-listhtlcs.json index 6d47c1cfc2db..5c47eab42ab1 100644 --- a/doc/schemas/lightning-listhtlcs.json +++ b/doc/schemas/lightning-listhtlcs.json @@ -111,138 +111,142 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:listhtlcs#1", - "method": "listhtlcs", - "params": "{}" - }, - { - "id": "example:listhtlcs#2", - "method": "listhtlcs", - "params": [ - "103x2x0" - ] - }, - { - "id": "example:listhtlcs#3", - "method": "listhtlcs", - "params": [ - "436c2658eb4f4689b42ff11b8b05f31ba09860d0df7168085e0796cdf40f85e0" - ] - } - ], - "example_json_response": [ - { - "htlcs": [ - { - "short_channel_id": "103x1x0", - "id": 0, - "expiry": 117, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "d2668e77c5a2220496e813de36f1fc09ba804b16af4c6bb38299d8a6eb8a5f10", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x1x0", - "id": 1, - "expiry": 117, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "286e08ac8f575f10508d751fcfc93871b4344271967c7b9e5eacb3f3573b8307", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x1x0", - "id": 2, - "expiry": 135, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "3e4baa750ee3dfb934578f041ccb40b87432bf37ec65c9d7bce5ff28fecbd95f", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x1x0", - "id": 3, - "expiry": 135, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "4c3ce32565dc10ef2bd230c32802ce2fe8b007208c0a90757aa289f75c994d49", - "state": "SENT_REMOVE_REVOCATION" - } - ] + "request": { + "id": "example:listhtlcs#1", + "method": "listhtlcs", + "params": "{}" + }, + "response": { + "htlcs": [ + { + "short_channel_id": "103x1x0", + "id": 0, + "expiry": 117, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "d2668e77c5a2220496e813de36f1fc09ba804b16af4c6bb38299d8a6eb8a5f10", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x1x0", + "id": 1, + "expiry": 117, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "286e08ac8f575f10508d751fcfc93871b4344271967c7b9e5eacb3f3573b8307", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x1x0", + "id": 2, + "expiry": 135, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "3e4baa750ee3dfb934578f041ccb40b87432bf37ec65c9d7bce5ff28fecbd95f", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x1x0", + "id": 3, + "expiry": 135, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "4c3ce32565dc10ef2bd230c32802ce2fe8b007208c0a90757aa289f75c994d49", + "state": "SENT_REMOVE_REVOCATION" + } + ] + } }, { - "htlcs": [ - { - "short_channel_id": "103x2x0", - "id": 0, - "expiry": 117, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "12bb14b1d119e1ae0759e5ff6f1f6653e3fd8f71ea59411500d2871404a47a98", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x2x0", - "id": 1, - "expiry": 117, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "57d950209cc0b4fcc5e3027569232f96cf83ef85314c6b139a5713848d811a66", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x2x0", - "id": 2, - "expiry": 135, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "45ad4654715411a07a0ad6ec3f4bfaa918c90e3d1934b10b1c1c5846523ddd7f", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x2x0", - "id": 3, - "expiry": 135, - "direction": "out", - "amount_msat": 100001001, - "payment_hash": "cc0dcd214aa71c62bfba711a0746da821f2cdba1770b11c225920bdde12c931e", - "state": "RCVD_REMOVE_ACK_REVOCATION" - } - ] + "request": { + "id": "example:listhtlcs#2", + "method": "listhtlcs", + "params": [ + "103x2x0" + ] + }, + "response": { + "htlcs": [ + { + "short_channel_id": "103x2x0", + "id": 0, + "expiry": 117, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "12bb14b1d119e1ae0759e5ff6f1f6653e3fd8f71ea59411500d2871404a47a98", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x2x0", + "id": 1, + "expiry": 117, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "57d950209cc0b4fcc5e3027569232f96cf83ef85314c6b139a5713848d811a66", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x2x0", + "id": 2, + "expiry": 135, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "45ad4654715411a07a0ad6ec3f4bfaa918c90e3d1934b10b1c1c5846523ddd7f", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x2x0", + "id": 3, + "expiry": 135, + "direction": "out", + "amount_msat": 100001001, + "payment_hash": "cc0dcd214aa71c62bfba711a0746da821f2cdba1770b11c225920bdde12c931e", + "state": "RCVD_REMOVE_ACK_REVOCATION" + } + ] + } }, { - "htlcs": [ - { - "short_channel_id": "103x1x0", - "id": 0, - "expiry": 124, - "direction": "out", - "amount_msat": 1001, - "payment_hash": "2ab653668c8017ff2f36ac36678a8da04e11380bd9580a2926b170523b0c6e3b", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x1x0", - "id": 1, - "expiry": 124, - "direction": "out", - "amount_msat": 2001, - "payment_hash": "92f889cb2e48aa28e1e577228b907cdbcc371a2c018e9c8f60fa7036e232cf1d", - "state": "RCVD_REMOVE_ACK_REVOCATION" - }, - { - "short_channel_id": "103x1x0", - "id": 2, - "expiry": 128, - "direction": "out", - "amount_msat": 4001, - "payment_hash": "14ef01c9fb12d7dcac288f48ce87b19a7d5c3d5779aaed1e4adcb5c5d0e9fa45", - "state": "RCVD_REMOVE_ACK_REVOCATION" - } - ] + "request": { + "id": "example:listhtlcs#3", + "method": "listhtlcs", + "params": [ + "436c2658eb4f4689b42ff11b8b05f31ba09860d0df7168085e0796cdf40f85e0" + ] + }, + "response": { + "htlcs": [ + { + "short_channel_id": "103x1x0", + "id": 0, + "expiry": 124, + "direction": "out", + "amount_msat": 1001, + "payment_hash": "2ab653668c8017ff2f36ac36678a8da04e11380bd9580a2926b170523b0c6e3b", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x1x0", + "id": 1, + "expiry": 124, + "direction": "out", + "amount_msat": 2001, + "payment_hash": "92f889cb2e48aa28e1e577228b907cdbcc371a2c018e9c8f60fa7036e232cf1d", + "state": "RCVD_REMOVE_ACK_REVOCATION" + }, + { + "short_channel_id": "103x1x0", + "id": 2, + "expiry": 128, + "direction": "out", + "amount_msat": 4001, + "payment_hash": "14ef01c9fb12d7dcac288f48ce87b19a7d5c3d5779aaed1e4adcb5c5d0e9fa45", + "state": "RCVD_REMOVE_ACK_REVOCATION" + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-listinvoicerequests.json b/doc/schemas/lightning-listinvoicerequests.json index 64b0228adc37..ca3e95c55149 100644 --- a/doc/schemas/lightning-listinvoicerequests.json +++ b/doc/schemas/lightning-listinvoicerequests.json @@ -85,26 +85,26 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:listinvoicerequests#1", - "method": "listinvoicerequests", - "params": [ - "cf0b41d4eb248d975909deb9accf9722b1c86839de80ee8815ce907bbb700a1d" - ] - } - ], - "example_json_response": [ - { - "invoicerequests": [ - { - "invreq_id": "cf0b41d4eb248d975909deb9accf9722b1c86839de80ee8815ce907bbb700a1d", - "active": true, - "single_use": true, - "bolt12": "lnr1qqgx9ag7nmtns87htndlgcfndlq0wzstwd5k6urvv5s8getnw3gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02gzqta0pqpvzzqnxu3vc68fug904w25y3zpskc8huazwmy34av93h2fjswe3tsp4rrcyps5sf5jwnn2tr3ghn32mdta8jvax62pwzhna8sktmaezl3f4s3zy35gx6dfay7r8zn299uwr7ugpze74zft4m8q3fnk2sr0ljqpve3jq", - "used": false - } - ] + "request": { + "id": "example:listinvoicerequests#1", + "method": "listinvoicerequests", + "params": [ + "cf0b41d4eb248d975909deb9accf9722b1c86839de80ee8815ce907bbb700a1d" + ] + }, + "response": { + "invoicerequests": [ + { + "invreq_id": "cf0b41d4eb248d975909deb9accf9722b1c86839de80ee8815ce907bbb700a1d", + "active": true, + "single_use": true, + "bolt12": "lnr1qqgx9ag7nmtns87htndlgcfndlq0wzstwd5k6urvv5s8getnw3gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02gzqta0pqpvzzqnxu3vc68fug904w25y3zpskc8huazwmy34av93h2fjswe3tsp4rrcyps5sf5jwnn2tr3ghn32mdta8jvax62pwzhna8sktmaezl3f4s3zy35gx6dfay7r8zn299uwr7ugpze74zft4m8q3fnk2sr0ljqpve3jq", + "used": false + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-listinvoices.json b/doc/schemas/lightning-listinvoices.json index 77fb3c2f5978..8769c7908243 100644 --- a/doc/schemas/lightning-listinvoices.json +++ b/doc/schemas/lightning-listinvoices.json @@ -287,37 +287,37 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:listinvoices#1", - "method": "listinvoices", - "params": { - "label": "xEoCR94SIz6UIRUEkxum", - "payment_hash": null, - "invstring": null, - "offer_id": null, - "index": null, - "start": null, - "limit": null - } - } - ], - "example_json_response": [ - { - "invoices": [ - { + "request": { + "id": "example:listinvoices#1", + "method": "listinvoices", + "params": { "label": "xEoCR94SIz6UIRUEkxum", - "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", - "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "amount_msat": 11000000, - "status": "unpaid", - "description": [ - "XEoCR94SIz6UIRUEkxum." - ], - "expires_at": 1706757730, - "created_index": 1 + "payment_hash": null, + "invstring": null, + "offer_id": null, + "index": null, + "start": null, + "limit": null } - ] + }, + "response": { + "invoices": [ + { + "label": "xEoCR94SIz6UIRUEkxum", + "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", + "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", + "amount_msat": 11000000, + "status": "unpaid", + "description": [ + "XEoCR94SIz6UIRUEkxum." + ], + "expires_at": 1706757730, + "created_index": 1 + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-listnodes.json b/doc/schemas/lightning-listnodes.json index 9829a649d1bd..e80c4e503e5b 100644 --- a/doc/schemas/lightning-listnodes.json +++ b/doc/schemas/lightning-listnodes.json @@ -244,76 +244,78 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:listnodes#1", - "method": "listnodes", - "params": { - "id": "02e29856dab8ddd9044c18486e4cab79ec717b490447af2d4831e290e48d57638a" - } - }, - { - "id": "example:listnodes#2", - "method": "listnodes", - "params": { - "id": null - } - } - ], - "example_json_response": [ - { - "nodes": [ - { - "nodeid": "02e29856dab8ddd9044c14586e4cab79ec717b490447af2d4831e290e48d58638a", - "alias": "some_alias", - "color": "68f442", - "last_timestamp": 1597213741, - "features": "02a2a1", - "addresses": [ - { - "type": "ipv4", - "address": "zzz.yy.xx.xx", - "port": 9735 - } - ] + "request": { + "id": "example:listnodes#1", + "method": "listnodes", + "params": { + "id": "02e29856dab8ddd9044c18486e4cab79ec717b490447af2d4831e290e48d57638a" } - ] + }, + "response": { + "nodes": [ + { + "nodeid": "02e29856dab8ddd9044c14586e4cab79ec717b490447af2d4831e290e48d58638a", + "alias": "some_alias", + "color": "68f442", + "last_timestamp": 1597213741, + "features": "02a2a1", + "addresses": [ + { + "type": "ipv4", + "address": "zzz.yy.xx.xx", + "port": 9735 + } + ] + } + ] + } }, { - "nodes": [ - { - "nodeid": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "alias": "SILENTARTIST-v23.11-415-gd120eba", - "color": "022d22", - "last_timestamp": 1708624765, - "features": "88a0000a8a5961", - "addresses": [] - }, - { - "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "alias": "JUNIORBEAM-v23.11-415-gd120eba", - "color": "0266e4", - "last_timestamp": 1708624765, - "features": "88a0000a8a5961", - "addresses": [] - }, - { - "nodeid": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "alias": "HOPPINGFIRE-v23.11-415-gd120eba", - "color": "035d2b", - "last_timestamp": 1708624765, - "features": "88a0000a8a5961", - "addresses": [] - }, - { - "nodeid": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", - "alias": "JUNIORFELONY-v23.11-415-gd120eba", - "color": "0382ce", - "last_timestamp": 1708624766, - "features": "88a0000a8a5961", - "addresses": [] + "request": { + "id": "example:listnodes#2", + "method": "listnodes", + "params": { + "id": null } - ] + }, + "response": { + "nodes": [ + { + "nodeid": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "alias": "SILENTARTIST-v23.11-415-gd120eba", + "color": "022d22", + "last_timestamp": 1708624765, + "features": "88a0000a8a5961", + "addresses": [] + }, + { + "nodeid": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "alias": "JUNIORBEAM-v23.11-415-gd120eba", + "color": "0266e4", + "last_timestamp": 1708624765, + "features": "88a0000a8a5961", + "addresses": [] + }, + { + "nodeid": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "alias": "HOPPINGFIRE-v23.11-415-gd120eba", + "color": "035d2b", + "last_timestamp": 1708624765, + "features": "88a0000a8a5961", + "addresses": [] + }, + { + "nodeid": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", + "alias": "JUNIORFELONY-v23.11-415-gd120eba", + "color": "0382ce", + "last_timestamp": 1708624766, + "features": "88a0000a8a5961", + "addresses": [] + } + ] + } } ], "errors": [ diff --git a/doc/schemas/lightning-listoffers.json b/doc/schemas/lightning-listoffers.json index a508f5626080..c9d46ddf14a0 100644 --- a/doc/schemas/lightning-listoffers.json +++ b/doc/schemas/lightning-listoffers.json @@ -84,51 +84,53 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:listoffers#1", - "method": "listoffers", - "params": { - "active_only": true - } - }, - { - "id": "example:listoffers#2", - "method": "listoffers", - "params": [ - "f61cca153d1948dade19349792d9bcdc9cef687fd27db0b553a67979f55aae48" - ] - } - ], - "example_json_response": [ - { - "offers": [ - { - "offer_id": "053a5c566fbea2681a5ff9c05a913da23e45b95d09ef5bd25d7d408f23da7084", - "active": true, - "single_use": false, - "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqvqcdgq2z9pk7enxv4jjqen0wgs8yatnw3ujz83qkc6rvp4j28rt3dtrn32zkvdy7efhnlrpr5rp5geqxs783wtlj550qs8czzku4nk3pqp6m593qxgunzuqcwkmgqkmp6ty0wyvjcqdguv3pnpukedwn6cr87m89t74h3auyaeg89xkvgzpac70z3m9rn5xzu28c", - "used": false - }, - { - "offer_id": "3247d3597fec19e362ca683416a48a0f76a44c1600725a7ee1936548feadacca", - "active": true, - "single_use": false, - "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcxqd24x3qgqgqlgzs3gdhkven9v5sxvmmjype82um50ys3ug9kxsmqdvj3c6ut2cuu2s4nrf8k2dulccgaqcdzxgp583utjlu49rcyqt8hc3s797umxn3r9367rdqc577rma7key58fywkajxnuzyapge86hj2pg80rjrma40xdqrxnsnva5l3ce7hz4ua8wf755dees4y9vnq", - "used": true + "request": { + "id": "example:listoffers#1", + "method": "listoffers", + "params": { + "active_only": true } - ] + }, + "response": { + "offers": [ + { + "offer_id": "053a5c566fbea2681a5ff9c05a913da23e45b95d09ef5bd25d7d408f23da7084", + "active": true, + "single_use": false, + "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqvqcdgq2z9pk7enxv4jjqen0wgs8yatnw3ujz83qkc6rvp4j28rt3dtrn32zkvdy7efhnlrpr5rp5geqxs783wtlj550qs8czzku4nk3pqp6m593qxgunzuqcwkmgqkmp6ty0wyvjcqdguv3pnpukedwn6cr87m89t74h3auyaeg89xkvgzpac70z3m9rn5xzu28c", + "used": false + }, + { + "offer_id": "3247d3597fec19e362ca683416a48a0f76a44c1600725a7ee1936548feadacca", + "active": true, + "single_use": false, + "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcxqd24x3qgqgqlgzs3gdhkven9v5sxvmmjype82um50ys3ug9kxsmqdvj3c6ut2cuu2s4nrf8k2dulccgaqcdzxgp583utjlu49rcyqt8hc3s797umxn3r9367rdqc577rma7key58fywkajxnuzyapge86hj2pg80rjrma40xdqrxnsnva5l3ce7hz4ua8wf755dees4y9vnq", + "used": true + } + ] + } }, { - "offers": [ - { - "offer_id": "f61cca153d1948dade19349792d9bcdc9cef687fd27db0b553a67979f55aae48", - "active": true, - "single_use": false, - "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqyqs5rn5v4ehggrxdaezqvtdwdshg93pqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq63s", - "used": false - } - ] + "request": { + "id": "example:listoffers#2", + "method": "listoffers", + "params": [ + "f61cca153d1948dade19349792d9bcdc9cef687fd27db0b553a67979f55aae48" + ] + }, + "response": { + "offers": [ + { + "offer_id": "f61cca153d1948dade19349792d9bcdc9cef687fd27db0b553a67979f55aae48", + "active": true, + "single_use": false, + "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqyqs5rn5v4ehggrxdaezqvtdwdshg93pqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq63s", + "used": false + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-listpays.json b/doc/schemas/lightning-listpays.json index 3aa707e97a33..97ad3acdbcaf 100644 --- a/doc/schemas/lightning-listpays.json +++ b/doc/schemas/lightning-listpays.json @@ -209,53 +209,55 @@ "The returned array is ordered by increasing **created_at** fields." ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:listpays#1", - "method": "listpays", - "params": { - "bolt11": "lnbcrt123n1pjmxp7qsp5hxu7u28y0nx4v689u3hwzdzse2w9yaylhheavf9dxvwtdup7pvespp5ha66gxse68j4n6755v7299dnmq4w34gp0znxu0xzahdc43zrg40qdq5v3jhxcmjd9c8g6t0dc6sxqrp7scqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqsqqqqqqqqpqqqqqzsqqc9qxpqysgqk74dvqlvr92ayy5s7x0r0u9xywez6wu4h8pfta386cw6x7cdrvn8pz87kyg5c930aent423gm9ylpaw5p35k72f02hg0s9dulg4d8fqpgj7gpm", - "payment_hash": null, - "status": null - } - }, - { - "id": "example:listpays#2", - "method": "listpays", - "params": { - "bolt11": "lnbcrt123n1pjmxp7qsp5u84368dz7yhzcqm955h96wdqch7uarasun45cr0vs5d8t0cv5avqpp5r9p0dp92guaatrmhf302m0dyj4n79gk93qu2l5tagfxq3dedgfqsdq5v3jhxcmjd9c8g6t0dc6qxqrp7scqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqsqqqqqqqqpqqqqqzsqqc9qxpqysgq46wu0fznfx27rcnyzhcttf8yqx3lwqs482yxlead0fyt8mefrrrj5m379fa5qukgquf9tnwsuj3nnfmwkzkfg6pyhzq6w8gauuh6m5cqgur64n", - "payment_hash": null, - "status": null - } - } - ], - "example_json_response": [ - { - "pays": [ - { + "request": { + "id": "example:listpays#1", + "method": "listpays", + "params": { "bolt11": "lnbcrt123n1pjmxp7qsp5hxu7u28y0nx4v689u3hwzdzse2w9yaylhheavf9dxvwtdup7pvespp5ha66gxse68j4n6755v7299dnmq4w34gp0znxu0xzahdc43zrg40qdq5v3jhxcmjd9c8g6t0dc6sxqrp7scqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqsqqqqqqqqpqqqqqzsqqc9qxpqysgqk74dvqlvr92ayy5s7x0r0u9xywez6wu4h8pfta386cw6x7cdrvn8pz87kyg5c930aent423gm9ylpaw5p35k72f02hg0s9dulg4d8fqpgj7gpm", - "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "payment_hash": "bf75a41a19d1e559ebd4a33ca295b3d82ae8d50178a66e3cc2eddb8ac443455e", - "status": "failed", - "created_at": 1706231854, - "amount_sent_msat": 0 + "payment_hash": null, + "status": null } - ] + }, + "response": { + "pays": [ + { + "bolt11": "lnbcrt123n1pjmxp7qsp5hxu7u28y0nx4v689u3hwzdzse2w9yaylhheavf9dxvwtdup7pvespp5ha66gxse68j4n6755v7299dnmq4w34gp0znxu0xzahdc43zrg40qdq5v3jhxcmjd9c8g6t0dc6sxqrp7scqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqsqqqqqqqqpqqqqqzsqqc9qxpqysgqk74dvqlvr92ayy5s7x0r0u9xywez6wu4h8pfta386cw6x7cdrvn8pz87kyg5c930aent423gm9ylpaw5p35k72f02hg0s9dulg4d8fqpgj7gpm", + "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "payment_hash": "bf75a41a19d1e559ebd4a33ca295b3d82ae8d50178a66e3cc2eddb8ac443455e", + "status": "failed", + "created_at": 1706231854, + "amount_sent_msat": 0 + } + ] + } }, { - "pays": [ - { + "request": { + "id": "example:listpays#2", + "method": "listpays", + "params": { "bolt11": "lnbcrt123n1pjmxp7qsp5u84368dz7yhzcqm955h96wdqch7uarasun45cr0vs5d8t0cv5avqpp5r9p0dp92guaatrmhf302m0dyj4n79gk93qu2l5tagfxq3dedgfqsdq5v3jhxcmjd9c8g6t0dc6qxqrp7scqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqsqqqqqqqqpqqqqqzsqqc9qxpqysgq46wu0fznfx27rcnyzhcttf8yqx3lwqs482yxlead0fyt8mefrrrj5m379fa5qukgquf9tnwsuj3nnfmwkzkfg6pyhzq6w8gauuh6m5cqgur64n", - "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "payment_hash": "1942f684aa473bd58f774c5eadbda49567e2a2c58838afd17d424c08b72d4241", - "status": "complete", - "created_at": 1706231849, - "completed_at": 1706231854, - "preimage": "89ce412a2089cbcb72a73ce755337cf693859ea58f21ef0d1caf286a9b0f2a7c", - "amount_msat": 12300, - "amount_sent_msat": 12301 + "payment_hash": null, + "status": null } - ] + }, + "response": { + "pays": [ + { + "bolt11": "lnbcrt123n1pjmxp7qsp5u84368dz7yhzcqm955h96wdqch7uarasun45cr0vs5d8t0cv5avqpp5r9p0dp92guaatrmhf302m0dyj4n79gk93qu2l5tagfxq3dedgfqsdq5v3jhxcmjd9c8g6t0dc6qxqrp7scqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqqvuqqqqsqqqqqqqqpqqqqqzsqqc9qxpqysgq46wu0fznfx27rcnyzhcttf8yqx3lwqs482yxlead0fyt8mefrrrj5m379fa5qukgquf9tnwsuj3nnfmwkzkfg6pyhzq6w8gauuh6m5cqgur64n", + "destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "payment_hash": "1942f684aa473bd58f774c5eadbda49567e2a2c58838afd17d424c08b72d4241", + "status": "complete", + "created_at": 1706231849, + "completed_at": 1706231854, + "preimage": "89ce412a2089cbcb72a73ce755337cf693859ea58f21ef0d1caf286a9b0f2a7c", + "amount_msat": 12300, + "amount_sent_msat": 12301 + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-listpeerchannels.json b/doc/schemas/lightning-listpeerchannels.json index b8968539b123..d9f76e718864 100644 --- a/doc/schemas/lightning-listpeerchannels.json +++ b/doc/schemas/lightning-listpeerchannels.json @@ -1386,208 +1386,210 @@ "", "- -32602: If the given parameters are wrong." ], - "example_json_request": [ + "json_example": [ { - "id": "example:listpeerchannels#1", - "method": "listpeerchannels", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" + "request": { + "id": "example:listpeerchannels#1", + "method": "listpeerchannels", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" + } + }, + "response": { + "channels": [ + { + "peer_id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "peer_connected": true, + "channel_type": { + "bits": [ + 12 + ], + "names": [ + "static_remotekey/even" + ] + }, + "updates": { + "local": { + "htlc_minimum_msat": 0, + "htlc_maximum_msat": 990000000, + "cltv_expiry_delta": 6, + "fee_base_msat": 1, + "fee_proportional_millionths": 10 + } + }, + "state": "CHANNELD_AWAITING_LOCKIN", + "scratch_txid": "4e9c2866b9ae1f765b89ea7ec37428c900ea97f717f85f00e3db852cb6aea3a8", + "last_tx_fee_msat": 5430000, + "feerate": { + "perkw": 7500, + "perkb": 30000 + }, + "owner": "channeld", + "direction": 1, + "channel_id": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", + "funding_txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b", + "funding_outnum": 0, + "close_to_addr": "bcrt1pamt5tqzd49uyessr7437l2vllf20muqmzdauje8x8scjgpc0l0nqhyqcyp", + "close_to": "5120eed745804da9784cc203f563efa99ffa54fdf01b137bc964e63c3124070ffbe6", + "private": false, + "opener": "local", + "alias": { + "local": "5589251x14022525x17398" + }, + "features": [ + "option_static_remotekey" + ], + "funding": { + "local_funds_msat": 1000000000, + "remote_funds_msat": 0, + "pushed_msat": 0 + }, + "to_us_msat": 1000000000, + "min_to_us_msat": 1000000000, + "max_to_us_msat": 1000000000, + "total_msat": 1000000000, + "fee_base_msat": 1, + "fee_proportional_millionths": 10, + "dust_limit_msat": 546000, + "max_total_htlc_in_msat": 18446744073709552000, + "their_reserve_msat": 10000000, + "our_reserve_msat": 10000000, + "spendable_msat": 973980000, + "receivable_msat": 0, + "minimum_htlc_in_msat": 0, + "minimum_htlc_out_msat": 0, + "maximum_htlc_out_msat": 990000000, + "their_to_self_delay": 5, + "our_to_self_delay": 5, + "max_accepted_htlcs": 483, + "state_changes": [], + "status": [], + "in_payments_offered": 0, + "in_offered_msat": 0, + "in_payments_fulfilled": 0, + "in_fulfilled_msat": 0, + "out_payments_offered": 0, + "out_offered_msat": 0, + "out_payments_fulfilled": 0, + "out_fulfilled_msat": 0, + "htlcs": [] + } + ] } }, { - "id": "example:listpeerchannels#2", - "method": "listpeerchannels", - "params": { - "id": null - } - } - ], - "example_json_response": [ - { - "channels": [ - { - "peer_id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "peer_connected": true, - "channel_type": { - "bits": [ - 12 - ], - "names": [ - "static_remotekey/even" - ] - }, - "updates": { - "local": { - "htlc_minimum_msat": 0, - "htlc_maximum_msat": 990000000, - "cltv_expiry_delta": 6, - "fee_base_msat": 1, - "fee_proportional_millionths": 10 - } - }, - "state": "CHANNELD_AWAITING_LOCKIN", - "scratch_txid": "4e9c2866b9ae1f765b89ea7ec37428c900ea97f717f85f00e3db852cb6aea3a8", - "last_tx_fee_msat": 5430000, - "feerate": { - "perkw": 7500, - "perkb": 30000 - }, - "owner": "channeld", - "direction": 1, - "channel_id": "7b0bd48371c473ea25b9ab95613c51a936463c41858c8bbdf356f5328f3d0a6c", - "funding_txid": "6c0a3d8f32f556f3bd8b8c85413c4636a9513c6195abb925ea73c47183d40b7b", - "funding_outnum": 0, - "close_to_addr": "bcrt1pamt5tqzd49uyessr7437l2vllf20muqmzdauje8x8scjgpc0l0nqhyqcyp", - "close_to": "5120eed745804da9784cc203f563efa99ffa54fdf01b137bc964e63c3124070ffbe6", - "private": false, - "opener": "local", - "alias": { - "local": "5589251x14022525x17398" - }, - "features": [ - "option_static_remotekey" - ], - "funding": { - "local_funds_msat": 1000000000, - "remote_funds_msat": 0, - "pushed_msat": 0 - }, - "to_us_msat": 1000000000, - "min_to_us_msat": 1000000000, - "max_to_us_msat": 1000000000, - "total_msat": 1000000000, - "fee_base_msat": 1, - "fee_proportional_millionths": 10, - "dust_limit_msat": 546000, - "max_total_htlc_in_msat": 18446744073709552000, - "their_reserve_msat": 10000000, - "our_reserve_msat": 10000000, - "spendable_msat": 973980000, - "receivable_msat": 0, - "minimum_htlc_in_msat": 0, - "minimum_htlc_out_msat": 0, - "maximum_htlc_out_msat": 990000000, - "their_to_self_delay": 5, - "our_to_self_delay": 5, - "max_accepted_htlcs": 483, - "state_changes": [], - "status": [], - "in_payments_offered": 0, - "in_offered_msat": 0, - "in_payments_fulfilled": 0, - "in_fulfilled_msat": 0, - "out_payments_offered": 0, - "out_offered_msat": 0, - "out_payments_fulfilled": 0, - "out_fulfilled_msat": 0, - "htlcs": [] + "request": { + "id": "example:listpeerchannels#2", + "method": "listpeerchannels", + "params": { + "id": null } - ] - }, - { - "channels": [ - { - "peer_id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "peer_connected": true, - "reestablished": true, - "channel_type": { - "bits": [ - 12, - 22 + }, + "response": { + "channels": [ + { + "peer_id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "peer_connected": true, + "reestablished": true, + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "updates": { + "local": { + "htlc_minimum_msat": 0, + "htlc_maximum_msat": 990000000, + "cltv_expiry_delta": 6, + "fee_base_msat": 1, + "fee_proportional_millionths": 10 + }, + "remote": { + "htlc_minimum_msat": 0, + "htlc_maximum_msat": 990000000, + "cltv_expiry_delta": 6, + "fee_base_msat": 1, + "fee_proportional_millionths": 10 + } + }, + "state": "CHANNELD_NORMAL", + "scratch_txid": "ece66657d6203a4ea77807f566fd5b98a78b659f0cd59ce9200aa3bd6875ee25", + "last_tx_fee_msat": 4545000, + "lost_state": false, + "feerate": { + "perkw": 3750, + "perkb": 15000 + }, + "owner": "channeld", + "short_channel_id": "103x1x0", + "direction": 1, + "channel_id": "def5ef03e0d36ed65de814c0a8d6599a502fe1afb8e956529320bb350e876b5f", + "funding_txid": "5f6b870e35bb20935256e9b8afe12f509a59d6a8c014e85dd66ed3e003eff5de", + "funding_outnum": 0, + "close_to_addr": "bcrt1pamt5tqzd49uyessr7437l2vllf20muqmzdauje8x8scjgpc0l0nqhyqcyp", + "close_to": "5120eed745804da9784cc203f563efa99ffa54fdf01b137bc964e63c3124070ffbe6", + "private": false, + "opener": "local", + "alias": { + "local": "15447035x5589520x8959", + "remote": "6036590x13481428x5501" + }, + "features": [ + "option_static_remotekey", + "option_anchors_zero_fee_htlc_tx" ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] - }, - "updates": { - "local": { - "htlc_minimum_msat": 0, - "htlc_maximum_msat": 990000000, - "cltv_expiry_delta": 6, - "fee_base_msat": 1, - "fee_proportional_millionths": 10 - }, - "remote": { - "htlc_minimum_msat": 0, - "htlc_maximum_msat": 990000000, - "cltv_expiry_delta": 6, - "fee_base_msat": 1, - "fee_proportional_millionths": 10 - } - }, - "state": "CHANNELD_NORMAL", - "scratch_txid": "ece66657d6203a4ea77807f566fd5b98a78b659f0cd59ce9200aa3bd6875ee25", - "last_tx_fee_msat": 4545000, - "lost_state": false, - "feerate": { - "perkw": 3750, - "perkb": 15000 - }, - "owner": "channeld", - "short_channel_id": "103x1x0", - "direction": 1, - "channel_id": "def5ef03e0d36ed65de814c0a8d6599a502fe1afb8e956529320bb350e876b5f", - "funding_txid": "5f6b870e35bb20935256e9b8afe12f509a59d6a8c014e85dd66ed3e003eff5de", - "funding_outnum": 0, - "close_to_addr": "bcrt1pamt5tqzd49uyessr7437l2vllf20muqmzdauje8x8scjgpc0l0nqhyqcyp", - "close_to": "5120eed745804da9784cc203f563efa99ffa54fdf01b137bc964e63c3124070ffbe6", - "private": false, - "opener": "local", - "alias": { - "local": "15447035x5589520x8959", - "remote": "6036590x13481428x5501" - }, - "features": [ - "option_static_remotekey", - "option_anchors_zero_fee_htlc_tx" - ], - "funding": { - "local_funds_msat": 1000000000, - "remote_funds_msat": 0, - "pushed_msat": 0 - }, - "to_us_msat": 1000000000, - "min_to_us_msat": 1000000000, - "max_to_us_msat": 1000000000, - "total_msat": 1000000000, - "fee_base_msat": 1, - "fee_proportional_millionths": 10, - "dust_limit_msat": 546000, - "max_total_htlc_in_msat": 18446744073709552000, - "their_reserve_msat": 10000000, - "our_reserve_msat": 10000000, - "spendable_msat": 978330000, - "receivable_msat": 0, - "minimum_htlc_in_msat": 0, - "minimum_htlc_out_msat": 0, - "maximum_htlc_out_msat": 990000000, - "their_to_self_delay": 5, - "our_to_self_delay": 5, - "max_accepted_htlcs": 483, - "state_changes": [ - { - "timestamp": "2024-02-22T17:48:57.127Z", - "old_state": "CHANNELD_AWAITING_LOCKIN", - "new_state": "CHANNELD_NORMAL", - "cause": "user", - "message": "Lockin complete" - } - ], - "status": [ - "CHANNELD_NORMAL:Channel ready for use." - ], - "in_payments_offered": 0, - "in_offered_msat": 0, - "in_payments_fulfilled": 0, - "in_fulfilled_msat": 0, - "out_payments_offered": 0, - "out_offered_msat": 0, - "out_payments_fulfilled": 0, - "out_fulfilled_msat": 0, - "htlcs": [] - } - ] + "funding": { + "local_funds_msat": 1000000000, + "remote_funds_msat": 0, + "pushed_msat": 0 + }, + "to_us_msat": 1000000000, + "min_to_us_msat": 1000000000, + "max_to_us_msat": 1000000000, + "total_msat": 1000000000, + "fee_base_msat": 1, + "fee_proportional_millionths": 10, + "dust_limit_msat": 546000, + "max_total_htlc_in_msat": 18446744073709552000, + "their_reserve_msat": 10000000, + "our_reserve_msat": 10000000, + "spendable_msat": 978330000, + "receivable_msat": 0, + "minimum_htlc_in_msat": 0, + "minimum_htlc_out_msat": 0, + "maximum_htlc_out_msat": 990000000, + "their_to_self_delay": 5, + "our_to_self_delay": 5, + "max_accepted_htlcs": 483, + "state_changes": [ + { + "timestamp": "2024-02-22T17:48:57.127Z", + "old_state": "CHANNELD_AWAITING_LOCKIN", + "new_state": "CHANNELD_NORMAL", + "cause": "user", + "message": "Lockin complete" + } + ], + "status": [ + "CHANNELD_NORMAL:Channel ready for use." + ], + "in_payments_offered": 0, + "in_offered_msat": 0, + "in_payments_fulfilled": 0, + "in_fulfilled_msat": 0, + "out_payments_offered": 0, + "out_offered_msat": 0, + "out_payments_fulfilled": 0, + "out_fulfilled_msat": 0, + "htlcs": [] + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-listpeers.json b/doc/schemas/lightning-listpeers.json index 55f8616a0529..0113a433a917 100644 --- a/doc/schemas/lightning-listpeers.json +++ b/doc/schemas/lightning-listpeers.json @@ -301,50 +301,52 @@ "", "- -32602: If the given parameters are wrong." ], - "example_json_request": [ + "json_example": [ { - "id": "example:listpeers#1", - "method": "listpeers", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "level": null - } - }, - { - "id": "example:listpeers#2", - "method": "listpeers", - "params": { - "id": null, - "level": null - } - } - ], - "example_json_response": [ - { - "peers": [ - { + "request": { + "id": "example:listpeers#1", + "method": "listpeers", + "params": { "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "connected": true, - "num_channels": 1, - "netaddr": [ - "127.0.0.1:44619" - ], - "features": "08a0000a0a69a2" + "level": null } - ] + }, + "response": { + "peers": [ + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "connected": true, + "num_channels": 1, + "netaddr": [ + "127.0.0.1:44619" + ], + "features": "08a0000a0a69a2" + } + ] + } }, { - "peers": [ - { - "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "connected": true, - "num_channels": 1, - "netaddr": [ - "127.0.0.1:48862" - ], - "features": "08a0000a0a69a2" + "request": { + "id": "example:listpeers#2", + "method": "listpeers", + "params": { + "id": null, + "level": null } - ] + }, + "response": { + "peers": [ + { + "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "connected": true, + "num_channels": 1, + "netaddr": [ + "127.0.0.1:48862" + ], + "features": "08a0000a0a69a2" + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-listsendpays.json b/doc/schemas/lightning-listsendpays.json index f100a2e86117..fbaed7a2f824 100644 --- a/doc/schemas/lightning-listsendpays.json +++ b/doc/schemas/lightning-listsendpays.json @@ -322,79 +322,81 @@ "Note that the returned array is ordered by increasing *id*." ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:listsendpays#1", - "method": "listsendpays", - "params": { - "bolt11": null, - "payment_hash": null, - "status": null, - "index": null, - "start": null, - "limit": null - } - }, - { - "id": "example:listsendpays#2", - "method": "listsendpays", - "params": { - "bolt11": "lnbcrt1230n1pja03q9sp5xu9aypccf3n6vld2waxcysy47ct2wl5x5adtm7k8u30knqes22lspp5duw2v8csh0zh4xg9ql3amem98avlkc2ecre99tgmr2340amf9kmsdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqwh78s8wqg0kepspw0epcxmxteh5wu8n6ddlwdnyj758fqxpqk8ejf597x8ju3r32xqgae3yzjjz9e5s6l2vs5zxvkayhmemmx74wvyqqyqf8c9", - "payment_hash": null, - "status": null, - "index": null, - "start": null, - "limit": null - } - } - ], - "example_json_response": [ - { - "payments": [ - { - "created_index": 1, - "id": 1, - "payment_hash": "e3b43574acd074b0c4ba1b13b5155ff5f9c76742e643ed003e17301c5a2db149", - "groupid": 1, - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount_msat": 20000, - "amount_sent_msat": 20000, - "created_at": 1706225269, - "status": "pending", - "bolt11": "lnbcrt200n1pjm9mn5sp5gq84lgga959m6gg4g0kj29ypwjaxxnm4cu5csymq8p6nqxv800mspp5uw6r2a9v6p6tp396rvfm292l7huuwe6zuep76qp7zucpck3dk9ysdpqf9grgmt62fmk5stswefh23n2tpykvcmzxqyjw5qcqp99qxpqysgqz8s496zmwed278jvp075zlhrnj0ncg45kcfw5s2lkhtxd3wc39f8wflp5gmd827dk470xpasfpx0azsfu0k8ttwae7620h8d050w28cqan776g" - }, - { - "created_index": 2, - "id": 2, - "payment_hash": "f55d92cfe019b5a015f5e5956e9255053cda14786171d5002feb12ae5254e5a5", - "groupid": 1, - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount_msat": 30000, - "amount_sent_msat": 30000, - "created_at": 1706225269, - "status": "pending", - "bolt11": "lnbcrt300n1pjm9mn5sp5zqfkr93rp92mdyj6m8lzpcu90rfefcaqff8fxdd2sc5mace23ujspp574we9nlqrx66q904uk2kayj4q57d59rcv9ca2qp0avf2u5j5ukjsdpq29j55nfcgfcnsvzw2er57knhwcmhzwt0xqyjw5qcqp99qxpqysgq76p2jpnegtzlxmn0aqt6d3f89q4p6y5v3v2qz7t2mm6xt90nt324cq400tl82k28562aux8jxs57d603g7s0q4g3dapu9a7vln94j7spsut799" + "request": { + "id": "example:listsendpays#1", + "method": "listsendpays", + "params": { + "bolt11": null, + "payment_hash": null, + "status": null, + "index": null, + "start": null, + "limit": null } - ] + }, + "response": { + "payments": [ + { + "created_index": 1, + "id": 1, + "payment_hash": "e3b43574acd074b0c4ba1b13b5155ff5f9c76742e643ed003e17301c5a2db149", + "groupid": 1, + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount_msat": 20000, + "amount_sent_msat": 20000, + "created_at": 1706225269, + "status": "pending", + "bolt11": "lnbcrt200n1pjm9mn5sp5gq84lgga959m6gg4g0kj29ypwjaxxnm4cu5csymq8p6nqxv800mspp5uw6r2a9v6p6tp396rvfm292l7huuwe6zuep76qp7zucpck3dk9ysdpqf9grgmt62fmk5stswefh23n2tpykvcmzxqyjw5qcqp99qxpqysgqz8s496zmwed278jvp075zlhrnj0ncg45kcfw5s2lkhtxd3wc39f8wflp5gmd827dk470xpasfpx0azsfu0k8ttwae7620h8d050w28cqan776g" + }, + { + "created_index": 2, + "id": 2, + "payment_hash": "f55d92cfe019b5a015f5e5956e9255053cda14786171d5002feb12ae5254e5a5", + "groupid": 1, + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount_msat": 30000, + "amount_sent_msat": 30000, + "created_at": 1706225269, + "status": "pending", + "bolt11": "lnbcrt300n1pjm9mn5sp5zqfkr93rp92mdyj6m8lzpcu90rfefcaqff8fxdd2sc5mace23ujspp574we9nlqrx66q904uk2kayj4q57d59rcv9ca2qp0avf2u5j5ukjsdpq29j55nfcgfcnsvzw2er57knhwcmhzwt0xqyjw5qcqp99qxpqysgq76p2jpnegtzlxmn0aqt6d3f89q4p6y5v3v2qz7t2mm6xt90nt324cq400tl82k28562aux8jxs57d603g7s0q4g3dapu9a7vln94j7spsut799" + } + ] + } }, { - "payments": [ - { - "created_index": 1, - "id": 1, - "payment_hash": "6f1ca61f10bbc57a990507e3dde7653f59fb6159c0f252ad1b1aa357f7692db7", - "groupid": 1, - "updated_index": 1, - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount_msat": 123000, - "amount_sent_msat": 123000, - "created_at": 1708639237, - "completed_at": 1708639238, - "status": "complete", - "payment_preimage": "91f8366681fdfd309c048082fcde81a79116f85a7b2dd09aef1e34f5f7c3397b", - "bolt11": "lnbcrt1230n1pja03q9sp5xu9aypccf3n6vld2waxcysy47ct2wl5x5adtm7k8u30knqes22lspp5duw2v8csh0zh4xg9ql3amem98avlkc2ecre99tgmr2340amf9kmsdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqwh78s8wqg0kepspw0epcxmxteh5wu8n6ddlwdnyj758fqxpqk8ejf597x8ju3r32xqgae3yzjjz9e5s6l2vs5zxvkayhmemmx74wvyqqyqf8c9" + "request": { + "id": "example:listsendpays#2", + "method": "listsendpays", + "params": { + "bolt11": "lnbcrt1230n1pja03q9sp5xu9aypccf3n6vld2waxcysy47ct2wl5x5adtm7k8u30knqes22lspp5duw2v8csh0zh4xg9ql3amem98avlkc2ecre99tgmr2340amf9kmsdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqwh78s8wqg0kepspw0epcxmxteh5wu8n6ddlwdnyj758fqxpqk8ejf597x8ju3r32xqgae3yzjjz9e5s6l2vs5zxvkayhmemmx74wvyqqyqf8c9", + "payment_hash": null, + "status": null, + "index": null, + "start": null, + "limit": null } - ] + }, + "response": { + "payments": [ + { + "created_index": 1, + "id": 1, + "payment_hash": "6f1ca61f10bbc57a990507e3dde7653f59fb6159c0f252ad1b1aa357f7692db7", + "groupid": 1, + "updated_index": 1, + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount_msat": 123000, + "amount_sent_msat": 123000, + "created_at": 1708639237, + "completed_at": 1708639238, + "status": "complete", + "payment_preimage": "91f8366681fdfd309c048082fcde81a79116f85a7b2dd09aef1e34f5f7c3397b", + "bolt11": "lnbcrt1230n1pja03q9sp5xu9aypccf3n6vld2waxcysy47ct2wl5x5adtm7k8u30knqes22lspp5duw2v8csh0zh4xg9ql3amem98avlkc2ecre99tgmr2340amf9kmsdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqwh78s8wqg0kepspw0epcxmxteh5wu8n6ddlwdnyj758fqxpqk8ejf597x8ju3r32xqgae3yzjjz9e5s6l2vs5zxvkayhmemmx74wvyqqyqf8c9" + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-listsqlschemas.json b/doc/schemas/lightning-listsqlschemas.json index dd298487c490..26afd7b629f5 100644 --- a/doc/schemas/lightning-listsqlschemas.json +++ b/doc/schemas/lightning-listsqlschemas.json @@ -96,173 +96,175 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:listsqlschemas#1", - "method": "listsqlschemas", - "params": { - "table": "offers" + "request": { + "id": "example:listsqlschemas#1", + "method": "listsqlschemas", + "params": { + "table": "offers" + } + }, + "response": { + "schemas": [ + { + "tablename": "offers", + "columns": [ + { + "name": "offer_id", + "type": "BLOB" + }, + { + "name": "active", + "type": "INTEGER" + }, + { + "name": "single_use", + "type": "INTEGER" + }, + { + "name": "bolt12", + "type": "TEXT" + }, + { + "name": "bolt12_unsigned", + "type": "TEXT" + }, + { + "name": "used", + "type": "INTEGER" + }, + { + "name": "label", + "type": "TEXT" + } + ], + "indices": [ + [ + "offer_id" + ] + ] + } + ] } }, { - "id": "example:listsqlschemas#2", - "method": "listsqlschemas", - "params": [ - "closedchannels" - ] - } - ], - "example_json_response": [ - { - "schemas": [ - { - "tablename": "offers", - "columns": [ - { - "name": "offer_id", - "type": "BLOB" - }, - { - "name": "active", - "type": "INTEGER" - }, - { - "name": "single_use", - "type": "INTEGER" - }, - { - "name": "bolt12", - "type": "TEXT" - }, - { - "name": "bolt12_unsigned", - "type": "TEXT" - }, - { - "name": "used", - "type": "INTEGER" - }, - { - "name": "label", - "type": "TEXT" - } - ], - "indices": [ - [ - "offer_id" + "request": { + "id": "example:listsqlschemas#2", + "method": "listsqlschemas", + "params": [ + "closedchannels" + ] + }, + "response": { + "schemas": [ + { + "tablename": "closedchannels", + "columns": [ + { + "name": "rowid", + "type": "INTEGER" + }, + { + "name": "peer_id", + "type": "BLOB" + }, + { + "name": "channel_id", + "type": "BLOB" + }, + { + "name": "short_channel_id", + "type": "TEXT" + }, + { + "name": "alias_local", + "type": "TEXT" + }, + { + "name": "alias_remote", + "type": "TEXT" + }, + { + "name": "opener", + "type": "TEXT" + }, + { + "name": "closer", + "type": "TEXT" + }, + { + "name": "private", + "type": "INTEGER" + }, + { + "name": "total_local_commitments", + "type": "INTEGER" + }, + { + "name": "total_remote_commitments", + "type": "INTEGER" + }, + { + "name": "total_htlcs_sent", + "type": "INTEGER" + }, + { + "name": "funding_txid", + "type": "BLOB" + }, + { + "name": "funding_outnum", + "type": "INTEGER" + }, + { + "name": "leased", + "type": "INTEGER" + }, + { + "name": "funding_fee_paid_msat", + "type": "INTEGER" + }, + { + "name": "funding_fee_rcvd_msat", + "type": "INTEGER" + }, + { + "name": "funding_pushed_msat", + "type": "INTEGER" + }, + { + "name": "total_msat", + "type": "INTEGER" + }, + { + "name": "final_to_us_msat", + "type": "INTEGER" + }, + { + "name": "min_to_us_msat", + "type": "INTEGER" + }, + { + "name": "max_to_us_msat", + "type": "INTEGER" + }, + { + "name": "last_commitment_txid", + "type": "BLOB" + }, + { + "name": "last_commitment_fee_msat", + "type": "INTEGER" + }, + { + "name": "close_cause", + "type": "TEXT" + } ] - ] - } - ] - }, - { - "schemas": [ - { - "tablename": "closedchannels", - "columns": [ - { - "name": "rowid", - "type": "INTEGER" - }, - { - "name": "peer_id", - "type": "BLOB" - }, - { - "name": "channel_id", - "type": "BLOB" - }, - { - "name": "short_channel_id", - "type": "TEXT" - }, - { - "name": "alias_local", - "type": "TEXT" - }, - { - "name": "alias_remote", - "type": "TEXT" - }, - { - "name": "opener", - "type": "TEXT" - }, - { - "name": "closer", - "type": "TEXT" - }, - { - "name": "private", - "type": "INTEGER" - }, - { - "name": "total_local_commitments", - "type": "INTEGER" - }, - { - "name": "total_remote_commitments", - "type": "INTEGER" - }, - { - "name": "total_htlcs_sent", - "type": "INTEGER" - }, - { - "name": "funding_txid", - "type": "BLOB" - }, - { - "name": "funding_outnum", - "type": "INTEGER" - }, - { - "name": "leased", - "type": "INTEGER" - }, - { - "name": "funding_fee_paid_msat", - "type": "INTEGER" - }, - { - "name": "funding_fee_rcvd_msat", - "type": "INTEGER" - }, - { - "name": "funding_pushed_msat", - "type": "INTEGER" - }, - { - "name": "total_msat", - "type": "INTEGER" - }, - { - "name": "final_to_us_msat", - "type": "INTEGER" - }, - { - "name": "min_to_us_msat", - "type": "INTEGER" - }, - { - "name": "max_to_us_msat", - "type": "INTEGER" - }, - { - "name": "last_commitment_txid", - "type": "BLOB" - }, - { - "name": "last_commitment_fee_msat", - "type": "INTEGER" - }, - { - "name": "close_cause", - "type": "TEXT" - } - ] - } - ] + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-listtransactions.json b/doc/schemas/lightning-listtransactions.json index ed54c8c35c6a..8246d45988c1 100644 --- a/doc/schemas/lightning-listtransactions.json +++ b/doc/schemas/lightning-listtransactions.json @@ -143,11 +143,44 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:listtransactions#1", - "method": "listtransactions", - "params": {} + "request": { + "id": "example:listtransactions#1", + "method": "listtransactions", + "params": {} + }, + "response": { + "transactions": [ + { + "hash": "05985072bbe20747325e69a159fe08176cc1bbc96d25e8848edad2dddc1165d0", + "rawtx": "02000000027032912651fc25a3e0893acd5f9640598707e2dfef92143bb5a4020e335442800100000017160014a5f48b9aa3cb8ca6cc1040c11e386745bb4dc932ffffffffd229a4b4f78638ebcac10a68b0561585a5d6e4d3b769ad0a909e9b9afaeae24e00000000171600145c83da9b685f9142016c6f5eb5f98a45cfa6f686ffffffff01915a01000000000017a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf8700000000", + "blockheight": 0, + "txindex": 0, + "locktime": 0, + "version": 2, + "inputs": [ + { + "txid": "804254330e02a4b53b1492efdfe207875940965fcd3a89e0a325fc5126913270", + "index": 1, + "sequence": 4294967295 + }, + { + "txid": "4ee2eafa9a9b9e900aad69b7d3e4d6a5851556b0680ac1caeb3886f7b4a429d2", + "index": 0, + "sequence": 4294967295 + } + ], + "outputs": [ + { + "index": 0, + "satoshis": "88721000msat", + "scriptPubKey": "a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf87" + } + ] + } + ] + } } ], "errors": [ @@ -155,39 +188,6 @@ "", "- -32602: Error in given parameters." ], - "example_json_response": [ - { - "transactions": [ - { - "hash": "05985072bbe20747325e69a159fe08176cc1bbc96d25e8848edad2dddc1165d0", - "rawtx": "02000000027032912651fc25a3e0893acd5f9640598707e2dfef92143bb5a4020e335442800100000017160014a5f48b9aa3cb8ca6cc1040c11e386745bb4dc932ffffffffd229a4b4f78638ebcac10a68b0561585a5d6e4d3b769ad0a909e9b9afaeae24e00000000171600145c83da9b685f9142016c6f5eb5f98a45cfa6f686ffffffff01915a01000000000017a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf8700000000", - "blockheight": 0, - "txindex": 0, - "locktime": 0, - "version": 2, - "inputs": [ - { - "txid": "804254330e02a4b53b1492efdfe207875940965fcd3a89e0a325fc5126913270", - "index": 1, - "sequence": 4294967295 - }, - { - "txid": "4ee2eafa9a9b9e900aad69b7d3e4d6a5851556b0680ac1caeb3886f7b4a429d2", - "index": 0, - "sequence": 4294967295 - } - ], - "outputs": [ - { - "index": 0, - "satoshis": "88721000msat", - "scriptPubKey": "a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf87" - } - ] - } - ] - } - ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." diff --git a/doc/schemas/lightning-makesecret.json b/doc/schemas/lightning-makesecret.json index 181499faf675..31fb22c63b71 100644 --- a/doc/schemas/lightning-makesecret.json +++ b/doc/schemas/lightning-makesecret.json @@ -42,29 +42,31 @@ "", "- -1: Catchall nonspecific error." ], - "example_json_request": [ + "json_example": [ { - "id": "example:makesecret#1", - "method": "makesecret", - "params": [ - "73636220736563726574" - ] - }, - { - "id": "example:makesecret#2", - "method": "makesecret", - "params": [ - null, - "scb secret" - ] - } - ], - "example_json_response": [ - { - "secret": "a9a2e742405c28f059349132923a99337ae7f71168b7485496e3365f5bc664ed" + "request": { + "id": "example:makesecret#1", + "method": "makesecret", + "params": [ + "73636220736563726574" + ] + }, + "response": { + "secret": "a9a2e742405c28f059349132923a99337ae7f71168b7485496e3365f5bc664ed" + } }, { - "secret": "a9a2e742405c28f059349132923a99337ae7f71168b7485496e3365f5bc664ed" + "request": { + "id": "example:makesecret#2", + "method": "makesecret", + "params": [ + null, + "scb secret" + ] + }, + "response": { + "secret": "a9a2e742405c28f059349132923a99337ae7f71168b7485496e3365f5bc664ed" + } } ], "author": [ diff --git a/doc/schemas/lightning-multifundchannel.json b/doc/schemas/lightning-multifundchannel.json index d399f0f5ed6f..0d943db5052e 100644 --- a/doc/schemas/lightning-multifundchannel.json +++ b/doc/schemas/lightning-multifundchannel.json @@ -346,110 +346,112 @@ "}", "```" ], - "example_json_request": [ + "json_example": [ { - "id": "example:multifundchannel#1", - "method": "multifundchannel", - "params": { - "destinations": [ + "request": { + "id": "example:multifundchannel#1", + "method": "multifundchannel", + "params": { + "destinations": [ + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59@localhost:41939", + "amount": 50000 + } + ], + "feerate": "10000perkw", + "minconf": null, + "utxos": null, + "minchannels": null, + "commitment_feerate": "2000perkw" + } + }, + "response": { + "tx": "0200000000010100a8ceb6f76c49c8c0c809ca359461540708a9a5ac56e56e6a7aaafb35f4d3850000000000fdffffff0250c30000000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd0623ff030000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a02473044022064763837f2cc84507eb1fc28c9e95d51174e1da4b8755da8e67fe21e37d0a8b402206295d0f19625f014819361a20572b936d81f6c5ba419e56997e882f3a7be094a012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", + "txid": "ecba36e93bcf40542d43a05ef550bb0e4be51d766aa2ec8c5640a0d431ab0d06", + "channel_ids": [ { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59@localhost:41939", - "amount": 50000 + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "channel_id": "060dab31d4a040568ceca26a761de54b0ebb50f55ea0432d5440cf3be936baec", + "channel_type": { + "bits": [ + 12 + ], + "names": [ + "static_remotekey/even" + ] + }, + "outnum": 0 } ], - "feerate": "10000perkw", - "minconf": null, - "utxos": null, - "minchannels": null, - "commitment_feerate": "2000perkw" + "failed": [] } }, { - "id": "example:multifundchannel#2", - "method": "multifundchannel", - "params": { - "destinations": [ + "request": { + "id": "example:multifundchannel#2", + "method": "multifundchannel", + "params": { + "destinations": [ + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59@localhost:44663", + "amount": 50000 + }, + { + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d@localhost:34631", + "amount": 50000 + }, + { + "id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199@localhost:34617", + "amount": 50000 + } + ], + "feerate": null, + "minconf": null, + "utxos": null, + "minchannels": 1 + } + }, + "response": { + "tx": "020000000001023041611dac05004825ab64781b4a33bf622380bf90196fae689196b1850a1f8f0000000000fdffffff5646519c565466c9588a88400ec71a39a2c0b6988beadb32491a13d9b89f85360100000000fdffffff0250c3000000000000220020181492c29a989f099fd2cf412c74b192dd095e81f4e4f6bec45bd1fbfdd2cfd983720000000000002251203e8a03f678bb7ca048baecc39788530560ea049816d604f72925e425288446c80140caa3b93c6667e4fe0026417cc87ae9dfd16d80018e7c6dcd6dfcee4d6cab7c7e84181baeb95ba25934ad1aa6b57f83c8287bf1b727123350b35549a3abe15b060140b3c6626b9b57081cc7eb5e4f518669764d265fb84316d8fb610e19ede13c5a370c1072861b909ec923acec980adb4a3e488ee3c6f9c49164bd4596945b52f62678000000", + "txid": "1fcc6d46200443ad21e3a1a1628b862bafd0d75c0b4454f5494957097bc7930d", + "channel_ids": [ { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59@localhost:44663", - "amount": 50000 - }, + "id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", + "channel_id": "0d93c77b09574949f554440b5cd7d0af2b868b62a1a1e321ad430420466dcc1f", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "outnum": 0 + } + ], + "failed": [ { - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d@localhost:34631", - "amount": 50000 + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "method": "connect", + "error": { + "code": 401, + "message": "All addresses failed: 127.0.0.1:44663: Connection establishment: Connection refused. " + } }, { - "id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199@localhost:34617", - "amount": 50000 + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "method": "connect", + "error": { + "code": 401, + "message": "All addresses failed: 127.0.0.1:34631: Connection establishment: Connection refused. " + } } - ], - "feerate": null, - "minconf": null, - "utxos": null, - "minchannels": 1 + ] } } ], - "example_json_response": [ - { - "tx": "0200000000010100a8ceb6f76c49c8c0c809ca359461540708a9a5ac56e56e6a7aaafb35f4d3850000000000fdffffff0250c30000000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd0623ff030000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a02473044022064763837f2cc84507eb1fc28c9e95d51174e1da4b8755da8e67fe21e37d0a8b402206295d0f19625f014819361a20572b936d81f6c5ba419e56997e882f3a7be094a012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", - "txid": "ecba36e93bcf40542d43a05ef550bb0e4be51d766aa2ec8c5640a0d431ab0d06", - "channel_ids": [ - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "channel_id": "060dab31d4a040568ceca26a761de54b0ebb50f55ea0432d5440cf3be936baec", - "channel_type": { - "bits": [ - 12 - ], - "names": [ - "static_remotekey/even" - ] - }, - "outnum": 0 - } - ], - "failed": [] - }, - { - "tx": "020000000001023041611dac05004825ab64781b4a33bf622380bf90196fae689196b1850a1f8f0000000000fdffffff5646519c565466c9588a88400ec71a39a2c0b6988beadb32491a13d9b89f85360100000000fdffffff0250c3000000000000220020181492c29a989f099fd2cf412c74b192dd095e81f4e4f6bec45bd1fbfdd2cfd983720000000000002251203e8a03f678bb7ca048baecc39788530560ea049816d604f72925e425288446c80140caa3b93c6667e4fe0026417cc87ae9dfd16d80018e7c6dcd6dfcee4d6cab7c7e84181baeb95ba25934ad1aa6b57f83c8287bf1b727123350b35549a3abe15b060140b3c6626b9b57081cc7eb5e4f518669764d265fb84316d8fb610e19ede13c5a370c1072861b909ec923acec980adb4a3e488ee3c6f9c49164bd4596945b52f62678000000", - "txid": "1fcc6d46200443ad21e3a1a1628b862bafd0d75c0b4454f5494957097bc7930d", - "channel_ids": [ - { - "id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", - "channel_id": "0d93c77b09574949f554440b5cd7d0af2b868b62a1a1e321ad430420466dcc1f", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] - }, - "outnum": 0 - } - ], - "failed": [ - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "method": "connect", - "error": { - "code": 401, - "message": "All addresses failed: 127.0.0.1:44663: Connection establishment: Connection refused. " - } - }, - { - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "method": "connect", - "error": { - "code": 401, - "message": "All addresses failed: 127.0.0.1:34631: Connection establishment: Connection refused. " - } - } - ] - } - ], "author": [ "ZmnSCPxj <> is mainly responsible." ], diff --git a/doc/schemas/lightning-multiwithdraw.json b/doc/schemas/lightning-multiwithdraw.json index f9dd6a1329ce..e7d67d5b30e7 100644 --- a/doc/schemas/lightning-multiwithdraw.json +++ b/doc/schemas/lightning-multiwithdraw.json @@ -66,70 +66,72 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:multiwithdraw#1", - "method": "multiwithdraw", - "params": { - "outputs": [ - { - "bcrt1qyusnugshkn6kh5vmdjpe8hylvxlxjy3ns0hmrs": "2222000msat" - }, - { - "bcrt1q6r4vvt7uack33qf9n05umfxy8h5s2rdcmq7ra3": "3333000msat" - } - ], - "feerate": null, - "minconf": null, - "utxos": null + "request": { + "id": "example:multiwithdraw#1", + "method": "multiwithdraw", + "params": { + "outputs": [ + { + "bcrt1qyusnugshkn6kh5vmdjpe8hylvxlxjy3ns0hmrs": "2222000msat" + }, + { + "bcrt1q6r4vvt7uack33qf9n05umfxy8h5s2rdcmq7ra3": "3333000msat" + } + ], + "feerate": null, + "minconf": null, + "utxos": null + } + }, + "response": { + "tx": "02000000000101b75863b811587b4c15bb94d9285c31d6369b8ff609e44de399936f8acb268f600000000000fdffffff03050d000000000000160014d0eac62fdcee2d1881259be9cda4c43de9050db8ae0800000000000016001427213e2217b4f56bd19b6c8393dc9f61be691233d4b5f5050000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a0247304402203a001463da125de5615ff1c18f9cd4a1d2a138c91d40189d350821ac8fb3ae4f02207a507eec27e15fe43476233cd9fe8b690ebd265073a58ed18ff79a1416886f18012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", + "txid": "94e803b98257855569d35b675d65fb4fa0061a8b5f828992e2104a2882bb18bf" } }, { - "id": "example:multiwithdraw#2", - "method": "multiwithdraw", - "params": { - "outputs": [ - { - "BCRT1QW508D6QEJXTDG4Y5R3ZARVARY0C5XW7KYGT080": 1000 - }, - { - "bcrt1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3qzf4jry": 1000 - }, - { - "bcrt1pw508d6qejxtdg4y5r3zarvary0c5xw7kw508d6qejxtdg4y5r3zarvary0c5xw7k0ylj56": 1000 - }, - { - "BCRT1SW50QT2UWHA": 1000 - }, - { - "bcrt1zw508d6qejxtdg4y5r3zarvaryv2wuatf": 1000 - }, - { - "bcrt1qqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvseswlauz7": 1000 - }, - { - "bcrt1pqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvsesyga46z": 1000 - }, - { - "bcrt1p0xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vqc8gma6": 1000 - } - ], - "feerate": null, - "minconf": null, - "utxos": null + "request": { + "id": "example:multiwithdraw#2", + "method": "multiwithdraw", + "params": { + "outputs": [ + { + "BCRT1QW508D6QEJXTDG4Y5R3ZARVARY0C5XW7KYGT080": 1000 + }, + { + "bcrt1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3qzf4jry": 1000 + }, + { + "bcrt1pw508d6qejxtdg4y5r3zarvary0c5xw7kw508d6qejxtdg4y5r3zarvary0c5xw7k0ylj56": 1000 + }, + { + "BCRT1SW50QT2UWHA": 1000 + }, + { + "bcrt1zw508d6qejxtdg4y5r3zarvaryv2wuatf": 1000 + }, + { + "bcrt1qqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvseswlauz7": 1000 + }, + { + "bcrt1pqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvsesyga46z": 1000 + }, + { + "bcrt1p0xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vqc8gma6": 1000 + } + ], + "feerate": null, + "minconf": null, + "utxos": null + } + }, + "response": { + "tx": "02000000000101dc5a50dfbafc30697b930b44e763ff7a255475d17d975fa0e2003431312098cf0100000000fdffffff09e803000000000000225120000000c4a5cad46221b2a187905e5266362b99d5e91c6ce24d165dab93e86433e803000000000000046002751ee8030000000000002a5128751e76e8199196d454941c45d1b3a323f1433bd6751e76e8199196d454941c45d1b3a323f1433bd6e80300000000000022512079be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f817983b939700000000002251200518e92cd94e0f62c06f126dff98b9abe79b7ed845a156d5245678e26554475de803000000000000160014751e76e8199196d454941c45d1b3a323f1433bd6e8030000000000002200201863143c14c5166804bd19203356da136c985678cd4d27a1b8c6329604903262e803000000000000125210751e76e8199196d454941c45d1b3a323e803000000000000220020000000c4a5cad46221b2a187905e5266362b99d5e91c6ce24d165dab93e8643301407f0d9bc098c5439ff611507b6a7d403047ed4e0b883f293db19d4e109d350a24f790acb55547384ff2a23fcfde0eba9af7cebc321c19cfc4817ecd47d50c2cd854000000", + "txid": "062383a7c9a19a2768939087a5c89826a4ea3531080f20cc06aa1cbf431be505" } } ], - "example_json_response": [ - { - "tx": "02000000000101b75863b811587b4c15bb94d9285c31d6369b8ff609e44de399936f8acb268f600000000000fdffffff03050d000000000000160014d0eac62fdcee2d1881259be9cda4c43de9050db8ae0800000000000016001427213e2217b4f56bd19b6c8393dc9f61be691233d4b5f5050000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a0247304402203a001463da125de5615ff1c18f9cd4a1d2a138c91d40189d350821ac8fb3ae4f02207a507eec27e15fe43476233cd9fe8b690ebd265073a58ed18ff79a1416886f18012103d745445c9362665f22e0d96e9e766f273f3260dea39c8a76bfa05dd2684ddccf66000000", - "txid": "94e803b98257855569d35b675d65fb4fa0061a8b5f828992e2104a2882bb18bf" - }, - { - "tx": "02000000000101dc5a50dfbafc30697b930b44e763ff7a255475d17d975fa0e2003431312098cf0100000000fdffffff09e803000000000000225120000000c4a5cad46221b2a187905e5266362b99d5e91c6ce24d165dab93e86433e803000000000000046002751ee8030000000000002a5128751e76e8199196d454941c45d1b3a323f1433bd6751e76e8199196d454941c45d1b3a323f1433bd6e80300000000000022512079be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f817983b939700000000002251200518e92cd94e0f62c06f126dff98b9abe79b7ed845a156d5245678e26554475de803000000000000160014751e76e8199196d454941c45d1b3a323f1433bd6e8030000000000002200201863143c14c5166804bd19203356da136c985678cd4d27a1b8c6329604903262e803000000000000125210751e76e8199196d454941c45d1b3a323e803000000000000220020000000c4a5cad46221b2a187905e5266362b99d5e91c6ce24d165dab93e8643301407f0d9bc098c5439ff611507b6a7d403047ed4e0b883f293db19d4e109d350a24f790acb55547384ff2a23fcfde0eba9af7cebc321c19cfc4817ecd47d50c2cd854000000", - "txid": "062383a7c9a19a2768939087a5c89826a4ea3531080f20cc06aa1cbf431be505" - } - ], "errors": [ "On failure, an error is reported and the withdrawal transaction is not created.", "", diff --git a/doc/schemas/lightning-newaddr.json b/doc/schemas/lightning-newaddr.json index 8da2e56f4168..438c9cbe81e9 100644 --- a/doc/schemas/lightning-newaddr.json +++ b/doc/schemas/lightning-newaddr.json @@ -49,30 +49,32 @@ "errors": [ "If an unrecognized address type is requested an error message will be returned." ], - "example_json_request": [ + "json_example": [ { - "id": "example:newaddr#1", - "method": "newaddr", - "params": { - "addresstype": null + "request": { + "id": "example:newaddr#1", + "method": "newaddr", + "params": { + "addresstype": null + } + }, + "response": { + "bech32": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf" } }, { - "id": "example:newaddr#2", - "method": "newaddr", - "params": { - "addresstype": "bech32" + "request": { + "id": "example:newaddr#2", + "method": "newaddr", + "params": { + "addresstype": "bech32" + } + }, + "response": { + "bech32": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf" } } ], - "example_json_response": [ - { - "bech32": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf" - }, - { - "bech32": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf" - } - ], "author": [ "Felix <> is mainly responsible." ], diff --git a/doc/schemas/lightning-notifications.json b/doc/schemas/lightning-notifications.json index 273260d00a22..7b9a3d0917a1 100644 --- a/doc/schemas/lightning-notifications.json +++ b/doc/schemas/lightning-notifications.json @@ -64,26 +64,28 @@ } } ], - "example_json_request": [ + "json_example": [ { - "id": "example:notifications#1", - "method": "notifications", - "params": { - "enable": true - } + "request": { + "id": "example:notifications#1", + "method": "notifications", + "params": { + "enable": true + } + }, + "response": {} }, { - "id": "example:notifications#2", - "method": "notifications", - "params": { - "enable": false - } + "request": { + "id": "example:notifications#2", + "method": "notifications", + "params": { + "enable": false + } + }, + "response": {} } ], - "example_json_response": [ - {}, - {} - ], "author": [ "Rusty Russell <> wrote the initial version of this man page." ], diff --git a/doc/schemas/lightning-offer.json b/doc/schemas/lightning-offer.json index 12f9490c5814..e1e5092bb9e3 100644 --- a/doc/schemas/lightning-offer.json +++ b/doc/schemas/lightning-offer.json @@ -165,43 +165,45 @@ "- -1: Catchall nonspecific error.", "- 1000: Offer with this offer_id already exists (but is not active)." ], - "example_json_request": [ + "json_example": [ { - "id": "example:offer#1", - "method": "offer", - "params": { - "amount": "1msat", - "description": "test for 1msat" + "request": { + "id": "example:offer#1", + "method": "offer", + "params": { + "amount": "1msat", + "description": "test for 1msat" + } + }, + "response": { + "offer_id": "f61cca153d1948dade19349792d9bcdc9cef687fd27db0b553a67979f55aae48", + "active": true, + "single_use": false, + "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqyqs5rn5v4ehggrxdaezqvtdwdshg93pqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq63s", + "used": false, + "created": true } }, { - "id": "example:offer#2", - "method": "offer", - "params": { - "amount": "100000sat", - "description": "quantity_max test", - "recurrence": "1week" + "request": { + "id": "example:offer#2", + "method": "offer", + "params": { + "amount": "100000sat", + "description": "quantity_max test", + "recurrence": "1week" + } + }, + "response": { + "offer_id": "f7a501e51e2a90d032150b9100b1977c625f05cfda22469bdc81d8a20b1e303f", + "active": true, + "single_use": false, + "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqszltcgqpgghzatpde6xjaretakkz7pqw3jhxaqkyypxdeze35wncs2l2u4gfzyrpds00e6yakfrt6ctrw5n9qanzhqr2xq6qgqsw", + "used": false, + "created": true } } ], - "example_json_response": [ - { - "offer_id": "f61cca153d1948dade19349792d9bcdc9cef687fd27db0b553a67979f55aae48", - "active": true, - "single_use": false, - "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqyqs5rn5v4ehggrxdaezqvtdwdshg93pqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq63s", - "used": false, - "created": true - }, - { - "offer_id": "f7a501e51e2a90d032150b9100b1977c625f05cfda22469bdc81d8a20b1e303f", - "active": true, - "single_use": false, - "bolt12": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqszltcgqpgghzatpde6xjaretakkz7pqw3jhxaqkyypxdeze35wncs2l2u4gfzyrpds00e6yakfrt6ctrw5n9qanzhqr2xq6qgqsw", - "used": false, - "created": true - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-openchannel_abort.json b/doc/schemas/lightning-openchannel_abort.json index 1aac1f9b69f8..7be06aae162f 100644 --- a/doc/schemas/lightning-openchannel_abort.json +++ b/doc/schemas/lightning-openchannel_abort.json @@ -56,22 +56,22 @@ "- 311: Unknown channel id.", "- 312: Channel in an invalid state" ], - "example_json_request": [ + "json_example": [ { - "id": "example:openchannel_abort#1", - "method": "openchannel_abort", - "params": { - "channel_id": "aec3dfd0c7643a23b679cd2e493c053f8fdf621ff2624949f9582c4118b818c6" + "request": { + "id": "example:openchannel_abort#1", + "method": "openchannel_abort", + "params": { + "channel_id": "aec3dfd0c7643a23b679cd2e493c053f8fdf621ff2624949f9582c4118b818c6" + } + }, + "response": { + "channel_id": "aec3dfd0c7643a23b679cd2e493c053f8fdf621ff2624949f9582c4118b818c6", + "channel_canceled": true, + "reason": "Abort requested" } } ], - "example_json_response": [ - { - "channel_id": "aec3dfd0c7643a23b679cd2e493c053f8fdf621ff2624949f9582c4118b818c6", - "channel_canceled": true, - "reason": "Abort requested" - } - ], "author": [ "Lisa Neigut <> is mainly responsible." ], diff --git a/doc/schemas/lightning-openchannel_init.json b/doc/schemas/lightning-openchannel_init.json index 17cc87cadbc1..8ab72791ea81 100644 --- a/doc/schemas/lightning-openchannel_init.json +++ b/doc/schemas/lightning-openchannel_init.json @@ -179,75 +179,77 @@ "If you sent a *request_amt* and the peer supports `option_will_fund` and is interested in leasing you liquidity in this channel, returns their updated channel fee max (*channel_fee_proportional_basis*, *channel_fee_base_msat*), updated rate card for the lease fee (*lease_fee_proportional_basis*, *lease_fee_base_sat*) and their on-chain weight *weight_charge*, which will be added to the lease fee at a rate of *funding_feerate* * *weight_charge* / 1000." ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:openchannel_init#1", - "method": "openchannel_init", - "params": { - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "amount": 999000, - "initialpsbt": "cHNidP8BADMCAAAAAYbThUhSzYr7ph6Z434bdcW7eoirYOFMmUt2GXZ79sF/AQAAAAD9////AGYAAAAAAQDeAgAAAAABARVD4QKlmwy8SNcNypf1o9TzbIFZjj4dqVzHAL0SLDoTAAAAAAD9////AjOv9ikBAAAAFgAUXJGglH7At5HOVY4ZHp0+19kv655AQg8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgVIxRXqIykOOxm/6YPaFFx2Qh1618qlXPUhDiliVQ2KUCIHQcHniUTcm1XT8SyRE8ev52jm0uiIYum15XcR/tPh+NASEC3Pby7xL4+Ig/Z8TchQ0QT1upLGet3da8qjSjgHO9LOJlAAAAAQEfQEIPAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", - "commitment_feerate": null, - "funding_feerate": null, - "announce": true, - "close_to": null, - "request_amt": null, - "channel_type": [ - 12, - 22 - ] - } - }, - { - "id": "example:openchannel_init#2", - "method": "openchannel_init", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount": 16777216, - "initialpsbt": "cHNidP8BADMCAAAAAQVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAAAAAAD9////AGYAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", - "commitment_feerate": null, - "funding_feerate": null, - "announce": true, - "close_to": null, - "request_amt": null, - "channel_type": null - } - } - ], - "example_json_response": [ - { - "channel_id": "53fa2b1ca0d8f21abeaaac0495ab9925cdfaf2ca8b04dbe4aeb061823e1ff2c8", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABARVD4QKlmwy8SNcNypf1o9TzbIFZjj4dqVzHAL0SLDoTAAAAAAD9////AjOv9ikBAAAAFgAUXJGglH7At5HOVY4ZHp0+19kv655AQg8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgVIxRXqIykOOxm/6YPaFFx2Qh1618qlXPUhDiliVQ2KUCIHQcHniUTcm1XT8SyRE8ev52jm0uiIYum15XcR/tPh+NASEC3Pby7xL4+Ig/Z8TchQ0QT1upLGet3da8qjSjgHO9LOJlAAAAAQEfQEIPAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIIbThUhSzYr7ph6Z434bdcW7eoirYOFMmUt2GXZ79sF/AQ8EAQAAAAEQBP3///8M/AlsaWdodG5pbmcBCMCDK/6LyRi8AAEDCFg+DwAAAAAAAQQiACDYM+8ZRsbTj0OCG/yzqLt2buFQn9LuMPDZqFFcgmCmfAz8CWxpZ2h0bmluZwEIchtFHfZ5FBgA", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] + "request": { + "id": "example:openchannel_init#1", + "method": "openchannel_init", + "params": { + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "amount": 999000, + "initialpsbt": "cHNidP8BADMCAAAAAYbThUhSzYr7ph6Z434bdcW7eoirYOFMmUt2GXZ79sF/AQAAAAD9////AGYAAAAAAQDeAgAAAAABARVD4QKlmwy8SNcNypf1o9TzbIFZjj4dqVzHAL0SLDoTAAAAAAD9////AjOv9ikBAAAAFgAUXJGglH7At5HOVY4ZHp0+19kv655AQg8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgVIxRXqIykOOxm/6YPaFFx2Qh1618qlXPUhDiliVQ2KUCIHQcHniUTcm1XT8SyRE8ev52jm0uiIYum15XcR/tPh+NASEC3Pby7xL4+Ig/Z8TchQ0QT1upLGet3da8qjSjgHO9LOJlAAAAAQEfQEIPAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", + "commitment_feerate": null, + "funding_feerate": null, + "announce": true, + "close_to": null, + "request_amt": null, + "channel_type": [ + 12, + 22 + ] + } }, - "commitments_secured": false, - "funding_serial": 8222241539686471000, - "requires_confirmed_inputs": false + "response": { + "channel_id": "53fa2b1ca0d8f21abeaaac0495ab9925cdfaf2ca8b04dbe4aeb061823e1ff2c8", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABARVD4QKlmwy8SNcNypf1o9TzbIFZjj4dqVzHAL0SLDoTAAAAAAD9////AjOv9ikBAAAAFgAUXJGglH7At5HOVY4ZHp0+19kv655AQg8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgVIxRXqIykOOxm/6YPaFFx2Qh1618qlXPUhDiliVQ2KUCIHQcHniUTcm1XT8SyRE8ev52jm0uiIYum15XcR/tPh+NASEC3Pby7xL4+Ig/Z8TchQ0QT1upLGet3da8qjSjgHO9LOJlAAAAAQEfQEIPAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIIbThUhSzYr7ph6Z434bdcW7eoirYOFMmUt2GXZ79sF/AQ8EAQAAAAEQBP3///8M/AlsaWdodG5pbmcBCMCDK/6LyRi8AAEDCFg+DwAAAAAAAQQiACDYM+8ZRsbTj0OCG/yzqLt2buFQn9LuMPDZqFFcgmCmfAz8CWxpZ2h0bmluZwEIchtFHfZ5FBgA", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "commitments_secured": false, + "funding_serial": 8222241539686471000, + "requires_confirmed_inputs": false + } }, { - "channel_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCLR8RjOq9lmcAAEDCAAAAAEAAAAAAQQiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQz8CWxpZ2h0bmluZwEIZZtc7LD4y9YA", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] + "request": { + "id": "example:openchannel_init#2", + "method": "openchannel_init", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount": 16777216, + "initialpsbt": "cHNidP8BADMCAAAAAQVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAAAAAAD9////AGYAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", + "commitment_feerate": null, + "funding_feerate": null, + "announce": true, + "close_to": null, + "request_amt": null, + "channel_type": null + } }, - "commitments_secured": false, - "funding_serial": 7321547790872006000, - "requires_confirmed_inputs": false + "response": { + "channel_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCLR8RjOq9lmcAAEDCAAAAAEAAAAAAQQiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQz8CWxpZ2h0bmluZwEIZZtc7LD4y9YA", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "commitments_secured": false, + "funding_serial": 7321547790872006000, + "requires_confirmed_inputs": false + } } ], "errors": [ diff --git a/doc/schemas/lightning-openchannel_update.json b/doc/schemas/lightning-openchannel_update.json index 0c430268fbbf..b290634afe5e 100644 --- a/doc/schemas/lightning-openchannel_update.json +++ b/doc/schemas/lightning-openchannel_update.json @@ -184,59 +184,61 @@ "- 311: Unknown channel id.", "- 312: Channel in an invalid state" ], - "example_json_request": [ + "json_example": [ { - "id": "example:openchannel_update#1", - "method": "openchannel_update", - "params": { + "request": { + "id": "example:openchannel_update#1", + "method": "openchannel_update", + "params": { + "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA" + } + }, + "response": { "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA" + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "commitments_secured": true, + "funding_outnum": 0 } }, { - "id": "example:openchannel_update#2", - "method": "openchannel_update", - "params": { + "request": { + "id": "example:openchannel_update#2", + "method": "openchannel_update", + "params": { + "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA" + } + }, + "response": { "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA" + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA", + "channel_type": { + "bits": [ + 12, + 22 + ], + "names": [ + "static_remotekey/even", + "anchors_zero_fee_htlc_tx/even" + ] + }, + "commitments_secured": true, + "funding_outnum": 0, + "close_to": "5120eed745804da9784cc203f563efa99ffa54fdf01b137bc964e63c3124070ffbe6" } } ], - "example_json_response": [ - { - "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] - }, - "commitments_secured": true, - "funding_outnum": 0 - }, - { - "channel_id": "c3a282c1136f44dc2e499c116a9d9e6ea64649c3eabdd396cb96fb30a86fad8e", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDeAgAAAAABAdWZZguGlQJ1eA+d7WAT500jdCzHJWT9J/TGQIkbS1KfAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFE8Xxp4GJggW2lJcsHg0VLolc/Z/AkcwRAIgEQLtA2JvAk7S1R9QD5o4SVNXCjMwTUIyHtu65taC/d4CIEnpq2PdrqKqitdmZj09U8cFuwV+Ba9kmZSUsctSWx8CASECUKP6EBufpaBXT910uYhCcKdw9z8iqHgyKa3uuX2QgmVlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIAVmgyf8sA3N9J6XaH5z7W+GUPDFOM/2L/PuD7iE0RaqAQ8EAAAAAAEQBP3///8M/AlsaWdodG5pbmcBCH932EuFXyxeAAEDCEBCDwAAAAAAAQQiACA/FzDCfUe+WFEBa+aPSY4TZTYt6liPHz5OHo04w2gQ3wz8CWxpZ2h0bmluZwEI42voJCAYLKQA", - "channel_type": { - "bits": [ - 12, - 22 - ], - "names": [ - "static_remotekey/even", - "anchors_zero_fee_htlc_tx/even" - ] - }, - "commitments_secured": true, - "funding_outnum": 0, - "close_to": "5120eed745804da9784cc203f563efa99ffa54fdf01b137bc964e63c3124070ffbe6" - } - ], "author": [ "Lisa Neigut <> is mainly responsible." ], diff --git a/doc/schemas/lightning-parsefeerate.json b/doc/schemas/lightning-parsefeerate.json index 378c835dbb28..aa3bcef01c2d 100644 --- a/doc/schemas/lightning-parsefeerate.json +++ b/doc/schemas/lightning-parsefeerate.json @@ -32,48 +32,54 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:parsefeerate#1", - "method": "parsefeerate", - "params": [ - "unilateral_close" - ] - }, - { - "id": "example:parsefeerate#2", - "method": "parsefeerate", - "params": [ - "9999perkw" - ] - }, - { - "id": "example:parsefeerate#3", - "method": "parsefeerate", - "params": [ - 10000 - ] - }, - { - "id": "example:parsefeerate#4", - "method": "parsefeerate", - "params": [ - "urgent" - ] - } - ], - "example_json_response": [ - { - "perkw": 11000 + "request": { + "id": "example:parsefeerate#1", + "method": "parsefeerate", + "params": [ + "unilateral_close" + ] + }, + "response": { + "perkw": 11000 + } }, { - "perkw": 9999 + "request": { + "id": "example:parsefeerate#2", + "method": "parsefeerate", + "params": [ + "9999perkw" + ] + }, + "response": { + "perkw": 9999 + } }, { - "perkw": 2500 + "request": { + "id": "example:parsefeerate#3", + "method": "parsefeerate", + "params": [ + 10000 + ] + }, + "response": { + "perkw": 2500 + } }, { - "perkw": 11000 + "request": { + "id": "example:parsefeerate#4", + "method": "parsefeerate", + "params": [ + "urgent" + ] + }, + "response": { + "perkw": 11000 + } } ], "errors": [ diff --git a/doc/schemas/lightning-pay.json b/doc/schemas/lightning-pay.json index b114328ed193..6ada1a8ef18e 100644 --- a/doc/schemas/lightning-pay.json +++ b/doc/schemas/lightning-pay.json @@ -223,38 +223,38 @@ "", "The *data* field of errors will include statistics *getroute_tries* and *sendpay_tries*. It will also contain a *failures* field with detailed data about routing errors." ], - "example_json_request": [ + "json_example": [ { - "id": "example:pay#1", - "method": "pay", - "params": { - "bolt11": "lni1qqgxr7gha7gusyg83lsr8qcqg4axgq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqtypg3hgetnwsszycn0d36rzv3zypjx2umrwf5hqarfdahzcg8sn7jmpuyl423pvggzvmj9nrga83q474e2sjygxzmq7ln5fmvjxh4skxafx2pmx9wqx5v9qgqxyfhyvyg6pdvu4tcjvpp7kkal9rp57wj7xv4pl3ajku70rzy3pavzzqjz06c8s2vvmrpjlkcse0txx0gmc6jalqqxmeyjm75qcnfnqxwyt2sfsqnxu3vc68fug904w25y3zpskc8huazwmy34av93h2fjswe3tsp4rqpe8qlx9xssexfc0aguke3q6u0jgw2qmn008mzu04mkmqmjmhes3gcpqdqdnzl270s48vsp635rd4jm04snvgkcp65qlkgp8qztu2mdp7c5uqpj2rll3pzu56st537rct3v62gfqeamzthjuwkr0pkvsdnnffpn4sq9sz0lryaufktx0nfxlffum3yesqev5gwqqqqqqqqqqqqqqqzsqqqqqqqqqqqqr5jt9hav2gqqqqqq5szxtvwkyz5zq2000hlwvadejz366lqjt9sd2j4rf5tfd9rgmmyegt4dqd34cf6v4gqkfvppqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq633uzqn3n74ccym4wcvq20vsx7lmk450kprpvlrh4cukk8xy9ptjcef4rnhytnkyn4vnxxtd57yeaksze2s30y26cs6u3rjd9322eg9puk24q", - "amount_msat": null, - "label": null, - "riskfactor": null, - "maxfeepercent": null, - "retry_for": null, - "maxdelay": null, - "exemptfee": null, - "localinvreqid": null, - "exclude": null, - "maxfee": null, - "description": null + "request": { + "id": "example:pay#1", + "method": "pay", + "params": { + "bolt11": "lni1qqgxr7gha7gusyg83lsr8qcqg4axgq3qqc3xu3s3rg94nj40zfsy866mhu5vxne6tcej5878k2mneuvgjy8ssqtypg3hgetnwsszycn0d36rzv3zypjx2umrwf5hqarfdahzcg8sn7jmpuyl423pvggzvmj9nrga83q474e2sjygxzmq7ln5fmvjxh4skxafx2pmx9wqx5v9qgqxyfhyvyg6pdvu4tcjvpp7kkal9rp57wj7xv4pl3ajku70rzy3pavzzqjz06c8s2vvmrpjlkcse0txx0gmc6jalqqxmeyjm75qcnfnqxwyt2sfsqnxu3vc68fug904w25y3zpskc8huazwmy34av93h2fjswe3tsp4rqpe8qlx9xssexfc0aguke3q6u0jgw2qmn008mzu04mkmqmjmhes3gcpqdqdnzl270s48vsp635rd4jm04snvgkcp65qlkgp8qztu2mdp7c5uqpj2rll3pzu56st537rct3v62gfqeamzthjuwkr0pkvsdnnffpn4sq9sz0lryaufktx0nfxlffum3yesqev5gwqqqqqqqqqqqqqqqzsqqqqqqqqqqqqr5jt9hav2gqqqqqq5szxtvwkyz5zq2000hlwvadejz366lqjt9sd2j4rf5tfd9rgmmyegt4dqd34cf6v4gqkfvppqfnwgkvdr57yzh6h92zg3qctvrm7w38djg67kzcm4yeg8vc4cq633uzqn3n74ccym4wcvq20vsx7lmk450kprpvlrh4cukk8xy9ptjcef4rnhytnkyn4vnxxtd57yeaksze2s30y26cs6u3rjd9322eg9puk24q", + "amount_msat": null, + "label": null, + "riskfactor": null, + "maxfeepercent": null, + "retry_for": null, + "maxdelay": null, + "exemptfee": null, + "localinvreqid": null, + "exclude": null, + "maxfee": null, + "description": null + } + }, + "response": { + "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "payment_hash": "29ef7dfee675b990a3ad7c125960d54aa34d16969468dec9942ead03635c274c", + "created_at": 1706153504.76628, + "parts": 1, + "amount_msat": 100, + "amount_sent_msat": 100, + "payment_preimage": "6634c1b549c6615d234832f377e06d5a5ab088c40cebdc5cfb8c1262030abcad", + "status": "complete" } } ], - "example_json_response": [ - { - "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "payment_hash": "29ef7dfee675b990a3ad7c125960d54aa34d16969468dec9942ead03635c274c", - "created_at": 1706153504.76628, - "parts": 1, - "amount_msat": 100, - "amount_sent_msat": 100, - "payment_preimage": "6634c1b549c6615d234832f377e06d5a5ab088c40cebdc5cfb8c1262030abcad", - "status": "complete" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-ping.json b/doc/schemas/lightning-ping.json index 7d2fef724cc7..e39fe4f3c483 100644 --- a/doc/schemas/lightning-ping.json +++ b/doc/schemas/lightning-ping.json @@ -47,22 +47,32 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:ping#1", - "method": "ping", - "params": { - "len": 128, - "pongbytes": 128 + "request": { + "id": "example:ping#1", + "method": "ping", + "params": { + "len": 128, + "pongbytes": 128 + } + }, + "response": { + "totlen": 132 } }, { - "id": "example:ping#2", - "method": "ping", - "params": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "len": 1000, - "pongbytes": 65535 + "request": { + "id": "example:ping#2", + "method": "ping", + "params": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "len": 1000, + "pongbytes": 65535 + } + }, + "response": { + "totlen": 0 } } ], @@ -71,14 +81,6 @@ "", "- -32602: Error in given parameters or we're already waiting for a ping response from peer." ], - "example_json_response": [ - { - "totlen": 132 - }, - { - "totlen": 0 - } - ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." diff --git a/doc/schemas/lightning-plugin.json b/doc/schemas/lightning-plugin.json index e294c1fda836..dd9eeabd9af2 100644 --- a/doc/schemas/lightning-plugin.json +++ b/doc/schemas/lightning-plugin.json @@ -172,107 +172,109 @@ "errors": [ "On error, the reason why the action could not be taken upon the plugin is returned." ], - "example_json_request": [ + "json_example": [ { - "id": "example:plugin#1", - "method": "plugin", - "params": [ - "list" - ] - }, - { - "id": "example:plugin#2", - "method": "plugin", - "params": { - "subcommand": "stop", - "plugin": "fail_htlcs.py" + "request": { + "id": "example:plugin#1", + "method": "plugin", + "params": [ + "list" + ] + }, + "response": { + "command": "list", + "plugins": [ + { + "name": "~/lightning/plugins/autoclean", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/chanbackup", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/bcli", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/commando", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/funder", + "active": true, + "dynamic": true + }, + { + "name": "~/lightning/plugins/topology", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/keysend", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/offers", + "active": true, + "dynamic": true + }, + { + "name": "~/lightning/plugins/pay", + "active": true, + "dynamic": true + }, + { + "name": "~/lightning/plugins/txprepare", + "active": true, + "dynamic": true + }, + { + "name": "~/lightning/plugins/cln-renepay", + "active": true, + "dynamic": true + }, + { + "name": "~/lightning/plugins/spenderp", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/plugins/sql", + "active": true, + "dynamic": true + }, + { + "name": "~/lightning/plugins/bookkeeper", + "active": true, + "dynamic": false + }, + { + "name": "~/lightning/target/debug/examples/cln-plugin-startup", + "active": true, + "dynamic": false + } + ] } - } - ], - "example_json_response": [ - { - "command": "list", - "plugins": [ - { - "name": "~/lightning/plugins/autoclean", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/chanbackup", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/bcli", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/commando", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/funder", - "active": true, - "dynamic": true - }, - { - "name": "~/lightning/plugins/topology", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/keysend", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/offers", - "active": true, - "dynamic": true - }, - { - "name": "~/lightning/plugins/pay", - "active": true, - "dynamic": true - }, - { - "name": "~/lightning/plugins/txprepare", - "active": true, - "dynamic": true - }, - { - "name": "~/lightning/plugins/cln-renepay", - "active": true, - "dynamic": true - }, - { - "name": "~/lightning/plugins/spenderp", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/plugins/sql", - "active": true, - "dynamic": true - }, - { - "name": "~/lightning/plugins/bookkeeper", - "active": true, - "dynamic": false - }, - { - "name": "~/lightning/target/debug/examples/cln-plugin-startup", - "active": true, - "dynamic": false - } - ] }, { - "command": "stop", - "result": "Successfully stopped fail_htlcs.py." + "request": { + "id": "example:plugin#2", + "method": "plugin", + "params": { + "subcommand": "stop", + "plugin": "fail_htlcs.py" + } + }, + "response": { + "command": "stop", + "result": "Successfully stopped fail_htlcs.py." + } } ], "author": [ diff --git a/doc/schemas/lightning-recover.json b/doc/schemas/lightning-recover.json index d83631939f75..7ce3502bc426 100644 --- a/doc/schemas/lightning-recover.json +++ b/doc/schemas/lightning-recover.json @@ -38,28 +38,30 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:recover#1", - "method": "recover", - "params": { - "hsmsecret": "cl10leetsd35kw6r5de5kueedxgqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqdeuq7xuh94k9g" - } + "request": { + "id": "example:recover#1", + "method": "recover", + "params": { + "hsmsecret": "cl10leetsd35kw6r5de5kueedxgqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqdeuq7xuh94k9g" + } + }, + "response": {} }, { - "id": "example:recover#2", - "method": "recover", - "params": { - "hsmsecret": "6c696768746e696e672d31000000000000000000000000000000000000000000" + "request": { + "id": "example:recover#2", + "method": "recover", + "params": { + "hsmsecret": "6c696768746e696e672d31000000000000000000000000000000000000000000" + } + }, + "response": { + "result": "Recovery restart in progress" } } ], - "example_json_response": [ - {}, - { - "result": "Recovery restart in progress" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-recoverchannel.json b/doc/schemas/lightning-recoverchannel.json index 168731ccc9de..1ff6ca9799c8 100644 --- a/doc/schemas/lightning-recoverchannel.json +++ b/doc/schemas/lightning-recoverchannel.json @@ -41,22 +41,22 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:recoverchannel#1", - "method": "recoverchannel", - "params": [ - [ - "0000000000000001c3a7b9d74a174497122bc52d74d6d69836acadc77e0429c6d8b68b48d5c9139a022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d5904017f0000019f0bc3a7b9d74a174497122bc52d74d6d69836acadc77e0429c6d8b68b48d5c9139a0000000000000000000186a000021000" + "request": { + "id": "example:recoverchannel#1", + "method": "recoverchannel", + "params": [ + [ + "0000000000000001c3a7b9d74a174497122bc52d74d6d69836acadc77e0429c6d8b68b48d5c9139a022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d5904017f0000019f0bc3a7b9d74a174497122bc52d74d6d69836acadc77e0429c6d8b68b48d5c9139a0000000000000000000186a000021000" + ] ] - ] - } - ], - "example_json_response": [ - { - "stubs": [ - "c3a7b9d74a174497122bc52d74d6d69836acadc77e0429c6d8b68b48d5c9139a" - ] + }, + "response": { + "stubs": [ + "c3a7b9d74a174497122bc52d74d6d69836acadc77e0429c6d8b68b48d5c9139a" + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-renepay.json b/doc/schemas/lightning-renepay.json index 23453afb87e9..10505d5eda41 100644 --- a/doc/schemas/lightning-renepay.json +++ b/doc/schemas/lightning-renepay.json @@ -161,45 +161,47 @@ "- 210: Payment timed out without a payment in progress.", "- 212: Invoice is invalid." ], - "example_json_request": [ + "json_example": [ { - "id": "example:renepay#1", - "method": "renepay", - "params": { - "invstring": "lnbcrt1230n1pjmxj9jsp5suc4cag0lv3wemllkvms56e6ll0w867cczqfttuu8cpfl089f9kspp56wvxtdh8fxg5r5y3kg3klxceakqaydskwzatga25v95da8nzkmwqdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqkmyhymt0j7hy38vzqxx465s4ys0fg78flnjqfx4clvdq9mrmgglpcnjrrnhtk7maa87pfvjez88hke8w97zvuecwswaf9gzyqlsthegpza67eu" + "request": { + "id": "example:renepay#1", + "method": "renepay", + "params": { + "invstring": "lnbcrt1230n1pjmxj9jsp5suc4cag0lv3wemllkvms56e6ll0w867cczqfttuu8cpfl089f9kspp56wvxtdh8fxg5r5y3kg3klxceakqaydskwzatga25v95da8nzkmwqdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqkmyhymt0j7hy38vzqxx465s4ys0fg78flnjqfx4clvdq9mrmgglpcnjrrnhtk7maa87pfvjez88hke8w97zvuecwswaf9gzyqlsthegpza67eu" + } + }, + "response": { + "payment_preimage": "0a3fd704b34f47d6e306dbac78141753be83848d3a19725c972abfc367dcc591", + "payment_hash": "d39865b6e7499141d091b2236f9b19ed81d2361670bab475546168de9e62b6dc", + "created_at": 1706248370.6267352, + "parts": 1, + "amount_msat": 123000, + "amount_sent_msat": 123000, + "status": "complete", + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" } }, { - "id": "example:renepay#2", - "method": "renepay", - "params": { - "invstring": "lnbcrt1pja0f9asp50kzadmeyy78eymjvhnlk5dznl3g5k5x8agh52ewjtg0jclas4ylspp5crsutd9hg05lxyhzphdcuyng6z3knrsdae83mxwawa842gz3vj3sdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqr5yzhxmup4muyaz6x8u2dy4qyu9t5qzuf5k9xayvj5kg7tve60gjk4jrv2l76exnj2xkuzhtwky23pkkxedzy6p9yrsgyqdwj7dv5gsp4zcw6v", - "amount_msat": 548925 + "request": { + "id": "example:renepay#2", + "method": "renepay", + "params": { + "invstring": "lnbcrt1pja0f9asp50kzadmeyy78eymjvhnlk5dznl3g5k5x8agh52ewjtg0jclas4ylspp5crsutd9hg05lxyhzphdcuyng6z3knrsdae83mxwawa842gz3vj3sdqjv3jhxcmjd9c8g6t0dcxqyjw5qcqp99qxpqysgqr5yzhxmup4muyaz6x8u2dy4qyu9t5qzuf5k9xayvj5kg7tve60gjk4jrv2l76exnj2xkuzhtwky23pkkxedzy6p9yrsgyqdwj7dv5gsp4zcw6v", + "amount_msat": 548925 + } + }, + "response": { + "payment_preimage": "a635e92d024beebfc58519e6544888aa560ba3bcaba7e74924e4b8432eaa56f5", + "payment_hash": "c0e1c5b4b743e9f312e20ddb8e1268d0a3698e0dee4f1d99dd774f55205164a3", + "created_at": 1708631229.7841823, + "parts": 1, + "amount_msat": 548925, + "amount_sent_msat": 548925, + "status": "complete", + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" } } ], - "example_json_response": [ - { - "payment_preimage": "0a3fd704b34f47d6e306dbac78141753be83848d3a19725c972abfc367dcc591", - "payment_hash": "d39865b6e7499141d091b2236f9b19ed81d2361670bab475546168de9e62b6dc", - "created_at": 1706248370.6267352, - "parts": 1, - "amount_msat": 123000, - "amount_sent_msat": 123000, - "status": "complete", - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" - }, - { - "payment_preimage": "a635e92d024beebfc58519e6544888aa560ba3bcaba7e74924e4b8432eaa56f5", - "payment_hash": "c0e1c5b4b743e9f312e20ddb8e1268d0a3698e0dee4f1d99dd774f55205164a3", - "created_at": 1708631229.7841823, - "parts": 1, - "amount_msat": 548925, - "amount_sent_msat": 548925, - "status": "complete", - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59" - } - ], "author": [ "Eduardo Quintana-Miranda <> is mainly responsible." ], diff --git a/doc/schemas/lightning-reserveinputs.json b/doc/schemas/lightning-reserveinputs.json index 6a603bf11efb..dfc9fb11bf65 100644 --- a/doc/schemas/lightning-reserveinputs.json +++ b/doc/schemas/lightning-reserveinputs.json @@ -95,125 +95,127 @@ "", "- -32602: Invalid parameter, such as specifying a spent/reserved input in *psbt*." ], - "example_json_request": [ + "json_example": [ { - "id": "example:reserveinputs#1", - "method": "reserveinputs", - "params": { - "psbt": "cHNidP8BAFwCAAAAAkwJVUqB0xXTO7JZ3PnPdGnxoYfQxhU+xqXGFYXsyX0RAAAAAAD9////TAlVSoHTFdM7slnc+c90afGhh9DGFT7GpcYVhezJfREBAAAAAP3///8AAAAAAAAAAA==", - "exclusive": true, - "reserve": null - } - }, - { - "id": "example:reserveinputs#2", - "method": "reserveinputs", - "params": { - "psbt": "cHNidP8BAP32AQIAAAAMgnW099dbh1uD153ih5eU5WhluynLxekXjAOjkEdNBg8BAAAAAP3///9FWKQt8C+1y4741+beFSqWAaj9DuvzHNpxvpxS+GB8lwEAAAAA/f///6E5TAGqktI29Oso6b9kZZoAFFGGvpJQUM8VO+3LMTlmAAAAAAD9////nSDT7hrkuoQtAV1yNnbpkJsB5ifKoM2zP+CcLPfis1gBAAAAAP3///+P1rW90UXfD0gIk58h3sXxxy3ZfJJLP0H1I4Jpzy/87QEAAAAA/f///w0UKZ/s9DnPpV+FJ8h2BEI7tl+qVxSGRFRv9FYw4girAQAAAAD9////EPNsUFrEOZyfjbqbh8rfHQ4C9RQECw12n3c1yhFqkzoAAAAAAP3///8QW9LEsSmuvSnvVzy+FDktM7ewQmZnIJI/TJMahLmSzwEAAAAA/f///+4edbWRHDdRJcMeHHElgSmb+nENPsz/g/0AmAEU6hXeAAAAAAD9////T15YLGmk7HBsrL+awdcxi3db3esp8AcCTS9XGrEnfoAAAAAAAP3///8q7xInvEk7J0Ir9cpKXqU2lArUskkYLrimIE0+Yb6a2QEAAAAA/f///8hBLKyMa2zRJqwNOk7DmsDIfG7IvJtQiJ+QnkkHl6atAAAAAAD9////AAAAAAAAAAAAAAAAAAAAAAAA", - "exclusive": false, - "reserve": null - } - } - ], - "example_json_response": [ - { - "reservations": [ - { - "txid": "117dc9ec8515c6a5c63e15c6d087a1f16974cff9dc59b23bd315d3814a55094c", - "vout": 1, - "was_reserved": false, - "reserved": true, - "reserved_to_block": 175 + "request": { + "id": "example:reserveinputs#1", + "method": "reserveinputs", + "params": { + "psbt": "cHNidP8BAFwCAAAAAkwJVUqB0xXTO7JZ3PnPdGnxoYfQxhU+xqXGFYXsyX0RAAAAAAD9////TAlVSoHTFdM7slnc+c90afGhh9DGFT7GpcYVhezJfREBAAAAAP3///8AAAAAAAAAAA==", + "exclusive": true, + "reserve": null } - ] + }, + "response": { + "reservations": [ + { + "txid": "117dc9ec8515c6a5c63e15c6d087a1f16974cff9dc59b23bd315d3814a55094c", + "vout": 1, + "was_reserved": false, + "reserved": true, + "reserved_to_block": 175 + } + ] + } }, { - "reservations": [ - { - "txid": "0f064d4790a3038c17e9c5cb29bb6568e5949787e29dd7835b875bd7f7b47582", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "977c60f8529cbe71da1cf3eb0efda801962a15dee6d7f88ecbb52ff02da45845", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "663931cbed3b15cf505092be865114009a6564bfe928ebf436d292aa014c39a1", - "vout": 0, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "58b3e2f72c9ce03fb3cda0ca27e6019b90e97636725d012d84bae41aeed3209d", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "edfc2fcf698223f5413f4b927cd92dc7f1c5de219f9308480fdf45d1bdb5d68f", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "ab08e23056f46f5444861457aa5fb63b420476c827855fa5cf39f4ec9f29140d", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "3a936a11ca35779f760d0b0414f5020e1ddfca879bba8d9f9c39c45a506cf310", - "vout": 0, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "cf92b9841a934c3f9220676642b0b7332d3914be3c57ef29bdae29b1c4d25b10", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "de15ea14019800fd83ffcc3e0d71fa9b298125711c1ec32551371c91b5751eee", - "vout": 0, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "807e27b11a572f4d0207f029ebdd5b778b31d7c19abfac6c70eca4692c585e4f", - "vout": 0, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "d99abe613e4d20a6b82e1849b2d40a9436a55e4acaf52b42273b49bc2712ef2a", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "ada69707499e909f88509bbcc86e7cc8c09ac34e3a0dac26d16c6b8cac2c41c8", - "vout": 0, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 + "request": { + "id": "example:reserveinputs#2", + "method": "reserveinputs", + "params": { + "psbt": "cHNidP8BAP32AQIAAAAMgnW099dbh1uD153ih5eU5WhluynLxekXjAOjkEdNBg8BAAAAAP3///9FWKQt8C+1y4741+beFSqWAaj9DuvzHNpxvpxS+GB8lwEAAAAA/f///6E5TAGqktI29Oso6b9kZZoAFFGGvpJQUM8VO+3LMTlmAAAAAAD9////nSDT7hrkuoQtAV1yNnbpkJsB5ifKoM2zP+CcLPfis1gBAAAAAP3///+P1rW90UXfD0gIk58h3sXxxy3ZfJJLP0H1I4Jpzy/87QEAAAAA/f///w0UKZ/s9DnPpV+FJ8h2BEI7tl+qVxSGRFRv9FYw4girAQAAAAD9////EPNsUFrEOZyfjbqbh8rfHQ4C9RQECw12n3c1yhFqkzoAAAAAAP3///8QW9LEsSmuvSnvVzy+FDktM7ewQmZnIJI/TJMahLmSzwEAAAAA/f///+4edbWRHDdRJcMeHHElgSmb+nENPsz/g/0AmAEU6hXeAAAAAAD9////T15YLGmk7HBsrL+awdcxi3db3esp8AcCTS9XGrEnfoAAAAAAAP3///8q7xInvEk7J0Ir9cpKXqU2lArUskkYLrimIE0+Yb6a2QEAAAAA/f///8hBLKyMa2zRJqwNOk7DmsDIfG7IvJtQiJ+QnkkHl6atAAAAAAD9////AAAAAAAAAAAAAAAAAAAAAAAA", + "exclusive": false, + "reserve": null } - ] + }, + "response": { + "reservations": [ + { + "txid": "0f064d4790a3038c17e9c5cb29bb6568e5949787e29dd7835b875bd7f7b47582", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "977c60f8529cbe71da1cf3eb0efda801962a15dee6d7f88ecbb52ff02da45845", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "663931cbed3b15cf505092be865114009a6564bfe928ebf436d292aa014c39a1", + "vout": 0, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "58b3e2f72c9ce03fb3cda0ca27e6019b90e97636725d012d84bae41aeed3209d", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "edfc2fcf698223f5413f4b927cd92dc7f1c5de219f9308480fdf45d1bdb5d68f", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "ab08e23056f46f5444861457aa5fb63b420476c827855fa5cf39f4ec9f29140d", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "3a936a11ca35779f760d0b0414f5020e1ddfca879bba8d9f9c39c45a506cf310", + "vout": 0, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "cf92b9841a934c3f9220676642b0b7332d3914be3c57ef29bdae29b1c4d25b10", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "de15ea14019800fd83ffcc3e0d71fa9b298125711c1ec32551371c91b5751eee", + "vout": 0, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "807e27b11a572f4d0207f029ebdd5b778b31d7c19abfac6c70eca4692c585e4f", + "vout": 0, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "d99abe613e4d20a6b82e1849b2d40a9436a55e4acaf52b42273b49bc2712ef2a", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "ada69707499e909f88509bbcc86e7cc8c09ac34e3a0dac26d16c6b8cac2c41c8", + "vout": 0, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-sendcustommsg.json b/doc/schemas/lightning-sendcustommsg.json index 906c207773a7..c0d160156bbb 100644 --- a/doc/schemas/lightning-sendcustommsg.json +++ b/doc/schemas/lightning-sendcustommsg.json @@ -48,21 +48,21 @@ "If any of the above limitations is not respected the method returns an explicit error message stating the issue." ] }, - "example_json_request": [ + "json_example": [ { - "id": "example:sendcustommsg#5", - "method": "sendcustommsg", - "params": { - "node_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "msg": "77770012" + "request": { + "id": "example:sendcustommsg#5", + "method": "sendcustommsg", + "params": { + "node_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "msg": "77770012" + } + }, + "response": { + "status": "Message sent to connectd for delivery" } } ], - "example_json_response": [ - { - "status": "Message sent to connectd for delivery" - } - ], "author": [ "Christian Decker <> is mainly responsible." ], diff --git a/doc/schemas/lightning-sendinvoice.json b/doc/schemas/lightning-sendinvoice.json index a2c7cc569574..8fb09995c5a8 100644 --- a/doc/schemas/lightning-sendinvoice.json +++ b/doc/schemas/lightning-sendinvoice.json @@ -198,33 +198,33 @@ "- 1004: The node making the offer returned an error message.", "- 1005: We timed out waiting for the invoice to be paid" ], - "example_json_request": [ + "json_example": [ { - "id": "example:sendinvoice#1", - "method": "sendinvoice", - "params": { - "invreq": "lnr1qqg804wzdsyn8g4mf2yc22k8xvjpjzstwd5k6urvv5s8getnw3gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02gqsykppqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4nuzqw5w7y7xqm2rushk5a5n3mcuvqel954raykd5nqa830nq9hpd4s4fcnxw266vp9d5c8f3m3w40hmm6gm8akxx3rsnr7d4usunv0x3q8q", - "label": "payme for real!" + "request": { + "id": "example:sendinvoice#1", + "method": "sendinvoice", + "params": { + "invreq": "lnr1qqg804wzdsyn8g4mf2yc22k8xvjpjzstwd5k6urvv5s8getnw3gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02gqsykppqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4nuzqw5w7y7xqm2rushk5a5n3mcuvqel954raykd5nqa830nq9hpd4s4fcnxw266vp9d5c8f3m3w40hmm6gm8akxx3rsnr7d4usunv0x3q8q", + "label": "payme for real!" + } + }, + "response": { + "label": "payme for real!", + "bolt12": "lni1qqg804wzdsyn8g4mf2yc22k8xvjpjzstwd5k6urvv5s8getnw3gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02gqsykppqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4ngycqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky96qmcmtl30xtt7jdakfyhzm8f0gny6f4d2ukx5gurem04z8lfd2wza5qs9pz6wp9vu7cm6n4wmmrz77y4w6z5xv4q93yudkdtkl5zmzdzuawzqqex7gd5v0x0r83pqj82udd542fl4krh50s0dkx47d0hd5wh77g52xxl75ccpkt35mc8n282wslju9ufyys2y8qqqqqqqqqqqqqqqpgqqqqqqqqqqqqp6f9jm7k9yqqqqqq2gpr96l99lfspt25zqnyfgu7hznmt2tzkjdt92d2wc3dsq7keph7w8gudjs46spfzqrlu4gqs9vppqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky9muzqpze8kk43g0wh4h8qlac5lswwesrvsaxcza2f5j90c2h3ts8yzmn9g4mxqe89fngrqny8nf52xxuxep6548etda8lp876jr0nnxgdkdq", + "payment_hash": "4c89473d714f6b52c56935655354ec45b007ad90dfce3a38d942ba8052200ffc", + "amount_msat": 2, + "status": "paid", + "pay_index": 1, + "amount_received_msat": 2, + "paid_at": 1708640865, + "payment_preimage": "305951ab02cb2ea5eb884dbfd8fb110b4e088ecb8338b3e84e8f9c70919c19bf", + "description": "simple test", + "expires_at": 1708640953, + "created_index": 2, + "updated_index": 1 } } ], - "example_json_response": [ - { - "label": "payme for real!", - "bolt12": "lni1qqg804wzdsyn8g4mf2yc22k8xvjpjzstwd5k6urvv5s8getnw3gzqp3zderpzxstt8927ynqg044h0egcd8n5h3n9g0u0v4h8ncc3yg02gqsykppqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4ngycqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky96qmcmtl30xtt7jdakfyhzm8f0gny6f4d2ukx5gurem04z8lfd2wza5qs9pz6wp9vu7cm6n4wmmrz77y4w6z5xv4q93yudkdtkl5zmzdzuawzqqex7gd5v0x0r83pqj82udd542fl4krh50s0dkx47d0hd5wh77g52xxl75ccpkt35mc8n282wslju9ufyys2y8qqqqqqqqqqqqqqqpgqqqqqqqqqqqqp6f9jm7k9yqqqqqq2gpr96l99lfspt25zqnyfgu7hznmt2tzkjdt92d2wc3dsq7keph7w8gudjs46spfzqrlu4gqs9vppqdwjkyvjm7apxnssu4qgwhfkd67ghs6n6k48v6uqczgt88p6tky9muzqpze8kk43g0wh4h8qlac5lswwesrvsaxcza2f5j90c2h3ts8yzmn9g4mxqe89fngrqny8nf52xxuxep6548etda8lp876jr0nnxgdkdq", - "payment_hash": "4c89473d714f6b52c56935655354ec45b007ad90dfce3a38d942ba8052200ffc", - "amount_msat": 2, - "status": "paid", - "pay_index": 1, - "amount_received_msat": 2, - "paid_at": 1708640865, - "payment_preimage": "305951ab02cb2ea5eb884dbfd8fb110b4e088ecb8338b3e84e8f9c70919c19bf", - "description": "simple test", - "expires_at": 1708640953, - "created_index": 2, - "updated_index": 1 - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-sendonion.json b/doc/schemas/lightning-sendonion.json index bcd7656e13fd..6ce98656566c 100644 --- a/doc/schemas/lightning-sendonion.json +++ b/doc/schemas/lightning-sendonion.json @@ -312,42 +312,42 @@ "", "the error details are decrypted and presented here, if *shared_secrets* was provided and an error was returned by one of the intermediate nodes" ], - "example_json_request": [ + "json_example": [ { - "id": "example:sendonion#1", - "method": "sendonion", - "params": { - "onion": "00034928294556b10308f9aeac7a240223d4d5f72097db1ef36a36b10cab937f2f205ed7218b47d4600eaf7fd390940bf9a6cdac99aafdb4783c468150eeeab9b57e56a06778d023ffb3bb84c7d8c2ad8868b61c28b566634af52c288ed6569583db66f5bd0edfb801c252f078020e1df6359af5969296b4698a71d17c5ca6e5ee4b64b7cce3ad0a1aa31e6be4d5fe3a31fa7a25259c640716020a9a248ca3ebb68eb823f8884b5df3710969f4c2ffb153779a923bab946ed43c1f6658d7f8e7e25303bb78ef4862fb550b8b1c79d522b035eedfda9ab70a61322522acf7233bb8ea2423958448fc8ac3d000835fda04bf661f1bf2ad2d091f506840bb2f10f82c0812149d99267a47824defe90877ed70db526b2200e18dccb92b17516de3778c055645728eadf4c74375aa0aae80a7773a536a908ca1e25c0fdca90e50ce0be05eeb973ec5e83ce3ab6b35818e021780428af81320a694483c1c15f64e685ba1fd3b1e1b926e6b4ec9eeeac8aca60c60e0f0f583e35e7f081dc6f4c64157e100c79c4c25101bed77cd9f93416f9a67d9f1916a782c498c38365af4a5fabb1b745fa840a054a06564c3f4b376aeb72cdd059d3794c82bbbf12a1f62234016a6912b384e7e4cebbd39ee4395aeff43c461e226d1e0151cce508a181a9c61275bf4b89e4556cf24df13b993dec96541555f8b9a699be9488568a11ac7f25849da62765472511ad74a6660c10e37f5fa13d4e4665ef7825ae1f2da4a86d5581912262de89b4b11a722fd127b31aa0d7fab8c679b07bf95e65cb80b2dacb5b90794399fb8f23823f68058431aa1c399b5baceccaf8521d004f45dba6ec1fddc54473343e9e67cd50cc3f2f3d8a5dab8a7ab9ae553dc3cd34e74b858da75975265f7c673a25e8d01a5130ab40eaba712b80c608cd0431b4b45ea0d81af595e21f24976608429127bf586f7507666500bc7245cf9266fa0bd0e58404c496e190c873cd143ace9048e9d5021c23967a24e09f2e54166e54b4ee8888dc1af535624e7ee8b426c1628175017a9e8a73eb1d0d49028a4f4d77897f3c08f1cd7bdee2b00f9bb9eadc49a69bf4f6c0cb2c95a16f03d7958f1b8f83cb40ae87ddf75f26050e2c2ed9f8f8523b3d389a50b217bda651dc21f095fe7d2d3851a0a6cf01051f3f3c6f1ad59ed46d44928d15a0e6e1bd4df4c99bdb82a05b0e781b69a73bc30fe579c8ac9fe8aeb6beb1c0f44def2775b7341af37e6ef58ceb34958b29d3e36112b78644612228761b8badc802f0b2b8fcaeb1db8f3a8db4afa2d7b4540a7c331db6f5141fa3909a513df875ff8a63f5b542d662781ca96a69e3b2925d6a63555b2c5825ffb2ad848d71122f54110e0d203000f3e9cc23b793c3540dfb8d881caedd25055a8f495e9e7a0391dbf9cbd9344f7df659ee8d3ce5ec16217ab83e1394ba991eb8ffd9a869f8ebb2e2428845e779979c57b5f8875f502728229a55ce87b3eba85c75264d30eaf7b373f6b09ba3086d9e98348d87b049468c2c30a6501cb2a3862f1703bbf29895e8b4262353eae720ed8ae678750011e2eb51f4800d3f4725fa873d7deec1c46f77a5f61c73dc938239e77f432bcc245c7b935413c51c0bc92bdaae144452aa95910909e46e500557961203f4e1483b9c09c124464907825e1ff74c87c58d6e2e91970baac9b89a554beca6df9acee16d77dd929d0caa7797e06f2c384c03fdedc89c697b9c34787a50cf399a8d7f195e79b347efc8267c474a477ce210f11049d432b280eaf3fccd451f6218d35c64cbd1006bcc54eeea8b856855c9aa92bc3adc6900a7c7a0eee09834c5a1f2da3d8ea9a478aea90c954952ad2a72d3856350ac3132d17e1e8116fa774066a22c857a827699c98285111a405e74685a3ae579ae78c545774f45491e4935bf4", - "first_hop": { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "channel": "103x3x0", - "direction": 1, - "amount_msat": 1002, - "delay": 21, - "style": "tlv" - }, + "request": { + "id": "example:sendonion#1", + "method": "sendonion", + "params": { + "onion": "00034928294556b10308f9aeac7a240223d4d5f72097db1ef36a36b10cab937f2f205ed7218b47d4600eaf7fd390940bf9a6cdac99aafdb4783c468150eeeab9b57e56a06778d023ffb3bb84c7d8c2ad8868b61c28b566634af52c288ed6569583db66f5bd0edfb801c252f078020e1df6359af5969296b4698a71d17c5ca6e5ee4b64b7cce3ad0a1aa31e6be4d5fe3a31fa7a25259c640716020a9a248ca3ebb68eb823f8884b5df3710969f4c2ffb153779a923bab946ed43c1f6658d7f8e7e25303bb78ef4862fb550b8b1c79d522b035eedfda9ab70a61322522acf7233bb8ea2423958448fc8ac3d000835fda04bf661f1bf2ad2d091f506840bb2f10f82c0812149d99267a47824defe90877ed70db526b2200e18dccb92b17516de3778c055645728eadf4c74375aa0aae80a7773a536a908ca1e25c0fdca90e50ce0be05eeb973ec5e83ce3ab6b35818e021780428af81320a694483c1c15f64e685ba1fd3b1e1b926e6b4ec9eeeac8aca60c60e0f0f583e35e7f081dc6f4c64157e100c79c4c25101bed77cd9f93416f9a67d9f1916a782c498c38365af4a5fabb1b745fa840a054a06564c3f4b376aeb72cdd059d3794c82bbbf12a1f62234016a6912b384e7e4cebbd39ee4395aeff43c461e226d1e0151cce508a181a9c61275bf4b89e4556cf24df13b993dec96541555f8b9a699be9488568a11ac7f25849da62765472511ad74a6660c10e37f5fa13d4e4665ef7825ae1f2da4a86d5581912262de89b4b11a722fd127b31aa0d7fab8c679b07bf95e65cb80b2dacb5b90794399fb8f23823f68058431aa1c399b5baceccaf8521d004f45dba6ec1fddc54473343e9e67cd50cc3f2f3d8a5dab8a7ab9ae553dc3cd34e74b858da75975265f7c673a25e8d01a5130ab40eaba712b80c608cd0431b4b45ea0d81af595e21f24976608429127bf586f7507666500bc7245cf9266fa0bd0e58404c496e190c873cd143ace9048e9d5021c23967a24e09f2e54166e54b4ee8888dc1af535624e7ee8b426c1628175017a9e8a73eb1d0d49028a4f4d77897f3c08f1cd7bdee2b00f9bb9eadc49a69bf4f6c0cb2c95a16f03d7958f1b8f83cb40ae87ddf75f26050e2c2ed9f8f8523b3d389a50b217bda651dc21f095fe7d2d3851a0a6cf01051f3f3c6f1ad59ed46d44928d15a0e6e1bd4df4c99bdb82a05b0e781b69a73bc30fe579c8ac9fe8aeb6beb1c0f44def2775b7341af37e6ef58ceb34958b29d3e36112b78644612228761b8badc802f0b2b8fcaeb1db8f3a8db4afa2d7b4540a7c331db6f5141fa3909a513df875ff8a63f5b542d662781ca96a69e3b2925d6a63555b2c5825ffb2ad848d71122f54110e0d203000f3e9cc23b793c3540dfb8d881caedd25055a8f495e9e7a0391dbf9cbd9344f7df659ee8d3ce5ec16217ab83e1394ba991eb8ffd9a869f8ebb2e2428845e779979c57b5f8875f502728229a55ce87b3eba85c75264d30eaf7b373f6b09ba3086d9e98348d87b049468c2c30a6501cb2a3862f1703bbf29895e8b4262353eae720ed8ae678750011e2eb51f4800d3f4725fa873d7deec1c46f77a5f61c73dc938239e77f432bcc245c7b935413c51c0bc92bdaae144452aa95910909e46e500557961203f4e1483b9c09c124464907825e1ff74c87c58d6e2e91970baac9b89a554beca6df9acee16d77dd929d0caa7797e06f2c384c03fdedc89c697b9c34787a50cf399a8d7f195e79b347efc8267c474a477ce210f11049d432b280eaf3fccd451f6218d35c64cbd1006bcc54eeea8b856855c9aa92bc3adc6900a7c7a0eee09834c5a1f2da3d8ea9a478aea90c954952ad2a72d3856350ac3132d17e1e8116fa774066a22c857a827699c98285111a405e74685a3ae579ae78c545774f45491e4935bf4", + "first_hop": { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "channel": "103x3x0", + "direction": 1, + "amount_msat": 1002, + "delay": 21, + "style": "tlv" + }, + "payment_hash": "f584c14bb23506acdd94cf3cea377f3cc5805f3cba5430bc3756ef83ede1a0dc", + "label": null, + "shared_secrets": null, + "partid": null, + "bolt11": null, + "amount_msat": null, + "destination": null + } + }, + "response": { + "message": "Monitor status with listpays or waitsendpay", + "created_index": 1, + "id": 1, "payment_hash": "f584c14bb23506acdd94cf3cea377f3cc5805f3cba5430bc3756ef83ede1a0dc", - "label": null, - "shared_secrets": null, - "partid": null, - "bolt11": null, - "amount_msat": null, - "destination": null + "groupid": 1, + "amount_sent_msat": 1002, + "created_at": 1706315098, + "status": "pending" } } ], - "example_json_response": [ - { - "message": "Monitor status with listpays or waitsendpay", - "created_index": 1, - "id": 1, - "payment_hash": "f584c14bb23506acdd94cf3cea377f3cc5805f3cba5430bc3756ef83ede1a0dc", - "groupid": 1, - "amount_sent_msat": 1002, - "created_at": 1706315098, - "status": "pending" - } - ], "author": [ "Christian Decker <> is mainly responsible." ], diff --git a/doc/schemas/lightning-sendpay.json b/doc/schemas/lightning-sendpay.json index d156113f7537..9b3b6291e67f 100644 --- a/doc/schemas/lightning-sendpay.json +++ b/doc/schemas/lightning-sendpay.json @@ -336,97 +336,99 @@ "*failcode*: The failure code, as per BOLT #4.", "*channel_update*: The hex string of the *channel_update* message received from the remote node. Only present if error is from the remote node and the *failcode* has the UPDATE bit set, as per BOLT #4." ], - "example_json_request": [ + "json_example": [ { - "id": "example:sendpay#1", - "method": "sendpay", - "params": { - "route": [ - { - "amount_msat": 11000000, - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "delay": 5, - "channel": "103x1x0" - } - ], + "request": { + "id": "example:sendpay#1", + "method": "sendpay", + "params": { + "route": [ + { + "amount_msat": 11000000, + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "delay": 5, + "channel": "103x1x0" + } + ], + "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", + "label": null, + "amount_msat": null, + "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", + "payment_secret": "82644944d3f70d42aad1d5f7b5d7a629e7afa30b529cc952a4c59fc0e3790ea2", + "partid": null, + "groupid": null, + "payment_metadata": null + } + }, + "response": { + "message": "Monitor status with listpays or waitsendpay", + "created_index": 1, + "id": 1, "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "label": null, - "amount_msat": null, - "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk", - "payment_secret": "82644944d3f70d42aad1d5f7b5d7a629e7afa30b529cc952a4c59fc0e3790ea2", - "partid": null, - "groupid": null, - "payment_metadata": null + "groupid": 1, + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount_msat": 11000000, + "amount_sent_msat": 11000000, + "created_at": 1706152930, + "status": "pending", + "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk" } }, { - "id": "example:sendpay#2", - "method": "sendpay", - "params": { - "route": [ - { - "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "channel": "103x1x0", - "direction": 1, - "amount_msat": 4211, - "style": "tlv", - "delay": 24 - }, - { - "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", - "channel": "105x1x0", - "direction": 0, - "amount_msat": 3710, - "style": "tlv", - "delay": 16 - }, - { - "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "channel": "107x1x0", - "direction": 1, - "amount_msat": 3210, - "style": "tlv", - "delay": 8 - } - ], + "request": { + "id": "example:sendpay#2", + "method": "sendpay", + "params": { + "route": [ + { + "id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "channel": "103x1x0", + "direction": 1, + "amount_msat": 4211, + "style": "tlv", + "delay": 24 + }, + { + "id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d", + "channel": "105x1x0", + "direction": 0, + "amount_msat": 3710, + "style": "tlv", + "delay": 16 + }, + { + "id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "channel": "107x1x0", + "direction": 1, + "amount_msat": 3210, + "style": "tlv", + "delay": 8 + } + ], + "payment_hash": "bc747053329402620a26bdc187cd134cdb699130d85be499ecd24160aff04c5c", + "label": null, + "amount_msat": null, + "bolt11": null, + "payment_secret": "c36a2fe9aced78c06960e2f21b369ed03f0492c97e53ba3b662163bcdaf1d7fa", + "partid": null, + "groupid": null, + "payment_metadata": null + } + }, + "response": { + "message": "Monitor status with listpays or waitsendpay", + "created_index": 2, + "id": 2, "payment_hash": "bc747053329402620a26bdc187cd134cdb699130d85be499ecd24160aff04c5c", - "label": null, - "amount_msat": null, - "bolt11": null, - "payment_secret": "c36a2fe9aced78c06960e2f21b369ed03f0492c97e53ba3b662163bcdaf1d7fa", - "partid": null, - "groupid": null, - "payment_metadata": null + "groupid": 1, + "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "amount_msat": 3210, + "amount_sent_msat": 4211, + "created_at": 1708624260, + "status": "pending" } } ], - "example_json_response": [ - { - "message": "Monitor status with listpays or waitsendpay", - "created_index": 1, - "id": 1, - "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "groupid": 1, - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount_msat": 11000000, - "amount_sent_msat": 11000000, - "created_at": 1706152930, - "status": "pending", - "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk" - }, - { - "message": "Monitor status with listpays or waitsendpay", - "created_index": 2, - "id": 2, - "payment_hash": "bc747053329402620a26bdc187cd134cdb699130d85be499ecd24160aff04c5c", - "groupid": 1, - "destination": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "amount_msat": 3210, - "amount_sent_msat": 4211, - "created_at": 1708624260, - "status": "pending" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-sendpsbt.json b/doc/schemas/lightning-sendpsbt.json index 7f67685daeec..a81a94eab69b 100644 --- a/doc/schemas/lightning-sendpsbt.json +++ b/doc/schemas/lightning-sendpsbt.json @@ -47,20 +47,32 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:sendpsbt#1", - "method": "sendpsbt", - "params": { - "psbt": "some_psbt" + "request": { + "id": "example:sendpsbt#1", + "method": "sendpsbt", + "params": { + "psbt": "some_psbt" + } + }, + "response": { + "txid": "05985072bbe20747325e69a159fe08176cc1bbc96d25e8848edad2dddc1165d0", + "tx": "02000000027032912651fc25a3e0893acd5f9640598707e2dfef92143bb5a4020e335442800100000017160014a5f48b9aa3cb8ca6cc1040c11e386745bb4dc932ffffffffd229a4b4f78638ebcac10a68b0561585a5d6e4d3b769ad0a909e9b9afaeae24e00000000171600145c83da9b685f9142016c6f5eb5f98a45cfa6f686ffffffff01915a01000000000017a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf8700000000" } }, { - "id": "example:sendpsbt#2", - "method": "sendpsbt", - "params": { - "psbt": "cHNidP8BAM0CAAAABEV+dnFRINmyeHxi4Id0OrcuzI5au5/BlPtTfu7E2m3EAAAAAAD9////cv8oioDx+0NCEnjBSYtnwF0H4VR13j+bkyb5gOOQLUUBAAAAAP3///8ehOrKm7JEq6zflkp9+zmSwE1iPe1yh3KTXvk+om/legEAAAAA/f///2s31wNrI1UavMgjC1GyrOHNbxOm68KYa13WX/mGfmjcAQAAAAD9////AcEAPQAAAAAAFgAUyQltQ/QI6lJgICYsza18hRa5KoEAAAAAAAEAcQIAAAABTzfqjIqV1wPpqc/3/Cb+tMX5EDrLmnhb5BMNx3aB/hYAAAAAAP3///8CQEIPAAAAAAAWABR9CNmX36nN45+GhjqvD4LjLMMMg/+juSkBAAAAFgAUJB0adsMdjkacZWrLwyteqfOaTrRlAAAAAQEfQEIPAAAAAAAWABR9CNmX36nN45+GhjqvD4LjLMMMgyICA1p5u7tAbUvCjfBfpqhzKM+wKn4TdDvs3NHfz+BxwuAQRzBEAiBwFb9rA0nUVlIPGd2aaiRbJ+KH4MLM3Bu+f0JuXB/hwAIgT2rrIUG9gXBZoH9fcPjCnbbM1SR4GiLYGLeALB8yENoBIgYDWnm7u0BtS8KN8F+mqHMoz7AqfhN0O+zc0d/P4HHC4BAIfQjZlwAAAAAAAQBxAgAAAAGANpEFI+CgfALTim/MWsAa62g+EmFWrFrzBDBCmCB3MgAAAAAA/f///wKZKdgpAQAAABYAFB+xhfU1pgl9WIvDKzAHZp8UeNkzQEIPAAAAAAAWABQHHEnK0vQg88gF+fa5ilcmnLFBUGUAAAABAR9AQg8AAAAAABYAFAccScrS9CDzyAX59rmKVyacsUFQIgICXTcoCCnxhsuZXNzL8jirRWQBOTlzUTljJKNldd803f9HMEQCIDtx/kEoc4PHDDm4eX5SEOmuRGu7ShpEG7xKBbuD/NjiAiBYkIKod39dcBarCT7Dbchkuwx70tJhOxQSJi2EMioGrwEiBgJdNygIKfGGy5lc3MvyOKtFZAE5OXNROWMko2V13zTd/wgHHEnKAAAAAAABAHECAAAAAVHU7RCZylzRMdlMBJ2ba4XKxv0l7LdWVnPYS6mhkf60AAAAAAD9////Av5VbSkBAAAAFgAU0BhRKzRbIC6H+s6j86d6cMpTNNhAQg8AAAAAABYAFD1D0ia8wnAZreUtej3FKnrBvii4ZQAAAAEBH0BCDwAAAAAAFgAUPUPSJrzCcBmt5S16PcUqesG+KLgiAgKKWZFo08l968cbxm5icOzwVPMA2Igwm6BUcaSCF13ZMEcwRAIgNAeIVGvUj9MWM18am0dx3JtEf79iQMX7Rqz1tttes3ICIAtNCglUlvpSidAxc/xoiy9cA13bgimJx25G+eZXfYJeASIGAopZkWjTyX3rxxvGbmJw7PBU8wDYiDCboFRxpIIXXdkwCD1D0iYAAAAAAAEAcQIAAAABRX52cVEg2bJ4fGLgh3Q6ty7Mjlq7n8GU+1N+7sTabcQBAAAAAP3///8CMmGqKQEAAAAWABSxLq0p9YAKl+hX7pFc0K/X+PIWmUBCDwAAAAAAFgAUZhwjt5DdNJE3OvCx2L7Qh31c3iJlAAAAAQEfQEIPAAAAAAAWABRmHCO3kN00kTc68LHYvtCHfVzeIiICA/qclQheQrHlADzR9BgXjDDJbkrneVTKD8SMWIJv9OsORzBEAiBKABqNV7cF5DKhtd+m+ZEmWF21vBt2uBKnzeDuUFqvDwIgJc6+/6GQqIfz869kJpUFTAMYTeL2qWR6d28EQEOJgkMBIgYD+pyVCF5CseUAPNH0GBeMMMluSud5VMoPxIxYgm/06w4IZhwjtwAAAAAAAA==", - "reserve": null + "request": { + "id": "example:sendpsbt#2", + "method": "sendpsbt", + "params": { + "psbt": "cHNidP8BAM0CAAAABEV+dnFRINmyeHxi4Id0OrcuzI5au5/BlPtTfu7E2m3EAAAAAAD9////cv8oioDx+0NCEnjBSYtnwF0H4VR13j+bkyb5gOOQLUUBAAAAAP3///8ehOrKm7JEq6zflkp9+zmSwE1iPe1yh3KTXvk+om/legEAAAAA/f///2s31wNrI1UavMgjC1GyrOHNbxOm68KYa13WX/mGfmjcAQAAAAD9////AcEAPQAAAAAAFgAUyQltQ/QI6lJgICYsza18hRa5KoEAAAAAAAEAcQIAAAABTzfqjIqV1wPpqc/3/Cb+tMX5EDrLmnhb5BMNx3aB/hYAAAAAAP3///8CQEIPAAAAAAAWABR9CNmX36nN45+GhjqvD4LjLMMMg/+juSkBAAAAFgAUJB0adsMdjkacZWrLwyteqfOaTrRlAAAAAQEfQEIPAAAAAAAWABR9CNmX36nN45+GhjqvD4LjLMMMgyICA1p5u7tAbUvCjfBfpqhzKM+wKn4TdDvs3NHfz+BxwuAQRzBEAiBwFb9rA0nUVlIPGd2aaiRbJ+KH4MLM3Bu+f0JuXB/hwAIgT2rrIUG9gXBZoH9fcPjCnbbM1SR4GiLYGLeALB8yENoBIgYDWnm7u0BtS8KN8F+mqHMoz7AqfhN0O+zc0d/P4HHC4BAIfQjZlwAAAAAAAQBxAgAAAAGANpEFI+CgfALTim/MWsAa62g+EmFWrFrzBDBCmCB3MgAAAAAA/f///wKZKdgpAQAAABYAFB+xhfU1pgl9WIvDKzAHZp8UeNkzQEIPAAAAAAAWABQHHEnK0vQg88gF+fa5ilcmnLFBUGUAAAABAR9AQg8AAAAAABYAFAccScrS9CDzyAX59rmKVyacsUFQIgICXTcoCCnxhsuZXNzL8jirRWQBOTlzUTljJKNldd803f9HMEQCIDtx/kEoc4PHDDm4eX5SEOmuRGu7ShpEG7xKBbuD/NjiAiBYkIKod39dcBarCT7Dbchkuwx70tJhOxQSJi2EMioGrwEiBgJdNygIKfGGy5lc3MvyOKtFZAE5OXNROWMko2V13zTd/wgHHEnKAAAAAAABAHECAAAAAVHU7RCZylzRMdlMBJ2ba4XKxv0l7LdWVnPYS6mhkf60AAAAAAD9////Av5VbSkBAAAAFgAU0BhRKzRbIC6H+s6j86d6cMpTNNhAQg8AAAAAABYAFD1D0ia8wnAZreUtej3FKnrBvii4ZQAAAAEBH0BCDwAAAAAAFgAUPUPSJrzCcBmt5S16PcUqesG+KLgiAgKKWZFo08l968cbxm5icOzwVPMA2Igwm6BUcaSCF13ZMEcwRAIgNAeIVGvUj9MWM18am0dx3JtEf79iQMX7Rqz1tttes3ICIAtNCglUlvpSidAxc/xoiy9cA13bgimJx25G+eZXfYJeASIGAopZkWjTyX3rxxvGbmJw7PBU8wDYiDCboFRxpIIXXdkwCD1D0iYAAAAAAAEAcQIAAAABRX52cVEg2bJ4fGLgh3Q6ty7Mjlq7n8GU+1N+7sTabcQBAAAAAP3///8CMmGqKQEAAAAWABSxLq0p9YAKl+hX7pFc0K/X+PIWmUBCDwAAAAAAFgAUZhwjt5DdNJE3OvCx2L7Qh31c3iJlAAAAAQEfQEIPAAAAAAAWABRmHCO3kN00kTc68LHYvtCHfVzeIiICA/qclQheQrHlADzR9BgXjDDJbkrneVTKD8SMWIJv9OsORzBEAiBKABqNV7cF5DKhtd+m+ZEmWF21vBt2uBKnzeDuUFqvDwIgJc6+/6GQqIfz869kJpUFTAMYTeL2qWR6d28EQEOJgkMBIgYD+pyVCF5CseUAPNH0GBeMMMluSud5VMoPxIxYgm/06w4IZhwjtwAAAAAAAA==", + "reserve": null + } + }, + "response": { + "tx": "02000000000104457e76715120d9b2787c62e087743ab72ecc8e5abb9fc194fb537eeec4da6dc40000000000fdffffff72ff288a80f1fb43421278c1498b67c05d07e15475de3f9b9326f980e3902d450100000000fdffffff1e84eaca9bb244abacdf964a7dfb3992c04d623ded728772935ef93ea26fe57a0100000000fdffffff6b37d7036b23551abcc8230b51b2ace1cd6f13a6ebc2986b5dd65ff9867e68dc0100000000fdffffff01c1003d0000000000160014c9096d43f408ea526020262ccdad7c8516b92a810247304402207015bf6b0349d456520f19dd9a6a245b27e287e0c2ccdc1bbe7f426e5c1fe1c002204f6aeb2141bd817059a07f5f70f8c29db6ccd524781a22d818b7802c1f3210da0121035a79bbbb406d4bc28df05fa6a87328cfb02a7e13743becdcd1dfcfe071c2e0100247304402203b71fe41287383c70c39b8797e5210e9ae446bbb4a1a441bbc4a05bb83fcd8e20220589082a8777f5d7016ab093ec36dc864bb0c7bd2d2613b1412262d84322a06af0121025d37280829f186cb995cdccbf238ab45640139397351396324a36575df34ddff024730440220340788546bd48fd316335f1a9b4771dc9b447fbf6240c5fb46acf5b6db5eb37202200b4d0a095496fa5289d03173fc688b2f5c035ddb822989c76e46f9e6577d825e0121028a599168d3c97debc71bc66e6270ecf054f300d888309ba05471a482175dd9300247304402204a001a8d57b705e432a1b5dfa6f99126585db5bc1b76b812a7cde0ee505aaf0f022025cebeffa190a887f3f3af642695054c03184de2f6a9647a776f044043898243012103fa9c95085e42b1e5003cd1f418178c30c96e4ae77954ca0fc48c58826ff4eb0e00000000", + "txid": "43bb1c1bce6763ffe4d5df6b49f152f907f36f7849e55bb56075e2b256d17502" } } ], @@ -69,16 +81,6 @@ "", "- -32602: Error in given parameters or some error happened during the command process." ], - "example_json_response": [ - { - "txid": "05985072bbe20747325e69a159fe08176cc1bbc96d25e8848edad2dddc1165d0", - "tx": "02000000027032912651fc25a3e0893acd5f9640598707e2dfef92143bb5a4020e335442800100000017160014a5f48b9aa3cb8ca6cc1040c11e386745bb4dc932ffffffffd229a4b4f78638ebcac10a68b0561585a5d6e4d3b769ad0a909e9b9afaeae24e00000000171600145c83da9b685f9142016c6f5eb5f98a45cfa6f686ffffffff01915a01000000000017a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf8700000000" - }, - { - "tx": "02000000000104457e76715120d9b2787c62e087743ab72ecc8e5abb9fc194fb537eeec4da6dc40000000000fdffffff72ff288a80f1fb43421278c1498b67c05d07e15475de3f9b9326f980e3902d450100000000fdffffff1e84eaca9bb244abacdf964a7dfb3992c04d623ded728772935ef93ea26fe57a0100000000fdffffff6b37d7036b23551abcc8230b51b2ace1cd6f13a6ebc2986b5dd65ff9867e68dc0100000000fdffffff01c1003d0000000000160014c9096d43f408ea526020262ccdad7c8516b92a810247304402207015bf6b0349d456520f19dd9a6a245b27e287e0c2ccdc1bbe7f426e5c1fe1c002204f6aeb2141bd817059a07f5f70f8c29db6ccd524781a22d818b7802c1f3210da0121035a79bbbb406d4bc28df05fa6a87328cfb02a7e13743becdcd1dfcfe071c2e0100247304402203b71fe41287383c70c39b8797e5210e9ae446bbb4a1a441bbc4a05bb83fcd8e20220589082a8777f5d7016ab093ec36dc864bb0c7bd2d2613b1412262d84322a06af0121025d37280829f186cb995cdccbf238ab45640139397351396324a36575df34ddff024730440220340788546bd48fd316335f1a9b4771dc9b447fbf6240c5fb46acf5b6db5eb37202200b4d0a095496fa5289d03173fc688b2f5c035ddb822989c76e46f9e6577d825e0121028a599168d3c97debc71bc66e6270ecf054f300d888309ba05471a482175dd9300247304402204a001a8d57b705e432a1b5dfa6f99126585db5bc1b76b812a7cde0ee505aaf0f022025cebeffa190a887f3f3af642695054c03184de2f6a9647a776f044043898243012103fa9c95085e42b1e5003cd1f418178c30c96e4ae77954ca0fc48c58826ff4eb0e00000000", - "txid": "43bb1c1bce6763ffe4d5df6b49f152f907f36f7849e55bb56075e2b256d17502" - } - ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." diff --git a/doc/schemas/lightning-setchannel.json b/doc/schemas/lightning-setchannel.json index 94cc68c4099a..a227110cf560 100644 --- a/doc/schemas/lightning-setchannel.json +++ b/doc/schemas/lightning-setchannel.json @@ -157,62 +157,64 @@ "- -1: Channel is in incorrect state, i.e. Catchall nonspecific error.", "- -32602: JSONRPC2_INVALID_PARAMS, i.e. Given id is not a channel ID or short channel ID." ], - "example_json_request": [ + "json_example": [ { - "id": "example:setchannel#1", - "method": "setchannel", - "params": { - "id": "103x1x0", - "feebase": null, - "feeppm": null, - "htlcmin": null, - "htlcmax": null, - "enforcedelay": null, - "ignorefeelimits": true - } - }, - { - "id": "example:setchannel#2", - "method": "setchannel", - "params": { - "id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", - "feebase": 4000, - "feeppm": 300, - "htlcmin": null, - "htlcmax": null, - "enforcedelay": 0, - "ignorefeelimits": null - } - } - ], - "example_json_response": [ - { - "channels": [ - { - "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", - "channel_id": "90210d39d12a65d239ece267c5f48e0a82e7cb95724e658f6d99f370064faad1", - "short_channel_id": "103x1x0", - "fee_base_msat": 1, - "fee_proportional_millionths": 10, - "minimum_htlc_out_msat": 0, - "maximum_htlc_out_msat": 990000000, - "ignore_fee_limits": true + "request": { + "id": "example:setchannel#1", + "method": "setchannel", + "params": { + "id": "103x1x0", + "feebase": null, + "feeppm": null, + "htlcmin": null, + "htlcmax": null, + "enforcedelay": null, + "ignorefeelimits": true } - ] + }, + "response": { + "channels": [ + { + "peer_id": "0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c03518", + "channel_id": "90210d39d12a65d239ece267c5f48e0a82e7cb95724e658f6d99f370064faad1", + "short_channel_id": "103x1x0", + "fee_base_msat": 1, + "fee_proportional_millionths": 10, + "minimum_htlc_out_msat": 0, + "maximum_htlc_out_msat": 990000000, + "ignore_fee_limits": true + } + ] + } }, { - "channels": [ - { - "peer_id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", - "channel_id": "9c54c71bbbe59591cc3162e14fc4ff58c146f085c07d0f206ea679a8231d03ab", - "short_channel_id": "103x3x0", - "fee_base_msat": 4000, - "fee_proportional_millionths": 300, - "minimum_htlc_out_msat": 0, - "maximum_htlc_out_msat": 990000000, - "ignore_fee_limits": false + "request": { + "id": "example:setchannel#2", + "method": "setchannel", + "params": { + "id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", + "feebase": 4000, + "feeppm": 300, + "htlcmin": null, + "htlcmax": null, + "enforcedelay": 0, + "ignorefeelimits": null } - ] + }, + "response": { + "channels": [ + { + "peer_id": "0382ce59ebf18be7d84677c2e35f23294b9992ceca95491fcf8a56c6cb2d9de199", + "channel_id": "9c54c71bbbe59591cc3162e14fc4ff58c146f085c07d0f206ea679a8231d03ab", + "short_channel_id": "103x3x0", + "fee_base_msat": 4000, + "fee_proportional_millionths": 300, + "minimum_htlc_out_msat": 0, + "maximum_htlc_out_msat": 990000000, + "ignore_fee_limits": false + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-setconfig.json b/doc/schemas/lightning-setconfig.json index f8dc6f66a4ea..f468ffadfaaa 100644 --- a/doc/schemas/lightning-setconfig.json +++ b/doc/schemas/lightning-setconfig.json @@ -124,57 +124,61 @@ "", "- -32602: JSONRPC2_INVALID_PARAMS, i.e. the parameter is not dynamic, or the val was invalid." ], - "example_json_request": [ + "json_example": [ { - "id": "example:setconfig#1", - "method": "setconfig", - "params": [ - "autoclean-paidinvoices-age", - 1 - ] - }, - { - "id": "example:setconfig#2", - "method": "setconfig", - "params": [ - "test-dynamic-config", - "changed" - ] - }, - { - "id": "example:setconfig#3", - "method": "setconfig", - "params": { - "config": "min-capacity-sat", - "val": 500000 - } - } - ], - "example_json_response": [ - { - "config": { - "config": "autoclean-paidinvoices-age", - "value_int": 1, - "source": "/tmp/ltests-7u_8_rtu/test_autoclean_1/lightning-3/regtest/config:6", - "plugin": "~/lightning/plugins/autoclean", - "dynamic": true + "request": { + "id": "example:setconfig#1", + "method": "setconfig", + "params": [ + "autoclean-paidinvoices-age", + 1 + ] + }, + "response": { + "config": { + "config": "autoclean-paidinvoices-age", + "value_int": 1, + "source": "/tmp/ltests-7u_8_rtu/test_autoclean_1/lightning-3/regtest/config:6", + "plugin": "~/lightning/plugins/autoclean", + "dynamic": true + } } }, { - "config": { - "config": "test-dynamic-config", - "value_str": "changed", - "source": "/tmp/ltests-7u_8_rtu/test_dynamic_option_python_plugin_1/lightning-1/regtest/config:2", - "plugin": "~/lightning/tests/plugins/dynamic_option.py", - "dynamic": true + "request": { + "id": "example:setconfig#2", + "method": "setconfig", + "params": [ + "test-dynamic-config", + "changed" + ] + }, + "response": { + "config": { + "config": "test-dynamic-config", + "value_str": "changed", + "source": "/tmp/ltests-7u_8_rtu/test_dynamic_option_python_plugin_1/lightning-1/regtest/config:2", + "plugin": "~/lightning/tests/plugins/dynamic_option.py", + "dynamic": true + } } }, { - "config": { - "config": "min-capacity-sat", - "value_int": 500000, - "source": "/tmp/ltests-nvfdbou2/test_setconfig_1/lightning-2/regtest/config:2", - "dynamic": true + "request": { + "id": "example:setconfig#3", + "method": "setconfig", + "params": { + "config": "min-capacity-sat", + "val": 500000 + } + }, + "response": { + "config": { + "config": "min-capacity-sat", + "value_int": 500000, + "source": "/tmp/ltests-nvfdbou2/test_setconfig_1/lightning-2/regtest/config:2", + "dynamic": true + } } } ], diff --git a/doc/schemas/lightning-setpsbtversion.json b/doc/schemas/lightning-setpsbtversion.json index f4f26ebd6fa1..2247d5f4d2d3 100644 --- a/doc/schemas/lightning-setpsbtversion.json +++ b/doc/schemas/lightning-setpsbtversion.json @@ -40,22 +40,32 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:setpsbtversion#1", - "method": "setpsbtversion", - "params": { - "psbt": "cHNidP8BAAoCAAAAAAAAAAAAAA==", - "version": "2" + "request": { + "id": "example:setpsbtversion#1", + "method": "setpsbtversion", + "params": { + "psbt": "cHNidP8BAAoCAAAAAAAAAAAAAA==", + "version": "2" + } + }, + "response": { + "psbt": "cHNidP8BAgQCAAAAAQQBAAEFAQABBgEDAfsEAgAAAAA=" } }, { - "id": "example:setpsbtversion#2", - "method": "setpsbtversion", - "params": [ - "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIQEIPAAAAAAABBCJRIJd6ICNAQALFOMhoUHuSVSuzcaUdkDKlk4K+A+DR9+4uAA==", - 0 - ] + "request": { + "id": "example:setpsbtversion#2", + "method": "setpsbtversion", + "params": [ + "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIQEIPAAAAAAABBCJRIJd6ICNAQALFOMhoUHuSVSuzcaUdkDKlk4K+A+DR9+4uAA==", + 0 + ] + }, + "response": { + "psbt": "cHNidP8BADUCAAAAAAFAQg8AAAAAACJRIJd6ICNAQALFOMhoUHuSVSuzcaUdkDKlk4K+A+DR9+4ubwAAAAAA" + } } ], "errors": [ @@ -63,14 +73,6 @@ "", "- -32602: Parameter missed or malformed." ], - "example_json_response": [ - { - "psbt": "cHNidP8BAgQCAAAAAQQBAAEFAQABBgEDAfsEAgAAAAA=" - }, - { - "psbt": "cHNidP8BADUCAAAAAAFAQg8AAAAAACJRIJd6ICNAQALFOMhoUHuSVSuzcaUdkDKlk4K+A+DR9+4ubwAAAAAA" - } - ], "author": [ "Gregory Sanders <> is mainly responsible." ], diff --git a/doc/schemas/lightning-showrunes.json b/doc/schemas/lightning-showrunes.json index fca78dcc8fc6..b69dc0060950 100644 --- a/doc/schemas/lightning-showrunes.json +++ b/doc/schemas/lightning-showrunes.json @@ -154,76 +154,78 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:showrunes#1", - "method": "showrunes", - "params": "{}" - }, - { - "id": "example:showrunes#2", - "method": "showrunes", - "params": { - "rune": "Bl0V_vkVkGr4h356JbCMCcoDyyKE8djkoQ2156iPB509MCZwZXI9MTAwMDAwMDAwMG5zZWM=" + "request": { + "id": "example:showrunes#1", + "method": "showrunes", + "params": "{}" + }, + "response": { + "runes": [ + { + "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", + "unique_id": "0", + "restrictions": [], + "restrictions_as_english": "" + }, + { + "rune": "geZmO6U7yqpHn-moaX93FVMVWrDRfSNY4AXx9ypLcqg9MQ==", + "unique_id": "1", + "restrictions": [], + "restrictions_as_english": "" + }, + { + "rune": "Bl0V_vkVkGr4h356JbCMCcoDyyKE8djkoQ2156iPB509MCZwZXI9MTAwMDAwMDAwMG5zZWM=", + "unique_id": "2", + "restrictions": [ + { + "alternatives": [ + { + "fieldname": "per", + "value": "1000000000nsec", + "condition": "=", + "english": "per equal to 1000000000nsec" + } + ], + "english": "per equal to 1000000000nsec" + } + ], + "restrictions_as_english": "per equal to 1000000000nsec" + } + ] } - } - ], - "example_json_response": [ - { - "runes": [ - { - "rune": "OSqc7ixY6F-gjcigBfxtzKUI54uzgFSA6YfBQoWGDV89MA==", - "unique_id": "0", - "restrictions": [], - "restrictions_as_english": "" - }, - { - "rune": "geZmO6U7yqpHn-moaX93FVMVWrDRfSNY4AXx9ypLcqg9MQ==", - "unique_id": "1", - "restrictions": [], - "restrictions_as_english": "" - }, - { - "rune": "Bl0V_vkVkGr4h356JbCMCcoDyyKE8djkoQ2156iPB509MCZwZXI9MTAwMDAwMDAwMG5zZWM=", - "unique_id": "2", - "restrictions": [ - { - "alternatives": [ - { - "fieldname": "per", - "value": "1000000000nsec", - "condition": "=", - "english": "per equal to 1000000000nsec" - } - ], - "english": "per equal to 1000000000nsec" - } - ], - "restrictions_as_english": "per equal to 1000000000nsec" - } - ] }, { - "runes": [ - { - "rune": "Bl0V_vkVkGr4h356JbCMCcoDyyKE8djkoQ2156iPB509MCZwZXI9MTAwMDAwMDAwMG5zZWM=", - "unique_id": "2", - "restrictions": [ - { - "alternatives": [ - { - "fieldname": "per", - "value": "1000000000nsec", - "condition": "=", - "english": "per equal to 1000000000nsec" - } - ], - "english": "per equal to 1000000000nsec" - } - ], - "restrictions_as_english": "per equal to 1000000000nsec" + "request": { + "id": "example:showrunes#2", + "method": "showrunes", + "params": { + "rune": "Bl0V_vkVkGr4h356JbCMCcoDyyKE8djkoQ2156iPB509MCZwZXI9MTAwMDAwMDAwMG5zZWM=" } - ] + }, + "response": { + "runes": [ + { + "rune": "Bl0V_vkVkGr4h356JbCMCcoDyyKE8djkoQ2156iPB509MCZwZXI9MTAwMDAwMDAwMG5zZWM=", + "unique_id": "2", + "restrictions": [ + { + "alternatives": [ + { + "fieldname": "per", + "value": "1000000000nsec", + "condition": "=", + "english": "per equal to 1000000000nsec" + } + ], + "english": "per equal to 1000000000nsec" + } + ], + "restrictions_as_english": "per equal to 1000000000nsec" + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-signinvoice.json b/doc/schemas/lightning-signinvoice.json index 33b85c4109b4..21882c4d6911 100644 --- a/doc/schemas/lightning-signinvoice.json +++ b/doc/schemas/lightning-signinvoice.json @@ -39,18 +39,18 @@ "", "- -1: Catchall nonspecific error." ], - "example_json_request": [ + "json_example": [ { - "id": "example:signinvoice#1", - "method": "signinvoice", - "params": [ - "lnbcrt10n1pjmxt3lsp5jumuz2sv3ca68kzd92hp3wdtpx8ghnxur65fs6maw6dyxsleqd0spp5nadvvh7uzk2qzh8d9d7tsxr08l9uaz2vjeuuahqtufjv52d0eassdq8d9h8vvgxqyjw5qcqp99qxpqysgq4rrn702eum6c9ld9khlz39vdyd8zcwrav5ygqvu6w54aep6yarkyfrnk990yf5prpasgzmj52stektf6mzwdl5hc6qlsglt2a0pwp0spwww44w" - ] - } - ], - "example_json_response": [ - { - "bolt11": "lnbcrt10n1pjmxt3lsp5jumuz2sv3ca68kzd92hp3wdtpx8ghnxur65fs6maw6dyxsleqd0spp5nadvvh7uzk2qzh8d9d7tsxr08l9uaz2vjeuuahqtufjv52d0eassdq8d9h8vvgxqyjw5qcqp99qxpqysgq3nhrd72qe7wmc2hvwhaqnx05y6dzxh2tal02kw055er7uutkkrcreccm37ce6wv7ee8q70ktlr9fy3fd635hc2k98a4svd9c8v4cpjsppm2eee" + "request": { + "id": "example:signinvoice#1", + "method": "signinvoice", + "params": [ + "lnbcrt10n1pjmxt3lsp5jumuz2sv3ca68kzd92hp3wdtpx8ghnxur65fs6maw6dyxsleqd0spp5nadvvh7uzk2qzh8d9d7tsxr08l9uaz2vjeuuahqtufjv52d0eassdq8d9h8vvgxqyjw5qcqp99qxpqysgq4rrn702eum6c9ld9khlz39vdyd8zcwrav5ygqvu6w54aep6yarkyfrnk990yf5prpasgzmj52stektf6mzwdl5hc6qlsglt2a0pwp0spwww44w" + ] + }, + "response": { + "bolt11": "lnbcrt10n1pjmxt3lsp5jumuz2sv3ca68kzd92hp3wdtpx8ghnxur65fs6maw6dyxsleqd0spp5nadvvh7uzk2qzh8d9d7tsxr08l9uaz2vjeuuahqtufjv52d0eassdq8d9h8vvgxqyjw5qcqp99qxpqysgq3nhrd72qe7wmc2hvwhaqnx05y6dzxh2tal02kw055er7uutkkrcreccm37ce6wv7ee8q70ktlr9fy3fd635hc2k98a4svd9c8v4cpjsppm2eee" + } } ], "author": [ diff --git a/doc/schemas/lightning-signmessage.json b/doc/schemas/lightning-signmessage.json index 6e1d709bc693..9e25a830fda0 100644 --- a/doc/schemas/lightning-signmessage.json +++ b/doc/schemas/lightning-signmessage.json @@ -51,34 +51,36 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:signmessage#1", - "method": "signmessage", - "params": { - "message": "this is a test!" + "request": { + "id": "example:signmessage#1", + "method": "signmessage", + "params": { + "message": "this is a test!" + } + }, + "response": { + "signature": "a2ec227012795f9d6b80a3f5ea98374c6d2886917517c05336799923fcf37caf08344c0431275e1a8189da01b444ae978007fe70f0cc9009f38cabe074ade87d", + "recid": "00", + "zbase": "d6tqaeuonjhi98mmont9m4wag7gg4krg1f4txonug3h31e9h6p6k6nbwjondnj46dkyausobstnk7fhyy998bhgc1yr98dfmhb4k54d7" } }, { - "id": "example:signmessage#2", - "method": "signmessage", - "params": { - "message": "message for you" + "request": { + "id": "example:signmessage#2", + "method": "signmessage", + "params": { + "message": "message for you" + } + }, + "response": { + "signature": "85843b010bc517b32eaafe70232e2c44bb5a354c74d2202390af1b272e4c6ac23ac3f97ea663d8b49116ad6c2d080515b43bcdf1ea4f38cdb18af0edf8209cd8", + "recid": "00", + "zbase": "d6naeqabbxntxc3qim98ye3qftnmsstijt4prebd1nztsj3qjticrqsd9f9kca6as1etpmmcfwrykfpw8xg9d41x8dg5dnzo7zhnb8ga" } } ], - "example_json_response": [ - { - "signature": "a2ec227012795f9d6b80a3f5ea98374c6d2886917517c05336799923fcf37caf08344c0431275e1a8189da01b444ae978007fe70f0cc9009f38cabe074ade87d", - "recid": "00", - "zbase": "d6tqaeuonjhi98mmont9m4wag7gg4krg1f4txonug3h31e9h6p6k6nbwjondnj46dkyausobstnk7fhyy998bhgc1yr98dfmhb4k54d7" - }, - { - "signature": "85843b010bc517b32eaafe70232e2c44bb5a354c74d2202390af1b272e4c6ac23ac3f97ea663d8b49116ad6c2d080515b43bcdf1ea4f38cdb18af0edf8209cd8", - "recid": "00", - "zbase": "d6naeqabbxntxc3qim98ye3qftnmsstijt4prebd1nztsj3qjticrqsd9f9kca6as1etpmmcfwrykfpw8xg9d41x8dg5dnzo7zhnb8ga" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-signpsbt.json b/doc/schemas/lightning-signpsbt.json index 4eac54b74f4a..53327dfb249a 100644 --- a/doc/schemas/lightning-signpsbt.json +++ b/doc/schemas/lightning-signpsbt.json @@ -46,23 +46,33 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:signpsbt#1", - "method": "signpsbt", - "params": { - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////DPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4M/AlsaWdodG5pbmcBCMbeD+3qn9/kAAEDCODIEAAAAAAAAQQiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQz8CWxpZ2h0bmluZwEI4upB+mjl6AIA", - "signonly": null + "request": { + "id": "example:signpsbt#1", + "method": "signpsbt", + "params": { + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////DPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4M/AlsaWdodG5pbmcBCMbeD+3qn9/kAAEDCODIEAAAAAAAAQQiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQz8CWxpZ2h0bmluZwEI4upB+mjl6AIA", + "signonly": null + } + }, + "response": { + "signed_psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////ARNACI9TcWG+6uC9ElBFN3qhND7amsor/dtBhJ5ujEQAT/80548avrt7d7IJiOAaCNzzYLSXITdL2xjx6mhbBi9hTiEWkUUygSpECk12bHHNORk2lKNArhHgEuW6Gtnvum52ylMJAMLMqxcAAAAADPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4hB7nAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXCQDWuWnTBAAAAAz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMI4MgQAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" } }, { - "id": "example:signpsbt#2", - "method": "signpsbt", - "params": { - "psbt": "cHNidP8BAP1xAQIAAAAIFTef27H2GAJBzP4UZMeDePsDVkglO47/q4jqK18ibCYAAAAAAP3///+axwap6WKnEHvLjIJZX0ZeJ87cs7PKkXBfwvbGVmjpTQEAAAAA/f///wQ1cVzb9NR7nXadyRuhQBv+2iqhZkhvUA+sPo5z/SsSAQAAAAD9////lXQ788meUtSxhBX13mx2XhyM3Ddo30QtmNW0YuE2TDABAAAAAP3///8Kr4BwElAScx3bA5ZdavrHwh4Zh+rFNvkE/+7gu1WbngEAAAAA/f///3Uei7j3k/b5tnjFGvNZhe2iWz8O6FQjTEpM5XIoduNsAQAAAAD9////fm5Om4MojcnfZiTmrwb4b5Byw9emrjITi/nkEqTK9MsBAAAAAP3///8lwdpZqt3ILPRwhINY4PGvkg2CSw7agcMPSuFoHDDkIQAAAAAA/f///wGCAXoAAAAAABYAFMkJbUP0COpSYCAmLM2tfIUWuSqBAAAAAAABAHECAAAAAZVxzFxyEg7tiQTgRHwGleR8Srxw6taAGOoEpJK/Xj5sAAAAAAD9////AkBCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYzr/YpAQAAABYAFKmkod5S53U4m5tKFApyeC35UbnbZwAAAAEBH0BCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYAAQBxAgAAAAEVN5/bsfYYAkHM/hRkx4N4+wNWSCU7jv+riOorXyJsJgEAAAAA/f///wJmbOcpAQAAABYAFCCSJBD9wY/VwxnBcnFiu1tA6CGTQEIPAAAAAAAWABSjI8KCqaGX/BGOwJza8hyiuxuIcmcAAAABAR9AQg8AAAAAABYAFKMjwoKpoZf8EY7AnNryHKK7G4hyAAEAcQIAAAAB98EwKZMOHiyRYWyToae6Kce3gCwqUvnVXXHlB/ps9ocBAAAAAP3///8CmNuLKQEAAAAWABQ4roxw+phYHelaRr71DYB3FEy/30BCDwAAAAAAFgAUwSDtQiY7PVvBc7ww56Y72YIQdjllAAAAAQEfQEIPAAAAAAAWABTBIO1CJjs9W8FzvDDnpjvZghB2OQABAHECAAAAAZH/SvCXvDW7b8qb55CDC4M+jgZ61H/e8rZnAGaXp+Z+AAAAAAD9////Apkp2CkBAAAAFgAUc/Y+sIq3oYyEe40GkKJsXawkzwFAQg8AAAAAABYAFLdt1h5Bte8FKvIc2jJgiIwHC7mvZwAAAAEBH0BCDwAAAAAAFgAUt23WHkG17wUq8hzaMmCIjAcLua8AAQBxAgAAAAETC3wMCv9qK3lvVkVJu9b/v2VgMepZtnfngMp2xMXRnwAAAAAA/f///wJk0E4pAQAAABYAFEIsc4cBl+BTN33Kn80+YYfkMt+cQEIPAAAAAAAWABT2/7RIxKohhGbacpBz0BZNYcnfsGUAAAABAR9AQg8AAAAAABYAFPb/tEjEqiGEZtpykHPQFk1hyd+wAAEAcQIAAAABA8J/OnC+cuH79Z6wZmzwdAjhBDaPHavh3yvhr4odDXQBAAAAAP3///8CykowKQEAAAAWABTVHuO8cKOOX/JlmMU66on6Uc54mkBCDwAAAAAAFgAUunZMZryWMqCTiMuVWNF/cleg6dVnAAAAAQEfQEIPAAAAAAAWABS6dkxmvJYyoJOIy5VY0X9yV6Dp1QABAHECAAAAAfRxBaZZ3FfDGwxhZQLYCurN+7kJj0x6nzChg434dnjRAAAAAAD9////AszmyCkBAAAAFgAULSqRp54barF/7R9XOmsLDCVWdAFAQg8AAAAAABYAFNa5adNt/9rZhpGT9mPuSA39xzSIZQAAAAEBH0BCDwAAAAAAFgAU1rlp023/2tmGkZP2Y+5IDf3HNIgAAQBxAgAAAAEgk1JYyP4oIoPoYYcTPPDvZynVfXWINJnBEFBsLv0MtAAAAAAA/f///wJAQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iMmGqKQEAAAAWABT5XKNwVIFsUKh26sqHFSlOLq5TFGUAAAABAR9AQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iAAA=", - "signonly": [ - 7 - ] + "request": { + "id": "example:signpsbt#2", + "method": "signpsbt", + "params": { + "psbt": "cHNidP8BAP1xAQIAAAAIFTef27H2GAJBzP4UZMeDePsDVkglO47/q4jqK18ibCYAAAAAAP3///+axwap6WKnEHvLjIJZX0ZeJ87cs7PKkXBfwvbGVmjpTQEAAAAA/f///wQ1cVzb9NR7nXadyRuhQBv+2iqhZkhvUA+sPo5z/SsSAQAAAAD9////lXQ788meUtSxhBX13mx2XhyM3Ddo30QtmNW0YuE2TDABAAAAAP3///8Kr4BwElAScx3bA5ZdavrHwh4Zh+rFNvkE/+7gu1WbngEAAAAA/f///3Uei7j3k/b5tnjFGvNZhe2iWz8O6FQjTEpM5XIoduNsAQAAAAD9////fm5Om4MojcnfZiTmrwb4b5Byw9emrjITi/nkEqTK9MsBAAAAAP3///8lwdpZqt3ILPRwhINY4PGvkg2CSw7agcMPSuFoHDDkIQAAAAAA/f///wGCAXoAAAAAABYAFMkJbUP0COpSYCAmLM2tfIUWuSqBAAAAAAABAHECAAAAAZVxzFxyEg7tiQTgRHwGleR8Srxw6taAGOoEpJK/Xj5sAAAAAAD9////AkBCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYzr/YpAQAAABYAFKmkod5S53U4m5tKFApyeC35UbnbZwAAAAEBH0BCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYAAQBxAgAAAAEVN5/bsfYYAkHM/hRkx4N4+wNWSCU7jv+riOorXyJsJgEAAAAA/f///wJmbOcpAQAAABYAFCCSJBD9wY/VwxnBcnFiu1tA6CGTQEIPAAAAAAAWABSjI8KCqaGX/BGOwJza8hyiuxuIcmcAAAABAR9AQg8AAAAAABYAFKMjwoKpoZf8EY7AnNryHKK7G4hyAAEAcQIAAAAB98EwKZMOHiyRYWyToae6Kce3gCwqUvnVXXHlB/ps9ocBAAAAAP3///8CmNuLKQEAAAAWABQ4roxw+phYHelaRr71DYB3FEy/30BCDwAAAAAAFgAUwSDtQiY7PVvBc7ww56Y72YIQdjllAAAAAQEfQEIPAAAAAAAWABTBIO1CJjs9W8FzvDDnpjvZghB2OQABAHECAAAAAZH/SvCXvDW7b8qb55CDC4M+jgZ61H/e8rZnAGaXp+Z+AAAAAAD9////Apkp2CkBAAAAFgAUc/Y+sIq3oYyEe40GkKJsXawkzwFAQg8AAAAAABYAFLdt1h5Bte8FKvIc2jJgiIwHC7mvZwAAAAEBH0BCDwAAAAAAFgAUt23WHkG17wUq8hzaMmCIjAcLua8AAQBxAgAAAAETC3wMCv9qK3lvVkVJu9b/v2VgMepZtnfngMp2xMXRnwAAAAAA/f///wJk0E4pAQAAABYAFEIsc4cBl+BTN33Kn80+YYfkMt+cQEIPAAAAAAAWABT2/7RIxKohhGbacpBz0BZNYcnfsGUAAAABAR9AQg8AAAAAABYAFPb/tEjEqiGEZtpykHPQFk1hyd+wAAEAcQIAAAABA8J/OnC+cuH79Z6wZmzwdAjhBDaPHavh3yvhr4odDXQBAAAAAP3///8CykowKQEAAAAWABTVHuO8cKOOX/JlmMU66on6Uc54mkBCDwAAAAAAFgAUunZMZryWMqCTiMuVWNF/cleg6dVnAAAAAQEfQEIPAAAAAAAWABS6dkxmvJYyoJOIy5VY0X9yV6Dp1QABAHECAAAAAfRxBaZZ3FfDGwxhZQLYCurN+7kJj0x6nzChg434dnjRAAAAAAD9////AszmyCkBAAAAFgAULSqRp54barF/7R9XOmsLDCVWdAFAQg8AAAAAABYAFNa5adNt/9rZhpGT9mPuSA39xzSIZQAAAAEBH0BCDwAAAAAAFgAU1rlp023/2tmGkZP2Y+5IDf3HNIgAAQBxAgAAAAEgk1JYyP4oIoPoYYcTPPDvZynVfXWINJnBEFBsLv0MtAAAAAAA/f///wJAQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iMmGqKQEAAAAWABT5XKNwVIFsUKh26sqHFSlOLq5TFGUAAAABAR9AQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iAAA=", + "signonly": [ + 7 + ] + } + }, + "response": { + "signed_psbt": "cHNidP8BAP1xAQIAAAAIFTef27H2GAJBzP4UZMeDePsDVkglO47/q4jqK18ibCYAAAAAAP3///+axwap6WKnEHvLjIJZX0ZeJ87cs7PKkXBfwvbGVmjpTQEAAAAA/f///wQ1cVzb9NR7nXadyRuhQBv+2iqhZkhvUA+sPo5z/SsSAQAAAAD9////lXQ788meUtSxhBX13mx2XhyM3Ddo30QtmNW0YuE2TDABAAAAAP3///8Kr4BwElAScx3bA5ZdavrHwh4Zh+rFNvkE/+7gu1WbngEAAAAA/f///3Uei7j3k/b5tnjFGvNZhe2iWz8O6FQjTEpM5XIoduNsAQAAAAD9////fm5Om4MojcnfZiTmrwb4b5Byw9emrjITi/nkEqTK9MsBAAAAAP3///8lwdpZqt3ILPRwhINY4PGvkg2CSw7agcMPSuFoHDDkIQAAAAAA/f///wGCAXoAAAAAABYAFMkJbUP0COpSYCAmLM2tfIUWuSqBAAAAAAABAHECAAAAAZVxzFxyEg7tiQTgRHwGleR8Srxw6taAGOoEpJK/Xj5sAAAAAAD9////AkBCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYzr/YpAQAAABYAFKmkod5S53U4m5tKFApyeC35UbnbZwAAAAEBH0BCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYAAQBxAgAAAAEVN5/bsfYYAkHM/hRkx4N4+wNWSCU7jv+riOorXyJsJgEAAAAA/f///wJmbOcpAQAAABYAFCCSJBD9wY/VwxnBcnFiu1tA6CGTQEIPAAAAAAAWABSjI8KCqaGX/BGOwJza8hyiuxuIcmcAAAABAR9AQg8AAAAAABYAFKMjwoKpoZf8EY7AnNryHKK7G4hyAAEAcQIAAAAB98EwKZMOHiyRYWyToae6Kce3gCwqUvnVXXHlB/ps9ocBAAAAAP3///8CmNuLKQEAAAAWABQ4roxw+phYHelaRr71DYB3FEy/30BCDwAAAAAAFgAUwSDtQiY7PVvBc7ww56Y72YIQdjllAAAAAQEfQEIPAAAAAAAWABTBIO1CJjs9W8FzvDDnpjvZghB2OQABAHECAAAAAZH/SvCXvDW7b8qb55CDC4M+jgZ61H/e8rZnAGaXp+Z+AAAAAAD9////Apkp2CkBAAAAFgAUc/Y+sIq3oYyEe40GkKJsXawkzwFAQg8AAAAAABYAFLdt1h5Bte8FKvIc2jJgiIwHC7mvZwAAAAEBH0BCDwAAAAAAFgAUt23WHkG17wUq8hzaMmCIjAcLua8AAQBxAgAAAAETC3wMCv9qK3lvVkVJu9b/v2VgMepZtnfngMp2xMXRnwAAAAAA/f///wJk0E4pAQAAABYAFEIsc4cBl+BTN33Kn80+YYfkMt+cQEIPAAAAAAAWABT2/7RIxKohhGbacpBz0BZNYcnfsGUAAAABAR9AQg8AAAAAABYAFPb/tEjEqiGEZtpykHPQFk1hyd+wAAEAcQIAAAABA8J/OnC+cuH79Z6wZmzwdAjhBDaPHavh3yvhr4odDXQBAAAAAP3///8CykowKQEAAAAWABTVHuO8cKOOX/JlmMU66on6Uc54mkBCDwAAAAAAFgAUunZMZryWMqCTiMuVWNF/cleg6dVnAAAAAQEfQEIPAAAAAAAWABS6dkxmvJYyoJOIy5VY0X9yV6Dp1QABAHECAAAAAfRxBaZZ3FfDGwxhZQLYCurN+7kJj0x6nzChg434dnjRAAAAAAD9////AszmyCkBAAAAFgAULSqRp54barF/7R9XOmsLDCVWdAFAQg8AAAAAABYAFNa5adNt/9rZhpGT9mPuSA39xzSIZQAAAAEBH0BCDwAAAAAAFgAU1rlp023/2tmGkZP2Y+5IDf3HNIgAAQBxAgAAAAEgk1JYyP4oIoPoYYcTPPDvZynVfXWINJnBEFBsLv0MtAAAAAAA/f///wJAQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iMmGqKQEAAAAWABT5XKNwVIFsUKh26sqHFSlOLq5TFGUAAAABAR9AQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iIgID+pyVCF5CseUAPNH0GBeMMMluSud5VMoPxIxYgm/06w5HMEQCIG90DSr+fGNoWhCrgLbJG3Wt8PJNMWYqaa5MLWRwA0oTAiA9rsLEqqVhjV6wENfzzpudaE949uLlVqWgDjE/FSgKNAEiBgP6nJUIXkKx5QA80fQYF4wwyW5K53lUyg/EjFiCb/TrDghmHCO3AAAAAAAA" } } ], @@ -71,14 +81,6 @@ "", "- -32602: Error in given parameters, or there aren't wallet's inputs to sign, or we couldn't sign all of *signonly*, or inputs are not reserved." ], - "example_json_response": [ - { - "signed_psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////ARNACI9TcWG+6uC9ElBFN3qhND7amsor/dtBhJ5ujEQAT/80548avrt7d7IJiOAaCNzzYLSXITdL2xjx6mhbBi9hTiEWkUUygSpECk12bHHNORk2lKNArhHgEuW6Gtnvum52ylMJAMLMqxcAAAAADPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4hB7nAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXCQDWuWnTBAAAAAz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMI4MgQAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" - }, - { - "signed_psbt": "cHNidP8BAP1xAQIAAAAIFTef27H2GAJBzP4UZMeDePsDVkglO47/q4jqK18ibCYAAAAAAP3///+axwap6WKnEHvLjIJZX0ZeJ87cs7PKkXBfwvbGVmjpTQEAAAAA/f///wQ1cVzb9NR7nXadyRuhQBv+2iqhZkhvUA+sPo5z/SsSAQAAAAD9////lXQ788meUtSxhBX13mx2XhyM3Ddo30QtmNW0YuE2TDABAAAAAP3///8Kr4BwElAScx3bA5ZdavrHwh4Zh+rFNvkE/+7gu1WbngEAAAAA/f///3Uei7j3k/b5tnjFGvNZhe2iWz8O6FQjTEpM5XIoduNsAQAAAAD9////fm5Om4MojcnfZiTmrwb4b5Byw9emrjITi/nkEqTK9MsBAAAAAP3///8lwdpZqt3ILPRwhINY4PGvkg2CSw7agcMPSuFoHDDkIQAAAAAA/f///wGCAXoAAAAAABYAFMkJbUP0COpSYCAmLM2tfIUWuSqBAAAAAAABAHECAAAAAZVxzFxyEg7tiQTgRHwGleR8Srxw6taAGOoEpJK/Xj5sAAAAAAD9////AkBCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYzr/YpAQAAABYAFKmkod5S53U4m5tKFApyeC35UbnbZwAAAAEBH0BCDwAAAAAAFgAUKvGgVL/ThjWE/P1oORVXh/ObucYAAQBxAgAAAAEVN5/bsfYYAkHM/hRkx4N4+wNWSCU7jv+riOorXyJsJgEAAAAA/f///wJmbOcpAQAAABYAFCCSJBD9wY/VwxnBcnFiu1tA6CGTQEIPAAAAAAAWABSjI8KCqaGX/BGOwJza8hyiuxuIcmcAAAABAR9AQg8AAAAAABYAFKMjwoKpoZf8EY7AnNryHKK7G4hyAAEAcQIAAAAB98EwKZMOHiyRYWyToae6Kce3gCwqUvnVXXHlB/ps9ocBAAAAAP3///8CmNuLKQEAAAAWABQ4roxw+phYHelaRr71DYB3FEy/30BCDwAAAAAAFgAUwSDtQiY7PVvBc7ww56Y72YIQdjllAAAAAQEfQEIPAAAAAAAWABTBIO1CJjs9W8FzvDDnpjvZghB2OQABAHECAAAAAZH/SvCXvDW7b8qb55CDC4M+jgZ61H/e8rZnAGaXp+Z+AAAAAAD9////Apkp2CkBAAAAFgAUc/Y+sIq3oYyEe40GkKJsXawkzwFAQg8AAAAAABYAFLdt1h5Bte8FKvIc2jJgiIwHC7mvZwAAAAEBH0BCDwAAAAAAFgAUt23WHkG17wUq8hzaMmCIjAcLua8AAQBxAgAAAAETC3wMCv9qK3lvVkVJu9b/v2VgMepZtnfngMp2xMXRnwAAAAAA/f///wJk0E4pAQAAABYAFEIsc4cBl+BTN33Kn80+YYfkMt+cQEIPAAAAAAAWABT2/7RIxKohhGbacpBz0BZNYcnfsGUAAAABAR9AQg8AAAAAABYAFPb/tEjEqiGEZtpykHPQFk1hyd+wAAEAcQIAAAABA8J/OnC+cuH79Z6wZmzwdAjhBDaPHavh3yvhr4odDXQBAAAAAP3///8CykowKQEAAAAWABTVHuO8cKOOX/JlmMU66on6Uc54mkBCDwAAAAAAFgAUunZMZryWMqCTiMuVWNF/cleg6dVnAAAAAQEfQEIPAAAAAAAWABS6dkxmvJYyoJOIy5VY0X9yV6Dp1QABAHECAAAAAfRxBaZZ3FfDGwxhZQLYCurN+7kJj0x6nzChg434dnjRAAAAAAD9////AszmyCkBAAAAFgAULSqRp54barF/7R9XOmsLDCVWdAFAQg8AAAAAABYAFNa5adNt/9rZhpGT9mPuSA39xzSIZQAAAAEBH0BCDwAAAAAAFgAU1rlp023/2tmGkZP2Y+5IDf3HNIgAAQBxAgAAAAEgk1JYyP4oIoPoYYcTPPDvZynVfXWINJnBEFBsLv0MtAAAAAAA/f///wJAQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iMmGqKQEAAAAWABT5XKNwVIFsUKh26sqHFSlOLq5TFGUAAAABAR9AQg8AAAAAABYAFGYcI7eQ3TSRNzrwsdi+0Id9XN4iIgID+pyVCF5CseUAPNH0GBeMMMluSud5VMoPxIxYgm/06w5HMEQCIG90DSr+fGNoWhCrgLbJG3Wt8PJNMWYqaa5MLWRwA0oTAiA9rsLEqqVhjV6wENfzzpudaE949uLlVqWgDjE/FSgKNAEiBgP6nJUIXkKx5QA80fQYF4wwyW5K53lUyg/EjFiCb/TrDghmHCO3AAAAAAAA" - } - ], "author": [ "Vincenzo Palazzo <> wrote the initial version of this man page,", "but many others did the hard work of actually implementing this rpc command." diff --git a/doc/schemas/lightning-splice_init.json b/doc/schemas/lightning-splice_init.json index 6e8d01b90820..561351d6cd78 100644 --- a/doc/schemas/lightning-splice_init.json +++ b/doc/schemas/lightning-splice_init.json @@ -109,36 +109,38 @@ "lightning-cli splice_signed $CHANNEL_ID $PSBT", "```" ], - "example_json_request": [ + "json_example": [ { - "id": "example:splice_init#1", - "method": "splice_init", - "params": { - "channel_id": "5677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc", - "relative_amount": 100000, - "initialpsbt": "cHNidP8BAF4CAAAAAVZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQAAAAD9////AU58DQAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5sAAAAAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", - "feerate_per_kw": null + "request": { + "id": "example:splice_init#1", + "method": "splice_init", + "params": { + "channel_id": "5677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc", + "relative_amount": 100000, + "initialpsbt": "cHNidP8BAF4CAAAAAVZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQAAAAD9////AU58DQAAAAAAIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL5sAAAAAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oAAA==", + "feerate_per_kw": null + } + }, + "response": { + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEFR1IhAjJCZt6EA7OrFXoJ8feE1YevYYMcmYwVG8whu3TCsjFLIQLjvTgAmGbJ2o7EqpnMTqnGwN1G3xXGHvDOHycSkXFOV1KuAQ4gVndyHDWkJKI9bcx8kJA25QWuaGUOCdWXM7S35zADpNwBDwQAAAAAARAEAAAAAAz8CWxpZ2h0bmluZwEIK/Jiqp0i3SYAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAQAAAAEQBP3///8M/AlsaWdodG5pbmcBCDmPhBY5ChQUAAEDCE58DQAAAAAAAQQiUSB4NjVf3IqC3EywCncsVVQVHQY4Sk3WXo0/aKwIVmuEvgz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMIAAAAAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" } }, { - "id": "example:splice_init#2", - "method": "splice_init", - "params": { - "channel_id": "a40bb442dab0231b51d8f842d95aad548aa35e1d13c4cfcf2997344f805453a1", - "relative_amount": -105000, - "initialpsbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIoIYBAAAAAAABBCJRIHg2NV/cioLcTLAKdyxVVBUdBjhKTdZejT9orAhWa4S+AA==", - "feerate_per_kw": null + "request": { + "id": "example:splice_init#2", + "method": "splice_init", + "params": { + "channel_id": "a40bb442dab0231b51d8f842d95aad548aa35e1d13c4cfcf2997344f805453a1", + "relative_amount": -105000, + "initialpsbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIoIYBAAAAAAABBCJRIHg2NV/cioLcTLAKdyxVVBUdBjhKTdZejT9orAhWa4S+AA==", + "feerate_per_kw": null + } + }, + "response": { + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABARzi7RBt64yrfqRL2p+KiUw8cYtiKICRFHmp/4eCSemSAQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgTCjR9L+TfzP7pLJVVto5egTRbRNj/RaBhyrA3UW0aEcCIAJO5FZjXvdpRcGR949C4DnfHs3soklTjn/1upkia+TgASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M9mAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEFR1IhAjJCZt6EA7OrFXoJ8feE1YevYYMcmYwVG8whu3TCsjFLIQLjvTgAmGbJ2o7EqpnMTqnGwN1G3xXGHvDOHycSkXFOV1KuAQ4gpAu0QtqwIxtR2PhC2VqtVIqjXh0TxM/PKZc0T4BUU6EBDwQAAAAAARAEAAAAAAz8CWxpZ2h0bmluZwEIn2Ac8fyFEJwAAQMIAAAAAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQgu7JK9IpBWOAABAwighgEAAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4M/AlsaWdodG5pbmcBCOZ1GpRwbKfuAA==" } } ], - "example_json_response": [ - { - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEFR1IhAjJCZt6EA7OrFXoJ8feE1YevYYMcmYwVG8whu3TCsjFLIQLjvTgAmGbJ2o7EqpnMTqnGwN1G3xXGHvDOHycSkXFOV1KuAQ4gVndyHDWkJKI9bcx8kJA25QWuaGUOCdWXM7S35zADpNwBDwQAAAAAARAEAAAAAAz8CWxpZ2h0bmluZwEIK/Jiqp0i3SYAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAQAAAAEQBP3///8M/AlsaWdodG5pbmcBCDmPhBY5ChQUAAEDCE58DQAAAAAAAQQiUSB4NjVf3IqC3EywCncsVVQVHQY4Sk3WXo0/aKwIVmuEvgz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMIAAAAAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" - }, - { - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABARzi7RBt64yrfqRL2p+KiUw8cYtiKICRFHmp/4eCSemSAQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgTCjR9L+TfzP7pLJVVto5egTRbRNj/RaBhyrA3UW0aEcCIAJO5FZjXvdpRcGR949C4DnfHs3soklTjn/1upkia+TgASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M9mAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEFR1IhAjJCZt6EA7OrFXoJ8feE1YevYYMcmYwVG8whu3TCsjFLIQLjvTgAmGbJ2o7EqpnMTqnGwN1G3xXGHvDOHycSkXFOV1KuAQ4gpAu0QtqwIxtR2PhC2VqtVIqjXh0TxM/PKZc0T4BUU6EBDwQAAAAAARAEAAAAAAz8CWxpZ2h0bmluZwEIn2Ac8fyFEJwAAQMIAAAAAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQgu7JK9IpBWOAABAwighgEAAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4M/AlsaWdodG5pbmcBCOZ1GpRwbKfuAA==" - } - ], "author": [ "Dusty <<@dusty_daemon>> is mainly responsible." ], diff --git a/doc/schemas/lightning-splice_signed.json b/doc/schemas/lightning-splice_signed.json index 08c5756dafac..1b3285ab9307 100644 --- a/doc/schemas/lightning-splice_signed.json +++ b/doc/schemas/lightning-splice_signed.json @@ -98,22 +98,22 @@ "lightning-cli splice_signed $CHANNEL_ID $PSBT", "```" ], - "example_json_request": [ + "json_example": [ { - "id": "example:splice_signed#1", - "method": "splice_signed", - "params": { - "channel_id": "5677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc", - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////ARNACI9TcWG+6uC9ElBFN3qhND7amsor/dtBhJ5ujEQAT/80548avrt7d7IJiOAaCNzzYLSXITdL2xjx6mhbBi9hTiEWkUUygSpECk12bHHNORk2lKNArhHgEuW6Gtnvum52ylMJAMLMqxcAAAAADPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4hB7nAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXCQDWuWnTBAAAAAz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMI4MgQAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" + "request": { + "id": "example:splice_signed#1", + "method": "splice_signed", + "params": { + "channel_id": "5677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc", + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////ARNACI9TcWG+6uC9ElBFN3qhND7amsor/dtBhJ5ujEQAT/80548avrt7d7IJiOAaCNzzYLSXITdL2xjx6mhbBi9hTiEWkUUygSpECk12bHHNORk2lKNArhHgEuW6Gtnvum52ylMJAMLMqxcAAAAADPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4hB7nAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXCQDWuWnTBAAAAAz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMI4MgQAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" + } + }, + "response": { + "tx": "020000000001025677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc0000000000000000005677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc0100000000fdffffff024e7c0d00000000002251207836355fdc8a82dc4cb00a772c5554151d06384a4dd65e8d3f68ac08566b84bee0c81000000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd0400473044022053269f3951a1fc942174ac0dde8462405a86c89b31b444890664ee9735872cff02204cd822c4456c15e90ad342b23e9bb252d383d4e17a8a04818c4919e4fd61efd80147304402205ac0787c79e74ebfa0eaf18964625c53eb672cc4bed2c65303bd9cc192dad6f902206c6c0cded47201dae0020f50a8998555e654d3420c64e801fc668238e3c1cdfa0147522102324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b2102e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5752ae0140088f537161beeae0bd125045377aa1343eda9aca2bfddb41849e6e8c44004fff34e78f1abebb7b77b20988e01a08dcf360b49721374bdb18f1ea685b062f614e6c000000", + "txid": "f00d5e230b401274c88d3e6205e2c6117028cb9878b7d2bc52b1441f0b589427" } } ], - "example_json_response": [ - { - "tx": "020000000001025677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc0000000000000000005677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc0100000000fdffffff024e7c0d00000000002251207836355fdc8a82dc4cb00a772c5554151d06384a4dd65e8d3f68ac08566b84bee0c81000000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd0400473044022053269f3951a1fc942174ac0dde8462405a86c89b31b444890664ee9735872cff02204cd822c4456c15e90ad342b23e9bb252d383d4e17a8a04818c4919e4fd61efd80147304402205ac0787c79e74ebfa0eaf18964625c53eb672cc4bed2c65303bd9cc192dad6f902206c6c0cded47201dae0020f50a8998555e654d3420c64e801fc668238e3c1cdfa0147522102324266de8403b3ab157a09f1f784d587af61831c998c151bcc21bb74c2b2314b2102e3bd38009866c9da8ec4aa99cc4ea9c6c0dd46df15c61ef0ce1f271291714e5752ae0140088f537161beeae0bd125045377aa1343eda9aca2bfddb41849e6e8c44004fff34e78f1abebb7b77b20988e01a08dcf360b49721374bdb18f1ea685b062f614e6c000000", - "txid": "f00d5e230b401274c88d3e6205e2c6117028cb9878b7d2bc52b1441f0b589427" - } - ], "author": [ "Dusty <<@dusty_daemon>> is mainly responsible." ], diff --git a/doc/schemas/lightning-splice_update.json b/doc/schemas/lightning-splice_update.json index 02e58de6eaae..17882f86cbc1 100644 --- a/doc/schemas/lightning-splice_update.json +++ b/doc/schemas/lightning-splice_update.json @@ -102,22 +102,22 @@ "lightning-cli splice_signed $CHANNEL_ID $PSBT", "```" ], - "example_json_request": [ + "json_example": [ { - "id": "example:splice_update#1", - "method": "splice_update", - "params": { - "channel_id": "5677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc", - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEFR1IhAjJCZt6EA7OrFXoJ8feE1YevYYMcmYwVG8whu3TCsjFLIQLjvTgAmGbJ2o7EqpnMTqnGwN1G3xXGHvDOHycSkXFOV1KuAQ4gVndyHDWkJKI9bcx8kJA25QWuaGUOCdWXM7S35zADpNwBDwQAAAAAARAEAAAAAAz8CWxpZ2h0bmluZwEIK/Jiqp0i3SYAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAQAAAAEQBP3///8M/AlsaWdodG5pbmcBCDmPhBY5ChQUAAEDCE58DQAAAAAAAQQiUSB4NjVf3IqC3EywCncsVVQVHQY4Sk3WXo0/aKwIVmuEvgz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMIAAAAAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" + "request": { + "id": "example:splice_update#1", + "method": "splice_update", + "params": { + "channel_id": "5677721c35a424a23d6dcc7c909036e505ae68650e09d59733b4b7e73003a4dc", + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEFR1IhAjJCZt6EA7OrFXoJ8feE1YevYYMcmYwVG8whu3TCsjFLIQLjvTgAmGbJ2o7EqpnMTqnGwN1G3xXGHvDOHycSkXFOV1KuAQ4gVndyHDWkJKI9bcx8kJA25QWuaGUOCdWXM7S35zADpNwBDwQAAAAAARAEAAAAAAz8CWxpZ2h0bmluZwEIK/Jiqp0i3SYAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAQAAAAEQBP3///8M/AlsaWdodG5pbmcBCDmPhBY5ChQUAAEDCE58DQAAAAAAAQQiUSB4NjVf3IqC3EywCncsVVQVHQY4Sk3WXo0/aKwIVmuEvgz8CWxpZ2h0bmluZwEIxt4P7eqf3+QAAQMIAAAAAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQji6kH6aOXoAgA=" + } + }, + "response": { + "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////DPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4M/AlsaWdodG5pbmcBCMbeD+3qn9/kAAEDCODIEAAAAAAAAQQiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQz8CWxpZ2h0bmluZwEI4upB+mjl6AIA", + "commitments_secured": true } } ], - "example_json_response": [ - { - "psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQIBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABAYulMzSBYSogKOBxk3Kg+HN0Hl81kGsQVuw2mwoetN33AQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgFlrmLyNU919XilsjNJ5sxvlE36XmUmRAoDD36K8BZ+cCIE2F6HPv3XjcNsU6hOOY9hUSuVjQUuVWqiNf3Bq3RopeASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8YAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEOIFZ3chw1pCSiPW3MfJCQNuUFrmhlDgnVlzO0t+cwA6TcAQ8EAAAAAAEQBAAAAAAM/AlsaWdodG5pbmcBCCvyYqqdIt0mAAEA9gIAAAAAAQGLpTM0gWEqICjgcZNyoPhzdB5fNZBrEFbsNpsKHrTd9wEAAAAA/f///wJAQg8AAAAAACIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAS8PAAAAAAAiUSBj/+5Op9UebK35CG4oaiUnkiqqJbjFOuvzL6MqCmJ/WgJHMEQCIBZa5i8jVPdfV4pbIzSebMb5RN+l5lJkQKAw9+ivAWfnAiBNhehz79143DbFOoTjmPYVErlY0FLlVqojX9wat0aKXgEhA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPGAAAAAEBKwEvDwAAAAAAIlEgY//uTqfVHmyt+QhuKGolJ5IqqiW4xTrr8y+jKgpif1oBDiBWd3IcNaQkoj1tzHyQkDblBa5oZQ4J1ZcztLfnMAOk3AEPBAEAAAABEAT9////DPwJbGlnaHRuaW5nAQg5j4QWOQoUFAABAwhOfA0AAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4M/AlsaWdodG5pbmcBCMbeD+3qn9/kAAEDCODIEAAAAAAAAQQiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQz8CWxpZ2h0bmluZwEI4upB+mjl6AIA", - "commitments_secured": true - } - ], "author": [ "Dusty <<@dusty_daemon>> is mainly responsible." ], diff --git a/doc/schemas/lightning-sql-template.json b/doc/schemas/lightning-sql-template.json index 7b9cd43e5edd..2eddb64a72d4 100644 --- a/doc/schemas/lightning-sql-template.json +++ b/doc/schemas/lightning-sql-template.json @@ -200,53 +200,55 @@ "}", "```" ], - "example_json_request": [ + "json_example": [ { - "id": "example:sql#1", - "method": "sql", - "params": [ - "SELECT * FROM forwards;" - ] - }, - { - "id": "example:sql#2", - "method": "sql", - "params": [ - "SELECT * from peerchannels_features" - ] - } - ], - "example_json_response": [ - { - "rows": [] + "request": { + "id": "example:sql#1", + "method": "sql", + "params": [ + "SELECT * FROM forwards;" + ] + }, + "response": { + "rows": [] + } }, { - "rows": [ - [ - 6, - 1, - 0, - "option_static_remotekey" - ], - [ - 7, - 1, - 1, - "option_anchors_zero_fee_htlc_tx" - ], - [ - 16, - 11, - 0, - "option_static_remotekey" - ], - [ - 17, - 11, - 1, - "option_anchors_zero_fee_htlc_tx" + "request": { + "id": "example:sql#2", + "method": "sql", + "params": [ + "SELECT * from peerchannels_features" ] - ] + }, + "response": { + "rows": [ + [ + 6, + 1, + 0, + "option_static_remotekey" + ], + [ + 7, + 1, + 1, + "option_anchors_zero_fee_htlc_tx" + ], + [ + 16, + 11, + 0, + "option_static_remotekey" + ], + [ + 17, + 11, + 1, + "option_anchors_zero_fee_htlc_tx" + ] + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-staticbackup.json b/doc/schemas/lightning-staticbackup.json index 170b13522acc..dcf38a507843 100644 --- a/doc/schemas/lightning-staticbackup.json +++ b/doc/schemas/lightning-staticbackup.json @@ -27,18 +27,18 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:staticbackup#1", - "method": "staticbackup", - "params": "{}" - } - ], - "example_json_response": [ - { - "scb": [ - "0000000000000001c707da9b230e1655b0a6c082b8daf4fa44d9d1f68163ed4d531d45cf453dc651022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d5900017f000001b2e3c707da9b230e1655b0a6c082b8daf4fa44d9d1f68163ed4d531d45cf453dc6510000000000000000000186a000021000" - ] + "request": { + "id": "example:staticbackup#1", + "method": "staticbackup", + "params": "{}" + }, + "response": { + "scb": [ + "0000000000000001c707da9b230e1655b0a6c082b8daf4fa44d9d1f68163ed4d531d45cf453dc651022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d5900017f000001b2e3c707da9b230e1655b0a6c082b8daf4fa44d9d1f68163ed4d531d45cf453dc6510000000000000000000186a000021000" + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-stop.json b/doc/schemas/lightning-stop.json index 3a982d1bac97..9a0df291ede7 100644 --- a/doc/schemas/lightning-stop.json +++ b/doc/schemas/lightning-stop.json @@ -25,16 +25,16 @@ } } }, - "example_json_request": [ + "json_example": [ { - "id": "example:stop#1", - "method": "stop", - "params": {} - } - ], - "example_json_response": [ - { - "result": "Shutdown complete" + "request": { + "id": "example:stop#1", + "method": "stop", + "params": {} + }, + "response": { + "result": "Shutdown complete" + } } ], "author": [ diff --git a/doc/schemas/lightning-txdiscard.json b/doc/schemas/lightning-txdiscard.json index eb3996e64f8c..4a3f8d85c506 100644 --- a/doc/schemas/lightning-txdiscard.json +++ b/doc/schemas/lightning-txdiscard.json @@ -48,21 +48,21 @@ "", "- -1: An unknown *txid*." ], - "example_json_request": [ + "json_example": [ { - "id": "example:txdiscard#1", - "method": "txdiscard", - "params": { + "request": { + "id": "example:txdiscard#1", + "method": "txdiscard", + "params": { + "txid": "6e680cb76077f11c838cc7aee0c0aa360f9857f00856bb1614025a1af53739fc" + } + }, + "response": { + "unsigned_tx": "020000000142dc00d81359c3a551e170e3bf5262fa9cacc2eb2e283a10e579491cd86dce4b0000000000fdffffff02ffffff00000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd42839800000000002251207836355fdc8a82dc4cb00a772c5554151d06384a4dd65e8d3f68ac08566b84be66000000", "txid": "6e680cb76077f11c838cc7aee0c0aa360f9857f00856bb1614025a1af53739fc" } } ], - "example_json_response": [ - { - "unsigned_tx": "020000000142dc00d81359c3a551e170e3bf5262fa9cacc2eb2e283a10e579491cd86dce4b0000000000fdffffff02ffffff00000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd42839800000000002251207836355fdc8a82dc4cb00a772c5554151d06384a4dd65e8d3f68ac08566b84be66000000", - "txid": "6e680cb76077f11c838cc7aee0c0aa360f9857f00856bb1614025a1af53739fc" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-txprepare.json b/doc/schemas/lightning-txprepare.json index 256cbb5f21bd..fe7d09824341 100644 --- a/doc/schemas/lightning-txprepare.json +++ b/doc/schemas/lightning-txprepare.json @@ -82,48 +82,50 @@ "- 301: There are not enough funds in the internal wallet (including fees) to create the transaction.", "- 302: The dust limit is not met." ], - "example_json_request": [ + "json_example": [ { - "id": "example:txprepare#1", - "method": "txprepare", - "params": { - "outputs": [ - { - "bcrt1qtwxd8wg5eanumk86vfeujvp48hfkgannf77evggzct048wggsrxsum2pmm": 16777215 - } - ], - "feerate": null, - "minconf": null, - "utxos": null + "request": { + "id": "example:txprepare#1", + "method": "txprepare", + "params": { + "outputs": [ + { + "bcrt1qtwxd8wg5eanumk86vfeujvp48hfkgannf77evggzct048wggsrxsum2pmm": 16777215 + } + ], + "feerate": null, + "minconf": null, + "utxos": null + } + }, + "response": { + "unsigned_tx": "020000000142dc00d81359c3a551e170e3bf5262fa9cacc2eb2e283a10e579491cd86dce4b0000000000fdffffff02ffffff00000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd42839800000000002251207836355fdc8a82dc4cb00a772c5554151d06384a4dd65e8d3f68ac08566b84be66000000", + "txid": "6e680cb76077f11c838cc7aee0c0aa360f9857f00856bb1614025a1af53739fc", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABATRHoQ9tEMHRHpf06v5uTEdjdMk1rccIaA6MNGMipNQWAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFLnqitWTi465LGxeucwoSAj16NGbAkcwRAIgVtOsUaQaPgH86aW6e6qmJa1xVb8KWvc+HALGosqVVmQCIFi4JU8Gy+vl2a2/frY+71hitYIBB/tjsRP7fpgb8b9TASECHUIV5q1r2ownjOlAFPQASTlZxxNgBvi5O3hCRvajwdJlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIELcANgTWcOlUeFw479SYvqcrMLrLig6EOV5SRzYbc5LAQ8EAAAAAAEQBP3///8AAQMI////AAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAAEDCEKDmAAAAAAAAQQiUSB4NjVf3IqC3EywCncsVVQVHQY4Sk3WXo0/aKwIVmuEvgA=" } }, { - "id": "example:txprepare#2", - "method": "txprepare", - "params": { - "outputs": [ - { - "bcrt1qyhu7rxj3rrlcj84jtzp2mk9d89xm9v2rx4d4h8au830axugx6mmqsuplng": "100000sat" - } - ], - "feerate": null, - "minconf": null, - "utxos": null + "request": { + "id": "example:txprepare#2", + "method": "txprepare", + "params": { + "outputs": [ + { + "bcrt1qyhu7rxj3rrlcj84jtzp2mk9d89xm9v2rx4d4h8au830axugx6mmqsuplng": "100000sat" + } + ], + "feerate": null, + "minconf": null, + "utxos": null + } + }, + "response": { + "unsigned_tx": "0200000001a91077a134fb9fe4a8d13a482b718368bfd9ce3eff61ff7d96549480a1f97dca0100000000fdffffff02a08601000000000022002025f9e19a5118ff891eb25882add8ad394db2b143355b5b9fbc3c5fd37106d6f66173010000000000225120a2a01c7965289eee56b5cfcddb9856c70fa476c264d21f711c6a69af776ae40366000000", + "txid": "f11d436054607603e903fc69c4bd9b39ce97421341c7cf814ad025cb5bf59c1c", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABAYZ4QwAgPq6Os8kk073f5Yx4T9LXYfbOjAdkzMXfuBQdAAAAAAD9////AjPkAioBAAAAFgAUeOeqzyifepeJAMCl4vnnJ/TRptRADQMAAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgYBFwmqWCrVkxxZ0/tte3z4lIem0L7MkhXzGAOvBWa6YCIFx7H4zOzxjixlZMi0DYYbIEflDjYHJXLfN1wVcXYuekASEDgztw/3Rks6vKGYMXJ83VEvQcNIjg3rJW6KdxEh26uwplAAAAAQEfQA0DAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIKkQd6E0+5/kqNE6SCtxg2i/2c4+/2H/fZZUlICh+X3KAQ8EAQAAAAEQBP3///8AAQMIoIYBAAAAAAABBCIAICX54ZpRGP+JHrJYgq3YrTlNsrFDNVtbn7w8X9NxBtb2AAEDCGFzAQAAAAAAAQQiUSCioBx5ZSie7la1z83bmFbHD6R2wmTSH3Ecammvd2rkAwA=" } } ], - "example_json_response": [ - { - "unsigned_tx": "020000000142dc00d81359c3a551e170e3bf5262fa9cacc2eb2e283a10e579491cd86dce4b0000000000fdffffff02ffffff00000000002200205b8cd3b914cf67cdd8fa6273c930353dd36476734fbd962102c2df53b90880cd42839800000000002251207836355fdc8a82dc4cb00a772c5554151d06384a4dd65e8d3f68ac08566b84be66000000", - "txid": "6e680cb76077f11c838cc7aee0c0aa360f9857f00856bb1614025a1af53739fc", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABATRHoQ9tEMHRHpf06v5uTEdjdMk1rccIaA6MNGMipNQWAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFLnqitWTi465LGxeucwoSAj16NGbAkcwRAIgVtOsUaQaPgH86aW6e6qmJa1xVb8KWvc+HALGosqVVmQCIFi4JU8Gy+vl2a2/frY+71hitYIBB/tjsRP7fpgb8b9TASECHUIV5q1r2ownjOlAFPQASTlZxxNgBvi5O3hCRvajwdJlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIELcANgTWcOlUeFw479SYvqcrMLrLig6EOV5SRzYbc5LAQ8EAAAAAAEQBP3///8AAQMI////AAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNAAEDCEKDmAAAAAAAAQQiUSB4NjVf3IqC3EywCncsVVQVHQY4Sk3WXo0/aKwIVmuEvgA=" - }, - { - "unsigned_tx": "0200000001a91077a134fb9fe4a8d13a482b718368bfd9ce3eff61ff7d96549480a1f97dca0100000000fdffffff02a08601000000000022002025f9e19a5118ff891eb25882add8ad394db2b143355b5b9fbc3c5fd37106d6f66173010000000000225120a2a01c7965289eee56b5cfcddb9856c70fa476c264d21f711c6a69af776ae40366000000", - "txid": "f11d436054607603e903fc69c4bd9b39ce97421341c7cf814ad025cb5bf59c1c", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABAYZ4QwAgPq6Os8kk073f5Yx4T9LXYfbOjAdkzMXfuBQdAAAAAAD9////AjPkAioBAAAAFgAUeOeqzyifepeJAMCl4vnnJ/TRptRADQMAAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgYBFwmqWCrVkxxZ0/tte3z4lIem0L7MkhXzGAOvBWa6YCIFx7H4zOzxjixlZMi0DYYbIEflDjYHJXLfN1wVcXYuekASEDgztw/3Rks6vKGYMXJ83VEvQcNIjg3rJW6KdxEh26uwplAAAAAQEfQA0DAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQEOIKkQd6E0+5/kqNE6SCtxg2i/2c4+/2H/fZZUlICh+X3KAQ8EAQAAAAEQBP3///8AAQMIoIYBAAAAAAABBCIAICX54ZpRGP+JHrJYgq3YrTlNsrFDNVtbn7w8X9NxBtb2AAEDCGFzAQAAAAAAAQQiUSCioBx5ZSie7la1z83bmFbHD6R2wmTSH3Ecammvd2rkAwA=" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-txsend.json b/doc/schemas/lightning-txsend.json index ecfa07da3c33..73ffabdea304 100644 --- a/doc/schemas/lightning-txsend.json +++ b/doc/schemas/lightning-txsend.json @@ -52,22 +52,22 @@ "", "- -1: Catchall nonspecific error." ], - "example_json_request": [ + "json_example": [ { - "id": "example:txsend#1", - "method": "txsend", - "params": { - "txid": "c9f59ba6bda8e095bb43ecabfa37de8d5194e5c839b6b63be4e29bceaae483ce" + "request": { + "id": "example:txsend#1", + "method": "txsend", + "params": { + "txid": "c9f59ba6bda8e095bb43ecabfa37de8d5194e5c839b6b63be4e29bceaae483ce" + } + }, + "response": { + "tx": "020000000142dc00d81359c3a551e170e3bf5262fa9cacc2eb2e283a10e579491cd86dce4b0000000000fdffffff020000000100000000220020b636f07026ea64952ece5b7620a9337d9ac2321c796a499260994d1b373667504183980000000000225120754a77b503fcba0fd80f0a1a8226ed6764ff9a9d9bb61b485d40d4c9f4be245966000000", + "txid": "c9f59ba6bda8e095bb43ecabfa37de8d5194e5c839b6b63be4e29bceaae483ce", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABATRHoQ9tEMHRHpf06v5uTEdjdMk1rccIaA6MNGMipNQWAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFLnqitWTi465LGxeucwoSAj16NGbAkcwRAIgVtOsUaQaPgH86aW6e6qmJa1xVb8KWvc+HALGosqVVmQCIFi4JU8Gy+vl2a2/frY+71hitYIBB/tjsRP7fpgb8b9TASECHUIV5q1r2ownjOlAFPQASTlZxxNgBvi5O3hCRvajwdJlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZSICA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPRzBEAiBp/HPhg1ObOXqTr5rIjUYLMspGLz+sk1pjD9pjRFzf3wIgWycOB/dQPzwZAK3OXYs269h8o85ucDpdVhH4AyX69a0BIgYD10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8IAfrZCgAAAAABDiBC3ADYE1nDpVHhcOO/UmL6nKzC6y4oOhDleUkc2G3OSwEPBAAAAAABEAT9////AAEDCAAAAAEAAAAAAQQiACC2NvBwJupklS7OW3YgqTN9msIyHHlqSZJgmU0bNzZnUAABAwhBg5gAAAAAAAEEIlEgdUp3tQP8ug/YDwoagibtZ2T/mp2bthtIXUDUyfS+JFkhBycqmiXx/+1S+rBKLMiK6rE1tTcjhWqPFIHCZBf4ipIuCQDVXEk5CwAAAAA=" } } ], - "example_json_response": [ - { - "tx": "020000000142dc00d81359c3a551e170e3bf5262fa9cacc2eb2e283a10e579491cd86dce4b0000000000fdffffff020000000100000000220020b636f07026ea64952ece5b7620a9337d9ac2321c796a499260994d1b373667504183980000000000225120754a77b503fcba0fd80f0a1a8226ed6764ff9a9d9bb61b485d40d4c9f4be245966000000", - "txid": "c9f59ba6bda8e095bb43ecabfa37de8d5194e5c839b6b63be4e29bceaae483ce", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABATRHoQ9tEMHRHpf06v5uTEdjdMk1rccIaA6MNGMipNQWAAAAAAD9////AoCWmAEAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WXzWm0oAQAAABYAFLnqitWTi465LGxeucwoSAj16NGbAkcwRAIgVtOsUaQaPgH86aW6e6qmJa1xVb8KWvc+HALGosqVVmQCIFi4JU8Gy+vl2a2/frY+71hitYIBB/tjsRP7fpgb8b9TASECHUIV5q1r2ownjOlAFPQASTlZxxNgBvi5O3hCRvajwdJlAAAAAQEfgJaYAQAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZSICA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPRzBEAiBp/HPhg1ObOXqTr5rIjUYLMspGLz+sk1pjD9pjRFzf3wIgWycOB/dQPzwZAK3OXYs269h8o85ucDpdVhH4AyX69a0BIgYD10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8IAfrZCgAAAAABDiBC3ADYE1nDpVHhcOO/UmL6nKzC6y4oOhDleUkc2G3OSwEPBAAAAAABEAT9////AAEDCAAAAAEAAAAAAQQiACC2NvBwJupklS7OW3YgqTN9msIyHHlqSZJgmU0bNzZnUAABAwhBg5gAAAAAAAEEIlEgdUp3tQP8ug/YDwoagibtZ2T/mp2bthtIXUDUyfS+JFkhBycqmiXx/+1S+rBKLMiK6rE1tTcjhWqPFIHCZBf4ipIuCQDVXEk5CwAAAAA=" - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-unreserveinputs.json b/doc/schemas/lightning-unreserveinputs.json index 2552b677ef36..14bc09cc9381 100644 --- a/doc/schemas/lightning-unreserveinputs.json +++ b/doc/schemas/lightning-unreserveinputs.json @@ -109,37 +109,39 @@ "", "- -32602: Invalid parameter, i.e. an unparseable PSBT." ], - "example_json_request": [ + "json_example": [ { - "id": "example:unreserveinputs#1", - "method": "unreserveinputs", - "params": { - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABAXyy20ynmOFyRbegGyApk50yNIAb4C+RKV5c2n5VKL3lAAAAAAD9////Akf0EAAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUs/fQpAQAAABYAFN9HebR4q6498ytdeRKjC64CkCOMAkcwRAIgSTJCpWVH1FLZYPdwFe7gZckxCtk+AxPp20KUVKqPIdUCIA3hkoUco68vffiwt6TrE3KgX09JE9m7PDUUgrHQANMRASEDBOBlCza/8qXE5q8uJ+OWsKscDERWfdA+LLCa/lwMH0BlAAAAAQEfR/QQAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZSICA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPRzBEAiBKjSasyN29ODqXSemEQCZfRIvbJP8thKRBrd4e+NLEMQIgMGNz3+DWDnLmjnIDCaVcC7BKxuycwvtJq1qlKFtTaXcBIgYD10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8IAfrZCgAAAAABDiAoXS6QUlCcOApG/j+hr4OhNt0tT4GvCzI6z16Hepi7OwEPBAAAAAABEAT9////AAEDCCN6CAAAAAAAAQQWABQfJ4Qjje0sa2yGBz++6jkM2hGRmAz8CWxpZ2h0bmluZwQCAAEAAQMIinkIAAAAAAABBCJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aIQeRRTKBKkQKTXZscc05GTaUo0CuEeAS5boa2e+6bnbKUwkAwsyrFwIAAAAA", - "reserve": 200 + "request": { + "id": "example:unreserveinputs#1", + "method": "unreserveinputs", + "params": { + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABAXyy20ynmOFyRbegGyApk50yNIAb4C+RKV5c2n5VKL3lAAAAAAD9////Akf0EAAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUs/fQpAQAAABYAFN9HebR4q6498ytdeRKjC64CkCOMAkcwRAIgSTJCpWVH1FLZYPdwFe7gZckxCtk+AxPp20KUVKqPIdUCIA3hkoUco68vffiwt6TrE3KgX09JE9m7PDUUgrHQANMRASEDBOBlCza/8qXE5q8uJ+OWsKscDERWfdA+LLCa/lwMH0BlAAAAAQEfR/QQAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZSICA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPRzBEAiBKjSasyN29ODqXSemEQCZfRIvbJP8thKRBrd4e+NLEMQIgMGNz3+DWDnLmjnIDCaVcC7BKxuycwvtJq1qlKFtTaXcBIgYD10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8IAfrZCgAAAAABDiAoXS6QUlCcOApG/j+hr4OhNt0tT4GvCzI6z16Hepi7OwEPBAAAAAABEAT9////AAEDCCN6CAAAAAAAAQQWABQfJ4Qjje0sa2yGBz++6jkM2hGRmAz8CWxpZ2h0bmluZwQCAAEAAQMIinkIAAAAAAABBCJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aIQeRRTKBKkQKTXZscc05GTaUo0CuEeAS5boa2e+6bnbKUwkAwsyrFwIAAAAA", + "reserve": 200 + } + }, + "response": { + "reservations": [ + { + "txid": "3bbb987a875ecf3a320baf814f2ddd36a183afa13ffe460a389c5052902e5d28", + "vout": 0, + "was_reserved": true, + "reserved": false + } + ] } }, { - "id": "example:unreserveinputs#2", - "method": "unreserveinputs", - "params": { - "psbt": "cHNidP8BAF4CAAAAAVa79WPJoiYrzo/RgzIAn5HanoBFZo0vZvEjxPAVwLv4AAAAAAD9////AXzpHAAAAAAAIlEgBRjpLNlOD2LAbxJt/5i5q+ebfthFoVbVJFZ44mVUR11mAAAAAAEA3gIAAAAAAQENwcSElLyC0jcwUHiODBhtapHyzIdiwytOGiu/Raf4BwAAAAAA/f///wKAhB4AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFl82znKQEAAAAWABQyIWyAI6LDf6dJ58BDPdkh+PWUZwJHMEQCIGiJFhVi/d/Hz19Cz48uHTjhgBJ6WAlgl/bLVS7A6VtxAiAwlb7xYzIM4uopFvMnpOmGIOp3+upOPPF2F8VaB8U/HQEhA6BAjey7RADP4ifoh2VXhX7QXkh+sZqozv1EPuU5TxZmZQAAAAEBH4CEHgAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUAAA==", - "reserve": null - } - } - ], - "example_json_response": [ - { - "reservations": [ - { - "txid": "3bbb987a875ecf3a320baf814f2ddd36a183afa13ffe460a389c5052902e5d28", - "vout": 0, - "was_reserved": true, - "reserved": false + "request": { + "id": "example:unreserveinputs#2", + "method": "unreserveinputs", + "params": { + "psbt": "cHNidP8BAF4CAAAAAVa79WPJoiYrzo/RgzIAn5HanoBFZo0vZvEjxPAVwLv4AAAAAAD9////AXzpHAAAAAAAIlEgBRjpLNlOD2LAbxJt/5i5q+ebfthFoVbVJFZ44mVUR11mAAAAAAEA3gIAAAAAAQENwcSElLyC0jcwUHiODBhtapHyzIdiwytOGiu/Raf4BwAAAAAA/f///wKAhB4AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFl82znKQEAAAAWABQyIWyAI6LDf6dJ58BDPdkh+PWUZwJHMEQCIGiJFhVi/d/Hz19Cz48uHTjhgBJ6WAlgl/bLVS7A6VtxAiAwlb7xYzIM4uopFvMnpOmGIOp3+upOPPF2F8VaB8U/HQEhA6BAjey7RADP4ifoh2VXhX7QXkh+sZqozv1EPuU5TxZmZQAAAAEBH4CEHgAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUAAA==", + "reserve": null } - ] - }, - { - "reservations": [] + }, + "response": { + "reservations": [] + } } ], "author": [ diff --git a/doc/schemas/lightning-upgradewallet.json b/doc/schemas/lightning-upgradewallet.json index ff70c9fe82de..0f74f3cefb26 100644 --- a/doc/schemas/lightning-upgradewallet.json +++ b/doc/schemas/lightning-upgradewallet.json @@ -67,30 +67,32 @@ "", "The caller can call `upgradewallet` to convert their funds to native segwit outputs, which are valid for liquidity ad buys." ], - "example_json_request": [ + "json_example": [ { - "id": "example:upgradewallet#1", - "method": "upgradewallet", - "params": "{}" - }, - { - "id": "example:upgradewallet#2", - "method": "upgradewallet", - "params": { - "feerate": "urgent", - "reservedok": true + "request": { + "id": "example:upgradewallet#1", + "method": "upgradewallet", + "params": "{}" + }, + "response": { + "upgraded_outs": 0 } - } - ], - "example_json_response": [ - { - "upgraded_outs": 0 }, { - "tx": "0200000001c08ce0a9ea1e00179ea603cb8619ec2a2df990ef931e1ccd87fa7a0e271ed8370100000000fdffffff013514310100000000225120888ab14b6e1655d1d00039b836d70b66e3351543ab6cd2f94166255f3d5e6cb5cf000000", - "txid": "de5f1d6f0b2f95cfe5cfbf8cc33bd3f279a8f800ee0efc27bbfafb2b6ead9560", - "psbt": "cHNidP8BAgQCAAAAAQMEzwAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDgAgAAAAABAZRZ0m0kaJA+ubJw1eYurGROu1BYc0i7l9xbyG06R6uZAQAAAAD9////AmQtPCgBAAAAF6kUnoGu9IUv0FGnzol3Lb/BNBNkOViHAC0xAQAAAAAXqRRlVyjzbP420BqlDTI2cERp+EpVQIcCRzBEAiBliJpjBsipwFgsLZMlzbESZ6hMTh+pgKQlXUIL0nLb3wIga/xwr/IJgEc7Ie6ApS4aVDr9xr1TZ3wj+8bRvI6WqScBIQPgYuc48PzUufScX6A6YOsdmJwn+bAQjLZ/g9jhQYduHM4AAAABASAALTEBAAAAABepFGVXKPNs/jbQGqUNMjZwRGn4SlVAhyICArnAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXRzBEAiBlTUNYfS5n5rGRVmoNb0z3AMGJjHijwpXROGIVxfoBnQIgeTx32KY3CcfYTYzXUIRQAMUQB7rlPWRptWMDD3UttkcBAQQWABTWuWnTbf/a2YaRk/Zj7kgN/cc0iCIGArnAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXCNa5adMAAAAAAQ4gwIzgqeoeABeepgPLhhnsKi35kO+THhzNh/p6Dice2DcBDwQBAAAAARAE/f///wABAwg1FDEBAAAAAAEEIlEgiIqxS24WVdHQADm4NtcLZuM1FUOrbNL5QWYlXz1ebLUhByjMj8l44gnxaV+ltWVQYdsaqyMRtSQXaUW/EBXvLUuJCQCftnv8BwAAAAA=", - "upgraded_outs": 1 + "request": { + "id": "example:upgradewallet#2", + "method": "upgradewallet", + "params": { + "feerate": "urgent", + "reservedok": true + } + }, + "response": { + "tx": "0200000001c08ce0a9ea1e00179ea603cb8619ec2a2df990ef931e1ccd87fa7a0e271ed8370100000000fdffffff013514310100000000225120888ab14b6e1655d1d00039b836d70b66e3351543ab6cd2f94166255f3d5e6cb5cf000000", + "txid": "de5f1d6f0b2f95cfe5cfbf8cc33bd3f279a8f800ee0efc27bbfafb2b6ead9560", + "psbt": "cHNidP8BAgQCAAAAAQMEzwAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQDgAgAAAAABAZRZ0m0kaJA+ubJw1eYurGROu1BYc0i7l9xbyG06R6uZAQAAAAD9////AmQtPCgBAAAAF6kUnoGu9IUv0FGnzol3Lb/BNBNkOViHAC0xAQAAAAAXqRRlVyjzbP420BqlDTI2cERp+EpVQIcCRzBEAiBliJpjBsipwFgsLZMlzbESZ6hMTh+pgKQlXUIL0nLb3wIga/xwr/IJgEc7Ie6ApS4aVDr9xr1TZ3wj+8bRvI6WqScBIQPgYuc48PzUufScX6A6YOsdmJwn+bAQjLZ/g9jhQYduHM4AAAABASAALTEBAAAAABepFGVXKPNs/jbQGqUNMjZwRGn4SlVAhyICArnAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXRzBEAiBlTUNYfS5n5rGRVmoNb0z3AMGJjHijwpXROGIVxfoBnQIgeTx32KY3CcfYTYzXUIRQAMUQB7rlPWRptWMDD3UttkcBAQQWABTWuWnTbf/a2YaRk/Zj7kgN/cc0iCIGArnAxoROEqUxyWjlXFUHjsFtm/dr6SkP2H0cynK0g5oXCNa5adMAAAAAAQ4gwIzgqeoeABeepgPLhhnsKi35kO+THhzNh/p6Dice2DcBDwQBAAAAARAE/f///wABAwg1FDEBAAAAAAEEIlEgiIqxS24WVdHQADm4NtcLZuM1FUOrbNL5QWYlXz1ebLUhByjMj8l44gnxaV+ltWVQYdsaqyMRtSQXaUW/EBXvLUuJCQCftnv8BwAAAAA=", + "upgraded_outs": 1 + } } ], "author": [ diff --git a/doc/schemas/lightning-utxopsbt.json b/doc/schemas/lightning-utxopsbt.json index 36d8f7015ab3..32f126dd663a 100644 --- a/doc/schemas/lightning-utxopsbt.json +++ b/doc/schemas/lightning-utxopsbt.json @@ -192,71 +192,73 @@ "- -1: Catchall nonspecific error.", "- 301: Insufficient UTXOs to meet *satoshi* value." ], - "example_json_request": [ + "json_example": [ { - "id": "example:utxopsbt#1", - "method": "utxopsbt", - "params": { - "satoshi": 0, - "feerate": "253perkw", - "startweight": 0, - "utxos": [ - "d82a99192fb333106ea8d08f5231ed45f2ed5b1ef9eb81b0fef8f9ea354d2637:1" - ], - "reserve": 0, - "reservedok": true, - "locktime": null, - "min_witness_weight": null, - "excess_as_change": false - } - }, - { - "id": "example:utxopsbt#2", - "method": "utxopsbt", - "params": { - "satoshi": 1000000, - "feerate": "7500perkw", - "startweight": 0, - "utxos": [ - "2fc3b9f8d4aed120f6d9a6f206f07c35ef4d518ec0305d1d974873d256e38ca7:1", - "2f669f6a605ee5c7ddd2abb753bc64b1a90bd1b7448264f5d78a7ca823c00a1b:1" - ], - "reserve": null, - "reservedok": true, - "locktime": null, - "min_witness_weight": null, - "excess_as_change": false + "request": { + "id": "example:utxopsbt#1", + "method": "utxopsbt", + "params": { + "satoshi": 0, + "feerate": "253perkw", + "startweight": 0, + "utxos": [ + "d82a99192fb333106ea8d08f5231ed45f2ed5b1ef9eb81b0fef8f9ea354d2637:1" + ], + "reserve": 0, + "reservedok": true, + "locktime": null, + "min_witness_weight": null, + "excess_as_change": false + } + }, + "response": { + "psbt": "cHNidP8BADMCAAAAATcmTTXq+fj+sIHr+R5b7fJF7TFSj9CobhAzsy8ZmSrYAQAAAAD9////AGYAAAAAAQDeAgAAAAABAWQACJva49ga8OCYXvPRWQRhoXndrJykwjgXbwT251dEAAAAAAD9////AiOI9ikBAAAAFgAU3gClv/YpAKRpfDuiFu6mIL2E4+5QaQ8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgUXIQFs7oRkorVThUn3sLj7WI7g8c8RHai4ChoCvIkWsCICp1CqHl4BlMJCKFHRWHXhhekaj0r1EFSNrh8UnvysQPASEDqHIAEdaH3H6pb3VJzbJNDG4lL8PTfsheL+h2p6baK3JlAAAAAQEfUGkPAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", + "feerate_per_kw": 253, + "estimated_final_weight": 271, + "excess_msat": 1009932000 } - } - ], - "example_json_response": [ - { - "psbt": "cHNidP8BADMCAAAAATcmTTXq+fj+sIHr+R5b7fJF7TFSj9CobhAzsy8ZmSrYAQAAAAD9////AGYAAAAAAQDeAgAAAAABAWQACJva49ga8OCYXvPRWQRhoXndrJykwjgXbwT251dEAAAAAAD9////AiOI9ikBAAAAFgAU3gClv/YpAKRpfDuiFu6mIL2E4+5QaQ8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAkcwRAIgUXIQFs7oRkorVThUn3sLj7WI7g8c8RHai4ChoCvIkWsCICp1CqHl4BlMJCKFHRWHXhhekaj0r1EFSNrh8UnvysQPASEDqHIAEdaH3H6pb3VJzbJNDG4lL8PTfsheL+h2p6baK3JlAAAAAQEfUGkPAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZQA=", - "feerate_per_kw": 253, - "estimated_final_weight": 271, - "excess_msat": 1009932000 }, { - "psbt": "cHNidP8BAFwCAAAAAqeM41bSc0iXHV0wwI5RTe81fPAG8qbZ9iDRrtT4ucMvAQAAAAD9////GwrAI6h8itf1ZIJEt9ELqbFkvFO3q9Ldx+VeYGqfZi8BAAAAAP3///8AZgAAAAABAN4CAAAAAAEBEaK0TQ97IsrzuO1gLt+vYbvLBG90NrCOZp7SCgrRknYAAAAAAP3///8CM6/2KQEAAAAWABQ1B/KkIVbg7yFRcCEN/VOptfOX/EBCDwAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUCRzBEAiA1oI1us81XEa/DRlvcP2qnbWLsV5pZcRfvj9MLyT202gIgb7noMqHYWMmm7H7VNEfWa29jjtuV9yrrSc9ui11ECQ0BIQKhZOHR4gFKMu2EKKgZ/7qnhzq9PvhtnAW2sxPZ4c9RIWUAAAABAR9AQg8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAAEA3gIAAAAAAQGnjONW0nNIlx1dMMCOUU3vNXzwBvKm2fYg0a7U+LnDLwAAAAAA/f///wJmbOcpAQAAABYAFOwPo5eUrDF7UgZBFQLRHOeX6PiGQEIPAAAAAAAWABTCzKsXHCpb6dq1LsQbglhjAkxUZgJHMEQCICgjGlauGj2eiMS4MWUK6zAWqMe1OuidQR+Hy9ZgSTuzAiA8JTb9OrLqS3hiWtT+TQ/NBsKJ2hhHLDaKUUNdgi4OkAEhA9g3oH5ejmGIqUY2ZWxc8YWF2+T+XpE/6oC40Cx3+e97ZQAAAAEBH0BCDwAAAAAAFgAUwsyrFxwqW+natS7EG4JYYwJMVGYA", - "feerate_per_kw": 7500, - "estimated_final_weight": 542, - "excess_msat": 995935000, - "reservations": [ - { - "txid": "2fc3b9f8d4aed120f6d9a6f206f07c35ef4d518ec0305d1d974873d256e38ca7", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 - }, - { - "txid": "2f669f6a605ee5c7ddd2abb753bc64b1a90bd1b7448264f5d78a7ca823c00a1b", - "vout": 1, - "was_reserved": true, - "reserved": true, - "reserved_to_block": 246 + "request": { + "id": "example:utxopsbt#2", + "method": "utxopsbt", + "params": { + "satoshi": 1000000, + "feerate": "7500perkw", + "startweight": 0, + "utxos": [ + "2fc3b9f8d4aed120f6d9a6f206f07c35ef4d518ec0305d1d974873d256e38ca7:1", + "2f669f6a605ee5c7ddd2abb753bc64b1a90bd1b7448264f5d78a7ca823c00a1b:1" + ], + "reserve": null, + "reservedok": true, + "locktime": null, + "min_witness_weight": null, + "excess_as_change": false } - ] + }, + "response": { + "psbt": "cHNidP8BAFwCAAAAAqeM41bSc0iXHV0wwI5RTe81fPAG8qbZ9iDRrtT4ucMvAQAAAAD9////GwrAI6h8itf1ZIJEt9ELqbFkvFO3q9Ldx+VeYGqfZi8BAAAAAP3///8AZgAAAAABAN4CAAAAAAEBEaK0TQ97IsrzuO1gLt+vYbvLBG90NrCOZp7SCgrRknYAAAAAAP3///8CM6/2KQEAAAAWABQ1B/KkIVbg7yFRcCEN/VOptfOX/EBCDwAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUCRzBEAiA1oI1us81XEa/DRlvcP2qnbWLsV5pZcRfvj9MLyT202gIgb7noMqHYWMmm7H7VNEfWa29jjtuV9yrrSc9ui11ECQ0BIQKhZOHR4gFKMu2EKKgZ/7qnhzq9PvhtnAW2sxPZ4c9RIWUAAAABAR9AQg8AAAAAABYAFAH62Qq81maX4lkhZHIt5KlevuFlAAEA3gIAAAAAAQGnjONW0nNIlx1dMMCOUU3vNXzwBvKm2fYg0a7U+LnDLwAAAAAA/f///wJmbOcpAQAAABYAFOwPo5eUrDF7UgZBFQLRHOeX6PiGQEIPAAAAAAAWABTCzKsXHCpb6dq1LsQbglhjAkxUZgJHMEQCICgjGlauGj2eiMS4MWUK6zAWqMe1OuidQR+Hy9ZgSTuzAiA8JTb9OrLqS3hiWtT+TQ/NBsKJ2hhHLDaKUUNdgi4OkAEhA9g3oH5ejmGIqUY2ZWxc8YWF2+T+XpE/6oC40Cx3+e97ZQAAAAEBH0BCDwAAAAAAFgAUwsyrFxwqW+natS7EG4JYYwJMVGYA", + "feerate_per_kw": 7500, + "estimated_final_weight": 542, + "excess_msat": 995935000, + "reservations": [ + { + "txid": "2fc3b9f8d4aed120f6d9a6f206f07c35ef4d518ec0305d1d974873d256e38ca7", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + }, + { + "txid": "2f669f6a605ee5c7ddd2abb753bc64b1a90bd1b7448264f5d78a7ca823c00a1b", + "vout": 1, + "was_reserved": true, + "reserved": true, + "reserved_to_block": 246 + } + ] + } } ], "author": [ diff --git a/doc/schemas/lightning-wait.json b/doc/schemas/lightning-wait.json index 32f5d3dbcfa2..8d80213bfa45 100644 --- a/doc/schemas/lightning-wait.json +++ b/doc/schemas/lightning-wait.json @@ -291,60 +291,64 @@ "", "- -32602: If the given parameters are wrong." ], - "example_json_request": [ + "json_example": [ { - "id": "example:wait#1", - "method": "wait", - "params": { + "request": { + "id": "example:wait#1", + "method": "wait", + "params": { + "subsystem": "invoices", + "indexname": "created", + "nextvalue": 1 + } + }, + "response": { "subsystem": "invoices", - "indexname": "created", - "nextvalue": 1 + "created": 1, + "details": { + "status": "unpaid", + "label": "invlabel", + "bolt11": "lnbcrt420p1pjmxtevsp5d8c6gnaj8lyjy2qly783vklda9dfaqeyzyc37agxxp8h3uguv8pqpp5w6lhwxhqnuew4hle5h7qwjm27zz784mvsrzhmayhscy5t2hy5c4qdqvd9h8ver9wd3sxqyjw5qcqp99qxpqysgq09gxhjhwu9u3z6dlt5ln5f4g8zl78wz4pgh0am3kz54m9lllhqckf4gmhmt2ftrclq5x62zkqmggc7y0ju0ghdfwjz8hyd8l5cqvemgpyyhm6w" + } } }, { - "id": "example:wait#2", - "method": "wait", - "params": { + "request": { + "id": "example:wait#2", + "method": "wait", + "params": { + "subsystem": "invoices", + "indexname": "updated", + "nextvalue": 2 + } + }, + "response": { "subsystem": "invoices", - "indexname": "updated", - "nextvalue": 2 + "updated": 2, + "details": { + "status": "expired" + } } }, { - "id": "example:wait#3", - "method": "wait", - "params": { + "request": { + "id": "example:wait#3", + "method": "wait", + "params": { + "subsystem": "sendpays", + "indexname": "updated", + "nextvalue": 2 + } + }, + "response": { "subsystem": "sendpays", - "indexname": "updated", - "nextvalue": 2 - } - } - ], - "example_json_response": [ - { - "subsystem": "invoices", - "created": 1, - "details": { - "status": "unpaid", - "label": "invlabel", - "bolt11": "lnbcrt420p1pjmxtevsp5d8c6gnaj8lyjy2qly783vklda9dfaqeyzyc37agxxp8h3uguv8pqpp5w6lhwxhqnuew4hle5h7qwjm27zz784mvsrzhmayhscy5t2hy5c4qdqvd9h8ver9wd3sxqyjw5qcqp99qxpqysgq09gxhjhwu9u3z6dlt5ln5f4g8zl78wz4pgh0am3kz54m9lllhqckf4gmhmt2ftrclq5x62zkqmggc7y0ju0ghdfwjz8hyd8l5cqvemgpyyhm6w" - } - }, - { - "subsystem": "invoices", - "updated": 2, - "details": { - "status": "expired" - } - }, - { - "subsystem": "sendpays", - "updated": 2, - "details": { - "status": "complete", - "partid": 0, - "groupid": 1, - "payment_hash": "220dcfcf43e1fab3ce30f70eb943c3ce962393f5a65ced52d749e324b443d19e" + "updated": 2, + "details": { + "status": "complete", + "partid": 0, + "groupid": 1, + "payment_hash": "220dcfcf43e1fab3ce30f70eb943c3ce962393f5a65ced52d749e324b443d19e" + } } } ], diff --git a/doc/schemas/lightning-waitanyinvoice.json b/doc/schemas/lightning-waitanyinvoice.json index a6d580ff6626..a901418c3600 100644 --- a/doc/schemas/lightning-waitanyinvoice.json +++ b/doc/schemas/lightning-waitanyinvoice.json @@ -213,58 +213,60 @@ "", "- 904: The *timeout* was reached without an invoice being paid." ], - "example_json_request": [ + "json_example": [ { - "id": "example:waitanyinvoice#1", - "method": "waitanyinvoice", - "params": { - "lastpay_index": null, - "timeout": null + "request": { + "id": "example:waitanyinvoice#1", + "method": "waitanyinvoice", + "params": { + "lastpay_index": null, + "timeout": null + } + }, + "response": { + "label": "inv1", + "bolt11": "lnbcrt10n1pjmxtsxsp56sn02x8lccjfsvunnhz5858zuyxztug9luy226w4qsmfm4r8pkcspp5gw5r0dw99yf3zqxrg24l8g9m9hun9cu06ldg4rga8s9t9kv8z45sdq8d9h8vvgxqyjw5qcqp99qxpqysgqv537uh2sx8ch640mf4t43t8qjtpg3z7gukgm07tlyq986m7nvsnxkapg37z4vsxtl4thfqzc64anqr83geygkc2xaftxgr97dltqfjqpe3mhja", + "payment_hash": "43a837b5c529131100c342abf3a0bb2df932e38fd7da8a8d1d3c0ab2d9871569", + "amount_msat": 1000, + "status": "paid", + "pay_index": 1, + "amount_received_msat": 1000, + "paid_at": 1706241546, + "payment_preimage": "a0c668998de14b975f33e1060b3efd7efc0bde784ac266ab667a1b2fddab3cd1", + "description": [ + "Inv1." + ], + "expires_at": 1706846342, + "created_index": 1, + "updated_index": 1 } }, { - "id": "example:waitanyinvoice#2", - "method": "waitanyinvoice", - "params": { - "lastpay_index": 3, - "timeout": 0 + "request": { + "id": "example:waitanyinvoice#2", + "method": "waitanyinvoice", + "params": { + "lastpay_index": 3, + "timeout": 0 + } + }, + "response": { + "label": "inv4", + "bolt11": "lnbcrt10n1pja0tkmsp57j4z9zwvdsyh57unh3da7aac5z20clfnrwy5nqm6wujaelduw23qpp580mdrwakz9xewc2vhvpucset9gjkgdvyhw7h9frcy2d6p2lwdw2qdq8d9h8vdqxqyjw5qcqp99qxpqysgqtgyzhtxs3p2dyk8wk9q028033303702d2hml4frmu38qe79mrkgzgxvyjmq2q4nhjgcuz3uhmlda3jnhf9w6mj8mj97pkgnda9l5kdcqsdgewf", + "payment_hash": "3bf6d1bbb6114d97614cbb03cc432b2a25643584bbbd72a478229ba0abee6b94", + "amount_msat": 1000, + "status": "paid", + "pay_index": 4, + "amount_received_msat": 1000, + "paid_at": 1708633825, + "payment_preimage": "77336a342dde76050c7ee7fc18599e407dfc1edad3c784ba68e9603004365b94", + "description": "inv4", + "expires_at": 1709238619, + "created_index": 4, + "updated_index": 4 } } ], - "example_json_response": [ - { - "label": "inv1", - "bolt11": "lnbcrt10n1pjmxtsxsp56sn02x8lccjfsvunnhz5858zuyxztug9luy226w4qsmfm4r8pkcspp5gw5r0dw99yf3zqxrg24l8g9m9hun9cu06ldg4rga8s9t9kv8z45sdq8d9h8vvgxqyjw5qcqp99qxpqysgqv537uh2sx8ch640mf4t43t8qjtpg3z7gukgm07tlyq986m7nvsnxkapg37z4vsxtl4thfqzc64anqr83geygkc2xaftxgr97dltqfjqpe3mhja", - "payment_hash": "43a837b5c529131100c342abf3a0bb2df932e38fd7da8a8d1d3c0ab2d9871569", - "amount_msat": 1000, - "status": "paid", - "pay_index": 1, - "amount_received_msat": 1000, - "paid_at": 1706241546, - "payment_preimage": "a0c668998de14b975f33e1060b3efd7efc0bde784ac266ab667a1b2fddab3cd1", - "description": [ - "Inv1." - ], - "expires_at": 1706846342, - "created_index": 1, - "updated_index": 1 - }, - { - "label": "inv4", - "bolt11": "lnbcrt10n1pja0tkmsp57j4z9zwvdsyh57unh3da7aac5z20clfnrwy5nqm6wujaelduw23qpp580mdrwakz9xewc2vhvpucset9gjkgdvyhw7h9frcy2d6p2lwdw2qdq8d9h8vdqxqyjw5qcqp99qxpqysgqtgyzhtxs3p2dyk8wk9q028033303702d2hml4frmu38qe79mrkgzgxvyjmq2q4nhjgcuz3uhmlda3jnhf9w6mj8mj97pkgnda9l5kdcqsdgewf", - "payment_hash": "3bf6d1bbb6114d97614cbb03cc432b2a25643584bbbd72a478229ba0abee6b94", - "amount_msat": 1000, - "status": "paid", - "pay_index": 4, - "amount_received_msat": 1000, - "paid_at": 1708633825, - "payment_preimage": "77336a342dde76050c7ee7fc18599e407dfc1edad3c784ba68e9603004365b94", - "description": "inv4", - "expires_at": 1709238619, - "created_index": 4, - "updated_index": 4 - } - ], "author": [ "Rusty Russell <> is mainly responsible." ], diff --git a/doc/schemas/lightning-waitblockheight.json b/doc/schemas/lightning-waitblockheight.json index ecc80b9bb19b..6f52469cf946 100644 --- a/doc/schemas/lightning-waitblockheight.json +++ b/doc/schemas/lightning-waitblockheight.json @@ -48,32 +48,34 @@ "", "- 2000: Timed out." ], - "example_json_request": [ + "json_example": [ { - "id": "example:waitblockheight#1", - "method": "waitblockheight", - "params": { - "blockheight": 99, - "timeout": null + "request": { + "id": "example:waitblockheight#1", + "method": "waitblockheight", + "params": { + "blockheight": 99, + "timeout": null + } + }, + "response": { + "blockheight": 99 } }, { - "id": "example:waitblockheight#2", - "method": "waitblockheight", - "params": { - "blockheight": 103, - "timeout": 600 + "request": { + "id": "example:waitblockheight#2", + "method": "waitblockheight", + "params": { + "blockheight": 103, + "timeout": 600 + } + }, + "response": { + "blockheight": 103 } } ], - "example_json_response": [ - { - "blockheight": 99 - }, - { - "blockheight": 103 - } - ], "author": [ "ZmnSCPxj <> is mainly responsible." ], diff --git a/doc/schemas/lightning-waitinvoice.json b/doc/schemas/lightning-waitinvoice.json index fa2987f30357..6e31307f7c0b 100644 --- a/doc/schemas/lightning-waitinvoice.json +++ b/doc/schemas/lightning-waitinvoice.json @@ -216,34 +216,34 @@ "- -1: If the invoice is deleted while unpaid, or the invoice does not exist.", "- 903: If the invoice expires before being paid, or is already expired." ], - "example_json_request": [ + "json_example": [ { - "id": "example:waitinvoice#1", - "method": "waitinvoice", - "params": { - "label": "inv2" + "request": { + "id": "example:waitinvoice#1", + "method": "waitinvoice", + "params": { + "label": "inv2" + } + }, + "response": { + "label": "inv2", + "bolt11": "lnbcrt10n1pjmxtwjsp5mzvdu6v8hqsf2tlj0nlyks23afqp7ejs444syjxf74p60ztmld8qpp5q4ayz5pys3t0yj0dmkmh7ctarkv9z434paz4u9rdwnj4f43thhaqdq8d9h8vvsxqyjw5qcqp99qxpqysgqn0055ttns6pafsxh6xuqce6e4vz8gtxlzqx0l9d9f5crmqx4jymh4zy9jdaszm0dj89sq39fvhpwcs626dt0n3gw8kassfdehp5sy3sq7fzy3w", + "payment_hash": "057a4150248456f249edddb77f617d1d985156350f455e146d74e554d62bbdfa", + "amount_msat": 1000, + "status": "paid", + "pay_index": 1, + "amount_received_msat": 1000, + "paid_at": 1706241494, + "payment_preimage": "34ccd37cc85e067cb376f9ea8c70d70469f58bf296f2566ed9ad4dfb70971a26", + "description": [ + "Inv2." + ], + "expires_at": 1706846290, + "created_index": 2, + "updated_index": 1 } } ], - "example_json_response": [ - { - "label": "inv2", - "bolt11": "lnbcrt10n1pjmxtwjsp5mzvdu6v8hqsf2tlj0nlyks23afqp7ejs444syjxf74p60ztmld8qpp5q4ayz5pys3t0yj0dmkmh7ctarkv9z434paz4u9rdwnj4f43thhaqdq8d9h8vvsxqyjw5qcqp99qxpqysgqn0055ttns6pafsxh6xuqce6e4vz8gtxlzqx0l9d9f5crmqx4jymh4zy9jdaszm0dj89sq39fvhpwcs626dt0n3gw8kassfdehp5sy3sq7fzy3w", - "payment_hash": "057a4150248456f249edddb77f617d1d985156350f455e146d74e554d62bbdfa", - "amount_msat": 1000, - "status": "paid", - "pay_index": 1, - "amount_received_msat": 1000, - "paid_at": 1706241494, - "payment_preimage": "34ccd37cc85e067cb376f9ea8c70d70469f58bf296f2566ed9ad4dfb70971a26", - "description": [ - "Inv2." - ], - "expires_at": 1706846290, - "created_index": 2, - "updated_index": 1 - } - ], "author": [ "Christian Decker <> is mainly responsible." ], diff --git a/doc/schemas/lightning-waitsendpay.json b/doc/schemas/lightning-waitsendpay.json index 9da2c0db179e..4930edd10593 100644 --- a/doc/schemas/lightning-waitsendpay.json +++ b/doc/schemas/lightning-waitsendpay.json @@ -218,35 +218,35 @@ "*failcode*: The failure code, as per BOLT #4.", "*failcodename*: The human-readable name corresponding to *failcode*, if known." ], - "example_json_request": [ + "json_example": [ { - "id": "example:waitsendpay#1", - "method": "waitsendpay", - "params": { + "request": { + "id": "example:waitsendpay#1", + "method": "waitsendpay", + "params": { + "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", + "timeout": null, + "partid": null, + "groupid": null + } + }, + "response": { + "created_index": 1, + "id": 1, "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "timeout": null, - "partid": null, - "groupid": null + "groupid": 1, + "updated_index": 1, + "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", + "amount_msat": 11000000, + "amount_sent_msat": 11000000, + "created_at": 1706152930, + "completed_at": 1706152933, + "status": "complete", + "payment_preimage": "af7ba559629f719c04c43a82767fe3622790a539164d6270db07f765203e574b", + "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk" } } ], - "example_json_response": [ - { - "created_index": 1, - "id": 1, - "payment_hash": "072b1d20f4a7c757a56d5fb10eaed40b58b68849da41fe396cdbd2d81692875a", - "groupid": 1, - "updated_index": 1, - "destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59", - "amount_msat": 11000000, - "amount_sent_msat": 11000000, - "created_at": 1706152930, - "completed_at": 1706152933, - "status": "complete", - "payment_preimage": "af7ba559629f719c04c43a82767fe3622790a539164d6270db07f765203e574b", - "bolt11": "lnbcrt110u1pjmr5lzsp5sfjyj3xn7ux592k36hmmt4ax98n6lgct22wvj54yck0upcmep63qpp5qu436g855lr40ftdt7csatk5pdvtdzzfmfqluwtvm0fds95jsadqdpq0pzk7s6j8y69xjt6xe25j5j4g44hsatdxqyjw5qcqp99qxpqysgquwma3zrw4cd8e8j4u9uh4gxukaacckse64kx2l9dqv8rvrysdq5r5dt38t9snqj9u5ar07h2exr4fg56wpudkhkk7gtxlyt72ku5fpqqd4fnlk" - } - ], "author": [ "ZmnSCPxj <> is mainly responsible." ], diff --git a/doc/schemas/lightning-withdraw.json b/doc/schemas/lightning-withdraw.json index 4ce43cd36149..36a2e202c0f0 100644 --- a/doc/schemas/lightning-withdraw.json +++ b/doc/schemas/lightning-withdraw.json @@ -85,44 +85,46 @@ "- 302: The dust limit is not met.", "- 313: The `min-emergency-msat` reserve not be preserved (and we have anchor channels)." ], - "example_json_request": [ + "json_example": [ { - "id": "example:withdraw#1", - "method": "withdraw", - "params": { - "destination": "bcrt1qjc7j2l5es4haw35c9jzm8dfm763ng5djp8f0s0", - "satoshi": 555555, - "feerate": null, - "minconf": null, - "utxos": null + "request": { + "id": "example:withdraw#1", + "method": "withdraw", + "params": { + "destination": "bcrt1qjc7j2l5es4haw35c9jzm8dfm763ng5djp8f0s0", + "satoshi": 555555, + "feerate": null, + "minconf": null, + "utxos": null + } + }, + "response": { + "tx": "0200000001ef28647baa13cc4c03b8a58c8bd08b69de434c22ff591eb68171ae992e3d816d0000000000fdffffff02237a080000000000160014963d257e99856fd746982c85b3b53bf6a33451b24d6808000000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a66000000", + "txid": "ccb97d7dc695cabb78b217c0b27d7d00d2941966199480e6443e0680d24d69eb", + "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABAWPCRda9hy4QKqUEmtb7gK7SAqzh1xBP8nZ7PCj+7+JDAAAAAAD9////Akf0EAAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUs/fQpAQAAABYAFOIj6yaI/g85utJBtkPPdK1X59cfAkcwRAIgH7J57HuUTpnCbDrDqE8W7ryuCXk+i/TszQ/NF55lWncCIDeN4y+EzIDP3l2XO5/wjk98krYqnzvEhrStk+0+fTowASEC6Ng5r5KTNIXBRRvjivsd8SKnHF59r/ViDj2+CLJVb75lAAAAAQEfR/QQAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZSICA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPRzBEAiBY0urYSHLnnXaAJH7yaGfvGmm+VuNCNIBhQaJU6iDNEgIgA7EASW+V00Su+lRQAE3Qbe4wavLq7l6Jn2vR+6Snyd0BIgYD10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8IAfrZCgAAAAABDiDvKGR7qhPMTAO4pYyL0Itp3kNMIv9ZHraBca6ZLj2BbQEPBAAAAAABEAT9////AAEDCCN6CAAAAAAAAQQWABSWPSV+mYVv10aYLIWztTv2ozRRsgz8CWxpZ2h0bmluZwQCAAEAAQMITWgIAAAAAAABBCJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aIQeRRTKBKkQKTXZscc05GTaUo0CuEeAS5boa2e+6bnbKUwkAwsyrFwIAAAAA" } }, { - "id": "example:withdraw#2", - "method": "withdraw", - "params": { - "destination": "bcrt1q66ukn5mdllddnp53j0mx8mjgph7uwdygn0uy45", - "satoshi": "all", - "feerate": "20000perkb", - "minconf": 0, - "utxos": [ - "218390859cf94d869e33f69161f4187a98f691afe868c20811528f589e90a61f:1" - ] + "request": { + "id": "example:withdraw#2", + "method": "withdraw", + "params": { + "destination": "bcrt1q66ukn5mdllddnp53j0mx8mjgph7uwdygn0uy45", + "satoshi": "all", + "feerate": "20000perkb", + "minconf": 0, + "utxos": [ + "218390859cf94d869e33f69161f4187a98f691afe868c20811528f589e90a61f:1" + ] + } + }, + "response": { + "tx": "02000000011fa6909e588f521108c268e8af91f6987a18f46191f6339e864df99c859083210100000000fdffffff0158070f0000000000160014d6b969d36dffdad9869193f663ee480dfdc7348867000000", + "txid": "ad9a712a201214c68c39ca5be68c9d153d1cac91e540d88aa3207b241e23acf8", + "psbt": "cHNidP8BAgQCAAAAAQMEZwAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQD9ZQECAAAAAAEBVa+m1d1amChv4Dwq1rVoS4KSm0BUUnVa3fUYcB3dH9oAAAAAAP////8CECcAAAAAAAAiUSBXeaBg8gDUDo+HGkDrkWFMxb+m0KX4UuBTQAp/7/hhUOEPDwAAAAAAIlEg7tdFgE2peEzCA/Vj76mf+lT98BsTe8lk5jwxJAcP++YEAEcwRAIgPsWO/4IxeW6OclDdXVnwL99X7B18sRlxgFqyvUAzN7gCIGOQOq0wZ6bV+wdYQP+9sH8IkfmqWZbQRRDkZEgfcprMAUcwRAIgb5/dI4+uVhluQjSA2q/3oAGxZd4vYzQWexfmcRQML7ECIFfgRwCaHYdyu5/H5moOPlfQlLc2gPgB6bgtfNSfRA6jAUdSIQIyQmbehAOzqxV6CfH3hNWHr2GDHJmMFRvMIbt0wrIxSyEC4704AJhmydqOxKqZzE6pxsDdRt8Vxh7wzh8nEpFxTldSrgAAAAABASvhDw8AAAAAACJRIO7XRYBNqXhMwgP1Y++pn/pU/fAbE3vJZOY8MSQHD/vmAQ4gH6aQnliPUhEIwmjor5H2mHoY9GGR9jOehk35nIWQgyEBDwQBAAAAARAE/f///wETQL0MqyYsx9Z9q14BhByMgWLW4oJHOqED5qcZ3wyJ4eDuLYfNGq6Ck30dAqFzJL4VhZLSuv87zN/1AEDNMl2DmTohFl03KAgp8YbLmVzcy/I4q0VkATk5c1E5YySjZXXfNN3/CQAHHEnKAAAAAAAiAgK5wMaEThKlMclo5VxVB47BbZv3a+kpD9h9HMpytIOaFwjWuWnTBAAAAAEDCFgHDwAAAAAAAQQWABTWuWnTbf/a2YaRk/Zj7kgN/cc0iAz8CWxpZ2h0bmluZwQCAAEA" } } ], - "example_json_response": [ - { - "tx": "0200000001ef28647baa13cc4c03b8a58c8bd08b69de434c22ff591eb68171ae992e3d816d0000000000fdffffff02237a080000000000160014963d257e99856fd746982c85b3b53bf6a33451b24d6808000000000022512063ffee4ea7d51e6cadf9086e286a2527922aaa25b8c53aebf32fa32a0a627f5a66000000", - "txid": "ccb97d7dc695cabb78b217c0b27d7d00d2941966199480e6443e0680d24d69eb", - "psbt": "cHNidP8BAgQCAAAAAQMEZgAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQDeAgAAAAABAWPCRda9hy4QKqUEmtb7gK7SAqzh1xBP8nZ7PCj+7+JDAAAAAAD9////Akf0EAAAAAAAFgAUAfrZCrzWZpfiWSFkci3kqV6+4WUs/fQpAQAAABYAFOIj6yaI/g85utJBtkPPdK1X59cfAkcwRAIgH7J57HuUTpnCbDrDqE8W7ryuCXk+i/TszQ/NF55lWncCIDeN4y+EzIDP3l2XO5/wjk98krYqnzvEhrStk+0+fTowASEC6Ng5r5KTNIXBRRvjivsd8SKnHF59r/ViDj2+CLJVb75lAAAAAQEfR/QQAAAAAAAWABQB+tkKvNZml+JZIWRyLeSpXr7hZSICA9dFRFyTYmZfIuDZbp52byc/MmDeo5yKdr+gXdJoTdzPRzBEAiBY0urYSHLnnXaAJH7yaGfvGmm+VuNCNIBhQaJU6iDNEgIgA7EASW+V00Su+lRQAE3Qbe4wavLq7l6Jn2vR+6Snyd0BIgYD10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M8IAfrZCgAAAAABDiDvKGR7qhPMTAO4pYyL0Itp3kNMIv9ZHraBca6ZLj2BbQEPBAAAAAABEAT9////AAEDCCN6CAAAAAAAAQQWABSWPSV+mYVv10aYLIWztTv2ozRRsgz8CWxpZ2h0bmluZwQCAAEAAQMITWgIAAAAAAABBCJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aIQeRRTKBKkQKTXZscc05GTaUo0CuEeAS5boa2e+6bnbKUwkAwsyrFwIAAAAA" - }, - { - "tx": "02000000011fa6909e588f521108c268e8af91f6987a18f46191f6339e864df99c859083210100000000fdffffff0158070f0000000000160014d6b969d36dffdad9869193f663ee480dfdc7348867000000", - "txid": "ad9a712a201214c68c39ca5be68c9d153d1cac91e540d88aa3207b241e23acf8", - "psbt": "cHNidP8BAgQCAAAAAQMEZwAAAAEEAQEBBQEBAQYBAwH7BAIAAAAAAQD9ZQECAAAAAAEBVa+m1d1amChv4Dwq1rVoS4KSm0BUUnVa3fUYcB3dH9oAAAAAAP////8CECcAAAAAAAAiUSBXeaBg8gDUDo+HGkDrkWFMxb+m0KX4UuBTQAp/7/hhUOEPDwAAAAAAIlEg7tdFgE2peEzCA/Vj76mf+lT98BsTe8lk5jwxJAcP++YEAEcwRAIgPsWO/4IxeW6OclDdXVnwL99X7B18sRlxgFqyvUAzN7gCIGOQOq0wZ6bV+wdYQP+9sH8IkfmqWZbQRRDkZEgfcprMAUcwRAIgb5/dI4+uVhluQjSA2q/3oAGxZd4vYzQWexfmcRQML7ECIFfgRwCaHYdyu5/H5moOPlfQlLc2gPgB6bgtfNSfRA6jAUdSIQIyQmbehAOzqxV6CfH3hNWHr2GDHJmMFRvMIbt0wrIxSyEC4704AJhmydqOxKqZzE6pxsDdRt8Vxh7wzh8nEpFxTldSrgAAAAABASvhDw8AAAAAACJRIO7XRYBNqXhMwgP1Y++pn/pU/fAbE3vJZOY8MSQHD/vmAQ4gH6aQnliPUhEIwmjor5H2mHoY9GGR9jOehk35nIWQgyEBDwQBAAAAARAE/f///wETQL0MqyYsx9Z9q14BhByMgWLW4oJHOqED5qcZ3wyJ4eDuLYfNGq6Ck30dAqFzJL4VhZLSuv87zN/1AEDNMl2DmTohFl03KAgp8YbLmVzcy/I4q0VkATk5c1E5YySjZXXfNN3/CQAHHEnKAAAAAAAiAgK5wMaEThKlMclo5VxVB47BbZv3a+kpD9h9HMpytIOaFwjWuWnTBAAAAAEDCFgHDwAAAAAAAQQWABTWuWnTbf/a2YaRk/Zj7kgN/cc0iAz8CWxpZ2h0bmluZwQCAAEA" - } - ], "author": [ "Felix <> is mainly responsible." ], diff --git a/tools/fromschema.py b/tools/fromschema.py index f2c437641c03..1123daccbdc4 100755 --- a/tools/fromschema.py +++ b/tools/fromschema.py @@ -7,8 +7,8 @@ import re # To maintain the sequence of the before return value (body) and after return value (footer) sections in the markdown file -BODY_KEY_SEQUENCE = ['reliability', 'usage', 'restriction_format', 'permitted_sqlite3_functions', 'treatment_of_types', 'tables', 'example_usage', 'example_json_request', 'notes', 'notifications', 'sharing_runes', 'riskfactor_effect_on_routing', 'recommended_riskfactor_values', 'optimality', 'randomization'] -FOOTER_KEY_SEQUENCE = ['example_json_response', 'errors', 'example_json_notifications', 'trivia', 'author', 'see_also', 'resources'] +BODY_KEY_SEQUENCE = ['reliability', 'usage', 'restriction_format', 'permitted_sqlite3_functions', 'treatment_of_types', 'tables', 'example_usage', 'notes', 'notifications', 'sharing_runes', 'riskfactor_effect_on_routing', 'recommended_riskfactor_values', 'optimality', 'randomization'] +FOOTER_KEY_SEQUENCE = ['errors', 'json_example', 'trivia', 'author', 'see_also', 'resources'] def output_title(title, underline='-', num_leading_newlines=1, num_trailing_newlines=2): @@ -426,13 +426,7 @@ def generate_body(schema): body_key_found = True output_title(key.replace('_', ' ').upper(), '-', 1 if first_matching_key else 2) first_matching_key = False - if key == 'example_json_request' and len(schema[key]) > 0: - output('```json\n') - for example in schema.get(key, []): - output(json.dumps(example, indent=2).strip() + '\n') - output('```') - else: - outputs(schema[key], '\n') + outputs(schema[key], '\n') if body_key_found: output('\n') @@ -448,20 +442,17 @@ def generate_footer(schema): if key == 'see_also': # Wrap see_also list with comma separated values output(esc_underscores(', '.join(schema[key]))) - elif key.startswith('example_json_') and len(schema[key]) > 0: - # For printing example_json_response and example_json_notifications into code block + elif key == 'json_example' and len(schema[key]) > 0: for i, example in enumerate(schema.get(key, [])): - # For printing string elements from example json response; example: `createonion` - if isinstance(example, str): - output(example) - if i + 1 < len(schema[key]): - output('\n') - else: - if i == 0: - output('```json\n') - output(json.dumps(example, indent=2).strip() + '\n') - if i + 1 == len(schema[key]): - output('```') + output('{}**Example {}**: {}\n'.format('' if i == 0 else '\n\n', i + 1, '\n'.join(example.get('description', '')))) + output('\nRequest:\n') + output('```json\n') + output(json.dumps(example['request'], indent=2).strip() + '\n') + output('```') + output('\nResponse:\n') + output('```json\n') + output(json.dumps(example['response'], indent=2).strip() + '\n') + output('```') else: outputs(schema[key], '\n') output('\n')