@bsv/wallet-toolbox 2.4.1 → 2.4.3
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 +33 -0
- package/README.md +41 -0
- package/docs/client.md +417 -173
- package/docs/services.md +51 -26
- package/docs/storage.md +367 -76
- package/docs/wallet.md +384 -140
- package/out/src/Wallet.d.ts +1 -1
- package/out/src/Wallet.d.ts.map +1 -1
- package/out/src/Wallet.js +8 -7
- package/out/src/Wallet.js.map +1 -1
- package/out/src/WalletPermissionsManager.d.ts +33 -0
- package/out/src/WalletPermissionsManager.d.ts.map +1 -1
- package/out/src/WalletPermissionsManager.js +132 -37
- package/out/src/WalletPermissionsManager.js.map +1 -1
- package/out/src/monitor/tasks/TaskArcSSE.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskArcSSE.js +11 -7
- package/out/src/monitor/tasks/TaskArcSSE.js.map +1 -1
- package/out/src/monitor/tasks/TaskCheckForProofs.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskCheckForProofs.js +10 -10
- package/out/src/monitor/tasks/TaskCheckForProofs.js.map +1 -1
- package/out/src/monitor/tasks/TaskReviewStatus.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskReviewStatus.js +7 -2
- package/out/src/monitor/tasks/TaskReviewStatus.js.map +1 -1
- package/out/src/monitor/tasks/TaskUnFail.d.ts.map +1 -1
- package/out/src/monitor/tasks/TaskUnFail.js +2 -57
- package/out/src/monitor/tasks/TaskUnFail.js.map +1 -1
- package/out/src/sdk/WalletServices.interfaces.d.ts +1 -0
- package/out/src/sdk/WalletServices.interfaces.d.ts.map +1 -1
- package/out/src/sdk/WalletStorage.interfaces.d.ts +10 -4
- package/out/src/sdk/WalletStorage.interfaces.d.ts.map +1 -1
- package/out/src/sdk/types.d.ts +1 -1
- package/out/src/sdk/types.d.ts.map +1 -1
- package/out/src/services/Services.d.ts.map +1 -1
- package/out/src/services/Services.js +39 -19
- package/out/src/services/Services.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/GoChaintracksServiceClient.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/GoChaintracksServiceClient.js +4 -0
- package/out/src/services/chaintracker/chaintracks/GoChaintracksServiceClient.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Ingest/WhatsOnChainIngestorWs.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Ingest/WhatsOnChainIngestorWs.js +2 -0
- package/out/src/services/chaintracker/chaintracks/Ingest/WhatsOnChainIngestorWs.js.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageNoDb.d.ts.map +1 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageNoDb.js +2 -1
- package/out/src/services/chaintracker/chaintracks/Storage/ChaintracksStorageNoDb.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 -0
- package/out/src/services/chaintracker/chaintracks/util/blockHeaderUtilities.js.map +1 -1
- package/out/src/services/createDefaultWalletServicesOptions.d.ts.map +1 -1
- package/out/src/services/createDefaultWalletServicesOptions.js +17 -3
- package/out/src/services/createDefaultWalletServicesOptions.js.map +1 -1
- package/out/src/services/networkConfig.d.ts +29 -0
- package/out/src/services/networkConfig.d.ts.map +1 -0
- package/out/src/services/networkConfig.js +54 -0
- package/out/src/services/networkConfig.js.map +1 -0
- package/out/src/services/providers/Arcade.d.ts.map +1 -1
- package/out/src/services/providers/Arcade.js +6 -2
- package/out/src/services/providers/Arcade.js.map +1 -1
- package/out/src/services/providers/SdkWhatsOnChain.d.ts +1 -1
- package/out/src/services/providers/SdkWhatsOnChain.d.ts.map +1 -1
- package/out/src/services/providers/SdkWhatsOnChain.js +12 -4
- package/out/src/services/providers/SdkWhatsOnChain.js.map +1 -1
- package/out/src/signer/methods/buildSignableTransaction.d.ts.map +1 -1
- package/out/src/signer/methods/buildSignableTransaction.js +3 -1
- package/out/src/signer/methods/buildSignableTransaction.js.map +1 -1
- package/out/src/signer/methods/completeSignedTransaction.d.ts.map +1 -1
- package/out/src/signer/methods/completeSignedTransaction.js +5 -3
- package/out/src/signer/methods/completeSignedTransaction.js.map +1 -1
- package/out/src/signer/methods/createAction.d.ts.map +1 -1
- package/out/src/signer/methods/createAction.js +12 -5
- package/out/src/signer/methods/createAction.js.map +1 -1
- package/out/src/signer/methods/resultBeef.d.ts +4 -0
- package/out/src/signer/methods/resultBeef.d.ts.map +1 -0
- package/out/src/signer/methods/resultBeef.js +12 -0
- package/out/src/signer/methods/resultBeef.js.map +1 -0
- package/out/src/signer/methods/signAction.d.ts.map +1 -1
- package/out/src/signer/methods/signAction.js +6 -1
- package/out/src/signer/methods/signAction.js.map +1 -1
- package/out/src/storage/StorageProvider.d.ts +17 -0
- package/out/src/storage/StorageProvider.d.ts.map +1 -1
- package/out/src/storage/StorageProvider.js +206 -13
- package/out/src/storage/StorageProvider.js.map +1 -1
- package/out/src/storage/index.all.d.ts +1 -0
- package/out/src/storage/index.all.d.ts.map +1 -1
- package/out/src/storage/index.all.js +1 -0
- package/out/src/storage/index.all.js.map +1 -1
- package/out/src/storage/methods/createAction.js +17 -4
- package/out/src/storage/methods/createAction.js.map +1 -1
- package/out/src/storage/methods/getBeefForTransaction.d.ts.map +1 -1
- package/out/src/storage/methods/getBeefForTransaction.js +47 -24
- package/out/src/storage/methods/getBeefForTransaction.js.map +1 -1
- package/out/src/storage/methods/internalizeAction.js +3 -3
- package/out/src/storage/methods/internalizeAction.js.map +1 -1
- package/out/src/storage/methods/processAction.d.ts.map +1 -1
- package/out/src/storage/methods/processAction.js +5 -4
- package/out/src/storage/methods/processAction.js.map +1 -1
- package/out/src/storage/remoting/BinaryJson.d.ts +10 -0
- package/out/src/storage/remoting/BinaryJson.d.ts.map +1 -0
- package/out/src/storage/remoting/BinaryJson.js +172 -0
- package/out/src/storage/remoting/BinaryJson.js.map +1 -0
- package/out/src/storage/remoting/KnexSessionManager.d.ts +37 -0
- package/out/src/storage/remoting/KnexSessionManager.d.ts.map +1 -0
- package/out/src/storage/remoting/KnexSessionManager.js +198 -0
- package/out/src/storage/remoting/KnexSessionManager.js.map +1 -0
- package/out/src/storage/remoting/StorageClient.d.ts +2 -2
- package/out/src/storage/remoting/StorageClient.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageClient.js +14 -5
- package/out/src/storage/remoting/StorageClient.js.map +1 -1
- package/out/src/storage/remoting/StorageClientBase.d.ts +11 -1
- package/out/src/storage/remoting/StorageClientBase.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageClientBase.js +4 -1
- package/out/src/storage/remoting/StorageClientBase.js.map +1 -1
- package/out/src/storage/remoting/StorageMobile.d.ts +2 -2
- package/out/src/storage/remoting/StorageMobile.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageMobile.js +14 -5
- package/out/src/storage/remoting/StorageMobile.js.map +1 -1
- package/out/src/storage/remoting/StorageServer.d.ts +10 -0
- package/out/src/storage/remoting/StorageServer.d.ts.map +1 -1
- package/out/src/storage/remoting/StorageServer.js +48 -21
- package/out/src/storage/remoting/StorageServer.js.map +1 -1
- package/out/src/storage/schema/KnexMigrations.d.ts +2 -0
- package/out/src/storage/schema/KnexMigrations.d.ts.map +1 -1
- package/out/src/storage/schema/KnexMigrations.js +34 -1
- package/out/src/storage/schema/KnexMigrations.js.map +1 -1
- package/out/src/storage/schema/tables/TableAuthSession.d.ts +20 -0
- package/out/src/storage/schema/tables/TableAuthSession.d.ts.map +1 -0
- package/out/src/storage/schema/tables/TableAuthSession.js +15 -0
- package/out/src/storage/schema/tables/TableAuthSession.js.map +1 -0
- package/out/src/storage/schema/tables/index.d.ts +1 -0
- package/out/src/storage/schema/tables/index.d.ts.map +1 -1
- package/out/src/storage/schema/tables/index.js +1 -0
- package/out/src/storage/schema/tables/index.js.map +1 -1
- package/out/src/storage/storageProviderHelpers.d.ts +5 -4
- package/out/src/storage/storageProviderHelpers.d.ts.map +1 -1
- package/out/src/storage/storageProviderHelpers.js +7 -6
- package/out/src/storage/storageProviderHelpers.js.map +1 -1
- package/out/src/utility/utilityHelpers.d.ts.map +1 -1
- package/out/src/utility/utilityHelpers.js +2 -0
- package/out/src/utility/utilityHelpers.js.map +1 -1
- package/package.json +5 -4
package/docs/wallet.md
CHANGED
|
@@ -6,71 +6,71 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6
6
|
|
|
7
7
|
| | | |
|
|
8
8
|
| --- | --- | --- |
|
|
9
|
-
| [AdminStatsResult](#interface-adminstatsresult) | [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [
|
|
10
|
-
| [AggregatePostBeefTxResult](#interface-aggregatepostbeeftxresult) | [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [
|
|
11
|
-
| [ArcConfig](#interface-arcconfig) | [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [
|
|
12
|
-
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [
|
|
13
|
-
| [ArcSSEClientOptions](#interface-arcsseclientoptions) | [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [
|
|
14
|
-
| [ArcSSEEvent](#interface-arcsseevent) | [GetMerklePathResult](#interface-getmerklepathresult) | [
|
|
15
|
-
| [AuthId](#interface-authid) | [GetRawTxResult](#interface-getrawtxresult) | [
|
|
16
|
-
| [BaseBlockHeader](#interface-baseblockheader) | [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [
|
|
17
|
-
| [BitailsConfig](#interface-bitailsconfig) | [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [
|
|
18
|
-
| [BitailsMerkleProof](#interface-bitailsmerkleproof) | [GetScriptHashHistory](#interface-getscripthashhistory) | [
|
|
19
|
-
| [BlockHeader](#interface-blockheader) | [GetScriptHashHistoryResult](#interface-getscripthashhistoryresult) | [
|
|
20
|
-
| [BsvExchangeRate](#interface-bsvexchangerate) | [GetStatusForTxidsResult](#interface-getstatusfortxidsresult) | [
|
|
21
|
-
| [BulkFileDataManagerMergeResult](#interface-bulkfiledatamanagermergeresult) | [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [
|
|
22
|
-
| [BulkFileDataManagerOptions](#interface-bulkfiledatamanageroptions) | [GetUtxoStatusResult](#interface-getutxostatusresult) | [
|
|
23
|
-
| [BulkHeaderFileInfo](#interface-bulkheaderfileinfo) | [HeightRangeApi](#interface-heightrangeapi) | [
|
|
24
|
-
| [BulkHeaderFilesInfo](#interface-bulkheaderfilesinfo) | [HeightRanges](#interface-heightranges) | [
|
|
25
|
-
| [CertOpsWallet](#interface-certopswallet) | [KeyPair](#interface-keypair) | [
|
|
26
|
-
| [Certifier](#interface-certifier) | [LiveBlockHeader](#interface-liveblockheader) | [
|
|
27
|
-
| [ChaintracksApi](#interface-chaintracksapi) | [MerklePathNote](#interface-merklepathnote) | [
|
|
28
|
-
| [ChaintracksAppendableFileApi](#interface-chaintracksappendablefileapi) | [MockChainBlockHeaderRow](#interface-mockchainblockheaderrow) | [
|
|
29
|
-
| [ChaintracksChainTrackerOptions](#interface-chaintrackschaintrackeroptions) | [MockChainTransactionRow](#interface-mockchaintransactionrow) | [
|
|
30
|
-
| [ChaintracksClientApi](#interface-chaintracksclientapi) | [MockChainUtxoRow](#interface-mockchainutxorow) | [
|
|
31
|
-
| [ChaintracksFetchApi](#interface-chaintracksfetchapi) | [MonitorOptions](#interface-monitoroptions) | [
|
|
32
|
-
| [ChaintracksFsApi](#interface-chaintracksfsapi) | [OutPoint](#interface-outpoint) | [
|
|
33
|
-
| [ChaintracksInfoApi](#interface-chaintracksinfoapi) | [Paged](#interface-paged) | [
|
|
34
|
-
| [ChaintracksPackageInfoApi](#interface-chaintrackspackageinfoapi) | [PendingSignAction](#interface-pendingsignaction) | [
|
|
35
|
-
| [ChaintracksReadableFileApi](#interface-chaintracksreadablefileapi) | [PendingStorageInput](#interface-pendingstorageinput) | [
|
|
36
|
-
| [ChaintracksServiceClientOptions](#interface-chaintracksserviceclientoptions) | [PostBeefResult](#interface-postbeefresult) | [
|
|
37
|
-
| [ChaintracksStorageApi](#interface-chaintracksstorageapi) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [
|
|
38
|
-
| [ChaintracksStorageBaseOptions](#interface-chaintracksstoragebaseoptions) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [
|
|
39
|
-
| [ChaintracksStorageBulkFileApi](#interface-chaintracksstoragebulkfileapi) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [
|
|
40
|
-
| [ChaintracksStorageIngestApi](#interface-chaintracksstorageingestapi) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [
|
|
41
|
-
| [ChaintracksStorageQueryApi](#interface-chaintracksstoragequeryapi) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [
|
|
42
|
-
| [ChaintracksWritableFileApi](#interface-chaintrackswritablefileapi) | [PostTxsResult](#interface-posttxsresult) | [
|
|
43
|
-
| [CommitNewTxResults](#interface-commitnewtxresults) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [
|
|
44
|
-
| [ContactRecord](#interface-contactrecord) | [ProvenOrRawTx](#interface-provenorrawtx) | [
|
|
45
|
-
| [ContactSource](#interface-contactsource) | [ProvenTransactionStatus](#interface-proventransactionstatus) | [
|
|
46
|
-
| [CreateActionResultX](#interface-createactionresultx) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [
|
|
47
|
-
| [DeactivedHeader](#interface-deactivedheader) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [
|
|
48
|
-
| [EntitySyncMap](#interface-entitysyncmap) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [
|
|
49
|
-
| [EntityTimeStamp](#interface-entitytimestamp) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [
|
|
50
|
-
| [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [ProviderCallHistory](#interface-providercallhistory) | [
|
|
51
|
-
| [ExtendedVerifiableCertificate](#interface-extendedverifiablecertificate) | [PurgeParams](#interface-purgeparams) | [
|
|
52
|
-
| [FiatExchangeRates](#interface-fiatexchangerates) | [PurgeResults](#interface-purgeresults) | [
|
|
53
|
-
| [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [ReorgResult](#interface-reorgresult) | [
|
|
54
|
-
| [FindCertificatesArgs](#interface-findcertificatesargs) | [ReproveHeaderResult](#interface-reproveheaderresult) | [
|
|
55
|
-
| [FindCommissionsArgs](#interface-findcommissionsargs) | [ReproveProvenResult](#interface-reproveprovenresult) | [
|
|
56
|
-
| [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [ReqHistoryNote](#interface-reqhistorynote) | [
|
|
57
|
-
| [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [
|
|
58
|
-
| [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [ReviewActionResult](#interface-reviewactionresult) | [
|
|
59
|
-
| [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [ReviewHeightRangeResult](#interface-reviewheightrangeresult) | [
|
|
60
|
-
| [FindOutputTagsArgs](#interface-findoutputtagsargs) | [ScriptHashHistoryResponse](#interface-scripthashhistoryresponse) | [
|
|
61
|
-
| [FindOutputsArgs](#interface-findoutputsargs) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [
|
|
62
|
-
| [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [
|
|
63
|
-
| [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [ServiceCall](#interface-servicecall) | [
|
|
64
|
-
| [FindProvenTxsArgs](#interface-findproventxsargs) | [ServiceCall](#interface-servicecall) | [
|
|
65
|
-
| [FindSincePagedArgs](#interface-findsincepagedargs) | [ServiceCallHistory](#interface-servicecallhistory) | [
|
|
66
|
-
| [FindStaleMerkleRootsArgs](#interface-findstalemerklerootsargs) | [ServiceCallHistoryCounts](#interface-servicecallhistorycounts) | [
|
|
67
|
-
| [FindSyncStatesArgs](#interface-findsyncstatesargs) | [ServiceToCall](#interface-servicetocall) | [
|
|
68
|
-
| [FindTransactionsArgs](#interface-findtransactionsargs) | [ServicesCallHistory](#interface-servicescallhistory) | [
|
|
69
|
-
| [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [SignActionResultX](#interface-signactionresultx) | [
|
|
70
|
-
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [SpentInputTransition](#interface-spentinputtransition) | [
|
|
71
|
-
| [FindUsersArgs](#interface-findusersargs) | [StatusForTxidResult](#interface-statusfortxidresult) | [
|
|
72
|
-
| [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StorageAdminStats](#interface-storageadminstats) |
|
|
73
|
-
| [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [
|
|
9
|
+
| [AdminStatsResult](#interface-adminstatsresult) | [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [StorageCreateActionResult](#interface-storagecreateactionresult) |
|
|
10
|
+
| [AggregatePostBeefTxResult](#interface-aggregatepostbeeftxresult) | [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) |
|
|
11
|
+
| [ArcConfig](#interface-arcconfig) | [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) |
|
|
12
|
+
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [StorageFeeModel](#interface-storagefeemodel) |
|
|
13
|
+
| [ArcSSEClientOptions](#interface-arcsseclientoptions) | [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) |
|
|
14
|
+
| [ArcSSEEvent](#interface-arcsseevent) | [GetMerklePathResult](#interface-getmerklepathresult) | [StorageIdentity](#interface-storageidentity) |
|
|
15
|
+
| [AuthId](#interface-authid) | [GetRawTxResult](#interface-getrawtxresult) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) |
|
|
16
|
+
| [BaseBlockHeader](#interface-baseblockheader) | [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [StorageProcessActionArgs](#interface-storageprocessactionargs) |
|
|
17
|
+
| [BitailsConfig](#interface-bitailsconfig) | [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [StorageProcessActionResults](#interface-storageprocessactionresults) |
|
|
18
|
+
| [BitailsMerkleProof](#interface-bitailsmerkleproof) | [GetScriptHashHistory](#interface-getscripthashhistory) | [StorageProvenOrReq](#interface-storageprovenorreq) |
|
|
19
|
+
| [BlockHeader](#interface-blockheader) | [GetScriptHashHistoryResult](#interface-getscripthashhistoryresult) | [StorageProviderOptions](#interface-storageprovideroptions) |
|
|
20
|
+
| [BsvExchangeRate](#interface-bsvexchangerate) | [GetStatusForTxidsResult](#interface-getstatusfortxidsresult) | [StorageReaderOptions](#interface-storagereaderoptions) |
|
|
21
|
+
| [BulkFileDataManagerMergeResult](#interface-bulkfiledatamanagermergeresult) | [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) |
|
|
22
|
+
| [BulkFileDataManagerOptions](#interface-bulkfiledatamanageroptions) | [GetUtxoStatusResult](#interface-getutxostatusresult) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) |
|
|
23
|
+
| [BulkHeaderFileInfo](#interface-bulkheaderfileinfo) | [HeightRangeApi](#interface-heightrangeapi) | [SyncChunk](#interface-syncchunk) |
|
|
24
|
+
| [BulkHeaderFilesInfo](#interface-bulkheaderfilesinfo) | [HeightRanges](#interface-heightranges) | [SyncError](#interface-syncerror) |
|
|
25
|
+
| [CertOpsWallet](#interface-certopswallet) | [KeyPair](#interface-keypair) | [SyncMap](#interface-syncmap) |
|
|
26
|
+
| [Certifier](#interface-certifier) | [LiveBlockHeader](#interface-liveblockheader) | [TableAuthSession](#interface-tableauthsession) |
|
|
27
|
+
| [ChaintracksApi](#interface-chaintracksapi) | [MerklePathNote](#interface-merklepathnote) | [TableCertificate](#interface-tablecertificate) |
|
|
28
|
+
| [ChaintracksAppendableFileApi](#interface-chaintracksappendablefileapi) | [MockChainBlockHeaderRow](#interface-mockchainblockheaderrow) | [TableCertificateField](#interface-tablecertificatefield) |
|
|
29
|
+
| [ChaintracksChainTrackerOptions](#interface-chaintrackschaintrackeroptions) | [MockChainTransactionRow](#interface-mockchaintransactionrow) | [TableCertificateX](#interface-tablecertificatex) |
|
|
30
|
+
| [ChaintracksClientApi](#interface-chaintracksclientapi) | [MockChainUtxoRow](#interface-mockchainutxorow) | [TableCommission](#interface-tablecommission) |
|
|
31
|
+
| [ChaintracksFetchApi](#interface-chaintracksfetchapi) | [MonitorOptions](#interface-monitoroptions) | [TableMonitorEvent](#interface-tablemonitorevent) |
|
|
32
|
+
| [ChaintracksFsApi](#interface-chaintracksfsapi) | [OutPoint](#interface-outpoint) | [TableOutput](#interface-tableoutput) |
|
|
33
|
+
| [ChaintracksInfoApi](#interface-chaintracksinfoapi) | [Paged](#interface-paged) | [TableOutputBasket](#interface-tableoutputbasket) |
|
|
34
|
+
| [ChaintracksPackageInfoApi](#interface-chaintrackspackageinfoapi) | [PendingSignAction](#interface-pendingsignaction) | [TableOutputTag](#interface-tableoutputtag) |
|
|
35
|
+
| [ChaintracksReadableFileApi](#interface-chaintracksreadablefileapi) | [PendingStorageInput](#interface-pendingstorageinput) | [TableOutputTagMap](#interface-tableoutputtagmap) |
|
|
36
|
+
| [ChaintracksServiceClientOptions](#interface-chaintracksserviceclientoptions) | [PostBeefResult](#interface-postbeefresult) | [TableOutputX](#interface-tableoutputx) |
|
|
37
|
+
| [ChaintracksStorageApi](#interface-chaintracksstorageapi) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [TableProvenTx](#interface-tableproventx) |
|
|
38
|
+
| [ChaintracksStorageBaseOptions](#interface-chaintracksstoragebaseoptions) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [TableProvenTxReq](#interface-tableproventxreq) |
|
|
39
|
+
| [ChaintracksStorageBulkFileApi](#interface-chaintracksstoragebulkfileapi) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) |
|
|
40
|
+
| [ChaintracksStorageIngestApi](#interface-chaintracksstorageingestapi) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [TableSettings](#interface-tablesettings) |
|
|
41
|
+
| [ChaintracksStorageQueryApi](#interface-chaintracksstoragequeryapi) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [TableSyncState](#interface-tablesyncstate) |
|
|
42
|
+
| [ChaintracksWritableFileApi](#interface-chaintrackswritablefileapi) | [PostTxsResult](#interface-posttxsresult) | [TableTransaction](#interface-tabletransaction) |
|
|
43
|
+
| [CommitNewTxResults](#interface-commitnewtxresults) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [TableTxLabel](#interface-tabletxlabel) |
|
|
44
|
+
| [ContactRecord](#interface-contactrecord) | [ProvenOrRawTx](#interface-provenorrawtx) | [TableTxLabelMap](#interface-tabletxlabelmap) |
|
|
45
|
+
| [ContactSource](#interface-contactsource) | [ProvenTransactionStatus](#interface-proventransactionstatus) | [TableUser](#interface-tableuser) |
|
|
46
|
+
| [CreateActionResultX](#interface-createactionresultx) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [TaskPurgeParams](#interface-taskpurgeparams) |
|
|
47
|
+
| [DeactivedHeader](#interface-deactivedheader) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [TrustSettings](#interface-trustsettings) |
|
|
48
|
+
| [EntitySyncMap](#interface-entitysyncmap) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [TrxToken](#interface-trxtoken) |
|
|
49
|
+
| [EntityTimeStamp](#interface-entitytimestamp) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
|
|
50
|
+
| [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [ProviderCallHistory](#interface-providercallhistory) | [TxScriptOffsets](#interface-txscriptoffsets) |
|
|
51
|
+
| [ExtendedVerifiableCertificate](#interface-extendedverifiablecertificate) | [PurgeParams](#interface-purgeparams) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
|
|
52
|
+
| [FiatExchangeRates](#interface-fiatexchangerates) | [PurgeResults](#interface-purgeresults) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
|
|
53
|
+
| [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [ReorgResult](#interface-reorgresult) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
|
|
54
|
+
| [FindCertificatesArgs](#interface-findcertificatesargs) | [ReproveHeaderResult](#interface-reproveheaderresult) | [VerifyAndRepairBeefResult](#interface-verifyandrepairbeefresult) |
|
|
55
|
+
| [FindCommissionsArgs](#interface-findcommissionsargs) | [ReproveProvenResult](#interface-reproveprovenresult) | [WalletArgs](#interface-walletargs) |
|
|
56
|
+
| [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [ReqHistoryNote](#interface-reqhistorynote) | [WalletBalance](#interface-walletbalance) |
|
|
57
|
+
| [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [WalletLoggerArgs](#interface-walletloggerargs) |
|
|
58
|
+
| [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [ReviewActionResult](#interface-reviewactionresult) | [WalletServices](#interface-walletservices) |
|
|
59
|
+
| [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [ReviewHeightRangeResult](#interface-reviewheightrangeresult) | [WalletServicesOptions](#interface-walletservicesoptions) |
|
|
60
|
+
| [FindOutputTagsArgs](#interface-findoutputtagsargs) | [ScriptHashHistoryResponse](#interface-scripthashhistoryresponse) | [WalletSettings](#interface-walletsettings) |
|
|
61
|
+
| [FindOutputsArgs](#interface-findoutputsargs) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [WalletSettingsManagerConfig](#interface-walletsettingsmanagerconfig) |
|
|
62
|
+
| [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [WalletSigner](#interface-walletsigner) |
|
|
63
|
+
| [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [ServiceCall](#interface-servicecall) | [WalletStorage](#interface-walletstorage) |
|
|
64
|
+
| [FindProvenTxsArgs](#interface-findproventxsargs) | [ServiceCall](#interface-servicecall) | [WalletStorageInfo](#interface-walletstorageinfo) |
|
|
65
|
+
| [FindSincePagedArgs](#interface-findsincepagedargs) | [ServiceCallHistory](#interface-servicecallhistory) | [WalletStorageProvider](#interface-walletstorageprovider) |
|
|
66
|
+
| [FindStaleMerkleRootsArgs](#interface-findstalemerklerootsargs) | [ServiceCallHistoryCounts](#interface-servicecallhistorycounts) | [WalletStorageReader](#interface-walletstoragereader) |
|
|
67
|
+
| [FindSyncStatesArgs](#interface-findsyncstatesargs) | [ServiceToCall](#interface-servicetocall) | [WalletStorageSync](#interface-walletstoragesync) |
|
|
68
|
+
| [FindTransactionsArgs](#interface-findtransactionsargs) | [ServicesCallHistory](#interface-servicescallhistory) | [WalletStorageSyncReader](#interface-walletstoragesyncreader) |
|
|
69
|
+
| [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [SignActionResultX](#interface-signactionresultx) | [WalletStorageWriter](#interface-walletstoragewriter) |
|
|
70
|
+
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [SpentInputTransition](#interface-spentinputtransition) | [WalletTheme](#interface-wallettheme) |
|
|
71
|
+
| [FindUsersArgs](#interface-findusersargs) | [StatusForTxidResult](#interface-statusfortxidresult) | [WocChainInfo](#interface-wocchaininfo) |
|
|
72
|
+
| [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StorageAdminStats](#interface-storageadminstats) | [WocHeader](#interface-wocheader) |
|
|
73
|
+
| [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [StorageClientOptions](#interface-storageclientoptions) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
|
|
74
74
|
|
|
75
75
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
76
76
|
|
|
@@ -4309,12 +4309,33 @@ export interface StorageAdminStats {
|
|
|
4309
4309
|
|
|
4310
4310
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4311
4311
|
|
|
4312
|
+
---
|
|
4313
|
+
##### Interface: StorageClientOptions
|
|
4314
|
+
|
|
4315
|
+
```ts
|
|
4316
|
+
export interface StorageClientOptions {
|
|
4317
|
+
binaryRequests?: boolean;
|
|
4318
|
+
}
|
|
4319
|
+
```
|
|
4320
|
+
|
|
4321
|
+
###### Property binaryRequests
|
|
4322
|
+
|
|
4323
|
+
Send compact tagged binary request values after the server advertises
|
|
4324
|
+
support. Leave disabled during rolling deployments where an endpoint may
|
|
4325
|
+
still route requests to legacy server instances.
|
|
4326
|
+
|
|
4327
|
+
```ts
|
|
4328
|
+
binaryRequests?: boolean
|
|
4329
|
+
```
|
|
4330
|
+
|
|
4331
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4332
|
+
|
|
4312
4333
|
---
|
|
4313
4334
|
##### Interface: StorageCreateActionResult
|
|
4314
4335
|
|
|
4315
4336
|
```ts
|
|
4316
4337
|
export interface StorageCreateActionResult {
|
|
4317
|
-
inputBeef?: number[];
|
|
4338
|
+
inputBeef?: number[] | Uint8Array;
|
|
4318
4339
|
inputs: StorageCreateTransactionSdkInput[];
|
|
4319
4340
|
outputs: StorageCreateTransactionSdkOutput[];
|
|
4320
4341
|
noSendChangeOutputVouts?: number[];
|
|
@@ -4339,7 +4360,7 @@ export interface StorageCreateTransactionSdkInput {
|
|
|
4339
4360
|
sourceVout: number;
|
|
4340
4361
|
sourceSatoshis: number;
|
|
4341
4362
|
sourceLockingScript: string;
|
|
4342
|
-
sourceTransaction?: number[];
|
|
4363
|
+
sourceTransaction?: number[] | Uint8Array;
|
|
4343
4364
|
unlockingScriptLength: number;
|
|
4344
4365
|
providedBy: StorageProvidedBy;
|
|
4345
4366
|
type: string;
|
|
@@ -4410,7 +4431,8 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4410
4431
|
export interface StorageGetBeefOptions {
|
|
4411
4432
|
trustSelf?: "known";
|
|
4412
4433
|
knownTxids?: string[];
|
|
4413
|
-
mergeToBeef?: Beef | number[];
|
|
4434
|
+
mergeToBeef?: Beef | number[] | Uint8Array;
|
|
4435
|
+
maxConcurrency?: number;
|
|
4414
4436
|
ignoreStorage?: boolean;
|
|
4415
4437
|
ignoreServices?: boolean;
|
|
4416
4438
|
ignoreNewProven?: boolean;
|
|
@@ -4460,12 +4482,20 @@ list of txids to be included as txidOnly if referenced. Validity is known to cal
|
|
|
4460
4482
|
knownTxids?: string[]
|
|
4461
4483
|
```
|
|
4462
4484
|
|
|
4485
|
+
###### Property maxConcurrency
|
|
4486
|
+
|
|
4487
|
+
Maximum independent ancestor lookups to perform concurrently. Defaults to 8.
|
|
4488
|
+
|
|
4489
|
+
```ts
|
|
4490
|
+
maxConcurrency?: number
|
|
4491
|
+
```
|
|
4492
|
+
|
|
4463
4493
|
###### Property mergeToBeef
|
|
4464
4494
|
|
|
4465
4495
|
optional. If defined, raw transactions and merkle paths required by txid are merged to this instance and returned. Otherwise a new Beef is constructed and returned.
|
|
4466
4496
|
|
|
4467
4497
|
```ts
|
|
4468
|
-
mergeToBeef?: Beef | number[]
|
|
4498
|
+
mergeToBeef?: Beef | number[] | Uint8Array
|
|
4469
4499
|
```
|
|
4470
4500
|
|
|
4471
4501
|
###### Property minProofLevel
|
|
@@ -4591,7 +4621,7 @@ export interface StorageProcessActionArgs {
|
|
|
4591
4621
|
isDelayed: boolean;
|
|
4592
4622
|
reference?: string;
|
|
4593
4623
|
txid?: string;
|
|
4594
|
-
rawTx?: number[];
|
|
4624
|
+
rawTx?: number[] | Uint8Array;
|
|
4595
4625
|
sendWith: string[];
|
|
4596
4626
|
logger?: WalletLoggerInterface;
|
|
4597
4627
|
}
|
|
@@ -4775,6 +4805,30 @@ See also: [EntitySyncMap](./storage.md#interface-entitysyncmap)
|
|
|
4775
4805
|
|
|
4776
4806
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4777
4807
|
|
|
4808
|
+
---
|
|
4809
|
+
##### Interface: TableAuthSession
|
|
4810
|
+
|
|
4811
|
+
Durable representation of a BRC-103 peer session.
|
|
4812
|
+
|
|
4813
|
+
The session nonce is the authoritative key. `lastUpdate` also acts as the
|
|
4814
|
+
optimistic-write version so a delayed request from one replica cannot
|
|
4815
|
+
overwrite newer authentication state written by another replica.
|
|
4816
|
+
|
|
4817
|
+
```ts
|
|
4818
|
+
export interface TableAuthSession {
|
|
4819
|
+
sessionNonce: string;
|
|
4820
|
+
peerNonce?: string | null;
|
|
4821
|
+
peerIdentityKey?: string | null;
|
|
4822
|
+
isAuthenticated: boolean | number;
|
|
4823
|
+
lastUpdate: number | string;
|
|
4824
|
+
certificatesRequired?: boolean | number | null;
|
|
4825
|
+
certificatesValidated?: boolean | number | null;
|
|
4826
|
+
expiresAt: number | string;
|
|
4827
|
+
}
|
|
4828
|
+
```
|
|
4829
|
+
|
|
4830
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4831
|
+
|
|
4778
4832
|
---
|
|
4779
4833
|
##### Interface: TableCertificate
|
|
4780
4834
|
|
|
@@ -5489,12 +5543,30 @@ export interface UpdateProvenTxReqWithNewProvenTxResult {
|
|
|
5489
5543
|
status: ProvenTxReqStatus;
|
|
5490
5544
|
history: string;
|
|
5491
5545
|
provenTxId: number;
|
|
5546
|
+
notified?: boolean;
|
|
5547
|
+
notify?: string;
|
|
5492
5548
|
log?: string;
|
|
5493
5549
|
}
|
|
5494
5550
|
```
|
|
5495
5551
|
|
|
5496
5552
|
See also: [ProvenTxReqStatus](./client.md#type-proventxreqstatus)
|
|
5497
5553
|
|
|
5554
|
+
###### Property notified
|
|
5555
|
+
|
|
5556
|
+
Final durable notification state, when supplied by the storage implementation.
|
|
5557
|
+
|
|
5558
|
+
```ts
|
|
5559
|
+
notified?: boolean
|
|
5560
|
+
```
|
|
5561
|
+
|
|
5562
|
+
###### Property notify
|
|
5563
|
+
|
|
5564
|
+
Final durable notification payload, when supplied by the storage implementation.
|
|
5565
|
+
|
|
5566
|
+
```ts
|
|
5567
|
+
notify?: string
|
|
5568
|
+
```
|
|
5569
|
+
|
|
5498
5570
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5499
5571
|
|
|
5500
5572
|
---
|
|
@@ -5911,6 +5983,7 @@ ARC fallback) and the Monitor's SSE/proof task (`TaskArcadeSSE`) targets this UR
|
|
|
5911
5983
|
Default is undefined (Arcade disabled; ARC providers used as before).
|
|
5912
5984
|
mainnet: `https://arcade-v2-us-1.bsvblockchain.tech`
|
|
5913
5985
|
teratest: `https://arcade-v2-ttn-us-1.bsvblockchain.tech`
|
|
5986
|
+
tstn: supplied at runtime via the `TSTN_ARCADE_URL` environment variable (not public)
|
|
5914
5987
|
|
|
5915
5988
|
```ts
|
|
5916
5989
|
arcadeUrl?: string
|
|
@@ -8674,7 +8747,7 @@ export default class SdkWhatsOnChain implements ChainTracker {
|
|
|
8674
8747
|
readonly apiKey: string;
|
|
8675
8748
|
protected readonly URL: string;
|
|
8676
8749
|
protected readonly httpClient: HttpClient;
|
|
8677
|
-
constructor(network: "main" | "test" | "stn" | "ttn" = "main", config: WhatsOnChainConfig = {})
|
|
8750
|
+
constructor(network: "main" | "test" | "stn" | "ttn" | "tstn" = "main", config: WhatsOnChainConfig = {})
|
|
8678
8751
|
async isValidRootForHeight(root: string, height: number): Promise<boolean>
|
|
8679
8752
|
async currentHeight(): Promise<number>
|
|
8680
8753
|
protected getHttpHeaders(): Record<string, string>
|
|
@@ -8686,7 +8759,7 @@ export default class SdkWhatsOnChain implements ChainTracker {
|
|
|
8686
8759
|
Constructs an instance of the WhatsOnChain ChainTracker.
|
|
8687
8760
|
|
|
8688
8761
|
```ts
|
|
8689
|
-
constructor(network: "main" | "test" | "stn" | "ttn" = "main", config: WhatsOnChainConfig = {})
|
|
8762
|
+
constructor(network: "main" | "test" | "stn" | "ttn" | "tstn" = "main", config: WhatsOnChainConfig = {})
|
|
8690
8763
|
```
|
|
8691
8764
|
|
|
8692
8765
|
Argument Details
|
|
@@ -8912,12 +8985,12 @@ For details of the API implemented, follow the "See also" link for the `WalletSt
|
|
|
8912
8985
|
|
|
8913
8986
|
```ts
|
|
8914
8987
|
export class StorageClient extends StorageClientBase {
|
|
8915
|
-
constructor(wallet: WalletInterface, endpointUrl: string)
|
|
8988
|
+
constructor(wallet: WalletInterface, endpointUrl: string, options: StorageClientOptions = {})
|
|
8916
8989
|
protected async rpcCall<T>(method: string, params: unknown[]): Promise<T>
|
|
8917
8990
|
}
|
|
8918
8991
|
```
|
|
8919
8992
|
|
|
8920
|
-
See also: [StorageClientBase](./storage.md#class-storageclientbase)
|
|
8993
|
+
See also: [StorageClientBase](./storage.md#class-storageclientbase), [StorageClientOptions](./storage.md#interface-storageclientoptions)
|
|
8921
8994
|
|
|
8922
8995
|
###### Method rpcCall
|
|
8923
8996
|
|
|
@@ -8950,8 +9023,10 @@ export abstract class StorageClientBase implements WalletStorageProvider {
|
|
|
8950
9023
|
readonly endpointUrl: string;
|
|
8951
9024
|
protected readonly authClient: AuthFetch;
|
|
8952
9025
|
protected nextId = 1;
|
|
9026
|
+
protected serverSupportsBinary = false;
|
|
9027
|
+
protected readonly binaryRequests: boolean;
|
|
8953
9028
|
public settings?: TableSettings;
|
|
8954
|
-
constructor(wallet: WalletInterface, endpointUrl: string)
|
|
9029
|
+
constructor(wallet: WalletInterface, endpointUrl: string, options: StorageClientOptions = {})
|
|
8955
9030
|
isStorageProvider(): boolean
|
|
8956
9031
|
protected abstract rpcCall<T>(method: string, params: unknown[]): Promise<T>;
|
|
8957
9032
|
isAvailable(): boolean
|
|
@@ -8993,7 +9068,7 @@ export abstract class StorageClientBase implements WalletStorageProvider {
|
|
|
8993
9068
|
}
|
|
8994
9069
|
```
|
|
8995
9070
|
|
|
8996
|
-
See also: [AuthId](./client.md#interface-authid), [EntityTimeStamp](./client.md#interface-entitytimestamp), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [SyncChunk](./client.md#interface-syncchunk), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableSyncState](./storage.md#interface-tablesyncstate), [TableUser](./storage.md#interface-tableuser), [UpdateProvenTxReqWithNewProvenTxArgs](./client.md#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](./client.md#interface-updateproventxreqwithnewproventxresult), [WalletServices](./client.md#interface-walletservices), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [createAction](./storage.md#function-createaction), [getSyncChunk](./storage.md#function-getsyncchunk), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [processAction](./storage.md#function-processaction), [validateDate](./storage.md#function-validatedate), [validateEntities](./storage.md#function-validateentities), [validateEntity](./storage.md#function-validateentity)
|
|
9071
|
+
See also: [AuthId](./client.md#interface-authid), [EntityTimeStamp](./client.md#interface-entitytimestamp), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageClientOptions](./storage.md#interface-storageclientoptions), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [SyncChunk](./client.md#interface-syncchunk), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableSyncState](./storage.md#interface-tablesyncstate), [TableUser](./storage.md#interface-tableuser), [UpdateProvenTxReqWithNewProvenTxArgs](./client.md#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](./client.md#interface-updateproventxreqwithnewproventxresult), [WalletServices](./client.md#interface-walletservices), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [createAction](./storage.md#function-createaction), [getSyncChunk](./storage.md#function-getsyncchunk), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [processAction](./storage.md#function-processaction), [validateDate](./storage.md#function-validatedate), [validateEntities](./storage.md#function-validateentities), [validateEntity](./storage.md#function-validateentity)
|
|
8997
9072
|
|
|
8998
9073
|
###### Method abortAction
|
|
8999
9074
|
|
|
@@ -9646,6 +9721,10 @@ export abstract class StorageProvider extends StorageReaderWriter implements Wal
|
|
|
9646
9721
|
async relinquishOutput(auth: AuthId, args: RelinquishOutputArgs): Promise<number>
|
|
9647
9722
|
async processSyncChunk(args: RequestSyncChunkArgs, chunk: SyncChunk): Promise<ProcessSyncChunkResult>
|
|
9648
9723
|
async updateProvenTxReqWithNewProvenTx(args: UpdateProvenTxReqWithNewProvenTxArgs): Promise<UpdateProvenTxReqWithNewProvenTxResult>
|
|
9724
|
+
async reconcileCompletedProvenTxReqs(): Promise<{
|
|
9725
|
+
log: string;
|
|
9726
|
+
}>
|
|
9727
|
+
async unfailTransactionsForProof(req: EntityProvenTxReq, indent = 0, requestUpdate?: Pick<TableProvenTxReqDynamics, "status" | "attempts">): Promise<string>
|
|
9649
9728
|
async confirmSpendableOutputs(): Promise<{
|
|
9650
9729
|
invalidSpendableOutputs: TableOutput[];
|
|
9651
9730
|
}>
|
|
@@ -9697,6 +9776,31 @@ async getValidBeefForKnownTxid(txid: string, mergeToBeef?: Beef, trustSelf?: Tru
|
|
|
9697
9776
|
```
|
|
9698
9777
|
See also: [TrxToken](./client.md#interface-trxtoken)
|
|
9699
9778
|
|
|
9779
|
+
###### Method reconcileCompletedProvenTxReqs
|
|
9780
|
+
|
|
9781
|
+
Reconcile completed proof requests whose transaction fan-out previously
|
|
9782
|
+
failed or whose durable notification state drifted.
|
|
9783
|
+
|
|
9784
|
+
This is called by TaskReviewStatus so a completed request with
|
|
9785
|
+
`notified = false` is retried and can become eligible for normal purge.
|
|
9786
|
+
|
|
9787
|
+
```ts
|
|
9788
|
+
async reconcileCompletedProvenTxReqs(): Promise<{
|
|
9789
|
+
log: string;
|
|
9790
|
+
}>
|
|
9791
|
+
```
|
|
9792
|
+
|
|
9793
|
+
###### Method unfailTransactionsForProof
|
|
9794
|
+
|
|
9795
|
+
Restore every failed local copy of a transaction before proof completion.
|
|
9796
|
+
Also heals the request's notification set from the authoritative txid
|
|
9797
|
+
lookup so TaskUnFail cannot omit a local copy after notification drift.
|
|
9798
|
+
|
|
9799
|
+
```ts
|
|
9800
|
+
async unfailTransactionsForProof(req: EntityProvenTxReq, indent = 0, requestUpdate?: Pick<TableProvenTxReqDynamics, "status" | "attempts">): Promise<string>
|
|
9801
|
+
```
|
|
9802
|
+
See also: [EntityProvenTxReq](./storage.md#class-entityproventxreq), [TableProvenTxReqDynamics](./storage.md#interface-tableproventxreqdynamics)
|
|
9803
|
+
|
|
9700
9804
|
###### Method updateProvenTxReqWithNewProvenTx
|
|
9701
9805
|
|
|
9702
9806
|
Handles storage changes when a valid MerklePath and mined block header are found for a ProvenTxReq txid.
|
|
@@ -10893,7 +10997,7 @@ export class Wallet implements WalletInterface, ProtoWallet {
|
|
|
10893
10997
|
forceRefresh?: boolean;
|
|
10894
10998
|
}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<DiscoverCertificatesResult>
|
|
10895
10999
|
verifyReturnedTxidOnly(beef: Beef, knownTxids?: string[]): Beef
|
|
10896
|
-
verifyReturnedTxidOnlyAtomicBEEF(beef: AtomicBEEF, knownTxids?: string[]): AtomicBEEF
|
|
11000
|
+
verifyReturnedTxidOnlyAtomicBEEF(beef: AtomicBEEF, knownTxids?: string[], parsedBeef?: Beef): AtomicBEEF
|
|
10897
11001
|
verifyReturnedTxidOnlyBEEF(beef: BEEF): BEEF
|
|
10898
11002
|
logMakeLogger(method: string, args: any): WalletLoggerInterface | undefined
|
|
10899
11003
|
logMethodStart(method: string, logger?: WalletLoggerInterface): void
|
|
@@ -11759,58 +11863,62 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
11759
11863
|
|
|
11760
11864
|
| | | |
|
|
11761
11865
|
| --- | --- | --- |
|
|
11762
|
-
| [WalletErrorFromJson](#function-walleterrorfromjson) | [handleScriptHashHistoryCatch](#function-handlescripthashhistorycatch) | [
|
|
11763
|
-
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [handleScriptHashHistoryResponse](#function-handlescripthashhistoryresponse) | [
|
|
11764
|
-
| [addWork](#function-addwork) | [handleUtxoConnReset](#function-handleutxoconnreset) | [
|
|
11765
|
-
| [arcDefaultUrl](#function-arcdefaulturl) | [internalizeAction](#function-internalizeaction) | [
|
|
11766
|
-
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [internalizeAction](#function-internalizeaction) | [
|
|
11767
|
-
| [arcadeDefaultUrl](#function-arcadedefaulturl) | [isArcAcceptedTxStatus](#function-isarcacceptedtxstatus) | [
|
|
11768
|
-
| [arraysEqual](#function-arraysequal) | [isArcDoubleSpendTxStatus](#function-isarcdoublespendtxstatus) | [
|
|
11769
|
-
| [asArray](#function-asarray) | [isArcInvalidTxStatus](#function-isarcinvalidtxstatus) | [
|
|
11866
|
+
| [WalletErrorFromJson](#function-walleterrorfromjson) | [handleScriptHashHistoryCatch](#function-handlescripthashhistorycatch) | [setResultBeef](#function-setresultbeef) |
|
|
11867
|
+
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [handleScriptHashHistoryResponse](#function-handlescripthashhistoryresponse) | [sha256Hash](#function-sha256hash) |
|
|
11868
|
+
| [addWork](#function-addwork) | [handleUtxoConnReset](#function-handleutxoconnreset) | [sha256HashOfBinaryFile](#function-sha256hashofbinaryfile) |
|
|
11869
|
+
| [arcDefaultUrl](#function-arcdefaulturl) | [internalizeAction](#function-internalizeaction) | [shareReqsWithWorld](#function-sharereqswithworld) |
|
|
11870
|
+
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [internalizeAction](#function-internalizeaction) | [signAction](#function-signaction) |
|
|
11871
|
+
| [arcadeDefaultUrl](#function-arcadedefaulturl) | [isArcAcceptedTxStatus](#function-isarcacceptedtxstatus) | [stampLog](#function-stamplog) |
|
|
11872
|
+
| [arraysEqual](#function-arraysequal) | [isArcDoubleSpendTxStatus](#function-isarcdoublespendtxstatus) | [stampLogFormat](#function-stamplogformat) |
|
|
11873
|
+
| [asArray](#function-asarray) | [isArcInvalidTxStatus](#function-isarcinvalidtxstatus) | [stringifyJsonRpc](#function-stringifyjsonrpc) |
|
|
11770
11874
|
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [isArcServiceErrorStatus](#function-isarcserviceerrorstatus) | [subWork](#function-subwork) |
|
|
11771
11875
|
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [isAutoSpendableChangeOutput](#function-isautospendablechangeoutput) | [swapByteOrder](#function-swapbyteorder) |
|
|
11772
|
-
| [asBsvSdkScript](#function-asbsvsdkscript) | [isBaseBlockHeader](#function-isbaseblockheader) | [
|
|
11773
|
-
| [asBsvSdkTx](#function-asbsvsdktx) | [isBlockHeader](#function-isblockheader) | [
|
|
11774
|
-
| [asString](#function-asstring) | [isCreateActionSpecOp](#function-iscreateactionspecop) | [
|
|
11775
|
-
| [asUint8Array](#function-asuint8array) | [isKnownValidBulkHeaderFile](#function-isknownvalidbulkheaderfile) | [
|
|
11776
|
-
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [isListActionsSpecOp](#function-islistactionsspecop) | [
|
|
11777
|
-
| [
|
|
11778
|
-
| [
|
|
11779
|
-
| [
|
|
11780
|
-
| [
|
|
11781
|
-
| [
|
|
11782
|
-
| [
|
|
11783
|
-
| [
|
|
11784
|
-
| [
|
|
11785
|
-
| [
|
|
11786
|
-
| [
|
|
11787
|
-
| [
|
|
11788
|
-
| [
|
|
11789
|
-
| [
|
|
11790
|
-
| [
|
|
11791
|
-
| [
|
|
11792
|
-
| [
|
|
11793
|
-
| [
|
|
11794
|
-
| [
|
|
11795
|
-
| [
|
|
11796
|
-
| [
|
|
11797
|
-
| [
|
|
11798
|
-
| [
|
|
11799
|
-
| [
|
|
11800
|
-
| [
|
|
11801
|
-
| [
|
|
11876
|
+
| [asBsvSdkScript](#function-asbsvsdkscript) | [isBaseBlockHeader](#function-isbaseblockheader) | [tableAuthSessionToPeerSession](#function-tableauthsessiontopeersession) |
|
|
11877
|
+
| [asBsvSdkTx](#function-asbsvsdktx) | [isBlockHeader](#function-isblockheader) | [throwDummyReviewActions](#function-throwdummyreviewactions) |
|
|
11878
|
+
| [asString](#function-asstring) | [isCreateActionSpecOp](#function-iscreateactionspecop) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) |
|
|
11879
|
+
| [asUint8Array](#function-asuint8array) | [isKnownValidBulkHeaderFile](#function-isknownvalidbulkheaderfile) | [toLookupNetworkPreset](#function-tolookupnetworkpreset) |
|
|
11880
|
+
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [isListActionsSpecOp](#function-islistactionsspecop) | [toWalletNetwork](#function-towalletnetwork) |
|
|
11881
|
+
| [binaryJsonReplacer](#function-binaryjsonreplacer) | [isListOutputsSpecOp](#function-islistoutputsspecop) | [transactionInputSize](#function-transactioninputsize) |
|
|
11882
|
+
| [binaryJsonReviver](#function-binaryjsonreviver) | [isLive](#function-islive) | [transactionOutputSize](#function-transactionoutputsize) |
|
|
11883
|
+
| [blockHash](#function-blockhash) | [isLiveBlockHeader](#function-isliveblockheader) | [transactionSize](#function-transactionsize) |
|
|
11884
|
+
| [buildSignableTransaction](#function-buildsignabletransaction) | [isManagedChangeOutput](#function-ismanagedchangeoutput) | [tstnArcadeUrl](#function-tstnarcadeurl) |
|
|
11885
|
+
| [classifyMerklePathResponse](#function-classifymerklepathresponse) | [isMoreWork](#function-ismorework) | [tstnChaintracksUrl](#function-tstnchaintracksurl) |
|
|
11886
|
+
| [classifyReqStatus](#function-classifyreqstatus) | [keyOffsetToHashedSecret](#function-keyoffsettohashedsecret) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) |
|
|
11887
|
+
| [completeSignedTransaction](#function-completesignedtransaction) | [legacyBinaryJsonReplacer](#function-legacybinaryjsonreplacer) | [updateExchangeratesapi](#function-updateexchangeratesapi) |
|
|
11888
|
+
| [computeMerklePath](#function-computemerklepath) | [listCertificates](#function-listcertificates) | [updateReqsFromAggregateResults](#function-updatereqsfromaggregateresults) |
|
|
11889
|
+
| [computeMerkleRoot](#function-computemerkleroot) | [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [validBulkHeaderFilesByFileHash](#function-validbulkheaderfilesbyfilehash) |
|
|
11890
|
+
| [convertBitsToTarget](#function-convertbitstotarget) | [logCreateActionArgs](#function-logcreateactionargs) | [validateAgainstDirtyHashes](#function-validateagainstdirtyhashes) |
|
|
11891
|
+
| [convertBitsToWork](#function-convertbitstowork) | [logWalletError](#function-logwalleterror) | [validateBufferOfHeaders](#function-validatebufferofheaders) |
|
|
11892
|
+
| [convertBufferToUint32](#function-convertbuffertouint32) | [makeAtomicBeef](#function-makeatomicbeef) | [validateBulkFileData](#function-validatebulkfiledata) |
|
|
11893
|
+
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [makeChangeLock](#function-makechangelock) | [validateDate](#function-validatedate) |
|
|
11894
|
+
| [convertUint32ToBuffer](#function-convertuint32tobuffer) | [makeMerklePathNote](#function-makemerklepathnote) | [validateEntities](#function-validateentities) |
|
|
11895
|
+
| [convertWocToBlockHeaderHex](#function-convertwoctoblockheaderhex) | [markStaleInputsAsSpent](#function-markstaleinputsasspent) | [validateEntity](#function-validateentity) |
|
|
11896
|
+
| [createAction](#function-createaction) | [markUserInputsSpent](#function-markuserinputsspent) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) |
|
|
11897
|
+
| [createAction](#function-createaction) | [maxDate](#function-maxdate) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) |
|
|
11898
|
+
| [createCoinbaseTransaction](#function-createcoinbasetransaction) | [mergeInputBeefs](#function-mergeinputbeefs) | [validateGenesisHeader](#function-validategenesisheader) |
|
|
11899
|
+
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [mergeInputsIntoBeef](#function-mergeinputsintobeef) | [validateHeaderDifficulty](#function-validateheaderdifficulty) |
|
|
11900
|
+
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [notifyTransactionsOfProof](#function-notifytransactionsofproof) | [validateHeaderFormat](#function-validateheaderformat) |
|
|
11901
|
+
| [createSyncMap](#function-createsyncmap) | [offsetPrivKey](#function-offsetprivkey) | [validateScriptHash](#function-validatescripthash) |
|
|
11902
|
+
| [decodeBinaryJsonValue](#function-decodebinaryjsonvalue) | [offsetPubKey](#function-offsetpubkey) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
|
|
11903
|
+
| [deserializeBaseBlockHeader](#function-deserializebaseblockheader) | [optionalArraysEqual](#function-optionalarraysequal) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
|
|
11904
|
+
| [deserializeBaseBlockHeaders](#function-deserializebaseblockheaders) | [parseJsonRpc](#function-parsejsonrpc) | [validateSyncChunkEntities](#function-validatesyncchunkentities) |
|
|
11905
|
+
| [deserializeBlockHeader](#function-deserializeblockheader) | [parseResults$](#function-parseresults$) | [varUintSize](#function-varuintsize) |
|
|
11906
|
+
| [deserializeBlockHeaders](#function-deserializeblockheaders) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [verifyHexString](#function-verifyhexstring) |
|
|
11907
|
+
| [doubleSha256BE](#function-doublesha256be) | [populateUtxoDetails](#function-populateutxodetails) | [verifyId](#function-verifyid) |
|
|
11908
|
+
| [doubleSha256LE](#function-doublesha256le) | [processAction](#function-processaction) | [verifyInteger](#function-verifyinteger) |
|
|
11802
11909
|
| [generateChangeSdk](#function-generatechangesdk) | [processAction](#function-processaction) | [verifyNumber](#function-verifynumber) |
|
|
11803
|
-
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [
|
|
11804
|
-
| [genesisBuffer](#function-genesisbuffer) | [
|
|
11805
|
-
| [genesisHeader](#function-genesisheader) | [
|
|
11806
|
-
| [getBeefForTransaction](#function-getbeeffortransaction) | [
|
|
11807
|
-
| [getBeefForTxid](#function-getbeeffortxid) | [
|
|
11808
|
-
| [getExchangeRatesIo](#function-getexchangeratesio) | [
|
|
11809
|
-
| [getIdentityKey](#function-getidentitykey) | [
|
|
11810
|
-
| [getProofs](#function-getproofs) | [
|
|
11811
|
-
| [
|
|
11812
|
-
| [
|
|
11813
|
-
| [
|
|
11910
|
+
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [proveCertificate](#function-provecertificate) | [verifyOne](#function-verifyone) |
|
|
11911
|
+
| [genesisBuffer](#function-genesisbuffer) | [randomBytes](#function-randombytes) | [verifyOneOrNone](#function-verifyoneornone) |
|
|
11912
|
+
| [genesisHeader](#function-genesisheader) | [randomBytesBase64](#function-randombytesbase64) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
|
|
11913
|
+
| [getBeefForTransaction](#function-getbeeffortransaction) | [randomBytesHex](#function-randombyteshex) | [verifyRequestedOutputsUnchanged](#function-verifyrequestedoutputsunchanged) |
|
|
11914
|
+
| [getBeefForTxid](#function-getbeeffortxid) | [readUInt32BE](#function-readuint32be) | [verifyTruthy](#function-verifytruthy) |
|
|
11915
|
+
| [getExchangeRatesIo](#function-getexchangeratesio) | [readUInt32LE](#function-readuint32le) | [verifyUnlockScripts](#function-verifyunlockscripts) |
|
|
11916
|
+
| [getIdentityKey](#function-getidentitykey) | [redeemServiceCharges](#function-redeemservicecharges) | [verifyUnrequestedOutputsAreChangeOrCommission](#function-verifyunrequestedoutputsarechangeorcommission) |
|
|
11917
|
+
| [getProofs](#function-getproofs) | [restoreInputsToSpendable](#function-restoreinputstospendable) | [wait](#function-wait) |
|
|
11918
|
+
| [getResultBeef](#function-getresultbeef) | [selectBulkHeaderFiles](#function-selectbulkheaderfiles) | [workBNtoBuffer](#function-workbntobuffer) |
|
|
11919
|
+
| [getSyncChunk](#function-getsyncchunk) | [serializeBaseBlockHeader](#function-serializebaseblockheader) | [writeUInt32BE](#function-writeuint32be) |
|
|
11920
|
+
| [getWhatsOnChainBlockHeaderByHash](#function-getwhatsonchainblockheaderbyhash) | [serializeBaseBlockHeaders](#function-serializebaseblockheaders) | [writeUInt32LE](#function-writeuint32le) |
|
|
11921
|
+
| [handlePostRawTxErrorResponse](#function-handlepostrawtxerrorresponse) | [setDisableDoubleSpendCheckForTest](#function-setdisabledoublespendcheckfortest) | |
|
|
11814
11922
|
|
|
11815
11923
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11816
11924
|
|
|
@@ -12096,6 +12204,24 @@ See also: [EntityProvenTxReq](./storage.md#class-entityproventxreq), [PostReqsTo
|
|
|
12096
12204
|
|
|
12097
12205
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
12098
12206
|
|
|
12207
|
+
---
|
|
12208
|
+
##### Function: binaryJsonReplacer
|
|
12209
|
+
|
|
12210
|
+
```ts
|
|
12211
|
+
export function binaryJsonReplacer(this: Record<string, unknown>, key: string, value: unknown): unknown
|
|
12212
|
+
```
|
|
12213
|
+
|
|
12214
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
12215
|
+
|
|
12216
|
+
---
|
|
12217
|
+
##### Function: binaryJsonReviver
|
|
12218
|
+
|
|
12219
|
+
```ts
|
|
12220
|
+
export function binaryJsonReviver(_key: string, value: unknown): unknown
|
|
12221
|
+
```
|
|
12222
|
+
|
|
12223
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
12224
|
+
|
|
12099
12225
|
---
|
|
12100
12226
|
##### Function: blockHash
|
|
12101
12227
|
|
|
@@ -12384,6 +12510,15 @@ See also: [SyncMap](./storage.md#interface-syncmap)
|
|
|
12384
12510
|
|
|
12385
12511
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
12386
12512
|
|
|
12513
|
+
---
|
|
12514
|
+
##### Function: decodeBinaryJsonValue
|
|
12515
|
+
|
|
12516
|
+
```ts
|
|
12517
|
+
export function decodeBinaryJsonValue(value: unknown): unknown
|
|
12518
|
+
```
|
|
12519
|
+
|
|
12520
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
12521
|
+
|
|
12387
12522
|
---
|
|
12388
12523
|
##### Function: deserializeBaseBlockHeader
|
|
12389
12524
|
|
|
@@ -12562,6 +12697,7 @@ export function genesisHeader(chain: Chain): BlockHeader {
|
|
|
12562
12697
|
};
|
|
12563
12698
|
case "test":
|
|
12564
12699
|
case "ttn":
|
|
12700
|
+
case "tstn":
|
|
12565
12701
|
return {
|
|
12566
12702
|
version: 1,
|
|
12567
12703
|
previousHash: "0000000000000000000000000000000000000000000000000000000000000000",
|
|
@@ -12676,6 +12812,15 @@ reqs partitioned by status
|
|
|
12676
12812
|
|
|
12677
12813
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
12678
12814
|
|
|
12815
|
+
---
|
|
12816
|
+
##### Function: getResultBeef
|
|
12817
|
+
|
|
12818
|
+
```ts
|
|
12819
|
+
export function getResultBeef(result: object): Beef | undefined
|
|
12820
|
+
```
|
|
12821
|
+
|
|
12822
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
12823
|
+
|
|
12679
12824
|
---
|
|
12680
12825
|
##### Function: getSyncChunk
|
|
12681
12826
|
|
|
@@ -13110,6 +13255,15 @@ export function keyOffsetToHashedSecret(pub: PublicKey, keyOffset?: string): {
|
|
|
13110
13255
|
|
|
13111
13256
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13112
13257
|
|
|
13258
|
+
---
|
|
13259
|
+
##### Function: legacyBinaryJsonReplacer
|
|
13260
|
+
|
|
13261
|
+
```ts
|
|
13262
|
+
export function legacyBinaryJsonReplacer(_key: string, value: unknown): unknown
|
|
13263
|
+
```
|
|
13264
|
+
|
|
13265
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13266
|
+
|
|
13113
13267
|
---
|
|
13114
13268
|
##### Function: listCertificates
|
|
13115
13269
|
|
|
@@ -13296,14 +13450,15 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
13296
13450
|
Notify each transaction that a proof has been found.
|
|
13297
13451
|
Mutates `req` history notes in place.
|
|
13298
13452
|
|
|
13299
|
-
The `addNote`
|
|
13300
|
-
|
|
13453
|
+
The `addNote` callback avoids coupling this helper to a specific entity type.
|
|
13454
|
+
Returns false if any transaction update failed so callers can retain the
|
|
13455
|
+
request for later status repair.
|
|
13301
13456
|
|
|
13302
13457
|
```ts
|
|
13303
|
-
export async function notifyTransactionsOfProof(ids: number[], provenTxId: number, addNote: (note: ReqHistoryNote) => void,
|
|
13458
|
+
export async function notifyTransactionsOfProof(ids: number[], provenTxId: number, addNote: (note: ReqHistoryNote) => void, updateTransaction: (id: number, update: {
|
|
13304
13459
|
provenTxId: number;
|
|
13305
13460
|
status: "completed";
|
|
13306
|
-
}) => Promise<unknown>): Promise<
|
|
13461
|
+
}) => Promise<unknown>): Promise<boolean>
|
|
13307
13462
|
```
|
|
13308
13463
|
|
|
13309
13464
|
See also: [ReqHistoryNote](./client.md#interface-reqhistorynote)
|
|
@@ -13343,6 +13498,15 @@ export function optionalArraysEqual(arr1?: Number[], arr2?: Number[]): boolean
|
|
|
13343
13498
|
|
|
13344
13499
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13345
13500
|
|
|
13501
|
+
---
|
|
13502
|
+
##### Function: parseJsonRpc
|
|
13503
|
+
|
|
13504
|
+
```ts
|
|
13505
|
+
export function parseJsonRpc(text: string, binary: boolean = false): any
|
|
13506
|
+
```
|
|
13507
|
+
|
|
13508
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13509
|
+
|
|
13346
13510
|
---
|
|
13347
13511
|
##### Function: parseResults$
|
|
13348
13512
|
|
|
@@ -13565,6 +13729,15 @@ export function setDisableDoubleSpendCheckForTest(v: boolean)
|
|
|
13565
13729
|
|
|
13566
13730
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13567
13731
|
|
|
13732
|
+
---
|
|
13733
|
+
##### Function: setResultBeef
|
|
13734
|
+
|
|
13735
|
+
```ts
|
|
13736
|
+
export function setResultBeef(result: object, beef: Beef): void
|
|
13737
|
+
```
|
|
13738
|
+
|
|
13739
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13740
|
+
|
|
13568
13741
|
---
|
|
13569
13742
|
##### Function: sha256Hash
|
|
13570
13743
|
|
|
@@ -13686,6 +13859,15 @@ Argument Details
|
|
|
13686
13859
|
|
|
13687
13860
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13688
13861
|
|
|
13862
|
+
---
|
|
13863
|
+
##### Function: stringifyJsonRpc
|
|
13864
|
+
|
|
13865
|
+
```ts
|
|
13866
|
+
export function stringifyJsonRpc(value: unknown, binary: boolean): string
|
|
13867
|
+
```
|
|
13868
|
+
|
|
13869
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13870
|
+
|
|
13689
13871
|
---
|
|
13690
13872
|
##### Function: subWork
|
|
13691
13873
|
|
|
@@ -13718,6 +13900,17 @@ new buffer with byte order reversed.
|
|
|
13718
13900
|
|
|
13719
13901
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13720
13902
|
|
|
13903
|
+
---
|
|
13904
|
+
##### Function: tableAuthSessionToPeerSession
|
|
13905
|
+
|
|
13906
|
+
```ts
|
|
13907
|
+
export function tableAuthSessionToPeerSession(row: TableAuthSession): PeerSession
|
|
13908
|
+
```
|
|
13909
|
+
|
|
13910
|
+
See also: [TableAuthSession](./storage.md#interface-tableauthsession)
|
|
13911
|
+
|
|
13912
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13913
|
+
|
|
13721
13914
|
---
|
|
13722
13915
|
##### Function: throwDummyReviewActions
|
|
13723
13916
|
|
|
@@ -13844,6 +14037,29 @@ Argument Details
|
|
|
13844
14037
|
|
|
13845
14038
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13846
14039
|
|
|
14040
|
+
---
|
|
14041
|
+
##### Function: tstnArcadeUrl
|
|
14042
|
+
|
|
14043
|
+
Arcade broadcaster / ARC endpoint for tstn, or `undefined` when `TSTN_ARCADE_URL` is unset.
|
|
14044
|
+
|
|
14045
|
+
```ts
|
|
14046
|
+
export function tstnArcadeUrl(): string | undefined
|
|
14047
|
+
```
|
|
14048
|
+
|
|
14049
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
14050
|
+
|
|
14051
|
+
---
|
|
14052
|
+
##### Function: tstnChaintracksUrl
|
|
14053
|
+
|
|
14054
|
+
ChainTracks service URL for tstn. Falls back to `${TSTN_ARCADE_URL}/chaintracks/v1` when
|
|
14055
|
+
`TSTN_CHAINTRACKS_URL` is unset (mirrors the ttn layout). Throws when neither is configured.
|
|
14056
|
+
|
|
14057
|
+
```ts
|
|
14058
|
+
export function tstnChaintracksUrl(): string
|
|
14059
|
+
```
|
|
14060
|
+
|
|
14061
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
14062
|
+
|
|
13847
14063
|
---
|
|
13848
14064
|
##### Function: updateChaintracksFiatExchangeRates
|
|
13849
14065
|
|
|
@@ -14509,7 +14725,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
14509
14725
|
##### Type: Chain
|
|
14510
14726
|
|
|
14511
14727
|
```ts
|
|
14512
|
-
export type Chain = "main" | "test" | "ttn" | "mock"
|
|
14728
|
+
export type Chain = "main" | "test" | "ttn" | "tstn" | "mock"
|
|
14513
14729
|
```
|
|
14514
14730
|
|
|
14515
14731
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
@@ -14868,15 +15084,16 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
14868
15084
|
|
|
14869
15085
|
| | | |
|
|
14870
15086
|
| --- | --- | --- |
|
|
14871
|
-
| [ARCADE_POST_BEEF_CONCURRENCY](#variable-arcade_post_beef_concurrency) | [
|
|
14872
|
-
| [
|
|
14873
|
-
| [
|
|
14874
|
-
| [
|
|
14875
|
-
| [
|
|
14876
|
-
| [
|
|
14877
|
-
| [
|
|
14878
|
-
| [
|
|
14879
|
-
| [
|
|
15087
|
+
| [ARCADE_POST_BEEF_CONCURRENCY](#variable-arcade_post_beef_concurrency) | [brc29ProtocolID](#variable-brc29protocolid) | [specOpInvalidChange](#variable-specopinvalidchange) |
|
|
15088
|
+
| [BINARY_ENCODING](#variable-binary_encoding) | [dirtyHashes](#variable-dirtyhashes) | [specOpNoSendActions](#variable-specopnosendactions) |
|
|
15089
|
+
| [BINARY_ENCODING_HEADER](#variable-binary_encoding_header) | [logger](#variable-logger) | [specOpSetWalletChangeParams](#variable-specopsetwalletchangeparams) |
|
|
15090
|
+
| [BINARY_REQUEST_ENCODING_HEADER](#variable-binary_request_encoding_header) | [managedChangeOutputFields](#variable-managedchangeoutputfields) | [specOpThrowReviewActions](#variable-specopthrowreviewactions) |
|
|
15091
|
+
| [DEFAULT_SETTINGS](#variable-default_settings) | [maxChangeOutputsPerTransaction](#variable-maxchangeoutputspertransaction) | [specOpWalletBalance](#variable-specopwalletbalance) |
|
|
15092
|
+
| [MAX_STORAGE_COMMISSION_SATOSHIS](#variable-max_storage_commission_satoshis) | [maxPossibleSatoshis](#variable-maxpossiblesatoshis) | [specOpWalletManagedUtxos](#variable-specopwalletmanagedutxos) |
|
|
15093
|
+
| [ProvenTxReqNonTerminalStatus](#variable-proventxreqnonterminalstatus) | [outputColumnsWithoutLockingScript](#variable-outputcolumnswithoutlockingscript) | [transactionColumnsWithoutRawTx](#variable-transactioncolumnswithoutrawtx) |
|
|
15094
|
+
| [ProvenTxReqTerminalStatus](#variable-proventxreqterminalstatus) | [parseResults](#variable-parseresults) | [transformVerifiableCertificatesWithTrust](#variable-transformverifiablecertificateswithtrust) |
|
|
15095
|
+
| [TESTNET_DEFAULT_SETTINGS](#variable-testnet_default_settings) | [queryOverlay](#variable-queryoverlay) | [validBulkHeaderFiles](#variable-validbulkheaderfiles) |
|
|
15096
|
+
| [aggregateActionResults](#variable-aggregateactionresults) | [specOpFailedActions](#variable-specopfailedactions) | |
|
|
14880
15097
|
|
|
14881
15098
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
14882
15099
|
|
|
@@ -14890,6 +15107,33 @@ ARCADE_POST_BEEF_CONCURRENCY = 4
|
|
|
14890
15107
|
|
|
14891
15108
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
14892
15109
|
|
|
15110
|
+
---
|
|
15111
|
+
##### Variable: BINARY_ENCODING
|
|
15112
|
+
|
|
15113
|
+
```ts
|
|
15114
|
+
BINARY_ENCODING = "base64"
|
|
15115
|
+
```
|
|
15116
|
+
|
|
15117
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15118
|
+
|
|
15119
|
+
---
|
|
15120
|
+
##### Variable: BINARY_ENCODING_HEADER
|
|
15121
|
+
|
|
15122
|
+
```ts
|
|
15123
|
+
BINARY_ENCODING_HEADER = "X-BSV-Binary-Encoding"
|
|
15124
|
+
```
|
|
15125
|
+
|
|
15126
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15127
|
+
|
|
15128
|
+
---
|
|
15129
|
+
##### Variable: BINARY_REQUEST_ENCODING_HEADER
|
|
15130
|
+
|
|
15131
|
+
```ts
|
|
15132
|
+
BINARY_REQUEST_ENCODING_HEADER = "X-BSV-Binary-Request-Encoding"
|
|
15133
|
+
```
|
|
15134
|
+
|
|
15135
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
15136
|
+
|
|
14893
15137
|
---
|
|
14894
15138
|
##### Variable: DEFAULT_SETTINGS
|
|
14895
15139
|
|