@bsv/sdk 2.1.0 → 2.1.2

package/src/overlay-tools/SHIPBroadcaster.ts

@@ -50,6 +50,12 @@ export interface AdmittanceInstructions {
  */
 export type STEAK = Record<string, AdmittanceInstructions>
 
+/** The require mode for topic acknowledgment: all topics must be present, or any one suffices. */
+export type RequireMode = 'all' | 'any'
+
+/** Specifies which topics must be acknowledged: all, any, or a specific list. */
+export type TopicAcknowledgmentRequirement = RequireMode | string[]
+
 /** Configuration options for the SHIP broadcaster. */
 export interface SHIPBroadcasterConfig {
   /**
@@ -64,11 +70,11 @@ export interface SHIPBroadcasterConfig {
   /** The resolver used to locate suitable hosts with SHIP */
   resolver?: LookupResolver
   /** Determines which topics (all, any, or a specific list) must be present within all STEAKs received from every host for the broadcast to be considered a success. By default, all hosts must acknowledge all topics. */
-  requireAcknowledgmentFromAllHostsForTopics?: 'all' | 'any' | string[]
+  requireAcknowledgmentFromAllHostsForTopics?: TopicAcknowledgmentRequirement
   /** Determines which topics (all, any, or a specific list) must be present within STEAK received from at least one host for the broadcast to be considered a success. */
-  requireAcknowledgmentFromAnyHostForTopics?: 'all' | 'any' | string[]
+  requireAcknowledgmentFromAnyHostForTopics?: TopicAcknowledgmentRequirement
   /** Determines a mapping whose keys are specific hosts and whose values are the topics (all, any, or a specific list) that must be present within the STEAK received by the given hosts, in order for the broadcast to be considered a success. */
-  requireAcknowledgmentFromSpecificHostsForTopics?: Record<string, 'all' | 'any' | string[]>
+  requireAcknowledgmentFromSpecificHostsForTopics?: Record<string, TopicAcknowledgmentRequirement>
 }
 
 /** Facilitates transaction broadcasts that return STEAK. */
@@ -128,9 +134,9 @@ export default class TopicBroadcaster implements Broadcaster {
   private readonly topics: string[]
   private readonly facilitator: OverlayBroadcastFacilitator
   private readonly resolver: LookupResolver
-  private readonly requireAcknowledgmentFromAllHostsForTopics: | 'all' | 'any' | string[]
-  private readonly requireAcknowledgmentFromAnyHostForTopics: | 'all' | 'any' | string[]
-  private readonly requireAcknowledgmentFromSpecificHostsForTopics: Record<string, 'all' | 'any' | string[]>
+  private readonly requireAcknowledgmentFromAllHostsForTopics: TopicAcknowledgmentRequirement
+  private readonly requireAcknowledgmentFromAnyHostForTopics: TopicAcknowledgmentRequirement
+  private readonly requireAcknowledgmentFromSpecificHostsForTopics: Record<string, TopicAcknowledgmentRequirement>
   private readonly networkPreset: 'mainnet' | 'testnet' | 'local'
 
   // Cache for findInterestedHosts to avoid repeated SHIP tracker lookups
@@ -233,7 +239,7 @@ export default class TopicBroadcaster implements Broadcaster {
       for (const [topic, instructions] of Object.entries(steak)) {
         const outputsToAdmit = instructions.outputsToAdmit
         const coinsToRetain = instructions.coinsToRetain
-        const coinsRemoved = instructions.coinsRemoved as number[]
+        const coinsRemoved = instructions.coinsRemoved
 
         if (
           outputsToAdmit?.length > 0 ||
@@ -248,162 +254,99 @@ export default class TopicBroadcaster implements Broadcaster {
     }
 
     // Now, perform the checks
+    const allHostsError = this.checkAllHostsRequirement(hostAcknowledgments)
+    if (allHostsError != null) return allHostsError
 
-    // Check requireAcknowledgmentFromAllHostsForTopics
-    let requiredTopicsAllHosts: string[]
-    let requireAllHosts: 'all' | 'any'
-
-    if (this.requireAcknowledgmentFromAllHostsForTopics === 'all') {
-      requiredTopicsAllHosts = this.topics
-      requireAllHosts = 'all'
-    } else if (this.requireAcknowledgmentFromAllHostsForTopics === 'any') {
-      requiredTopicsAllHosts = this.topics
-      requireAllHosts = 'any'
-    } else if (Array.isArray(this.requireAcknowledgmentFromAllHostsForTopics)) {
-      requiredTopicsAllHosts = this.requireAcknowledgmentFromAllHostsForTopics
-      requireAllHosts = 'all'
-    } else {
-      // Default to 'all' and 'all'
-      requiredTopicsAllHosts = this.topics
-      requireAllHosts = 'all'
-    }
+    const anyHostError = this.checkAnyHostRequirement(hostAcknowledgments)
+    if (anyHostError != null) return anyHostError
 
-    if (requiredTopicsAllHosts.length > 0) {
-      const allHostsAcknowledged = this.checkAcknowledgmentFromAllHosts(
-        hostAcknowledgments,
-        requiredTopicsAllHosts,
-        requireAllHosts
-      )
-      if (!allHostsAcknowledged) {
-        return {
-          status: 'error',
-          code: 'ERR_REQUIRE_ACK_FROM_ALL_HOSTS_FAILED',
-          description: 'Not all hosts acknowledged the required topics.'
-        }
-      }
+    const specificHostsError = this.checkSpecificHostsRequirement(hostAcknowledgments)
+    if (specificHostsError != null) return specificHostsError
+
+    // If all checks pass, return success
+    return {
+      status: 'success',
+      txid: tx.id('hex'),
+      message: `Sent to ${successfulHosts.length} Overlay Services ${successfulHosts.length === 1 ? 'host' : 'hosts'}.`
     }
+  }
 
-    // Check requireAcknowledgmentFromAnyHostForTopics
-    let requiredTopicsAnyHost: string[]
-    let requireAnyHost: 'all' | 'any'
-
-    if (this.requireAcknowledgmentFromAnyHostForTopics === 'all') {
-      requiredTopicsAnyHost = this.topics
-      requireAnyHost = 'all'
-    } else if (this.requireAcknowledgmentFromAnyHostForTopics === 'any') {
-      requiredTopicsAnyHost = this.topics
-      requireAnyHost = 'any'
-    } else if (Array.isArray(this.requireAcknowledgmentFromAnyHostForTopics)) {
-      requiredTopicsAnyHost = this.requireAcknowledgmentFromAnyHostForTopics
-      requireAnyHost = 'all'
-    } else {
-      // No requirement
-      requiredTopicsAnyHost = []
-      requireAnyHost = 'all'
+  /** Resolves the (requiredTopics, require) pair for requireAcknowledgmentFromAllHostsForTopics. */
+  private resolveAllHostsRequirement (): { requiredTopics: string[], require: RequireMode } {
+    const r = this.requireAcknowledgmentFromAllHostsForTopics
+    if (r === 'any') return { requiredTopics: this.topics, require: 'any' }
+    if (Array.isArray(r)) return { requiredTopics: r, require: 'all' }
+    // Default 'all' or unknown: all topics, all requirement
+    return { requiredTopics: this.topics, require: 'all' }
+  }
+
+  private checkAllHostsRequirement (hostAcknowledgments: Record<string, Set<string>>): BroadcastFailure | null {
+    const { requiredTopics, require } = this.resolveAllHostsRequirement()
+    if (requiredTopics.length === 0) return null
+    if (!this.checkAcknowledgmentFromAllHosts(hostAcknowledgments, requiredTopics, require)) {
+      return { status: 'error', code: 'ERR_REQUIRE_ACK_FROM_ALL_HOSTS_FAILED', description: 'Not all hosts acknowledged the required topics.' }
     }
+    return null
+  }
 
-    if (requiredTopicsAnyHost.length > 0) {
-      const anyHostAcknowledged = this.checkAcknowledgmentFromAnyHost(
-        hostAcknowledgments,
-        requiredTopicsAnyHost,
-        requireAnyHost
-      )
-      if (!anyHostAcknowledged) {
-        return {
-          status: 'error',
-          code: 'ERR_REQUIRE_ACK_FROM_ANY_HOST_FAILED',
-          description: 'No host acknowledged the required topics.'
-        }
-      }
+  /** Resolves the (requiredTopics, require) pair for requireAcknowledgmentFromAnyHostForTopics. */
+  private resolveAnyHostRequirement (): { requiredTopics: string[], require: RequireMode } {
+    const r = this.requireAcknowledgmentFromAnyHostForTopics
+    if (r === 'all') return { requiredTopics: this.topics, require: 'all' }
+    if (r === 'any') return { requiredTopics: this.topics, require: 'any' }
+    if (Array.isArray(r)) return { requiredTopics: r, require: 'all' }
+    return { requiredTopics: [], require: 'all' }
+  }
+
+  private checkAnyHostRequirement (hostAcknowledgments: Record<string, Set<string>>): BroadcastFailure | null {
+    const { requiredTopics, require } = this.resolveAnyHostRequirement()
+    if (requiredTopics.length === 0) return null
+    if (!this.checkAcknowledgmentFromAnyHost(hostAcknowledgments, requiredTopics, require)) {
+      return { status: 'error', code: 'ERR_REQUIRE_ACK_FROM_ANY_HOST_FAILED', description: 'No host acknowledged the required topics.' }
     }
+    return null
+  }
 
-    // Check requireAcknowledgmentFromSpecificHostsForTopics
-    if (
-      Object.keys(this.requireAcknowledgmentFromSpecificHostsForTopics).length >
-      0
-    ) {
-      const specificHostsAcknowledged =
-        this.checkAcknowledgmentFromSpecificHosts(
-          hostAcknowledgments,
-          this.requireAcknowledgmentFromSpecificHostsForTopics
-        )
-      if (!specificHostsAcknowledged) {
-        return {
-          status: 'error',
-          code: 'ERR_REQUIRE_ACK_FROM_SPECIFIC_HOSTS_FAILED',
-          description:
-            'Specific hosts did not acknowledge the required topics.'
-        }
-      }
+  private checkSpecificHostsRequirement (hostAcknowledgments: Record<string, Set<string>>): BroadcastFailure | null {
+    if (Object.keys(this.requireAcknowledgmentFromSpecificHostsForTopics).length === 0) return null
+    if (!this.checkAcknowledgmentFromSpecificHosts(hostAcknowledgments, this.requireAcknowledgmentFromSpecificHostsForTopics)) {
+      return { status: 'error', code: 'ERR_REQUIRE_ACK_FROM_SPECIFIC_HOSTS_FAILED', description: 'Specific hosts did not acknowledge the required topics.' }
     }
+    return null
+  }
 
-    // If all checks pass, return success
-    return {
-      status: 'success',
-      txid: tx.id('hex'),
-      message: `Sent to ${successfulHosts.length} Overlay Services ${successfulHosts.length === 1 ? 'host' : 'hosts'}.`
+  /**
+   * Returns true if `acknowledgedTopics` satisfies the given requirement against `requiredTopics`.
+   */
+  private topicsMatchRequirement (
+    acknowledgedTopics: Set<string>,
+    requiredTopics: string[],
+    require: RequireMode
+  ): boolean {
+    if (require === 'all') {
+      return requiredTopics.every(t => acknowledgedTopics.has(t))
     }
+    return requiredTopics.some(t => acknowledgedTopics.has(t))
   }
 
   private checkAcknowledgmentFromAllHosts (
     hostAcknowledgments: Record<string, Set<string>>,
     requiredTopics: string[],
-    require: 'all' | 'any'
+    require: RequireMode
   ): boolean {
-    for (const acknowledgedTopics of Object.values(hostAcknowledgments)) {
-      if (require === 'all') {
-        for (const topic of requiredTopics) {
-          if (!acknowledgedTopics.has(topic)) {
-            return false
-          }
-        }
-      } else if (require === 'any') {
-        let anyAcknowledged = false
-        for (const topic of requiredTopics) {
-          if (acknowledgedTopics.has(topic)) {
-            anyAcknowledged = true
-            break
-          }
-        }
-        if (!anyAcknowledged) {
-          return false
-        }
-      }
-    }
-    return true
+    return Object.values(hostAcknowledgments).every(
+      acknowledged => this.topicsMatchRequirement(acknowledged, requiredTopics, require)
+    )
   }
 
   private checkAcknowledgmentFromAnyHost (
     hostAcknowledgments: Record<string, Set<string>>,
     requiredTopics: string[],
-    require: 'all' | 'any'
+    require: RequireMode
   ): boolean {
-    if (require === 'all') {
-      // All required topics must be acknowledged by at least one host
-      for (const acknowledgedTopics of Object.values(hostAcknowledgments)) {
-        let acknowledgesAllRequiredTopics = true
-        for (const topic of requiredTopics) {
-          if (!acknowledgedTopics.has(topic)) {
-            acknowledgesAllRequiredTopics = false
-            break
-          }
-        }
-        if (acknowledgesAllRequiredTopics) {
-          return true
-        }
-      }
-      return false
-    } else {
-      // At least one required topic must be acknowledged by at least one host
-      for (const acknowledgedTopics of Object.values(hostAcknowledgments)) {
-        for (const topic of requiredTopics) {
-          if (acknowledgedTopics.has(topic)) {
-            return true
-          }
-        }
-      }
-      return false
-    }
+    return Object.values(hostAcknowledgments).some(
+      acknowledged => this.topicsMatchRequirement(acknowledged, requiredTopics, require)
+    )
   }
 
   private checkAcknowledgmentFromSpecificHosts (
@@ -417,11 +360,8 @@ export default class TopicBroadcaster implements Broadcaster {
         return false
       }
       let requiredTopics: string[]
-      let require: 'all' | 'any'
-      if (
-        requiredTopicsOrAllAny === 'all' ||
-        requiredTopicsOrAllAny === 'any'
-      ) {
+      let require: RequireMode
+      if (requiredTopicsOrAllAny === 'all' || requiredTopicsOrAllAny === 'any') {
         require = requiredTopicsOrAllAny
         requiredTopics = this.topics
       } else if (Array.isArray(requiredTopicsOrAllAny)) {
@@ -431,23 +371,8 @@ export default class TopicBroadcaster implements Broadcaster {
         // Invalid configuration
         continue
       }
-      if (require === 'all') {
-        for (const topic of requiredTopics) {
-          if (!acknowledgedTopics.has(topic)) {
-            return false
-          }
-        }
-      } else if (require === 'any') {
-        let anyAcknowledged = false
-        for (const topic of requiredTopics) {
-          if (acknowledgedTopics.has(topic)) {
-            anyAcknowledged = true
-            break
-          }
-        }
-        if (!anyAcknowledged) {
-          return false
-        }
+      if (!this.topicsMatchRequirement(acknowledgedTopics, requiredTopics, require)) {
+        return false
       }
     }
     return true
@@ -462,8 +387,8 @@ export default class TopicBroadcaster implements Broadcaster {
     // Handle the local network preset
     if (this.networkPreset === 'local') {
       const resultSet = new Set<string>()
-      for (let i = 0; i < this.topics.length; i++) {
-        resultSet.add(this.topics[i])
+      for (const topic of this.topics) {
+        resultSet.add(topic)
       }
       return { 'http://localhost:8080': resultSet }
     }
@@ -519,11 +444,10 @@ export default class TopicBroadcaster implements Broadcaster {
         ) {
           continue
         }
-        if (results[parsed.domain] === undefined) {
-          results[parsed.domain] = new Set()
-        }
+        results[parsed.domain] ??= new Set()
         results[parsed.domain].add(parsed.topicOrService)
-      } catch (e) {
+      } catch (_notShipOutput) {
+        // Output could not be decoded as an overlay admin token — not a SHIP advertisement; skip
         continue
       }
     }

package/src/primitives/AESGCM.ts

@@ -54,7 +54,7 @@ const Rcon = [
 const mul2 = new Uint8Array(256)
 const mul3 = new Uint8Array(256)
 for (let i = 0; i < 256; i++) {
-  const m2 = ((i << 1) ^ ((i & 0x80) !== 0 ? 0x1b : 0)) & 0xff
+  const m2 = ((i << 1) ^ ((i & 0x80) === 0 ? 0 : 0x1b)) & 0xff
   mul2[i] = m2
   mul3[i] = m2 ^ i
 }
@@ -217,7 +217,7 @@ export const checkBit = function (
   byteIndex: number,
   bitIndex: number
 ): 1 | 0 {
-  return (byteArray[byteIndex] & (0x01 << bitIndex)) !== 0 ? 1 : 0
+  return (byteArray[byteIndex] & (0x01 << bitIndex)) === 0 ? 0 : 1
 }
 
 export const getBytes = function (numericValue: number): number[] {