ln-telegram/test/post/test_notify_of_forwards.js

Lightning Network Telegram bot commands

const {deepEqual} = require('node:assert').strict;
const {rejects} = require('node:assert').strict;
const test = require('node:test');

const {chanInfoResult} = require('./../fixtures');
const {getInfoResponse} = require('./../fixtures');
const {nodeInfoResult} = require('./../fixtures');
const {versionInfo} = require('./../fixtures');
const {notifyOfForwards} = require('./../../');

const makeArgs = overrides => {
  const args = {
    forwards: [],
    from: 'from',
    id: 1,
    lnd: {},
    node: Buffer.alloc(33).toString('hex'),
    nodes: [
      {public_key: Buffer.alloc(33, 2).toString('hex')},
      {public_key: Buffer.alloc(33, 3).toString('hex')},
    ],
    send: ({}) => new Promise(resolve => resolve()),
  };

  Object.keys(overrides).forEach(k => args[k] = overrides[k]);

  return args;
};

const getInfoRes = () => JSON.parse(JSON.stringify(getInfoResponse));

const tests = [
  {
    args: makeArgs({forwards: undefined}),
    description: 'A forwards array is required to notify of forwards',
    error: [400, 'ExpectedForwardsArrayToNotifyOfForwards'],
  },
  {
    args: makeArgs({from: undefined}),
    description: 'A from name is required to notify of forwards',
    error: [400, 'ExpectedFromNodeNameToNotifyOfForwards'],
  },
  {
    args: makeArgs({id: undefined}),
    description: 'A user id is required to notify of forwards',
    error: [400, 'ExpectedConnectedUserIdToNotifyOfForwards'],
  },
  {
    args: makeArgs({lnd: undefined}),
    description: 'An lnd connection is required to notify of forwards',
    error: [400, 'ExpectedLndToNotifyOfForwards'],
  },
  {
    args: makeArgs({node: undefined}),
    description: 'A node public key is required to notify of forwards',
    error: [400, 'ExpectedFromNodePublicKeyToNotifyOfForwards'],
  },
  {
    args: makeArgs({nodes: undefined}),
    description: 'Nodes are required to notify of forwards',
    error: [400, 'ExpectedArrayOfNodesToNotifyOfForwards'],
  },
  {
    args: makeArgs({send: undefined}),
    description: 'A send function is required to notify of forwards',
    error: [400, 'ExpectedSendFunctionToNotifyOfForwards'],
  },
  {
    args: makeArgs({}),
    description: 'No forwards yields no notifications',
  },
  {
    args: makeArgs({
      forwards: [{
        fee_mtokens: '1000',
        incoming_channel: '0x0x1',
        mtokens: '1000',
        outgoing_channel: '1x1x1',
      }],
      lnd: {
        default: {
          getChanInfo: (args, cbk) => cbk(null, chanInfoResult),
          getInfo: ({}, cbk) => cbk(null, getInfoRes()),
          getNodeInfo: ({}, cbk) => cbk(null, nodeInfoResult),
        },
        version: {
          getVersion: ({}, cbk) => cbk(null, versionInfo),
        },
      },
    }),
    description: 'A forward is mapped to a forward notification',
    expected: '💰 Forwarded 0\\.00000001 alias *→* alias\\. Earned 0\\.00000001 100\\.00% \\(1000000\\) \\- _from_',
  },
  {
    args: makeArgs({
      forwards: [{
        fee_mtokens: '1000',
        incoming_channel: '0x0x1',
        mtokens: '1000',
        outgoing_channel: '1x1x1',
      }],
      lnd: {
        default: {
          getChanInfo: (args, cbk) => cbk(null, chanInfoResult),
          getInfo: ({}, cbk) => cbk(null, getInfoRes()),
          getNodeInfo: ({}, cbk) => cbk(null, nodeInfoResult),
        },
        version: {
          getVersion: ({}, cbk) => cbk(null, versionInfo),
        },
      },
      nodes: [{}],
    }),
    description: 'From is dropped when there is only one node',
    expected: '💰 Forwarded 0\\.00000001 alias *→* alias\\. Earned 0\\.00000001 100\\.00% \\(1000000\\)',
  },
  {
    args: makeArgs({
      forwards: [{
        fee_mtokens: '1000',
        incoming_channel: '0x0x1',
        mtokens: '1000',
        outgoing_channel: '1x1x1',
      }],
      lnd: {
        default: {
          getChanInfo: (args, cbk) => cbk('err'),
          getInfo: ({}, cbk) => cbk(null, getInfoRes()),
          getNodeInfo: ({}, cbk) => cbk(null, nodeInfoResult),
        },
        version: {
          getVersion: ({}, cbk) => cbk(null, versionInfo),
        },
      },
      nodes: [{}],
    }),
    description: 'Channel aliases skipped when a channel error is returned',
    expected: '💰 Forwarded 0\\.00000001 0x0x1 *→* 1x1x1\\. Earned 0\\.00000001 100\\.00% \\(1000000\\)',
  },
];

tests.forEach(({args, description, error, expected}) => {
  return test(description, async () => {
    if (!!error) {
      await rejects(notifyOfForwards(args), error, 'Got expected error');
    } else {
      const res = await notifyOfForwards(args);

      deepEqual(res, expected, 'Got expected result');
    }

    return;
  });
});