@bsv/wallet-toolbox 1.1.33 → 1.1.35

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.1.33",
+  "version": "1.1.35",
   "description": "BRC100 conforming wallet, wallet storage and wallet signer components",
   "main": "./out/src/index.js",
   "types": "./out/src/index.d.ts",

package/src/Setup.ts

@@ -13,6 +13,7 @@ import {
 } from '@bsv/sdk'
 import {
   Monitor,
+  randomBytesHex,
   sdk,
   Services,
   StorageClient,
@@ -157,7 +158,7 @@ DEV_KEYS = '{
       args.active,
       args.backups
     )
-    if (storage.stores.length > 0) await storage.makeAvailable()
+    if (storage.canMakeAvailable()) await storage.makeAvailable()
     const serviceOptions = Services.createDefaultOptions(chain)
     serviceOptions.taalApiKey = args.env.taalApiKey
     const services = new Services(serviceOptions)
@@ -411,7 +412,7 @@ DEV_KEYS = '{
       commissionPubKeyHex: undefined,
       feeModel: { model: 'sat/kb', value: 1 }
     })
-    await storage.migrate(args.databaseName, wo.identityKey)
+    await storage.migrate(args.databaseName, randomBytesHex(33))
     await storage.makeAvailable()
     await wo.wallet.destroy()
     return storage

package/src/sdk/WERR_errors.ts

@@ -113,13 +113,14 @@ export class WERR_UNAUTHORIZED extends WalletError {
 }
 
 /**
- * WalletStorageManager is not accessing user's active storage.
+ * WalletStorageManager is not accessing user's active storage or there are conflicting active stores configured.
  */
 export class WERR_NOT_ACTIVE extends WalletError {
   constructor(message?: string) {
     super(
       'WERR_NOT_ACTIVE',
-      message ?? `WalletStorageManager is not accessing user's active storage.`
+      message ??
+        `WalletStorageManager is not accessing user's active storage or there are conflicting active stores configured.`
     )
   }
 }

package/src/sdk/WalletStorage.interfaces.ts

@@ -111,6 +111,11 @@ export interface WalletStorageSync extends WalletStorageWriter {
     storageName: string
   ): Promise<{ syncState: TableSyncState; isNew: boolean }>
 
+  /**
+   * Updagte the `activeStorage` property of the authenticated user by their `userId`.
+   * @param auth
+   * @param newActiveStorageIdentityKey
+   */
   setActive(
     auth: sdk.AuthId,
     newActiveStorageIdentityKey: string
@@ -123,6 +128,14 @@ export interface WalletStorageSync extends WalletStorageWriter {
   ): Promise<sdk.ProcessSyncChunkResult>
 }
 
+/**
+ * This is the minimal interface required for a WalletStorageProvider to export data to another provider.
+ */
+export interface WalletStorageSyncReader {
+  makeAvailable(): Promise<TableSettings>
+  getSyncChunk(args: RequestSyncChunkArgs): Promise<SyncChunk>
+}
+
 export interface WalletStorageWriter extends WalletStorageReader {
   makeAvailable(): Promise<TableSettings>
   migrate(storageName: string, storageIdentityKey: string): Promise<string>
@@ -437,3 +450,107 @@ export interface UpdateProvenTxReqWithNewProvenTxResult {
   provenTxId: number
   log?: string
 }
+
+/**
+ * success: Last sync of this user from this storage was successful.
+ *
+ * error: Last sync protocol operation for this user to this storage threw and error.
+ *
+ * identified: Configured sync storage has been identified but not sync'ed.
+ *
+ * unknown: Sync protocol state is unknown.
+ */
+export type SyncStatus =
+  | 'success'
+  | 'error'
+  | 'identified'
+  | 'updated'
+  | 'unknown'
+
+export type SyncProtocolVersion = '0.1.0'
+
+export interface RequestSyncChunkArgs {
+  /**
+   * The storageIdentityKey of the storage supplying the update SyncChunk data.
+   */
+  fromStorageIdentityKey: string
+  /**
+   * The storageIdentityKey of the storage consuming the update SyncChunk data.
+   */
+  toStorageIdentityKey: string
+
+  /**
+   * The identity of whose data is being requested
+   */
+  identityKey: string
+  /**
+   * The max updated_at time received from the storage service receiving the request.
+   * Will be undefiend if this is the first request or if no data was previously sync'ed.
+   *
+   * `since` must include items if 'updated_at' is greater or equal. Thus, when not undefined, a sync request should always return at least one item already seen.
+   */
+  since?: Date
+  /**
+   * A rough limit on how large the response should be.
+   * The item that exceeds the limit is included and ends adding more items.
+   */
+  maxRoughSize: number
+  /**
+   * The maximum number of items (records) to be returned.
+   */
+  maxItems: number
+  /**
+   * For each entity in dependency order, the offset at which to start returning items
+   * from `since`.
+   *
+   * The entity order is:
+   * 0 ProvenTxs
+   * 1 ProvenTxReqs
+   * 2 OutputBaskets
+   * 3 TxLabels
+   * 4 OutputTags
+   * 5 Transactions
+   * 6 TxLabelMaps
+   * 7 Commissions
+   * 8 Outputs
+   * 9 OutputTagMaps
+   * 10 Certificates
+   * 11 CertificateFields
+   */
+  offsets: { name: string; offset: number }[]
+}
+
+/**
+ * Result received from remote `WalletStorage` in response to a `RequestSyncChunkArgs` request.
+ *
+ * Each property is undefined if there was no attempt to update it. Typically this is caused by size and count limits on this result.
+ *
+ * If all properties are empty arrays the sync process has received all available new and updated items.
+ */
+export interface SyncChunk {
+  fromStorageIdentityKey: string
+  toStorageIdentityKey: string
+  userIdentityKey: string
+
+  user?: TableUser
+  provenTxs?: TableProvenTx[]
+  provenTxReqs?: TableProvenTxReq[]
+  outputBaskets?: TableOutputBasket[]
+  txLabels?: TableTxLabel[]
+  outputTags?: TableOutputTag[]
+  transactions?: TableTransaction[]
+  txLabelMaps?: TableTxLabelMap[]
+  commissions?: TableCommission[]
+  outputs?: TableOutput[]
+  outputTagMaps?: TableOutputTagMap[]
+  certificates?: TableCertificate[]
+  certificateFields?: TableCertificateField[]
+}
+
+export interface ProcessSyncChunkResult {
+  done: boolean
+  maxUpdated_at: Date | undefined
+  updates: number
+  inserts: number
+  error?: sdk.WalletError
+}

package/src/sdk/index.ts

@@ -1,8 +1,6 @@
 export * from './WalletError'
 export * from './WalletSigner.interfaces'
 export * from './WalletStorage.interfaces'
-export * from './StorageSyncReader'
-export * from './StorageSyncReaderWriter'
 export * from './WERR_errors'
 export * from './validationHelpers'
 export * from './CertOps'

package/src/services/__tests/verifyBeef.test.ts

@@ -0,0 +1,18 @@
+import { Beef } from '@bsv/sdk'
+import { Services } from '../Services'
+
+describe('verifyBeef tests', () => {
+  jest.setTimeout(99999999)
+
+  test('0_', async () => {
+    const bhex =
+      '0200beef01fe7c830d000a02a0021d4ca6c031db7f6334c08ddfda43cbde3800c7fa27892f8e80a5218ca8493918a10081788ac8d8267d409b6258a6a6f5d28317ee65b5b25892def4f6cbf44f92571d01510027c2382032711033d0a1e2724b9eefcf257e27bce28e37b7472877860570ee6e0129008e15879954392f322efdd32376077a3323db02501926a697f5db6b68862f67ce01150061dcb195186d564d754a056d9ad90d65ece5bfa5ddccebd24b64d25df3780b15010b00bcd8f2c9c62b4fbbefad9640f9f6dccf21246fa08a6e1cab2c052666dee4182001040018ad6a5739749e27c191a5ef7442d861e5b8d204d36c91e08bf8015811851dbe010300f47047d1c4582eb02349eabcdafc7f4573e93ed687718275475d6f528783d16201000039a5fa5dbbbcd4a1754c250a7879ae1ad2eeb189d87d3614c2a2d9519a7a47af0101001670fc6a8d40adbd3f8a84ae35f0a702695f19f19a8feddcfd1de6249cc164e901010092a689a4cda27aea3552a98a7441ffbaed8566ae31e0a1a67e67647e2f3b8fda05025a8b77e1c82cfcfda197fec3f805a6b7000737a583e45833df6721975fe8bad102448f38860c45d33c87041c0fda51befb1c90853d3141a0df3ac737ccb9b5e61b01000100000001f7ddf439a165bf63a7d6c144b4bd8882ff45dc35a3ca3e75517fa56482fed6bd000000006b4830450221008106bc7164333415bc485ae1d12acd72bbc536f1f03b25aa42d92971565b329902202d484d09935be7fa49bbd5806148dbfdb90cc86516537351acf20655c03fa656412102b53b5339d6241c4271a07e7b09035966defe37c1a3edd60b8a427d5a5b488cb5ffffffff021d00000000000000c421029664d9baa433b4ded47ce151d348fda7ed30df597b93bf5f321ec2fe742b0faaac2131546f446f44744b7265457a6248594b466a6d6f42756475466d53585855475a4734aba7171082ff009628f6d1abea57bc1ffcdb6c2b45a5e17219eaf6bc6b6e093b5243036565505084548f9715a440b6c03e73427d4730450221008e4964dc5e8f3cc6f41da7508cba05babb2ce211fa47fe91ae9c06903d95fde902206cb21d6c188f302fccedbbcd80459561dbabcabe3da16853371fede9f5d027d06d75c8030000000000001976a914f8a84c2bef6eed4eb3270c8605a8063202ed25cb88ac000000000001000000015a8b77e1c82cfcfda197fec3f805a6b7000737a583e45833df6721975fe8bad1010000006b483045022100fb62de36ac2930029b1397931c3f30bf6df5166f2e82bed6b2ef1d23491f8e450220730105461dc12236439ee568709ee72c345bb6748efe8656a0e96e4cc5eaecfb412102c6b33e96f3b635ebd71bcedd9bcb90b4c098b9b38730f58984e23615e0864833ffffffff042800000000000000c521029664d9baa433b4ded47ce151d348fda7ed30df597b93bf5f321ec2fe742b0faaac2131546f446f44744b7265457a6248594b466a6d6f42756475466d53585855475a47361c08d47822cb0806cd17af298948641db6bd36440da9a988af0f6600cba6dabfcfe5c7fe086b7a08e8feef3a9d21d8b0126c2f4a260b46304402204f418ece238fb0587f887c1e0ea6beb4ebcefa6749d1b523195bd65dc9971374022009d0b21c669a72a8a01808d394c55de730a3a4d287b3bb209697b2e79a9787ce6d7516050000000000001976a914803a2e1d2ca2373c21129a7075f1a42587f16c8188acec030000000000001976a91441cb6381a584c464df4b6dd75b91fb0ab6c4b7a688acd0040000000000001976a914e08fbd92ba37c1d84bba8439c55793ea60c0dd6b88ac00000000000100000001448f38860c45d33c87041c0fda51befb1c90853d3141a0df3ac737ccb9b5e61b020000006a4730440220411ab1f23f747899bf71185fbb4ab03defc6e215fb1ee3d24060b14256d2dc40022035669cd13b5c5fd399a402862b4e6bc001d0cbf56660bac37b1563eeaf49a700412103b20f91159733fd69817cc4d4f9ed0cf4340f63b482e0a0a7f233885c61d1b044ffffffff020a00000000000000c421029664d9baa433b4ded47ce151d348fda7ed30df597b93bf5f321ec2fe742b0faaac2131546f446f44744b7265457a6248594b466a6d6f42756475466d53585855475a47343c32fe905bb02e70c0a9779048c921b1e26a2684c498ab44759ac25bcdfafa95309c59d1c3ac12f056ad8d10dabe777d1d57dd934730450221009a64cdc81a0ada12d329463db24260a15ad56bdc3523613c0fae2fb64762d20e022021b942e859749fc23585fdb0395585d6ea52dcf0a310cc989a38ff0483c8717e6d75b7150000000000001976a91468cce1214ccbd14d9dfd813d8490daadaa96b39288ac00000000'
+    const beef = Beef.fromString(bhex)
+    const chaintracker = await new Services('main').getChainTracker()
+
+    console.log(beef.toLogString())
+
+    const ok = await beef.verify(chaintracker, true)
+    expect(ok)
+  })
+})

package/src/services/providers/__tests/WhatsOnChain.test.ts

@@ -2,7 +2,7 @@ import { WhatsOnChainBroadcaster, WhatsOnChainConfig } from '@bsv/sdk'
 import { _tu } from '../../../../test/utils/TestUtilsWalletStorage'
 import { WhatsOnChain } from '../WhatsOnChain'
 import { Services } from '../../Services'
-import { sdk, wait } from '../../../index.client'
+import { sdk, StorageClient, wait } from '../../../index.client'
 import { Setup, StorageKnex } from '../../../index.all'
 describe('whatsonchain tests', () => {
   jest.setTimeout(99999999)
@@ -224,4 +224,19 @@ describe('whatsonchain tests', () => {
 
     await c.wallet.destroy()
   })
+
+  test.skip('8c backup to cloud', async () => {
+    if (Setup.noEnv('main')) return
+    if (!Setup.getEnv('main').filePath) return
+
+    const c = await _tu.createWalletSetupEnv('main')
+    const client = new StorageClient(
+      c.wallet,
+      'https://storage.babbage.systems'
+    )
+    await c.storage.addWalletStorageProvider(client)
+    await c.storage.updateBackups()
+
+    await c.wallet.destroy()
+  })
 })

package/src/storage/StorageReader.ts

@@ -35,7 +35,7 @@ import { getSyncChunk } from './methods/getSyncChunk'
  * The ability to construct a properly configured instance of this class implies authentication.
  * As such there are no user specific authenticated access checks implied in the implementation of any of these methods.
  */
-export abstract class StorageReader implements sdk.StorageSyncReader {
+export abstract class StorageReader implements sdk.WalletStorageSyncReader {
   chain: sdk.Chain
   _settings?: TableSettings
   whenLastAccess?: Date

package/src/storage/StorageReaderWriter.ts

@@ -310,7 +310,8 @@ export abstract class StorageReaderWriter extends StorageReader {
           created_at: now,
           updated_at: now,
           userId: 0,
-          identityKey
+          identityKey,
+          activeStorage: this.getSettings().storageIdentityKey
         }
         user.userId = await this.insertUser(user, trx)
         isNew = true

package/src/storage/StorageSyncReader.ts

@@ -25,15 +25,12 @@ import { StorageReader } from './StorageReader'
  * Constructed from an `auth` object that must minimally include the authenticated user's identityKey,
  * and the `StorageBaseReader` to be protected.
  */
-export class StorageSyncReader implements sdk.StorageSyncReader {
+export class StorageSyncReader implements sdk.WalletStorageSyncReader {
   constructor(
     public auth: sdk.AuthId,
     public storage: StorageReader
   ) {}
 
-  isAvailable(): boolean {
-    return this.storage.isAvailable()
-  }
   async makeAvailable(): Promise<TableSettings> {
     await this.storage.makeAvailable()
     if (this.auth.userId === undefined) {
@@ -43,119 +40,15 @@ export class StorageSyncReader implements sdk.StorageSyncReader {
       if (!user) throw new sdk.WERR_UNAUTHORIZED()
       this.auth.userId = user.userId
     }
-    return this.getSettings()
+    return this.storage.getSettings()
   }
   destroy(): Promise<void> {
     return this.storage.destroy()
   }
-  getSettings(): TableSettings {
-    return this.storage.getSettings()
-  }
   async getSyncChunk(args: sdk.RequestSyncChunkArgs): Promise<sdk.SyncChunk> {
     if (!this.auth.userId) await this.makeAvailable()
     if (args.identityKey !== this.auth.identityKey)
       throw new sdk.WERR_UNAUTHORIZED()
     return await this.storage.getSyncChunk(args)
   }
-  async findUserByIdentityKey(key: string): Promise<TableUser | undefined> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (key !== this.auth.identityKey) throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.findUserByIdentityKey(key)
-  }
-  async findSyncStates(
-    args: sdk.FindSyncStatesArgs
-  ): Promise<TableSyncState[]> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (args.partial.userId !== this.auth.userId)
-      throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.findSyncStates(args)
-  }
-  async findCertificateFields(
-    args: sdk.FindCertificateFieldsArgs
-  ): Promise<TableCertificateField[]> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (args.partial.userId !== this.auth.userId)
-      throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.findCertificateFields(args)
-  }
-  async findCertificates(
-    args: sdk.FindCertificatesArgs
-  ): Promise<TableCertificateX[]> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (args.partial.userId !== this.auth.userId)
-      throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.findCertificates(args)
-  }
-  async findCommissions(
-    args: sdk.FindCommissionsArgs
-  ): Promise<TableCommission[]> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (args.partial.userId !== this.auth.userId)
-      throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.findCommissions(args)
-  }
-  async findOutputBaskets(
-    args: sdk.FindOutputBasketsArgs
-  ): Promise<TableOutputBasket[]> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (args.partial.userId !== this.auth.userId)
-      throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.findOutputBaskets(args)
-  }
-  async findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (args.partial.userId !== this.auth.userId)
-      throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.findOutputs(args)
-  }
-  async findOutputTags(
-    args: sdk.FindOutputTagsArgs
-  ): Promise<TableOutputTag[]> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (args.partial.userId !== this.auth.userId)
-      throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.findOutputTags(args)
-  }
-  async findTransactions(
-    args: sdk.FindTransactionsArgs
-  ): Promise<TableTransaction[]> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (args.partial.userId !== this.auth.userId)
-      throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.findTransactions(args)
-  }
-  async findTxLabels(args: sdk.FindTxLabelsArgs): Promise<TableTxLabel[]> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (args.partial.userId !== this.auth.userId)
-      throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.findTxLabels(args)
-  }
-  async getProvenTxsForUser(
-    args: sdk.FindForUserSincePagedArgs
-  ): Promise<TableProvenTx[]> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (args.userId !== this.auth.userId) throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.getProvenTxsForUser(args)
-  }
-  async getProvenTxReqsForUser(
-    args: sdk.FindForUserSincePagedArgs
-  ): Promise<TableProvenTxReq[]> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (args.userId !== this.auth.userId) throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.getProvenTxReqsForUser(args)
-  }
-  async getTxLabelMapsForUser(
-    args: sdk.FindForUserSincePagedArgs
-  ): Promise<TableTxLabelMap[]> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (args.userId !== this.auth.userId) throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.getTxLabelMapsForUser(args)
-  }
-  async getOutputTagMapsForUser(
-    args: sdk.FindForUserSincePagedArgs
-  ): Promise<TableOutputTagMap[]> {
-    if (!this.auth.userId) await this.makeAvailable()
-    if (args.userId !== this.auth.userId) throw new sdk.WERR_UNAUTHORIZED()
-    return await this.storage.getOutputTagMapsForUser(args)
-  }
 }