aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-19 15:14:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: document pay localofferid field.

Browse Source 
Fixes: #4665
Reported-by: @shesek
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell
2022-04-02 12:49:05 +10:30
parent 92028ebaee
commit 713cd0540d
2 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
contrib/pyln-client/pyln/client/lightning.py
View File

@@ -997,7 +997,7 @@ class LightningRpc(UnixDomainSocketRpc):
def pay(self, bolt11, msatoshi=None, label=None, riskfactor=None, def pay(self, bolt11, msatoshi=None, label=None, riskfactor=None,
maxfeepercent=None, retry_for=None, maxfeepercent=None, retry_for=None,
maxdelay=None, exemptfee=None, exclude=None): maxdelay=None, exemptfee=None, localofferid=None, exclude=None):
""" """
Send payment specified by {bolt11} with {msatoshi} Send payment specified by {bolt11} with {msatoshi}
(ignored if {bolt11} has an amount), optional {label} (ignored if {bolt11} has an amount), optional {label}
@@ -1012,6 +1012,7 @@ class LightningRpc(UnixDomainSocketRpc):
"retry_for": retry_for, "retry_for": retry_for,
"maxdelay": maxdelay, "maxdelay": maxdelay,
"exemptfee": exemptfee, "exemptfee": exemptfee,
"localofferid": localofferid,
"exclude": exclude, "exclude": exclude,
} }
return self.call("pay", payload) return self.call("pay", payload)

7
doc/lightning-pay.7.md
View File

@@ -6,7 +6,7 @@ SYNOPSIS
**pay** *bolt11* [*msatoshi*] [*label*] [*riskfactor*] **pay** *bolt11* [*msatoshi*] [*label*] [*riskfactor*]
[*maxfeepercent*] [*retry\_for*] [*maxdelay*] [*exemptfee*] [*maxfeepercent*] [*retry\_for*] [*maxdelay*] [*exemptfee*]
[*exclude*] [*localofferid*] [*exclude*]
DESCRIPTION DESCRIPTION
----------- -----------
@@ -32,6 +32,11 @@ leveraged by forwarding nodes. Setting `exemptfee` allows the
`maxfeepercent` check to be skipped on fees that are smaller than `maxfeepercent` check to be skipped on fees that are smaller than
`exemptfee` (default: 5000 millisatoshi). `exemptfee` (default: 5000 millisatoshi).
`localofferid` is used by offers to link a payment attempt to a local
`send_invoice` offer created by lightningd-offerout(7). This ensures
that we only make a single payment for an offer, and that the offer is
marked `used` once paid.
The response will occur when the payment fails or succeeds. Once a The response will occur when the payment fails or succeeds. Once a
payment has succeeded, calls to **pay** with the same *bolt11* will payment has succeeded, calls to **pay** with the same *bolt11* will
succeed immediately. succeed immediately.