@bsv/wallet-toolbox 2.4.2 → 2.4.4
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 +38 -1
- package/docs/README.md +3 -1
- package/docs/action-batch-planning.md +117 -0
- package/docs/authentication-observability.md +94 -0
- package/docs/client.md +1566 -627
- package/docs/monitor.md +26 -5
- package/docs/storage.md +514 -334
- package/docs/wallet.md +1109 -932
- package/out/src/CWIStyleWalletManager.d.ts +52 -5
- package/out/src/CWIStyleWalletManager.d.ts.map +1 -1
- package/out/src/CWIStyleWalletManager.js +500 -128
- package/out/src/CWIStyleWalletManager.js.map +1 -1
- package/out/src/Wallet.d.ts +8 -0
- package/out/src/Wallet.d.ts.map +1 -1
- package/out/src/Wallet.js +23 -9
- package/out/src/Wallet.js.map +1 -1
- package/out/src/WalletAuthenticationManager.d.ts +20 -6
- package/out/src/WalletAuthenticationManager.d.ts.map +1 -1
- package/out/src/WalletAuthenticationManager.js +214 -34
- package/out/src/WalletAuthenticationManager.js.map +1 -1
- package/out/src/WalletPermissionsManager.d.ts +15 -0
- package/out/src/WalletPermissionsManager.d.ts.map +1 -1
- package/out/src/WalletPermissionsManager.js +76 -28
- package/out/src/WalletPermissionsManager.js.map +1 -1
- package/out/src/index.all.d.ts +1 -0
- package/out/src/index.all.d.ts.map +1 -1
- package/out/src/index.all.js +1 -0
- package/out/src/index.all.js.map +1 -1
- package/out/src/index.client.d.ts +2 -0
- package/out/src/index.client.d.ts.map +1 -1
- package/out/src/index.client.js +2 -0
- package/out/src/index.client.js.map +1 -1
- package/out/src/index.mobile.d.ts +1 -0
- package/out/src/index.mobile.d.ts.map +1 -1
- package/out/src/index.mobile.js +1 -0
- package/out/src/index.mobile.js.map +1 -1
- package/out/src/monitor/Monitor.d.ts.map +1 -1
- package/out/src/monitor/Monitor.js +4 -3
- package/out/src/monitor/Monitor.js.map +1 -1
- package/out/src/monitor/tasks/TaskCleanupActionBatches.d.ts +13 -0
- package/out/src/monitor/tasks/TaskCleanupActionBatches.d.ts.map +1 -0
- package/out/src/monitor/tasks/TaskCleanupActionBatches.js +24 -0
- package/out/src/monitor/tasks/TaskCleanupActionBatches.js.map +1 -0
- package/out/src/monitor/tasks/index.all.d.ts +1 -0
- package/out/src/monitor/tasks/index.all.d.ts.map +1 -1
- package/out/src/monitor/tasks/index.all.js +1 -0
- package/out/src/monitor/tasks/index.all.js.map +1 -1
- package/out/src/sdk/ActionBatch.interfaces.d.ts +105 -0
- package/out/src/sdk/ActionBatch.interfaces.d.ts.map +1 -0
- package/out/src/sdk/ActionBatch.interfaces.js +3 -0
- package/out/src/sdk/ActionBatch.interfaces.js.map +1 -0
- package/out/src/sdk/WalletStorage.interfaces.d.ts +18 -1
- package/out/src/sdk/WalletStorage.interfaces.d.ts.map +1 -1
- 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/signer/actionBatch/ActionBatchPlanner.d.ts +28 -0
- package/out/src/signer/actionBatch/ActionBatchPlanner.d.ts.map +1 -0
- package/out/src/signer/actionBatch/ActionBatchPlanner.js +313 -0
- package/out/src/signer/actionBatch/ActionBatchPlanner.js.map +1 -0
- package/out/src/signer/actionBatch/ActionBatchWorkspace.d.ts +33 -0
- package/out/src/signer/actionBatch/ActionBatchWorkspace.d.ts.map +1 -0
- package/out/src/signer/actionBatch/ActionBatchWorkspace.js +693 -0
- package/out/src/signer/actionBatch/ActionBatchWorkspace.js.map +1 -0
- package/out/src/signer/methods/buildSignableTransaction.d.ts.map +1 -1
- package/out/src/signer/methods/buildSignableTransaction.js +2 -1
- package/out/src/signer/methods/buildSignableTransaction.js.map +1 -1
- package/out/src/signer/methods/createAction.d.ts.map +1 -1
- package/out/src/signer/methods/createAction.js +4 -1
- package/out/src/signer/methods/createAction.js.map +1 -1
- package/out/src/storage/StorageIdb.d.ts +14 -0
- package/out/src/storage/StorageIdb.d.ts.map +1 -1
- package/out/src/storage/StorageIdb.js +156 -30
- package/out/src/storage/StorageIdb.js.map +1 -1
- package/out/src/storage/StorageKnex.d.ts +19 -0
- package/out/src/storage/StorageKnex.d.ts.map +1 -1
- package/out/src/storage/StorageKnex.js +107 -1
- package/out/src/storage/StorageKnex.js.map +1 -1
- package/out/src/storage/StorageProvider.d.ts +28 -0
- package/out/src/storage/StorageProvider.d.ts.map +1 -1
- package/out/src/storage/StorageProvider.js +49 -0
- package/out/src/storage/StorageProvider.js.map +1 -1
- package/out/src/storage/WalletStorageManager.d.ts +8 -0
- package/out/src/storage/WalletStorageManager.d.ts.map +1 -1
- package/out/src/storage/WalletStorageManager.js +24 -0
- package/out/src/storage/WalletStorageManager.js.map +1 -1
- package/out/src/storage/idbHelpers.d.ts +2 -0
- package/out/src/storage/idbHelpers.d.ts.map +1 -1
- package/out/src/storage/idbHelpers.js +19 -0
- package/out/src/storage/idbHelpers.js.map +1 -1
- package/out/src/storage/methods/actionBatch.d.ts +14 -0
- package/out/src/storage/methods/actionBatch.d.ts.map +1 -0
- package/out/src/storage/methods/actionBatch.js +644 -0
- package/out/src/storage/methods/actionBatch.js.map +1 -0
- package/out/src/storage/methods/actionBatchBlobs.d.ts +12 -0
- package/out/src/storage/methods/actionBatchBlobs.d.ts.map +1 -0
- package/out/src/storage/methods/actionBatchBlobs.js +121 -0
- package/out/src/storage/methods/actionBatchBlobs.js.map +1 -0
- package/out/src/storage/methods/actionBatchValidation.d.ts +15 -0
- package/out/src/storage/methods/actionBatchValidation.d.ts.map +1 -0
- package/out/src/storage/methods/actionBatchValidation.js +310 -0
- package/out/src/storage/methods/actionBatchValidation.js.map +1 -0
- package/out/src/storage/methods/actionPlanning.d.ts +12 -0
- package/out/src/storage/methods/actionPlanning.d.ts.map +1 -0
- package/out/src/storage/methods/actionPlanning.js +48 -0
- package/out/src/storage/methods/actionPlanning.js.map +1 -0
- package/out/src/storage/methods/createAction.d.ts.map +1 -1
- package/out/src/storage/methods/createAction.js +9 -25
- package/out/src/storage/methods/createAction.js.map +1 -1
- package/out/src/storage/remoting/StorageClientBase.d.ts +9 -0
- package/out/src/storage/remoting/StorageClientBase.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageClientBase.js +36 -1
- package/out/src/storage/remoting/StorageClientBase.js.map +1 -1
- package/out/src/storage/remoting/StorageServer.d.ts +10 -0
- package/out/src/storage/remoting/StorageServer.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageServer.js +147 -7
- package/out/src/storage/remoting/StorageServer.js.map +1 -1
- package/out/src/storage/schema/KnexMigrations.d.ts.map +1 -1
- package/out/src/storage/schema/KnexMigrations.js +44 -0
- package/out/src/storage/schema/KnexMigrations.js.map +1 -1
- package/out/src/storage/schema/StorageIdbSchema.d.ts +24 -0
- package/out/src/storage/schema/StorageIdbSchema.d.ts.map +1 -1
- package/out/src/storage/schema/tables/TableActionBatch.d.ts +24 -0
- package/out/src/storage/schema/tables/TableActionBatch.d.ts.map +1 -0
- package/out/src/storage/schema/tables/TableActionBatch.js +3 -0
- package/out/src/storage/schema/tables/TableActionBatch.js.map +1 -0
- package/out/src/storage/schema/tables/index.d.ts +1 -0
- package/out/src/storage/schema/tables/index.d.ts.map +1 -1
- package/out/src/storage/schema/tables/index.js +1 -0
- package/out/src/storage/schema/tables/index.js.map +1 -1
- package/out/src/utility/actionBatchDigest.d.ts +9 -0
- package/out/src/utility/actionBatchDigest.d.ts.map +1 -0
- package/out/src/utility/actionBatchDigest.js +48 -0
- package/out/src/utility/actionBatchDigest.js.map +1 -0
- package/out/src/utility/beefForTxids.d.ts +9 -0
- package/out/src/utility/beefForTxids.d.ts.map +1 -0
- package/out/src/utility/beefForTxids.js +35 -0
- package/out/src/utility/beefForTxids.js.map +1 -0
- package/out/src/wab-client/WABClient.d.ts +36 -90
- package/out/src/wab-client/WABClient.d.ts.map +1 -1
- package/out/src/wab-client/WABClient.js +103 -151
- package/out/src/wab-client/WABClient.js.map +1 -1
- package/out/src/wab-client/WABTransport.d.ts +53 -0
- package/out/src/wab-client/WABTransport.d.ts.map +1 -0
- package/out/src/wab-client/WABTransport.js +300 -0
- package/out/src/wab-client/WABTransport.js.map +1 -0
- package/out/src/wab-client/auth-method-interactors/AuthMethodInteractor.d.ts +10 -10
- package/out/src/wab-client/auth-method-interactors/AuthMethodInteractor.d.ts.map +1 -1
- package/out/src/wab-client/auth-method-interactors/AuthMethodInteractor.js +16 -21
- package/out/src/wab-client/auth-method-interactors/AuthMethodInteractor.js.map +1 -1
- package/out/src/wab-client/auth-method-interactors/TwilioPhoneInteractor.d.ts +2 -1
- package/out/src/wab-client/auth-method-interactors/TwilioPhoneInteractor.d.ts.map +1 -1
- package/out/src/wab-client/auth-method-interactors/TwilioPhoneInteractor.js +14 -0
- package/out/src/wab-client/auth-method-interactors/TwilioPhoneInteractor.js.map +1 -1
- package/package.json +23 -23
package/docs/client.md
CHANGED
|
@@ -6,95 +6,244 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6
6
|
|
|
7
7
|
| | | |
|
|
8
8
|
| --- | --- | --- |
|
|
9
|
-
| [
|
|
10
|
-
| [
|
|
11
|
-
| [
|
|
12
|
-
| [
|
|
13
|
-
| [
|
|
14
|
-
| [
|
|
15
|
-
| [
|
|
16
|
-
| [
|
|
17
|
-
| [
|
|
18
|
-
| [
|
|
19
|
-
| [
|
|
20
|
-
| [
|
|
21
|
-
| [
|
|
22
|
-
| [
|
|
23
|
-
| [
|
|
24
|
-
| [
|
|
25
|
-
| [
|
|
26
|
-
| [
|
|
27
|
-
| [
|
|
28
|
-
| [
|
|
29
|
-
| [
|
|
30
|
-
| [
|
|
31
|
-
| [
|
|
32
|
-
| [
|
|
33
|
-
| [
|
|
34
|
-
| [
|
|
35
|
-
| [
|
|
36
|
-
| [
|
|
37
|
-
| [
|
|
38
|
-
| [
|
|
39
|
-
| [
|
|
40
|
-
| [
|
|
41
|
-
| [
|
|
42
|
-
| [
|
|
43
|
-
| [
|
|
44
|
-
| [
|
|
45
|
-
| [
|
|
46
|
-
| [
|
|
47
|
-
| [
|
|
48
|
-
| [
|
|
49
|
-
| [
|
|
50
|
-
| [
|
|
51
|
-
| [
|
|
52
|
-
| [
|
|
53
|
-
| [
|
|
54
|
-
| [
|
|
55
|
-
| [
|
|
56
|
-
| [
|
|
57
|
-
| [
|
|
58
|
-
| [
|
|
59
|
-
| [
|
|
60
|
-
| [
|
|
61
|
-
| [
|
|
62
|
-
| [
|
|
63
|
-
| [
|
|
64
|
-
| [
|
|
65
|
-
| [
|
|
66
|
-
| [
|
|
67
|
-
| [
|
|
68
|
-
| [
|
|
69
|
-
| [
|
|
70
|
-
| [
|
|
71
|
-
| [
|
|
72
|
-
| [
|
|
73
|
-
| [
|
|
74
|
-
| [
|
|
75
|
-
| [
|
|
76
|
-
| [
|
|
77
|
-
| [
|
|
78
|
-
| [
|
|
79
|
-
| [
|
|
80
|
-
| [
|
|
81
|
-
| [
|
|
82
|
-
| [
|
|
83
|
-
| [
|
|
84
|
-
| [
|
|
85
|
-
| [
|
|
86
|
-
| [
|
|
87
|
-
| [
|
|
88
|
-
| [
|
|
89
|
-
| [
|
|
90
|
-
| [
|
|
91
|
-
| [
|
|
92
|
-
| [
|
|
9
|
+
| [AbortActionBatchResult](#interface-abortactionbatchresult) | [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StartAuthResponse](#interface-startauthresponse) |
|
|
10
|
+
| [ActionBatchCommitAction](#interface-actionbatchcommitaction) | [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [StatusForTxidResult](#interface-statusfortxidresult) |
|
|
11
|
+
| [ActionBatchCommitMetadata](#interface-actionbatchcommitmetadata) | [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [StopListenerToken](#interface-stoplistenertoken) |
|
|
12
|
+
| [ActionBatchFundingOutput](#interface-actionbatchfundingoutput) | [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [StorageAdminStats](#interface-storageadminstats) |
|
|
13
|
+
| [ActionBatchManifest](#interface-actionbatchmanifest) | [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [StorageCapabilities](#interface-storagecapabilities) |
|
|
14
|
+
| [ActionBatchPlannedAction](#interface-actionbatchplannedaction) | [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [StorageClientOptions](#interface-storageclientoptions) |
|
|
15
|
+
| [ActionBatchPlannerState](#interface-actionbatchplannerstate) | [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [StorageCreateActionResult](#interface-storagecreateactionresult) |
|
|
16
|
+
| [AdminStatsResult](#interface-adminstatsresult) | [GetHeaderByteFileLinksResult](#interface-getheaderbytefilelinksresult) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) |
|
|
17
|
+
| [AggregatePostBeefTxResult](#interface-aggregatepostbeeftxresult) | [GetMerklePathResult](#interface-getmerklepathresult) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) |
|
|
18
|
+
| [ArcConfig](#interface-arcconfig) | [GetRawTxResult](#interface-getrawtxresult) | [StorageFeeModel](#interface-storagefeemodel) |
|
|
19
|
+
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) |
|
|
20
|
+
| [ArcSSEClientOptions](#interface-arcsseclientoptions) | [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [StorageIdbOptions](#interface-storageidboptions) |
|
|
21
|
+
| [ArcSSEEvent](#interface-arcsseevent) | [GetScriptHashHistory](#interface-getscripthashhistory) | [StorageIdbSchema](#interface-storageidbschema) |
|
|
22
|
+
| [AuthId](#interface-authid) | [GetScriptHashHistoryResult](#interface-getscripthashhistoryresult) | [StorageIdentity](#interface-storageidentity) |
|
|
23
|
+
| [AuthPayload](#interface-authpayload) | [GetStatusForTxidsResult](#interface-getstatusfortxidsresult) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) |
|
|
24
|
+
| [BaseBlockHeader](#interface-baseblockheader) | [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [StorageProcessActionArgs](#interface-storageprocessactionargs) |
|
|
25
|
+
| [BeginActionBatchArgs](#interface-beginactionbatchargs) | [GetUtxoStatusResult](#interface-getutxostatusresult) | [StorageProcessActionResults](#interface-storageprocessactionresults) |
|
|
26
|
+
| [BeginActionBatchResult](#interface-beginactionbatchresult) | [GoChaintracksServiceClientOptions](#interface-gochaintracksserviceclientoptions) | [StorageProvenOrReq](#interface-storageprovenorreq) |
|
|
27
|
+
| [BitailsConfig](#interface-bitailsconfig) | [GroupedPermissionRequest](#interface-groupedpermissionrequest) | [StorageProviderOptions](#interface-storageprovideroptions) |
|
|
28
|
+
| [BitailsMerkleProof](#interface-bitailsmerkleproof) | [GroupedPermissions](#interface-groupedpermissions) | [StorageReaderOptions](#interface-storagereaderoptions) |
|
|
29
|
+
| [BlockHeader](#interface-blockheader) | [HeightRangeApi](#interface-heightrangeapi) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) |
|
|
30
|
+
| [BsvExchangeRate](#interface-bsvexchangerate) | [HeightRanges](#interface-heightranges) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) |
|
|
31
|
+
| [BulkFileDataManagerMergeResult](#interface-bulkfiledatamanagermergeresult) | [KdfConfig](#interface-kdfconfig) | [SyncChunk](#interface-syncchunk) |
|
|
32
|
+
| [BulkFileDataManagerOptions](#interface-bulkfiledatamanageroptions) | [KeyPair](#interface-keypair) | [SyncError](#interface-syncerror) |
|
|
33
|
+
| [BulkHeaderFileInfo](#interface-bulkheaderfileinfo) | [KeyPairAddress](#interface-keypairaddress) | [SyncMap](#interface-syncmap) |
|
|
34
|
+
| [BulkHeaderFilesInfo](#interface-bulkheaderfilesinfo) | [ListActionsSpecOp](#interface-listactionsspecop) | [TableActionBatch](#interface-tableactionbatch) |
|
|
35
|
+
| [BulkIngestorApi](#interface-bulkingestorapi) | [ListOutputsSpecOp](#interface-listoutputsspecop) | [TableActionBatchBlob](#interface-tableactionbatchblob) |
|
|
36
|
+
| [BulkIngestorBaseOptions](#interface-bulkingestorbaseoptions) | [LiveBlockHeader](#interface-liveblockheader) | [TableActionBatchOutput](#interface-tableactionbatchoutput) |
|
|
37
|
+
| [BulkIngestorCDNOptions](#interface-bulkingestorcdnoptions) | [LiveIngestorApi](#interface-liveingestorapi) | [TableAuthSession](#interface-tableauthsession) |
|
|
38
|
+
| [BulkIngestorWhatsOnChainOptions](#interface-bulkingestorwhatsonchainoptions) | [LiveIngestorBaseOptions](#interface-liveingestorbaseoptions) | [TableCertificate](#interface-tablecertificate) |
|
|
39
|
+
| [BulkStorageApi](#interface-bulkstorageapi) | [LiveIngestorChaintracksSSEOptions](#interface-liveingestorchaintrackssseoptions) | [TableCertificateField](#interface-tablecertificatefield) |
|
|
40
|
+
| [BulkStorageBaseOptions](#interface-bulkstoragebaseoptions) | [LiveIngestorWhatsOnChainOptions](#interface-liveingestorwhatsonchainoptions) | [TableCertificateX](#interface-tablecertificatex) |
|
|
41
|
+
| [BulkSyncResult](#interface-bulksyncresult) | [MerklePathNote](#interface-merklepathnote) | [TableCommission](#interface-tablecommission) |
|
|
42
|
+
| [CanonicalFundingCandidate](#interface-canonicalfundingcandidate) | [MockChainBlockHeaderRow](#interface-mockchainblockheaderrow) | [TableMonitorEvent](#interface-tablemonitorevent) |
|
|
43
|
+
| [CertOpsWallet](#interface-certopswallet) | [MockChainTransactionRow](#interface-mockchaintransactionrow) | [TableOutput](#interface-tableoutput) |
|
|
44
|
+
| [Certifier](#interface-certifier) | [MockChainUtxoRow](#interface-mockchainutxorow) | [TableOutputBasket](#interface-tableoutputbasket) |
|
|
45
|
+
| [ChaintracksApi](#interface-chaintracksapi) | [MonitorOptions](#interface-monitoroptions) | [TableOutputTag](#interface-tableoutputtag) |
|
|
46
|
+
| [ChaintracksAppendableFileApi](#interface-chaintracksappendablefileapi) | [OutPoint](#interface-outpoint) | [TableOutputTagMap](#interface-tableoutputtagmap) |
|
|
47
|
+
| [ChaintracksChainTrackerOptions](#interface-chaintrackschaintrackeroptions) | [Paged](#interface-paged) | [TableOutputX](#interface-tableoutputx) |
|
|
48
|
+
| [ChaintracksClientApi](#interface-chaintracksclientapi) | [ParsedBrc114ActionTimeLabels](#interface-parsedbrc114actiontimelabels) | [TableProvenTx](#interface-tableproventx) |
|
|
49
|
+
| [ChaintracksFetchApi](#interface-chaintracksfetchapi) | [ParsedOutpoint](#interface-parsedoutpoint) | [TableProvenTxReq](#interface-tableproventxreq) |
|
|
50
|
+
| [ChaintracksFsApi](#interface-chaintracksfsapi) | [PendingSignAction](#interface-pendingsignaction) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) |
|
|
51
|
+
| [ChaintracksInfoApi](#interface-chaintracksinfoapi) | [PendingStorageInput](#interface-pendingstorageinput) | [TableSettings](#interface-tablesettings) |
|
|
52
|
+
| [ChaintracksIngestorParams](#interface-chaintracksingestorparams) | [PermissionRequest](#interface-permissionrequest) | [TableSyncState](#interface-tablesyncstate) |
|
|
53
|
+
| [ChaintracksManagementApi](#interface-chaintracksmanagementapi) | [PermissionToken](#interface-permissiontoken) | [TableTransaction](#interface-tabletransaction) |
|
|
54
|
+
| [ChaintracksOptions](#interface-chaintracksoptions) | [PermissionsManagerConfig](#interface-permissionsmanagerconfig) | [TableTxLabel](#interface-tabletxlabel) |
|
|
55
|
+
| [ChaintracksPackageInfoApi](#interface-chaintrackspackageinfoapi) | [PermissionsModule](#interface-permissionsmodule) | [TableTxLabelMap](#interface-tabletxlabelmap) |
|
|
56
|
+
| [ChaintracksReadableFileApi](#interface-chaintracksreadablefileapi) | [PlannerOutput](#interface-planneroutput) | [TableUser](#interface-tableuser) |
|
|
57
|
+
| [ChaintracksServiceClientOptions](#interface-chaintracksserviceclientoptions) | [PostBeefResult](#interface-postbeefresult) | [TaskPurgeParams](#interface-taskpurgeparams) |
|
|
58
|
+
| [ChaintracksStorageApi](#interface-chaintracksstorageapi) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [TrustSettings](#interface-trustsettings) |
|
|
59
|
+
| [ChaintracksStorageBaseOptions](#interface-chaintracksstoragebaseoptions) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [TrxToken](#interface-trxtoken) |
|
|
60
|
+
| [ChaintracksStorageBulkFileApi](#interface-chaintracksstoragebulkfileapi) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
|
|
61
|
+
| [ChaintracksStorageIdbOptions](#interface-chaintracksstorageidboptions) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [TxScriptOffsets](#interface-txscriptoffsets) |
|
|
62
|
+
| [ChaintracksStorageIdbSchema](#interface-chaintracksstorageidbschema) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [UMPToken](#interface-umptoken) |
|
|
63
|
+
| [ChaintracksStorageIngestApi](#interface-chaintracksstorageingestapi) | [PostTxsResult](#interface-posttxsresult) | [UMPTokenInteractor](#interface-umptokeninteractor) |
|
|
64
|
+
| [ChaintracksStorageNoDbOptions](#interface-chaintracksstoragenodboptions) | [PrepareActionBatchCommitResult](#interface-prepareactionbatchcommitresult) | [UMPTokenLookupDiagnostics](#interface-umptokenlookupdiagnostics) |
|
|
65
|
+
| [ChaintracksStorageQueryApi](#interface-chaintracksstoragequeryapi) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
|
|
66
|
+
| [ChaintracksWritableFileApi](#interface-chaintrackswritablefileapi) | [Profile](#interface-profile) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
|
|
67
|
+
| [CommitActionBatchResult](#interface-commitactionbatchresult) | [ProvenOrRawTx](#interface-provenorrawtx) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
|
|
68
|
+
| [CommitNewTxResults](#interface-commitnewtxresults) | [ProvenTransactionStatus](#interface-proventransactionstatus) | [ValidatedBatchAction](#interface-validatedbatchaction) |
|
|
69
|
+
| [CompleteAuthResponse](#interface-completeauthresponse) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [VerifyAndRepairBeefResult](#interface-verifyandrepairbeefresult) |
|
|
70
|
+
| [ContactRecord](#interface-contactrecord) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [WABClientOptions](#interface-wabclientoptions) |
|
|
71
|
+
| [ContactSource](#interface-contactsource) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [WABFaucetResponse](#interface-wabfaucetresponse) |
|
|
72
|
+
| [CounterpartyPermissionRequest](#interface-counterpartypermissionrequest) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [WABOperationResponse](#interface-waboperationresponse) |
|
|
73
|
+
| [CounterpartyPermissions](#interface-counterpartypermissions) | [ProviderCallHistory](#interface-providercallhistory) | [WABRequestOptions](#interface-wabrequestoptions) |
|
|
74
|
+
| [CreateActionResultX](#interface-createactionresultx) | [PurgeParams](#interface-purgeparams) | [WABServerInfo](#interface-wabserverinfo) |
|
|
75
|
+
| [DeactivedHeader](#interface-deactivedheader) | [PurgeResults](#interface-purgeresults) | [WABTransportOptions](#interface-wabtransportoptions) |
|
|
76
|
+
| [EntitySyncMap](#interface-entitysyncmap) | [PutActionBatchBlobArgs](#interface-putactionbatchblobargs) | [WalletArgs](#interface-walletargs) |
|
|
77
|
+
| [EntityTimeStamp](#interface-entitytimestamp) | [RenewActionBatchResult](#interface-renewactionbatchresult) | [WalletAuthenticationManagerOptions](#interface-walletauthenticationmanageroptions) |
|
|
78
|
+
| [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [ReorgResult](#interface-reorgresult) | [WalletBalance](#interface-walletbalance) |
|
|
79
|
+
| [ExtendActionBatchArgs](#interface-extendactionbatchargs) | [ReproveHeaderResult](#interface-reproveheaderresult) | [WalletLoggerArgs](#interface-walletloggerargs) |
|
|
80
|
+
| [ExtendActionBatchResult](#interface-extendactionbatchresult) | [ReproveProvenResult](#interface-reproveprovenresult) | [WalletPermissionsManagerCallbacks](#interface-walletpermissionsmanagercallbacks) |
|
|
81
|
+
| [ExtendedVerifiableCertificate](#interface-extendedverifiablecertificate) | [ReqHistoryNote](#interface-reqhistorynote) | [WalletServices](#interface-walletservices) |
|
|
82
|
+
| [FiatExchangeRates](#interface-fiatexchangerates) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [WalletServicesOptions](#interface-walletservicesoptions) |
|
|
83
|
+
| [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [ReviewActionResult](#interface-reviewactionresult) | [WalletSettings](#interface-walletsettings) |
|
|
84
|
+
| [FindCertificatesArgs](#interface-findcertificatesargs) | [ReviewHeightRangeResult](#interface-reviewheightrangeresult) | [WalletSettingsManagerConfig](#interface-walletsettingsmanagerconfig) |
|
|
85
|
+
| [FindCommissionsArgs](#interface-findcommissionsargs) | [ScriptHashHistoryResponse](#interface-scripthashhistoryresponse) | [WalletSigner](#interface-walletsigner) |
|
|
86
|
+
| [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [WalletStorage](#interface-walletstorage) |
|
|
87
|
+
| [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [WalletStorageInfo](#interface-walletstorageinfo) |
|
|
88
|
+
| [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [ServiceCall](#interface-servicecall) | [WalletStorageProvider](#interface-walletstorageprovider) |
|
|
89
|
+
| [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [ServiceCall](#interface-servicecall) | [WalletStorageReader](#interface-walletstoragereader) |
|
|
90
|
+
| [FindOutputTagsArgs](#interface-findoutputtagsargs) | [ServiceCallHistory](#interface-servicecallhistory) | [WalletStorageSync](#interface-walletstoragesync) |
|
|
91
|
+
| [FindOutputsArgs](#interface-findoutputsargs) | [ServiceCallHistoryCounts](#interface-servicecallhistorycounts) | [WalletStorageSyncReader](#interface-walletstoragesyncreader) |
|
|
92
|
+
| [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [ServiceToCall](#interface-servicetocall) | [WalletStorageWriter](#interface-walletstoragewriter) |
|
|
93
|
+
| [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [ServicesCallHistory](#interface-servicescallhistory) | [WalletTheme](#interface-wallettheme) |
|
|
94
|
+
| [FindProvenTxsArgs](#interface-findproventxsargs) | [SetupClientWalletArgs](#interface-setupclientwalletargs) | [WhatsOnChainServicesOptions](#interface-whatsonchainservicesoptions) |
|
|
95
|
+
| [FindSincePagedArgs](#interface-findsincepagedargs) | [SetupClientWalletClientArgs](#interface-setupclientwalletclientargs) | [WocChainInfo](#interface-wocchaininfo) |
|
|
96
|
+
| [FindStaleMerkleRootsArgs](#interface-findstalemerklerootsargs) | [SetupWallet](#interface-setupwallet) | [WocGetHeaderByteFileLinks](#interface-wocgetheaderbytefilelinks) |
|
|
97
|
+
| [FindSyncStatesArgs](#interface-findsyncstatesargs) | [SetupWalletClient](#interface-setupwalletclient) | [WocGetHeadersHeader](#interface-wocgetheadersheader) |
|
|
98
|
+
| [FindTransactionsArgs](#interface-findtransactionsargs) | [SetupWalletIdb](#interface-setupwalletidb) | [WocHeader](#interface-wocheader) |
|
|
99
|
+
| [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [SetupWalletIdbArgs](#interface-setupwalletidbargs) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
|
|
100
|
+
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [SignActionResultX](#interface-signactionresultx) | |
|
|
101
|
+
| [FindUsersArgs](#interface-findusersargs) | [SpentInputTransition](#interface-spentinputtransition) | |
|
|
102
|
+
|
|
103
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
##### Interface: AbortActionBatchResult
|
|
108
|
+
|
|
109
|
+
```ts
|
|
110
|
+
export interface AbortActionBatchResult {
|
|
111
|
+
aborted: boolean;
|
|
112
|
+
}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
##### Interface: ActionBatchCommitAction
|
|
119
|
+
|
|
120
|
+
```ts
|
|
121
|
+
export interface ActionBatchCommitAction {
|
|
122
|
+
reference: string;
|
|
123
|
+
txid: TXIDHexString;
|
|
124
|
+
rawTx?: number[] | Uint8Array;
|
|
125
|
+
rawTxDigest?: string;
|
|
126
|
+
lockingScriptDigests?: Array<string | undefined>;
|
|
127
|
+
plan: StorageCreateActionResult;
|
|
128
|
+
metadata: ActionBatchCommitMetadata;
|
|
129
|
+
commissionKeyOffset?: string;
|
|
130
|
+
}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
See also: [ActionBatchCommitMetadata](./client.md#interface-actionbatchcommitmetadata), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult)
|
|
134
|
+
|
|
135
|
+
###### Property lockingScriptDigests
|
|
136
|
+
|
|
137
|
+
Content-addressed locking scripts aligned to plan.outputs for compact workspaces.
|
|
138
|
+
|
|
139
|
+
```ts
|
|
140
|
+
lockingScriptDigests?: Array<string | undefined>
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
##### Interface: ActionBatchCommitMetadata
|
|
147
|
+
|
|
148
|
+
```ts
|
|
149
|
+
export interface ActionBatchCommitMetadata {
|
|
150
|
+
description: string;
|
|
151
|
+
labels: string[];
|
|
152
|
+
isNoSend: boolean;
|
|
153
|
+
isDelayed: boolean;
|
|
154
|
+
inputs: Validation.ValidCreateActionInput[];
|
|
155
|
+
outputs: Validation.ValidCreateActionOutput[];
|
|
156
|
+
}
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
##### Interface: ActionBatchFundingOutput
|
|
163
|
+
|
|
164
|
+
```ts
|
|
165
|
+
export interface ActionBatchFundingOutput extends TableOutput {
|
|
166
|
+
sourceTransaction?: number[] | Uint8Array;
|
|
167
|
+
}
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
See also: [TableOutput](./storage.md#interface-tableoutput)
|
|
171
|
+
|
|
172
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
##### Interface: ActionBatchManifest
|
|
176
|
+
|
|
177
|
+
```ts
|
|
178
|
+
export interface ActionBatchManifest {
|
|
179
|
+
batchId: string;
|
|
180
|
+
digest: string;
|
|
181
|
+
actions: ActionBatchCommitAction[];
|
|
182
|
+
inlineBlobs?: Record<string, number[] | Uint8Array>;
|
|
183
|
+
blobChunks?: Record<string, string[]>;
|
|
184
|
+
dependencyBeef?: number[] | Uint8Array;
|
|
185
|
+
dependencyBeefDigest?: string;
|
|
186
|
+
sendWith: TXIDHexString[];
|
|
187
|
+
isDelayed: boolean;
|
|
188
|
+
}
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
See also: [ActionBatchCommitAction](./client.md#interface-actionbatchcommitaction)
|
|
192
|
+
|
|
193
|
+
###### Property blobChunks
|
|
194
|
+
|
|
195
|
+
Physical chunk digests for logical blobs larger than the provider's advertised blob limit.
|
|
196
|
+
|
|
197
|
+
```ts
|
|
198
|
+
blobChunks?: Record<string, string[]>
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
###### Property inlineBlobs
|
|
202
|
+
|
|
203
|
+
Content-addressed blobs carried in the commit request when the batch is below the inline limit.
|
|
204
|
+
|
|
205
|
+
```ts
|
|
206
|
+
inlineBlobs?: Record<string, number[] | Uint8Array>
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
##### Interface: ActionBatchPlannedAction
|
|
213
|
+
|
|
214
|
+
```ts
|
|
215
|
+
export interface ActionBatchPlannedAction {
|
|
216
|
+
dcr: StorageCreateActionResult;
|
|
217
|
+
consumedOutpoints: string[];
|
|
218
|
+
commissionKeyOffset?: string;
|
|
219
|
+
}
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
See also: [StorageCreateActionResult](./client.md#interface-storagecreateactionresult)
|
|
93
223
|
|
|
94
224
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
95
225
|
|
|
96
226
|
---
|
|
227
|
+
##### Interface: ActionBatchPlannerState
|
|
97
228
|
|
|
229
|
+
```ts
|
|
230
|
+
export interface ActionBatchPlannerState {
|
|
231
|
+
begin: BeginActionBatchResult;
|
|
232
|
+
sharedBeef: Beef;
|
|
233
|
+
reserved: Map<string, PlannerOutput>;
|
|
234
|
+
explicit: Map<string, PlannerOutput>;
|
|
235
|
+
staged: Map<string, PlannerOutput>;
|
|
236
|
+
discardedStagedTxids: Set<string>;
|
|
237
|
+
consumed: Set<string>;
|
|
238
|
+
estimatedChangeCount: number;
|
|
239
|
+
}
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
See also: [BeginActionBatchResult](./client.md#interface-beginactionbatchresult), [PlannerOutput](./client.md#interface-planneroutput)
|
|
243
|
+
|
|
244
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
245
|
+
|
|
246
|
+
---
|
|
98
247
|
##### Interface: AdminStatsResult
|
|
99
248
|
|
|
100
249
|
```ts
|
|
@@ -339,95 +488,9 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
339
488
|
---
|
|
340
489
|
##### Interface: AuthPayload
|
|
341
490
|
|
|
342
|
-
AuthMethodInteractor
|
|
343
|
-
|
|
344
|
-
A base interface/class for client-side logic to interact with a server
|
|
345
|
-
for a specific Auth Method's flow (start, complete).
|
|
346
|
-
|
|
347
491
|
```ts
|
|
348
492
|
export interface AuthPayload {
|
|
349
|
-
[key: string]:
|
|
350
|
-
}
|
|
351
|
-
```
|
|
352
|
-
|
|
353
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
354
|
-
|
|
355
|
-
---
|
|
356
|
-
##### Interface: BRC38ImportOptions
|
|
357
|
-
|
|
358
|
-
```ts
|
|
359
|
-
export interface BRC38ImportOptions {
|
|
360
|
-
mode: "merge" | "restore";
|
|
361
|
-
}
|
|
362
|
-
```
|
|
363
|
-
|
|
364
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
365
|
-
|
|
366
|
-
---
|
|
367
|
-
##### Interface: BRC38ImportResult
|
|
368
|
-
|
|
369
|
-
```ts
|
|
370
|
-
export interface BRC38ImportResult {
|
|
371
|
-
mode: "merge" | "restore";
|
|
372
|
-
identityKey: string;
|
|
373
|
-
userId: number;
|
|
374
|
-
inserts: number;
|
|
375
|
-
updates: number;
|
|
376
|
-
}
|
|
377
|
-
```
|
|
378
|
-
|
|
379
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
380
|
-
|
|
381
|
-
---
|
|
382
|
-
##### Interface: BRC38Tables
|
|
383
|
-
|
|
384
|
-
```ts
|
|
385
|
-
export interface BRC38Tables {
|
|
386
|
-
provenTxs: PortableRow[];
|
|
387
|
-
provenTxReqs: PortableRow[];
|
|
388
|
-
outputBaskets: PortableRow[];
|
|
389
|
-
transactions: PortableRow[];
|
|
390
|
-
commissions: PortableRow[];
|
|
391
|
-
outputs: PortableRow[];
|
|
392
|
-
outputTags: PortableRow[];
|
|
393
|
-
outputTagMaps: PortableRow[];
|
|
394
|
-
txLabels: PortableRow[];
|
|
395
|
-
txLabelMaps: PortableRow[];
|
|
396
|
-
certificates: PortableRow[];
|
|
397
|
-
certificateFields: PortableRow[];
|
|
398
|
-
syncStates: PortableRow[];
|
|
399
|
-
}
|
|
400
|
-
```
|
|
401
|
-
|
|
402
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
403
|
-
|
|
404
|
-
---
|
|
405
|
-
##### Interface: BRC38WalletData
|
|
406
|
-
|
|
407
|
-
```ts
|
|
408
|
-
export interface BRC38WalletData {
|
|
409
|
-
brc: 38;
|
|
410
|
-
title: "User Wallet Data Format";
|
|
411
|
-
formatVersion: 1;
|
|
412
|
-
exportedAt: string;
|
|
413
|
-
sourceStorage: PortableRow;
|
|
414
|
-
user: PortableRow;
|
|
415
|
-
tables: BRC38Tables;
|
|
416
|
-
}
|
|
417
|
-
```
|
|
418
|
-
|
|
419
|
-
See also: [BRC38Tables](./storage.md#interface-brc38tables)
|
|
420
|
-
|
|
421
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
422
|
-
|
|
423
|
-
---
|
|
424
|
-
##### Interface: BRC39Options
|
|
425
|
-
|
|
426
|
-
```ts
|
|
427
|
-
export interface BRC39Options {
|
|
428
|
-
iterations?: number;
|
|
429
|
-
memoryKiB?: number;
|
|
430
|
-
parallelism?: number;
|
|
493
|
+
[key: string]: unknown;
|
|
431
494
|
}
|
|
432
495
|
```
|
|
433
496
|
|
|
@@ -502,6 +565,41 @@ version: number
|
|
|
502
565
|
|
|
503
566
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
504
567
|
|
|
568
|
+
---
|
|
569
|
+
##### Interface: BeginActionBatchArgs
|
|
570
|
+
|
|
571
|
+
```ts
|
|
572
|
+
export interface BeginActionBatchArgs {
|
|
573
|
+
batchId: string;
|
|
574
|
+
firstAction: Validation.ValidCreateActionArgs;
|
|
575
|
+
}
|
|
576
|
+
```
|
|
577
|
+
|
|
578
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
579
|
+
|
|
580
|
+
---
|
|
581
|
+
##### Interface: BeginActionBatchResult
|
|
582
|
+
|
|
583
|
+
```ts
|
|
584
|
+
export interface BeginActionBatchResult {
|
|
585
|
+
batchId: string;
|
|
586
|
+
expiresAt: string;
|
|
587
|
+
hardExpiresAt: string;
|
|
588
|
+
changeBasket: TableOutputBasket;
|
|
589
|
+
feeModel: StorageFeeModel;
|
|
590
|
+
commissionSatoshis: number;
|
|
591
|
+
commissionPubKeyHex?: string;
|
|
592
|
+
availableChangeCount: number;
|
|
593
|
+
reservedOutputs: ActionBatchFundingOutput[];
|
|
594
|
+
explicitOutputs: ActionBatchFundingOutput[];
|
|
595
|
+
inputBeef?: number[] | Uint8Array;
|
|
596
|
+
}
|
|
597
|
+
```
|
|
598
|
+
|
|
599
|
+
See also: [ActionBatchFundingOutput](./client.md#interface-actionbatchfundingoutput), [StorageFeeModel](./client.md#interface-storagefeemodel), [TableOutputBasket](./storage.md#interface-tableoutputbasket)
|
|
600
|
+
|
|
601
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
602
|
+
|
|
505
603
|
---
|
|
506
604
|
##### Interface: BitailsConfig
|
|
507
605
|
|
|
@@ -1239,6 +1337,18 @@ See also: [BlockHeader](./client.md#interface-blockheader), [HeightRange](./serv
|
|
|
1239
1337
|
|
|
1240
1338
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1241
1339
|
|
|
1340
|
+
---
|
|
1341
|
+
##### Interface: CanonicalFundingCandidate
|
|
1342
|
+
|
|
1343
|
+
```ts
|
|
1344
|
+
export interface CanonicalFundingCandidate {
|
|
1345
|
+
outputId: number;
|
|
1346
|
+
satoshis: number;
|
|
1347
|
+
}
|
|
1348
|
+
```
|
|
1349
|
+
|
|
1350
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1351
|
+
|
|
1242
1352
|
---
|
|
1243
1353
|
##### Interface: CertOpsWallet
|
|
1244
1354
|
|
|
@@ -2519,6 +2629,22 @@ Argument Details
|
|
|
2519
2629
|
|
|
2520
2630
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2521
2631
|
|
|
2632
|
+
---
|
|
2633
|
+
##### Interface: CommitActionBatchResult
|
|
2634
|
+
|
|
2635
|
+
```ts
|
|
2636
|
+
export interface CommitActionBatchResult extends StorageProcessActionResults {
|
|
2637
|
+
batchId: string;
|
|
2638
|
+
manifestDigest: string;
|
|
2639
|
+
committedTxids: TXIDHexString[];
|
|
2640
|
+
alreadyCommitted: boolean;
|
|
2641
|
+
}
|
|
2642
|
+
```
|
|
2643
|
+
|
|
2644
|
+
See also: [StorageProcessActionResults](./client.md#interface-storageprocessactionresults)
|
|
2645
|
+
|
|
2646
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2647
|
+
|
|
2522
2648
|
---
|
|
2523
2649
|
##### Interface: CommitNewTxResults
|
|
2524
2650
|
|
|
@@ -2541,9 +2667,27 @@ export interface CompleteAuthResponse {
|
|
|
2541
2667
|
success: boolean;
|
|
2542
2668
|
message?: string;
|
|
2543
2669
|
presentationKey?: string;
|
|
2670
|
+
accountStatus?: "new-user" | "existing-user";
|
|
2671
|
+
existingUser?: boolean;
|
|
2544
2672
|
}
|
|
2545
2673
|
```
|
|
2546
2674
|
|
|
2675
|
+
###### Property accountStatus
|
|
2676
|
+
|
|
2677
|
+
Preferred explicit continuity signal for newer WAB servers.
|
|
2678
|
+
|
|
2679
|
+
```ts
|
|
2680
|
+
accountStatus?: "new-user" | "existing-user"
|
|
2681
|
+
```
|
|
2682
|
+
|
|
2683
|
+
###### Property existingUser
|
|
2684
|
+
|
|
2685
|
+
Compatibility signal accepted from WAB deployments using a boolean.
|
|
2686
|
+
|
|
2687
|
+
```ts
|
|
2688
|
+
existingUser?: boolean
|
|
2689
|
+
```
|
|
2690
|
+
|
|
2547
2691
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2548
2692
|
|
|
2549
2693
|
---
|
|
@@ -2797,6 +2941,40 @@ export interface ExchangeRatesIoApi {
|
|
|
2797
2941
|
|
|
2798
2942
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2799
2943
|
|
|
2944
|
+
---
|
|
2945
|
+
##### Interface: ExtendActionBatchArgs
|
|
2946
|
+
|
|
2947
|
+
```ts
|
|
2948
|
+
export interface ExtendActionBatchArgs {
|
|
2949
|
+
batchId: string;
|
|
2950
|
+
targetSatoshis: number;
|
|
2951
|
+
requestedOutputs: number;
|
|
2952
|
+
explicitOutpoints: Array<{
|
|
2953
|
+
txid: string;
|
|
2954
|
+
vout: number;
|
|
2955
|
+
}>;
|
|
2956
|
+
includeSourceTransactions: boolean;
|
|
2957
|
+
}
|
|
2958
|
+
```
|
|
2959
|
+
|
|
2960
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2961
|
+
|
|
2962
|
+
---
|
|
2963
|
+
##### Interface: ExtendActionBatchResult
|
|
2964
|
+
|
|
2965
|
+
```ts
|
|
2966
|
+
export interface ExtendActionBatchResult {
|
|
2967
|
+
expiresAt: string;
|
|
2968
|
+
reservedOutputs: ActionBatchFundingOutput[];
|
|
2969
|
+
explicitOutputs: ActionBatchFundingOutput[];
|
|
2970
|
+
inputBeef?: number[] | Uint8Array;
|
|
2971
|
+
}
|
|
2972
|
+
```
|
|
2973
|
+
|
|
2974
|
+
See also: [ActionBatchFundingOutput](./client.md#interface-actionbatchfundingoutput)
|
|
2975
|
+
|
|
2976
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2977
|
+
|
|
2800
2978
|
---
|
|
2801
2979
|
##### Interface: ExtendedVerifiableCertificate
|
|
2802
2980
|
|
|
@@ -4924,6 +5102,20 @@ onResponse: (res: any, context: {
|
|
|
4924
5102
|
|
|
4925
5103
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4926
5104
|
|
|
5105
|
+
---
|
|
5106
|
+
##### Interface: PlannerOutput
|
|
5107
|
+
|
|
5108
|
+
```ts
|
|
5109
|
+
export interface PlannerOutput extends ActionBatchFundingOutput {
|
|
5110
|
+
basketName?: string;
|
|
5111
|
+
tags?: string[];
|
|
5112
|
+
}
|
|
5113
|
+
```
|
|
5114
|
+
|
|
5115
|
+
See also: [ActionBatchFundingOutput](./client.md#interface-actionbatchfundingoutput)
|
|
5116
|
+
|
|
5117
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5118
|
+
|
|
4927
5119
|
---
|
|
4928
5120
|
##### Interface: PostBeefResult
|
|
4929
5121
|
|
|
@@ -5128,6 +5320,19 @@ status: "success" | "error"
|
|
|
5128
5320
|
|
|
5129
5321
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5130
5322
|
|
|
5323
|
+
---
|
|
5324
|
+
##### Interface: PrepareActionBatchCommitResult
|
|
5325
|
+
|
|
5326
|
+
```ts
|
|
5327
|
+
export interface PrepareActionBatchCommitResult {
|
|
5328
|
+
missingDigests: string[];
|
|
5329
|
+
maxBlobBytes: number;
|
|
5330
|
+
maxConcurrentUploads: number;
|
|
5331
|
+
}
|
|
5332
|
+
```
|
|
5333
|
+
|
|
5334
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5335
|
+
|
|
5131
5336
|
---
|
|
5132
5337
|
##### Interface: ProcessSyncChunkResult
|
|
5133
5338
|
|
|
@@ -5405,6 +5610,30 @@ export interface PurgeResults {
|
|
|
5405
5610
|
|
|
5406
5611
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5407
5612
|
|
|
5613
|
+
---
|
|
5614
|
+
##### Interface: PutActionBatchBlobArgs
|
|
5615
|
+
|
|
5616
|
+
```ts
|
|
5617
|
+
export interface PutActionBatchBlobArgs {
|
|
5618
|
+
batchId: string;
|
|
5619
|
+
digest: string;
|
|
5620
|
+
bytes: number[] | Uint8Array;
|
|
5621
|
+
}
|
|
5622
|
+
```
|
|
5623
|
+
|
|
5624
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5625
|
+
|
|
5626
|
+
---
|
|
5627
|
+
##### Interface: RenewActionBatchResult
|
|
5628
|
+
|
|
5629
|
+
```ts
|
|
5630
|
+
export interface RenewActionBatchResult {
|
|
5631
|
+
expiresAt: string;
|
|
5632
|
+
}
|
|
5633
|
+
```
|
|
5634
|
+
|
|
5635
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5636
|
+
|
|
5408
5637
|
---
|
|
5409
5638
|
##### Interface: ReorgResult
|
|
5410
5639
|
|
|
@@ -6255,7 +6484,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6255
6484
|
export interface StartAuthResponse {
|
|
6256
6485
|
success: boolean;
|
|
6257
6486
|
message?: string;
|
|
6258
|
-
data?:
|
|
6487
|
+
data?: unknown;
|
|
6259
6488
|
}
|
|
6260
6489
|
```
|
|
6261
6490
|
|
|
@@ -6383,6 +6612,26 @@ export interface StorageAdminStats {
|
|
|
6383
6612
|
|
|
6384
6613
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6385
6614
|
|
|
6615
|
+
---
|
|
6616
|
+
##### Interface: StorageCapabilities
|
|
6617
|
+
|
|
6618
|
+
Internal Wallet Toolbox capabilities. These do not extend the BRC-100 wallet interface.
|
|
6619
|
+
|
|
6620
|
+
```ts
|
|
6621
|
+
export interface StorageCapabilities {
|
|
6622
|
+
actionBatch?: {
|
|
6623
|
+
version: 1;
|
|
6624
|
+
maxInlineBytes: number;
|
|
6625
|
+
maxBlobBytes: number;
|
|
6626
|
+
maxConcurrentUploads: number;
|
|
6627
|
+
leaseMs: number;
|
|
6628
|
+
hardLifetimeMs: number;
|
|
6629
|
+
};
|
|
6630
|
+
}
|
|
6631
|
+
```
|
|
6632
|
+
|
|
6633
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6634
|
+
|
|
6386
6635
|
---
|
|
6387
6636
|
##### Interface: StorageClientOptions
|
|
6388
6637
|
|
|
@@ -6615,6 +6864,35 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6615
6864
|
|
|
6616
6865
|
```ts
|
|
6617
6866
|
export interface StorageIdbSchema {
|
|
6867
|
+
action_batches: {
|
|
6868
|
+
key: number;
|
|
6869
|
+
value: TableActionBatch;
|
|
6870
|
+
indexes: {
|
|
6871
|
+
userId: number;
|
|
6872
|
+
userId_batchId: [
|
|
6873
|
+
number,
|
|
6874
|
+
string
|
|
6875
|
+
];
|
|
6876
|
+
expiresAt: Date;
|
|
6877
|
+
};
|
|
6878
|
+
};
|
|
6879
|
+
action_batch_outputs: {
|
|
6880
|
+
key: number;
|
|
6881
|
+
value: TableActionBatchOutput;
|
|
6882
|
+
indexes: {
|
|
6883
|
+
actionBatchId: number;
|
|
6884
|
+
};
|
|
6885
|
+
};
|
|
6886
|
+
action_batch_blobs: {
|
|
6887
|
+
key: [
|
|
6888
|
+
number,
|
|
6889
|
+
string
|
|
6890
|
+
];
|
|
6891
|
+
value: TableActionBatchBlob;
|
|
6892
|
+
indexes: {
|
|
6893
|
+
actionBatchId: number;
|
|
6894
|
+
};
|
|
6895
|
+
};
|
|
6618
6896
|
certificates: {
|
|
6619
6897
|
key: number;
|
|
6620
6898
|
value: TableCertificate;
|
|
@@ -6763,7 +7041,7 @@ export interface StorageIdbSchema {
|
|
|
6763
7041
|
}
|
|
6764
7042
|
```
|
|
6765
7043
|
|
|
6766
|
-
See also: [ProvenTxReqStatus](./client.md#type-proventxreqstatus), [SyncStatus](./client.md#type-syncstatus), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TableCommission](./storage.md#interface-tablecommission), [TableMonitorEvent](./storage.md#interface-tablemonitorevent), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableSyncState](./storage.md#interface-tablesyncstate), [TableTransaction](./storage.md#interface-tabletransaction), [TableTxLabel](./storage.md#interface-tabletxlabel), [TableTxLabelMap](./storage.md#interface-tabletxlabelmap), [TableUser](./storage.md#interface-tableuser), [TransactionStatus](./client.md#type-transactionstatus)
|
|
7044
|
+
See also: [ProvenTxReqStatus](./client.md#type-proventxreqstatus), [SyncStatus](./client.md#type-syncstatus), [TableActionBatch](./storage.md#interface-tableactionbatch), [TableActionBatchBlob](./storage.md#interface-tableactionbatchblob), [TableActionBatchOutput](./storage.md#interface-tableactionbatchoutput), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TableCommission](./storage.md#interface-tablecommission), [TableMonitorEvent](./storage.md#interface-tablemonitorevent), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableSyncState](./storage.md#interface-tablesyncstate), [TableTransaction](./storage.md#interface-tabletransaction), [TableTxLabel](./storage.md#interface-tabletxlabel), [TableTxLabelMap](./storage.md#interface-tabletxlabelmap), [TableUser](./storage.md#interface-tableuser), [TransactionStatus](./client.md#type-transactionstatus)
|
|
6767
7045
|
|
|
6768
7046
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6769
7047
|
|
|
@@ -7049,12 +7327,63 @@ See also: [EntitySyncMap](./storage.md#interface-entitysyncmap)
|
|
|
7049
7327
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7050
7328
|
|
|
7051
7329
|
---
|
|
7052
|
-
##### Interface:
|
|
7330
|
+
##### Interface: TableActionBatch
|
|
7053
7331
|
|
|
7054
|
-
|
|
7055
|
-
|
|
7056
|
-
|
|
7057
|
-
|
|
7332
|
+
```ts
|
|
7333
|
+
export interface TableActionBatch extends EntityTimeStamp {
|
|
7334
|
+
actionBatchId: number;
|
|
7335
|
+
userId: number;
|
|
7336
|
+
batchId: string;
|
|
7337
|
+
status: ActionBatchStatus;
|
|
7338
|
+
expiresAt: Date;
|
|
7339
|
+
hardExpiresAt: Date;
|
|
7340
|
+
manifestDigest?: string;
|
|
7341
|
+
uploadDigests?: string;
|
|
7342
|
+
result?: string;
|
|
7343
|
+
}
|
|
7344
|
+
```
|
|
7345
|
+
|
|
7346
|
+
See also: [ActionBatchStatus](./storage.md#type-actionbatchstatus), [EntityTimeStamp](./client.md#interface-entitytimestamp)
|
|
7347
|
+
|
|
7348
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7349
|
+
|
|
7350
|
+
---
|
|
7351
|
+
##### Interface: TableActionBatchBlob
|
|
7352
|
+
|
|
7353
|
+
```ts
|
|
7354
|
+
export interface TableActionBatchBlob extends EntityTimeStamp {
|
|
7355
|
+
actionBatchBlobId: number;
|
|
7356
|
+
actionBatchId: number;
|
|
7357
|
+
digest: string;
|
|
7358
|
+
bytes: number[];
|
|
7359
|
+
}
|
|
7360
|
+
```
|
|
7361
|
+
|
|
7362
|
+
See also: [EntityTimeStamp](./client.md#interface-entitytimestamp)
|
|
7363
|
+
|
|
7364
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7365
|
+
|
|
7366
|
+
---
|
|
7367
|
+
##### Interface: TableActionBatchOutput
|
|
7368
|
+
|
|
7369
|
+
```ts
|
|
7370
|
+
export interface TableActionBatchOutput extends EntityTimeStamp {
|
|
7371
|
+
actionBatchId: number;
|
|
7372
|
+
outputId: number;
|
|
7373
|
+
}
|
|
7374
|
+
```
|
|
7375
|
+
|
|
7376
|
+
See also: [EntityTimeStamp](./client.md#interface-entitytimestamp)
|
|
7377
|
+
|
|
7378
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7379
|
+
|
|
7380
|
+
---
|
|
7381
|
+
##### Interface: TableAuthSession
|
|
7382
|
+
|
|
7383
|
+
Durable representation of a BRC-103 peer session.
|
|
7384
|
+
|
|
7385
|
+
The session nonce is the authoritative key. `lastUpdate` also acts as the
|
|
7386
|
+
optimistic-write version so a delayed request from one replica cannot
|
|
7058
7387
|
overwrite newer authentication state written by another replica.
|
|
7059
7388
|
|
|
7060
7389
|
```ts
|
|
@@ -7963,6 +8292,25 @@ See also: [UMPToken](./client.md#interface-umptoken)
|
|
|
7963
8292
|
|
|
7964
8293
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7965
8294
|
|
|
8295
|
+
---
|
|
8296
|
+
##### Interface: UMPTokenLookupDiagnostics
|
|
8297
|
+
|
|
8298
|
+
```ts
|
|
8299
|
+
export interface UMPTokenLookupDiagnostics {
|
|
8300
|
+
hostCount: number;
|
|
8301
|
+
completedHosts: number;
|
|
8302
|
+
successfulHosts: number;
|
|
8303
|
+
emptyHosts: number;
|
|
8304
|
+
failedHosts: number;
|
|
8305
|
+
rejectedHosts: number;
|
|
8306
|
+
freeformHosts: number;
|
|
8307
|
+
outputCount: number;
|
|
8308
|
+
correlationId?: string;
|
|
8309
|
+
}
|
|
8310
|
+
```
|
|
8311
|
+
|
|
8312
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8313
|
+
|
|
7966
8314
|
---
|
|
7967
8315
|
##### Interface: UpdateProvenTxReqWithNewProvenTxArgs
|
|
7968
8316
|
|
|
@@ -8030,6 +8378,22 @@ export interface ValidateGenerateChangeSdkParamsResult {
|
|
|
8030
8378
|
|
|
8031
8379
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8032
8380
|
|
|
8381
|
+
---
|
|
8382
|
+
##### Interface: ValidatedBatchAction
|
|
8383
|
+
|
|
8384
|
+
```ts
|
|
8385
|
+
export interface ValidatedBatchAction {
|
|
8386
|
+
action: ActionBatchCommitAction;
|
|
8387
|
+
tx: Transaction;
|
|
8388
|
+
rawTx: number[];
|
|
8389
|
+
inputBeef: number[];
|
|
8390
|
+
}
|
|
8391
|
+
```
|
|
8392
|
+
|
|
8393
|
+
See also: [ActionBatchCommitAction](./client.md#interface-actionbatchcommitaction)
|
|
8394
|
+
|
|
8395
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8396
|
+
|
|
8033
8397
|
---
|
|
8034
8398
|
##### Interface: VerifyAndRepairBeefResult
|
|
8035
8399
|
|
|
@@ -8049,6 +8413,129 @@ See also: [ReproveHeaderResult](./client.md#interface-reproveheaderresult)
|
|
|
8049
8413
|
|
|
8050
8414
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8051
8415
|
|
|
8416
|
+
---
|
|
8417
|
+
##### Interface: WABClientOptions
|
|
8418
|
+
|
|
8419
|
+
```ts
|
|
8420
|
+
export interface WABClientOptions extends WABTransportOptions {
|
|
8421
|
+
}
|
|
8422
|
+
```
|
|
8423
|
+
|
|
8424
|
+
See also: [WABTransportOptions](./client.md#interface-wabtransportoptions)
|
|
8425
|
+
|
|
8426
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8427
|
+
|
|
8428
|
+
---
|
|
8429
|
+
##### Interface: WABFaucetResponse
|
|
8430
|
+
|
|
8431
|
+
```ts
|
|
8432
|
+
export interface WABFaucetResponse extends WABOperationResponse {
|
|
8433
|
+
paymentData?: {
|
|
8434
|
+
k?: string;
|
|
8435
|
+
tx?: number[];
|
|
8436
|
+
txid?: string;
|
|
8437
|
+
};
|
|
8438
|
+
}
|
|
8439
|
+
```
|
|
8440
|
+
|
|
8441
|
+
See also: [WABOperationResponse](./client.md#interface-waboperationresponse)
|
|
8442
|
+
|
|
8443
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8444
|
+
|
|
8445
|
+
---
|
|
8446
|
+
##### Interface: WABOperationResponse
|
|
8447
|
+
|
|
8448
|
+
```ts
|
|
8449
|
+
export interface WABOperationResponse {
|
|
8450
|
+
success: boolean;
|
|
8451
|
+
message?: string;
|
|
8452
|
+
[key: string]: unknown;
|
|
8453
|
+
}
|
|
8454
|
+
```
|
|
8455
|
+
|
|
8456
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8457
|
+
|
|
8458
|
+
---
|
|
8459
|
+
##### Interface: WABRequestOptions
|
|
8460
|
+
|
|
8461
|
+
```ts
|
|
8462
|
+
export interface WABRequestOptions {
|
|
8463
|
+
method?: "GET" | "POST";
|
|
8464
|
+
body?: unknown;
|
|
8465
|
+
operation: string;
|
|
8466
|
+
correlationId?: string;
|
|
8467
|
+
}
|
|
8468
|
+
```
|
|
8469
|
+
|
|
8470
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8471
|
+
|
|
8472
|
+
---
|
|
8473
|
+
##### Interface: WABServerInfo
|
|
8474
|
+
|
|
8475
|
+
```ts
|
|
8476
|
+
export interface WABServerInfo {
|
|
8477
|
+
supportedAuthMethods?: string[];
|
|
8478
|
+
[key: string]: unknown;
|
|
8479
|
+
}
|
|
8480
|
+
```
|
|
8481
|
+
|
|
8482
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8483
|
+
|
|
8484
|
+
---
|
|
8485
|
+
##### Interface: WABTransportOptions
|
|
8486
|
+
|
|
8487
|
+
```ts
|
|
8488
|
+
export interface WABTransportOptions {
|
|
8489
|
+
fetch?: typeof fetch;
|
|
8490
|
+
timeoutMs?: number;
|
|
8491
|
+
maxRequestBytes?: number;
|
|
8492
|
+
maxResponseBytes?: number;
|
|
8493
|
+
telemetry?: TelemetryConfig;
|
|
8494
|
+
}
|
|
8495
|
+
```
|
|
8496
|
+
|
|
8497
|
+
###### Property fetch
|
|
8498
|
+
|
|
8499
|
+
Injectable fetch implementation for React Native, tests, and custom runtimes.
|
|
8500
|
+
|
|
8501
|
+
```ts
|
|
8502
|
+
fetch?: typeof fetch
|
|
8503
|
+
```
|
|
8504
|
+
|
|
8505
|
+
###### Property maxRequestBytes
|
|
8506
|
+
|
|
8507
|
+
Maximum encoded JSON request size. Defaults to 1 MiB.
|
|
8508
|
+
|
|
8509
|
+
```ts
|
|
8510
|
+
maxRequestBytes?: number
|
|
8511
|
+
```
|
|
8512
|
+
|
|
8513
|
+
###### Property maxResponseBytes
|
|
8514
|
+
|
|
8515
|
+
Maximum accepted JSON response size. Defaults to 1 MiB.
|
|
8516
|
+
|
|
8517
|
+
```ts
|
|
8518
|
+
maxResponseBytes?: number
|
|
8519
|
+
```
|
|
8520
|
+
|
|
8521
|
+
###### Property telemetry
|
|
8522
|
+
|
|
8523
|
+
Optional privacy-bounded telemetry integration.
|
|
8524
|
+
|
|
8525
|
+
```ts
|
|
8526
|
+
telemetry?: TelemetryConfig
|
|
8527
|
+
```
|
|
8528
|
+
|
|
8529
|
+
###### Property timeoutMs
|
|
8530
|
+
|
|
8531
|
+
Hard wall-clock request timeout. Defaults to 10 seconds.
|
|
8532
|
+
|
|
8533
|
+
```ts
|
|
8534
|
+
timeoutMs?: number
|
|
8535
|
+
```
|
|
8536
|
+
|
|
8537
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8538
|
+
|
|
8052
8539
|
---
|
|
8053
8540
|
##### Interface: WalletArgs
|
|
8054
8541
|
|
|
@@ -8064,10 +8551,22 @@ export interface WalletArgs {
|
|
|
8064
8551
|
lookupResolver?: LookupResolver;
|
|
8065
8552
|
contactSource?: ContactSource;
|
|
8066
8553
|
makeLogger?: MakeWalletLogger;
|
|
8554
|
+
actionBatchMode?: ActionBatchMode;
|
|
8067
8555
|
}
|
|
8068
8556
|
```
|
|
8069
8557
|
|
|
8070
|
-
See also: [Chain](./client.md#type-chain), [ContactSource](./client.md#interface-contactsource), [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [WalletServices](./client.md#interface-walletservices), [WalletSettingsManager](./client.md#class-walletsettingsmanager), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
8558
|
+
See also: [ActionBatchMode](./client.md#type-actionbatchmode), [Chain](./client.md#type-chain), [ContactSource](./client.md#interface-contactsource), [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [WalletServices](./client.md#interface-walletservices), [WalletSettingsManager](./client.md#class-walletsettingsmanager), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
8559
|
+
|
|
8560
|
+
###### Property actionBatchMode
|
|
8561
|
+
|
|
8562
|
+
Internal Wallet Toolbox optimization policy. `auto` negotiates the optional
|
|
8563
|
+
action-batch storage capability; `legacy` always uses per-action storage.
|
|
8564
|
+
This does not change the BRC-100 wallet interface.
|
|
8565
|
+
|
|
8566
|
+
```ts
|
|
8567
|
+
actionBatchMode?: ActionBatchMode
|
|
8568
|
+
```
|
|
8569
|
+
See also: [ActionBatchMode](./client.md#type-actionbatchmode)
|
|
8071
8570
|
|
|
8072
8571
|
###### Property contactSource
|
|
8073
8572
|
|
|
@@ -8097,6 +8596,26 @@ makeLogger?: MakeWalletLogger
|
|
|
8097
8596
|
|
|
8098
8597
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8099
8598
|
|
|
8599
|
+
---
|
|
8600
|
+
##### Interface: WalletAuthenticationManagerOptions
|
|
8601
|
+
|
|
8602
|
+
```ts
|
|
8603
|
+
export interface WalletAuthenticationManagerOptions {
|
|
8604
|
+
telemetry?: TelemetryConfig;
|
|
8605
|
+
authSessionTtlMs?: number;
|
|
8606
|
+
}
|
|
8607
|
+
```
|
|
8608
|
+
|
|
8609
|
+
###### Property authSessionTtlMs
|
|
8610
|
+
|
|
8611
|
+
Maximum lifetime of a temporary WAB presentation key. Defaults to 10 minutes.
|
|
8612
|
+
|
|
8613
|
+
```ts
|
|
8614
|
+
authSessionTtlMs?: number
|
|
8615
|
+
```
|
|
8616
|
+
|
|
8617
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8618
|
+
|
|
8100
8619
|
---
|
|
8101
8620
|
##### Interface: WalletBalance
|
|
8102
8621
|
|
|
@@ -8651,6 +9170,14 @@ export interface WalletStorage {
|
|
|
8651
9170
|
abortAction: (args: AbortActionArgs) => Promise<AbortActionResult>;
|
|
8652
9171
|
createAction: (args: Validation.ValidCreateActionArgs) => Promise<StorageCreateActionResult>;
|
|
8653
9172
|
processAction: (args: StorageProcessActionArgs) => Promise<StorageProcessActionResults>;
|
|
9173
|
+
getCapabilities: () => Promise<StorageCapabilities>;
|
|
9174
|
+
beginActionBatch: (args: BeginActionBatchArgs) => Promise<BeginActionBatchResult>;
|
|
9175
|
+
extendActionBatch: (args: ExtendActionBatchArgs) => Promise<ExtendActionBatchResult>;
|
|
9176
|
+
renewActionBatch: (batchId: string) => Promise<RenewActionBatchResult>;
|
|
9177
|
+
prepareActionBatchCommit: (manifest: ActionBatchManifest) => Promise<PrepareActionBatchCommitResult>;
|
|
9178
|
+
putActionBatchBlob: (args: PutActionBatchBlobArgs) => Promise<void>;
|
|
9179
|
+
commitActionBatch: (manifest: ActionBatchManifest) => Promise<CommitActionBatchResult>;
|
|
9180
|
+
abortActionBatch: (batchId: string) => Promise<AbortActionBatchResult>;
|
|
8654
9181
|
internalizeAction: (args: InternalizeActionArgs) => Promise<InternalizeActionResult>;
|
|
8655
9182
|
findCertificates: (args: FindCertificatesArgs) => Promise<TableCertificateX[]>;
|
|
8656
9183
|
findOutputBaskets: (args: FindOutputBasketsArgs) => Promise<TableOutputBasket[]>;
|
|
@@ -8666,7 +9193,7 @@ export interface WalletStorage {
|
|
|
8666
9193
|
}
|
|
8667
9194
|
```
|
|
8668
9195
|
|
|
8669
|
-
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), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [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), [WalletServices](./client.md#interface-walletservices), [WalletStorageInfo](./client.md#interface-walletstorageinfo), [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)
|
|
9196
|
+
See also: [AbortActionBatchResult](./client.md#interface-abortactionbatchresult), [ActionBatchManifest](./client.md#interface-actionbatchmanifest), [AuthId](./client.md#interface-authid), [BeginActionBatchArgs](./client.md#interface-beginactionbatchargs), [BeginActionBatchResult](./client.md#interface-beginactionbatchresult), [CommitActionBatchResult](./client.md#interface-commitactionbatchresult), [ExtendActionBatchArgs](./client.md#interface-extendactionbatchargs), [ExtendActionBatchResult](./client.md#interface-extendactionbatchresult), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [PrepareActionBatchCommitResult](./client.md#interface-prepareactionbatchcommitresult), [PutActionBatchBlobArgs](./client.md#interface-putactionbatchblobargs), [RenewActionBatchResult](./client.md#interface-renewactionbatchresult), [StorageCapabilities](./client.md#interface-storagecapabilities), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [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), [WalletServices](./client.md#interface-walletservices), [WalletStorageInfo](./client.md#interface-walletstorageinfo), [abortActionBatch](./storage.md#function-abortactionbatch), [beginActionBatch](./storage.md#function-beginactionbatch), [commitActionBatch](./storage.md#function-commitactionbatch), [createAction](./storage.md#function-createaction), [extendActionBatch](./storage.md#function-extendactionbatch), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [prepareActionBatchCommit](./storage.md#function-prepareactionbatchcommit), [processAction](./storage.md#function-processaction), [putActionBatchBlob](./storage.md#function-putactionbatchblob), [renewActionBatch](./storage.md#function-renewactionbatch)
|
|
8670
9197
|
|
|
8671
9198
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8672
9199
|
|
|
@@ -8789,6 +9316,14 @@ export interface WalletStorageWriter extends WalletStorageReader {
|
|
|
8789
9316
|
abortAction: (auth: AuthId, args: AbortActionArgs) => Promise<AbortActionResult>;
|
|
8790
9317
|
createAction: (auth: AuthId, args: Validation.ValidCreateActionArgs) => Promise<StorageCreateActionResult>;
|
|
8791
9318
|
processAction: (auth: AuthId, args: StorageProcessActionArgs) => Promise<StorageProcessActionResults>;
|
|
9319
|
+
getCapabilities: () => Promise<StorageCapabilities>;
|
|
9320
|
+
beginActionBatch: (auth: AuthId, args: BeginActionBatchArgs) => Promise<BeginActionBatchResult>;
|
|
9321
|
+
extendActionBatch: (auth: AuthId, args: ExtendActionBatchArgs) => Promise<ExtendActionBatchResult>;
|
|
9322
|
+
renewActionBatch: (auth: AuthId, batchId: string) => Promise<RenewActionBatchResult>;
|
|
9323
|
+
prepareActionBatchCommit: (auth: AuthId, manifest: ActionBatchManifest) => Promise<PrepareActionBatchCommitResult>;
|
|
9324
|
+
putActionBatchBlob: (auth: AuthId, args: PutActionBatchBlobArgs) => Promise<void>;
|
|
9325
|
+
commitActionBatch: (auth: AuthId, manifest: ActionBatchManifest) => Promise<CommitActionBatchResult>;
|
|
9326
|
+
abortActionBatch: (auth: AuthId, batchId: string) => Promise<AbortActionBatchResult>;
|
|
8792
9327
|
internalizeAction: (auth: AuthId, args: InternalizeActionArgs) => Promise<StorageInternalizeActionResult>;
|
|
8793
9328
|
insertCertificateAuth: (auth: AuthId, certificate: TableCertificateX) => Promise<number>;
|
|
8794
9329
|
relinquishCertificate: (auth: AuthId, args: RelinquishCertificateArgs) => Promise<number>;
|
|
@@ -8796,7 +9331,7 @@ export interface WalletStorageWriter extends WalletStorageReader {
|
|
|
8796
9331
|
}
|
|
8797
9332
|
```
|
|
8798
9333
|
|
|
8799
|
-
See also: [AuthId](./client.md#interface-authid), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableSettings](./storage.md#interface-tablesettings), [TableUser](./storage.md#interface-tableuser), [WalletStorageReader](./client.md#interface-walletstoragereader), [createAction](./storage.md#function-createaction), [internalizeAction](./storage.md#function-internalizeaction), [processAction](./storage.md#function-processaction)
|
|
9334
|
+
See also: [AbortActionBatchResult](./client.md#interface-abortactionbatchresult), [ActionBatchManifest](./client.md#interface-actionbatchmanifest), [AuthId](./client.md#interface-authid), [BeginActionBatchArgs](./client.md#interface-beginactionbatchargs), [BeginActionBatchResult](./client.md#interface-beginactionbatchresult), [CommitActionBatchResult](./client.md#interface-commitactionbatchresult), [ExtendActionBatchArgs](./client.md#interface-extendactionbatchargs), [ExtendActionBatchResult](./client.md#interface-extendactionbatchresult), [PrepareActionBatchCommitResult](./client.md#interface-prepareactionbatchcommitresult), [PutActionBatchBlobArgs](./client.md#interface-putactionbatchblobargs), [RenewActionBatchResult](./client.md#interface-renewactionbatchresult), [StorageCapabilities](./client.md#interface-storagecapabilities), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableSettings](./storage.md#interface-tablesettings), [TableUser](./storage.md#interface-tableuser), [WalletStorageReader](./client.md#interface-walletstoragereader), [abortActionBatch](./storage.md#function-abortactionbatch), [beginActionBatch](./storage.md#function-beginactionbatch), [commitActionBatch](./storage.md#function-commitactionbatch), [createAction](./storage.md#function-createaction), [extendActionBatch](./storage.md#function-extendactionbatch), [internalizeAction](./storage.md#function-internalizeaction), [prepareActionBatchCommit](./storage.md#function-prepareactionbatchcommit), [processAction](./storage.md#function-processaction), [putActionBatchBlob](./storage.md#function-putactionbatchblob), [renewActionBatch](./storage.md#function-renewactionbatch)
|
|
8800
9335
|
|
|
8801
9336
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8802
9337
|
|
|
@@ -8986,46 +9521,48 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
8986
9521
|
|
|
8987
9522
|
| | | |
|
|
8988
9523
|
| --- | --- | --- |
|
|
8989
|
-
| [ARC](#class-arc) | [
|
|
8990
|
-
| [
|
|
8991
|
-
| [
|
|
8992
|
-
| [
|
|
8993
|
-
| [
|
|
8994
|
-
| [
|
|
8995
|
-
| [
|
|
8996
|
-
| [
|
|
8997
|
-
| [
|
|
8998
|
-
| [
|
|
8999
|
-
| [
|
|
9000
|
-
| [
|
|
9001
|
-
| [
|
|
9002
|
-
| [
|
|
9003
|
-
| [
|
|
9004
|
-
| [
|
|
9005
|
-
| [
|
|
9006
|
-
| [
|
|
9007
|
-
| [
|
|
9008
|
-
| [
|
|
9009
|
-
| [
|
|
9010
|
-
| [
|
|
9011
|
-
| [
|
|
9012
|
-
| [
|
|
9013
|
-
| [
|
|
9014
|
-
| [
|
|
9015
|
-
| [
|
|
9016
|
-
| [
|
|
9017
|
-
| [
|
|
9018
|
-
| [
|
|
9019
|
-
| [
|
|
9020
|
-
| [
|
|
9021
|
-
| [
|
|
9022
|
-
| [
|
|
9023
|
-
| [
|
|
9024
|
-
| [
|
|
9025
|
-
| [
|
|
9026
|
-
| [
|
|
9027
|
-
| [
|
|
9028
|
-
| [
|
|
9524
|
+
| [ARC](#class-arc) | [EntityTransaction](#class-entitytransaction) | [TaskPurge](#class-taskpurge) |
|
|
9525
|
+
| [ActionBatchController](#class-actionbatchcontroller) | [EntityTxLabel](#class-entitytxlabel) | [TaskReorg](#class-taskreorg) |
|
|
9526
|
+
| [ArcSSEClient](#class-arcsseclient) | [EntityTxLabelMap](#class-entitytxlabelmap) | [TaskReviewDoubleSpends](#class-taskreviewdoublespends) |
|
|
9527
|
+
| [Arcade](#class-arcade) | [EntityUser](#class-entityuser) | [TaskReviewProvenTxs](#class-taskreviewproventxs) |
|
|
9528
|
+
| [AuthMethodInteractor](#class-authmethodinteractor) | [GoChaintracksServiceClient](#class-gochaintracksserviceclient) | [TaskReviewStatus](#class-taskreviewstatus) |
|
|
9529
|
+
| [BHServiceClient](#class-bhserviceclient) | [HeightRange](#class-heightrange) | [TaskReviewUtxos](#class-taskreviewutxos) |
|
|
9530
|
+
| [Bitails](#class-bitails) | [LiveIngestorBase](#class-liveingestorbase) | [TaskSendWaiting](#class-tasksendwaiting) |
|
|
9531
|
+
| [BulkFileDataManager](#class-bulkfiledatamanager) | [LiveIngestorChaintracksSSE](#class-liveingestorchaintrackssse) | [TaskUnFail](#class-taskunfail) |
|
|
9532
|
+
| [BulkFileDataReader](#class-bulkfiledatareader) | [LiveIngestorWhatsOnChainPoll](#class-liveingestorwhatsonchainpoll) | [TwilioPhoneInteractor](#class-twiliophoneinteractor) |
|
|
9533
|
+
| [BulkFilesReader](#class-bulkfilesreader) | [MergeEntity](#class-mergeentity) | [UMPTokenLookupError](#class-umptokenlookuperror) |
|
|
9534
|
+
| [BulkFilesReaderFs](#class-bulkfilesreaderfs) | [MockChainMigrations](#class-mockchainmigrations) | [WABAccountContinuityError](#class-wabaccountcontinuityerror) |
|
|
9535
|
+
| [BulkFilesReaderStorage](#class-bulkfilesreaderstorage) | [MockChainStorage](#class-mockchainstorage) | [WABClient](#class-wabclient) |
|
|
9536
|
+
| [BulkHeaderFile](#class-bulkheaderfile) | [MockChainTracker](#class-mockchaintracker) | [WABClientError](#class-wabclienterror) |
|
|
9537
|
+
| [BulkHeaderFileFs](#class-bulkheaderfilefs) | [MockMiner](#class-mockminer) | [WABTransport](#class-wabtransport) |
|
|
9538
|
+
| [BulkHeaderFileStorage](#class-bulkheaderfilestorage) | [MockServices](#class-mockservices) | [WERR_BAD_REQUEST](#class-werr_bad_request) |
|
|
9539
|
+
| [BulkHeaderFiles](#class-bulkheaderfiles) | [Monitor](#class-monitor) | [WERR_BROADCAST_UNAVAILABLE](#class-werr_broadcast_unavailable) |
|
|
9540
|
+
| [BulkIngestorBase](#class-bulkingestorbase) | [OverlayUMPTokenInteractor](#class-overlayumptokeninteractor) | [WERR_INSUFFICIENT_FUNDS](#class-werr_insufficient_funds) |
|
|
9541
|
+
| [BulkIngestorCDN](#class-bulkingestorcdn) | [PersonaIDInteractor](#class-personaidinteractor) | [WERR_INTERNAL](#class-werr_internal) |
|
|
9542
|
+
| [BulkIngestorCDNBabbage](#class-bulkingestorcdnbabbage) | [PrivilegedKeyManager](#class-privilegedkeymanager) | [WERR_INVALID_MERKLE_ROOT](#class-werr_invalid_merkle_root) |
|
|
9543
|
+
| [BulkIngestorWhatsOnChainCdn](#class-bulkingestorwhatsonchaincdn) | [ScriptTemplateBRC29](#class-scripttemplatebrc29) | [WERR_INVALID_OPERATION](#class-werr_invalid_operation) |
|
|
9544
|
+
| [BulkStorageBase](#class-bulkstoragebase) | [SdkWhatsOnChain](#class-sdkwhatsonchain) | [WERR_INVALID_PARAMETER](#class-werr_invalid_parameter) |
|
|
9545
|
+
| [CWIStyleWalletManager](#class-cwistylewalletmanager) | [ServiceCollection](#class-servicecollection) | [WERR_INVALID_PUBLIC_KEY](#class-werr_invalid_public_key) |
|
|
9546
|
+
| [Chaintracks](#class-chaintracks) | [Services](#class-services) | [WERR_MISSING_PARAMETER](#class-werr_missing_parameter) |
|
|
9547
|
+
| [ChaintracksChainTracker](#class-chaintrackschaintracker) | [SetupClient](#class-setupclient) | [WERR_NETWORK_CHAIN](#class-werr_network_chain) |
|
|
9548
|
+
| [ChaintracksFetch](#class-chaintracksfetch) | [SimpleWalletManager](#class-simplewalletmanager) | [WERR_NOT_ACTIVE](#class-werr_not_active) |
|
|
9549
|
+
| [ChaintracksFetchError](#class-chaintracksfetcherror) | [SingleWriterMultiReaderLock](#class-singlewritermultireaderlock) | [WERR_NOT_IMPLEMENTED](#class-werr_not_implemented) |
|
|
9550
|
+
| [ChaintracksServiceClient](#class-chaintracksserviceclient) | [StorageClient](#class-storageclient) | [WERR_REVIEW_ACTIONS](#class-werr_review_actions) |
|
|
9551
|
+
| [ChaintracksStorageBase](#class-chaintracksstoragebase) | [StorageClientBase](#class-storageclientbase) | [WERR_UNAUTHORIZED](#class-werr_unauthorized) |
|
|
9552
|
+
| [ChaintracksStorageIdb](#class-chaintracksstorageidb) | [StorageIdb](#class-storageidb) | [Wallet](#class-wallet) |
|
|
9553
|
+
| [ChaintracksStorageNoDb](#class-chaintracksstoragenodb) | [StorageProvider](#class-storageprovider) | [WalletAuthenticationManager](#class-walletauthenticationmanager) |
|
|
9554
|
+
| [DevConsoleInteractor](#class-devconsoleinteractor) | [StorageReader](#class-storagereader) | [WalletError](#class-walleterror) |
|
|
9555
|
+
| [EntityBase](#class-entitybase) | [StorageReaderWriter](#class-storagereaderwriter) | [WalletLogger](#class-walletlogger) |
|
|
9556
|
+
| [EntityCertificate](#class-entitycertificate) | [StorageSyncReader](#class-storagesyncreader) | [WalletMonitorTask](#class-walletmonitortask) |
|
|
9557
|
+
| [EntityCertificateField](#class-entitycertificatefield) | [TaskArcadeSSE](#class-taskarcadesse) | [WalletPermissionsManager](#class-walletpermissionsmanager) |
|
|
9558
|
+
| [EntityCommission](#class-entitycommission) | [TaskCheckForProofs](#class-taskcheckforproofs) | [WalletSettingsManager](#class-walletsettingsmanager) |
|
|
9559
|
+
| [EntityOutput](#class-entityoutput) | [TaskCheckNoSends](#class-taskchecknosends) | [WalletSigner](#class-walletsigner) |
|
|
9560
|
+
| [EntityOutputBasket](#class-entityoutputbasket) | [TaskCleanupActionBatches](#class-taskcleanupactionbatches) | [WalletStorageManager](#class-walletstoragemanager) |
|
|
9561
|
+
| [EntityOutputTag](#class-entityoutputtag) | [TaskClock](#class-taskclock) | [WhatsOnChain](#class-whatsonchain) |
|
|
9562
|
+
| [EntityOutputTagMap](#class-entityoutputtagmap) | [TaskFailAbandoned](#class-taskfailabandoned) | [WhatsOnChainNoServices](#class-whatsonchainnoservices) |
|
|
9563
|
+
| [EntityProvenTx](#class-entityproventx) | [TaskMineBlock](#class-taskmineblock) | [WhatsOnChainServices](#class-whatsonchainservices) |
|
|
9564
|
+
| [EntityProvenTxReq](#class-entityproventxreq) | [TaskMonitorCallHistory](#class-taskmonitorcallhistory) | |
|
|
9565
|
+
| [EntitySyncState](#class-entitysyncstate) | [TaskNewHeader](#class-tasknewheader) | |
|
|
9029
9566
|
|
|
9030
9567
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9031
9568
|
|
|
@@ -9124,6 +9661,27 @@ See also: [PostTxResultForTxid](./client.md#interface-posttxresultfortxid)
|
|
|
9124
9661
|
|
|
9125
9662
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9126
9663
|
|
|
9664
|
+
---
|
|
9665
|
+
##### Class: ActionBatchController
|
|
9666
|
+
|
|
9667
|
+
```ts
|
|
9668
|
+
export class ActionBatchController {
|
|
9669
|
+
constructor(private readonly wallet: Wallet, readonly mode: ActionBatchMode)
|
|
9670
|
+
get hasWorkspace(): boolean
|
|
9671
|
+
overlayListActions(persisted: ListActionsResult, args: Validation.ValidListActionsArgs): ListActionsResult
|
|
9672
|
+
overlayListOutputs(persisted: ListOutputsResult, args: Validation.ValidListOutputsArgs): ListOutputsResult
|
|
9673
|
+
async plan(args: Validation.ValidCreateActionArgs): Promise<StorageCreateActionResult | undefined>
|
|
9674
|
+
async process(prior: PendingSignAction | undefined, args: Validation.ValidProcessActionArgs): Promise<StorageProcessActionResults | undefined>
|
|
9675
|
+
ownsReference(reference: string): boolean
|
|
9676
|
+
async abort(): Promise<boolean>
|
|
9677
|
+
async abortAction(referenceOrTxid: string): Promise<boolean>
|
|
9678
|
+
}
|
|
9679
|
+
```
|
|
9680
|
+
|
|
9681
|
+
See also: [ActionBatchMode](./client.md#type-actionbatchmode), [PendingSignAction](./client.md#interface-pendingsignaction), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [Wallet](./client.md#class-wallet)
|
|
9682
|
+
|
|
9683
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9684
|
+
|
|
9127
9685
|
---
|
|
9128
9686
|
##### Class: ArcSSEClient
|
|
9129
9687
|
|
|
@@ -9237,30 +9795,31 @@ Subclasses only need to set `methodType`; the HTTP calls to
|
|
|
9237
9795
|
```ts
|
|
9238
9796
|
export abstract class AuthMethodInteractor {
|
|
9239
9797
|
public abstract methodType: string;
|
|
9240
|
-
|
|
9241
|
-
public async
|
|
9798
|
+
protected preparePayload(payload: AuthPayload): AuthPayload
|
|
9799
|
+
public async startAuth(serverUrl: string, presentationKey: string, payload: AuthPayload, transport?: WABTransport, correlationId?: string): Promise<StartAuthResponse>
|
|
9800
|
+
public async completeAuth(serverUrl: string, presentationKey: string, payload: AuthPayload, transport?: WABTransport, correlationId?: string): Promise<CompleteAuthResponse>
|
|
9242
9801
|
}
|
|
9243
9802
|
```
|
|
9244
9803
|
|
|
9245
|
-
See also: [AuthPayload](./client.md#interface-authpayload), [CompleteAuthResponse](./client.md#interface-completeauthresponse), [StartAuthResponse](./client.md#interface-startauthresponse)
|
|
9804
|
+
See also: [AuthPayload](./client.md#interface-authpayload), [CompleteAuthResponse](./client.md#interface-completeauthresponse), [StartAuthResponse](./client.md#interface-startauthresponse), [WABTransport](./client.md#class-wabtransport)
|
|
9246
9805
|
|
|
9247
9806
|
###### Method completeAuth
|
|
9248
9807
|
|
|
9249
9808
|
Complete the flow (e.g. confirm OTP).
|
|
9250
9809
|
|
|
9251
9810
|
```ts
|
|
9252
|
-
public async completeAuth(serverUrl: string, presentationKey: string, payload: AuthPayload): Promise<CompleteAuthResponse>
|
|
9811
|
+
public async completeAuth(serverUrl: string, presentationKey: string, payload: AuthPayload, transport?: WABTransport, correlationId?: string): Promise<CompleteAuthResponse>
|
|
9253
9812
|
```
|
|
9254
|
-
See also: [AuthPayload](./client.md#interface-authpayload), [CompleteAuthResponse](./client.md#interface-completeauthresponse)
|
|
9813
|
+
See also: [AuthPayload](./client.md#interface-authpayload), [CompleteAuthResponse](./client.md#interface-completeauthresponse), [WABTransport](./client.md#class-wabtransport)
|
|
9255
9814
|
|
|
9256
9815
|
###### Method startAuth
|
|
9257
9816
|
|
|
9258
9817
|
Start the flow (e.g. request an OTP or create a session).
|
|
9259
9818
|
|
|
9260
9819
|
```ts
|
|
9261
|
-
public async startAuth(serverUrl: string, presentationKey: string, payload: AuthPayload): Promise<StartAuthResponse>
|
|
9820
|
+
public async startAuth(serverUrl: string, presentationKey: string, payload: AuthPayload, transport?: WABTransport, correlationId?: string): Promise<StartAuthResponse>
|
|
9262
9821
|
```
|
|
9263
|
-
See also: [AuthPayload](./client.md#interface-authpayload), [StartAuthResponse](./client.md#interface-startauthresponse)
|
|
9822
|
+
See also: [AuthPayload](./client.md#interface-authpayload), [StartAuthResponse](./client.md#interface-startauthresponse), [WABTransport](./client.md#class-wabtransport)
|
|
9264
9823
|
|
|
9265
9824
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9266
9825
|
|
|
@@ -9938,9 +10497,10 @@ supporting multiple user profiles under a single account.
|
|
|
9938
10497
|
export class CWIStyleWalletManager implements WalletInterface {
|
|
9939
10498
|
authenticated: boolean;
|
|
9940
10499
|
get ready(): Promise<void>
|
|
10500
|
+
protected readonly telemetry: Telemetry;
|
|
9941
10501
|
authenticationMode: "presentation-key-and-password" | "presentation-key-and-recovery-key" | "recovery-key-and-password" = "presentation-key-and-password";
|
|
9942
|
-
authenticationFlow: "new-user" | "existing-user" = "
|
|
9943
|
-
constructor(adminOriginator: OriginatorDomainNameStringUnder250Bytes, walletBuilder: (profilePrimaryKey: number[], profilePrivilegedKeyManager: PrivilegedKeyManager, profileId: number[]) => Promise<WalletInterface>, interactor: UMPTokenInteractor
|
|
10502
|
+
authenticationFlow: "unknown" | "new-user" | "existing-user" = "unknown";
|
|
10503
|
+
constructor(adminOriginator: OriginatorDomainNameStringUnder250Bytes, walletBuilder: (profilePrimaryKey: number[], profilePrivilegedKeyManager: PrivilegedKeyManager, profileId: number[]) => Promise<WalletInterface>, interactor: UMPTokenInteractor | undefined, recoveryKeySaver: (key: number[]) => Promise<true>, passwordRetriever: (reason: string, test: (passwordCandidate: string) => boolean | Promise<boolean>) => Promise<string>, newWalletFunder?: (presentationKey: number[], wallet: WalletInterface, adminOriginator: OriginatorDomainNameStringUnder250Bytes) => Promise<void>, stateSnapshot?: number[], kdfConfig?: KdfConfig, telemetry?: TelemetryConfig)
|
|
9944
10504
|
async providePresentationKey(key: number[]): Promise<void>
|
|
9945
10505
|
async providePassword(password: string): Promise<void>
|
|
9946
10506
|
async provideRecoveryKey(recoveryKey: number[]): Promise<void>
|
|
@@ -9993,16 +10553,16 @@ export class CWIStyleWalletManager implements WalletInterface {
|
|
|
9993
10553
|
}
|
|
9994
10554
|
```
|
|
9995
10555
|
|
|
9996
|
-
See also: [KdfConfig](./client.md#interface-kdfconfig), [
|
|
10556
|
+
See also: [KdfConfig](./client.md#interface-kdfconfig), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [UMPTokenInteractor](./client.md#interface-umptokeninteractor), [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), [proveCertificate](./client.md#function-provecertificate), [signAction](./client.md#function-signaction)
|
|
9997
10557
|
|
|
9998
10558
|
###### Constructor
|
|
9999
10559
|
|
|
10000
10560
|
Constructs a new CWIStyleWalletManager.
|
|
10001
10561
|
|
|
10002
10562
|
```ts
|
|
10003
|
-
constructor(adminOriginator: OriginatorDomainNameStringUnder250Bytes, walletBuilder: (profilePrimaryKey: number[], profilePrivilegedKeyManager: PrivilegedKeyManager, profileId: number[]) => Promise<WalletInterface>, interactor: UMPTokenInteractor
|
|
10563
|
+
constructor(adminOriginator: OriginatorDomainNameStringUnder250Bytes, walletBuilder: (profilePrimaryKey: number[], profilePrivilegedKeyManager: PrivilegedKeyManager, profileId: number[]) => Promise<WalletInterface>, interactor: UMPTokenInteractor | undefined, recoveryKeySaver: (key: number[]) => Promise<true>, passwordRetriever: (reason: string, test: (passwordCandidate: string) => boolean | Promise<boolean>) => Promise<string>, newWalletFunder?: (presentationKey: number[], wallet: WalletInterface, adminOriginator: OriginatorDomainNameStringUnder250Bytes) => Promise<void>, stateSnapshot?: number[], kdfConfig?: KdfConfig, telemetry?: TelemetryConfig)
|
|
10004
10564
|
```
|
|
10005
|
-
See also: [KdfConfig](./client.md#interface-kdfconfig), [
|
|
10565
|
+
See also: [KdfConfig](./client.md#interface-kdfconfig), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [UMPTokenInteractor](./client.md#interface-umptokeninteractor)
|
|
10006
10566
|
|
|
10007
10567
|
Argument Details
|
|
10008
10568
|
|
|
@@ -10036,7 +10596,7 @@ authenticated: boolean
|
|
|
10036
10596
|
Indicates new user or existing user flow.
|
|
10037
10597
|
|
|
10038
10598
|
```ts
|
|
10039
|
-
authenticationFlow: "new-user" | "existing-user" = "
|
|
10599
|
+
authenticationFlow: "unknown" | "new-user" | "existing-user" = "unknown"
|
|
10040
10600
|
```
|
|
10041
10601
|
|
|
10042
10602
|
###### Property authenticationMode
|
|
@@ -10047,6 +10607,14 @@ Current mode of authentication.
|
|
|
10047
10607
|
authenticationMode: "presentation-key-and-password" | "presentation-key-and-recovery-key" | "recovery-key-and-password" = "presentation-key-and-password"
|
|
10048
10608
|
```
|
|
10049
10609
|
|
|
10610
|
+
###### Property telemetry
|
|
10611
|
+
|
|
10612
|
+
Privacy-bounded diagnostic channel for wallet state transitions.
|
|
10613
|
+
|
|
10614
|
+
```ts
|
|
10615
|
+
protected readonly telemetry: Telemetry
|
|
10616
|
+
```
|
|
10617
|
+
|
|
10050
10618
|
###### Method addProfile
|
|
10051
10619
|
|
|
10052
10620
|
Adds a new profile with the given name.
|
|
@@ -12351,7 +12919,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
12351
12919
|
|
|
12352
12920
|
```ts
|
|
12353
12921
|
export class OverlayUMPTokenInteractor implements UMPTokenInteractor {
|
|
12354
|
-
constructor(resolver: LookupResolver = new LookupResolver(), broadcaster: SHIPBroadcaster = new SHIPBroadcaster(["tm_users"]))
|
|
12922
|
+
constructor(resolver: LookupResolver = new LookupResolver(), broadcaster: SHIPBroadcaster = new SHIPBroadcaster(["tm_users"]), telemetry?: TelemetryConfig)
|
|
12355
12923
|
public async findByPresentationKeyHash(hash: number[]): Promise<UMPToken | undefined>
|
|
12356
12924
|
public async findByRecoveryKeyHash(hash: number[]): Promise<UMPToken | undefined>
|
|
12357
12925
|
public async buildAndSend(wallet: WalletInterface, adminOriginator: OriginatorDomainNameStringUnder250Bytes, token: UMPToken, oldTokenToConsume?: UMPToken): Promise<OutpointString>
|
|
@@ -12365,7 +12933,7 @@ See also: [UMPToken](./client.md#interface-umptoken), [UMPTokenInteractor](./cli
|
|
|
12365
12933
|
Construct a new OverlayUMPTokenInteractor.
|
|
12366
12934
|
|
|
12367
12935
|
```ts
|
|
12368
|
-
constructor(resolver: LookupResolver = new LookupResolver(), broadcaster: SHIPBroadcaster = new SHIPBroadcaster(["tm_users"]))
|
|
12936
|
+
constructor(resolver: LookupResolver = new LookupResolver(), broadcaster: SHIPBroadcaster = new SHIPBroadcaster(["tm_users"]), telemetry?: TelemetryConfig)
|
|
12369
12937
|
```
|
|
12370
12938
|
|
|
12371
12939
|
Argument Details
|
|
@@ -13338,6 +13906,14 @@ export abstract class StorageClientBase implements WalletStorageProvider {
|
|
|
13338
13906
|
async internalizeAction(auth: AuthId, args: InternalizeActionArgs): Promise<StorageInternalizeActionResult>
|
|
13339
13907
|
async createAction(auth: AuthId, args: Validation.ValidCreateActionArgs): Promise<StorageCreateActionResult>
|
|
13340
13908
|
async processAction(auth: AuthId, args: StorageProcessActionArgs): Promise<StorageProcessActionResults>
|
|
13909
|
+
async getCapabilities(): Promise<StorageCapabilities>
|
|
13910
|
+
async beginActionBatch(auth: AuthId, args: BeginActionBatchArgs): Promise<BeginActionBatchResult>
|
|
13911
|
+
async extendActionBatch(auth: AuthId, args: ExtendActionBatchArgs): Promise<ExtendActionBatchResult>
|
|
13912
|
+
async renewActionBatch(auth: AuthId, batchId: string): Promise<RenewActionBatchResult>
|
|
13913
|
+
async prepareActionBatchCommit(auth: AuthId, manifest: ActionBatchManifest): Promise<PrepareActionBatchCommitResult>
|
|
13914
|
+
async putActionBatchBlob(auth: AuthId, args: PutActionBatchBlobArgs): Promise<void>
|
|
13915
|
+
async commitActionBatch(auth: AuthId, manifest: ActionBatchManifest): Promise<CommitActionBatchResult>
|
|
13916
|
+
async abortActionBatch(auth: AuthId, batchId: string): Promise<AbortActionBatchResult>
|
|
13341
13917
|
async abortAction(auth: AuthId, args: AbortActionArgs): Promise<AbortActionResult>
|
|
13342
13918
|
async findOrInsertUser(identityKey): Promise<{
|
|
13343
13919
|
user: TableUser;
|
|
@@ -13367,7 +13943,7 @@ export abstract class StorageClientBase implements WalletStorageProvider {
|
|
|
13367
13943
|
}
|
|
13368
13944
|
```
|
|
13369
13945
|
|
|
13370
|
-
See also: [AuthId](./client.md#interface-authid), [EntityTimeStamp](./client.md#interface-entitytimestamp), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageClientOptions](./storage.md#interface-storageclientoptions), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [SyncChunk](./client.md#interface-syncchunk), [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), [TableSyncState](./storage.md#interface-tablesyncstate), [TableUser](./storage.md#interface-tableuser), [UpdateProvenTxReqWithNewProvenTxArgs](./client.md#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](./client.md#interface-updateproventxreqwithnewproventxresult), [WalletServices](./client.md#interface-walletservices), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [createAction](./storage.md#function-createaction), [getSyncChunk](./storage.md#function-getsyncchunk), [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), [validateDate](./storage.md#function-validatedate), [validateEntities](./storage.md#function-validateentities), [validateEntity](./storage.md#function-validateentity)
|
|
13946
|
+
See also: [AbortActionBatchResult](./client.md#interface-abortactionbatchresult), [ActionBatchManifest](./client.md#interface-actionbatchmanifest), [AuthId](./client.md#interface-authid), [BeginActionBatchArgs](./client.md#interface-beginactionbatchargs), [BeginActionBatchResult](./client.md#interface-beginactionbatchresult), [CommitActionBatchResult](./client.md#interface-commitactionbatchresult), [EntityTimeStamp](./client.md#interface-entitytimestamp), [ExtendActionBatchArgs](./client.md#interface-extendactionbatchargs), [ExtendActionBatchResult](./client.md#interface-extendactionbatchresult), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [PrepareActionBatchCommitResult](./client.md#interface-prepareactionbatchcommitresult), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [PutActionBatchBlobArgs](./client.md#interface-putactionbatchblobargs), [RenewActionBatchResult](./client.md#interface-renewactionbatchresult), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageCapabilities](./client.md#interface-storagecapabilities), [StorageClientOptions](./storage.md#interface-storageclientoptions), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [SyncChunk](./client.md#interface-syncchunk), [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), [TableSyncState](./storage.md#interface-tablesyncstate), [TableUser](./storage.md#interface-tableuser), [UpdateProvenTxReqWithNewProvenTxArgs](./client.md#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](./client.md#interface-updateproventxreqwithnewproventxresult), [WalletServices](./client.md#interface-walletservices), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [abortActionBatch](./storage.md#function-abortactionbatch), [beginActionBatch](./storage.md#function-beginactionbatch), [commitActionBatch](./storage.md#function-commitactionbatch), [createAction](./storage.md#function-createaction), [extendActionBatch](./storage.md#function-extendactionbatch), [getSyncChunk](./storage.md#function-getsyncchunk), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [prepareActionBatchCommit](./storage.md#function-prepareactionbatchcommit), [processAction](./storage.md#function-processaction), [putActionBatchBlob](./storage.md#function-putactionbatchblob), [renewActionBatch](./storage.md#function-renewactionbatch), [validateDate](./storage.md#function-validatedate), [validateEntities](./storage.md#function-validateentities), [validateEntity](./storage.md#function-validateentity)
|
|
13371
13947
|
|
|
13372
13948
|
###### Method abortAction
|
|
13373
13949
|
|
|
@@ -13960,6 +14536,7 @@ export class StorageIdb extends StorageProvider implements WalletStorageProvider
|
|
|
13960
14536
|
dbName: string;
|
|
13961
14537
|
db?: IDBPDatabase<StorageIdbSchema>;
|
|
13962
14538
|
constructor(options: StorageIdbOptions)
|
|
14539
|
+
protected override supportsActionBatchPersistence(): boolean
|
|
13963
14540
|
async migrate(storageName: string, storageIdentityKey: string): Promise<string>
|
|
13964
14541
|
async verifyDB(storageName?: string, storageIdentityKey?: string): Promise<IDBPDatabase<StorageIdbSchema>>
|
|
13965
14542
|
toDbTrx(stores: string[], mode: "readonly" | "readwrite", trx?: TrxToken): IDBPTransaction<StorageIdbSchema, string[], "readwrite" | "readonly">
|
|
@@ -14031,6 +14608,9 @@ export class StorageIdb extends StorageProvider implements WalletStorageProvider
|
|
|
14031
14608
|
async updateTxLabelMap(transactionId: number, txLabelId: number, update: Partial<TableTxLabelMap>, trx?: TrxToken): Promise<number>
|
|
14032
14609
|
async destroy(): Promise<void>
|
|
14033
14610
|
allStores: string[] = [
|
|
14611
|
+
"action_batches",
|
|
14612
|
+
"action_batch_outputs",
|
|
14613
|
+
"action_batch_blobs",
|
|
14034
14614
|
"certificates",
|
|
14035
14615
|
"certificate_fields",
|
|
14036
14616
|
"commissions",
|
|
@@ -14047,6 +14627,18 @@ export class StorageIdb extends StorageProvider implements WalletStorageProvider
|
|
|
14047
14627
|
"tx_labels_map",
|
|
14048
14628
|
"users"
|
|
14049
14629
|
];
|
|
14630
|
+
override async insertActionBatch(batch: TableActionBatch, trx?: TrxToken): Promise<number>
|
|
14631
|
+
override async findActionBatch(userId: number, batchId: string, trx?: TrxToken): Promise<TableActionBatch | undefined>
|
|
14632
|
+
override async findExpiredActionBatches(now: Date, trx?: TrxToken): Promise<TableActionBatch[]>
|
|
14633
|
+
override async updateActionBatch(actionBatchId: number, update: Partial<TableActionBatch>, trx?: TrxToken): Promise<number>
|
|
14634
|
+
override async deleteActionBatch(actionBatchId: number, trx?: TrxToken): Promise<void>
|
|
14635
|
+
override async reserveActionBatchOutputs(reservations: TableActionBatchOutput[], trx?: TrxToken): Promise<void>
|
|
14636
|
+
override async findActionBatchOutputIds(actionBatchId: number, trx?: TrxToken): Promise<number[]>
|
|
14637
|
+
override async findReservedActionBatchOutputIds(outputIds: number[], trx?: TrxToken): Promise<number[]>
|
|
14638
|
+
override async deleteActionBatchOutputReservations(actionBatchId: number, trx?: TrxToken): Promise<void>
|
|
14639
|
+
override async putActionBatchBlobRecord(blob: TableActionBatchBlob, trx?: TrxToken): Promise<void>
|
|
14640
|
+
override async findActionBatchBlobRecord(actionBatchId: number, digest: string, trx?: TrxToken): Promise<TableActionBatchBlob | undefined>
|
|
14641
|
+
override async deleteActionBatchBlobRecords(actionBatchId: number, trx?: TrxToken): Promise<void>
|
|
14050
14642
|
async transaction<T>(scope: (trx: TrxToken) => Promise<T>, trx?: TrxToken): Promise<T>
|
|
14051
14643
|
async filterCertificateFields(args: FindCertificateFieldsArgs, filtered: (v: TableCertificateField) => void): Promise<void>
|
|
14052
14644
|
async findCertificateFields(args: FindCertificateFieldsArgs): Promise<TableCertificateField[]>
|
|
@@ -14095,7 +14687,7 @@ export class StorageIdb extends StorageProvider implements WalletStorageProvider
|
|
|
14095
14687
|
}
|
|
14096
14688
|
```
|
|
14097
14689
|
|
|
14098
|
-
See also: [AuthId](./client.md#interface-authid), [DBType](./storage.md#type-dbtype), [EntityTimeStamp](./client.md#interface-entitytimestamp), [FindCertificateFieldsArgs](./client.md#interface-findcertificatefieldsargs), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindCommissionsArgs](./client.md#interface-findcommissionsargs), [FindForUserSincePagedArgs](./client.md#interface-findforusersincepagedargs), [FindMonitorEventsArgs](./client.md#interface-findmonitoreventsargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputTagMapsArgs](./client.md#interface-findoutputtagmapsargs), [FindOutputTagsArgs](./client.md#interface-findoutputtagsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [FindProvenTxsArgs](./client.md#interface-findproventxsargs), [FindSyncStatesArgs](./client.md#interface-findsyncstatesargs), [FindTransactionsArgs](./client.md#interface-findtransactionsargs), [FindTxLabelMapsArgs](./client.md#interface-findtxlabelmapsargs), [FindTxLabelsArgs](./client.md#interface-findtxlabelsargs), [FindUsersArgs](./client.md#interface-findusersargs), [ProvenOrRawTx](./client.md#interface-provenorrawtx), [PurgeParams](./client.md#interface-purgeparams), [PurgeResults](./client.md#interface-purgeresults), [StorageAdminStats](./storage.md#interface-storageadminstats), [StorageIdbOptions](./storage.md#interface-storageidboptions), [StorageIdbSchema](./storage.md#interface-storageidbschema), [StorageProvider](./storage.md#class-storageprovider), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableCommission](./storage.md#interface-tablecommission), [TableMonitorEvent](./storage.md#interface-tablemonitorevent), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableSyncState](./storage.md#interface-tablesyncstate), [TableTransaction](./storage.md#interface-tabletransaction), [TableTxLabel](./storage.md#interface-tabletxlabel), [TableTxLabelMap](./storage.md#interface-tabletxlabelmap), [TableUser](./storage.md#interface-tableuser), [TrxToken](./client.md#interface-trxtoken), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [listActions](./storage.md#function-listactions), [listOutputs](./storage.md#function-listoutputs), [purgeData](./storage.md#function-purgedata), [reviewStatus](./storage.md#function-reviewstatus), [validateEntities](./storage.md#function-validateentities), [validateEntity](./storage.md#function-validateentity)
|
|
14690
|
+
See also: [AuthId](./client.md#interface-authid), [DBType](./storage.md#type-dbtype), [EntityTimeStamp](./client.md#interface-entitytimestamp), [FindCertificateFieldsArgs](./client.md#interface-findcertificatefieldsargs), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindCommissionsArgs](./client.md#interface-findcommissionsargs), [FindForUserSincePagedArgs](./client.md#interface-findforusersincepagedargs), [FindMonitorEventsArgs](./client.md#interface-findmonitoreventsargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputTagMapsArgs](./client.md#interface-findoutputtagmapsargs), [FindOutputTagsArgs](./client.md#interface-findoutputtagsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [FindProvenTxsArgs](./client.md#interface-findproventxsargs), [FindSyncStatesArgs](./client.md#interface-findsyncstatesargs), [FindTransactionsArgs](./client.md#interface-findtransactionsargs), [FindTxLabelMapsArgs](./client.md#interface-findtxlabelmapsargs), [FindTxLabelsArgs](./client.md#interface-findtxlabelsargs), [FindUsersArgs](./client.md#interface-findusersargs), [ProvenOrRawTx](./client.md#interface-provenorrawtx), [PurgeParams](./client.md#interface-purgeparams), [PurgeResults](./client.md#interface-purgeresults), [StorageAdminStats](./storage.md#interface-storageadminstats), [StorageIdbOptions](./storage.md#interface-storageidboptions), [StorageIdbSchema](./storage.md#interface-storageidbschema), [StorageProvider](./storage.md#class-storageprovider), [TableActionBatch](./storage.md#interface-tableactionbatch), [TableActionBatchBlob](./storage.md#interface-tableactionbatchblob), [TableActionBatchOutput](./storage.md#interface-tableactionbatchoutput), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableCommission](./storage.md#interface-tablecommission), [TableMonitorEvent](./storage.md#interface-tablemonitorevent), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableSyncState](./storage.md#interface-tablesyncstate), [TableTransaction](./storage.md#interface-tabletransaction), [TableTxLabel](./storage.md#interface-tabletxlabel), [TableTxLabelMap](./storage.md#interface-tabletxlabelmap), [TableUser](./storage.md#interface-tableuser), [TrxToken](./client.md#interface-trxtoken), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [listActions](./storage.md#function-listactions), [listOutputs](./storage.md#function-listoutputs), [purgeData](./storage.md#function-purgedata), [reviewStatus](./storage.md#function-reviewstatus), [validateEntities](./storage.md#function-validateentities), [validateEntity](./storage.md#function-validateentity)
|
|
14099
14691
|
|
|
14100
14692
|
###### Method allocateChangeInput
|
|
14101
14693
|
|
|
@@ -14245,12 +14837,38 @@ export abstract class StorageProvider extends StorageReaderWriter implements Wal
|
|
|
14245
14837
|
abstract listActions(auth: AuthId, args: Validation.ValidListActionsArgs): Promise<ListActionsResult>;
|
|
14246
14838
|
abstract listOutputs(auth: AuthId, args: Validation.ValidListOutputsArgs): Promise<ListOutputsResult>;
|
|
14247
14839
|
abstract countChangeInputs(userId: number, basketId: number, excludeSending: boolean): Promise<number>;
|
|
14840
|
+
async insertActionBatch(batch: TableActionBatch, trx?: TrxToken): Promise<number>
|
|
14841
|
+
async findActionBatch(userId: number, batchId: string, trx?: TrxToken): Promise<TableActionBatch | undefined>
|
|
14842
|
+
async findActionBatchForUpdate(userId: number, batchId: string, trx: TrxToken): Promise<TableActionBatch | undefined>
|
|
14843
|
+
async findExpiredActionBatches(now: Date, trx?: TrxToken): Promise<TableActionBatch[]>
|
|
14844
|
+
async updateActionBatch(actionBatchId: number, update: Partial<TableActionBatch>, trx?: TrxToken): Promise<number>
|
|
14845
|
+
async deleteActionBatch(actionBatchId: number, trx?: TrxToken): Promise<void>
|
|
14846
|
+
async reserveActionBatchOutputs(reservations: TableActionBatchOutput[], trx?: TrxToken): Promise<void>
|
|
14847
|
+
async findActionBatchOutputIds(actionBatchId: number, trx?: TrxToken): Promise<number[]>
|
|
14848
|
+
async findReservedActionBatchOutputIds(_outputIds: number[], _trx?: TrxToken): Promise<number[]>
|
|
14849
|
+
async deleteActionBatchOutputReservations(actionBatchId: number, trx?: TrxToken): Promise<void>
|
|
14850
|
+
async putActionBatchBlobRecord(blob: TableActionBatchBlob, trx?: TrxToken): Promise<void>
|
|
14851
|
+
async findActionBatchBlobRecord(actionBatchId: number, digest: string, trx?: TrxToken): Promise<TableActionBatchBlob | undefined>
|
|
14852
|
+
async deleteActionBatchBlobRecords(actionBatchId: number, trx?: TrxToken): Promise<void>
|
|
14853
|
+
async getCapabilities(): Promise<StorageCapabilities>
|
|
14854
|
+
protected supportsActionBatchPersistence(): boolean
|
|
14855
|
+
async beginActionBatch(auth: AuthId, args: BeginActionBatchArgs): Promise<BeginActionBatchResult>
|
|
14856
|
+
async extendActionBatch(auth: AuthId, args: ExtendActionBatchArgs): Promise<ExtendActionBatchResult>
|
|
14857
|
+
async renewActionBatch(auth: AuthId, batchId: string): Promise<RenewActionBatchResult>
|
|
14858
|
+
async prepareActionBatchCommit(auth: AuthId, manifest: ActionBatchManifest): Promise<PrepareActionBatchCommitResult>
|
|
14859
|
+
async putActionBatchBlob(auth: AuthId, args: PutActionBatchBlobArgs): Promise<void>
|
|
14860
|
+
async commitActionBatch(auth: AuthId, manifest: ActionBatchManifest): Promise<CommitActionBatchResult>
|
|
14861
|
+
async abortActionBatch(auth: AuthId, batchId: string): Promise<AbortActionBatchResult>
|
|
14248
14862
|
async findOutputsByIds(outputIds: number[], trx?: TrxToken): Promise<Record<number, TableOutput>>
|
|
14249
14863
|
async findStaleMerkleRoots(args: FindStaleMerkleRootsArgs): Promise<string[]>
|
|
14250
14864
|
async findOutputsByOutpoints(userId: number, outpoints: Array<{
|
|
14251
14865
|
txid: string;
|
|
14252
14866
|
vout: number;
|
|
14253
14867
|
}>, trx?: TrxToken): Promise<Record<string, TableOutput>>
|
|
14868
|
+
async findOutputsByOutpointsForUpdate(userId: number, outpoints: Array<{
|
|
14869
|
+
txid: string;
|
|
14870
|
+
vout: number;
|
|
14871
|
+
}>, trx: TrxToken): Promise<Record<string, TableOutput>>
|
|
14254
14872
|
async findOrInsertOutputBasketsBulk(userId: number, names: string[], trx?: TrxToken): Promise<Record<string, TableOutputBasket>>
|
|
14255
14873
|
async findOrInsertOutputTagsBulk(userId: number, tags: string[], trx?: TrxToken): Promise<Record<string, TableOutputTag>>
|
|
14256
14874
|
async sumSpendableSatoshisInBasket(userId: number, basketId: number, excludeSending: boolean, trx?: TrxToken): Promise<number>
|
|
@@ -14296,7 +14914,7 @@ export abstract class StorageProvider extends StorageReaderWriter implements Wal
|
|
|
14296
14914
|
}
|
|
14297
14915
|
```
|
|
14298
14916
|
|
|
14299
|
-
See also: [AdminStatsResult](./storage.md#interface-adminstatsresult), [AuthId](./client.md#interface-authid), [Chain](./client.md#type-chain), [EntityProvenTxReq](./storage.md#class-entityproventxreq), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindStaleMerkleRootsArgs](./client.md#interface-findstalemerklerootsargs), [GetReqsAndBeefResult](./storage.md#interface-getreqsandbeefresult), [PostReqsToNetworkResult](./storage.md#interface-postreqstonetworkresult), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [ProvenOrRawTx](./client.md#interface-provenorrawtx), [PurgeParams](./client.md#interface-purgeparams), [PurgeResults](./client.md#interface-purgeresults), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageFeeModel](./client.md#interface-storagefeemodel), [StorageGetBeefOptions](./client.md#interface-storagegetbeefoptions), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [StorageProvenOrReq](./client.md#interface-storageprovenorreq), [StorageProviderOptions](./storage.md#interface-storageprovideroptions), [StorageReaderWriter](./storage.md#class-storagereaderwriter), [SyncChunk](./client.md#interface-syncchunk), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableMonitorEvent](./storage.md#interface-tablemonitorevent), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputX](./storage.md#interface-tableoutputx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableProvenTxReqDynamics](./storage.md#interface-tableproventxreqdynamics), [TableTxLabel](./storage.md#interface-tabletxlabel), [TableUser](./storage.md#interface-tableuser), [TransactionStatus](./client.md#type-transactionstatus), [TrxToken](./client.md#interface-trxtoken), [UpdateProvenTxReqWithNewProvenTxArgs](./client.md#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](./client.md#interface-updateproventxreqwithnewproventxresult), [WalletServices](./client.md#interface-walletservices), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [attemptToPostReqsToNetwork](./storage.md#function-attempttopostreqstonetwork), [createAction](./storage.md#function-createaction), [getBeefForTransaction](./storage.md#function-getbeeffortransaction), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [logger](./client.md#variable-logger), [processAction](./storage.md#function-processaction), [purgeData](./storage.md#function-purgedata), [reviewStatus](./storage.md#function-reviewstatus)
|
|
14917
|
+
See also: [AbortActionBatchResult](./client.md#interface-abortactionbatchresult), [ActionBatchManifest](./client.md#interface-actionbatchmanifest), [AdminStatsResult](./storage.md#interface-adminstatsresult), [AuthId](./client.md#interface-authid), [BeginActionBatchArgs](./client.md#interface-beginactionbatchargs), [BeginActionBatchResult](./client.md#interface-beginactionbatchresult), [Chain](./client.md#type-chain), [CommitActionBatchResult](./client.md#interface-commitactionbatchresult), [EntityProvenTxReq](./storage.md#class-entityproventxreq), [ExtendActionBatchArgs](./client.md#interface-extendactionbatchargs), [ExtendActionBatchResult](./client.md#interface-extendactionbatchresult), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindStaleMerkleRootsArgs](./client.md#interface-findstalemerklerootsargs), [GetReqsAndBeefResult](./storage.md#interface-getreqsandbeefresult), [PostReqsToNetworkResult](./storage.md#interface-postreqstonetworkresult), [PrepareActionBatchCommitResult](./client.md#interface-prepareactionbatchcommitresult), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [ProvenOrRawTx](./client.md#interface-provenorrawtx), [PurgeParams](./client.md#interface-purgeparams), [PurgeResults](./client.md#interface-purgeresults), [PutActionBatchBlobArgs](./client.md#interface-putactionbatchblobargs), [RenewActionBatchResult](./client.md#interface-renewactionbatchresult), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageCapabilities](./client.md#interface-storagecapabilities), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageFeeModel](./client.md#interface-storagefeemodel), [StorageGetBeefOptions](./client.md#interface-storagegetbeefoptions), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [StorageProvenOrReq](./client.md#interface-storageprovenorreq), [StorageProviderOptions](./storage.md#interface-storageprovideroptions), [StorageReaderWriter](./storage.md#class-storagereaderwriter), [SyncChunk](./client.md#interface-syncchunk), [TableActionBatch](./storage.md#interface-tableactionbatch), [TableActionBatchBlob](./storage.md#interface-tableactionbatchblob), [TableActionBatchOutput](./storage.md#interface-tableactionbatchoutput), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableMonitorEvent](./storage.md#interface-tablemonitorevent), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputX](./storage.md#interface-tableoutputx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableProvenTxReqDynamics](./storage.md#interface-tableproventxreqdynamics), [TableTxLabel](./storage.md#interface-tabletxlabel), [TableUser](./storage.md#interface-tableuser), [TransactionStatus](./client.md#type-transactionstatus), [TrxToken](./client.md#interface-trxtoken), [UpdateProvenTxReqWithNewProvenTxArgs](./client.md#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](./client.md#interface-updateproventxreqwithnewproventxresult), [WalletServices](./client.md#interface-walletservices), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [abortActionBatch](./storage.md#function-abortactionbatch), [attemptToPostReqsToNetwork](./storage.md#function-attempttopostreqstonetwork), [beginActionBatch](./storage.md#function-beginactionbatch), [commitActionBatch](./storage.md#function-commitactionbatch), [createAction](./storage.md#function-createaction), [extendActionBatch](./storage.md#function-extendactionbatch), [getBeefForTransaction](./storage.md#function-getbeeffortransaction), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [logger](./client.md#variable-logger), [prepareActionBatchCommit](./storage.md#function-prepareactionbatchcommit), [processAction](./storage.md#function-processaction), [purgeData](./storage.md#function-purgedata), [putActionBatchBlob](./storage.md#function-putactionbatchblob), [renewActionBatch](./storage.md#function-renewactionbatch), [reviewStatus](./storage.md#function-reviewstatus)
|
|
14300
14918
|
|
|
14301
14919
|
###### Method confirmSpendableOutputs
|
|
14302
14920
|
|
|
@@ -14788,6 +15406,26 @@ trigger(nowMsecsSinceEpoch: number): {
|
|
|
14788
15406
|
|
|
14789
15407
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
14790
15408
|
|
|
15409
|
+
---
|
|
15410
|
+
##### Class: TaskCleanupActionBatches
|
|
15411
|
+
|
|
15412
|
+
Releases expired action-batch reservations and incomplete staged blobs.
|
|
15413
|
+
|
|
15414
|
+
```ts
|
|
15415
|
+
export class TaskCleanupActionBatches extends WalletMonitorTask {
|
|
15416
|
+
static readonly taskName = "CleanupActionBatches";
|
|
15417
|
+
constructor(monitor: Monitor, public triggerMsecs = Monitor.oneMinute)
|
|
15418
|
+
trigger(nowMsecsSinceEpoch: number): {
|
|
15419
|
+
run: boolean;
|
|
15420
|
+
}
|
|
15421
|
+
async runTask(): Promise<string>
|
|
15422
|
+
}
|
|
15423
|
+
```
|
|
15424
|
+
|
|
15425
|
+
See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
15426
|
+
|
|
15427
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15428
|
+
|
|
14791
15429
|
---
|
|
14792
15430
|
##### Class: TaskClock
|
|
14793
15431
|
|
|
@@ -15269,264 +15907,165 @@ A client-side class that knows how to call the WAB server for Twilio-based phone
|
|
|
15269
15907
|
```ts
|
|
15270
15908
|
export class TwilioPhoneInteractor extends AuthMethodInteractor {
|
|
15271
15909
|
public methodType = "TwilioPhone";
|
|
15910
|
+
protected override preparePayload(payload: AuthPayload): AuthPayload
|
|
15272
15911
|
}
|
|
15273
15912
|
```
|
|
15274
15913
|
|
|
15275
|
-
See also: [AuthMethodInteractor](./client.md#class-authmethodinteractor)
|
|
15914
|
+
See also: [AuthMethodInteractor](./client.md#class-authmethodinteractor), [AuthPayload](./client.md#interface-authpayload)
|
|
15915
|
+
|
|
15916
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15917
|
+
|
|
15918
|
+
---
|
|
15919
|
+
##### Class: UMPTokenLookupError
|
|
15920
|
+
|
|
15921
|
+
Raised when UMP absence cannot be established authoritatively.
|
|
15922
|
+
|
|
15923
|
+
Callers must offer retry/recovery rather than treating this error as a new
|
|
15924
|
+
account. Diagnostics contain counts only and never hashes, keys, or tokens.
|
|
15925
|
+
|
|
15926
|
+
```ts
|
|
15927
|
+
export class UMPTokenLookupError extends Error {
|
|
15928
|
+
readonly code = "WERR_UMP_LOOKUP_INDETERMINATE";
|
|
15929
|
+
constructor(public readonly reason: UMPTokenLookupFailureReason, public readonly diagnostics: UMPTokenLookupDiagnostics, options?: {
|
|
15930
|
+
cause?: unknown;
|
|
15931
|
+
})
|
|
15932
|
+
}
|
|
15933
|
+
```
|
|
15934
|
+
|
|
15935
|
+
See also: [UMPTokenLookupDiagnostics](./client.md#interface-umptokenlookupdiagnostics), [UMPTokenLookupFailureReason](./client.md#type-umptokenlookupfailurereason)
|
|
15936
|
+
|
|
15937
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15938
|
+
|
|
15939
|
+
---
|
|
15940
|
+
##### Class: WABAccountContinuityError
|
|
15941
|
+
|
|
15942
|
+
```ts
|
|
15943
|
+
export class WABAccountContinuityError extends Error {
|
|
15944
|
+
readonly code = "WERR_WAB_ACCOUNT_CONTINUITY";
|
|
15945
|
+
constructor(message: string = "WAB and UMP account state did not agree. Retry or use account recovery.")
|
|
15946
|
+
}
|
|
15947
|
+
```
|
|
15276
15948
|
|
|
15277
15949
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15278
15950
|
|
|
15279
15951
|
---
|
|
15280
15952
|
##### Class: WABClient
|
|
15281
15953
|
|
|
15954
|
+
Production-oriented WAB client with one security and observability boundary
|
|
15955
|
+
for every endpoint.
|
|
15956
|
+
|
|
15282
15957
|
```ts
|
|
15283
15958
|
export class WABClient {
|
|
15284
|
-
|
|
15285
|
-
|
|
15959
|
+
readonly transport: WABTransport;
|
|
15960
|
+
constructor(serverUrl: string, options: WABClientOptions = {})
|
|
15961
|
+
public async getInfo(): Promise<WABServerInfo>
|
|
15286
15962
|
public generateRandomPresentationKey(): string
|
|
15287
|
-
public async startAuthMethod(authMethod: AuthMethodInteractor, presentationKey: string, payload:
|
|
15288
|
-
public async completeAuthMethod(authMethod: AuthMethodInteractor, presentationKey: string, payload:
|
|
15289
|
-
public async listLinkedMethods(presentationKey: string): Promise<
|
|
15290
|
-
public async unlinkMethod(presentationKey: string, authMethodId: number): Promise<
|
|
15291
|
-
public async requestFaucet(presentationKey: string): Promise<
|
|
15292
|
-
public async deleteUser(presentationKey: string): Promise<
|
|
15293
|
-
public async startShareAuth(methodType: string, userIdHash: string, payload:
|
|
15963
|
+
public async startAuthMethod(authMethod: AuthMethodInteractor, presentationKey: string, payload: AuthPayload, correlationId?: string): Promise<StartAuthResponse>
|
|
15964
|
+
public async completeAuthMethod(authMethod: AuthMethodInteractor, presentationKey: string, payload: AuthPayload, correlationId?: string): Promise<CompleteAuthResponse>
|
|
15965
|
+
public async listLinkedMethods(presentationKey: string): Promise<WABOperationResponse>
|
|
15966
|
+
public async unlinkMethod(presentationKey: string, authMethodId: number): Promise<WABOperationResponse>
|
|
15967
|
+
public async requestFaucet(presentationKey: string): Promise<WABFaucetResponse>
|
|
15968
|
+
public async deleteUser(presentationKey: string): Promise<WABOperationResponse>
|
|
15969
|
+
public async startShareAuth(methodType: string, userIdHash: string, payload: AuthPayload): Promise<{
|
|
15294
15970
|
success: boolean;
|
|
15295
15971
|
message: string;
|
|
15296
15972
|
}>
|
|
15297
|
-
public async storeShare(methodType: string, payload:
|
|
15973
|
+
public async storeShare(methodType: string, payload: AuthPayload, shareB: string, userIdHash: string): Promise<{
|
|
15298
15974
|
success: boolean;
|
|
15299
15975
|
message: string;
|
|
15300
15976
|
userId?: number;
|
|
15301
15977
|
}>
|
|
15302
|
-
public async retrieveShare(methodType: string, payload:
|
|
15978
|
+
public async retrieveShare(methodType: string, payload: AuthPayload, userIdHash: string): Promise<{
|
|
15303
15979
|
success: boolean;
|
|
15304
15980
|
shareB?: string;
|
|
15305
15981
|
message: string;
|
|
15306
15982
|
}>
|
|
15307
|
-
public async updateShare(methodType: string, payload:
|
|
15983
|
+
public async updateShare(methodType: string, payload: AuthPayload, userIdHash: string, newShareB: string): Promise<{
|
|
15308
15984
|
success: boolean;
|
|
15309
15985
|
message: string;
|
|
15310
15986
|
shareVersion?: number;
|
|
15311
15987
|
}>
|
|
15312
|
-
public async deleteShamirUser(methodType: string, payload:
|
|
15988
|
+
public async deleteShamirUser(methodType: string, payload: AuthPayload, userIdHash: string): Promise<{
|
|
15313
15989
|
success: boolean;
|
|
15314
15990
|
message: string;
|
|
15315
15991
|
}>
|
|
15316
15992
|
}
|
|
15317
15993
|
```
|
|
15318
15994
|
|
|
15319
|
-
See also: [AuthMethodInteractor](./client.md#class-authmethodinteractor)
|
|
15320
|
-
|
|
15321
|
-
###### Method completeAuthMethod
|
|
15322
|
-
|
|
15323
|
-
Complete an Auth Method flow
|
|
15995
|
+
See also: [AuthMethodInteractor](./client.md#class-authmethodinteractor), [AuthPayload](./client.md#interface-authpayload), [CompleteAuthResponse](./client.md#interface-completeauthresponse), [StartAuthResponse](./client.md#interface-startauthresponse), [WABClientOptions](./client.md#interface-wabclientoptions), [WABFaucetResponse](./client.md#interface-wabfaucetresponse), [WABOperationResponse](./client.md#interface-waboperationresponse), [WABServerInfo](./client.md#interface-wabserverinfo), [WABTransport](./client.md#class-wabtransport)
|
|
15324
15996
|
|
|
15325
|
-
|
|
15326
|
-
public async completeAuthMethod(authMethod: AuthMethodInteractor, presentationKey: string, payload: any): Promise<any>
|
|
15327
|
-
```
|
|
15328
|
-
See also: [AuthMethodInteractor](./client.md#class-authmethodinteractor)
|
|
15997
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15329
15998
|
|
|
15330
|
-
|
|
15999
|
+
---
|
|
16000
|
+
##### Class: WABClientError
|
|
15331
16001
|
|
|
15332
|
-
|
|
15333
|
-
|
|
16002
|
+
A privacy-safe WAB transport failure. Response bodies and request payloads
|
|
16003
|
+
are deliberately excluded from the error.
|
|
15334
16004
|
|
|
15335
16005
|
```ts
|
|
15336
|
-
|
|
15337
|
-
|
|
15338
|
-
|
|
15339
|
-
}
|
|
16006
|
+
export class WABClientError extends Error {
|
|
16007
|
+
constructor(public readonly code: WABClientErrorCode, message: string, public readonly retryable: boolean, public readonly status?: number, options?: {
|
|
16008
|
+
cause?: unknown;
|
|
16009
|
+
})
|
|
16010
|
+
}
|
|
15340
16011
|
```
|
|
15341
16012
|
|
|
15342
|
-
|
|
15343
|
-
|
|
15344
|
-
+ **methodType**
|
|
15345
|
-
+ The auth method type used for verification
|
|
15346
|
-
+ **payload**
|
|
15347
|
-
+ Contains the OTP code and auth method specific data
|
|
15348
|
-
+ **userIdHash**
|
|
15349
|
-
+ SHA256 hash of the user's identity key
|
|
16013
|
+
See also: [WABClientErrorCode](./client.md#type-wabclienterrorcode)
|
|
15350
16014
|
|
|
15351
|
-
|
|
15352
|
-
|
|
15353
|
-
Delete user
|
|
16015
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15354
16016
|
|
|
15355
|
-
|
|
15356
|
-
|
|
15357
|
-
```
|
|
16017
|
+
---
|
|
16018
|
+
##### Class: WABTransport
|
|
15358
16019
|
|
|
15359
|
-
|
|
16020
|
+
Centralized, bounded transport used by every WAB client operation.
|
|
15360
16021
|
|
|
15361
|
-
|
|
16022
|
+
Only fixed endpoint metadata is reported. Request bodies and response bodies
|
|
16023
|
+
never cross the telemetry boundary.
|
|
15362
16024
|
|
|
15363
16025
|
```ts
|
|
15364
|
-
|
|
16026
|
+
export class WABTransport {
|
|
16027
|
+
readonly serverUrl: string;
|
|
16028
|
+
readonly serverOrigin: string;
|
|
16029
|
+
readonly telemetry: Telemetry;
|
|
16030
|
+
constructor(serverUrl: string, options: WABTransportOptions = {})
|
|
16031
|
+
createCorrelationId(): string | undefined
|
|
16032
|
+
async request<T>(path: string, options: WABRequestOptions): Promise<T>
|
|
16033
|
+
}
|
|
15365
16034
|
```
|
|
15366
16035
|
|
|
15367
|
-
|
|
15368
|
-
|
|
15369
|
-
Return the WAB server info
|
|
16036
|
+
See also: [WABRequestOptions](./client.md#interface-wabrequestoptions), [WABTransportOptions](./client.md#interface-wabtransportoptions)
|
|
15370
16037
|
|
|
15371
|
-
|
|
15372
|
-
public async getInfo(): Promise<any>
|
|
15373
|
-
```
|
|
16038
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15374
16039
|
|
|
15375
|
-
|
|
16040
|
+
---
|
|
16041
|
+
##### Class: WERR_BAD_REQUEST
|
|
15376
16042
|
|
|
15377
|
-
|
|
16043
|
+
The request is invalid.
|
|
15378
16044
|
|
|
15379
16045
|
```ts
|
|
15380
|
-
|
|
16046
|
+
export class WERR_BAD_REQUEST extends WalletError {
|
|
16047
|
+
constructor(message?: string)
|
|
16048
|
+
}
|
|
15381
16049
|
```
|
|
15382
16050
|
|
|
15383
|
-
|
|
15384
|
-
|
|
15385
|
-
Request faucet
|
|
16051
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
15386
16052
|
|
|
15387
|
-
|
|
15388
|
-
public async requestFaucet(presentationKey: string): Promise<any>
|
|
15389
|
-
```
|
|
16053
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15390
16054
|
|
|
15391
|
-
|
|
16055
|
+
---
|
|
16056
|
+
##### Class: WERR_BROADCAST_UNAVAILABLE
|
|
15392
16057
|
|
|
15393
|
-
|
|
15394
|
-
Requires OTP verification
|
|
16058
|
+
Unable to broadcast transaction at this time.
|
|
15395
16059
|
|
|
15396
16060
|
```ts
|
|
15397
|
-
|
|
15398
|
-
|
|
15399
|
-
|
|
15400
|
-
message: string;
|
|
15401
|
-
}>
|
|
16061
|
+
export class WERR_BROADCAST_UNAVAILABLE extends WalletError {
|
|
16062
|
+
constructor(message?: string)
|
|
16063
|
+
}
|
|
15402
16064
|
```
|
|
15403
16065
|
|
|
15404
|
-
|
|
16066
|
+
See also: [WalletError](./client.md#class-walleterror)
|
|
15405
16067
|
|
|
15406
|
-
|
|
15407
|
-
+ The auth method type used for verification
|
|
15408
|
-
+ **payload**
|
|
15409
|
-
+ Contains the OTP code and auth method specific data
|
|
15410
|
-
+ **userIdHash**
|
|
15411
|
-
+ SHA256 hash of the user's identity key
|
|
15412
|
-
|
|
15413
|
-
###### Method startAuthMethod
|
|
15414
|
-
|
|
15415
|
-
Start an Auth Method flow
|
|
15416
|
-
|
|
15417
|
-
```ts
|
|
15418
|
-
public async startAuthMethod(authMethod: AuthMethodInteractor, presentationKey: string, payload: any): Promise<any>
|
|
15419
|
-
```
|
|
15420
|
-
See also: [AuthMethodInteractor](./client.md#class-authmethodinteractor)
|
|
15421
|
-
|
|
15422
|
-
###### Method startShareAuth
|
|
15423
|
-
|
|
15424
|
-
Start OTP verification for share operations
|
|
15425
|
-
This initiates the auth flow (e.g., sends SMS code via Twilio)
|
|
15426
|
-
|
|
15427
|
-
```ts
|
|
15428
|
-
public async startShareAuth(methodType: string, userIdHash: string, payload: any): Promise<{
|
|
15429
|
-
success: boolean;
|
|
15430
|
-
message: string;
|
|
15431
|
-
}>
|
|
15432
|
-
```
|
|
15433
|
-
|
|
15434
|
-
Argument Details
|
|
15435
|
-
|
|
15436
|
-
+ **methodType**
|
|
15437
|
-
+ The auth method type (e.g., "TwilioPhone", "DevConsole")
|
|
15438
|
-
+ **userIdHash**
|
|
15439
|
-
+ SHA256 hash of the user's identity key
|
|
15440
|
-
+ **payload**
|
|
15441
|
-
+ Auth method specific data (e.g., { phoneNumber: "+1..." })
|
|
15442
|
-
|
|
15443
|
-
###### Method storeShare
|
|
15444
|
-
|
|
15445
|
-
Store a Shamir share (Share B) on the server
|
|
15446
|
-
Requires prior OTP verification via startShareAuth
|
|
15447
|
-
|
|
15448
|
-
```ts
|
|
15449
|
-
public async storeShare(methodType: string, payload: any, shareB: string, userIdHash: string): Promise<{
|
|
15450
|
-
success: boolean;
|
|
15451
|
-
message: string;
|
|
15452
|
-
userId?: number;
|
|
15453
|
-
}>
|
|
15454
|
-
```
|
|
15455
|
-
|
|
15456
|
-
Argument Details
|
|
15457
|
-
|
|
15458
|
-
+ **methodType**
|
|
15459
|
-
+ The auth method type used for verification
|
|
15460
|
-
+ **payload**
|
|
15461
|
-
+ Contains the OTP code and auth method specific data
|
|
15462
|
-
+ **shareB**
|
|
15463
|
-
+ The Shamir share to store (format: x.y.threshold.integrity)
|
|
15464
|
-
+ **userIdHash**
|
|
15465
|
-
+ SHA256 hash of the user's identity key
|
|
15466
|
-
|
|
15467
|
-
###### Method unlinkMethod
|
|
15468
|
-
|
|
15469
|
-
Unlink a given Auth Method by ID
|
|
15470
|
-
|
|
15471
|
-
```ts
|
|
15472
|
-
public async unlinkMethod(presentationKey: string, authMethodId: number): Promise<any>
|
|
15473
|
-
```
|
|
15474
|
-
|
|
15475
|
-
###### Method updateShare
|
|
15476
|
-
|
|
15477
|
-
Update a Shamir share (for key rotation)
|
|
15478
|
-
Requires OTP verification
|
|
15479
|
-
|
|
15480
|
-
```ts
|
|
15481
|
-
public async updateShare(methodType: string, payload: any, userIdHash: string, newShareB: string): Promise<{
|
|
15482
|
-
success: boolean;
|
|
15483
|
-
message: string;
|
|
15484
|
-
shareVersion?: number;
|
|
15485
|
-
}>
|
|
15486
|
-
```
|
|
15487
|
-
|
|
15488
|
-
Argument Details
|
|
15489
|
-
|
|
15490
|
-
+ **methodType**
|
|
15491
|
-
+ The auth method type used for verification
|
|
15492
|
-
+ **payload**
|
|
15493
|
-
+ Contains the OTP code and auth method specific data
|
|
15494
|
-
+ **userIdHash**
|
|
15495
|
-
+ SHA256 hash of the user's identity key
|
|
15496
|
-
+ **newShareB**
|
|
15497
|
-
+ The new Shamir share to store
|
|
15498
|
-
|
|
15499
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15500
|
-
|
|
15501
|
-
---
|
|
15502
|
-
##### Class: WERR_BAD_REQUEST
|
|
15503
|
-
|
|
15504
|
-
The request is invalid.
|
|
15505
|
-
|
|
15506
|
-
```ts
|
|
15507
|
-
export class WERR_BAD_REQUEST extends WalletError {
|
|
15508
|
-
constructor(message?: string)
|
|
15509
|
-
}
|
|
15510
|
-
```
|
|
15511
|
-
|
|
15512
|
-
See also: [WalletError](./client.md#class-walleterror)
|
|
15513
|
-
|
|
15514
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15515
|
-
|
|
15516
|
-
---
|
|
15517
|
-
##### Class: WERR_BROADCAST_UNAVAILABLE
|
|
15518
|
-
|
|
15519
|
-
Unable to broadcast transaction at this time.
|
|
15520
|
-
|
|
15521
|
-
```ts
|
|
15522
|
-
export class WERR_BROADCAST_UNAVAILABLE extends WalletError {
|
|
15523
|
-
constructor(message?: string)
|
|
15524
|
-
}
|
|
15525
|
-
```
|
|
15526
|
-
|
|
15527
|
-
See also: [WalletError](./client.md#class-walleterror)
|
|
15528
|
-
|
|
15529
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
16068
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15530
16069
|
|
|
15531
16070
|
---
|
|
15532
16071
|
##### Class: WERR_INSUFFICIENT_FUNDS
|
|
@@ -15788,6 +16327,7 @@ export class Wallet implements WalletInterface, ProtoWallet {
|
|
|
15788
16327
|
privilegedKeyManager?: PrivilegedKeyManager;
|
|
15789
16328
|
makeLogger?: MakeWalletLogger;
|
|
15790
16329
|
pendingSignActions: Record<string, PendingSignAction>;
|
|
16330
|
+
readonly actionBatch: ActionBatchController;
|
|
15791
16331
|
randomVals?: number[] = undefined;
|
|
15792
16332
|
constructor(argsOrSigner: WalletArgs | WalletSigner, services?: WalletServices, monitor?: Monitor, privilegedKeyManager?: PrivilegedKeyManager, makeLogger?: MakeWalletLogger)
|
|
15793
16333
|
async destroy(): Promise<void>
|
|
@@ -15846,7 +16386,7 @@ export class Wallet implements WalletInterface, ProtoWallet {
|
|
|
15846
16386
|
}
|
|
15847
16387
|
```
|
|
15848
16388
|
|
|
15849
|
-
See also: [Chain](./client.md#type-chain), [ContactSource](./client.md#interface-contactsource), [KeyPair](./client.md#interface-keypair), [Monitor](./monitor.md#class-monitor), [PendingSignAction](./client.md#interface-pendingsignaction), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [StorageIdentity](./client.md#interface-storageidentity), [WalletArgs](./client.md#interface-walletargs), [WalletBalance](./client.md#interface-walletbalance), [WalletServices](./client.md#interface-walletservices), [WalletSettingsManager](./client.md#class-walletsettingsmanager), [WalletSigner](./client.md#class-walletsigner), [WalletStorageManager](./storage.md#class-walletstoragemanager), [createAction](./storage.md#function-createaction), [getIdentityKey](./client.md#function-getidentitykey), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [logWalletError](./client.md#function-logwalleterror), [logger](./client.md#variable-logger), [proveCertificate](./client.md#function-provecertificate), [signAction](./client.md#function-signaction)
|
|
16389
|
+
See also: [ActionBatchController](./client.md#class-actionbatchcontroller), [Chain](./client.md#type-chain), [ContactSource](./client.md#interface-contactsource), [KeyPair](./client.md#interface-keypair), [Monitor](./monitor.md#class-monitor), [PendingSignAction](./client.md#interface-pendingsignaction), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [StorageIdentity](./client.md#interface-storageidentity), [WalletArgs](./client.md#interface-walletargs), [WalletBalance](./client.md#interface-walletbalance), [WalletServices](./client.md#interface-walletservices), [WalletSettingsManager](./client.md#class-walletsettingsmanager), [WalletSigner](./client.md#class-walletsigner), [WalletStorageManager](./storage.md#class-walletstoragemanager), [createAction](./storage.md#function-createaction), [getIdentityKey](./client.md#function-getidentitykey), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [logWalletError](./client.md#function-logwalleterror), [logger](./client.md#variable-logger), [proveCertificate](./client.md#function-provecertificate), [signAction](./client.md#function-signaction)
|
|
15850
16390
|
|
|
15851
16391
|
###### Property autoKnownTxids
|
|
15852
16392
|
|
|
@@ -16048,22 +16588,25 @@ with a WABClient for user authentication flows (e.g. Twilio phone).
|
|
|
16048
16588
|
|
|
16049
16589
|
```ts
|
|
16050
16590
|
export class WalletAuthenticationManager extends CWIStyleWalletManager {
|
|
16051
|
-
constructor(adminOriginator: string, walletBuilder: (primaryKey: number[], privilegedKeyManager: PrivilegedKeyManager) => Promise<WalletInterface>, interactor: UMPTokenInteractor =
|
|
16052
|
-
public setAuthMethod(method: AuthMethodInteractor)
|
|
16053
|
-
public async startAuth(payload:
|
|
16054
|
-
public async completeAuth(payload:
|
|
16591
|
+
constructor(adminOriginator: string, walletBuilder: (primaryKey: number[], privilegedKeyManager: PrivilegedKeyManager) => Promise<WalletInterface>, interactor: UMPTokenInteractor | undefined = undefined, recoveryKeySaver: (key: number[]) => Promise<true>, passwordRetriever: (reason: string, test: (passwordCandidate: string) => boolean | Promise<boolean>) => Promise<string>, wabClient: WABClient, authMethod?: AuthMethodInteractor, stateSnapshot?: number[], options: WalletAuthenticationManagerOptions = {})
|
|
16592
|
+
public setAuthMethod(method: AuthMethodInteractor): void
|
|
16593
|
+
public async startAuth(payload: AuthPayload): Promise<void>
|
|
16594
|
+
public async completeAuth(payload: AuthPayload): Promise<void>
|
|
16595
|
+
public cancelAuth(): void
|
|
16596
|
+
public override destroy(): void
|
|
16055
16597
|
}
|
|
16056
16598
|
```
|
|
16057
16599
|
|
|
16058
|
-
See also: [AuthMethodInteractor](./client.md#class-authmethodinteractor), [
|
|
16600
|
+
See also: [AuthMethodInteractor](./client.md#class-authmethodinteractor), [AuthPayload](./client.md#interface-authpayload), [CWIStyleWalletManager](./client.md#class-cwistylewalletmanager), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [UMPTokenInteractor](./client.md#interface-umptokeninteractor), [WABClient](./client.md#class-wabclient), [WalletAuthenticationManagerOptions](./client.md#interface-walletauthenticationmanageroptions)
|
|
16059
16601
|
|
|
16060
16602
|
###### Method completeAuth
|
|
16061
16603
|
|
|
16062
16604
|
Completes the WAB-based flow, retrieving the final presentationKey from WAB if successful.
|
|
16063
16605
|
|
|
16064
16606
|
```ts
|
|
16065
|
-
public async completeAuth(payload:
|
|
16607
|
+
public async completeAuth(payload: AuthPayload): Promise<void>
|
|
16066
16608
|
```
|
|
16609
|
+
See also: [AuthPayload](./client.md#interface-authpayload)
|
|
16067
16610
|
|
|
16068
16611
|
###### Method setAuthMethod
|
|
16069
16612
|
|
|
@@ -16071,7 +16614,7 @@ Sets (or switches) the chosen AuthMethodInteractor at runtime,
|
|
|
16071
16614
|
in case the user changes their mind or picks a new method in the UI.
|
|
16072
16615
|
|
|
16073
16616
|
```ts
|
|
16074
|
-
public setAuthMethod(method: AuthMethodInteractor)
|
|
16617
|
+
public setAuthMethod(method: AuthMethodInteractor): void
|
|
16075
16618
|
```
|
|
16076
16619
|
See also: [AuthMethodInteractor](./client.md#class-authmethodinteractor)
|
|
16077
16620
|
|
|
@@ -16081,8 +16624,9 @@ Initiate the WAB-based flow, e.g. sending an SMS code or starting an ID check,
|
|
|
16081
16624
|
using the chosen AuthMethodInteractor.
|
|
16082
16625
|
|
|
16083
16626
|
```ts
|
|
16084
|
-
public async startAuth(payload:
|
|
16627
|
+
public async startAuth(payload: AuthPayload): Promise<void>
|
|
16085
16628
|
```
|
|
16629
|
+
See also: [AuthPayload](./client.md#interface-authpayload)
|
|
16086
16630
|
|
|
16087
16631
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
16088
16632
|
|
|
@@ -16926,6 +17470,14 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
16926
17470
|
async relinquishCertificate(args: RelinquishCertificateArgs): Promise<number>
|
|
16927
17471
|
async relinquishOutput(args: RelinquishOutputArgs): Promise<number>
|
|
16928
17472
|
async processAction(args: sdk.StorageProcessActionArgs): Promise<sdk.StorageProcessActionResults>
|
|
17473
|
+
async getCapabilities(): Promise<sdk.StorageCapabilities>
|
|
17474
|
+
async beginActionBatch(args: sdk.BeginActionBatchArgs): Promise<sdk.BeginActionBatchResult>
|
|
17475
|
+
async extendActionBatch(args: sdk.ExtendActionBatchArgs): Promise<sdk.ExtendActionBatchResult>
|
|
17476
|
+
async renewActionBatch(batchId: string): Promise<sdk.RenewActionBatchResult>
|
|
17477
|
+
async prepareActionBatchCommit(manifest: sdk.ActionBatchManifest): Promise<sdk.PrepareActionBatchCommitResult>
|
|
17478
|
+
async putActionBatchBlob(args: sdk.PutActionBatchBlobArgs): Promise<void>
|
|
17479
|
+
async commitActionBatch(manifest: sdk.ActionBatchManifest): Promise<sdk.CommitActionBatchResult>
|
|
17480
|
+
async abortActionBatch(batchId: string): Promise<sdk.AbortActionBatchResult>
|
|
16929
17481
|
async insertCertificate(certificate: TableCertificate): Promise<number>
|
|
16930
17482
|
async listActions(vargs: Validation.ValidListActionsArgs): Promise<ListActionsResult>
|
|
16931
17483
|
async listCertificates(args: Validation.ValidListCertificatesArgs): Promise<ListCertificatesResult>
|
|
@@ -16954,7 +17506,7 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
16954
17506
|
}
|
|
16955
17507
|
```
|
|
16956
17508
|
|
|
16957
|
-
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), [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)
|
|
17509
|
+
See also: [AbortActionBatchResult](./client.md#interface-abortactionbatchresult), [ActionBatchManifest](./client.md#interface-actionbatchmanifest), [AuthId](./client.md#interface-authid), [BeginActionBatchArgs](./client.md#interface-beginactionbatchargs), [BeginActionBatchResult](./client.md#interface-beginactionbatchresult), [CommitActionBatchResult](./client.md#interface-commitactionbatchresult), [ExtendActionBatchArgs](./client.md#interface-extendactionbatchargs), [ExtendActionBatchResult](./client.md#interface-extendactionbatchresult), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [PrepareActionBatchCommitResult](./client.md#interface-prepareactionbatchcommitresult), [PutActionBatchBlobArgs](./client.md#interface-putactionbatchblobargs), [RenewActionBatchResult](./client.md#interface-renewactionbatchresult), [ReproveHeaderResult](./client.md#interface-reproveheaderresult), [ReproveProvenResult](./client.md#interface-reproveprovenresult), [StorageCapabilities](./client.md#interface-storagecapabilities), [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), [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), [abortActionBatch](./storage.md#function-abortactionbatch), [beginActionBatch](./storage.md#function-beginactionbatch), [commitActionBatch](./storage.md#function-commitactionbatch), [createAction](./storage.md#function-createaction), [extendActionBatch](./storage.md#function-extendactionbatch), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [prepareActionBatchCommit](./storage.md#function-prepareactionbatchcommit), [processAction](./storage.md#function-processaction), [putActionBatchBlob](./storage.md#function-putactionbatchblob), [renewActionBatch](./storage.md#function-renewactionbatch)
|
|
16958
17510
|
|
|
16959
17511
|
###### Constructor
|
|
16960
17512
|
|
|
@@ -17294,84 +17846,90 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
17294
17846
|
|
|
17295
17847
|
| | | |
|
|
17296
17848
|
| --- | --- | --- |
|
|
17297
|
-
| [WalletErrorFromJson](#function-walleterrorfromjson) | [
|
|
17298
|
-
| [WocHeadersBulkListener](#function-wocheadersbulklistener) | [
|
|
17299
|
-
| [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [internalizeAction](#function-internalizeaction) | [
|
|
17300
|
-
| [WocHeadersLiveListener](#function-wocheaderslivelistener) | [
|
|
17301
|
-
| [WocHeadersLiveListener_test](#function-wocheaderslivelistener_test) | [
|
|
17302
|
-
| [
|
|
17303
|
-
| [
|
|
17304
|
-
| [
|
|
17305
|
-
| [
|
|
17306
|
-
| [
|
|
17307
|
-
| [
|
|
17308
|
-
| [
|
|
17309
|
-
| [
|
|
17310
|
-
| [
|
|
17311
|
-
| [
|
|
17312
|
-
| [
|
|
17313
|
-
| [
|
|
17314
|
-
| [
|
|
17315
|
-
| [
|
|
17316
|
-
| [
|
|
17317
|
-
| [
|
|
17318
|
-
| [
|
|
17319
|
-
| [
|
|
17320
|
-
| [
|
|
17321
|
-
| [
|
|
17322
|
-
| [
|
|
17323
|
-
| [
|
|
17324
|
-
| [
|
|
17325
|
-
| [
|
|
17326
|
-
| [
|
|
17327
|
-
| [
|
|
17328
|
-
| [
|
|
17329
|
-
| [
|
|
17330
|
-
| [
|
|
17331
|
-
| [
|
|
17332
|
-
| [
|
|
17333
|
-
| [
|
|
17334
|
-
| [
|
|
17335
|
-
| [
|
|
17336
|
-
| [
|
|
17337
|
-
| [
|
|
17338
|
-
| [
|
|
17339
|
-
| [
|
|
17340
|
-
| [
|
|
17341
|
-
| [
|
|
17342
|
-
| [
|
|
17343
|
-
| [
|
|
17344
|
-
| [
|
|
17345
|
-
| [
|
|
17346
|
-
| [
|
|
17347
|
-
| [
|
|
17348
|
-
| [
|
|
17349
|
-
| [
|
|
17350
|
-
| [
|
|
17351
|
-
| [
|
|
17352
|
-
| [
|
|
17353
|
-
| [
|
|
17354
|
-
| [
|
|
17355
|
-
| [
|
|
17356
|
-
| [
|
|
17357
|
-
| [
|
|
17358
|
-
| [
|
|
17359
|
-
| [
|
|
17360
|
-
| [
|
|
17361
|
-
| [
|
|
17362
|
-
| [
|
|
17363
|
-
| [
|
|
17364
|
-
| [
|
|
17365
|
-
| [
|
|
17366
|
-
| [
|
|
17367
|
-
| [
|
|
17368
|
-
| [
|
|
17369
|
-
| [
|
|
17370
|
-
| [
|
|
17371
|
-
| [
|
|
17372
|
-
| [
|
|
17373
|
-
| [
|
|
17374
|
-
| [
|
|
17849
|
+
| [WalletErrorFromJson](#function-walleterrorfromjson) | [importSingleOutpoint](#function-importsingleoutpoint) | [serializeBaseBlockHeader](#function-serializebaseblockheader) |
|
|
17850
|
+
| [WocHeadersBulkListener](#function-wocheadersbulklistener) | [internalizeAction](#function-internalizeaction) | [serializeBaseBlockHeaders](#function-serializebaseblockheaders) |
|
|
17851
|
+
| [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [internalizeAction](#function-internalizeaction) | [setDisableDoubleSpendCheckForTest](#function-setdisabledoublespendcheckfortest) |
|
|
17852
|
+
| [WocHeadersLiveListener](#function-wocheaderslivelistener) | [isArcAcceptedTxStatus](#function-isarcacceptedtxstatus) | [setResultBeef](#function-setresultbeef) |
|
|
17853
|
+
| [WocHeadersLiveListener_test](#function-wocheaderslivelistener_test) | [isArcDoubleSpendTxStatus](#function-isarcdoublespendtxstatus) | [sha256Hash](#function-sha256hash) |
|
|
17854
|
+
| [abortActionBatch](#function-abortactionbatch) | [isArcInvalidTxStatus](#function-isarcinvalidtxstatus) | [sha256HashOfBinaryFile](#function-sha256hashofbinaryfile) |
|
|
17855
|
+
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [isArcServiceErrorStatus](#function-isarcserviceerrorstatus) | [shareReqsWithWorld](#function-sharereqswithworld) |
|
|
17856
|
+
| [actionBatchBlobDigest](#function-actionbatchblobdigest) | [isAutoSpendableChangeOutput](#function-isautospendablechangeoutput) | [signAction](#function-signaction) |
|
|
17857
|
+
| [actionBatchManifestDigest](#function-actionbatchmanifestdigest) | [isBaseBlockHeader](#function-isbaseblockheader) | [signAndComplete](#function-signandcomplete) |
|
|
17858
|
+
| [addPlannerOutputs](#function-addplanneroutputs) | [isBlockHeader](#function-isblockheader) | [stageTransactionOutputs](#function-stagetransactionoutputs) |
|
|
17859
|
+
| [addWork](#function-addwork) | [isCreateActionSpecOp](#function-iscreateactionspecop) | [stampLog](#function-stamplog) |
|
|
17860
|
+
| [additionalFundingTarget](#function-additionalfundingtarget) | [isKnownValidBulkHeaderFile](#function-isknownvalidbulkheaderfile) | [stampLogFormat](#function-stamplogformat) |
|
|
17861
|
+
| [arcDefaultUrl](#function-arcdefaulturl) | [isListActionsSpecOp](#function-islistactionsspecop) | [stringifyJsonRpc](#function-stringifyjsonrpc) |
|
|
17862
|
+
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [isListOutputsSpecOp](#function-islistoutputsspecop) | [subWork](#function-subwork) |
|
|
17863
|
+
| [arcadeDefaultUrl](#function-arcadedefaulturl) | [isLive](#function-islive) | [swapByteOrder](#function-swapbyteorder) |
|
|
17864
|
+
| [arraysEqual](#function-arraysequal) | [isLiveBlockHeader](#function-isliveblockheader) | [tableAuthSessionToPeerSession](#function-tableauthsessiontopeersession) |
|
|
17865
|
+
| [asArray](#function-asarray) | [isManagedChangeOutput](#function-ismanagedchangeoutput) | [throwDummyReviewActions](#function-throwdummyreviewactions) |
|
|
17866
|
+
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [isMoreWork](#function-ismorework) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) |
|
|
17867
|
+
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [keyOffsetToHashedSecret](#function-keyoffsettohashedsecret) | [toLookupNetworkPreset](#function-tolookupnetworkpreset) |
|
|
17868
|
+
| [asBsvSdkScript](#function-asbsvsdkscript) | [legacyBinaryJsonReplacer](#function-legacybinaryjsonreplacer) | [toWalletNetwork](#function-towalletnetwork) |
|
|
17869
|
+
| [asBsvSdkTx](#function-asbsvsdktx) | [listActionsIdb](#function-listactionsidb) | [transactionInputSize](#function-transactioninputsize) |
|
|
17870
|
+
| [asString](#function-asstring) | [listCertificates](#function-listcertificates) | [transactionOutputSize](#function-transactionoutputsize) |
|
|
17871
|
+
| [asUint8Array](#function-asuint8array) | [listOutputsIdb](#function-listoutputsidb) | [transactionSize](#function-transactionsize) |
|
|
17872
|
+
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [tstnArcadeUrl](#function-tstnarcadeurl) |
|
|
17873
|
+
| [beefForTxids](#function-beeffortxids) | [logCreateActionArgs](#function-logcreateactionargs) | [tstnChaintracksUrl](#function-tstnchaintracksurl) |
|
|
17874
|
+
| [beginActionBatch](#function-beginactionbatch) | [logWalletError](#function-logwalleterror) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) |
|
|
17875
|
+
| [binaryJsonReplacer](#function-binaryjsonreplacer) | [makeAtomicBeef](#function-makeatomicbeef) | [updateExchangeratesapi](#function-updateexchangeratesapi) |
|
|
17876
|
+
| [binaryJsonReviver](#function-binaryjsonreviver) | [makeBrc114ActionTimeLabel](#function-makebrc114actiontimelabel) | [updateReqsFromAggregateResults](#function-updatereqsfromaggregateresults) |
|
|
17877
|
+
| [blockHash](#function-blockhash) | [makeChangeLock](#function-makechangelock) | [upgradeActionBatchStoresV2](#function-upgradeactionbatchstoresv2) |
|
|
17878
|
+
| [buildBeefForOutpoints](#function-buildbeefforoutpoints) | [makeMerklePathNote](#function-makemerklepathnote) | [upgradeAllStoresV1](#function-upgradeallstoresv1) |
|
|
17879
|
+
| [buildChaintracksOptionsWithIngestors](#function-buildchaintracksoptionswithingestors) | [markStaleInputsAsSpent](#function-markstaleinputsasspent) | [upgradeCertificateFields](#function-upgradecertificatefields) |
|
|
17880
|
+
| [buildSignableTransaction](#function-buildsignabletransaction) | [markUserInputsSpent](#function-markuserinputsspent) | [upgradeCertificates](#function-upgradecertificates) |
|
|
17881
|
+
| [classifyMerklePathResponse](#function-classifymerklepathresponse) | [matchesCertificateFieldPartial](#function-matchescertificatefieldpartial) | [upgradeCommissions](#function-upgradecommissions) |
|
|
17882
|
+
| [classifyReqStatus](#function-classifyreqstatus) | [matchesCertificatePartial](#function-matchescertificatepartial) | [upgradeMonitorEvents](#function-upgrademonitorevents) |
|
|
17883
|
+
| [cleanupExpiredActionBatches](#function-cleanupexpiredactionbatches) | [matchesCommissionPartial](#function-matchescommissionpartial) | [upgradeOutputBaskets](#function-upgradeoutputbaskets) |
|
|
17884
|
+
| [commitActionBatch](#function-commitactionbatch) | [matchesMonitorEventPartial](#function-matchesmonitoreventpartial) | [upgradeOutputTags](#function-upgradeoutputtags) |
|
|
17885
|
+
| [completeSignedTransaction](#function-completesignedtransaction) | [matchesOutputBasketPartial](#function-matchesoutputbasketpartial) | [upgradeOutputTagsMap](#function-upgradeoutputtagsmap) |
|
|
17886
|
+
| [computeMerklePath](#function-computemerklepath) | [matchesOutputPartial](#function-matchesoutputpartial) | [upgradeOutputs](#function-upgradeoutputs) |
|
|
17887
|
+
| [computeMerkleRoot](#function-computemerkleroot) | [matchesOutputTagMapPartial](#function-matchesoutputtagmappartial) | [upgradeProvenTxReqs](#function-upgradeproventxreqs) |
|
|
17888
|
+
| [convertBitsToTarget](#function-convertbitstotarget) | [matchesOutputTagPartial](#function-matchesoutputtagpartial) | [upgradeProvenTxs](#function-upgradeproventxs) |
|
|
17889
|
+
| [convertBitsToWork](#function-convertbitstowork) | [matchesProvenTxPartial](#function-matchesproventxpartial) | [upgradeSyncStates](#function-upgradesyncstates) |
|
|
17890
|
+
| [convertBufferToUint32](#function-convertbuffertouint32) | [matchesProvenTxReqPartial](#function-matchesproventxreqpartial) | [upgradeTransactions](#function-upgradetransactions) |
|
|
17891
|
+
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [matchesSyncStatePartial](#function-matchessyncstatepartial) | [upgradeTxLabels](#function-upgradetxlabels) |
|
|
17892
|
+
| [convertUint32ToBuffer](#function-convertuint32tobuffer) | [matchesTransactionPartial](#function-matchestransactionpartial) | [upgradeTxLabelsMap](#function-upgradetxlabelsmap) |
|
|
17893
|
+
| [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [matchesTxLabelMapPartial](#function-matchestxlabelmappartial) | [upgradeUsers](#function-upgradeusers) |
|
|
17894
|
+
| [createAction](#function-createaction) | [matchesTxLabelPartial](#function-matchestxlabelpartial) | [validBulkHeaderFilesByFileHash](#function-validbulkheaderfilesbyfilehash) |
|
|
17895
|
+
| [createAction](#function-createaction) | [maxDate](#function-maxdate) | [validateActionBatchInlinePayload](#function-validateactionbatchinlinepayload) |
|
|
17896
|
+
| [createCoinbaseTransaction](#function-createcoinbasetransaction) | [mergeInputBeefs](#function-mergeinputbeefs) | [validateAgainstDirtyHashes](#function-validateagainstdirtyhashes) |
|
|
17897
|
+
| [createDefaultIdbChaintracksOptions](#function-createdefaultidbchaintracksoptions) | [mergeInputsIntoBeef](#function-mergeinputsintobeef) | [validateBufferOfHeaders](#function-validatebufferofheaders) |
|
|
17898
|
+
| [createDefaultNoDbChaintracksOptions](#function-createdefaultnodbchaintracksoptions) | [mergePlannerBeef](#function-mergeplannerbeef) | [validateBulkFileData](#function-validatebulkfiledata) |
|
|
17899
|
+
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [notifyTransactionsOfProof](#function-notifytransactionsofproof) | [validateDate](#function-validatedate) |
|
|
17900
|
+
| [createIdbChaintracks](#function-createidbchaintracks) | [offsetPrivKey](#function-offsetprivkey) | [validateEntities](#function-validateentities) |
|
|
17901
|
+
| [createNoDbChaintracks](#function-createnodbchaintracks) | [offsetPubKey](#function-offsetpubkey) | [validateEntity](#function-validateentity) |
|
|
17902
|
+
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [optionalArraysEqual](#function-optionalarraysequal) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) |
|
|
17903
|
+
| [createSyncMap](#function-createsyncmap) | [parseBrc114ActionTimeLabels](#function-parsebrc114actiontimelabels) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) |
|
|
17904
|
+
| [dateMatches](#function-datematches) | [parseJsonRpc](#function-parsejsonrpc) | [validateGenesisHeader](#function-validategenesisheader) |
|
|
17905
|
+
| [decodeBinaryJsonValue](#function-decodebinaryjsonvalue) | [parseOutpoint](#function-parseoutpoint) | [validateHeaderDifficulty](#function-validateheaderdifficulty) |
|
|
17906
|
+
| [deserializeBaseBlockHeader](#function-deserializebaseblockheader) | [parseResults$](#function-parseresults$) | [validateHeaderFormat](#function-validateheaderformat) |
|
|
17907
|
+
| [deserializeBaseBlockHeaders](#function-deserializebaseblockheaders) | [parseTxAndAssertId](#function-parsetxandassertid) | [validateManifestActions](#function-validatemanifestactions) |
|
|
17908
|
+
| [deserializeBlockHeader](#function-deserializeblockheader) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [validateScriptHash](#function-validatescripthash) |
|
|
17909
|
+
| [deserializeBlockHeaders](#function-deserializeblockheaders) | [partitionActionLabels](#function-partitionactionlabels) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
|
|
17910
|
+
| [doubleSha256BE](#function-doublesha256be) | [planAction](#function-planaction) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
|
|
17911
|
+
| [doubleSha256LE](#function-doublesha256le) | [plannerOutputLockingScript](#function-planneroutputlockingscript) | [validateSyncChunkEntities](#function-validatesyncchunkentities) |
|
|
17912
|
+
| [extendActionBatch](#function-extendactionbatch) | [populateUtxoDetails](#function-populateutxodetails) | [varUintSize](#function-varuintsize) |
|
|
17913
|
+
| [fundWalletFromP2PKHOutpoints](#function-fundwalletfromp2pkhoutpoints) | [prepareActionBatchCommit](#function-prepareactionbatchcommit) | [verifyActionBatchManifestDigest](#function-verifyactionbatchmanifestdigest) |
|
|
17914
|
+
| [fundingRunwayExtension](#function-fundingrunwayextension) | [processAction](#function-processaction) | [verifyHexString](#function-verifyhexstring) |
|
|
17915
|
+
| [generateChangeSdk](#function-generatechangesdk) | [processAction](#function-processaction) | [verifyId](#function-verifyid) |
|
|
17916
|
+
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [proveCertificate](#function-provecertificate) | [verifyInteger](#function-verifyinteger) |
|
|
17917
|
+
| [genesisBuffer](#function-genesisbuffer) | [purgeDataIdb](#function-purgedataidb) | [verifyNumber](#function-verifynumber) |
|
|
17918
|
+
| [genesisHeader](#function-genesisheader) | [putActionBatchBlob](#function-putactionbatchblob) | [verifyOne](#function-verifyone) |
|
|
17919
|
+
| [getActionBatchCapabilities](#function-getactionbatchcapabilities) | [randomBytes](#function-randombytes) | [verifyOneOrNone](#function-verifyoneornone) |
|
|
17920
|
+
| [getBeefForTransaction](#function-getbeeffortransaction) | [randomBytesBase64](#function-randombytesbase64) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
|
|
17921
|
+
| [getBeefForTxid](#function-getbeeffortxid) | [randomBytesHex](#function-randombyteshex) | [verifyP2PKHOwnership](#function-verifyp2pkhownership) |
|
|
17922
|
+
| [getExchangeRatesIo](#function-getexchangeratesio) | [randomizeOutputVouts](#function-randomizeoutputvouts) | [verifyRequestedOutputsUnchanged](#function-verifyrequestedoutputsunchanged) |
|
|
17923
|
+
| [getIdentityKey](#function-getidentitykey) | [readUInt32BE](#function-readuint32be) | [verifyTruthy](#function-verifytruthy) |
|
|
17924
|
+
| [getListOutputsSpecOp](#function-getlistoutputsspecop) | [readUInt32LE](#function-readuint32le) | [verifyUnlockScripts](#function-verifyunlockscripts) |
|
|
17925
|
+
| [getProofs](#function-getproofs) | [redeemServiceCharges](#function-redeemservicecharges) | [verifyUnrequestedOutputsAreChangeOrCommission](#function-verifyunrequestedoutputsarechangeorcommission) |
|
|
17926
|
+
| [getResultBeef](#function-getresultbeef) | [renewActionBatch](#function-renewactionbatch) | [wait](#function-wait) |
|
|
17927
|
+
| [getSyncChunk](#function-getsyncchunk) | [repeatableRandom](#function-repeatablerandom) | [wocGetHeadersHeaderToBlockHeader](#function-wocgetheadersheadertoblockheader) |
|
|
17928
|
+
| [getWhatsOnChainBlockHeaderByHash](#function-getwhatsonchainblockheaderbyhash) | [resolveAutoSigned](#function-resolveautosigned) | [workBNtoBuffer](#function-workbntobuffer) |
|
|
17929
|
+
| [handlePostRawTxErrorResponse](#function-handlepostrawtxerrorresponse) | [restoreInputsToSpendable](#function-restoreinputstospendable) | [writeUInt32BE](#function-writeuint32be) |
|
|
17930
|
+
| [handleScriptHashHistoryCatch](#function-handlescripthashhistorycatch) | [reviewStatusIdb](#function-reviewstatusidb) | [writeUInt32LE](#function-writeuint32le) |
|
|
17931
|
+
| [handleScriptHashHistoryResponse](#function-handlescripthashhistoryresponse) | [selectBulkHeaderFiles](#function-selectbulkheaderfiles) | |
|
|
17932
|
+
| [handleUtxoConnReset](#function-handleutxoconnreset) | [selectCanonicalChange](#function-selectcanonicalchange) | |
|
|
17375
17933
|
|
|
17376
17934
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
17377
17935
|
|
|
@@ -17490,6 +18048,17 @@ export async function WocHeadersLiveListener_test(): Promise<void>
|
|
|
17490
18048
|
|
|
17491
18049
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
17492
18050
|
|
|
18051
|
+
---
|
|
18052
|
+
##### Function: abortActionBatch
|
|
18053
|
+
|
|
18054
|
+
```ts
|
|
18055
|
+
export async function abortActionBatch(storage: StorageProvider, auth: AuthId, batchId: string): Promise<AbortActionBatchResult>
|
|
18056
|
+
```
|
|
18057
|
+
|
|
18058
|
+
See also: [AbortActionBatchResult](./client.md#interface-abortactionbatchresult), [AuthId](./client.md#interface-authid), [StorageProvider](./storage.md#class-storageprovider)
|
|
18059
|
+
|
|
18060
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18061
|
+
|
|
17493
18062
|
---
|
|
17494
18063
|
##### Function: acquireDirectCertificate
|
|
17495
18064
|
|
|
@@ -17501,6 +18070,40 @@ See also: [AuthId](./client.md#interface-authid), [Wallet](./client.md#class-wal
|
|
|
17501
18070
|
|
|
17502
18071
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
17503
18072
|
|
|
18073
|
+
---
|
|
18074
|
+
##### Function: actionBatchBlobDigest
|
|
18075
|
+
|
|
18076
|
+
```ts
|
|
18077
|
+
export function actionBatchBlobDigest(bytes: number[] | Uint8Array): string
|
|
18078
|
+
```
|
|
18079
|
+
|
|
18080
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18081
|
+
|
|
18082
|
+
---
|
|
18083
|
+
##### Function: actionBatchManifestDigest
|
|
18084
|
+
|
|
18085
|
+
Digest only the semantic manifest. Inline bytes are represented by their
|
|
18086
|
+
content digest so inline and uploaded forms have the same idempotency key.
|
|
18087
|
+
|
|
18088
|
+
```ts
|
|
18089
|
+
export function actionBatchManifestDigest(manifest: Omit<ActionBatchManifest, "digest">): string
|
|
18090
|
+
```
|
|
18091
|
+
|
|
18092
|
+
See also: [ActionBatchManifest](./client.md#interface-actionbatchmanifest)
|
|
18093
|
+
|
|
18094
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18095
|
+
|
|
18096
|
+
---
|
|
18097
|
+
##### Function: addPlannerOutputs
|
|
18098
|
+
|
|
18099
|
+
```ts
|
|
18100
|
+
export function addPlannerOutputs(target: Map<string, PlannerOutput>, outputs: ActionBatchFundingOutput[], basketName?: string): void
|
|
18101
|
+
```
|
|
18102
|
+
|
|
18103
|
+
See also: [ActionBatchFundingOutput](./client.md#interface-actionbatchfundingoutput), [PlannerOutput](./client.md#interface-planneroutput)
|
|
18104
|
+
|
|
18105
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18106
|
+
|
|
17504
18107
|
---
|
|
17505
18108
|
##### Function: addWork
|
|
17506
18109
|
|
|
@@ -17516,6 +18119,17 @@ Sum of work1 + work2 as Buffer encoded chainWork value
|
|
|
17516
18119
|
|
|
17517
18120
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
17518
18121
|
|
|
18122
|
+
---
|
|
18123
|
+
##### Function: additionalFundingTarget
|
|
18124
|
+
|
|
18125
|
+
```ts
|
|
18126
|
+
export function additionalFundingTarget(error: WERR_INSUFFICIENT_FUNDS): number
|
|
18127
|
+
```
|
|
18128
|
+
|
|
18129
|
+
See also: [WERR_INSUFFICIENT_FUNDS](./client.md#class-werr_insufficient_funds)
|
|
18130
|
+
|
|
18131
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18132
|
+
|
|
17519
18133
|
---
|
|
17520
18134
|
##### Function: arcDefaultUrl
|
|
17521
18135
|
|
|
@@ -17751,6 +18365,31 @@ See also: [EntityProvenTxReq](./storage.md#class-entityproventxreq), [PostReqsTo
|
|
|
17751
18365
|
|
|
17752
18366
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
17753
18367
|
|
|
18368
|
+
---
|
|
18369
|
+
##### Function: beefForTxids
|
|
18370
|
+
|
|
18371
|
+
Return the minimal subgraph needed to prove the requested transactions.
|
|
18372
|
+
|
|
18373
|
+
Parents are added before children so the resulting BEEF preserves dependency
|
|
18374
|
+
order. Shared ancestors and bumps are merged only once.
|
|
18375
|
+
|
|
18376
|
+
```ts
|
|
18377
|
+
export function beefForTxids(source: Beef, txids: string[]): Beef
|
|
18378
|
+
```
|
|
18379
|
+
|
|
18380
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18381
|
+
|
|
18382
|
+
---
|
|
18383
|
+
##### Function: beginActionBatch
|
|
18384
|
+
|
|
18385
|
+
```ts
|
|
18386
|
+
export async function beginActionBatch(storage: StorageProvider, auth: AuthId, args: BeginActionBatchArgs): Promise<BeginActionBatchResult>
|
|
18387
|
+
```
|
|
18388
|
+
|
|
18389
|
+
See also: [AuthId](./client.md#interface-authid), [BeginActionBatchArgs](./client.md#interface-beginactionbatchargs), [BeginActionBatchResult](./client.md#interface-beginactionbatchresult), [StorageProvider](./storage.md#class-storageprovider)
|
|
18390
|
+
|
|
18391
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18392
|
+
|
|
17754
18393
|
---
|
|
17755
18394
|
##### Function: binaryJsonReplacer
|
|
17756
18395
|
|
|
@@ -17872,6 +18511,28 @@ See also: [GetReqsAndBeefDetail](./storage.md#interface-getreqsandbeefdetail), [
|
|
|
17872
18511
|
|
|
17873
18512
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
17874
18513
|
|
|
18514
|
+
---
|
|
18515
|
+
##### Function: cleanupExpiredActionBatches
|
|
18516
|
+
|
|
18517
|
+
```ts
|
|
18518
|
+
export async function cleanupExpiredActionBatches(storage: StorageProvider): Promise<number>
|
|
18519
|
+
```
|
|
18520
|
+
|
|
18521
|
+
See also: [StorageProvider](./storage.md#class-storageprovider)
|
|
18522
|
+
|
|
18523
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18524
|
+
|
|
18525
|
+
---
|
|
18526
|
+
##### Function: commitActionBatch
|
|
18527
|
+
|
|
18528
|
+
```ts
|
|
18529
|
+
export async function commitActionBatch(storage: StorageProvider, auth: AuthId, manifest: ActionBatchManifest): Promise<CommitActionBatchResult>
|
|
18530
|
+
```
|
|
18531
|
+
|
|
18532
|
+
See also: [ActionBatchManifest](./client.md#interface-actionbatchmanifest), [AuthId](./client.md#interface-authid), [CommitActionBatchResult](./client.md#interface-commitactionbatchresult), [StorageProvider](./storage.md#class-storageprovider)
|
|
18533
|
+
|
|
18534
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18535
|
+
|
|
17875
18536
|
---
|
|
17876
18537
|
##### Function: completeSignedTransaction
|
|
17877
18538
|
|
|
@@ -18166,17 +18827,6 @@ export function decodeBinaryJsonValue(value: unknown): unknown
|
|
|
18166
18827
|
|
|
18167
18828
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18168
18829
|
|
|
18169
|
-
---
|
|
18170
|
-
##### Function: decryptBRC39
|
|
18171
|
-
|
|
18172
|
-
```ts
|
|
18173
|
-
export async function decryptBRC39(bytes: number[] | Uint8Array, password: string): Promise<BRC38WalletData>
|
|
18174
|
-
```
|
|
18175
|
-
|
|
18176
|
-
See also: [BRC38WalletData](./storage.md#interface-brc38walletdata)
|
|
18177
|
-
|
|
18178
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18179
|
-
|
|
18180
18830
|
---
|
|
18181
18831
|
##### Function: deserializeBaseBlockHeader
|
|
18182
18832
|
|
|
@@ -18288,46 +18938,13 @@ Argument Details
|
|
|
18288
18938
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18289
18939
|
|
|
18290
18940
|
---
|
|
18291
|
-
##### Function:
|
|
18292
|
-
|
|
18293
|
-
```ts
|
|
18294
|
-
export async function encryptBRC39(documentOrJson: BRC38WalletData | string, password: string, options?: BRC39Options): Promise<number[]>
|
|
18295
|
-
```
|
|
18296
|
-
|
|
18297
|
-
See also: [BRC38WalletData](./storage.md#interface-brc38walletdata), [BRC39Options](./storage.md#interface-brc39options)
|
|
18298
|
-
|
|
18299
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18300
|
-
|
|
18301
|
-
---
|
|
18302
|
-
##### Function: exportBRC38
|
|
18303
|
-
|
|
18304
|
-
```ts
|
|
18305
|
-
export async function exportBRC38(storage: StorageProvider, identityKey: string): Promise<BRC38WalletData>
|
|
18306
|
-
```
|
|
18307
|
-
|
|
18308
|
-
See also: [BRC38WalletData](./storage.md#interface-brc38walletdata), [StorageProvider](./storage.md#class-storageprovider)
|
|
18309
|
-
|
|
18310
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18311
|
-
|
|
18312
|
-
---
|
|
18313
|
-
##### Function: exportBRC38Json
|
|
18941
|
+
##### Function: extendActionBatch
|
|
18314
18942
|
|
|
18315
18943
|
```ts
|
|
18316
|
-
export async function
|
|
18944
|
+
export async function extendActionBatch(storage: StorageProvider, auth: AuthId, args: ExtendActionBatchArgs): Promise<ExtendActionBatchResult>
|
|
18317
18945
|
```
|
|
18318
18946
|
|
|
18319
|
-
See also: [StorageProvider](./storage.md#class-storageprovider)
|
|
18320
|
-
|
|
18321
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18322
|
-
|
|
18323
|
-
---
|
|
18324
|
-
##### Function: exportBRC39
|
|
18325
|
-
|
|
18326
|
-
```ts
|
|
18327
|
-
export async function exportBRC39(storage: StorageProvider, identityKey: string, password: string, options?: BRC39Options): Promise<number[]>
|
|
18328
|
-
```
|
|
18329
|
-
|
|
18330
|
-
See also: [BRC39Options](./storage.md#interface-brc39options), [StorageProvider](./storage.md#class-storageprovider)
|
|
18947
|
+
See also: [AuthId](./client.md#interface-authid), [ExtendActionBatchArgs](./client.md#interface-extendactionbatchargs), [ExtendActionBatchResult](./client.md#interface-extendactionbatchresult), [StorageProvider](./storage.md#class-storageprovider)
|
|
18331
18948
|
|
|
18332
18949
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18333
18950
|
|
|
@@ -18352,6 +18969,21 @@ See also: [KeyPairAddress](./setup.md#interface-keypairaddress), [ScriptTemplate
|
|
|
18352
18969
|
|
|
18353
18970
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18354
18971
|
|
|
18972
|
+
---
|
|
18973
|
+
##### Function: fundingRunwayExtension
|
|
18974
|
+
|
|
18975
|
+
```ts
|
|
18976
|
+
export function fundingRunwayExtension(runwayTarget: number, ewmaConfirmedInputs: number, ewmaConfirmedSatoshis: number, availableConfirmed: Array<{
|
|
18977
|
+
satoshis: number;
|
|
18978
|
+
}>): {
|
|
18979
|
+
nextRunwayTarget: number;
|
|
18980
|
+
requestedOutputs: number;
|
|
18981
|
+
targetSatoshis: number;
|
|
18982
|
+
} | undefined
|
|
18983
|
+
```
|
|
18984
|
+
|
|
18985
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18986
|
+
|
|
18355
18987
|
---
|
|
18356
18988
|
##### Function: generateChangeSdk
|
|
18357
18989
|
|
|
@@ -18441,6 +19073,17 @@ See also: [BlockHeader](./client.md#interface-blockheader), [Chain](./client.md#
|
|
|
18441
19073
|
|
|
18442
19074
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18443
19075
|
|
|
19076
|
+
---
|
|
19077
|
+
##### Function: getActionBatchCapabilities
|
|
19078
|
+
|
|
19079
|
+
```ts
|
|
19080
|
+
export function getActionBatchCapabilities(): StorageCapabilities
|
|
19081
|
+
```
|
|
19082
|
+
|
|
19083
|
+
See also: [StorageCapabilities](./client.md#interface-storagecapabilities)
|
|
19084
|
+
|
|
19085
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
19086
|
+
|
|
18444
19087
|
---
|
|
18445
19088
|
##### Function: getBeefForTransaction
|
|
18446
19089
|
|
|
@@ -18649,28 +19292,6 @@ See also: [GetUtxoStatusResult](./client.md#interface-getutxostatusresult)
|
|
|
18649
19292
|
|
|
18650
19293
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18651
19294
|
|
|
18652
|
-
---
|
|
18653
|
-
##### Function: importBRC38
|
|
18654
|
-
|
|
18655
|
-
```ts
|
|
18656
|
-
export async function importBRC38(storage: StorageProvider, documentOrJson: BRC38WalletData | string, options: BRC38ImportOptions): Promise<BRC38ImportResult>
|
|
18657
|
-
```
|
|
18658
|
-
|
|
18659
|
-
See also: [BRC38ImportOptions](./storage.md#interface-brc38importoptions), [BRC38ImportResult](./storage.md#interface-brc38importresult), [BRC38WalletData](./storage.md#interface-brc38walletdata), [StorageProvider](./storage.md#class-storageprovider)
|
|
18660
|
-
|
|
18661
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18662
|
-
|
|
18663
|
-
---
|
|
18664
|
-
##### Function: importBRC39
|
|
18665
|
-
|
|
18666
|
-
```ts
|
|
18667
|
-
export async function importBRC39(storage: StorageProvider, bytes: number[] | Uint8Array, password: string, options: BRC38ImportOptions): Promise<BRC38ImportResult>
|
|
18668
|
-
```
|
|
18669
|
-
|
|
18670
|
-
See also: [BRC38ImportOptions](./storage.md#interface-brc38importoptions), [BRC38ImportResult](./storage.md#interface-brc38importresult), [StorageProvider](./storage.md#class-storageprovider)
|
|
18671
|
-
|
|
18672
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18673
|
-
|
|
18674
19295
|
---
|
|
18675
19296
|
##### Function: importSingleOutpoint
|
|
18676
19297
|
|
|
@@ -19402,6 +20023,17 @@ See also: [TrxToken](./client.md#interface-trxtoken)
|
|
|
19402
20023
|
|
|
19403
20024
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
19404
20025
|
|
|
20026
|
+
---
|
|
20027
|
+
##### Function: mergePlannerBeef
|
|
20028
|
+
|
|
20029
|
+
```ts
|
|
20030
|
+
export function mergePlannerBeef(state: ActionBatchPlannerState, tx: Transaction): void
|
|
20031
|
+
```
|
|
20032
|
+
|
|
20033
|
+
See also: [ActionBatchPlannerState](./client.md#interface-actionbatchplannerstate)
|
|
20034
|
+
|
|
20035
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20036
|
+
|
|
19405
20037
|
---
|
|
19406
20038
|
##### Function: notifyTransactionsOfProof
|
|
19407
20039
|
|
|
@@ -19456,17 +20088,6 @@ export function optionalArraysEqual(arr1?: Number[], arr2?: Number[]): boolean
|
|
|
19456
20088
|
|
|
19457
20089
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
19458
20090
|
|
|
19459
|
-
---
|
|
19460
|
-
##### Function: parseBRC38Json
|
|
19461
|
-
|
|
19462
|
-
```ts
|
|
19463
|
-
export function parseBRC38Json(json: string): BRC38WalletData
|
|
19464
|
-
```
|
|
19465
|
-
|
|
19466
|
-
See also: [BRC38WalletData](./storage.md#interface-brc38walletdata)
|
|
19467
|
-
|
|
19468
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
19469
|
-
|
|
19470
20091
|
---
|
|
19471
20092
|
##### Function: parseBrc114ActionTimeLabels
|
|
19472
20093
|
|
|
@@ -19548,6 +20169,28 @@ See also: [ListActionsSpecOp](./storage.md#interface-listactionsspecop)
|
|
|
19548
20169
|
|
|
19549
20170
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
19550
20171
|
|
|
20172
|
+
---
|
|
20173
|
+
##### Function: planAction
|
|
20174
|
+
|
|
20175
|
+
```ts
|
|
20176
|
+
export async function planAction(state: ActionBatchPlannerState, args: Validation.ValidCreateActionArgs): Promise<ActionBatchPlannedAction>
|
|
20177
|
+
```
|
|
20178
|
+
|
|
20179
|
+
See also: [ActionBatchPlannedAction](./client.md#interface-actionbatchplannedaction), [ActionBatchPlannerState](./client.md#interface-actionbatchplannerstate)
|
|
20180
|
+
|
|
20181
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20182
|
+
|
|
20183
|
+
---
|
|
20184
|
+
##### Function: plannerOutputLockingScript
|
|
20185
|
+
|
|
20186
|
+
```ts
|
|
20187
|
+
export function plannerOutputLockingScript(state: ActionBatchPlannerState, output: PlannerOutput): number[]
|
|
20188
|
+
```
|
|
20189
|
+
|
|
20190
|
+
See also: [ActionBatchPlannerState](./client.md#interface-actionbatchplannerstate), [PlannerOutput](./client.md#interface-planneroutput)
|
|
20191
|
+
|
|
20192
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20193
|
+
|
|
19551
20194
|
---
|
|
19552
20195
|
##### Function: populateUtxoDetails
|
|
19553
20196
|
|
|
@@ -19566,6 +20209,17 @@ See also: [GetUtxoStatusResult](./client.md#interface-getutxostatusresult)
|
|
|
19566
20209
|
|
|
19567
20210
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
19568
20211
|
|
|
20212
|
+
---
|
|
20213
|
+
##### Function: prepareActionBatchCommit
|
|
20214
|
+
|
|
20215
|
+
```ts
|
|
20216
|
+
export async function prepareActionBatchCommit(storage: StorageProvider, auth: AuthId, manifest: ActionBatchManifest): Promise<PrepareActionBatchCommitResult>
|
|
20217
|
+
```
|
|
20218
|
+
|
|
20219
|
+
See also: [ActionBatchManifest](./client.md#interface-actionbatchmanifest), [AuthId](./client.md#interface-authid), [PrepareActionBatchCommitResult](./client.md#interface-prepareactionbatchcommitresult), [StorageProvider](./storage.md#class-storageprovider)
|
|
20220
|
+
|
|
20221
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20222
|
+
|
|
19569
20223
|
---
|
|
19570
20224
|
##### Function: processAction
|
|
19571
20225
|
|
|
@@ -19610,6 +20264,17 @@ See also: [PurgeParams](./client.md#interface-purgeparams), [PurgeResults](./cli
|
|
|
19610
20264
|
|
|
19611
20265
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
19612
20266
|
|
|
20267
|
+
---
|
|
20268
|
+
##### Function: putActionBatchBlob
|
|
20269
|
+
|
|
20270
|
+
```ts
|
|
20271
|
+
export async function putActionBatchBlob(storage: StorageProvider, auth: AuthId, args: PutActionBatchBlobArgs): Promise<void>
|
|
20272
|
+
```
|
|
20273
|
+
|
|
20274
|
+
See also: [AuthId](./client.md#interface-authid), [PutActionBatchBlobArgs](./client.md#interface-putactionbatchblobargs), [StorageProvider](./storage.md#class-storageprovider)
|
|
20275
|
+
|
|
20276
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20277
|
+
|
|
19613
20278
|
---
|
|
19614
20279
|
##### Function: randomBytes
|
|
19615
20280
|
|
|
@@ -19649,6 +20314,19 @@ count cryptographically secure random bytes as hex encoded string
|
|
|
19649
20314
|
|
|
19650
20315
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
19651
20316
|
|
|
20317
|
+
---
|
|
20318
|
+
##### Function: randomizeOutputVouts
|
|
20319
|
+
|
|
20320
|
+
Pure Fisher-Yates vout assignment shared by legacy and batch planning.
|
|
20321
|
+
|
|
20322
|
+
```ts
|
|
20323
|
+
export function randomizeOutputVouts<T extends {
|
|
20324
|
+
vout: number;
|
|
20325
|
+
}>(outputs: T[], randomVals?: number[]): void
|
|
20326
|
+
```
|
|
20327
|
+
|
|
20328
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20329
|
+
|
|
19652
20330
|
---
|
|
19653
20331
|
##### Function: readUInt32BE
|
|
19654
20332
|
|
|
@@ -19678,6 +20356,26 @@ See also: [TableCommission](./storage.md#interface-tablecommission)
|
|
|
19678
20356
|
|
|
19679
20357
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
19680
20358
|
|
|
20359
|
+
---
|
|
20360
|
+
##### Function: renewActionBatch
|
|
20361
|
+
|
|
20362
|
+
```ts
|
|
20363
|
+
export async function renewActionBatch(storage: StorageProvider, auth: AuthId, batchId: string): Promise<RenewActionBatchResult>
|
|
20364
|
+
```
|
|
20365
|
+
|
|
20366
|
+
See also: [AuthId](./client.md#interface-authid), [RenewActionBatchResult](./client.md#interface-renewactionbatchresult), [StorageProvider](./storage.md#class-storageprovider)
|
|
20367
|
+
|
|
20368
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20369
|
+
|
|
20370
|
+
---
|
|
20371
|
+
##### Function: repeatableRandom
|
|
20372
|
+
|
|
20373
|
+
```ts
|
|
20374
|
+
export function repeatableRandom(randomVals?: number[]): () => number
|
|
20375
|
+
```
|
|
20376
|
+
|
|
20377
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20378
|
+
|
|
19681
20379
|
---
|
|
19682
20380
|
##### Function: resolveAutoSigned
|
|
19683
20381
|
|
|
@@ -19731,6 +20429,19 @@ See also: [BulkHeaderFileInfo](./services.md#interface-bulkheaderfileinfo), [Cha
|
|
|
19731
20429
|
|
|
19732
20430
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
19733
20431
|
|
|
20432
|
+
---
|
|
20433
|
+
##### Function: selectCanonicalChange
|
|
20434
|
+
|
|
20435
|
+
Pure exact / least-over / largest-under change selection policy.
|
|
20436
|
+
|
|
20437
|
+
```ts
|
|
20438
|
+
export function selectCanonicalChange<T extends CanonicalFundingCandidate>(outputs: T[], targetSatoshis: number, exactSatoshis?: number): T | undefined
|
|
20439
|
+
```
|
|
20440
|
+
|
|
20441
|
+
See also: [CanonicalFundingCandidate](./storage.md#interface-canonicalfundingcandidate)
|
|
20442
|
+
|
|
20443
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20444
|
+
|
|
19734
20445
|
---
|
|
19735
20446
|
##### Function: serializeBaseBlockHeader
|
|
19736
20447
|
|
|
@@ -19885,6 +20596,17 @@ See also: [KeyPairAddress](./setup.md#interface-keypairaddress), [ScriptTemplate
|
|
|
19885
20596
|
|
|
19886
20597
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
19887
20598
|
|
|
20599
|
+
---
|
|
20600
|
+
##### Function: stageTransactionOutputs
|
|
20601
|
+
|
|
20602
|
+
```ts
|
|
20603
|
+
export function stageTransactionOutputs(state: ActionBatchPlannerState, tx: Transaction, dcr: StorageCreateActionResult): void
|
|
20604
|
+
```
|
|
20605
|
+
|
|
20606
|
+
See also: [ActionBatchPlannerState](./client.md#interface-actionbatchplannerstate), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult)
|
|
20607
|
+
|
|
20608
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20609
|
+
|
|
19888
20610
|
---
|
|
19889
20611
|
##### Function: stampLog
|
|
19890
20612
|
|
|
@@ -20184,6 +20906,19 @@ Argument Details
|
|
|
20184
20906
|
|
|
20185
20907
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20186
20908
|
|
|
20909
|
+
---
|
|
20910
|
+
##### Function: upgradeActionBatchStoresV2
|
|
20911
|
+
|
|
20912
|
+
Internal, non-synchronized action-batch state added in schema version 2.
|
|
20913
|
+
|
|
20914
|
+
```ts
|
|
20915
|
+
export function upgradeActionBatchStoresV2(db: IDBPDatabase<StorageIdbSchema>): void
|
|
20916
|
+
```
|
|
20917
|
+
|
|
20918
|
+
See also: [StorageIdbSchema](./storage.md#interface-storageidbschema)
|
|
20919
|
+
|
|
20920
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20921
|
+
|
|
20187
20922
|
---
|
|
20188
20923
|
##### Function: upgradeAllStoresV1
|
|
20189
20924
|
|
|
@@ -20379,6 +21114,17 @@ object where keys are file hashes of known bulk header files.
|
|
|
20379
21114
|
|
|
20380
21115
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20381
21116
|
|
|
21117
|
+
---
|
|
21118
|
+
##### Function: validateActionBatchInlinePayload
|
|
21119
|
+
|
|
21120
|
+
```ts
|
|
21121
|
+
export function validateActionBatchInlinePayload(manifest: ActionBatchManifest): void
|
|
21122
|
+
```
|
|
21123
|
+
|
|
21124
|
+
See also: [ActionBatchManifest](./client.md#interface-actionbatchmanifest)
|
|
21125
|
+
|
|
21126
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21127
|
+
|
|
20382
21128
|
---
|
|
20383
21129
|
##### Function: validateAgainstDirtyHashes
|
|
20384
21130
|
|
|
@@ -20583,6 +21329,20 @@ Argument Details
|
|
|
20583
21329
|
|
|
20584
21330
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20585
21331
|
|
|
21332
|
+
---
|
|
21333
|
+
##### Function: validateManifestActions
|
|
21334
|
+
|
|
21335
|
+
```ts
|
|
21336
|
+
export async function validateManifestActions(storage: StorageProvider, batch: TableActionBatch, manifest: ActionBatchManifest): Promise<{
|
|
21337
|
+
actions: ValidatedBatchAction[];
|
|
21338
|
+
dependencyBeef: number[];
|
|
21339
|
+
}>
|
|
21340
|
+
```
|
|
21341
|
+
|
|
21342
|
+
See also: [ActionBatchManifest](./client.md#interface-actionbatchmanifest), [StorageProvider](./storage.md#class-storageprovider), [TableActionBatch](./storage.md#interface-tableactionbatch), [ValidatedBatchAction](./storage.md#interface-validatedbatchaction)
|
|
21343
|
+
|
|
21344
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21345
|
+
|
|
20586
21346
|
---
|
|
20587
21347
|
##### Function: validateScriptHash
|
|
20588
21348
|
|
|
@@ -20651,6 +21411,17 @@ See also: [WERR_INVALID_PARAMETER](./client.md#class-werr_invalid_parameter)
|
|
|
20651
21411
|
|
|
20652
21412
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20653
21413
|
|
|
21414
|
+
---
|
|
21415
|
+
##### Function: verifyActionBatchManifestDigest
|
|
21416
|
+
|
|
21417
|
+
```ts
|
|
21418
|
+
export function verifyActionBatchManifestDigest(manifest: ActionBatchManifest): boolean
|
|
21419
|
+
```
|
|
21420
|
+
|
|
21421
|
+
See also: [ActionBatchManifest](./client.md#interface-actionbatchmanifest)
|
|
21422
|
+
|
|
21423
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21424
|
+
|
|
20654
21425
|
---
|
|
20655
21426
|
##### Function: verifyHexString
|
|
20656
21427
|
|
|
@@ -20943,24 +21714,43 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
20943
21714
|
|
|
20944
21715
|
| | | |
|
|
20945
21716
|
| --- | --- | --- |
|
|
20946
|
-
| [
|
|
20947
|
-
| [
|
|
20948
|
-
| [
|
|
20949
|
-
| [
|
|
20950
|
-
| [
|
|
20951
|
-
| [
|
|
20952
|
-
| [
|
|
20953
|
-
| [
|
|
20954
|
-
| [
|
|
20955
|
-
| [
|
|
20956
|
-
| [
|
|
20957
|
-
| [
|
|
20958
|
-
| [
|
|
21717
|
+
| [ActionBatchMode](#type-actionbatchmode) | [GetScriptHashHistoryService](#type-getscripthashhistoryservice) | [PostTxsService](#type-posttxsservice) |
|
|
21718
|
+
| [ActionBatchStatus](#type-actionbatchstatus) | [GetStatusForTxidsService](#type-getstatusfortxidsservice) | [ProvenTxReqStatus](#type-proventxreqstatus) |
|
|
21719
|
+
| [AnyBlockHeader](#type-anyblockheader) | [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat) | [ReorgListener](#type-reorglistener) |
|
|
21720
|
+
| [ByteEncoding](#type-byteencoding) | [GetUtxoStatusService](#type-getutxostatusservice) | [ReviewActionResultStatus](#type-reviewactionresultstatus) |
|
|
21721
|
+
| [ByteInput](#type-byteinput) | [GroupedPermissionEventHandler](#type-groupedpermissioneventhandler) | [ScriptHashFormat](#type-scripthashformat) |
|
|
21722
|
+
| [Chain](#type-chain) | [HeaderListener](#type-headerlistener) | [SecurityLevel](#type-securitylevel) |
|
|
21723
|
+
| [CounterpartyPermissionEventHandler](#type-counterpartypermissioneventhandler) | [InsertHeaderResult](#type-insertheaderresult) | [StorageProvidedBy](#type-storageprovidedby) |
|
|
21724
|
+
| [DBType](#type-dbtype) | [LineItemType](#type-lineitemtype) | [SyncProtocolVersion](#type-syncprotocolversion) |
|
|
21725
|
+
| [EnqueueHandler](#type-enqueuehandler) | [MerklePathNoteWhat](#type-merklepathnotewhat) | [SyncStatus](#type-syncstatus) |
|
|
21726
|
+
| [EntityStorage](#type-entitystorage) | [MonitorStartupTaskMode](#type-monitorstartuptaskmode) | [TransactionStatus](#type-transactionstatus) |
|
|
21727
|
+
| [ErrorHandler](#type-errorhandler) | [MonitorStorage](#type-monitorstorage) | [UMPTokenLookupFailureReason](#type-umptokenlookupfailurereason) |
|
|
21728
|
+
| [FiatCurrencyCode](#type-fiatcurrencycode) | [PermissionEventHandler](#type-permissioneventhandler) | [UpdateFiatExchangeRateService](#type-updatefiatexchangerateservice) |
|
|
21729
|
+
| [GetMerklePathService](#type-getmerklepathservice) | [PostBeefService](#type-postbeefservice) | [WABClientErrorCode](#type-wabclienterrorcode) |
|
|
21730
|
+
| [GetRawTxService](#type-getrawtxservice) | [PostReqsToNetworkDetailsStatus](#type-postreqstonetworkdetailsstatus) | [WalletLoggerLevel](#type-walletloggerlevel) |
|
|
21731
|
+
|
|
21732
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21733
|
+
|
|
21734
|
+
---
|
|
21735
|
+
|
|
21736
|
+
##### Type: ActionBatchMode
|
|
21737
|
+
|
|
21738
|
+
```ts
|
|
21739
|
+
export type ActionBatchMode = "auto" | "legacy"
|
|
21740
|
+
```
|
|
20959
21741
|
|
|
20960
21742
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
20961
21743
|
|
|
20962
21744
|
---
|
|
21745
|
+
##### Type: ActionBatchStatus
|
|
20963
21746
|
|
|
21747
|
+
```ts
|
|
21748
|
+
export type ActionBatchStatus = "active" | "prepared" | "committed" | "aborted" | "expired"
|
|
21749
|
+
```
|
|
21750
|
+
|
|
21751
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21752
|
+
|
|
21753
|
+
---
|
|
20964
21754
|
##### Type: AnyBlockHeader
|
|
20965
21755
|
|
|
20966
21756
|
Union of all block header variants
|
|
@@ -21408,6 +22198,15 @@ export type TransactionStatus = "completed" | "failed" | "unprocessed" | "sendin
|
|
|
21408
22198
|
|
|
21409
22199
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21410
22200
|
|
|
22201
|
+
---
|
|
22202
|
+
##### Type: UMPTokenLookupFailureReason
|
|
22203
|
+
|
|
22204
|
+
```ts
|
|
22205
|
+
export type UMPTokenLookupFailureReason = "lookup-unavailable" | "lookup-incomplete" | "token-malformed" | "token-ambiguous"
|
|
22206
|
+
```
|
|
22207
|
+
|
|
22208
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22209
|
+
|
|
21411
22210
|
---
|
|
21412
22211
|
##### Type: UpdateFiatExchangeRateService
|
|
21413
22212
|
|
|
@@ -21419,6 +22218,15 @@ See also: [FiatExchangeRates](./client.md#interface-fiatexchangerates), [WalletS
|
|
|
21419
22218
|
|
|
21420
22219
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21421
22220
|
|
|
22221
|
+
---
|
|
22222
|
+
##### Type: WABClientErrorCode
|
|
22223
|
+
|
|
22224
|
+
```ts
|
|
22225
|
+
export type WABClientErrorCode = "WAB_INVALID_CONFIGURATION" | "WAB_INVALID_REQUEST" | "WAB_NETWORK_ERROR" | "WAB_TIMEOUT" | "WAB_HTTP_ERROR" | "WAB_REQUEST_TOO_LARGE" | "WAB_RESPONSE_TOO_LARGE" | "WAB_INVALID_RESPONSE"
|
|
22226
|
+
```
|
|
22227
|
+
|
|
22228
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22229
|
+
|
|
21422
22230
|
---
|
|
21423
22231
|
##### Type: WalletLoggerLevel
|
|
21424
22232
|
|
|
@@ -21441,23 +22249,100 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
21441
22249
|
|
|
21442
22250
|
| | | |
|
|
21443
22251
|
| --- | --- | --- |
|
|
21444
|
-
| [
|
|
21445
|
-
| [
|
|
21446
|
-
| [
|
|
21447
|
-
| [
|
|
21448
|
-
| [
|
|
21449
|
-
| [
|
|
21450
|
-
| [
|
|
21451
|
-
| [
|
|
21452
|
-
| [
|
|
21453
|
-
| [
|
|
21454
|
-
| [
|
|
21455
|
-
| [
|
|
22252
|
+
| [ACTION_BATCH_HARD_LIFETIME_MS](#variable-action_batch_hard_lifetime_ms) | [BINARY_ENCODING_HEADER](#variable-binary_encoding_header) | [managedChangeOutputFields](#variable-managedchangeoutputfields) |
|
|
22253
|
+
| [ACTION_BATCH_LEASE_MS](#variable-action_batch_lease_ms) | [BINARY_REQUEST_ENCODING_HEADER](#variable-binary_request_encoding_header) | [maxChangeOutputsPerTransaction](#variable-maxchangeoutputspertransaction) |
|
|
22254
|
+
| [ACTION_BATCH_MAX_BLOB_BYTES](#variable-action_batch_max_blob_bytes) | [DEFAULT_PROFILE_ID](#variable-default_profile_id) | [maxPossibleSatoshis](#variable-maxpossiblesatoshis) |
|
|
22255
|
+
| [ACTION_BATCH_MAX_CHUNKS_PER_BLOB](#variable-action_batch_max_chunks_per_blob) | [DEFAULT_SETTINGS](#variable-default_settings) | [outputColumnsWithoutLockingScript](#variable-outputcolumnswithoutlockingscript) |
|
|
22256
|
+
| [ACTION_BATCH_MAX_CONCURRENT_UPLOADS](#variable-action_batch_max_concurrent_uploads) | [KDF_MAX_HASH_LENGTH](#variable-kdf_max_hash_length) | [parseResults](#variable-parseresults) |
|
|
22257
|
+
| [ACTION_BATCH_MAX_INLINE_BYTES](#variable-action_batch_max_inline_bytes) | [MAX_STATE_SNAPSHOT_BYTES](#variable-max_state_snapshot_bytes) | [queryOverlay](#variable-queryoverlay) |
|
|
22258
|
+
| [ACTION_BATCH_MAX_LOGICAL_BLOB_BYTES](#variable-action_batch_max_logical_blob_bytes) | [MAX_STORAGE_COMMISSION_SATOSHIS](#variable-max_storage_commission_satoshis) | [specOpFailedActions](#variable-specopfailedactions) |
|
|
22259
|
+
| [ACTION_BATCH_MAX_RESERVATION_EXTENSION_OUTPUTS](#variable-action_batch_max_reservation_extension_outputs) | [PBKDF2_MAX_ITERATIONS](#variable-pbkdf2_max_iterations) | [specOpInvalidChange](#variable-specopinvalidchange) |
|
|
22260
|
+
| [ARCADE_POST_BEEF_CONCURRENCY](#variable-arcade_post_beef_concurrency) | [PBKDF2_NUM_ROUNDS](#variable-pbkdf2_num_rounds) | [specOpNoSendActions](#variable-specopnosendactions) |
|
|
22261
|
+
| [ARGON2ID_DEFAULT_HASH_LENGTH](#variable-argon2id_default_hash_length) | [ProvenTxReqNonTerminalStatus](#variable-proventxreqnonterminalstatus) | [specOpSetWalletChangeParams](#variable-specopsetwalletchangeparams) |
|
|
22262
|
+
| [ARGON2ID_DEFAULT_ITERATIONS](#variable-argon2id_default_iterations) | [ProvenTxReqTerminalStatus](#variable-proventxreqterminalstatus) | [specOpThrowReviewActions](#variable-specopthrowreviewactions) |
|
|
22263
|
+
| [ARGON2ID_DEFAULT_MEMORY_KIB](#variable-argon2id_default_memory_kib) | [TESTNET_DEFAULT_SETTINGS](#variable-testnet_default_settings) | [specOpWalletBalance](#variable-specopwalletbalance) |
|
|
22264
|
+
| [ARGON2ID_DEFAULT_PARALLELISM](#variable-argon2id_default_parallelism) | [aggregateActionResults](#variable-aggregateactionresults) | [specOpWalletManagedUtxos](#variable-specopwalletmanagedutxos) |
|
|
22265
|
+
| [ARGON2ID_MAX_ITERATIONS](#variable-argon2id_max_iterations) | [brc29ProtocolID](#variable-brc29protocolid) | [transactionColumnsWithoutRawTx](#variable-transactioncolumnswithoutrawtx) |
|
|
22266
|
+
| [ARGON2ID_MAX_MEMORY_KIB](#variable-argon2id_max_memory_kib) | [dirtyHashes](#variable-dirtyhashes) | [transformVerifiableCertificatesWithTrust](#variable-transformverifiablecertificateswithtrust) |
|
|
22267
|
+
| [ARGON2ID_MAX_PARALLELISM](#variable-argon2id_max_parallelism) | [getLabelToSpecOp](#variable-getlabeltospecop) | [validBulkHeaderFiles](#variable-validbulkheaderfiles) |
|
|
22268
|
+
| [BINARY_ENCODING](#variable-binary_encoding) | [logger](#variable-logger) | |
|
|
22269
|
+
|
|
22270
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22271
|
+
|
|
22272
|
+
---
|
|
22273
|
+
|
|
22274
|
+
##### Variable: ACTION_BATCH_HARD_LIFETIME_MS
|
|
22275
|
+
|
|
22276
|
+
```ts
|
|
22277
|
+
ACTION_BATCH_HARD_LIFETIME_MS = 60 * 60 * 1000
|
|
22278
|
+
```
|
|
22279
|
+
|
|
22280
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22281
|
+
|
|
22282
|
+
---
|
|
22283
|
+
##### Variable: ACTION_BATCH_LEASE_MS
|
|
22284
|
+
|
|
22285
|
+
```ts
|
|
22286
|
+
ACTION_BATCH_LEASE_MS = 15 * 60 * 1000
|
|
22287
|
+
```
|
|
22288
|
+
|
|
22289
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22290
|
+
|
|
22291
|
+
---
|
|
22292
|
+
##### Variable: ACTION_BATCH_MAX_BLOB_BYTES
|
|
22293
|
+
|
|
22294
|
+
```ts
|
|
22295
|
+
ACTION_BATCH_MAX_BLOB_BYTES = 8 * 1024 * 1024
|
|
22296
|
+
```
|
|
22297
|
+
|
|
22298
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22299
|
+
|
|
22300
|
+
---
|
|
22301
|
+
##### Variable: ACTION_BATCH_MAX_CHUNKS_PER_BLOB
|
|
22302
|
+
|
|
22303
|
+
```ts
|
|
22304
|
+
ACTION_BATCH_MAX_CHUNKS_PER_BLOB = 64
|
|
22305
|
+
```
|
|
22306
|
+
|
|
22307
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22308
|
+
|
|
22309
|
+
---
|
|
22310
|
+
##### Variable: ACTION_BATCH_MAX_CONCURRENT_UPLOADS
|
|
22311
|
+
|
|
22312
|
+
```ts
|
|
22313
|
+
ACTION_BATCH_MAX_CONCURRENT_UPLOADS = 4
|
|
22314
|
+
```
|
|
22315
|
+
|
|
22316
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22317
|
+
|
|
22318
|
+
---
|
|
22319
|
+
##### Variable: ACTION_BATCH_MAX_INLINE_BYTES
|
|
22320
|
+
|
|
22321
|
+
```ts
|
|
22322
|
+
ACTION_BATCH_MAX_INLINE_BYTES = 4 * 1024 * 1024
|
|
22323
|
+
```
|
|
21456
22324
|
|
|
21457
22325
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21458
22326
|
|
|
21459
22327
|
---
|
|
22328
|
+
##### Variable: ACTION_BATCH_MAX_LOGICAL_BLOB_BYTES
|
|
22329
|
+
|
|
22330
|
+
```ts
|
|
22331
|
+
ACTION_BATCH_MAX_LOGICAL_BLOB_BYTES = 64 * 1024 * 1024
|
|
22332
|
+
```
|
|
22333
|
+
|
|
22334
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22335
|
+
|
|
22336
|
+
---
|
|
22337
|
+
##### Variable: ACTION_BATCH_MAX_RESERVATION_EXTENSION_OUTPUTS
|
|
22338
|
+
|
|
22339
|
+
```ts
|
|
22340
|
+
ACTION_BATCH_MAX_RESERVATION_EXTENSION_OUTPUTS = 64
|
|
22341
|
+
```
|
|
22342
|
+
|
|
22343
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21460
22344
|
|
|
22345
|
+
---
|
|
21461
22346
|
##### Variable: ARCADE_POST_BEEF_CONCURRENCY
|
|
21462
22347
|
|
|
21463
22348
|
```ts
|
|
@@ -21502,6 +22387,33 @@ ARGON2ID_DEFAULT_PARALLELISM = 1
|
|
|
21502
22387
|
|
|
21503
22388
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21504
22389
|
|
|
22390
|
+
---
|
|
22391
|
+
##### Variable: ARGON2ID_MAX_ITERATIONS
|
|
22392
|
+
|
|
22393
|
+
```ts
|
|
22394
|
+
ARGON2ID_MAX_ITERATIONS = 20
|
|
22395
|
+
```
|
|
22396
|
+
|
|
22397
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22398
|
+
|
|
22399
|
+
---
|
|
22400
|
+
##### Variable: ARGON2ID_MAX_MEMORY_KIB
|
|
22401
|
+
|
|
22402
|
+
```ts
|
|
22403
|
+
ARGON2ID_MAX_MEMORY_KIB = 262144
|
|
22404
|
+
```
|
|
22405
|
+
|
|
22406
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22407
|
+
|
|
22408
|
+
---
|
|
22409
|
+
##### Variable: ARGON2ID_MAX_PARALLELISM
|
|
22410
|
+
|
|
22411
|
+
```ts
|
|
22412
|
+
ARGON2ID_MAX_PARALLELISM = 16
|
|
22413
|
+
```
|
|
22414
|
+
|
|
22415
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22416
|
+
|
|
21505
22417
|
---
|
|
21506
22418
|
##### Variable: BINARY_ENCODING
|
|
21507
22419
|
|
|
@@ -21571,6 +22483,24 @@ See also: [WalletSettings](./client.md#interface-walletsettings)
|
|
|
21571
22483
|
|
|
21572
22484
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21573
22485
|
|
|
22486
|
+
---
|
|
22487
|
+
##### Variable: KDF_MAX_HASH_LENGTH
|
|
22488
|
+
|
|
22489
|
+
```ts
|
|
22490
|
+
KDF_MAX_HASH_LENGTH = 64
|
|
22491
|
+
```
|
|
22492
|
+
|
|
22493
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22494
|
+
|
|
22495
|
+
---
|
|
22496
|
+
##### Variable: MAX_STATE_SNAPSHOT_BYTES
|
|
22497
|
+
|
|
22498
|
+
```ts
|
|
22499
|
+
MAX_STATE_SNAPSHOT_BYTES = 16 * 1024 * 1024
|
|
22500
|
+
```
|
|
22501
|
+
|
|
22502
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22503
|
+
|
|
21574
22504
|
---
|
|
21575
22505
|
##### Variable: MAX_STORAGE_COMMISSION_SATOSHIS
|
|
21576
22506
|
|
|
@@ -21580,6 +22510,15 @@ MAX_STORAGE_COMMISSION_SATOSHIS = 500000
|
|
|
21580
22510
|
|
|
21581
22511
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
21582
22512
|
|
|
22513
|
+
---
|
|
22514
|
+
##### Variable: PBKDF2_MAX_ITERATIONS
|
|
22515
|
+
|
|
22516
|
+
```ts
|
|
22517
|
+
PBKDF2_MAX_ITERATIONS = 10000000
|
|
22518
|
+
```
|
|
22519
|
+
|
|
22520
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
22521
|
+
|
|
21583
22522
|
---
|
|
21584
22523
|
##### Variable: PBKDF2_NUM_ROUNDS
|
|
21585
22524
|
|