lightning/test/lnd_methods/onchain/test_sign_chain_address_message.js

Lightning Network client library

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

const {signChainAddressMessage} = require('./../../../');

const makeArgs = override => {
  const args = {
    address: 'address',
    lnd: {
      wallet: {
        signMessageWithAddr: ({}, cbk) => cbk(null, {signature: '12345'}),
      },
    },
    message: 'message',
  };

  Object.keys(override).forEach(attr => args[attr] = override[attr]);

  return args;
};

const tests = [
  {
    args: makeArgs({address: undefined}),
    description: 'A chain address is required to sign a message',
    error: [400, 'ExpectedChainAddressToSignChainAddressMessage'],
  },
  {
    args: makeArgs({lnd: undefined}),
    description: 'LND is required to sign a message',
    error: [400, 'ExpectedLndToSignChainAddressMessage'],
  },
  {
    args: makeArgs({message: undefined}),
    description: 'A message is required to sign a message',
    error: [400, 'ExpectedMessageToSignChainAddressMessage'],
  },
  {
    args: makeArgs({
      lnd: {
        wallet: {
          signMessageWithAddr: ({}, cbk) => cbk({
            details: 'unknown method SignMessageWithAddr for service walletrpc.WalletKit',
          }),
        },
      },
    }),
    description: 'Unsupported error is returned',
    error: [501, 'BackingLndDoesNotSupportSigningChainMessages'],
  },
  {
    args: makeArgs({
      lnd: {wallet: {signMessageWithAddr: ({}, cbk) => cbk('err')}},
    }),
    description: 'Unexpected error is returned',
    error: [503, 'UnexpectedSignChainAddressMessageError', {err: 'err'}],
  },
  {
    args: makeArgs({lnd: {wallet: {signMessageWithAddr: ({}, cbk) => cbk()}}}),
    description: 'A response is expected',
    error: [503, 'ExpectedResponseToSignChainAddrMessageRequest'],
  },
  {
    args: makeArgs({
      lnd: {wallet: {signMessageWithAddr: ({}, cbk) => cbk(null, {})}},
    }),
    description: 'A signature is expected',
    error: [503, 'ExpectedSignatureForChainMessageSignRequest'],
  },
  {
    args: makeArgs({}),
    description: 'Signature produced',
    expected: {signature: 'd76df8'},
  },
];

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

    return;
  });
});