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