mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-20 13:54:36 +01:00
Code Issues Projects Releases Wiki Activity

docs: Changes examples format

Browse source 
- Changed ALL `doc/schemas/lightning-*.json` file's `json_example` to `examples`
- Change the heading from example to examples
- Bring shell command before the json command
- Move Example to the end of the page
- Remove horizontal line from Example
This commit is contained in:
ShahanaFarooqui 2024-06-20 14:57:02 -07:00 • committed by Christian Decker
parent 1347e86671
commit 976c0c90bc
118 changed files with 2995 additions and 2995 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2988
contrib/msggen/msggen/schema.json
View file

File diff suppressed because it is too large Load diff

2
doc/rpc-schema-draft.json
View file

@ -390,7 +390,7 @@
"type": "string"
}
},
"json_example": {
"examples": {
"type": "array",
"items": {
"type": "object",

20
doc/schemas/lightning-addgossip.json
View file

@ -27,7 +27,16 @@
"response": {
"properties": {}
},
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-pay(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:addgossip#1",
@ -48,14 +57,5 @@
},
"response": {}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-pay(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-addpsbtoutput.json
View file

@ -75,7 +75,17 @@
"lightning-cli addpsbtoutput 100000sat",
"```"
],
"json_example": [
"author": [
"Dusty <<@dusty_daemon>> is mainly responsible."
],
"see_also": [
"lightning-fundpsbt(7)",
"lightning-utxopsbt(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:addpsbtoutput#1",
@ -121,15 +131,5 @@
"outnum": 1
}
}
],
"author": [
"Dusty <<@dusty_daemon>> is mainly responsible."
],
"see_also": [
"lightning-fundpsbt(7)",
"lightning-utxopsbt(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-autoclean-once.json
View file

@ -186,7 +186,17 @@
}
}
},
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightningd-config(5)",
"lightning-autoclean-status(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:autoclean-once#1",
@ -223,15 +233,5 @@
}
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightningd-config(5)",
"lightning-autoclean-status(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-autoclean-status.json
View file

@ -414,7 +414,19 @@
"Note that the ages parameters are set by various `autoclean-...-age` parameters in your configuration: see lightningd-config(5)."
]
},
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightningd-config(5)",
"lightning-listinvoices(7)",
"lightning-listpays(7)",
"lightning-listforwards(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:autoclean-status#1",
@ -468,17 +480,5 @@
}
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightningd-config(5)",
"lightning-listinvoices(7)",
"lightning-listpays(7)",
"lightning-listforwards(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-batching.json
View file

@ -24,18 +24,6 @@
"response": {
"properties": {}
},
"json_example": [
{
"request": {
"id": "example:batching#1",
"method": "batching",
"params": {
"enable": true
}
},
"response": {}
}
],
"errors": [
"On failure, one of the following error codes may be returned:",
"",
@ -46,5 +34,17 @@
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:batching#1",
"method": "batching",
"params": {
"enable": true
}
},
"response": {}
}
]
}

28
doc/schemas/lightning-bkpr-channelsapy.json
View file

@ -191,7 +191,20 @@
}
}
},
"json_example": [
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-bkpr-listincome(7)",
"lightning-bkpr-listfunds(7)",
"lightning-bkpr-listaccountevents(7)",
"lightning-bkpr-dumpincomecsv(7)",
"lightning-listpeers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:bkpr-channelsapy#1",
@ -245,18 +258,5 @@
]
}
}
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-bkpr-listincome(7)",
"lightning-bkpr-listfunds(7)",
"lightning-bkpr-listaccountevents(7)",
"lightning-bkpr-dumpincomecsv(7)",
"lightning-listpeers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

28
doc/schemas/lightning-bkpr-dumpincomecsv.json
View file

@ -73,7 +73,20 @@
}
}
},
"json_example": [
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-bkpr-listincome(7)",
"lightning-bkpr-listfunds(7)",
"lightning-bkpr-listaccountevents(7)",
"lightning-bkpr-channelsapy(7)",
"lightning-listpeers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:bkpr-dumpincomecsv#1",
@ -88,18 +101,5 @@
"csv_format": "koinly"
}
}
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-bkpr-listincome(7)",
"lightning-bkpr-listfunds(7)",
"lightning-bkpr-listaccountevents(7)",
"lightning-bkpr-channelsapy(7)",
"lightning-listpeers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-bkpr-inspect.json
View file

@ -195,7 +195,18 @@
}
}
},
"json_example": [
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-listbalances(7)",
"lightning-listfunds(7)",
"lightning-listpeers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:bkpr-inspect#1",
@ -223,16 +234,5 @@
]
}
}
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-listbalances(7)",
"lightning-listfunds(7)",
"lightning-listpeers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-bkpr-listaccountevents.json
View file

@ -243,7 +243,19 @@
}
}
},
"json_example": [
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-bkpr-listincome(7)",
"lightning-listfunds(7)",
"lightning-bkpr-listbalances(7)",
"lightning-bkpr-channelsapy(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:bkpr-listaccountevents#1",
@ -467,17 +479,5 @@
]
}
}
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-bkpr-listincome(7)",
"lightning-listfunds(7)",
"lightning-bkpr-listbalances(7)",
"lightning-bkpr-channelsapy(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

28
doc/schemas/lightning-bkpr-listbalances.json
View file

@ -122,7 +122,20 @@
}
}
},
"json_example": [
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-bkpr-listincome(7)",
"lightning-listfunds(7)",
"lightning-bkpr-listaccountevents(7)",
"lightning-bkpr-channelsapy(7)",
"lightning-listpeers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:bkpr-listbalances#1",
@ -143,18 +156,5 @@
]
}
}
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-bkpr-listincome(7)",
"lightning-listfunds(7)",
"lightning-bkpr-listaccountevents(7)",
"lightning-bkpr-channelsapy(7)",
"lightning-listpeers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-bkpr-listincome.json
View file

@ -118,7 +118,18 @@
}
}
},
"json_example": [
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-bkpr-listaccountevents(7)",
"lightning-listfunds(7)",
"lightning-bkpr-listbalances(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:bkpr-listincome#1",
@ -197,16 +208,5 @@
]
}
}
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-bkpr-listaccountevents(7)",
"lightning-listfunds(7)",
"lightning-bkpr-listbalances(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-blacklistrune.json
View file

@ -69,7 +69,17 @@
}
}
},
"json_example": [
"author": [
"Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible."
],
"see_also": [
"lightning-commando-blacklist(7)",
"lightning-showrunes(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:blacklistrune#1",
@ -127,15 +137,5 @@
]
}
}
],
"author": [
"Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible."
],
"see_also": [
"lightning-commando-blacklist(7)",
"lightning-showrunes(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

14
doc/schemas/lightning-check.json
View file

@ -37,7 +37,13 @@
"command_to_check"
]
},
"json_example": [
"author": [
"Mark Beckwith <<wythe@intrig.com>> and Rusty Russell <<rusty@rustcorp.com.au>> are mainly responsible."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:check#1",
@ -92,11 +98,5 @@
"command_to_check": "recover"
}
}
],
"author": [
"Mark Beckwith <<wythe@intrig.com>> and Rusty Russell <<rusty@rustcorp.com.au>> are mainly responsible."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

32
doc/schemas/lightning-checkmessage.json
View file

@ -58,7 +58,22 @@
}
}
},
"json_example": [
"errors": [
"On failure, an error is returned and core lightning exit with the following error code:",
"",
"- -32602: Parameter missed or malformed;",
"- 1301: *pubkey* not found in the graph."
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-signmessage(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:checkmessage#1",
@ -88,20 +103,5 @@
"verified": true
}
}
],
"errors": [
"On failure, an error is returned and core lightning exit with the following error code:",
"",
"- -32602: Parameter missed or malformed;",
"- 1301: *pubkey* not found in the graph."
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-signmessage(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-checkrune.json
View file

@ -73,7 +73,17 @@
"- 1502 (RUNE_NOT_PERMITTED): rune does not allow this usage (includes a detailed reason why)",
"- 1503 (RUNE_BLACKLISTED): rune has been explicitly blacklisted."
],
"json_example": [
"author": [
"Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible for consolidating logic from commando."
],
"see_also": [
"lightning-createrune(7)",
"lightning-blacklistrune(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:checkrune#1",
@ -129,15 +139,5 @@
"valid": true
}
}
],
"author": [
"Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible for consolidating logic from commando."
],
"see_also": [
"lightning-createrune(7)",
"lightning-blacklistrune(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-close.json
View file

@ -143,7 +143,18 @@
"notifications": [
"Notifications may be returned indicating what is going on, especially if the peer is offline and we are waiting."
],
"json_example": [
"author": [
"ZmnSCPxj <<ZmnSCPxj@protonmail.com>> is mainly responsible."
],
"see_also": [
"lightning-disconnect(7)",
"lightning-fundchannel(7)",
"lightningd-config(5)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:close#1",
@ -190,16 +201,5 @@
"type": "mutual"
}
}
],
"author": [
"ZmnSCPxj <<ZmnSCPxj@protonmail.com>> is mainly responsible."
],
"see_also": [
"lightning-disconnect(7)",
"lightning-fundchannel(7)",
"lightningd-config(5)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

20
doc/schemas/lightning-commando-blacklist.json
View file

@ -71,7 +71,16 @@
}
}
},
"json_example": [
"author": [
"Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible."
],
"see_also": [
"lightning-commando-listrunes(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:commando-blacklist#1",
@ -129,14 +138,5 @@
]
}
}
],
"author": [
"Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible."
],
"see_also": [
"lightning-commando-listrunes(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-commando-listrunes.json
View file

@ -160,7 +160,17 @@
}
}
},
"json_example": [
"author": [
"Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible."
],
"see_also": [
"lightning-commando-rune(7)",
"lightning-commando-blacklist(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:commando-listrunes#1",
@ -284,15 +294,5 @@
]
}
}
],
"author": [
"Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible."
],
"see_also": [
"lightning-commando-rune(7)",
"lightning-commando-blacklist(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-commando-rune.json
View file

@ -220,7 +220,19 @@
"",
"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."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> wrote the original Python commando.py plugin, the in-tree commando plugin, and this manual page.",
"",
"Christian Decker came up with the name \"commando\", which almost excuses his previous adoption of the name \"Eltoo\"."
],
"see_also": [
"lightning-commando(7)",
"lightning-decode(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:commando-rune#1",
@ -286,17 +298,5 @@
"unique_id": "3"
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> wrote the original Python commando.py plugin, the in-tree commando plugin, and this manual page.",
"",
"Christian Decker came up with the name \"commando\", which almost excuses his previous adoption of the name \"Eltoo\"."
],
"see_also": [
"lightning-commando(7)",
"lightning-decode(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-commando.json
View file

@ -72,7 +72,18 @@
"",
"It can also fail if the peer does not respond, in which case it will simply hang awaiting a response."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> wrote the original Python commando.py plugin, the in-tree commando plugin, and this manual page.",
"",
"Christian Decker came up with the name \"commando\", which almost excuses his previous adoption of the name \"Eltoo\"."
],
"see_also": [
"lightning-commando-rune(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:commando#1",
@ -172,16 +183,5 @@
"status": "complete"
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> wrote the original Python commando.py plugin, the in-tree commando plugin, and this manual page.",
"",
"Christian Decker came up with the name \"commando\", which almost excuses his previous adoption of the name \"Eltoo\"."
],
"see_also": [
"lightning-commando-rune(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-connect.json
View file

@ -171,7 +171,19 @@
"- 402: If the peer disconnected while we were connecting",
"- -32602: If the given parameters are wrong"
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible. Felix <<fixone@gmail.com>> is the original author of this manpage."
],
"see_also": [
"lightning-fundchannel(7)",
"lightning-listpeers(7)",
"lightning-listchannels(7)",
"lightning-disconnect(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:connect#1",
@ -214,17 +226,5 @@
}
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible. Felix <<fixone@gmail.com>> is the original author of this manpage."
],
"see_also": [
"lightning-fundchannel(7)",
"lightning-listpeers(7)",
"lightning-listchannels(7)",
"lightning-disconnect(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-createonion.json
View file

@ -155,7 +155,19 @@
"",
"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**."
],
"json_example": [
"author": [
"Christian Decker <<decker.christian@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-sendonion(7)",
"lightning-getroute(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"",
"[BOLT 04](https://github.com/lightning/bolts/blob/master/04-onion-routing.md)"
],
"examples": [
{
"request": {
"id": "example:createonion#1",
@ -219,17 +231,5 @@
]
}
}
],
"author": [
"Christian Decker <<decker.christian@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-sendonion(7)",
"lightning-getroute(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"",
"[BOLT 04](https://github.com/lightning/bolts/blob/master/04-onion-routing.md)"
]
}

26
doc/schemas/lightning-createrune.json
View file

@ -223,7 +223,19 @@
"",
"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."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> wrote the original Python commando.py plugin, the in-tree commando plugin, and this manual page.",
"",
"Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible for migrating commando-rune to createrune."
],
"see_also": [
"lightning-commando-rune(7)",
"lightning-checkrune(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:createrune#1",
@ -272,17 +284,5 @@
"unique_id": "2"
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> wrote the original Python commando.py plugin, the in-tree commando plugin, and this manual page.",
"",
"Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible for migrating commando-rune to createrune."
],
"see_also": [
"lightning-commando-rune(7)",
"lightning-checkrune(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-datastore.json
View file

@ -114,7 +114,18 @@
"- 1206: One of the parents already exists with a value.",
"- -32602: invalid parameters"
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listdatastore(7)",
"lightning-deldatastore(7)",
"lightning-datastoreusage(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:datastore#1",
@ -185,16 +196,5 @@
"string": "somedatatostoreinthedatastore"
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listdatastore(7)",
"lightning-deldatastore(7)",
"lightning-datastoreusage(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-datastoreusage.json
View file

@ -62,7 +62,18 @@
}
}
},
"json_example": [
"author": [
"Peter Neuroth <<pet.v.ne@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-datastore(7)",
"lightning-deldatastore(7)",
"lightning-listdatastore(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:datastoreusage#1",
@ -109,16 +120,5 @@
}
}
}
],
"author": [
"Peter Neuroth <<pet.v.ne@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-datastore(7)",
"lightning-deldatastore(7)",
"lightning-listdatastore(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

38
doc/schemas/lightning-decode.json
View file

@ -2061,7 +2061,25 @@
}
]
},
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-pay(7)",
"lightning-offer(7)",
"lightning-fetchinvoice(7)",
"lightning-sendinvoice(7)",
"lightning-commando-rune(7)"
],
"resources": [
"[BOLT #11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md)",
"",
"[BOLT #12](https://github.com/rustyrussell/lightning-rfc/blob/guilt/offers/12-offer-encoding.md)",
"(experimental, [bolt](https://github.com/lightning/bolts) #798)",
"",
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:decode#1",
@ -2128,23 +2146,5 @@
"valid": true
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-pay(7)",
"lightning-offer(7)",
"lightning-fetchinvoice(7)",
"lightning-sendinvoice(7)",
"lightning-commando-rune(7)"
],
"resources": [
"[BOLT #11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md)",
"",
"[BOLT #12](https://github.com/rustyrussell/lightning-rfc/blob/guilt/offers/12-offer-encoding.md)",
"(experimental, [bolt](https://github.com/lightning/bolts) #798)",
"",
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

28
doc/schemas/lightning-decodepay.json
View file

@ -247,7 +247,20 @@
"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."
]
},
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-pay(7)",
"lightning-getroute(7)",
"lightning-sendpay(7)"
],
"resources": [
"[BOLT #11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md)",
"",
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:decodepay#1",
@ -272,18 +285,5 @@
"signature": "3045022100e3b7d8886eae1a7c9e55e1797aa0dcb77b8c5a19d56c657cad030e360c90682802203a35713acb098245e53a37faeac98754a29a7078db5ed6f2166f917e55b94484"
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-pay(7)",
"lightning-getroute(7)",
"lightning-sendpay(7)"
],
"resources": [
"[BOLT #11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md)",
"",
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-deldatastore.json
View file

@ -79,7 +79,18 @@
"- 1201: the key does exist, but the generation is wrong",
"- -32602: invalid parameters"
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listdatastore(7)",
"lightning-datastore(7)",
"lightning-datastoreusage(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:deldatastore#1",
@ -117,16 +128,5 @@
"string": "aval"
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listdatastore(7)",
"lightning-datastore(7)",
"lightning-datastoreusage(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

20
doc/schemas/lightning-delforward.json
View file

@ -50,7 +50,16 @@
"",
"- 1401: The forward specified does not exist."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-autoclean(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:delforward#1",
@ -75,14 +84,5 @@
},
"response": {}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-autoclean(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-delinvoice.json
View file

@ -277,7 +277,19 @@
"- 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."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listinvoices(7)",
"lightning-waitinvoice(7)",
"lightning-invoice(7)",
"lightning-autoclean-status(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:delinvoice#1",
@ -322,17 +334,5 @@
"updated_index": 1
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listinvoices(7)",
"lightning-waitinvoice(7)",
"lightning-invoice(7)",
"lightning-autoclean-status(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

44
doc/schemas/lightning-delpay.json
View file

@ -185,7 +185,28 @@
"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."
]
},
"json_example": [
"errors": [
"On failure, an error is returned. If the lightning process fails before responding, the",
"caller should use lightning-listsentpays(7) or lightning-listpays(7) to query whether this payment was deleted or not.",
"",
"The following error codes may occur:",
"",
"- -32602: Parameter missed or malformed;",
"- 211: Payment status mismatch. Check the correct status via **paystatus**;",
"- 208: Payment with payment_hash not found."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> is mainly responsible."
],
"see_also": [
"lightning-listpays(7)",
"lightning-listsendpays(7)",
"lightning-paystatus(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:delpay#1",
@ -272,26 +293,5 @@
]
}
}
],
"errors": [
"On failure, an error is returned. If the lightning process fails before responding, the",
"caller should use lightning-listsentpays(7) or lightning-listpays(7) to query whether this payment was deleted or not.",
"",
"The following error codes may occur:",
"",
"- -32602: Parameter missed or malformed;",
"- 211: Payment status mismatch. Check the correct status via **paystatus**;",
"- 208: Payment with payment_hash not found."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> is mainly responsible."
],
"see_also": [
"lightning-listpays(7)",
"lightning-listsendpays(7)",
"lightning-paystatus(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-deprecations.json
View file

@ -24,18 +24,6 @@
"response": {
"properties": {}
},
"json_example": [
{
"request": {
"id": "example:deprecations#1",
"method": "deprecations",
"params": {
"enable": false
}
},
"response": {}
}
],
"errors": [
"On failure, one of the following error codes may be returned:",
"",
@ -50,5 +38,17 @@
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:deprecations#1",
"method": "deprecations",
"params": {
"enable": false
}
},
"response": {}
}
]
}

26
doc/schemas/lightning-dev-forget-channel.json
View file

@ -77,7 +77,19 @@
"- -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."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-close(7)",
"lightning-listchannels(7)",
"lightning-listpeerchannels(7)",
"lightning-listfunds(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"description": [
"Forget a channel by peer pubkey when only one channel exists with the peer."
@ -115,17 +127,5 @@
"funding_txid": "b254f30a58adde9326b7e8a701f9d5b3c4db2160b58c5378afbe04448018ec8a"
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-close(7)",
"lightning-listchannels(7)",
"lightning-listpeerchannels(7)",
"lightning-listfunds(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-disableoffer.json
View file

@ -76,7 +76,17 @@
"Note: the returned object is the same format as **listoffers**."
]
},
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-offer(7)",
"lightning-listoffers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:disableoffer#1",
@ -93,15 +103,5 @@
"used": false
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-offer(7)",
"lightning-listoffers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-disconnect.json
View file

@ -45,7 +45,17 @@
"- -32602: If the given parameters are wrong.",
"- -1: Catchall nonspecific error."
],
"json_example": [
"author": [
"Michael Hawkins <<michael.hawkins@protonmail.com>>."
],
"see_also": [
"lightning-connect(1)",
"lightning-listpeers(1)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:disconnect#1",
@ -68,15 +78,5 @@
},
"response": {}
}
],
"author": [
"Michael Hawkins <<michael.hawkins@protonmail.com>>."
],
"see_also": [
"lightning-connect(1)",
"lightning-listpeers(1)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

20
doc/schemas/lightning-emergencyrecover.json
View file

@ -29,7 +29,16 @@
}
}
},
"json_example": [
"author": [
"Aditya <<aditya.sharma20111@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-getsharedsecret(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:emergencyrecover#1",
@ -52,14 +61,5 @@
]
}
}
],
"author": [
"Aditya <<aditya.sharma20111@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-getsharedsecret(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

28
doc/schemas/lightning-feerates.json
View file

@ -369,7 +369,20 @@
"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\"."
],
"json_example": [
"author": [
"ZmnSCPxj <<ZmnSCPxj@protonmail.com>> wrote the initial version of this manpage."
],
"see_also": [
"lightning-parsefeerate(7)",
"lightning-fundchannel(7)",
"lightning-withdraw(7)",
"lightning-txprepare(7)",
"lightning-fundchannel_start(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:feerates#1",
@ -467,18 +480,5 @@
}
}
}
],
"author": [
"ZmnSCPxj <<ZmnSCPxj@protonmail.com>> wrote the initial version of this manpage."
],
"see_also": [
"lightning-parsefeerate(7)",
"lightning-fundchannel(7)",
"lightning-withdraw(7)",
"lightning-txprepare(7)",
"lightning-fundchannel_start(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-fetchinvoice.json
View file

@ -174,7 +174,17 @@
"- 1004: The node making the offer returned an error message.",
"- 1005: We timed out trying to fetch an invoice."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-sendinvoice(7)",
"lightning-pay(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:fetchinvoice#1",
@ -217,15 +227,5 @@
"changes": {}
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-sendinvoice(7)",
"lightning-pay(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

46
doc/schemas/lightning-fundchannel.json
View file

@ -221,7 +221,29 @@
"lightning-cli -k fundchannel id=03f...fc1 amount=all feerate=normal utxos='[\"bcc1...39c:0\"]'",
"```"
],
"json_example": [
"errors": [
"The following error codes may occur:",
"",
"- -1: Catchall nonspecific error.",
"- 300: The maximum allowed funding amount is exceeded.",
"- 301: There are not enough funds in the internal wallet (including fees) to create the transaction.",
"- 302: The output amount is too small, and would be considered dust.",
"- 303: Broadcasting of the funding transaction failed, the internal call to bitcoin-cli returned with an error.",
"- 313: The `min-emergency-msat` reserve not be preserved (and we have or are opening anchor channels).",
"",
"Failure may also occur if **lightningd** and the peer cannot agree on channel parameters (funding limits, channel reserves, fees, etc.)."
],
"see_also": [
"lightning-connect(7)",
"lightning-listfunds()",
"lightning-listpeers(7)",
"lightning-feerates(7)",
"lightning-multifundchannel(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:fundchannel#1",
@ -267,27 +289,5 @@
"outnum": 0
}
}
],
"errors": [
"The following error codes may occur:",
"",
"- -1: Catchall nonspecific error.",
"- 300: The maximum allowed funding amount is exceeded.",
"- 301: There are not enough funds in the internal wallet (including fees) to create the transaction.",
"- 302: The output amount is too small, and would be considered dust.",
"- 303: Broadcasting of the funding transaction failed, the internal call to bitcoin-cli returned with an error.",
"- 313: The `min-emergency-msat` reserve not be preserved (and we have or are opening anchor channels).",
"",
"Failure may also occur if **lightningd** and the peer cannot agree on channel parameters (funding limits, channel reserves, fees, etc.)."
],
"see_also": [
"lightning-connect(7)",
"lightning-listfunds()",
"lightning-listpeers(7)",
"lightning-feerates(7)",
"lightning-multifundchannel(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

52
doc/schemas/lightning-fundchannel_cancel.json
View file

@ -37,32 +37,6 @@
}
}
},
"json_example": [
{
"request": {
"id": "example:fundchannel_cancel#1",
"method": "fundchannel_cancel",
"params": {
"id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59"
}
},
"response": {
"cancelled": "Channel open canceled by RPC"
}
},
{
"request": {
"id": "example:fundchannel_cancel#2",
"method": "fundchannel_cancel",
"params": {
"id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59"
}
},
"response": {
"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:",
"",
@ -87,5 +61,31 @@
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:fundchannel_cancel#1",
"method": "fundchannel_cancel",
"params": {
"id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59"
}
},
"response": {
"cancelled": "Channel open canceled by RPC"
}
},
{
"request": {
"id": "example:fundchannel_cancel#2",
"method": "fundchannel_cancel",
"params": {
"id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59"
}
},
"response": {
"cancelled": "Channel open canceled by RPC(after fundchannel_complete)"
}
}
]
}

32
doc/schemas/lightning-fundchannel_complete.json
View file

@ -61,22 +61,6 @@
"- 306: Unknown peer id.",
"- 309: PSBT does not have a unique, correct output to fund the channel."
],
"json_example": [
{
"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
}
}
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
@ -94,5 +78,21 @@
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"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
}
}
]
}

38
doc/schemas/lightning-fundchannel_start.json
View file

@ -187,7 +187,25 @@
"- 306: Unknown peer id.",
"- 312: Peer negotiated `option_dual_fund`, must use `openchannel_init` not `fundchannel_start`. (Only if ``experimental-dual-fund` is enabled)"
],
"json_example": [
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-connect(7)",
"lightning-fundchannel(7)",
"lightning-multifundchannel(7)",
"lightning-fundchannel_complete(7)",
"lightning-fundchannel_cancel(7)",
"lightning-openchannel_init(7)",
"lightning-openchannel_update(7)",
"lightning-openchannel_signed(7)",
"lightning-openchannel_bump(7)",
"lightning-openchannel_abort(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:fundchannel_start#1",
@ -230,23 +248,5 @@
"warning_usage": "The funding transaction MUST NOT be broadcast until after channel establishment has been successfully completed by running `fundchannel_complete`"
}
}
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-connect(7)",
"lightning-fundchannel(7)",
"lightning-multifundchannel(7)",
"lightning-fundchannel_complete(7)",
"lightning-fundchannel_cancel(7)",
"lightning-openchannel_init(7)",
"lightning-openchannel_update(7)",
"lightning-openchannel_signed(7)",
"lightning-openchannel_bump(7)",
"lightning-openchannel_abort(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-funderupdate.json
View file

@ -267,7 +267,17 @@
"",
"- -32602: If the given parameters are invalid."
],
"json_example": [
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-fundchannel(7)",
"lightning-listfunds(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:funderupdate#1",
@ -323,15 +333,5 @@
"fund_probability": 100
}
}
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-fundchannel(7)",
"lightning-listfunds(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-fundpsbt.json
View file

@ -195,7 +195,18 @@
"- -1: Catchall nonspecific error.",
"- 301: Insufficient UTXOs to meet *satoshi* value."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-utxopsbt(7)",
"lightning-reserveinputs(7)",
"lightning-unreserveinputs(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:fundpsbt#1",
@ -271,16 +282,5 @@
]
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-utxopsbt(7)",
"lightning-reserveinputs(7)",
"lightning-unreserveinputs(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

36
doc/schemas/lightning-getinfo.json
View file

@ -362,7 +362,24 @@
}
}
},
"json_example": [
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters or some error happened during the command process."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-connect(7)",
"lightning-fundchannel(7)",
"lightning-listconfigs(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:getinfo#1",
@ -410,22 +427,5 @@
}
}
}
],
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters or some error happened during the command process."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-connect(7)",
"lightning-fundchannel(7)",
"lightning-listconfigs(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-getlog.json
View file

@ -215,7 +215,19 @@
}
}
},
"json_example": [
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:getlog#1",
@ -242,17 +254,5 @@
]
}
}
],
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-getroute.json
View file

@ -352,7 +352,17 @@
"",
"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."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-pay(7)",
"lightning-sendpay(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:getroute#1",
@ -424,15 +434,5 @@
]
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-pay(7)",
"lightning-sendpay(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-help.json
View file

@ -75,7 +75,19 @@
}
}
},
"json_example": [
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:help#1",
@ -116,17 +128,5 @@
"format-hint": "simple"
}
}
],
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-invoice.json
View file

@ -188,7 +188,18 @@
"- 901: An invoice with the given *preimage* already exists.",
"- 902: None of the specified *exposeprivatechannels* were usable."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listinvoices(7)",
"lightning-delinvoice(7)",
"lightning-pay(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:invoice#1",
@ -229,16 +240,5 @@
"warning_capacity": "Insufficient incoming channel capacity to pay invoice"
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listinvoices(7)",
"lightning-delinvoice(7)",
"lightning-pay(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

32
doc/schemas/lightning-invoicerequest.json
View file

@ -107,7 +107,22 @@
}
}
},
"json_example": [
"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.",
"",
"- -1: Catchall nonspecific error."
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listinvoicerequests(7)",
"lightning-disableinvoicerequest(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:invoicerequest#1",
@ -126,20 +141,5 @@
"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.",
"",
"- -1: Catchall nonspecific error."
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listinvoicerequests(7)",
"lightning-disableinvoicerequest(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

30
doc/schemas/lightning-keysend.json
View file

@ -209,7 +209,21 @@
"*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."
],
"json_example": [
"author": [
"Christian Decker <<decker@blockstream.com>> is mainly responsible."
],
"see_also": [
"lightning-listpays(7)",
"lightning-decodepay(7)",
"lightning-listinvoices(7)",
"lightning-delinvoice(7)",
"lightning-getroute(7)",
"lightning-invoice(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:keysend#1",
@ -294,19 +308,5 @@
"status": "complete"
}
}
],
"author": [
"Christian Decker <<decker@blockstream.com>> is mainly responsible."
],
"see_also": [
"lightning-listpays(7)",
"lightning-decodepay(7)",
"lightning-listinvoices(7)",
"lightning-delinvoice(7)",
"lightning-getroute(7)",
"lightning-invoice(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-listchannels.json
View file

@ -169,7 +169,19 @@
"",
"- -32602: If the given parameters are wrong."
],
"json_example": [
"author": [
"Michael Hawkins <<michael.hawkins@protonmail.com>>."
],
"see_also": [
"lightning-fundchannel(7)",
"lightning-listnodes(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"",
"BOLT #7: <https://github.com/lightning/bolts/blob/master/07-routing-gossip.md>"
],
"examples": [
{
"request": {
"id": "example:listchannels#1",
@ -229,17 +241,5 @@
]
}
}
],
"author": [
"Michael Hawkins <<michael.hawkins@protonmail.com>>."
],
"see_also": [
"lightning-fundchannel(7)",
"lightning-listnodes(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"",
"BOLT #7: <https://github.com/lightning/bolts/blob/master/07-routing-gossip.md>"
]
}

34
doc/schemas/lightning-listconfigs.json
View file

@ -2440,7 +2440,23 @@
"- **value_bool** (boolean, optional): for boolean options"
]
},
"json_example": [
"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 <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-getinfo(7)",
"lightningd-config(5)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:listconfigs#1",
@ -2891,21 +2907,5 @@
}
}
}
],
"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 <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-getinfo(7)",
"lightningd-config(5)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-listdatastore.json
View file

@ -81,7 +81,18 @@
"",
"- -32602: invalid parameters."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-datastore(7)",
"lightning-deldatastore(7)",
"lightning-datastoreusage(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:listdatastore#1",
@ -117,16 +128,5 @@
]
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-datastore(7)",
"lightning-deldatastore(7)",
"lightning-datastoreusage(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-listforwards.json
View file

@ -362,7 +362,17 @@
}
}
},
"json_example": [
"author": [
"Rene Pickhardt <<r.pickhardt@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-autoclean-status(7)",
"lightning-getinfo(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:listforwards#1",
@ -434,15 +444,5 @@
"forwards": []
}
}
],
"author": [
"Rene Pickhardt <<r.pickhardt@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-autoclean-status(7)",
"lightning-getinfo(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-listfunds.json
View file

@ -329,7 +329,19 @@
}
}
},
"json_example": [
"author": [
"Felix <<fixone@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-newaddr(7)",
"lightning-fundchannel(7)",
"lightning-withdraw(7)",
"lightning-listtransactions(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:listfunds#1",
@ -362,17 +374,5 @@
"channels": []
}
}
],
"author": [
"Felix <<fixone@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-newaddr(7)",
"lightning-fundchannel(7)",
"lightning-withdraw(7)",
"lightning-listtransactions(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

20
doc/schemas/lightning-listhtlcs.json
View file

@ -111,7 +111,16 @@
}
}
},
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listforwards(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:listhtlcs#1",
@ -248,14 +257,5 @@
]
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listforwards(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-listinvoicerequests.json
View file

@ -85,7 +85,17 @@
}
}
},
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-invoicerequests(7)",
"lightning-disableinvoicerequest(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:listinvoicerequests#1",
@ -106,15 +116,5 @@
]
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-invoicerequests(7)",
"lightning-disableinvoicerequest(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-listinvoices.json
View file

@ -287,7 +287,18 @@
}
}
},
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-waitinvoice(7)",
"lightning-delinvoice(7)",
"lightning-invoice(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:listinvoices#1",
@ -313,16 +324,5 @@
]
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-waitinvoice(7)",
"lightning-delinvoice(7)",
"lightning-invoice(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

32
doc/schemas/lightning-listnodes.json
View file

@ -244,7 +244,22 @@
}
}
},
"json_example": [
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-listchannels(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:listnodes#1",
@ -315,20 +330,5 @@
]
}
}
],
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-listchannels(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-listoffers.json
View file

@ -84,7 +84,17 @@
}
}
},
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-offer(7)",
"lightning-listoffers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:listoffers#1",
@ -132,15 +142,5 @@
]
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-offer(7)",
"lightning-listoffers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-listpays.json
View file

@ -209,7 +209,18 @@
"The returned array is ordered by increasing **created_at** fields."
]
},
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-pay(7)",
"lightning-paystatus(7)",
"lightning-listsendpays(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:listpays#1",
@ -255,16 +266,5 @@
]
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-pay(7)",
"lightning-paystatus(7)",
"lightning-listsendpays(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-listpeerchannels.json
View file

@ -1388,7 +1388,19 @@
"",
"- -32602: If the given parameters are wrong."
],
"json_example": [
"author": [
"Michael Hawkins <<michael.hawkins@protonmail.com>>."
],
"see_also": [
"lightning-connect(7)",
"lightning-fundchannel_start(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"Lightning RFC site (BOLT #9): ",
"<https://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md>"
],
"examples": [
{
"request": {
"id": "example:listpeerchannels#1",
@ -1591,17 +1603,5 @@
]
}
}
],
"author": [
"Michael Hawkins <<michael.hawkins@protonmail.com>>."
],
"see_also": [
"lightning-connect(7)",
"lightning-fundchannel_start(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"Lightning RFC site (BOLT #9): ",
"<https://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md>"
]
}

28
doc/schemas/lightning-listpeers.json
View file

@ -304,7 +304,20 @@
"",
"- -32602: If the given parameters are wrong."
],
"json_example": [
"author": [
"Michael Hawkins <<michael.hawkins@protonmail.com>>."
],
"see_also": [
"lightning-connect(7)",
"lightning-fundchannel_start(7)",
"lightning-setchannel(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"Lightning RFC site (BOLT #9):",
"<https://github.com/lightning/bolts/blob/master/09-features.md>"
],
"examples": [
{
"request": {
"id": "example:listpeers#1",
@ -347,18 +360,5 @@
]
}
}
],
"author": [
"Michael Hawkins <<michael.hawkins@protonmail.com>>."
],
"see_also": [
"lightning-connect(7)",
"lightning-fundchannel_start(7)",
"lightning-setchannel(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"Lightning RFC site (BOLT #9):",
"<https://github.com/lightning/bolts/blob/master/09-features.md>"
]
}

24
doc/schemas/lightning-listsendpays.json
View file

@ -322,7 +322,18 @@
"Note that the returned array is ordered by increasing *id*."
]
},
"json_example": [
"author": [
"Christian Decker <<decker.christian@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-listpays(7)",
"lightning-sendpay(7)",
"lightning-listinvoices(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:listsendpays#1",
@ -386,16 +397,5 @@
]
}
}
],
"author": [
"Christian Decker <<decker.christian@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-listpays(7)",
"lightning-sendpay(7)",
"lightning-listinvoices(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

20
doc/schemas/lightning-listsqlschemas.json
View file

@ -96,7 +96,16 @@
}
}
},
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-sql(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:listsqlschemas#1",
@ -266,14 +275,5 @@
]
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-sql(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

34
doc/schemas/lightning-listtransactions.json
View file

@ -143,7 +143,23 @@
}
}
},
"json_example": [
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-newaddr(7)",
"lightning-listfunds(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:listtransactions#1",
@ -182,21 +198,5 @@
]
}
}
],
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-newaddr(7)",
"lightning-listfunds(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

14
doc/schemas/lightning-makesecret.json
View file

@ -42,7 +42,13 @@
"",
"- -1: Catchall nonspecific error."
],
"json_example": [
"author": [
"Aditya <<aditya.sharma20111@gmail.com>> is mainly responsible."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:makesecret#1",
@ -68,11 +74,5 @@
"secret": "a9a2e742405c28f059349132923a99337ae7f71168b7485496e3365f5bc664ed"
}
}
],
"author": [
"Aditya <<aditya.sharma20111@gmail.com>> is mainly responsible."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-multifundchannel.json
View file

@ -347,7 +347,19 @@
"}",
"```"
],
"json_example": [
"author": [
"ZmnSCPxj <<ZmnSCPxj@protonmail.com>> is mainly responsible."
],
"see_also": [
"lightning-connect(7)",
"lightning-listfunds()",
"lightning-listpeers(7)",
"lightning-fundchannel(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:multifundchannel#1",
@ -446,17 +458,5 @@
]
}
}
],
"author": [
"ZmnSCPxj <<ZmnSCPxj@protonmail.com>> is mainly responsible."
],
"see_also": [
"lightning-connect(7)",
"lightning-listfunds()",
"lightning-listpeers(7)",
"lightning-fundchannel(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

42
doc/schemas/lightning-multiwithdraw.json
View file

@ -66,7 +66,27 @@
}
}
},
"json_example": [
"errors": [
"On failure, an error is reported and the withdrawal transaction is not created.",
"",
"- -1: Catchall nonspecific error.",
"- 301: There are not enough funds in the internal wallet (including fees) to create the transaction.",
"- 302: The dust limit is not met."
],
"author": [
"ZmnSCPxj <<ZmnSCPxj@protonmail.com>> is mainly responsible."
],
"see_also": [
"lightning-listfunds(7)",
"lightning-fundchannel(7)",
"lightning-newaddr(7)",
"lightning-txprepare(7)",
"lightning-withdraw(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:multiwithdraw#1",
@ -125,25 +145,5 @@
"txid": "062383a7c9a19a2768939087a5c89826a4ea3531080f20cc06aa1cbf431be505"
}
}
],
"errors": [
"On failure, an error is reported and the withdrawal transaction is not created.",
"",
"- -1: Catchall nonspecific error.",
"- 301: There are not enough funds in the internal wallet (including fees) to create the transaction.",
"- 302: The dust limit is not met."
],
"author": [
"ZmnSCPxj <<ZmnSCPxj@protonmail.com>> is mainly responsible."
],
"see_also": [
"lightning-listfunds(7)",
"lightning-fundchannel(7)",
"lightning-newaddr(7)",
"lightning-txprepare(7)",
"lightning-withdraw(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-newaddr.json
View file

@ -49,7 +49,19 @@
"errors": [
"If an unrecognized address type is requested an error message will be returned."
],
"json_example": [
"author": [
"Felix <<fixone@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-listfunds(7)",
"lightning-fundchannel(7)",
"lightning-withdraw(7)",
"lightning-listtransactions(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:newaddr#1",
@ -72,17 +84,5 @@
"bech32": "bcrt1qq8adjz4u6enf0cjey9j8yt0y490tact93fzgsf"
}
}
],
"author": [
"Felix <<fixone@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-listfunds(7)",
"lightning-fundchannel(7)",
"lightning-withdraw(7)",
"lightning-listtransactions(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

14
doc/schemas/lightning-notifications.json
View file

@ -64,7 +64,13 @@
}
}
],
"json_example": [
"author": [
"Rusty Russell <<rusty@blockstream.com>> wrote the initial version of this man page."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:notifications#1",
@ -85,11 +91,5 @@
},
"response": {}
}
],
"author": [
"Rusty Russell <<rusty@blockstream.com>> wrote the initial version of this man page."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-offer.json
View file

@ -166,7 +166,18 @@
"- -1: Catchall nonspecific error.",
"- 1000: Offer with this offer_id already exists (but is not active)."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listoffers(7)",
"lightning-disableoffer(7)",
"lightning-invoicerequest(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:offer#1",
@ -204,16 +215,5 @@
"created": true
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listoffers(7)",
"lightning-disableoffer(7)",
"lightning-invoicerequest(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

32
doc/schemas/lightning-openchannel_abort.json
View file

@ -56,22 +56,6 @@
"- 311: Unknown channel id.",
"- 312: Channel in an invalid state"
],
"json_example": [
{
"request": {
"id": "example:openchannel_abort#1",
"method": "openchannel_abort",
"params": {
"channel_id": "aec3dfd0c7643a23b679cd2e493c053f8fdf621ff2624949f9582c4118b818c6"
}
},
"response": {
"channel_id": "aec3dfd0c7643a23b679cd2e493c053f8fdf621ff2624949f9582c4118b818c6",
"channel_canceled": true,
"reason": "Abort requested"
}
}
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
@ -89,5 +73,21 @@
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:openchannel_abort#1",
"method": "openchannel_abort",
"params": {
"channel_id": "aec3dfd0c7643a23b679cd2e493c053f8fdf621ff2624949f9582c4118b818c6"
}
},
"response": {
"channel_id": "aec3dfd0c7643a23b679cd2e493c053f8fdf621ff2624949f9582c4118b818c6",
"channel_canceled": true,
"reason": "Abort requested"
}
}
]
}

66
doc/schemas/lightning-openchannel_init.json
View file

@ -180,7 +180,39 @@
"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."
]
},
"json_example": [
"errors": [
"On error the returned object will contain `code` and `message` properties, with `code` being one of the following:",
"",
"- -32602: If the given parameters are wrong.",
"- -1: Catchall nonspecific error.",
"- 300: The amount exceeded the maximum configured funding amount.",
"- 301: The provided PSBT cannot afford the funding amount.",
"- 304: Still syncing with bitcoin network",
"- 305: Peer is not connected.",
"- 306: Unknown peer id.",
"- 309: PSBT missing required fields",
"- 310: v2 channel open protocol not supported by peer",
"- 312: Channel in an invalid state"
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-openchannel_update(7)",
"lightning-openchannel_signed(7)",
"lightning-openchannel_abort(7)",
"lightning-openchannel_bump(7)",
"lightning-fundchannel_start(7)",
"lightning-fundchannel_complete(7)",
"lightning-fundchannel(7)",
"lightning-fundpsbt(7)",
"lightning-utxopsbt(7)",
"lightning-multifundchannel(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:openchannel_init#1",
@ -241,37 +273,5 @@
"requires_confirmed_inputs": false
}
}
],
"errors": [
"On error the returned object will contain `code` and `message` properties, with `code` being one of the following:",
"",
"- -32602: If the given parameters are wrong.",
"- -1: Catchall nonspecific error.",
"- 300: The amount exceeded the maximum configured funding amount.",
"- 301: The provided PSBT cannot afford the funding amount.",
"- 304: Still syncing with bitcoin network",
"- 305: Peer is not connected.",
"- 306: Unknown peer id.",
"- 309: PSBT missing required fields",
"- 310: v2 channel open protocol not supported by peer",
"- 312: Channel in an invalid state"
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-openchannel_update(7)",
"lightning-openchannel_signed(7)",
"lightning-openchannel_abort(7)",
"lightning-openchannel_bump(7)",
"lightning-fundchannel_start(7)",
"lightning-fundchannel_complete(7)",
"lightning-fundchannel(7)",
"lightning-fundpsbt(7)",
"lightning-utxopsbt(7)",
"lightning-multifundchannel(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

38
doc/schemas/lightning-openchannel_update.json
View file

@ -185,7 +185,25 @@
"- 311: Unknown channel id.",
"- 312: Channel in an invalid state"
],
"json_example": [
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-openchannel_init(7)",
"lightning-openchannel_signed(7)",
"lightning-openchannel_bump(7)",
"lightning-openchannel_abort(7)",
"lightning-fundchannel_start(7)",
"lightning-fundchannel_complete(7)",
"lightning-fundchannel(7)",
"lightning-fundpsbt(7)",
"lightning-utxopsbt(7)",
"lightning-multifundchannel(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:openchannel_update#1",
@ -239,23 +257,5 @@
"close_to": "5120eed745804da9784cc203f563efa99ffa54fdf01b137bc964e63c3124070ffbe6"
}
}
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-openchannel_init(7)",
"lightning-openchannel_signed(7)",
"lightning-openchannel_bump(7)",
"lightning-openchannel_abort(7)",
"lightning-fundchannel_start(7)",
"lightning-fundchannel_complete(7)",
"lightning-fundchannel(7)",
"lightning-fundpsbt(7)",
"lightning-utxopsbt(7)",
"lightning-multifundchannel(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

24
doc/schemas/lightning-parsefeerate.json
View file

@ -32,7 +32,18 @@
}
}
},
"json_example": [
"errors": [
"The **parsefeerate** command will error if the *feerate_str* format is not recognized.",
"",
"- -32602: If the given parameters are wrong."
],
"trivia": [
"In CLN 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\"."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:parsefeerate#1",
@ -81,16 +92,5 @@
"perkw": 11000
}
}
],
"errors": [
"The **parsefeerate** command will error if the *feerate_str* format is not recognized.",
"",
"- -32602: If the given parameters are wrong."
],
"trivia": [
"In CLN 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\"."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

30
doc/schemas/lightning-pay.json
View file

@ -223,7 +223,21 @@
"",
"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."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listpays(7)",
"lightning-decodepay(7)",
"lightning-listinvoices(7)",
"lightning-delinvoice(7)",
"lightning-getroute(7)",
"lightning-invoice(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:pay#1",
@ -243,19 +257,5 @@
"status": "complete"
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listpays(7)",
"lightning-decodepay(7)",
"lightning-listinvoices(7)",
"lightning-delinvoice(7)",
"lightning-getroute(7)",
"lightning-invoice(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

32
doc/schemas/lightning-ping.json
View file

@ -47,7 +47,22 @@
}
}
},
"json_example": [
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters or we're already waiting for a ping response from peer."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-connect(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:ping#1",
@ -75,20 +90,5 @@
"totlen": 0
}
}
],
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters or we're already waiting for a ping response from peer."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-connect(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

28
doc/schemas/lightning-plugin.json
View file

@ -172,7 +172,20 @@
"errors": [
"On error, the reason why the action could not be taken upon the plugin is returned."
],
"json_example": [
"author": [
"Antoine Poinsot <<darosior@protonmail.com>> is mainly responsible."
],
"see_also": [
"lightning-cli(1)",
"lightning-listconfigs(1)",
"[writing plugins][writing plugins]"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"",
"[writing plugins]: PLUGINS.md"
],
"examples": [
{
"request": {
"id": "example:plugin#1",
@ -276,18 +289,5 @@
"result": "Successfully stopped fail_htlcs.py."
}
}
],
"author": [
"Antoine Poinsot <<darosior@protonmail.com>> is mainly responsible."
],
"see_also": [
"lightning-cli(1)",
"lightning-listconfigs(1)",
"[writing plugins][writing plugins]"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"",
"[writing plugins]: PLUGINS.md"
]
}

20
doc/schemas/lightning-recover.json
View file

@ -38,7 +38,16 @@
}
}
},
"json_example": [
"author": [
"Rusty Russell <<rusty@blockstream.com>> is mainly responsible."
],
"see_also": [
"lightning-hsmtool(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:recover#1",
@ -61,14 +70,5 @@
"result": "Recovery restart in progress"
}
}
],
"author": [
"Rusty Russell <<rusty@blockstream.com>> is mainly responsible."
],
"see_also": [
"lightning-hsmtool(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

20
doc/schemas/lightning-recoverchannel.json
View file

@ -41,7 +41,16 @@
}
}
},
"json_example": [
"author": [
"Aditya <<aditya.sharma20111@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-getsharedsecret(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:recoverchannel#1",
@ -58,14 +67,5 @@
]
}
}
],
"author": [
"Aditya <<aditya.sharma20111@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-getsharedsecret(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

28
doc/schemas/lightning-renepay.json
View file

@ -161,7 +161,20 @@
"- 210: Payment timed out without a payment in progress.",
"- 212: Invoice is invalid."
],
"json_example": [
"author": [
"Eduardo Quintana-Miranda <<eduardo.quintana@pm.me>> is mainly responsible."
],
"see_also": [
"lightning-renepaystatus(7)",
"lightning-listpays(7)",
"lightning-invoice(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"",
"Pickhardt R. and Richter S., *Optimally Reliable & Cheap Payment Flows on the Lightning Network* <https://arxiv.org/abs/2107.05322>"
],
"examples": [
{
"request": {
"id": "example:renepay#1",
@ -201,18 +214,5 @@
"destination": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59"
}
}
],
"author": [
"Eduardo Quintana-Miranda <<eduardo.quintana@pm.me>> is mainly responsible."
],
"see_also": [
"lightning-renepaystatus(7)",
"lightning-listpays(7)",
"lightning-invoice(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"",
"Pickhardt R. and Richter S., *Optimally Reliable & Cheap Payment Flows on the Lightning Network* <https://arxiv.org/abs/2107.05322>"
]
}

24
doc/schemas/lightning-reserveinputs.json
View file

@ -95,7 +95,18 @@
"",
"- -32602: Invalid parameter, such as specifying a spent/reserved input in *psbt*."
],
"json_example": [
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-unreserveinputs(7)",
"lightning-signpsbt(7)",
"lightning-sendpsbt(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:reserveinputs#1",
@ -214,16 +225,5 @@
]
}
}
],
"author": [
"Lisa Neigut <<niftynei@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-unreserveinputs(7)",
"lightning-signpsbt(7)",
"lightning-sendpsbt(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-sendcustommsg.json
View file

@ -48,7 +48,17 @@
"If any of the above limitations is not respected the method returns an explicit error message stating the issue."
]
},
"json_example": [
"author": [
"Christian Decker <<decker.christian@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-createonion(7)",
"lightning-sendonion(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:sendcustommsg#5",
@ -62,15 +72,5 @@
"status": "Message sent to connectd for delivery"
}
}
],
"author": [
"Christian Decker <<decker.christian@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-createonion(7)",
"lightning-sendonion(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

20
doc/schemas/lightning-sendinvoice.json
View file

@ -191,7 +191,16 @@
"- 1004: The node making the offer returned an error message.",
"- 1005: We timed out waiting for the invoice to be paid"
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-fetchinvoice(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:sendinvoice#1",
@ -217,14 +226,5 @@
"updated_index": 1
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-fetchinvoice(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

28
doc/schemas/lightning-sendonion.json
View file

@ -312,7 +312,20 @@
"",
"the error details are decrypted and presented here, if *shared_secrets* was provided and an error was returned by one of the intermediate nodes"
],
"json_example": [
"author": [
"Christian Decker <<decker.christian@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-createonion(7)",
"lightning-sendpay(7)",
"lightning-listsendpays(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"",
"[bolt04]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md"
],
"examples": [
{
"request": {
"id": "example:sendonion#1",
@ -341,18 +354,5 @@
"status": "pending"
}
}
],
"author": [
"Christian Decker <<decker.christian@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-createonion(7)",
"lightning-sendpay(7)",
"lightning-listsendpays(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"",
"[bolt04]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md"
]
}

30
doc/schemas/lightning-sendpay.json
View file

@ -336,7 +336,21 @@
"*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."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listinvoices(7)",
"lightning-delinvoice(7)",
"lightning-getroute(7)",
"lightning-invoice(7)",
"lightning-pay(7)",
"lightning-waitsendpay(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:sendpay#1",
@ -417,19 +431,5 @@
"status": "pending"
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-listinvoices(7)",
"lightning-delinvoice(7)",
"lightning-getroute(7)",
"lightning-invoice(7)",
"lightning-pay(7)",
"lightning-waitsendpay(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

36
doc/schemas/lightning-sendpsbt.json
View file

@ -47,7 +47,24 @@
}
}
},
"json_example": [
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters or some error happened during the command process."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-fundpsbt(7)",
"lightning-signpsbt(7)",
"lightning-listtransactions(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:sendpsbt#1",
@ -74,22 +91,5 @@
"txid": "43bb1c1bce6763ffe4d5df6b49f152f907f36f7849e55bb56075e2b256d17502"
}
}
],
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -32602: Error in given parameters or some error happened during the command process."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-fundpsbt(7)",
"lightning-signpsbt(7)",
"lightning-listtransactions(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

26
doc/schemas/lightning-setchannel.json
View file

@ -157,7 +157,19 @@
"- -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."
],
"json_example": [
"author": [
"Michael Schmoock <<michael@schmoock.net>> is the author of this feature."
],
"see_also": [
"lightningd-config(5)",
"lightning-fundchannel(7)",
"lightning-listchannels(7)",
"lightning-listpeers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:setchannel#1",
@ -208,17 +220,5 @@
]
}
}
],
"author": [
"Michael Schmoock <<michael@schmoock.net>> is the author of this feature."
],
"see_also": [
"lightningd-config(5)",
"lightning-fundchannel(7)",
"lightning-listchannels(7)",
"lightning-listpeers(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-setconfig.json
View file

@ -124,7 +124,17 @@
"",
"- -32602: JSONRPC2_INVALID_PARAMS, i.e. the parameter is not dynamic, or the val was invalid."
],
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible for this feature."
],
"see_also": [
"lightningd-config(5)",
"lightning-listconfigs(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:setconfig#1",
@ -181,15 +191,5 @@
}
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible for this feature."
],
"see_also": [
"lightningd-config(5)",
"lightning-listconfigs(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

34
doc/schemas/lightning-setpsbtversion.json
View file

@ -40,7 +40,23 @@
}
}
},
"json_example": [
"errors": [
"The following error codes may occur:",
"",
"- -32602: Parameter missed or malformed."
],
"author": [
"Gregory Sanders <<gsanders87@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-fundpsbt(7)",
"lightning-utxopsbt(7)",
"lightning-signpsbt(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:setpsbtversion#1",
@ -67,21 +83,5 @@
"psbt": "cHNidP8BADUCAAAAAAFAQg8AAAAAACJRIJd6ICNAQALFOMhoUHuSVSuzcaUdkDKlk4K+A+DR9+4ubwAAAAAA"
}
}
],
"errors": [
"The following error codes may occur:",
"",
"- -32602: Parameter missed or malformed."
],
"author": [
"Gregory Sanders <<gsanders87@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-fundpsbt(7)",
"lightning-utxopsbt(7)",
"lightning-signpsbt(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-showrunes.json
View file

@ -154,7 +154,17 @@
}
}
},
"json_example": [
"author": [
"Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible."
],
"see_also": [
"lightning-commando-showrunes(7)",
"lightning-blacklistrune(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:showrunes#1",
@ -227,15 +237,5 @@
]
}
}
],
"author": [
"Shahana Farooqui <<sfarooqui@blockstream.com>> is mainly responsible."
],
"see_also": [
"lightning-commando-showrunes(7)",
"lightning-blacklistrune(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

28
doc/schemas/lightning-signinvoice.json
View file

@ -39,20 +39,6 @@
"",
"- -1: Catchall nonspecific error."
],
"json_example": [
{
"request": {
"id": "example:signinvoice#1",
"method": "signinvoice",
"params": [
"lnbcrt10n1pjmxt3lsp5jumuz2sv3ca68kzd92hp3wdtpx8ghnxur65fs6maw6dyxsleqd0spp5nadvvh7uzk2qzh8d9d7tsxr08l9uaz2vjeuuahqtufjv52d0eassdq8d9h8vvgxqyjw5qcqp99qxpqysgq4rrn702eum6c9ld9khlz39vdyd8zcwrav5ygqvu6w54aep6yarkyfrnk990yf5prpasgzmj52stektf6mzwdl5hc6qlsglt2a0pwp0spwww44w"
]
},
"response": {
"bolt11": "lnbcrt10n1pjmxt3lsp5jumuz2sv3ca68kzd92hp3wdtpx8ghnxur65fs6maw6dyxsleqd0spp5nadvvh7uzk2qzh8d9d7tsxr08l9uaz2vjeuuahqtufjv52d0eassdq8d9h8vvgxqyjw5qcqp99qxpqysgq3nhrd72qe7wmc2hvwhaqnx05y6dzxh2tal02kw055er7uutkkrcreccm37ce6wv7ee8q70ktlr9fy3fd635hc2k98a4svd9c8v4cpjsppm2eee"
}
}
],
"author": [
"Carl Dong <<contact@carldong.me>> is mainly responsible."
],
@ -67,5 +53,19 @@
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:signinvoice#1",
"method": "signinvoice",
"params": [
"lnbcrt10n1pjmxt3lsp5jumuz2sv3ca68kzd92hp3wdtpx8ghnxur65fs6maw6dyxsleqd0spp5nadvvh7uzk2qzh8d9d7tsxr08l9uaz2vjeuuahqtufjv52d0eassdq8d9h8vvgxqyjw5qcqp99qxpqysgq4rrn702eum6c9ld9khlz39vdyd8zcwrav5ygqvu6w54aep6yarkyfrnk990yf5prpasgzmj52stektf6mzwdl5hc6qlsglt2a0pwp0spwww44w"
]
},
"response": {
"bolt11": "lnbcrt10n1pjmxt3lsp5jumuz2sv3ca68kzd92hp3wdtpx8ghnxur65fs6maw6dyxsleqd0spp5nadvvh7uzk2qzh8d9d7tsxr08l9uaz2vjeuuahqtufjv52d0eassdq8d9h8vvgxqyjw5qcqp99qxpqysgq3nhrd72qe7wmc2hvwhaqnx05y6dzxh2tal02kw055er7uutkkrcreccm37ce6wv7ee8q70ktlr9fy3fd635hc2k98a4svd9c8v4cpjsppm2eee"
}
}
]
}

24
doc/schemas/lightning-signmessage.json
View file

@ -51,7 +51,18 @@
}
}
},
"json_example": [
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-checkmessage(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"",
"[SignMessageRequest](https://api.lightning.community/#grpc-request-signmessagerequest)"
],
"examples": [
{
"request": {
"id": "example:signmessage#1",
@ -80,16 +91,5 @@
"zbase": "d6naeqabbxntxc3qim98ye3qftnmsstijt4prebd1nztsj3qjticrqsd9f9kca6as1etpmmcfwrykfpw8xg9d41x8dg5dnzo7zhnb8ga"
}
}
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"see_also": [
"lightning-checkmessage(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>",
"",
"[SignMessageRequest](https://api.lightning.community/#grpc-request-signmessagerequest)"
]
}

34
doc/schemas/lightning-signpsbt.json
View file

@ -46,7 +46,23 @@
}
}
},
"json_example": [
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -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."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-fundpsbt(7)",
"lightning-sendpsbt(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:signpsbt#1",
@ -74,21 +90,5 @@
"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"
}
}
],
"errors": [
"On failure, one of the following error codes may be returned:",
"",
"- -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."
],
"author": [
"Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
"but many others did the hard work of actually implementing this rpc command."
],
"see_also": [
"lightning-fundpsbt(7)",
"lightning-sendpsbt(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-splice_init.json
View file

@ -109,7 +109,17 @@
"lightning-cli splice_signed $CHANNEL_ID $PSBT",
"```"
],
"json_example": [
"author": [
"Dusty <<@dusty_daemon>> is mainly responsible."
],
"see_also": [
"lightning-splice_signed(7)",
"lightning-splice_update(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:splice_init#1",
@ -138,15 +148,5 @@
"psbt": "cHNidP8BAgQCAAAAAQMEbAAAAAEEAQEBBQECAQYBAwH7BAIAAAAAAQD2AgAAAAABARzi7RBt64yrfqRL2p+KiUw8cYtiKICRFHmp/4eCSemSAQAAAAD9////AkBCDwAAAAAAIgAgW4zTuRTPZ83Y+mJzyTA1PdNkdnNPvZYhAsLfU7kIgM0BLw8AAAAAACJRIGP/7k6n1R5srfkIbihqJSeSKqoluMU66/MvoyoKYn9aAkcwRAIgTCjR9L+TfzP7pLJVVto5egTRbRNj/RaBhyrA3UW0aEcCIAJO5FZjXvdpRcGR949C4DnfHs3soklTjn/1upkia+TgASED10VEXJNiZl8i4NlunnZvJz8yYN6jnIp2v6Bd0mhN3M9mAAAAAQErQEIPAAAAAAAiACBbjNO5FM9nzdj6YnPJMDU902R2c0+9liECwt9TuQiAzQEFR1IhAjJCZt6EA7OrFXoJ8feE1YevYYMcmYwVG8whu3TCsjFLIQLjvTgAmGbJ2o7EqpnMTqnGwN1G3xXGHvDOHycSkXFOV1KuAQ4gpAu0QtqwIxtR2PhC2VqtVIqjXh0TxM/PKZc0T4BUU6EBDwQAAAAAARAEAAAAAAz8CWxpZ2h0bmluZwEIn2Ac8fyFEJwAAQMIAAAAAAAAAAABBCIAIFuM07kUz2fN2Ppic8kwNT3TZHZzT72WIQLC31O5CIDNDPwJbGlnaHRuaW5nAQgu7JK9IpBWOAABAwighgEAAAAAAAEEIlEgeDY1X9yKgtxMsAp3LFVUFR0GOEpN1l6NP2isCFZrhL4M/AlsaWdodG5pbmcBCOZ1GpRwbKfuAA=="
}
}
],
"author": [
"Dusty <<@dusty_daemon>> is mainly responsible."
],
"see_also": [
"lightning-splice_signed(7)",
"lightning-splice_update(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

22
doc/schemas/lightning-splice_signed.json
View file

@ -98,7 +98,17 @@
"lightning-cli splice_signed $CHANNEL_ID $PSBT",
"```"
],
"json_example": [
"author": [
"Dusty <<@dusty_daemon>> is mainly responsible."
],
"see_also": [
"lightning-splice_init(7)",
"lightning-splice_update(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:splice_signed#1",
@ -113,15 +123,5 @@
"txid": "f00d5e230b401274c88d3e6205e2c6117028cb9878b7d2bc52b1441f0b589427"
}
}
],
"author": [
"Dusty <<@dusty_daemon>> is mainly responsible."
],
"see_also": [
"lightning-splice_init(7)",
"lightning-splice_update(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}

Some files were not shown because too many files have changed in this diff Show more