lightning/lnd_responses/payment_failure.js

Lightning Network client library

const {chanFormat} = require('bolt07');

const policyFromChannelUpdate = require('./policy_from_channel_update');

/** Derive payment failure from raw API failure

  {
    [channel]: <Failure Source Channel Id String>
    failure: {
      [channel_update]: {
        base_fee: <Base Fee Millitokens Number>
        chain_hash: <Chain Hash Buffer Object>
        [chan_id]: <Numeric Channel Id String>
        channel_flags: <Channel Flags Number>
        extra_opaque_data: <Extra Opaque Data Buffer Object>
        fee_rate: <Fee Rate Number>
        htlc_maximum_msat: <Maximum HTLC Millitokens Number>
        htlc_minimum_msat: <Minimum HTLC Millitokens Number>
        message_flags: <Message Flags Number>
        signature: <Signature Buffer Object>
        time_lock_delta: <CLTV Delta Number>
        timestamp: <Update Epoch Time Seconds Number>
      }
      code: <Failure Code String>
      [failure_source_index]: <Failed Hop Index Number>
      height: <Height Number>
      htlc_msat: <HTLC Millitokens String>
    }
    index: <Failure Index Number>
    [key]: <From Public Key Hex String>
    [keys]: [<Public Key Hex String>]
  }

  @returns
  {
    code: <Error Type Code Number>
    [details]: {
      [channel]: <Standard Format Channel Id String>
      [height]: <Error Associated Block Height Number>
      [index]: <Failed Hop Index Number>
      [mtokens]: <Error Millitokens String>
      [policy]: {
        base_fee_mtokens: <Base Fee Millitokens String>
        cltv_delta: <Locktime Delta Number>
        fee_rate: <Fees Charged in Millitokens Per Million Number>
        [is_disabled]: <Channel is Disabled Bool>
        max_htlc_mtokens: <Maximum HLTC Millitokens Value String>
        min_htlc_mtokens: <Minimum HTLC Millitokens Value String>
        updated_at: <Updated At ISO 8601 Date String>
      }
      [timeout_height]: <Error CLTV Timeout Height Number>
      [update]: {
        chain: <Chain Id Hex String>
        channel_flags: <Channel Flags Number>
        extra_opaque_data: <Extra Opaque Data Hex String>
        message_flags: <Message Flags Number>
        signature: <Channel Update Signature Hex String>
      }
    }
    message: <Error Message String>
  }
*/
module.exports = ({channel, failure, index, key, keys}) => {
  if (!failure) {
    return {code: 500, message: 'ExpectedFailureToDerivePaymentFailure'};
  }

  const update = failure.channel_update;

  if (!!update) {
    try {
      policyFromChannelUpdate({key, keys, update});

      chanFormat({number: update.chan_id});
    } catch (err) {
      return {code: 500, message: 'ExpectedValidChannelUpdateToDeriveFailure'};
    }
  }

  const failChan = !update ? {channel} : chanFormat({number: update.chan_id});
  const hasMtokens = !!failure.htlc_msat && failure.htlc_msat !== '0';

  const details = {
    channel: !!channel ? channel : failChan.channel,
    height: failure.height || undefined,
    index: failure.failure_source_index,
    mtokens: !hasMtokens ? undefined : failure.htlc_msat,
    policy: !update ? null : policyFromChannelUpdate({key, keys, update}),
    timeout_height: failure.cltv_expiry || undefined,
    update: !update ? undefined : {
      chain: update.chain_hash.reverse().toString('hex'),
      channel_flags : update.channel_flags,
      extra_opaque_data: update.extra_opaque_data.toString('hex'),
      message_flags: update.message_flags,
      signature: update.signature.toString('hex'),
    },
  };

  switch (failure.code) {
  case 'AMOUNT_BELOW_MINIMUM':
    return {details, code: 503, message: 'AmountBelowMinimum'};

  case 'CHANNEL_DISABLED':
    return {details, code: 503, message: 'ChannelDisabled'};

  case 'EXPIRY_TOO_FAR':
    return {details, code: 503, message: 'ExpiryTooFar'};

  case 'EXPIRY_TOO_SOON':
    return {details, code: 503, message: 'ExpiryTooSoon'};

  case 'FEE_INSUFFICIENT':
    return {details, code: 503, message: 'FeeInsufficient'};

  case 'FINAL_EXPIRY_TOO_SOON':
    return {details, code: 404, message: 'FinalExpiryTooSoon'};

  case 'FINAL_INCORRECT_CLTV_EXPIRY':
    return {details, code: 404, message: 'FinalIncorrectCltvExpiry'};

  case 'FINAL_INCORRECT_HTLC_AMOUNT':
    return {details, code: 404, message: 'FinalIncorrectHtlcAmount'};

  case 'INCORRECT_CLTV_EXPIRY':
    return {details, code: 503, message: 'IncorrectCltvExpiry'};

  case 'INCORRECT_OR_UNKNOWN_PAYMENT_DETAILS':
  case 'UNKNOWN_PAYMENT_HASH':
    return {details, code: 404, message: 'UnknownPaymentHash'};

  case 'INCORRECT_PAYMENT_AMOUNT':
    return {details, code: 404, message: 'IncorrectPaymentAmount'};

  case 'INVALID_ONION_HMAC':
    return {details, code: 503, message: 'InvalidOnionHmac'};

  case 'INVALID_ONION_KEY':
    return {details, code: 503, message: 'InvalidOnionKey'};

  case 'INVALID_ONION_PAYLOAD':
    return {details, code: 503, message: 'InvalidOnionPayload'};

  case 'INVALID_ONION_VERSION':
    return {details, code: 503, message: 'InvalidOnionVersion'};

  case 'INVALID_REALM':
    return {details, code: 503, message: 'InvalidRealm'};

  case 'MPP_TIMEOUT':
    return {details, code: 503, message: 'MppTimeout'};

  case 'PERMANENT_CHANNEL_FAILURE':
    return {details, code: 503, message: 'PermanentChannelFailure'};

  case 'PERMANENT_NODE_FAILURE':
    return {details, code: 503, message: 'PermanentNodeFailure'};

  case 'REQUIRED_CHANNEL_FEATURE_MISSING':
    return {details, code: 503, message: 'RequiredChannelFeatureMissing'};

  case 'REQUIRED_NODE_FEATURE_MISSING':
    return {details, code: 503, message: 'RequiredNodeFeatureMissing'};

  case 'TEMPORARY_CHANNEL_FAILURE':
    return {details, code: 503, message: 'TemporaryChannelFailure'};

  case 'TEMPORARY_NODE_FAILURE':
    return {details, code: 503, message: 'TemporaryNodeFailure'};

  case 'UNKNOWN_NEXT_PEER':
    return {details, code: 503, message: 'UnknownNextPeer'};

  case 'UNKNOWN_FAILURE':
    return {details, code: 503, message: 'UnknownFailure'};

  case 'UNREADABLE_FAILURE':
    return {details, code: 503, message: 'UnreadableFailure'};

  default:
    return {details, code: 500, message: 'UnexpectedPayViaRoutesFailure'};
  }
};