lightning/test/lnd_methods/invoices/test_subscribe_to_invoice.js

Lightning Network client library

const {deepStrictEqual} = require('node:assert').strict;
const EventEmitter = require('events');
const {rejects} = require('node:assert').strict;
const {strictEqual} = require('node:assert').strict;
const test = require('node:test');
const {throws} = require('node:assert').strict;

const {lookupInvoiceResponse} = require('./../fixtures');
const {subscribeToInvoice} = require('./../../../');

const emitter = new EventEmitter();

emitter.cancel = () => {};

const makeLnd = ({err}) => {
  return {invoices: {subscribeSingleInvoice: ({}) => emitter}};
};

const tests = [
  {
    args: {},
    description: 'An id is required to subscribe to an invoice',
    error: 'ExpectedIdOfInvoiceToSubscribeTo',
  },
  {
    args: {id: 'id'},
    description: 'A hex id is required to subscribe to an invoice',
    error: 'ExpectedIdOfInvoiceToSubscribeTo',
  },
  {
    args: {id: '00'},
    description: 'LND is required to subscribe to an invoice',
    error: 'ExpectedInvoiceLndToSubscribeToSingleInvoice',
  },
  {
    args: {id: '00', lnd: makeLnd({}), restart_delay_ms: 1},
    description: 'An invoice is subscribed to',
    expected: {
      invoice: {
        chain_address: undefined,
        cltv_delta: 1,
        confirmed_at: undefined,
        confirmed_index: 1,
        created_at: '1970-01-01T00:00:01.000Z',
        description: '',
        description_hash: undefined,
        expires_at: '1970-01-01T00:00:02.000Z',
        features: [],
        id: '0000000000000000000000000000000000000000000000000000000000000000',
        index: 1,
        is_canceled: true,
        is_confirmed: false,
        is_held: undefined,
        is_private: false,
        is_push: undefined,
        mtokens: '1000',
        payment: undefined,
        payments: [],
        received: 0,
        received_mtokens: '0',
        request: 'request',
        secret: '0000000000000000000000000000000000000000000000000000000000000000',
        tokens: 1
      },
    },
  },
  {
    args: {added_after: 1, id: '00', lnd: makeLnd({}), restart_delay_ms: 1},
    description: 'Subscribe to invoices with cursor',
    expected: {
      invoice: {
        chain_address: undefined,
        cltv_delta: 1,
        confirmed_at: undefined,
        confirmed_index: 1,
        created_at: '1970-01-01T00:00:01.000Z',
        description: '',
        description_hash: undefined,
        expires_at: '1970-01-01T00:00:02.000Z',
        features: [],
        id: '0000000000000000000000000000000000000000000000000000000000000000',
        index: 1,
        is_canceled: true,
        is_confirmed: false,
        is_held: undefined,
        is_private: false,
        is_push: undefined,
        mtokens: '1000',
        payment: undefined,
        payments: [],
        received: 0,
        received_mtokens: '0',
        request: 'request',
        secret: '0000000000000000000000000000000000000000000000000000000000000000',
        tokens: 1
      },
    },
  },
];

tests.forEach(({args, description, error, expected}) => {
  return test(description, (t, end) => {
    if (!!error) {
      throws(() => subscribeToInvoice(args), new Error(error), 'Got error');
    } else {
      let gotEnd;
      let gotErr;
      let gotErr2 = null;
      let gotErr3;
      let gotInvoice;
      let gotStatus;
      const sub = subscribeToInvoice(args);

      sub.on('end', () => gotEnd = true);
      sub.on('error', err => gotErr = err);
      sub.on('invoice_updated', invoice => gotInvoice = invoice);
      sub.on('status', status => gotStatus = status);

      emitter.emit('end', {});
      emitter.emit('error', new Error('error'));
      emitter.emit('status', 'status');

      sub.removeAllListeners('error');

      emitter.emit('error', new Error('error'));

      strictEqual(gotEnd, true, 'Got end event');
      deepStrictEqual(gotErr, new Error('error'), 'Got expected error');
      strictEqual(gotErr2, null, 'Did not get second error');
      strictEqual(gotStatus, 'status', 'Got expected status');

      sub.on('error', err => gotErr3 = err);

      emitter.emit('data', {});

      const invoiceError = 'ExpectedInvoiceCreationDateInResponse';

      deepStrictEqual(gotErr3, [503, invoiceError], 'Got invoice update err');

      emitter.emit('data', lookupInvoiceResponse({}));

      deepStrictEqual(gotInvoice, expected.invoice, 'Got expected invoice');
    }

    return end();
  });
});