balanceofsatoshis 11.36.3 → 11.37.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 11.37.0
+
+- `advertise`: Add support for specifying a maximum ad spend with `--budget`
+
 ## 11.36.3
 
 - `telegram`: Add support for `--use-proxy` to specify a SOCKS proxy server

package/bos

@@ -98,6 +98,7 @@ prog
   .help('use --filter conditions to limit broadcast scope: capacity > 1*m')
   .help('--filter variables: CAPACITY/CHANNELS_COUNT/K/M')
   .help('Default filter scope: channels_count > 9')
+  .option('--budget <budget>', 'Spending amount to allow for advertising', INT)
   .option('--dryrun', 'Avoid actually sending advertisements')
   .option('--filter <expression>', 'Require node match condition', REPEATABLE)
   .option('--message <message>', 'Custom advertisement message')
@@ -107,6 +108,7 @@ prog
       try {
         return await services.advertise({
           logger,
+          budget: options.budget || undefined,
           filters: flatten([options.filter].filter(n => !!n)),
           is_dry_run: !!options.dryrun,
           lnd: (await lndForNode(logger, options.node)).lnd,

package/package.json

@@ -81,5 +81,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/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.36.3"
+  "version": "11.37.0"
 }

package/services/advertise.js

@@ -164,11 +164,22 @@ module.exports = (args, cbk) => {
 
       // Send message to nodes
       send: ['message', 'nodes', ({message, nodes}, cbk) => {
+        const maxSpendPerNode = sendTokens + maxFeeTokens;
         const sent = [];
 
         args.logger.info({routable_nodes: nodes.length});
 
         return asyncMapSeries(nodes, (node, cbk) => {
+          const paidTokens = ceil(Number(sent.reduce((sum, n) => {
+            return sum + BigInt(n.mtokens) + BigInt(n.fee_mtokens);
+          },
+          BigInt(Number()))) / mtokPerToken);
+
+          // Check that the potential next ad would not go over budget
+          if (!!args.budget && paidTokens + maxSpendPerNode > args.budget) {
+            return cbk([400, 'AdvertisingBudgetExhausted']);
+          }
+
           const probe = subscribeToProbeForRoute({
             cltv_delay: cltvDelay,
             destination: node.public_key,