@bsv/overlay 0.1.0-alpha.3 → 0.1.0-alpha.4

package/src/Engine.ts

@@ -9,6 +9,9 @@ import { LookupQuestion } from './LookupQuestion.js'
 import { LookupAnswer } from './LookupAnswer.js'
 import { LookupFormula } from './LookupFormula.js'
 import { Transaction, ChainTracker, MerklePath, Broadcaster } from '@bsv/sdk'
+import { Advertiser } from './Advertiser.js'
+import { SHIPAdvertisement } from './SHIPAdvertisement.js'
+import { SLAPAdvertisement } from './SLAPAdvertisement.js'
 
 /**
  * Am engine for running BSV Overlay Services (topic managers and lookup services).
@@ -20,14 +23,18 @@ export class Engine {
    * @param {[key: string]: LookupService} lookupServices - manages UTXO lookups
    * @param {Storage} storage - for interacting with internally-managed persistent data
    * @param {ChainTracker} chainTracker - Verifies SPV data associated with transactions
+   * @param {string} hostingURL
    * @param {Broadcaster} [Broadcaster] - broadcaster used for broadcasting the incoming transaction
+   * @param {Advertiser} [Advertiser] - handles SHIP and SLAP advertisements for peer-discovery
    */
   constructor(
     public managers: { [key: string]: TopicManager },
     public lookupServices: { [key: string]: LookupService },
     public storage: Storage,
     public chainTracker: ChainTracker,
-    public broadcaster?: Broadcaster
+    public hostingURL: string,
+    public broadcaster?: Broadcaster,
+    public advertiser?: Advertiser
   ) { }
 
   /**
@@ -207,8 +214,87 @@ export class Engine {
     if (Object.keys(steak).length > 0 && this.broadcaster !== undefined) {
       await this.broadcaster.broadcast(tx)
     }
+
+    // If we don't have an advertiser, just return the steak
+    if (this.advertiser === undefined) {
+      return steak
+    }
+
+    // Propagate transaction to other nodes according to synchronization agreements
+    // 1. Find nodes that host the topics associated with admissable outputs
+    // We want to figure out which topics we actually care about (because their associated outputs were admitted)
+    // AND if the topic was not admitted we want to remove it from the list of topics we care about.
+    const relevantTopics = taggedBEEF.topics.filter(topic =>
+      steak[topic] !== undefined && steak[topic].outputsToAdmit.length !== 0
+    )
+
+    if (relevantTopics.length > 0) {
+      // Find all SHIP advertisements for the topics we care about
+      const domainToTopicsMap = new Map<string, Set<string>>()
+      for (const topic of relevantTopics) {
+        try {
+          // Handle custom lookup service answers
+          const lookupAnswer = await this.lookup({
+            service: 'ls_ship',
+            query: {
+              topic
+            }
+          })
+
+          // Lookup will currently always return type output-list
+          if (lookupAnswer.type === 'output-list') {
+            const shipAdvertisements: SHIPAdvertisement[] = []
+            lookupAnswer.outputs.forEach(output => {
+              try {
+                // Parse out the advertisements using the provided parser
+                const tx = Transaction.fromBEEF(output.beef)
+                const advertisement = this.advertiser?.parseAdvertisement(tx.outputs[output.outputIndex].lockingScript)
+                if (advertisement !== undefined && advertisement !== null && advertisement.protocol === 'SHIP') {
+                  shipAdvertisements.push(advertisement)
+                }
+              } catch (error) {
+                console.error('Failed to parse advertisement output:', error)
+              }
+            })
+            if (shipAdvertisements.length > 0) {
+              shipAdvertisements.forEach((advertisement: SHIPAdvertisement) => {
+                if (!domainToTopicsMap.has(advertisement.domainName)) {
+                  domainToTopicsMap.set(advertisement.domainName, new Set<string>())
+                }
+                domainToTopicsMap.get(advertisement.domainName)?.add(topic)
+              })
+            }
+          }
+        } catch (error) {
+          console.error(`Error looking up topic ${String(topic)}:`, error)
+        }
+      }
+
+      const broadcastPromises: Array<Promise<Response>> = []
+
+      // Note: We are depending on window.fetch, this may not be ideal for the long term.
+      for (const [domain, topics] of domainToTopicsMap.entries()) {
+        if (domain !== this.hostingURL) {
+          const promise = fetch(`${String(domain)}/submit`, {
+            method: 'POST',
+            headers: {
+              'Content-Type': 'application/octet-stream',
+              'X-Topics': JSON.stringify(Array.from(topics))
+            },
+            body: new Uint8Array(taggedBEEF.beef)
+          })
+          broadcastPromises.push(promise)
+        }
+      }
+
+      try {
+        await Promise.all(broadcastPromises)
+      } catch (error) {
+        console.error('Error during broadcasting:', error)
+      }
+    }
+
     return steak
-    // TODO propagate transaction to other nodes according to synchronization agreements
   }
 
   /**
@@ -255,6 +341,81 @@ export class Engine {
     }
   }
 
+  /**
+   * Ensures alignment between the current SHIP/SLAP advertisements and the 
+   * configured Topic Managers and Lookup Services in the engine.
+   *
+   * This method performs the following actions:
+   * 1. Retrieves the current configuration of topics and services.
+   * 2. Fetches the existing SHIP advertisements for each configured topic.
+   * 3. Fetches the existing SLAP advertisements for each configured service.
+   * 4. Compares the current configuration with the fetched advertisements to determine which advertisements
+   *    need to be created or revoked.
+   * 5. Creates new SHIP/SLAP advertisements if they do not exist for the configured topics/services.
+   * 6. Revokes existing SHIP/SLAP advertisements if they are no longer required based on the current configuration.
+   *
+   * The function uses the `Advertiser` methods to create or revoke advertisements and ensures the updates are
+   * submitted to the SHIP/SLAP overlay networks using the engine's `submit()` method.
+   *
+   * @throws Will throw an error if there are issues during the advertisement synchronization process.
+   * @returns {Promise<void>} A promise that resolves when the synchronization process is complete.
+   */
+  async syncAdvertisements(): Promise<void> {
+    if (this.advertiser === undefined) {
+      return
+    }
+    // Step 1: Retrieve Current Configuration
+    const configuredTopics = Object.keys(this.managers)
+    const configuredServices = Object.keys(this.lookupServices)
+
+    // Step 2: Fetch Existing Advertisements for each topic and service
+    const currentSHIPAdvertisements: SHIPAdvertisement[] = []
+    for (const topic of configuredTopics) {
+      const ads = await this.advertiser.findAllSHIPAdvertisements(topic)
+      currentSHIPAdvertisements.push(...ads)
+    }
+
+    const currentSLAPAdvertisements: SLAPAdvertisement[] = []
+    for (const service of configuredServices) {
+      const ads = await this.advertiser.findAllSLAPAdvertisements(service)
+      currentSLAPAdvertisements.push(...ads)
+    }
+
+    // Step 3: Compare and Determine Actions
+    const requiredSHIPAdvertisements = new Set(configuredTopics)
+    const requiredSLAPAdvertisements = new Set(configuredServices)
+
+    const existingSHIPTopics = new Set(currentSHIPAdvertisements.map(ad => ad.topicName))
+    const existingSLAPServices = new Set(currentSLAPAdvertisements.map(ad => ad.serviceName))
+
+    const shipToCreate = Array.from(requiredSHIPAdvertisements).filter(topic => !existingSHIPTopics.has(topic))
+    const shipToRevoke = currentSHIPAdvertisements.filter(ad => !requiredSHIPAdvertisements.has(ad.topicName))
+
+    const slapToCreate = Array.from(requiredSLAPAdvertisements).filter(service => !existingSLAPServices.has(service))
+    const slapToRevoke = currentSLAPAdvertisements.filter(ad => !requiredSLAPAdvertisements.has(ad.serviceName))
+
+    // Step 4: Update Advertisements
+    for (const topic of shipToCreate) {
+      const taggedBEEF = await this.advertiser.createSHIPAdvertisement(topic)
+      await this.submit(taggedBEEF)
+    }
+
+    for (const service of slapToCreate) {
+      const taggedBEEF = await this.advertiser.createSLAPAdvertisement(service)
+      await this.submit(taggedBEEF)
+    }
+
+    for (const ad of shipToRevoke) {
+      const taggedBEEF = await this.advertiser.revokeAdvertisement(ad)
+      await this.submit(taggedBEEF)
+    }
+
+    for (const ad of slapToRevoke) {
+      const taggedBEEF = await this.advertiser.revokeAdvertisement(ad)
+      await this.submit(taggedBEEF)
+    }
+  }
+
   /**
    * Traverse and return the history of a UTXO.
    *

package/src/SHIPAdvertisement.ts

@@ -0,0 +1,8 @@
+export interface SHIPAdvertisement {
+  protocol: 'SHIP'
+  identityKey: string
+  domainName: string
+  topicName: string
+  beef?: number[]
+  outputIndex?: number
+}

package/src/SLAPAdvertisement.ts

@@ -0,0 +1,8 @@
+export interface SLAPAdvertisement {
+  protocol: 'SLAP'
+  identityKey: string
+  domainName: string
+  serviceName: string
+  beef?: number[]
+  outputIndex?: number
+}

package/src/__tests/Engine.test.ts

@@ -63,6 +63,64 @@ describe('BSV Overlay Services Engine', () => {
       deleteOutput: jest.fn()
     }
   })
+  describe('handleNewMerkleProof tests', () => {
+const mockOutput: Output = {
+  txid: exampleTXID,
+  outputIndex: 0,
+  outputScript: exampleTX.outputs[0].lockingScript.toBinary(),
+  topic: 'hello',
+  satoshis: exampleTX.outputs[0].satoshis as number,
+  beef: exampleBeef,
+  spent: false,
+  outputsConsumed: [],
+  consumedBy: []
+}
+    it('0 simple proof', async () => {
+      const beef = beef27c8f_1
+      const txid = txid27c8f
+      const tx = Transaction.fromHexBEEF(beef)
+
+      const output27c8f_0: Output = {
+        txid: txid,
+        outputIndex: 0,
+        outputScript: tx.outputs[0].lockingScript.toBinary(),
+        topic: 'hello',
+        satoshis: tx.outputs[0].satoshis as number,
+        beef: tx.toBEEF(),
+        spent: false,
+        outputsConsumed: [],
+        consumedBy: []
+      }
+
+      mockLookupService.lookup = jest.fn(async () => [{
+        txid: txid,
+        outputIndex: 0,
+        history: 1
+      }])
+      let newBEEF: number[] = []
+      mockStorageEngine.findOutput = jest.fn(async () => output27c8f_0)
+      mockStorageEngine.findOutputsForTransaction = jest.fn(async () => [output27c8f_0])
+      mockStorageEngine.updateOutputBeef = jest.fn(async (txid: string, outputIndex: number, topic: string, beef: number[]) => {
+        newBEEF = beef
+      })
+      const engine = new Engine(
+        {
+          Hello: mockTopicManager
+        },
+        {
+          Hello: mockLookupService
+        },
+        mockStorageEngine,
+        mockChainTracker
+      )
+
+      const merklePath = Transaction.fromHexBEEF(beef27c8f_0).merklePath
+      if (!merklePath) throw('improper test setup')
+      await engine.handleNewMerkleProof(txid, merklePath)
+      expect(newBEEF.length > 0 && newBEEF.length < beef.length / 2).toBe(true)
+    })
+  })
+
   describe('submit', () => {
     it('Throws an error if the user submits to a topic that is not supported', async () => {
       const engine = new Engine(
@@ -792,3 +850,10 @@ describe('BSV Overlay Services Engine', () => {
     //   })
   })
 })
+
+// beef27c8f_1 is 1 level deep, i.e. proofs on inputs
+const beef27c8f_1 = '0100beef01feafcf0c000802020044ef36fc6c79af360b13f2164c6e772e6e5e2083a54d72894f34710fe6a68cf80302792c8c563b17721744d8f101d79e873aae62816d0fd47dd9d90ada219c1b252d010000059e83aae2cfc6a35477566439dd9d58969cc41a134864c671c9b844f2a409a60101004991c129bba819832d6dd315c3a2065bd31b1a60aff8192be335f83731641e690101002f87724a7387df82417902266d2a4fb2fee857451e963a352ce8acbb279aa9eb010100a9e9eb55d20cef840bacbdb26ad8d6e7680ef7653364830b1e770fa140ece6bb010100f0ecd03fff2df21b0034d331cade50152781be9052dcec54eb95c963ef1cdcbf0101006fdb2c01a266e761a32f53b3ad0fabbca31ae234d31d85d9af9bbd624b321c9b0101008108cad77aabf7b0ee371f42afd773cada534244535f7108c7590df2b9d5f8a2020100000006e9847b33c5d666ccee1dccd52235489d8d58bf432be1b8c0cc7c13af80f10703030000006b483045022100fe8a18e043d693246a56c9b32ff553bea89a0bbe389bc55e8244044dcd865de3022065245c30fbbcc6820e4761048ed28c587bf41ece1933dfb85b8fa8c3433d93504121022f2ac22e73a55aa4ff21e905f66959200642ae74716544f834a48af5aa53fb27ffffffff7e8823d7e3e5565fdb9e53c015ad5b63bc6dd6ee1a9be7f7a8e105c903783d45050000006b483045022100e6332a6459350ff2486a39b6d79cdc0b65b6d52cf898fc457e45880c0db01b2a02206e34126bc81e6f03c6de90278788d6b2be3a3f5d7bd85e6442bbea90b8a5e2394121029780a1a98be5ff17a3228feb830e3bc32395ebecc5cf6de08f7a5685faf66c07ffffffff7e8823d7e3e5565fdb9e53c015ad5b63bc6dd6ee1a9be7f7a8e105c903783d45040000006b483045022100dfba71c6c33d2366b2202ea136271fd2f3a26c0a7295f6dd6018fbe12fc48708022052387ca532247bbfffef4b076fd2fbbdebe85b3cf53c73004897cd07be5d1ad6412103f735eb69c9f0b3c90dd2798b709e12a5b3d176a4690bd2a31ec616af9ecd47b5ffffffff7e8823d7e3e5565fdb9e53c015ad5b63bc6dd6ee1a9be7f7a8e105c903783d45020000006b483045022100f941b74c5da1e7f0ce4d1c08745e4d6b8ef56656199505caeff4b74f54890cec02201eaa0d01112497c89ebe4818687c5f3305629a83abd3b0bf5135feee68f57ca0412103fb0ec51f9e6e45b213cb1deff921e3322624cfb6d4a4ba5dc699867cf163b736ffffffff7e8823d7e3e5565fdb9e53c015ad5b63bc6dd6ee1a9be7f7a8e105c903783d45030000006a47304402205a3a2848350fdc19cae73243bea16dfc1e8fbbd5cecde4b5c88a57790505cebb022043db51d04998d52ec394d0e945a76e9922dd63caffb882242bec2ced2a35c7f1412102bae3e2f47dceaed7db2a212e059a00674a0087e3395b92d9f12cdbefdbc84efaffffffffad49b6f41125ffadab03cb2dcc24caf2c897c2cd4aed6e0a3b5c003f2dde757a030000006b483045022100aa7aaec7fc6c5a2f4d5318b7fcbbca0f223c5c198f8fc0e1c8d59aee7155af1202207a4960fb58aa86eba12852f84fa3cdb4c427c7374fe737b3d5bcd9e2a6d76e3b412102b55cfd872e85b3dd424dcceafe01ed5a87dfb599d354ab7fc50d9ec48af77f6effffffff1a400d0300000000001976a914f182138abcb69c7c2339040605aa0a442cfec44288acc8000000000000001976a914e9d2276f468223a6d650672ab9d4c1271fb157e288acacb00000000000001976a914c0ea0208a097df8146933ae15f3ce545d5451e7388ac7a140000000000001976a9142d9ae3291f9393639fe2c38c9a7a948d136a10b488acea070000000000001976a91435d1c396b7ccb467118a41c2d77ebf79fb5fb7eb88ac17050000000000001976a9140dac1e2ddc975ee6d9f393e2ccd4876edb386cdd88ac51060000000000001976a91422878cb2f57a1ebe513815562003128f6e99eda188ac67040000000000001976a91439a752923ba1ef8b126ba7886646d58f54521c6588ac1e040000000000001976a914a939565af52d3fa974a040f42c35365d76b98f6a88acec030000000000001976a914c90823a53e29cafd35a225cc14e3a44eda143a5788ac05040000000000001976a914af6f8d6aaec3bf123efc17c8977bfad1ec1c859388acec030000000000001976a914d4c5e66a062e634be1c6f0eb1f2af0acebecb47988acf1030000000000001976a914a94a3e84bd740095ab39bed110cd3b3922c8595088ace8030000000000001976a914aa2e3c3bf6f3ee79f5af3b94eab2be60a394ce4c88aceb030000000000001976a91459394fa083ff3726571c79624dba3b38f14d924c88ace8030000000000001976a914726eb3ae6211711aa1624f3d767035b0b44abdc488ace8030000000000001976a9145f4680a099a6dc6891af3094aaab96aa66a6259888ace8030000000000001976a914f1a4fbd99e3923b0934abdb8839c337eb2fd50b888ace8030000000000001976a9147ed0ad307f5fe9993f984e7525c0012e3569594588ace8030000000000001976a91407f386bcdc4892cc2d0be3226b721ceaf04750b288ace8030000000000001976a914b51edaaa3c92d0af94109d952c7ddf13aa345f9988ace8030000000000001976a914018f4e02bd74f17a75f5b3965db4633ab514c57588ace8030000000000001976a914cc8d1f7ba5406b81efbc23da0fcccb4d3fe5b40a88ace8030000000000001976a914db1d4b7bd3e62f535dc3f2c8d0a989b000fa736d88ace8030000000000001976a914b8ea69358da7bea9506b15db6fc6597b3849b0a188ace8030000000000001976a914ecd769fdd67e04786e871c50c1a10504861bd79488ac0000000001000100000001792c8c563b17721744d8f101d79e873aae62816d0fd47dd9d90ada219c1b252d070000006b48304502210090368b5925795abb0415a3cd6265d7abae7d3541fb7f2fdb1fdffdd916b3fce3022068136da44df8ee367807c7c59c950ea8d428adfe142268cd6371cf4c1b4c3208412102858ea1804708d1e16e77b49ba1559b3742797f5f43efd3922fa3d21557521d7cffffffff03f401000000000000fde10121026afd108ddbc05e093207ebdf06557a3d66e15b96accbf1766c2e7d6efa3d1981ac22313852713463583334356b6a7461734467764b41455a435135564c5a72516f76786d2081d846bcae65ce281829b6d81eff3862a68b8eaf4e99ad97c0c4ad2e149631c020f936ace2d2b4034710dec819e343f69ddbb1a16d721b88413b697c2475f75f504c4e8470062e6966cb7ec80864e5e1217ecf2b3f113bb5307e1ec1d338678e54b426a11a267e990f7dcd85072c7b3870fabb54812d7f8a7aaa672ce01e4f8a2c6a1d532849877329bd23be0b3383fcb437ffd1ff05aad824343bfe5bae52d5775ed99ba9d5a72038dd50f81153e674a8b1c5d659aac361e660cc5657b291eda149de2505efb0bbac0a353331393633353238334c797f3040f01934bb25733d4700a0309194a7defd8ceea7a8a59ad279c6237e2917264a115773777c5746546288b15ec1cf6788b801dd3952fec804cadbba2ff4e05464735e2db83c3509b59119efc843716c34becd2884f011f2e7f61f382237891875115b6ea5bac1c3e9ca6c575b44547d589c38c1b5a8cadb463044022016e1fdb226b465f3151aaa1e033b122dd58f3b495d2846d532f784ec8f6fc9ae022031dc12155c02e7f588c9f6d975a79c9c26cf341c1c88578cd6a87a3c01f6a73d6d6d6d6dc8000000000000001976a914010b7bfa8ff585b6d95f8a18a998cbd87508bd4188aca9010000000000001976a914254c6f1ce67d27ae4dafb03d2ba08318df2883c588ac0000000000'
+// beef27c8f_0 is 0 levels deep, i.e. tx has merklePath
+const beef27c8f_0 = '0100beef01fef4f10c000902fd020100ab2d9b3bbfc2ecf5c834f7719bf10dcabef31cfa3b78fa714bd3a2b3958fc6b5fd0301029515629d935d81e704ca97b8dc02a698c39d78f06bbb3d8d46bcaa5178f3c827018000fc94b1da08b5d0850afcc4948a9e129a2c2c0bb629090ca84fef5d326ceadbc2014100fa78356192a22189dd3c2a03bfb2e043667a55a85386a8d0f0853bbaa54ba748012100e37888006acc37cbfc6a459117c3e957b00e8ff3a90d93bc9aaa3fc9d972453701110052564e444cbe4b1f24015d91f5cfd7eff63e5f403613a7b48e77efa32761f950010900acef65445ef232f1fcb527bab67fccc90ae9d0c610a4f752d84c5e10a3415d74010500e1fadd176551150808ae96ff2b4dff487c432788d23db25fd3fb5e8b3e16b96f0103003e530f146a992ed9378807fa43bc1e6033de0711d728ee3a0ea1507b5ffff2940100006c8eca8a9d680ab2ae4dc1f0e247f282de3f32b99175e6f9ddb4f8e76ae0bf1b010100000001792c8c563b17721744d8f101d79e873aae62816d0fd47dd9d90ada219c1b252d070000006b48304502210090368b5925795abb0415a3cd6265d7abae7d3541fb7f2fdb1fdffdd916b3fce3022068136da44df8ee367807c7c59c950ea8d428adfe142268cd6371cf4c1b4c3208412102858ea1804708d1e16e77b49ba1559b3742797f5f43efd3922fa3d21557521d7cffffffff03f401000000000000fde10121026afd108ddbc05e093207ebdf06557a3d66e15b96accbf1766c2e7d6efa3d1981ac22313852713463583334356b6a7461734467764b41455a435135564c5a72516f76786d2081d846bcae65ce281829b6d81eff3862a68b8eaf4e99ad97c0c4ad2e149631c020f936ace2d2b4034710dec819e343f69ddbb1a16d721b88413b697c2475f75f504c4e8470062e6966cb7ec80864e5e1217ecf2b3f113bb5307e1ec1d338678e54b426a11a267e990f7dcd85072c7b3870fabb54812d7f8a7aaa672ce01e4f8a2c6a1d532849877329bd23be0b3383fcb437ffd1ff05aad824343bfe5bae52d5775ed99ba9d5a72038dd50f81153e674a8b1c5d659aac361e660cc5657b291eda149de2505efb0bbac0a353331393633353238334c797f3040f01934bb25733d4700a0309194a7defd8ceea7a8a59ad279c6237e2917264a115773777c5746546288b15ec1cf6788b801dd3952fec804cadbba2ff4e05464735e2db83c3509b59119efc843716c34becd2884f011f2e7f61f382237891875115b6ea5bac1c3e9ca6c575b44547d589c38c1b5a8cadb463044022016e1fdb226b465f3151aaa1e033b122dd58f3b495d2846d532f784ec8f6fc9ae022031dc12155c02e7f588c9f6d975a79c9c26cf341c1c88578cd6a87a3c01f6a73d6d6d6d6dc8000000000000001976a914010b7bfa8ff585b6d95f8a18a998cbd87508bd4188aca9010000000000001976a914254c6f1ce67d27ae4dafb03d2ba08318df2883c588ac000000000100'
+// full txid
+const txid27c8f = '27c8f37851aabc468d3dbb6bf0789dc398a602dcb897ca04e7815d939d621595'