aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-22 16:44:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

lightningd: change msatoshi args to amount_msat.

Browse Source 
This is consistent with our output changes, and increases consistency.
It also keeps future sanity checks happy, that we only use JSON msat
helpers with '_msat' fields.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Changed: JSON-RPC: `invoice`, `sendonion`, `sendpay`, `pay`, `keysend`, `fetchinvoice`, `sendinvoice`: `msatoshi` argument is now called `amount_msat` to match other fields.
Changelog-Deprecated: JSON-RPC: `invoice`, `sendonion`, `sendpay`, `pay`, `keysend`, `fetchinvoice`, `sendinvoice` `msatoshi` (use `amount_msat`)
This commit is contained in:
Rusty Russell
2022-06-19 16:50:11 +09:30
parent ca69e293d1
commit cd7e784d6f
25 changed files with 192 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -615,7 +615,7 @@ class LightningRpc(UnixDomainSocketRpc):
"""
return self.call("dev-memleak")
def dev_pay(self, bolt11, msatoshi=None, label=None, riskfactor=None,
def dev_pay(self, bolt11, amount_msat=None, label=None, riskfactor=None,
maxfeepercent=None, retry_for=None,
maxdelay=None, exemptfee=None, use_shadow=True, exclude=None):
"""
@@ -624,7 +624,7 @@ class LightningRpc(UnixDomainSocketRpc):
"""
payload = {
"bolt11": bolt11,
"msatoshi": msatoshi,
"amount_msat": amount_msat,
"label": label,
"riskfactor": riskfactor,
"maxfeepercent": maxfeepercent,
@@ -797,19 +797,26 @@ class LightningRpc(UnixDomainSocketRpc):
res = self.call("listpeers", payload)
return res.get("peers") and res["peers"][0] or None
def getroute(self, node_id, msatoshi, riskfactor, cltv=9, fromid=None,
fuzzpercent=None, exclude=None, maxhops=None):
def getroute(self, node_id, amount_msat=None, riskfactor=None, cltv=9, fromid=None,
fuzzpercent=None, exclude=None, maxhops=None, msatoshi=None):
"""
Show route to {id} for {msatoshi}, using {riskfactor} and optional
Show route to {id} for {amount_msat}, using {riskfactor} and optional
{cltv} (default 9). If specified search from {fromid} otherwise use
this node as source. Randomize the route with up to {fuzzpercent}
(0.0 -> 100.0, default 5.0). {exclude} is an optional array of
scid/direction or node-id to exclude. Limit the number of hops in the
route to {maxhops}.
"""
if msatoshi:
amount_msat = msatoshi
if riskfactor is None:
raise TypeError("getroute() missing 'riskfactor'")
if amount_msat is None:
raise TypeError("getroute() missing 'amount_msat'")
payload = {
"id": node_id,
"msatoshi": msatoshi,
"amount_msat": amount_msat,
"riskfactor": riskfactor,
"cltv": cltv,
"fromid": fromid,
@@ -828,14 +835,22 @@ class LightningRpc(UnixDomainSocketRpc):
}
return self.call("help", payload)
def invoice(self, msatoshi, label, description, expiry=None, fallbacks=None,
preimage=None, exposeprivatechannels=None, cltv=None, deschashonly=None):
def invoice(self, amount_msat=None, label=None, description=None, expiry=None, fallbacks=None,
preimage=None, exposeprivatechannels=None, cltv=None, deschashonly=None, msatoshi=None):
"""
Create an invoice for {msatoshi} with {label} and {description} with
Create an invoice for {amount_msat} with {label} and {description} with
optional {expiry} seconds (default 1 week).
"""
if msatoshi:
amount_msat = msatoshi
if label is None:
raise TypeError("invoice() missing 'label'")
if description is None:
raise TypeError("invoice() missing 'description'")
if amount_msat is None:
raise TypeError("invoice() missing 'amount_msat'")
payload = {
"msatoshi": msatoshi,
"amount_msat": amount_msat,
"label": label,
"description": description,
"expiry": expiry,
@@ -995,18 +1010,21 @@ class LightningRpc(UnixDomainSocketRpc):
"""
return self.call("newaddr", {"addresstype": addresstype})
def pay(self, bolt11, msatoshi=None, label=None, riskfactor=None,
def pay(self, bolt11, amount_msat=None, label=None, riskfactor=None,
maxfeepercent=None, retry_for=None,
maxdelay=None, exemptfee=None, localofferid=None, exclude=None,
maxfee=None, description=None):
maxfee=None, description=None, msatoshi=None):
"""
Send payment specified by {bolt11} with {msatoshi}
Send payment specified by {bolt11} with {amount_msat}
(ignored if {bolt11} has an amount), optional {label}
and {riskfactor} (default 1.0).
"""
# Deprecated usage
if msatoshi:
amount_msat = msatoshi
payload = {
"bolt11": bolt11,
"msatoshi": msatoshi,
"amount_msat": amount_msat,
"label": label,
"riskfactor": riskfactor,
"maxfeepercent": maxfeepercent,
@@ -1132,15 +1150,18 @@ class LightningRpc(UnixDomainSocketRpc):
}
return self.call("plugin", payload)
def sendpay(self, route, payment_hash, label=None, msatoshi=None, bolt11=None, payment_secret=None, partid=None, groupid=None, payment_metadata=None):
def sendpay(self, route, payment_hash, label=None, amount_msat=None, bolt11=None, payment_secret=None, partid=None, groupid=None, payment_metadata=None, msatoshi=None):
"""
Send along {route} in return for preimage of {payment_hash}.
"""
# Deprecated usage
if msatoshi:
amount_msat = msatoshi
payload = {
"route": route,
"payment_hash": payment_hash,
"label": label,
"msatoshi": msatoshi,
"amount_msat": amount_msat,
"bolt11": bolt11,
"payment_secret": payment_secret,
"partid": partid,
@@ -1151,8 +1172,8 @@ class LightningRpc(UnixDomainSocketRpc):
def sendonion(
self, onion, first_hop, payment_hash, label=None,
shared_secrets=None, partid=None, bolt11=None, msatoshi=None,
destination=None
shared_secrets=None, partid=None, bolt11=None, amount_msat=None,
destination=None, msatoshi=None
):
"""Send an outgoing payment using the specified onion.
@@ -1161,6 +1182,9 @@ class LightningRpc(UnixDomainSocketRpc):
internal handling, but not required.
"""
# Deprecated usage
if msatoshi:
amount_msat = msatoshi
payload = {
"onion": onion,
"first_hop": first_hop,
@@ -1169,7 +1193,7 @@ class LightningRpc(UnixDomainSocketRpc):
"shared_secrets": shared_secrets,
"partid": partid,
"bolt11": bolt11,
"msatoshi": msatoshi,
"amount_msat": amount_msat,
"destination": destination,
}
return self.call("sendonion", payload)
@@ -1428,11 +1452,16 @@ class LightningRpc(UnixDomainSocketRpc):
payload.update({k: v for k, v in kwargs.items()})
return self.call("getsharedsecret", payload)
def keysend(self, destination, msatoshi, label=None, maxfeepercent=None,
def keysend(self, destination, amount_msat=None, label=None, maxfeepercent=None,
retry_for=None, maxdelay=None, exemptfee=None,
extratlvs=None):
extratlvs=None, msatoshi=None):
"""
"""
# Deprecated usage
if msatoshi:
amount_msat = msatoshi
if amount_msat is None:
raise TypeError("keysend() missing 'amount_msat'")
if extratlvs is not None and not isinstance(extratlvs, dict):
raise ValueError(
@@ -1441,7 +1470,7 @@ class LightningRpc(UnixDomainSocketRpc):
payload = {
"destination": destination,
"msatoshi": msatoshi,
"amount_msat": amount_msat,
"label": label,
"maxfeepercent": maxfeepercent,
"retry_for": retry_for,