lightning/test/typescript/failure_from_payment.test-d.ts

Lightning Network client library

import {expectError, expectType} from 'tsd';
import {failureFromPayment} from '../../lnd_responses/failure_from_payment';

const payment_hash = Buffer.alloc(32).toString('hex')

expectError(failureFromPayment());
expectError(failureFromPayment({}));
expectError(failureFromPayment({payment_hash, failure_reason: 'invalid failure reason'}));

expectType<{
  id: string;
  is_insufficient_balance: boolean;
  is_invalid_payment: boolean;
  is_pathfinding_timeout: boolean;
  is_route_not_found: boolean;
}>(failureFromPayment({payment_hash, failure_reason: 'FAILURE_REASON_NONE'}));
expectType<{
  id: string;
  is_insufficient_balance: true;
  is_invalid_payment: false;
  is_pathfinding_timeout: false;
  is_route_not_found: false;
}>(failureFromPayment({payment_hash, failure_reason: 'FAILURE_REASON_INSUFFICIENT_BALANCE'}));
expectType<{
  id: string;
  is_insufficient_balance: false;
  is_invalid_payment: true;
  is_pathfinding_timeout: false;
  is_route_not_found: false;
}>(
  failureFromPayment({
    payment_hash,
    failure_reason: 'FAILURE_REASON_INCORRECT_PAYMENT_DETAILS',
  })
);
expectType<{
  id: string;
  is_insufficient_balance: false;
  is_invalid_payment: false;
  is_pathfinding_timeout: true;
  is_route_not_found: false;
}>(failureFromPayment({payment_hash, failure_reason: 'FAILURE_REASON_TIMEOUT'}));
expectType<{
  id: string;
  is_insufficient_balance: false;
  is_invalid_payment: false;
  is_pathfinding_timeout: false;
  is_route_not_found: true;
}>(failureFromPayment({payment_hash, failure_reason: 'FAILURE_REASON_NO_ROUTE'}));