balanceofsatoshis 11.2.1 → 11.5.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Versions
 
+## Version 11.5.1
+
+- `--avoid`: Correct naming`OUT_FEE_RATE`/`IN_FEE_RATE` to `OPPOSITE_FEE_RATE`
+
+## Version 11.5.0
+
+- `--avoid` Add `IN_FEE_RATE` and `OUT_FEE_RATE` to formulas
+- `find`: Correct socket output for peer node lookups
+- `telegram`: Correct week summary chain fee costs in `/costs`
+
+## Version 11.4.0
+
+- `call`: Add `--param` flag to pass arguments directly instead of interactively
+
+## Version 11.3.0
+
+- `credentials`: Allow specifying specific methods to allow in a credential
+
 ## Version 11.2.1
 
 - Improve support for LND v0.13.3

package/README.md

@@ -533,6 +533,22 @@ functions and reference variables.
 There is a dynamic playground here where you can play with expressions:
 https://formulajs.info/functions/
 
+### `--avoid`
+
+In `--avoid` flag commands like rebalance, a formula can be applied directionally:
+
+`--avoid "fee_rate < 100/<PUBKEY>"` to avoid channels forwarding to the public key that
+charge a fee rate under 100 PPM.
+
+Available variables:
+
+- `age`: Age of the channel vs the current height
+- `base_fee`: Base fee to be charged to route
+- `capacity`: Capacity of the channel
+- `fee_rate`: PPM fee to be charged to route
+- `height`: Absolute height of the channel
+- `opposite_fee_rate`: PPM fee that is charged in the non-routing direction
+
 ### `amount`
 
 Formula amounts are supported in the following commands:

package/bos

@@ -212,6 +212,7 @@ prog
   .help('If you do not specify a method it will list the supported methods')
   .argument('[method]', 'Method to call')
   .option('--node <node_name>', 'Saved node to use for call')
+  .option('--param <param>', 'query encoded name=value', REPEATABLE)
   .action((args, options, logger) => {
     return new Promise(async (resolve, reject) => {
       try {
@@ -220,6 +221,7 @@ prog
           ask: (n, cbk) => inquirer.prompt([n]).then(n => cbk(null, n)),
           lnd: (await lndForNode(logger, options.node)).lnd,
           method: args.method,
+          params: flatten([options.param].filter(n => !!n)),
         },
         responses.returnObject({logger, reject, resolve}));
       } catch (err) {
@@ -420,6 +422,7 @@ prog
   .help('Output encrypted remote access credentials. Use with "nodes --add"')
   .option('--cleartext', 'Output remote access credentials without encryption')
   .option('--days <days>', 'Expiration days for credentials', INT, 365)
+  .option('--method <method_name>', 'White-list specific method', REPEATABLE)
   .option('--node <node_name>', 'Get credentials for a saved node')
   .option('--nospend', 'Credentials do not include spending privileges')
   .option('--readonly', 'Credentials only include read permissions')
@@ -432,6 +435,7 @@ prog
         is_cleartext: options.cleartext,
         is_nospend: options.nospend,
         is_readonly: options.readonly,
+        methods: flatten([options.method].filter(n => !!n)),
         node: options.node,
       },
       responses.returnObject({logger, reject, resolve}));
@@ -1189,7 +1193,7 @@ prog
   .option('--max-fee-rate <max_fee_rate>', 'Max fee rate to pay')
   .option('--minutes <minutes>', 'Time-out route search after N minutes', INT)
   .option('--no-color', 'Mute all colors')
-  .option('--node <node_name>', 'Node to use for rebalance')
+  .option('--node <node_name>', 'Saved node to use for rebalance')
   .option('--out <pubkey_or_alias>', 'Route out through a specific peer')
   .option('--out-filter <out_filter>', 'Filter outbound tag nodes', REPEATABLE)
   .option('--out-target-inbound <amount>', 'Balance up to inbound amount')

package/commands/call_raw_api.js

@@ -1,3 +1,5 @@
+const {parse} = require('querystring');
+
 const asyncAuto = require('async/auto');
 const asyncMapSeries = require('async/mapSeries');
 const lnService = require('ln-service');
@@ -5,6 +7,7 @@ const {returnResult} = require('asyncjs-util');
 
 const {calls} = require('./api');
 
+const {assign} = Object;
 const isChannel = n => !!n && /^\d*x\d*x\d*$/.test(n);
 const isHash = n => !!n && /^[0-9A-F]{64}$/i.test(n);
 const isPublicKey = n => !!n && /^0[2-3][0-9A-F]{64}$/i.test(n);
@@ -19,12 +22,13 @@ const methodDetails = (calls, method) => calls.find(n => n.method === method);
     lnd: <Authenticated LND API Object>
     logger: <Winston Logger Object>
     [method]: <Method to Call String>
+    [params]: [<Querystring Encoded Parameter String>]
   }
 
   @returns via cbk or Promise
   <Result Object>
 */
-module.exports = ({ask, lnd, logger, method}, cbk) => {
+module.exports = ({ask, lnd, logger, method, params}, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
@@ -76,12 +80,36 @@ module.exports = ({ask, lnd, logger, method}, cbk) => {
           return cbk(null, []);
         }
 
+        const parameters = (params || [])
+          .map(encoded => parse(encoded))
+          .reduce((sum, n) => assign(sum, n), {});
+
+        // Parameters must all match method parameters
+        const unknown = keys(parameters).find(param => {
+          return !arguments.find(({named}) => named === param);
+        });
+
+        if (!!unknown) {
+          return cbk([400, 'UnknownParameterProvided', {unknown}]);
+        }
+
         return asyncMapSeries(arguments, (argument, cbk) => {
+          const {named} = argument;
+
+          if (!!parameters[named] && argument.type === 'boolean') {
+            return cbk(null, {[named]: parameters[named] === 'true'});
+          }
+
+          if (parameters[named] !== undefined) {
+            return cbk(null, {[named]: parameters[named]});
+          }
+
           if (argument.type === 'boolean') {
             return ask({
               default: false,
-              name: argument.named,
+              name: named,
               message: argument.description,
+              prefix: `[${named}]`,
               type: 'confirm',
             },
             cbk);
@@ -90,7 +118,8 @@ module.exports = ({ask, lnd, logger, method}, cbk) => {
           return ask({
             default: () => !!argument.optional ? String() : undefined,
             message: argument.description,
-            name: argument.named,
+            name: named,
+            prefix: `[${named}]`,
             suffix: !!argument.optional ? ' (Optional)' : String(),
             type: argument.type || 'input',
             validate: input => {

package/lnd/credential_restrictions.js

@@ -0,0 +1,41 @@
+const {noSpendPerms} = require('./constants');
+const {permissionEntities} = require('./constants');
+
+const readPerms = permissionEntities.map(entity => `${entity}:read`);
+
+/** Derive restrictions for macaroon
+
+  {
+    [is_nospend]: <Restrict Credentials To Non-Spending Permissions Bool>
+    [is_readonly]: <Restrict Credentials To Read-Only Permissions Bool>
+    [methods]: [<Allow Specific Method String>]
+  }
+
+  @returns
+  {
+    [allow]: {
+      methods: [<Allow Specific Method String>]
+      permissions: [<Entity:Action String>]
+    }
+  }
+*/
+module.exports = args => {
+  const methods = args.methods || [];
+
+  // Exit early when specific credentials are not requested
+  if (!args.is_readonly && !args.is_nospend && !methods.length) {
+    return {};
+  }
+
+  const permissions = [];
+
+  if (!!args.is_readonly) {
+    readPerms.forEach(n => permissions.push(n));
+  }
+
+  if (!!args.is_nospend) {
+    noSpendPerms.forEach(n => permissions.push(n));
+  }
+
+  return {allow: {methods, permissions}};
+};

package/lnd/find_record.js

@@ -114,7 +114,7 @@ module.exports = ({lnd, query}, cbk) => {
                 color: res.color,
                 features: res.features,
                 public_key: getKey.value.public_key,
-                sockets: res.sockets,
+                sockets: res.sockets.map(n => n.socket),
                 updated_at: res.last_updated,
               }],
             });

package/lnd/get_credentials.js

@@ -16,6 +16,7 @@ const {pemAsDer} = require('./../encryption');
     is_nospend: <Restrict Credentials To Non-Spending Permissions Bool>
     is_readonly: <Restrict Credentials To Read-Only Permissions Bool>
     logger: <Winston Logger Object> ({info}) => ()
+    [methods]: [<Allow Specific Method String>]
     [node]: <Node Name String>
   }
 
@@ -81,6 +82,7 @@ module.exports = (args, cbk) => {
           is_nospend: args.is_nospend,
           is_readonly: args.is_readonly,
           logger: args.logger,
+          methods: args.methods,
           node: args.node,
         },
         cbk);

package/lnd/lnd_credentials.js

@@ -12,6 +12,7 @@ const {grantAccess} = require('ln-service');
 const {restrictMacaroon} = require('ln-service');
 const {returnResult} = require('asyncjs-util');
 
+const credentialRestrictions = require('./credential_restrictions');
 const {decryptCiphertext} = require('./../encryption');
 const {derAsPem} = require('./../encryption');
 const getCert = require('./get_cert');
@@ -38,6 +39,7 @@ const socket = 'localhost:10009';
     [is_readonly]: <Restrict Credentials To Read-Only Permissions Bool>
     [key]: <Encrypt to Public Key DER Hex String>
     [logger]: <Winston Logger Object>
+    [methods]: [<Allow Specific Method String>]
     [node]: <Node Name String> // Defaults to default local mainnet node creds
   }
 
@@ -199,8 +201,14 @@ module.exports = (args, cbk) => {
         'macaroon',
         ({credentials, macaroon}, cbk) =>
       {
+        const {allow} = credentialRestrictions({
+          is_nospend: args.is_nospend,
+          is_readonly: args.is_readonly,
+          methods: args.methods,
+        });
+
         // Exit early when readonly credentials are not requested
-        if (!args.is_readonly && !args.is_nospend) {
+        if (!allow) {
           return cbk(null, {macaroon});
         }
 
@@ -210,9 +218,12 @@ module.exports = (args, cbk) => {
           socket: credentials.socket,
         });
 
-        const permissions = !!args.is_readonly ? readPerms : noSpendPerms;
-
-        return grantAccess({lnd, permissions}, cbk);
+        return grantAccess({
+          lnd,
+          methods: allow.methods,
+          permissions: allow.permissions,
+        },
+        cbk);
       }],
 
       // Final credentials with encryption applied

package/package.json

@@ -25,19 +25,19 @@
     "caporal": "1.4.0",
     "cbor": "8.0.2",
     "cert-info": "1.5.1",
-    "colorette": "2.0.14",
+    "colorette": "2.0.16",
     "crypto-js": "4.1.1",
     "csv-parse": "4.16.3",
     "goldengate": "10.4.0",
     "hot-formula-parser": "4.0.0",
     "import-lazy": "4.0.0",
     "ini": "2.0.0",
-    "inquirer": "8.1.5",
+    "inquirer": "8.2.0",
     "invoices": "2.0.0",
     "ln-accounting": "5.0.3",
-    "ln-service": "52.10.1",
+    "ln-service": "52.11.1",
     "ln-sync": "2.0.2",
-    "ln-telegram": "3.3.0",
+    "ln-telegram": "3.3.1",
     "moment": "2.29.1",
     "paid-services": "3.0.0",
     "probing": "1.3.6",
@@ -80,5 +80,5 @@
     "postpublish": "docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t alexbosworth/balanceofsatoshis --push .",
     "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 -t 60 test/arrays/*.js test/balances/*.js test/chain/*.js test/display/*.js test/encryption/*.js test/fiat/*.js test/lnd/*.js test/network/*.js test/nodes/*.js test/peers/*.js test/responses/*.js test/routing/*.js test/services/*.js test/swaps/*.js test/tags/*.js test/wallets/*.js"
   },
-  "version": "11.2.1"
+  "version": "11.5.1"
 }

package/routing/get_ignores.js

@@ -223,6 +223,7 @@ module.exports = (args, cbk) => {
                   age: getHeight.current_block_height - height,
                   base_fee: Number(outPolicy.base_fee_mtokens) || Number(),
                   fee_rate: outPolicy.fee_rate || Number(),
+                  opposite_fee_rate: peerPolicy.fee_rate || Number(),
                 });
 
                 keys(variables).forEach(key => {
@@ -283,8 +284,9 @@ module.exports = (args, cbk) => {
               .map(({capacity, id, policies}) => {
                 const height = heightFromId(id);
                 const inPolicy = policies.find(n => n.public_key !== key);
+                const outPolicy = policies.find(n => n.public_key === key);
 
-                if (!inPolicy) {
+                if (!inPolicy || !outPolicy) {
                   return;
                 }
 
@@ -299,6 +301,7 @@ module.exports = (args, cbk) => {
                   age: getHeight.current_block_height - height,
                   base_fee: Number(inPolicy.base_fee_mtokens) || Number(),
                   fee_rate: inPolicy.fee_rate || Number(),
+                  opposite_fee_rate: outPolicy.fee_rate || Number(),
                 });
 
                 keys(variables).forEach(key => {

package/telegram/start_telegram_bot.js

@@ -323,7 +323,7 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
           });
         });
 
-        bot.command('liquidity', async ({message, reply}) => {
+        bot.command('liquidity', async ctx => {
           try {
             await asyncRetry({
               errorFilter: err => {
@@ -335,13 +335,14 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
               },
             }, async () => {
               await handleLiquidityCommand({
-                reply,
                 request,
-                from: message.from.id,
+                from: ctx.message.from.id,
                 id: connectedId,
                 key: apiKey.key,
                 nodes: allNodes,
-                text: message.text,
+                reply: ctx.reply,
+                text: ctx.message.text,
+                working: () => ctx.replyWithChatAction('typing'),
               });
             });
           } catch (err) {
@@ -392,6 +393,7 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
               id: connectedId,
               nodes: allNodes,
               reply: n => ctx.reply(n),
+              working: () => ctx.replyWithChatAction('typing'),
             });
           } catch (err) {
             logger.error({err});

package/test/lnd/test_credential_restrictions.js

@@ -0,0 +1,74 @@
+const {test} = require('@alexbosworth/tap');
+
+const method = require('./../../lnd/credential_restrictions');
+
+const tests = [
+  {
+    args: {},
+    description: 'No restrictions results in no allow elements',
+    expected: {},
+  },
+  {
+    args: {is_nospend: true},
+    description: 'No spend results in nospend permissions',
+    expected: {
+      allow: {
+        methods: [],
+        permissions: [
+          'address:read',
+          'address:write',
+          'info:read',
+          'info:write',
+          'invoices:read',
+          'invoices:write',
+          'macaroon:read',
+          'message:read',
+          'offchain:read',
+          'onchain:read',
+          'peers:read',
+          'peers:write',
+          'signer:read',
+        ],
+      },
+    },
+  },
+  {
+    args: {is_readonly: true},
+    description: 'Readonly results in read permissions',
+    expected: {
+      allow: {
+        methods: [],
+        permissions: [
+          'address:read',
+          'info:read',
+          'invoices:read',
+          'macaroon:read',
+          'message:read',
+          'offchain:read',
+          'onchain:read',
+          'peers:read',
+          'signer:read',
+        ],
+      },
+    },
+  },
+  {
+    args: {methods: ['getWalletInfo']},
+    description: 'Readonly results in read permissions',
+    expected: {allow: {methods: ['getWalletInfo'], permissions: []}},
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, async ({end, strictSame, throws}) => {
+    if (!!error) {
+      throws(() => method(args), new Error(error), 'Got expected error');
+    } else {
+      const res = method(args);
+
+      strictSame(res, expected, 'Got expected result');
+    }
+
+    return end();
+  });
+});