@bsv/sdk 1.4.5 → 1.4.7

package/docs/storage.md

@@ -20,7 +20,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 ```ts
 export interface DownloadResult {
-    data: Buffer;
+    data: number[];
     mimeType: string | null;
 }
 ```
@@ -32,7 +32,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 ```ts
 export interface DownloaderConfig {
-    networkPreset: string;
+    networkPreset: "mainnet" | "testnet" | "local";
 }
 ```
 
@@ -96,11 +96,11 @@ Locates HTTP URLs where content can be downloaded. It uses the passed or the def
 export class StorageDownloader {
     constructor(config?: DownloaderConfig) 
     public async resolve(uhrpUrl: string): Promise<string[]> 
-    public async download(uhrpUrl: string) 
+    public async download(uhrpUrl: string): Promise<DownloadResult> 
 }
 ```
 
-See also: [DownloaderConfig](./storage.md#interface-downloaderconfig)
+See also: [DownloadResult](./storage.md#interface-downloadresult), [DownloaderConfig](./storage.md#interface-downloaderconfig)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 

package/package.json

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

package/src/overlay-tools/LookupResolver.ts

@@ -53,7 +53,7 @@ export const DEFAULT_TESTNET_SLAP_TRACKERS: string[] = [
   'https://testnet-users.bapp.dev'
 ]
 
-const MAX_TRACKER_WAIT_TIME = 1000
+const MAX_TRACKER_WAIT_TIME = 5000
 
 /** Configuration options for the Lookup resolver. */
 export interface LookupResolverConfig {

package/src/overlay-tools/SHIPBroadcaster.ts

@@ -86,6 +86,7 @@ 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:"'
@@ -153,6 +154,7 @@ export default class TopicBroadcaster implements Broadcaster {
   async broadcast (
     tx: Transaction
   ): Promise<BroadcastResponse | BroadcastFailure> {
+    console.log(tx)
     let beef: number[]
     try {
       beef = tx.toBEEF()
@@ -161,9 +163,8 @@ export default class TopicBroadcaster implements Broadcaster {
         'Transactions sent via SHIP to Overlay Services must be serializable to BEEF format.'
       )
     }
-    const interestedHosts = this.networkPreset === 'local'
-      ? [{ 'http://localhost:8080': new Set<string>(this.topics) }]
-      : await this.findInterestedHosts()
+    const interestedHosts = await this.findInterestedHosts()
+    console.log(interestedHosts)
     if (Object.keys(interestedHosts).length === 0) {
       return {
         status: 'error',
@@ -183,6 +184,7 @@ export default class TopicBroadcaster implements Broadcaster {
           }
           return { host, success: true, steak }
         } catch (error) {
+          console.error(error)
           // Log error if needed
           return { host, success: false, error }
         }
@@ -438,6 +440,14 @@ export default class TopicBroadcaster implements Broadcaster {
    * @returns A mapping of URLs for hosts interested in this transaction. Keys are URLs, values are which of our topics the specific host cares about.
    */
   private async findInterestedHosts (): Promise<Record<string, Set<string>>> {
+    // 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])
+      }
+      return { 'http://localhost:8080': resultSet }
+    }
     // TODO: cache the list of interested hosts to avoid spamming SHIP trackers.
     // TODO: Monetize the operation of the SHIP tracker system.
     // TODO: Cache ship/slap lookup with expiry (every 5min)

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

@@ -108,7 +108,7 @@ describe('LookupResolver', () => {
             service: 'ls_foo'
           }
         },
-        1000
+        5000
       ],
       [
         'https://slaphost.com',
@@ -214,7 +214,7 @@ describe('LookupResolver', () => {
             service: 'ls_foo'
           }
         },
-        1000
+        5000
       ],
       [
         'https://slaphost.com',
@@ -474,7 +474,7 @@ describe('LookupResolver', () => {
             service: 'ls_foo'
           }
         },
-        1000
+        5000
       ],
       [
         'https://mock.slap2',
@@ -484,7 +484,7 @@ describe('LookupResolver', () => {
             service: 'ls_foo'
           }
         },
-        1000
+        5000
       ],
       [
         'https://slaphost1.com',
@@ -595,7 +595,7 @@ describe('LookupResolver', () => {
             service: 'ls_foo'
           }
         },
-        1000
+        5000
       ],
       [
         'https://slaphost1.com',
@@ -707,7 +707,7 @@ describe('LookupResolver', () => {
             service: 'ls_foo'
           }
         },
-        1000
+        5000
       ],
       [
         'https://slaphost1.com',
@@ -818,7 +818,7 @@ describe('LookupResolver', () => {
             service: 'ls_foo'
           }
         },
-        1000
+        5000
       ],
       [
         'https://slaphost1.com',
@@ -873,7 +873,7 @@ describe('LookupResolver', () => {
             service: 'ls_foo'
           }
         },
-        1000
+        5000
       ]
     ])
   })
@@ -968,7 +968,7 @@ describe('LookupResolver', () => {
             service: 'ls_foo'
           }
         },
-        1000
+        5000
       ],
       [
         'https://slaphost1.com',
@@ -1066,7 +1066,7 @@ describe('LookupResolver', () => {
             service: 'ls_foo'
           }
         },
-        1000
+        5000
       ]
     ])
   })
@@ -1161,7 +1161,7 @@ describe('LookupResolver', () => {
               service: 'ls_foo'
             }
           },
-          1000
+          5000
         ],
         [
           'https://mock.slap2',
@@ -1171,7 +1171,7 @@ describe('LookupResolver', () => {
               service: 'ls_foo'
             }
           },
-          1000
+          5000
         ],
         [
           'https://slaphost.com',
@@ -1292,7 +1292,7 @@ describe('LookupResolver', () => {
               service: 'ls_foo'
             }
           },
-          1000
+          5000
         ],
         [
           'https://slaphost1.com',
@@ -1403,7 +1403,7 @@ describe('LookupResolver', () => {
               service: 'ls_foo'
             }
           },
-          1000
+          5000
         ],
         [
           'https://slaphost1.com',
@@ -1513,7 +1513,7 @@ describe('LookupResolver', () => {
               service: 'ls_foo'
             }
           },
-          1000
+          5000
         ],
         [
           'https://slaphost1.com',
@@ -1596,7 +1596,7 @@ describe('LookupResolver', () => {
               service: 'ls_foo'
             }
           },
-          1000
+          5000
         ],
         [
           'https://slaphost.com',

package/src/storage/StorageDownloader.ts

@@ -39,9 +39,16 @@ export class StorageDownloader {
       throw new Error('Lookup answer must be an output list')
     }
     const decodedResults: string[] = []
+    const currentTime = Math.floor(Date.now() / 1000)
     for (let i = 0; i < response.outputs.length; i++) {
       const tx = Transaction.fromBEEF(response.outputs[i].beef)
       const { fields } = PushDrop.decode(tx.outputs[response.outputs[i].outputIndex].lockingScript)
+
+      const expiryTime = new Utils.Reader(fields[3]).readVarIntNum()
+      if (expiryTime < currentTime) {
+        continue
+      }
+
       decodedResults.push(Utils.toUTF8(fields[2]))
     }
     return decodedResults

package/src/storage/StorageUploader.ts

@@ -31,6 +31,7 @@ export class StorageUploader {
     retentionPeriod: number
   ): Promise<{
       uploadURL: string
+      requiredHeaders: Record<string, string>
       amount?: number
     }> {
     const url = `${this.baseURL}/upload`
@@ -48,26 +49,32 @@ export class StorageUploader {
       status: string
       uploadURL: string
       amount?: number
+      requiredHeaders: Record<string, string>
     }
     if (data.status === 'error') {
       throw new Error('Upload route returned an error.')
     }
     return {
       uploadURL: data.uploadURL,
+      requiredHeaders: data.requiredHeaders,
       amount: data.amount
     }
   }
 
   private async uploadFile (
     uploadURL: string,
-    file: UploadableFile
+    file: UploadableFile,
+    requiredHeaders: Record<string, string>
   ): Promise<UploadFileResult> {
     const body = Uint8Array.from(file.data)
 
     const response = await fetch(uploadURL, {
       method: 'PUT',
       body,
-      headers: { 'Content-Type': file.type }
+      headers: {
+        'Content-Type': file.type,
+        ...requiredHeaders
+      }
     })
     if (!response.ok) {
       throw new Error(`File upload failed: HTTP ${response.status}`)
@@ -102,7 +109,7 @@ export class StorageUploader {
     const { file, retentionPeriod } = params
     const fileSize = file.data.length
 
-    const { uploadURL } = await this.getUploadInfo(fileSize, retentionPeriod)
-    return await this.uploadFile(uploadURL, file)
+    const { uploadURL, requiredHeaders } = await this.getUploadInfo(fileSize, retentionPeriod)
+    return await this.uploadFile(uploadURL, file, requiredHeaders)
   }
 }

package/src/storage/__test/StorageDownloader.test.ts

@@ -71,6 +71,8 @@ describe('StorageDownloader', () => {
             const resolved = await downloader.resolve('fakeUhrpUrl')
             expect(resolved).toEqual(['http://a.com', 'http://a.com'])
         })
+
+
     })
 
     describe('download()', () => {
@@ -103,7 +105,7 @@ describe('StorageDownloader', () => {
                 193, 139, 142, 159, 142, 32, 8, 151, 20, 133,
                 110, 226, 51, 179, 144, 42, 89, 29, 13, 95,
                 41, 37
-              ]
+            ]
             jest.spyOn(StorageUtils, 'getHashFromURL').mockReturnValue(knownHash)
 
             // Suppose two possible download URLs
@@ -166,5 +168,37 @@ describe('StorageDownloader', () => {
                 .rejects
                 .toThrow('Unable to download content from validButNoGoodHostUrl')
         })
+
+        it('throws if all entries are expired', async () => {
+            const currentTime = Math.floor(Date.now())
+
+            jest.spyOn(LookupResolver.prototype, 'query').mockResolvedValue({
+                type: 'output-list',
+                outputs: [
+                    { beef: 'fake-beef-a', outputIndex: 0 },
+                    { beef: 'fake-beef-b', outputIndex: 1 }
+                ]
+            } as any)
+
+            jest.spyOn(Transaction, 'fromBEEF').mockImplementation(() => {
+                return {
+                    outputs: [
+                        { lockingScript: {} },
+                        { lockingScript: {} }
+                    ]
+                } as any
+            })
+
+            jest.spyOn(PushDrop, 'decode').mockImplementation(() => {
+                return {
+                    lockingPublicKey: {} as PublicKey,
+                    fields: [[], [], [], [currentTime - 100]]
+                }
+            })
+
+            await expect(downloader.resolve('expiredUhrpUrl'))
+                .resolves
+                .toEqual(["", ""])
+        })
     })
 })