mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity
4c370022d0
core-lightning/doc/lightning-sendonion.7.md
ShahanaFarooqui b0da807700 doc: Markdown cleanup 
This commit will remove parameter descriptions from RPC markdown but we will fix it in next commits by reading these descriptions directly from json.

- Removing parameter description text
- Adding/removing newlines for cleaner formatting
- Adding ERRORS title wherever needed
- Updating titles for consistency
- Adding resources links
2024-03-19 14:58:59 +10:30

3.3 KiB
Raw Blame History

lightning-sendonion -- Send a payment with a custom onion packet

SYNOPSIS

sendonion onion first_hop payment_hash [label] [shared_secrets] [partid] [bolt11] [amount_msat] [destination]

DESCRIPTION

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:

[
	"298606954e9de3e9d938d18a74fed794c440e8eda82e52dc08600953c8acf9c4",
	"2dc094de72adb03b90894192edf9f67919cb2691b37b1f7d4a2f4f31c108b087",
	"a7b82b240dbd77a4ac8ea07709b1395d8c510c73c17b4b392bb1f0605d989c85"
]

RETURN VALUE

On success, an object is returned, containing:

  • created_index (u64): 1-based index indicating order this payment was created in (added v23.11)
  • id (u64): old synonym for created_index
  • payment_hash (hash): the hash of the payment_preimage which will prove payment
  • status (string): status of the payment (could be complete if already sent previously) (one of "pending", "complete")
  • created_at (u64): the UNIX timestamp showing when this payment was initiated
  • amount_sent_msat (msat): The amount sent
  • amount_msat (msat, optional): The amount delivered to destination (if known)
  • destination (pubkey, optional): the final destination of the payment if known
  • label (string, optional): the label, if given to sendpay
  • bolt11 (string, optional): the bolt11 string (if supplied)
  • bolt12 (string, optional): the bolt12 string (if supplied: experimental-offers only).
  • partid (u64, optional): the partid (if supplied) to sendonion/sendpay

If status is "complete":

  • payment_preimage (secret): the proof of payment: SHA256 of this payment_hash
  • updated_index (u64, optional): 1-based index indicating order this payment was changed (added v23.11)

If status is "pending":

  • message (string, optional): Monitor status with listpays or waitsendpay

ERRORS

The following error codes may occur:

  • 202: an parseable onion
  • the error details are decrypted and presented here, if shared_secrets was provided and an error was returned by one of the intermediate nodes

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