paid-services 10.0.0 → 10.1.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## Version 10.1.0
+
+- `createSupportOffer`: Add `introduction` to start the created offer path at
+    a connected peer, for a node that is connected only by private channels
+- `getOfferInvoice`: Check the offer before deriving the payer key, so that a
+    refused offer does not use up a payer key index
+- `payOfferInvoice`: Refuse invoices that require multi-part payment
+
 ## Version 10.0.0
 
 - `getOfferInvoice`: Add `features` to show the features of the invoice

package/offers/get_offer_invoice.js

@@ -4,6 +4,7 @@ const {createSignedInvoiceRequest} = require('invoices');
 const {getNetwork} = require('ln-sync');
 const {getPeers} = require('ln-service');
 const {getPublicKey} = require('ln-service');
+const {pointFromScalar} = require('tiny-secp256k1');
 const {returnResult} = require('asyncjs-util');
 const {signBytes} = require('ln-service');
 
@@ -14,8 +15,10 @@ const requestOfferInvoice = require('./request_offer_invoice');
 const {resolvePathIntroductions} = require('./../network');
 
 const {isSafeInteger} = Number;
+const bufferAsHex = buffer => Buffer.from(buffer).toString('hex');
 const defaultTimeoutMs = 30000;
 const isTimeout = n => isSafeInteger(n) && n > 0;
+const placeholderPayerId = bufferAsHex(pointFromScalar(Buffer.alloc(32, 1)));
 const typeSchnorr = 'schnorr';
 
 /** Get an invoice for a BOLT 12 offer
@@ -30,9 +33,10 @@ const typeSchnorr = 'schnorr';
   request sent to its issuer id.
 
   The request is signed by the `payer_id`, a new key that LND derives in key
-  family 808 at `payer_key_index`. Keep the index to be able to prove, with
-  the key derived again from the seed, that the request and the payment of
-  its invoice were made by the payer.
+  family 808 at `payer_key_index`, only once the request is known to be one
+  that can be made, so that a refused request uses no index. Keep the index
+  to be able to prove, with the key derived again from the seed, that the
+  request and the payment of its invoice were made by the payer.
 
   {
     [bip353_name]: <BIP 353 Human Readable Name Offer Was Found With String>
@@ -98,12 +102,48 @@ module.exports = (args, cbk) => {
       // Get the connected peers to start the reply path at one of them
       getPeers: ['validate', ({}, cbk) => getPeers({lnd: args.lnd}, cbk)],
 
+      // Make the request with a placeholder payer id, to check that it can be
+      // made before a payer key is derived for it
+      checkRequest: ['getNetwork', ({getNetwork}, cbk) => {
+        try {
+          return cbk(null, invoiceRequestForOffer({
+            bip353_name: args.bip353_name,
+            mtokens: args.mtokens,
+            network: getNetwork.bitcoinjs,
+            offer: args.offer,
+            payer_id: placeholderPayerId,
+            payer_note: args.payer_note,
+          }));
+        } catch (err) {
+          return cbk([400, err.message]);
+        }
+      }],
+
+      // Find the introduction node of each offer path, to not reply from it
+      getPaths: ['checkRequest', ({checkRequest}, cbk) => {
+        return resolvePathIntroductions({
+          lnd: args.lnd,
+          paths: checkRequest.paths,
+        },
+        cbk);
+      }],
+
+      // The offer paths to send the request over
+      offerPaths: ['getPaths', ({getPaths}, cbk) => {
+        // Exit early when no path has a known introduction node
+        if (!getPaths.paths.length) {
+          return cbk([503, 'FailedToFindIntroductionNodesOfOfferPaths']);
+        }
+
+        return cbk(null, getPaths.paths);
+      }],
+
       // Get a new derived key for the payer id, to derive again from the seed
-      getPayerKey: ['validate', ({}, cbk) => {
+      getPayerKey: ['offerPaths', ({}, cbk) => {
         return getPublicKey({family: payerKeyFamily, lnd: args.lnd}, cbk);
       }],
 
-      // Make the unsigned invoice request for the offer
+      // Make the unsigned invoice request for the offer with the payer id
       unsigned: [
         'getNetwork',
         'getPayerKey',
@@ -150,25 +190,6 @@ module.exports = (args, cbk) => {
         }
       }],
 
-      // Find the introduction node of each offer path, to not reply from it
-      getPaths: ['unsigned', ({unsigned}, cbk) => {
-        return resolvePathIntroductions({
-          lnd: args.lnd,
-          paths: unsigned.paths,
-        },
-        cbk);
-      }],
-
-      // The offer paths to send the request over
-      offerPaths: ['getPaths', ({getPaths}, cbk) => {
-        // Exit early when no path has a known introduction node
-        if (!getPaths.paths.length) {
-          return cbk([503, 'FailedToFindIntroductionNodesOfOfferPaths']);
-        }
-
-        return cbk(null, getPaths.paths);
-      }],
-
       // Send the request over each path in turn until the recipient answers
       getReplies: [
         'getPeers',

package/offers/pay_offer_invoice.js

@@ -7,13 +7,18 @@ const {returnResult} = require('asyncjs-util');
 
 const {resolvePathIntroductions} = require('./../network');
 
+const hasBit = (features, bit) => !!features.find(n => n.bit === bit);
 const isMtokens = n => typeof n === 'string' && /^\d+$/.test(n);
+const requiredMppBit = 16;
 
 /** Pay a BOLT 12 invoice over its blinded payment paths
 
   The invoice is not checked against an offer. Pay an invoice from
   `getOfferInvoice`, which checks that it is for the offer and amount asked.
 
+  The invoice is paid over one route, so an invoice that requires multi-part
+  payment is not supported.
+
   {
     invoice: <BOLT 12 Invoice String>
     lnd: <Authenticated LND API Object>
@@ -71,6 +76,11 @@ module.exports = (args, cbk) => {
           return cbk([400, 'ExpectedInvoiceForNodeNetworkToPay']);
         }
 
+        // BOLT 12 pays over multiple paths when the invoice requires MPP
+        if (hasBit(details.features, requiredMppBit)) {
+          return cbk([400, 'UnsupportedMultiPartPaymentRequiredToPayInvoice']);
+        }
+
         if (!details.paths.length) {
           return cbk([400, 'ExpectedPaymentPathsInInvoiceToPay']);
         }

package/package.json

@@ -73,5 +73,5 @@
     "integration-tests": "node test/integration",
     "test": "node --experimental-test-coverage --test test/actions/*.js test/balanced/*.js test/client/*.js test/config/*.js test/network/*.js test/offers/*.js test/p2p/*.js test/records/*.js test/respond/*.js test/server/*.js test/service_records/*.js test/swaps/*.js test/services/*.js test/support/*.js test/trades/*.js"
   },
-  "version": "10.0.0"
+  "version": "10.1.0"
 }

package/support/create_support_offer.js

@@ -28,6 +28,7 @@ const bufferAsHex = buffer => Buffer.from(buffer).toString('hex');
 const isHex = n => typeof n === 'string' && /^([0-9a-f]{2})+$/i.test(n);
 const isLimit = n => n === undefined || (isSafeInteger(n) && n > 0);
 const isPathId = n => isHex(n) && n.length / 2 >= minPathIdBytes;
+const isPublicKey = n => typeof n === 'string' && /^[0-9A-F]{66}$/i.test(n);
 const isSequence = n => n === undefined || (isSafeInteger(n) && n >= 0);
 const isServiceId = n => isHex(n) && n.length / 2 === serviceIdBytes;
 
@@ -38,8 +39,12 @@ const isServiceId = n => isHex(n) && n.length / 2 === serviceIdBytes;
 
   The offer has blinded paths to self. Give `paths` made to self, each with
   the `id` given to self in its final hop, at least 16 random bytes kept
-  private, to keep the node private. Otherwise a path that starts at self is
-  created. Keep the offer small, with one path, so that its invoices fit in
+  private, to keep the node private. Otherwise a path is created that starts
+  at a connected `introduction` peer, or at self when none is given. A node
+  with only private channels gives an `introduction` peer that has public
+  channels and relays onion messages, since BOLT 12 requires paths from
+  publicly reachable nodes in the offer of a node connected only by private
+  channels. Keep the offer small, with one path, so that its invoices fit in
   onion messages of the regular size.
 
   The offer has its own issuer id, a derived key that is not linked to the
@@ -63,6 +68,7 @@ const isServiceId = n => isHex(n) && n.length / 2 === serviceIdBytes;
 
   {
     [description]: <Offer Description String>
+    [introduction]: <Introduction Peer Public Key Hex String>
     [issuer]: <Issuer Identifier String>
     [issuer_record]: <Use Issuer Id of Support Record Hex String>
     lnd: <Authenticated LND API Object>
@@ -126,6 +132,15 @@ module.exports = (args, cbk) => {
           return cbk([400, 'ExpectedArrayOfPathsForSupportOffer']);
         }
 
+        if (!!args.introduction && !isPublicKey(args.introduction)) {
+          return cbk([400, 'ExpectedIntroductionPublicKeyForSupportOffer']);
+        }
+
+        // An introduction peer starts a created path, not a given path
+        if (!!args.introduction && !!args.paths) {
+          return cbk([400, 'ExpectedEitherIntroductionPeerOrGivenPaths']);
+        }
+
         if (!!args.suggested_mtokens && !!args.suggested_amounts) {
           return cbk([400, 'ExpectedEitherSuggestedMtokensOrAmounts']);
         }
@@ -275,7 +290,11 @@ module.exports = (args, cbk) => {
           return cbk();
         }
 
-        return createNetworkPath({lnd: args.lnd}, cbk);
+        return createNetworkPath({
+          introduction: args.introduction,
+          lnd: args.lnd,
+        },
+        cbk);
       }],
 
       // Create the offer