@bsv/wallet-toolbox 1.6.33 → 1.6.34
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.
- package/CHANGELOG.md +7 -0
- package/docs/client.md +340 -93
- package/docs/monitor.md +34 -12
- package/docs/storage.md +49 -1
- package/docs/wallet.md +340 -93
- package/mobile/out/src/monitor/tasks/TaskReorg.d.ts.map +1 -1
- package/mobile/out/src/monitor/tasks/TaskReorg.js +5 -1
- package/mobile/out/src/monitor/tasks/TaskReorg.js.map +1 -1
- package/mobile/out/src/sdk/WERR_errors.d.ts +8 -0
- package/mobile/out/src/sdk/WERR_errors.d.ts.map +1 -1
- package/mobile/out/src/sdk/WERR_errors.js +33 -0
- package/mobile/out/src/sdk/WERR_errors.js.map +1 -1
- package/mobile/out/src/sdk/WalletError.d.ts +19 -0
- package/mobile/out/src/sdk/WalletError.d.ts.map +1 -1
- package/mobile/out/src/sdk/WalletError.js +42 -1
- package/mobile/out/src/sdk/WalletError.js.map +1 -1
- package/mobile/out/src/sdk/WalletErrorFromJson.d.ts +12 -0
- package/mobile/out/src/sdk/WalletErrorFromJson.d.ts.map +1 -0
- package/mobile/out/src/sdk/WalletErrorFromJson.js +69 -0
- package/mobile/out/src/sdk/WalletErrorFromJson.js.map +1 -0
- package/mobile/out/src/sdk/index.d.ts +1 -0
- package/mobile/out/src/sdk/index.d.ts.map +1 -1
- package/mobile/out/src/sdk/index.js +1 -0
- package/mobile/out/src/sdk/index.js.map +1 -1
- package/mobile/out/src/services/chaintracker/ChaintracksChainTracker.js +1 -1
- package/mobile/out/src/services/chaintracker/ChaintracksChainTracker.js.map +1 -1
- package/mobile/out/src/services/chaintracker/chaintracks/util/ChaintracksFetch.d.ts.map +1 -1
- package/mobile/out/src/services/chaintracker/chaintracks/util/ChaintracksFetch.js +16 -9
- package/mobile/out/src/services/chaintracker/chaintracks/util/ChaintracksFetch.js.map +1 -1
- package/mobile/out/src/storage/WalletStorageManager.d.ts.map +1 -1
- package/mobile/out/src/storage/WalletStorageManager.js.map +1 -1
- package/mobile/out/src/storage/remoting/StorageClient.d.ts.map +1 -1
- package/mobile/out/src/storage/remoting/StorageClient.js +3 -5
- package/mobile/out/src/storage/remoting/StorageClient.js.map +1 -1
- package/mobile/package-lock.json +2 -2
- package/mobile/package.json +1 -1
- package/out/src/monitor/tasks/TaskReorg.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskReorg.js +5 -1
- package/out/src/monitor/tasks/TaskReorg.js.map +1 -1
- package/out/src/sdk/WERR_errors.d.ts +8 -0
- package/out/src/sdk/WERR_errors.d.ts.map +1 -1
- package/out/src/sdk/WERR_errors.js +33 -0
- package/out/src/sdk/WERR_errors.js.map +1 -1
- package/out/src/sdk/WalletError.d.ts +19 -0
- package/out/src/sdk/WalletError.d.ts.map +1 -1
- package/out/src/sdk/WalletError.js +42 -1
- package/out/src/sdk/WalletError.js.map +1 -1
- package/out/src/sdk/WalletErrorFromJson.d.ts +12 -0
- package/out/src/sdk/WalletErrorFromJson.d.ts.map +1 -0
- package/out/src/sdk/WalletErrorFromJson.js +69 -0
- package/out/src/sdk/WalletErrorFromJson.js.map +1 -0
- package/out/src/sdk/__test/WalletError.test.d.ts +2 -0
- package/out/src/sdk/__test/WalletError.test.d.ts.map +1 -0
- package/out/src/sdk/__test/WalletError.test.js +255 -0
- package/out/src/sdk/__test/WalletError.test.js.map +1 -0
- package/out/src/sdk/index.d.ts +1 -0
- package/out/src/sdk/index.d.ts.map +1 -1
- package/out/src/sdk/index.js +1 -0
- package/out/src/sdk/index.js.map +1 -1
- package/out/src/services/__tests/verifyBeef.test.js.map +1 -1
- package/out/src/services/chaintracker/ChaintracksChainTracker.js +1 -1
- package/out/src/services/chaintracker/ChaintracksChainTracker.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/ChaintracksFetch.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/ChaintracksFetch.js +16 -9
- package/out/src/services/chaintracker/chaintracks/util/ChaintracksFetch.js.map +1 -1
- package/out/src/storage/WalletStorageManager.d.ts.map +1 -1
- package/out/src/storage/WalletStorageManager.js.map +1 -1
- package/out/src/storage/remoting/StorageClient.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageClient.js +3 -5
- package/out/src/storage/remoting/StorageClient.js.map +1 -1
- package/out/src/storage/remoting/StorageServer.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageServer.js +12 -10
- package/out/src/storage/remoting/StorageServer.js.map +1 -1
- package/out/test/Wallet/specOps/specOps.man.test.js +8 -6
- package/out/test/Wallet/specOps/specOps.man.test.js.map +1 -1
- package/out/tsconfig.all.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/monitor/tasks/TaskReorg.ts +5 -1
- package/src/sdk/WERR_errors.ts +34 -0
- package/src/sdk/WalletError.ts +42 -1
- package/src/sdk/WalletErrorFromJson.ts +80 -0
- package/src/sdk/WalletStorage.interfaces.ts +3 -3
- package/src/sdk/__test/WalletError.test.ts +318 -0
- package/src/sdk/index.ts +1 -0
- package/src/services/__tests/verifyBeef.test.ts +0 -1
- package/src/services/chaintracker/ChaintracksChainTracker.ts +1 -1
- package/src/services/chaintracker/chaintracks/util/ChaintracksFetch.ts +18 -11
- package/src/storage/WalletStorageManager.ts +16 -19
- package/src/storage/methods/internalizeAction.ts +1 -1
- package/src/storage/remoting/StorageClient.ts +4 -6
- package/src/storage/remoting/StorageServer.ts +13 -11
- package/test/Wallet/specOps/specOps.man.test.ts +6 -4
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,13 @@ This document captures the history of significant changes to the wallet-toolbox
|
|
|
4
4
|
The git commit history contains the details but is unable to draw
|
|
5
5
|
attention to changes that materially alter behavior or extend functionality.
|
|
6
6
|
|
|
7
|
+
## wallet-toolbox 1.6.34
|
|
8
|
+
|
|
9
|
+
- Change StorageServer / StorageClient to rethrow WERR errors including WERR_REVIEW_ACTIONS
|
|
10
|
+
- Change ChaintracksChainTracker to default to new public services.
|
|
11
|
+
- Add WalletError.test.ts and resolve issues related to WERR_errors
|
|
12
|
+
- Add retry support to ChaintracksFetch download method to handle WoC rate limits.
|
|
13
|
+
|
|
7
14
|
## wallet-toolbox 1.6.33
|
|
8
15
|
|
|
9
16
|
- Add schema migration: outputs spendable index.
|
package/docs/client.md
CHANGED
|
@@ -14,86 +14,87 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
14
14
|
|
|
15
15
|
| | | |
|
|
16
16
|
| --- | --- | --- |
|
|
17
|
-
| [AdminStatsResult](#interface-adminstatsresult) | [
|
|
18
|
-
| [ArcConfig](#interface-arcconfig) | [
|
|
19
|
-
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [
|
|
20
|
-
| [AuthId](#interface-authid) | [
|
|
21
|
-
| [AuthPayload](#interface-authpayload) | [
|
|
22
|
-
| [BaseBlockHeader](#interface-baseblockheader) | [
|
|
23
|
-
| [BitailsConfig](#interface-bitailsconfig) | [
|
|
24
|
-
| [BitailsMerkleProof](#interface-bitailsmerkleproof) | [
|
|
25
|
-
| [BlockHeader](#interface-blockheader) | [
|
|
26
|
-
| [BsvExchangeRate](#interface-bsvexchangerate) | [
|
|
27
|
-
| [BulkFileDataManagerMergeResult](#interface-bulkfiledatamanagermergeresult) | [
|
|
28
|
-
| [BulkFileDataManagerOptions](#interface-bulkfiledatamanageroptions) | [
|
|
29
|
-
| [BulkHeaderFileInfo](#interface-bulkheaderfileinfo) | [
|
|
30
|
-
| [BulkHeaderFilesInfo](#interface-bulkheaderfilesinfo) | [
|
|
31
|
-
| [BulkIngestorApi](#interface-bulkingestorapi) | [
|
|
32
|
-
| [BulkIngestorBaseOptions](#interface-bulkingestorbaseoptions) | [
|
|
33
|
-
| [BulkIngestorCDNOptions](#interface-bulkingestorcdnoptions) | [
|
|
34
|
-
| [BulkIngestorWhatsOnChainOptions](#interface-bulkingestorwhatsonchainoptions) | [
|
|
35
|
-
| [BulkStorageApi](#interface-bulkstorageapi) | [
|
|
36
|
-
| [BulkStorageBaseOptions](#interface-bulkstoragebaseoptions) | [
|
|
37
|
-
| [BulkSyncResult](#interface-bulksyncresult) | [
|
|
38
|
-
| [CertOpsWallet](#interface-certopswallet) | [
|
|
39
|
-
| [Certifier](#interface-certifier) | [
|
|
40
|
-
| [ChaintracksApi](#interface-chaintracksapi) | [
|
|
41
|
-
| [ChaintracksAppendableFileApi](#interface-chaintracksappendablefileapi) | [
|
|
42
|
-
| [ChaintracksChainTrackerOptions](#interface-chaintrackschaintrackeroptions) | [
|
|
43
|
-
| [ChaintracksClientApi](#interface-chaintracksclientapi) | [
|
|
44
|
-
| [ChaintracksFetchApi](#interface-chaintracksfetchapi) | [
|
|
45
|
-
| [ChaintracksFsApi](#interface-chaintracksfsapi) | [
|
|
46
|
-
| [ChaintracksInfoApi](#interface-chaintracksinfoapi) | [
|
|
47
|
-
| [ChaintracksManagementApi](#interface-chaintracksmanagementapi) | [
|
|
48
|
-
| [ChaintracksOptions](#interface-chaintracksoptions) | [
|
|
49
|
-
| [ChaintracksPackageInfoApi](#interface-chaintrackspackageinfoapi) | [
|
|
50
|
-
| [ChaintracksReadableFileApi](#interface-chaintracksreadablefileapi) | [
|
|
51
|
-
| [ChaintracksServiceClientOptions](#interface-chaintracksserviceclientoptions) | [
|
|
52
|
-
| [ChaintracksStorageApi](#interface-chaintracksstorageapi) | [
|
|
53
|
-
| [ChaintracksStorageBaseOptions](#interface-chaintracksstoragebaseoptions) | [
|
|
54
|
-
| [ChaintracksStorageBulkFileApi](#interface-chaintracksstoragebulkfileapi) | [
|
|
55
|
-
| [ChaintracksStorageIdbOptions](#interface-chaintracksstorageidboptions) | [
|
|
56
|
-
| [ChaintracksStorageIdbSchema](#interface-chaintracksstorageidbschema) | [
|
|
57
|
-
| [ChaintracksStorageIngestApi](#interface-chaintracksstorageingestapi) | [
|
|
58
|
-
| [ChaintracksStorageNoDbOptions](#interface-chaintracksstoragenodboptions) | [
|
|
59
|
-
| [ChaintracksStorageQueryApi](#interface-chaintracksstoragequeryapi) | [
|
|
60
|
-
| [ChaintracksWritableFileApi](#interface-chaintrackswritablefileapi) | [
|
|
61
|
-
| [CommitNewTxResults](#interface-commitnewtxresults) | [
|
|
62
|
-
| [CompleteAuthResponse](#interface-completeauthresponse) | [
|
|
63
|
-
| [CreateActionResultX](#interface-createactionresultx) | [
|
|
64
|
-
| [DeactivedHeader](#interface-deactivedheader) | [
|
|
65
|
-
| [EntitySyncMap](#interface-entitysyncmap) | [
|
|
66
|
-
| [EntityTimeStamp](#interface-entitytimestamp) | [
|
|
67
|
-
| [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [
|
|
17
|
+
| [AdminStatsResult](#interface-adminstatsresult) | [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) |
|
|
18
|
+
| [ArcConfig](#interface-arcconfig) | [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [SyncChunk](#interface-syncchunk) |
|
|
19
|
+
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [GetScriptHashHistory](#interface-getscripthashhistory) | [SyncError](#interface-syncerror) |
|
|
20
|
+
| [AuthId](#interface-authid) | [GetScriptHashHistoryResult](#interface-getscripthashhistoryresult) | [SyncMap](#interface-syncmap) |
|
|
21
|
+
| [AuthPayload](#interface-authpayload) | [GetStatusForTxidsResult](#interface-getstatusfortxidsresult) | [TableCertificate](#interface-tablecertificate) |
|
|
22
|
+
| [BaseBlockHeader](#interface-baseblockheader) | [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [TableCertificateField](#interface-tablecertificatefield) |
|
|
23
|
+
| [BitailsConfig](#interface-bitailsconfig) | [GetUtxoStatusResult](#interface-getutxostatusresult) | [TableCertificateX](#interface-tablecertificatex) |
|
|
24
|
+
| [BitailsMerkleProof](#interface-bitailsmerkleproof) | [GroupedPermissionRequest](#interface-groupedpermissionrequest) | [TableCommission](#interface-tablecommission) |
|
|
25
|
+
| [BlockHeader](#interface-blockheader) | [GroupedPermissions](#interface-groupedpermissions) | [TableMonitorEvent](#interface-tablemonitorevent) |
|
|
26
|
+
| [BsvExchangeRate](#interface-bsvexchangerate) | [HeightRangeApi](#interface-heightrangeapi) | [TableOutput](#interface-tableoutput) |
|
|
27
|
+
| [BulkFileDataManagerMergeResult](#interface-bulkfiledatamanagermergeresult) | [HeightRanges](#interface-heightranges) | [TableOutputBasket](#interface-tableoutputbasket) |
|
|
28
|
+
| [BulkFileDataManagerOptions](#interface-bulkfiledatamanageroptions) | [KeyPair](#interface-keypair) | [TableOutputTag](#interface-tableoutputtag) |
|
|
29
|
+
| [BulkHeaderFileInfo](#interface-bulkheaderfileinfo) | [KeyPairAddress](#interface-keypairaddress) | [TableOutputTagMap](#interface-tableoutputtagmap) |
|
|
30
|
+
| [BulkHeaderFilesInfo](#interface-bulkheaderfilesinfo) | [ListActionsSpecOp](#interface-listactionsspecop) | [TableOutputX](#interface-tableoutputx) |
|
|
31
|
+
| [BulkIngestorApi](#interface-bulkingestorapi) | [ListOutputsSpecOp](#interface-listoutputsspecop) | [TableProvenTx](#interface-tableproventx) |
|
|
32
|
+
| [BulkIngestorBaseOptions](#interface-bulkingestorbaseoptions) | [LiveBlockHeader](#interface-liveblockheader) | [TableProvenTxReq](#interface-tableproventxreq) |
|
|
33
|
+
| [BulkIngestorCDNOptions](#interface-bulkingestorcdnoptions) | [LiveIngestorApi](#interface-liveingestorapi) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) |
|
|
34
|
+
| [BulkIngestorWhatsOnChainOptions](#interface-bulkingestorwhatsonchainoptions) | [LiveIngestorBaseOptions](#interface-liveingestorbaseoptions) | [TableSettings](#interface-tablesettings) |
|
|
35
|
+
| [BulkStorageApi](#interface-bulkstorageapi) | [LiveIngestorWhatsOnChainOptions](#interface-liveingestorwhatsonchainoptions) | [TableSyncState](#interface-tablesyncstate) |
|
|
36
|
+
| [BulkStorageBaseOptions](#interface-bulkstoragebaseoptions) | [MonitorOptions](#interface-monitoroptions) | [TableTransaction](#interface-tabletransaction) |
|
|
37
|
+
| [BulkSyncResult](#interface-bulksyncresult) | [OutPoint](#interface-outpoint) | [TableTxLabel](#interface-tabletxlabel) |
|
|
38
|
+
| [CertOpsWallet](#interface-certopswallet) | [Paged](#interface-paged) | [TableTxLabelMap](#interface-tabletxlabelmap) |
|
|
39
|
+
| [Certifier](#interface-certifier) | [PendingSignAction](#interface-pendingsignaction) | [TableUser](#interface-tableuser) |
|
|
40
|
+
| [ChaintracksApi](#interface-chaintracksapi) | [PendingStorageInput](#interface-pendingstorageinput) | [TaskPurgeParams](#interface-taskpurgeparams) |
|
|
41
|
+
| [ChaintracksAppendableFileApi](#interface-chaintracksappendablefileapi) | [PermissionRequest](#interface-permissionrequest) | [TrustSettings](#interface-trustsettings) |
|
|
42
|
+
| [ChaintracksChainTrackerOptions](#interface-chaintrackschaintrackeroptions) | [PermissionToken](#interface-permissiontoken) | [TrxToken](#interface-trxtoken) |
|
|
43
|
+
| [ChaintracksClientApi](#interface-chaintracksclientapi) | [PermissionsManagerConfig](#interface-permissionsmanagerconfig) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
|
|
44
|
+
| [ChaintracksFetchApi](#interface-chaintracksfetchapi) | [PostBeefResult](#interface-postbeefresult) | [TxScriptOffsets](#interface-txscriptoffsets) |
|
|
45
|
+
| [ChaintracksFsApi](#interface-chaintracksfsapi) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [UMPToken](#interface-umptoken) |
|
|
46
|
+
| [ChaintracksInfoApi](#interface-chaintracksinfoapi) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [UMPTokenInteractor](#interface-umptokeninteractor) |
|
|
47
|
+
| [ChaintracksManagementApi](#interface-chaintracksmanagementapi) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
|
|
48
|
+
| [ChaintracksOptions](#interface-chaintracksoptions) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
|
|
49
|
+
| [ChaintracksPackageInfoApi](#interface-chaintrackspackageinfoapi) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [ValidAbortActionArgs](#interface-validabortactionargs) |
|
|
50
|
+
| [ChaintracksReadableFileApi](#interface-chaintracksreadablefileapi) | [PostTxsResult](#interface-posttxsresult) | [ValidAcquireCertificateArgs](#interface-validacquirecertificateargs) |
|
|
51
|
+
| [ChaintracksServiceClientOptions](#interface-chaintracksserviceclientoptions) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [ValidAcquireDirectCertificateArgs](#interface-validacquiredirectcertificateargs) |
|
|
52
|
+
| [ChaintracksStorageApi](#interface-chaintracksstorageapi) | [Profile](#interface-profile) | [ValidAcquireIssuanceCertificateArgs](#interface-validacquireissuancecertificateargs) |
|
|
53
|
+
| [ChaintracksStorageBaseOptions](#interface-chaintracksstoragebaseoptions) | [ProvenOrRawTx](#interface-provenorrawtx) | [ValidBasketInsertion](#interface-validbasketinsertion) |
|
|
54
|
+
| [ChaintracksStorageBulkFileApi](#interface-chaintracksstoragebulkfileapi) | [ProvenTransactionStatus](#interface-proventransactionstatus) | [ValidCreateActionArgs](#interface-validcreateactionargs) |
|
|
55
|
+
| [ChaintracksStorageIdbOptions](#interface-chaintracksstorageidboptions) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [ValidCreateActionInput](#interface-validcreateactioninput) |
|
|
56
|
+
| [ChaintracksStorageIdbSchema](#interface-chaintracksstorageidbschema) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [ValidCreateActionOptions](#interface-validcreateactionoptions) |
|
|
57
|
+
| [ChaintracksStorageIngestApi](#interface-chaintracksstorageingestapi) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [ValidCreateActionOutput](#interface-validcreateactionoutput) |
|
|
58
|
+
| [ChaintracksStorageNoDbOptions](#interface-chaintracksstoragenodboptions) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [ValidDiscoverByAttributesArgs](#interface-validdiscoverbyattributesargs) |
|
|
59
|
+
| [ChaintracksStorageQueryApi](#interface-chaintracksstoragequeryapi) | [ProviderCallHistory](#interface-providercallhistory) | [ValidDiscoverByIdentityKeyArgs](#interface-validdiscoverbyidentitykeyargs) |
|
|
60
|
+
| [ChaintracksWritableFileApi](#interface-chaintrackswritablefileapi) | [PurgeParams](#interface-purgeparams) | [ValidInternalizeActionArgs](#interface-validinternalizeactionargs) |
|
|
61
|
+
| [CommitNewTxResults](#interface-commitnewtxresults) | [PurgeResults](#interface-purgeresults) | [ValidInternalizeOutput](#interface-validinternalizeoutput) |
|
|
62
|
+
| [CompleteAuthResponse](#interface-completeauthresponse) | [ReproveHeaderResult](#interface-reproveheaderresult) | [ValidListActionsArgs](#interface-validlistactionsargs) |
|
|
63
|
+
| [CreateActionResultX](#interface-createactionresultx) | [ReproveProvenResult](#interface-reproveprovenresult) | [ValidListCertificatesArgs](#interface-validlistcertificatesargs) |
|
|
64
|
+
| [DeactivedHeader](#interface-deactivedheader) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [ValidListOutputsArgs](#interface-validlistoutputsargs) |
|
|
65
|
+
| [EntitySyncMap](#interface-entitysyncmap) | [ReviewActionResult](#interface-reviewactionresult) | [ValidProcessActionArgs](#interface-validprocessactionargs) |
|
|
66
|
+
| [EntityTimeStamp](#interface-entitytimestamp) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [ValidProcessActionOptions](#interface-validprocessactionoptions) |
|
|
67
|
+
| [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [ValidProveCertificateArgs](#interface-validprovecertificateargs) |
|
|
68
68
|
| [ExtendedVerifiableCertificate](#interface-extendedverifiablecertificate) | [ServiceCall](#interface-servicecall) | [ValidRelinquishCertificateArgs](#interface-validrelinquishcertificateargs) |
|
|
69
|
-
| [FiatExchangeRates](#interface-fiatexchangerates) | [
|
|
70
|
-
| [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [
|
|
71
|
-
| [FindCertificatesArgs](#interface-findcertificatesargs) | [
|
|
72
|
-
| [FindCommissionsArgs](#interface-findcommissionsargs) | [
|
|
73
|
-
| [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [
|
|
74
|
-
| [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [
|
|
75
|
-
| [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [
|
|
76
|
-
| [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [
|
|
77
|
-
| [FindOutputTagsArgs](#interface-findoutputtagsargs) | [
|
|
78
|
-
| [FindOutputsArgs](#interface-findoutputsargs) | [
|
|
79
|
-
| [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [
|
|
80
|
-
| [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [
|
|
81
|
-
| [FindProvenTxsArgs](#interface-findproventxsargs) | [
|
|
82
|
-
| [FindSincePagedArgs](#interface-findsincepagedargs) | [
|
|
83
|
-
| [FindSyncStatesArgs](#interface-findsyncstatesargs) | [
|
|
84
|
-
| [FindTransactionsArgs](#interface-findtransactionsargs) | [
|
|
85
|
-
| [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [
|
|
86
|
-
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [
|
|
87
|
-
| [FindUsersArgs](#interface-findusersargs) | [
|
|
88
|
-
| [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [
|
|
89
|
-
| [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [
|
|
90
|
-
| [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [
|
|
91
|
-
| [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [
|
|
92
|
-
| [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [
|
|
93
|
-
| [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [
|
|
94
|
-
| [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [
|
|
95
|
-
| [GetHeaderByteFileLinksResult](#interface-getheaderbytefilelinksresult) | [
|
|
96
|
-
| [GetMerklePathResult](#interface-getmerklepathresult) | [
|
|
69
|
+
| [FiatExchangeRates](#interface-fiatexchangerates) | [ServiceCall](#interface-servicecall) | [ValidRelinquishOutputArgs](#interface-validrelinquishoutputargs) |
|
|
70
|
+
| [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [ServiceCallHistory](#interface-servicecallhistory) | [ValidSignActionArgs](#interface-validsignactionargs) |
|
|
71
|
+
| [FindCertificatesArgs](#interface-findcertificatesargs) | [ServiceCallHistoryCounts](#interface-servicecallhistorycounts) | [ValidSignActionOptions](#interface-validsignactionoptions) |
|
|
72
|
+
| [FindCommissionsArgs](#interface-findcommissionsargs) | [ServiceToCall](#interface-servicetocall) | [ValidWalletPayment](#interface-validwalletpayment) |
|
|
73
|
+
| [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [SetupClientWalletArgs](#interface-setupclientwalletargs) | [ValidWalletSignerArgs](#interface-validwalletsignerargs) |
|
|
74
|
+
| [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [SetupClientWalletClientArgs](#interface-setupclientwalletclientargs) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
|
|
75
|
+
| [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [SetupWallet](#interface-setupwallet) | [WalletArgs](#interface-walletargs) |
|
|
76
|
+
| [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [SetupWalletClient](#interface-setupwalletclient) | [WalletBalance](#interface-walletbalance) |
|
|
77
|
+
| [FindOutputTagsArgs](#interface-findoutputtagsargs) | [SetupWalletIdb](#interface-setupwalletidb) | [WalletPermissionsManagerCallbacks](#interface-walletpermissionsmanagercallbacks) |
|
|
78
|
+
| [FindOutputsArgs](#interface-findoutputsargs) | [SetupWalletIdbArgs](#interface-setupwalletidbargs) | [WalletServices](#interface-walletservices) |
|
|
79
|
+
| [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [SignActionResultX](#interface-signactionresultx) | [WalletServicesOptions](#interface-walletservicesoptions) |
|
|
80
|
+
| [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [StartAuthResponse](#interface-startauthresponse) | [WalletSettings](#interface-walletsettings) |
|
|
81
|
+
| [FindProvenTxsArgs](#interface-findproventxsargs) | [StatusForTxidResult](#interface-statusfortxidresult) | [WalletSettingsManagerConfig](#interface-walletsettingsmanagerconfig) |
|
|
82
|
+
| [FindSincePagedArgs](#interface-findsincepagedargs) | [StorageAdminStats](#interface-storageadminstats) | [WalletSigner](#interface-walletsigner) |
|
|
83
|
+
| [FindSyncStatesArgs](#interface-findsyncstatesargs) | [StorageCreateActionResult](#interface-storagecreateactionresult) | [WalletStorage](#interface-walletstorage) |
|
|
84
|
+
| [FindTransactionsArgs](#interface-findtransactionsargs) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) | [WalletStorageInfo](#interface-walletstorageinfo) |
|
|
85
|
+
| [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) | [WalletStorageProvider](#interface-walletstorageprovider) |
|
|
86
|
+
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [StorageFeeModel](#interface-storagefeemodel) | [WalletStorageReader](#interface-walletstoragereader) |
|
|
87
|
+
| [FindUsersArgs](#interface-findusersargs) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) | [WalletStorageSync](#interface-walletstoragesync) |
|
|
88
|
+
| [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StorageIdbOptions](#interface-storageidboptions) | [WalletStorageSyncReader](#interface-walletstoragesyncreader) |
|
|
89
|
+
| [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [StorageIdbSchema](#interface-storageidbschema) | [WalletStorageWriter](#interface-walletstoragewriter) |
|
|
90
|
+
| [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [StorageIdentity](#interface-storageidentity) | [WalletTheme](#interface-wallettheme) |
|
|
91
|
+
| [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) | [WhatsOnChainServicesOptions](#interface-whatsonchainservicesoptions) |
|
|
92
|
+
| [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [StorageProcessActionArgs](#interface-storageprocessactionargs) | [WocChainInfo](#interface-wocchaininfo) |
|
|
93
|
+
| [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [StorageProcessActionResults](#interface-storageprocessactionresults) | [WocGetHeaderByteFileLinks](#interface-wocgetheaderbytefilelinks) |
|
|
94
|
+
| [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [StorageProvenOrReq](#interface-storageprovenorreq) | [WocGetHeadersHeader](#interface-wocgetheadersheader) |
|
|
95
|
+
| [GetHeaderByteFileLinksResult](#interface-getheaderbytefilelinksresult) | [StorageProviderOptions](#interface-storageprovideroptions) | [WocHeader](#interface-wocheader) |
|
|
96
|
+
| [GetMerklePathResult](#interface-getmerklepathresult) | [StorageReaderOptions](#interface-storagereaderoptions) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
|
|
97
|
+
| [GetRawTxResult](#interface-getrawtxresult) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) | |
|
|
97
98
|
|
|
98
99
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
99
100
|
|
|
@@ -4629,6 +4630,124 @@ export interface PurgeResults {
|
|
|
4629
4630
|
|
|
4630
4631
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4631
4632
|
|
|
4633
|
+
---
|
|
4634
|
+
##### Interface: ReproveHeaderResult
|
|
4635
|
+
|
|
4636
|
+
Returned results from WalletStorageManager reproveHeader method.
|
|
4637
|
+
|
|
4638
|
+
```ts
|
|
4639
|
+
export interface ReproveHeaderResult {
|
|
4640
|
+
log: string;
|
|
4641
|
+
updated: {
|
|
4642
|
+
was: TableProvenTx;
|
|
4643
|
+
update: Partial<TableProvenTx>;
|
|
4644
|
+
logUpdate: string;
|
|
4645
|
+
}[];
|
|
4646
|
+
unchanged: TableProvenTx[];
|
|
4647
|
+
unavailable: TableProvenTx[];
|
|
4648
|
+
}
|
|
4649
|
+
```
|
|
4650
|
+
|
|
4651
|
+
See also: [TableProvenTx](./storage.md#interface-tableproventx)
|
|
4652
|
+
|
|
4653
|
+
###### Property log
|
|
4654
|
+
|
|
4655
|
+
Human readable log of the reproveHeader process.
|
|
4656
|
+
|
|
4657
|
+
```ts
|
|
4658
|
+
log: string
|
|
4659
|
+
```
|
|
4660
|
+
|
|
4661
|
+
###### Property unavailable
|
|
4662
|
+
|
|
4663
|
+
List of proven_txs records that were checked but currently proof data is unavailable.
|
|
4664
|
+
|
|
4665
|
+
```ts
|
|
4666
|
+
unavailable: TableProvenTx[]
|
|
4667
|
+
```
|
|
4668
|
+
See also: [TableProvenTx](./storage.md#interface-tableproventx)
|
|
4669
|
+
|
|
4670
|
+
###### Property unchanged
|
|
4671
|
+
|
|
4672
|
+
List of proven_txs records that were checked but currently available proof is unchanged.
|
|
4673
|
+
|
|
4674
|
+
```ts
|
|
4675
|
+
unchanged: TableProvenTx[]
|
|
4676
|
+
```
|
|
4677
|
+
See also: [TableProvenTx](./storage.md#interface-tableproventx)
|
|
4678
|
+
|
|
4679
|
+
###### Property updated
|
|
4680
|
+
|
|
4681
|
+
List of proven_txs records that were updated with new proof data.
|
|
4682
|
+
|
|
4683
|
+
```ts
|
|
4684
|
+
updated: {
|
|
4685
|
+
was: TableProvenTx;
|
|
4686
|
+
update: Partial<TableProvenTx>;
|
|
4687
|
+
logUpdate: string;
|
|
4688
|
+
}[]
|
|
4689
|
+
```
|
|
4690
|
+
See also: [TableProvenTx](./storage.md#interface-tableproventx)
|
|
4691
|
+
|
|
4692
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4693
|
+
|
|
4694
|
+
---
|
|
4695
|
+
##### Interface: ReproveProvenResult
|
|
4696
|
+
|
|
4697
|
+
Returned results from WalletStorageManager reproveProven method.
|
|
4698
|
+
|
|
4699
|
+
```ts
|
|
4700
|
+
export interface ReproveProvenResult {
|
|
4701
|
+
log: string;
|
|
4702
|
+
updated?: {
|
|
4703
|
+
update: Partial<TableProvenTx>;
|
|
4704
|
+
logUpdate: string;
|
|
4705
|
+
};
|
|
4706
|
+
unchanged: boolean;
|
|
4707
|
+
unavailable: boolean;
|
|
4708
|
+
}
|
|
4709
|
+
```
|
|
4710
|
+
|
|
4711
|
+
See also: [TableProvenTx](./storage.md#interface-tableproventx)
|
|
4712
|
+
|
|
4713
|
+
###### Property log
|
|
4714
|
+
|
|
4715
|
+
Human readable log of the reproveProven process.
|
|
4716
|
+
|
|
4717
|
+
```ts
|
|
4718
|
+
log: string
|
|
4719
|
+
```
|
|
4720
|
+
|
|
4721
|
+
###### Property unavailable
|
|
4722
|
+
|
|
4723
|
+
True if proof data for proven_txs record is currently unavailable.
|
|
4724
|
+
|
|
4725
|
+
```ts
|
|
4726
|
+
unavailable: boolean
|
|
4727
|
+
```
|
|
4728
|
+
|
|
4729
|
+
###### Property unchanged
|
|
4730
|
+
|
|
4731
|
+
True if proof data for proven_txs record was found to be unchanged.
|
|
4732
|
+
|
|
4733
|
+
```ts
|
|
4734
|
+
unchanged: boolean
|
|
4735
|
+
```
|
|
4736
|
+
|
|
4737
|
+
###### Property updated
|
|
4738
|
+
|
|
4739
|
+
Valid if proof data for proven_txs record is available and has changed.
|
|
4740
|
+
|
|
4741
|
+
```ts
|
|
4742
|
+
updated?: {
|
|
4743
|
+
update: Partial<TableProvenTx>;
|
|
4744
|
+
logUpdate: string;
|
|
4745
|
+
}
|
|
4746
|
+
```
|
|
4747
|
+
See also: [TableProvenTx](./storage.md#interface-tableproventx)
|
|
4748
|
+
|
|
4749
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4750
|
+
|
|
4632
4751
|
---
|
|
4633
4752
|
##### Interface: RequestSyncChunkArgs
|
|
4634
4753
|
|
|
@@ -11427,6 +11546,18 @@ callOnProvenTransaction(txStatus: ProvenTransactionStatus): void
|
|
|
11427
11546
|
```
|
|
11428
11547
|
See also: [ProvenTransactionStatus](./client.md#interface-proventransactionstatus)
|
|
11429
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
|
+
|
|
11430
11561
|
###### Method processNewBlockHeader
|
|
11431
11562
|
|
|
11432
11563
|
Process new chain header event received from Chaintracks
|
|
@@ -13873,7 +14004,7 @@ They must be shifted out as they are processed.
|
|
|
13873
14004
|
The current implementation ages deactivation notifications by 10 minutes with each retry.
|
|
13874
14005
|
If a successful proof update confirms original proof data after 3 retries, the original is retained.
|
|
13875
14006
|
|
|
13876
|
-
In normal operation there should
|
|
14007
|
+
In normal operation there should rarely be any work for this task to perform.
|
|
13877
14008
|
The most common result is that there are no matching proven_txs records because
|
|
13878
14009
|
generating new proven_txs records intentionally lags new block generation to
|
|
13879
14010
|
minimize this disruption.
|
|
@@ -13883,17 +14014,8 @@ It is very disruptive to update a proven_txs record because:
|
|
|
13883
14014
|
- Generated beefs are impacted.
|
|
13884
14015
|
- Updated proof data may be unavailable at the time a reorg is first reported.
|
|
13885
14016
|
|
|
13886
|
-
|
|
13887
|
-
|
|
13888
|
-
createAction fails to verify against the chaintracker.
|
|
13889
|
-
|
|
13890
|
-
An alternate approach to processing these events is to revert the proven_txs record to a proven_tx_reqs record.
|
|
13891
|
-
Pros:
|
|
13892
|
-
- The same multiple attempt logic that already exists is reused.
|
|
13893
|
-
- Failing to obtain a new proof already has transaction failure handling in place.
|
|
13894
|
-
- Generated beefs automatically become one generation deeper, potentially allowing transaction outputs to be spent.
|
|
13895
|
-
Cons:
|
|
13896
|
-
- 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.
|
|
13897
14019
|
|
|
13898
14020
|
```ts
|
|
13899
14021
|
export class TaskReorg extends WalletMonitorTask {
|
|
@@ -13909,6 +14031,25 @@ export class TaskReorg extends WalletMonitorTask {
|
|
|
13909
14031
|
|
|
13910
14032
|
See also: [DeactivedHeader](./monitor.md#interface-deactivedheader), [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
13911
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
|
+
|
|
13912
14053
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13913
14054
|
|
|
13914
14055
|
---
|
|
@@ -14250,6 +14391,7 @@ to pay the fee to unlock and spend the outputs used to provide the additional sa
|
|
|
14250
14391
|
```ts
|
|
14251
14392
|
export class WERR_INSUFFICIENT_FUNDS extends WalletError {
|
|
14252
14393
|
constructor(public totalSatoshisNeeded: number, public moreSatoshisNeeded: number)
|
|
14394
|
+
override toJson(): string
|
|
14253
14395
|
}
|
|
14254
14396
|
```
|
|
14255
14397
|
|
|
@@ -14314,6 +14456,7 @@ This is an example of an error object with a custom property `parameter` and tem
|
|
|
14314
14456
|
```ts
|
|
14315
14457
|
export class WERR_INVALID_PARAMETER extends WalletError {
|
|
14316
14458
|
constructor(public parameter: string, mustBe?: string)
|
|
14459
|
+
override toJson(): string
|
|
14317
14460
|
}
|
|
14318
14461
|
```
|
|
14319
14462
|
|
|
@@ -14327,6 +14470,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
14327
14470
|
```ts
|
|
14328
14471
|
export class WERR_INVALID_PUBLIC_KEY extends WalletError {
|
|
14329
14472
|
constructor(public key: string, network: WalletNetwork = "mainnet")
|
|
14473
|
+
protected override toJson(): string
|
|
14330
14474
|
}
|
|
14331
14475
|
```
|
|
14332
14476
|
|
|
@@ -14357,6 +14501,7 @@ This is an example of an error object with a custom property `parameter`
|
|
|
14357
14501
|
```ts
|
|
14358
14502
|
export class WERR_MISSING_PARAMETER extends WalletError {
|
|
14359
14503
|
constructor(public parameter: string)
|
|
14504
|
+
override toJson(): string
|
|
14360
14505
|
}
|
|
14361
14506
|
```
|
|
14362
14507
|
|
|
@@ -14419,6 +14564,7 @@ paid to processing errors.
|
|
|
14419
14564
|
```ts
|
|
14420
14565
|
export class WERR_REVIEW_ACTIONS extends WalletError {
|
|
14421
14566
|
constructor(public reviewActionResults: ReviewActionResult[], public sendWithResults: SendWithResult[], public txid?: TXIDHexString, public tx?: AtomicBEEF, public noSendChange?: OutpointString[])
|
|
14567
|
+
override toJson(): string
|
|
14422
14568
|
}
|
|
14423
14569
|
```
|
|
14424
14570
|
|
|
@@ -14790,6 +14936,8 @@ export class WalletError extends Error implements WalletErrorObject {
|
|
|
14790
14936
|
code: string;
|
|
14791
14937
|
description: string;
|
|
14792
14938
|
}
|
|
14939
|
+
protected toJson(): string
|
|
14940
|
+
static unknownToJson(error: unknown | WalletError): string
|
|
14793
14941
|
}
|
|
14794
14942
|
```
|
|
14795
14943
|
|
|
@@ -14816,6 +14964,37 @@ static fromUnknown(err: unknown): WalletError
|
|
|
14816
14964
|
```
|
|
14817
14965
|
See also: [WalletError](./client.md#class-walleterror)
|
|
14818
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
|
+
|
|
14819
14998
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
14820
14999
|
|
|
14821
15000
|
---
|
|
@@ -15547,6 +15726,9 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
15547
15726
|
async findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>
|
|
15548
15727
|
async findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>
|
|
15549
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>
|
|
15550
15732
|
async syncFromReader(identityKey: string, reader: sdk.WalletStorageSyncReader, activeSync?: sdk.WalletStorageSync, log: string = ""): Promise<{
|
|
15551
15733
|
inserts: number;
|
|
15552
15734
|
updates: number;
|
|
@@ -15564,7 +15746,7 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
15564
15746
|
}
|
|
15565
15747
|
```
|
|
15566
15748
|
|
|
15567
|
-
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)
|
|
15568
15750
|
|
|
15569
15751
|
###### Constructor
|
|
15570
15752
|
|
|
@@ -15682,6 +15864,39 @@ Throws
|
|
|
15682
15864
|
|
|
15683
15865
|
WERR_INVALID_PARAMETER if canMakeAvailable returns false.
|
|
15684
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
|
+
|
|
15685
15900
|
###### Method runAsSync
|
|
15686
15901
|
|
|
15687
15902
|
```ts
|
|
@@ -15711,6 +15926,18 @@ Argument Details
|
|
|
15711
15926
|
+ **storageIdentityKey**
|
|
15712
15927
|
+ of current backup storage provider that is to become the new active provider.
|
|
15713
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
|
+
|
|
15714
15941
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15715
15942
|
|
|
15716
15943
|
---
|
|
@@ -15896,6 +16123,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
15896
16123
|
|
|
15897
16124
|
| | | |
|
|
15898
16125
|
| --- | --- | --- |
|
|
16126
|
+
| [WalletErrorFromJson](#function-walleterrorfromjson) | [internalizeAction](#function-internalizeaction) | [validateAcquireDirectCertificateArgs](#function-validateacquiredirectcertificateargs) |
|
|
15899
16127
|
| [WocHeadersBulkListener](#function-wocheadersbulklistener) | [isBaseBlockHeader](#function-isbaseblockheader) | [validateAcquireIssuanceCertificateArgs](#function-validateacquireissuancecertificateargs) |
|
|
15900
16128
|
| [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [isBlockHeader](#function-isblockheader) | [validateAgainstDirtyHashes](#function-validateagainstdirtyhashes) |
|
|
15901
16129
|
| [WocHeadersLiveListener](#function-wocheaderslivelistener) | [isCreateActionSpecOp](#function-iscreateactionspecop) | [validateBasketInsertion](#function-validatebasketinsertion) |
|
|
@@ -15949,12 +16177,31 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
15949
16177
|
| [getSyncChunk](#function-getsyncchunk) | [validBulkHeaderFilesByFileHash](#function-validbulkheaderfilesbyfilehash) | [workBNtoBuffer](#function-workbntobuffer) |
|
|
15950
16178
|
| [getWhatsOnChainBlockHeaderByHash](#function-getwhatsonchainblockheaderbyhash) | [validateAbortActionArgs](#function-validateabortactionargs) | [writeUInt32BE](#function-writeuint32be) |
|
|
15951
16179
|
| [internalizeAction](#function-internalizeaction) | [validateAcquireCertificateArgs](#function-validateacquirecertificateargs) | [writeUInt32LE](#function-writeuint32le) |
|
|
15952
|
-
| [internalizeAction](#function-internalizeaction) | [validateAcquireDirectCertificateArgs](#function-validateacquiredirectcertificateargs) | |
|
|
15953
16180
|
|
|
15954
16181
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15955
16182
|
|
|
15956
16183
|
---
|
|
15957
16184
|
|
|
16185
|
+
##### Function: WalletErrorFromJson
|
|
16186
|
+
|
|
16187
|
+
Reconstruct the correct derived WalletError from a JSON object created by `WalletError.unknownToJson`.
|
|
16188
|
+
|
|
16189
|
+
This function is implemented as a separate function instead of a WalletError class static
|
|
16190
|
+
to avoid circular dependencies.
|
|
16191
|
+
|
|
16192
|
+
```ts
|
|
16193
|
+
export function WalletErrorFromJson(json: object): WalletError
|
|
16194
|
+
```
|
|
16195
|
+
|
|
16196
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
16197
|
+
|
|
16198
|
+
Returns
|
|
16199
|
+
|
|
16200
|
+
a WalletError derived error object, typically for re-throw.
|
|
16201
|
+
|
|
16202
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
16203
|
+
|
|
16204
|
+
---
|
|
15958
16205
|
##### Function: WocHeadersBulkListener
|
|
15959
16206
|
|
|
15960
16207
|
High speed WebSocket based based old block header listener
|