mirror/lnd
1
0 Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

routerrpc: modify field orders based on their assigned number

Browse Source 
This commit is a pure refactoring which sorts the fields in
`SendPaymentRequest` so it's easier to see what number to use when
adding a new field.
This commit is contained in:
yyforyongyu committed 2023-11-14 20:26:13 +08:00
1 parent 922130c80e
commit c58454effe
3 files changed
+167 -167
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

lnrpc/routerrpc/router.swagger.json
+29 -29
View File
@@ -1678,11 +1678,6 @@
"format": "int64",
"description": "Number of satoshis to send.\n\nThe fields amt and amt_msat are mutually exclusive."
},
"amt_msat": {
"type": "string",
"format": "int64",
"description": "Number of millisatoshis to send.\n\nThe fields amt and amt_msat are mutually exclusive."
},
"payment_hash": {
"type": "string",
"format": "byte",
@@ -1693,11 +1688,6 @@
"format": "int32",
"description": "The CLTV delta from the current height that should be used to set the\ntimelock for the final hop."
},
"payment_addr": {
"type": "string",
"format": "byte",
"description": "An optional payment addr to be included within the last hop of the route."
},
"payment_request": {
"type": "string",
"description": "A bare-bones invoice for a payment within the Lightning Network. With the\ndetails of the invoice, the sender has all the data necessary to send a\npayment to the recipient. The amount in the payment request may be zero. In\nthat case it is required to set the amt field as well. If no payment request\nis specified, the following fields are required: dest, amt and payment_hash."
@@ -1712,33 +1702,15 @@
"format": "int64",
"description": "The maximum number of satoshis that will be paid as a fee of the payment.\nIf this field is left to the default value of 0, only zero-fee routes will\nbe considered. This usually means single hop routes connecting directly to\nthe destination. To send the payment without a fee limit, use max int here.\n\nThe fields fee_limit_sat and fee_limit_msat are mutually exclusive."
},
"fee_limit_msat": {
"type": "string",
"format": "int64",
"description": "The maximum number of millisatoshis that will be paid as a fee of the\npayment. If this field is left to the default value of 0, only zero-fee\nroutes will be considered. This usually means single hop routes connecting\ndirectly to the destination. To send the payment without a fee limit, use\nmax int here.\n\nThe fields fee_limit_sat and fee_limit_msat are mutually exclusive."
},
"outgoing_chan_id": {
"type": "string",
"format": "uint64",
"description": "Deprecated, use outgoing_chan_ids. The channel id of the channel that must\nbe taken to the first hop. If zero, any channel may be used (unless\noutgoing_chan_ids are set)."
},
"outgoing_chan_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uint64"
},
"description": "The channel ids of the channels are allowed for the first hop. If empty,\nany channel may be used."
},
"last_hop_pubkey": {
"type": "string",
"format": "byte",
"description": "The pubkey of the last hop of the route. If empty, any hop may be used."
},
"cltv_limit": {
"type": "integer",
"format": "int32",
"description": "An optional maximum total time lock for the route. This should not exceed\nlnd's `--max-cltv-expiry` setting. If zero, then the value of\n`--max-cltv-expiry` is enforced."
"description": "An optional maximum total time lock for the route. This should not\nexceed lnd's `--max-cltv-expiry` setting. If zero, then the value of\n`--max-cltv-expiry` is enforced."
},
"route_hints": {
"type": "array",
@@ -1755,6 +1727,21 @@
},
"description": "An optional field that can be used to pass an arbitrary set of TLV records\nto a peer which understands the new records. This can be used to pass\napplication specific data during the payment attempt. Record types are\nrequired to be in the custom range \u003e= 65536. When using REST, the values\nmust be encoded as base64."
},
"amt_msat": {
"type": "string",
"format": "int64",
"description": "Number of millisatoshis to send.\n\nThe fields amt and amt_msat are mutually exclusive."
},
"fee_limit_msat": {
"type": "string",
"format": "int64",
"description": "The maximum number of millisatoshis that will be paid as a fee of the\npayment. If this field is left to the default value of 0, only zero-fee\nroutes will be considered. This usually means single hop routes connecting\ndirectly to the destination. To send the payment without a fee limit, use\nmax int here.\n\nThe fields fee_limit_sat and fee_limit_msat are mutually exclusive."
},
"last_hop_pubkey": {
"type": "string",
"format": "byte",
"description": "The pubkey of the last hop of the route. If empty, any hop may be used."
},
"allow_self_payment": {
"type": "boolean",
"description": "If set, circular payments to self are permitted."
@@ -1775,6 +1762,19 @@
"type": "boolean",
"description": "If set, only the final payment update is streamed back. Intermediate updates\nthat show which htlcs are still in flight are suppressed."
},
"outgoing_chan_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uint64"
},
"description": "The channel ids of the channels are allowed for the first hop. If empty,\nany channel may be used."
},
"payment_addr": {
"type": "string",
"format": "byte",
"description": "An optional payment addr to be included within the last hop of the route."
},
"max_shard_size_msat": {
"type": "string",
"format": "uint64",