@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,20 @@
1
+ export const randomValsUsed1 = [
2
+ 0.3145996888882596, 0.45719282963580565, 0.8555247776688835, 0.2649974738591665, 0.7381622959747749,
3
+ 0.1945477495382142, 0.5032123391994598, 0.02861436749749835, 0.7999598138479351, 0.8979243255586506,
4
+ 0.9034507043487272, 0.4280218402928029, 0.6358932443326806, 0.30173236243173585, 0.3598078135029954,
5
+ 0.9870248947111777, 0.2675337664781172, 0.6050300757408575, 0.7391162382709817, 0.8727502788995358,
6
+ 0.36799576712472737, 0.6604956576157504, 0.1702104642469362, 0.7797698104303106, 0.08655953134554961,
7
+ 0.2847318171161146, 0.07534328732698126, 0.9009525464087105, 0.5264602243751411, 0.866180150709631,
8
+ 0.5813059581773354, 0.3348084822567492, 0.5668720381665056, 0.03296403051210928, 0.8225656781470101,
9
+ 0.5321943190815006, 0.7708306957508375, 0.13417838069050525, 0.7763632653423949, 0.08160553045351926,
10
+ 0.45497831351884677, 0.13467302343886756, 0.21261951092011078, 0.04372527326966513, 0.7939708066933404,
11
+ 0.31542646439897015, 0.23821328607534542, 0.29505981550698746, 0.436696157907251, 0.8692456197556584,
12
+ 0.6851392295747836, 0.4203746637055583, 0.9959411956291628, 0.42200495673071803, 0.9174433944732405,
13
+ 0.7758897322425307, 0.3453529493770806, 0.15520421082199776, 0.4883039767344435, 0.45987000169072356,
14
+ 0.9146194455087437, 0.33743694585941686, 0.2725130478399085, 0.7058681732538112, 0.18975119489481007,
15
+ 0.46483529505143717, 0.5650362982181798, 0.48841275156927955, 0.8012266835493618, 0.2952784976832741,
16
+ 0.9823977685364349, 0.45683871241931007, 0.6008021097728846, 0.1405802039681765, 0.6968599380515865,
17
+ 0.3016840411555928, 0.8652691542976458, 0.5733994909626297, 0.288364714649364, 0.28178697025295385,
18
+ 0.02893432926139794, 0.6179746775758665, 0.35219485471542944, 0.97651703347549, 0.04012334579632282,
19
+ 0.3582381346512069, 0.5756199598871186, 0.11453606927098825
20
+ ]
@@ -0,0 +1,274 @@
1
+ import {
2
+ Beef,
3
+ BigNumber,
4
+ CreateActionArgs,
5
+ CreateActionInput,
6
+ CreateActionOptions,
7
+ Curve,
8
+ P2PKH,
9
+ PositiveIntegerOrZero,
10
+ PrivateKey,
11
+ SignActionArgs,
12
+ SignActionSpend,
13
+ Utils
14
+ } from '@bsv/sdk'
15
+ import { keyOffsetToHashedSecret, lockScriptWithKeyOffsetFromPubKey, offsetPrivKey, offsetPubKey } from '../offsetKey'
16
+ import { _tu, TestWalletOnly } from '../../../../test/utils/TestUtilsWalletStorage'
17
+ import { Setup } from '../../../Setup'
18
+ import { StorageKnex } from '../../StorageKnex'
19
+ import { FindCommissionsArgs, FindTransactionsArgs } from '../../../sdk'
20
+ import { verifyOne, verifyTruthy } from '../../../utility/utilityHelpers'
21
+ import { TableCommission } from '../../schema/tables/TableCommission'
22
+ import { WalletStorageManager } from '../../WalletStorageManager'
23
+
24
+ describe('offsetKey tests', () => {
25
+ jest.setTimeout(99999999)
26
+
27
+ test('1_offsetPrivKey', async () => {
28
+ const bn2 = BigNumber.fromHex('FFF0000000000000000000000000000000000000000000000000000000000100', 'big')
29
+
30
+ const priv2 = new PrivateKey(bn2)
31
+
32
+ const privKey2 = priv2.toWif()
33
+
34
+ const keyOffset = 'KyaVZ1AnxYN4oB8JnxYVyZ8xYC9ySpq2Umzx6jwzQGVo71k1EgSt'
35
+ const oPrivKey = 'KyMYVLNeyF4qQsgHW3N1eJv9WcRd2aZC8hw7iLgCojQsyizqKsV4'
36
+
37
+ const r12 = offsetPrivKey(privKey2, keyOffset)
38
+
39
+ expect(r12.keyOffset).toBe(keyOffset)
40
+
41
+ expect(r12.offsetPrivKey).toBe(oPrivKey)
42
+ })
43
+
44
+ test('2_offsetPubKey', async () => {
45
+ const bn2 = BigNumber.fromHex('FFF0000000000000000000000000000000000000000000000000000000000100', 'big')
46
+
47
+ const priv2 = new PrivateKey(bn2)
48
+
49
+ const pub2 = priv2.toPublicKey()
50
+
51
+ const keyOffset = 'KyaVZ1AnxYN4oB8JnxYVyZ8xYC9ySpq2Umzx6jwzQGVo71k1EgSt'
52
+ const oPrivKey = 'KyMYVLNeyF4qQsgHW3N1eJv9WcRd2aZC8hw7iLgCojQsyizqKsV4'
53
+ const oPubKey = '024b4362ce98e0afd22bf3319831cfaf691ad2f08471a3386bcda98d65435a0f24'
54
+
55
+ const r22 = offsetPubKey(pub2.toString(), keyOffset)
56
+
57
+ expect(r22.keyOffset).toBe(keyOffset)
58
+
59
+ expect(r22.offsetPubKey).toBe(oPubKey)
60
+
61
+ const pubKey2 = PrivateKey.fromWif(oPrivKey).toPublicKey().toString()
62
+
63
+ expect(pubKey2).toBe(oPubKey)
64
+ })
65
+
66
+ test('3_lockScriptWithKeyOffsetFromPubKey', async () => {
67
+ const pubKey = '0397742eaef6c7f08c4aa057397d45529f93ab90345b84ce5a5aac06ea9cdd132e'
68
+
69
+ const ko = 'Kx9MjojdkjL3bEo5tQwHpwT1voKN1z56NjpATsa2Sx6QTrVjgMQJ'
70
+ const script = '76a9149d09d0ee09b212c548f6b1a7835641f33654246788ac'
71
+
72
+ const r1 = lockScriptWithKeyOffsetFromPubKey(pubKey, ko)
73
+
74
+ expect(r1.script).toBe(script)
75
+ expect(r1.keyOffset).toBe(ko)
76
+
77
+ // And with a random keyOffset...
78
+ const r2 = lockScriptWithKeyOffsetFromPubKey(pubKey)
79
+
80
+ expect(r2.script).not.toBe(script)
81
+ expect(r2.keyOffset).not.toBe(ko)
82
+ })
83
+
84
+ test('4a_check keyOffset address', async () => {
85
+ if (_tu.noEnv('main')) return
86
+
87
+ const env = _tu.getEnv('main')
88
+ const privHex = env.devKeys[env.commissionsIdentity]!
89
+ const priv = PrivateKey.fromHex(privHex)
90
+ const pub = priv.toPublicKey()
91
+
92
+ const keyOffset = 'L2hMY5uW6Vh46DEFMzrYiKSFWDRSMGDTsaeDvhiKNNJGihwKD17w'
93
+
94
+ const r = offsetPrivKey(priv.toWif(), keyOffset)
95
+ const privO = PrivateKey.fromWif(r.offsetPrivKey)
96
+ const address = privO.toAddress()
97
+ expect(address).toBe('1EZz5oxwXoG6LgGLxeYPeg1NfzQrP1vL6M')
98
+ })
99
+
100
+ test('4_redeemServiceCharges', async () => {
101
+ if (_tu.noEnv('main')) return
102
+
103
+ const env = _tu.getEnv('main')
104
+ if (!env.devKeys[env.commissionsIdentity]) {
105
+ throw new Error('No dev key for commissions identity')
106
+ }
107
+
108
+ const knex = Setup.createMySQLKnex(process.env.MAIN_CLOUD_MYSQL_CONNECTION!)
109
+ const storage = new StorageKnex({
110
+ chain: env.chain,
111
+ knex: knex,
112
+ commissionSatoshis: 0,
113
+ commissionPubKeyHex: undefined,
114
+ feeModel: { model: 'sat/kb', value: 1 }
115
+ })
116
+
117
+ let setup: TestWalletOnly
118
+ await storage.makeAvailable()
119
+
120
+ setup = await _tu.createTestWalletWithStorageClient({
121
+ chain: 'main',
122
+ rootKeyHex: env.devKeys[env.commissionsIdentity]
123
+ })
124
+ storage.setServices(setup.services)
125
+
126
+ try {
127
+ // await setup.wallet.abortAction({ reference: 'e9c03bdf603e90ebe482044e8d0f7afbf2d6fe480a13dbd8689e2e5e5183bed4' })
128
+
129
+ // txid b6f72df4224efbacab42a16e1e88f48c217f03929c36987b9067d2556de47c10
130
+ // height 922107
131
+ // hash 00000000000000001957bfadf841d1709d5039b3243c33ba58e4a6a97b44d2a8
132
+ const sm = new WalletStorageManager(setup.identityKey, storage)
133
+ sm.setServices(setup.services)
134
+ await sm.reproveHeader('000000000000000014d97d19bf82956c1f7ce3977da10b7fbdab9a10653c02e7')
135
+
136
+ const comms: TableCommission[] = []
137
+ const beef = new Beef()
138
+ const chainTracker = await setup.services.getChainTracker()
139
+ const inputs: CreateActionInput[] = []
140
+
141
+ const fca: FindCommissionsArgs = {
142
+ partial: { isRedeemed: false },
143
+ paged: { limit: 200, offset: 0 }
144
+ }
145
+
146
+ for (; comms.length < fca.paged!.limit; ) {
147
+ const unredeemedComms = await storage.findCommissions(fca)
148
+ if (unredeemedComms.length === 0) break
149
+ for (const comm of unredeemedComms) {
150
+ const tt = verifyTruthy(await storage.findTransactionById(comm.transactionId, undefined, true))
151
+ if (tt.provenTxId && tt.txid) {
152
+ // Only add merge valid beefs...
153
+ try {
154
+ await storage.getBeefForTransaction(tt.txid, { mergeToBeef: beef, chainTracker })
155
+ } catch (e) {
156
+ // Ignore errors in merging beefs
157
+ }
158
+ const tx = verifyTruthy(beef.findTxid(tt.txid)).tx!
159
+ const commVOut = tx.outputs.findIndex(
160
+ o => o.satoshis === comm.satoshis && o.lockingScript.toHex() === Utils.toHex(comm.lockingScript)
161
+ )
162
+ const commOut = tx.outputs[commVOut]
163
+ const input: CreateActionInput = {
164
+ outpoint: `${tt.txid}.${commVOut}`,
165
+ inputDescription: `commId:${comm.commissionId}`,
166
+ unlockingScriptLength: 108
167
+ }
168
+ inputs.push(input)
169
+ comms.push(comm)
170
+ if (comms.length >= fca.paged!.limit) break
171
+ }
172
+ }
173
+ fca.paged!.offset! += unredeemedComms.length
174
+ }
175
+
176
+ if (comms.length > 0) {
177
+ console.log(beef.toLogString())
178
+ const verified = await beef.verify(await setup.services.getChainTracker(), false)
179
+ expect(verified).toBe(true)
180
+
181
+ const cao: CreateActionOptions = {
182
+ randomizeOutputs: false,
183
+ //signAndProcess: false,
184
+ noSend: true
185
+ }
186
+ const ca: CreateActionArgs = {
187
+ description: 'redeem commissions',
188
+ inputs: inputs,
189
+ inputBEEF: beef.toBinary(),
190
+ options: cao
191
+ }
192
+
193
+ const car = await setup.wallet.createAction(ca)
194
+ expect(car.signableTransaction).toBeTruthy()
195
+
196
+ const st = car.signableTransaction!
197
+ expect(st.reference).toBeTruthy()
198
+ const atomicBeef = Beef.fromBinary(st.tx)
199
+ const txid = atomicBeef.txs[atomicBeef.txs.length - 1].txid!
200
+ const tx = atomicBeef.findTransactionForSigning(txid)!
201
+
202
+ const priv = PrivateKey.fromHex(env.devKeys[env.commissionsIdentity])
203
+ const pub = priv.toPublicKey()
204
+ const curve = new Curve()
205
+ const p2pkh = new P2PKH()
206
+ const spends: Record<PositiveIntegerOrZero, SignActionSpend> = {}
207
+ let vin = 0
208
+ // set an unlockingScriptTemplate for each commission input being redeemed in unsigned tx
209
+ for (const comm of comms) {
210
+ const { hashedSecret } = keyOffsetToHashedSecret(pub, comm.keyOffset)
211
+ const bn = priv.add(hashedSecret).mod(curve.n)
212
+ const offsetPrivKey = new PrivateKey(bn)
213
+ const unlock = p2pkh.unlock(offsetPrivKey, 'all', false)
214
+ tx.inputs[vin].unlockingScriptTemplate = unlock
215
+ vin++
216
+ }
217
+
218
+ // sign each input
219
+ await tx.sign()
220
+
221
+ vin = 0
222
+ // extract all the signed unlocking scripts
223
+ for (const comm of comms) {
224
+ const script = tx.inputs[vin].unlockingScript!
225
+ const unlockingScript = script.toHex()
226
+ spends[vin] = { unlockingScript }
227
+ vin++
228
+ }
229
+
230
+ const signArgs: SignActionArgs = {
231
+ reference: st.reference,
232
+ spends,
233
+ options: {
234
+ returnTXIDOnly: true,
235
+ noSend: true
236
+ }
237
+ }
238
+
239
+ // Forward all the unlocking scripts to storage and create the ProvenTxReq for the noSend txid.
240
+ const sr = await setup.wallet.signAction(signArgs)
241
+ expect(sr.txid).toBeTruthy()
242
+
243
+ // Update the commissions as redeemed in storage
244
+ for (const comm of comms) {
245
+ await storage.updateCommission(comm.commissionId, { isRedeemed: true })
246
+ }
247
+
248
+ {
249
+ // Get the transaction broadcast
250
+ const createArgs: CreateActionArgs = {
251
+ description: `broadcasting noSend`,
252
+ options: {
253
+ acceptDelayedBroadcast: false,
254
+ sendWith: [sr.txid!]
255
+ }
256
+ }
257
+
258
+ const cr = await setup.wallet.createAction(createArgs)
259
+
260
+ expect(cr.noSendChange).not.toBeTruthy()
261
+ expect(cr.sendWithResults?.length).toBe(1)
262
+ const [swr] = cr.sendWithResults!
263
+ expect(swr.status !== 'failed').toBe(true)
264
+ }
265
+ }
266
+ } catch (err) {
267
+ console.error('Error in 4_redeemServiceCharges test:', err)
268
+ throw err
269
+ }
270
+
271
+ await storage.destroy()
272
+ await setup.wallet.destroy()
273
+ })
274
+ })
@@ -0,0 +1,389 @@
1
+ import { Beef, Transaction, WalletLoggerInterface } from '@bsv/sdk'
2
+ import { StorageProvider } from '../StorageProvider'
3
+ import { EntityProvenTxReq } from '../schema/entities'
4
+ import * as sdk from '../../sdk'
5
+ import { ReqHistoryNote } from '../../sdk'
6
+ import { wait } from '../../utility/utilityHelpers'
7
+
8
+ /**
9
+ * Attempt to post one or more `ProvenTxReq` with status 'unsent'
10
+ * to the bitcoin network.
11
+ *
12
+ * @param reqs
13
+ */
14
+ export async function attemptToPostReqsToNetwork(
15
+ storage: StorageProvider,
16
+ reqs: EntityProvenTxReq[],
17
+ trx?: sdk.TrxToken,
18
+ logger?: WalletLoggerInterface
19
+ ): Promise<PostReqsToNetworkResult> {
20
+ // initialize results, validate reqs ready to post, txids are of the transactions in the beef that we care about.
21
+
22
+ const { r, vreqs, txids } = await validateReqsAndMergeBeefs(storage, reqs, trx)
23
+ logger?.log(`validated request and merged beefs`)
24
+
25
+ const services = storage.getServices()
26
+
27
+ const pbrs = await services.postBeef(r.beef, txids, logger)
28
+
29
+ // post beef results (pbrs) is an array by service provider
30
+ // for each service provider, there's an aggregate result and individual results by txid.
31
+
32
+ await transferNotesToReqHistories(txids, vreqs, pbrs, storage, trx)
33
+
34
+ const apbrs = aggregatePostBeefResultsByTxid(txids, vreqs, pbrs)
35
+
36
+ await updateReqsFromAggregateResults(txids, r, apbrs, storage, services, trx, logger)
37
+
38
+ return r
39
+ }
40
+
41
+ async function validateReqsAndMergeBeefs(
42
+ storage: StorageProvider,
43
+ reqs: EntityProvenTxReq[],
44
+ trx?: sdk.TrxToken
45
+ ): Promise<{ r: PostReqsToNetworkResult; vreqs: PostReqsToNetworkDetails[]; txids: string[] }> {
46
+ const r: PostReqsToNetworkResult = {
47
+ status: 'success',
48
+ beef: new Beef(),
49
+ details: [],
50
+ log: ''
51
+ }
52
+
53
+ const vreqs: PostReqsToNetworkDetails[] = []
54
+
55
+ for (const req of reqs) {
56
+ try {
57
+ const noRawTx = !req.rawTx
58
+ const noTxIds = !req.notify.transactionIds || req.notify.transactionIds.length < 1
59
+ const noInputBEEF = !req.inputBEEF
60
+ if (noRawTx || noTxIds || noInputBEEF) {
61
+ // This should have happened earlier...
62
+ req.addHistoryNote({ when: new Date().toISOString(), what: 'validateReqFailed', noRawTx, noTxIds, noInputBEEF })
63
+ req.status = 'invalid'
64
+ await req.updateStorageDynamicProperties(storage, trx)
65
+ r.details.push({ txid: req.txid, req, status: 'invalid' })
66
+ } else {
67
+ const vreq: PostReqsToNetworkDetails = { txid: req.txid, req, status: 'unknown' }
68
+ await storage.mergeReqToBeefToShareExternally(req.api, r.beef, [], trx)
69
+ vreqs.push(vreq)
70
+ r.details.push(vreq)
71
+ }
72
+ } catch (eu: unknown) {
73
+ const { code, message } = sdk.WalletError.fromUnknown(eu)
74
+ req.addHistoryNote({ when: new Date().toISOString(), what: 'validateReqError', txid: req.txid, code, message })
75
+ req.attempts++
76
+ if (req.attempts > 6) {
77
+ req.status = 'invalid'
78
+ r.details.push({ txid: req.txid, req, status: 'invalid' })
79
+ }
80
+ await req.updateStorageDynamicProperties(storage, trx)
81
+ }
82
+ }
83
+ return { r, vreqs, txids: vreqs.map(r => r.txid) }
84
+ }
85
+
86
+ async function transferNotesToReqHistories(
87
+ txids: string[],
88
+ vreqs: PostReqsToNetworkDetails[],
89
+ pbrs: sdk.PostBeefResult[],
90
+ storage: StorageProvider,
91
+ trx?: sdk.TrxToken
92
+ ): Promise<void> {
93
+ for (const txid of txids) {
94
+ const vreq = vreqs.find(r => r.txid === txid)
95
+ if (!vreq) throw new sdk.WERR_INTERNAL()
96
+ const notes: sdk.ReqHistoryNote[] = []
97
+ for (const pbr of pbrs) {
98
+ notes.push(...(pbr.notes || []))
99
+ const r = pbr.txidResults.find(tr => tr.txid === txid)
100
+ if (r) notes.push(...(r.notes || []))
101
+ }
102
+ for (const n of notes) {
103
+ vreq.req.addHistoryNote(n)
104
+ }
105
+ await vreq.req.updateStorageDynamicProperties(storage, trx)
106
+ }
107
+ }
108
+
109
+ /**
110
+ * For each txid, decide on the aggregate success or failure of attempting to broadcast it to the bitcoin processing network.
111
+ *
112
+ * Possible results:
113
+ * 1. Success: At least one success, no double spends.
114
+ * 2. DoubleSpend: One or more double spends.
115
+ * 3. InvalidTransaction: No success, no double spend, one or more non-exception errors.
116
+ * 4. Service Failure: No results or all results are exception errors.
117
+ *
118
+ * @param txids
119
+ * @param reqs
120
+ * @param pbrs
121
+ * @param storage
122
+ * @returns
123
+ */
124
+ function aggregatePostBeefResultsByTxid(
125
+ txids: string[],
126
+ vreqs: PostReqsToNetworkDetails[],
127
+ pbrs: sdk.PostBeefResult[]
128
+ ): Record<string, AggregatePostBeefTxResult> {
129
+ const r: Record<string, AggregatePostBeefTxResult> = {}
130
+
131
+ for (const txid of txids) {
132
+ const vreq = vreqs.find(r => r.txid === txid)!
133
+ const ar: AggregatePostBeefTxResult = {
134
+ txid,
135
+ vreq,
136
+ txidResults: [],
137
+ status: 'success',
138
+ successCount: 0,
139
+ doubleSpendCount: 0,
140
+ statusErrorCount: 0,
141
+ serviceErrorCount: 0,
142
+ competingTxs: []
143
+ }
144
+ r[txid] = ar
145
+ for (const pbr of pbrs) {
146
+ const tr = pbr.txidResults.find(tr => tr.txid === txid)
147
+ if (tr) {
148
+ ar.txidResults.push(tr)
149
+ if (tr.status === 'success') ar.successCount++
150
+ else if (tr.doubleSpend) {
151
+ ar.doubleSpendCount++
152
+ if (tr.competingTxs) {
153
+ ar.competingTxs = [...tr.competingTxs]
154
+ }
155
+ } else if (tr.serviceError) ar.serviceErrorCount++
156
+ else ar.statusErrorCount++
157
+ }
158
+ if (ar.competingTxs.length > 1) ar.competingTxs = [...new Set(ar.competingTxs)] // Remove duplicates
159
+ }
160
+
161
+ if (ar.successCount > 0 && ar.doubleSpendCount === 0) ar.status = 'success'
162
+ else if (ar.doubleSpendCount > 0) ar.status = 'doubleSpend'
163
+ else if (ar.statusErrorCount > 0) ar.status = 'invalidTx'
164
+ else ar.status = 'serviceError'
165
+ }
166
+
167
+ return r
168
+ }
169
+
170
+ /**
171
+ * For each txid in submitted `txids`:
172
+ *
173
+ * Based on its aggregate status, and whether broadcast happening in background (isDelayed) or immediately (!isDelayed),
174
+ * and iff current req.status is not 'unproven' or 'completed':
175
+ *
176
+ * 'success':
177
+ * req.status => 'unmined', tx.status => 'unproven'
178
+ * 'doubleSpend':
179
+ * req.status => 'doubleSpend', tx.status => 'failed'
180
+ * 'invalidTx':
181
+ * req.status => 'invalid', tx.status => 'failed'
182
+ * 'serviceError':
183
+ * increment req.attempts
184
+ *
185
+ * @param txids
186
+ * @param apbrs
187
+ * @param storage
188
+ * @param services if valid, doubleSpend results will be verified (but only if not within a trx. e.g. trx must be undefined)
189
+ * @param trx
190
+ */
191
+ async function updateReqsFromAggregateResults(
192
+ txids: string[],
193
+ r: PostReqsToNetworkResult,
194
+ apbrs: Record<string, AggregatePostBeefTxResult>,
195
+ storage: StorageProvider,
196
+ services?: sdk.WalletServices,
197
+ trx?: sdk.TrxToken,
198
+ logger?: WalletLoggerInterface
199
+ ): Promise<void> {
200
+ logger?.group('update storage from aggregate results')
201
+ for (const txid of txids) {
202
+ const ar = apbrs[txid]!
203
+ const req = ar.vreq.req
204
+ await req.refreshFromStorage(storage, trx)
205
+
206
+ const { successCount, doubleSpendCount, statusErrorCount, serviceErrorCount } = ar
207
+ const note: ReqHistoryNote = {
208
+ when: new Date().toISOString(),
209
+ what: 'aggregateResults',
210
+ reqStatus: req.status,
211
+ aggStatus: ar.status,
212
+ attempts: req.attempts,
213
+ successCount,
214
+ doubleSpendCount,
215
+ statusErrorCount,
216
+ serviceErrorCount
217
+ }
218
+
219
+ if (['completed', 'unmined'].indexOf(req.status) >= 0)
220
+ // However it happened, don't degrade status if it is somehow already beyond broadcast stage
221
+ continue
222
+
223
+ if (ar.status === 'doubleSpend' && services && !trx) await confirmDoubleSpend(ar, r.beef, storage, services, logger)
224
+
225
+ let newReqStatus: sdk.ProvenTxReqStatus | undefined = undefined
226
+ let newTxStatus: sdk.TransactionStatus | undefined = undefined
227
+ switch (ar.status) {
228
+ case 'success':
229
+ newReqStatus = 'unmined'
230
+ newTxStatus = 'unproven'
231
+ break
232
+ case 'doubleSpend':
233
+ newReqStatus = 'doubleSpend'
234
+ newTxStatus = 'failed'
235
+ break
236
+ case 'invalidTx':
237
+ newReqStatus = 'invalid'
238
+ newTxStatus = 'failed'
239
+ break
240
+ case 'serviceError':
241
+ newReqStatus = 'sending'
242
+ newTxStatus = 'sending'
243
+ req.attempts++
244
+ break
245
+ default:
246
+ throw new sdk.WERR_INTERNAL(`unimplemented AggregateStatus ${ar.status}`)
247
+ }
248
+
249
+ note.newReqStatus = newReqStatus
250
+ note.newTxStatus = newTxStatus
251
+ note.newAttempts = req.attempts
252
+
253
+ if (newReqStatus) req.status = newReqStatus
254
+
255
+ req.addHistoryNote(note)
256
+ await req.updateStorageDynamicProperties(storage, trx)
257
+
258
+ if (newTxStatus) {
259
+ const ids = req.notify.transactionIds
260
+ if (ids) {
261
+ // Also set generated outputs to spendable false and consumed input outputs to spendable true (and clears their spentBy).
262
+ await storage.updateTransactionsStatus(ids, newTxStatus, trx)
263
+ }
264
+ }
265
+
266
+ // Transfer critical results to details going back to the user
267
+ const details = r.details.find(d => d.txid === txid)!
268
+ details.status = ar.status
269
+ details.competingTxs = ar.competingTxs
270
+ logger?.log(`updated ${txid}`)
271
+ }
272
+ logger?.group('update storage from aggregate results')
273
+ }
274
+
275
+ /**
276
+ * Requires ar.status === 'doubleSpend'
277
+ *
278
+ * Parse the rawTx and review each input as a possible double spend.
279
+ *
280
+ * If all inputs appear to be unspent, update aggregate status to 'success' if successCount > 0, otherwise 'serviceError'.
281
+ *
282
+ * @param ar
283
+ * @param storage
284
+ * @param services
285
+ */
286
+ async function confirmDoubleSpend(
287
+ ar: AggregatePostBeefTxResult,
288
+ beef: Beef,
289
+ storage: StorageProvider,
290
+ services: sdk.WalletServices,
291
+ logger?: WalletLoggerInterface
292
+ ): Promise<void> {
293
+ const req = ar.vreq.req
294
+ const note: ReqHistoryNote = { when: new Date().toISOString(), what: 'confirmDoubleSpend' }
295
+
296
+ let known = false
297
+
298
+ for (let retry = 0; retry < 3; retry++) {
299
+ const gsr = await services.getStatusForTxids([req.txid])
300
+ note[`getStatus${retry}`] = `${gsr.status}${gsr.error ? `${gsr.error.code}` : ''},${gsr.results[0]?.status}`
301
+ if (gsr.status === 'success' && gsr.results[0].status !== 'unknown') {
302
+ known = true
303
+ break
304
+ } else {
305
+ await wait(1000)
306
+ }
307
+ }
308
+
309
+ if (known) {
310
+ // doubleSpend -> success
311
+ ar.status = 'success'
312
+ note.newStatus = ar.status
313
+ } else {
314
+ // Confirmed double spend, get txids of possible competing transactions.
315
+ const tx = Transaction.fromBinary(req.rawTx)
316
+ const competingTxids = new Set(ar.competingTxs)
317
+ for (const input of tx.inputs) {
318
+ const sourceTx = beef.findTxid(input.sourceTXID!)?.tx
319
+ if (!sourceTx) throw new sdk.WERR_INTERNAL(`beef lacks tx for ${input.sourceTXID}`)
320
+ const lockingScript = sourceTx.outputs[input.sourceOutputIndex].lockingScript.toHex()
321
+ const hash = services.hashOutputScript(lockingScript)
322
+ const shhrs = await services.getScriptHashHistory(hash, undefined, logger)
323
+ if (shhrs.status === 'success') {
324
+ for (const h of shhrs.history) {
325
+ // Neither the source of the input nor the current transaction are competition.
326
+ if (h.txid !== input.sourceTXID && h.txid !== ar.txid) competingTxids.add(h.txid)
327
+ }
328
+ }
329
+ }
330
+ ar.competingTxs = [...competingTxids].slice(-24) // keep at most 24, if they were sorted by time, keep newest
331
+ note.competingTxs = ar.competingTxs.join(',')
332
+ }
333
+ req.addHistoryNote(note)
334
+ }
335
+
336
+ type AggregateStatus = 'success' | 'doubleSpend' | 'invalidTx' | 'serviceError'
337
+
338
+ interface AggregatePostBeefTxResult {
339
+ txid: string
340
+ txidResults: sdk.PostTxResultForTxid[]
341
+ status: AggregateStatus
342
+ vreq: PostReqsToNetworkDetails
343
+ successCount: number
344
+ doubleSpendCount: number
345
+ statusErrorCount: number
346
+ serviceErrorCount: number
347
+ /**
348
+ * Any competing double spend txids reported for this txid
349
+ */
350
+ competingTxs: string[]
351
+ }
352
+
353
+ /**
354
+ * Indicates status of a new Action following a `createAction` or `signAction` in immediate mode:
355
+ * When `acceptDelayedBroadcast` is falses.
356
+ *
357
+ * 'success': The action has been broadcast and accepted by the bitcoin processing network.
358
+ * 'doulbeSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the loosing transaction.
359
+ * 'invalidTx': The action was rejected by the processing network as an invalid bitcoin transaction.
360
+ * 'serviceError': The broadcast services are currently unable to reach the bitcoin network. The action is now queued for delayed retries.
361
+ *
362
+ * 'invalid': The action was in an invalid state for processing, this status should never be seen by user code.
363
+ * 'unknown': An internal processing error has occured, this status should never be seen by user code.
364
+ *
365
+ */
366
+ export type PostReqsToNetworkDetailsStatus =
367
+ | 'success'
368
+ | 'doubleSpend'
369
+ | 'unknown'
370
+ | 'invalid'
371
+ | 'serviceError'
372
+ | 'invalidTx'
373
+
374
+ export interface PostReqsToNetworkDetails {
375
+ txid: string
376
+ req: EntityProvenTxReq
377
+ status: PostReqsToNetworkDetailsStatus
378
+ /**
379
+ * Any competing double spend txids reported for this txid
380
+ */
381
+ competingTxs?: string[]
382
+ }
383
+
384
+ export interface PostReqsToNetworkResult {
385
+ status: 'success' | 'error'
386
+ beef: Beef
387
+ details: PostReqsToNetworkDetails[]
388
+ log: string
389
+ }