@bopen-io/wallet-toolbox 1.7.18

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 (390) hide show
  1. package/.claude/settings.local.json +10 -0
  2. package/.env.template +22 -0
  3. package/.github/ISSUE_TEMPLATE/bug_report.md +40 -0
  4. package/.github/ISSUE_TEMPLATE/discussion.md +24 -0
  5. package/.github/pull_request_template.md +22 -0
  6. package/.github/workflows/push.yaml +145 -0
  7. package/.prettierrc +10 -0
  8. package/CHANGELOG.md +280 -0
  9. package/CONTRIBUTING.md +89 -0
  10. package/README.md +43 -0
  11. package/docs/README.md +85 -0
  12. package/docs/client.md +19627 -0
  13. package/docs/monitor.md +953 -0
  14. package/docs/open-rpc/index.html +46 -0
  15. package/docs/services.md +6377 -0
  16. package/docs/setup.md +1268 -0
  17. package/docs/storage.md +5367 -0
  18. package/docs/wallet.md +19626 -0
  19. package/jest.config.ts +25 -0
  20. package/license.md +28 -0
  21. package/out/tsconfig.all.tsbuildinfo +1 -0
  22. package/package.json +63 -0
  23. package/src/CWIStyleWalletManager.ts +1999 -0
  24. package/src/Setup.ts +579 -0
  25. package/src/SetupClient.ts +322 -0
  26. package/src/SetupWallet.ts +108 -0
  27. package/src/SimpleWalletManager.ts +526 -0
  28. package/src/Wallet.ts +1169 -0
  29. package/src/WalletAuthenticationManager.ts +153 -0
  30. package/src/WalletLogger.ts +213 -0
  31. package/src/WalletPermissionsManager.ts +3660 -0
  32. package/src/WalletSettingsManager.ts +114 -0
  33. package/src/__tests/CWIStyleWalletManager.test.d.ts.map +1 -0
  34. package/src/__tests/CWIStyleWalletManager.test.js.map +1 -0
  35. package/src/__tests/CWIStyleWalletManager.test.ts +675 -0
  36. package/src/__tests/WalletPermissionsManager.callbacks.test.ts +323 -0
  37. package/src/__tests/WalletPermissionsManager.checks.test.ts +844 -0
  38. package/src/__tests/WalletPermissionsManager.encryption.test.ts +412 -0
  39. package/src/__tests/WalletPermissionsManager.fixtures.ts +307 -0
  40. package/src/__tests/WalletPermissionsManager.flows.test.ts +462 -0
  41. package/src/__tests/WalletPermissionsManager.initialization.test.ts +300 -0
  42. package/src/__tests/WalletPermissionsManager.pmodules.test.ts +798 -0
  43. package/src/__tests/WalletPermissionsManager.proxying.test.ts +724 -0
  44. package/src/__tests/WalletPermissionsManager.tokens.test.ts +503 -0
  45. package/src/index.all.ts +27 -0
  46. package/src/index.client.ts +25 -0
  47. package/src/index.mobile.ts +21 -0
  48. package/src/index.ts +1 -0
  49. package/src/monitor/Monitor.ts +412 -0
  50. package/src/monitor/MonitorDaemon.ts +188 -0
  51. package/src/monitor/README.md +3 -0
  52. package/src/monitor/__test/MonitorDaemon.man.test.ts +45 -0
  53. package/src/monitor/tasks/TaskCheckForProofs.ts +243 -0
  54. package/src/monitor/tasks/TaskCheckNoSends.ts +73 -0
  55. package/src/monitor/tasks/TaskClock.ts +33 -0
  56. package/src/monitor/tasks/TaskFailAbandoned.ts +54 -0
  57. package/src/monitor/tasks/TaskMonitorCallHistory.ts +26 -0
  58. package/src/monitor/tasks/TaskNewHeader.ts +93 -0
  59. package/src/monitor/tasks/TaskPurge.ts +68 -0
  60. package/src/monitor/tasks/TaskReorg.ts +89 -0
  61. package/src/monitor/tasks/TaskReviewStatus.ts +48 -0
  62. package/src/monitor/tasks/TaskSendWaiting.ts +122 -0
  63. package/src/monitor/tasks/TaskSyncWhenIdle.ts +26 -0
  64. package/src/monitor/tasks/TaskUnFail.ts +151 -0
  65. package/src/monitor/tasks/WalletMonitorTask.ts +47 -0
  66. package/src/sdk/CertOpsWallet.ts +18 -0
  67. package/src/sdk/PrivilegedKeyManager.ts +372 -0
  68. package/src/sdk/README.md +13 -0
  69. package/src/sdk/WERR_errors.ts +234 -0
  70. package/src/sdk/WalletError.ts +170 -0
  71. package/src/sdk/WalletErrorFromJson.ts +80 -0
  72. package/src/sdk/WalletServices.interfaces.ts +700 -0
  73. package/src/sdk/WalletSigner.interfaces.ts +11 -0
  74. package/src/sdk/WalletStorage.interfaces.ts +606 -0
  75. package/src/sdk/__test/CertificateLifeCycle.test.ts +131 -0
  76. package/src/sdk/__test/PrivilegedKeyManager.test.ts +738 -0
  77. package/src/sdk/__test/WalletError.test.ts +318 -0
  78. package/src/sdk/__test/validationHelpers.test.ts +21 -0
  79. package/src/sdk/index.ts +10 -0
  80. package/src/sdk/types.ts +226 -0
  81. package/src/services/README.md +11 -0
  82. package/src/services/ServiceCollection.ts +248 -0
  83. package/src/services/Services.ts +603 -0
  84. package/src/services/__tests/ARC.man.test.ts +123 -0
  85. package/src/services/__tests/ARC.timeout.man.test.ts +79 -0
  86. package/src/services/__tests/ArcGorillaPool.man.test.ts +108 -0
  87. package/src/services/__tests/arcServices.test.ts +8 -0
  88. package/src/services/__tests/bitrails.test.ts +56 -0
  89. package/src/services/__tests/getMerklePath.test.ts +15 -0
  90. package/src/services/__tests/getRawTx.test.ts +13 -0
  91. package/src/services/__tests/postBeef.test.ts +104 -0
  92. package/src/services/__tests/verifyBeef.test.ts +50 -0
  93. package/src/services/chaintracker/BHServiceClient.ts +212 -0
  94. package/src/services/chaintracker/ChaintracksChainTracker.ts +71 -0
  95. package/src/services/chaintracker/__tests/ChaintracksChainTracker.test.ts +33 -0
  96. package/src/services/chaintracker/__tests/ChaintracksServiceClient.test.ts +29 -0
  97. package/src/services/chaintracker/chaintracks/Api/BlockHeaderApi.ts +72 -0
  98. package/src/services/chaintracker/chaintracks/Api/BulkIngestorApi.ts +83 -0
  99. package/src/services/chaintracker/chaintracks/Api/BulkStorageApi.ts +92 -0
  100. package/src/services/chaintracker/chaintracks/Api/ChaintracksApi.ts +64 -0
  101. package/src/services/chaintracker/chaintracks/Api/ChaintracksClientApi.ts +189 -0
  102. package/src/services/chaintracker/chaintracks/Api/ChaintracksFetchApi.ts +18 -0
  103. package/src/services/chaintracker/chaintracks/Api/ChaintracksFsApi.ts +58 -0
  104. package/src/services/chaintracker/chaintracks/Api/ChaintracksStorageApi.ts +386 -0
  105. package/src/services/chaintracker/chaintracks/Api/LiveIngestorApi.ts +25 -0
  106. package/src/services/chaintracker/chaintracks/Chaintracks.ts +609 -0
  107. package/src/services/chaintracker/chaintracks/ChaintracksService.ts +199 -0
  108. package/src/services/chaintracker/chaintracks/ChaintracksServiceClient.ts +154 -0
  109. package/src/services/chaintracker/chaintracks/Ingest/BulkIngestorBase.ts +176 -0
  110. package/src/services/chaintracker/chaintracks/Ingest/BulkIngestorCDN.ts +174 -0
  111. package/src/services/chaintracker/chaintracks/Ingest/BulkIngestorCDNBabbage.ts +18 -0
  112. package/src/services/chaintracker/chaintracks/Ingest/BulkIngestorWhatsOnChainCdn.ts +113 -0
  113. package/src/services/chaintracker/chaintracks/Ingest/BulkIngestorWhatsOnChainWs.ts +81 -0
  114. package/src/services/chaintracker/chaintracks/Ingest/LiveIngestorBase.ts +86 -0
  115. package/src/services/chaintracker/chaintracks/Ingest/LiveIngestorTeranodeP2P.ts +59 -0
  116. package/src/services/chaintracker/chaintracks/Ingest/LiveIngestorWhatsOnChainPoll.ts +104 -0
  117. package/src/services/chaintracker/chaintracks/Ingest/LiveIngestorWhatsOnChainWs.ts +66 -0
  118. package/src/services/chaintracker/chaintracks/Ingest/WhatsOnChainIngestorWs.ts +566 -0
  119. package/src/services/chaintracker/chaintracks/Ingest/WhatsOnChainServices.ts +219 -0
  120. package/src/services/chaintracker/chaintracks/Ingest/__tests/BulkIngestorCDNBabbage.test.ts +54 -0
  121. package/src/services/chaintracker/chaintracks/Ingest/__tests/LiveIngestorWhatsOnChainPoll.test.ts +33 -0
  122. package/src/services/chaintracker/chaintracks/Ingest/__tests/WhatsOnChainServices.test.ts +124 -0
  123. package/src/services/chaintracker/chaintracks/Storage/BulkStorageBase.ts +92 -0
  124. package/src/services/chaintracker/chaintracks/Storage/ChaintracksKnexMigrations.ts +104 -0
  125. package/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageBase.ts +382 -0
  126. package/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageIdb.ts +574 -0
  127. package/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageKnex.ts +438 -0
  128. package/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageMemory.ts +29 -0
  129. package/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageNoDb.ts +304 -0
  130. package/src/services/chaintracker/chaintracks/Storage/__tests/ChaintracksStorageIdb.test.ts +102 -0
  131. package/src/services/chaintracker/chaintracks/Storage/__tests/ChaintracksStorageKnex.test.ts +45 -0
  132. package/src/services/chaintracker/chaintracks/__tests/Chaintracks.test.ts +77 -0
  133. package/src/services/chaintracker/chaintracks/__tests/ChaintracksClientApi.test.ts +192 -0
  134. package/src/services/chaintracker/chaintracks/__tests/LocalCdnServer.ts +75 -0
  135. package/src/services/chaintracker/chaintracks/__tests/createIdbChaintracks.test.ts +62 -0
  136. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest349/mainNetBlockHeaders.json +1 -0
  137. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest349/mainNet_0.headers +0 -0
  138. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest349/mainNet_1.headers +0 -0
  139. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest349/mainNet_2.headers +0 -0
  140. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest349/mainNet_3.headers +0 -0
  141. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest379/mainNetBlockHeaders.json +1 -0
  142. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest379/mainNet_0.headers +0 -0
  143. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest379/mainNet_1.headers +0 -0
  144. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest379/mainNet_2.headers +0 -0
  145. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest379/mainNet_3.headers +0 -0
  146. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest399/mainNetBlockHeaders.json +1 -0
  147. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest399/mainNet_0.headers +0 -0
  148. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest399/mainNet_1.headers +0 -0
  149. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest399/mainNet_2.headers +0 -0
  150. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest399/mainNet_3.headers +0 -0
  151. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest402/mainNetBlockHeaders.json +1 -0
  152. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest402/mainNet_0.headers +0 -0
  153. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest402/mainNet_1.headers +0 -0
  154. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest402/mainNet_2.headers +0 -0
  155. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest402/mainNet_3.headers +0 -0
  156. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest402/mainNet_4.headers +0 -0
  157. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest499/mainNetBlockHeaders.json +1 -0
  158. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest499/mainNet_0.headers +0 -0
  159. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest499/mainNet_1.headers +0 -0
  160. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest499/mainNet_2.headers +0 -0
  161. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest499/mainNet_3.headers +0 -0
  162. package/src/services/chaintracker/chaintracks/__tests/data/cdnTest499/mainNet_4.headers +0 -0
  163. package/src/services/chaintracker/chaintracks/createDefaultIdbChaintracksOptions.ts +92 -0
  164. package/src/services/chaintracker/chaintracks/createDefaultKnexChaintracksOptions.ts +111 -0
  165. package/src/services/chaintracker/chaintracks/createDefaultNoDbChaintracksOptions.ts +91 -0
  166. package/src/services/chaintracker/chaintracks/createIdbChaintracks.ts +60 -0
  167. package/src/services/chaintracker/chaintracks/createKnexChaintracks.ts +65 -0
  168. package/src/services/chaintracker/chaintracks/createNoDbChaintracks.ts +60 -0
  169. package/src/services/chaintracker/chaintracks/index.all.ts +12 -0
  170. package/src/services/chaintracker/chaintracks/index.client.ts +4 -0
  171. package/src/services/chaintracker/chaintracks/index.mobile.ts +37 -0
  172. package/src/services/chaintracker/chaintracks/util/BulkFileDataManager.ts +975 -0
  173. package/src/services/chaintracker/chaintracks/util/BulkFileDataReader.ts +60 -0
  174. package/src/services/chaintracker/chaintracks/util/BulkFilesReader.ts +336 -0
  175. package/src/services/chaintracker/chaintracks/util/BulkHeaderFile.ts +247 -0
  176. package/src/services/chaintracker/chaintracks/util/ChaintracksFetch.ts +69 -0
  177. package/src/services/chaintracker/chaintracks/util/ChaintracksFs.ts +141 -0
  178. package/src/services/chaintracker/chaintracks/util/HeightRange.ts +153 -0
  179. package/src/services/chaintracker/chaintracks/util/SingleWriterMultiReaderLock.ts +76 -0
  180. package/src/services/chaintracker/chaintracks/util/__tests/BulkFileDataManager.test.ts +304 -0
  181. package/src/services/chaintracker/chaintracks/util/__tests/ChaintracksFetch.test.ts +60 -0
  182. package/src/services/chaintracker/chaintracks/util/__tests/HeightRange.test.ts +67 -0
  183. package/src/services/chaintracker/chaintracks/util/__tests/SingleWriterMultiReaderLock.test.ts +49 -0
  184. package/src/services/chaintracker/chaintracks/util/blockHeaderUtilities.ts +573 -0
  185. package/src/services/chaintracker/chaintracks/util/dirtyHashes.ts +29 -0
  186. package/src/services/chaintracker/chaintracks/util/validBulkHeaderFilesByFileHash.ts +432 -0
  187. package/src/services/chaintracker/index.all.ts +4 -0
  188. package/src/services/chaintracker/index.client.ts +4 -0
  189. package/src/services/chaintracker/index.mobile.ts +4 -0
  190. package/src/services/createDefaultWalletServicesOptions.ts +77 -0
  191. package/src/services/index.ts +1 -0
  192. package/src/services/processingErrors/arcSuccessError.json +76 -0
  193. package/src/services/providers/ARC.ts +350 -0
  194. package/src/services/providers/Bitails.ts +256 -0
  195. package/src/services/providers/SdkWhatsOnChain.ts +83 -0
  196. package/src/services/providers/WhatsOnChain.ts +883 -0
  197. package/src/services/providers/__tests/WhatsOnChain.test.ts +242 -0
  198. package/src/services/providers/__tests/exchangeRates.test.ts +18 -0
  199. package/src/services/providers/exchangeRates.ts +265 -0
  200. package/src/services/providers/getBeefForTxid.ts +369 -0
  201. package/src/signer/README.md +5 -0
  202. package/src/signer/WalletSigner.ts +17 -0
  203. package/src/signer/methods/acquireDirectCertificate.ts +52 -0
  204. package/src/signer/methods/buildSignableTransaction.ts +183 -0
  205. package/src/signer/methods/completeSignedTransaction.ts +117 -0
  206. package/src/signer/methods/createAction.ts +172 -0
  207. package/src/signer/methods/internalizeAction.ts +106 -0
  208. package/src/signer/methods/proveCertificate.ts +43 -0
  209. package/src/signer/methods/signAction.ts +54 -0
  210. package/src/storage/README.md +14 -0
  211. package/src/storage/StorageIdb.ts +2304 -0
  212. package/src/storage/StorageKnex.ts +1425 -0
  213. package/src/storage/StorageProvider.ts +810 -0
  214. package/src/storage/StorageReader.ts +194 -0
  215. package/src/storage/StorageReaderWriter.ts +432 -0
  216. package/src/storage/StorageSyncReader.ts +34 -0
  217. package/src/storage/WalletStorageManager.ts +943 -0
  218. package/src/storage/__test/StorageIdb.test.ts +43 -0
  219. package/src/storage/__test/WalletStorageManager.test.ts +275 -0
  220. package/src/storage/__test/adminStats.man.test.ts +89 -0
  221. package/src/storage/__test/getBeefForTransaction.test.ts +385 -0
  222. package/src/storage/index.all.ts +11 -0
  223. package/src/storage/index.client.ts +7 -0
  224. package/src/storage/index.mobile.ts +6 -0
  225. package/src/storage/methods/ListActionsSpecOp.ts +70 -0
  226. package/src/storage/methods/ListOutputsSpecOp.ts +129 -0
  227. package/src/storage/methods/__test/GenerateChange/generateChangeSdk.test.ts +1057 -0
  228. package/src/storage/methods/__test/GenerateChange/randomValsUsed1.ts +20 -0
  229. package/src/storage/methods/__test/offsetKey.test.ts +274 -0
  230. package/src/storage/methods/attemptToPostReqsToNetwork.ts +389 -0
  231. package/src/storage/methods/createAction.ts +947 -0
  232. package/src/storage/methods/generateChange.ts +556 -0
  233. package/src/storage/methods/getBeefForTransaction.ts +139 -0
  234. package/src/storage/methods/getSyncChunk.ts +293 -0
  235. package/src/storage/methods/internalizeAction.ts +562 -0
  236. package/src/storage/methods/listActionsIdb.ts +183 -0
  237. package/src/storage/methods/listActionsKnex.ts +226 -0
  238. package/src/storage/methods/listCertificates.ts +73 -0
  239. package/src/storage/methods/listOutputsIdb.ts +203 -0
  240. package/src/storage/methods/listOutputsKnex.ts +263 -0
  241. package/src/storage/methods/offsetKey.ts +89 -0
  242. package/src/storage/methods/processAction.ts +420 -0
  243. package/src/storage/methods/purgeData.ts +251 -0
  244. package/src/storage/methods/purgeDataIdb.ts +10 -0
  245. package/src/storage/methods/reviewStatus.ts +101 -0
  246. package/src/storage/methods/reviewStatusIdb.ts +43 -0
  247. package/src/storage/methods/utils.Buffer.ts +33 -0
  248. package/src/storage/methods/utils.ts +56 -0
  249. package/src/storage/remoting/StorageClient.ts +567 -0
  250. package/src/storage/remoting/StorageMobile.ts +544 -0
  251. package/src/storage/remoting/StorageServer.ts +291 -0
  252. package/src/storage/remoting/__test/StorageClient.test.ts +113 -0
  253. package/src/storage/schema/KnexMigrations.ts +489 -0
  254. package/src/storage/schema/StorageIdbSchema.ts +150 -0
  255. package/src/storage/schema/entities/EntityBase.ts +210 -0
  256. package/src/storage/schema/entities/EntityCertificate.ts +188 -0
  257. package/src/storage/schema/entities/EntityCertificateField.ts +136 -0
  258. package/src/storage/schema/entities/EntityCommission.ts +148 -0
  259. package/src/storage/schema/entities/EntityOutput.ts +290 -0
  260. package/src/storage/schema/entities/EntityOutputBasket.ts +153 -0
  261. package/src/storage/schema/entities/EntityOutputTag.ts +121 -0
  262. package/src/storage/schema/entities/EntityOutputTagMap.ts +123 -0
  263. package/src/storage/schema/entities/EntityProvenTx.ts +319 -0
  264. package/src/storage/schema/entities/EntityProvenTxReq.ts +580 -0
  265. package/src/storage/schema/entities/EntitySyncState.ts +389 -0
  266. package/src/storage/schema/entities/EntityTransaction.ts +306 -0
  267. package/src/storage/schema/entities/EntityTxLabel.ts +121 -0
  268. package/src/storage/schema/entities/EntityTxLabelMap.ts +123 -0
  269. package/src/storage/schema/entities/EntityUser.ts +112 -0
  270. package/src/storage/schema/entities/MergeEntity.ts +73 -0
  271. package/src/storage/schema/entities/__tests/CertificateFieldTests.test.ts +353 -0
  272. package/src/storage/schema/entities/__tests/CertificateTests.test.ts +354 -0
  273. package/src/storage/schema/entities/__tests/CommissionTests.test.ts +371 -0
  274. package/src/storage/schema/entities/__tests/OutputBasketTests.test.ts +278 -0
  275. package/src/storage/schema/entities/__tests/OutputTagMapTests.test.ts +242 -0
  276. package/src/storage/schema/entities/__tests/OutputTagTests.test.ts +288 -0
  277. package/src/storage/schema/entities/__tests/OutputTests.test.ts +464 -0
  278. package/src/storage/schema/entities/__tests/ProvenTxReqTests.test.ts +340 -0
  279. package/src/storage/schema/entities/__tests/ProvenTxTests.test.ts +504 -0
  280. package/src/storage/schema/entities/__tests/SyncStateTests.test.ts +288 -0
  281. package/src/storage/schema/entities/__tests/TransactionTests.test.ts +604 -0
  282. package/src/storage/schema/entities/__tests/TxLabelMapTests.test.ts +361 -0
  283. package/src/storage/schema/entities/__tests/TxLabelTests.test.ts +198 -0
  284. package/src/storage/schema/entities/__tests/stampLogTests.test.ts +90 -0
  285. package/src/storage/schema/entities/__tests/usersTests.test.ts +340 -0
  286. package/src/storage/schema/entities/index.ts +16 -0
  287. package/src/storage/schema/tables/TableCertificate.ts +21 -0
  288. package/src/storage/schema/tables/TableCertificateField.ts +12 -0
  289. package/src/storage/schema/tables/TableCommission.ts +13 -0
  290. package/src/storage/schema/tables/TableMonitorEvent.ts +9 -0
  291. package/src/storage/schema/tables/TableOutput.ts +64 -0
  292. package/src/storage/schema/tables/TableOutputBasket.ts +12 -0
  293. package/src/storage/schema/tables/TableOutputTag.ts +10 -0
  294. package/src/storage/schema/tables/TableOutputTagMap.ts +9 -0
  295. package/src/storage/schema/tables/TableProvenTx.ts +14 -0
  296. package/src/storage/schema/tables/TableProvenTxReq.ts +65 -0
  297. package/src/storage/schema/tables/TableSettings.ts +17 -0
  298. package/src/storage/schema/tables/TableSyncState.ts +18 -0
  299. package/src/storage/schema/tables/TableTransaction.ts +54 -0
  300. package/src/storage/schema/tables/TableTxLabel.ts +10 -0
  301. package/src/storage/schema/tables/TableTxLabelMap.ts +9 -0
  302. package/src/storage/schema/tables/TableUser.ts +16 -0
  303. package/src/storage/schema/tables/index.ts +16 -0
  304. package/src/storage/sync/StorageMySQLDojoReader.ts +696 -0
  305. package/src/storage/sync/index.ts +1 -0
  306. package/src/utility/Format.ts +133 -0
  307. package/src/utility/README.md +3 -0
  308. package/src/utility/ReaderUint8Array.ts +187 -0
  309. package/src/utility/ScriptTemplateBRC29.ts +73 -0
  310. package/src/utility/__tests/utilityHelpers.noBuffer.test.ts +109 -0
  311. package/src/utility/aggregateResults.ts +68 -0
  312. package/src/utility/identityUtils.ts +159 -0
  313. package/src/utility/index.all.ts +7 -0
  314. package/src/utility/index.client.ts +7 -0
  315. package/src/utility/parseTxScriptOffsets.ts +29 -0
  316. package/src/utility/stampLog.ts +69 -0
  317. package/src/utility/tscProofToMerklePath.ts +48 -0
  318. package/src/utility/utilityHelpers.buffer.ts +34 -0
  319. package/src/utility/utilityHelpers.noBuffer.ts +60 -0
  320. package/src/utility/utilityHelpers.ts +275 -0
  321. package/src/wab-client/WABClient.ts +94 -0
  322. package/src/wab-client/__tests/WABClient.man.test.ts +59 -0
  323. package/src/wab-client/auth-method-interactors/AuthMethodInteractor.ts +47 -0
  324. package/src/wab-client/auth-method-interactors/DevConsoleInteractor.ts +73 -0
  325. package/src/wab-client/auth-method-interactors/PersonaIDInteractor.ts +35 -0
  326. package/src/wab-client/auth-method-interactors/TwilioPhoneInteractor.ts +72 -0
  327. package/syncVersions.js +71 -0
  328. package/test/Wallet/StorageClient/storageClient.man.test.ts +75 -0
  329. package/test/Wallet/action/abortAction.test.ts +47 -0
  330. package/test/Wallet/action/createAction.test.ts +299 -0
  331. package/test/Wallet/action/createAction2.test.ts +1273 -0
  332. package/test/Wallet/action/createActionToGenerateBeefs.man.test.ts +293 -0
  333. package/test/Wallet/action/internalizeAction.a.test.ts +286 -0
  334. package/test/Wallet/action/internalizeAction.test.ts +682 -0
  335. package/test/Wallet/action/relinquishOutput.test.ts +37 -0
  336. package/test/Wallet/certificate/acquireCertificate.test.ts +298 -0
  337. package/test/Wallet/certificate/listCertificates.test.ts +346 -0
  338. package/test/Wallet/construct/Wallet.constructor.test.ts +57 -0
  339. package/test/Wallet/get/getHeaderForHeight.test.ts +82 -0
  340. package/test/Wallet/get/getHeight.test.ts +52 -0
  341. package/test/Wallet/get/getKnownTxids.test.ts +86 -0
  342. package/test/Wallet/get/getNetwork.test.ts +27 -0
  343. package/test/Wallet/get/getVersion.test.ts +27 -0
  344. package/test/Wallet/list/listActions.test.ts +279 -0
  345. package/test/Wallet/list/listActions2.test.ts +1381 -0
  346. package/test/Wallet/list/listCertificates.test.ts +118 -0
  347. package/test/Wallet/list/listOutputs.test.ts +447 -0
  348. package/test/Wallet/live/walletLive.man.test.ts +521 -0
  349. package/test/Wallet/local/localWallet.man.test.ts +93 -0
  350. package/test/Wallet/local/localWallet2.man.test.ts +277 -0
  351. package/test/Wallet/signAction/mountaintop.man.test.ts +130 -0
  352. package/test/Wallet/specOps/specOps.man.test.ts +220 -0
  353. package/test/Wallet/support/janitor.man.test.ts +40 -0
  354. package/test/Wallet/support/operations.man.test.ts +407 -0
  355. package/test/Wallet/support/reqErrorReview.2025.05.06.man.test.ts +347 -0
  356. package/test/Wallet/sync/Wallet.sync.test.ts +215 -0
  357. package/test/Wallet/sync/Wallet.updateWalletLegacyTestData.man.test.ts +203 -0
  358. package/test/Wallet/sync/setActive.test.ts +170 -0
  359. package/test/WalletClient/LocalKVStore.man.test.ts +114 -0
  360. package/test/WalletClient/WERR.man.test.ts +35 -0
  361. package/test/bsv-ts-sdk/LocalKVStore.test.ts +102 -0
  362. package/test/checkDB.ts +57 -0
  363. package/test/checkdb +0 -0
  364. package/test/examples/backup.man.test.ts +59 -0
  365. package/test/examples/pushdrop.test.ts +282 -0
  366. package/test/monitor/Monitor.test.ts +620 -0
  367. package/test/services/Services.test.ts +263 -0
  368. package/test/storage/KnexMigrations.test.ts +86 -0
  369. package/test/storage/StorageMySQLDojoReader.man.test.ts +60 -0
  370. package/test/storage/count.test.ts +177 -0
  371. package/test/storage/find.test.ts +195 -0
  372. package/test/storage/findLegacy.test.ts +67 -0
  373. package/test/storage/idb/allocateChange.test.ts +251 -0
  374. package/test/storage/idb/count.test.ts +158 -0
  375. package/test/storage/idb/find.test.ts +177 -0
  376. package/test/storage/idb/idbSpeed.test.ts +36 -0
  377. package/test/storage/idb/insert.test.ts +268 -0
  378. package/test/storage/idb/transactionAbort.test.ts +108 -0
  379. package/test/storage/idb/update.test.ts +999 -0
  380. package/test/storage/insert.test.ts +278 -0
  381. package/test/storage/update.test.ts +1021 -0
  382. package/test/storage/update2.test.ts +897 -0
  383. package/test/utils/TestUtilsWalletStorage.ts +2526 -0
  384. package/test/utils/localWalletMethods.ts +363 -0
  385. package/test/utils/removeFailedFromDatabase.sql +17 -0
  386. package/ts2md.json +44 -0
  387. package/tsconfig.all.json +31 -0
  388. package/tsconfig.client.json +29 -0
  389. package/tsconfig.json +17 -0
  390. package/tsconfig.mobile.json +28 -0
@@ -0,0 +1,675 @@
1
+ import { WalletInterface, Random, Hash, Utils, PrivateKey, SymmetricKey } from '@bsv/sdk'
2
+ import { PrivilegedKeyManager } from '../sdk'
3
+ import { CWIStyleWalletManager, PBKDF2_NUM_ROUNDS, UMPToken, UMPTokenInteractor } from '../CWIStyleWalletManager'
4
+ import { jest } from '@jest/globals'
5
+
6
+ jest.useFakeTimers()
7
+
8
+ // ------------------------------------------------------------------------------------------
9
+ // Mocks and Utilities
10
+ // ------------------------------------------------------------------------------------------
11
+
12
+ /** A utility to create an Outpoint string for test usage. */
13
+ function makeOutpoint(txid: string, vout: number): string {
14
+ return `${txid}:${vout}`
15
+ }
16
+
17
+ /**
18
+ * A mock underlying WalletInterface to verify that proxy methods:
19
+ * 1. Are not callable if not authenticated
20
+ * 2. Are disallowed if originator is admin
21
+ * 3. Forward to the real method if conditions pass
22
+ */
23
+ const mockUnderlyingWallet = {
24
+ getPublicKey: jest.fn(),
25
+ revealCounterpartyKeyLinkage: jest.fn(),
26
+ revealSpecificKeyLinkage: jest.fn(),
27
+ encrypt: jest.fn(),
28
+ decrypt: jest.fn(),
29
+ createHmac: jest.fn(),
30
+ verifyHmac: jest.fn(),
31
+ createSignature: jest.fn(),
32
+ verifySignature: jest.fn(),
33
+ createAction: jest.fn(),
34
+ signAction: jest.fn(),
35
+ abortAction: jest.fn(),
36
+ listActions: jest.fn(),
37
+ internalizeAction: jest.fn(),
38
+ listOutputs: jest.fn(),
39
+ relinquishOutput: jest.fn(),
40
+ acquireCertificate: jest.fn(),
41
+ listCertificates: jest.fn(),
42
+ proveCertificate: jest.fn(),
43
+ relinquishCertificate: jest.fn(),
44
+ discoverByIdentityKey: jest.fn(),
45
+ discoverByAttributes: jest.fn(),
46
+ isAuthenticated: jest.fn(),
47
+ waitForAuthentication: jest.fn(),
48
+ getHeight: jest.fn(),
49
+ getHeaderForHeight: jest.fn(),
50
+ getNetwork: jest.fn(),
51
+ getVersion: jest.fn()
52
+ } as unknown as WalletInterface
53
+
54
+ /**
55
+ * A mock function that simulates building an underlying wallet.
56
+ */
57
+ const mockWalletBuilder = jest.fn(async (primaryKey, privilegedKeyManager) => {
58
+ // Return our mock underlying wallet object.
59
+ return mockUnderlyingWallet
60
+ })
61
+
62
+ /**
63
+ * A mock UMPTokenInteractor implementation.
64
+ * We can track whether buildAndSend is called with the right arguments, etc.
65
+ */
66
+ const mockUMPTokenInteractor: UMPTokenInteractor = {
67
+ findByPresentationKeyHash: jest.fn(async (hash: number[]) => undefined),
68
+ findByRecoveryKeyHash: jest.fn(async (hash: number[]) => undefined),
69
+ buildAndSend: jest.fn(
70
+ async (wallet: WalletInterface, admin: string, token: UMPToken, oldToken?: UMPToken) => 'abcd.0'
71
+ )
72
+ }
73
+
74
+ /**
75
+ * A mock "recoveryKeySaver" that claims it always saved the key successfully.
76
+ */
77
+ const mockRecoveryKeySaver = jest.fn(async (key: number[]) => true as true)
78
+
79
+ /**
80
+ * A mock "passwordRetriever" that we can customize to return a specific password
81
+ * or throw if needed.
82
+ */
83
+ const mockPasswordRetriever = jest.fn(async () => 'test-password')
84
+
85
+ const XOR = (n1: number[], n2: number[]): number[] => {
86
+ if (n1.length !== n2.length) {
87
+ throw new Error('lengths mismatch')
88
+ }
89
+ const r = new Array<number>(n1.length)
90
+ for (let i = 0; i < n1.length; i++) {
91
+ r[i] = n1[i] ^ n2[i]
92
+ }
93
+ return r
94
+ }
95
+
96
+ // Generate some globals
97
+ const presentationKey = Random(32)
98
+ const recoveryKey = Random(32)
99
+ const passwordSalt = Random(32)
100
+ const passwordKey = Hash.pbkdf2(Utils.toArray('test-password', 'utf8'), passwordSalt, PBKDF2_NUM_ROUNDS, 32, 'sha512')
101
+ const primaryKey = Random(32)
102
+ const privilegedKey = Random(32)
103
+
104
+ /**
105
+ * A helper function to create a minimal valid UMP token.
106
+ * This can be used to mock a stored token for existing users.
107
+ */
108
+ async function createMockUMPToken(): Promise<UMPToken> {
109
+ const presentationPassword = new SymmetricKey(XOR(presentationKey, passwordKey))
110
+ const presentationRecovery = new SymmetricKey(XOR(presentationKey, recoveryKey))
111
+ const recoveryPassword = new SymmetricKey(XOR(recoveryKey, passwordKey))
112
+ const primaryPassword = new SymmetricKey(XOR(primaryKey, passwordKey))
113
+ const tempPrivilegedKeyManager = new PrivilegedKeyManager(async () => new PrivateKey(privilegedKey))
114
+ return {
115
+ passwordSalt,
116
+ passwordPresentationPrimary: presentationPassword.encrypt(primaryKey) as number[],
117
+ passwordRecoveryPrimary: recoveryPassword.encrypt(primaryKey) as number[],
118
+ presentationRecoveryPrimary: presentationRecovery.encrypt(primaryKey) as number[],
119
+ passwordPrimaryPrivileged: primaryPassword.encrypt(privilegedKey) as number[],
120
+ presentationRecoveryPrivileged: presentationRecovery.encrypt(privilegedKey) as number[],
121
+ presentationHash: Hash.sha256(presentationKey),
122
+ recoveryHash: Hash.sha256(recoveryKey),
123
+ presentationKeyEncrypted: (
124
+ await tempPrivilegedKeyManager.encrypt({
125
+ plaintext: presentationKey,
126
+ protocolID: [2, 'admin key wrapping'],
127
+ keyID: '1'
128
+ })
129
+ ).ciphertext,
130
+ passwordKeyEncrypted: (
131
+ await tempPrivilegedKeyManager.encrypt({
132
+ plaintext: passwordKey,
133
+ protocolID: [2, 'admin key wrapping'],
134
+ keyID: '1'
135
+ })
136
+ ).ciphertext,
137
+ recoveryKeyEncrypted: (
138
+ await tempPrivilegedKeyManager.encrypt({
139
+ plaintext: recoveryKey,
140
+ protocolID: [2, 'admin key wrapping'],
141
+ keyID: '1'
142
+ })
143
+ ).ciphertext,
144
+ currentOutpoint: 'abcd:0'
145
+ }
146
+ }
147
+
148
+ describe('CWIStyleWalletManager Tests', () => {
149
+ let manager: CWIStyleWalletManager
150
+
151
+ beforeEach(() => {
152
+ // Reset all mock calls
153
+ jest.clearAllMocks()
154
+
155
+ // We create a new manager for each test, with no initial snapshot
156
+ manager = new CWIStyleWalletManager(
157
+ 'admin.walletvendor.com', // admin originator
158
+ mockWalletBuilder,
159
+ mockUMPTokenInteractor,
160
+ mockRecoveryKeySaver,
161
+ mockPasswordRetriever
162
+ // no state snapshot
163
+ )
164
+ })
165
+
166
+ // ----------------------------------------------------------------------------------------
167
+ // Private method tests (just to ensure coverage).
168
+ // We'll call them via (manager as any).somePrivateMethod(...) if needed.
169
+ // ----------------------------------------------------------------------------------------
170
+
171
+ test('XOR function: verifies correctness', () => {
172
+ const fnXOR = (manager as any).XOR as (a: number[], b: number[]) => number[]
173
+
174
+ const a = [0x00, 0xff, 0xaa]
175
+ const b = [0xff, 0xff, 0x55]
176
+ const result = fnXOR(a, b)
177
+
178
+ // 0x00 ^ 0xFF = 0xFF
179
+ // 0xFF ^ 0xFF = 0x00
180
+ // 0xAA ^ 0x55 = 0xFF
181
+ expect(result).toEqual([0xff, 0x00, 0xff])
182
+ })
183
+
184
+ // ----------------------------------------------------------------------------------------
185
+ // Authentication flows
186
+ // ----------------------------------------------------------------------------------------
187
+
188
+ describe('New user flow: presentation + password', () => {
189
+ test('Successfully creates a new token and calls buildAndSend', async () => {
190
+ // New wallet funder is a mock function
191
+ const newWalletFunder = jest.fn(() => {})
192
+ ;(manager as any).newWalletFunder = newWalletFunder
193
+
194
+ // Mock that no token is found by presentation key hash
195
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(undefined)
196
+
197
+ // Provide a presentation key
198
+ await manager.providePresentationKey(presentationKey)
199
+
200
+ expect(manager.authenticationFlow).toBe('new-user')
201
+
202
+ // Provide a password
203
+ mockPasswordRetriever.mockResolvedValueOnce('dummy-password')
204
+ await manager.providePassword('dummy-password')
205
+
206
+ // The wallet should now be built, so manager is authenticated
207
+ expect(manager.authenticated).toBe(true)
208
+
209
+ // Recovery key saver should have been called
210
+ expect(mockRecoveryKeySaver).toHaveBeenCalledTimes(1)
211
+
212
+ // The underlying wallet builder should have been called exactly once
213
+ expect(mockWalletBuilder).toHaveBeenCalledTimes(1)
214
+
215
+ // The manager should have called buildAndSend on the interactor
216
+ expect(mockUMPTokenInteractor.buildAndSend).toHaveBeenCalledTimes(1)
217
+ const buildArgs = (mockUMPTokenInteractor.buildAndSend as any).mock.calls[0]
218
+ // [0] => the wallet, [1] => adminOriginator, [2] => newToken, [3] => oldToken
219
+ expect(buildArgs[1]).toBe('admin.walletvendor.com')
220
+ expect(buildArgs[2]).toHaveProperty('presentationHash')
221
+ expect(buildArgs[3]).toBeUndefined() // Because it's a new user (no old token)
222
+ expect(newWalletFunder).toHaveBeenCalled() // New wallet funder should have been called
223
+ })
224
+
225
+ test('Throws if user tries to provide recovery key during new-user flow', async () => {
226
+ // Mark it as new user flow by no token found
227
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(undefined)
228
+ await manager.providePresentationKey(Array.from({ length: 32 }, () => 1))
229
+
230
+ await expect(manager.provideRecoveryKey(Array.from({ length: 32 }, () => 2))).rejects.toThrow(
231
+ 'Do not submit recovery key in new-user flow'
232
+ )
233
+ })
234
+ })
235
+
236
+ describe('Existing user flow: presentation + password', () => {
237
+ test('Decryption of primary key and building the wallet', async () => {
238
+ // Provide a mock UMP token
239
+ const mockToken = await createMockUMPToken()
240
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(mockToken)
241
+
242
+ // Provide presentation
243
+ await manager.providePresentationKey(presentationKey)
244
+ expect(manager.authenticationFlow).toBe('existing-user')
245
+
246
+ // Provide password
247
+ // The manager's internal code will do PBKDF2 with the password + token.passwordSalt
248
+ // Then XOR that with the presentation key for decryption.
249
+ await manager.providePassword('test-password')
250
+
251
+ // Check that manager is authenticated
252
+ expect(manager.authenticated).toBe(true)
253
+
254
+ // Underlying wallet is built
255
+ expect(mockWalletBuilder).toHaveBeenCalledTimes(1)
256
+ })
257
+ })
258
+
259
+ describe('Existing user flow: presentation + recovery key', () => {
260
+ beforeEach(async () => {
261
+ manager.authenticationMode = 'presentation-key-and-recovery-key'
262
+ manager.authenticationFlow = 'existing-user'
263
+ })
264
+
265
+ test('Successfully decrypts with presentation+recovery', async () => {
266
+ // Provide a mock UMP token
267
+ const mockToken = await createMockUMPToken()
268
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(mockToken)
269
+
270
+ await manager.providePresentationKey(presentationKey)
271
+
272
+ // Provide the recovery key.
273
+ // In "presentation-key-and-recovery-key" mode, the manager won't need the password at all.
274
+ await manager.provideRecoveryKey(recoveryKey)
275
+
276
+ expect(manager.authenticated).toBe(true)
277
+ expect(mockWalletBuilder).toHaveBeenCalledTimes(1)
278
+ })
279
+
280
+ test('Throws if presentation key not provided first', async () => {
281
+ const recoveryKey = Array.from({ length: 32 }, () => 8)
282
+ await expect(manager.provideRecoveryKey(recoveryKey)).rejects.toThrow('Provide the presentation key first')
283
+ })
284
+ })
285
+
286
+ describe('Existing user flow: recovery key + password', () => {
287
+ beforeEach(async () => {
288
+ manager.authenticationMode = 'recovery-key-and-password'
289
+ manager.authenticationFlow = 'existing-user'
290
+ })
291
+
292
+ test('Works with correct keys, sets mode as existing-user', async () => {
293
+ const mockToken = await createMockUMPToken()
294
+ ;(mockUMPTokenInteractor.findByRecoveryKeyHash as any).mockResolvedValueOnce(mockToken)
295
+
296
+ // Provide recovery key
297
+ await manager.provideRecoveryKey(recoveryKey)
298
+
299
+ // Provide password
300
+ await manager.providePassword('test-password')
301
+
302
+ expect(manager.authenticated).toBe(true)
303
+ expect(mockWalletBuilder).toHaveBeenCalledTimes(1)
304
+ })
305
+
306
+ test('Throws if no token found by recovery key hash', async () => {
307
+ ;(mockUMPTokenInteractor.findByRecoveryKeyHash as any).mockResolvedValueOnce(undefined)
308
+ await expect(manager.provideRecoveryKey(recoveryKey)).rejects.toThrow('No user found with this recovery key')
309
+ })
310
+ })
311
+
312
+ // ----------------------------------------------------------------------------------------
313
+ // Snapshots
314
+ // ----------------------------------------------------------------------------------------
315
+
316
+ describe('saveSnapshot / loadSnapshot', () => {
317
+ test('Saves a snapshot and can load it into a fresh manager instance', async () => {
318
+ // We'll do a new user flow so that manager is authenticated with a real token.
319
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(undefined)
320
+ const presKey = Array.from({ length: 32 }, () => 0xa1)
321
+ await manager.providePresentationKey(presKey)
322
+ await manager.providePassword('mypassword') // triggers creation of new user
323
+
324
+ const snapshot = manager.saveSnapshot()
325
+ expect(Array.isArray(snapshot)).toBe(true)
326
+ expect(snapshot.length).toBeGreaterThan(64) // 32 bytes + encrypted data
327
+
328
+ // Now create a fresh manager:
329
+ const freshManager = new CWIStyleWalletManager(
330
+ 'admin.walletvendor.com',
331
+ mockWalletBuilder,
332
+ mockUMPTokenInteractor,
333
+ mockRecoveryKeySaver,
334
+ mockPasswordRetriever
335
+ )
336
+
337
+ // Not authenticated yet
338
+ await expect(() => freshManager.getPublicKey({ identityKey: true })).rejects.toThrow('User is not authenticated')
339
+
340
+ // Load the snapshot
341
+ await freshManager.loadSnapshot(snapshot)
342
+
343
+ // The fresh manager is now authenticated (underlying wallet will be built).
344
+ await expect(freshManager.getPublicKey({ identityKey: true })).resolves.not.toThrow()
345
+
346
+ // It calls walletBuilder again
347
+ expect(mockWalletBuilder).toHaveBeenCalledTimes(2) // once for the old manager, once for the fresh
348
+ })
349
+
350
+ test('Throws error if saving snapshot while no primary key or token set', async () => {
351
+ // Manager is not yet authenticated
352
+ expect(() => manager.saveSnapshot()).toThrow('No root primary key or current UMP token set')
353
+ })
354
+
355
+ test('Throws if snapshot is corrupt or cannot be decrypted', async () => {
356
+ // Attempt to load an invalid snapshot
357
+ await expect(() => manager.loadSnapshot([1, 2, 3])).rejects.toThrow('Failed to load snapshot')
358
+ })
359
+ })
360
+
361
+ // ----------------------------------------------------------------------------------------
362
+ // Changing Keys
363
+ // ----------------------------------------------------------------------------------------
364
+
365
+ describe('Change Password', () => {
366
+ test('Requires authentication and updates the UMP token on-chain', async () => {
367
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(undefined)
368
+ manager = new CWIStyleWalletManager(
369
+ 'admin.walletvendor.com',
370
+ mockWalletBuilder,
371
+ mockUMPTokenInteractor,
372
+ mockRecoveryKeySaver,
373
+ async () => 'test-password'
374
+ )
375
+ await manager.providePresentationKey(presentationKey)
376
+ await manager.providePassword('test-password')
377
+ expect(manager.authenticated).toBe(true)
378
+ await manager.changePassword('new-pass')
379
+ expect(mockUMPTokenInteractor.buildAndSend).toHaveBeenCalledTimes(2)
380
+ })
381
+
382
+ test('Throws if not authenticated', async () => {
383
+ await expect(manager.changePassword('test-password')).rejects.toThrow(
384
+ 'Not authenticated or missing required data.'
385
+ )
386
+ })
387
+ })
388
+
389
+ describe('Change Recovery Key', () => {
390
+ test('Prompts to save the new key, updates the token', async () => {
391
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(undefined)
392
+ manager = new CWIStyleWalletManager(
393
+ 'admin.walletvendor.com',
394
+ mockWalletBuilder,
395
+ mockUMPTokenInteractor,
396
+ mockRecoveryKeySaver,
397
+ async () => 'test-password'
398
+ )
399
+ await manager.providePresentationKey(presentationKey)
400
+ await manager.providePassword('test-password')
401
+ expect(manager.authenticated).toBe(true)
402
+ ;(mockUMPTokenInteractor.buildAndSend as any).mockResolvedValueOnce(makeOutpoint('rcv1', 0))
403
+ await manager.changeRecoveryKey()
404
+
405
+ // The user is prompted to store the new key
406
+ expect(mockRecoveryKeySaver).toHaveBeenCalledTimes(2) // once when user created, once after changed
407
+ // The UMP token is updated
408
+ expect(mockUMPTokenInteractor.buildAndSend).toHaveBeenCalledTimes(2)
409
+ })
410
+
411
+ test('Throws if not authenticated', async () => {
412
+ await expect(manager.changeRecoveryKey()).rejects.toThrow('Not authenticated or missing required data.')
413
+ })
414
+ })
415
+
416
+ describe('Change Presentation Key', () => {
417
+ test('Requires authentication, re-publishes the token, old token consumed', async () => {
418
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(undefined)
419
+ manager = new CWIStyleWalletManager(
420
+ 'admin.walletvendor.com',
421
+ mockWalletBuilder,
422
+ mockUMPTokenInteractor,
423
+ mockRecoveryKeySaver,
424
+ async () => 'test-password'
425
+ )
426
+ await manager.providePresentationKey(presentationKey)
427
+ await manager.providePassword('test-password')
428
+ expect(manager.authenticated).toBe(true)
429
+ ;(mockUMPTokenInteractor.buildAndSend as any).mockResolvedValueOnce(makeOutpoint('rcv1', 0))
430
+ const newPresKey = Array.from({ length: 32 }, () => 0xee)
431
+ await manager.changePresentationKey(newPresKey)
432
+ expect(mockUMPTokenInteractor.buildAndSend).toHaveBeenCalledTimes(2)
433
+ })
434
+ })
435
+
436
+ describe('Profile management', () => {
437
+ test('addProfile adds a new profile and updates the UMP token', async () => {
438
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(undefined)
439
+ await manager.providePresentationKey(presentationKey)
440
+ await manager.providePassword('test-password')
441
+ expect(manager.authenticated).toBe(true)
442
+
443
+ const initialProfiles = manager.listProfiles()
444
+ expect(initialProfiles).toHaveLength(1)
445
+ expect(initialProfiles[0].name).toBe('default')
446
+
447
+ const getFactorSpy = jest.spyOn(manager as any, 'getFactor').mockImplementation(async () => Random(32))
448
+
449
+ ;(mockUMPTokenInteractor.buildAndSend as any).mockClear()
450
+
451
+ const newProfileId = await manager.addProfile('Work')
452
+ expect(Array.isArray(newProfileId)).toBe(true)
453
+ expect(newProfileId.length).toBe(16)
454
+
455
+ const updatedProfiles = manager.listProfiles()
456
+ expect(updatedProfiles).toHaveLength(2)
457
+ const workProfile = updatedProfiles.find(p => p.name === 'Work')
458
+ expect(workProfile).toBeDefined()
459
+ expect(workProfile!.active).toBe(false)
460
+
461
+ expect(mockUMPTokenInteractor.buildAndSend).toHaveBeenCalledTimes(1)
462
+
463
+ getFactorSpy.mockRestore()
464
+ })
465
+
466
+ test('syncUMPToken refreshes UMP token and profiles from overlay when newer token exists', async () => {
467
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(undefined)
468
+ await manager.providePresentationKey(presentationKey)
469
+ await manager.providePassword('test-password')
470
+ expect(manager.authenticated).toBe(true)
471
+
472
+ const originalToken = (manager as any).currentUMPToken as UMPToken
473
+ const rootPrimaryKey = (manager as any).rootPrimaryKey as number[]
474
+
475
+ const extraProfile = {
476
+ name: 'overlay-profile',
477
+ id: Random(16),
478
+ primaryPad: Random(32),
479
+ privilegedPad: Random(32),
480
+ createdAt: Math.floor(Date.now() / 1000)
481
+ }
482
+ const profilesJson = JSON.stringify([extraProfile])
483
+ const profilesBytes = Utils.toArray(profilesJson, 'utf8')
484
+ const profilesEncrypted = new SymmetricKey(rootPrimaryKey).encrypt(profilesBytes) as number[]
485
+
486
+ const updatedToken: UMPToken = {
487
+ ...originalToken,
488
+ currentOutpoint: makeOutpoint('overlay-tx', 0),
489
+ profilesEncrypted
490
+ }
491
+
492
+ const saveSnapshotSpy = jest.spyOn(manager, 'saveSnapshot')
493
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(updatedToken)
494
+
495
+ const result = await manager.syncUMPToken()
496
+ expect(result).toBe(true)
497
+ expect(saveSnapshotSpy).toHaveBeenCalled()
498
+ saveSnapshotSpy.mockRestore()
499
+
500
+ const profiles = manager.listProfiles()
501
+ expect(profiles.some(p => p.name === 'overlay-profile')).toBe(true)
502
+ })
503
+ })
504
+
505
+ test('Destroy callback clears sensitive data', async () => {
506
+ // authenticate as new user
507
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(undefined)
508
+ await manager.providePresentationKey(Array.from({ length: 32 }, () => 12))
509
+ await manager.providePassword('some-pass')
510
+
511
+ // manager is authenticated
512
+ expect(manager.authenticated).toBe(true)
513
+
514
+ // Destroy
515
+ manager.destroy()
516
+
517
+ expect(manager.authenticated).toBe(false)
518
+ // And we can confirm that manager won't allow calls
519
+ await expect(() => manager.getPublicKey({ identityKey: true })).rejects.toThrow('User is not authenticated')
520
+ })
521
+
522
+ // ----------------------------------------------------------------------------------------
523
+ // Proxies / originator checks
524
+ // ----------------------------------------------------------------------------------------
525
+
526
+ describe('Proxy method calls', () => {
527
+ beforeEach(async () => {
528
+ // authenticate
529
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(undefined)
530
+ await manager.providePresentationKey(presentationKey)
531
+ await manager.providePassword('test-password')
532
+ })
533
+
534
+ test('Throws if user is not authenticated', async () => {
535
+ // force de-auth
536
+ ;(manager as any).authenticated = false
537
+ await expect(() => manager.getPublicKey({ identityKey: true })).rejects.toThrow('User is not authenticated.')
538
+ })
539
+
540
+ test('Throws if originator is adminOriginator', async () => {
541
+ await expect(manager.getPublicKey({ identityKey: true }, 'admin.walletvendor.com')).rejects.toThrow(
542
+ 'External applications are not allowed to use the admin originator.'
543
+ )
544
+ })
545
+
546
+ test('Passes if user is authenticated and originator is not admin', async () => {
547
+ await manager.getPublicKey({ identityKey: true }, 'example.com')
548
+ expect(mockUnderlyingWallet.getPublicKey).toHaveBeenCalledTimes(1)
549
+ })
550
+
551
+ test('All proxied methods call underlying with correct arguments', async () => {
552
+ // We'll do a quick spot-check of a few methods:
553
+ await manager.encrypt({ plaintext: [1, 2, 3], protocolID: [1, 'tests'], keyID: '1' }, 'mydomain.com')
554
+ expect(mockUnderlyingWallet.encrypt).toHaveBeenCalledWith(
555
+ { plaintext: [1, 2, 3], protocolID: [1, 'tests'], keyID: '1' },
556
+ 'mydomain.com'
557
+ )
558
+
559
+ // TODO: Test all other proxied methods
560
+ })
561
+
562
+ test('isAuthenticated() rejects if originator is admin, resolves otherwise', async () => {
563
+ // If admin tries:
564
+ await expect(manager.isAuthenticated({}, 'admin.walletvendor.com')).rejects.toThrow(
565
+ 'External applications are not allowed to use the admin originator.'
566
+ )
567
+ // If normal domain:
568
+ const result = await manager.isAuthenticated({}, 'normal.com')
569
+ expect(result).toEqual({ authenticated: true })
570
+ })
571
+
572
+ test('waitForAuthentication() eventually resolves', async () => {
573
+ // Already authenticated from beforeEach. So it should immediately return.
574
+ await manager.waitForAuthentication({}, 'normal.com')
575
+ expect(mockUnderlyingWallet.waitForAuthentication).toHaveBeenCalledTimes(1)
576
+ })
577
+ })
578
+ describe('Additional Tests for Password Retriever Callback, Privileged Key Expiry, and UMP Token Serialization', () => {
579
+ let manager: CWIStyleWalletManager
580
+
581
+ beforeEach(() => {
582
+ jest.clearAllMocks()
583
+ manager = new CWIStyleWalletManager(
584
+ 'admin.walletvendor.com',
585
+ mockWalletBuilder,
586
+ mockUMPTokenInteractor,
587
+ mockRecoveryKeySaver,
588
+ mockPasswordRetriever
589
+ )
590
+ })
591
+
592
+ test('serializeUMPToken and deserializeUMPToken correctly round-trip a UMP token', async () => {
593
+ const token = await createMockUMPToken()
594
+ // We need a token with a currentOutpoint for serialization.
595
+ expect(token.currentOutpoint).toBeDefined()
596
+ const serializeFn = (manager as any).serializeUMPToken as (token: UMPToken) => number[]
597
+ const deserializeFn = (manager as any).deserializeUMPToken as (bin: number[]) => UMPToken
598
+
599
+ const serialized = serializeFn(token)
600
+ expect(Array.isArray(serialized)).toBe(true)
601
+ expect(serialized.length).toBeGreaterThan(0)
602
+
603
+ const deserialized = deserializeFn(serialized)
604
+ expect(deserialized).toEqual(token)
605
+ })
606
+
607
+ test('Password retriever callback: the test function is passed and returns a boolean', async () => {
608
+ let capturedTestFn: ((candidate: string) => boolean) | null = null
609
+ const customPasswordRetriever = jest.fn(async (reason: string, testFn: (candidate: string) => boolean) => {
610
+ capturedTestFn = testFn
611
+ // In a real scenario the test function would validate a candidate.
612
+ // For our test we simply return the correct password.
613
+ return 'test-password'
614
+ })
615
+ ;(manager as any).passwordRetriever = customPasswordRetriever
616
+
617
+ // Force a new-user flow by having no token found.
618
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(undefined)
619
+ await manager.providePresentationKey(presentationKey)
620
+ await manager.providePassword('test-password')
621
+ expect(manager.authenticated).toBe(true)
622
+ // Clear the privileged key so the callback gets ran
623
+ jest.advanceTimersByTime(121_000)
624
+
625
+ // Let's trigger a privileged operation
626
+ await manager.changePassword('test-password') // trigger some privileged operation...
627
+ expect(customPasswordRetriever).toHaveBeenCalled()
628
+ expect(capturedTestFn).not.toBeNull()
629
+ // Since the internal test function is defined inline, we simply check that its output is a boolean.
630
+ // (Its logic uses the outer scope and may not use its argument correctly, but we verify that it at least returns a boolean.)
631
+ const testResult = capturedTestFn!('any-input')
632
+ expect(typeof testResult).toBe('boolean')
633
+ expect(capturedTestFn!('any-input')).toBe(false)
634
+ expect(capturedTestFn!('test-password')).toBe(true)
635
+ })
636
+
637
+ test('Privileged key expiry: each call to decrypt via the privileged manager invokes passwordRetriever', async () => {
638
+ // In a new-user flow, buildUnderlying is called without a privilegedKey,
639
+ // so any later use of the privileged manager will trigger a password prompt.
640
+ const customPasswordRetriever = jest.fn(async (reason: string, testFn: (candidate: string) => boolean) => {
641
+ return 'test-password'
642
+ })
643
+ ;(manager as any).passwordRetriever = customPasswordRetriever
644
+
645
+ // New-user flow (no existing token)
646
+ ;(mockUMPTokenInteractor.findByPresentationKeyHash as any).mockResolvedValueOnce(undefined)
647
+ await manager.providePresentationKey(presentationKey)
648
+ await manager.providePassword('test-password')
649
+
650
+ // Clear any calls recorded during authentication.
651
+ customPasswordRetriever.mockClear()
652
+
653
+ // Call the underlying privileged key manager’s decrypt twice.
654
+ // (For example, we use the ciphertext from one of the token’s encrypted fields.)
655
+ await (manager as any).rootPrivilegedKeyManager.decrypt({
656
+ ciphertext: (manager as any).currentUMPToken.passwordKeyEncrypted,
657
+ protocolID: [2, 'admin key wrapping'],
658
+ keyID: '1'
659
+ })
660
+
661
+ // Key expires after 2 minutes
662
+ jest.advanceTimersByTime(121_000)
663
+
664
+ await (manager as any).rootPrivilegedKeyManager.decrypt({
665
+ ciphertext: (manager as any).currentUMPToken.passwordKeyEncrypted,
666
+ protocolID: [2, 'admin key wrapping'],
667
+ keyID: '1'
668
+ })
669
+
670
+ // Since no ephemeral privileged key was provided when building the underlying wallet,
671
+ // each call to decrypt should have resulted in a call to passwordRetriever.
672
+ expect(customPasswordRetriever).toHaveBeenCalledTimes(2)
673
+ })
674
+ })
675
+ })