lightning 5.16.6 → 5.19.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Versions
 
+## 5.19.0
+
+- `closeChannel`: Add support for `max_tokens_per_vbyte` to set max fee rate
+- `getChainTransactions`: Add `inputs` support for previous outpoints
+- `subscribeToTransactions`: Add `inputs` support for previous outpoints
+
+## 5.18.0
+
+- `signBytes`: Add `type` and support for specifying `schnorr` type signing
+- `verifyBytesSignature`: Add support for verifying Schnorr signatures
+
+## 5.17.0
+
+- `getChannels`: Add support for `is_trusted_funding` and `other_ids`
+- `getClosedChannels`: Add support for `other_ids`
+- `getEphemeralChannelIds`: Add method to get other channel ids
+- `openChannels`: Add support for `is_trusted_funding` for instant opening
+- `subscribeToChannels`: Add support for `is_trusted_funding`, `other_ids`
+- `subscribeToOpenRequests`: Add support for `is_trusted_funding`
+
 ## 5.16.6
 
 - `subscribeToInvoices`: Cancel subscription when there are no event listeners

package/README.md

@@ -156,6 +156,8 @@ variables set:
     channels on the node.
 - [getConnectedWatchtowers](https://github.com/alexbosworth/ln-service#getconnectedwatchtowers):
     List watchtowers that were added
+- [getEphemeralChannelIds](https://github.com/alexbosworth/ln-service#getephemeralchannelids):
+    List other channel ids for channels
 - [getFailedPayments](https://github.com/alexbosworth/ln-service#getfailedpayments): List out
     past payments that failed.
 - [getFeeRates](https://github.com/alexbosworth/ln-service#getfeerates): List routing fee rates

package/bolt00/mtokens_amount.js

@@ -1,3 +1,4 @@
+const isNumber = n => !isNaN(n);
 const tokensAsMtokens = tokens => (BigInt(tokens) * BigInt(1e3)).toString();
 
 /** Derive millitokens from tokens and mtokens
@@ -20,6 +21,10 @@ module.exports = ({mtokens, tokens}) => {
     return {};
   }
 
+  if (!mtokens && !isNumber(tokens)) {
+    throw new Error('ExpectedEitherTokensNumberOrMtokensStringForAmountValue');
+  }
+
   // Exit early when there is only tokens set
   if (!mtokens) {
     return {mtokens: tokensAsMtokens(tokens)};

package/grpc/protos/lightning.proto

@@ -570,6 +570,13 @@ service Lightning {
     */
     rpc SubscribeCustomMessages (SubscribeCustomMessagesRequest)
         returns (stream CustomMessage);
+
+    /* lncli: `listaliases`
+    ListAliases returns the set of all aliases that have ever existed with
+    their confirmed SCID (if it exists) and/or the base SCID (in the case of
+    zero conf).
+    */
+    rpc ListAliases (ListAliasesRequest) returns (ListAliasesResponse);
 }
 
 message SubscribeCustomMessagesRequest {
@@ -686,7 +693,11 @@ message Transaction {
 
     // A label that was optionally set on transaction broadcast.
     string label = 10;
+
+    // PreviousOutpoints/Inputs of this transaction.
+    repeated PreviousOutPoint previous_outpoints = 12;
 }
+
 message GetTransactionsRequest {
     /*
     The height from which to list transactions, inclusive. If this value is
@@ -915,6 +926,14 @@ message ChannelAcceptRequest {
 
     // The commitment type the initiator wishes to use for the proposed channel.
     CommitmentType commitment_type = 14;
+
+    // Whether the initiator wants to open a zero-conf channel via the channel
+    // type.
+    bool wants_zero_conf = 15;
+
+    // Whether the initiator wants to use the scid-alias channel type. This is
+    // separate from the feature bit.
+    bool wants_scid_alias = 16;
 }
 
 message ChannelAcceptResponse {
@@ -975,6 +994,13 @@ message ChannelAcceptResponse {
     The number of confirmations we require before we consider the channel open.
     */
     uint32 min_accept_depth = 10;
+
+    /*
+    Whether the responder wants this to be a zero-conf channel. This will fail
+    if either side does not have the scid-alias feature bit set. The minimum
+    depth field must be zero if this is true.
+    */
+    bool zero_conf = 11;
 }
 
 message ChannelPoint {
@@ -1007,12 +1033,21 @@ message OutPoint {
     uint32 output_index = 3;
 }
 
+message PreviousOutPoint {
+    // The outpoint in format txid:n.
+    string outpoint = 1;
+
+    // Denotes if the outpoint is controlled by the internal wallet.
+    // The flag will only detect p2wkh, np2wkh and p2tr inputs as its own.
+    bool is_our_output = 2;
+}
+
 message LightningAddress {
-    // The identity pubkey of the Lightning node
+    // The identity pubkey of the Lightning node.
     string pubkey = 1;
 
     // The network location of the lightning node, e.g. `69.69.69.69:1337` or
-    // `localhost:10011`
+    // `localhost:10011`.
     string host = 2;
 }
 
@@ -1201,11 +1236,15 @@ message VerifyMessageResponse {
 }
 
 message ConnectPeerRequest {
-    // Lightning address of the peer, in the format `<pubkey>@host`
+    /*
+    Lightning address of the peer to connect to.
+    */
     LightningAddress addr = 1;
 
-    /* If set, the daemon will attempt to persistently connect to the target
-     * peer. Otherwise, the call will be synchronous. */
+    /*
+    If set, the daemon will attempt to persistently connect to the target
+    peer. Otherwise, the call will be synchronous.
+    */
     bool perm = 2;
 
     /*
@@ -1458,6 +1497,18 @@ message Channel {
 
     // List constraints for the remote node.
     ChannelConstraints remote_constraints = 30;
+
+    /*
+    This lists out the set of alias short channel ids that exist for a channel.
+    This may be empty.
+    */
+    repeated uint64 alias_scids = 31;
+
+    // Whether or not this is a zero-conf channel.
+    bool zero_conf = 32;
+
+    // This is the confirmed / on-chain zero-conf SCID.
+    uint64 zero_conf_confirmed_scid = 33;
 }
 
 message ListChannelsRequest {
@@ -1477,6 +1528,22 @@ message ListChannelsResponse {
     repeated Channel channels = 11;
 }
 
+message AliasMap {
+    /*
+    For non-zero-conf channels, this is the confirmed SCID. Otherwise, this is
+    the first assigned "base" alias.
+    */
+    uint64 base_scid = 1;
+
+    // The set of all aliases stored for the base SCID.
+    repeated uint64 aliases = 2;
+}
+message ListAliasesRequest {
+}
+message ListAliasesResponse {
+    repeated AliasMap alias_maps = 1;
+}
+
 enum Initiator {
     INITIATOR_UNKNOWN = 0;
     INITIATOR_LOCAL = 1;
@@ -1541,6 +1608,15 @@ message ChannelCloseSummary {
     Initiator close_initiator = 12;
 
     repeated Resolution resolutions = 13;
+
+    /*
+    This lists out the set of alias short channel ids that existed for the
+    closed channel. This may be empty.
+    */
+    repeated uint64 alias_scids = 14;
+
+    //  The confirmed SCID for a zero-conf channel.
+    uint64 zero_conf_confirmed_scid = 15 [jstype = JS_STRING];
 }
 
 enum ResolutionType {
@@ -1886,6 +1962,11 @@ message CloseChannelRequest {
     // A manual fee rate set in sat/vbyte that should be used when crafting the
     // closure transaction.
     uint64 sat_per_vbyte = 6;
+
+    // The maximum fee rate the closer is willing to pay.
+    //
+    // NOTE: This field is only respected if we're the initiator of the channel.
+    uint64 max_fee_per_vbyte = 7;
 }
 
 message CloseStatusUpdate {
@@ -2097,6 +2178,17 @@ message OpenChannelRequest {
     the remote peer supports explicit channel negotiation.
     */
     CommitmentType commitment_type = 18;
+
+    /*
+    If this is true, then a zero-conf channel open will be attempted.
+    */
+    bool zero_conf = 19;
+
+    /*
+    If this is true, then an option-scid-alias channel-type open will be
+    attempted.
+    */
+    bool scid_alias = 20;
 }
 message OpenStatusUpdate {
     oneof update {
@@ -2550,6 +2642,9 @@ message WalletBalanceResponse {
     // other usage.
     int64 locked_balance = 5;
 
+    // The amount of reserve required.
+    int64 reserved_balance_anchor_chan = 6;
+
     // A mapping of each wallet account's name to its balance.
     map<string, WalletAccountBalance> account_balance = 4;
 }
@@ -3171,6 +3266,7 @@ message Invoice {
     /*
     The hash of the preimage. When using REST, this field must be encoded as
     base64.
+    Note: Output only, don't specify for creating an invoice.
     */
     bytes r_hash = 4;
 
@@ -3188,19 +3284,30 @@ message Invoice {
     */
     int64 value_msat = 23;
 
-    // Whether this invoice has been fulfilled
+    /*
+    Whether this invoice has been fulfilled
+
+    The field is deprecated. Use the state field instead (compare to SETTLED).
+    */
     bool settled = 6 [deprecated = true];
 
-    // When this invoice was created
+    /*
+    When this invoice was created.
+    Note: Output only, don't specify for creating an invoice.
+    */
     int64 creation_date = 7;
 
-    // When this invoice was settled
+    /*
+    When this invoice was settled.
+    Note: Output only, don't specify for creating an invoice.
+    */
     int64 settle_date = 8;
 
     /*
     A bare-bones invoice for a payment within the Lightning Network. With the
     details of the invoice, the sender has all the data necessary to send a
     payment to the recipient.
+    Note: Output only, don't specify for creating an invoice.
     */
     string payment_request = 9;
 
@@ -3235,6 +3342,7 @@ message Invoice {
     this index making it monotonically increasing. Callers to the
     SubscribeInvoices call can use this to instantly get notified of all added
     invoices with an add_index greater than this one.
+    Note: Output only, don't specify for creating an invoice.
     */
     uint64 add_index = 16;
 
@@ -3243,6 +3351,7 @@ message Invoice {
     increment this index making it monotonically increasing. Callers to the
     SubscribeInvoices call can use this to instantly get notified of all
     settled invoices with an settle_index greater than this one.
+    Note: Output only, don't specify for creating an invoice.
     */
     uint64 settle_index = 17;
 
@@ -3256,6 +3365,7 @@ message Invoice {
     was ultimately accepted. Additionally, it's possible that the sender paid
     MORE that was specified in the original invoice. So we'll record that here
     as well.
+    Note: Output only, don't specify for creating an invoice.
     */
     int64 amt_paid_sat = 19;
 
@@ -3266,6 +3376,7 @@ message Invoice {
     amount was ultimately accepted. Additionally, it's possible that the sender
     paid MORE that was specified in the original invoice. So we'll record that
     here as well.
+    Note: Output only, don't specify for creating an invoice.
     */
     int64 amt_paid_msat = 20;
 
@@ -3278,18 +3389,26 @@ message Invoice {
 
     /*
     The state the invoice is in.
+    Note: Output only, don't specify for creating an invoice.
     */
     InvoiceState state = 21;
 
-    // List of HTLCs paying to this invoice [EXPERIMENTAL].
+    /*
+    List of HTLCs paying to this invoice [EXPERIMENTAL].
+    Note: Output only, don't specify for creating an invoice.
+    */
     repeated InvoiceHTLC htlcs = 22;
 
-    // List of features advertised on the invoice.
+    /*
+    List of features advertised on the invoice.
+    Note: Output only, don't specify for creating an invoice.
+    */
     map<uint32, Feature> features = 24;
 
     /*
     Indicates if this invoice was a spontaneous payment that arrived via keysend
     [EXPERIMENTAL].
+    Note: Output only, don't specify for creating an invoice.
     */
     bool is_keysend = 25;
 
@@ -3297,6 +3416,7 @@ message Invoice {
     The payment address of this invoice. This value will be used in MPP
     payments, and also for newer invoices that always require the MPP payload
     for added end-to-end security.
+    Note: Output only, don't specify for creating an invoice.
     */
     bytes payment_addr = 26;
 
@@ -3312,6 +3432,7 @@ message Invoice {
     given set ID. This field is always populated for AMP invoices, and can be
     used along side LookupInvoice to obtain the HTLC information related to a
     given sub-invoice.
+    Note: Output only, don't specify for creating an invoice.
     */
     map<string, AMPInvoiceState> amp_invoice_state = 28;
 }
@@ -4319,6 +4440,14 @@ message RPCMiddlewareRequest {
         the same type, or replaced by an error message.
         */
         RPCMessage response = 6;
+
+        /*
+        This is used to indicate to the client that the server has successfully
+        registered the interceptor. This is only used in the very first message
+        that the server sends to the client after the client sends the server
+        the middleware registration message.
+        */
+        bool reg_complete = 8;
     }
 
     /*
@@ -4356,7 +4485,8 @@ message RPCMessage {
 
     /*
     The full canonical gRPC name of the message type (in the format
-    <rpcpackage>.TypeName, for example lnrpc.GetInfoRequest).
+    <rpcpackage>.TypeName, for example lnrpc.GetInfoRequest). In case of an
+    error being returned from lnd, this simply contains the string "error".
     */
     string type_name = 3;
 
@@ -4365,6 +4495,13 @@ message RPCMessage {
     format.
     */
     bytes serialized = 4;
+
+    /*
+    Indicates that the response from lnd was an error, not a gRPC response. If
+    this is set to true then the type_name contains the string "error" and
+    serialized contains the error string.
+    */
+    bool is_error = 5;
 }
 
 message RPCMiddlewareResponse {
@@ -4441,18 +4578,16 @@ message InterceptFeedback {
     string error = 1;
 
     /*
-    A boolean indicating that the gRPC response should be replaced/overwritten.
-    As its name suggests, this can only be used as a feedback to an intercepted
-    response RPC message and is ignored for feedback on any other message. This
-    boolean is needed because in protobuf an empty message is serialized as a
-    0-length or nil byte slice and we wouldn't be able to distinguish between
+    A boolean indicating that the gRPC message should be replaced/overwritten.
+    This boolean is needed because in protobuf an empty message is serialized as
+    a 0-length or nil byte slice and we wouldn't be able to distinguish between
     an empty replacement message and the "don't replace anything" case.
     */
     bool replace_response = 2;
 
     /*
     If the replace_response field is set to true, this field must contain the
-    binary serialized gRPC response message in the protobuf format.
+    binary serialized gRPC message in the protobuf format.
     */
     bytes replacement_serialized = 3;
 }

package/grpc/protos/signer.proto

@@ -320,7 +320,10 @@ message InputScriptResp {
 }
 
 message SignMessageReq {
-    // The message to be signed.
+    /*
+    The message to be signed. When using REST, this field must be encoded as
+    base64.
+    */
     bytes msg = 1;
 
     // The key locator that identifies which key to use for signing.
@@ -331,9 +334,21 @@ message SignMessageReq {
 
     /*
     Use the compact (pubkey recoverable) format instead of the raw lnwire
-    format.
+    format. This option cannot be used with Schnorr signatures.
     */
     bool compact_sig = 4;
+
+    /*
+    Use Schnorr signature. This option cannot be used with compact format.
+    */
+    bool schnorr_sig = 5;
+
+    /*
+    The optional Taproot tweak bytes to apply to the private key before creating
+    a Schnorr signature. The private key is tweaked as described in BIP-341:
+    privKey + h_tapTweak(internalKey || tapTweak)
+    */
+    bytes schnorr_sig_tap_tweak = 6;
 }
 message SignMessageResp {
     /*
@@ -343,17 +358,28 @@ message SignMessageResp {
 }
 
 message VerifyMessageReq {
-    // The message over which the signature is to be verified.
+    // The message over which the signature is to be verified. When using
+    // REST, this field must be encoded as base64.
     bytes msg = 1;
 
     /*
     The fixed-size LN wire encoded signature to be verified over the given
-    message.
+    message. When using REST, this field must be encoded as base64.
     */
     bytes signature = 2;
 
-    // The public key the signature has to be valid for.
+    /*
+    The public key the signature has to be valid for. When using REST, this
+    field must be encoded as base64. If the is_schnorr_sig option is true, then
+    the public key is expected to be in the 32-byte x-only serialization
+    according to BIP-340.
+    */
     bytes pubkey = 3;
+
+    /*
+    Specifies if the signature is a Schnorr signature.
+    */
+    bool is_schnorr_sig = 4;
 }
 message VerifyMessageResp {
     // Whether the signature was valid over the given message.

package/index.js

@@ -41,6 +41,7 @@ const {getChannelBalance} = require('./lnd_methods');
 const {getChannels} = require('./lnd_methods');
 const {getClosedChannels} = require('./lnd_methods');
 const {getConnectedWatchtowers} = require('./lnd_methods');
+const {getEphemeralChannelIds} = require('./lnd_methods');
 const {getFailedPayments} = require('./lnd_methods');
 const {getFeeRates} = require('./lnd_methods');
 const {getForwardingConfidence} = require('./lnd_methods');
@@ -183,11 +184,12 @@ module.exports = {
   getChainFeeEstimate,
   getChainFeeRate,
   getChainTransactions,
-  getChannelBalance,
   getChannel,
+  getChannelBalance,
   getChannels,
   getClosedChannels,
   getConnectedWatchtowers,
+  getEphemeralChannelIds,
   getFailedPayments,
   getFeeRates,
   getForwardingConfidence,

package/lnd_methods/index.js

@@ -39,6 +39,7 @@ const {getChannelBalance} = require('./offchain');
 const {getChannels} = require('./offchain');
 const {getClosedChannels} = require('./offchain');
 const {getConnectedWatchtowers} = require('./offchain');
+const {getEphemeralChannelIds} = require('./offchain');
 const {getFailedPayments} = require('./offchain');
 const {getFeeRates} = require('./offchain');
 const {getForwardingConfidence} = require('./offchain');
@@ -182,6 +183,7 @@ module.exports = {
   getChannels,
   getClosedChannels,
   getConnectedWatchtowers,
+  getEphemeralChannelIds,
   getFailedPayments,
   getFeeRates,
   getForwardingConfidence,

package/lnd_methods/info/get_network_graph.d.ts

@@ -8,7 +8,7 @@ export type GetNetworkGraphResult = {
     /** Standard Format Channel Id */
     id: string;
     policies: {
-      /** Bae Fee Millitokens */
+      /** Base Fee Millitokens */
       base_fee_mtokens?: string;
       /** CLTV Height Delta */
       cltv_delta?: number;

package/lnd_methods/macaroon/methods.json

@@ -157,6 +157,10 @@
     "methods": ["ListTowers", "Policy", "Stats"],
     "type": "tower_client"
   },
+  "getEphemeralChannelIds": {
+    "method": "ListAliases",
+    "type": "default"
+  },
   "getFailedPayments": {
     "method": "ListPayments",
     "type": "default"

package/lnd_methods/offchain/get_channels.js

@@ -15,6 +15,8 @@ const type = 'default';
   `in_channel`, `in_payment`, `is_forward`, `out_channel`, `out_payment`,
   `payment` are not supported on LND 0.11.1 and below
 
+  `is_trusted_funding` is not supported on LND 0.15.0 and below
+
   {
     [is_active]: <Limit Results To Only Active Channels Bool> // false
     [is_offline]: <Limit Results To Only Offline Channels Bool> // false
@@ -38,6 +40,7 @@ const type = 'default';
       is_opening: <Channel Is Opening Bool>
       is_partner_initiated: <Channel Partner Opened Channel Bool>
       is_private: <Channel Is Private Bool>
+      [is_trusted_funding]: <Funding Output is Trusted Bool>
       local_balance: <Local Balance Tokens Number>
       [local_csv]: <Local CSV Blocks Delay Number>
       [local_dust]: <Local Non-Enforceable Amount Tokens Number>
@@ -46,6 +49,7 @@ const type = 'default';
       [local_max_pending_mtokens]: <Local Maximum Pending Millitokens String>
       [local_min_htlc_mtokens]: <Local Minimum HTLC Millitokens String>
       local_reserve: <Local Reserved Tokens Number>
+      other_ids: [<Other Channel Id String>]
       partner_public_key: <Channel Partner Public Key String>
       past_states: <Total Count of Past Channel States Number>
       pending_payments: [{

package/lnd_methods/offchain/get_closed_channels.js

@@ -17,6 +17,8 @@ const outpointSeparator = ':';
 
   Requires `offchain:read` permission
 
+  `other_ids is not supported on LND 0.15.0 and below
+
   {
     [is_breach_close]: <Only Return Breach Close Channels Bool>
     [is_cooperative_close]: <Only Return Cooperative Close Channels Bool>
@@ -54,6 +56,7 @@ const outpointSeparator = ':';
       [is_partner_closed]: <Channel Was Closed By Channel Peer Bool>
       [is_partner_initiated]: <Channel Was Initiated By Channel Peer Bool>
       is_remote_force_close: <Is Remote Force Close Bool>
+      other_ids: [<Other Channel Id String>]
       partner_public_key: <Partner Public Key Hex String>
       transaction_id: <Channel Funding Transaction Id Hex String>
       transaction_vout: <Channel Funding Output Index Number>
@@ -101,6 +104,10 @@ module.exports = (args, cbk) => {
       // Map channels
       mapChannels: ['getClosedChannels', ({getClosedChannels}, cbk) => {
         return asyncMapSeries(getClosedChannels, (chan, cbk) => {
+          if (!isArray(chan.alias_scids)) {
+            return cbk([503, 'ExpectedArrayOfAliasShortChannelIds']);
+          }
+
           if (!chan.capacity) {
             return cbk([503, 'ExpectedCloseChannelCapacity']);
           }
@@ -133,6 +140,10 @@ module.exports = (args, cbk) => {
             return cbk([503, 'ExpectedFinalTimeLockedBalanceForClosedChan']);
           }
 
+          const otherIds = chan.alias_scids
+            .filter(n => n !== chan.zero_conf_confirmed_scid)
+            .map(number => chanFormat({number}));
+
           const closer = chan.close_initiator;
           const finalTimeLock = Number(chan.time_locked_balance);
           const hasCloseTx = chan.closing_tx_hash !== emptyTxId;
@@ -141,11 +152,14 @@ module.exports = (args, cbk) => {
           let isPartnerClosed;
           let isPartnerInitiated;
           const [txId, vout] = chan.channel_point.split(outpointSeparator);
+          const zeroConfId = chan.zero_conf_confirmed_scid;
 
-          const chanId = !hasId ? null : chanFormat({number: chan.chan_id});
           const closeTxId = !hasCloseTx ? undefined : chan.closing_tx_hash;
           const isLocalCooperativeClose = closer === 'INITIATOR_LOCAL';
           const isRemoteCooperativeClose = closer === 'INITIATOR_REMOTE';
+          const number = !!Number(zeroConfId) ? zeroConfId : chan.chan_id;
+
+          const chanId = !hasId ? null : chanFormat({number});
 
           // Try and determine if the channel was opened by our peer
           if (chan.open_initiator === 'INITIATOR_LOCAL') {
@@ -197,6 +211,7 @@ module.exports = (args, cbk) => {
             is_partner_closed: isPartnerClosed,
             is_partner_initiated: isPartnerInitiated,
             is_remote_force_close: chan.close_type === 'REMOTE_FORCE_CLOSE',
+            other_ids: otherIds.map(n => n.channel),
             partner_public_key: chan.remote_pubkey,
             transaction_id: txId,
             transaction_vout: Number(vout),