merge and sort payment options

src/lib/merge-payment-methods.test.ts

@@ -5,6 +5,7 @@ import { kinds, type Event } from 'nostr-tools'
 import {
   buildOrderedZapLightningAddresses,
   getAlternativePaymentMethods,
+  groupPaymentMethodsByDisplayType,
   prepareZapDialogAlternativePayments,
   mergePaymentMethods,
   normalizeLightningAuthority,
@@ -155,6 +156,92 @@ describe('mergePaymentMethods kind 0 about coin lines', () => {
   })
 })
 
+describe('mergePaymentMethods ordering', () => {
+  it('lists profile then payment lightning addresses within Lightning Network', () => {
+    const profileEvent = {
+      kind: kinds.Metadata,
+      pubkey: 'aa'.repeat(32),
+      created_at: 1,
+      tags: [
+        ['lud16', 'profile-first@example.com'],
+        ['lud16', 'profile-second@example.com']
+      ] as string[][],
+      content: '{}',
+      id: 'bb'.repeat(64),
+      sig: 'cc'.repeat(128)
+    } as Event
+
+    const methods = mergePaymentMethods(
+      {
+        methods: [
+          {
+            type: 'lightning',
+            authority: 'profile-second@example.com',
+            payto: 'payto://lightning/profile-second@example.com',
+            displayType: 'Lightning Network'
+          },
+          {
+            type: 'lightning',
+            authority: 'payment-only@example.com',
+            payto: 'payto://lightning/payment-only@example.com',
+            displayType: 'Lightning Network'
+          }
+        ]
+      },
+      getProfileFromEvent(profileEvent),
+      profileEvent
+    )
+
+    const lightning = groupPaymentMethodsByDisplayType(methods).find(
+      (g) => g.displayType === 'Lightning Network'
+    )?.methods
+
+    expect(lightning?.map((m) => m.authority)).toEqual([
+      'profile-first@example.com',
+      'profile-second@example.com',
+      'payment-only@example.com'
+    ])
+  })
+
+  it('keeps distinct profile and payment targets across categories', () => {
+    const profileEvent = {
+      kind: kinds.Metadata,
+      pubkey: 'aa'.repeat(32),
+      created_at: 1,
+      tags: [['payto', 'monero', '4profilemonero']] as string[][],
+      content: '{}',
+      id: 'bb'.repeat(64),
+      sig: 'cc'.repeat(128)
+    } as Event
+
+    const methods = mergePaymentMethods(
+      {
+        methods: [
+          {
+            type: 'lightning',
+            authority: 'zap@example.com',
+            payto: 'payto://lightning/zap@example.com',
+            displayType: 'Lightning Network'
+          },
+          {
+            type: 'bip353',
+            authority: 'dns@example.com',
+            payto: 'payto://bip353/dns@example.com',
+            displayType: 'DNS Payment Instructions (BIP-353)'
+          }
+        ]
+      },
+      null,
+      profileEvent
+    )
+
+    expect(methods).toHaveLength(3)
+    expect(methods.some((m) => m.type === 'monero')).toBe(true)
+    expect(methods.some((m) => m.type === 'lightning')).toBe(true)
+    expect(methods.some((m) => m.type === 'bip353')).toBe(true)
+  })
+})
+
 describe('mergePaymentMethods kind 0 cryptocurrency_addresses', () => {
   it('imports Garnet monero from profile JSON', () => {
     const addr = '4AdUndXHHZ6cfufTMvppY6JwXNouMBzSkbLYfpAV5Usx3skxNgvYatVKtQNjUoNcknXV85jSp3wjUGpHbWfnqPm4WjwFGtW'

src/lib/merge-payment-methods.ts

@@ -21,6 +21,20 @@ export type MergedPaymentMethod = {
   currency?: string
   minAmount?: number
   maxAmount?: number
+  /** Position in the profile (kind 0) event, for within-category ordering. */
+  profileOrder?: number
+  /** Position in the payment (kind 10133) event, for within-category ordering. */
+  paymentOrder?: number
+}
+
+type PaymentMethodInput = {
+  type: string
+  authority: string
+  payto?: string
+  displayType?: string
+  currency?: string
+  minAmount?: number
+  maxAmount?: number
 }
 
 export type PaymentMethodGroup = {
@@ -132,70 +146,40 @@ export function paytoPaymentSortRank(type: string): number {
   return 2
 }
 
-/** Merge payment methods from kind 10133 and profile (kind 0: JSON + tags), normalized and deduplicated. */
+const LIGHTNING_NETWORK_LABEL = 'Lightning Network'
-export function mergePaymentMethods(
-  paymentInfo: ReturnType<typeof getPaymentInfoFromEvent> | null,
-  profile: TProfile | null,
-  profileEvent?: Event | null
-): MergedPaymentMethod[] {
-  const seen = new Map<string, MergedPaymentMethod>()
-  const out: MergedPaymentMethod[] = []
 
-  const add = (
+/** Map a kind 0 `w` tag to a payto-shaped row (tag order preserved by the caller). */
-    type: string,
+function paymentMethodInputFromWTag(tag: string[]): PaymentMethodInput | null {
-    authority: string,
+  if (tag[0] !== 'w' || !tag[1] || !tag[2]) return null
-    payto?: string,
+
-    displayType?: string,
+  const addr = String(tag[2]).trim()
-    extra?: { currency?: string; minAmount?: number; maxAmount?: number }
+  if (!addr) return null
-  ) => {
+
-    if (!authority?.trim()) return
+  let currency = String(tag[1]).trim()
-    const normType = getCanonicalPaytoType(type)
+  let network = tag[3] ? String(tag[3]).trim().toLowerCase() : ''
-    const key = `${normType}:${normalizePaymentAuthority(normType, authority)}`
+
-    const existing = seen.get(key)
+  if (!network && currency.toLowerCase() === 'lightning') {
-    if (existing) {
+    network = 'lightning'
-      if (isLightningPaytoType(normType)) {
+    currency = ''
-        existing.authority = resolveLightningAuthority(existing.authority, authority.trim())
-        existing.payto = buildPaytoUri(normType, existing.authority)
-      }
-      return
-    }
-    const trimmedAuthority = authority.trim()
-    const resolvedAuthority =
-      isLightningPaytoType(normType)
-        ? resolveLightningAuthority(trimmedAuthority)
-        : normType === 'paypal'
-          ? normalizePaypalAuthority(trimmedAuthority)
-          : trimmedAuthority
-    const entry: MergedPaymentMethod = {
-      type: normType,
-      authority: resolvedAuthority,
-      payto: payto || (normType && resolvedAuthority ? buildPaytoUri(normType, resolvedAuthority) : undefined),
-      displayType: displayType || getPaytoEditorTypeLabel(normType),
-      ...extra
-    }
-    seen.set(key, entry)
-    out.push(entry)
   }
 
-  const fromProfile = profile?.lightningAddressList?.length
+  if (!network) return null
-    ? profile.lightningAddressList
-    : profile?.lightningAddress
-      ? [profile.lightningAddress]
-      : []
-  fromProfile.forEach((addr) => {
-    if (addr) add('lightning', addr, `payto://lightning/${addr}`, 'Lightning Network')
-  })
 
-  profile?.wWalletTags?.forEach((w) => {
+  const cur = currency.toLowerCase()
-    const net = w.network.toLowerCase()
+  const net = network.toLowerCase()
-    if (net === 'lightning') return
+
-    const addr = w.address?.trim()
+  if (net === 'lightning') {
-    if (!addr) return
+    return { type: 'lightning', authority: addr, displayType: LIGHTNING_NETWORK_LABEL }
-    const cur = (w.currency || '').trim().toLowerCase()
+  }
 
   if (net === 'bitcoin') {
-      add('bitcoin', addr, buildPaytoUri('bitcoin', addr), 'Bitcoin', { currency: w.currency })
+    return {
-      return
+      type: 'bitcoin',
+      authority: addr,
+      payto: buildPaytoUri('bitcoin', addr),
+      displayType: 'Bitcoin',
+      currency: currency || undefined
+    }
   }
 
   const netCanonical = getCanonicalPaytoType(net)
@@ -207,74 +191,308 @@ export function mergePaymentMethods(
     netCanonical !== 'lbtc' &&
     netCanonical !== 'usdt'
   ) {
-      add(
+    return {
-        netCanonical,
+      type: netCanonical,
-        addr,
+      authority: addr,
-        buildPaytoUri(netCanonical, addr),
+      payto: buildPaytoUri(netCanonical, addr),
-        getPaytoEditorTypeLabel(netCanonical),
+      displayType: getPaytoEditorTypeLabel(netCanonical),
-        { currency: w.currency }
+      currency: currency || undefined
-      )
+    }
-      return
   }
 
   if (cur === 'usdt' || cur === 'usd₮' || cur === 'tether' || net === 'usdt') {
-      add('usdt', addr, buildPaytoUri('usdt', addr), 'Tether (USDT)', { currency: w.currency || 'USDT' })
+    return {
-      return
+      type: 'usdt',
+      authority: addr,
+      payto: buildPaytoUri('usdt', addr),
+      displayType: 'Tether (USDT)',
+      currency: currency || 'USDT'
+    }
   }
 
   if (net === 'liquid') {
     if (cur === 'lbtc' || cur === 'l-btc' || cur === 'liquid btc') {
-        add('lbtc', addr, buildPaytoUri('lbtc', addr), 'Liquid Bitcoin (LBTC)', { currency: w.currency })
+      return {
-      } else {
+        type: 'lbtc',
-        add('liquid', addr, buildPaytoUri('liquid', addr), cur ? `Liquid (${w.currency})` : 'Liquid', {
+        authority: addr,
-          currency: w.currency
+        payto: buildPaytoUri('lbtc', addr),
-        })
+        displayType: 'Liquid Bitcoin (LBTC)',
+        currency: currency || undefined
+      }
+    }
+    return {
+      type: 'liquid',
+      authority: addr,
+      payto: buildPaytoUri('liquid', addr),
+      displayType: cur ? `Liquid (${currency})` : 'Liquid',
+      currency: currency || undefined
     }
-      return
   }
 
   if (cur === 'lbtc' || cur === 'l-btc') {
-      add('lbtc', addr, buildPaytoUri('lbtc', addr), 'Liquid Bitcoin (LBTC)', { currency: w.currency })
+    return {
+      type: 'lbtc',
+      authority: addr,
+      payto: buildPaytoUri('lbtc', addr),
+      displayType: 'Liquid Bitcoin (LBTC)',
+      currency: currency || undefined
+    }
   }
-  })
 
-  if (paymentInfo?.methods?.length) {
+  return null
-    paymentInfo.methods.forEach((m) => {
+}
-      const authority = m.authority || m.address || ''
+
-      add(
+/**
-        (m.type || 'lightning').toLowerCase(),
+ * Payment targets from a kind 0 event in document order: tags top-to-bottom, then JSON content.
+ */
+export function extractProfileEventPaymentMethodsInOrder(
+  profileEvent: Event | null | undefined
+): PaymentMethodInput[] {
+  if (!profileEvent || profileEvent.kind !== kinds.Metadata) return []
+
+  const out: PaymentMethodInput[] = []
+
+  for (const tag of profileEvent.tags) {
+    const name = tag[0]
+    if (name === 'lud16' && tag[1]) {
+      out.push({
+        type: 'lightning',
+        authority: String(tag[1]),
+        displayType: LIGHTNING_NETWORK_LABEL
+      })
+      continue
+    }
+    if (name === 'lud06' && tag[1]) {
+      out.push({
+        type: 'lightning',
+        authority: String(tag[1]),
+        displayType: LIGHTNING_NETWORK_LABEL
+      })
+      continue
+    }
+    if (name === 'w') {
+      const row = paymentMethodInputFromWTag(tag)
+      if (row) out.push(row)
+      continue
+    }
+    if (name === 'payto' && tag[1] && tag[2]) {
+      const type = String(tag[1]).toLowerCase()
+      const authority = String(tag[2])
+      out.push({
+        type,
         authority,
-        m.payto,
+        payto: buildPaytoUri(getCanonicalPaytoType(type), authority)
-        m.displayType,
-        { currency: m.currency, minAmount: m.minAmount, maxAmount: m.maxAmount }
-      )
       })
-  } else if (paymentInfo?.payto) {
+    }
-    const type = (paymentInfo.type || 'lightning').toLowerCase()
-    const authority = paymentInfo.authority || paymentInfo.payto.replace(/^payto:\/\/[^/]+\//, '') || ''
-    add(type, authority, paymentInfo.payto, type === 'lightning' ? 'Lightning Network' : paymentInfo.type || 'Payment')
   }
 
-  if (profileEvent?.kind === kinds.Metadata) {
   try {
-      const profileJson = JSON.parse(profileEvent.content || '{}') as unknown
+    const profileJson = JSON.parse(profileEvent.content || '{}') as Record<string, unknown>
+    const lud16 = profileJson.lud16
+    if (typeof lud16 === 'string' && lud16.trim()) {
+      out.push({
+        type: 'lightning',
+        authority: lud16.trim(),
+        displayType: LIGHTNING_NETWORK_LABEL
+      })
+    }
+    const lud06 = profileJson.lud06
+    if (typeof lud06 === 'string' && lud06.trim()) {
+      out.push({
+        type: 'lightning',
+        authority: lud06.trim(),
+        displayType: LIGHTNING_NETWORK_LABEL
+      })
+    }
     for (const m of extractKind0PaymentMethodsFromProfileJson(profileJson)) {
-        add(m.type, m.authority, m.payto, m.displayType)
+      out.push({
+        type: m.type,
+        authority: m.authority,
+        payto: m.payto,
+        displayType: m.displayType
+      })
     }
   } catch {
     /* ignore invalid kind 0 JSON */
   }
-    for (const tag of profileEvent.tags) {
+
-      if (tag[0] === 'payto' && tag[1] && tag[2]) {
+  return out
-        const type = String(tag[1]).toLowerCase()
+}
-        add(type, String(tag[2]), buildPaytoUri(getCanonicalPaytoType(type), String(tag[2])))
+
+function paymentMethodInputKey(input: PaymentMethodInput): string {
+  const normType = getCanonicalPaytoType(input.type)
+  return `${normType}:${normalizePaymentAuthority(normType, input.authority)}`
+}
+
+/** Append inputs from `extra` that are not already in `primary` (same type + authority). */
+function appendUniquePaymentInputs(
+  primary: PaymentMethodInput[],
+  extra: PaymentMethodInput[]
+): PaymentMethodInput[] {
+  const keys = new Set(primary.map(paymentMethodInputKey))
+  const out = [...primary]
+  for (const input of extra) {
+    const key = paymentMethodInputKey(input)
+    if (keys.has(key)) continue
+    keys.add(key)
+    out.push(input)
+  }
+  return out
+}
+
+/** Fallback when only parsed profile is available (no kind 0 event loaded). */
+function extractParsedProfilePaymentMethodsInOrder(profile: TProfile | null): PaymentMethodInput[] {
+  if (!profile) return []
+
+  const out: PaymentMethodInput[] = []
+  const lightningList = profile.lightningAddressList?.length
+    ? profile.lightningAddressList
+    : profile.lightningAddress
+      ? [profile.lightningAddress]
+      : []
+
+  for (const addr of lightningList) {
+    if (addr?.trim()) {
+      out.push({
+        type: 'lightning',
+        authority: addr,
+        displayType: LIGHTNING_NETWORK_LABEL
+      })
+    }
+  }
+
+  profile.wWalletTags?.forEach((w) => {
+    const row = paymentMethodInputFromWTag(['w', w.currency, w.address, w.network])
+    if (row) out.push(row)
+  })
+
+  return out
+}
+
+/**
+ * Payment targets from kind 10133 in document order (payto tags, or JSON methods fallback).
+ */
+export function extractPaymentEventMethodsInOrder(
+  paymentInfo: ReturnType<typeof getPaymentInfoFromEvent> | null
+): PaymentMethodInput[] {
+  if (!paymentInfo) return []
+
+  if (paymentInfo.methods?.length) {
+    return paymentInfo.methods.map((m) => {
+      const type = (m.type || 'lightning').toLowerCase()
+      const authority = m.authority || m.address || ''
+      return {
+        type,
+        authority,
+        payto: m.payto,
+        displayType: m.displayType,
+        currency: m.currency,
+        minAmount: m.minAmount,
+        maxAmount: m.maxAmount
+      }
+    })
+  }
+
+  if (paymentInfo.payto) {
+    const type = (paymentInfo.type || 'lightning').toLowerCase()
+    const authority =
+      paymentInfo.authority || paymentInfo.payto.replace(/^payto:\/\/[^/]+\//, '') || ''
+    return [
+      {
+        type,
+        authority,
+        payto: paymentInfo.payto,
+        displayType:
+          type === 'lightning' ? LIGHTNING_NETWORK_LABEL : paymentInfo.type || 'Payment'
+      }
+    ]
+  }
+
+  return []
+}
+
+function normalizePaymentMethodInput(input: PaymentMethodInput): MergedPaymentMethod | null {
+  const authority = input.authority?.trim()
+  if (!authority) return null
+
+  const normType = getCanonicalPaytoType(input.type)
+  const resolvedAuthority = isLightningPaytoType(normType)
+    ? resolveLightningAuthority(authority)
+    : normType === 'paypal'
+      ? normalizePaypalAuthority(authority)
+      : authority
+
+  return {
+    type: normType,
+    authority: resolvedAuthority,
+    payto:
+      input.payto ||
+      (normType && resolvedAuthority ? buildPaytoUri(normType, resolvedAuthority) : undefined),
+    displayType: input.displayType || getPaytoEditorTypeLabel(normType),
+    currency: input.currency,
+    minAmount: input.minAmount,
+    maxAmount: input.maxAmount
   }
+}
+
+function mergeOrderedPaymentMethodLists(
+  profileInputs: PaymentMethodInput[],
+  paymentInputs: PaymentMethodInput[]
+): MergedPaymentMethod[] {
+  const seen = new Map<string, MergedPaymentMethod>()
+  const out: MergedPaymentMethod[] = []
+
+  const ingest = (inputs: PaymentMethodInput[], source: 'profile' | 'payment') => {
+    inputs.forEach((input, index) => {
+      const normalized = normalizePaymentMethodInput(input)
+      if (!normalized) return
+
+      const key = `${normalized.type}:${normalizePaymentAuthority(normalized.type, normalized.authority)}`
+      const existing = seen.get(key)
+      if (existing) {
+        if (isLightningPaytoType(normalized.type)) {
+          existing.authority = resolveLightningAuthority(existing.authority, normalized.authority)
+          existing.payto = buildPaytoUri(normalized.type, existing.authority)
+        }
+        return
+      }
+
+      const entry: MergedPaymentMethod = {
+        ...normalized,
+        ...(source === 'profile' ? { profileOrder: index } : { paymentOrder: index })
       }
+      seen.set(key, entry)
+      out.push(entry)
+    })
   }
 
+  ingest(profileInputs, 'profile')
+  ingest(paymentInputs, 'payment')
   return out
 }
 
+/** Merge payment methods: profile (kind 0) event order, then payment (kind 10133) event order; deduplicated. */
+export function mergePaymentMethods(
+  paymentInfo: ReturnType<typeof getPaymentInfoFromEvent> | null,
+  profile: TProfile | null,
+  profileEvent?: Event | null
+): MergedPaymentMethod[] {
+  let profileInputs = profileEvent
+    ? extractProfileEventPaymentMethodsInOrder(profileEvent)
+    : extractParsedProfilePaymentMethodsInOrder(profile)
+
+  // Include parsed profile targets not represented in the raw event walk (e.g. cached profile row).
+  if (profileEvent && profile) {
+    profileInputs = appendUniquePaymentInputs(
+      profileInputs,
+      extractParsedProfilePaymentMethodsInOrder(profile)
+    )
+  }
+
+  const paymentInputs = extractPaymentEventMethodsInOrder(paymentInfo)
+  return mergeOrderedPaymentMethodLists(profileInputs, paymentInputs)
+}
+
 /** True when the recipient has any payto / Lightning target (kind 0 or 10133). */
 export function recipientHasAnyPaymentOptions(
   paymentInfo: ReturnType<typeof getPaymentInfoFromEvent> | null,
@@ -288,6 +506,15 @@ export function sortMergedPaymentMethods(methods: MergedPaymentMethod[]): Merged
   return [...methods].sort((a, b) => paytoPaymentSortRank(a.type) - paytoPaymentSortRank(b.type))
 }
 
+function compareMethodsWithinCategory(a: MergedPaymentMethod, b: MergedPaymentMethod): number {
+  const aFromProfile = a.profileOrder != null
+  const bFromProfile = b.profileOrder != null
+  if (aFromProfile && bFromProfile) return a.profileOrder! - b.profileOrder!
+  if (aFromProfile) return -1
+  if (bFromProfile) return 1
+  return (a.paymentOrder ?? 0) - (b.paymentOrder ?? 0)
+}
+
 /** Group payment methods by displayType (same headings as profile payment section). */
 export function groupPaymentMethodsByDisplayType(methods: MergedPaymentMethod[]): PaymentMethodGroup[] {
   const groups = new Map<string, MergedPaymentMethod[]>()
@@ -296,6 +523,9 @@ export function groupPaymentMethodsByDisplayType(methods: MergedPaymentMethod[])
     if (!groups.has(key)) groups.set(key, [])
     groups.get(key)!.push(method)
   }
+  for (const groupMethods of groups.values()) {
+    groupMethods.sort(compareMethodsWithinCategory)
+  }
   const order = Array.from(groups.keys()).sort((a, b) => {
     const typeA = groups.get(a)?.[0]?.type ?? ''
     const typeB = groups.get(b)?.[0]?.type ?? ''
@@ -305,8 +535,8 @@ export function groupPaymentMethodsByDisplayType(methods: MergedPaymentMethod[])
 }
 
 /**
- * Ordered Lightning targets for zaps: kind 0 `lud16` tags, then `w` (network lightning),
+ * Ordered Lightning targets for zaps: profile (kind 0) event order, then payment (kind 10133).
- * then kind 10133 lightning methods. Optional `preferredAddress` is moved to the front.
+ * Optional `preferredAddress` is moved to the front.
  */
 export function buildOrderedZapLightningAddresses(opts: {
   profileEvent?: Event | null
@@ -315,42 +545,15 @@ export function buildOrderedZapLightningAddresses(opts: {
   paymentInfo: ReturnType<typeof getPaymentInfoFromEvent> | null
   preferredAddress?: string | null
 }): string[] {
-  const seen = new Set<string>()
-  const out: string[] = []
-
-  const add = (raw: string | undefined) => {
-    if (!raw?.trim()) return
-    const resolved = resolveLightningAuthority(raw.trim())
-    const key = normalizePaymentAuthority('lightning', resolved)
-    if (seen.has(key)) return
-    seen.add(key)
-    out.push(resolved)
-  }
-
   const ev = opts.profileEvent
   const profile =
     ev?.kind === kinds.Metadata ? getProfileFromEvent(ev) : (opts.profile ?? null)
-  if (ev?.kind === kinds.Metadata) {
-    for (const tag of ev.tags) {
-      if (tag[0] === 'lud16' && tag[1]) add(tag[1])
-      if (tag[0] === 'lud06' && tag[1]) add(tag[1])
-    }
-    for (const tag of ev.tags) {
-      if (tag[0] !== 'w' || !tag[1] || !tag[2]) continue
-      if (tag[3] && String(tag[3]).toLowerCase() === 'lightning') {
-        add(tag[2])
-      } else if (!tag[3] && String(tag[1]).toLowerCase() === 'lightning') {
-        add(tag[2])
-      }
-    }
-  }
 
-  const paymentMethods = mergePaymentMethods(opts.paymentInfo, profile, ev)
+  const addrs = mergePaymentMethods(opts.paymentInfo, profile, ev)
-  for (const m of paymentMethods) {
+    .filter((m) => isZappableLightningPaytoType(m.type))
-    if (isZappableLightningPaytoType(m.type)) add(m.authority)
+    .map((m) => m.authority)
-  }
 
-  return prioritizeZapLightningAddress(out, opts.preferredAddress ?? undefined)
+  return prioritizeZapLightningAddress(addrs, opts.preferredAddress ?? undefined)
 }
 
 /** Move `preferred` to the front when present; append if not already listed. */