@bsv/overlay-discovery-services 1.2.0 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/overlay-discovery-services",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "type": "module",
   "description": "BSV Blockchain Overlay Services Engine",
   "main": "dist/cjs/mod.js",
@@ -62,7 +62,7 @@
     "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@bsv/overlay": "^0.1.25",
+    "@bsv/overlay": "^0.2.1",
     "@bsv/sdk": "^1.4.6",
     "@bsv/wallet-toolbox-client": "^1.2.10",
     "mongodb": "^6.11.0"

package/src/SHIP/SHIPLookupService.ts

@@ -1,6 +1,6 @@
-import { LookupService, LookupQuestion, LookupAnswer, LookupFormula } from '@bsv/overlay'
+import { LookupService, LookupQuestion, LookupAnswer, LookupFormula, AdmissionMode, OutputAdmittedByTopic, OutputSpent, SpendNotificationMode } from '@bsv/overlay'
 import { SHIPStorage } from './SHIPStorage.js'
-import { Script, PushDrop, Utils } from '@bsv/sdk'
+import { PushDrop, Utils } from '@bsv/sdk'
 import { SHIPQuery } from 'src/types.js'
 import SHIPLookupDocs from './SHIPLookup.docs.js'
 
@@ -11,18 +11,15 @@ import SHIPLookupDocs from './SHIPLookup.docs.js'
  * within the overlay network.
  */
 export class SHIPLookupService implements LookupService {
+  admissionMode: AdmissionMode = 'locking-script'
+  spendNotificationMode: SpendNotificationMode = 'none'
   constructor(public storage: SHIPStorage) { }
 
-  /**
-   * Handles the addition of a new output to the topic.
-   * @param txid - The transaction ID containing the output.
-   * @param outputIndex - The index of the output in the transaction.
-   * @param outputScript - The script of the output to be processed.
-   * @param topic - The topic associated with the output.
-   */
-  async outputAdded?(txid: string, outputIndex: number, outputScript: Script, topic: string): Promise<void> {
+  async outputAdmittedByTopic(payload: OutputAdmittedByTopic): Promise<void> {
+    if (payload.mode !== 'locking-script') throw new Error('Invalid payload')
+    const { topic, lockingScript, txid, outputIndex } = payload
     if (topic !== 'tm_ship') return
-    const result = PushDrop.decode(outputScript)
+    const result = PushDrop.decode(lockingScript)
     const shipIdentifier = Utils.toUTF8(result.fields[0])
     const identityKey = Utils.toHex(result.fields[1])
     const domain = Utils.toUTF8(result.fields[2])
@@ -31,33 +28,17 @@ export class SHIPLookupService implements LookupService {
     await this.storage.storeSHIPRecord(txid, outputIndex, identityKey, domain, topicSupported)
   }
 
-  /**
-   * Handles the spending of an output in the topic.
-   * @param txid - The transaction ID of the spent output.
-   * @param outputIndex - The index of the spent output.
-   * @param topic - The topic associated with the spent output.
-   */
-  async outputSpent?(txid: string, outputIndex: number, topic: string): Promise<void> {
+  async outputSpent(payload: OutputSpent): Promise<void> {
+    if (payload.mode !== 'none') throw new Error('Invalid payload')
+    const { topic, txid, outputIndex } = payload
     if (topic !== 'tm_ship') return
     await this.storage.deleteSHIPRecord(txid, outputIndex)
   }
 
-  /**
-   * Handles the deletion of an output in the topic.
-   * @param txid - The transaction ID of the deleted output.
-   * @param outputIndex - The index of the deleted output.
-   * @param topic - The topic associated with the deleted output.
-   */
-  async outputDeleted?(txid: string, outputIndex: number, topic: string): Promise<void> {
-    if (topic !== 'tm_ship') return
+  async outputEvicted (txid: string, outputIndex: number): Promise<void> {
     await this.storage.deleteSHIPRecord(txid, outputIndex)
   }
 
-  /**
-   * Answers a lookup query.
-   * @param question - The lookup question to be answered.
-   * @returns A promise that resolves to a lookup answer or formula.
-   */
   async lookup(question: LookupQuestion): Promise<LookupAnswer | LookupFormula> {
     if (question.query === undefined || question.query === null) {
       throw new Error('A valid query must be provided!')
@@ -84,18 +65,10 @@ export class SHIPLookupService implements LookupService {
     return await this.storage.findRecord({ domain, topics, identityKey })
   }
 
-  /**
-   * Returns documentation specific to this overlay lookup service.
-   * @returns A promise that resolves to the documentation string.
-   */
   async getDocumentation(): Promise<string> {
     return SHIPLookupDocs
   }
 
-  /**
-   * Returns metadata associated with this lookup service.
-   * @returns A promise that resolves to an object containing metadata.
-   */
   async getMetaData(): Promise<{
     name: string
     shortDescription: string

package/src/SLAP/SLAPLookupService.ts

@@ -1,6 +1,6 @@
-import { LookupService, LookupQuestion, LookupAnswer, LookupFormula } from '@bsv/overlay'
+import { LookupService, LookupQuestion, LookupAnswer, LookupFormula, AdmissionMode, OutputAdmittedByTopic, OutputSpent, SpendNotificationMode } from '@bsv/overlay'
+import { PushDrop, Utils } from '@bsv/sdk'
 import { SLAPStorage } from './SLAPStorage.js'
-import { Script, PushDrop, Utils } from '@bsv/sdk'
 import { SLAPQuery } from 'src/types.js'
 import SLAPLookupDocs from './SLAPLookup.docs.js'
 
@@ -12,18 +12,15 @@ import SLAPLookupDocs from './SLAPLookup.docs.js'
  * records for lookup purposes.
  */
 export class SLAPLookupService implements LookupService {
+  admissionMode: AdmissionMode = 'locking-script'
+  spendNotificationMode: SpendNotificationMode = 'none'
   constructor(public storage: SLAPStorage) { }
 
-  /**
-   * Handles the addition of a new output to the topic.
-   * @param txid - The transaction ID containing the output.
-   * @param outputIndex - The index of the output in the transaction.
-   * @param outputScript - The script of the output to be processed.
-   * @param topic - The topic associated with the output.
-   */
-  async outputAdded?(txid: string, outputIndex: number, outputScript: Script, topic: string): Promise<void> {
+  async outputAdmittedByTopic(payload: OutputAdmittedByTopic): Promise<void> {
+    if (payload.mode !== 'locking-script') throw new Error('Invalid mode')
+    const { txid, outputIndex, lockingScript, topic } = payload
     if (topic !== 'tm_slap') return
-    const result = PushDrop.decode(outputScript)
+    const result = PushDrop.decode(lockingScript)
     const protocol = Utils.toUTF8(result.fields[0])
     const identityKey = Utils.toHex(result.fields[1])
     const domain = Utils.toUTF8(result.fields[2])
@@ -32,33 +29,17 @@ export class SLAPLookupService implements LookupService {
     await this.storage.storeSLAPRecord(txid, outputIndex, identityKey, domain, service)
   }
 
-  /**
-   * Handles the spending of an output in the topic.
-   * @param txid - The transaction ID of the spent output.
-   * @param outputIndex - The index of the spent output.
-   * @param topic - The topic associated with the spent output.
-   */
-  async outputSpent?(txid: string, outputIndex: number, topic: string): Promise<void> {
+  async outputSpent(payload: OutputSpent): Promise<void> {
+    if (payload.mode !== 'none') throw new Error('Invalid payload')
+    const { topic, txid, outputIndex } = payload
     if (topic !== 'tm_slap') return
     await this.storage.deleteSLAPRecord(txid, outputIndex)
   }
 
-  /**
-   * Handles the deletion of an output in the topic.
-   * @param txid - The transaction ID of the deleted output.
-   * @param outputIndex - The index of the deleted output.
-   * @param topic - The topic associated with the deleted output.
-   */
-  async outputDeleted?(txid: string, outputIndex: number, topic: string): Promise<void> {
-    if (topic !== 'tm_slap') return
+  async outputEvicted (txid: string, outputIndex: number): Promise<void> {
     await this.storage.deleteSLAPRecord(txid, outputIndex)
   }
 
-  /**
-   * Answers a lookup query.
-   * @param question - The lookup question to be answered.
-   * @returns A promise that resolves to a lookup answer or formula.
-   */
   async lookup(question: LookupQuestion): Promise<LookupAnswer | LookupFormula> {
     if (question.query === undefined || question.query === null) {
       throw new Error('A valid query must be provided!')
@@ -96,18 +77,10 @@ export class SLAPLookupService implements LookupService {
     return result
   }
 
-  /**
-   * Returns documentation specific to this overlay lookup service.
-   * @returns A promise that resolves to the documentation string.
-   */
   async getDocumentation(): Promise<string> {
     return SLAPLookupDocs
   }
 
-  /**
-   * Returns metadata associated with this lookup service.
-   * @returns A promise that resolves to an object containing metadata.
-   */
   async getMetaData(): Promise<{
     name: string
     shortDescription: string

package/src/WalletAdvertiser.ts

@@ -121,13 +121,18 @@ export class WalletAdvertiser implements Advertiser {
       resolver = new LookupResolver({ networkPreset: network })
     }
     const advertisements: Advertisement[] = []
-    const lookupAnswer = await resolver.query({
-      service: protocol === 'SHIP' ? 'ls_ship' : 'ls_slap',
-      query: {
-        identityKey: this.identityKey
-      }
-    })
-
+    let lookupAnswer
+    try {
+      lookupAnswer = await resolver.query({
+        service: protocol === 'SHIP' ? 'ls_ship' : 'ls_slap',
+        query: {
+          identityKey: this.identityKey
+        }
+      })
+    } catch (e) {
+      console.warn(`Error finding ${protocol} advertisements`, e)
+      return advertisements
+    }
     // Lookup will currently always return type output-list
     if (lookupAnswer.type === 'output-list') {
       lookupAnswer.outputs.forEach(output => {