@bsv/wallet-toolbox 1.6.33 → 1.6.35

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 (127) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/docs/client.md +424 -154
  3. package/docs/monitor.md +34 -12
  4. package/docs/storage.md +49 -1
  5. package/docs/wallet.md +414 -144
  6. package/mobile/out/src/Wallet.d.ts +4 -0
  7. package/mobile/out/src/Wallet.d.ts.map +1 -1
  8. package/mobile/out/src/Wallet.js +1 -2
  9. package/mobile/out/src/Wallet.js.map +1 -1
  10. package/mobile/out/src/monitor/tasks/TaskReorg.d.ts.map +1 -1
  11. package/mobile/out/src/monitor/tasks/TaskReorg.js +5 -1
  12. package/mobile/out/src/monitor/tasks/TaskReorg.js.map +1 -1
  13. package/mobile/out/src/sdk/WERR_errors.d.ts +8 -0
  14. package/mobile/out/src/sdk/WERR_errors.d.ts.map +1 -1
  15. package/mobile/out/src/sdk/WERR_errors.js +33 -0
  16. package/mobile/out/src/sdk/WERR_errors.js.map +1 -1
  17. package/mobile/out/src/sdk/WalletError.d.ts +19 -0
  18. package/mobile/out/src/sdk/WalletError.d.ts.map +1 -1
  19. package/mobile/out/src/sdk/WalletError.js +42 -1
  20. package/mobile/out/src/sdk/WalletError.js.map +1 -1
  21. package/mobile/out/src/sdk/WalletErrorFromJson.d.ts +12 -0
  22. package/mobile/out/src/sdk/WalletErrorFromJson.d.ts.map +1 -0
  23. package/mobile/out/src/sdk/WalletErrorFromJson.js +69 -0
  24. package/mobile/out/src/sdk/WalletErrorFromJson.js.map +1 -0
  25. package/mobile/out/src/sdk/index.d.ts +1 -0
  26. package/mobile/out/src/sdk/index.d.ts.map +1 -1
  27. package/mobile/out/src/sdk/index.js +1 -0
  28. package/mobile/out/src/sdk/index.js.map +1 -1
  29. package/mobile/out/src/sdk/validationHelpers.d.ts +8 -0
  30. package/mobile/out/src/sdk/validationHelpers.d.ts.map +1 -1
  31. package/mobile/out/src/sdk/validationHelpers.js +13 -2
  32. package/mobile/out/src/sdk/validationHelpers.js.map +1 -1
  33. package/mobile/out/src/services/chaintracker/ChaintracksChainTracker.d.ts.map +1 -1
  34. package/mobile/out/src/services/chaintracker/ChaintracksChainTracker.js +1 -1
  35. package/mobile/out/src/services/chaintracker/ChaintracksChainTracker.js.map +1 -1
  36. package/mobile/out/src/services/chaintracker/chaintracks/util/ChaintracksFetch.d.ts.map +1 -1
  37. package/mobile/out/src/services/chaintracker/chaintracks/util/ChaintracksFetch.js +16 -9
  38. package/mobile/out/src/services/chaintracker/chaintracks/util/ChaintracksFetch.js.map +1 -1
  39. package/mobile/out/src/signer/methods/createAction.js +1 -1
  40. package/mobile/out/src/signer/methods/createAction.js.map +1 -1
  41. package/mobile/out/src/storage/WalletStorageManager.d.ts.map +1 -1
  42. package/mobile/out/src/storage/WalletStorageManager.js.map +1 -1
  43. package/mobile/out/src/storage/methods/createAction.d.ts.map +1 -1
  44. package/mobile/out/src/storage/methods/createAction.js +3 -0
  45. package/mobile/out/src/storage/methods/createAction.js.map +1 -1
  46. package/mobile/out/src/storage/remoting/StorageClient.d.ts.map +1 -1
  47. package/mobile/out/src/storage/remoting/StorageClient.js +3 -5
  48. package/mobile/out/src/storage/remoting/StorageClient.js.map +1 -1
  49. package/mobile/package-lock.json +2 -2
  50. package/mobile/package.json +1 -1
  51. package/out/src/Wallet.d.ts +4 -0
  52. package/out/src/Wallet.d.ts.map +1 -1
  53. package/out/src/Wallet.js +1 -2
  54. package/out/src/Wallet.js.map +1 -1
  55. package/out/src/monitor/tasks/TaskReorg.d.ts.map +1 -1
  56. package/out/src/monitor/tasks/TaskReorg.js +5 -1
  57. package/out/src/monitor/tasks/TaskReorg.js.map +1 -1
  58. package/out/src/sdk/WERR_errors.d.ts +8 -0
  59. package/out/src/sdk/WERR_errors.d.ts.map +1 -1
  60. package/out/src/sdk/WERR_errors.js +33 -0
  61. package/out/src/sdk/WERR_errors.js.map +1 -1
  62. package/out/src/sdk/WalletError.d.ts +19 -0
  63. package/out/src/sdk/WalletError.d.ts.map +1 -1
  64. package/out/src/sdk/WalletError.js +42 -1
  65. package/out/src/sdk/WalletError.js.map +1 -1
  66. package/out/src/sdk/WalletErrorFromJson.d.ts +12 -0
  67. package/out/src/sdk/WalletErrorFromJson.d.ts.map +1 -0
  68. package/out/src/sdk/WalletErrorFromJson.js +69 -0
  69. package/out/src/sdk/WalletErrorFromJson.js.map +1 -0
  70. package/out/src/sdk/__test/WalletError.test.d.ts +2 -0
  71. package/out/src/sdk/__test/WalletError.test.d.ts.map +1 -0
  72. package/out/src/sdk/__test/WalletError.test.js +255 -0
  73. package/out/src/sdk/__test/WalletError.test.js.map +1 -0
  74. package/out/src/sdk/index.d.ts +1 -0
  75. package/out/src/sdk/index.d.ts.map +1 -1
  76. package/out/src/sdk/index.js +1 -0
  77. package/out/src/sdk/index.js.map +1 -1
  78. package/out/src/sdk/validationHelpers.d.ts +8 -0
  79. package/out/src/sdk/validationHelpers.d.ts.map +1 -1
  80. package/out/src/sdk/validationHelpers.js +13 -2
  81. package/out/src/sdk/validationHelpers.js.map +1 -1
  82. package/out/src/services/__tests/verifyBeef.test.js.map +1 -1
  83. package/out/src/services/chaintracker/ChaintracksChainTracker.d.ts.map +1 -1
  84. package/out/src/services/chaintracker/ChaintracksChainTracker.js +1 -1
  85. package/out/src/services/chaintracker/ChaintracksChainTracker.js.map +1 -1
  86. package/out/src/services/chaintracker/chaintracks/util/ChaintracksFetch.d.ts.map +1 -1
  87. package/out/src/services/chaintracker/chaintracks/util/ChaintracksFetch.js +16 -9
  88. package/out/src/services/chaintracker/chaintracks/util/ChaintracksFetch.js.map +1 -1
  89. package/out/src/signer/methods/createAction.js +1 -1
  90. package/out/src/signer/methods/createAction.js.map +1 -1
  91. package/out/src/storage/WalletStorageManager.d.ts.map +1 -1
  92. package/out/src/storage/WalletStorageManager.js.map +1 -1
  93. package/out/src/storage/methods/createAction.d.ts.map +1 -1
  94. package/out/src/storage/methods/createAction.js +3 -0
  95. package/out/src/storage/methods/createAction.js.map +1 -1
  96. package/out/src/storage/remoting/StorageClient.d.ts.map +1 -1
  97. package/out/src/storage/remoting/StorageClient.js +3 -5
  98. package/out/src/storage/remoting/StorageClient.js.map +1 -1
  99. package/out/src/storage/remoting/StorageServer.d.ts.map +1 -1
  100. package/out/src/storage/remoting/StorageServer.js +12 -10
  101. package/out/src/storage/remoting/StorageServer.js.map +1 -1
  102. package/out/test/Wallet/specOps/specOps.man.test.js +8 -6
  103. package/out/test/Wallet/specOps/specOps.man.test.js.map +1 -1
  104. package/out/test/WalletClient/WERR.man.test.js +9 -6
  105. package/out/test/WalletClient/WERR.man.test.js.map +1 -1
  106. package/out/tsconfig.all.tsbuildinfo +1 -1
  107. package/package.json +1 -1
  108. package/src/Wallet.ts +1 -3
  109. package/src/monitor/tasks/TaskReorg.ts +5 -1
  110. package/src/sdk/WERR_errors.ts +34 -0
  111. package/src/sdk/WalletError.ts +42 -1
  112. package/src/sdk/WalletErrorFromJson.ts +80 -0
  113. package/src/sdk/WalletStorage.interfaces.ts +3 -3
  114. package/src/sdk/__test/WalletError.test.ts +318 -0
  115. package/src/sdk/index.ts +1 -0
  116. package/src/sdk/validationHelpers.ts +15 -3
  117. package/src/services/__tests/verifyBeef.test.ts +0 -1
  118. package/src/services/chaintracker/ChaintracksChainTracker.ts +1 -2
  119. package/src/services/chaintracker/chaintracks/util/ChaintracksFetch.ts +18 -11
  120. package/src/signer/methods/createAction.ts +1 -1
  121. package/src/storage/WalletStorageManager.ts +16 -19
  122. package/src/storage/methods/createAction.ts +3 -0
  123. package/src/storage/methods/internalizeAction.ts +1 -1
  124. package/src/storage/remoting/StorageClient.ts +4 -6
  125. package/src/storage/remoting/StorageServer.ts +13 -11
  126. package/test/Wallet/specOps/specOps.man.test.ts +6 -4
  127. package/test/WalletClient/WERR.man.test.ts +11 -7
package/docs/wallet.md CHANGED
@@ -13,86 +13,87 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
13
13
 
14
14
  | | | |
15
15
  | --- | --- | --- |
16
- | [AdminStatsResult](#interface-adminstatsresult) | [GetRawTxResult](#interface-getrawtxresult) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) |
17
- | [ArcConfig](#interface-arcconfig) | [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [SyncChunk](#interface-syncchunk) |
18
- | [ArcMinerGetTxData](#interface-arcminergettxdata) | [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [SyncError](#interface-syncerror) |
19
- | [AuthId](#interface-authid) | [GetScriptHashHistory](#interface-getscripthashhistory) | [SyncMap](#interface-syncmap) |
20
- | [AuthPayload](#interface-authpayload) | [GetScriptHashHistoryResult](#interface-getscripthashhistoryresult) | [TableCertificate](#interface-tablecertificate) |
21
- | [BaseBlockHeader](#interface-baseblockheader) | [GetStatusForTxidsResult](#interface-getstatusfortxidsresult) | [TableCertificateField](#interface-tablecertificatefield) |
22
- | [BitailsConfig](#interface-bitailsconfig) | [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [TableCertificateX](#interface-tablecertificatex) |
23
- | [BitailsMerkleProof](#interface-bitailsmerkleproof) | [GetUtxoStatusResult](#interface-getutxostatusresult) | [TableCommission](#interface-tablecommission) |
24
- | [BlockHeader](#interface-blockheader) | [GroupedPermissionRequest](#interface-groupedpermissionrequest) | [TableMonitorEvent](#interface-tablemonitorevent) |
25
- | [BsvExchangeRate](#interface-bsvexchangerate) | [GroupedPermissions](#interface-groupedpermissions) | [TableOutput](#interface-tableoutput) |
26
- | [BulkFileDataManagerMergeResult](#interface-bulkfiledatamanagermergeresult) | [HeightRangeApi](#interface-heightrangeapi) | [TableOutputBasket](#interface-tableoutputbasket) |
27
- | [BulkFileDataManagerOptions](#interface-bulkfiledatamanageroptions) | [HeightRanges](#interface-heightranges) | [TableOutputTag](#interface-tableoutputtag) |
28
- | [BulkHeaderFileInfo](#interface-bulkheaderfileinfo) | [KeyPair](#interface-keypair) | [TableOutputTagMap](#interface-tableoutputtagmap) |
29
- | [BulkHeaderFilesInfo](#interface-bulkheaderfilesinfo) | [KeyPairAddress](#interface-keypairaddress) | [TableOutputX](#interface-tableoutputx) |
30
- | [BulkIngestorApi](#interface-bulkingestorapi) | [ListActionsSpecOp](#interface-listactionsspecop) | [TableProvenTx](#interface-tableproventx) |
31
- | [BulkIngestorBaseOptions](#interface-bulkingestorbaseoptions) | [ListOutputsSpecOp](#interface-listoutputsspecop) | [TableProvenTxReq](#interface-tableproventxreq) |
32
- | [BulkIngestorCDNOptions](#interface-bulkingestorcdnoptions) | [LiveBlockHeader](#interface-liveblockheader) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) |
33
- | [BulkIngestorWhatsOnChainOptions](#interface-bulkingestorwhatsonchainoptions) | [LiveIngestorApi](#interface-liveingestorapi) | [TableSettings](#interface-tablesettings) |
34
- | [BulkStorageApi](#interface-bulkstorageapi) | [LiveIngestorBaseOptions](#interface-liveingestorbaseoptions) | [TableSyncState](#interface-tablesyncstate) |
35
- | [BulkStorageBaseOptions](#interface-bulkstoragebaseoptions) | [LiveIngestorWhatsOnChainOptions](#interface-liveingestorwhatsonchainoptions) | [TableTransaction](#interface-tabletransaction) |
36
- | [BulkSyncResult](#interface-bulksyncresult) | [MonitorOptions](#interface-monitoroptions) | [TableTxLabel](#interface-tabletxlabel) |
37
- | [CertOpsWallet](#interface-certopswallet) | [OutPoint](#interface-outpoint) | [TableTxLabelMap](#interface-tabletxlabelmap) |
38
- | [Certifier](#interface-certifier) | [Paged](#interface-paged) | [TableUser](#interface-tableuser) |
39
- | [ChaintracksApi](#interface-chaintracksapi) | [PendingSignAction](#interface-pendingsignaction) | [TaskPurgeParams](#interface-taskpurgeparams) |
40
- | [ChaintracksAppendableFileApi](#interface-chaintracksappendablefileapi) | [PendingStorageInput](#interface-pendingstorageinput) | [TrustSettings](#interface-trustsettings) |
41
- | [ChaintracksChainTrackerOptions](#interface-chaintrackschaintrackeroptions) | [PermissionRequest](#interface-permissionrequest) | [TrxToken](#interface-trxtoken) |
42
- | [ChaintracksClientApi](#interface-chaintracksclientapi) | [PermissionToken](#interface-permissiontoken) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
43
- | [ChaintracksFetchApi](#interface-chaintracksfetchapi) | [PermissionsManagerConfig](#interface-permissionsmanagerconfig) | [TxScriptOffsets](#interface-txscriptoffsets) |
44
- | [ChaintracksFsApi](#interface-chaintracksfsapi) | [PostBeefResult](#interface-postbeefresult) | [UMPToken](#interface-umptoken) |
45
- | [ChaintracksInfoApi](#interface-chaintracksinfoapi) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [UMPTokenInteractor](#interface-umptokeninteractor) |
46
- | [ChaintracksManagementApi](#interface-chaintracksmanagementapi) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
47
- | [ChaintracksOptions](#interface-chaintracksoptions) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
48
- | [ChaintracksPackageInfoApi](#interface-chaintrackspackageinfoapi) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [ValidAbortActionArgs](#interface-validabortactionargs) |
49
- | [ChaintracksReadableFileApi](#interface-chaintracksreadablefileapi) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [ValidAcquireCertificateArgs](#interface-validacquirecertificateargs) |
50
- | [ChaintracksServiceClientOptions](#interface-chaintracksserviceclientoptions) | [PostTxsResult](#interface-posttxsresult) | [ValidAcquireDirectCertificateArgs](#interface-validacquiredirectcertificateargs) |
51
- | [ChaintracksStorageApi](#interface-chaintracksstorageapi) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [ValidAcquireIssuanceCertificateArgs](#interface-validacquireissuancecertificateargs) |
52
- | [ChaintracksStorageBaseOptions](#interface-chaintracksstoragebaseoptions) | [Profile](#interface-profile) | [ValidBasketInsertion](#interface-validbasketinsertion) |
53
- | [ChaintracksStorageBulkFileApi](#interface-chaintracksstoragebulkfileapi) | [ProvenOrRawTx](#interface-provenorrawtx) | [ValidCreateActionArgs](#interface-validcreateactionargs) |
54
- | [ChaintracksStorageIdbOptions](#interface-chaintracksstorageidboptions) | [ProvenTransactionStatus](#interface-proventransactionstatus) | [ValidCreateActionInput](#interface-validcreateactioninput) |
55
- | [ChaintracksStorageIdbSchema](#interface-chaintracksstorageidbschema) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [ValidCreateActionOptions](#interface-validcreateactionoptions) |
56
- | [ChaintracksStorageIngestApi](#interface-chaintracksstorageingestapi) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [ValidCreateActionOutput](#interface-validcreateactionoutput) |
57
- | [ChaintracksStorageNoDbOptions](#interface-chaintracksstoragenodboptions) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [ValidDiscoverByAttributesArgs](#interface-validdiscoverbyattributesargs) |
58
- | [ChaintracksStorageQueryApi](#interface-chaintracksstoragequeryapi) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [ValidDiscoverByIdentityKeyArgs](#interface-validdiscoverbyidentitykeyargs) |
59
- | [ChaintracksWritableFileApi](#interface-chaintrackswritablefileapi) | [ProviderCallHistory](#interface-providercallhistory) | [ValidInternalizeActionArgs](#interface-validinternalizeactionargs) |
60
- | [CommitNewTxResults](#interface-commitnewtxresults) | [PurgeParams](#interface-purgeparams) | [ValidInternalizeOutput](#interface-validinternalizeoutput) |
61
- | [CompleteAuthResponse](#interface-completeauthresponse) | [PurgeResults](#interface-purgeresults) | [ValidListActionsArgs](#interface-validlistactionsargs) |
62
- | [CreateActionResultX](#interface-createactionresultx) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [ValidListCertificatesArgs](#interface-validlistcertificatesargs) |
63
- | [DeactivedHeader](#interface-deactivedheader) | [ReviewActionResult](#interface-reviewactionresult) | [ValidListOutputsArgs](#interface-validlistoutputsargs) |
64
- | [EntitySyncMap](#interface-entitysyncmap) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [ValidProcessActionArgs](#interface-validprocessactionargs) |
65
- | [EntityTimeStamp](#interface-entitytimestamp) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [ValidProcessActionOptions](#interface-validprocessactionoptions) |
66
- | [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [ServiceCall](#interface-servicecall) | [ValidProveCertificateArgs](#interface-validprovecertificateargs) |
16
+ | [AdminStatsResult](#interface-adminstatsresult) | [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) |
17
+ | [ArcConfig](#interface-arcconfig) | [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [SyncChunk](#interface-syncchunk) |
18
+ | [ArcMinerGetTxData](#interface-arcminergettxdata) | [GetScriptHashHistory](#interface-getscripthashhistory) | [SyncError](#interface-syncerror) |
19
+ | [AuthId](#interface-authid) | [GetScriptHashHistoryResult](#interface-getscripthashhistoryresult) | [SyncMap](#interface-syncmap) |
20
+ | [AuthPayload](#interface-authpayload) | [GetStatusForTxidsResult](#interface-getstatusfortxidsresult) | [TableCertificate](#interface-tablecertificate) |
21
+ | [BaseBlockHeader](#interface-baseblockheader) | [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [TableCertificateField](#interface-tablecertificatefield) |
22
+ | [BitailsConfig](#interface-bitailsconfig) | [GetUtxoStatusResult](#interface-getutxostatusresult) | [TableCertificateX](#interface-tablecertificatex) |
23
+ | [BitailsMerkleProof](#interface-bitailsmerkleproof) | [GroupedPermissionRequest](#interface-groupedpermissionrequest) | [TableCommission](#interface-tablecommission) |
24
+ | [BlockHeader](#interface-blockheader) | [GroupedPermissions](#interface-groupedpermissions) | [TableMonitorEvent](#interface-tablemonitorevent) |
25
+ | [BsvExchangeRate](#interface-bsvexchangerate) | [HeightRangeApi](#interface-heightrangeapi) | [TableOutput](#interface-tableoutput) |
26
+ | [BulkFileDataManagerMergeResult](#interface-bulkfiledatamanagermergeresult) | [HeightRanges](#interface-heightranges) | [TableOutputBasket](#interface-tableoutputbasket) |
27
+ | [BulkFileDataManagerOptions](#interface-bulkfiledatamanageroptions) | [KeyPair](#interface-keypair) | [TableOutputTag](#interface-tableoutputtag) |
28
+ | [BulkHeaderFileInfo](#interface-bulkheaderfileinfo) | [KeyPairAddress](#interface-keypairaddress) | [TableOutputTagMap](#interface-tableoutputtagmap) |
29
+ | [BulkHeaderFilesInfo](#interface-bulkheaderfilesinfo) | [ListActionsSpecOp](#interface-listactionsspecop) | [TableOutputX](#interface-tableoutputx) |
30
+ | [BulkIngestorApi](#interface-bulkingestorapi) | [ListOutputsSpecOp](#interface-listoutputsspecop) | [TableProvenTx](#interface-tableproventx) |
31
+ | [BulkIngestorBaseOptions](#interface-bulkingestorbaseoptions) | [LiveBlockHeader](#interface-liveblockheader) | [TableProvenTxReq](#interface-tableproventxreq) |
32
+ | [BulkIngestorCDNOptions](#interface-bulkingestorcdnoptions) | [LiveIngestorApi](#interface-liveingestorapi) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) |
33
+ | [BulkIngestorWhatsOnChainOptions](#interface-bulkingestorwhatsonchainoptions) | [LiveIngestorBaseOptions](#interface-liveingestorbaseoptions) | [TableSettings](#interface-tablesettings) |
34
+ | [BulkStorageApi](#interface-bulkstorageapi) | [LiveIngestorWhatsOnChainOptions](#interface-liveingestorwhatsonchainoptions) | [TableSyncState](#interface-tablesyncstate) |
35
+ | [BulkStorageBaseOptions](#interface-bulkstoragebaseoptions) | [MonitorOptions](#interface-monitoroptions) | [TableTransaction](#interface-tabletransaction) |
36
+ | [BulkSyncResult](#interface-bulksyncresult) | [OutPoint](#interface-outpoint) | [TableTxLabel](#interface-tabletxlabel) |
37
+ | [CertOpsWallet](#interface-certopswallet) | [Paged](#interface-paged) | [TableTxLabelMap](#interface-tabletxlabelmap) |
38
+ | [Certifier](#interface-certifier) | [PendingSignAction](#interface-pendingsignaction) | [TableUser](#interface-tableuser) |
39
+ | [ChaintracksApi](#interface-chaintracksapi) | [PendingStorageInput](#interface-pendingstorageinput) | [TaskPurgeParams](#interface-taskpurgeparams) |
40
+ | [ChaintracksAppendableFileApi](#interface-chaintracksappendablefileapi) | [PermissionRequest](#interface-permissionrequest) | [TrustSettings](#interface-trustsettings) |
41
+ | [ChaintracksChainTrackerOptions](#interface-chaintrackschaintrackeroptions) | [PermissionToken](#interface-permissiontoken) | [TrxToken](#interface-trxtoken) |
42
+ | [ChaintracksClientApi](#interface-chaintracksclientapi) | [PermissionsManagerConfig](#interface-permissionsmanagerconfig) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
43
+ | [ChaintracksFetchApi](#interface-chaintracksfetchapi) | [PostBeefResult](#interface-postbeefresult) | [TxScriptOffsets](#interface-txscriptoffsets) |
44
+ | [ChaintracksFsApi](#interface-chaintracksfsapi) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [UMPToken](#interface-umptoken) |
45
+ | [ChaintracksInfoApi](#interface-chaintracksinfoapi) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [UMPTokenInteractor](#interface-umptokeninteractor) |
46
+ | [ChaintracksManagementApi](#interface-chaintracksmanagementapi) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
47
+ | [ChaintracksOptions](#interface-chaintracksoptions) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
48
+ | [ChaintracksPackageInfoApi](#interface-chaintrackspackageinfoapi) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [ValidAbortActionArgs](#interface-validabortactionargs) |
49
+ | [ChaintracksReadableFileApi](#interface-chaintracksreadablefileapi) | [PostTxsResult](#interface-posttxsresult) | [ValidAcquireCertificateArgs](#interface-validacquirecertificateargs) |
50
+ | [ChaintracksServiceClientOptions](#interface-chaintracksserviceclientoptions) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [ValidAcquireDirectCertificateArgs](#interface-validacquiredirectcertificateargs) |
51
+ | [ChaintracksStorageApi](#interface-chaintracksstorageapi) | [Profile](#interface-profile) | [ValidAcquireIssuanceCertificateArgs](#interface-validacquireissuancecertificateargs) |
52
+ | [ChaintracksStorageBaseOptions](#interface-chaintracksstoragebaseoptions) | [ProvenOrRawTx](#interface-provenorrawtx) | [ValidBasketInsertion](#interface-validbasketinsertion) |
53
+ | [ChaintracksStorageBulkFileApi](#interface-chaintracksstoragebulkfileapi) | [ProvenTransactionStatus](#interface-proventransactionstatus) | [ValidCreateActionArgs](#interface-validcreateactionargs) |
54
+ | [ChaintracksStorageIdbOptions](#interface-chaintracksstorageidboptions) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [ValidCreateActionInput](#interface-validcreateactioninput) |
55
+ | [ChaintracksStorageIdbSchema](#interface-chaintracksstorageidbschema) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [ValidCreateActionOptions](#interface-validcreateactionoptions) |
56
+ | [ChaintracksStorageIngestApi](#interface-chaintracksstorageingestapi) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [ValidCreateActionOutput](#interface-validcreateactionoutput) |
57
+ | [ChaintracksStorageNoDbOptions](#interface-chaintracksstoragenodboptions) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [ValidDiscoverByAttributesArgs](#interface-validdiscoverbyattributesargs) |
58
+ | [ChaintracksStorageQueryApi](#interface-chaintracksstoragequeryapi) | [ProviderCallHistory](#interface-providercallhistory) | [ValidDiscoverByIdentityKeyArgs](#interface-validdiscoverbyidentitykeyargs) |
59
+ | [ChaintracksWritableFileApi](#interface-chaintrackswritablefileapi) | [PurgeParams](#interface-purgeparams) | [ValidInternalizeActionArgs](#interface-validinternalizeactionargs) |
60
+ | [CommitNewTxResults](#interface-commitnewtxresults) | [PurgeResults](#interface-purgeresults) | [ValidInternalizeOutput](#interface-validinternalizeoutput) |
61
+ | [CompleteAuthResponse](#interface-completeauthresponse) | [ReproveHeaderResult](#interface-reproveheaderresult) | [ValidListActionsArgs](#interface-validlistactionsargs) |
62
+ | [CreateActionResultX](#interface-createactionresultx) | [ReproveProvenResult](#interface-reproveprovenresult) | [ValidListCertificatesArgs](#interface-validlistcertificatesargs) |
63
+ | [DeactivedHeader](#interface-deactivedheader) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [ValidListOutputsArgs](#interface-validlistoutputsargs) |
64
+ | [EntitySyncMap](#interface-entitysyncmap) | [ReviewActionResult](#interface-reviewactionresult) | [ValidProcessActionArgs](#interface-validprocessactionargs) |
65
+ | [EntityTimeStamp](#interface-entitytimestamp) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [ValidProcessActionOptions](#interface-validprocessactionoptions) |
66
+ | [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [ValidProveCertificateArgs](#interface-validprovecertificateargs) |
67
67
  | [ExtendedVerifiableCertificate](#interface-extendedverifiablecertificate) | [ServiceCall](#interface-servicecall) | [ValidRelinquishCertificateArgs](#interface-validrelinquishcertificateargs) |
68
- | [FiatExchangeRates](#interface-fiatexchangerates) | [ServiceCallHistory](#interface-servicecallhistory) | [ValidRelinquishOutputArgs](#interface-validrelinquishoutputargs) |
69
- | [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [ServiceCallHistoryCounts](#interface-servicecallhistorycounts) | [ValidSignActionArgs](#interface-validsignactionargs) |
70
- | [FindCertificatesArgs](#interface-findcertificatesargs) | [ServiceToCall](#interface-servicetocall) | [ValidSignActionOptions](#interface-validsignactionoptions) |
71
- | [FindCommissionsArgs](#interface-findcommissionsargs) | [SetupClientWalletArgs](#interface-setupclientwalletargs) | [ValidWalletPayment](#interface-validwalletpayment) |
72
- | [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [SetupClientWalletClientArgs](#interface-setupclientwalletclientargs) | [ValidWalletSignerArgs](#interface-validwalletsignerargs) |
73
- | [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [SetupWallet](#interface-setupwallet) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
74
- | [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [SetupWalletClient](#interface-setupwalletclient) | [WalletArgs](#interface-walletargs) |
75
- | [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [SetupWalletIdb](#interface-setupwalletidb) | [WalletBalance](#interface-walletbalance) |
76
- | [FindOutputTagsArgs](#interface-findoutputtagsargs) | [SetupWalletIdbArgs](#interface-setupwalletidbargs) | [WalletPermissionsManagerCallbacks](#interface-walletpermissionsmanagercallbacks) |
77
- | [FindOutputsArgs](#interface-findoutputsargs) | [SignActionResultX](#interface-signactionresultx) | [WalletServices](#interface-walletservices) |
78
- | [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [StartAuthResponse](#interface-startauthresponse) | [WalletServicesOptions](#interface-walletservicesoptions) |
79
- | [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [StatusForTxidResult](#interface-statusfortxidresult) | [WalletSettings](#interface-walletsettings) |
80
- | [FindProvenTxsArgs](#interface-findproventxsargs) | [StorageAdminStats](#interface-storageadminstats) | [WalletSettingsManagerConfig](#interface-walletsettingsmanagerconfig) |
81
- | [FindSincePagedArgs](#interface-findsincepagedargs) | [StorageCreateActionResult](#interface-storagecreateactionresult) | [WalletSigner](#interface-walletsigner) |
82
- | [FindSyncStatesArgs](#interface-findsyncstatesargs) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) | [WalletStorage](#interface-walletstorage) |
83
- | [FindTransactionsArgs](#interface-findtransactionsargs) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) | [WalletStorageInfo](#interface-walletstorageinfo) |
84
- | [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [StorageFeeModel](#interface-storagefeemodel) | [WalletStorageProvider](#interface-walletstorageprovider) |
85
- | [FindTxLabelsArgs](#interface-findtxlabelsargs) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) | [WalletStorageReader](#interface-walletstoragereader) |
86
- | [FindUsersArgs](#interface-findusersargs) | [StorageIdbOptions](#interface-storageidboptions) | [WalletStorageSync](#interface-walletstoragesync) |
87
- | [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StorageIdbSchema](#interface-storageidbschema) | [WalletStorageSyncReader](#interface-walletstoragesyncreader) |
88
- | [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [StorageIdentity](#interface-storageidentity) | [WalletStorageWriter](#interface-walletstoragewriter) |
89
- | [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) | [WalletTheme](#interface-wallettheme) |
90
- | [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [StorageProcessActionArgs](#interface-storageprocessactionargs) | [WhatsOnChainServicesOptions](#interface-whatsonchainservicesoptions) |
91
- | [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [StorageProcessActionResults](#interface-storageprocessactionresults) | [WocChainInfo](#interface-wocchaininfo) |
92
- | [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [StorageProvenOrReq](#interface-storageprovenorreq) | [WocGetHeaderByteFileLinks](#interface-wocgetheaderbytefilelinks) |
93
- | [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [StorageProviderOptions](#interface-storageprovideroptions) | [WocGetHeadersHeader](#interface-wocgetheadersheader) |
94
- | [GetHeaderByteFileLinksResult](#interface-getheaderbytefilelinksresult) | [StorageReaderOptions](#interface-storagereaderoptions) | [WocHeader](#interface-wocheader) |
95
- | [GetMerklePathResult](#interface-getmerklepathresult) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
68
+ | [FiatExchangeRates](#interface-fiatexchangerates) | [ServiceCall](#interface-servicecall) | [ValidRelinquishOutputArgs](#interface-validrelinquishoutputargs) |
69
+ | [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [ServiceCallHistory](#interface-servicecallhistory) | [ValidSignActionArgs](#interface-validsignactionargs) |
70
+ | [FindCertificatesArgs](#interface-findcertificatesargs) | [ServiceCallHistoryCounts](#interface-servicecallhistorycounts) | [ValidSignActionOptions](#interface-validsignactionoptions) |
71
+ | [FindCommissionsArgs](#interface-findcommissionsargs) | [ServiceToCall](#interface-servicetocall) | [ValidWalletPayment](#interface-validwalletpayment) |
72
+ | [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [SetupClientWalletArgs](#interface-setupclientwalletargs) | [ValidWalletSignerArgs](#interface-validwalletsignerargs) |
73
+ | [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [SetupClientWalletClientArgs](#interface-setupclientwalletclientargs) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
74
+ | [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [SetupWallet](#interface-setupwallet) | [WalletArgs](#interface-walletargs) |
75
+ | [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [SetupWalletClient](#interface-setupwalletclient) | [WalletBalance](#interface-walletbalance) |
76
+ | [FindOutputTagsArgs](#interface-findoutputtagsargs) | [SetupWalletIdb](#interface-setupwalletidb) | [WalletPermissionsManagerCallbacks](#interface-walletpermissionsmanagercallbacks) |
77
+ | [FindOutputsArgs](#interface-findoutputsargs) | [SetupWalletIdbArgs](#interface-setupwalletidbargs) | [WalletServices](#interface-walletservices) |
78
+ | [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [SignActionResultX](#interface-signactionresultx) | [WalletServicesOptions](#interface-walletservicesoptions) |
79
+ | [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [StartAuthResponse](#interface-startauthresponse) | [WalletSettings](#interface-walletsettings) |
80
+ | [FindProvenTxsArgs](#interface-findproventxsargs) | [StatusForTxidResult](#interface-statusfortxidresult) | [WalletSettingsManagerConfig](#interface-walletsettingsmanagerconfig) |
81
+ | [FindSincePagedArgs](#interface-findsincepagedargs) | [StorageAdminStats](#interface-storageadminstats) | [WalletSigner](#interface-walletsigner) |
82
+ | [FindSyncStatesArgs](#interface-findsyncstatesargs) | [StorageCreateActionResult](#interface-storagecreateactionresult) | [WalletStorage](#interface-walletstorage) |
83
+ | [FindTransactionsArgs](#interface-findtransactionsargs) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) | [WalletStorageInfo](#interface-walletstorageinfo) |
84
+ | [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) | [WalletStorageProvider](#interface-walletstorageprovider) |
85
+ | [FindTxLabelsArgs](#interface-findtxlabelsargs) | [StorageFeeModel](#interface-storagefeemodel) | [WalletStorageReader](#interface-walletstoragereader) |
86
+ | [FindUsersArgs](#interface-findusersargs) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) | [WalletStorageSync](#interface-walletstoragesync) |
87
+ | [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StorageIdbOptions](#interface-storageidboptions) | [WalletStorageSyncReader](#interface-walletstoragesyncreader) |
88
+ | [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [StorageIdbSchema](#interface-storageidbschema) | [WalletStorageWriter](#interface-walletstoragewriter) |
89
+ | [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [StorageIdentity](#interface-storageidentity) | [WalletTheme](#interface-wallettheme) |
90
+ | [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) | [WhatsOnChainServicesOptions](#interface-whatsonchainservicesoptions) |
91
+ | [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [StorageProcessActionArgs](#interface-storageprocessactionargs) | [WocChainInfo](#interface-wocchaininfo) |
92
+ | [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [StorageProcessActionResults](#interface-storageprocessactionresults) | [WocGetHeaderByteFileLinks](#interface-wocgetheaderbytefilelinks) |
93
+ | [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [StorageProvenOrReq](#interface-storageprovenorreq) | [WocGetHeadersHeader](#interface-wocgetheadersheader) |
94
+ | [GetHeaderByteFileLinksResult](#interface-getheaderbytefilelinksresult) | [StorageProviderOptions](#interface-storageprovideroptions) | [WocHeader](#interface-wocheader) |
95
+ | [GetMerklePathResult](#interface-getmerklepathresult) | [StorageReaderOptions](#interface-storagereaderoptions) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
96
+ | [GetRawTxResult](#interface-getrawtxresult) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) | |
96
97
 
97
98
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
98
99
 
@@ -4628,6 +4629,124 @@ export interface PurgeResults {
4628
4629
 
4629
4630
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4630
4631
 
4632
+ ---
4633
+ ##### Interface: ReproveHeaderResult
4634
+
4635
+ Returned results from WalletStorageManager reproveHeader method.
4636
+
4637
+ ```ts
4638
+ export interface ReproveHeaderResult {
4639
+ log: string;
4640
+ updated: {
4641
+ was: TableProvenTx;
4642
+ update: Partial<TableProvenTx>;
4643
+ logUpdate: string;
4644
+ }[];
4645
+ unchanged: TableProvenTx[];
4646
+ unavailable: TableProvenTx[];
4647
+ }
4648
+ ```
4649
+
4650
+ See also: [TableProvenTx](./storage.md#interface-tableproventx)
4651
+
4652
+ ###### Property log
4653
+
4654
+ Human readable log of the reproveHeader process.
4655
+
4656
+ ```ts
4657
+ log: string
4658
+ ```
4659
+
4660
+ ###### Property unavailable
4661
+
4662
+ List of proven_txs records that were checked but currently proof data is unavailable.
4663
+
4664
+ ```ts
4665
+ unavailable: TableProvenTx[]
4666
+ ```
4667
+ See also: [TableProvenTx](./storage.md#interface-tableproventx)
4668
+
4669
+ ###### Property unchanged
4670
+
4671
+ List of proven_txs records that were checked but currently available proof is unchanged.
4672
+
4673
+ ```ts
4674
+ unchanged: TableProvenTx[]
4675
+ ```
4676
+ See also: [TableProvenTx](./storage.md#interface-tableproventx)
4677
+
4678
+ ###### Property updated
4679
+
4680
+ List of proven_txs records that were updated with new proof data.
4681
+
4682
+ ```ts
4683
+ updated: {
4684
+ was: TableProvenTx;
4685
+ update: Partial<TableProvenTx>;
4686
+ logUpdate: string;
4687
+ }[]
4688
+ ```
4689
+ See also: [TableProvenTx](./storage.md#interface-tableproventx)
4690
+
4691
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4692
+
4693
+ ---
4694
+ ##### Interface: ReproveProvenResult
4695
+
4696
+ Returned results from WalletStorageManager reproveProven method.
4697
+
4698
+ ```ts
4699
+ export interface ReproveProvenResult {
4700
+ log: string;
4701
+ updated?: {
4702
+ update: Partial<TableProvenTx>;
4703
+ logUpdate: string;
4704
+ };
4705
+ unchanged: boolean;
4706
+ unavailable: boolean;
4707
+ }
4708
+ ```
4709
+
4710
+ See also: [TableProvenTx](./storage.md#interface-tableproventx)
4711
+
4712
+ ###### Property log
4713
+
4714
+ Human readable log of the reproveProven process.
4715
+
4716
+ ```ts
4717
+ log: string
4718
+ ```
4719
+
4720
+ ###### Property unavailable
4721
+
4722
+ True if proof data for proven_txs record is currently unavailable.
4723
+
4724
+ ```ts
4725
+ unavailable: boolean
4726
+ ```
4727
+
4728
+ ###### Property unchanged
4729
+
4730
+ True if proof data for proven_txs record was found to be unchanged.
4731
+
4732
+ ```ts
4733
+ unchanged: boolean
4734
+ ```
4735
+
4736
+ ###### Property updated
4737
+
4738
+ Valid if proof data for proven_txs record is available and has changed.
4739
+
4740
+ ```ts
4741
+ updated?: {
4742
+ update: Partial<TableProvenTx>;
4743
+ logUpdate: string;
4744
+ }
4745
+ ```
4746
+ See also: [TableProvenTx](./storage.md#interface-tableproventx)
4747
+
4748
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4749
+
4631
4750
  ---
4632
4751
  ##### Interface: RequestSyncChunkArgs
4633
4752
 
@@ -7182,6 +7301,7 @@ export interface ValidProcessActionArgs extends ValidWalletSignerArgs {
7182
7301
  isRemixChange: boolean;
7183
7302
  isNoSend: boolean;
7184
7303
  isDelayed: boolean;
7304
+ isTestWerrReviewActions: boolean;
7185
7305
  }
7186
7306
  ```
7187
7307
 
@@ -11426,6 +11546,18 @@ callOnProvenTransaction(txStatus: ProvenTransactionStatus): void
11426
11546
  ```
11427
11547
  See also: [ProvenTransactionStatus](./client.md#interface-proventransactionstatus)
11428
11548
 
11549
+ ###### Method processHeader
11550
+
11551
+ Handler for new header events from Chaintracks.
11552
+
11553
+ To minimize reorg processing, new headers are aged before processing via TaskNewHeader.
11554
+ Therefore this handler is intentionally a no-op.
11555
+
11556
+ ```ts
11557
+ processHeader(header: BlockHeader): void
11558
+ ```
11559
+ See also: [BlockHeader](./client.md#interface-blockheader)
11560
+
11429
11561
  ###### Method processNewBlockHeader
11430
11562
 
11431
11563
  Process new chain header event received from Chaintracks
@@ -13872,7 +14004,7 @@ They must be shifted out as they are processed.
13872
14004
  The current implementation ages deactivation notifications by 10 minutes with each retry.
13873
14005
  If a successful proof update confirms original proof data after 3 retries, the original is retained.
13874
14006
 
13875
- In normal operation there should never be any work for this task to perform.
14007
+ In normal operation there should rarely be any work for this task to perform.
13876
14008
  The most common result is that there are no matching proven_txs records because
13877
14009
  generating new proven_txs records intentionally lags new block generation to
13878
14010
  minimize this disruption.
@@ -13882,17 +14014,8 @@ It is very disruptive to update a proven_txs record because:
13882
14014
  - Generated beefs are impacted.
13883
14015
  - Updated proof data may be unavailable at the time a reorg is first reported.
13884
14016
 
13885
- Instead of reorg notification derived from new header notification, reorg repair to
13886
- the proven_txs table is more effectively driven by noticing that a beef generated for a new
13887
- createAction fails to verify against the chaintracker.
13888
-
13889
- An alternate approach to processing these events is to revert the proven_txs record to a proven_tx_reqs record.
13890
- Pros:
13891
- - The same multiple attempt logic that already exists is reused.
13892
- - Failing to obtain a new proof already has transaction failure handling in place.
13893
- - Generated beefs automatically become one generation deeper, potentially allowing transaction outputs to be spent.
13894
- Cons:
13895
- - Transactions must revert to un-proven / un-mined.
14017
+ Proper reorg handling also requires repairing invalid beefs for new transactions when
14018
+ createAction fails to verify a generated beef against the chaintracker.
13896
14019
 
13897
14020
  ```ts
13898
14021
  export class TaskReorg extends WalletMonitorTask {
@@ -13908,6 +14031,25 @@ export class TaskReorg extends WalletMonitorTask {
13908
14031
 
13909
14032
  See also: [DeactivedHeader](./monitor.md#interface-deactivedheader), [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
13910
14033
 
14034
+ ###### Method trigger
14035
+
14036
+ Shift aged deactivated headers onto `process` array.
14037
+
14038
+ ```ts
14039
+ trigger(nowMsecsSinceEpoch: number): {
14040
+ run: boolean;
14041
+ }
14042
+ ```
14043
+
14044
+ Returns
14045
+
14046
+ `run` true iff there are aged deactivated headers to process.
14047
+
14048
+ Argument Details
14049
+
14050
+ + **nowMsecsSinceEpoch**
14051
+ + current time in milliseconds since epoch.
14052
+
13911
14053
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
13912
14054
 
13913
14055
  ---
@@ -14249,6 +14391,7 @@ to pay the fee to unlock and spend the outputs used to provide the additional sa
14249
14391
  ```ts
14250
14392
  export class WERR_INSUFFICIENT_FUNDS extends WalletError {
14251
14393
  constructor(public totalSatoshisNeeded: number, public moreSatoshisNeeded: number)
14394
+ override toJson(): string
14252
14395
  }
14253
14396
  ```
14254
14397
 
@@ -14313,6 +14456,7 @@ This is an example of an error object with a custom property `parameter` and tem
14313
14456
  ```ts
14314
14457
  export class WERR_INVALID_PARAMETER extends WalletError {
14315
14458
  constructor(public parameter: string, mustBe?: string)
14459
+ override toJson(): string
14316
14460
  }
14317
14461
  ```
14318
14462
 
@@ -14326,6 +14470,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
14326
14470
  ```ts
14327
14471
  export class WERR_INVALID_PUBLIC_KEY extends WalletError {
14328
14472
  constructor(public key: string, network: WalletNetwork = "mainnet")
14473
+ protected override toJson(): string
14329
14474
  }
14330
14475
  ```
14331
14476
 
@@ -14356,6 +14501,7 @@ This is an example of an error object with a custom property `parameter`
14356
14501
  ```ts
14357
14502
  export class WERR_MISSING_PARAMETER extends WalletError {
14358
14503
  constructor(public parameter: string)
14504
+ override toJson(): string
14359
14505
  }
14360
14506
  ```
14361
14507
 
@@ -14418,6 +14564,7 @@ paid to processing errors.
14418
14564
  ```ts
14419
14565
  export class WERR_REVIEW_ACTIONS extends WalletError {
14420
14566
  constructor(public reviewActionResults: ReviewActionResult[], public sendWithResults: SendWithResult[], public txid?: TXIDHexString, public tx?: AtomicBEEF, public noSendChange?: OutpointString[])
14567
+ override toJson(): string
14421
14568
  }
14422
14569
  ```
14423
14570
 
@@ -14789,6 +14936,8 @@ export class WalletError extends Error implements WalletErrorObject {
14789
14936
  code: string;
14790
14937
  description: string;
14791
14938
  }
14939
+ protected toJson(): string
14940
+ static unknownToJson(error: unknown | WalletError): string
14792
14941
  }
14793
14942
  ```
14794
14943
 
@@ -14815,6 +14964,37 @@ static fromUnknown(err: unknown): WalletError
14815
14964
  ```
14816
14965
  See also: [WalletError](./client.md#class-walleterror)
14817
14966
 
14967
+ ###### Method toJson
14968
+
14969
+ Base class default JSON serialization.
14970
+ Captures just the name and message properties.
14971
+
14972
+ Override this method to safely (avoid deep, large, circular issues) serialize
14973
+ derived class properties.
14974
+
14975
+ ```ts
14976
+ protected toJson(): string
14977
+ ```
14978
+
14979
+ Returns
14980
+
14981
+ stringified JSON representation of the WalletError.
14982
+
14983
+ ###### Method unknownToJson
14984
+
14985
+ Safely serializes a WalletError derived, WERR_REVIEW_ACTIONS (special case), Error or unknown error to JSON.
14986
+
14987
+ Safely means avoiding deep, large, circular issues.
14988
+
14989
+ ```ts
14990
+ static unknownToJson(error: unknown | WalletError): string
14991
+ ```
14992
+ See also: [WalletError](./client.md#class-walleterror)
14993
+
14994
+ Returns
14995
+
14996
+ stringified JSON representation of the error such that it can be desirialized to a WalletError.
14997
+
14818
14998
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
14819
14999
 
14820
15000
  ---
@@ -15546,6 +15726,9 @@ export class WalletStorageManager implements sdk.WalletStorage {
15546
15726
  async findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>
15547
15727
  async findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>
15548
15728
  async findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>
15729
+ async reproveHeader(deactivatedHash: string): Promise<sdk.ReproveHeaderResult>
15730
+ async verifyAndRepairBeef(beef: Beef, allowTxidOnly?: boolean): Promise<boolean>
15731
+ async reproveProven(ptx: TableProvenTx, noUpdate?: boolean): Promise<sdk.ReproveProvenResult>
15549
15732
  async syncFromReader(identityKey: string, reader: sdk.WalletStorageSyncReader, activeSync?: sdk.WalletStorageSync, log: string = ""): Promise<{
15550
15733
  inserts: number;
15551
15734
  updates: number;
@@ -15563,7 +15746,7 @@ export class WalletStorageManager implements sdk.WalletStorage {
15563
15746
  }
15564
15747
  ```
15565
15748
 
15566
- See also: [AuthId](./client.md#interface-authid), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [StorageProvider](./storage.md#class-storageprovider), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableUser](./storage.md#interface-tableuser), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs), [ValidListActionsArgs](./client.md#interface-validlistactionsargs), [ValidListCertificatesArgs](./client.md#interface-validlistcertificatesargs), [ValidListOutputsArgs](./client.md#interface-validlistoutputsargs), [WalletServices](./client.md#interface-walletservices), [WalletStorage](./client.md#interface-walletstorage), [WalletStorageInfo](./client.md#interface-walletstorageinfo), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [WalletStorageReader](./client.md#interface-walletstoragereader), [WalletStorageSync](./client.md#interface-walletstoragesync), [WalletStorageSyncReader](./client.md#interface-walletstoragesyncreader), [WalletStorageWriter](./client.md#interface-walletstoragewriter), [createAction](./storage.md#function-createaction), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [processAction](./storage.md#function-processaction)
15749
+ See also: [AuthId](./client.md#interface-authid), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [ReproveHeaderResult](./client.md#interface-reproveheaderresult), [ReproveProvenResult](./client.md#interface-reproveprovenresult), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [StorageProvider](./storage.md#class-storageprovider), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableUser](./storage.md#interface-tableuser), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs), [ValidListActionsArgs](./client.md#interface-validlistactionsargs), [ValidListCertificatesArgs](./client.md#interface-validlistcertificatesargs), [ValidListOutputsArgs](./client.md#interface-validlistoutputsargs), [WalletServices](./client.md#interface-walletservices), [WalletStorage](./client.md#interface-walletstorage), [WalletStorageInfo](./client.md#interface-walletstorageinfo), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [WalletStorageReader](./client.md#interface-walletstoragereader), [WalletStorageSync](./client.md#interface-walletstoragesync), [WalletStorageSyncReader](./client.md#interface-walletstoragesyncreader), [WalletStorageWriter](./client.md#interface-walletstoragewriter), [createAction](./storage.md#function-createaction), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [processAction](./storage.md#function-processaction)
15567
15750
 
15568
15751
  ###### Constructor
15569
15752
 
@@ -15681,6 +15864,39 @@ Throws
15681
15864
 
15682
15865
  WERR_INVALID_PARAMETER if canMakeAvailable returns false.
15683
15866
 
15867
+ ###### Method reproveHeader
15868
+
15869
+ For each proven_txs record currently sourcing its transaction merkle proof from the given deactivated header,
15870
+ attempt to reprove the transaction against the current chain,
15871
+ updating the proven_txs record if a new valid proof is found.
15872
+
15873
+ ```ts
15874
+ async reproveHeader(deactivatedHash: string): Promise<sdk.ReproveHeaderResult>
15875
+ ```
15876
+ See also: [ReproveHeaderResult](./client.md#interface-reproveheaderresult)
15877
+
15878
+ Argument Details
15879
+
15880
+ + **deactivatedHash**
15881
+ + An orphaned header than may have served as a proof source for proven_txs records.
15882
+
15883
+ ###### Method reproveProven
15884
+
15885
+ Attempt to reprove the transaction against the current chain,
15886
+ If a new valid proof is found and noUpdate is not true,
15887
+ update the proven_txs record with new block and merkle proof data.
15888
+ If noUpdate is true, the update to be applied is available in the returned result.
15889
+
15890
+ ```ts
15891
+ async reproveProven(ptx: TableProvenTx, noUpdate?: boolean): Promise<sdk.ReproveProvenResult>
15892
+ ```
15893
+ See also: [ReproveProvenResult](./client.md#interface-reproveprovenresult), [TableProvenTx](./storage.md#interface-tableproventx)
15894
+
15895
+ Argument Details
15896
+
15897
+ + **ptx**
15898
+ + proven_txs record to reprove
15899
+
15684
15900
  ###### Method runAsSync
15685
15901
 
15686
15902
  ```ts
@@ -15710,6 +15926,18 @@ Argument Details
15710
15926
  + **storageIdentityKey**
15711
15927
  + of current backup storage provider that is to become the new active provider.
15712
15928
 
15929
+ ###### Method verifyAndRepairBeef
15930
+
15931
+ Extends the Beef `verify` function to handle BUMPs that have become invalid due to a chain reorg.
15932
+
15933
+ Any merkle root that fails `isValidRootForHeight` triggers a reprove attempt for that block header.
15934
+ This results in proven_txs with invalid proofs being updated with new valid proofs where possible.
15935
+ Finally, a new beef is generated and verified against the chaintracker.
15936
+
15937
+ ```ts
15938
+ async verifyAndRepairBeef(beef: Beef, allowTxidOnly?: boolean): Promise<boolean>
15939
+ ```
15940
+
15713
15941
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
15714
15942
 
15715
15943
  ---
@@ -15895,65 +16123,86 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
15895
16123
 
15896
16124
  | | | |
15897
16125
  | --- | --- | --- |
15898
- | [WocHeadersBulkListener](#function-wocheadersbulklistener) | [isBaseBlockHeader](#function-isbaseblockheader) | [validateAcquireIssuanceCertificateArgs](#function-validateacquireissuancecertificateargs) |
15899
- | [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [isBlockHeader](#function-isblockheader) | [validateAgainstDirtyHashes](#function-validateagainstdirtyhashes) |
15900
- | [WocHeadersLiveListener](#function-wocheaderslivelistener) | [isCreateActionSpecOp](#function-iscreateactionspecop) | [validateBasketInsertion](#function-validatebasketinsertion) |
15901
- | [WocHeadersLiveListener_test](#function-wocheaderslivelistener_test) | [isHexString](#function-ishexstring) | [validateBufferOfHeaders](#function-validatebufferofheaders) |
15902
- | [acquireDirectCertificate](#function-acquiredirectcertificate) | [isKnownValidBulkHeaderFile](#function-isknownvalidbulkheaderfile) | [validateBulkFileData](#function-validatebulkfiledata) |
15903
- | [addWork](#function-addwork) | [isListActionsSpecOp](#function-islistactionsspecop) | [validateCreateActionArgs](#function-validatecreateactionargs) |
15904
- | [arcDefaultUrl](#function-arcdefaulturl) | [isListOutputsSpecOp](#function-islistoutputsspecop) | [validateCreateActionInput](#function-validatecreateactioninput) |
15905
- | [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [isLive](#function-islive) | [validateCreateActionOptions](#function-validatecreateactionoptions) |
15906
- | [arraysEqual](#function-arraysequal) | [isLiveBlockHeader](#function-isliveblockheader) | [validateCreateActionOutput](#function-validatecreateactionoutput) |
15907
- | [asArray](#function-asarray) | [isMoreWork](#function-ismorework) | [validateDiscoverByAttributesArgs](#function-validatediscoverbyattributesargs) |
15908
- | [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [listActionsIdb](#function-listactionsidb) | [validateDiscoverByIdentityKeyArgs](#function-validatediscoverbyidentitykeyargs) |
15909
- | [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [listCertificates](#function-listcertificates) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) |
15910
- | [asBsvSdkScript](#function-asbsvsdkscript) | [listOutputsIdb](#function-listoutputsidb) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) |
15911
- | [asBsvSdkTx](#function-asbsvsdktx) | [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [validateGenesisHeader](#function-validategenesisheader) |
15912
- | [asString](#function-asstring) | [makeAtomicBeef](#function-makeatomicbeef) | [validateHeaderDifficulty](#function-validateheaderdifficulty) |
15913
- | [asUint8Array](#function-asuint8array) | [makeChangeLock](#function-makechangelock) | [validateHeaderFormat](#function-validateheaderformat) |
15914
- | [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [maxDate](#function-maxdate) | [validateInteger](#function-validateinteger) |
15915
- | [blockHash](#function-blockhash) | [offsetPubKey](#function-offsetpubkey) | [validateInternalizeActionArgs](#function-validateinternalizeactionargs) |
15916
- | [buildSignableTransaction](#function-buildsignabletransaction) | [optionalArraysEqual](#function-optionalarraysequal) | [validateInternalizeOutput](#function-validateinternalizeoutput) |
15917
- | [completeSignedTransaction](#function-completesignedtransaction) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [validateListActionsArgs](#function-validatelistactionsargs) |
15918
- | [convertBitsToTarget](#function-convertbitstotarget) | [parseWalletOutpoint](#function-parsewalletoutpoint) | [validateListCertificatesArgs](#function-validatelistcertificatesargs) |
15919
- | [convertBitsToWork](#function-convertbitstowork) | [processAction](#function-processaction) | [validateListOutputsArgs](#function-validatelistoutputsargs) |
15920
- | [convertBufferToUint32](#function-convertbuffertouint32) | [processAction](#function-processaction) | [validateOptionalInteger](#function-validateoptionalinteger) |
15921
- | [convertProofToMerklePath](#function-convertprooftomerklepath) | [proveCertificate](#function-provecertificate) | [validateOptionalOutpointString](#function-validateoptionaloutpointstring) |
15922
- | [convertUint32ToBuffer](#function-convertuint32tobuffer) | [purgeDataIdb](#function-purgedataidb) | [validateOriginator](#function-validateoriginator) |
15923
- | [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [randomBytes](#function-randombytes) | [validateOutpointString](#function-validateoutpointstring) |
15924
- | [createAction](#function-createaction) | [randomBytesBase64](#function-randombytesbase64) | [validatePositiveIntegerOrZero](#function-validatepositiveintegerorzero) |
16126
+ | [WalletErrorFromJson](#function-walleterrorfromjson) | [isBaseBlockHeader](#function-isbaseblockheader) | [validateAcquireIssuanceCertificateArgs](#function-validateacquireissuancecertificateargs) |
16127
+ | [WocHeadersBulkListener](#function-wocheadersbulklistener) | [isBlockHeader](#function-isblockheader) | [validateAgainstDirtyHashes](#function-validateagainstdirtyhashes) |
16128
+ | [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [isCreateActionSpecOp](#function-iscreateactionspecop) | [validateBasketInsertion](#function-validatebasketinsertion) |
16129
+ | [WocHeadersLiveListener](#function-wocheaderslivelistener) | [isHexString](#function-ishexstring) | [validateBufferOfHeaders](#function-validatebufferofheaders) |
16130
+ | [WocHeadersLiveListener_test](#function-wocheaderslivelistener_test) | [isKnownValidBulkHeaderFile](#function-isknownvalidbulkheaderfile) | [validateBulkFileData](#function-validatebulkfiledata) |
16131
+ | [acquireDirectCertificate](#function-acquiredirectcertificate) | [isListActionsSpecOp](#function-islistactionsspecop) | [validateCreateActionArgs](#function-validatecreateactionargs) |
16132
+ | [addWork](#function-addwork) | [isListOutputsSpecOp](#function-islistoutputsspecop) | [validateCreateActionInput](#function-validatecreateactioninput) |
16133
+ | [arcDefaultUrl](#function-arcdefaulturl) | [isLive](#function-islive) | [validateCreateActionOptions](#function-validatecreateactionoptions) |
16134
+ | [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [isLiveBlockHeader](#function-isliveblockheader) | [validateCreateActionOutput](#function-validatecreateactionoutput) |
16135
+ | [arraysEqual](#function-arraysequal) | [isMoreWork](#function-ismorework) | [validateDiscoverByAttributesArgs](#function-validatediscoverbyattributesargs) |
16136
+ | [asArray](#function-asarray) | [listActionsIdb](#function-listactionsidb) | [validateDiscoverByIdentityKeyArgs](#function-validatediscoverbyidentitykeyargs) |
16137
+ | [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [listCertificates](#function-listcertificates) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) |
16138
+ | [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [listOutputsIdb](#function-listoutputsidb) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) |
16139
+ | [asBsvSdkScript](#function-asbsvsdkscript) | [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [validateGenesisHeader](#function-validategenesisheader) |
16140
+ | [asBsvSdkTx](#function-asbsvsdktx) | [makeAtomicBeef](#function-makeatomicbeef) | [validateHeaderDifficulty](#function-validateheaderdifficulty) |
16141
+ | [asString](#function-asstring) | [makeChangeLock](#function-makechangelock) | [validateHeaderFormat](#function-validateheaderformat) |
16142
+ | [asUint8Array](#function-asuint8array) | [maxDate](#function-maxdate) | [validateInteger](#function-validateinteger) |
16143
+ | [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [offsetPubKey](#function-offsetpubkey) | [validateInternalizeActionArgs](#function-validateinternalizeactionargs) |
16144
+ | [blockHash](#function-blockhash) | [optionalArraysEqual](#function-optionalarraysequal) | [validateInternalizeOutput](#function-validateinternalizeoutput) |
16145
+ | [buildSignableTransaction](#function-buildsignabletransaction) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [validateListActionsArgs](#function-validatelistactionsargs) |
16146
+ | [completeSignedTransaction](#function-completesignedtransaction) | [parseWalletOutpoint](#function-parsewalletoutpoint) | [validateListCertificatesArgs](#function-validatelistcertificatesargs) |
16147
+ | [convertBitsToTarget](#function-convertbitstotarget) | [processAction](#function-processaction) | [validateListOutputsArgs](#function-validatelistoutputsargs) |
16148
+ | [convertBitsToWork](#function-convertbitstowork) | [processAction](#function-processaction) | [validateOptionalInteger](#function-validateoptionalinteger) |
16149
+ | [convertBufferToUint32](#function-convertbuffertouint32) | [proveCertificate](#function-provecertificate) | [validateOptionalOutpointString](#function-validateoptionaloutpointstring) |
16150
+ | [convertProofToMerklePath](#function-convertprooftomerklepath) | [purgeDataIdb](#function-purgedataidb) | [validateOriginator](#function-validateoriginator) |
16151
+ | [convertUint32ToBuffer](#function-convertuint32tobuffer) | [randomBytes](#function-randombytes) | [validateOutpointString](#function-validateoutpointstring) |
16152
+ | [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [randomBytesBase64](#function-randombytesbase64) | [validatePositiveIntegerOrZero](#function-validatepositiveintegerorzero) |
15925
16153
  | [createAction](#function-createaction) | [randomBytesHex](#function-randombyteshex) | [validateProveCertificateArgs](#function-validateprovecertificateargs) |
15926
- | [createDefaultIdbChaintracksOptions](#function-createdefaultidbchaintracksoptions) | [readUInt32BE](#function-readuint32be) | [validateRelinquishCertificateArgs](#function-validaterelinquishcertificateargs) |
15927
- | [createDefaultNoDbChaintracksOptions](#function-createdefaultnodbchaintracksoptions) | [readUInt32LE](#function-readuint32le) | [validateRelinquishOutputArgs](#function-validaterelinquishoutputargs) |
15928
- | [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [reviewStatusIdb](#function-reviewstatusidb) | [validateSatoshis](#function-validatesatoshis) |
15929
- | [createIdbChaintracks](#function-createidbchaintracks) | [selectBulkHeaderFiles](#function-selectbulkheaderfiles) | [validateScriptHash](#function-validatescripthash) |
15930
- | [createNoDbChaintracks](#function-createnodbchaintracks) | [serializeBaseBlockHeader](#function-serializebaseblockheader) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
15931
- | [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [serializeBaseBlockHeaders](#function-serializebaseblockheaders) | [validateSignActionArgs](#function-validatesignactionargs) |
15932
- | [createSyncMap](#function-createsyncmap) | [setDisableDoubleSpendCheckForTest](#function-setdisabledoublespendcheckfortest) | [validateSignActionOptions](#function-validatesignactionoptions) |
15933
- | [deserializeBaseBlockHeader](#function-deserializebaseblockheader) | [sha256Hash](#function-sha256hash) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
15934
- | [deserializeBaseBlockHeaders](#function-deserializebaseblockheaders) | [sha256HashOfBinaryFile](#function-sha256hashofbinaryfile) | [validateStringLength](#function-validatestringlength) |
15935
- | [deserializeBlockHeader](#function-deserializeblockheader) | [shareReqsWithWorld](#function-sharereqswithworld) | [validateWalletPayment](#function-validatewalletpayment) |
15936
- | [deserializeBlockHeaders](#function-deserializeblockheaders) | [signAction](#function-signaction) | [varUintSize](#function-varuintsize) |
15937
- | [doubleSha256BE](#function-doublesha256be) | [stampLog](#function-stamplog) | [verifyHexString](#function-verifyhexstring) |
15938
- | [doubleSha256LE](#function-doublesha256le) | [stampLogFormat](#function-stamplogformat) | [verifyId](#function-verifyid) |
15939
- | [generateChangeSdk](#function-generatechangesdk) | [subWork](#function-subwork) | [verifyInteger](#function-verifyinteger) |
15940
- | [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [swapByteOrder](#function-swapbyteorder) | [verifyNumber](#function-verifynumber) |
15941
- | [genesisBuffer](#function-genesisbuffer) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) | [verifyOne](#function-verifyone) |
15942
- | [genesisHeader](#function-genesisheader) | [toWalletNetwork](#function-towalletnetwork) | [verifyOneOrNone](#function-verifyoneornone) |
15943
- | [getBeefForTransaction](#function-getbeeffortransaction) | [transactionInputSize](#function-transactioninputsize) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
15944
- | [getBeefForTxid](#function-getbeeffortxid) | [transactionOutputSize](#function-transactionoutputsize) | [verifyTruthy](#function-verifytruthy) |
15945
- | [getExchangeRatesIo](#function-getexchangeratesio) | [transactionSize](#function-transactionsize) | [verifyUnlockScripts](#function-verifyunlockscripts) |
15946
- | [getIdentityKey](#function-getidentitykey) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) | [wait](#function-wait) |
15947
- | [getProofs](#function-getproofs) | [updateExchangeratesapi](#function-updateexchangeratesapi) | [wocGetHeadersHeaderToBlockHeader](#function-wocgetheadersheadertoblockheader) |
15948
- | [getSyncChunk](#function-getsyncchunk) | [validBulkHeaderFilesByFileHash](#function-validbulkheaderfilesbyfilehash) | [workBNtoBuffer](#function-workbntobuffer) |
15949
- | [getWhatsOnChainBlockHeaderByHash](#function-getwhatsonchainblockheaderbyhash) | [validateAbortActionArgs](#function-validateabortactionargs) | [writeUInt32BE](#function-writeuint32be) |
15950
- | [internalizeAction](#function-internalizeaction) | [validateAcquireCertificateArgs](#function-validateacquirecertificateargs) | [writeUInt32LE](#function-writeuint32le) |
16154
+ | [createAction](#function-createaction) | [readUInt32BE](#function-readuint32be) | [validateRelinquishCertificateArgs](#function-validaterelinquishcertificateargs) |
16155
+ | [createDefaultIdbChaintracksOptions](#function-createdefaultidbchaintracksoptions) | [readUInt32LE](#function-readuint32le) | [validateRelinquishOutputArgs](#function-validaterelinquishoutputargs) |
16156
+ | [createDefaultNoDbChaintracksOptions](#function-createdefaultnodbchaintracksoptions) | [reviewStatusIdb](#function-reviewstatusidb) | [validateSatoshis](#function-validatesatoshis) |
16157
+ | [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [selectBulkHeaderFiles](#function-selectbulkheaderfiles) | [validateScriptHash](#function-validatescripthash) |
16158
+ | [createIdbChaintracks](#function-createidbchaintracks) | [serializeBaseBlockHeader](#function-serializebaseblockheader) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
16159
+ | [createNoDbChaintracks](#function-createnodbchaintracks) | [serializeBaseBlockHeaders](#function-serializebaseblockheaders) | [validateSignActionArgs](#function-validatesignactionargs) |
16160
+ | [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [setDisableDoubleSpendCheckForTest](#function-setdisabledoublespendcheckfortest) | [validateSignActionOptions](#function-validatesignactionoptions) |
16161
+ | [createSyncMap](#function-createsyncmap) | [sha256Hash](#function-sha256hash) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
16162
+ | [deserializeBaseBlockHeader](#function-deserializebaseblockheader) | [sha256HashOfBinaryFile](#function-sha256hashofbinaryfile) | [validateStringLength](#function-validatestringlength) |
16163
+ | [deserializeBaseBlockHeaders](#function-deserializebaseblockheaders) | [shareReqsWithWorld](#function-sharereqswithworld) | [validateWalletPayment](#function-validatewalletpayment) |
16164
+ | [deserializeBlockHeader](#function-deserializeblockheader) | [signAction](#function-signaction) | [varUintSize](#function-varuintsize) |
16165
+ | [deserializeBlockHeaders](#function-deserializeblockheaders) | [stampLog](#function-stamplog) | [verifyHexString](#function-verifyhexstring) |
16166
+ | [doubleSha256BE](#function-doublesha256be) | [stampLogFormat](#function-stamplogformat) | [verifyId](#function-verifyid) |
16167
+ | [doubleSha256LE](#function-doublesha256le) | [subWork](#function-subwork) | [verifyInteger](#function-verifyinteger) |
16168
+ | [generateChangeSdk](#function-generatechangesdk) | [swapByteOrder](#function-swapbyteorder) | [verifyNumber](#function-verifynumber) |
16169
+ | [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [throwDummyReviewActions](#function-throwdummyreviewactions) | [verifyOne](#function-verifyone) |
16170
+ | [genesisBuffer](#function-genesisbuffer) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) | [verifyOneOrNone](#function-verifyoneornone) |
16171
+ | [genesisHeader](#function-genesisheader) | [toWalletNetwork](#function-towalletnetwork) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
16172
+ | [getBeefForTransaction](#function-getbeeffortransaction) | [transactionInputSize](#function-transactioninputsize) | [verifyTruthy](#function-verifytruthy) |
16173
+ | [getBeefForTxid](#function-getbeeffortxid) | [transactionOutputSize](#function-transactionoutputsize) | [verifyUnlockScripts](#function-verifyunlockscripts) |
16174
+ | [getExchangeRatesIo](#function-getexchangeratesio) | [transactionSize](#function-transactionsize) | [wait](#function-wait) |
16175
+ | [getIdentityKey](#function-getidentitykey) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) | [wocGetHeadersHeaderToBlockHeader](#function-wocgetheadersheadertoblockheader) |
16176
+ | [getProofs](#function-getproofs) | [updateExchangeratesapi](#function-updateexchangeratesapi) | [workBNtoBuffer](#function-workbntobuffer) |
16177
+ | [getSyncChunk](#function-getsyncchunk) | [validBulkHeaderFilesByFileHash](#function-validbulkheaderfilesbyfilehash) | [writeUInt32BE](#function-writeuint32be) |
16178
+ | [getWhatsOnChainBlockHeaderByHash](#function-getwhatsonchainblockheaderbyhash) | [validateAbortActionArgs](#function-validateabortactionargs) | [writeUInt32LE](#function-writeuint32le) |
16179
+ | [internalizeAction](#function-internalizeaction) | [validateAcquireCertificateArgs](#function-validateacquirecertificateargs) | |
15951
16180
  | [internalizeAction](#function-internalizeaction) | [validateAcquireDirectCertificateArgs](#function-validateacquiredirectcertificateargs) | |
15952
16181
 
15953
16182
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
15954
16183
 
15955
16184
  ---
15956
16185
 
16186
+ ##### Function: WalletErrorFromJson
16187
+
16188
+ Reconstruct the correct derived WalletError from a JSON object created by `WalletError.unknownToJson`.
16189
+
16190
+ This function is implemented as a separate function instead of a WalletError class static
16191
+ to avoid circular dependencies.
16192
+
16193
+ ```ts
16194
+ export function WalletErrorFromJson(json: object): WalletError
16195
+ ```
16196
+
16197
+ See also: [WalletError](./client.md#class-walleterror)
16198
+
16199
+ Returns
16200
+
16201
+ a WalletError derived error object, typically for re-throw.
16202
+
16203
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
16204
+
16205
+ ---
15957
16206
  ##### Function: WocHeadersBulkListener
15958
16207
 
15959
16208
  High speed WebSocket based based old block header listener
@@ -17610,6 +17859,17 @@ new buffer with byte order reversed.
17610
17859
 
17611
17860
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
17612
17861
 
17862
+ ---
17863
+ ##### Function: throwDummyReviewActions
17864
+
17865
+ Throws a WERR_REVIEW_ACTIONS with a full set of properties to test data formats and propagation.
17866
+
17867
+ ```ts
17868
+ export function throwDummyReviewActions()
17869
+ ```
17870
+
17871
+ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
17872
+
17613
17873
  ---
17614
17874
  ##### Function: toBinaryBaseBlockHeader
17615
17875
 
@@ -17884,12 +18144,22 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
17884
18144
  ---
17885
18145
  ##### Function: validateCreateActionArgs
17886
18146
 
18147
+ Validate the arguments for creating a new action.
18148
+
17887
18149
  ```ts
17888
18150
  export function validateCreateActionArgs(args: CreateActionArgs): ValidCreateActionArgs
17889
18151
  ```
17890
18152
 
17891
18153
  See also: [ValidCreateActionArgs](./client.md#interface-validcreateactionargs)
17892
18154
 
18155
+ Returns
18156
+
18157
+ validated arguments
18158
+
18159
+ Throws
18160
+
18161
+ primarily WERR_INVALID_PARAMETER if args are invalid.
18162
+
17893
18163
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
17894
18164
 
17895
18165
  ---