astra-lightning 1.0.0

package/test/lnd_methods/generic/test_get_route_confidence.js

@@ -0,0 +1,143 @@
+const {deepStrictEqual} = require('node:assert').strict;
+const EventEmitter = require('events');
+const {rejects} = require('node:assert').strict;
+const test = require('node:test');
+
+const {getInfoResponse} = require('./../fixtures');
+const {getRouteConfidence} = require('./../../../');
+
+const makeLnd = ({err, res}) => {
+  return {
+    default: {
+      getInfo: ({}, cbk) => cbk(err, getInfoResponse),
+    },
+    router: {
+      queryMissionControl: ({}, cbk) => {
+        if (!!err) {
+          return cbk(err);
+        }
+
+        if (res !== undefined) {
+          return cbk(null, res);
+        }
+
+        return cbk(null, {
+          pairs: [{
+            history: {
+              fail_amt_msat: '1000',
+              fail_amt_sat: '1',
+              fail_time: '1',
+              success_amt_msat: '1000',
+              success_amt_sat: '1',
+              success_time: '1',
+            },
+            node_from: Buffer.alloc(33, 3),
+            node_to: Buffer.alloc(33, 2),
+          }],
+        });
+      },
+      queryProbability: ({}, cbk) => {
+        if (!!err) {
+          return cbk(err);
+        }
+
+        if (res !== undefined) {
+          return cbk(null, res);
+        }
+
+        return cbk(null, {history: {}, probability: 0.5});
+      },
+    },
+    wallet: {
+      deriveKey: ({}, cbk) => cbk('err'),
+    },
+  };
+};
+
+const tests = [
+  {
+    args: {},
+    description: 'Hops are required',
+    error: [400, 'ExpectedArrayOfHopsToCalculateRoutingOdds'],
+  },
+  {
+    args: {hops: [{}]},
+    description: 'Valid hops are required',
+    error: [400, 'ExpectedHopsWithEdges'],
+  },
+  {
+    args: {
+      from: Buffer.alloc(33, 1).toString('hex'),
+      hops: [{
+        forward_mtokens: '1',
+        public_key: Buffer.alloc(33, 2).toString('hex'),
+      }],
+      lnd: {
+        default: {
+          getInfo: ({}, cbk) => cbk(null, getInfoResponse),
+        },
+        router: {
+          queryMissionControl: ({}, cbk) => {
+            return cbk(null, {
+              pairs: [{
+                history: {
+                  fail_amt_msat: '1000',
+                  fail_amt_sat: '1',
+                  fail_time: '1',
+                  success_amt_msat: '1000',
+                  success_amt_sat: '1',
+                  success_time: '1',
+                },
+                node_from: Buffer.alloc(33, 3),
+                node_to: Buffer.alloc(33, 2),
+              }],
+            });
+          },
+          queryProbability: ({}, cbk) => cbk('err'),
+        },
+        wallet: {
+          deriveKey: ({}, cbk) => cbk('err'),
+        },
+      },
+    },
+    description: 'Get route confidence when confidence query returns err',
+    error: [503, 'UnexpectedErrorFromQueryProbability', {err: 'err'}],
+  },
+  {
+    args: {
+      from: Buffer.alloc(33, 1).toString('hex'),
+      hops: [{
+        forward_mtokens: '1',
+        public_key: Buffer.alloc(33, 2).toString('hex'),
+      }],
+      lnd: makeLnd({}),
+    },
+    description: 'Get route confidence from non self',
+    expected: {confidence: 950000},
+  },
+  {
+    args: {
+      hops: [{
+        forward_mtokens: '1',
+        public_key: Buffer.alloc(33, 2).toString('hex'),
+      }],
+      lnd: makeLnd({}),
+    },
+    description: 'Get route confidence',
+    expected: {confidence: 950000},
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, async () => {
+    if (!!error) {
+      await rejects(getRouteConfidence(args), error, 'Got expected error');
+    } else {
+      const got = await getRouteConfidence(args);
+
+      deepStrictEqual(got, expected, 'Got expected result');
+    }
+
+    return;
+  });
+});

package/test/lnd_methods/info/test_get_autopilot.js

@@ -0,0 +1,292 @@
+const {equal} = require('node:assert').strict;
+const test = require('node:test');
+
+const {getAutopilot} = require('./../../../');
+
+const tests = [
+  {
+    args: {lnd: {}},
+    description: 'Get autopilot with the wrong lnd',
+    expected: {
+      error_code: 400,
+      error_message: 'ExpectedAutopilotEnabledLndToGetAutopilotStatus',
+    },
+  },
+  {
+    args: {
+      lnd: {
+        autopilot: {
+          queryScores: ({}, cbk) => cbk(),
+          status: ({}, cbk) => cbk(null, {active: false}),
+        },
+      },
+    },
+    description: 'Lookup enabled status',
+    expected: {is_enabled: false},
+  },
+  {
+    args: {
+      lnd: {
+        autopilot: {
+          queryScores: ({}, cbk) => cbk('err'),
+          status: ({}, cbk) => cbk(null, {active: false}),
+        },
+      },
+      node_scores: ['foo'],
+    },
+    description: 'Result error is passed back',
+    expected: {
+      error_code: 503,
+      error_message: 'UnexpectedErrorGettingNodeScores',
+    },
+  },
+  {
+    args: {
+      lnd: {
+        autopilot: {
+          queryScores: ({}, cbk) => cbk(),
+          status: ({}, cbk) => cbk(null, {active: false}),
+        },
+      },
+      node_scores: ['foo'],
+    },
+    description: 'Result is expected',
+    expected: {
+      error_code: 503,
+      error_message: 'ExpectedResultForLocalNodeScoresQuery',
+    },
+  },
+  {
+    args: {
+      lnd: {
+        autopilot: {
+          queryScores: ({}, cbk) => cbk(null, {}),
+          status: ({}, cbk) => cbk(null, {active: false}),
+        },
+      },
+      node_scores: ['foo'],
+    },
+    description: 'Result array is expected',
+    expected: {
+      error_code: 503,
+      error_message: 'ExpectedArrayOfResultsForNodesScoresQuery',
+    },
+  },
+  {
+    args: {
+      lnd: {
+        autopilot: {
+          queryScores: ({}, cbk) => cbk(null, {results: [null]}),
+          status: ({}, cbk) => cbk(null, {active: false}),
+        },
+      },
+      node_scores: ['foo'],
+    },
+    description: 'Result objects are expected',
+    expected: {
+      error_code: 503,
+      error_message: 'UnexpectedHeuristicResultSetInNodeScores',
+    },
+  },
+  {
+    args: {
+      lnd: {
+        autopilot: {
+          queryScores: ({}, cbk) => cbk(null, {results: [{}]}),
+          status: ({}, cbk) => cbk(null, {active: false}),
+        },
+      },
+      node_scores: ['foo'],
+    },
+    description: 'Result objects are expected',
+    expected: {
+      error_code: 503,
+      error_message: 'ExpectedHeuristicLabelForNodeScoreSet',
+    },
+  },
+  {
+    args: {
+      lnd: {
+        autopilot: {
+          queryScores: ({}, cbk) => {
+            return cbk(null, {results: [{heuristic: 'externalscore'}]});
+          },
+          status: ({}, cbk) => cbk({
+            message: '12 UNIMPLEMENTED: unknown service autopilotrpc.Autopilot',
+          }),
+        },
+      },
+      node_scores: ['foo'],
+    },
+    description: 'Autopilot built lnd is expected',
+    expected: {
+      error_code: 400,
+      error_message: 'ExpectedLndBuiltWithAutopilotToGetStatus',
+    },
+  },
+  {
+    args: {
+      lnd: {
+        autopilot: {
+          queryScores: ({}, cbk) => {
+            return cbk(null, {results: [{heuristic: 'externalscore'}]});
+          },
+          status: ({}, cbk) => cbk('err'),
+        },
+      },
+      node_scores: ['foo'],
+    },
+    description: 'Lookup status error passes back error',
+    expected: {
+      error_code: 503,
+      error_message: 'UnexpectedErrorGettingAutopilotStatus',
+    },
+  },
+  {
+    args: {
+      lnd: {
+        autopilot: {
+          queryScores: ({}, cbk) => {
+            return cbk(null, {results: [{heuristic: 'externalscore'}]});
+          },
+          status: ({}, cbk) => cbk(),
+        },
+      },
+      node_scores: ['foo'],
+    },
+    description: 'Lookup status expects status',
+    expected: {
+      error_code: 503,
+      error_message: 'UnexpectedEmptyResultGettingAutopilotStatus',
+    },
+  },
+  {
+    args: {
+      lnd: {
+        autopilot: {
+          queryScores: ({}, cbk) => {
+            return cbk(null, {results: [{heuristic: 'externalscore'}]});
+          },
+          status: ({}, cbk) => cbk(null, {}),
+        },
+      },
+      node_scores: ['foo'],
+    },
+    description: 'Lookup status expects status state',
+    expected: {
+      error_code: 503,
+      error_message: 'UnexpectedResponseForAutopilotStatusQuery',
+    },
+  },
+  {
+    args: {
+      lnd: {
+        autopilot: {
+          queryScores: ({}, cbk) => {
+            return cbk(null, {results: [{heuristic: 'externalscore'}]});
+          },
+          status: ({}, cbk) => cbk(null, {active: true}),
+        },
+      },
+      node_scores: ['foo'],
+    },
+    description: 'Lookup node scores expects scores',
+    expected: {
+      error_code: 503,
+      error_message: 'ExpectedScoresForNodesInScoreResults',
+    },
+  },
+  {
+    args: {
+      lnd: {
+        autopilot: {
+          queryScores: (args, cbk) => {
+            return cbk(null, {
+              results: [
+                {heuristic: 'externalscore', scores: {foo: 0.5}},
+                {heuristic: 'preferential', scores: {foo: 1}},
+                {heuristic: 'weightedcomb', scores: {foo: 0.75}},
+              ],
+            });
+          },
+          status: ({}, cbk) => cbk(null, {active: true}),
+        },
+      },
+      node_scores: ['foo'],
+    },
+    description: 'Lookup node scores',
+    expected: {
+      is_enabled: true,
+      node: {
+        local_preferential_score: 100000000,
+        local_score: 50000000,
+        preferential_score: 100000000,
+        public_key: 'foo',
+        score: 50000000,
+        weighted_local_score: 75000000,
+        weighted_score: 75000000,
+      },
+    },
+  },
+];
+
+tests.forEach(({args, description, expected}) => {
+  return test(description, (t, end) => {
+    getAutopilot(args, (err, res) => {
+      const [errCode, errMessage] = err || [];
+
+      if (!!expected.error_code || !!errCode) {
+        equal(errCode, expected.error_code, 'Got expected error code');
+      }
+
+      if (!!expected.error_message || !!errMessage) {
+        equal(errMessage, expected.error_message, 'Got expected err message');
+      }
+
+      if (!!err) {
+        return end();
+      }
+
+      equal(res.is_enabled, expected.is_enabled, 'Got is_enabled as expected');
+
+      if (!!expected.node) {
+        const [node] = res.nodes || [];
+
+        equal(
+          node.local_preferential_score,
+          expected.node.local_preferential_score,
+          'Local preferential score'
+        );
+
+        equal(
+          node.local_score,
+          expected.node.local_score,
+          'Local external score'
+        );
+
+        equal(
+          node.preferential_score,
+          expected.node.preferential_score,
+          'Preferential score'
+        );
+
+        equal(node.public_key, expected.node.public_key, 'Node public key');
+        equal(node.score, expected.node.score, 'Node external score');
+
+        equal(
+          node.weighted_local_score,
+          expected.node.weighted_local_score,
+          'Weighted score, local representation'
+        );
+
+        equal(
+          node.weighted_score,
+          expected.node.weighted_score,
+          'Weighted score'
+        );
+      }
+
+      return end();
+    });
+  });
+});

package/test/lnd_methods/info/test_get_channel.js

@@ -0,0 +1,257 @@
+const {deepStrictEqual} = require('node:assert').strict;
+const {rejects} = require('node:assert').strict;
+const test = require('node:test');
+
+const {getChannel} = require('./../../../');
+
+const tests = [
+  {
+    args: {},
+    description: 'An id for a channel is required',
+    error: [400, 'ExpectedChannelIdOrFundingOutpointToGetChannel'],
+  },
+  {
+    args: {id: 'id'},
+    description: 'LND is required to get the channel',
+    error: [400, 'ExpectedLndToGetChannelDetails'],
+  },
+  {
+    args: {id: 'id', transaction_id: '00'},
+    description: 'Only one identifier is required to get channel',
+    error: [400, 'ExpectedEitherChannelIdOrOutpointToGetChannel'],
+  },
+  {
+    args: {
+      lnd: {
+        default: {
+          getChanInfo: ({}, cbk) => cbk({details: 'edge marked as zombie'}),
+        },
+      },
+      transaction_id: '00',
+    },
+    description: 'A transaction output index is required',
+    error: [400, 'ExpectedChannelFundingOutputIndexToGetChannel'],
+  },
+  {
+    args: {
+      id: 'id',
+      lnd: {
+        default: {
+          getChanInfo: ({}, cbk) => cbk({details: 'edge marked as zombie'}),
+        },
+      },
+    },
+    description: 'Edge zombie failures are returned',
+    error: [404, 'FullChannelDetailsNotFound'],
+  },
+  {
+    args: {
+      id: 'id',
+      lnd: {
+        default: {getChanInfo: ({}, cbk) => cbk({details: 'edge not found'})}
+      },
+    },
+    description: 'Edge lookup failures are returned',
+    error: [404, 'FullChannelDetailsNotFound'],
+  },
+  {
+    args: {id: 'id', lnd: {default: {getChanInfo: ({}, cbk) => cbk('err')}}},
+    description: 'Get channel errors are passed back from LND',
+    error: [503, 'UnexpectedGetChannelInfoError', {err: 'err'}],
+  },
+  {
+    args: {id: 'id', lnd: {default: {getChanInfo: ({}, cbk) => cbk()}}},
+    description: 'A channel response is expected',
+    error: [503, 'ExpectedGetChannelResponse'],
+  },
+  {
+    args: {
+      id: 'id',
+      lnd: {
+        default: {
+          getChanInfo: ({}, cbk) => {
+            return cbk(null, {
+              chan_point: `${Buffer.alloc(32).toString('hex')}:0`,
+              channel_id: '000000000',
+              node1_policy: {
+                disabled: true,
+                fee_base_msat: '1',
+                fee_rate_milli_msat: '1',
+                last_update: 1,
+                max_htlc_msat: '1',
+                min_htlc: '1',
+                time_lock_delta: 1,
+              },
+              node1_pub: Buffer.alloc(33).toString('hex'),
+              node2_policy: {
+                disabled: false,
+                fee_base_msat: '2',
+                fee_rate_milli_msat: '2',
+                last_update: 1,
+                max_htlc_msat: '2',
+                min_htlc: '2',
+                time_lock_delta: 2,
+              },
+              node2_pub: Buffer.alloc(33, 1).toString('hex'),
+            });
+          },
+        },
+      },
+    },
+    description: 'A valid channel is expected',
+    error: [503, 'ExpectedChannelCapacityInChannelEdgeResponse'],
+  },
+  {
+    args: {
+      id: 'id',
+      lnd: {
+        default: {
+          getChanInfo: ({}, cbk) => {
+            return cbk(null, {
+              capacity: '1',
+              chan_point: `${Buffer.alloc(32).toString('hex')}:0`,
+              channel_id: '000000000',
+              node1_policy: {
+                disabled: true,
+                fee_base_msat: '1',
+                fee_rate_milli_msat: '1',
+                last_update: 1,
+                max_htlc_msat: '1',
+                min_htlc: '1',
+                time_lock_delta: 1,
+              },
+              node1_pub: Buffer.alloc(33).toString('hex'),
+              node2_policy: {
+                disabled: false,
+                fee_base_msat: '2',
+                fee_rate_milli_msat: '2',
+                last_update: 1,
+                max_htlc_msat: '2',
+                min_htlc: '2',
+                time_lock_delta: 2,
+              },
+              node2_pub: Buffer.alloc(33, 1).toString('hex'),
+            });
+          },
+        },
+      },
+    },
+    description: 'Gets graph channel details',
+    expected: {
+      capacity: 1,
+      id: '0x0x0',
+      policies: [
+        {
+          base_fee_mtokens: '1',
+          cltv_delta: 1,
+          fee_rate: 1,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
+          is_disabled: true,
+          max_htlc_mtokens: '1',
+          min_htlc_mtokens: '1',
+          public_key: Buffer.alloc(33).toString('hex'),
+          updated_at: new Date(1000).toISOString(),
+        },
+        {
+          base_fee_mtokens: '2',
+          cltv_delta: 2,
+          fee_rate: 2,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
+          is_disabled: false,
+          max_htlc_mtokens: '2',
+          min_htlc_mtokens: '2',
+          public_key: Buffer.alloc(33, 1).toString('hex'),
+          updated_at: new Date(1000).toISOString(),
+        },
+      ],
+      transaction_id: Buffer.alloc(32).toString('hex'),
+      transaction_vout: 0,
+      updated_at: new Date(1000).toISOString(),
+    },
+  },
+  {
+    args: {
+      lnd: {
+        default: {
+          getChanInfo: ({}, cbk) => {
+            return cbk(null, {
+              capacity: '1',
+              chan_point: `${Buffer.alloc(32).toString('hex')}:0`,
+              channel_id: '000000000',
+              node1_policy: {
+                disabled: true,
+                fee_base_msat: '1',
+                fee_rate_milli_msat: '1',
+                last_update: 1,
+                max_htlc_msat: '1',
+                min_htlc: '1',
+                time_lock_delta: 1,
+              },
+              node1_pub: Buffer.alloc(33).toString('hex'),
+              node2_policy: {
+                disabled: false,
+                fee_base_msat: '2',
+                fee_rate_milli_msat: '2',
+                last_update: 1,
+                max_htlc_msat: '2',
+                min_htlc: '2',
+                time_lock_delta: 2,
+              },
+              node2_pub: Buffer.alloc(33, 1).toString('hex'),
+            });
+          },
+        },
+      },
+      transaction_id: Buffer.alloc(32).toString('hex'),
+      transaction_vout: 0,
+    },
+    description: 'Gets graph channel details',
+    expected: {
+      capacity: 1,
+      id: '0x0x0',
+      policies: [
+        {
+          base_fee_mtokens: '1',
+          cltv_delta: 1,
+          fee_rate: 1,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
+          is_disabled: true,
+          max_htlc_mtokens: '1',
+          min_htlc_mtokens: '1',
+          public_key: Buffer.alloc(33).toString('hex'),
+          updated_at: new Date(1000).toISOString(),
+        },
+        {
+          base_fee_mtokens: '2',
+          cltv_delta: 2,
+          fee_rate: 2,
+          inbound_base_discount_mtokens: '0',
+          inbound_rate_discount: 0,
+          is_disabled: false,
+          max_htlc_mtokens: '2',
+          min_htlc_mtokens: '2',
+          public_key: Buffer.alloc(33, 1).toString('hex'),
+          updated_at: new Date(1000).toISOString(),
+        },
+      ],
+      transaction_id: Buffer.alloc(32).toString('hex'),
+      transaction_vout: 0,
+      updated_at: new Date(1000).toISOString(),
+    },
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, async () => {
+    if (!!error) {
+      await rejects(() => getChannel(args), error, 'Got expected error');
+    } else {
+      deepStrictEqual(await getChannel(args), expected, 'Got channel');
+    }
+
+    return;
+  });
+});