@bsv/sdk 1.6.0 → 1.6.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.6.0",
+  "version": "1.6.2",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",

package/src/overlay-tools/LookupResolver.ts

@@ -27,12 +27,9 @@ export type LookupAnswer =
     outputs: Array<{
       beef: number[]
       outputIndex: number
+      context?: number[]
     }>
   }
-  | {
-    type: 'freeform'
-    result: unknown
-  }
 
 /** Default SLAP trackers */
 export const DEFAULT_SLAP_TRACKERS: string[] = [
@@ -200,13 +197,8 @@ export default class LookupResolver {
     }
 
     // Process the successful responses
-    if (successfulResponses[0].type === 'freeform') {
-      // Return the first freeform response
-      return successfulResponses[0]
-    }
-
     // Aggregate outputs from all successful responses
-    const outputs = new Map<string, { beef: number[], outputIndex: number }>()
+    const outputs = new Map<string, { beef: number[], context?: number[], outputIndex: number }>()
 
     for (const response of successfulResponses) {
       if (response.type !== 'output-list') {
@@ -215,14 +207,9 @@ export default class LookupResolver {
       try {
         for (const output of response.outputs) {
           try {
-            const txId: string = String(Transaction.fromBEEF(output.beef).id('hex'))
-
-            if (txId !== '') { // ✅ Ensures `txId` is always a non-empty string
-              const key = `${String(txId)}.${String(output.outputIndex)}`
-              outputs.set(key, output)
-            } else {
-              console.warn('Invalid transaction ID:', txId)
-            }
+            const txId: string = Transaction.fromBEEF(output.beef).id('hex') // !! This is STUPIDLY inefficient.
+            const key = `${txId}.${output.outputIndex}`
+            outputs.set(key, output)
           } catch {
             continue
           }

package/src/overlay-tools/SHIPBroadcaster.ts

@@ -4,6 +4,7 @@ import {
   BroadcastFailure,
   Broadcaster
 } from '../transaction/index.js'
+import * as Utils from '../primitives/utils.js'
 import LookupResolver from './LookupResolver.js'
 import OverlayAdminTokenTemplate from './OverlayAdminTokenTemplate.js'
 
@@ -16,6 +17,7 @@ import OverlayAdminTokenTemplate from './OverlayAdminTokenTemplate.js'
 export interface TaggedBEEF {
   beef: number[]
   topics: string[]
+  offChainValues?: number[]
 }
 
 /**
@@ -86,19 +88,30 @@ export class HTTPSOverlayBroadcastFacilitator implements OverlayBroadcastFacilit
   }
 
   async send (url: string, taggedBEEF: TaggedBEEF): Promise<STEAK> {
-    console.log(url)
     if (!url.startsWith('https:') && !this.allowHTTP) {
       throw new Error(
         'HTTPS facilitator can only use URLs that start with "https:"'
       )
     }
+    const headers = {
+      'Content-Type': 'application/octet-stream',
+      'X-Topics': JSON.stringify(taggedBEEF.topics)
+    }
+    let body
+    if (Array.isArray(taggedBEEF.offChainValues)) {
+      headers['x-includes-off-chain-values'] = 'true'
+      const w = new Utils.Writer()
+      w.writeVarIntNum(taggedBEEF.beef.length)
+      w.write(taggedBEEF.beef)
+      w.write(taggedBEEF.offChainValues)
+      body = new Uint8Array(w.toArray())
+    } else {
+      body = new Uint8Array(taggedBEEF.beef)
+    }
     const response = await fetch(`${url}/submit`, {
       method: 'POST',
-      headers: {
-        'Content-Type': 'application/octet-stream',
-        'X-Topics': JSON.stringify(taggedBEEF.topics)
-      },
-      body: new Uint8Array(taggedBEEF.beef)
+      headers,
+      body
     })
     if (response.ok) {
       return await response.json()
@@ -154,8 +167,8 @@ export default class TopicBroadcaster implements Broadcaster {
   async broadcast (
     tx: Transaction
   ): Promise<BroadcastResponse | BroadcastFailure> {
-    console.log(tx)
     let beef: number[]
+    const offChainValues = tx.metadata.get('OffChainValues') as number[]
     try {
       beef = tx.toBEEF()
     } catch (error) {
@@ -164,7 +177,6 @@ export default class TopicBroadcaster implements Broadcaster {
       )
     }
     const interestedHosts = await this.findInterestedHosts()
-    console.log(interestedHosts)
     if (Object.keys(interestedHosts).length === 0) {
       return {
         status: 'error',
@@ -177,6 +189,7 @@ export default class TopicBroadcaster implements Broadcaster {
         try {
           const steak = await this.facilitator.send(host, {
             beef,
+            offChainValues,
             topics: [...topics]
           })
           if (steak == null || Object.keys(steak).length === 0) {

package/src/overlay-tools/__tests/LookupResolver.test.ts

@@ -620,118 +620,6 @@ describe('LookupResolver', () => {
     ])
   })
 
-  it('should handle hosts returning different response types', async () => {
-    const slapHostKey1 = new PrivateKey(42)
-    const slapWallet1 = new CompletedProtoWallet(slapHostKey1)
-    const slapLib1 = new OverlayAdminTokenTemplate(slapWallet1)
-    const slapScript1 = await slapLib1.lock(
-      'SLAP',
-      'https://slaphost1.com',
-      'ls_foo'
-    )
-    const slapTx1 = new Transaction(
-      1,
-      [],
-      [
-        {
-          lockingScript: slapScript1,
-          satoshis: 1
-        }
-      ],
-      0
-    )
-
-    const slapHostKey2 = new PrivateKey(43)
-    const slapWallet2 = new CompletedProtoWallet(slapHostKey2)
-    const slapLib2 = new OverlayAdminTokenTemplate(slapWallet2)
-    const slapScript2 = await slapLib2.lock(
-      'SLAP',
-      'https://slaphost2.com',
-      'ls_foo'
-    )
-    const slapTx2 = new Transaction(
-      1,
-      [],
-      [
-        {
-          lockingScript: slapScript2,
-          satoshis: 1
-        }
-      ],
-      0
-    )
-
-    // SLAP tracker returns two hosts
-    mockFacilitator.lookup.mockReturnValueOnce({
-      type: 'output-list',
-      outputs: [
-        { outputIndex: 0, beef: slapTx1.toBEEF() },
-        { outputIndex: 0, beef: slapTx2.toBEEF() }
-      ]
-    })
-
-    // First host returns 'freeform' response
-    mockFacilitator.lookup.mockReturnValueOnce({
-      type: 'freeform',
-      result: { message: 'Freeform response from host1' }
-    })
-
-    // Second host returns 'output-list' response
-    mockFacilitator.lookup.mockReturnValueOnce({
-      type: 'output-list',
-      outputs: [{ beef: sampleBeef3, outputIndex: 0 }]
-    })
-
-    const r = new LookupResolver({
-      facilitator: mockFacilitator,
-      slapTrackers: ['https://mock.slap']
-    })
-
-    const res = await r.query({
-      service: 'ls_foo',
-      query: { test: 1 }
-    })
-
-    // Since the first response is 'freeform', it should return that response
-    expect(res).toEqual({
-      type: 'freeform',
-      result: { message: 'Freeform response from host1' }
-    })
-
-    expect(mockFacilitator.lookup.mock.calls).toEqual([
-      [
-        'https://mock.slap',
-        {
-          service: 'ls_slap',
-          query: {
-            service: 'ls_foo'
-          }
-        },
-        5000
-      ],
-      [
-        'https://slaphost1.com',
-        {
-          service: 'ls_foo',
-          query: {
-            test: 1
-          }
-        },
-        undefined
-      ],
-      [
-        'https://slaphost2.com',
-        {
-          service: 'ls_foo',
-          query: {
-            test: 1
-          }
-        },
-        undefined
-      ]
-    ])
-  })
-
   it('should ignore freeform responses when first response is output-list', async () => {
     const slapHostKey1 = new PrivateKey(42)
     const slapWallet1 = new CompletedProtoWallet(slapHostKey1)

package/src/overlay-tools/__tests/SHIPBroadcaster.test.ts

@@ -253,7 +253,8 @@ describe('SHIPCast', () => {
     const testTx = {
       toBEEF: () => {
         throw new Error('Cannot serialize to BEEF')
-      }
+      },
+      metadata: new Map()
     } as unknown as Transaction
 
     await expect(b.broadcast(testTx)).rejects.toThrow(

package/src/transaction/Transaction.ts

@@ -318,7 +318,7 @@ export default class Transaction {
     inputs: TransactionInput[] = [],
     outputs: TransactionOutput[] = [],
     lockTime: number = 0,
-    metadata: Record<string, any> = {},
+    metadata: Record<string, any> = new Map(),
     merklePath?: MerklePath
   ) {
     this.version = version