@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.
- package/CHANGELOG.md +11 -0
- package/docs/client.md +424 -154
- package/docs/monitor.md +34 -12
- package/docs/storage.md +49 -1
- package/docs/wallet.md +414 -144
- package/mobile/out/src/Wallet.d.ts +4 -0
- package/mobile/out/src/Wallet.d.ts.map +1 -1
- package/mobile/out/src/Wallet.js +1 -2
- package/mobile/out/src/Wallet.js.map +1 -1
- 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/sdk/validationHelpers.d.ts +8 -0
- package/mobile/out/src/sdk/validationHelpers.d.ts.map +1 -1
- package/mobile/out/src/sdk/validationHelpers.js +13 -2
- package/mobile/out/src/sdk/validationHelpers.js.map +1 -1
- package/mobile/out/src/services/chaintracker/ChaintracksChainTracker.d.ts.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/signer/methods/createAction.js +1 -1
- package/mobile/out/src/signer/methods/createAction.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/methods/createAction.d.ts.map +1 -1
- package/mobile/out/src/storage/methods/createAction.js +3 -0
- package/mobile/out/src/storage/methods/createAction.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/Wallet.d.ts +4 -0
- package/out/src/Wallet.d.ts.map +1 -1
- package/out/src/Wallet.js +1 -2
- package/out/src/Wallet.js.map +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/sdk/validationHelpers.d.ts +8 -0
- package/out/src/sdk/validationHelpers.d.ts.map +1 -1
- package/out/src/sdk/validationHelpers.js +13 -2
- package/out/src/sdk/validationHelpers.js.map +1 -1
- package/out/src/services/__tests/verifyBeef.test.js.map +1 -1
- package/out/src/services/chaintracker/ChaintracksChainTracker.d.ts.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/signer/methods/createAction.js +1 -1
- package/out/src/signer/methods/createAction.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/methods/createAction.d.ts.map +1 -1
- package/out/src/storage/methods/createAction.js +3 -0
- package/out/src/storage/methods/createAction.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/test/WalletClient/WERR.man.test.js +9 -6
- package/out/test/WalletClient/WERR.man.test.js.map +1 -1
- package/out/tsconfig.all.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/Wallet.ts +1 -3
- 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/sdk/validationHelpers.ts +15 -3
- package/src/services/__tests/verifyBeef.test.ts +0 -1
- package/src/services/chaintracker/ChaintracksChainTracker.ts +1 -2
- package/src/services/chaintracker/chaintracks/util/ChaintracksFetch.ts +18 -11
- package/src/signer/methods/createAction.ts +1 -1
- package/src/storage/WalletStorageManager.ts +16 -19
- package/src/storage/methods/createAction.ts +3 -0
- 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/test/WalletClient/WERR.man.test.ts +11 -7
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
|
|
|
@@ -7183,6 +7302,7 @@ export interface ValidProcessActionArgs extends ValidWalletSignerArgs {
|
|
|
7183
7302
|
isRemixChange: boolean;
|
|
7184
7303
|
isNoSend: boolean;
|
|
7185
7304
|
isDelayed: boolean;
|
|
7305
|
+
isTestWerrReviewActions: boolean;
|
|
7186
7306
|
}
|
|
7187
7307
|
```
|
|
7188
7308
|
|
|
@@ -11427,6 +11547,18 @@ callOnProvenTransaction(txStatus: ProvenTransactionStatus): void
|
|
|
11427
11547
|
```
|
|
11428
11548
|
See also: [ProvenTransactionStatus](./client.md#interface-proventransactionstatus)
|
|
11429
11549
|
|
|
11550
|
+
###### Method processHeader
|
|
11551
|
+
|
|
11552
|
+
Handler for new header events from Chaintracks.
|
|
11553
|
+
|
|
11554
|
+
To minimize reorg processing, new headers are aged before processing via TaskNewHeader.
|
|
11555
|
+
Therefore this handler is intentionally a no-op.
|
|
11556
|
+
|
|
11557
|
+
```ts
|
|
11558
|
+
processHeader(header: BlockHeader): void
|
|
11559
|
+
```
|
|
11560
|
+
See also: [BlockHeader](./client.md#interface-blockheader)
|
|
11561
|
+
|
|
11430
11562
|
###### Method processNewBlockHeader
|
|
11431
11563
|
|
|
11432
11564
|
Process new chain header event received from Chaintracks
|
|
@@ -13873,7 +14005,7 @@ They must be shifted out as they are processed.
|
|
|
13873
14005
|
The current implementation ages deactivation notifications by 10 minutes with each retry.
|
|
13874
14006
|
If a successful proof update confirms original proof data after 3 retries, the original is retained.
|
|
13875
14007
|
|
|
13876
|
-
In normal operation there should
|
|
14008
|
+
In normal operation there should rarely be any work for this task to perform.
|
|
13877
14009
|
The most common result is that there are no matching proven_txs records because
|
|
13878
14010
|
generating new proven_txs records intentionally lags new block generation to
|
|
13879
14011
|
minimize this disruption.
|
|
@@ -13883,17 +14015,8 @@ It is very disruptive to update a proven_txs record because:
|
|
|
13883
14015
|
- Generated beefs are impacted.
|
|
13884
14016
|
- Updated proof data may be unavailable at the time a reorg is first reported.
|
|
13885
14017
|
|
|
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.
|
|
14018
|
+
Proper reorg handling also requires repairing invalid beefs for new transactions when
|
|
14019
|
+
createAction fails to verify a generated beef against the chaintracker.
|
|
13897
14020
|
|
|
13898
14021
|
```ts
|
|
13899
14022
|
export class TaskReorg extends WalletMonitorTask {
|
|
@@ -13909,6 +14032,25 @@ export class TaskReorg extends WalletMonitorTask {
|
|
|
13909
14032
|
|
|
13910
14033
|
See also: [DeactivedHeader](./monitor.md#interface-deactivedheader), [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
13911
14034
|
|
|
14035
|
+
###### Method trigger
|
|
14036
|
+
|
|
14037
|
+
Shift aged deactivated headers onto `process` array.
|
|
14038
|
+
|
|
14039
|
+
```ts
|
|
14040
|
+
trigger(nowMsecsSinceEpoch: number): {
|
|
14041
|
+
run: boolean;
|
|
14042
|
+
}
|
|
14043
|
+
```
|
|
14044
|
+
|
|
14045
|
+
Returns
|
|
14046
|
+
|
|
14047
|
+
`run` true iff there are aged deactivated headers to process.
|
|
14048
|
+
|
|
14049
|
+
Argument Details
|
|
14050
|
+
|
|
14051
|
+
+ **nowMsecsSinceEpoch**
|
|
14052
|
+
+ current time in milliseconds since epoch.
|
|
14053
|
+
|
|
13912
14054
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13913
14055
|
|
|
13914
14056
|
---
|
|
@@ -14250,6 +14392,7 @@ to pay the fee to unlock and spend the outputs used to provide the additional sa
|
|
|
14250
14392
|
```ts
|
|
14251
14393
|
export class WERR_INSUFFICIENT_FUNDS extends WalletError {
|
|
14252
14394
|
constructor(public totalSatoshisNeeded: number, public moreSatoshisNeeded: number)
|
|
14395
|
+
override toJson(): string
|
|
14253
14396
|
}
|
|
14254
14397
|
```
|
|
14255
14398
|
|
|
@@ -14314,6 +14457,7 @@ This is an example of an error object with a custom property `parameter` and tem
|
|
|
14314
14457
|
```ts
|
|
14315
14458
|
export class WERR_INVALID_PARAMETER extends WalletError {
|
|
14316
14459
|
constructor(public parameter: string, mustBe?: string)
|
|
14460
|
+
override toJson(): string
|
|
14317
14461
|
}
|
|
14318
14462
|
```
|
|
14319
14463
|
|
|
@@ -14327,6 +14471,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
14327
14471
|
```ts
|
|
14328
14472
|
export class WERR_INVALID_PUBLIC_KEY extends WalletError {
|
|
14329
14473
|
constructor(public key: string, network: WalletNetwork = "mainnet")
|
|
14474
|
+
protected override toJson(): string
|
|
14330
14475
|
}
|
|
14331
14476
|
```
|
|
14332
14477
|
|
|
@@ -14357,6 +14502,7 @@ This is an example of an error object with a custom property `parameter`
|
|
|
14357
14502
|
```ts
|
|
14358
14503
|
export class WERR_MISSING_PARAMETER extends WalletError {
|
|
14359
14504
|
constructor(public parameter: string)
|
|
14505
|
+
override toJson(): string
|
|
14360
14506
|
}
|
|
14361
14507
|
```
|
|
14362
14508
|
|
|
@@ -14419,6 +14565,7 @@ paid to processing errors.
|
|
|
14419
14565
|
```ts
|
|
14420
14566
|
export class WERR_REVIEW_ACTIONS extends WalletError {
|
|
14421
14567
|
constructor(public reviewActionResults: ReviewActionResult[], public sendWithResults: SendWithResult[], public txid?: TXIDHexString, public tx?: AtomicBEEF, public noSendChange?: OutpointString[])
|
|
14568
|
+
override toJson(): string
|
|
14422
14569
|
}
|
|
14423
14570
|
```
|
|
14424
14571
|
|
|
@@ -14790,6 +14937,8 @@ export class WalletError extends Error implements WalletErrorObject {
|
|
|
14790
14937
|
code: string;
|
|
14791
14938
|
description: string;
|
|
14792
14939
|
}
|
|
14940
|
+
protected toJson(): string
|
|
14941
|
+
static unknownToJson(error: unknown | WalletError): string
|
|
14793
14942
|
}
|
|
14794
14943
|
```
|
|
14795
14944
|
|
|
@@ -14816,6 +14965,37 @@ static fromUnknown(err: unknown): WalletError
|
|
|
14816
14965
|
```
|
|
14817
14966
|
See also: [WalletError](./client.md#class-walleterror)
|
|
14818
14967
|
|
|
14968
|
+
###### Method toJson
|
|
14969
|
+
|
|
14970
|
+
Base class default JSON serialization.
|
|
14971
|
+
Captures just the name and message properties.
|
|
14972
|
+
|
|
14973
|
+
Override this method to safely (avoid deep, large, circular issues) serialize
|
|
14974
|
+
derived class properties.
|
|
14975
|
+
|
|
14976
|
+
```ts
|
|
14977
|
+
protected toJson(): string
|
|
14978
|
+
```
|
|
14979
|
+
|
|
14980
|
+
Returns
|
|
14981
|
+
|
|
14982
|
+
stringified JSON representation of the WalletError.
|
|
14983
|
+
|
|
14984
|
+
###### Method unknownToJson
|
|
14985
|
+
|
|
14986
|
+
Safely serializes a WalletError derived, WERR_REVIEW_ACTIONS (special case), Error or unknown error to JSON.
|
|
14987
|
+
|
|
14988
|
+
Safely means avoiding deep, large, circular issues.
|
|
14989
|
+
|
|
14990
|
+
```ts
|
|
14991
|
+
static unknownToJson(error: unknown | WalletError): string
|
|
14992
|
+
```
|
|
14993
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
14994
|
+
|
|
14995
|
+
Returns
|
|
14996
|
+
|
|
14997
|
+
stringified JSON representation of the error such that it can be desirialized to a WalletError.
|
|
14998
|
+
|
|
14819
14999
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
14820
15000
|
|
|
14821
15001
|
---
|
|
@@ -15547,6 +15727,9 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
15547
15727
|
async findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>
|
|
15548
15728
|
async findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>
|
|
15549
15729
|
async findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>
|
|
15730
|
+
async reproveHeader(deactivatedHash: string): Promise<sdk.ReproveHeaderResult>
|
|
15731
|
+
async verifyAndRepairBeef(beef: Beef, allowTxidOnly?: boolean): Promise<boolean>
|
|
15732
|
+
async reproveProven(ptx: TableProvenTx, noUpdate?: boolean): Promise<sdk.ReproveProvenResult>
|
|
15550
15733
|
async syncFromReader(identityKey: string, reader: sdk.WalletStorageSyncReader, activeSync?: sdk.WalletStorageSync, log: string = ""): Promise<{
|
|
15551
15734
|
inserts: number;
|
|
15552
15735
|
updates: number;
|
|
@@ -15564,7 +15747,7 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
15564
15747
|
}
|
|
15565
15748
|
```
|
|
15566
15749
|
|
|
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)
|
|
15750
|
+
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
15751
|
|
|
15569
15752
|
###### Constructor
|
|
15570
15753
|
|
|
@@ -15682,6 +15865,39 @@ Throws
|
|
|
15682
15865
|
|
|
15683
15866
|
WERR_INVALID_PARAMETER if canMakeAvailable returns false.
|
|
15684
15867
|
|
|
15868
|
+
###### Method reproveHeader
|
|
15869
|
+
|
|
15870
|
+
For each proven_txs record currently sourcing its transaction merkle proof from the given deactivated header,
|
|
15871
|
+
attempt to reprove the transaction against the current chain,
|
|
15872
|
+
updating the proven_txs record if a new valid proof is found.
|
|
15873
|
+
|
|
15874
|
+
```ts
|
|
15875
|
+
async reproveHeader(deactivatedHash: string): Promise<sdk.ReproveHeaderResult>
|
|
15876
|
+
```
|
|
15877
|
+
See also: [ReproveHeaderResult](./client.md#interface-reproveheaderresult)
|
|
15878
|
+
|
|
15879
|
+
Argument Details
|
|
15880
|
+
|
|
15881
|
+
+ **deactivatedHash**
|
|
15882
|
+
+ An orphaned header than may have served as a proof source for proven_txs records.
|
|
15883
|
+
|
|
15884
|
+
###### Method reproveProven
|
|
15885
|
+
|
|
15886
|
+
Attempt to reprove the transaction against the current chain,
|
|
15887
|
+
If a new valid proof is found and noUpdate is not true,
|
|
15888
|
+
update the proven_txs record with new block and merkle proof data.
|
|
15889
|
+
If noUpdate is true, the update to be applied is available in the returned result.
|
|
15890
|
+
|
|
15891
|
+
```ts
|
|
15892
|
+
async reproveProven(ptx: TableProvenTx, noUpdate?: boolean): Promise<sdk.ReproveProvenResult>
|
|
15893
|
+
```
|
|
15894
|
+
See also: [ReproveProvenResult](./client.md#interface-reproveprovenresult), [TableProvenTx](./storage.md#interface-tableproventx)
|
|
15895
|
+
|
|
15896
|
+
Argument Details
|
|
15897
|
+
|
|
15898
|
+
+ **ptx**
|
|
15899
|
+
+ proven_txs record to reprove
|
|
15900
|
+
|
|
15685
15901
|
###### Method runAsSync
|
|
15686
15902
|
|
|
15687
15903
|
```ts
|
|
@@ -15711,6 +15927,18 @@ Argument Details
|
|
|
15711
15927
|
+ **storageIdentityKey**
|
|
15712
15928
|
+ of current backup storage provider that is to become the new active provider.
|
|
15713
15929
|
|
|
15930
|
+
###### Method verifyAndRepairBeef
|
|
15931
|
+
|
|
15932
|
+
Extends the Beef `verify` function to handle BUMPs that have become invalid due to a chain reorg.
|
|
15933
|
+
|
|
15934
|
+
Any merkle root that fails `isValidRootForHeight` triggers a reprove attempt for that block header.
|
|
15935
|
+
This results in proven_txs with invalid proofs being updated with new valid proofs where possible.
|
|
15936
|
+
Finally, a new beef is generated and verified against the chaintracker.
|
|
15937
|
+
|
|
15938
|
+
```ts
|
|
15939
|
+
async verifyAndRepairBeef(beef: Beef, allowTxidOnly?: boolean): Promise<boolean>
|
|
15940
|
+
```
|
|
15941
|
+
|
|
15714
15942
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15715
15943
|
|
|
15716
15944
|
---
|
|
@@ -15896,65 +16124,86 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
15896
16124
|
|
|
15897
16125
|
| | | |
|
|
15898
16126
|
| --- | --- | --- |
|
|
15899
|
-
| [
|
|
15900
|
-
| [
|
|
15901
|
-
| [
|
|
15902
|
-
| [
|
|
15903
|
-
| [
|
|
15904
|
-
| [
|
|
15905
|
-
| [
|
|
15906
|
-
| [
|
|
15907
|
-
| [
|
|
15908
|
-
| [
|
|
15909
|
-
| [
|
|
15910
|
-
| [
|
|
15911
|
-
| [
|
|
15912
|
-
| [
|
|
15913
|
-
| [
|
|
15914
|
-
| [
|
|
15915
|
-
| [
|
|
15916
|
-
| [
|
|
15917
|
-
| [
|
|
15918
|
-
| [
|
|
15919
|
-
| [
|
|
15920
|
-
| [
|
|
15921
|
-
| [
|
|
15922
|
-
| [
|
|
15923
|
-
| [
|
|
15924
|
-
| [
|
|
15925
|
-
| [
|
|
16127
|
+
| [WalletErrorFromJson](#function-walleterrorfromjson) | [isBaseBlockHeader](#function-isbaseblockheader) | [validateAcquireIssuanceCertificateArgs](#function-validateacquireissuancecertificateargs) |
|
|
16128
|
+
| [WocHeadersBulkListener](#function-wocheadersbulklistener) | [isBlockHeader](#function-isblockheader) | [validateAgainstDirtyHashes](#function-validateagainstdirtyhashes) |
|
|
16129
|
+
| [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [isCreateActionSpecOp](#function-iscreateactionspecop) | [validateBasketInsertion](#function-validatebasketinsertion) |
|
|
16130
|
+
| [WocHeadersLiveListener](#function-wocheaderslivelistener) | [isHexString](#function-ishexstring) | [validateBufferOfHeaders](#function-validatebufferofheaders) |
|
|
16131
|
+
| [WocHeadersLiveListener_test](#function-wocheaderslivelistener_test) | [isKnownValidBulkHeaderFile](#function-isknownvalidbulkheaderfile) | [validateBulkFileData](#function-validatebulkfiledata) |
|
|
16132
|
+
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [isListActionsSpecOp](#function-islistactionsspecop) | [validateCreateActionArgs](#function-validatecreateactionargs) |
|
|
16133
|
+
| [addWork](#function-addwork) | [isListOutputsSpecOp](#function-islistoutputsspecop) | [validateCreateActionInput](#function-validatecreateactioninput) |
|
|
16134
|
+
| [arcDefaultUrl](#function-arcdefaulturl) | [isLive](#function-islive) | [validateCreateActionOptions](#function-validatecreateactionoptions) |
|
|
16135
|
+
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [isLiveBlockHeader](#function-isliveblockheader) | [validateCreateActionOutput](#function-validatecreateactionoutput) |
|
|
16136
|
+
| [arraysEqual](#function-arraysequal) | [isMoreWork](#function-ismorework) | [validateDiscoverByAttributesArgs](#function-validatediscoverbyattributesargs) |
|
|
16137
|
+
| [asArray](#function-asarray) | [listActionsIdb](#function-listactionsidb) | [validateDiscoverByIdentityKeyArgs](#function-validatediscoverbyidentitykeyargs) |
|
|
16138
|
+
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [listCertificates](#function-listcertificates) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) |
|
|
16139
|
+
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [listOutputsIdb](#function-listoutputsidb) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) |
|
|
16140
|
+
| [asBsvSdkScript](#function-asbsvsdkscript) | [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [validateGenesisHeader](#function-validategenesisheader) |
|
|
16141
|
+
| [asBsvSdkTx](#function-asbsvsdktx) | [makeAtomicBeef](#function-makeatomicbeef) | [validateHeaderDifficulty](#function-validateheaderdifficulty) |
|
|
16142
|
+
| [asString](#function-asstring) | [makeChangeLock](#function-makechangelock) | [validateHeaderFormat](#function-validateheaderformat) |
|
|
16143
|
+
| [asUint8Array](#function-asuint8array) | [maxDate](#function-maxdate) | [validateInteger](#function-validateinteger) |
|
|
16144
|
+
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [offsetPubKey](#function-offsetpubkey) | [validateInternalizeActionArgs](#function-validateinternalizeactionargs) |
|
|
16145
|
+
| [blockHash](#function-blockhash) | [optionalArraysEqual](#function-optionalarraysequal) | [validateInternalizeOutput](#function-validateinternalizeoutput) |
|
|
16146
|
+
| [buildSignableTransaction](#function-buildsignabletransaction) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [validateListActionsArgs](#function-validatelistactionsargs) |
|
|
16147
|
+
| [completeSignedTransaction](#function-completesignedtransaction) | [parseWalletOutpoint](#function-parsewalletoutpoint) | [validateListCertificatesArgs](#function-validatelistcertificatesargs) |
|
|
16148
|
+
| [convertBitsToTarget](#function-convertbitstotarget) | [processAction](#function-processaction) | [validateListOutputsArgs](#function-validatelistoutputsargs) |
|
|
16149
|
+
| [convertBitsToWork](#function-convertbitstowork) | [processAction](#function-processaction) | [validateOptionalInteger](#function-validateoptionalinteger) |
|
|
16150
|
+
| [convertBufferToUint32](#function-convertbuffertouint32) | [proveCertificate](#function-provecertificate) | [validateOptionalOutpointString](#function-validateoptionaloutpointstring) |
|
|
16151
|
+
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [purgeDataIdb](#function-purgedataidb) | [validateOriginator](#function-validateoriginator) |
|
|
16152
|
+
| [convertUint32ToBuffer](#function-convertuint32tobuffer) | [randomBytes](#function-randombytes) | [validateOutpointString](#function-validateoutpointstring) |
|
|
16153
|
+
| [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [randomBytesBase64](#function-randombytesbase64) | [validatePositiveIntegerOrZero](#function-validatepositiveintegerorzero) |
|
|
15926
16154
|
| [createAction](#function-createaction) | [randomBytesHex](#function-randombyteshex) | [validateProveCertificateArgs](#function-validateprovecertificateargs) |
|
|
15927
|
-
| [
|
|
15928
|
-
| [
|
|
15929
|
-
| [
|
|
15930
|
-
| [
|
|
15931
|
-
| [
|
|
15932
|
-
| [
|
|
15933
|
-
| [
|
|
15934
|
-
| [
|
|
15935
|
-
| [
|
|
15936
|
-
| [
|
|
15937
|
-
| [
|
|
15938
|
-
| [
|
|
15939
|
-
| [
|
|
15940
|
-
| [
|
|
15941
|
-
| [
|
|
15942
|
-
| [
|
|
15943
|
-
| [
|
|
15944
|
-
| [
|
|
15945
|
-
| [
|
|
15946
|
-
| [
|
|
15947
|
-
| [
|
|
15948
|
-
| [
|
|
15949
|
-
| [
|
|
15950
|
-
| [
|
|
15951
|
-
| [
|
|
16155
|
+
| [createAction](#function-createaction) | [readUInt32BE](#function-readuint32be) | [validateRelinquishCertificateArgs](#function-validaterelinquishcertificateargs) |
|
|
16156
|
+
| [createDefaultIdbChaintracksOptions](#function-createdefaultidbchaintracksoptions) | [readUInt32LE](#function-readuint32le) | [validateRelinquishOutputArgs](#function-validaterelinquishoutputargs) |
|
|
16157
|
+
| [createDefaultNoDbChaintracksOptions](#function-createdefaultnodbchaintracksoptions) | [reviewStatusIdb](#function-reviewstatusidb) | [validateSatoshis](#function-validatesatoshis) |
|
|
16158
|
+
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [selectBulkHeaderFiles](#function-selectbulkheaderfiles) | [validateScriptHash](#function-validatescripthash) |
|
|
16159
|
+
| [createIdbChaintracks](#function-createidbchaintracks) | [serializeBaseBlockHeader](#function-serializebaseblockheader) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
|
|
16160
|
+
| [createNoDbChaintracks](#function-createnodbchaintracks) | [serializeBaseBlockHeaders](#function-serializebaseblockheaders) | [validateSignActionArgs](#function-validatesignactionargs) |
|
|
16161
|
+
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [setDisableDoubleSpendCheckForTest](#function-setdisabledoublespendcheckfortest) | [validateSignActionOptions](#function-validatesignactionoptions) |
|
|
16162
|
+
| [createSyncMap](#function-createsyncmap) | [sha256Hash](#function-sha256hash) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
|
|
16163
|
+
| [deserializeBaseBlockHeader](#function-deserializebaseblockheader) | [sha256HashOfBinaryFile](#function-sha256hashofbinaryfile) | [validateStringLength](#function-validatestringlength) |
|
|
16164
|
+
| [deserializeBaseBlockHeaders](#function-deserializebaseblockheaders) | [shareReqsWithWorld](#function-sharereqswithworld) | [validateWalletPayment](#function-validatewalletpayment) |
|
|
16165
|
+
| [deserializeBlockHeader](#function-deserializeblockheader) | [signAction](#function-signaction) | [varUintSize](#function-varuintsize) |
|
|
16166
|
+
| [deserializeBlockHeaders](#function-deserializeblockheaders) | [stampLog](#function-stamplog) | [verifyHexString](#function-verifyhexstring) |
|
|
16167
|
+
| [doubleSha256BE](#function-doublesha256be) | [stampLogFormat](#function-stamplogformat) | [verifyId](#function-verifyid) |
|
|
16168
|
+
| [doubleSha256LE](#function-doublesha256le) | [subWork](#function-subwork) | [verifyInteger](#function-verifyinteger) |
|
|
16169
|
+
| [generateChangeSdk](#function-generatechangesdk) | [swapByteOrder](#function-swapbyteorder) | [verifyNumber](#function-verifynumber) |
|
|
16170
|
+
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [throwDummyReviewActions](#function-throwdummyreviewactions) | [verifyOne](#function-verifyone) |
|
|
16171
|
+
| [genesisBuffer](#function-genesisbuffer) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) | [verifyOneOrNone](#function-verifyoneornone) |
|
|
16172
|
+
| [genesisHeader](#function-genesisheader) | [toWalletNetwork](#function-towalletnetwork) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
|
|
16173
|
+
| [getBeefForTransaction](#function-getbeeffortransaction) | [transactionInputSize](#function-transactioninputsize) | [verifyTruthy](#function-verifytruthy) |
|
|
16174
|
+
| [getBeefForTxid](#function-getbeeffortxid) | [transactionOutputSize](#function-transactionoutputsize) | [verifyUnlockScripts](#function-verifyunlockscripts) |
|
|
16175
|
+
| [getExchangeRatesIo](#function-getexchangeratesio) | [transactionSize](#function-transactionsize) | [wait](#function-wait) |
|
|
16176
|
+
| [getIdentityKey](#function-getidentitykey) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) | [wocGetHeadersHeaderToBlockHeader](#function-wocgetheadersheadertoblockheader) |
|
|
16177
|
+
| [getProofs](#function-getproofs) | [updateExchangeratesapi](#function-updateexchangeratesapi) | [workBNtoBuffer](#function-workbntobuffer) |
|
|
16178
|
+
| [getSyncChunk](#function-getsyncchunk) | [validBulkHeaderFilesByFileHash](#function-validbulkheaderfilesbyfilehash) | [writeUInt32BE](#function-writeuint32be) |
|
|
16179
|
+
| [getWhatsOnChainBlockHeaderByHash](#function-getwhatsonchainblockheaderbyhash) | [validateAbortActionArgs](#function-validateabortactionargs) | [writeUInt32LE](#function-writeuint32le) |
|
|
16180
|
+
| [internalizeAction](#function-internalizeaction) | [validateAcquireCertificateArgs](#function-validateacquirecertificateargs) | |
|
|
15952
16181
|
| [internalizeAction](#function-internalizeaction) | [validateAcquireDirectCertificateArgs](#function-validateacquiredirectcertificateargs) | |
|
|
15953
16182
|
|
|
15954
16183
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15955
16184
|
|
|
15956
16185
|
---
|
|
15957
16186
|
|
|
16187
|
+
##### Function: WalletErrorFromJson
|
|
16188
|
+
|
|
16189
|
+
Reconstruct the correct derived WalletError from a JSON object created by `WalletError.unknownToJson`.
|
|
16190
|
+
|
|
16191
|
+
This function is implemented as a separate function instead of a WalletError class static
|
|
16192
|
+
to avoid circular dependencies.
|
|
16193
|
+
|
|
16194
|
+
```ts
|
|
16195
|
+
export function WalletErrorFromJson(json: object): WalletError
|
|
16196
|
+
```
|
|
16197
|
+
|
|
16198
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
16199
|
+
|
|
16200
|
+
Returns
|
|
16201
|
+
|
|
16202
|
+
a WalletError derived error object, typically for re-throw.
|
|
16203
|
+
|
|
16204
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
16205
|
+
|
|
16206
|
+
---
|
|
15958
16207
|
##### Function: WocHeadersBulkListener
|
|
15959
16208
|
|
|
15960
16209
|
High speed WebSocket based based old block header listener
|
|
@@ -16462,10 +16711,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
16462
16711
|
##### Function: createAction
|
|
16463
16712
|
|
|
16464
16713
|
```ts
|
|
16465
|
-
export async function createAction(
|
|
16714
|
+
export async function createAction(wallet: Wallet, auth: AuthId, vargs: ValidCreateActionArgs): Promise<CreateActionResultX>
|
|
16466
16715
|
```
|
|
16467
16716
|
|
|
16468
|
-
See also: [AuthId](./client.md#interface-authid), [
|
|
16717
|
+
See also: [AuthId](./client.md#interface-authid), [CreateActionResultX](./client.md#interface-createactionresultx), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs), [Wallet](./client.md#class-wallet)
|
|
16469
16718
|
|
|
16470
16719
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
16471
16720
|
|
|
@@ -16473,10 +16722,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
16473
16722
|
##### Function: createAction
|
|
16474
16723
|
|
|
16475
16724
|
```ts
|
|
16476
|
-
export async function createAction(
|
|
16725
|
+
export async function createAction(storage: StorageProvider, auth: AuthId, vargs: ValidCreateActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<StorageCreateActionResult>
|
|
16477
16726
|
```
|
|
16478
16727
|
|
|
16479
|
-
See also: [AuthId](./client.md#interface-authid), [
|
|
16728
|
+
See also: [AuthId](./client.md#interface-authid), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageProvider](./storage.md#class-storageprovider), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs)
|
|
16480
16729
|
|
|
16481
16730
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
16482
16731
|
|
|
@@ -16908,13 +17157,13 @@ When the transaction already exists, the description is updated. The isOutgoing
|
|
|
16908
17157
|
|
|
16909
17158
|
"wallet payment" Merge Rules:
|
|
16910
17159
|
1. Targetting an existing change "default" basket output results in a no-op. No error. No alterations made.
|
|
16911
|
-
2. Targetting a previously "custom" non-change output converts it into a change output. This alters the transaction's `
|
|
17160
|
+
2. Targetting a previously "custom" non-change output converts it into a change output. This alters the transaction's `amount`, and the wallet balance.
|
|
16912
17161
|
|
|
16913
17162
|
```ts
|
|
16914
|
-
export async function internalizeAction(
|
|
17163
|
+
export async function internalizeAction(wallet: Wallet, auth: AuthId, args: InternalizeActionArgs): Promise<StorageInternalizeActionResult>
|
|
16915
17164
|
```
|
|
16916
17165
|
|
|
16917
|
-
See also: [AuthId](./client.md#interface-authid), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [
|
|
17166
|
+
See also: [AuthId](./client.md#interface-authid), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [Wallet](./client.md#class-wallet)
|
|
16918
17167
|
|
|
16919
17168
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
16920
17169
|
|
|
@@ -16944,13 +17193,13 @@ When the transaction already exists, the description is updated. The isOutgoing
|
|
|
16944
17193
|
|
|
16945
17194
|
"wallet payment" Merge Rules:
|
|
16946
17195
|
1. Targetting an existing change "default" basket output results in a no-op. No error. No alterations made.
|
|
16947
|
-
2. Targetting a previously "custom" non-change output converts it into a change output. This alters the transaction's `
|
|
17196
|
+
2. Targetting a previously "custom" non-change output converts it into a change output. This alters the transaction's `satoshis`, and the wallet balance.
|
|
16948
17197
|
|
|
16949
17198
|
```ts
|
|
16950
|
-
export async function internalizeAction(
|
|
17199
|
+
export async function internalizeAction(storage: StorageProvider, auth: AuthId, args: InternalizeActionArgs): Promise<StorageInternalizeActionResult>
|
|
16951
17200
|
```
|
|
16952
17201
|
|
|
16953
|
-
See also: [AuthId](./client.md#interface-authid), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [
|
|
17202
|
+
See also: [AuthId](./client.md#interface-authid), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [StorageProvider](./storage.md#class-storageprovider)
|
|
16954
17203
|
|
|
16955
17204
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
16956
17205
|
|
|
@@ -17611,6 +17860,17 @@ new buffer with byte order reversed.
|
|
|
17611
17860
|
|
|
17612
17861
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
17613
17862
|
|
|
17863
|
+
---
|
|
17864
|
+
##### Function: throwDummyReviewActions
|
|
17865
|
+
|
|
17866
|
+
Throws a WERR_REVIEW_ACTIONS with a full set of properties to test data formats and propagation.
|
|
17867
|
+
|
|
17868
|
+
```ts
|
|
17869
|
+
export function throwDummyReviewActions()
|
|
17870
|
+
```
|
|
17871
|
+
|
|
17872
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
17873
|
+
|
|
17614
17874
|
---
|
|
17615
17875
|
##### Function: toBinaryBaseBlockHeader
|
|
17616
17876
|
|
|
@@ -17885,12 +18145,22 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
17885
18145
|
---
|
|
17886
18146
|
##### Function: validateCreateActionArgs
|
|
17887
18147
|
|
|
18148
|
+
Validate the arguments for creating a new action.
|
|
18149
|
+
|
|
17888
18150
|
```ts
|
|
17889
18151
|
export function validateCreateActionArgs(args: CreateActionArgs): ValidCreateActionArgs
|
|
17890
18152
|
```
|
|
17891
18153
|
|
|
17892
18154
|
See also: [ValidCreateActionArgs](./client.md#interface-validcreateactionargs)
|
|
17893
18155
|
|
|
18156
|
+
Returns
|
|
18157
|
+
|
|
18158
|
+
validated arguments
|
|
18159
|
+
|
|
18160
|
+
Throws
|
|
18161
|
+
|
|
18162
|
+
primarily WERR_INVALID_PARAMETER if args are invalid.
|
|
18163
|
+
|
|
17894
18164
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
17895
18165
|
|
|
17896
18166
|
---
|