paid-services 3.7.0 → 3.10.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Versions
 
+## Version 3.10.0
+
+- `createAnchoredTrade`: Add method to create an anchored open trade
+- `getAnchoredTrade`: Add method to get an anchored open trade
+
+## Version 3.9.1
+
+- `decodeTrade`: Add method to decode a trade-secret
+
+## Version 3.8.0
+
+- `encodeTrade`: Add method to encode a trade-secret
+- `serviceAnchoredTrades`: Add method to serve open trade-secrets
+
 ## Version 3.7.0
 
 - `changeChannelCapacity`: Add support for decreasing funds into a new channel

package/index.js

@@ -1,11 +1,16 @@
 const {changeChannelCapacity} = require('./capacity');
 const {confirmServiceUse} = require('./client');
+const {createAnchoredTrade} = require('./trades');
+const {decodeTrade} = require('./trades');
+const {encodeTrade} = require('./trades');
+const {getAnchoredTrade} = require('./trades');
 const {getServiceSchema} = require('./client');
 const {getServicesList} = require('./client');
 const {makePeerRequest} = require('./p2p');
 const {makeServiceRequest} = require('./client');
 const {manageTrades} = require('./trades');
 const {schema} = require('./services');
+const {serviceAnchoredTrades} = require('./trades');
 const {servicePaidRequests} = require('./server');
 const {servicePeerRequests} = require('./p2p');
 
@@ -14,11 +19,16 @@ const serviceIds = schema.types;
 module.exports = {
   changeChannelCapacity,
   confirmServiceUse,
+  createAnchoredTrade,
+  decodeTrade,
+  encodeTrade,
+  getAnchoredTrade,
   getServiceSchema,
   getServicesList,
   makePeerRequest,
   makeServiceRequest,
   manageTrades,
+  serviceAnchoredTrades,
   serviceIds,
   servicePaidRequests,
   servicePeerRequests,

package/package.json

@@ -12,8 +12,8 @@
     "bolt01": "1.2.3",
     "bolt07": "1.8.0",
     "invoices": "2.0.3",
-    "ln-service": "53.4.0",
-    "ln-sync": "3.6.1"
+    "ln-service": "53.5.0",
+    "ln-sync": "3.7.0"
   },
   "description": "Lightning Paid Services library",
   "devDependencies": {
@@ -37,8 +37,8 @@
     "url": "https://github.com/alexbosworth/paid-services.git"
   },
   "scripts": {
-    "integration-tests": "tap --branches=1 --functions=1 --lines=1 --statements=1 -t 180 test/integration/*.js",
+    "integration-tests": "tap -j 2 --branches=1 --functions=1 --lines=1 --statements=1 -t 180 test/integration/*.js",
     "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 -t 60 test/actions/*.js test/capacity/*.js test/client/*.js test/config/*.js test/p2p/*.js test/records/*.js test/respond/*.js test/server/*.js test/server/*.js test/services/*.js test/trades/*.js"
   },
-  "version": "3.7.0"
+  "version": "3.10.0"
 }

package/trades/create_anchored_trade.js

@@ -0,0 +1,86 @@
+const asyncAuto = require('async/auto');
+const {createInvoice} = require('ln-service');
+const {returnResult} = require('asyncjs-util');
+
+const encodeAnchoredTrade = require('./encode_anchored_trade');
+
+const maxDescriptionLength = 100;
+const maxSecretLength = 100;
+
+/** Create an anchored trade
+
+  {
+    description: <Trade Description String>
+    expires_at: <Trade Expires at ISO 8601 Date String>
+    lnd: <Authenticated LND API Object>
+    secret: <Trade Secret String>
+    tokens: <Trade Price Tokens Number>
+  }
+
+  @returns via cbk or Promise
+  {
+    id: <Anchored Trade Id Hex String>
+  }
+*/
+module.exports = (args, cbk) => {
+  return new Promise((resolve, reject) => {
+    return asyncAuto({
+      // Check arguments
+      validate: cbk => {
+        if (args.description === undefined) {
+          return cbk([400, 'ExpectedTradeDescriptionToCreateAnchoredTrade']);
+        }
+
+        if (args.description.length > maxDescriptionLength) {
+          return cbk([400, 'ExpectedShorterTradeDescriptionToCreateTrade']);
+        }
+
+        if (!args.expires_at) {
+          return cbk([400, 'ExpectedTradeExpirationDateToCreateTrade']);
+        }
+
+        if (args.expires_at < new Date().toISOString()) {
+          return cbk([400, 'ExpectedLaterExpiresAtDateToCreateTrade']);
+        }
+
+        if (!args.lnd) {
+          return cbk([400, 'ExpectedAuthenticatedLndToCreateAnchoredTrade']);
+        }
+
+        if (!args.secret) {
+          return cbk([400, 'ExpectedTradeSecretToCreateAnchoredTrade']);
+        }
+
+        if (args.secret.length > maxSecretLength) {
+          return cbk([400, 'ExpectedShorterTradeSecretToCreateAnchoredTrade']);
+        }
+
+        if (!args.tokens) {
+          return cbk([400, 'ExpectedTokensPriceToCreateAnchoredTrade']);
+        }
+
+        return cbk();
+      },
+
+      // Create the trade
+      create: ['validate', ({}, cbk) => {
+        const {encoded} = encodeAnchoredTrade({
+          description: args.description,
+          secret: args.secret,
+        });
+
+        return createInvoice({
+          description: encoded,
+          expires_at: args.expires_at,
+          lnd: args.lnd,
+          tokens: args.tokens,
+        },
+        cbk);
+      }],
+
+      // Final trade
+      trade: ['create', ({create}, cbk) => cbk(null, {id: create.id})],
+    },
+    returnResult({reject, resolve, of: 'trade'}, cbk));
+  });
+};

package/trades/create_trade.js

@@ -1,11 +1,10 @@
 const asyncAuto = require('async/auto');
-const {createInvoice} = require('ln-service');
 const {getChannels} = require('ln-service');
 const {getNetwork} = require('ln-sync');
 const {getWalletInfo} = require('ln-service');
 const {returnResult} = require('asyncjs-util');
 
-const encodeAnchoredTrade = require('./encode_anchored_trade');
+const createAnchoredTrade = require('./create_anchored_trade');
 const finalizeTradeSecret = require('./finalize_trade_secret');
 const serviceOpenTrade = require('./service_open_trade');
 
@@ -204,15 +203,11 @@ module.exports = ({ask, lnd, logger}, cbk) => {
           return cbk();
         }
 
-        const {encoded} = encodeAnchoredTrade({
-          description: askForDescription.description,
-          secret: askForSecret.secret,
-        });
-
-        return createInvoice({
+        return createAnchoredTrade({
           lnd,
-          description: encoded,
+          description: askForDescription.description,
           expires_at: futureDate(daysAsMs(askForExpiration.days)),
+          secret: askForSecret.secret,
           tokens: asNumber(askForPrice.tokens),
         },
         cbk);

package/trades/find_trade.js

@@ -5,6 +5,7 @@ const asyncAuto = require('async/auto');
 const asyncDetect = require('async/detect');
 const asyncDetectSeries = require('async/detectSeries');
 const asyncMap = require('async/map');
+const asyncReflect = require('async/reflect');
 const {getChannel} = require('ln-service');
 const {getNode} = require('ln-service');
 const {getPeers} = require('ln-service');
@@ -206,19 +207,19 @@ module.exports = ({ask, id, identity, lnd, logger, nodes}, cbk) => {
       }],
 
       // Request a specific trade
-      requestTrade: ['to', ({to}, cbk) => {
+      requestTrade: ['to', asyncReflect(({to}, cbk) => {
         // Exit early when this is an open ended trade request with no id
         if (!id) {
           return cbk();
         }
 
         return requestTradeById({id, lnd, to}, cbk);
-      }],
+      })],
 
       // Request an inventory of trades
-      requestTrades: ['to', ({to}, cbk) => {
-        // Exit early when this is a trade request for a specific id
-        if (!!id) {
+      requestTrades: ['requestTrade', 'to', ({requestTrade, to}, cbk) => {
+        // Exit early when there was a successful request for a specific id
+        if (!!requestTrade.value) {
           return cbk();
         }
 
@@ -285,7 +286,7 @@ module.exports = ({ask, id, identity, lnd, logger, nodes}, cbk) => {
         ({requestTrade, requestTrades}, cbk) =>
       {
         // Exit early when the trade was already selected
-        if (!!requestTrade) {
+        if (!!requestTrade.value) {
           return cbk();
         }
 
@@ -331,7 +332,7 @@ module.exports = ({ask, id, identity, lnd, logger, nodes}, cbk) => {
         'requestTrade',
         ({fetchSelectedTrade, requestTrade}, cbk) =>
       {
-        return cbk(null, fetchSelectedTrade || requestTrade);
+        return cbk(null, fetchSelectedTrade || requestTrade.value);
       }],
     },
     returnResult({reject, resolve, of: 'trade'}, cbk));

package/trades/get_anchored_trade.js

@@ -0,0 +1,72 @@
+const asyncAuto = require('async/auto');
+const asyncReflect = require('async/reflect');
+const {getInvoice} = require('ln-service');
+const {returnResult} = require('asyncjs-util');
+
+const decodeAnchoredTrade = require('./decode_anchored_trade');
+
+/** Get anchored trade
+
+  {
+    id: <Trade Id Hex String>
+    lnd: <Authenticated LND API Object>
+  }
+
+  @returns via cbk or Promise
+  {
+    [trade]: {
+      description: <Trade Description String>
+      expires_at: <Trade Expires at ISO 8601 Date String>
+      secret: <Trade Secret String>
+      tokens: <Trade Price Tokens Number>
+    }
+  }
+*/
+module.exports = ({id, lnd}, cbk) => {
+  return new Promise((resolve, reject) => {
+    return asyncAuto({
+      // Check arguments
+      validate: cbk => {
+        if (!id) {
+          return cbk([400, 'ExpectedIdToGetAnchoredTrade']);
+        }
+
+        if (!lnd) {
+          return cbk([400, 'ExpectedLndToGetAnchoredTrade']);
+        }
+
+        return cbk();
+      },
+
+      // Get invoice
+      getInvoice: ['validate', asyncReflect(({}, cbk) => {
+        return getInvoice({id, lnd}, cbk);
+      })],
+
+      // Decode trade details
+      decode: ['getInvoice', ({getInvoice}, cbk) => {
+        if (!getInvoice.value) {
+          return cbk(null, {});
+        }
+
+        const encoded = getInvoice.value.description;
+
+        const {trade} = decodeAnchoredTrade({encoded});
+
+        if (!trade) {
+          return cbk([400, 'ExpectedAnchoredTradeData']);
+        }
+
+        return cbk(null, {
+          trade: {
+            description: trade.description,
+            expires_at: getInvoice.value.expires_at,
+            secret: trade.secret,
+            tokens: getInvoice.value.tokens,
+          },
+        });
+      }],
+    },
+    returnResult({reject, resolve, of: 'decode'}, cbk));
+  });
+};

package/trades/index.js

@@ -1,3 +1,15 @@
+const createAnchoredTrade = require('./create_anchored_trade');
+const decodeTrade = require('./decode_trade');
+const encodeTrade = require('./encode_trade');
+const getAnchoredTrade = require('./get_anchored_trade');
 const manageTrades = require('./manage_trades');
+const serviceAnchoredTrades = require('./service_anchored_trades');
 
-module.exports = {manageTrades};
+module.exports = {
+  createAnchoredTrade,
+  decodeTrade,
+  encodeTrade,
+  getAnchoredTrade,
+  manageTrades,
+  serviceAnchoredTrades,
+};

package/trades/service_anchored_trades.js

@@ -13,6 +13,7 @@ const defaultInvoicesLimit = 100;
 const events = ['details', 'error', 'failure', 'settled', 'trade'];
 const fromNow = date => new Date(date) - new Date();
 const {keys} = Object;
+const sumOf = arr => arr.reduce((sum, n) => sum + n, 0);
 
 /** Service trades represented by anchored invoices
 
@@ -47,6 +48,7 @@ const {keys} = Object;
   // Starting service for trade
   @event 'start'
   {
+    created_at: <Open Trade Created At ISO 8601 Date String>
     description: <Trade Description String>
     expires_at: <Trade Expires at ISO 8601 Date String>
     id: <Trade Id Hex String>
@@ -86,6 +88,7 @@ module.exports = ({lnd}) => {
 
     // Pick up the trade to service
     emitter.emit('start', {
+      created_at: trade.created_at,
       description: trade.description,
       expires_at: trade.expires_at,
       id: trade.id,
@@ -129,6 +132,28 @@ module.exports = ({lnd}) => {
   // Listen for any new invoices that represent anchored trades
   const sub = subscribeToInvoices({lnd});
 
+  // Stop servicing all trades
+  const stopService = () => {
+    // Stop paging in progress
+    paging.token = false;
+
+    // Stop listening to all invoices
+    sub.removeAllListeners();
+
+    // Stop listening to all anchor invoices
+    return keys(listening).forEach(id => listening[id].removeAllListeners());
+  };
+
+  // Stop the service when there are no more listeners
+  emitter.on('removeListener', () => {
+    // Exit early when there are still listeners on an event
+    if (!!sumOf(events.map(n => emitter.listenerCount(n)))) {
+      return;
+    }
+
+    return stopService();
+  });
+
   // Listen for new trades to appear
   sub.on('invoice_updated', invoice => {
     const {trade} = tradeFromInvoice(invoice);
@@ -155,13 +180,13 @@ module.exports = ({lnd}) => {
         if (!!err) {
           emitter.emit(err);
 
-          // Stop listening to all invoices
-          sub.removeAllListeners();
-
-          // Stop listening to all anchor invoices
-          keys(listening).forEach(id => listening[id].removeAllListeners());
+          // Stop the service
+          return stopService();
+        }
 
-          return;
+        // Exit early when paging is already stopped
+        if (paging.token === false) {
+          return cbk();
         }
 
         paging.token = res.next || false;

package/trades/trade_from_invoice.js

@@ -3,6 +3,7 @@ const decodeAnchoredTrade = require('./decode_anchored_trade');
 /** Derive open trade details from an invoice
 
   {
+    created_at: <Invoice Created At ISO 8601 Date String>
     description: <Invoice Description String>
     id: <Invoice Id Hex String>
     expires_at: <Invoice Expiration ISO 8601 Date String>
@@ -15,6 +16,7 @@ const decodeAnchoredTrade = require('./decode_anchored_trade');
   @returns
   {
     [trade]: {
+      created_at: <Open Trade Created At ISO 8601 Date String>
       description: <Trade Description String>
       expires_at: <Trade Expires at ISO 8601 Date String>
       id: <Trade Id Hex String>
@@ -41,6 +43,7 @@ module.exports = args => {
 
   return {
     trade: {
+      created_at: args.created_at,
       description: trade.description,
       expires_at: args.expires_at,
       id: args.id,