balanceofsatoshis 23.3.0 → 24.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Versions
 
+## 24.0.1
+
+### Breaking Changes
+
+- Remove `change-channel-capacity`, `services`, `triggers`, and `use` commands
+
 ## 23.3.0
 
 - `call`: Add `subscribeToMessages` to listen for received onion messages

package/bos

@@ -46,7 +46,6 @@ const services = importLazy('./services');
 const {swapTypes} = commandConstants;
 const swaps = importLazy('./swaps');
 const telegram = importLazy('./telegram');
-const triggers = importLazy('./triggers');
 const wallets = importLazy('./wallets');
 const {version} = importLazy('./package');
 
@@ -323,48 +322,6 @@ prog
     });
   })
 
-  // Change the capacity of an existing channel
-  .command('change-channel-capacity', 'Change the capacity of a channel')
-  .visible(false)
-  .help('Remote node must be prepared to receive this type of request')
-  .help('The remote node should also run this same command after you propose')
-  .option('--node <node_name>', 'Use saved node details instead of local node')
-  .action((args, options, logger) => {
-    return new Promise(async (resolve, reject) => {
-      try {
-        const {lnd} = await lndForNode(logger, options.node);
-
-        const saved = await nodes.manageSavedNodes({
-          logger,
-          spawn,
-          ask: await commands.interrogate({}),
-          fs: {
-            writeFile,
-            getDirectoryFiles: readdir,
-            getFile: readFile,
-            getFileStatus: lstat,
-            makeDirectory: mkdir,
-            removeDirectory: rmdir,
-            removeFile: unlink,
-          },
-          is_including_lnd_api: true,
-          lock_credentials_to: [],
-          network: (await lnSync.getNetwork({lnd})).network,
-        });
-
-        return paidServices.changeChannelCapacity({
-          lnd,
-          logger,
-          ask: await commands.interrogate({}),
-          nodes: saved.nodes,
-        },
-        responses.returnObject({exit, logger, reject, resolve}));
-      } catch (err) {
-        return logger.error({err}) && reject();
-      }
-    });
-  })
-
   // Show a chart of chain fees paid
   .command('chart-chain-fees', 'Get a chart of chain fee expenses')
   .help('Show chart of mining fee expenditure over time')
@@ -1948,59 +1905,6 @@ prog
     });
   })
 
-  // Offer paid services
-  .command('services', 'Run a KeySend paid services server')
-  .visible(false)
-  .help('KeySend services are paid native Lightning Network services')
-  .option('--activity-fees', 'Share routing fees earned vs num fwds')
-  .option('--activity-volume', 'Share routing total volume amount')
-  .option('--connect', 'Enable requesting an inbound peer connection')
-  .option('--inbox-email-from', 'Inbox service email from address')
-  .option('--inbox-email-postmark-auth', 'Inbox service email to address')
-  .option('--inbox-email-to', 'Inbox service to email')
-  .option('--inbox-price', 'Required payment amount for inbox')
-  .option('--inbox-sms-from', 'Inbox service sms from number')
-  .option('--inbox-sms-to', 'Inbox service sms to number')
-  .option('--inbox-sms-twilio-sid', 'Inbox service Twilio account sid')
-  .option('--inbox-sms-twilio-auth', 'Inbox service Twilio auth token')
-  .option('--invoice', 'Enable creating custom invoices on demand')
-  .option('--node <node_name>', 'Saved node')
-  .option('--payer <pay_with_node_name>', 'Node to pay request responses with')
-  .option('--profile <profile>', 'Share a profile with info about your node')
-  .option('--profile-link <link>', 'Add a link to your profile', REPEATABLE)
-  .option('--network <public_key>', 'Share other service node key', REPEATABLE)
-  .option('--relay', 'Enable payments relay service', BOOL)
-  .action((args, options, logger) => {
-    return new Promise(async (resolve, reject) => {
-      try {
-        services.servicePaidRequests({
-          fetch,
-          logger,
-          activity_fees: options.activityFees,
-          activity_volume: options.activityVolume,
-          inbox_email_from: options.inboxEmailFrom,
-          inbox_email_to: options.inboxEmailTo,
-          inbox_postmark_api_key: options.inboxEmailPostmarkAuth,
-          inbox_price: options.inboxPrice,
-          inbox_sms_from_number: options.inboxSmsFrom,
-          inbox_sms_to_number: options.inboxSmsTo,
-          inbox_twilio_account_sid: options.inboxSmsTwilioSid,
-          inbox_twilio_auth_token: options.inboxSmsTwilioAuth,
-          is_connect_enabled: !!options.connect || undefined,
-          is_invoice_enabled: !!options.invoice || undefined,
-          is_relay_enabled: !!options.relay || undefined,
-          network_nodes: flatten([options.network].filter(n => !!n)),
-          node: options.node,
-          payer: options.payer || options.node,
-          profile: options.profile,
-          profile_urls: flatten([options.profileLink].filter(n => !!n)),
-        });
-      } catch (err) {
-        return logger.error({err}) && reject();
-      }
-    });
-  })
-
   // Get a swap API key or inspect an existing one
   .command('swap-api-key', 'Purchase a swap API key or inspect a swap API key')
   .visible(false)
@@ -2226,25 +2130,6 @@ prog
     });
   })
 
-  // Manage triggers
-  .command('triggers', 'Manage event triggers')
-  .option('--node <name>', 'Node to manage triggers on')
-  .visible(false)
-  .action((args, options, logger) => {
-    return new Promise(async (resolve, reject) => {
-      try {
-        return triggers.manageTriggers({
-          logger,
-          ask: await commands.interrogate({}),
-          lnd: (await lndForNode(logger, options.node)).lnd,
-        },
-        responses.returnObject({exit, logger, reject, resolve}));
-      } catch (err) {
-        return logger.error({err}) && reject();
-      }
-    });
-  })
-
   // Unlock wallet
   .command('unlock', 'Unlock wallet if locked')
   .help('Check if the wallet is locked, if so use a password file to unlock')
@@ -2261,33 +2146,6 @@ prog
     });
   })
 
-  // Use a paid service
-  .command('use', 'Use a paid KeySend service from a services provider')
-  .visible(false)
-  .help('KeySend services are paid native Lightning Network services')
-  .help('All communication with these services uses LN payments')
-  .help('Run services using the services command')
-  .argument('<server_id>', 'Public key of services-offering node')
-  .option('--node <node_name>', 'Saved node')
-  .action((args, options, logger) => {
-    return new Promise(async (resolve, reject) => {
-      try {
-        const {lnd} = await lndForNode(logger, options.node);
-
-        return await services.usePaidService({
-          lnd,
-          logger,
-          ask: await commands.interrogate({}),
-          fs: {getFile: readFile},
-          network: (await lnSync.getNetwork({lnd})).network,
-          node: args.serverId,
-        });
-      } catch (err) {
-        return logger.error({err}) && reject();
-      }
-    });
-  })
-
   // Get utxos
   .command('utxos', 'Get a list of utxos')
   .option('--confirmed', 'Return only confirmed utxos')

package/chain/get_channel_resolution.js

@@ -1,8 +1,9 @@
 const asyncAuto = require('async/auto');
 const asyncMapSeries = require('async/mapSeries');
+const {componentsOfTransaction} = require('@alexbosworth/blockchain');
+const {idForTransaction} = require('@alexbosworth/blockchain');
 const {resolutionType} = require('bolt03');
 const {returnResult} = require('asyncjs-util');
-const {Transaction} = require('bitcoinjs-lib');
 
 const {endpoints} = require('./blockstream');
 
@@ -90,12 +91,10 @@ module.exports = (args, cbk) => {
       // Decode transactions to derive spends
       spends: ['validate', ({}, cbk) => {
         const spends = args.transactions.map(({id, transaction}) => {
-          return Transaction.fromHex(transaction).ins.map(({hash}, index) => {
-            return {
-              id: hash.reverse().toString('hex'),
-              spent_by: id,
-              vin: index,
-            };
+          const {inputs} = componentsOfTransaction({transaction});
+
+          return inputs.map((input, index) => {
+            return {id: input.id, spent_by: id, vin: index};
           });
         });
 
@@ -219,11 +218,13 @@ module.exports = (args, cbk) => {
           return cbk(null, {});
         }
 
-        const tx = Transaction.fromHex(getCommitmentTransaction);
+        const tx = componentsOfTransaction({
+          transaction: getCommitmentTransaction,
+        });
 
         const resolutions = getCloseSpends.map(({txid, vin}, i) => {
-          const {transaction} = getTransactions.find(n => txid === n.id) || {};
-          const {value} = tx.outs[i];
+          const {transaction} = getTransactions.find(n => txid === n.id);
+          const value = tx.outputs[i].tokens;
 
           if (!transaction) {
             return {value, type: 'unspent'};
@@ -231,7 +232,7 @@ module.exports = (args, cbk) => {
 
           return {
             value,
-            transaction_id: Transaction.fromHex(transaction).getId(),
+            transaction_id: idForTransaction({transaction}).id,
             type: resolutionType({vin, transaction}).type,
           };
         });

package/chain/get_raw_transaction.js

@@ -1,7 +1,7 @@
 const asyncAuto = require('async/auto');
 const asyncRetry = require('async/retry');
+const {componentsOfTransaction} = require('@alexbosworth/blockchain');
 const {returnResult} = require('asyncjs-util');
-const {Transaction} = require('bitcoinjs-lib');
 
 const {endpoints} = require('./blockstream');
 
@@ -72,7 +72,7 @@ module.exports = ({id, interval, network, request, retries}, cbk) => {
             }
 
             try {
-              Transaction.fromHex(transaction);
+              componentsOfTransaction({transaction});
             } catch (err) {
               return cbk([503, 'ExpectedValidTransactionInResponse']);
             }

package/chain/get_utxos.js

@@ -1,5 +1,6 @@
 const asyncAuto = require('async/auto');
 const asyncMapSeries = require('async/mapSeries');
+const {componentsOfTransaction} = require('@alexbosworth/blockchain');
 const {formatTokens} = require('ln-sync');
 const {getChainTransactions} = require('ln-service');
 const {getChannels} = require('ln-service');
@@ -10,12 +11,10 @@ const {getTransactionRecord} = require('ln-sync');
 const {getUtxos} = require('ln-service');
 const moment = require('moment');
 const {returnResult} = require('asyncjs-util');
-const {Transaction} = require('bitcoinjs-lib');
 
 const describeChan = n => `${n.action} with ${(n.node || '' + n.with).trim()}`;
 const expiresAt = n => !!n ? moment(n).calendar() : undefined;
 const flatten = arr => [].concat(...arr);
-const {fromHex} = Transaction;
 const none = 0;
 const uniq = arr => Array.from(new Set(arr));
 
@@ -119,7 +118,11 @@ module.exports = (args, cbk) => {
             return;
           }
 
-          const output = fromHex(tx.transaction).outs[locked.transaction_vout];
+          const {outputs} = componentsOfTransaction({
+            transaction: tx.transaction,
+          });
+
+          const output = outputs[locked.transaction_vout];
 
           // Exit early when the output is not found in the transaction
           if (!output) {
@@ -130,7 +133,7 @@ module.exports = (args, cbk) => {
             confirmation_count: tx.confirmation_count,
             lock_expires_at: locked.lock_expires_at,
             lock_id: locked.lock_id,
-            tokens: output.value,
+            tokens: output.tokens,
             transaction_id: locked.transaction_id,
             transaction_vout: locked.transaction_vout,
           };

package/chain/networks.json

@@ -0,0 +1,7 @@
+{
+  "networks": {
+    "btc": {"bech32": "bc", "p2pkh": 0, "p2sh": 5},
+    "btcregtest": {"bech32": "bcrt", "p2pkh": 111, "p2sh": 196},
+    "btctestnet": {"bech32": "tb", "p2pkh": 111, "p2sh": 196}
+  }
+}

package/chain/output_script_for_address.js

@@ -1,12 +1,19 @@
-const {address} = require('bitcoinjs-lib');
-const {networks} = require('bitcoinjs-lib');
+const {decodeBase58Address} = require('@alexbosworth/blockchain');
+const {decodeBech32Address} = require('@alexbosworth/blockchain');
+const {p2pkhOutputScript} = require('@alexbosworth/blockchain');
+const {p2shOutputScript} = require('@alexbosworth/blockchain');
+const {p2trOutputScript} = require('@alexbosworth/blockchain');
+const {p2wpkhOutputScript} = require('@alexbosworth/blockchain');
+const {p2wshOutputScript} = require('@alexbosworth/blockchain');
+
+const {networks} = require('./networks');
 
 const bufferAsHex = buffer => buffer.toString('hex');
+const byteAsHex = n => n.toString(16).padStart(2, '0');
 const byteLengthForP2tr = 32;
-const {fromBech32} = address;
-const names = {btc: 'bitcoin', btcregtest: 'regtest', btctestnet: 'testnet'};
-const prefixForP2tr = '5120';
-const toOutputScript = (a, n) => address.toOutputScript(a, n).toString('hex');
+const byteLengthForP2wpkh = 20;
+const opVersionOffset = 0x50;
+const versionSegwit = 0;
 const versionTaproot = 1;
 
 /** Get the output script for an address
@@ -25,32 +32,57 @@ const versionTaproot = 1;
   }
 */
 module.exports = ({address, network}) => {
+  const params = networks[network];
+
+  if (!params) {
+    throw new Error('UnsupportedNetworkToConvertAddressToOutputScript');
+  }
+
+  // Exit early when the address is a base58 address
   try {
-    return {
-      script: bufferAsHex(toOutputScript(address, networks[names[network]])),
-    };
+    const {hash, version} = decodeBase58Address({address});
+
+    if (version === params.p2pkh) {
+      return {script: bufferAsHex(p2pkhOutputScript({hash}).script)};
+    }
+
+    if (version === params.p2sh) {
+      return {script: bufferAsHex(p2shOutputScript({hash}).script)};
+    }
+
+    throw new Error('InvalidNetworkToConvertAddressToOutputScript');
   } catch (err) {
-    // Exit early when this is not a bech32 address
-    try {
-      fromBech32(address);
-    } catch (_) {
+    // Continue on to bech32 decoding when the address is not base58
+    if (err.message === 'InvalidNetworkToConvertAddressToOutputScript') {
       throw err;
     }
+  }
 
-    const {data, prefix, version} = fromBech32(address);
+  const {prefix, program, version} = decodeBech32Address({address});
 
-    if (prefix !== networks[names[network]].bech32) {
-      throw new Error('InvalidNetworkToConvertAddressToOutputScript');
-    }
+  if (prefix !== params.bech32) {
+    throw new Error('InvalidNetworkToConvertAddressToOutputScript');
+  }
 
-    if (version !== versionTaproot) {
-      throw new Error('UnexpectedVersionOfAddressToConverToOutputScript');
-    }
+  if (version === versionSegwit && program.length === byteLengthForP2wpkh) {
+    return {script: bufferAsHex(p2wpkhOutputScript({hash: program}).script)};
+  }
 
-    if (data.length !== byteLengthForP2tr) {
-      throw new Error('UnexpectedByteLengthForPayToTaprootAddress');
-    }
+  if (version === versionSegwit) {
+    return {script: bufferAsHex(p2wshOutputScript({hash: program}).script)};
+  }
+
+  // Future segwit versions are OP_n followed by a push of the program
+  if (version !== versionTaproot) {
+    const push = byteAsHex(program.length);
+    const versionOp = byteAsHex(opVersionOffset + version);
 
-    return {script: `${prefixForP2tr}${bufferAsHex(data)}`};
+    return {script: `${versionOp}${push}${bufferAsHex(program)}`};
   }
+
+  if (program.length !== byteLengthForP2tr) {
+    throw new Error('UnexpectedByteLengthForPayToTaprootAddress');
+  }
+
+  return {script: bufferAsHex(p2trOutputScript({hash: program}).script)};
 };

package/package.json

@@ -28,7 +28,6 @@
     "bech32": "2.0.0",
     "bip66": "2.0.0",
     "bitcoinjs-lib": "6.1.7",
-    "bolt01": "4.0.0",
     "bolt03": "2.0.0",
     "bolt04": "1.3.0",
     "bolt07": "2.0.0",
@@ -85,7 +84,6 @@
     "swaps",
     "tags",
     "telegram",
-    "triggers",
     "wallets"
   ],
   "keywords": [
@@ -109,5 +107,5 @@
     "postpublish": "docker buildx build --platform linux/amd64,linux/arm64 -t alexbosworth/balanceofsatoshis -t alexbosworth/balanceofsatoshis:$npm_package_version --push .",
     "test": "node --experimental-test-coverage --test test/arrays/*.js test/balances/*.js test/chain/*.js test/display/*.js test/encryption/*.js test/lnd/*.js test/network/*.js test/nodes/*.js test/offchain/*.js test/peers/*.js test/responses/*.js test/routing/*.js test/services/*.js test/swaps/*.js test/tags/*.js test/telegram/*.js test/wallets/*.js"
   },
-  "version": "23.3.0"
+  "version": "24.0.1"
 }

package/services/index.js

@@ -1,11 +1,4 @@
 const advertise = require('./advertise');
 const openBalancedChannel = require('./open_balanced_channel');
-const servicePaidRequests = require('./service_paid_requests');
-const usePaidService = require('./use_paid_service');
 
-module.exports = {
-  advertise,
-  openBalancedChannel,
-  servicePaidRequests,
-  usePaidService,
-};
+module.exports = {advertise, openBalancedChannel};

package/services/key_send_request_arguments.js

@@ -1,85 +0,0 @@
-const {decodeTlvStream} = require('bolt01');
-
-const base64AsHex = base64 => Buffer.from(base64, 'base64').toString('hex');
-const processAfter = () => new Date(Date.now() - (1000*60*60)).toISOString();
-
-/** Derive key send request arguments from invoice details
-
-  {
-    [confirmed_at]: <Settled at ISO 8601 Date String>
-    description: <Invoice Description String>
-    [description_hash]: <Invoice Description Hash String>
-    id: <Payment Hash Hex String>
-    [is_canceled]: <Invoice is Canceled Bool>
-    is_confirmed: <Invoice is Confirmed Bool>
-    payments: [{
-      is_confirmed: <HTLC is Confirmed Bool>
-      messages: [{
-        type: <Message Type String>
-        value: <Hex Encoded Value String>
-      }]
-    }]
-    received: <Tokens Received Rounded Down Number>
-    secret: <Invoice Preimage Hex String>
-    tokens: <Invoiced Tokens Rounded Down Number>
-  }
-
-  @returns
-  {
-    [arguments]: {
-      id: <Payment Hash Hex String>
-      messages: [{
-        type: <Message Type String>
-        value: <Hex Encoded Value String>
-      }]
-      received: <Tokens Received Rounded Down Number>
-    }
-  }
-*/
-module.exports = (args) => {
-  const {id} = args;
-
-  // Exit early when there is a simulated keysend invoice
-  if (!args.is_canceled && args.description_hash === args.secret) {
-    try {
-      const encoded = base64AsHex(args.description);
-
-      return {
-        arguments: {
-          id,
-          messages: decodeTlvStream({encoded}).records,
-          received: args.tokens,
-        },
-      };
-    } catch (err) {
-      return {};
-    }
-  }
-
-  // Exit early when the invoice is not settled
-  if (!args.is_confirmed) {
-    return {};
-  }
-
-  // Exit early when this was confirmed too long ago
-  if (args.confirmed_at < processAfter()) {
-    return {};
-  }
-
-  const htlcs = args.payments.filter(n => !!n.is_confirmed);
-  const {received} = args;
-
-  // Exit early when the invoice has no confirmed HTLCs
-  if (!htlcs.length) {
-    return {};
-  }
-
-  const [{messages}] = htlcs;
-
-  // Exit early when the first HTLC has no messages
-  if (!messages.length) {
-    return {};
-  }
-
-  return {arguments: {id, messages, received}};
-};