@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,738 @@
1
+ import { PrivilegedKeyManager } from '../PrivilegedKeyManager'
2
+ import { Utils, PrivateKey, Hash, Random } from '@bsv/sdk'
3
+
4
+ const sampleData = [3, 1, 4, 1, 5, 9]
5
+
6
+ // A helper function to get a 32-byte hex
7
+ function getRandom32ByteHex(): string {
8
+ const rawBytes = Random(32)
9
+ return Utils.toHex(rawBytes)
10
+ }
11
+
12
+ describe('PrivilegedKeyManager', () => {
13
+ it('Validates the BRC-3 compliance vector', async () => {
14
+ const wallet = new PrivilegedKeyManager(async () => new PrivateKey(1))
15
+ const { valid } = await wallet.verifySignature({
16
+ data: Utils.toArray('BRC-3 Compliance Validated!', 'utf8'),
17
+ signature: [
18
+ 48, 68, 2, 32, 43, 34, 58, 156, 219, 32, 50, 70, 29, 240, 155, 137, 88, 60, 200, 95, 243, 198, 201, 21, 56, 82,
19
+ 141, 112, 69, 196, 170, 73, 156, 6, 44, 48, 2, 32, 118, 125, 254, 201, 44, 87, 177, 170, 93, 11, 193, 134, 18,
20
+ 70, 9, 31, 234, 27, 170, 177, 54, 96, 181, 140, 166, 196, 144, 14, 230, 118, 106, 105
21
+ ],
22
+ protocolID: [2, 'BRC3 Test'],
23
+ keyID: '42',
24
+ counterparty: '0294c479f762f6baa97fbcd4393564c1d7bd8336ebd15928135bbcf575cd1a71a1'
25
+ })
26
+ expect(valid).toBe(true)
27
+ await wallet.destroyKey()
28
+ })
29
+ it('Validates the BRC-2 HMAC compliance vector', async () => {
30
+ const wallet = new PrivilegedKeyManager(
31
+ async () => new PrivateKey('6a2991c9de20e38b31d7ea147bf55f5039e4bbc073160f5e0d541d1f17e321b8', 'hex')
32
+ )
33
+ const { valid } = await wallet.verifyHmac({
34
+ data: Utils.toArray('BRC-2 HMAC Compliance Validated!', 'utf8'),
35
+ hmac: [
36
+ 81, 240, 18, 153, 163, 45, 174, 85, 9, 246, 142, 125, 209, 133, 82, 76, 254, 103, 46, 182, 86, 59, 219, 61, 126,
37
+ 30, 176, 232, 233, 100, 234, 14
38
+ ],
39
+ protocolID: [2, 'BRC2 Test'],
40
+ keyID: '42',
41
+ counterparty: '0294c479f762f6baa97fbcd4393564c1d7bd8336ebd15928135bbcf575cd1a71a1'
42
+ })
43
+ expect(valid).toBe(true)
44
+ await wallet.destroyKey()
45
+ })
46
+ it('Validates the BRC-2 Encryption compliance vector', async () => {
47
+ const wallet = new PrivilegedKeyManager(
48
+ async () => new PrivateKey('6a2991c9de20e38b31d7ea147bf55f5039e4bbc073160f5e0d541d1f17e321b8', 'hex')
49
+ )
50
+ const { plaintext } = await wallet.decrypt({
51
+ ciphertext: [
52
+ 252, 203, 216, 184, 29, 161, 223, 212, 16, 193, 94, 99, 31, 140, 99, 43, 61, 236, 184, 67, 54, 105, 199, 47, 11,
53
+ 19, 184, 127, 2, 165, 125, 9, 188, 195, 196, 39, 120, 130, 213, 95, 186, 89, 64, 28, 1, 80, 20, 213, 159, 133,
54
+ 98, 253, 128, 105, 113, 247, 197, 152, 236, 64, 166, 207, 113, 134, 65, 38, 58, 24, 127, 145, 140, 206, 47, 70,
55
+ 146, 84, 186, 72, 95, 35, 154, 112, 178, 55, 72, 124
56
+ ],
57
+ protocolID: [2, 'BRC2 Test'],
58
+ keyID: '42',
59
+ counterparty: '0294c479f762f6baa97fbcd4393564c1d7bd8336ebd15928135bbcf575cd1a71a1'
60
+ })
61
+ expect(Utils.toUTF8(plaintext)).toEqual('BRC-2 Encryption Compliance Validated!')
62
+ await wallet.destroyKey()
63
+ })
64
+ it('Encrypts messages decryptable by the counterparty', async () => {
65
+ const userKey = PrivateKey.fromRandom()
66
+ const counterpartyKey = PrivateKey.fromRandom()
67
+ const user = new PrivilegedKeyManager(async () => userKey)
68
+ const counterparty = new PrivilegedKeyManager(async () => counterpartyKey)
69
+ const { ciphertext } = await user.encrypt({
70
+ plaintext: sampleData,
71
+ protocolID: [2, 'tests'],
72
+ keyID: '4',
73
+ counterparty: counterpartyKey.toPublicKey().toString()
74
+ })
75
+ const { plaintext } = await counterparty.decrypt({
76
+ ciphertext,
77
+ protocolID: [2, 'tests'],
78
+ keyID: '4',
79
+ counterparty: userKey.toPublicKey().toString()
80
+ })
81
+ expect(plaintext).toEqual(sampleData)
82
+ expect(ciphertext).not.toEqual(plaintext)
83
+ await user.destroyKey()
84
+ await counterparty.destroyKey()
85
+ })
86
+ it('Fails to decryupt messages for the wrong protocol, key, and counterparty', async () => {
87
+ const userKey = PrivateKey.fromRandom()
88
+ const counterpartyKey = PrivateKey.fromRandom()
89
+ const user = new PrivilegedKeyManager(async () => userKey)
90
+ const counterparty = new PrivilegedKeyManager(async () => counterpartyKey)
91
+ const { ciphertext } = await user.encrypt({
92
+ plaintext: sampleData,
93
+ protocolID: [2, 'tests'],
94
+ keyID: '4',
95
+ counterparty: counterpartyKey.toPublicKey().toString()
96
+ })
97
+ await expect(
98
+ async () =>
99
+ await counterparty.decrypt({
100
+ ciphertext,
101
+ protocolID: [1, 'tests'],
102
+ keyID: '4',
103
+ counterparty: userKey.toPublicKey().toString()
104
+ })
105
+ ).rejects.toThrow()
106
+ await expect(
107
+ async () =>
108
+ await counterparty.decrypt({
109
+ ciphertext,
110
+ protocolID: [2, 'tests'],
111
+ keyID: '5',
112
+ counterparty: userKey.toPublicKey().toString()
113
+ })
114
+ ).rejects.toThrow()
115
+ await expect(
116
+ async () =>
117
+ await counterparty.decrypt({
118
+ ciphertext,
119
+ protocolID: [2, 'tests'],
120
+ keyID: '4',
121
+ counterparty: counterpartyKey.toPublicKey().toString()
122
+ })
123
+ ).rejects.toThrow()
124
+ await user.destroyKey()
125
+ await counterparty.destroyKey()
126
+ })
127
+ it('Correctly derives keys for a counterparty', async () => {
128
+ const userKey = PrivateKey.fromRandom()
129
+ const counterpartyKey = PrivateKey.fromRandom()
130
+ const user = new PrivilegedKeyManager(async () => userKey)
131
+ const counterparty = new PrivilegedKeyManager(async () => counterpartyKey)
132
+ const { publicKey: identityKey } = await user.getPublicKey({
133
+ identityKey: true
134
+ })
135
+ expect(identityKey).toEqual(userKey.toPublicKey().toString())
136
+ const { publicKey: derivedForCounterparty } = await user.getPublicKey({
137
+ protocolID: [2, 'tests'],
138
+ keyID: '4',
139
+ counterparty: counterpartyKey.toPublicKey().toString()
140
+ })
141
+ const { publicKey: derivedByCounterparty } = await counterparty.getPublicKey({
142
+ protocolID: [2, 'tests'],
143
+ keyID: '4',
144
+ counterparty: userKey.toPublicKey().toString(),
145
+ forSelf: true
146
+ })
147
+ expect(derivedForCounterparty).toEqual(derivedByCounterparty)
148
+ await user.destroyKey()
149
+ await counterparty.destroyKey()
150
+ })
151
+ it('Signs messages verifiable by the counterparty', async () => {
152
+ const userKey = PrivateKey.fromRandom()
153
+ const counterpartyKey = PrivateKey.fromRandom()
154
+ const user = new PrivilegedKeyManager(async () => userKey)
155
+ const counterparty = new PrivilegedKeyManager(async () => counterpartyKey)
156
+ const { signature } = await user.createSignature({
157
+ data: sampleData,
158
+ protocolID: [2, 'tests'],
159
+ keyID: '4',
160
+ counterparty: counterpartyKey.toPublicKey().toString()
161
+ })
162
+ const { valid } = await counterparty.verifySignature({
163
+ signature,
164
+ data: sampleData,
165
+ protocolID: [2, 'tests'],
166
+ keyID: '4',
167
+ counterparty: userKey.toPublicKey().toString()
168
+ })
169
+ expect(valid).toEqual(true)
170
+ expect(signature.length).not.toEqual(0)
171
+ await user.destroyKey()
172
+ await counterparty.destroyKey()
173
+ })
174
+ it('Directly signs hash of message verifiable by the counterparty', async () => {
175
+ const userKey = PrivateKey.fromRandom()
176
+ const counterpartyKey = PrivateKey.fromRandom()
177
+ const user = new PrivilegedKeyManager(async () => userKey)
178
+ const counterparty = new PrivilegedKeyManager(async () => counterpartyKey)
179
+ const { signature } = await user.createSignature({
180
+ hashToDirectlySign: Hash.sha256(sampleData),
181
+ protocolID: [2, 'tests'],
182
+ keyID: '4',
183
+ counterparty: counterpartyKey.toPublicKey().toString()
184
+ })
185
+ const { valid } = await counterparty.verifySignature({
186
+ signature,
187
+ data: sampleData,
188
+ protocolID: [2, 'tests'],
189
+ keyID: '4',
190
+ counterparty: userKey.toPublicKey().toString()
191
+ })
192
+ expect(valid).toEqual(true)
193
+ const { valid: hashValid } = await counterparty.verifySignature({
194
+ signature,
195
+ hashToDirectlyVerify: Hash.sha256(sampleData),
196
+ protocolID: [2, 'tests'],
197
+ keyID: '4',
198
+ counterparty: userKey.toPublicKey().toString()
199
+ })
200
+ expect(hashValid).toEqual(true)
201
+ expect(signature.length).not.toEqual(0)
202
+ await user.destroyKey()
203
+ await counterparty.destroyKey()
204
+ })
205
+ it('Fails to verify signature for the wrong data, protocol, key, and counterparty', async () => {
206
+ const userKey = PrivateKey.fromRandom()
207
+ const counterpartyKey = PrivateKey.fromRandom()
208
+ const user = new PrivilegedKeyManager(async () => userKey)
209
+ const counterparty = new PrivilegedKeyManager(async () => counterpartyKey)
210
+ const { signature } = await user.createSignature({
211
+ data: sampleData,
212
+ protocolID: [2, 'tests'],
213
+ keyID: '4',
214
+ counterparty: counterpartyKey.toPublicKey().toString()
215
+ })
216
+ await expect(
217
+ async () =>
218
+ await counterparty.verifySignature({
219
+ signature,
220
+ data: [0, ...sampleData],
221
+ protocolID: [2, 'tests'],
222
+ keyID: '4',
223
+ counterparty: userKey.toPublicKey().toString()
224
+ })
225
+ ).rejects.toThrow()
226
+ await expect(
227
+ async () =>
228
+ await counterparty.verifySignature({
229
+ signature,
230
+ data: sampleData,
231
+ protocolID: [2, 'wrong'],
232
+ keyID: '4',
233
+ counterparty: userKey.toPublicKey().toString()
234
+ })
235
+ ).rejects.toThrow()
236
+ await expect(
237
+ async () =>
238
+ await counterparty.verifySignature({
239
+ signature,
240
+ data: sampleData,
241
+ protocolID: [2, 'tests'],
242
+ keyID: '2',
243
+ counterparty: userKey.toPublicKey().toString()
244
+ })
245
+ ).rejects.toThrow()
246
+ await expect(
247
+ async () =>
248
+ await counterparty.verifySignature({
249
+ signature,
250
+ data: sampleData,
251
+ protocolID: [2, 'tests'],
252
+ keyID: '4',
253
+ counterparty: counterpartyKey.toPublicKey().toString()
254
+ })
255
+ ).rejects.toThrow()
256
+ await user.destroyKey()
257
+ await counterparty.destroyKey()
258
+ })
259
+ it('Computes HMAC over messages verifiable by the counterparty', async () => {
260
+ const userKey = PrivateKey.fromRandom()
261
+ const counterpartyKey = PrivateKey.fromRandom()
262
+ const user = new PrivilegedKeyManager(async () => userKey)
263
+ const counterparty = new PrivilegedKeyManager(async () => counterpartyKey)
264
+ const { hmac } = await user.createHmac({
265
+ data: sampleData,
266
+ protocolID: [2, 'tests'],
267
+ keyID: '4',
268
+ counterparty: counterpartyKey.toPublicKey().toString()
269
+ })
270
+ const { valid } = await counterparty.verifyHmac({
271
+ hmac,
272
+ data: sampleData,
273
+ protocolID: [2, 'tests'],
274
+ keyID: '4',
275
+ counterparty: userKey.toPublicKey().toString()
276
+ })
277
+ expect(valid).toEqual(true)
278
+ expect(hmac.length).toEqual(32)
279
+ await user.destroyKey()
280
+ await counterparty.destroyKey()
281
+ })
282
+ it('Fails to verify HMAC for the wrong data, protocol, key, and counterparty', async () => {
283
+ const userKey = PrivateKey.fromRandom()
284
+ const counterpartyKey = PrivateKey.fromRandom()
285
+ const user = new PrivilegedKeyManager(async () => userKey)
286
+ const counterparty = new PrivilegedKeyManager(async () => counterpartyKey)
287
+ const { hmac } = await user.createHmac({
288
+ data: sampleData,
289
+ protocolID: [2, 'tests'],
290
+ keyID: '4',
291
+ counterparty: counterpartyKey.toPublicKey().toString()
292
+ })
293
+ await expect(
294
+ async () =>
295
+ await counterparty.verifyHmac({
296
+ hmac,
297
+ data: [0, ...sampleData],
298
+ protocolID: [2, 'tests'],
299
+ keyID: '4',
300
+ counterparty: userKey.toPublicKey().toString()
301
+ })
302
+ ).rejects.toThrow()
303
+ await expect(
304
+ async () =>
305
+ await counterparty.verifyHmac({
306
+ hmac,
307
+ data: sampleData,
308
+ protocolID: [2, 'wrong'],
309
+ keyID: '4',
310
+ counterparty: userKey.toPublicKey().toString()
311
+ })
312
+ ).rejects.toThrow()
313
+ await expect(
314
+ async () =>
315
+ await counterparty.verifyHmac({
316
+ hmac,
317
+ data: sampleData,
318
+ protocolID: [2, 'tests'],
319
+ keyID: '2',
320
+ counterparty: userKey.toPublicKey().toString()
321
+ })
322
+ ).rejects.toThrow()
323
+ await expect(
324
+ async () =>
325
+ await counterparty.verifyHmac({
326
+ hmac,
327
+ data: sampleData,
328
+ protocolID: [2, 'tests'],
329
+ keyID: '4',
330
+ counterparty: counterpartyKey.toPublicKey().toString()
331
+ })
332
+ ).rejects.toThrow()
333
+ await user.destroyKey()
334
+ await counterparty.destroyKey()
335
+ })
336
+ it('Uses anyone for creating signatures and self for other operations if no counterparty is provided', async () => {
337
+ const userKey = PrivateKey.fromRandom()
338
+ const user = new PrivilegedKeyManager(async () => userKey)
339
+ const { hmac } = await user.createHmac({
340
+ data: sampleData,
341
+ protocolID: [2, 'tests'],
342
+ keyID: '4'
343
+ })
344
+ const { valid: hmacValid } = await user.verifyHmac({
345
+ hmac,
346
+ data: sampleData,
347
+ protocolID: [2, 'tests'],
348
+ keyID: '4'
349
+ })
350
+ expect(hmacValid).toEqual(true)
351
+ const { valid: explicitSelfHmacValid } = await user.verifyHmac({
352
+ hmac,
353
+ data: sampleData,
354
+ protocolID: [2, 'tests'],
355
+ keyID: '4',
356
+ counterparty: 'self'
357
+ })
358
+ expect(explicitSelfHmacValid).toEqual(true)
359
+ expect(hmac.length).toEqual(32)
360
+ const { signature: anyoneSig } = await user.createSignature({
361
+ data: sampleData,
362
+ protocolID: [2, 'tests'],
363
+ keyID: '4'
364
+ // counterparty=anyone is implicit for creating signatures
365
+ })
366
+ const anyone = new PrivilegedKeyManager(async () => new PrivateKey(1))
367
+ const { valid: anyoneSigValid } = await anyone.verifySignature({
368
+ signature: anyoneSig,
369
+ data: sampleData,
370
+ protocolID: [2, 'tests'],
371
+ keyID: '4',
372
+ counterparty: userKey.toPublicKey().toString()
373
+ })
374
+ expect(anyoneSigValid).toEqual(true)
375
+ const { signature: selfSig } = await user.createSignature({
376
+ data: sampleData,
377
+ protocolID: [2, 'tests'],
378
+ keyID: '4',
379
+ counterparty: 'self'
380
+ })
381
+ const { valid: selfSigValid } = await user.verifySignature({
382
+ signature: selfSig,
383
+ data: sampleData,
384
+ protocolID: [2, 'tests'],
385
+ keyID: '4'
386
+ // Self is implicit when verifying signatures
387
+ })
388
+ expect(selfSigValid).toEqual(true)
389
+ const { valid: explicitSelfSigValid } = await user.verifySignature({
390
+ signature: selfSig,
391
+ data: sampleData,
392
+ protocolID: [2, 'tests'],
393
+ keyID: '4',
394
+ counterparty: 'self'
395
+ })
396
+ expect(explicitSelfSigValid).toEqual(true)
397
+ const { publicKey } = await user.getPublicKey({
398
+ protocolID: [2, 'tests'],
399
+ keyID: '4'
400
+ })
401
+ const { publicKey: explicitSelfPublicKey } = await user.getPublicKey({
402
+ protocolID: [2, 'tests'],
403
+ keyID: '4',
404
+ counterparty: 'self'
405
+ })
406
+ expect(publicKey).toEqual(explicitSelfPublicKey)
407
+ const { ciphertext } = await user.encrypt({
408
+ plaintext: sampleData,
409
+ protocolID: [2, 'tests'],
410
+ keyID: '4'
411
+ })
412
+ const { plaintext } = await user.decrypt({
413
+ ciphertext,
414
+ protocolID: [2, 'tests'],
415
+ keyID: '4'
416
+ })
417
+ const { plaintext: explicitSelfPlaintext } = await user.decrypt({
418
+ ciphertext,
419
+ protocolID: [2, 'tests'],
420
+ keyID: '4',
421
+ counterparty: 'self'
422
+ })
423
+ expect(plaintext).toEqual(explicitSelfPlaintext)
424
+ expect(plaintext).toEqual(sampleData)
425
+ await user.destroyKey()
426
+ await anyone.destroyKey()
427
+ })
428
+ describe('PrivilegedKeyManager Key Linkage Revelation', () => {
429
+ it('Validates the revealCounterpartyKeyLinkage function', async () => {
430
+ // Initialize keys
431
+ const proverKey = PrivateKey.fromRandom()
432
+ const counterpartyKey = PrivateKey.fromRandom()
433
+ const verifierKey = PrivateKey.fromRandom()
434
+
435
+ // Initialize wallets
436
+ const proverWallet = new PrivilegedKeyManager(async () => proverKey)
437
+ const verifierWallet = new PrivilegedKeyManager(async () => verifierKey)
438
+
439
+ // Prover reveals counterparty key linkage
440
+ const revelation = await proverWallet.revealCounterpartyKeyLinkage({
441
+ counterparty: counterpartyKey.toPublicKey().toString(),
442
+ verifier: verifierKey.toPublicKey().toString()
443
+ })
444
+
445
+ // Verifier decrypts the encrypted linkage
446
+ const { plaintext: linkage } = await verifierWallet.decrypt({
447
+ ciphertext: revelation.encryptedLinkage,
448
+ protocolID: [2, 'counterparty linkage revelation'],
449
+ keyID: revelation.revelationTime,
450
+ counterparty: proverKey.toPublicKey().toString()
451
+ })
452
+
453
+ // Compute expected linkage
454
+ const expectedLinkage = proverKey.deriveSharedSecret(counterpartyKey.toPublicKey()).encode(true)
455
+
456
+ // Compare linkage and expectedLinkage
457
+ expect(linkage).toEqual(expectedLinkage)
458
+ await proverWallet.destroyKey()
459
+ await verifierWallet.destroyKey()
460
+ })
461
+
462
+ it('Validates the revealSpecificKeyLinkage function', async () => {
463
+ // Initialize keys
464
+ const proverKey = PrivateKey.fromRandom()
465
+ const counterpartyKey = PrivateKey.fromRandom()
466
+ const verifierKey = PrivateKey.fromRandom()
467
+
468
+ // Initialize wallets
469
+ const proverWallet = new PrivilegedKeyManager(async () => proverKey)
470
+ const verifierWallet = new PrivilegedKeyManager(async () => verifierKey)
471
+
472
+ const protocolID: [0 | 1 | 2, string] = [0, 'tests']
473
+ const keyID = 'test key id'
474
+
475
+ // Prover reveals specific key linkage
476
+ const revelation = await proverWallet.revealSpecificKeyLinkage({
477
+ counterparty: counterpartyKey.toPublicKey().toString(),
478
+ verifier: verifierKey.toPublicKey().toString(),
479
+ protocolID,
480
+ keyID
481
+ })
482
+
483
+ // Verifier decrypts the encrypted linkage
484
+ const { plaintext: linkage } = await verifierWallet.decrypt({
485
+ ciphertext: revelation.encryptedLinkage,
486
+ protocolID: [2, `specific linkage revelation ${protocolID[0]} ${protocolID[1]}`],
487
+ keyID,
488
+ counterparty: proverKey.toPublicKey().toString()
489
+ })
490
+
491
+ // Compute expected linkage
492
+ const sharedSecret = proverKey.deriveSharedSecret(counterpartyKey.toPublicKey()).encode(true)
493
+
494
+ // Function to compute the invoice number
495
+ const computeInvoiceNumber = function (protocolID, keyID) {
496
+ const securityLevel = protocolID[0]
497
+ if (!Number.isInteger(securityLevel) || securityLevel < 0 || securityLevel > 2) {
498
+ throw new Error('Protocol security level must be 0, 1, or 2')
499
+ }
500
+ const protocolName = protocolID[1].toLowerCase().trim()
501
+ if (keyID.length > 800) {
502
+ throw new Error('Key IDs must be 800 characters or less')
503
+ }
504
+ if (keyID.length < 1) {
505
+ throw new Error('Key IDs must be 1 character or more')
506
+ }
507
+ if (protocolName.length > 400) {
508
+ throw new Error('Protocol names must be 400 characters or less')
509
+ }
510
+ if (protocolName.length < 5) {
511
+ throw new Error('Protocol names must be 5 characters or more')
512
+ }
513
+ if (protocolName.includes(' ')) {
514
+ throw new Error('Protocol names cannot contain multiple consecutive spaces (" ")')
515
+ }
516
+ if (!/^[a-z0-9 ]+$/g.test(protocolName)) {
517
+ throw new Error('Protocol names can only contain letters, numbers and spaces')
518
+ }
519
+ if (protocolName.endsWith(' protocol')) {
520
+ throw new Error('No need to end your protocol name with " protocol"')
521
+ }
522
+ return `${securityLevel}-${protocolName}-${keyID}`
523
+ }
524
+ const invoiceNumber = computeInvoiceNumber(protocolID, keyID)
525
+ const invoiceNumberBin = Utils.toArray(invoiceNumber, 'utf8')
526
+
527
+ // Compute expected linkage
528
+ const expectedLinkage = Hash.sha256hmac(sharedSecret, invoiceNumberBin)
529
+
530
+ // Compare linkage and expectedLinkage
531
+ expect(linkage).toEqual(expectedLinkage)
532
+
533
+ await proverWallet.destroyKey()
534
+ await verifierWallet.destroyKey()
535
+ })
536
+ })
537
+ describe('PrivilegedKeyManager - Internal Logic Tests', () => {
538
+ beforeEach(() => {
539
+ jest.useFakeTimers()
540
+ })
541
+ afterEach(() => {
542
+ jest.clearAllTimers()
543
+ jest.useRealTimers()
544
+ })
545
+ it('Calls keyGetter only once if getPrivilegedKey is invoked multiple times within retention period', async () => {
546
+ // Create a mock keyGetter that returns a PrivateKey
547
+ const keyGetterMock = jest.fn(async (reason: string) => {
548
+ return new PrivateKey(getRandom32ByteHex(), 'hex')
549
+ })
550
+
551
+ // Retention period is 100 ms for testing
552
+ const km = new PrivilegedKeyManager(keyGetterMock, 100)
553
+
554
+ // 1) First call, should call keyGetter once
555
+ const key1 = await (km as any).getPrivilegedKey('first reason')
556
+ expect(keyGetterMock).toHaveBeenCalledTimes(1)
557
+
558
+ // 2) Second call, if within retention, should NOT call keyGetter again
559
+ const key2 = await (km as any).getPrivilegedKey('second reason')
560
+ expect(keyGetterMock).toHaveBeenCalledTimes(1)
561
+
562
+ // 3) Check that both keys match the same underlying private key
563
+ expect(key1.toHex()).toBe(key2.toHex())
564
+ await km.destroyKey()
565
+ })
566
+
567
+ it('Destroys key after retention period elapses', async () => {
568
+ const keyGetterMock = jest.fn(async (reason: string) => {
569
+ return new PrivateKey(getRandom32ByteHex(), 'hex')
570
+ })
571
+
572
+ const retentionMs = 200
573
+ const km = new PrivilegedKeyManager(keyGetterMock, retentionMs)
574
+
575
+ // Acquire the key
576
+ await (km as any).getPrivilegedKey('test reason')
577
+
578
+ // We have chunkPropNames set
579
+ expect((km as any).chunkPropNames.length).toBeGreaterThan(0)
580
+
581
+ // Fast-forward time beyond the retention period
582
+ jest.advanceTimersByTime(retentionMs + 1)
583
+
584
+ // The destroyKey logic should have run
585
+ expect((km as any).chunkPropNames.length).toBe(0)
586
+ expect((km as any).chunkPadPropNames.length).toBe(0)
587
+ expect((km as any).decoyPropNamesDestroy.length).toBe(0)
588
+ await km.destroyKey()
589
+ })
590
+
591
+ it('Explicitly calls destroyKey() and removes all chunk properties', async () => {
592
+ const keyGetterMock = jest.fn(async (reason: string) => {
593
+ return new PrivateKey(getRandom32ByteHex(), 'hex')
594
+ })
595
+ const km = new PrivilegedKeyManager(keyGetterMock, 5000)
596
+
597
+ // Acquire the key
598
+ await (km as any).getPrivilegedKey('destroy test')
599
+
600
+ // Verify chunk props exist
601
+ expect((km as any).chunkPropNames.length).toBeGreaterThan(0)
602
+ expect((km as any).chunkPadPropNames.length).toBeGreaterThan(0)
603
+
604
+ // Explicitly call destroyKey
605
+ ;(km as any).destroyKey()
606
+
607
+ // Now chunkPropNames and chunkPadPropNames should be cleared
608
+ expect((km as any).chunkPropNames.length).toBe(0)
609
+ expect((km as any).chunkPadPropNames.length).toBe(0)
610
+ await km.destroyKey()
611
+ })
612
+
613
+ it('Reuses in-memory obfuscated key if data is valid, otherwise fetches a new key', async () => {
614
+ const mockHex = getRandom32ByteHex()
615
+ const keyGetterMock = jest.fn(async () => new PrivateKey(mockHex, 'hex'))
616
+
617
+ const km = new PrivilegedKeyManager(keyGetterMock, 5000)
618
+
619
+ // 1) First retrieval => calls keyGetter
620
+ const key1 = await (km as any).getPrivilegedKey('reuse test')
621
+ expect(keyGetterMock).toHaveBeenCalledTimes(1)
622
+ expect(key1.toHex()).toBe(mockHex)
623
+
624
+ // 2) Tamper with chunk data so reassembleKeyFromChunks returns null
625
+ // We can zero out one chunk or remove it
626
+ ;(km as any)[(km as any).chunkPropNames[0]] = undefined
627
+
628
+ // 3) Second retrieval => chunk data is invalid => calls keyGetter again
629
+ const key2 = await (km as any).getPrivilegedKey('reuse test 2')
630
+ expect(keyGetterMock).toHaveBeenCalledTimes(2)
631
+ // The newly fetched key must still match mockHex,
632
+ // because the mock always returns the same key.
633
+ expect(key2.toHex()).toBe(mockHex)
634
+ await km.destroyKey()
635
+ })
636
+
637
+ it('Ensures chunk-splitting logic is correct for a 32-byte key', async () => {
638
+ const km = new PrivilegedKeyManager(async () => new PrivateKey(1), 5000)
639
+
640
+ const testBytes = new Uint8Array(32)
641
+ // Fill with some pattern, e.g. 0..31
642
+ testBytes.forEach((_, i) => {
643
+ testBytes[i] = i
644
+ })
645
+
646
+ const chunks = (km as any).splitKeyIntoChunks(testBytes)
647
+ expect(chunks.length).toBe((km as any).CHUNK_COUNT)
648
+
649
+ // By default CHUNK_COUNT = 4
650
+ // Typically each chunk would be 8 bytes (for a 32-byte key).
651
+ chunks.forEach((chunk: Uint8Array, i: number) => {
652
+ if (i < 3) {
653
+ expect(chunk.length).toBe(8)
654
+ } else {
655
+ // last chunk picks up leftover
656
+ expect(chunk.length).toBe(8)
657
+ }
658
+ })
659
+
660
+ // Reassemble logic typically is done by reassembleKeyFromChunks,
661
+ // but let's test it in isolation. We'll XOR with random pads,
662
+ // store them, reassemble, etc.
663
+
664
+ // For demonstration, we can do a quick test:
665
+ const pad = chunks.map((c: Uint8Array) => Uint8Array.from(Random(c.length)))
666
+ const obfuscated = chunks.map((c: Uint8Array, i: number) => (km as any).xorBytes(c, pad[i]))
667
+
668
+ // Then "store" and reassemble
669
+ ;(km as any).chunkPropNames = []
670
+ ;(km as any).chunkPadPropNames = []
671
+ obfuscated.forEach((obf: Uint8Array, i: number) => {
672
+ const chunkProp = `chunk${i}`
673
+ const padProp = `pad${i}`
674
+ ;(km as any).chunkPropNames.push(chunkProp)
675
+ ;(km as any).chunkPadPropNames.push(padProp)
676
+ ;(km as any)[chunkProp] = obf
677
+ ;(km as any)[padProp] = pad[i]
678
+ })
679
+ const reassembled = (km as any).reassembleKeyFromChunks()
680
+ expect(reassembled.length).toBe(32)
681
+ expect(Array.from(reassembled)).toEqual(Array.from(testBytes))
682
+ await km.destroyKey()
683
+ })
684
+
685
+ it('XOR function works as expected', async () => {
686
+ const km = new PrivilegedKeyManager(async () => new PrivateKey(1), 5000)
687
+ const a = Uint8Array.from([0, 1, 255])
688
+ const b = Uint8Array.from([255, 1, 0])
689
+
690
+ const result = (km as any).xorBytes(a, b)
691
+ // 0 ^ 255 = 255, 1 ^ 1 = 0, 255 ^ 0 = 255
692
+ expect(Array.from(result)).toEqual([255, 0, 255])
693
+
694
+ // XOR with zero array => same array
695
+ const zero = new Uint8Array(3)
696
+ const result2 = (km as any).xorBytes(a, zero)
697
+ expect(Array.from(result2)).toEqual([0, 1, 255])
698
+ await km.destroyKey()
699
+ })
700
+
701
+ it('Generates random property names', async () => {
702
+ const km = new PrivilegedKeyManager(async () => new PrivateKey(1), 5000)
703
+ const prop1 = (km as any).generateRandomPropName()
704
+ const prop2 = (km as any).generateRandomPropName()
705
+ expect(prop1).not.toBe(prop2)
706
+ // Just check format (roughly)
707
+ expect(prop1).toMatch(/^_[0-9a-f]{8}_[0-9]{1,6}$/)
708
+ expect(prop2).toMatch(/^_[0-9a-f]{8}_[0-9]{1,6}$/)
709
+ await km.destroyKey()
710
+ })
711
+
712
+ it('Sets up initial decoy properties in the constructor', async () => {
713
+ const km = new PrivilegedKeyManager(async () => new PrivateKey(1), 5000)
714
+ // decoyPropNamesRemain has length 2
715
+ expect((km as any).decoyPropNamesRemain.length).toBe(2)
716
+ // Validate those properties actually exist on the object
717
+ for (const propName of (km as any).decoyPropNamesRemain) {
718
+ expect((km as any)[propName]).toBeInstanceOf(Uint8Array)
719
+ expect((km as any)[propName].length).toBe(16)
720
+ }
721
+ await km.destroyKey()
722
+ })
723
+
724
+ it('New decoy properties are created on each key fetch and destroyed on destroy', async () => {
725
+ const km = new PrivilegedKeyManager(async () => new PrivateKey(1), 5000)
726
+ await (km as any).getPrivilegedKey('decoy test')
727
+
728
+ // We should have 2 decoy props that remain, plus 2 that are "destroyable"
729
+ expect((km as any).decoyPropNamesRemain.length).toBe(2)
730
+ expect((km as any).decoyPropNamesDestroy.length).toBe(2)
731
+
732
+ // Destroy them
733
+ ;(km as any).destroyKey()
734
+ expect((km as any).decoyPropNamesDestroy.length).toBe(0)
735
+ await km.destroyKey()
736
+ })
737
+ })
738
+ })