@bsv/sdk 1.2.1 → 1.2.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",
@@ -214,7 +214,7 @@
     "ts-jest": "^29.1.1",
     "ts-loader": "^9.5.1",
     "ts-standard": "^12.0.2",
-    "ts2md": "^0.2.0",
+    "ts2md": "^0.2.4",
     "tsconfig-to-dual-package": "^1.2.0",
     "typescript": "^5.2.2",
     "webpack": "^5.95.0",

package/src/overlay-tools/LookupResolver.ts

@@ -49,6 +49,8 @@ export const DEFAULT_SLAP_TRACKERS: string[] = [
   // Trackers known to host invalid or illegal records will be removed at the discretion of the BSV Association.
 ]
 
+const MAX_TRACKER_WAIT_TIME = 1000
+
 /** Configuration options for the Lookup resolver. */
 export interface LookupResolverConfig {
   /** The facilitator used to make requests to Overlay Services hosts. */
@@ -63,7 +65,14 @@ export interface LookupResolverConfig {
 
 /** Facilitates lookups to URLs that return answers. */
 export interface OverlayLookupFacilitator {
-  lookup: (url: string, question: LookupQuestion) => Promise<LookupAnswer>
+  /**
+   * Returns a lookup answer for a lookup question
+   * @param url - Overlay Service URL to send the lookup question to.
+   * @param question - Lookup question to find an answer to.
+   * @param timeout - Specifics how long to wait for a lookup answer in milliseconds.
+   * @returns 
+   */
+  lookup: (url: string, question: LookupQuestion, timeout?: number) => Promise<LookupAnswer>
 }
 
 export class HTTPSOverlayLookupFacilitator implements OverlayLookupFacilitator {
@@ -73,17 +82,24 @@ export class HTTPSOverlayLookupFacilitator implements OverlayLookupFacilitator {
     this.fetchClient = httpClient
   }
 
-  async lookup(url: string, question: LookupQuestion): Promise<LookupAnswer> {
+  async lookup(url: string, question: LookupQuestion, timeout: number = 5000): Promise<LookupAnswer> {
     if (!url.startsWith('https:')) {
       throw new Error('HTTPS facilitator can only use URLs that start with "https:"')
     }
-    const response = await fetch(`${url}/lookup`, {
+    const timeoutPromise = new Promise((_, reject) =>
+      setTimeout(() => reject(new Error('Request timed out')), timeout)
+    )
+
+    const fetchPromise = fetch(`${url}/lookup`, {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json'
       },
       body: JSON.stringify({ service: question.service, query: question.query })
     })
+
+    const response: Response = await Promise.race([fetchPromise, timeoutPromise]) as unknown as Response
+
     if (response.ok) {
       return await response.json()
     } else {
@@ -112,7 +128,7 @@ export default class LookupResolver {
   /**
    * Given a LookupQuestion, returns a LookupAnswer. Aggregates across multiple services and supports resiliency.
    */
-  async query(question: LookupQuestion): Promise<LookupAnswer> {
+  async query(question: LookupQuestion, timeout?: number): Promise<LookupAnswer> {
     let competentHosts: string[] = []
     if (question.service === 'ls_slap') {
       competentHosts = this.slapTrackers
@@ -133,7 +149,7 @@ export default class LookupResolver {
 
     // Use Promise.allSettled to handle individual host failures
     const hostResponses = await Promise.allSettled(
-      competentHosts.map(async host => await this.facilitator.lookup(host, question))
+      competentHosts.map(async host => await this.facilitator.lookup(host, question, timeout))
     )
 
     const successfulResponses = hostResponses
@@ -190,7 +206,7 @@ export default class LookupResolver {
 
     // Use Promise.allSettled to handle individual SLAP tracker failures
     const trackerResponses = await Promise.allSettled(
-      this.slapTrackers.map(async tracker => await this.facilitator.lookup(tracker, query))
+      this.slapTrackers.map(async tracker => await this.facilitator.lookup(tracker, query, MAX_TRACKER_WAIT_TIME))
     )
 
     const hosts = new Set<string>()

package/src/overlay-tools/SHIPBroadcaster.ts

@@ -56,6 +56,8 @@ export interface OverlayBroadcastFacilitator {
   send: (url: string, taggedBEEF: TaggedBEEF) => Promise<STEAK>
 }
 
+const MAX_SHIP_QUERY_TIMEOUT = 1000
+
 export class HTTPSOverlayBroadcastFacilitator implements OverlayBroadcastFacilitator {
   httpClient: typeof fetch
 
@@ -116,8 +118,8 @@ export default class SHIPCast implements Broadcaster {
     } = config ?? {} as SHIPBroadcasterConfig
     this.facilitator = facilitator ?? new HTTPSOverlayBroadcastFacilitator()
     this.resolver = resolver ?? new LookupResolver()
-    this.requireAcknowledgmentFromAllHostsForTopics = requireAcknowledgmentFromAllHostsForTopics ?? 'all'
-    this.requireAcknowledgmentFromAnyHostForTopics = requireAcknowledgmentFromAnyHostForTopics ?? []
+    this.requireAcknowledgmentFromAllHostsForTopics = requireAcknowledgmentFromAllHostsForTopics ?? []
+    this.requireAcknowledgmentFromAnyHostForTopics = requireAcknowledgmentFromAnyHostForTopics ?? 'all'
     this.requireAcknowledgmentFromSpecificHostsForTopics = requireAcknowledgmentFromSpecificHostsForTopics ?? {}
   }
 
@@ -178,6 +180,7 @@ export default class SHIPCast implements Broadcaster {
       for (const [topic, instructions] of Object.entries(steak)) {
         const outputsToAdmit = instructions.outputsToAdmit
         const coinsToRetain = instructions.coinsToRetain
+        // TODO: Account for coins removed property on STEAK
         if ((outputsToAdmit && outputsToAdmit.length > 0) || (coinsToRetain && coinsToRetain.length > 0)) {
           acknowledgedTopics.add(topic)
         }
@@ -378,8 +381,8 @@ export default class SHIPCast implements Broadcaster {
       service: 'ls_ship',
       query: {
         topics: this.topics
-      }
-    })
+      },
+    }, MAX_SHIP_QUERY_TIMEOUT)
     if (answer.type !== 'output-list') {
       throw new Error('SHIP answer is not an output list.')
     }

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

@@ -63,7 +63,8 @@ describe('LookupResolver', () => {
           query: {
             service: 'ls_foo'
           }
-        }
+        },
+        1000
       ],
       [
         'https://slaphost.com',
@@ -71,8 +72,9 @@ describe('LookupResolver', () => {
           service: 'ls_foo',
           query: {
             test: 1
-          }
-        }
+          },
+        },
+        undefined
       ]
     ])
   })
@@ -139,7 +141,8 @@ describe('LookupResolver', () => {
           query: {
             service: 'ls_foo'
           }
-        }
+        },
+        1000
       ],
       [
         'https://slaphost.com',
@@ -148,7 +151,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ],
       [ // additional host should also have been queried
         'https://additional.host',
@@ -157,7 +161,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ]
     ])
   })
@@ -197,7 +202,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ]
     ])
   })
@@ -252,7 +258,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ],
       [ // additional host should also have been queried
         'https://additional.host',
@@ -261,7 +268,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ]
     ])
   })
@@ -341,7 +349,8 @@ describe('LookupResolver', () => {
           query: {
             service: 'ls_foo'
           }
-        }
+        },
+        1000
       ],
       [
         'https://mock.slap2',
@@ -350,7 +359,8 @@ describe('LookupResolver', () => {
           query: {
             service: 'ls_foo'
           }
-        }
+        },
+        1000
       ],
       [
         'https://slaphost1.com',
@@ -359,7 +369,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ],
       [
         'https://slaphost2.com',
@@ -368,7 +379,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ]
     ])
   })
@@ -434,7 +446,8 @@ describe('LookupResolver', () => {
           query: {
             service: 'ls_foo'
           }
-        }
+        },
+        1000
       ],
       [
         'https://slaphost1.com',
@@ -443,7 +456,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ],
       [
         'https://slaphost2.com',
@@ -452,7 +466,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ]
     ])
   })
@@ -521,7 +536,8 @@ describe('LookupResolver', () => {
           query: {
             service: 'ls_foo'
           }
-        }
+        },
+        1000
       ],
       [
         'https://slaphost1.com',
@@ -530,7 +546,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ],
       [
         'https://slaphost2.com',
@@ -539,7 +556,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ]
     ])
   })
@@ -607,7 +625,8 @@ describe('LookupResolver', () => {
           query: {
             service: 'ls_foo'
           }
-        }
+        },
+        1000
       ],
       [
         'https://slaphost1.com',
@@ -616,7 +635,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ],
       [
         'https://slaphost2.com',
@@ -625,7 +645,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ]
     ])
   })
@@ -655,7 +676,8 @@ describe('LookupResolver', () => {
           query: {
             service: 'ls_foo'
           }
-        }
+        },
+        1000
       ]
     ])
   })
@@ -725,7 +747,8 @@ describe('LookupResolver', () => {
           query: {
             service: 'ls_foo'
           }
-        }
+        },
+        1000
       ],
       [
         'https://slaphost1.com',
@@ -734,7 +757,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ],
       [
         'https://slaphost2.com',
@@ -743,7 +767,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ]
     ])
   })
@@ -777,7 +802,8 @@ describe('LookupResolver', () => {
           query: {
             test: 1
           }
-        }
+        },
+        undefined
       ]
     ])
   })
@@ -808,7 +834,8 @@ describe('LookupResolver', () => {
           query: {
             service: 'ls_foo'
           }
-        }
+        },
+        1000
       ]
     ])
   })
@@ -882,7 +909,8 @@ describe('LookupResolver', () => {
             query: {
               service: 'ls_foo'
             }
-          }
+          },
+          1000
         ],
         [
           'https://mock.slap2',
@@ -891,7 +919,8 @@ describe('LookupResolver', () => {
             query: {
               service: 'ls_foo'
             }
-          }
+          },
+          1000
         ],
         [
           'https://slaphost.com',
@@ -900,7 +929,8 @@ describe('LookupResolver', () => {
             query: {
               test: 1
             }
-          }
+          },
+          undefined
         ]
       ])
     })
@@ -977,7 +1007,8 @@ describe('LookupResolver', () => {
             query: {
               service: 'ls_foo'
             }
-          }
+          },
+          1000
         ],
         [
           'https://slaphost1.com',
@@ -986,7 +1017,8 @@ describe('LookupResolver', () => {
             query: {
               test: 1
             }
-          }
+          },
+          undefined
         ],
         [
           'https://slaphost2.com',
@@ -995,7 +1027,8 @@ describe('LookupResolver', () => {
             query: {
               test: 1
             }
-          }
+          },
+          undefined
         ]
       ])
     })
@@ -1063,7 +1096,8 @@ describe('LookupResolver', () => {
             query: {
               service: 'ls_foo'
             }
-          }
+          },
+          1000
         ],
         [
           'https://slaphost1.com',
@@ -1072,7 +1106,8 @@ describe('LookupResolver', () => {
             query: {
               test: 1
             }
-          }
+          },
+          undefined
         ],
         [
           'https://slaphost2.com',
@@ -1081,7 +1116,8 @@ describe('LookupResolver', () => {
             query: {
               test: 1
             }
-          }
+          },
+          undefined
         ]
       ])
     })
@@ -1148,7 +1184,8 @@ describe('LookupResolver', () => {
             query: {
               service: 'ls_foo'
             }
-          }
+          },
+          1000
         ],
         [
           'https://slaphost1.com',
@@ -1157,7 +1194,8 @@ describe('LookupResolver', () => {
             query: {
               test: 1
             }
-          }
+          },
+          undefined
         ],
         [
           'https://slaphost2.com',
@@ -1166,7 +1204,8 @@ describe('LookupResolver', () => {
             query: {
               test: 1
             }
-          }
+          },
+          undefined
         ]
       ])
     })
@@ -1217,7 +1256,8 @@ describe('LookupResolver', () => {
             query: {
               service: 'ls_foo'
             }
-          }
+          },
+          1000
         ],
         [
           'https://slaphost.com',
@@ -1226,7 +1266,8 @@ describe('LookupResolver', () => {
             query: {
               test: 1
             }
-          }
+          },
+          undefined
         ]
       ])
     })

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

@@ -69,8 +69,8 @@ describe('SHIPCast', () => {
       service: 'ls_ship',
       query: {
         topics: ['tm_foo']
-      }
-    })
+      },
+    }, 1000)
 
     expect(mockFacilitator.send).toHaveBeenCalledWith('https://shiphost.com', {
       beef: testTx.toBEEF(),
@@ -231,8 +231,8 @@ describe('SHIPCast', () => {
       service: 'ls_ship',
       query: {
         topics: ['tm_foo']
-      }
-    })
+      },
+    }, 1000)
 
     expect(mockFacilitator.send).not.toHaveBeenCalled()
   })
@@ -396,12 +396,12 @@ describe('SHIPCast', () => {
       query: {
         topics: ['tm_foo', 'tm_bar']
       }
-    })
+    }, 1000)
 
     expect(mockFacilitator.send).toHaveBeenCalledTimes(2)
   })
 
-  it('should fail when a host does not acknowledge all topics (default behavior)', async () => {
+  it('should fail if at least one host does not acknowledge every topic (default behavior)', async () => {
     const shipHostKey1 = new PrivateKey(42)
     const shipWallet1 = new ProtoWallet(shipHostKey1)
     const shipLib1 = new OverlayAdminTokenTemplate(shipWallet1)
@@ -434,7 +434,7 @@ describe('SHIPCast', () => {
       const steak = {}
       for (const topic of topics) {
         steak[topic] = {
-          outputsToAdmit: [0],
+          outputsToAdmit: [],
           coinsToRetain: []
         }
       }
@@ -462,8 +462,8 @@ describe('SHIPCast', () => {
 
     expect(response).toEqual({
       status: 'error',
-      code: 'ERR_REQUIRE_ACK_FROM_ALL_HOSTS_FAILED',
-      description: 'Not all hosts acknowledged the required topics.'
+      code: 'ERR_REQUIRE_ACK_FROM_ANY_HOST_FAILED',
+      description: 'No host acknowledged the required topics.'
     })
   })