paid-services 3.9.1 → 3.10.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # 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

package/index.js

@@ -1,7 +1,9 @@
 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');
@@ -17,8 +19,10 @@ const serviceIds = schema.types;
 module.exports = {
   changeChannelCapacity,
   confirmServiceUse,
+  createAnchoredTrade,
   decodeTrade,
   encodeTrade,
+  getAnchoredTrade,
   getServiceSchema,
   getServicesList,
   makePeerRequest,

package/package.json

@@ -12,8 +12,8 @@
     "bolt01": "1.2.3",
     "bolt07": "1.8.0",
     "invoices": "2.0.3",
-    "ln-service": "53.4.2",
-    "ln-sync": "3.6.1"
+    "ln-service": "53.5.0",
+    "ln-sync": "3.7.0"
   },
   "description": "Lightning Paid Services library",
   "devDependencies": {
@@ -40,5 +40,5 @@
     "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.9.1"
+  "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/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,11 +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 = {
+  createAnchoredTrade,
   decodeTrade,
   encodeTrade,
+  getAnchoredTrade,
   manageTrades,
   serviceAnchoredTrades,
 };