Skip to content

Add relevant RPC examples to docs #9314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
enaples wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

Add relevant RPC examples to docs #9314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5829f30
tests: added 'bkpr-report' RPC example
enaples Jul 14, 2026
f6253ba
tests: added 'listnetworkevents' RPC example
enaples Jul 16, 2026
e72efe8
tests: added example of currencyrate plugin RPC calls
enaples Jul 16, 2026
7edd542
tests: added 'sendamount' RPC call example
enaples Jul 16, 2026
04a4855
tests: added 'createproof' RPC call example
enaples Jul 16, 2026
10e2389
tests: added 'delnetworkevent' RPC call example
enaples Jul 17, 2026
351a2e6
tests: added 'cancelrecurringinvoice' RPC call example
enaples Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions doc/schemas/bkpr-report.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,21 @@
"response": {
"report": [
"Date,Tag,Account,Description,Credit,Debit,BTC/USD,Credit (USD),Debit(USD)",
"2026-04-02 12:42:03,deposit,wallet,Onchain output 37562cf0b3a5d6783ae02925bcc486bb89afe156abf15e692736e5da9a060018:1,+0.02000000000,0,67140.89,$1342.81,$0.00",
"2026-04-02 12:42:04,invoice,9b3114c8003dc8dedbcf3b7bc9fb04e1575a1112aea33be8369ae9670aff64f4,Invoice description test_bkpr_report_invoice,0,-0.00000123456,67140.89,$0.00,$0.08",
"2026-04-02 12:42:04,onchain_fee,9b3114c8003dc8dedbcf3b7bc9fb04e1575a1112aea33be8369ae9670aff64f4,Onchain transaction f464ff0a67e99a36e83ba3ae12115a57e104fbc97b3bcfdbdec83d00c814319b,0,-0.00004927000,67140.89,$0.00,$3.30"
"2025-01-27 18:46:41,deposit,wallet,Invoice description edited utxo description,+2.00000000000,0,,$,$",
"2025-01-27 18:46:43,deposit,wallet,Onchain output 130def5c51ac7024c2d21c9b45c91e63fd0f9b1081c9f30de18a5eb3f7ffc86d:0,+0.02000000000,0,,$,$",
"2025-01-27 18:46:47,invoice,c51daaf63cd67a9092a021076a8b3def61b38dea85019b0a074ddada3e1a4e6c,Invoice description edited invoice description from description send some sats l2 to l3,+0.00500000000,0,,$,$",
"2025-01-27 18:46:48,invoice,f8f6216a51c6d73e2a759d1de6f675c3780f42957e27bd2f7d8bd0fb373b9006,Invoice description description send some sats l3 to l4,0,-0.00500000000,,$,$",
"2025-01-27 18:46:49,invoice,c51daaf63cd67a9092a021076a8b3def61b38dea85019b0a074ddada3e1a4e6c,Invoice description Invoice description l31,+0.00000010000,0,,$,$",
"2025-01-27 18:46:50,invoice,c51daaf63cd67a9092a021076a8b3def61b38dea85019b0a074ddada3e1a4e6c,Invoice description keysend,+0.00000010000,0,,$,$",
"2025-01-27 18:46:51,routed,f8f6216a51c6d73e2a759d1de6f675c3780f42957e27bd2f7d8bd0fb373b9006,,+0.00000000101,0,,$,$",
"2025-01-27 18:46:53,invoice,c51daaf63cd67a9092a021076a8b3def61b38dea85019b0a074ddada3e1a4e6c,Invoice description keysend,+0.00000010000,0,,$,$",
"2025-01-27 18:46:54,invoice,c51daaf63cd67a9092a021076a8b3def61b38dea85019b0a074ddada3e1a4e6c,Invoice description l32 description,+0.00000050000,0,,$,$",
"2025-01-27 18:46:55,invoice,c51daaf63cd67a9092a021076a8b3def61b38dea85019b0a074ddada3e1a4e6c,Invoice description l33 description,+0.00000100000,0,,$,$",
"2025-01-27 18:46:56,routed,f8f6216a51c6d73e2a759d1de6f675c3780f42957e27bd2f7d8bd0fb373b9006,,+0.00000000001,0,,$,$",
"2025-01-27 18:47:04,deposit,wallet,Onchain output c8035875a93de7342073e9ff85a3ae70fe346f634cda125d4fbce1714cc64b4d:1,+0.02000000000,0,,$,$",
"2025-01-27 18:47:07,onchain_fee,16e2e64cfffd6603c0697aa9df4f99c769e6697400d4c28acf7ad25a72fe5429,Onchain transaction 23c5b3b5733c26f6cfa450e27d9ac122a626b36626fa0ced8206f488cc8e310a,0,-0.00004927000,,$,$",
"2025-01-27 18:46:46,onchain_fee,f8f6216a51c6d73e2a759d1de6f675c3780f42957e27bd2f7d8bd0fb373b9006,Onchain transaction 7e4d853f75800aac4e510424ca030027b1e1192c0b6ba51d221452b39a8f57e2,0,-0.00004927000,,$,$",
"2025-01-27 18:47:01,onchain_fee,c51daaf63cd67a9092a021076a8b3def61b38dea85019b0a074ddada3e1a4e6c,Onchain transaction dc446777a9b3d6d5962f502f5d22f66b01452389c1bbe8460491e7376f44a1eb,0,-0.00000000102,,$,$"
],
"format-hint": "simple"
}
Expand Down
19 changes: 18 additions & 1 deletion doc/schemas/cancelrecurringinvoice.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"bip353": {
"type": "string",
"description": [
"BIP353 string (optionally with ₿) indicating where we fetched the offer from"
"BIP353 string (optionally with \u20bf) indicating where we fetched the offer from"
]
}
}
Expand All @@ -77,5 +77,22 @@
],
"resources": [
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
],
"examples": [
{
"request": {
"id": "example:cancelrecurringinvoice#1",
"method": "cancelrecurringinvoice",
"params": {
"offer": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrcgqv85ysq2zefx2cm4wfexjmn8ypeh2cnnvdexjur5d9hku93pqg58h7kghxdn23m7h6fnfmk7rcetrz0zgezwkuquq7tpgufrx88vpl3mnt9psqsq8s",
"recurrence_counter": 1,
"recurrence_label": "subscription l3",
"payer_note": "Cancelling subscription"
}
},
"response": {
"bolt12": "lnr1qqsquux3chfhckgak29er5ljyamfzyln7uka69lf6fddl7te7k20w0gzyqrzymjxzydqkkw24ufxqslttwlj3s608f0rx2slc7etw0833zgs7zqrpapyqzsk2fjkxatjwf5kueeqwd6kyumrwf5hqarfdahpvggz9pal4j9env65wl47jv6wahs7x2ccncjxgn4hq8q8jc28zge3emq9qgqxyfhyvyg6pdvu4tcjvpp7kkal9rp57wj7xv4pl3ajku70rzy3pa2qqkppqtpdhn70ts2jyn6f0x8zf7p3sqfrglh2v4s7zqg5pxlfq8gs8f9dckghgdskucm9d3kxjmn8ypeh2cnnvdexjur5d9hkauzqthdkt4nhqfewafy75t27xycdfgmyak7wsfpjwu6wc3l9r3dqspfnjzeda9xslw7q8k9c6wzxcsyzegn49rl43ykntut4x0dktle4re878wdv5xqzqq70uae4j3wqzq07wu6eghsq"
}
}
]
}
33 changes: 33 additions & 0 deletions doc/schemas/createproof.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,5 +160,38 @@
],
"resources": [
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
],
"examples": [
{
"request": {
"id": "example:createproof#1",
"method": "createproof",
"params": {
"invstring": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrc2zegxz7tdv4h8ggrjv4ch26tjv4ejqurjdahkv93pqg58h7kghxdn23m7h6fnfmk7rcetrz0zgezwkuquq7tpgufrx88vq"
}
},
"response": {
"proofs": [
{
"bolt12": "lnp1pgt9qcted4jkuapqwfjhzatfwfjhxgrswfhk7eskyypzs7l6ezuekd2806lfxd8wmc0r9vvfufryf6msrsrev9r3yvcuaszcyypyzanz3eyn5zgclm7wpz20wcq0e4ykpsuugryk95lvgv2gy6dy9r4yq3ne035q4qs8s5r64x52g8drh6sfvl3eudl3crjy7spfg0t56sch67h5weq8fsa2qvr6zg9wqvpqqq9syypzs7l6ezuekd2806lfxd8wmc0r9vvfufryf6msrsrev9r3yvcuas8sgp5ytk6gtg9uwn7m5scae2rctte4y7c2sl030tvepsyygw77wxm7460ne9s3d93cg3x76mdsu5xzyz4j3ph825dp6ve5n78ynz0fx9nl79qxq25pz0xdmh8qjj9yg2avdrplmppqvq0gne3tk0gz5y27y69vzf9vquk8j2k7mq7w9u99zm9vd5dwvz4c7nf4324sgehn0q3yynyuzn7s86fq2shrw7ffu5d2y4pwxaujneg65f2zudme98j34gj59cmhj209r2306ql2qcq3wxqet9d06qltsp8977rjak289nv62vujc0fpm5lh4rywk3zh4lmq7d36esq20fm24pkmtzjw4085srpgxwcxh8yqs3weexndsed53q8vrymuvxjxhr9jpnszuw3fdplrfwyjyemect2dzx8vxhgmlx7zw567ucd3gq9v37hkyacdps886zge3q6a2xcdk42dmezhm7uqtzrapawhrca06rf74chaq0k06qgqcazxey889hytdkl58r4z77y4psut06ckhdnerkck2fr54h09jgxv9zpfyxc7vqkpymzsx558p9kcxnu6rnn094vjn5t8l2te453hqezvrj0s2wxuvdn7g4a02ctntty0hy83nypvwhr8dkwg54tj9zx69ahs8zd23hczsc39cfq6yyn0mp702p273cakgfk5j9dg4rqsukcrpanhtwh7pzy4x9q5cvykg68d7rqg2e7wysgt7007pzy9qpk238l2g0xskct9ynva35tey440dxlpe4m3e4qk6yllqakmzf745xt9ps4jajk7kj2dr56atazvlvhcf2lzv8rsvdracjd4452z2wkdv0zdepl90z3pvx2h5kyqtvntqp680a7kyhgvmpfhcfqcjdlksx29r30cey",
"offer_fields_included": [
"offer_description",
"offer_issuer_id"
],
"invreq_fields_included": [
"invreq_payer_id"
],
"invoice_fields_included": [
"invoice_created_at",
"invoice_payment_hash",
"invoice_amount",
"invoice_features",
"invoice_node_id",
"signature"
]
}
]
}
}
]
}
15 changes: 15 additions & 0 deletions doc/schemas/currencyconvert.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,20 @@
],
"resources": [
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
],
"examples": [
{
"request": {
"id": "example:currencyconvert#1",
"method": "currencyconvert",
"params": {
"amount": 100,
"currency": "USD"
}
},
"response": {
"msat": 155974480
}
}
]
}
4 changes: 2 additions & 2 deletions doc/schemas/currencyrate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
}
},
"response": {
"rate": 67889.825
"rate": 64113.052
}
},
{
Expand All @@ -102,7 +102,7 @@
}
},
"response": {
"rate": 67931.9
"rate": 64130.09
}
}
]
Expand Down
12 changes: 12 additions & 0 deletions doc/schemas/delnetworkevent.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,17 @@
],
"resources": [
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
],
"examples": [
{
"request": {
"id": "example:delnetworkevent#1",
"method": "delnetworkevent",
"params": {
"created_index": 2
}
},
"response": {}
}
]
}
39 changes: 39 additions & 0 deletions doc/schemas/listcurrencyrates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,44 @@
],
"resources": [
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
],
"examples": [
{
"request": {
"id": "example:listcurrencyrates#1",
"method": "listcurrencyrates",
"params": {
"currency": "USD"
}
},
"response": {
"currencyrates": [
{
"amount": 64130.09,
"source": "binance"
},
{
"amount": 64099.33,
"source": "blockchain.info"
},
{
"amount": 64117.405,
"source": "coinbase"
},
{
"amount": 64117.67,
"source": "bitstamp"
},
{
"amount": 64108.7,
"source": "kraken"
},
{
"amount": 64103.0,
"source": "coingecko"
}
]
}
}
]
}
117 changes: 117 additions & 0 deletions doc/schemas/listnetworkevents.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,5 +149,122 @@
],
"resources": [
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
],
"examples": [
{
"request": {
"id": "example:listnetworkevents#1",
"method": "listnetworkevents",
"params": {}
},
"response": {
"networkevents": [
{
"created_index": 1,
"peer_id": "038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b",
"type": "connect",
"timestamp": 1738000000
},
{
"created_index": 2,
"peer_id": "03cecbfdc68544cc596223b68ce0710c9e5d2c9cb317ee07822d95079acc703d31",
"type": "connect",
"timestamp": 1738000000,
"reason": "connect command \"pytest:connect#22\"",
"duration_nsec": 1477000
},
{
"created_index": 3,
"peer_id": "0258f3ff3e0853ccc09f6fe89823056d7c0c55c95fab97674df5e1ad97a72f6265",
"type": "connect",
"timestamp": 1738000000,
"reason": "connect command \"pytest:connect#24\"",
"duration_nsec": 949000
},
{
"created_index": 4,
"peer_id": "038194b5f32bdf0aa59812c86c4ef7ad2f294104fa027d1ace9b469bb6f88cf37b",
"type": "ping",
"timestamp": 1738000000,
"duration_nsec": 364000
},
{
"created_index": 5,
"peer_id": "02287bfac8b99b35477ebe9334eede1e32b189e24644eb701c079614712331cec0",
"type": "connect",
"timestamp": 1738000000,
"reason": "connect command \"pytest:connect#416\"",
"duration_nsec": 1844000
},
{
"created_index": 6,
"peer_id": "02287bfac8b99b35477ebe9334eede1e32b189e24644eb701c079614712331cec0",
"type": "disconnect",
"timestamp": 1738000000,
"duration_nsec": 7947000
},
{
"created_index": 7,
"peer_id": "0258f3ff3e0853ccc09f6fe89823056d7c0c55c95fab97674df5e1ad97a72f6265",
"type": "disconnect",
"timestamp": 1738000000,
"duration_nsec": 78635382000
},
{
"created_index": 8,
"peer_id": "0258f3ff3e0853ccc09f6fe89823056d7c0c55c95fab97674df5e1ad97a72f6265",
"type": "connect",
"timestamp": 1738000000,
"reason": "reconnect by timer",
"duration_nsec": 3529000
},
{
"created_index": 9,
"peer_id": "02287bfac8b99b35477ebe9334eede1e32b189e24644eb701c079614712331cec0",
"type": "connect",
"timestamp": 1738000000,
"reason": "connect command \"pytest:connect#458\"",
"duration_nsec": 633000
},
{
"created_index": 10,
"peer_id": "02287bfac8b99b35477ebe9334eede1e32b189e24644eb701c079614712331cec0",
"type": "disconnect",
"timestamp": 1738000000,
"duration_nsec": 6094786000
},
{
"created_index": 11,
"peer_id": "0258f3ff3e0853ccc09f6fe89823056d7c0c55c95fab97674df5e1ad97a72f6265",
"type": "disconnect",
"timestamp": 1738000000,
"duration_nsec": 58905461000
}
]
}
},
{
"request": {
"id": "example:listnetworkevents#2",
"method": "listnetworkevents",
"params": {
"id": "03cecbfdc68544cc596223b68ce0710c9e5d2c9cb317ee07822d95079acc703d31",
"index": "created",
"limit": 3
}
},
"response": {
"networkevents": [
{
"created_index": 2,
"peer_id": "03cecbfdc68544cc596223b68ce0710c9e5d2c9cb317ee07822d95079acc703d31",
"type": "connect",
"timestamp": 1738000000,
"reason": "connect command \"pytest:connect#22\"",
"duration_nsec": 1477000
}
]
}
}
]
}
20 changes: 19 additions & 1 deletion doc/schemas/sendamount.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,5 +133,23 @@
"resources": [
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
],
"examples": []
"examples": [
{
"request": {
"id": "example:sendamount#1",
"method": "sendamount",
"params": {
"invstring": "lno1qgsqvgnwgcg35z6ee2h3yczraddm72xrfua9uve2rlrm9deu7xyfzrc2zefkjmtsd3jjqar9wd6zqum9dejxzmt0w4h8g93pqg58h7kghxdn23m7h6fnfmk7rcetrz0zgezwkuquq7tpgufrx88vq",
"amount_msat": "1000sat"
}
},
"response": {
"payment_preimage": "542e377929e51aa1542e377929e51aa1542e377929e51aa1542e377929e51aa1",
"amount_msat": 1000000,
"amount_sent_msat": 1000000,
"failed_parts": 0,
"successful_parts": 1
}
}
]
}
Loading
Loading