mempool/backend/src/api/lightning/clightning/clightning-convert.ts

import { ILightningApi } from '../lightning-api.interface';
import FundingTxFetcher from '../../../tasks/lightning/sync-tasks/funding-tx-fetcher';
import logger from '../../../logger';
import { Common } from '../../common';
import { hex2bin } from '../../../utils/format';
import config from '../../../config';

// https://github.com/lightningnetwork/lnd/blob/master/lnwire/features.go
export enum FeatureBits {
	DataLossProtectRequired = 0,
	DataLossProtectOptional = 1,
	InitialRoutingSync = 3,
	UpfrontShutdownScriptRequired = 4,
	UpfrontShutdownScriptOptional = 5,
	GossipQueriesRequired = 6,
	GossipQueriesOptional = 7,
	TLVOnionPayloadRequired = 8,
	TLVOnionPayloadOptional = 9,
	StaticRemoteKeyRequired = 12,
	StaticRemoteKeyOptional = 13,
	PaymentAddrRequired = 14,
	PaymentAddrOptional = 15,
	MPPRequired = 16,
	MPPOptional = 17,
	WumboChannelsRequired = 18,
	WumboChannelsOptional = 19,
	AnchorsRequired = 20,
	AnchorsOptional = 21,
	AnchorsZeroFeeHtlcTxRequired = 22,
	AnchorsZeroFeeHtlcTxOptional = 23,
	ShutdownAnySegwitRequired = 26,
	ShutdownAnySegwitOptional = 27,
	AMPRequired = 30,
	AMPOptional = 31,
	ExplicitChannelTypeRequired = 44,
	ExplicitChannelTypeOptional = 45,
	ScidAliasRequired = 46,
	ScidAliasOptional = 47,
	PaymentMetadataRequired = 48,
	PaymentMetadataOptional = 49,
	ZeroConfRequired = 50,
	ZeroConfOptional = 51,
	KeysendRequired = 54,
	KeysendOptional = 55,
	ScriptEnforcedLeaseRequired = 2022,
	ScriptEnforcedLeaseOptional = 2023,
	MaxBolt11Feature = 5114,
};
  
export const FeaturesMap = new Map<FeatureBits, string>([
	[FeatureBits.DataLossProtectRequired, 'data-loss-protect'],
	[FeatureBits.DataLossProtectOptional, 'data-loss-protect'],
	[FeatureBits.InitialRoutingSync, 'initial-routing-sync'],
	[FeatureBits.UpfrontShutdownScriptRequired, 'upfront-shutdown-script'],
	[FeatureBits.UpfrontShutdownScriptOptional, 'upfront-shutdown-script'],
	[FeatureBits.GossipQueriesRequired, 'gossip-queries'],
	[FeatureBits.GossipQueriesOptional, 'gossip-queries'],
	[FeatureBits.TLVOnionPayloadRequired, 'tlv-onion'],
	[FeatureBits.TLVOnionPayloadOptional, 'tlv-onion'],
	[FeatureBits.StaticRemoteKeyOptional, 'static-remote-key'],
	[FeatureBits.StaticRemoteKeyRequired, 'static-remote-key'],
	[FeatureBits.PaymentAddrOptional, 'payment-addr'],
	[FeatureBits.PaymentAddrRequired, 'payment-addr'],
	[FeatureBits.MPPOptional, 'multi-path-payments'],
	[FeatureBits.MPPRequired, 'multi-path-payments'],
	[FeatureBits.AnchorsRequired, 'anchor-commitments'],
	[FeatureBits.AnchorsOptional, 'anchor-commitments'],
	[FeatureBits.AnchorsZeroFeeHtlcTxRequired, 'anchors-zero-fee-htlc-tx'],
	[FeatureBits.AnchorsZeroFeeHtlcTxOptional, 'anchors-zero-fee-htlc-tx'],
	[FeatureBits.WumboChannelsRequired, 'wumbo-channels'],
	[FeatureBits.WumboChannelsOptional, 'wumbo-channels'],
	[FeatureBits.AMPRequired, 'amp'],
	[FeatureBits.AMPOptional, 'amp'],
	[FeatureBits.PaymentMetadataOptional, 'payment-metadata'],
	[FeatureBits.PaymentMetadataRequired, 'payment-metadata'],
	[FeatureBits.ExplicitChannelTypeOptional, 'explicit-commitment-type'],
	[FeatureBits.ExplicitChannelTypeRequired, 'explicit-commitment-type'],
	[FeatureBits.KeysendOptional, 'keysend'],
	[FeatureBits.KeysendRequired, 'keysend'],
	[FeatureBits.ScriptEnforcedLeaseRequired, 'script-enforced-lease'],
	[FeatureBits.ScriptEnforcedLeaseOptional, 'script-enforced-lease'],
	[FeatureBits.ScidAliasRequired, 'scid-alias'],
	[FeatureBits.ScidAliasOptional, 'scid-alias'],
	[FeatureBits.ZeroConfRequired, 'zero-conf'],
	[FeatureBits.ZeroConfOptional, 'zero-conf'],
	[FeatureBits.ShutdownAnySegwitRequired, 'shutdown-any-segwit'],
	[FeatureBits.ShutdownAnySegwitOptional, 'shutdown-any-segwit'],
]);

/**
 * Convert a clightning "listnode" entry to a lnd node entry
 */
export function convertNode(clNode: any): ILightningApi.Node {
  let custom_records: { [type: number]: string } | undefined = undefined;
  if (clNode.option_will_fund) {
    try {
      custom_records = { '1': Buffer.from(clNode.option_will_fund.compact_lease || '', 'hex').toString('base64') };
    } catch (e) {
      logger.err(`Cannot decode option_will_fund compact_lease for ${clNode.nodeid}). Reason: ` + (e instanceof Error ? e.message : e));
      custom_records = undefined;
    }
  }

  const nodeFeatures: ILightningApi.Feature[] = [];
  const nodeFeaturesBinary = hex2bin(clNode.features).split('').reverse().join('');

  for (let i = 0; i < nodeFeaturesBinary.length; i++) {
    if (nodeFeaturesBinary[i] === '0') {
      continue;
    }
    const feature = FeaturesMap.get(i);
    if (!feature) {
      nodeFeatures.push({
        bit: i,
        name: 'unknown',
        is_required: i % 2 === 0,
        is_known: false
      });
    } else {
      nodeFeatures.push({
        bit: i,
        name: feature,
        is_required: i % 2 === 0,
        is_known: true
      });
    }
  }

  return {
    alias: clNode.alias ?? '',
    color: `#${clNode.color ?? ''}`,
    features: nodeFeatures,
    pub_key: clNode.nodeid,
    addresses: clNode.addresses?.map((addr) => {
      let address = addr.address;
      if (addr.type === 'ipv6') {
        address = `[${address}]`;
      }
      return {
        network: addr.type,
        addr: `${address}:${addr.port}`
      };
    }) ?? [],
    last_update: clNode?.last_timestamp ?? 0,
    custom_records
  };
}

/**
 * Convert clightning "listchannels" response to lnd "describegraph.edges" format
 */
export async function convertAndmergeBidirectionalChannels(clChannels: any[]): Promise<ILightningApi.Channel[]> {
  logger.debug(`Converting clightning nodes and channels to lnd graph format`, logger.tags.ln);

  let loggerTimer = new Date().getTime() / 1000;
  let channelProcessed = 0;

  const consolidatedChannelList: ILightningApi.Channel[] = [];
  const clChannelsDict = {};
  const clChannelsDictCount = {};

  for (const clChannel of clChannels) {
    if (!clChannelsDict[clChannel.short_channel_id]) {
      clChannelsDict[clChannel.short_channel_id] = clChannel;
      clChannelsDictCount[clChannel.short_channel_id] = 1;
    } else {
      const fullChannel = await buildFullChannel(clChannel, clChannelsDict[clChannel.short_channel_id]);
      if (fullChannel !== null) {
        consolidatedChannelList.push(fullChannel);
        delete clChannelsDict[clChannel.short_channel_id];
        clChannelsDictCount[clChannel.short_channel_id]++;
      }
    }

    const elapsedSeconds = Math.round((new Date().getTime() / 1000) - loggerTimer);
    if (elapsedSeconds > config.LIGHTNING.LOGGER_UPDATE_INTERVAL) {
      logger.info(`Building complete channels from clightning output. Channels processed: ${channelProcessed + 1} of ${clChannels.length}`, logger.tags.ln);
      loggerTimer = new Date().getTime() / 1000;
    }

    ++channelProcessed;
  }

  channelProcessed = 0;
  const keys = Object.keys(clChannelsDict);
  for (const short_channel_id of keys) {
    const incompleteChannel = await buildIncompleteChannel(clChannelsDict[short_channel_id]);
    if (incompleteChannel !== null) {
      consolidatedChannelList.push(incompleteChannel);
    }

    const elapsedSeconds = Math.round((new Date().getTime() / 1000) - loggerTimer);
    if (elapsedSeconds > config.LIGHTNING.LOGGER_UPDATE_INTERVAL) {
      logger.info(`Building partial channels from clightning output. Channels processed: ${channelProcessed + 1} of ${keys.length}`);
      loggerTimer = new Date().getTime() / 1000;
    }

    channelProcessed++;
  }

  return consolidatedChannelList;
}

/**
 * Convert two clightning "getchannels" entries into a full a lnd "describegraph.edges" format
 * In this case, clightning knows the channel policy for both nodes
 */
async function buildFullChannel(clChannelA: any, clChannelB: any): Promise<ILightningApi.Channel | null> {
  const lastUpdate = Math.max(clChannelA.last_update ?? 0, clChannelB.last_update ?? 0);

  const tx = await FundingTxFetcher.$fetchChannelOpenTx(clChannelA.short_channel_id);
  if (!tx) {
    return null;
  }
  const parts = clChannelA.short_channel_id.split('x');
  const outputIdx = parts[2];

  return {
    channel_id: Common.channelShortIdToIntegerId(clChannelA.short_channel_id),
    capacity: (clChannelA.amount_msat / 1000).toString(),
    last_update: lastUpdate,
    node1_policy: convertPolicy(clChannelA),
    node2_policy: convertPolicy(clChannelB),
    chan_point: `${tx.txid}:${outputIdx}`,
    node1_pub: clChannelA.source,
    node2_pub: clChannelB.source,
  };
}

/**
 * Convert one clightning "getchannels" entry into a full a lnd "describegraph.edges" format
 * In this case, clightning knows the channel policy of only one node
 */
async function buildIncompleteChannel(clChannel: any): Promise<ILightningApi.Channel | null> {
  const tx = await FundingTxFetcher.$fetchChannelOpenTx(clChannel.short_channel_id);
  if (!tx) {
    return null;
  }
  const parts = clChannel.short_channel_id.split('x');
  const outputIdx = parts[2];

  return {
    channel_id: Common.channelShortIdToIntegerId(clChannel.short_channel_id),
    capacity: (clChannel.amount_msat / 1000).toString(),
    last_update: clChannel.last_update ?? 0,
    node1_policy: convertPolicy(clChannel),
    node2_policy: null,
    chan_point: `${tx.txid}:${outputIdx}`,
    node1_pub: clChannel.source,
    node2_pub: clChannel.destination,
  };
}

/**
 * Convert a clightning "listnode" response to a lnd channel policy format
 */
function convertPolicy(clChannel: any): ILightningApi.RoutingPolicy {
  return {
    time_lock_delta: clChannel.delay,
    min_htlc: clChannel.htlc_minimum_msat.toString(),
    max_htlc_msat: clChannel.htlc_maximum_msat.toString(),
    fee_base_msat: clChannel.base_fee_millisatoshi,
    fee_rate_milli_msat: clChannel.fee_per_millionth,
    disabled: !clChannel.active,
    last_update: clChannel.last_update ?? 0,
  };
}