@bsv/wallet-toolbox 2.4.3 → 2.4.4

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 (152) hide show
  1. package/CHANGELOG.md +38 -1
  2. package/docs/README.md +3 -1
  3. package/docs/action-batch-planning.md +117 -0
  4. package/docs/authentication-observability.md +94 -0
  5. package/docs/client.md +1566 -627
  6. package/docs/monitor.md +26 -5
  7. package/docs/storage.md +514 -334
  8. package/docs/wallet.md +1109 -932
  9. package/out/src/CWIStyleWalletManager.d.ts +52 -5
  10. package/out/src/CWIStyleWalletManager.d.ts.map +1 -1
  11. package/out/src/CWIStyleWalletManager.js +500 -128
  12. package/out/src/CWIStyleWalletManager.js.map +1 -1
  13. package/out/src/Wallet.d.ts +8 -0
  14. package/out/src/Wallet.d.ts.map +1 -1
  15. package/out/src/Wallet.js +23 -9
  16. package/out/src/Wallet.js.map +1 -1
  17. package/out/src/WalletAuthenticationManager.d.ts +20 -6
  18. package/out/src/WalletAuthenticationManager.d.ts.map +1 -1
  19. package/out/src/WalletAuthenticationManager.js +214 -34
  20. package/out/src/WalletAuthenticationManager.js.map +1 -1
  21. package/out/src/index.all.d.ts +1 -0
  22. package/out/src/index.all.d.ts.map +1 -1
  23. package/out/src/index.all.js +1 -0
  24. package/out/src/index.all.js.map +1 -1
  25. package/out/src/index.client.d.ts +2 -0
  26. package/out/src/index.client.d.ts.map +1 -1
  27. package/out/src/index.client.js +2 -0
  28. package/out/src/index.client.js.map +1 -1
  29. package/out/src/index.mobile.d.ts +1 -0
  30. package/out/src/index.mobile.d.ts.map +1 -1
  31. package/out/src/index.mobile.js +1 -0
  32. package/out/src/index.mobile.js.map +1 -1
  33. package/out/src/monitor/Monitor.d.ts.map +1 -1
  34. package/out/src/monitor/Monitor.js +4 -3
  35. package/out/src/monitor/Monitor.js.map +1 -1
  36. package/out/src/monitor/tasks/TaskCleanupActionBatches.d.ts +13 -0
  37. package/out/src/monitor/tasks/TaskCleanupActionBatches.d.ts.map +1 -0
  38. package/out/src/monitor/tasks/TaskCleanupActionBatches.js +24 -0
  39. package/out/src/monitor/tasks/TaskCleanupActionBatches.js.map +1 -0
  40. package/out/src/monitor/tasks/index.all.d.ts +1 -0
  41. package/out/src/monitor/tasks/index.all.d.ts.map +1 -1
  42. package/out/src/monitor/tasks/index.all.js +1 -0
  43. package/out/src/monitor/tasks/index.all.js.map +1 -1
  44. package/out/src/sdk/ActionBatch.interfaces.d.ts +105 -0
  45. package/out/src/sdk/ActionBatch.interfaces.d.ts.map +1 -0
  46. package/out/src/sdk/ActionBatch.interfaces.js +3 -0
  47. package/out/src/sdk/ActionBatch.interfaces.js.map +1 -0
  48. package/out/src/sdk/WalletStorage.interfaces.d.ts +18 -1
  49. package/out/src/sdk/WalletStorage.interfaces.d.ts.map +1 -1
  50. package/out/src/sdk/index.d.ts +1 -0
  51. package/out/src/sdk/index.d.ts.map +1 -1
  52. package/out/src/sdk/index.js +1 -0
  53. package/out/src/sdk/index.js.map +1 -1
  54. package/out/src/signer/actionBatch/ActionBatchPlanner.d.ts +28 -0
  55. package/out/src/signer/actionBatch/ActionBatchPlanner.d.ts.map +1 -0
  56. package/out/src/signer/actionBatch/ActionBatchPlanner.js +313 -0
  57. package/out/src/signer/actionBatch/ActionBatchPlanner.js.map +1 -0
  58. package/out/src/signer/actionBatch/ActionBatchWorkspace.d.ts +33 -0
  59. package/out/src/signer/actionBatch/ActionBatchWorkspace.d.ts.map +1 -0
  60. package/out/src/signer/actionBatch/ActionBatchWorkspace.js +693 -0
  61. package/out/src/signer/actionBatch/ActionBatchWorkspace.js.map +1 -0
  62. package/out/src/signer/methods/buildSignableTransaction.d.ts.map +1 -1
  63. package/out/src/signer/methods/buildSignableTransaction.js +2 -1
  64. package/out/src/signer/methods/buildSignableTransaction.js.map +1 -1
  65. package/out/src/signer/methods/createAction.d.ts.map +1 -1
  66. package/out/src/signer/methods/createAction.js +4 -1
  67. package/out/src/signer/methods/createAction.js.map +1 -1
  68. package/out/src/storage/StorageIdb.d.ts +14 -0
  69. package/out/src/storage/StorageIdb.d.ts.map +1 -1
  70. package/out/src/storage/StorageIdb.js +156 -30
  71. package/out/src/storage/StorageIdb.js.map +1 -1
  72. package/out/src/storage/StorageKnex.d.ts +19 -0
  73. package/out/src/storage/StorageKnex.d.ts.map +1 -1
  74. package/out/src/storage/StorageKnex.js +107 -1
  75. package/out/src/storage/StorageKnex.js.map +1 -1
  76. package/out/src/storage/StorageProvider.d.ts +28 -0
  77. package/out/src/storage/StorageProvider.d.ts.map +1 -1
  78. package/out/src/storage/StorageProvider.js +49 -0
  79. package/out/src/storage/StorageProvider.js.map +1 -1
  80. package/out/src/storage/WalletStorageManager.d.ts +8 -0
  81. package/out/src/storage/WalletStorageManager.d.ts.map +1 -1
  82. package/out/src/storage/WalletStorageManager.js +24 -0
  83. package/out/src/storage/WalletStorageManager.js.map +1 -1
  84. package/out/src/storage/idbHelpers.d.ts +2 -0
  85. package/out/src/storage/idbHelpers.d.ts.map +1 -1
  86. package/out/src/storage/idbHelpers.js +19 -0
  87. package/out/src/storage/idbHelpers.js.map +1 -1
  88. package/out/src/storage/methods/actionBatch.d.ts +14 -0
  89. package/out/src/storage/methods/actionBatch.d.ts.map +1 -0
  90. package/out/src/storage/methods/actionBatch.js +644 -0
  91. package/out/src/storage/methods/actionBatch.js.map +1 -0
  92. package/out/src/storage/methods/actionBatchBlobs.d.ts +12 -0
  93. package/out/src/storage/methods/actionBatchBlobs.d.ts.map +1 -0
  94. package/out/src/storage/methods/actionBatchBlobs.js +121 -0
  95. package/out/src/storage/methods/actionBatchBlobs.js.map +1 -0
  96. package/out/src/storage/methods/actionBatchValidation.d.ts +15 -0
  97. package/out/src/storage/methods/actionBatchValidation.d.ts.map +1 -0
  98. package/out/src/storage/methods/actionBatchValidation.js +310 -0
  99. package/out/src/storage/methods/actionBatchValidation.js.map +1 -0
  100. package/out/src/storage/methods/actionPlanning.d.ts +12 -0
  101. package/out/src/storage/methods/actionPlanning.d.ts.map +1 -0
  102. package/out/src/storage/methods/actionPlanning.js +48 -0
  103. package/out/src/storage/methods/actionPlanning.js.map +1 -0
  104. package/out/src/storage/methods/createAction.d.ts.map +1 -1
  105. package/out/src/storage/methods/createAction.js +9 -25
  106. package/out/src/storage/methods/createAction.js.map +1 -1
  107. package/out/src/storage/remoting/StorageClientBase.d.ts +9 -0
  108. package/out/src/storage/remoting/StorageClientBase.d.ts.map +1 -1
  109. package/out/src/storage/remoting/StorageClientBase.js +36 -1
  110. package/out/src/storage/remoting/StorageClientBase.js.map +1 -1
  111. package/out/src/storage/remoting/StorageServer.d.ts +10 -0
  112. package/out/src/storage/remoting/StorageServer.d.ts.map +1 -1
  113. package/out/src/storage/remoting/StorageServer.js +147 -7
  114. package/out/src/storage/remoting/StorageServer.js.map +1 -1
  115. package/out/src/storage/schema/KnexMigrations.d.ts.map +1 -1
  116. package/out/src/storage/schema/KnexMigrations.js +44 -0
  117. package/out/src/storage/schema/KnexMigrations.js.map +1 -1
  118. package/out/src/storage/schema/StorageIdbSchema.d.ts +24 -0
  119. package/out/src/storage/schema/StorageIdbSchema.d.ts.map +1 -1
  120. package/out/src/storage/schema/tables/TableActionBatch.d.ts +24 -0
  121. package/out/src/storage/schema/tables/TableActionBatch.d.ts.map +1 -0
  122. package/out/src/storage/schema/tables/TableActionBatch.js +3 -0
  123. package/out/src/storage/schema/tables/TableActionBatch.js.map +1 -0
  124. package/out/src/storage/schema/tables/index.d.ts +1 -0
  125. package/out/src/storage/schema/tables/index.d.ts.map +1 -1
  126. package/out/src/storage/schema/tables/index.js +1 -0
  127. package/out/src/storage/schema/tables/index.js.map +1 -1
  128. package/out/src/utility/actionBatchDigest.d.ts +9 -0
  129. package/out/src/utility/actionBatchDigest.d.ts.map +1 -0
  130. package/out/src/utility/actionBatchDigest.js +48 -0
  131. package/out/src/utility/actionBatchDigest.js.map +1 -0
  132. package/out/src/utility/beefForTxids.d.ts +9 -0
  133. package/out/src/utility/beefForTxids.d.ts.map +1 -0
  134. package/out/src/utility/beefForTxids.js +35 -0
  135. package/out/src/utility/beefForTxids.js.map +1 -0
  136. package/out/src/wab-client/WABClient.d.ts +36 -90
  137. package/out/src/wab-client/WABClient.d.ts.map +1 -1
  138. package/out/src/wab-client/WABClient.js +103 -151
  139. package/out/src/wab-client/WABClient.js.map +1 -1
  140. package/out/src/wab-client/WABTransport.d.ts +53 -0
  141. package/out/src/wab-client/WABTransport.d.ts.map +1 -0
  142. package/out/src/wab-client/WABTransport.js +300 -0
  143. package/out/src/wab-client/WABTransport.js.map +1 -0
  144. package/out/src/wab-client/auth-method-interactors/AuthMethodInteractor.d.ts +10 -10
  145. package/out/src/wab-client/auth-method-interactors/AuthMethodInteractor.d.ts.map +1 -1
  146. package/out/src/wab-client/auth-method-interactors/AuthMethodInteractor.js +16 -21
  147. package/out/src/wab-client/auth-method-interactors/AuthMethodInteractor.js.map +1 -1
  148. package/out/src/wab-client/auth-method-interactors/TwilioPhoneInteractor.d.ts +2 -1
  149. package/out/src/wab-client/auth-method-interactors/TwilioPhoneInteractor.d.ts.map +1 -1
  150. package/out/src/wab-client/auth-method-interactors/TwilioPhoneInteractor.js +14 -0
  151. package/out/src/wab-client/auth-method-interactors/TwilioPhoneInteractor.js.map +1 -1
  152. package/package.json +23 -23
package/docs/monitor.md CHANGED
@@ -253,11 +253,12 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
253
253
  | [TaskArcadeSSE](#class-taskarcadesse) | [TaskReviewDoubleSpends](#class-taskreviewdoublespends) |
254
254
  | [TaskCheckForProofs](#class-taskcheckforproofs) | [TaskReviewProvenTxs](#class-taskreviewproventxs) |
255
255
  | [TaskCheckNoSends](#class-taskchecknosends) | [TaskReviewStatus](#class-taskreviewstatus) |
256
- | [TaskClock](#class-taskclock) | [TaskReviewUtxos](#class-taskreviewutxos) |
257
- | [TaskFailAbandoned](#class-taskfailabandoned) | [TaskSendWaiting](#class-tasksendwaiting) |
258
- | [TaskMineBlock](#class-taskmineblock) | [TaskSyncWhenIdle](#class-tasksyncwhenidle) |
259
- | [TaskMonitorCallHistory](#class-taskmonitorcallhistory) | [TaskUnFail](#class-taskunfail) |
260
- | [TaskNewHeader](#class-tasknewheader) | [WalletMonitorTask](#class-walletmonitortask) |
256
+ | [TaskCleanupActionBatches](#class-taskcleanupactionbatches) | [TaskReviewUtxos](#class-taskreviewutxos) |
257
+ | [TaskClock](#class-taskclock) | [TaskSendWaiting](#class-tasksendwaiting) |
258
+ | [TaskFailAbandoned](#class-taskfailabandoned) | [TaskSyncWhenIdle](#class-tasksyncwhenidle) |
259
+ | [TaskMineBlock](#class-taskmineblock) | [TaskUnFail](#class-taskunfail) |
260
+ | [TaskMonitorCallHistory](#class-taskmonitorcallhistory) | [WalletMonitorTask](#class-walletmonitortask) |
261
+ | [TaskNewHeader](#class-tasknewheader) | |
261
262
 
262
263
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
263
264
 
@@ -657,6 +658,26 @@ trigger(nowMsecsSinceEpoch: number): {
657
658
 
658
659
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
659
660
 
661
+ ---
662
+ ##### Class: TaskCleanupActionBatches
663
+
664
+ Releases expired action-batch reservations and incomplete staged blobs.
665
+
666
+ ```ts
667
+ export class TaskCleanupActionBatches extends WalletMonitorTask {
668
+ static readonly taskName = "CleanupActionBatches";
669
+ constructor(monitor: Monitor, public triggerMsecs = Monitor.oneMinute)
670
+ trigger(nowMsecsSinceEpoch: number): {
671
+ run: boolean;
672
+ }
673
+ async runTask(): Promise<string>
674
+ }
675
+ ```
676
+
677
+ See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
678
+
679
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
680
+
660
681
  ---
661
682
  ##### Class: TaskClock
662
683