Skip to content

Commit a3a33fe

Browse files
ShahanaFarooquirustyrussell
ShahanaFarooqui
authored and
rustyrussell
committed
doc: Add GENERATE_EXAMPLES env
- Run with environment variable `GENERATE_EXAMPLES` - Update cln version in getinfo example on `make update-versions` - Added two `dev` configs, dev-no-plugin-checksum and dev-no-version-checks, to match CI listconfigs - Changed commando rpc example from `getinfo` to `newaddr` to avoid unneccessary file updates for future builds - Stabilized `bkpr-editdescriptionbyoutpoint`, `listclosedchannels` and `listaddresses` examples
1 parent 075f180 commit a3a33fe

9 files changed

+74
-287
lines changed

‎contrib/msggen/msggen/schema.json‎

Lines changed: 27 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -3301,7 +3301,7 @@
33013301
"currency": "bcrt",
33023302
"outpoint": "txidbk0101010101010101010101010101010101010101010101010101010101:1",
33033303
"timestamp": 1738510000,
3304-
"blockheight": 105,
3304+
"blockheight": 110,
33053305
"description": "edited utxo description"
33063306
}
33073307
]
@@ -6343,38 +6343,15 @@
63436343
"method": "commando",
63446344
"params": {
63456345
"peer_id": "nodeid020202020202020202020202020202020202020202020202020202020202",
6346-
"rune": "_RWaZZRI7wAYU2hqlFBmYgC_dFczcpAdI_9O87YbDpg9MCZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl",
6347-
"method": "getinfo",
6348-
"params": {}
6346+
"rune": "zFMd1fjhrAYxUeFA54TjloZqOt8JrA_i_nYwIgXkag49MA==",
6347+
"method": "newaddr",
6348+
"params": {
6349+
"addresstype": "p2tr"
6350+
}
63496351
}
63506352
},
63516353
"response": {
6352-
"id": "nodeid020202020202020202020202020202020202020202020202020202020202",
6353-
"alias": "SILENTARTIST",
6354-
"color": "022d22",
6355-
"num_peers": 3,
6356-
"num_pending_channels": 0,
6357-
"num_active_channels": 3,
6358-
"num_inactive_channels": 1,
6359-
"address": [],
6360-
"binding": [
6361-
{
6362-
"type": "ipv4",
6363-
"address": "127.0.0.1",
6364-
"port": 19735
6365-
}
6366-
],
6367-
"version": "v24.11rc1",
6368-
"blockheight": 130,
6369-
"network": "regtest",
6370-
"fees_collected_msat": 106,
6371-
"lightning-dir": "/tmp/.lightning/regtest",
6372-
"our_features": {
6373-
"init": "08a0882a8a59a1",
6374-
"node": "88a0882a8a59a1",
6375-
"channel": "",
6376-
"invoice": "02000002024100"
6377-
}
6354+
"p2tr": "bcrt1p338x07070707070707070707070707070707070707070707070707070707"
63786355
}
63796356
},
63806357
{
@@ -17062,14 +17039,14 @@
1706217039
"id": "example:listaddresses#1",
1706317040
"method": "listaddresses",
1706417041
"params": [
17065-
"bcrt1phtprcvhz842sxe8qw0yryvc0g6n6dw2puweklcpnfye273kjpfhs0d6d2e"
17042+
"bcrt1p2gppccw6ywewmg74qqxxmqfdpjds3rpr0mf22y9tm9xcc0muggwsea9nkf"
1706617043
]
1706717044
},
1706817045
"response": {
1706917046
"addresses": [
1707017047
{
17071-
"keyidx": 13,
17072-
"p2tr": "bcrt1phtprcvhz842sxe8qw0yryvc0g6n6dw2puweklcpnfye273kjpfhs0d6d2e"
17048+
"keyidx": 14,
17049+
"p2tr": "bcrt1p2gppccw6ywewmg74qqxxmqfdpjds3rpr0mf22y9tm9xcc0muggwsea9nkf"
1707317050
}
1707417051
]
1707517052
}
@@ -17095,97 +17072,6 @@
1709517072
}
1709617073
]
1709717074
}
17098-
},
17099-
{
17100-
"request": {
17101-
"id": "example:listaddresses#3",
17102-
"method": "listaddresses",
17103-
"params": {}
17104-
},
17105-
"response": {
17106-
"addresses": [
17107-
{
17108-
"keyidx": 1,
17109-
"bech32": "bcrt1qyusnugshkn6kh5vmdjpe8hylvxlxjy3ns0hmrs"
17110-
},
17111-
{
17112-
"keyidx": 2,
17113-
"p2tr": "bcrt1pmeuewfgl24n06v9868kts5v92494zexrvg0hc0sdmgwwnxm6t9sqdwfqjx"
17114-
},
17115-
{
17116-
"keyidx": 3,
17117-
"bech32": "bcrt1qv8ksdsrr9tegfmy7ryhfwav0cprf9jpfqdfr4m"
17118-
},
17119-
{
17120-
"keyidx": 4,
17121-
"p2tr": "bcrt1p3femk2q5x0ettk65v8r80z4z4lfguqgau67sg7v6txgkvtrp675qyc4gu2"
17122-
},
17123-
{
17124-
"keyidx": 5,
17125-
"p2tr": "bcrt1pshtjqf083lgghds3r8cfs74sqs04q4s6mfhpxrry2dpahrzyc2hslyvm7n"
17126-
},
17127-
{
17128-
"keyidx": 6,
17129-
"bech32": "bcrt1qkpw662yvzdy5ttdg8nw4eh4el0uc7m2ythw0h3"
17130-
},
17131-
{
17132-
"keyidx": 7,
17133-
"p2tr": "bcrt1pn45xgkyj54usdu98plm4zgcp4c5jvvfxmyexwcm5kc3gyfsrjmasd6ctsf"
17134-
},
17135-
{
17136-
"keyidx": 8,
17137-
"p2tr": "bcrt1pxu96ugcrazch0y4rfmsy4k5x56etsn7hdgq3gwatmzvu0mv7sdeql5x9qe"
17138-
},
17139-
{
17140-
"keyidx": 9,
17141-
"bech32": "bcrt1q5czetq5cqrxsnxqx0wkm85v8eup7yvjy3vlnr7"
17142-
},
17143-
{
17144-
"keyidx": 10,
17145-
"p2tr": "bcrt1plk4hcq06uuxq3c93lxk2ejs3pff3y8n4m322yhn4gfqk7dp2atmsj2vr99"
17146-
},
17147-
{
17148-
"keyidx": 11,
17149-
"p2tr": "bcrt1pvn0zt2s8cv6shrtx8yd0zh90hwx4wpuqjrplfzpucnmde7kr4q3qx3fjfh"
17150-
},
17151-
{
17152-
"keyidx": 12,
17153-
"bech32": "bcrt1qcqqvkswps3e6ck3jmqf86f9tcaeke5z04d3tv4"
17154-
},
17155-
{
17156-
"keyidx": 13,
17157-
"p2tr": "bcrt1phtprcvhz842sxe8qw0yryvc0g6n6dw2puweklcpnfye273kjpfhs0d6d2e"
17158-
},
17159-
{
17160-
"keyidx": 14,
17161-
"p2tr": "bcrt1p2gppccw6ywewmg74qqxxmqfdpjds3rpr0mf22y9tm9xcc0muggwsea9nkf"
17162-
},
17163-
{
17164-
"keyidx": 15,
17165-
"p2tr": "bcrt1p9dwaqcfmdef574edhn6rzxmxumxghvr79pvj3hdklfterern0p6qx77a44"
17166-
},
17167-
{
17168-
"keyidx": 16,
17169-
"bech32": "bcrt1qswadp7rqx7m0zx2tffhzmqfansdrpfesr2la7k"
17170-
},
17171-
{
17172-
"keyidx": 17,
17173-
"p2tr": "bcrt1pqr02nvastyzya4q3lcjd00l56xemhhgf59srfgyk5jchtal44s8sjt683e"
17174-
},
17175-
{
17176-
"keyidx": 18,
17177-
"bech32": "bcrt1qnk3lx7dch2ygmd8447wr7rj2yu0y92zl9wqf60"
17178-
},
17179-
{
17180-
"keyidx": 19,
17181-
"p2tr": "bcrt1pnsdhwv72k277x6uzajv6ld84tmfu6env4ajy8amprpk8pjfn9n9s3fjvxv"
17182-
},
17183-
{
17184-
"keyidx": 20,
17185-
"p2tr": "bcrt1p9n7h55ahdhmhlakvusfh8xlq98j9780punc9dx84xafcr8xulxmqwn4aa9"
17186-
}
17187-
]
17188-
}
1718917075
}
1719017076
]
1719117077
},
@@ -17833,8 +17719,8 @@
1783317719
"channel_id": "channelid0230000230000230000230000230000230000230000230000230000",
1783417720
"short_channel_id": "111x1x1",
1783517721
"alias": {
17836-
"local": "9100000x13000000x63000",
17837-
"remote": "3500000x7300000x11000"
17722+
"local": "121x131x141",
17723+
"remote": "151x161x171"
1783817724
},
1783917725
"opener": "local",
1784017726
"closer": "local",
@@ -17860,7 +17746,7 @@
1786017746
"min_to_us_msat": 489809898,
1786117747
"max_to_us_msat": 1000000000,
1786217748
"last_commitment_txid": "txidcloselastcommitment00000100001000010000100001000010000100001",
17863-
"last_commitment_fee_msat": 2896000,
17749+
"last_commitment_fee_msat": 2895000,
1786417750
"close_cause": "user",
1786517751
"last_stable_connection": 1738500000
1786617752
},
@@ -17869,8 +17755,8 @@
1786917755
"channel_id": "channelid0250000250000250000250000250000250000250000250000250000",
1787017756
"short_channel_id": "115x1x1",
1787117757
"alias": {
17872-
"local": "6500000x1100000x23000",
17873-
"remote": "5300000x1300000x55000"
17758+
"local": "122x132x142",
17759+
"remote": "152x162x172"
1787417760
},
1787517761
"opener": "local",
1787617762
"closer": "local",
@@ -17896,7 +17782,7 @@
1789617782
"min_to_us_msat": 500000000,
1789717783
"max_to_us_msat": 1000000000,
1789817784
"last_commitment_txid": "txidcloselastcommitment00000200002000020000200002000020000200002",
17899-
"last_commitment_fee_msat": 2895000,
17785+
"last_commitment_fee_msat": 2896000,
1790017786
"close_cause": "user",
1790117787
"last_stable_connection": 1738500000
1790217788
}
@@ -20602,6 +20488,14 @@
2060220488
"source": "default",
2060320489
"plugin": "/root/lightning/plugins/offers"
2060420490
},
20491+
"dev-no-plugin-checksum": {
20492+
"set": true,
20493+
"source": "cmdline"
20494+
},
20495+
"dev-no-version-checks": {
20496+
"set": true,
20497+
"source": "cmdline"
20498+
},
2060520499
"developer": {
2060620500
"set": true,
2060720501
"source": "cmdline"
@@ -27415,7 +27309,7 @@
2741527309
"bcrt1qm7k64cvd2ljw758ptwrrm8ny30u67ea3cfkxpn": 1000
2741627310
},
2741727311
{
27418-
"bcrt1qswadp7rqx7m0zx2tffhzmqfansdrpfesr2la7k": 1000
27312+
"bcrt1qdgvytwcw58uwlf3lqrej2eqaku6smn2mdvkycp": 1000
2741927313
},
2742027314
{
2742127315
"bcrt1q68wfpfam8tu3a457jv7u8r64tdvqltgfs0kj84": 1000
@@ -27511,7 +27405,7 @@
2751127405
"params": {}
2751227406
},
2751327407
"response": {
27514-
"bech32": "bcrt1qcqqvkswps3e6ck3jmqf86f9tcaeke5z04d3tv4"
27408+
"bech32": "bcrt1qwx6am26cuw38y4863pd6swrce2g8mzhaxr9xp8"
2751527409
}
2751627410
},
2751727411
{
@@ -27523,7 +27417,7 @@
2752327417
}
2752427418
},
2752527419
"response": {
27526-
"p2tr": "bcrt1phtprcvhz842sxe8qw0yryvc0g6n6dw2puweklcpnfye273kjpfhs0d6d2e"
27420+
"p2tr": "bcrt1p2gppccw6ywewmg74qqxxmqfdpjds3rpr0mf22y9tm9xcc0muggwsea9nkf"
2752727421
}
2752827422
}
2752927423
]

‎doc/schemas/lightning-bkpr-editdescriptionbyoutpoint.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@
286286
"currency": "bcrt",
287287
"outpoint": "txidbk0101010101010101010101010101010101010101010101010101010101:1",
288288
"timestamp": 1738510000,
289-
"blockheight": 105,
289+
"blockheight": 110,
290290
"description": "edited utxo description"
291291
}
292292
]

‎doc/schemas/lightning-commando.json‎

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -91,38 +91,15 @@
9191
"method": "commando",
9292
"params": {
9393
"peer_id": "nodeid020202020202020202020202020202020202020202020202020202020202",
94-
"rune": "_RWaZZRI7wAYU2hqlFBmYgC_dFczcpAdI_9O87YbDpg9MCZtZXRob2RebGlzdHxtZXRob2ReZ2V0fG1ldGhvZD1zdW1tYXJ5Jm1ldGhvZC9saXN0ZGF0YXN0b3Jl",
95-
"method": "getinfo",
96-
"params": {}
94+
"rune": "zFMd1fjhrAYxUeFA54TjloZqOt8JrA_i_nYwIgXkag49MA==",
95+
"method": "newaddr",
96+
"params": {
97+
"addresstype": "p2tr"
98+
}
9799
}
98100
},
99101
"response": {
100-
"id": "nodeid020202020202020202020202020202020202020202020202020202020202",
101-
"alias": "SILENTARTIST",
102-
"color": "022d22",
103-
"num_peers": 3,
104-
"num_pending_channels": 0,
105-
"num_active_channels": 3,
106-
"num_inactive_channels": 1,
107-
"address": [],
108-
"binding": [
109-
{
110-
"type": "ipv4",
111-
"address": "127.0.0.1",
112-
"port": 19735
113-
}
114-
],
115-
"version": "v24.11rc1",
116-
"blockheight": 130,
117-
"network": "regtest",
118-
"fees_collected_msat": 106,
119-
"lightning-dir": "/tmp/.lightning/regtest",
120-
"our_features": {
121-
"init": "08a0882a8a59a1",
122-
"node": "88a0882a8a59a1",
123-
"channel": "",
124-
"invoice": "02000002024100"
125-
}
102+
"p2tr": "bcrt1p338x07070707070707070707070707070707070707070707070707070707"
126103
}
127104
},
128105
{

0 commit comments

Comments
 (0)