@bsv/wallet-toolbox 2.1.26 → 2.1.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/README.md +8 -17
- package/docs/client.md +282 -172
- package/docs/wallet.md +224 -115
- package/out/src/Wallet.d.ts +46 -2
- package/out/src/Wallet.d.ts.map +1 -1
- package/out/src/Wallet.js +65 -4
- package/out/src/Wallet.js.map +1 -1
- package/out/src/utility/identityUtils.d.ts +12 -6
- package/out/src/utility/identityUtils.d.ts.map +1 -1
- package/out/src/utility/identityUtils.js +78 -30
- package/out/src/utility/identityUtils.js.map +1 -1
- package/package.json +2 -2
package/docs/client.md
CHANGED
|
@@ -6,86 +6,87 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6
6
|
|
|
7
7
|
| | | |
|
|
8
8
|
| --- | --- | --- |
|
|
9
|
-
| [AdminStatsResult](#interface-adminstatsresult) | [
|
|
10
|
-
| [AggregatePostBeefTxResult](#interface-aggregatepostbeeftxresult) | [
|
|
11
|
-
| [ArcConfig](#interface-arcconfig) | [
|
|
12
|
-
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [
|
|
13
|
-
| [ArcSSEClientOptions](#interface-arcsseclientoptions) | [
|
|
14
|
-
| [ArcSSEEvent](#interface-arcsseevent) | [
|
|
15
|
-
| [AuthId](#interface-authid) | [
|
|
16
|
-
| [AuthPayload](#interface-authpayload) | [
|
|
17
|
-
| [BaseBlockHeader](#interface-baseblockheader) | [
|
|
18
|
-
| [BitailsConfig](#interface-bitailsconfig) | [
|
|
19
|
-
| [BitailsMerkleProof](#interface-bitailsmerkleproof) | [
|
|
20
|
-
| [BlockHeader](#interface-blockheader) | [
|
|
21
|
-
| [BsvExchangeRate](#interface-bsvexchangerate) | [
|
|
22
|
-
| [BulkFileDataManagerMergeResult](#interface-bulkfiledatamanagermergeresult) | [
|
|
23
|
-
| [BulkFileDataManagerOptions](#interface-bulkfiledatamanageroptions) | [
|
|
24
|
-
| [BulkHeaderFileInfo](#interface-bulkheaderfileinfo) | [
|
|
25
|
-
| [BulkHeaderFilesInfo](#interface-bulkheaderfilesinfo) | [
|
|
26
|
-
| [BulkIngestorApi](#interface-bulkingestorapi) | [
|
|
27
|
-
| [BulkIngestorBaseOptions](#interface-bulkingestorbaseoptions) | [
|
|
28
|
-
| [BulkIngestorCDNOptions](#interface-bulkingestorcdnoptions) | [
|
|
29
|
-
| [BulkIngestorWhatsOnChainOptions](#interface-bulkingestorwhatsonchainoptions) | [
|
|
30
|
-
| [BulkStorageApi](#interface-bulkstorageapi) | [
|
|
31
|
-
| [BulkStorageBaseOptions](#interface-bulkstoragebaseoptions) | [
|
|
32
|
-
| [BulkSyncResult](#interface-bulksyncresult) | [
|
|
33
|
-
| [CertOpsWallet](#interface-certopswallet) | [
|
|
34
|
-
| [Certifier](#interface-certifier) | [
|
|
35
|
-
| [ChaintracksApi](#interface-chaintracksapi) | [
|
|
36
|
-
| [ChaintracksAppendableFileApi](#interface-chaintracksappendablefileapi) | [
|
|
37
|
-
| [ChaintracksChainTrackerOptions](#interface-chaintrackschaintrackeroptions) | [
|
|
38
|
-
| [ChaintracksClientApi](#interface-chaintracksclientapi) | [
|
|
39
|
-
| [ChaintracksFetchApi](#interface-chaintracksfetchapi) | [
|
|
40
|
-
| [ChaintracksFsApi](#interface-chaintracksfsapi) | [
|
|
41
|
-
| [ChaintracksInfoApi](#interface-chaintracksinfoapi) | [
|
|
42
|
-
| [ChaintracksIngestorParams](#interface-chaintracksingestorparams) | [
|
|
43
|
-
| [ChaintracksManagementApi](#interface-chaintracksmanagementapi) | [
|
|
44
|
-
| [ChaintracksOptions](#interface-chaintracksoptions) | [
|
|
45
|
-
| [ChaintracksPackageInfoApi](#interface-chaintrackspackageinfoapi) | [
|
|
46
|
-
| [ChaintracksReadableFileApi](#interface-chaintracksreadablefileapi) | [
|
|
47
|
-
| [ChaintracksServiceClientOptions](#interface-chaintracksserviceclientoptions) | [
|
|
48
|
-
| [ChaintracksStorageApi](#interface-chaintracksstorageapi) | [
|
|
49
|
-
| [ChaintracksStorageBaseOptions](#interface-chaintracksstoragebaseoptions) | [
|
|
50
|
-
| [ChaintracksStorageBulkFileApi](#interface-chaintracksstoragebulkfileapi) | [
|
|
51
|
-
| [ChaintracksStorageIdbOptions](#interface-chaintracksstorageidboptions) | [
|
|
52
|
-
| [ChaintracksStorageIdbSchema](#interface-chaintracksstorageidbschema) | [
|
|
53
|
-
| [ChaintracksStorageIngestApi](#interface-chaintracksstorageingestapi) | [
|
|
54
|
-
| [ChaintracksStorageNoDbOptions](#interface-chaintracksstoragenodboptions) | [
|
|
55
|
-
| [ChaintracksStorageQueryApi](#interface-chaintracksstoragequeryapi) | [
|
|
56
|
-
| [ChaintracksWritableFileApi](#interface-chaintrackswritablefileapi) | [
|
|
57
|
-
| [CommitNewTxResults](#interface-commitnewtxresults) | [
|
|
58
|
-
| [CompleteAuthResponse](#interface-completeauthresponse) | [
|
|
59
|
-
| [
|
|
60
|
-
| [
|
|
61
|
-
| [
|
|
62
|
-
| [
|
|
63
|
-
| [
|
|
64
|
-
| [
|
|
65
|
-
| [
|
|
66
|
-
| [
|
|
67
|
-
| [
|
|
68
|
-
| [
|
|
69
|
-
| [
|
|
70
|
-
| [
|
|
71
|
-
| [
|
|
72
|
-
| [
|
|
73
|
-
| [
|
|
74
|
-
| [
|
|
75
|
-
| [
|
|
76
|
-
| [
|
|
77
|
-
| [
|
|
78
|
-
| [
|
|
79
|
-
| [
|
|
80
|
-
| [
|
|
81
|
-
| [
|
|
82
|
-
| [
|
|
83
|
-
| [
|
|
84
|
-
| [
|
|
85
|
-
| [
|
|
86
|
-
| [
|
|
87
|
-
| [
|
|
88
|
-
| [
|
|
9
|
+
| [AdminStatsResult](#interface-adminstatsresult) | [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [SetupWalletClient](#interface-setupwalletclient) |
|
|
10
|
+
| [AggregatePostBeefTxResult](#interface-aggregatepostbeeftxresult) | [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [SetupWalletIdb](#interface-setupwalletidb) |
|
|
11
|
+
| [ArcConfig](#interface-arcconfig) | [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [SetupWalletIdbArgs](#interface-setupwalletidbargs) |
|
|
12
|
+
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [SignActionResultX](#interface-signactionresultx) |
|
|
13
|
+
| [ArcSSEClientOptions](#interface-arcsseclientoptions) | [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [StartAuthResponse](#interface-startauthresponse) |
|
|
14
|
+
| [ArcSSEEvent](#interface-arcsseevent) | [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [StatusForTxidResult](#interface-statusfortxidresult) |
|
|
15
|
+
| [AuthId](#interface-authid) | [GetHeaderByteFileLinksResult](#interface-getheaderbytefilelinksresult) | [StopListenerToken](#interface-stoplistenertoken) |
|
|
16
|
+
| [AuthPayload](#interface-authpayload) | [GetMerklePathResult](#interface-getmerklepathresult) | [StorageAdminStats](#interface-storageadminstats) |
|
|
17
|
+
| [BaseBlockHeader](#interface-baseblockheader) | [GetRawTxResult](#interface-getrawtxresult) | [StorageCreateActionResult](#interface-storagecreateactionresult) |
|
|
18
|
+
| [BitailsConfig](#interface-bitailsconfig) | [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) |
|
|
19
|
+
| [BitailsMerkleProof](#interface-bitailsmerkleproof) | [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) |
|
|
20
|
+
| [BlockHeader](#interface-blockheader) | [GetScriptHashHistory](#interface-getscripthashhistory) | [StorageFeeModel](#interface-storagefeemodel) |
|
|
21
|
+
| [BsvExchangeRate](#interface-bsvexchangerate) | [GetScriptHashHistoryResult](#interface-getscripthashhistoryresult) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) |
|
|
22
|
+
| [BulkFileDataManagerMergeResult](#interface-bulkfiledatamanagermergeresult) | [GetStatusForTxidsResult](#interface-getstatusfortxidsresult) | [StorageIdbOptions](#interface-storageidboptions) |
|
|
23
|
+
| [BulkFileDataManagerOptions](#interface-bulkfiledatamanageroptions) | [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [StorageIdbSchema](#interface-storageidbschema) |
|
|
24
|
+
| [BulkHeaderFileInfo](#interface-bulkheaderfileinfo) | [GetUtxoStatusResult](#interface-getutxostatusresult) | [StorageIdentity](#interface-storageidentity) |
|
|
25
|
+
| [BulkHeaderFilesInfo](#interface-bulkheaderfilesinfo) | [GroupedPermissionRequest](#interface-groupedpermissionrequest) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) |
|
|
26
|
+
| [BulkIngestorApi](#interface-bulkingestorapi) | [GroupedPermissions](#interface-groupedpermissions) | [StorageProcessActionArgs](#interface-storageprocessactionargs) |
|
|
27
|
+
| [BulkIngestorBaseOptions](#interface-bulkingestorbaseoptions) | [HeightRangeApi](#interface-heightrangeapi) | [StorageProcessActionResults](#interface-storageprocessactionresults) |
|
|
28
|
+
| [BulkIngestorCDNOptions](#interface-bulkingestorcdnoptions) | [HeightRanges](#interface-heightranges) | [StorageProvenOrReq](#interface-storageprovenorreq) |
|
|
29
|
+
| [BulkIngestorWhatsOnChainOptions](#interface-bulkingestorwhatsonchainoptions) | [KdfConfig](#interface-kdfconfig) | [StorageProviderOptions](#interface-storageprovideroptions) |
|
|
30
|
+
| [BulkStorageApi](#interface-bulkstorageapi) | [KeyPair](#interface-keypair) | [StorageReaderOptions](#interface-storagereaderoptions) |
|
|
31
|
+
| [BulkStorageBaseOptions](#interface-bulkstoragebaseoptions) | [KeyPairAddress](#interface-keypairaddress) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) |
|
|
32
|
+
| [BulkSyncResult](#interface-bulksyncresult) | [ListActionsSpecOp](#interface-listactionsspecop) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) |
|
|
33
|
+
| [CertOpsWallet](#interface-certopswallet) | [ListOutputsSpecOp](#interface-listoutputsspecop) | [SyncChunk](#interface-syncchunk) |
|
|
34
|
+
| [Certifier](#interface-certifier) | [LiveBlockHeader](#interface-liveblockheader) | [SyncError](#interface-syncerror) |
|
|
35
|
+
| [ChaintracksApi](#interface-chaintracksapi) | [LiveIngestorApi](#interface-liveingestorapi) | [SyncMap](#interface-syncmap) |
|
|
36
|
+
| [ChaintracksAppendableFileApi](#interface-chaintracksappendablefileapi) | [LiveIngestorBaseOptions](#interface-liveingestorbaseoptions) | [TableCertificate](#interface-tablecertificate) |
|
|
37
|
+
| [ChaintracksChainTrackerOptions](#interface-chaintrackschaintrackeroptions) | [LiveIngestorWhatsOnChainOptions](#interface-liveingestorwhatsonchainoptions) | [TableCertificateField](#interface-tablecertificatefield) |
|
|
38
|
+
| [ChaintracksClientApi](#interface-chaintracksclientapi) | [MerklePathNote](#interface-merklepathnote) | [TableCertificateX](#interface-tablecertificatex) |
|
|
39
|
+
| [ChaintracksFetchApi](#interface-chaintracksfetchapi) | [MockChainBlockHeaderRow](#interface-mockchainblockheaderrow) | [TableCommission](#interface-tablecommission) |
|
|
40
|
+
| [ChaintracksFsApi](#interface-chaintracksfsapi) | [MockChainTransactionRow](#interface-mockchaintransactionrow) | [TableMonitorEvent](#interface-tablemonitorevent) |
|
|
41
|
+
| [ChaintracksInfoApi](#interface-chaintracksinfoapi) | [MockChainUtxoRow](#interface-mockchainutxorow) | [TableOutput](#interface-tableoutput) |
|
|
42
|
+
| [ChaintracksIngestorParams](#interface-chaintracksingestorparams) | [MonitorOptions](#interface-monitoroptions) | [TableOutputBasket](#interface-tableoutputbasket) |
|
|
43
|
+
| [ChaintracksManagementApi](#interface-chaintracksmanagementapi) | [OutPoint](#interface-outpoint) | [TableOutputTag](#interface-tableoutputtag) |
|
|
44
|
+
| [ChaintracksOptions](#interface-chaintracksoptions) | [Paged](#interface-paged) | [TableOutputTagMap](#interface-tableoutputtagmap) |
|
|
45
|
+
| [ChaintracksPackageInfoApi](#interface-chaintrackspackageinfoapi) | [ParsedBrc114ActionTimeLabels](#interface-parsedbrc114actiontimelabels) | [TableOutputX](#interface-tableoutputx) |
|
|
46
|
+
| [ChaintracksReadableFileApi](#interface-chaintracksreadablefileapi) | [ParsedOutpoint](#interface-parsedoutpoint) | [TableProvenTx](#interface-tableproventx) |
|
|
47
|
+
| [ChaintracksServiceClientOptions](#interface-chaintracksserviceclientoptions) | [PendingSignAction](#interface-pendingsignaction) | [TableProvenTxReq](#interface-tableproventxreq) |
|
|
48
|
+
| [ChaintracksStorageApi](#interface-chaintracksstorageapi) | [PendingStorageInput](#interface-pendingstorageinput) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) |
|
|
49
|
+
| [ChaintracksStorageBaseOptions](#interface-chaintracksstoragebaseoptions) | [PermissionRequest](#interface-permissionrequest) | [TableSettings](#interface-tablesettings) |
|
|
50
|
+
| [ChaintracksStorageBulkFileApi](#interface-chaintracksstoragebulkfileapi) | [PermissionToken](#interface-permissiontoken) | [TableSyncState](#interface-tablesyncstate) |
|
|
51
|
+
| [ChaintracksStorageIdbOptions](#interface-chaintracksstorageidboptions) | [PermissionsManagerConfig](#interface-permissionsmanagerconfig) | [TableTransaction](#interface-tabletransaction) |
|
|
52
|
+
| [ChaintracksStorageIdbSchema](#interface-chaintracksstorageidbschema) | [PermissionsModule](#interface-permissionsmodule) | [TableTxLabel](#interface-tabletxlabel) |
|
|
53
|
+
| [ChaintracksStorageIngestApi](#interface-chaintracksstorageingestapi) | [PostBeefResult](#interface-postbeefresult) | [TableTxLabelMap](#interface-tabletxlabelmap) |
|
|
54
|
+
| [ChaintracksStorageNoDbOptions](#interface-chaintracksstoragenodboptions) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [TableUser](#interface-tableuser) |
|
|
55
|
+
| [ChaintracksStorageQueryApi](#interface-chaintracksstoragequeryapi) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [TaskPurgeParams](#interface-taskpurgeparams) |
|
|
56
|
+
| [ChaintracksWritableFileApi](#interface-chaintrackswritablefileapi) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [TrustSettings](#interface-trustsettings) |
|
|
57
|
+
| [CommitNewTxResults](#interface-commitnewtxresults) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [TrxToken](#interface-trxtoken) |
|
|
58
|
+
| [CompleteAuthResponse](#interface-completeauthresponse) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
|
|
59
|
+
| [ContactRecord](#interface-contactrecord) | [PostTxsResult](#interface-posttxsresult) | [TxScriptOffsets](#interface-txscriptoffsets) |
|
|
60
|
+
| [ContactSource](#interface-contactsource) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [UMPToken](#interface-umptoken) |
|
|
61
|
+
| [CounterpartyPermissionRequest](#interface-counterpartypermissionrequest) | [Profile](#interface-profile) | [UMPTokenInteractor](#interface-umptokeninteractor) |
|
|
62
|
+
| [CounterpartyPermissions](#interface-counterpartypermissions) | [ProvenOrRawTx](#interface-provenorrawtx) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
|
|
63
|
+
| [CreateActionResultX](#interface-createactionresultx) | [ProvenTransactionStatus](#interface-proventransactionstatus) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
|
|
64
|
+
| [DeactivedHeader](#interface-deactivedheader) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
|
|
65
|
+
| [EntitySyncMap](#interface-entitysyncmap) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [VerifyAndRepairBeefResult](#interface-verifyandrepairbeefresult) |
|
|
66
|
+
| [EntityTimeStamp](#interface-entitytimestamp) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [WalletArgs](#interface-walletargs) |
|
|
67
|
+
| [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [WalletBalance](#interface-walletbalance) |
|
|
68
|
+
| [ExtendedVerifiableCertificate](#interface-extendedverifiablecertificate) | [ProviderCallHistory](#interface-providercallhistory) | [WalletLoggerArgs](#interface-walletloggerargs) |
|
|
69
|
+
| [FiatExchangeRates](#interface-fiatexchangerates) | [PurgeParams](#interface-purgeparams) | [WalletPermissionsManagerCallbacks](#interface-walletpermissionsmanagercallbacks) |
|
|
70
|
+
| [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [PurgeResults](#interface-purgeresults) | [WalletServices](#interface-walletservices) |
|
|
71
|
+
| [FindCertificatesArgs](#interface-findcertificatesargs) | [ReorgResult](#interface-reorgresult) | [WalletServicesOptions](#interface-walletservicesoptions) |
|
|
72
|
+
| [FindCommissionsArgs](#interface-findcommissionsargs) | [ReproveHeaderResult](#interface-reproveheaderresult) | [WalletSettings](#interface-walletsettings) |
|
|
73
|
+
| [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [ReproveProvenResult](#interface-reproveprovenresult) | [WalletSettingsManagerConfig](#interface-walletsettingsmanagerconfig) |
|
|
74
|
+
| [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [ReqHistoryNote](#interface-reqhistorynote) | [WalletSigner](#interface-walletsigner) |
|
|
75
|
+
| [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [WalletStorage](#interface-walletstorage) |
|
|
76
|
+
| [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [ReviewActionResult](#interface-reviewactionresult) | [WalletStorageInfo](#interface-walletstorageinfo) |
|
|
77
|
+
| [FindOutputTagsArgs](#interface-findoutputtagsargs) | [ReviewHeightRangeResult](#interface-reviewheightrangeresult) | [WalletStorageProvider](#interface-walletstorageprovider) |
|
|
78
|
+
| [FindOutputsArgs](#interface-findoutputsargs) | [ScriptHashHistoryResponse](#interface-scripthashhistoryresponse) | [WalletStorageReader](#interface-walletstoragereader) |
|
|
79
|
+
| [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [WalletStorageSync](#interface-walletstoragesync) |
|
|
80
|
+
| [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [WalletStorageSyncReader](#interface-walletstoragesyncreader) |
|
|
81
|
+
| [FindProvenTxsArgs](#interface-findproventxsargs) | [ServiceCall](#interface-servicecall) | [WalletStorageWriter](#interface-walletstoragewriter) |
|
|
82
|
+
| [FindSincePagedArgs](#interface-findsincepagedargs) | [ServiceCall](#interface-servicecall) | [WalletTheme](#interface-wallettheme) |
|
|
83
|
+
| [FindStaleMerkleRootsArgs](#interface-findstalemerklerootsargs) | [ServiceCallHistory](#interface-servicecallhistory) | [WhatsOnChainServicesOptions](#interface-whatsonchainservicesoptions) |
|
|
84
|
+
| [FindSyncStatesArgs](#interface-findsyncstatesargs) | [ServiceCallHistoryCounts](#interface-servicecallhistorycounts) | [WocChainInfo](#interface-wocchaininfo) |
|
|
85
|
+
| [FindTransactionsArgs](#interface-findtransactionsargs) | [ServiceToCall](#interface-servicetocall) | [WocGetHeaderByteFileLinks](#interface-wocgetheaderbytefilelinks) |
|
|
86
|
+
| [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [ServicesCallHistory](#interface-servicescallhistory) | [WocGetHeadersHeader](#interface-wocgetheadersheader) |
|
|
87
|
+
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [SetupClientWalletArgs](#interface-setupclientwalletargs) | [WocHeader](#interface-wocheader) |
|
|
88
|
+
| [FindUsersArgs](#interface-findusersargs) | [SetupClientWalletClientArgs](#interface-setupclientwalletclientargs) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
|
|
89
|
+
| [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [SetupWallet](#interface-setupwallet) | |
|
|
89
90
|
|
|
90
91
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
91
92
|
|
|
@@ -2460,6 +2461,95 @@ export interface CompleteAuthResponse {
|
|
|
2460
2461
|
|
|
2461
2462
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2462
2463
|
|
|
2464
|
+
---
|
|
2465
|
+
##### Interface: ContactRecord
|
|
2466
|
+
|
|
2467
|
+
```ts
|
|
2468
|
+
export interface ContactRecord {
|
|
2469
|
+
identityKey: PubKeyHex;
|
|
2470
|
+
type?: string;
|
|
2471
|
+
decryptedFields?: Record<string, string>;
|
|
2472
|
+
certifierInfo?: {
|
|
2473
|
+
name?: string;
|
|
2474
|
+
iconUrl?: string;
|
|
2475
|
+
description?: string;
|
|
2476
|
+
trust?: number;
|
|
2477
|
+
};
|
|
2478
|
+
}
|
|
2479
|
+
```
|
|
2480
|
+
|
|
2481
|
+
###### Property certifierInfo
|
|
2482
|
+
|
|
2483
|
+
Optional certifier metadata; missing trust defaults to `Infinity` (contacts override overlay trust).
|
|
2484
|
+
|
|
2485
|
+
```ts
|
|
2486
|
+
certifierInfo?: {
|
|
2487
|
+
name?: string;
|
|
2488
|
+
iconUrl?: string;
|
|
2489
|
+
description?: string;
|
|
2490
|
+
trust?: number;
|
|
2491
|
+
}
|
|
2492
|
+
```
|
|
2493
|
+
|
|
2494
|
+
###### Property decryptedFields
|
|
2495
|
+
|
|
2496
|
+
Optional decrypted fields. Whatever the app stored when saving the contact.
|
|
2497
|
+
|
|
2498
|
+
```ts
|
|
2499
|
+
decryptedFields?: Record<string, string>
|
|
2500
|
+
```
|
|
2501
|
+
|
|
2502
|
+
###### Property type
|
|
2503
|
+
|
|
2504
|
+
Optional certificate type (e.g. xCert / discordCert) so callers can render a badge.
|
|
2505
|
+
|
|
2506
|
+
```ts
|
|
2507
|
+
type?: string
|
|
2508
|
+
```
|
|
2509
|
+
|
|
2510
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2511
|
+
|
|
2512
|
+
---
|
|
2513
|
+
##### Interface: ContactSource
|
|
2514
|
+
|
|
2515
|
+
The preferred means of constructing a `Wallet` is with a `WalletArgs` instance.
|
|
2516
|
+
|
|
2517
|
+
Minimal interface the wallet uses to short-circuit identity discovery against the user's local
|
|
2518
|
+
contacts before hitting the overlay. The result shape matches what `discoverByIdentityKey` /
|
|
2519
|
+
`discoverByAttributes` return so callers don't have to special-case contact-sourced records.
|
|
2520
|
+
|
|
2521
|
+
Implementations typically wrap `@bsv/sdk` `ContactsManager` or another on-device source. Reads
|
|
2522
|
+
are expected to be very fast (single-digit ms against local SQLite is typical).
|
|
2523
|
+
|
|
2524
|
+
```ts
|
|
2525
|
+
export interface ContactSource {
|
|
2526
|
+
findByIdentityKey: (identityKey: PubKeyHex) => Promise<ContactRecord | null | undefined>;
|
|
2527
|
+
findByAttributes?: (attributes: Record<string, string> | string[]) => Promise<ContactRecord[]>;
|
|
2528
|
+
}
|
|
2529
|
+
```
|
|
2530
|
+
|
|
2531
|
+
See also: [ContactRecord](./client.md#interface-contactrecord)
|
|
2532
|
+
|
|
2533
|
+
###### Property findByAttributes
|
|
2534
|
+
|
|
2535
|
+
Look up contacts matching a set of attributes. May be a no-op if attribute search is unsupported.
|
|
2536
|
+
|
|
2537
|
+
```ts
|
|
2538
|
+
findByAttributes?: (attributes: Record<string, string> | string[]) => Promise<ContactRecord[]>
|
|
2539
|
+
```
|
|
2540
|
+
See also: [ContactRecord](./client.md#interface-contactrecord)
|
|
2541
|
+
|
|
2542
|
+
###### Property findByIdentityKey
|
|
2543
|
+
|
|
2544
|
+
Look up a contact by identity key. Return `null` (or undefined) if unknown.
|
|
2545
|
+
|
|
2546
|
+
```ts
|
|
2547
|
+
findByIdentityKey: (identityKey: PubKeyHex) => Promise<ContactRecord | null | undefined>
|
|
2548
|
+
```
|
|
2549
|
+
See also: [ContactRecord](./client.md#interface-contactrecord)
|
|
2550
|
+
|
|
2551
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2552
|
+
|
|
2463
2553
|
---
|
|
2464
2554
|
##### Interface: CounterpartyPermissionRequest
|
|
2465
2555
|
|
|
@@ -7724,8 +7814,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
7724
7814
|
---
|
|
7725
7815
|
##### Interface: WalletArgs
|
|
7726
7816
|
|
|
7727
|
-
The preferred means of constructing a `Wallet` is with a `WalletArgs` instance.
|
|
7728
|
-
|
|
7729
7817
|
```ts
|
|
7730
7818
|
export interface WalletArgs {
|
|
7731
7819
|
chain: Chain;
|
|
@@ -7736,11 +7824,24 @@ export interface WalletArgs {
|
|
|
7736
7824
|
privilegedKeyManager?: PrivilegedKeyManager;
|
|
7737
7825
|
settingsManager?: WalletSettingsManager;
|
|
7738
7826
|
lookupResolver?: LookupResolver;
|
|
7827
|
+
contactSource?: ContactSource;
|
|
7739
7828
|
makeLogger?: MakeWalletLogger;
|
|
7740
7829
|
}
|
|
7741
7830
|
```
|
|
7742
7831
|
|
|
7743
|
-
See also: [Chain](./client.md#type-chain), [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [WalletServices](./client.md#interface-walletservices), [WalletSettingsManager](./client.md#class-walletsettingsmanager), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
7832
|
+
See also: [Chain](./client.md#type-chain), [ContactSource](./client.md#interface-contactsource), [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [WalletServices](./client.md#interface-walletservices), [WalletSettingsManager](./client.md#class-walletsettingsmanager), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
7833
|
+
|
|
7834
|
+
###### Property contactSource
|
|
7835
|
+
|
|
7836
|
+
Optional contact source consulted before the overlay in `discoverByIdentityKey` /
|
|
7837
|
+
`discoverByAttributes`. When a contact matches, the overlay call is skipped entirely.
|
|
7838
|
+
Pass `forceRefresh: true` on the discover args to bypass both contacts and the overlay
|
|
7839
|
+
cache.
|
|
7840
|
+
|
|
7841
|
+
```ts
|
|
7842
|
+
contactSource?: ContactSource
|
|
7843
|
+
```
|
|
7844
|
+
See also: [ContactSource](./client.md#interface-contactsource)
|
|
7744
7845
|
|
|
7745
7846
|
###### Property makeLogger
|
|
7746
7847
|
|
|
@@ -15161,6 +15262,7 @@ export class Wallet implements WalletInterface, ProtoWallet {
|
|
|
15161
15262
|
lookupResolver: LookupResolver;
|
|
15162
15263
|
services?: WalletServices;
|
|
15163
15264
|
monitor?: Monitor;
|
|
15265
|
+
contactSource?: ContactSource;
|
|
15164
15266
|
identityKey: string;
|
|
15165
15267
|
beef: BeefParty;
|
|
15166
15268
|
includeAllSourceTransactions: boolean = true;
|
|
@@ -15196,8 +15298,12 @@ export class Wallet implements WalletInterface, ProtoWallet {
|
|
|
15196
15298
|
async acquireCertificate(args: AcquireCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<AcquireCertificateResult>
|
|
15197
15299
|
async relinquishCertificate(args: RelinquishCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<RelinquishCertificateResult>
|
|
15198
15300
|
async proveCertificate(args: ProveCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<ProveCertificateResult>
|
|
15199
|
-
async discoverByIdentityKey(args: DiscoverByIdentityKeyArgs
|
|
15200
|
-
|
|
15301
|
+
async discoverByIdentityKey(args: DiscoverByIdentityKeyArgs & {
|
|
15302
|
+
forceRefresh?: boolean;
|
|
15303
|
+
}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<DiscoverCertificatesResult>
|
|
15304
|
+
async discoverByAttributes(args: DiscoverByAttributesArgs & {
|
|
15305
|
+
forceRefresh?: boolean;
|
|
15306
|
+
}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<DiscoverCertificatesResult>
|
|
15201
15307
|
verifyReturnedTxidOnly(beef: Beef, knownTxids?: string[]): Beef
|
|
15202
15308
|
verifyReturnedTxidOnlyAtomicBEEF(beef: AtomicBEEF, knownTxids?: string[]): AtomicBEEF
|
|
15203
15309
|
verifyReturnedTxidOnlyBEEF(beef: BEEF): BEEF
|
|
@@ -15226,7 +15332,7 @@ export class Wallet implements WalletInterface, ProtoWallet {
|
|
|
15226
15332
|
}
|
|
15227
15333
|
```
|
|
15228
15334
|
|
|
15229
|
-
See also: [Chain](./client.md#type-chain), [KeyPair](./client.md#interface-keypair), [Monitor](./monitor.md#class-monitor), [PendingSignAction](./client.md#interface-pendingsignaction), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [StorageIdentity](./client.md#interface-storageidentity), [WalletArgs](./client.md#interface-walletargs), [WalletBalance](./client.md#interface-walletbalance), [WalletServices](./client.md#interface-walletservices), [WalletSettingsManager](./client.md#class-walletsettingsmanager), [WalletSigner](./client.md#class-walletsigner), [WalletStorageManager](./storage.md#class-walletstoragemanager), [createAction](./storage.md#function-createaction), [getIdentityKey](./client.md#function-getidentitykey), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [logWalletError](./client.md#function-logwalleterror), [logger](./client.md#variable-logger), [proveCertificate](./client.md#function-provecertificate), [signAction](./client.md#function-signaction)
|
|
15335
|
+
See also: [Chain](./client.md#type-chain), [ContactSource](./client.md#interface-contactsource), [KeyPair](./client.md#interface-keypair), [Monitor](./monitor.md#class-monitor), [PendingSignAction](./client.md#interface-pendingsignaction), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [StorageIdentity](./client.md#interface-storageidentity), [WalletArgs](./client.md#interface-walletargs), [WalletBalance](./client.md#interface-walletbalance), [WalletServices](./client.md#interface-walletservices), [WalletSettingsManager](./client.md#class-walletsettingsmanager), [WalletSigner](./client.md#class-walletsigner), [WalletStorageManager](./storage.md#class-walletstoragemanager), [createAction](./storage.md#function-createaction), [getIdentityKey](./client.md#function-getidentitykey), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [logWalletError](./client.md#function-logwalleterror), [logger](./client.md#variable-logger), [proveCertificate](./client.md#function-provecertificate), [signAction](./client.md#function-signaction)
|
|
15230
15336
|
|
|
15231
15337
|
###### Property autoKnownTxids
|
|
15232
15338
|
|
|
@@ -16670,73 +16776,74 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
16670
16776
|
|
|
16671
16777
|
| | | |
|
|
16672
16778
|
| --- | --- | --- |
|
|
16673
|
-
| [WalletErrorFromJson](#function-walleterrorfromjson) | [
|
|
16674
|
-
| [WocHeadersBulkListener](#function-wocheadersbulklistener) | [internalizeAction](#function-internalizeaction) | [
|
|
16675
|
-
| [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [
|
|
16676
|
-
| [WocHeadersLiveListener](#function-wocheaderslivelistener) | [
|
|
16677
|
-
| [WocHeadersLiveListener_test](#function-wocheaderslivelistener_test) | [
|
|
16678
|
-
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [
|
|
16679
|
-
| [addWork](#function-addwork) | [
|
|
16680
|
-
| [arcDefaultUrl](#function-arcdefaulturl) | [
|
|
16681
|
-
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [
|
|
16682
|
-
| [arraysEqual](#function-arraysequal) | [
|
|
16683
|
-
| [asArray](#function-asarray) | [
|
|
16684
|
-
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [
|
|
16685
|
-
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [
|
|
16686
|
-
| [asBsvSdkScript](#function-asbsvsdkscript) | [
|
|
16687
|
-
| [asBsvSdkTx](#function-asbsvsdktx) | [
|
|
16688
|
-
| [asString](#function-asstring) | [
|
|
16689
|
-
| [asUint8Array](#function-asuint8array) | [
|
|
16690
|
-
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [
|
|
16691
|
-
| [blockHash](#function-blockhash) | [
|
|
16692
|
-
| [buildBeefForOutpoints](#function-buildbeefforoutpoints) | [
|
|
16693
|
-
| [buildChaintracksOptionsWithIngestors](#function-buildchaintracksoptionswithingestors) | [
|
|
16694
|
-
| [buildSignableTransaction](#function-buildsignabletransaction) | [
|
|
16695
|
-
| [classifyMerklePathResponse](#function-classifymerklepathresponse) | [
|
|
16696
|
-
| [classifyReqStatus](#function-classifyreqstatus) | [
|
|
16697
|
-
| [completeSignedTransaction](#function-completesignedtransaction) | [
|
|
16698
|
-
| [computeMerklePath](#function-computemerklepath) | [
|
|
16699
|
-
| [computeMerkleRoot](#function-computemerkleroot) | [
|
|
16700
|
-
| [convertBitsToTarget](#function-convertbitstotarget) | [
|
|
16701
|
-
| [convertBitsToWork](#function-convertbitstowork) | [
|
|
16702
|
-
| [convertBufferToUint32](#function-convertbuffertouint32) | [
|
|
16703
|
-
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [
|
|
16704
|
-
| [convertUint32ToBuffer](#function-convertuint32tobuffer) | [
|
|
16705
|
-
| [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [
|
|
16706
|
-
| [createAction](#function-createaction) | [matchesProvenTxReqPartial](#function-matchesproventxreqpartial) | [upgradeTxLabelsMap](#function-upgradetxlabelsmap) |
|
|
16779
|
+
| [WalletErrorFromJson](#function-walleterrorfromjson) | [internalizeAction](#function-internalizeaction) | [sha256HashOfBinaryFile](#function-sha256hashofbinaryfile) |
|
|
16780
|
+
| [WocHeadersBulkListener](#function-wocheadersbulklistener) | [internalizeAction](#function-internalizeaction) | [shareReqsWithWorld](#function-sharereqswithworld) |
|
|
16781
|
+
| [WocHeadersBulkListener_test](#function-wocheadersbulklistener_test) | [isBaseBlockHeader](#function-isbaseblockheader) | [signAction](#function-signaction) |
|
|
16782
|
+
| [WocHeadersLiveListener](#function-wocheaderslivelistener) | [isBlockHeader](#function-isblockheader) | [signAndComplete](#function-signandcomplete) |
|
|
16783
|
+
| [WocHeadersLiveListener_test](#function-wocheaderslivelistener_test) | [isCreateActionSpecOp](#function-iscreateactionspecop) | [stampLog](#function-stamplog) |
|
|
16784
|
+
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [isKnownValidBulkHeaderFile](#function-isknownvalidbulkheaderfile) | [stampLogFormat](#function-stamplogformat) |
|
|
16785
|
+
| [addWork](#function-addwork) | [isListActionsSpecOp](#function-islistactionsspecop) | [subWork](#function-subwork) |
|
|
16786
|
+
| [arcDefaultUrl](#function-arcdefaulturl) | [isListOutputsSpecOp](#function-islistoutputsspecop) | [swapByteOrder](#function-swapbyteorder) |
|
|
16787
|
+
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [isLive](#function-islive) | [throwDummyReviewActions](#function-throwdummyreviewactions) |
|
|
16788
|
+
| [arraysEqual](#function-arraysequal) | [isLiveBlockHeader](#function-isliveblockheader) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) |
|
|
16789
|
+
| [asArray](#function-asarray) | [isMoreWork](#function-ismorework) | [toLookupNetworkPreset](#function-tolookupnetworkpreset) |
|
|
16790
|
+
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [keyOffsetToHashedSecret](#function-keyoffsettohashedsecret) | [toWalletNetwork](#function-towalletnetwork) |
|
|
16791
|
+
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [listActionsIdb](#function-listactionsidb) | [transactionInputSize](#function-transactioninputsize) |
|
|
16792
|
+
| [asBsvSdkScript](#function-asbsvsdkscript) | [listCertificates](#function-listcertificates) | [transactionOutputSize](#function-transactionoutputsize) |
|
|
16793
|
+
| [asBsvSdkTx](#function-asbsvsdktx) | [listOutputsIdb](#function-listoutputsidb) | [transactionSize](#function-transactionsize) |
|
|
16794
|
+
| [asString](#function-asstring) | [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) |
|
|
16795
|
+
| [asUint8Array](#function-asuint8array) | [logCreateActionArgs](#function-logcreateactionargs) | [updateExchangeratesapi](#function-updateexchangeratesapi) |
|
|
16796
|
+
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [logWalletError](#function-logwalleterror) | [updateReqsFromAggregateResults](#function-updatereqsfromaggregateresults) |
|
|
16797
|
+
| [blockHash](#function-blockhash) | [makeAtomicBeef](#function-makeatomicbeef) | [upgradeAllStoresV1](#function-upgradeallstoresv1) |
|
|
16798
|
+
| [buildBeefForOutpoints](#function-buildbeefforoutpoints) | [makeBrc114ActionTimeLabel](#function-makebrc114actiontimelabel) | [upgradeCertificateFields](#function-upgradecertificatefields) |
|
|
16799
|
+
| [buildChaintracksOptionsWithIngestors](#function-buildchaintracksoptionswithingestors) | [makeChangeLock](#function-makechangelock) | [upgradeCertificates](#function-upgradecertificates) |
|
|
16800
|
+
| [buildSignableTransaction](#function-buildsignabletransaction) | [makeMerklePathNote](#function-makemerklepathnote) | [upgradeCommissions](#function-upgradecommissions) |
|
|
16801
|
+
| [classifyMerklePathResponse](#function-classifymerklepathresponse) | [markStaleInputsAsSpent](#function-markstaleinputsasspent) | [upgradeMonitorEvents](#function-upgrademonitorevents) |
|
|
16802
|
+
| [classifyReqStatus](#function-classifyreqstatus) | [matchesCertificateFieldPartial](#function-matchescertificatefieldpartial) | [upgradeOutputBaskets](#function-upgradeoutputbaskets) |
|
|
16803
|
+
| [completeSignedTransaction](#function-completesignedtransaction) | [matchesCertificatePartial](#function-matchescertificatepartial) | [upgradeOutputTags](#function-upgradeoutputtags) |
|
|
16804
|
+
| [computeMerklePath](#function-computemerklepath) | [matchesCommissionPartial](#function-matchescommissionpartial) | [upgradeOutputTagsMap](#function-upgradeoutputtagsmap) |
|
|
16805
|
+
| [computeMerkleRoot](#function-computemerkleroot) | [matchesMonitorEventPartial](#function-matchesmonitoreventpartial) | [upgradeOutputs](#function-upgradeoutputs) |
|
|
16806
|
+
| [convertBitsToTarget](#function-convertbitstotarget) | [matchesOutputBasketPartial](#function-matchesoutputbasketpartial) | [upgradeProvenTxReqs](#function-upgradeproventxreqs) |
|
|
16807
|
+
| [convertBitsToWork](#function-convertbitstowork) | [matchesOutputPartial](#function-matchesoutputpartial) | [upgradeProvenTxs](#function-upgradeproventxs) |
|
|
16808
|
+
| [convertBufferToUint32](#function-convertbuffertouint32) | [matchesOutputTagMapPartial](#function-matchesoutputtagmappartial) | [upgradeSyncStates](#function-upgradesyncstates) |
|
|
16809
|
+
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [matchesOutputTagPartial](#function-matchesoutputtagpartial) | [upgradeTransactions](#function-upgradetransactions) |
|
|
16810
|
+
| [convertUint32ToBuffer](#function-convertuint32tobuffer) | [matchesProvenTxPartial](#function-matchesproventxpartial) | [upgradeTxLabels](#function-upgradetxlabels) |
|
|
16811
|
+
| [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [matchesProvenTxReqPartial](#function-matchesproventxreqpartial) | [upgradeTxLabelsMap](#function-upgradetxlabelsmap) |
|
|
16707
16812
|
| [createAction](#function-createaction) | [matchesSyncStatePartial](#function-matchessyncstatepartial) | [upgradeUsers](#function-upgradeusers) |
|
|
16708
|
-
| [
|
|
16709
|
-
| [
|
|
16710
|
-
| [
|
|
16711
|
-
| [
|
|
16712
|
-
| [
|
|
16713
|
-
| [
|
|
16714
|
-
| [
|
|
16715
|
-
| [
|
|
16716
|
-
| [
|
|
16717
|
-
| [
|
|
16718
|
-
| [
|
|
16719
|
-
| [
|
|
16720
|
-
| [
|
|
16721
|
-
| [
|
|
16722
|
-
| [
|
|
16723
|
-
| [
|
|
16724
|
-
| [
|
|
16725
|
-
| [
|
|
16726
|
-
| [
|
|
16727
|
-
| [
|
|
16728
|
-
| [
|
|
16729
|
-
| [
|
|
16730
|
-
| [
|
|
16731
|
-
| [
|
|
16732
|
-
| [
|
|
16733
|
-
| [
|
|
16734
|
-
| [
|
|
16735
|
-
| [
|
|
16736
|
-
| [
|
|
16737
|
-
| [
|
|
16738
|
-
| [
|
|
16739
|
-
| [
|
|
16813
|
+
| [createAction](#function-createaction) | [matchesTransactionPartial](#function-matchestransactionpartial) | [validBulkHeaderFilesByFileHash](#function-validbulkheaderfilesbyfilehash) |
|
|
16814
|
+
| [createCoinbaseTransaction](#function-createcoinbasetransaction) | [matchesTxLabelMapPartial](#function-matchestxlabelmappartial) | [validateAgainstDirtyHashes](#function-validateagainstdirtyhashes) |
|
|
16815
|
+
| [createDefaultIdbChaintracksOptions](#function-createdefaultidbchaintracksoptions) | [matchesTxLabelPartial](#function-matchestxlabelpartial) | [validateBufferOfHeaders](#function-validatebufferofheaders) |
|
|
16816
|
+
| [createDefaultNoDbChaintracksOptions](#function-createdefaultnodbchaintracksoptions) | [maxDate](#function-maxdate) | [validateBulkFileData](#function-validatebulkfiledata) |
|
|
16817
|
+
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [mergeInputBeefs](#function-mergeinputbeefs) | [validateDate](#function-validatedate) |
|
|
16818
|
+
| [createIdbChaintracks](#function-createidbchaintracks) | [mergeInputsIntoBeef](#function-mergeinputsintobeef) | [validateEntities](#function-validateentities) |
|
|
16819
|
+
| [createNoDbChaintracks](#function-createnodbchaintracks) | [notifyTransactionsOfProof](#function-notifytransactionsofproof) | [validateEntity](#function-validateentity) |
|
|
16820
|
+
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [offsetPrivKey](#function-offsetprivkey) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) |
|
|
16821
|
+
| [createSyncMap](#function-createsyncmap) | [offsetPubKey](#function-offsetpubkey) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) |
|
|
16822
|
+
| [dateMatches](#function-datematches) | [optionalArraysEqual](#function-optionalarraysequal) | [validateGenesisHeader](#function-validategenesisheader) |
|
|
16823
|
+
| [deserializeBaseBlockHeader](#function-deserializebaseblockheader) | [parseBrc114ActionTimeLabels](#function-parsebrc114actiontimelabels) | [validateHeaderDifficulty](#function-validateheaderdifficulty) |
|
|
16824
|
+
| [deserializeBaseBlockHeaders](#function-deserializebaseblockheaders) | [parseOutpoint](#function-parseoutpoint) | [validateHeaderFormat](#function-validateheaderformat) |
|
|
16825
|
+
| [deserializeBlockHeader](#function-deserializeblockheader) | [parseResults$](#function-parseresults$) | [validateScriptHash](#function-validatescripthash) |
|
|
16826
|
+
| [deserializeBlockHeaders](#function-deserializeblockheaders) | [parseTxAndAssertId](#function-parsetxandassertid) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
|
|
16827
|
+
| [doubleSha256BE](#function-doublesha256be) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
|
|
16828
|
+
| [doubleSha256LE](#function-doublesha256le) | [partitionActionLabels](#function-partitionactionlabels) | [validateSyncChunkEntities](#function-validatesyncchunkentities) |
|
|
16829
|
+
| [fundWalletFromP2PKHOutpoints](#function-fundwalletfromp2pkhoutpoints) | [populateUtxoDetails](#function-populateutxodetails) | [varUintSize](#function-varuintsize) |
|
|
16830
|
+
| [generateChangeSdk](#function-generatechangesdk) | [processAction](#function-processaction) | [verifyHexString](#function-verifyhexstring) |
|
|
16831
|
+
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [processAction](#function-processaction) | [verifyId](#function-verifyid) |
|
|
16832
|
+
| [genesisBuffer](#function-genesisbuffer) | [proveCertificate](#function-provecertificate) | [verifyInteger](#function-verifyinteger) |
|
|
16833
|
+
| [genesisHeader](#function-genesisheader) | [purgeDataIdb](#function-purgedataidb) | [verifyNumber](#function-verifynumber) |
|
|
16834
|
+
| [getBeefForTransaction](#function-getbeeffortransaction) | [randomBytes](#function-randombytes) | [verifyOne](#function-verifyone) |
|
|
16835
|
+
| [getBeefForTxid](#function-getbeeffortxid) | [randomBytesBase64](#function-randombytesbase64) | [verifyOneOrNone](#function-verifyoneornone) |
|
|
16836
|
+
| [getExchangeRatesIo](#function-getexchangeratesio) | [randomBytesHex](#function-randombyteshex) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
|
|
16837
|
+
| [getIdentityKey](#function-getidentitykey) | [readUInt32BE](#function-readuint32be) | [verifyP2PKHOwnership](#function-verifyp2pkhownership) |
|
|
16838
|
+
| [getListOutputsSpecOp](#function-getlistoutputsspecop) | [readUInt32LE](#function-readuint32le) | [verifyTruthy](#function-verifytruthy) |
|
|
16839
|
+
| [getProofs](#function-getproofs) | [redeemServiceCharges](#function-redeemservicecharges) | [verifyUnlockScripts](#function-verifyunlockscripts) |
|
|
16840
|
+
| [getSyncChunk](#function-getsyncchunk) | [resolveAutoSigned](#function-resolveautosigned) | [wait](#function-wait) |
|
|
16841
|
+
| [getWhatsOnChainBlockHeaderByHash](#function-getwhatsonchainblockheaderbyhash) | [reviewStatusIdb](#function-reviewstatusidb) | [wocGetHeadersHeaderToBlockHeader](#function-wocgetheadersheadertoblockheader) |
|
|
16842
|
+
| [handlePostRawTxErrorResponse](#function-handlepostrawtxerrorresponse) | [selectBulkHeaderFiles](#function-selectbulkheaderfiles) | [workBNtoBuffer](#function-workbntobuffer) |
|
|
16843
|
+
| [handleScriptHashHistoryCatch](#function-handlescripthashhistorycatch) | [serializeBaseBlockHeader](#function-serializebaseblockheader) | [writeUInt32BE](#function-writeuint32be) |
|
|
16844
|
+
| [handleScriptHashHistoryResponse](#function-handlescripthashhistoryresponse) | [serializeBaseBlockHeaders](#function-serializebaseblockheaders) | [writeUInt32LE](#function-writeuint32le) |
|
|
16845
|
+
| [handleUtxoConnReset](#function-handleutxoconnreset) | [setDisableDoubleSpendCheckForTest](#function-setdisabledoublespendcheckfortest) | |
|
|
16846
|
+
| [importSingleOutpoint](#function-importsingleoutpoint) | [sha256Hash](#function-sha256hash) | |
|
|
16740
16847
|
|
|
16741
16848
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
16742
16849
|
|
|
@@ -18606,6 +18713,17 @@ See also: [ParsedOutpoint](./client.md#interface-parsedoutpoint)
|
|
|
18606
18713
|
|
|
18607
18714
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18608
18715
|
|
|
18716
|
+
---
|
|
18717
|
+
##### Function: parseResults$
|
|
18718
|
+
|
|
18719
|
+
```ts
|
|
18720
|
+
export async function* parseResults$(lookupResult: LookupAnswer): AsyncIterable<VerifiableCertificate>
|
|
18721
|
+
```
|
|
18722
|
+
|
|
18723
|
+
See also: [parseResults](./client.md#variable-parseresults)
|
|
18724
|
+
|
|
18725
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
18726
|
+
|
|
18609
18727
|
---
|
|
18610
18728
|
##### Function: parseTxAndAssertId
|
|
18611
18729
|
|
|
@@ -20744,26 +20862,18 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
20744
20862
|
|
|
20745
20863
|
```ts
|
|
20746
20864
|
parseResults = async (lookupResult: LookupAnswer): Promise<VerifiableCertificate[]> => {
|
|
20747
|
-
if (lookupResult.type
|
|
20748
|
-
|
|
20749
|
-
|
|
20750
|
-
|
|
20751
|
-
|
|
20752
|
-
|
|
20753
|
-
|
|
20754
|
-
|
|
20755
|
-
|
|
20756
|
-
|
|
20757
|
-
verifiableCert.decryptedFields = decryptedFields;
|
|
20758
|
-
parsedResults.push(verifiableCert);
|
|
20759
|
-
}
|
|
20760
|
-
catch (error) {
|
|
20761
|
-
console.error(error);
|
|
20762
|
-
}
|
|
20763
|
-
}
|
|
20764
|
-
return parsedResults;
|
|
20865
|
+
if (lookupResult.type !== "output-list")
|
|
20866
|
+
return [];
|
|
20867
|
+
const parsedResults: VerifiableCertificate[] = [];
|
|
20868
|
+
const shouldYield = isUiRuntime();
|
|
20869
|
+
for (const output of lookupResult.outputs) {
|
|
20870
|
+
if (shouldYield)
|
|
20871
|
+
await yieldToUi();
|
|
20872
|
+
const cert = await parseOne(output);
|
|
20873
|
+
if (cert != null)
|
|
20874
|
+
parsedResults.push(cert);
|
|
20765
20875
|
}
|
|
20766
|
-
return
|
|
20876
|
+
return parsedResults;
|
|
20767
20877
|
}
|
|
20768
20878
|
```
|
|
20769
20879
|
|
|
@@ -20777,7 +20887,7 @@ queryOverlay = async (query: unknown, resolver: LookupResolver): Promise<Verifia
|
|
|
20777
20887
|
const results = await resolver.query({
|
|
20778
20888
|
service: "ls_identity",
|
|
20779
20889
|
query
|
|
20780
|
-
});
|
|
20890
|
+
}, undefined, { graceMs: 300 });
|
|
20781
20891
|
return await parseResults(results);
|
|
20782
20892
|
}
|
|
20783
20893
|
```
|