lightning/test/lnd_methods/onchain/test_broadcast_chain_transaction.js

Lightning Network client library

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

const {Transaction} = require('bitcoinjs-lib');

const {broadcastChainTransaction} = require('./../../../lnd_methods');

const tests = [
  {
    args: {},
    description: 'LND is required',
    error: [400, 'ExpectedWalletRpcLndToSendRawTransaction'],
  },
  {
    args: {lnd: {wallet: {publishTransaction: ({}, cbk) => cbk()}}},
    description: 'Raw transaction is required',
    error: [400, 'ExpectedTransactionHexStringToBroadcastToPeers'],
  },
  {
    args: {
      lnd: {wallet: {publishTransaction: ({}, cbk) => cbk('err')}},
      transaction: new Transaction().toHex(),
    },
    description: 'Expected error is returned',
    error: [503, 'UnexpectedErrBroadcastingRawTx', {err: 'err'}],
  },
  {
    args: {
      lnd: {wallet: {publishTransaction: ({}, cbk) => cbk()}},
      transaction: new Transaction().toHex(),
    },
    description: 'A result is required',
    error: [503, 'ExpectedResultOfBroadcastRawTransaction'],
  },
  {
    args: {
      lnd: {
        wallet: {
          publishTransaction: ({}, cbk) => cbk(null, {publish_error: 'err'}),
        },
      },
      transaction: new Transaction().toHex(),
    },
    description: 'Failure to broadcast error is returned',
    error: [
      503,
      'FailedToBroadcastRawTransaction',
      {res: {publish_error: 'err'}},
    ],
  },
  {
    args: {
      lnd: {
        wallet: {
          publishTransaction: ({}, cbk) => cbk({
            details: 'unmatched backend error: -26: mempool min fee not met, 123 < 1234',
          }),
        },
      },
      transaction: new Transaction().toHex(),
    },
    description: 'Minimum relay fee not met',
    error: [
      503,
      'ChainBackendMinimumRelayFeeNotMet',
      {
        fee: 123,
        minimum: 1234,
      },
    ],
  },
  {
    args: {
      lnd: {wallet: {publishTransaction: ({}, cbk) => cbk(null, {})}},
      transaction: new Transaction().toHex(),
    },
    description: 'A transaction is published',
    expected: {
      id: 'd21633ba23f70118185227be58a63527675641ad37967e2aa461559f577aec43',
    },
  },
];

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

      strictEqual(id, expected.id, 'Got fee rate');
    }

    return;
  });
});