@bsv/wallet-toolbox 1.3.8 → 1.3.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/docs/client.md +1363 -133
  2. package/docs/storage.md +16 -10
  3. package/docs/wallet.md +1349 -119
  4. package/out/src/Wallet.js.map +1 -1
  5. package/out/src/index.client.d.ts +2 -0
  6. package/out/src/index.client.d.ts.map +1 -1
  7. package/out/src/index.client.js +2 -0
  8. package/out/src/index.client.js.map +1 -1
  9. package/out/src/sdk/WalletStorage.interfaces.d.ts +15 -0
  10. package/out/src/sdk/WalletStorage.interfaces.d.ts.map +1 -1
  11. package/out/src/storage/StorageIdb.d.ts +5 -1
  12. package/out/src/storage/StorageIdb.d.ts.map +1 -1
  13. package/out/src/storage/StorageIdb.js +17 -13
  14. package/out/src/storage/StorageIdb.js.map +1 -1
  15. package/out/src/storage/WalletStorageManager.d.ts +2 -0
  16. package/out/src/storage/WalletStorageManager.d.ts.map +1 -1
  17. package/out/src/storage/WalletStorageManager.js +48 -0
  18. package/out/src/storage/WalletStorageManager.js.map +1 -1
  19. package/out/src/storage/__test/adminStats.man.test.js.map +1 -1
  20. package/out/src/storage/index.all.d.ts +1 -0
  21. package/out/src/storage/index.all.d.ts.map +1 -1
  22. package/out/src/storage/index.all.js +1 -0
  23. package/out/src/storage/index.all.js.map +1 -1
  24. package/out/src/storage/index.client.d.ts +1 -0
  25. package/out/src/storage/index.client.d.ts.map +1 -1
  26. package/out/src/storage/index.client.js +1 -0
  27. package/out/src/storage/index.client.js.map +1 -1
  28. package/out/src/storage/remoting/StorageClient.d.ts +1 -1
  29. package/out/src/storage/remoting/StorageClient.d.ts.map +1 -1
  30. package/out/test/Wallet/local/localWallet2.man.test.js +58 -38
  31. package/out/test/Wallet/local/localWallet2.man.test.js.map +1 -1
  32. package/out/test/Wallet/support/operations.man.test.js +5 -3
  33. package/out/test/Wallet/support/operations.man.test.js.map +1 -1
  34. package/out/test/storage/idb/idbSpeed.test.js +1 -0
  35. package/out/test/storage/idb/idbSpeed.test.js.map +1 -1
  36. package/out/test/storage/idb/update.test.js +8 -8
  37. package/out/test/storage/idb/update.test.js.map +1 -1
  38. package/out/test/utils/localWalletMethods.d.ts +7 -2
  39. package/out/test/utils/localWalletMethods.d.ts.map +1 -1
  40. package/out/test/utils/localWalletMethods.js +19 -0
  41. package/out/test/utils/localWalletMethods.js.map +1 -1
  42. package/out/tsconfig.all.tsbuildinfo +1 -1
  43. package/package.json +1 -1
  44. package/src/Wallet.ts +2 -2
  45. package/src/index.client.ts +2 -0
  46. package/src/sdk/WalletStorage.interfaces.ts +17 -0
  47. package/src/storage/StorageIdb.ts +18 -14
  48. package/src/storage/WalletStorageManager.ts +50 -0
  49. package/src/storage/__test/adminStats.man.test.ts +8 -8
  50. package/src/storage/index.all.ts +1 -0
  51. package/src/storage/index.client.ts +1 -0
  52. package/src/storage/remoting/StorageClient.ts +1 -1
  53. package/test/Wallet/local/localWallet2.man.test.ts +66 -42
  54. package/test/Wallet/support/operations.man.test.ts +5 -3
  55. package/test/storage/idb/idbSpeed.test.ts +2 -0
  56. package/test/storage/idb/update.test.ts +8 -9
  57. package/test/utils/localWalletMethods.ts +34 -2
package/docs/storage.md CHANGED
@@ -2606,6 +2606,7 @@ For details of the API implemented, follow the "See also" link for the `WalletSt
2606
2606
 
2607
2607
  ```ts
2608
2608
  export class StorageClient implements sdk.WalletStorageProvider {
2609
+ readonly endpointUrl: string;
2609
2610
  public settings?: TableSettings;
2610
2611
  constructor(wallet: WalletInterface, endpointUrl: string)
2611
2612
  isStorageProvider(): boolean
@@ -3217,12 +3218,14 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
3217
3218
  ---
3218
3219
  ##### Class: StorageIdb
3219
3220
 
3221
+ This class implements the `StorageProvider` interface using IndexedDB,
3222
+ via the promises wrapper package `idb`.
3223
+
3220
3224
  ```ts
3221
3225
  export class StorageIdb extends StorageProvider implements sdk.WalletStorageProvider {
3222
3226
  dbName: string;
3223
3227
  db?: IDBPDatabase<StorageIdbSchema>;
3224
3228
  constructor(options: StorageIdbOptions)
3225
- override adminStats(adminIdentityKey: string): Promise<StorageAdminStats>
3226
3229
  async migrate(storageName: string, storageIdentityKey: string): Promise<string>
3227
3230
  async verifyDB(storageName?: string, storageIdentityKey?: string): Promise<IDBPDatabase<StorageIdbSchema>>
3228
3231
  toDbTrx(stores: string[], mode: "readonly" | "readwrite", trx?: sdk.TrxToken): IDBPTransaction<StorageIdbSchema, string[], "readwrite" | "readonly">
@@ -3354,6 +3357,7 @@ export class StorageIdb extends StorageProvider implements sdk.WalletStorageProv
3354
3357
  validatePartialForUpdate<T extends sdk.EntityTimeStamp>(update: Partial<T>, dateFields?: string[], booleanFields?: string[]): Partial<T>
3355
3358
  async validateEntityForInsert<T extends sdk.EntityTimeStamp>(entity: T, trx?: sdk.TrxToken, dateFields?: string[], booleanFields?: string[]): Promise<any>
3356
3359
  async validateRawTransaction(t: TableTransaction, trx?: sdk.TrxToken): Promise<void>
3360
+ async adminStats(adminIdentityKey: string): Promise<StorageAdminStats>
3357
3361
  }
3358
3362
  ```
3359
3363
 
@@ -3798,14 +3802,14 @@ select
3798
3802
  txUnfailWeek,
3799
3803
  txUnfailMonth,
3800
3804
  txUnfailTotal,
3801
- satoshisDefaultDay,
3802
- satoshisDefaultWeek,
3803
- satoshisDefaultMonth,
3804
- satoshisDefaultTotal,
3805
- satoshisOtherDay,
3806
- satoshisOtherWeek,
3807
- satoshisOtherMonth,
3808
- satoshisOtherTotal,
3805
+ satoshisDefaultDay: Number(satoshisDefaultDay),
3806
+ satoshisDefaultWeek: Number(satoshisDefaultWeek),
3807
+ satoshisDefaultMonth: Number(satoshisDefaultMonth),
3808
+ satoshisDefaultTotal: Number(satoshisDefaultTotal),
3809
+ satoshisOtherDay: Number(satoshisOtherDay),
3810
+ satoshisOtherWeek: Number(satoshisOtherWeek),
3811
+ satoshisOtherMonth: Number(satoshisOtherMonth),
3812
+ satoshisOtherTotal: Number(satoshisOtherTotal),
3809
3813
  basketsDay,
3810
3814
  basketsWeek,
3811
3815
  basketsMonth,
@@ -4393,10 +4397,12 @@ export class WalletStorageManager implements sdk.WalletStorage {
4393
4397
  }>
4394
4398
  async updateBackups(activeSync?: sdk.WalletStorageSync): Promise<string>
4395
4399
  async setActive(storageIdentityKey: string): Promise<string>
4400
+ getStoreEndpointURL(store: ManagedStorage): string | undefined
4401
+ getStores(): sdk.WalletStorageInfo[]
4396
4402
  }
4397
4403
  ```
4398
4404
 
4399
- See also: [AuthId](./client.md#interface-authid), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [StorageProvider](./storage.md#class-storageprovider), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableUser](./storage.md#interface-tableuser), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs), [ValidListActionsArgs](./client.md#interface-validlistactionsargs), [ValidListCertificatesArgs](./client.md#interface-validlistcertificatesargs), [ValidListOutputsArgs](./client.md#interface-validlistoutputsargs), [WalletServices](./client.md#interface-walletservices), [WalletStorage](./client.md#interface-walletstorage), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [WalletStorageReader](./client.md#interface-walletstoragereader), [WalletStorageSync](./client.md#interface-walletstoragesync), [WalletStorageSyncReader](./client.md#interface-walletstoragesyncreader), [WalletStorageWriter](./client.md#interface-walletstoragewriter), [createAction](./storage.md#function-createaction), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [processAction](./storage.md#function-processaction)
4405
+ See also: [AuthId](./client.md#interface-authid), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [StorageProvider](./storage.md#class-storageprovider), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableUser](./storage.md#interface-tableuser), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs), [ValidListActionsArgs](./client.md#interface-validlistactionsargs), [ValidListCertificatesArgs](./client.md#interface-validlistcertificatesargs), [ValidListOutputsArgs](./client.md#interface-validlistoutputsargs), [WalletServices](./client.md#interface-walletservices), [WalletStorage](./client.md#interface-walletstorage), [WalletStorageInfo](./client.md#interface-walletstorageinfo), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [WalletStorageReader](./client.md#interface-walletstoragereader), [WalletStorageSync](./client.md#interface-walletstoragesync), [WalletStorageSyncReader](./client.md#interface-walletstoragesyncreader), [WalletStorageWriter](./client.md#interface-walletstoragewriter), [createAction](./storage.md#function-createaction), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [processAction](./storage.md#function-processaction)
4400
4406
 
4401
4407
  ###### Property _active
4402
4408