@bsv/sdk 1.3.36 → 1.4.0

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

@@ -0,0 +1,86 @@
+import { StorageUtils } from '../index.js'
+import * as Utils from '../../primitives/utils.js'
+import * as Hash from '../..//primitives/Hash.js'
+
+// Example data
+const exampleHashHex = '1a5ec49a3f32cd56d19732e89bde5d81755ddc0fd8515dc8b226d47654139dca'
+const exampleHash = Utils.toArray(exampleHashHex, 'hex')
+const exampleFileHex = '687da27f04a112aa48f1cab2e7949f1eea4f7ba28319c1e999910cd561a634a05a3516e6db'
+const exampleFile = Utils.toArray(exampleFileHex, 'hex')
+const exampleURL = 'XUT6PqWb3GP3LR7dmBMCJwZ3oo5g1iGCF3CrpzyuJCemkGu1WGoq'
+
+describe('StorageUtils', () => {
+  describe('getURLForHash', () => {
+    it('Creates the correct URL for the hash', () => {
+      const url = StorageUtils.getURLForHash(exampleHash)
+      expect(url).toBe(exampleURL)
+    })
+
+    it('Throws an error if hash length is invalid', () => {
+      // Get the length of a FILE (not a hash — wrong length!)
+      expect(() => StorageUtils.getURLForHash(exampleFile)).toThrow(
+        new Error('Hash length must be 32 bytes (sha256)')
+      )
+    })
+  })
+
+  describe('getURLForFile', () => {
+    it('Creates the correct URL for the file', () => {
+      const url = StorageUtils.getURLForFile(exampleFile)
+      expect(url).toEqual(exampleURL)
+    })
+  })
+
+  describe('getHashFromURL', () => {
+    it('Decodes the URL to the correct hash', () => {
+      const hash = StorageUtils.getHashFromURL(exampleURL)
+      expect(Utils.toHex(hash)).toEqual(exampleHashHex)
+    })
+
+    it('Gets the same hash as getting one directly from the file', () => {
+      const hashA = StorageUtils.getHashFromURL(exampleURL)
+      const hashB = Hash.sha256(exampleFile)
+      expect(hashA).toEqual(hashB)
+    })
+
+    it('Throws an error if checksum is invalid', () => {
+      const badURL = 'XUU7cTfy6fA6q2neLDmzPqJnGB6o18PXKoGaWLPrH1SeWLKgdCKq'
+      expect(() => StorageUtils.getHashFromURL(badURL)).toThrow(new Error('Invalid checksum'))
+    })
+
+    it('Throws an error if URL length is invalid', () => {
+      const badURL = 'SomeBase58CheckTooShortOrTooLong'
+      expect(() => StorageUtils.getHashFromURL(badURL)).toThrow()
+    })
+
+    it('Throws an error if prefix is invalid', () => {
+      const invalidPrefixURL1 = 'AInvalidPrefixTestString1'
+      const invalidPrefixURL2 = 'AInvalidPrefixTestString2'
+      expect(() => StorageUtils.getHashFromURL(invalidPrefixURL1)).toThrow()
+      expect(() => StorageUtils.getHashFromURL(invalidPrefixURL2)).toThrow()
+    })
+  })
+
+  describe('isValidURL', () => {
+    it('Returns true when URL is valid', () => {
+      expect(StorageUtils.isValidURL(exampleURL)).toBe(true)
+    })
+
+    it('Returns false if checksum is invalid', () => {
+      const badURL = 'XUU7cTfy6fA6q2neLDmzPqJnGB6o18PXKoGaWLPrH1SeWLKgdCKq'
+      expect(StorageUtils.isValidURL(badURL)).toBe(false)
+    })
+
+    it('Returns false if URL length is invalid', () => {
+      const badURL = 'SomeBase58CheckTooShortOrTooLong'
+      expect(StorageUtils.isValidURL(badURL)).toBe(false)
+    })
+
+    it('Returns false if prefix is invalid', () => {
+      const badURL1 = 'AnotherInvalidPrefixTestString'
+      const badURL2 = 'YetAnotherInvalidPrefixTestString'
+      expect(StorageUtils.isValidURL(badURL1)).toBe(false)
+      expect(StorageUtils.isValidURL(badURL2)).toBe(false)
+    })
+  })
+})

package/src/storage/index.ts

@@ -0,0 +1,2 @@
+export * as StorageUtils from './StorageUtils.js'
+export { StorageUploader } from './StorageUploader.js'

package/src/wallet/WalletClient.ts

@@ -95,25 +95,25 @@ export default class WalletClient implements WalletInterface {
       await checkSub()
       this.substrate = sub
     } catch (e) {
-      console.error('XDMSubstrate initialization failed:', e) // Log the error
+      // XDM failed, try the next one...
       try {
         sub = new XDMSubstrate()
         await checkSub(MAX_XDM_RESPONSE_WAIT)
         this.substrate = sub
       } catch (e) {
-        console.error('WalletWireTransceiver initialization failed:', e)
+        // HTTP wire failed, move on...
         try {
           sub = new WalletWireTransceiver(new HTTPWalletWire(this.originator))
           await checkSub()
           this.substrate = sub
         } catch (e) {
-          console.error('HTTPWalletJSON initialization failed:', e)
+          // HTTP JSON failed, attempt the next...
           try {
             sub = new HTTPWalletJSON(this.originator)
             await checkSub()
             this.substrate = sub
           } catch (e) {
-            console.error('No wallet available:', e)
+            // No comms. Tell the user to install a BSV wallet.
             throw new Error(
               'No wallet available over any communication substrate. Install a BSV wallet today!'
             )

package/src/wallet/substrates/HTTPWalletWire.ts

@@ -1,6 +1,6 @@
 import WalletWire from './WalletWire.js'
 import WalletWireCalls from './WalletWireCalls.js'
-import { Utils } from '../../primitives/index.js'
+import * as Utils from '../../primitives/utils.js'
 
 export default class HTTPWalletWire implements WalletWire {
   baseUrl: string

package/src/wallet/substrates/WalletWireProcessor.ts

@@ -1,6 +1,6 @@
 import { WalletInterface, SecurityLevel } from '../Wallet.interfaces.js'
 import WalletWire from './WalletWire.js'
-import { Utils } from '../../primitives/index.js'
+import * as Utils from '../../primitives/utils.js'
 import calls from './WalletWireCalls.js'
 import Certificate from '../../auth/certificates/Certificate.js'
 

package/src/wallet/substrates/WalletWireTransceiver.ts

@@ -46,8 +46,8 @@ import {
   WalletInterface
 } from '../Wallet.interfaces.js'
 import WalletWire from './WalletWire.js'
-import { Certificate } from '../../auth/index.js'
-import { Utils } from '../../primitives/index.js'
+import Certificate from '../../auth/certificates/Certificate.js'
+import * as Utils from '../../primitives/utils.js'
 import calls, { CallType } from './WalletWireCalls.js'
 import { WalletError } from '../WalletError.js'
 

package/src/wallet/substrates/XDM.ts

@@ -27,9 +27,10 @@ import {
   VersionString7To30Bytes,
   WalletInterface
 } from '../Wallet.interfaces.js'
-import { Utils, Random } from '../../primitives/index.js'
+import Random from '../../primitives/Random.js'
+import * as Utils from '../../primitives/utils.js'
 import { WalletError } from '../WalletError.js'
-import { CallType } from '../../../mod.js'
+import { CallType } from './WalletWireCalls.js'
 
 /**
  * Facilitates wallet operations over cross-document messaging.