@bsv/wallet-toolbox 2.0.0-beta.1 → 2.0.0
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 +21 -0
- package/docs/README.md +1 -0
- package/docs/client.md +409 -267
- package/docs/services.md +15 -3
- package/docs/storage.md +48 -88
- package/docs/wab-shamir.md +311 -0
- package/docs/wallet.md +409 -267
- package/out/src/ShamirWalletManager.d.ts +213 -0
- package/out/src/ShamirWalletManager.d.ts.map +1 -0
- package/out/src/ShamirWalletManager.js +363 -0
- package/out/src/ShamirWalletManager.js.map +1 -0
- package/out/src/Wallet.d.ts +1 -1
- package/out/src/Wallet.d.ts.map +1 -1
- package/out/src/Wallet.js +23 -7
- package/out/src/Wallet.js.map +1 -1
- package/out/src/WalletPermissionsManager.d.ts +84 -1
- package/out/src/WalletPermissionsManager.d.ts.map +1 -1
- package/out/src/WalletPermissionsManager.js +1045 -214
- package/out/src/WalletPermissionsManager.js.map +1 -1
- package/out/src/__tests/ShamirWalletManager.test.d.ts +2 -0
- package/out/src/__tests/ShamirWalletManager.test.d.ts.map +1 -0
- package/out/src/__tests/ShamirWalletManager.test.js +298 -0
- package/out/src/__tests/ShamirWalletManager.test.js.map +1 -0
- package/out/src/__tests/WalletPermissionsManager.callbacks.test.js +134 -0
- package/out/src/__tests/WalletPermissionsManager.callbacks.test.js.map +1 -1
- package/out/src/__tests/WalletPermissionsManager.fixtures.d.ts.map +1 -1
- package/out/src/__tests/WalletPermissionsManager.fixtures.js +9 -0
- package/out/src/__tests/WalletPermissionsManager.fixtures.js.map +1 -1
- package/out/src/__tests/WalletPermissionsManager.flows.test.js +121 -0
- package/out/src/__tests/WalletPermissionsManager.flows.test.js.map +1 -1
- package/out/src/__tests/WalletPermissionsManager.pmodules.test.js +111 -0
- package/out/src/__tests/WalletPermissionsManager.pmodules.test.js.map +1 -1
- package/out/src/entropy/EntropyCollector.d.ts +89 -0
- package/out/src/entropy/EntropyCollector.d.ts.map +1 -0
- package/out/src/entropy/EntropyCollector.js +176 -0
- package/out/src/entropy/EntropyCollector.js.map +1 -0
- package/out/src/entropy/__tests/EntropyCollector.test.d.ts +2 -0
- package/out/src/entropy/__tests/EntropyCollector.test.d.ts.map +1 -0
- package/out/src/entropy/__tests/EntropyCollector.test.js +137 -0
- package/out/src/entropy/__tests/EntropyCollector.test.js.map +1 -0
- package/out/src/index.all.d.ts +2 -0
- package/out/src/index.all.d.ts.map +1 -1
- package/out/src/index.all.js +2 -0
- package/out/src/index.all.js.map +1 -1
- package/out/src/sdk/WalletServices.interfaces.d.ts.map +1 -1
- package/out/src/sdk/WalletStorage.interfaces.d.ts +3 -3
- package/out/src/sdk/WalletStorage.interfaces.d.ts.map +1 -1
- package/out/src/services/__tests/getRawTx.test.js +3 -0
- package/out/src/services/__tests/getRawTx.test.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Ingest/BulkIngestorWhatsOnChainCdn.d.ts +1 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageBase.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageBase.js +4 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageBase.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/__tests/Chaintracks.test.js +3 -1
- package/out/src/services/chaintracker/chaintracks/__tests/Chaintracks.test.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/blockHeaderUtilities.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/blockHeaderUtilities.js +1 -2
- package/out/src/services/chaintracker/chaintracks/util/blockHeaderUtilities.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/validBulkHeaderFilesByFileHash.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/util/validBulkHeaderFilesByFileHash.js +12 -0
- package/out/src/services/chaintracker/chaintracks/util/validBulkHeaderFilesByFileHash.js.map +1 -1
- package/out/src/storage/StorageProvider.d.ts +16 -2
- package/out/src/storage/StorageProvider.d.ts.map +1 -1
- package/out/src/storage/StorageProvider.js +33 -4
- package/out/src/storage/StorageProvider.js.map +1 -1
- package/out/src/storage/methods/ListOutputsSpecOp.d.ts +15 -1
- package/out/src/storage/methods/ListOutputsSpecOp.d.ts.map +1 -1
- package/out/src/storage/methods/ListOutputsSpecOp.js +52 -2
- package/out/src/storage/methods/ListOutputsSpecOp.js.map +1 -1
- package/out/src/storage/methods/__test/offsetKey.test.js +266 -100
- package/out/src/storage/methods/__test/offsetKey.test.js.map +1 -1
- package/out/src/storage/methods/getBeefForTransaction.js +1 -1
- package/out/src/storage/methods/getBeefForTransaction.js.map +1 -1
- package/out/src/storage/methods/internalizeAction.d.ts.map +1 -1
- package/out/src/storage/methods/internalizeAction.js +2 -2
- package/out/src/storage/methods/internalizeAction.js.map +1 -1
- package/out/src/storage/methods/listOutputsIdb.d.ts.map +1 -1
- package/out/src/storage/methods/listOutputsIdb.js +10 -17
- package/out/src/storage/methods/listOutputsIdb.js.map +1 -1
- package/out/src/storage/methods/listOutputsKnex.d.ts.map +1 -1
- package/out/src/storage/methods/listOutputsKnex.js +44 -26
- package/out/src/storage/methods/listOutputsKnex.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/ProvenTxTests.test.js +4 -0
- package/out/src/storage/schema/entities/__tests/ProvenTxTests.test.js.map +1 -1
- package/out/src/wab-client/WABClient.d.ts +65 -0
- package/out/src/wab-client/WABClient.d.ts.map +1 -1
- package/out/src/wab-client/WABClient.js +107 -0
- package/out/src/wab-client/WABClient.js.map +1 -1
- package/package.json +8 -4
- package/out/src/sdk/validationHelpers.d.ts +0 -303
- package/out/src/sdk/validationHelpers.d.ts.map +0 -1
- package/out/src/sdk/validationHelpers.js +0 -632
- package/out/src/sdk/validationHelpers.js.map +0 -1
- package/out/src/utility/ReaderUint8Array.d.ts +0 -28
- package/out/src/utility/ReaderUint8Array.d.ts.map +0 -1
- package/out/src/utility/ReaderUint8Array.js +0 -166
- package/out/src/utility/ReaderUint8Array.js.map +0 -1
package/docs/client.md
CHANGED
|
@@ -14,52 +14,54 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
14
14
|
|
|
15
15
|
| | | |
|
|
16
16
|
| --- | --- | --- |
|
|
17
|
-
| [AdminStatsResult](#interface-adminstatsresult) | [
|
|
18
|
-
| [ArcConfig](#interface-arcconfig) | [
|
|
19
|
-
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [
|
|
20
|
-
| [AuthId](#interface-authid) | [
|
|
21
|
-
| [AuthPayload](#interface-authpayload) | [
|
|
22
|
-
| [BaseBlockHeader](#interface-baseblockheader) | [
|
|
23
|
-
| [BitailsConfig](#interface-bitailsconfig) | [
|
|
24
|
-
| [BitailsMerkleProof](#interface-bitailsmerkleproof) | [
|
|
25
|
-
| [BlockHeader](#interface-blockheader) | [
|
|
26
|
-
| [BsvExchangeRate](#interface-bsvexchangerate) | [
|
|
27
|
-
| [BulkFileDataManagerMergeResult](#interface-bulkfiledatamanagermergeresult) | [
|
|
28
|
-
| [BulkFileDataManagerOptions](#interface-bulkfiledatamanageroptions) | [
|
|
29
|
-
| [BulkHeaderFileInfo](#interface-bulkheaderfileinfo) | [
|
|
30
|
-
| [BulkHeaderFilesInfo](#interface-bulkheaderfilesinfo) | [
|
|
31
|
-
| [BulkIngestorApi](#interface-bulkingestorapi) | [
|
|
32
|
-
| [BulkIngestorBaseOptions](#interface-bulkingestorbaseoptions) | [
|
|
33
|
-
| [BulkIngestorCDNOptions](#interface-bulkingestorcdnoptions) | [
|
|
34
|
-
| [BulkIngestorWhatsOnChainOptions](#interface-bulkingestorwhatsonchainoptions) | [
|
|
35
|
-
| [BulkStorageApi](#interface-bulkstorageapi) | [
|
|
36
|
-
| [BulkStorageBaseOptions](#interface-bulkstoragebaseoptions) | [
|
|
37
|
-
| [BulkSyncResult](#interface-bulksyncresult) | [
|
|
38
|
-
| [CertOpsWallet](#interface-certopswallet) | [
|
|
39
|
-
| [Certifier](#interface-certifier) | [
|
|
40
|
-
| [ChaintracksApi](#interface-chaintracksapi) | [
|
|
41
|
-
| [ChaintracksAppendableFileApi](#interface-chaintracksappendablefileapi) | [
|
|
42
|
-
| [ChaintracksChainTrackerOptions](#interface-chaintrackschaintrackeroptions) | [
|
|
43
|
-
| [ChaintracksClientApi](#interface-chaintracksclientapi) | [
|
|
44
|
-
| [ChaintracksFetchApi](#interface-chaintracksfetchapi) | [
|
|
45
|
-
| [ChaintracksFsApi](#interface-chaintracksfsapi) | [
|
|
46
|
-
| [ChaintracksInfoApi](#interface-chaintracksinfoapi) | [
|
|
47
|
-
| [ChaintracksManagementApi](#interface-chaintracksmanagementapi) | [
|
|
48
|
-
| [ChaintracksOptions](#interface-chaintracksoptions) | [
|
|
49
|
-
| [ChaintracksPackageInfoApi](#interface-chaintrackspackageinfoapi) | [
|
|
50
|
-
| [ChaintracksReadableFileApi](#interface-chaintracksreadablefileapi) | [
|
|
51
|
-
| [ChaintracksServiceClientOptions](#interface-chaintracksserviceclientoptions) | [
|
|
52
|
-
| [ChaintracksStorageApi](#interface-chaintracksstorageapi) | [
|
|
53
|
-
| [ChaintracksStorageBaseOptions](#interface-chaintracksstoragebaseoptions) | [
|
|
54
|
-
| [ChaintracksStorageBulkFileApi](#interface-chaintracksstoragebulkfileapi) | [
|
|
55
|
-
| [ChaintracksStorageIdbOptions](#interface-chaintracksstorageidboptions) | [
|
|
56
|
-
| [ChaintracksStorageIdbSchema](#interface-chaintracksstorageidbschema) | [
|
|
57
|
-
| [ChaintracksStorageIngestApi](#interface-chaintracksstorageingestapi) | [
|
|
58
|
-
| [ChaintracksStorageNoDbOptions](#interface-chaintracksstoragenodboptions) | [
|
|
59
|
-
| [ChaintracksStorageQueryApi](#interface-chaintracksstoragequeryapi) | [
|
|
60
|
-
| [ChaintracksWritableFileApi](#interface-chaintrackswritablefileapi) | [
|
|
61
|
-
| [CommitNewTxResults](#interface-commitnewtxresults) | [
|
|
62
|
-
| [CompleteAuthResponse](#interface-completeauthresponse) | [
|
|
17
|
+
| [AdminStatsResult](#interface-adminstatsresult) | [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [StatusForTxidResult](#interface-statusfortxidresult) |
|
|
18
|
+
| [ArcConfig](#interface-arcconfig) | [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [StorageAdminStats](#interface-storageadminstats) |
|
|
19
|
+
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [StorageCreateActionResult](#interface-storagecreateactionresult) |
|
|
20
|
+
| [AuthId](#interface-authid) | [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) |
|
|
21
|
+
| [AuthPayload](#interface-authpayload) | [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) |
|
|
22
|
+
| [BaseBlockHeader](#interface-baseblockheader) | [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [StorageFeeModel](#interface-storagefeemodel) |
|
|
23
|
+
| [BitailsConfig](#interface-bitailsconfig) | [GetHeaderByteFileLinksResult](#interface-getheaderbytefilelinksresult) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) |
|
|
24
|
+
| [BitailsMerkleProof](#interface-bitailsmerkleproof) | [GetMerklePathResult](#interface-getmerklepathresult) | [StorageIdbOptions](#interface-storageidboptions) |
|
|
25
|
+
| [BlockHeader](#interface-blockheader) | [GetRawTxResult](#interface-getrawtxresult) | [StorageIdbSchema](#interface-storageidbschema) |
|
|
26
|
+
| [BsvExchangeRate](#interface-bsvexchangerate) | [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [StorageIdentity](#interface-storageidentity) |
|
|
27
|
+
| [BulkFileDataManagerMergeResult](#interface-bulkfiledatamanagermergeresult) | [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) |
|
|
28
|
+
| [BulkFileDataManagerOptions](#interface-bulkfiledatamanageroptions) | [GetScriptHashHistory](#interface-getscripthashhistory) | [StorageProcessActionArgs](#interface-storageprocessactionargs) |
|
|
29
|
+
| [BulkHeaderFileInfo](#interface-bulkheaderfileinfo) | [GetScriptHashHistoryResult](#interface-getscripthashhistoryresult) | [StorageProcessActionResults](#interface-storageprocessactionresults) |
|
|
30
|
+
| [BulkHeaderFilesInfo](#interface-bulkheaderfilesinfo) | [GetStatusForTxidsResult](#interface-getstatusfortxidsresult) | [StorageProvenOrReq](#interface-storageprovenorreq) |
|
|
31
|
+
| [BulkIngestorApi](#interface-bulkingestorapi) | [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [StorageProviderOptions](#interface-storageprovideroptions) |
|
|
32
|
+
| [BulkIngestorBaseOptions](#interface-bulkingestorbaseoptions) | [GetUtxoStatusResult](#interface-getutxostatusresult) | [StorageReaderOptions](#interface-storagereaderoptions) |
|
|
33
|
+
| [BulkIngestorCDNOptions](#interface-bulkingestorcdnoptions) | [GroupedPermissionRequest](#interface-groupedpermissionrequest) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) |
|
|
34
|
+
| [BulkIngestorWhatsOnChainOptions](#interface-bulkingestorwhatsonchainoptions) | [GroupedPermissions](#interface-groupedpermissions) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) |
|
|
35
|
+
| [BulkStorageApi](#interface-bulkstorageapi) | [HeightRangeApi](#interface-heightrangeapi) | [SyncChunk](#interface-syncchunk) |
|
|
36
|
+
| [BulkStorageBaseOptions](#interface-bulkstoragebaseoptions) | [HeightRanges](#interface-heightranges) | [SyncError](#interface-syncerror) |
|
|
37
|
+
| [BulkSyncResult](#interface-bulksyncresult) | [KeyPair](#interface-keypair) | [SyncMap](#interface-syncmap) |
|
|
38
|
+
| [CertOpsWallet](#interface-certopswallet) | [KeyPairAddress](#interface-keypairaddress) | [TableCertificate](#interface-tablecertificate) |
|
|
39
|
+
| [Certifier](#interface-certifier) | [ListActionsSpecOp](#interface-listactionsspecop) | [TableCertificateField](#interface-tablecertificatefield) |
|
|
40
|
+
| [ChaintracksApi](#interface-chaintracksapi) | [ListOutputsSpecOp](#interface-listoutputsspecop) | [TableCertificateX](#interface-tablecertificatex) |
|
|
41
|
+
| [ChaintracksAppendableFileApi](#interface-chaintracksappendablefileapi) | [LiveBlockHeader](#interface-liveblockheader) | [TableCommission](#interface-tablecommission) |
|
|
42
|
+
| [ChaintracksChainTrackerOptions](#interface-chaintrackschaintrackeroptions) | [LiveIngestorApi](#interface-liveingestorapi) | [TableMonitorEvent](#interface-tablemonitorevent) |
|
|
43
|
+
| [ChaintracksClientApi](#interface-chaintracksclientapi) | [LiveIngestorBaseOptions](#interface-liveingestorbaseoptions) | [TableOutput](#interface-tableoutput) |
|
|
44
|
+
| [ChaintracksFetchApi](#interface-chaintracksfetchapi) | [LiveIngestorWhatsOnChainOptions](#interface-liveingestorwhatsonchainoptions) | [TableOutputBasket](#interface-tableoutputbasket) |
|
|
45
|
+
| [ChaintracksFsApi](#interface-chaintracksfsapi) | [MonitorOptions](#interface-monitoroptions) | [TableOutputTag](#interface-tableoutputtag) |
|
|
46
|
+
| [ChaintracksInfoApi](#interface-chaintracksinfoapi) | [OutPoint](#interface-outpoint) | [TableOutputTagMap](#interface-tableoutputtagmap) |
|
|
47
|
+
| [ChaintracksManagementApi](#interface-chaintracksmanagementapi) | [Paged](#interface-paged) | [TableOutputX](#interface-tableoutputx) |
|
|
48
|
+
| [ChaintracksOptions](#interface-chaintracksoptions) | [PendingSignAction](#interface-pendingsignaction) | [TableProvenTx](#interface-tableproventx) |
|
|
49
|
+
| [ChaintracksPackageInfoApi](#interface-chaintrackspackageinfoapi) | [PendingStorageInput](#interface-pendingstorageinput) | [TableProvenTxReq](#interface-tableproventxreq) |
|
|
50
|
+
| [ChaintracksReadableFileApi](#interface-chaintracksreadablefileapi) | [PermissionRequest](#interface-permissionrequest) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) |
|
|
51
|
+
| [ChaintracksServiceClientOptions](#interface-chaintracksserviceclientoptions) | [PermissionToken](#interface-permissiontoken) | [TableSettings](#interface-tablesettings) |
|
|
52
|
+
| [ChaintracksStorageApi](#interface-chaintracksstorageapi) | [PermissionsManagerConfig](#interface-permissionsmanagerconfig) | [TableSyncState](#interface-tablesyncstate) |
|
|
53
|
+
| [ChaintracksStorageBaseOptions](#interface-chaintracksstoragebaseoptions) | [PermissionsModule](#interface-permissionsmodule) | [TableTransaction](#interface-tabletransaction) |
|
|
54
|
+
| [ChaintracksStorageBulkFileApi](#interface-chaintracksstoragebulkfileapi) | [PostBeefResult](#interface-postbeefresult) | [TableTxLabel](#interface-tabletxlabel) |
|
|
55
|
+
| [ChaintracksStorageIdbOptions](#interface-chaintracksstorageidboptions) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [TableTxLabelMap](#interface-tabletxlabelmap) |
|
|
56
|
+
| [ChaintracksStorageIdbSchema](#interface-chaintracksstorageidbschema) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [TableUser](#interface-tableuser) |
|
|
57
|
+
| [ChaintracksStorageIngestApi](#interface-chaintracksstorageingestapi) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [TaskPurgeParams](#interface-taskpurgeparams) |
|
|
58
|
+
| [ChaintracksStorageNoDbOptions](#interface-chaintracksstoragenodboptions) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [TrustSettings](#interface-trustsettings) |
|
|
59
|
+
| [ChaintracksStorageQueryApi](#interface-chaintracksstoragequeryapi) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [TrxToken](#interface-trxtoken) |
|
|
60
|
+
| [ChaintracksWritableFileApi](#interface-chaintrackswritablefileapi) | [PostTxsResult](#interface-posttxsresult) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
|
|
61
|
+
| [CommitNewTxResults](#interface-commitnewtxresults) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [TxScriptOffsets](#interface-txscriptoffsets) |
|
|
62
|
+
| [CompleteAuthResponse](#interface-completeauthresponse) | [Profile](#interface-profile) | [UMPToken](#interface-umptoken) |
|
|
63
|
+
| [CounterpartyPermissionRequest](#interface-counterpartypermissionrequest) | [ProvenOrRawTx](#interface-provenorrawtx) | [UMPTokenInteractor](#interface-umptokeninteractor) |
|
|
64
|
+
| [CounterpartyPermissions](#interface-counterpartypermissions) | [ProvenTransactionStatus](#interface-proventransactionstatus) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
|
|
63
65
|
| [CreateActionResultX](#interface-createactionresultx) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
|
|
64
66
|
| [DeactivedHeader](#interface-deactivedheader) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
|
|
65
67
|
| [EntitySyncMap](#interface-entitysyncmap) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [VerifyAndRepairBeefResult](#interface-verifyandrepairbeefresult) |
|
|
@@ -86,8 +88,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
86
88
|
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [SetupWalletIdbArgs](#interface-setupwalletidbargs) | [WocGetHeadersHeader](#interface-wocgetheadersheader) |
|
|
87
89
|
| [FindUsersArgs](#interface-findusersargs) | [SignActionResultX](#interface-signactionresultx) | [WocHeader](#interface-wocheader) |
|
|
88
90
|
| [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StartAuthResponse](#interface-startauthresponse) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
|
|
89
|
-
| [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [StatusForTxidResult](#interface-statusfortxidresult) | |
|
|
90
|
-
| [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [StorageAdminStats](#interface-storageadminstats) | |
|
|
91
91
|
|
|
92
92
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
93
93
|
|
|
@@ -814,7 +814,7 @@ enableCache: boolean
|
|
|
814
814
|
|
|
815
815
|
###### Property idleWait
|
|
816
816
|
|
|
817
|
-
Maximum
|
|
817
|
+
Maximum msecs of "normal" pause with no new data arriving.
|
|
818
818
|
|
|
819
819
|
```ts
|
|
820
820
|
idleWait: number | undefined
|
|
@@ -2315,6 +2315,38 @@ export interface CompleteAuthResponse {
|
|
|
2315
2315
|
|
|
2316
2316
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2317
2317
|
|
|
2318
|
+
---
|
|
2319
|
+
##### Interface: CounterpartyPermissionRequest
|
|
2320
|
+
|
|
2321
|
+
```ts
|
|
2322
|
+
export interface CounterpartyPermissionRequest {
|
|
2323
|
+
originator: string;
|
|
2324
|
+
requestID: string;
|
|
2325
|
+
counterparty: PubKeyHex;
|
|
2326
|
+
counterpartyLabel?: string;
|
|
2327
|
+
permissions: CounterpartyPermissions;
|
|
2328
|
+
}
|
|
2329
|
+
```
|
|
2330
|
+
|
|
2331
|
+
See also: [CounterpartyPermissions](./client.md#interface-counterpartypermissions)
|
|
2332
|
+
|
|
2333
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2334
|
+
|
|
2335
|
+
---
|
|
2336
|
+
##### Interface: CounterpartyPermissions
|
|
2337
|
+
|
|
2338
|
+
```ts
|
|
2339
|
+
export interface CounterpartyPermissions {
|
|
2340
|
+
description?: string;
|
|
2341
|
+
protocols: Array<{
|
|
2342
|
+
protocolID: WalletProtocol;
|
|
2343
|
+
description: string;
|
|
2344
|
+
}>;
|
|
2345
|
+
}
|
|
2346
|
+
```
|
|
2347
|
+
|
|
2348
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2349
|
+
|
|
2318
2350
|
---
|
|
2319
2351
|
##### Interface: CreateActionResultX
|
|
2320
2352
|
|
|
@@ -3372,6 +3404,7 @@ export interface ListOutputsSpecOp {
|
|
|
3372
3404
|
ignoreLimit?: boolean;
|
|
3373
3405
|
includeOutputScripts?: boolean;
|
|
3374
3406
|
includeSpent?: boolean;
|
|
3407
|
+
totalOutputsIsSumOfSatoshis?: boolean;
|
|
3375
3408
|
resultFromTags?: (s: StorageProvider, auth: AuthId, vargs: Validation.ValidListOutputsArgs, specOpTags: string[]) => Promise<ListOutputsResult>;
|
|
3376
3409
|
resultFromOutputs?: (s: StorageProvider, auth: AuthId, vargs: Validation.ValidListOutputsArgs, specOpTags: string[], outputs: TableOutput[]) => Promise<ListOutputsResult>;
|
|
3377
3410
|
filterOutputs?: (s: StorageProvider, auth: AuthId, vargs: Validation.ValidListOutputsArgs, specOpTags: string[], outputs: TableOutput[]) => Promise<TableOutput[]>;
|
|
@@ -3400,6 +3433,14 @@ or an explicit array of tags to intercept.
|
|
|
3400
3433
|
tagsToIntercept?: string[]
|
|
3401
3434
|
```
|
|
3402
3435
|
|
|
3436
|
+
###### Property totalOutputsIsSumOfSatoshis
|
|
3437
|
+
|
|
3438
|
+
If true, and supported by storage, maximum performance optimization, computing balance done in the query itself.
|
|
3439
|
+
|
|
3440
|
+
```ts
|
|
3441
|
+
totalOutputsIsSumOfSatoshis?: boolean
|
|
3442
|
+
```
|
|
3443
|
+
|
|
3403
3444
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3404
3445
|
|
|
3405
3446
|
---
|
|
@@ -3977,6 +4018,9 @@ export interface PermissionsManagerConfig {
|
|
|
3977
4018
|
seekSpendingPermissions?: boolean;
|
|
3978
4019
|
seekGroupedPermission?: boolean;
|
|
3979
4020
|
differentiatePrivilegedOperations?: boolean;
|
|
4021
|
+
whitelistedCounterparties?: {
|
|
4022
|
+
[counterparty: PubKeyHex]: string[];
|
|
4023
|
+
};
|
|
3980
4024
|
}
|
|
3981
4025
|
```
|
|
3982
4026
|
|
|
@@ -4173,6 +4217,18 @@ do we seek spending authorization?
|
|
|
4173
4217
|
seekSpendingPermissions?: boolean
|
|
4174
4218
|
```
|
|
4175
4219
|
|
|
4220
|
+
###### Property whitelistedCounterparties
|
|
4221
|
+
|
|
4222
|
+
An allowlist mapping counterparty identity public keys (hex)
|
|
4223
|
+
to protocol names that are automatically permitted
|
|
4224
|
+
without prompting the user.
|
|
4225
|
+
|
|
4226
|
+
```ts
|
|
4227
|
+
whitelistedCounterparties?: {
|
|
4228
|
+
[counterparty: PubKeyHex]: string[];
|
|
4229
|
+
}
|
|
4230
|
+
```
|
|
4231
|
+
|
|
4176
4232
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4177
4233
|
|
|
4178
4234
|
---
|
|
@@ -4530,7 +4586,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4530
4586
|
export interface ProvenOrRawTx {
|
|
4531
4587
|
proven?: TableProvenTx;
|
|
4532
4588
|
rawTx?: number[];
|
|
4533
|
-
inputBEEF?:
|
|
4589
|
+
inputBEEF?: BEEF;
|
|
4534
4590
|
}
|
|
4535
4591
|
```
|
|
4536
4592
|
|
|
@@ -4950,7 +5006,7 @@ export interface ReviewActionResult {
|
|
|
4950
5006
|
txid: TXIDHexString;
|
|
4951
5007
|
status: ReviewActionResultStatus;
|
|
4952
5008
|
competingTxs?: string[];
|
|
4953
|
-
competingBeef?:
|
|
5009
|
+
competingBeef?: BEEF;
|
|
4954
5010
|
}
|
|
4955
5011
|
```
|
|
4956
5012
|
|
|
@@ -4961,7 +5017,7 @@ See also: [ReviewActionResultStatus](./client.md#type-reviewactionresultstatus)
|
|
|
4961
5017
|
Merged beef of competingTxs, valid when status is 'doubleSpend'.
|
|
4962
5018
|
|
|
4963
5019
|
```ts
|
|
4964
|
-
competingBeef?:
|
|
5020
|
+
competingBeef?: BEEF
|
|
4965
5021
|
```
|
|
4966
5022
|
|
|
4967
5023
|
###### Property competingTxs
|
|
@@ -7231,10 +7287,11 @@ export interface WalletPermissionsManagerCallbacks {
|
|
|
7231
7287
|
onCertificateAccessRequested?: PermissionEventHandler[];
|
|
7232
7288
|
onSpendingAuthorizationRequested?: PermissionEventHandler[];
|
|
7233
7289
|
onGroupedPermissionRequested?: GroupedPermissionEventHandler[];
|
|
7290
|
+
onCounterpartyPermissionRequested?: CounterpartyPermissionEventHandler[];
|
|
7234
7291
|
}
|
|
7235
7292
|
```
|
|
7236
7293
|
|
|
7237
|
-
See also: [GroupedPermissionEventHandler](./client.md#type-groupedpermissioneventhandler), [PermissionEventHandler](./client.md#type-permissioneventhandler)
|
|
7294
|
+
See also: [CounterpartyPermissionEventHandler](./client.md#type-counterpartypermissioneventhandler), [GroupedPermissionEventHandler](./client.md#type-groupedpermissioneventhandler), [PermissionEventHandler](./client.md#type-permissioneventhandler)
|
|
7238
7295
|
|
|
7239
7296
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7240
7297
|
|
|
@@ -8146,41 +8203,41 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
8146
8203
|
|
|
8147
8204
|
| | | |
|
|
8148
8205
|
| --- | --- | --- |
|
|
8149
|
-
| [ARC](#class-arc) | [EntityProvenTx](#class-entityproventx) | [
|
|
8150
|
-
| [AuthMethodInteractor](#class-authmethodinteractor) | [EntityProvenTxReq](#class-entityproventxreq) | [
|
|
8151
|
-
| [BHServiceClient](#class-bhserviceclient) | [EntitySyncState](#class-entitysyncstate) | [
|
|
8152
|
-
| [Bitails](#class-bitails) | [EntityTransaction](#class-entitytransaction) | [
|
|
8153
|
-
| [BulkFileDataManager](#class-bulkfiledatamanager) | [EntityTxLabel](#class-entitytxlabel) | [
|
|
8154
|
-
| [BulkFileDataReader](#class-bulkfiledatareader) | [EntityTxLabelMap](#class-entitytxlabelmap) | [
|
|
8155
|
-
| [BulkFilesReader](#class-bulkfilesreader) | [EntityUser](#class-entityuser) | [
|
|
8156
|
-
| [BulkFilesReaderFs](#class-bulkfilesreaderfs) | [HeightRange](#class-heightrange) | [
|
|
8157
|
-
| [BulkFilesReaderStorage](#class-bulkfilesreaderstorage) | [LiveIngestorBase](#class-liveingestorbase) | [
|
|
8158
|
-
| [BulkHeaderFile](#class-bulkheaderfile) | [LiveIngestorWhatsOnChainPoll](#class-liveingestorwhatsonchainpoll) | [
|
|
8159
|
-
| [BulkHeaderFileFs](#class-bulkheaderfilefs) | [MergeEntity](#class-mergeentity) | [
|
|
8160
|
-
| [BulkHeaderFileStorage](#class-bulkheaderfilestorage) | [Monitor](#class-monitor) | [
|
|
8161
|
-
| [BulkHeaderFiles](#class-bulkheaderfiles) | [OverlayUMPTokenInteractor](#class-overlayumptokeninteractor) | [
|
|
8162
|
-
| [BulkIngestorBase](#class-bulkingestorbase) | [PersonaIDInteractor](#class-personaidinteractor) | [
|
|
8163
|
-
| [BulkIngestorCDN](#class-bulkingestorcdn) | [PrivilegedKeyManager](#class-privilegedkeymanager) | [
|
|
8164
|
-
| [BulkIngestorCDNBabbage](#class-bulkingestorcdnbabbage) | [
|
|
8165
|
-
| [BulkIngestorWhatsOnChainCdn](#class-bulkingestorwhatsonchaincdn) | [
|
|
8166
|
-
| [BulkStorageBase](#class-bulkstoragebase) | [
|
|
8167
|
-
| [CWIStyleWalletManager](#class-cwistylewalletmanager) | [
|
|
8168
|
-
| [Chaintracks](#class-chaintracks) | [
|
|
8169
|
-
| [ChaintracksChainTracker](#class-chaintrackschaintracker) | [
|
|
8170
|
-
| [ChaintracksFetch](#class-chaintracksfetch) | [
|
|
8171
|
-
| [ChaintracksServiceClient](#class-chaintracksserviceclient) | [
|
|
8172
|
-
| [ChaintracksStorageBase](#class-chaintracksstoragebase) | [
|
|
8173
|
-
| [ChaintracksStorageIdb](#class-chaintracksstorageidb) | [
|
|
8174
|
-
| [ChaintracksStorageNoDb](#class-chaintracksstoragenodb) | [
|
|
8175
|
-
| [DevConsoleInteractor](#class-devconsoleinteractor) | [
|
|
8176
|
-
| [EntityBase](#class-entitybase) | [
|
|
8177
|
-
| [EntityCertificate](#class-entitycertificate) | [
|
|
8178
|
-
| [EntityCertificateField](#class-entitycertificatefield) | [
|
|
8179
|
-
| [EntityCommission](#class-entitycommission) | [
|
|
8180
|
-
| [EntityOutput](#class-entityoutput) | [
|
|
8181
|
-
| [EntityOutputBasket](#class-entityoutputbasket) | [
|
|
8182
|
-
| [EntityOutputTag](#class-entityoutputtag) | [
|
|
8183
|
-
| [EntityOutputTagMap](#class-entityoutputtagmap) | [
|
|
8206
|
+
| [ARC](#class-arc) | [EntityProvenTx](#class-entityproventx) | [TaskReorg](#class-taskreorg) |
|
|
8207
|
+
| [AuthMethodInteractor](#class-authmethodinteractor) | [EntityProvenTxReq](#class-entityproventxreq) | [TaskReviewStatus](#class-taskreviewstatus) |
|
|
8208
|
+
| [BHServiceClient](#class-bhserviceclient) | [EntitySyncState](#class-entitysyncstate) | [TaskSendWaiting](#class-tasksendwaiting) |
|
|
8209
|
+
| [Bitails](#class-bitails) | [EntityTransaction](#class-entitytransaction) | [TaskSyncWhenIdle](#class-tasksyncwhenidle) |
|
|
8210
|
+
| [BulkFileDataManager](#class-bulkfiledatamanager) | [EntityTxLabel](#class-entitytxlabel) | [TaskUnFail](#class-taskunfail) |
|
|
8211
|
+
| [BulkFileDataReader](#class-bulkfiledatareader) | [EntityTxLabelMap](#class-entitytxlabelmap) | [TwilioPhoneInteractor](#class-twiliophoneinteractor) |
|
|
8212
|
+
| [BulkFilesReader](#class-bulkfilesreader) | [EntityUser](#class-entityuser) | [WABClient](#class-wabclient) |
|
|
8213
|
+
| [BulkFilesReaderFs](#class-bulkfilesreaderfs) | [HeightRange](#class-heightrange) | [WERR_BAD_REQUEST](#class-werr_bad_request) |
|
|
8214
|
+
| [BulkFilesReaderStorage](#class-bulkfilesreaderstorage) | [LiveIngestorBase](#class-liveingestorbase) | [WERR_BROADCAST_UNAVAILABLE](#class-werr_broadcast_unavailable) |
|
|
8215
|
+
| [BulkHeaderFile](#class-bulkheaderfile) | [LiveIngestorWhatsOnChainPoll](#class-liveingestorwhatsonchainpoll) | [WERR_INSUFFICIENT_FUNDS](#class-werr_insufficient_funds) |
|
|
8216
|
+
| [BulkHeaderFileFs](#class-bulkheaderfilefs) | [MergeEntity](#class-mergeentity) | [WERR_INTERNAL](#class-werr_internal) |
|
|
8217
|
+
| [BulkHeaderFileStorage](#class-bulkheaderfilestorage) | [Monitor](#class-monitor) | [WERR_INVALID_MERKLE_ROOT](#class-werr_invalid_merkle_root) |
|
|
8218
|
+
| [BulkHeaderFiles](#class-bulkheaderfiles) | [OverlayUMPTokenInteractor](#class-overlayumptokeninteractor) | [WERR_INVALID_OPERATION](#class-werr_invalid_operation) |
|
|
8219
|
+
| [BulkIngestorBase](#class-bulkingestorbase) | [PersonaIDInteractor](#class-personaidinteractor) | [WERR_INVALID_PARAMETER](#class-werr_invalid_parameter) |
|
|
8220
|
+
| [BulkIngestorCDN](#class-bulkingestorcdn) | [PrivilegedKeyManager](#class-privilegedkeymanager) | [WERR_INVALID_PUBLIC_KEY](#class-werr_invalid_public_key) |
|
|
8221
|
+
| [BulkIngestorCDNBabbage](#class-bulkingestorcdnbabbage) | [ScriptTemplateBRC29](#class-scripttemplatebrc29) | [WERR_MISSING_PARAMETER](#class-werr_missing_parameter) |
|
|
8222
|
+
| [BulkIngestorWhatsOnChainCdn](#class-bulkingestorwhatsonchaincdn) | [SdkWhatsOnChain](#class-sdkwhatsonchain) | [WERR_NETWORK_CHAIN](#class-werr_network_chain) |
|
|
8223
|
+
| [BulkStorageBase](#class-bulkstoragebase) | [ServiceCollection](#class-servicecollection) | [WERR_NOT_ACTIVE](#class-werr_not_active) |
|
|
8224
|
+
| [CWIStyleWalletManager](#class-cwistylewalletmanager) | [Services](#class-services) | [WERR_NOT_IMPLEMENTED](#class-werr_not_implemented) |
|
|
8225
|
+
| [Chaintracks](#class-chaintracks) | [SetupClient](#class-setupclient) | [WERR_REVIEW_ACTIONS](#class-werr_review_actions) |
|
|
8226
|
+
| [ChaintracksChainTracker](#class-chaintrackschaintracker) | [SimpleWalletManager](#class-simplewalletmanager) | [WERR_UNAUTHORIZED](#class-werr_unauthorized) |
|
|
8227
|
+
| [ChaintracksFetch](#class-chaintracksfetch) | [SingleWriterMultiReaderLock](#class-singlewritermultireaderlock) | [Wallet](#class-wallet) |
|
|
8228
|
+
| [ChaintracksServiceClient](#class-chaintracksserviceclient) | [StorageClient](#class-storageclient) | [WalletAuthenticationManager](#class-walletauthenticationmanager) |
|
|
8229
|
+
| [ChaintracksStorageBase](#class-chaintracksstoragebase) | [StorageIdb](#class-storageidb) | [WalletError](#class-walleterror) |
|
|
8230
|
+
| [ChaintracksStorageIdb](#class-chaintracksstorageidb) | [StorageProvider](#class-storageprovider) | [WalletLogger](#class-walletlogger) |
|
|
8231
|
+
| [ChaintracksStorageNoDb](#class-chaintracksstoragenodb) | [StorageReader](#class-storagereader) | [WalletMonitorTask](#class-walletmonitortask) |
|
|
8232
|
+
| [DevConsoleInteractor](#class-devconsoleinteractor) | [StorageReaderWriter](#class-storagereaderwriter) | [WalletPermissionsManager](#class-walletpermissionsmanager) |
|
|
8233
|
+
| [EntityBase](#class-entitybase) | [StorageSyncReader](#class-storagesyncreader) | [WalletSettingsManager](#class-walletsettingsmanager) |
|
|
8234
|
+
| [EntityCertificate](#class-entitycertificate) | [TaskCheckForProofs](#class-taskcheckforproofs) | [WalletSigner](#class-walletsigner) |
|
|
8235
|
+
| [EntityCertificateField](#class-entitycertificatefield) | [TaskCheckNoSends](#class-taskchecknosends) | [WalletStorageManager](#class-walletstoragemanager) |
|
|
8236
|
+
| [EntityCommission](#class-entitycommission) | [TaskClock](#class-taskclock) | [WhatsOnChain](#class-whatsonchain) |
|
|
8237
|
+
| [EntityOutput](#class-entityoutput) | [TaskFailAbandoned](#class-taskfailabandoned) | [WhatsOnChainNoServices](#class-whatsonchainnoservices) |
|
|
8238
|
+
| [EntityOutputBasket](#class-entityoutputbasket) | [TaskMonitorCallHistory](#class-taskmonitorcallhistory) | [WhatsOnChainServices](#class-whatsonchainservices) |
|
|
8239
|
+
| [EntityOutputTag](#class-entityoutputtag) | [TaskNewHeader](#class-tasknewheader) | |
|
|
8240
|
+
| [EntityOutputTagMap](#class-entityoutputtagmap) | [TaskPurge](#class-taskpurge) | |
|
|
8184
8241
|
|
|
8185
8242
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8186
8243
|
|
|
@@ -11502,41 +11559,6 @@ destroyKey(): void
|
|
|
11502
11559
|
|
|
11503
11560
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11504
11561
|
|
|
11505
|
-
---
|
|
11506
|
-
##### Class: ReaderUint8Array
|
|
11507
|
-
|
|
11508
|
-
```ts
|
|
11509
|
-
export class ReaderUint8Array {
|
|
11510
|
-
public bin: Uint8Array;
|
|
11511
|
-
public pos: number;
|
|
11512
|
-
static makeReader(bin: Uint8Array | number[], pos: number = 0): ReaderUint8Array | Utils.Reader
|
|
11513
|
-
constructor(bin: Uint8Array = new Uint8Array(0), pos: number = 0)
|
|
11514
|
-
public eof(): boolean
|
|
11515
|
-
public read(len = this.length): Uint8Array
|
|
11516
|
-
public readReverse(len = this.length): Uint8Array
|
|
11517
|
-
public readUInt8(): number
|
|
11518
|
-
public readInt8(): number
|
|
11519
|
-
public readUInt16BE(): number
|
|
11520
|
-
public readInt16BE(): number
|
|
11521
|
-
public readUInt16LE(): number
|
|
11522
|
-
public readInt16LE(): number
|
|
11523
|
-
public readUInt32BE(): number
|
|
11524
|
-
public readInt32BE(): number
|
|
11525
|
-
public readUInt32LE(): number
|
|
11526
|
-
public readInt32LE(): number
|
|
11527
|
-
public readUInt64BEBn(): BigNumber
|
|
11528
|
-
public readUInt64LEBn(): BigNumber
|
|
11529
|
-
public readInt64LEBn(): BigNumber
|
|
11530
|
-
public readVarIntNum(signed: boolean = true): number
|
|
11531
|
-
public readVarInt(): Uint8Array
|
|
11532
|
-
public readVarIntBn(): BigNumber
|
|
11533
|
-
}
|
|
11534
|
-
```
|
|
11535
|
-
|
|
11536
|
-
See also: [readUInt32BE](./services.md#function-readuint32be), [readUInt32LE](./services.md#function-readuint32le)
|
|
11537
|
-
|
|
11538
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11539
|
-
|
|
11540
11562
|
---
|
|
11541
11563
|
##### Class: ScriptTemplateBRC29
|
|
11542
11564
|
|
|
@@ -13185,7 +13207,7 @@ export abstract class StorageProvider extends StorageReaderWriter implements Wal
|
|
|
13185
13207
|
async listCertificates(auth: AuthId, args: Validation.ValidListCertificatesArgs): Promise<ListCertificatesResult>
|
|
13186
13208
|
async verifyKnownValidTransaction(txid: string, trx?: TrxToken): Promise<boolean>
|
|
13187
13209
|
async getValidBeefForKnownTxid(txid: string, mergeToBeef?: Beef, trustSelf?: TrustSelf, knownTxids?: string[], trx?: TrxToken, requiredLevels?: number): Promise<Beef>
|
|
13188
|
-
async getValidBeefForTxid(txid: string, mergeToBeef?: Beef, trustSelf?: TrustSelf, knownTxids?: string[], trx?: TrxToken, requiredLevels?: number): Promise<Beef | undefined>
|
|
13210
|
+
async getValidBeefForTxid(txid: string, mergeToBeef?: Beef, trustSelf?: TrustSelf, knownTxids?: string[], trx?: TrxToken, requiredLevels?: number, chainTracker?: ChainTracker, skipInvalidProofs?: boolean): Promise<Beef | undefined>
|
|
13189
13211
|
async getBeefForTransaction(txid: string, options: StorageGetBeefOptions): Promise<Beef>
|
|
13190
13212
|
async findMonitorEventById(id: number, trx?: TrxToken): Promise<TableMonitorEvent | undefined>
|
|
13191
13213
|
async relinquishCertificate(auth: AuthId, args: RelinquishCertificateArgs): Promise<number>
|
|
@@ -13246,6 +13268,18 @@ async getReqsAndBeefToShareWithWorld(txids: string[], knownTxids: string[], trx?
|
|
|
13246
13268
|
```
|
|
13247
13269
|
See also: [GetReqsAndBeefResult](./storage.md#interface-getreqsandbeefresult), [TrxToken](./client.md#interface-trxtoken)
|
|
13248
13270
|
|
|
13271
|
+
###### Method getValidBeefForKnownTxid
|
|
13272
|
+
|
|
13273
|
+
Pulls data from storage to build a valid beef for a txid.
|
|
13274
|
+
|
|
13275
|
+
Optionally merges the data into an existing beef.
|
|
13276
|
+
Optionally requires a minimum number of proof levels.
|
|
13277
|
+
|
|
13278
|
+
```ts
|
|
13279
|
+
async getValidBeefForKnownTxid(txid: string, mergeToBeef?: Beef, trustSelf?: TrustSelf, knownTxids?: string[], trx?: TrxToken, requiredLevels?: number): Promise<Beef>
|
|
13280
|
+
```
|
|
13281
|
+
See also: [TrxToken](./client.md#interface-trxtoken)
|
|
13282
|
+
|
|
13249
13283
|
###### Method updateProvenTxReqWithNewProvenTx
|
|
13250
13284
|
|
|
13251
13285
|
Handles storage changes when a valid MerklePath and mined block header are found for a ProvenTxReq txid.
|
|
@@ -14024,6 +14058,29 @@ export class WABClient {
|
|
|
14024
14058
|
public async unlinkMethod(presentationKey: string, authMethodId: number)
|
|
14025
14059
|
public async requestFaucet(presentationKey: string)
|
|
14026
14060
|
public async deleteUser(presentationKey: string)
|
|
14061
|
+
public async startShareAuth(methodType: string, userIdHash: string, payload: any): Promise<{
|
|
14062
|
+
success: boolean;
|
|
14063
|
+
message: string;
|
|
14064
|
+
}>
|
|
14065
|
+
public async storeShare(methodType: string, payload: any, shareB: string, userIdHash: string): Promise<{
|
|
14066
|
+
success: boolean;
|
|
14067
|
+
message: string;
|
|
14068
|
+
userId?: number;
|
|
14069
|
+
}>
|
|
14070
|
+
public async retrieveShare(methodType: string, payload: any, userIdHash: string): Promise<{
|
|
14071
|
+
success: boolean;
|
|
14072
|
+
shareB?: string;
|
|
14073
|
+
message: string;
|
|
14074
|
+
}>
|
|
14075
|
+
public async updateShare(methodType: string, payload: any, userIdHash: string, newShareB: string): Promise<{
|
|
14076
|
+
success: boolean;
|
|
14077
|
+
message: string;
|
|
14078
|
+
shareVersion?: number;
|
|
14079
|
+
}>
|
|
14080
|
+
public async deleteShamirUser(methodType: string, payload: any, userIdHash: string): Promise<{
|
|
14081
|
+
success: boolean;
|
|
14082
|
+
message: string;
|
|
14083
|
+
}>
|
|
14027
14084
|
}
|
|
14028
14085
|
```
|
|
14029
14086
|
|
|
@@ -14038,6 +14095,27 @@ public async completeAuthMethod(authMethod: AuthMethodInteractor, presentationKe
|
|
|
14038
14095
|
```
|
|
14039
14096
|
See also: [AuthMethodInteractor](./client.md#class-authmethodinteractor)
|
|
14040
14097
|
|
|
14098
|
+
###### Method deleteShamirUser
|
|
14099
|
+
|
|
14100
|
+
Delete a Shamir user's account and stored share
|
|
14101
|
+
Requires OTP verification
|
|
14102
|
+
|
|
14103
|
+
```ts
|
|
14104
|
+
public async deleteShamirUser(methodType: string, payload: any, userIdHash: string): Promise<{
|
|
14105
|
+
success: boolean;
|
|
14106
|
+
message: string;
|
|
14107
|
+
}>
|
|
14108
|
+
```
|
|
14109
|
+
|
|
14110
|
+
Argument Details
|
|
14111
|
+
|
|
14112
|
+
+ **methodType**
|
|
14113
|
+
+ The auth method type used for verification
|
|
14114
|
+
+ **payload**
|
|
14115
|
+
+ Contains the OTP code and auth method specific data
|
|
14116
|
+
+ **userIdHash**
|
|
14117
|
+
+ SHA256 hash of the user's identity key
|
|
14118
|
+
|
|
14041
14119
|
###### Method deleteUser
|
|
14042
14120
|
|
|
14043
14121
|
Delete user
|
|
@@ -14078,6 +14156,28 @@ Request faucet
|
|
|
14078
14156
|
public async requestFaucet(presentationKey: string)
|
|
14079
14157
|
```
|
|
14080
14158
|
|
|
14159
|
+
###### Method retrieveShare
|
|
14160
|
+
|
|
14161
|
+
Retrieve a Shamir share (Share B) from the server
|
|
14162
|
+
Requires OTP verification
|
|
14163
|
+
|
|
14164
|
+
```ts
|
|
14165
|
+
public async retrieveShare(methodType: string, payload: any, userIdHash: string): Promise<{
|
|
14166
|
+
success: boolean;
|
|
14167
|
+
shareB?: string;
|
|
14168
|
+
message: string;
|
|
14169
|
+
}>
|
|
14170
|
+
```
|
|
14171
|
+
|
|
14172
|
+
Argument Details
|
|
14173
|
+
|
|
14174
|
+
+ **methodType**
|
|
14175
|
+
+ The auth method type used for verification
|
|
14176
|
+
+ **payload**
|
|
14177
|
+
+ Contains the OTP code and auth method specific data
|
|
14178
|
+
+ **userIdHash**
|
|
14179
|
+
+ SHA256 hash of the user's identity key
|
|
14180
|
+
|
|
14081
14181
|
###### Method startAuthMethod
|
|
14082
14182
|
|
|
14083
14183
|
Start an Auth Method flow
|
|
@@ -14087,6 +14187,51 @@ public async startAuthMethod(authMethod: AuthMethodInteractor, presentationKey:
|
|
|
14087
14187
|
```
|
|
14088
14188
|
See also: [AuthMethodInteractor](./client.md#class-authmethodinteractor)
|
|
14089
14189
|
|
|
14190
|
+
###### Method startShareAuth
|
|
14191
|
+
|
|
14192
|
+
Start OTP verification for share operations
|
|
14193
|
+
This initiates the auth flow (e.g., sends SMS code via Twilio)
|
|
14194
|
+
|
|
14195
|
+
```ts
|
|
14196
|
+
public async startShareAuth(methodType: string, userIdHash: string, payload: any): Promise<{
|
|
14197
|
+
success: boolean;
|
|
14198
|
+
message: string;
|
|
14199
|
+
}>
|
|
14200
|
+
```
|
|
14201
|
+
|
|
14202
|
+
Argument Details
|
|
14203
|
+
|
|
14204
|
+
+ **methodType**
|
|
14205
|
+
+ The auth method type (e.g., "TwilioPhone", "DevConsole")
|
|
14206
|
+
+ **userIdHash**
|
|
14207
|
+
+ SHA256 hash of the user's identity key
|
|
14208
|
+
+ **payload**
|
|
14209
|
+
+ Auth method specific data (e.g., { phoneNumber: "+1..." })
|
|
14210
|
+
|
|
14211
|
+
###### Method storeShare
|
|
14212
|
+
|
|
14213
|
+
Store a Shamir share (Share B) on the server
|
|
14214
|
+
Requires prior OTP verification via startShareAuth
|
|
14215
|
+
|
|
14216
|
+
```ts
|
|
14217
|
+
public async storeShare(methodType: string, payload: any, shareB: string, userIdHash: string): Promise<{
|
|
14218
|
+
success: boolean;
|
|
14219
|
+
message: string;
|
|
14220
|
+
userId?: number;
|
|
14221
|
+
}>
|
|
14222
|
+
```
|
|
14223
|
+
|
|
14224
|
+
Argument Details
|
|
14225
|
+
|
|
14226
|
+
+ **methodType**
|
|
14227
|
+
+ The auth method type used for verification
|
|
14228
|
+
+ **payload**
|
|
14229
|
+
+ Contains the OTP code and auth method specific data
|
|
14230
|
+
+ **shareB**
|
|
14231
|
+
+ The Shamir share to store (format: x.y.threshold.integrity)
|
|
14232
|
+
+ **userIdHash**
|
|
14233
|
+
+ SHA256 hash of the user's identity key
|
|
14234
|
+
|
|
14090
14235
|
###### Method unlinkMethod
|
|
14091
14236
|
|
|
14092
14237
|
Unlink a given Auth Method by ID
|
|
@@ -14095,6 +14240,30 @@ Unlink a given Auth Method by ID
|
|
|
14095
14240
|
public async unlinkMethod(presentationKey: string, authMethodId: number)
|
|
14096
14241
|
```
|
|
14097
14242
|
|
|
14243
|
+
###### Method updateShare
|
|
14244
|
+
|
|
14245
|
+
Update a Shamir share (for key rotation)
|
|
14246
|
+
Requires OTP verification
|
|
14247
|
+
|
|
14248
|
+
```ts
|
|
14249
|
+
public async updateShare(methodType: string, payload: any, userIdHash: string, newShareB: string): Promise<{
|
|
14250
|
+
success: boolean;
|
|
14251
|
+
message: string;
|
|
14252
|
+
shareVersion?: number;
|
|
14253
|
+
}>
|
|
14254
|
+
```
|
|
14255
|
+
|
|
14256
|
+
Argument Details
|
|
14257
|
+
|
|
14258
|
+
+ **methodType**
|
|
14259
|
+
+ The auth method type used for verification
|
|
14260
|
+
+ **payload**
|
|
14261
|
+
+ Contains the OTP code and auth method specific data
|
|
14262
|
+
+ **userIdHash**
|
|
14263
|
+
+ SHA256 hash of the user's identity key
|
|
14264
|
+
+ **newShareB**
|
|
14265
|
+
+ The new Shamir share to store
|
|
14266
|
+
|
|
14098
14267
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
14099
14268
|
|
|
14100
14269
|
---
|
|
@@ -14432,7 +14601,7 @@ export class Wallet implements WalletInterface, ProtoWallet {
|
|
|
14432
14601
|
async getVersion(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetVersionResult>
|
|
14433
14602
|
async sweepTo(toWallet: Wallet): Promise<void>
|
|
14434
14603
|
async balanceAndUtxos(basket: string = "default"): Promise<WalletBalance>
|
|
14435
|
-
async balance(): Promise<number>
|
|
14604
|
+
async balance(args?: ListOutputsArgs): Promise<number>
|
|
14436
14605
|
async reviewSpendableOutputs(all = false, release = false, optionalArgs?: Partial<ListOutputsArgs>): Promise<ListOutputsResult>
|
|
14437
14606
|
async setWalletChangeParams(count: number, satoshis: number): Promise<void>
|
|
14438
14607
|
async listNoSendActions(args: ListActionsArgs, abort = false): Promise<ListActionsResult>
|
|
@@ -14497,7 +14666,7 @@ Uses `listOutputs` special operation to compute the total value (of satoshis) fo
|
|
|
14497
14666
|
all spendable outputs in the 'default' basket.
|
|
14498
14667
|
|
|
14499
14668
|
```ts
|
|
14500
|
-
async balance(): Promise<number>
|
|
14669
|
+
async balance(args?: ListOutputsArgs): Promise<number>
|
|
14501
14670
|
```
|
|
14502
14671
|
|
|
14503
14672
|
Returns
|
|
@@ -14862,7 +15031,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
14862
15031
|
```ts
|
|
14863
15032
|
export class WalletPermissionsManager implements WalletInterface {
|
|
14864
15033
|
constructor(underlyingWallet: WalletInterface, adminOriginator: string, config: PermissionsManagerConfig = {})
|
|
14865
|
-
public bindCallback(eventName: keyof WalletPermissionsManagerCallbacks, handler: PermissionEventHandler | GroupedPermissionEventHandler): number
|
|
15034
|
+
public bindCallback(eventName: keyof WalletPermissionsManagerCallbacks, handler: PermissionEventHandler | GroupedPermissionEventHandler | CounterpartyPermissionEventHandler): number
|
|
14866
15035
|
public unbindCallback(eventName: keyof WalletPermissionsManagerCallbacks, reference: number | Function): boolean
|
|
14867
15036
|
public async grantPermission(params: {
|
|
14868
15037
|
requestID: string;
|
|
@@ -14877,6 +15046,13 @@ export class WalletPermissionsManager implements WalletInterface {
|
|
|
14877
15046
|
expiry?: number;
|
|
14878
15047
|
}): Promise<void>
|
|
14879
15048
|
public async denyGroupedPermission(requestID: string): Promise<void>
|
|
15049
|
+
public async dismissGroupedPermission(requestID: string): Promise<void>
|
|
15050
|
+
public async grantCounterpartyPermission(params: {
|
|
15051
|
+
requestID: string;
|
|
15052
|
+
granted: Partial<CounterpartyPermissions>;
|
|
15053
|
+
expiry?: number;
|
|
15054
|
+
}): Promise<void>
|
|
15055
|
+
public async denyCounterpartyPermission(requestID: string): Promise<void>
|
|
14880
15056
|
public async ensureProtocolPermission({ originator, privileged, protocolID, counterparty, reason, seekPermission = true, usageType }: {
|
|
14881
15057
|
originator: string;
|
|
14882
15058
|
privileged: boolean;
|
|
@@ -14995,7 +15171,7 @@ export class WalletPermissionsManager implements WalletInterface {
|
|
|
14995
15171
|
}
|
|
14996
15172
|
```
|
|
14997
15173
|
|
|
14998
|
-
See also: [GroupedPermissionEventHandler](./client.md#type-groupedpermissioneventhandler), [GroupedPermissions](./client.md#interface-groupedpermissions), [PermissionEventHandler](./client.md#type-permissioneventhandler), [PermissionToken](./client.md#interface-permissiontoken), [PermissionsManagerConfig](./client.md#interface-permissionsmanagerconfig), [WalletPermissionsManagerCallbacks](./client.md#interface-walletpermissionsmanagercallbacks), [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)
|
|
15174
|
+
See also: [CounterpartyPermissionEventHandler](./client.md#type-counterpartypermissioneventhandler), [CounterpartyPermissions](./client.md#interface-counterpartypermissions), [GroupedPermissionEventHandler](./client.md#type-groupedpermissioneventhandler), [GroupedPermissions](./client.md#interface-groupedpermissions), [PermissionEventHandler](./client.md#type-permissioneventhandler), [PermissionToken](./client.md#interface-permissiontoken), [PermissionsManagerConfig](./client.md#interface-permissionsmanagerconfig), [WalletPermissionsManagerCallbacks](./client.md#interface-walletpermissionsmanagercallbacks), [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)
|
|
14999
15175
|
|
|
15000
15176
|
###### Constructor
|
|
15001
15177
|
|
|
@@ -15020,9 +15196,9 @@ Argument Details
|
|
|
15020
15196
|
Binds a callback function to a named event, such as `onProtocolPermissionRequested`.
|
|
15021
15197
|
|
|
15022
15198
|
```ts
|
|
15023
|
-
public bindCallback(eventName: keyof WalletPermissionsManagerCallbacks, handler: PermissionEventHandler | GroupedPermissionEventHandler): number
|
|
15199
|
+
public bindCallback(eventName: keyof WalletPermissionsManagerCallbacks, handler: PermissionEventHandler | GroupedPermissionEventHandler | CounterpartyPermissionEventHandler): number
|
|
15024
15200
|
```
|
|
15025
|
-
See also: [GroupedPermissionEventHandler](./client.md#type-groupedpermissioneventhandler), [PermissionEventHandler](./client.md#type-permissioneventhandler), [WalletPermissionsManagerCallbacks](./client.md#interface-walletpermissionsmanagercallbacks)
|
|
15201
|
+
See also: [CounterpartyPermissionEventHandler](./client.md#type-counterpartypermissioneventhandler), [GroupedPermissionEventHandler](./client.md#type-groupedpermissioneventhandler), [PermissionEventHandler](./client.md#type-permissioneventhandler), [WalletPermissionsManagerCallbacks](./client.md#interface-walletpermissionsmanagercallbacks)
|
|
15026
15202
|
|
|
15027
15203
|
Returns
|
|
15028
15204
|
|
|
@@ -15928,52 +16104,52 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
15928
16104
|
|
|
15929
16105
|
| | | |
|
|
15930
16106
|
| --- | --- | --- |
|
|
15931
|
-
| [WalletErrorFromJson](#function-walleterrorfromjson) | [getBeefForTransaction](#function-getbeeffortransaction) | [
|
|
15932
|
-
| [WocHeadersBulkListener](#function-wocheadersbulklistener) | [getBeefForTxid](#function-getbeeffortxid) | [
|
|
15933
|
-
| [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [getExchangeRatesIo](#function-getexchangeratesio) | [
|
|
15934
|
-
| [WocHeadersLiveListener](#function-wocheaderslivelistener) | [getIdentityKey](#function-getidentitykey) | [
|
|
15935
|
-
| [WocHeadersLiveListener_test](#function-wocheaderslivelistener_test) | [
|
|
15936
|
-
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [
|
|
15937
|
-
| [addWork](#function-addwork) | [
|
|
15938
|
-
| [arcDefaultUrl](#function-arcdefaulturl) | [
|
|
15939
|
-
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [internalizeAction](#function-internalizeaction) | [
|
|
15940
|
-
| [arraysEqual](#function-arraysequal) | [
|
|
15941
|
-
| [asArray](#function-asarray) | [
|
|
15942
|
-
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [
|
|
15943
|
-
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [
|
|
15944
|
-
| [asBsvSdkScript](#function-asbsvsdkscript) | [
|
|
15945
|
-
| [asBsvSdkTx](#function-asbsvsdktx) | [
|
|
15946
|
-
| [asString](#function-asstring) | [
|
|
15947
|
-
| [asUint8Array](#function-asuint8array) | [
|
|
15948
|
-
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [
|
|
15949
|
-
| [blockHash](#function-blockhash) | [
|
|
15950
|
-
| [buildSignableTransaction](#function-buildsignabletransaction) | [
|
|
15951
|
-
| [completeSignedTransaction](#function-completesignedtransaction) | [
|
|
15952
|
-
| [convertBitsToTarget](#function-convertbitstotarget) | [
|
|
15953
|
-
| [convertBitsToWork](#function-convertbitstowork) | [
|
|
15954
|
-
| [convertBufferToUint32](#function-convertbuffertouint32) | [
|
|
15955
|
-
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [
|
|
15956
|
-
| [convertUint32ToBuffer](#function-convertuint32tobuffer) | [
|
|
15957
|
-
| [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [
|
|
16107
|
+
| [WalletErrorFromJson](#function-walleterrorfromjson) | [getBeefForTransaction](#function-getbeeffortransaction) | [serializeBaseBlockHeaders](#function-serializebaseblockheaders) |
|
|
16108
|
+
| [WocHeadersBulkListener](#function-wocheadersbulklistener) | [getBeefForTxid](#function-getbeeffortxid) | [setDisableDoubleSpendCheckForTest](#function-setdisabledoublespendcheckfortest) |
|
|
16109
|
+
| [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [getExchangeRatesIo](#function-getexchangeratesio) | [sha256Hash](#function-sha256hash) |
|
|
16110
|
+
| [WocHeadersLiveListener](#function-wocheaderslivelistener) | [getIdentityKey](#function-getidentitykey) | [sha256HashOfBinaryFile](#function-sha256hashofbinaryfile) |
|
|
16111
|
+
| [WocHeadersLiveListener_test](#function-wocheaderslivelistener_test) | [getListOutputsSpecOp](#function-getlistoutputsspecop) | [shareReqsWithWorld](#function-sharereqswithworld) |
|
|
16112
|
+
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [getProofs](#function-getproofs) | [signAction](#function-signaction) |
|
|
16113
|
+
| [addWork](#function-addwork) | [getSyncChunk](#function-getsyncchunk) | [stampLog](#function-stamplog) |
|
|
16114
|
+
| [arcDefaultUrl](#function-arcdefaulturl) | [getWhatsOnChainBlockHeaderByHash](#function-getwhatsonchainblockheaderbyhash) | [stampLogFormat](#function-stamplogformat) |
|
|
16115
|
+
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [internalizeAction](#function-internalizeaction) | [subWork](#function-subwork) |
|
|
16116
|
+
| [arraysEqual](#function-arraysequal) | [internalizeAction](#function-internalizeaction) | [swapByteOrder](#function-swapbyteorder) |
|
|
16117
|
+
| [asArray](#function-asarray) | [isBaseBlockHeader](#function-isbaseblockheader) | [throwDummyReviewActions](#function-throwdummyreviewactions) |
|
|
16118
|
+
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [isBlockHeader](#function-isblockheader) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) |
|
|
16119
|
+
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [isCreateActionSpecOp](#function-iscreateactionspecop) | [toWalletNetwork](#function-towalletnetwork) |
|
|
16120
|
+
| [asBsvSdkScript](#function-asbsvsdkscript) | [isKnownValidBulkHeaderFile](#function-isknownvalidbulkheaderfile) | [transactionInputSize](#function-transactioninputsize) |
|
|
16121
|
+
| [asBsvSdkTx](#function-asbsvsdktx) | [isListActionsSpecOp](#function-islistactionsspecop) | [transactionOutputSize](#function-transactionoutputsize) |
|
|
16122
|
+
| [asString](#function-asstring) | [isListOutputsSpecOp](#function-islistoutputsspecop) | [transactionSize](#function-transactionsize) |
|
|
16123
|
+
| [asUint8Array](#function-asuint8array) | [isLive](#function-islive) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) |
|
|
16124
|
+
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [isLiveBlockHeader](#function-isliveblockheader) | [updateExchangeratesapi](#function-updateexchangeratesapi) |
|
|
16125
|
+
| [blockHash](#function-blockhash) | [isMoreWork](#function-ismorework) | [validBulkHeaderFilesByFileHash](#function-validbulkheaderfilesbyfilehash) |
|
|
16126
|
+
| [buildSignableTransaction](#function-buildsignabletransaction) | [keyOffsetToHashedSecret](#function-keyoffsettohashedsecret) | [validateAgainstDirtyHashes](#function-validateagainstdirtyhashes) |
|
|
16127
|
+
| [completeSignedTransaction](#function-completesignedtransaction) | [listActionsIdb](#function-listactionsidb) | [validateBufferOfHeaders](#function-validatebufferofheaders) |
|
|
16128
|
+
| [convertBitsToTarget](#function-convertbitstotarget) | [listCertificates](#function-listcertificates) | [validateBulkFileData](#function-validatebulkfiledata) |
|
|
16129
|
+
| [convertBitsToWork](#function-convertbitstowork) | [listOutputsIdb](#function-listoutputsidb) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) |
|
|
16130
|
+
| [convertBufferToUint32](#function-convertbuffertouint32) | [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) |
|
|
16131
|
+
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [logCreateActionArgs](#function-logcreateactionargs) | [validateGenesisHeader](#function-validategenesisheader) |
|
|
16132
|
+
| [convertUint32ToBuffer](#function-convertuint32tobuffer) | [logWalletError](#function-logwalleterror) | [validateHeaderDifficulty](#function-validateheaderdifficulty) |
|
|
16133
|
+
| [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [makeAtomicBeef](#function-makeatomicbeef) | [validateHeaderFormat](#function-validateheaderformat) |
|
|
16134
|
+
| [createAction](#function-createaction) | [makeChangeLock](#function-makechangelock) | [validateScriptHash](#function-validatescripthash) |
|
|
15958
16135
|
| [createAction](#function-createaction) | [maxDate](#function-maxdate) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
|
|
15959
|
-
| [
|
|
15960
|
-
| [
|
|
15961
|
-
| [
|
|
15962
|
-
| [
|
|
15963
|
-
| [
|
|
15964
|
-
| [
|
|
15965
|
-
| [
|
|
15966
|
-
| [
|
|
15967
|
-
| [
|
|
15968
|
-
| [
|
|
15969
|
-
| [
|
|
15970
|
-
| [
|
|
15971
|
-
| [
|
|
15972
|
-
| [
|
|
15973
|
-
| [
|
|
15974
|
-
| [
|
|
15975
|
-
| [
|
|
15976
|
-
| [genesisHeader](#function-genesisheader) | [serializeBaseBlockHeaders](#function-serializebaseblockheaders) | |
|
|
16136
|
+
| [createDefaultIdbChaintracksOptions](#function-createdefaultidbchaintracksoptions) | [offsetPrivKey](#function-offsetprivkey) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
|
|
16137
|
+
| [createDefaultNoDbChaintracksOptions](#function-createdefaultnodbchaintracksoptions) | [offsetPubKey](#function-offsetpubkey) | [varUintSize](#function-varuintsize) |
|
|
16138
|
+
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [optionalArraysEqual](#function-optionalarraysequal) | [verifyHexString](#function-verifyhexstring) |
|
|
16139
|
+
| [createIdbChaintracks](#function-createidbchaintracks) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [verifyId](#function-verifyid) |
|
|
16140
|
+
| [createNoDbChaintracks](#function-createnodbchaintracks) | [processAction](#function-processaction) | [verifyInteger](#function-verifyinteger) |
|
|
16141
|
+
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [processAction](#function-processaction) | [verifyNumber](#function-verifynumber) |
|
|
16142
|
+
| [createSyncMap](#function-createsyncmap) | [proveCertificate](#function-provecertificate) | [verifyOne](#function-verifyone) |
|
|
16143
|
+
| [deserializeBaseBlockHeader](#function-deserializebaseblockheader) | [purgeDataIdb](#function-purgedataidb) | [verifyOneOrNone](#function-verifyoneornone) |
|
|
16144
|
+
| [deserializeBaseBlockHeaders](#function-deserializebaseblockheaders) | [randomBytes](#function-randombytes) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
|
|
16145
|
+
| [deserializeBlockHeader](#function-deserializeblockheader) | [randomBytesBase64](#function-randombytesbase64) | [verifyTruthy](#function-verifytruthy) |
|
|
16146
|
+
| [deserializeBlockHeaders](#function-deserializeblockheaders) | [randomBytesHex](#function-randombyteshex) | [verifyUnlockScripts](#function-verifyunlockscripts) |
|
|
16147
|
+
| [doubleSha256BE](#function-doublesha256be) | [readUInt32BE](#function-readuint32be) | [wait](#function-wait) |
|
|
16148
|
+
| [doubleSha256LE](#function-doublesha256le) | [readUInt32LE](#function-readuint32le) | [wocGetHeadersHeaderToBlockHeader](#function-wocgetheadersheadertoblockheader) |
|
|
16149
|
+
| [generateChangeSdk](#function-generatechangesdk) | [redeemServiceCharges](#function-redeemservicecharges) | [workBNtoBuffer](#function-workbntobuffer) |
|
|
16150
|
+
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [reviewStatusIdb](#function-reviewstatusidb) | [writeUInt32BE](#function-writeuint32be) |
|
|
16151
|
+
| [genesisBuffer](#function-genesisbuffer) | [selectBulkHeaderFiles](#function-selectbulkheaderfiles) | [writeUInt32LE](#function-writeuint32le) |
|
|
16152
|
+
| [genesisHeader](#function-genesisheader) | [serializeBaseBlockHeader](#function-serializebaseblockheader) | |
|
|
15977
16153
|
|
|
15978
16154
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15979
16155
|
|
|
@@ -16623,7 +16799,7 @@ Deserialize a BaseBlockHeader from an 80 byte buffer
|
|
|
16623
16799
|
|
|
16624
16800
|
```ts
|
|
16625
16801
|
export function deserializeBaseBlockHeader(buffer: number[] | Uint8Array, offset = 0): BaseBlockHeader {
|
|
16626
|
-
const reader = ReaderUint8Array.makeReader(buffer, offset);
|
|
16802
|
+
const reader = Utils.ReaderUint8Array.makeReader(buffer, offset);
|
|
16627
16803
|
const header: BaseBlockHeader = {
|
|
16628
16804
|
version: reader.readUInt32LE(),
|
|
16629
16805
|
previousHash: asString(reader.read(32).reverse()),
|
|
@@ -16636,7 +16812,7 @@ export function deserializeBaseBlockHeader(buffer: number[] | Uint8Array, offset
|
|
|
16636
16812
|
}
|
|
16637
16813
|
```
|
|
16638
16814
|
|
|
16639
|
-
See also: [BaseBlockHeader](./client.md#interface-baseblockheader), [
|
|
16815
|
+
See also: [BaseBlockHeader](./client.md#interface-baseblockheader), [asString](./client.md#function-asstring), [readUInt32LE](./services.md#function-readuint32le)
|
|
16640
16816
|
|
|
16641
16817
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
16642
16818
|
|
|
@@ -16872,6 +17048,23 @@ See also: [CertOpsWallet](./client.md#interface-certopswallet)
|
|
|
16872
17048
|
|
|
16873
17049
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
16874
17050
|
|
|
17051
|
+
---
|
|
17052
|
+
##### Function: getListOutputsSpecOp
|
|
17053
|
+
|
|
17054
|
+
Check basket and tags arguments passed to listOutputs to determine if they trigger a special operation execution mode.
|
|
17055
|
+
|
|
17056
|
+
```ts
|
|
17057
|
+
export function getListOutputsSpecOp(basket: string, tags: string[]): {
|
|
17058
|
+
specOp: ListOutputsSpecOp | undefined;
|
|
17059
|
+
basket?: string;
|
|
17060
|
+
tags: string[];
|
|
17061
|
+
}
|
|
17062
|
+
```
|
|
17063
|
+
|
|
17064
|
+
See also: [ListOutputsSpecOp](./storage.md#interface-listoutputsspecop)
|
|
17065
|
+
|
|
17066
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
17067
|
+
|
|
16875
17068
|
---
|
|
16876
17069
|
##### Function: getProofs
|
|
16877
17070
|
|
|
@@ -18257,7 +18450,8 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
18257
18450
|
|
|
18258
18451
|
| | | |
|
|
18259
18452
|
| --- | --- | --- |
|
|
18260
|
-
| [Chain](#type-chain) | [
|
|
18453
|
+
| [Chain](#type-chain) | [GetUtxoStatusService](#type-getutxostatusservice) | [ReqHistoryNote](#type-reqhistorynote) |
|
|
18454
|
+
| [CounterpartyPermissionEventHandler](#type-counterpartypermissioneventhandler) | [GroupedPermissionEventHandler](#type-groupedpermissioneventhandler) | [ReviewActionResultStatus](#type-reviewactionresultstatus) |
|
|
18261
18455
|
| [DBType](#type-dbtype) | [HeaderListener](#type-headerlistener) | [ScriptHashFormat](#type-scripthashformat) |
|
|
18262
18456
|
| [EnqueueHandler](#type-enqueuehandler) | [InsertHeaderResult](#type-insertheaderresult) | [ServicesCallHistory](#type-servicescallhistory) |
|
|
18263
18457
|
| [EntityStorage](#type-entitystorage) | [MonitorStorage](#type-monitorstorage) | [StopListenerToken](#type-stoplistenertoken) |
|
|
@@ -18267,7 +18461,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
18267
18461
|
| [GetScriptHashHistoryService](#type-getscripthashhistoryservice) | [PostTxsService](#type-posttxsservice) | [TransactionStatus](#type-transactionstatus) |
|
|
18268
18462
|
| [GetStatusForTxidsService](#type-getstatusfortxidsservice) | [ProvenTxReqStatus](#type-proventxreqstatus) | [UpdateFiatExchangeRateService](#type-updatefiatexchangerateservice) |
|
|
18269
18463
|
| [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat) | [ReorgListener](#type-reorglistener) | [WalletLoggerLevel](#type-walletloggerlevel) |
|
|
18270
|
-
| [GetUtxoStatusService](#type-getutxostatusservice) | [ReqHistoryNote](#type-reqhistorynote) | |
|
|
18271
18464
|
|
|
18272
18465
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18273
18466
|
|
|
@@ -18281,6 +18474,17 @@ export type Chain = "main" | "test"
|
|
|
18281
18474
|
|
|
18282
18475
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18283
18476
|
|
|
18477
|
+
---
|
|
18478
|
+
##### Type: CounterpartyPermissionEventHandler
|
|
18479
|
+
|
|
18480
|
+
```ts
|
|
18481
|
+
export type CounterpartyPermissionEventHandler = (request: CounterpartyPermissionRequest) => void | Promise<void>
|
|
18482
|
+
```
|
|
18483
|
+
|
|
18484
|
+
See also: [CounterpartyPermissionRequest](./client.md#interface-counterpartypermissionrequest)
|
|
18485
|
+
|
|
18486
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18487
|
+
|
|
18284
18488
|
---
|
|
18285
18489
|
##### Type: DBType
|
|
18286
18490
|
|
|
@@ -18702,17 +18906,20 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
18702
18906
|
---
|
|
18703
18907
|
#### Variables
|
|
18704
18908
|
|
|
18705
|
-
| | |
|
|
18706
|
-
| --- | --- |
|
|
18707
|
-
| [DEFAULT_PROFILE_ID](#variable-default_profile_id) | [
|
|
18708
|
-
| [DEFAULT_SETTINGS](#variable-default_settings) | [
|
|
18709
|
-
| [PBKDF2_NUM_ROUNDS](#variable-pbkdf2_num_rounds) | [
|
|
18710
|
-
| [ProvenTxReqNonTerminalStatus](#variable-proventxreqnonterminalstatus) | [
|
|
18711
|
-
| [ProvenTxReqTerminalStatus](#variable-proventxreqterminalstatus) | [
|
|
18712
|
-
| [TESTNET_DEFAULT_SETTINGS](#variable-testnet_default_settings) | [
|
|
18713
|
-
| [aggregateActionResults](#variable-aggregateactionresults) | [
|
|
18714
|
-
| [brc29ProtocolID](#variable-brc29protocolid) | [
|
|
18715
|
-
| [dirtyHashes](#variable-dirtyhashes) | [
|
|
18909
|
+
| | |
|
|
18910
|
+
| --- | --- |
|
|
18911
|
+
| [DEFAULT_PROFILE_ID](#variable-default_profile_id) | [outputColumnsWithoutLockingScript](#variable-outputcolumnswithoutlockingscript) |
|
|
18912
|
+
| [DEFAULT_SETTINGS](#variable-default_settings) | [parseResults](#variable-parseresults) |
|
|
18913
|
+
| [PBKDF2_NUM_ROUNDS](#variable-pbkdf2_num_rounds) | [queryOverlay](#variable-queryoverlay) |
|
|
18914
|
+
| [ProvenTxReqNonTerminalStatus](#variable-proventxreqnonterminalstatus) | [specOpFailedActions](#variable-specopfailedactions) |
|
|
18915
|
+
| [ProvenTxReqTerminalStatus](#variable-proventxreqterminalstatus) | [specOpInvalidChange](#variable-specopinvalidchange) |
|
|
18916
|
+
| [TESTNET_DEFAULT_SETTINGS](#variable-testnet_default_settings) | [specOpNoSendActions](#variable-specopnosendactions) |
|
|
18917
|
+
| [aggregateActionResults](#variable-aggregateactionresults) | [specOpSetWalletChangeParams](#variable-specopsetwalletchangeparams) |
|
|
18918
|
+
| [brc29ProtocolID](#variable-brc29protocolid) | [specOpThrowReviewActions](#variable-specopthrowreviewactions) |
|
|
18919
|
+
| [dirtyHashes](#variable-dirtyhashes) | [specOpWalletBalance](#variable-specopwalletbalance) |
|
|
18920
|
+
| [getLabelToSpecOp](#variable-getlabeltospecop) | [transactionColumnsWithoutRawTx](#variable-transactioncolumnswithoutrawtx) |
|
|
18921
|
+
| [logger](#variable-logger) | [transformVerifiableCertificatesWithTrust](#variable-transformverifiablecertificateswithtrust) |
|
|
18922
|
+
| [maxPossibleSatoshis](#variable-maxpossiblesatoshis) | [validBulkHeaderFiles](#variable-validbulkheaderfiles) |
|
|
18716
18923
|
|
|
18717
18924
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18718
18925
|
|
|
@@ -18891,83 +19098,6 @@ dirtyHashes = {
|
|
|
18891
19098
|
|
|
18892
19099
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18893
19100
|
|
|
18894
|
-
---
|
|
18895
|
-
##### Variable: getBasketToSpecOp
|
|
18896
|
-
|
|
18897
|
-
```ts
|
|
18898
|
-
getBasketToSpecOp: () => Record<string, ListOutputsSpecOp> = () => {
|
|
18899
|
-
return {
|
|
18900
|
-
[specOpWalletBalance]: {
|
|
18901
|
-
name: "totalOutputsIsWalletBalance",
|
|
18902
|
-
useBasket: "default",
|
|
18903
|
-
ignoreLimit: true,
|
|
18904
|
-
resultFromOutputs: async (s: StorageProvider, auth: AuthId, vargs: Validation.ValidListOutputsArgs, specOpTags: string[], outputs: TableOutput[]): Promise<ListOutputsResult> => {
|
|
18905
|
-
let totalOutputs = 0;
|
|
18906
|
-
for (const o of outputs)
|
|
18907
|
-
totalOutputs += o.satoshis;
|
|
18908
|
-
return { totalOutputs, outputs: [] };
|
|
18909
|
-
}
|
|
18910
|
-
},
|
|
18911
|
-
[specOpInvalidChange]: {
|
|
18912
|
-
name: "invalidChangeOutputs",
|
|
18913
|
-
useBasket: "default",
|
|
18914
|
-
ignoreLimit: true,
|
|
18915
|
-
includeOutputScripts: true,
|
|
18916
|
-
includeSpent: false,
|
|
18917
|
-
tagsToIntercept: ["release", "all"],
|
|
18918
|
-
filterOutputs: async (s: StorageProvider, auth: AuthId, vargs: Validation.ValidListOutputsArgs, specOpTags: string[], outputs: TableOutput[]): Promise<TableOutput[]> => {
|
|
18919
|
-
const filteredOutputs: TableOutput[] = [];
|
|
18920
|
-
const services = s.getServices();
|
|
18921
|
-
for (const o of outputs) {
|
|
18922
|
-
if (!o.basketId)
|
|
18923
|
-
continue;
|
|
18924
|
-
await s.validateOutputScript(o);
|
|
18925
|
-
let ok: boolean | undefined = false;
|
|
18926
|
-
if (o.lockingScript && o.lockingScript.length > 0) {
|
|
18927
|
-
ok = await services.isUtxo(o);
|
|
18928
|
-
}
|
|
18929
|
-
else {
|
|
18930
|
-
ok = undefined;
|
|
18931
|
-
}
|
|
18932
|
-
if (ok === false) {
|
|
18933
|
-
filteredOutputs.push(o);
|
|
18934
|
-
}
|
|
18935
|
-
}
|
|
18936
|
-
if (specOpTags.indexOf("release") >= 0) {
|
|
18937
|
-
for (const o of filteredOutputs) {
|
|
18938
|
-
await s.updateOutput(o.outputId, { spendable: false });
|
|
18939
|
-
o.spendable = false;
|
|
18940
|
-
}
|
|
18941
|
-
}
|
|
18942
|
-
return filteredOutputs;
|
|
18943
|
-
}
|
|
18944
|
-
},
|
|
18945
|
-
[specOpSetWalletChangeParams]: {
|
|
18946
|
-
name: "setWalletChangeParams",
|
|
18947
|
-
tagsParamsCount: 2,
|
|
18948
|
-
resultFromTags: async (s: StorageProvider, auth: AuthId, vargs: Validation.ValidListOutputsArgs, specOpTags: string[]): Promise<ListOutputsResult> => {
|
|
18949
|
-
if (specOpTags.length !== 2)
|
|
18950
|
-
throw new WERR_INVALID_PARAMETER("numberOfDesiredUTXOs and minimumDesiredUTXOValue", "valid");
|
|
18951
|
-
const numberOfDesiredUTXOs: number = verifyInteger(Number(specOpTags[0]));
|
|
18952
|
-
const minimumDesiredUTXOValue: number = verifyInteger(Number(specOpTags[1]));
|
|
18953
|
-
const basket = verifyOne(await s.findOutputBaskets({
|
|
18954
|
-
partial: { userId: verifyId(auth.userId), name: "default" }
|
|
18955
|
-
}));
|
|
18956
|
-
await s.updateOutputBasket(basket.basketId, {
|
|
18957
|
-
numberOfDesiredUTXOs,
|
|
18958
|
-
minimumDesiredUTXOValue
|
|
18959
|
-
});
|
|
18960
|
-
return { totalOutputs: 0, outputs: [] };
|
|
18961
|
-
}
|
|
18962
|
-
}
|
|
18963
|
-
};
|
|
18964
|
-
}
|
|
18965
|
-
```
|
|
18966
|
-
|
|
18967
|
-
See also: [AuthId](./client.md#interface-authid), [ListOutputsSpecOp](./storage.md#interface-listoutputsspecop), [StorageProvider](./storage.md#class-storageprovider), [TableOutput](./storage.md#interface-tableoutput), [WERR_INVALID_PARAMETER](./client.md#class-werr_invalid_parameter), [specOpInvalidChange](./client.md#variable-specopinvalidchange), [specOpSetWalletChangeParams](./client.md#variable-specopsetwalletchangeparams), [specOpWalletBalance](./client.md#variable-specopwalletbalance), [verifyId](./client.md#function-verifyid), [verifyInteger](./client.md#function-verifyinteger), [verifyOne](./client.md#function-verifyone)
|
|
18968
|
-
|
|
18969
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18970
|
-
|
|
18971
19101
|
---
|
|
18972
19102
|
##### Variable: getLabelToSpecOp
|
|
18973
19103
|
|
|
@@ -19614,6 +19744,18 @@ validBulkHeaderFiles: BulkHeaderFileInfo[] = [
|
|
|
19614
19744
|
prevHash: "00000000000000000e7dcc27c06ee353bd37260b2e7e664314c204f0324a5087",
|
|
19615
19745
|
sourceUrl: "https://cdn.projectbabbage.com/blockheaders",
|
|
19616
19746
|
validated: true
|
|
19747
|
+
},
|
|
19748
|
+
{
|
|
19749
|
+
chain: "main",
|
|
19750
|
+
count: 31772,
|
|
19751
|
+
fileHash: "NuVsRUrI5QnjILbYy4LS3A/Udl6PH/m8Y9uVguEsekM=",
|
|
19752
|
+
fileName: "mainNet_9.headers",
|
|
19753
|
+
firstHeight: 900000,
|
|
19754
|
+
lastChainWork: "0000000000000000000000000000000000000000016ab16bb9b31430588788d3",
|
|
19755
|
+
lastHash: "0000000000000000024a2f1caef4b0ffdc1a036b09f9ed7f48b538f619f32ef2",
|
|
19756
|
+
prevChainWork: "000000000000000000000000000000000000000001664db1f2d50327928007e0",
|
|
19757
|
+
prevHash: "00000000000000000e7dcc27c06ee353bd37260b2e7e664314c204f0324a5087",
|
|
19758
|
+
sourceUrl: "https://cdn.projectbabbage.com/blockheaders"
|
|
19617
19759
|
}
|
|
19618
19760
|
]
|
|
19619
19761
|
```
|