@bsv/message-box-client 2.0.4 → 2.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/message-box-client",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "publishConfig": {
     "access": "public"
   },
@@ -83,6 +83,6 @@
   },
   "dependencies": {
     "@bsv/authsocket-client": "^2.0.2",
-    "@bsv/sdk": "^2.0.4"
+    "@bsv/sdk": "^2.0.11"
   }
 }

package/src/MessageBoxClient.ts

@@ -38,8 +38,8 @@ import {
   ProtoWallet,
   InternalizeOutput,
   Random,
-  OriginatorDomainNameStringUnder250Bytes
-
+  OriginatorDomainNameStringUnder250Bytes,
+  Beef,
 } from '@bsv/sdk'
 import { AuthSocketClient } from '@bsv/authsocket-client'
 import * as Logger from './Utils/logger.js'
@@ -123,7 +123,7 @@ export class MessageBoxClient {
    * })
    * await client.init()
    */
-  constructor (options: MessageBoxClientOptions = {}) {
+  constructor(options: MessageBoxClientOptions = {}) {
     const {
       host,
       walletClient,
@@ -175,7 +175,7 @@ export class MessageBoxClient {
    * await client.init()
    * await client.sendMessage({ recipient, messageBox: 'inbox', body: 'Hello' })
    */
-  async init (targetHost: string = this.host): Promise<void> {
+  async init(targetHost: string = this.host): Promise<void> {
     const normalizedHost = targetHost?.trim()
     if (normalizedHost === '') {
       throw new Error('Cannot anoint host: No valid host provided')
@@ -220,7 +220,7 @@ export class MessageBoxClient {
    *
    * Used automatically by all public methods that require initialization.
    */
-  private async assertInitialized (): Promise<void> {
+  private async assertInitialized(): Promise<void> {
     if (!this.initialized || this.host == null || this.host.trim() === '') {
       await this.init()
     }
@@ -233,7 +233,7 @@ export class MessageBoxClient {
    * Returns a live list of WebSocket rooms the client is subscribed to.
    * Useful for inspecting state or ensuring no duplicates are joined.
    */
-  public getJoinedRooms (): Set<string> {
+  public getJoinedRooms(): Set<string> {
     return this.joinedRooms
   }
 
@@ -245,7 +245,7 @@ export class MessageBoxClient {
  * Returns the client's identity key, used for signing, encryption, and addressing.
  * If not already loaded, it will fetch and cache it.
  */
-  public async getIdentityKey (): Promise<string> {
+  public async getIdentityKey(): Promise<string> {
     if (this.myIdentityKey != null && this.myIdentityKey.trim() !== '') {
       return this.myIdentityKey
     }
@@ -273,7 +273,7 @@ export class MessageBoxClient {
    * Note: Do not interact with the socket directly unless necessary.
    * Use the provided `sendLiveMessage`, `listenForLiveMessages`, and related methods.
    */
-  public get testSocket (): ReturnType<typeof AuthSocketClient> | undefined {
+  public get testSocket(): ReturnType<typeof AuthSocketClient> | undefined {
     return this.socket
   }
 
@@ -301,7 +301,7 @@ export class MessageBoxClient {
    * await mb.initializeConnection()
    * // WebSocket is now ready for use
    */
-  async initializeConnection (overrideHost?: string): Promise<void> {
+  async initializeConnection(overrideHost?: string): Promise<void> {
     Logger.log('[MB CLIENT] initializeConnection() STARTED')
 
     if (this.myIdentityKey == null || this.myIdentityKey.trim() === '') {
@@ -461,7 +461,7 @@ export class MessageBoxClient {
    * @example
    * const host = await resolveHostForRecipient('028d...') // → returns either overlay host or this.host
    */
-  async resolveHostForRecipient (identityKey: string): Promise<string> {
+  async resolveHostForRecipient(identityKey: string): Promise<string> {
     const advertisementTokens = await this.queryAdvertisements(identityKey, undefined)
     if (advertisementTokens.length === 0) {
       Logger.warn(`[MB CLIENT] No advertisements for ${identityKey}, using default host ${this.host}`)
@@ -479,7 +479,7 @@ export class MessageBoxClient {
    * @param host?        if passed, only look for adverts anointed at that host
    * @returns            0-length array if nothing valid was found
    */
-  async queryAdvertisements (
+  async queryAdvertisements(
     identityKey?: string,
     host?: string
   ): Promise<AdvertisementToken[]> {
@@ -565,7 +565,7 @@ export class MessageBoxClient {
    * await client.joinRoom('payment_inbox')
    * // Now listening for real-time messages in room '028d...-payment_inbox'
    */
-  async joinRoom (messageBox: string, overrideHost?: string): Promise<void> {
+  async joinRoom(messageBox: string, overrideHost?: string): Promise<void> {
     Logger.log(`[MB CLIENT] Attempting to join WebSocket room: ${messageBox}`)
 
     // Ensure WebSocket connection is established first
@@ -623,7 +623,7 @@ export class MessageBoxClient {
    *   onMessage: (msg) => console.log('Received live message:', msg)
    * })
    */
-  async listenForLiveMessages ({
+  async listenForLiveMessages({
     onMessage,
     messageBox,
     overrideHost
@@ -726,7 +726,7 @@ export class MessageBoxClient {
    *   body: { amount: 1000 }
    * })
    */
-  async sendLiveMessage ({
+  async sendLiveMessage({
     recipient,
     messageBox,
     body,
@@ -888,7 +888,7 @@ export class MessageBoxClient {
    * @example
    * await client.leaveRoom('payment_inbox')
    */
-  async leaveRoom (messageBox: string): Promise<void> {
+  async leaveRoom(messageBox: string): Promise<void> {
     await this.assertInitialized()
     if (this.socket == null) {
       Logger.warn('[MB CLIENT] Attempted to leave a room but WebSocket is not connected.')
@@ -920,7 +920,7 @@ export class MessageBoxClient {
    * @example
    * await client.disconnectWebSocket()
    */
-  async disconnectWebSocket (): Promise<void> {
+  async disconnectWebSocket(): Promise<void> {
     await this.assertInitialized()
     if (this.socket != null) {
       Logger.log('[MB CLIENT] Closing WebSocket connection...')
@@ -958,7 +958,7 @@ export class MessageBoxClient {
    *   body: { type: 'ping' }
    * })
    */
-  async sendMessage (
+  async sendMessage(
     message: SendMessageParams,
     overrideHost?: string
   ): Promise<SendMessageResponse> {
@@ -1104,7 +1104,7 @@ export class MessageBoxClient {
  *  - compute per-recipient payment
  * Then sends to the allowed recipients with payment attached.
  */
-  async sendMesagetoRecepients (
+  async sendMesagetoRecepients(
     params: SendListParams,
     overrideHost?: string
   ): Promise<SendListResult> {
@@ -1289,41 +1289,65 @@ export class MessageBoxClient {
    * @example
    * const { txid } = await client.anointHost('https://my-messagebox.io')
    */
-  async anointHost (host: string): Promise<{ txid: string }> {
+  async anointHost(host: string): Promise<{ txid: string }> {
     Logger.log('[MB CLIENT] Starting anointHost...')
-    try {
-      if (!host.startsWith('http')) {
-        throw new Error('Invalid host URL')
-      }
-
-      const identityKey = await this.getIdentityKey()
+    if (!host.startsWith('http')) throw new Error('Invalid host URL')
 
-      Logger.log('[MB CLIENT] Fields - Identity:', identityKey, 'Host:', host)
-
-      const fields: number[][] = [
-        Utils.toArray(identityKey, 'hex'),
-        Utils.toArray(host, 'utf8')
-      ]
-
-      const pushdrop = new PushDrop(this.walletClient, this.originator)
-      Logger.log('Fields:', fields.map(a => Utils.toHex(a)))
-      Logger.log('ProtocolID:', [1, 'messagebox advertisement'])
-      Logger.log('KeyID:', '1')
-      Logger.log('SignAs:', 'self')
-      Logger.log('anyoneCanSpend:', false)
-      Logger.log('forSelf:', true)
-      const script = await pushdrop.lock(
-        fields,
-        [1, 'messagebox advertisement'],
-        '1',
-        'anyone',
-        true
-      )
+    const identityKey = await this.getIdentityKey()
+    const overlayTokens = await this.queryAdvertisements(identityKey)
+    Logger.log(`[MB CLIENT] Found ${overlayTokens.length} existing advertisement(s) on overlay`)
+
+    // Fetch ALL spendable wallet basket outputs and cross-reference with overlay tokens.
+    // Only overlay tokens the wallet considers spendable are safe to spend as inputs.
+    // This prevents stale overlay tokens (spent externally) from breaking the combined tx.
+    const basketResult = await this.walletClient.listOutputs({
+      basket: 'overlay advertisements',
+      limit: 10000
+    }, this.originator)
+    const spendableOutpoints = new Set(
+      basketResult.outputs.filter(o => o.spendable).map(o => o.outpoint)
+    )
+    const tokensToSpend = overlayTokens.filter(t => spendableOutpoints.has(`${t.txid}.${t.outputIndex}`))
+    const skipped = overlayTokens.length - tokensToSpend.length
+    if (skipped > 0) {
+      Logger.log(`[MB CLIENT] Skipping ${skipped} overlay token(s) not in spendable wallet basket`)
+    }
+    Logger.log(`[MB CLIENT] Revoking ${tokensToSpend.length} spendable token(s) in combined tx`)
+
+    const fields: number[][] = [
+      Utils.toArray(identityKey, 'hex'),
+      Utils.toArray(host, 'utf8')
+    ]
+    const pushdrop = new PushDrop(this.walletClient, this.originator)
+    const script = await pushdrop.lock(
+      fields,
+      [1, 'messagebox advertisement'],
+      '1',
+      'anyone',
+      true
+    )
+    Logger.log('[MB CLIENT] PushDrop script:', script.toASM())
 
-      Logger.log('[MB CLIENT] PushDrop script:', script.toASM())
+    try {
+      let inputBEEF: number[] | undefined
+      if (tokensToSpend.length > 0) {
+        const mergedBeef = Beef.fromBinary(tokensToSpend[0].beef)
+        for (let i = 1; i < tokensToSpend.length; i++) {
+          mergedBeef.mergeBeef(Beef.fromBinary(tokensToSpend[i].beef))
+        }
+        inputBEEF = mergedBeef.toBinary()
+      }
 
-      const { tx, txid } = await this.walletClient.createAction({
+      const { signableTransaction, tx: directTx, txid: directTxid } = await this.walletClient.createAction({
         description: 'Anoint host for overlay routing',
+        ...(inputBEEF !== undefined && {
+          inputBEEF,
+          inputs: tokensToSpend.map(token => ({
+            outpoint: `${token.txid}.${token.outputIndex}`,
+            unlockingScriptLength: 73,
+            inputDescription: `Revoking advertisement for ${token.host}`
+          }))
+        }),
         outputs: [{
           basket: 'overlay advertisements',
           lockingScript: script.toHex(),
@@ -1333,24 +1357,51 @@ export class MessageBoxClient {
         options: { randomizeOutputs: false, acceptDelayedBroadcast: false }
       }, this.originator)
 
-      Logger.log('[MB CLIENT] Transaction created:', txid)
+      if (signableTransaction === undefined) {
+        if (directTx === undefined) throw new Error('Anoint failed: no transaction returned')
+        Logger.log('[MB CLIENT] Transaction created (no inputs to sign):', directTxid)
+        const broadcaster = new TopicBroadcaster(['tm_messagebox'], { networkPreset: this.networkPreset })
+        const result = await broadcaster.broadcast(Transaction.fromAtomicBEEF(directTx))
+        Logger.log('[MB CLIENT] Advertisement broadcast succeeded. TXID:', result.txid)
+        if (typeof result.txid !== 'string') throw new Error('Anoint failed: broadcast did not return a txid')
+        return { txid: result.txid }
+      }
 
-      if (tx !== undefined) {
-        const broadcaster = new TopicBroadcaster(['tm_messagebox'], {
-          networkPreset: this.networkPreset
-        })
+      const partialTx = Transaction.fromAtomicBEEF(signableTransaction.tx)
+      const spends: Record<number, { unlockingScript: string }> = {}
+
+      for (let i = 0; i < tokensToSpend.length; i++) {
+        const token = tokensToSpend[i]
+        const sourceTx = Transaction.fromBEEF(token.beef)
+        const sourceSatoshis = sourceTx.outputs[token.outputIndex]?.satoshis ?? 1
+        const unlocker = pushdrop.unlock(
+          [1, 'messagebox advertisement'],
+          '1',
+          'anyone',
+          'all',
+          false,
+          sourceSatoshis,
+          token.lockingScript
+        )
+        const finalUnlockScript = await unlocker.sign(partialTx, i)
+        spends[i] = { unlockingScript: finalUnlockScript.toHex() }
+      }
 
-        const result = await broadcaster.broadcast(Transaction.fromAtomicBEEF(tx))
-        Logger.log('[MB CLIENT] Advertisement broadcast succeeded. TXID:', result.txid)
+      const { tx: signedTx, txid: signedTxid } = await this.walletClient.signAction({
+        reference: signableTransaction.reference,
+        spends,
+        options: { acceptDelayedBroadcast: false }
+      }, this.originator)
 
-        if (typeof result.txid !== 'string') {
-          throw new Error('Anoint failed: broadcast did not return a txid')
-        }
+      if (signedTx === undefined) throw new Error('Anoint failed: signing did not return a transaction')
+      Logger.log('[MB CLIENT] Transaction created:', signedTxid)
 
-        return { txid: result.txid }
-      }
+      const broadcaster = new TopicBroadcaster(['tm_messagebox'], { networkPreset: this.networkPreset })
+      const result = await broadcaster.broadcast(Transaction.fromAtomicBEEF(signedTx))
+      Logger.log('[MB CLIENT] Advertisement broadcast succeeded. TXID:', result.txid)
 
-      throw new Error('Anoint failed: failed to create action!')
+      if (typeof result.txid !== 'string') throw new Error('Anoint failed: broadcast did not return a txid')
+      return { txid: result.txid }
     } catch (err) {
       Logger.error('[MB CLIENT ERROR] anointHost threw:', err)
       throw err
@@ -1371,7 +1422,7 @@ export class MessageBoxClient {
    * @example
    * const { txid } = await client.revokeHost('https://my-messagebox.io')
    */
-  async revokeHostAdvertisement (advertisementToken: AdvertisementToken): Promise<{ txid: string }> {
+  async revokeHostAdvertisement(advertisementToken: AdvertisementToken): Promise<{ txid: string }> {
     Logger.log('[MB CLIENT] Starting revokeHost...')
     const outpoint = `${advertisementToken.txid}.${advertisementToken.outputIndex}`
     try {
@@ -1391,28 +1442,32 @@ export class MessageBoxClient {
         throw new Error('Failed to create signable transaction.')
       }
 
-      const partialTx = Transaction.fromBEEF(signableTransaction.tx)
+      const partialTx = Transaction.fromAtomicBEEF(signableTransaction.tx)
+
+      // Get the source satoshis from the BEEF so the sighash preimage is correct
+      const sourceTx = Transaction.fromBEEF(advertisementToken.beef)
+      const sourceSatoshis = sourceTx.outputs[advertisementToken.outputIndex]?.satoshis ?? 1
 
       // Prepare the unlocker
       const pushdrop = new PushDrop(this.walletClient, this.originator)
-      const unlocker = await pushdrop.unlock(
+      const unlocker = pushdrop.unlock(
         [1, 'messagebox advertisement'],
         '1',
         'anyone',
         'all',
         false,
-        advertisementToken.outputIndex,
+        sourceSatoshis,
         advertisementToken.lockingScript
       )
 
       // Convert to Transaction, apply signature
-      const finalUnlockScript = await unlocker.sign(partialTx, advertisementToken.outputIndex)
+      const finalUnlockScript = await unlocker.sign(partialTx, 0)
 
       // Complete signing with the final unlock script
       const { tx: signedTx } = await this.walletClient.signAction({
         reference: signableTransaction.reference,
         spends: {
-          [advertisementToken.outputIndex]: {
+          0: {
             unlockingScript: finalUnlockScript.toHex()
           }
         },
@@ -1474,7 +1529,7 @@ export class MessageBoxClient {
    * messages.forEach(msg => console.log(msg.sender, msg.body))
    * // Payments included with messages are automatically received
    */
-  async listMessages ({ messageBox, host, acceptPayments }: ListMessagesParams): Promise<PeerMessage[]> {
+  async listMessages({ messageBox, host, acceptPayments }: ListMessagesParams): Promise<PeerMessage[]> {
     if (typeof acceptPayments !== 'boolean') {
       acceptPayments = true
     }
@@ -1689,7 +1744,7 @@ export class MessageBoxClient {
    * })
    * console.log(messages)
    */
-  async listMessagesLite ({ messageBox, host }: ListMessagesParams): Promise<PeerMessage[]> {
+  async listMessagesLite({ messageBox, host }: ListMessagesParams): Promise<PeerMessage[]> {
     const res = await this.authFetch.fetch(`${host as string}/listMessages`, {
       method: 'POST',
       headers: { 'Content-Type': 'application/json' },
@@ -1769,7 +1824,7 @@ export class MessageBoxClient {
    * tryParse('{"hello":"world"}') // → { hello: "world" }
    * tryParse('plain text')        // → "plain text"
    */
-  tryParse (raw: string): any {
+  tryParse(raw: string): any {
     try {
       return JSON.parse(raw)
     } catch {
@@ -1826,7 +1881,7 @@ export class MessageBoxClient {
    * const success = await client.acknowledgeNotification(message)
    * console.log(success ? 'Payment received' : 'No payment or failed')
    */
-  async acknowledgeNotification (message: PeerMessage): Promise<boolean> {
+  async acknowledgeNotification(message: PeerMessage): Promise<boolean> {
     await this.acknowledgeMessage({ messageIds: [message.messageId] })
 
     const parsedBody: unknown =
@@ -1915,7 +1970,7 @@ export class MessageBoxClient {
    * @example
    * await client.acknowledgeMessage({ messageIds: ['msg123', 'msg456'] })
    */
-  async acknowledgeMessage ({ messageIds, host }: AcknowledgeMessageParams): Promise<string> {
+  async acknowledgeMessage({ messageIds, host }: AcknowledgeMessageParams): Promise<string> {
     if (!Array.isArray(messageIds) || messageIds.length === 0) {
       throw new Error('Message IDs array cannot be empty')
     }
@@ -1997,7 +2052,7 @@ export class MessageBoxClient {
    *   recipientFee: -1
    * })
    */
-  async setMessageBoxPermission (
+  async setMessageBoxPermission(
     params: SetMessageBoxPermissionParams,
     overrideHost?: string
   ): Promise<void> {
@@ -2044,7 +2099,7 @@ export class MessageBoxClient {
    *   sender: '03abc123...'
    * })
    */
-  async getMessageBoxPermission (
+  async getMessageBoxPermission(
     params: GetMessageBoxPermissionParams,
     overrideHost?: string
   ): Promise<MessageBoxPermission | null> {
@@ -2089,7 +2144,7 @@ export class MessageBoxClient {
    *   messageBox: 'notifications'
    * })
    */
-  async getMessageBoxQuote (
+  async getMessageBoxQuote(
     params: GetQuoteParams,
     overrideHost?: string
   ): Promise<MessageBoxQuote | MessageBoxMultiQuote> {
@@ -2282,7 +2337,7 @@ export class MessageBoxClient {
    *   offset: 0
    * })
    */
-  async listMessageBoxPermissions (params?: ListPermissionsParams, overrideHost?: string): Promise<MessageBoxPermission[]> {
+  async listMessageBoxPermissions(params?: ListPermissionsParams, overrideHost?: string): Promise<MessageBoxPermission[]> {
     const finalHost = overrideHost ?? this.host
     const queryParams = new URLSearchParams()
 
@@ -2341,7 +2396,7 @@ export class MessageBoxClient {
    * await client.allowNotificationsFromPeer('03abc123...') // Always allow
    * await client.allowNotificationsFromPeer('03def456...', 5) // Allow for 5 sats
    */
-  async allowNotificationsFromPeer (identityKey: PubKeyHex, recipientFee: number = 0, overrideHost?: string): Promise<void> {
+  async allowNotificationsFromPeer(identityKey: PubKeyHex, recipientFee: number = 0, overrideHost?: string): Promise<void> {
     await this.setMessageBoxPermission({
       messageBox: 'notifications',
       sender: identityKey,
@@ -2361,7 +2416,7 @@ export class MessageBoxClient {
    * @example
    * await client.denyNotificationsFromPeer('03spam123...')
    */
-  async denyNotificationsFromPeer (identityKey: PubKeyHex, overrideHost?: string): Promise<void> {
+  async denyNotificationsFromPeer(identityKey: PubKeyHex, overrideHost?: string): Promise<void> {
     await this.setMessageBoxPermission({
       messageBox: 'notifications',
       sender: identityKey,
@@ -2382,7 +2437,7 @@ export class MessageBoxClient {
    * const status = await client.checkPeerNotificationStatus('03abc123...')
    * console.log(status.allowed) // true/false
    */
-  async checkPeerNotificationStatus (identityKey: PubKeyHex, overrideHost?: string): Promise<MessageBoxPermission | null> {
+  async checkPeerNotificationStatus(identityKey: PubKeyHex, overrideHost?: string): Promise<MessageBoxPermission | null> {
     const myIdentityKey = await this.getIdentityKey()
     return await this.getMessageBoxPermission({
       recipient: myIdentityKey,
@@ -2402,7 +2457,7 @@ export class MessageBoxClient {
    * @example
    * const notifications = await client.listPeerNotifications()
    */
-  async listPeerNotifications (overrideHost?: string): Promise<MessageBoxPermission[]> {
+  async listPeerNotifications(overrideHost?: string): Promise<MessageBoxPermission[]> {
     return await this.listMessageBoxPermissions({ messageBox: 'notifications' }, overrideHost)
   }
 
@@ -2425,7 +2480,7 @@ export class MessageBoxClient {
    * // Send with maximum payment limit for safety
    * await client.sendNotification('03def456...', { title: 'Alert', body: 'Important update' }, 50)
    */
-  async sendNotification (
+  async sendNotification(
     recipient: PubKeyHex | PubKeyHex[],
     body: string | object,
     overrideHost?: string
@@ -2469,7 +2524,7 @@ export class MessageBoxClient {
    *   deviceId: 'iPhone15Pro'
    * })
    */
-  async registerDevice (
+  async registerDevice(
     params: DeviceRegistrationParams,
     overrideHost?: string
   ): Promise<DeviceRegistrationResponse> {
@@ -2534,7 +2589,7 @@ export class MessageBoxClient {
    *   console.log(`Device: ${device.platform} - ${device.fcmToken}`)
    * })
    */
-  async listRegisteredDevices (
+  async listRegisteredDevices(
     overrideHost?: string
   ): Promise<RegisteredDevice[]> {
     const finalHost = overrideHost ?? this.host
@@ -2564,7 +2619,7 @@ export class MessageBoxClient {
   // PRIVATE HELPER METHODS
   // ===========================
 
-  private static getStatusFromFee (fee: number): 'always_allow' | 'blocked' | 'payment_required' {
+  private static getStatusFromFee(fee: number): 'always_allow' | 'blocked' | 'payment_required' {
     if (fee === -1) return 'blocked'
     if (fee === 0) return 'always_allow'
     return 'payment_required'
@@ -2596,7 +2651,7 @@ export class MessageBoxClient {
   * const payment = await client.createMessagePayment(recipientKey, quote)
   * await client.sendMessage({ recipient, messageBox, body, payment })
   */
-  private async createMessagePayment (
+  private async createMessagePayment(
     recipient: string,
     quote: MessageBoxQuote,
     description: string = 'MessageBox delivery payment'
@@ -2713,7 +2768,7 @@ export class MessageBoxClient {
     }
   }
 
-  private async createMessagePaymentBatch (
+  private async createMessagePaymentBatch(
     recipients: string[],
     perRecipientQuotes: Map<string, { recipientFee: number, deliveryFee: number }>,
     // server (delivery agent) identity key to pay the delivery fee to