davide/palladum-lightning
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

doc: recommend injectpaymentonion in place of sendonion.

Browse Source 
Among other things, injectpaymentonion insists on knowing the destination
amount_msat.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell
2025-06-30 11:36:18 +09:30
committed by Sangbida Chaudhuri
parent 89f411ca79
commit c50bd381ec
2 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
contrib/msggen/msggen/schema.json
View File

@@ -29732,6 +29732,7 @@
"rpc": "sendonion",
"title": "Send a payment with a custom onion packet",
"description": [
"Note: you probably want to use the more modern and flexible `injectpaymentonion` command instead of this.",
"The **sendonion** RPC command can be used to initiate a payment attempt with a custom onion packet. The onion packet is used to deliver instructions for hops along the route on how to behave. Normally these instructions are indications on where to forward a payment and what parameters to use, or contain details of the payment for the final hop. However, it is possible to add arbitrary information for hops in the custom onion, allowing for custom extensions that are not directly supported by Core Lightning.",
"",
"If the first element of *route* does not have \"channel\" set, a suitable channel (if any) will be chosen, otherwise that specific short-channel-id is used. The following is an example of a 3 hop onion:",
@@ -30057,6 +30058,7 @@
"Christian Decker <<decker.christian@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-injectpaymentonion(7)",
"lightning-createonion(7)",
"lightning-sendpay(7)",
"lightning-listsendpays(7)"

2
doc/schemas/sendonion.json
View File

@@ -4,6 +4,7 @@
"rpc": "sendonion",
"title": "Send a payment with a custom onion packet",
"description": [
"Note: you probably want to use the more modern and flexible `injectpaymentonion` command instead of this.",
"The **sendonion** RPC command can be used to initiate a payment attempt with a custom onion packet. The onion packet is used to deliver instructions for hops along the route on how to behave. Normally these instructions are indications on where to forward a payment and what parameters to use, or contain details of the payment for the final hop. However, it is possible to add arbitrary information for hops in the custom onion, allowing for custom extensions that are not directly supported by Core Lightning.",
"",
"If the first element of *route* does not have \"channel\" set, a suitable channel (if any) will be chosen, otherwise that specific short-channel-id is used. The following is an example of a 3 hop onion:",
@@ -329,6 +330,7 @@
"Christian Decker <<decker.christian@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-injectpaymentonion(7)",
"lightning-createonion(7)",
"lightning-sendpay(7)",
"lightning-listsendpays(7)"