paid-services 4.1.0 → 4.2.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## Version 4.2.1
+
+- `manageSwap`: Add support for P2TR output addresses
+
 ## Version 4.1.0
 
 - `createGroupChannel`: Add `members` to restrict and order group membership

package/package.json

@@ -7,25 +7,25 @@
     "url": "https://github.com/alexbosworth/paid-services/issues"
   },
   "dependencies": {
-    "@alexbosworth/fiat": "1.0.3",
+    "@alexbosworth/fiat": "1.0.4",
     "async": "3.2.4",
-    "asyncjs-util": "1.2.10",
+    "asyncjs-util": "1.2.11",
     "bech32": "2.0.0",
-    "bolt01": "1.2.5",
-    "bolt07": "1.8.2",
+    "bolt01": "1.2.6",
+    "bolt07": "1.8.3",
     "ecpair": "2.1.0",
-    "goldengate": "11.4.0",
-    "invoices": "2.2.2",
-    "ln-service": "54.3.1",
-    "ln-sync": "4.0.5",
-    "psbt": "2.7.1",
-    "p2tr": "1.3.2",
+    "goldengate": "12.0.1",
+    "invoices": "2.2.3",
+    "ln-service": "54.9.0",
+    "ln-sync": "4.1.1",
+    "psbt": "2.7.2",
+    "p2tr": "1.3.3",
     "tiny-secp256k1": "2.2.1"
   },
   "description": "Lightning Paid Services library",
   "devDependencies": {
-    "@alexbosworth/tap": "15.0.11",
-    "ln-docker-daemons": "3.1.5",
+    "@alexbosworth/tap": "15.0.12",
+    "ln-docker-daemons": "4.0.4",
     "mock-lnd": "1.4.4",
     "secp256k1": "4.0.3"
   },
@@ -47,5 +47,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/balanced/*.js test/capacity/*.js test/client/*.js test/config/*.js test/p2p/*.js test/records/*.js test/respond/*.js test/server/*.js test/swaps/*.js test/services/*.js test/trades/*.js"
   },
-  "version": "4.1.0"
+  "version": "4.2.1"
 }

package/swaps/complete_off_to_on_swap.js

@@ -65,6 +65,7 @@ const encodeAddress = (prefix, data) => bech32m.encode(prefix, data);
 const externalKeyAsOutputScript = key => `5120${key}`;
 const family = 805;
 const {floor} = Math;
+const format = 'p2tr';
 const {from} = Buffer;
 const {fromHex} = Transaction;
 const fuzzBlocks = 100;
@@ -79,7 +80,7 @@ const {min} = Math;
 const minTokens = 10000;
 const minBlockMs = 1000 * 60;
 const pollInterval = {btcregtest: 100};
-const ppmRate = (fee, total) => fee * 1e6 / total.tokens;
+const ppmRate = (fee, total) => fee * 1e6 / total;
 const preimageByteLength = 32;
 const pubKeyAsInternalKey = key => Buffer.from(key).slice(1).toString('hex');
 const pushSecret = asyncTimeout(releaseSwapOutSecret, 1000 * 30);
@@ -155,7 +156,7 @@ module.exports = (args, cbk) => {
           return cbk(null, {address: args.sweep_address});
         }
 
-        return createChainAddress({lnd: args.lnd}, cbk);
+        return createChainAddress({format, lnd: args.lnd}, cbk);
       }],
 
       // Get the current chain fee rate for the sweep fee rate calculation

package/swaps/complete_on_to_off_swap.js

@@ -42,9 +42,11 @@ const {typePayMetadata} = require('./swap_field_types');
 const bufferAsHex = buffer => buffer.toString('hex');
 const defaultMaxFundingConfirmationDelay = 12;
 const defaultMinDelta = 60;
+const estimatedSize = 150;
 const family = 805;
 const flatten = arr => [].concat(...arr);
 const {floor} = Math;
+const format = 'p2tr';
 const {from} = Buffer;
 const {fromHex} = Transaction;
 const fuzzBlocks = 100;
@@ -126,7 +128,7 @@ module.exports = (args, cbk) => {
 
       // Get an address to sweep out to
       getSweepAddress: ['validate', ({}, cbk) => {
-        return createChainAddress({lnd: args.lnd}, cbk);
+        return createChainAddress({format, lnd: args.lnd}, cbk);
       }],
 
       // Get the encryption key to decode the recovery secrets
@@ -370,6 +372,11 @@ module.exports = (args, cbk) => {
         });
 
         const refunds = uniqBy(feeRates, 'rate').map(({rate, height}) => {
+          // Exit early when there is nothing to recover
+          if (rate * estimatedSize > recoveryDetails.tokens) {
+            return;
+          }
+
           return taprootRefundTransaction({
             ecp,
             block_height: height,
@@ -388,7 +395,7 @@ module.exports = (args, cbk) => {
           });
         });
 
-        return cbk(null, refunds.map(n => n.transaction));
+        return cbk(null, refunds.filter(n => !!n).map(n => n.transaction));
       }],
 
       // Sign the refund transactions

package/swaps/manage_swap.js

@@ -13,6 +13,7 @@ const {returnResult} = require('asyncjs-util');
 const decodeOffToOnRequest = require('./decode_off_to_on_request');
 const decodeOffToOnRestart = require('./decode_off_to_on_restart');
 const {decodeTrade} = require('./../trades');
+const outputScriptForAddress = require('./output_script_for_address');
 const recoverResponseToSwapOut = require('./recover_response_to_swap_out');
 const requestSwapOut = require('./request_swap_out');
 const respondToSwapOutRequest = require('./respond_to_swap_out_request');
@@ -310,7 +311,10 @@ module.exports = (args, cbk) => {
               }
 
               try {
-                return !!toOutputScript(input, networks[getNetwork.bitcoinjs]);
+                return !!outputScriptForAddress({
+                  address: input,
+                  network: getNetwork.bitcoinjs,
+                });
               } catch (err) {
                 return 'Unsupported on-chain address format';
               }

package/swaps/output_script_for_address.js

@@ -0,0 +1,55 @@
+const {address} = require('bitcoinjs-lib');
+const {networks} = require('bitcoinjs-lib');
+
+const bufferAsHex = buffer => buffer.toString('hex');
+const byteLengthForP2tr = 32;
+const {fromBech32} = address;
+const prefixForP2tr = '5120';
+const toOutputScript = (a, n) => address.toOutputScript(a, n).toString('hex');
+const versionTaproot = 1;
+
+/** Get the output script for an address
+
+  {
+    address: <Address String>
+    network: <BitcoinJs Network Name String>
+  }
+
+  @throws
+  <Error>
+
+  @returns
+  {
+    script: <Output Script Hex String>
+  }
+*/
+module.exports = ({address, network}) => {
+  try {
+    return {
+      script: bufferAsHex(toOutputScript(address, networks[network])),
+    };
+  } catch (err) {
+    // Exit early when this is not a bech32 address
+    try {
+      fromBech32(address);
+    } catch (_) {
+      throw err;
+    }
+
+    const {data, prefix, version} = fromBech32(address);
+
+    if (prefix !== networks[network].bech32) {
+      throw new Error('InvalidNetworkToConvertAddressToOutputScript');
+    }
+
+    if (version !== versionTaproot) {
+      throw new Error('UnexpectedVersionOfAddressToConverToOutputScript');
+    }
+
+    if (data.length !== byteLengthForP2tr) {
+      throw new Error('UnexpectedByteLengthForPayToTaprootAddress');
+    }
+
+    return {script: `${prefixForP2tr}${bufferAsHex(data)}`};
+  }
+};

package/swaps/request_swap_out.js

@@ -31,6 +31,7 @@ const defaultFeeRate = 5000;
 const defaultMaxAmount = 21e14;
 const defaultMaxFeeForDeposit = 1337;
 const defaultSwapAmount = 2500000;
+const feeAsPpm = (fee, total) => Math.ceil(fee * 1e6 / total);
 const findRecord = (r, type) => (r.find(n => n.type === type) || {}).value;
 const {floor} = Math;
 const hexAsBuffer = hex => Buffer.from(hex, 'hex');
@@ -421,14 +422,19 @@ module.exports = (args, cbk) => {
 
         const deposit = mtokensAsTokens(response.deposit_mtokens);
 
+        const combinedFee = tokens - askForTokens + deposit;
         const serviceFee = tokensAsBigUnit(deposit);
         const totalFee = tokensAsBigUnit(tokens - askForTokens + deposit);
 
+        const ppmTotal = feeAsPpm(combinedFee, askForTokens);
+
+        const feeInfo = `total fee is ${totalFee}, est PPM ${ppmTotal}`
+
         return cbk(null, {
           deposit,
           fee: tokens - askForTokens,
           incoming_peer: response.incoming_peer,
-          pricing: `Execution cost ${serviceFee}, total fee is ${totalFee}`,
+          pricing: `Execution cost ${serviceFee}, ${feeInfo}`,
           rate: rateForFee(askForTokens, deposit + (tokens - askForTokens)),
           timeout: response.timeout,
         });

package/test/integration/test_request_swap_out.js

@@ -53,7 +53,7 @@ test(`Start offchain swap`, async ({end, equal, strictSame}) => {
       });
 
       await asyncRetry({interval, times}, async () => {
-        const {channels} = await getChannels({lnd, is_actve: true});
+        const {channels} = await getChannels({lnd, is_active: true});
 
         if (!!channels.length) {
           return channels;

package/test/integration/test_swap_with_claim_path.js

@@ -53,7 +53,7 @@ test(`Swap with claim path`, async ({end, equal, strictSame}) => {
       });
 
       await asyncRetry({interval, times}, async () => {
-        const {channels} = await getChannels({lnd, is_actve: true});
+        const {channels} = await getChannels({lnd, is_active: true});
 
         if (!!channels.length) {
           return channels;

package/test/integration/test_swap_with_refund_path.js

@@ -58,7 +58,7 @@ test(`Timeout a swap`, async ({end, equal, strictSame}) => {
       });
 
       await asyncRetry({interval, times}, async () => {
-        const {channels} = await getChannels({lnd, is_actve: true});
+        const {channels} = await getChannels({lnd, is_active: true});
 
         if (!!channels.length) {
           return channels;