@bsv/wallet-toolbox 2.0.24 → 2.0.26-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/client.md +313 -109
- package/docs/monitor.md +73 -3
- package/docs/services.md +154 -20
- package/docs/wallet.md +313 -109
- package/out/src/index.all.d.ts +1 -0
- package/out/src/index.all.d.ts.map +1 -1
- package/out/src/index.all.js +1 -0
- package/out/src/index.all.js.map +1 -1
- package/out/src/index.mobile.d.ts +1 -0
- package/out/src/index.mobile.d.ts.map +1 -1
- package/out/src/index.mobile.js +1 -0
- package/out/src/index.mobile.js.map +1 -1
- package/out/src/mockchain/MockChainMigrations.d.ts +20 -0
- package/out/src/mockchain/MockChainMigrations.d.ts.map +1 -0
- package/out/src/mockchain/MockChainMigrations.js +67 -0
- package/out/src/mockchain/MockChainMigrations.js.map +1 -0
- package/out/src/mockchain/MockChainStorage.d.ts +58 -0
- package/out/src/mockchain/MockChainStorage.d.ts.map +1 -0
- package/out/src/mockchain/MockChainStorage.js +101 -0
- package/out/src/mockchain/MockChainStorage.js.map +1 -0
- package/out/src/mockchain/MockChainTracker.d.ts +28 -0
- package/out/src/mockchain/MockChainTracker.d.ts.map +1 -0
- package/out/src/mockchain/MockChainTracker.js +95 -0
- package/out/src/mockchain/MockChainTracker.js.map +1 -0
- package/out/src/mockchain/MockMiner.d.ts +16 -0
- package/out/src/mockchain/MockMiner.d.ts.map +1 -0
- package/out/src/mockchain/MockMiner.js +136 -0
- package/out/src/mockchain/MockMiner.js.map +1 -0
- package/out/src/mockchain/MockServices.d.ts +44 -0
- package/out/src/mockchain/MockServices.d.ts.map +1 -0
- package/out/src/mockchain/MockServices.js +504 -0
- package/out/src/mockchain/MockServices.js.map +1 -0
- package/out/src/mockchain/index.d.ts +9 -0
- package/out/src/mockchain/index.d.ts.map +1 -0
- package/out/src/mockchain/index.js +18 -0
- package/out/src/mockchain/index.js.map +1 -0
- package/out/src/mockchain/merkleTree.d.ts +13 -0
- package/out/src/mockchain/merkleTree.d.ts.map +1 -0
- package/out/src/mockchain/merkleTree.js +113 -0
- package/out/src/mockchain/merkleTree.js.map +1 -0
- package/out/src/monitor/Monitor.d.ts +23 -0
- package/out/src/monitor/Monitor.d.ts.map +1 -1
- package/out/src/monitor/Monitor.js +27 -0
- package/out/src/monitor/Monitor.js.map +1 -1
- package/out/src/monitor/tasks/TaskArcSSE.d.ts +24 -0
- package/out/src/monitor/tasks/TaskArcSSE.d.ts.map +1 -0
- package/out/src/monitor/tasks/TaskArcSSE.js +155 -0
- package/out/src/monitor/tasks/TaskArcSSE.js.map +1 -0
- package/out/src/monitor/tasks/TaskMineBlock.d.ts +13 -0
- package/out/src/monitor/tasks/TaskMineBlock.d.ts.map +1 -0
- package/out/src/monitor/tasks/TaskMineBlock.js +29 -0
- package/out/src/monitor/tasks/TaskMineBlock.js.map +1 -0
- package/out/src/services/chaintracker/chaintracks/Ingest/__tests/WhatsOnChainServices.test.d.ts +2 -0
- package/out/src/services/chaintracker/chaintracks/Ingest/__tests/WhatsOnChainServices.test.d.ts.map +1 -0
- package/out/src/services/chaintracker/chaintracks/Ingest/__tests/WhatsOnChainServices.test.js +102 -0
- package/out/src/services/chaintracker/chaintracks/Ingest/__tests/WhatsOnChainServices.test.js.map +1 -0
- package/out/src/services/index.d.ts +1 -0
- package/out/src/services/index.d.ts.map +1 -1
- package/out/src/services/index.js +1 -0
- package/out/src/services/index.js.map +1 -1
- package/out/src/services/providers/ArcSSEClient.d.ts +56 -0
- package/out/src/services/providers/ArcSSEClient.d.ts.map +1 -0
- package/out/src/services/providers/ArcSSEClient.js +122 -0
- package/out/src/services/providers/ArcSSEClient.js.map +1 -0
- package/package.json +1 -1
package/docs/client.md
CHANGED
|
@@ -6,80 +6,81 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6
6
|
|
|
7
7
|
| | | |
|
|
8
8
|
| --- | --- | --- |
|
|
9
|
-
| [AdminStatsResult](#interface-adminstatsresult) | [
|
|
10
|
-
| [ArcConfig](#interface-arcconfig) | [
|
|
11
|
-
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [
|
|
12
|
-
| [
|
|
13
|
-
| [
|
|
14
|
-
| [
|
|
15
|
-
| [
|
|
16
|
-
| [
|
|
17
|
-
| [
|
|
18
|
-
| [
|
|
19
|
-
| [
|
|
20
|
-
| [
|
|
21
|
-
| [
|
|
22
|
-
| [
|
|
23
|
-
| [
|
|
24
|
-
| [
|
|
25
|
-
| [
|
|
26
|
-
| [
|
|
27
|
-
| [
|
|
28
|
-
| [
|
|
29
|
-
| [
|
|
30
|
-
| [
|
|
31
|
-
| [
|
|
32
|
-
| [
|
|
33
|
-
| [
|
|
34
|
-
| [
|
|
35
|
-
| [
|
|
36
|
-
| [
|
|
37
|
-
| [
|
|
38
|
-
| [
|
|
39
|
-
| [
|
|
40
|
-
| [
|
|
41
|
-
| [
|
|
42
|
-
| [
|
|
43
|
-
| [
|
|
44
|
-
| [
|
|
45
|
-
| [
|
|
46
|
-
| [
|
|
47
|
-
| [
|
|
48
|
-
| [
|
|
49
|
-
| [
|
|
50
|
-
| [
|
|
51
|
-
| [
|
|
52
|
-
| [
|
|
53
|
-
| [
|
|
54
|
-
| [
|
|
55
|
-
| [
|
|
56
|
-
| [
|
|
57
|
-
| [
|
|
58
|
-
| [
|
|
59
|
-
| [
|
|
60
|
-
| [
|
|
61
|
-
| [
|
|
62
|
-
| [
|
|
63
|
-
| [
|
|
64
|
-
| [
|
|
65
|
-
| [
|
|
66
|
-
| [
|
|
67
|
-
| [
|
|
68
|
-
| [
|
|
69
|
-
| [
|
|
70
|
-
| [
|
|
71
|
-
| [
|
|
72
|
-
| [
|
|
73
|
-
| [
|
|
74
|
-
| [
|
|
75
|
-
| [
|
|
76
|
-
| [
|
|
77
|
-
| [
|
|
78
|
-
| [
|
|
79
|
-
| [
|
|
80
|
-
| [
|
|
81
|
-
| [
|
|
82
|
-
| [
|
|
9
|
+
| [AdminStatsResult](#interface-adminstatsresult) | [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StatusForTxidResult](#interface-statusfortxidresult) |
|
|
10
|
+
| [ArcConfig](#interface-arcconfig) | [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [StorageAdminStats](#interface-storageadminstats) |
|
|
11
|
+
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [StorageCreateActionResult](#interface-storagecreateactionresult) |
|
|
12
|
+
| [ArcSSEClientOptions](#interface-arcsseclientoptions) | [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) |
|
|
13
|
+
| [ArcSSEEvent](#interface-arcsseevent) | [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) |
|
|
14
|
+
| [AuthId](#interface-authid) | [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [StorageFeeModel](#interface-storagefeemodel) |
|
|
15
|
+
| [AuthPayload](#interface-authpayload) | [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) |
|
|
16
|
+
| [BaseBlockHeader](#interface-baseblockheader) | [GetHeaderByteFileLinksResult](#interface-getheaderbytefilelinksresult) | [StorageIdbOptions](#interface-storageidboptions) |
|
|
17
|
+
| [BitailsConfig](#interface-bitailsconfig) | [GetMerklePathResult](#interface-getmerklepathresult) | [StorageIdbSchema](#interface-storageidbschema) |
|
|
18
|
+
| [BitailsMerkleProof](#interface-bitailsmerkleproof) | [GetRawTxResult](#interface-getrawtxresult) | [StorageIdentity](#interface-storageidentity) |
|
|
19
|
+
| [BlockHeader](#interface-blockheader) | [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) |
|
|
20
|
+
| [BsvExchangeRate](#interface-bsvexchangerate) | [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [StorageProcessActionArgs](#interface-storageprocessactionargs) |
|
|
21
|
+
| [BulkFileDataManagerMergeResult](#interface-bulkfiledatamanagermergeresult) | [GetScriptHashHistory](#interface-getscripthashhistory) | [StorageProcessActionResults](#interface-storageprocessactionresults) |
|
|
22
|
+
| [BulkFileDataManagerOptions](#interface-bulkfiledatamanageroptions) | [GetScriptHashHistoryResult](#interface-getscripthashhistoryresult) | [StorageProvenOrReq](#interface-storageprovenorreq) |
|
|
23
|
+
| [BulkHeaderFileInfo](#interface-bulkheaderfileinfo) | [GetStatusForTxidsResult](#interface-getstatusfortxidsresult) | [StorageProviderOptions](#interface-storageprovideroptions) |
|
|
24
|
+
| [BulkHeaderFilesInfo](#interface-bulkheaderfilesinfo) | [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [StorageReaderOptions](#interface-storagereaderoptions) |
|
|
25
|
+
| [BulkIngestorApi](#interface-bulkingestorapi) | [GetUtxoStatusResult](#interface-getutxostatusresult) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) |
|
|
26
|
+
| [BulkIngestorBaseOptions](#interface-bulkingestorbaseoptions) | [GroupedPermissionRequest](#interface-groupedpermissionrequest) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) |
|
|
27
|
+
| [BulkIngestorCDNOptions](#interface-bulkingestorcdnoptions) | [GroupedPermissions](#interface-groupedpermissions) | [SyncChunk](#interface-syncchunk) |
|
|
28
|
+
| [BulkIngestorWhatsOnChainOptions](#interface-bulkingestorwhatsonchainoptions) | [HeightRangeApi](#interface-heightrangeapi) | [SyncError](#interface-syncerror) |
|
|
29
|
+
| [BulkStorageApi](#interface-bulkstorageapi) | [HeightRanges](#interface-heightranges) | [SyncMap](#interface-syncmap) |
|
|
30
|
+
| [BulkStorageBaseOptions](#interface-bulkstoragebaseoptions) | [KeyPair](#interface-keypair) | [TableCertificate](#interface-tablecertificate) |
|
|
31
|
+
| [BulkSyncResult](#interface-bulksyncresult) | [KeyPairAddress](#interface-keypairaddress) | [TableCertificateField](#interface-tablecertificatefield) |
|
|
32
|
+
| [CertOpsWallet](#interface-certopswallet) | [ListActionsSpecOp](#interface-listactionsspecop) | [TableCertificateX](#interface-tablecertificatex) |
|
|
33
|
+
| [Certifier](#interface-certifier) | [ListOutputsSpecOp](#interface-listoutputsspecop) | [TableCommission](#interface-tablecommission) |
|
|
34
|
+
| [ChaintracksApi](#interface-chaintracksapi) | [LiveBlockHeader](#interface-liveblockheader) | [TableMonitorEvent](#interface-tablemonitorevent) |
|
|
35
|
+
| [ChaintracksAppendableFileApi](#interface-chaintracksappendablefileapi) | [LiveIngestorApi](#interface-liveingestorapi) | [TableOutput](#interface-tableoutput) |
|
|
36
|
+
| [ChaintracksChainTrackerOptions](#interface-chaintrackschaintrackeroptions) | [LiveIngestorBaseOptions](#interface-liveingestorbaseoptions) | [TableOutputBasket](#interface-tableoutputbasket) |
|
|
37
|
+
| [ChaintracksClientApi](#interface-chaintracksclientapi) | [LiveIngestorWhatsOnChainOptions](#interface-liveingestorwhatsonchainoptions) | [TableOutputTag](#interface-tableoutputtag) |
|
|
38
|
+
| [ChaintracksFetchApi](#interface-chaintracksfetchapi) | [MonitorOptions](#interface-monitoroptions) | [TableOutputTagMap](#interface-tableoutputtagmap) |
|
|
39
|
+
| [ChaintracksFsApi](#interface-chaintracksfsapi) | [OutPoint](#interface-outpoint) | [TableOutputX](#interface-tableoutputx) |
|
|
40
|
+
| [ChaintracksInfoApi](#interface-chaintracksinfoapi) | [Paged](#interface-paged) | [TableProvenTx](#interface-tableproventx) |
|
|
41
|
+
| [ChaintracksManagementApi](#interface-chaintracksmanagementapi) | [PendingSignAction](#interface-pendingsignaction) | [TableProvenTxReq](#interface-tableproventxreq) |
|
|
42
|
+
| [ChaintracksOptions](#interface-chaintracksoptions) | [PendingStorageInput](#interface-pendingstorageinput) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) |
|
|
43
|
+
| [ChaintracksPackageInfoApi](#interface-chaintrackspackageinfoapi) | [PermissionRequest](#interface-permissionrequest) | [TableSettings](#interface-tablesettings) |
|
|
44
|
+
| [ChaintracksReadableFileApi](#interface-chaintracksreadablefileapi) | [PermissionToken](#interface-permissiontoken) | [TableSyncState](#interface-tablesyncstate) |
|
|
45
|
+
| [ChaintracksServiceClientOptions](#interface-chaintracksserviceclientoptions) | [PermissionsManagerConfig](#interface-permissionsmanagerconfig) | [TableTransaction](#interface-tabletransaction) |
|
|
46
|
+
| [ChaintracksStorageApi](#interface-chaintracksstorageapi) | [PermissionsModule](#interface-permissionsmodule) | [TableTxLabel](#interface-tabletxlabel) |
|
|
47
|
+
| [ChaintracksStorageBaseOptions](#interface-chaintracksstoragebaseoptions) | [PostBeefResult](#interface-postbeefresult) | [TableTxLabelMap](#interface-tabletxlabelmap) |
|
|
48
|
+
| [ChaintracksStorageBulkFileApi](#interface-chaintracksstoragebulkfileapi) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [TableUser](#interface-tableuser) |
|
|
49
|
+
| [ChaintracksStorageIdbOptions](#interface-chaintracksstorageidboptions) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [TaskPurgeParams](#interface-taskpurgeparams) |
|
|
50
|
+
| [ChaintracksStorageIdbSchema](#interface-chaintracksstorageidbschema) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [TrustSettings](#interface-trustsettings) |
|
|
51
|
+
| [ChaintracksStorageIngestApi](#interface-chaintracksstorageingestapi) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [TrxToken](#interface-trxtoken) |
|
|
52
|
+
| [ChaintracksStorageNoDbOptions](#interface-chaintracksstoragenodboptions) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
|
|
53
|
+
| [ChaintracksStorageQueryApi](#interface-chaintracksstoragequeryapi) | [PostTxsResult](#interface-posttxsresult) | [TxScriptOffsets](#interface-txscriptoffsets) |
|
|
54
|
+
| [ChaintracksWritableFileApi](#interface-chaintrackswritablefileapi) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [UMPToken](#interface-umptoken) |
|
|
55
|
+
| [CommitNewTxResults](#interface-commitnewtxresults) | [Profile](#interface-profile) | [UMPTokenInteractor](#interface-umptokeninteractor) |
|
|
56
|
+
| [CompleteAuthResponse](#interface-completeauthresponse) | [ProvenOrRawTx](#interface-provenorrawtx) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
|
|
57
|
+
| [CounterpartyPermissionRequest](#interface-counterpartypermissionrequest) | [ProvenTransactionStatus](#interface-proventransactionstatus) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
|
|
58
|
+
| [CounterpartyPermissions](#interface-counterpartypermissions) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
|
|
59
|
+
| [CreateActionResultX](#interface-createactionresultx) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [VerifyAndRepairBeefResult](#interface-verifyandrepairbeefresult) |
|
|
60
|
+
| [DeactivedHeader](#interface-deactivedheader) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [WalletArgs](#interface-walletargs) |
|
|
61
|
+
| [EntitySyncMap](#interface-entitysyncmap) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [WalletBalance](#interface-walletbalance) |
|
|
62
|
+
| [EntityTimeStamp](#interface-entitytimestamp) | [ProviderCallHistory](#interface-providercallhistory) | [WalletLoggerArgs](#interface-walletloggerargs) |
|
|
63
|
+
| [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [PurgeParams](#interface-purgeparams) | [WalletPermissionsManagerCallbacks](#interface-walletpermissionsmanagercallbacks) |
|
|
64
|
+
| [ExtendedVerifiableCertificate](#interface-extendedverifiablecertificate) | [PurgeResults](#interface-purgeresults) | [WalletServices](#interface-walletservices) |
|
|
65
|
+
| [FiatExchangeRates](#interface-fiatexchangerates) | [ReproveHeaderResult](#interface-reproveheaderresult) | [WalletServicesOptions](#interface-walletservicesoptions) |
|
|
66
|
+
| [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [ReproveProvenResult](#interface-reproveprovenresult) | [WalletSettings](#interface-walletsettings) |
|
|
67
|
+
| [FindCertificatesArgs](#interface-findcertificatesargs) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [WalletSettingsManagerConfig](#interface-walletsettingsmanagerconfig) |
|
|
68
|
+
| [FindCommissionsArgs](#interface-findcommissionsargs) | [ReviewActionResult](#interface-reviewactionresult) | [WalletSigner](#interface-walletsigner) |
|
|
69
|
+
| [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [WalletStorage](#interface-walletstorage) |
|
|
70
|
+
| [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [WalletStorageInfo](#interface-walletstorageinfo) |
|
|
71
|
+
| [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [ServiceCall](#interface-servicecall) | [WalletStorageProvider](#interface-walletstorageprovider) |
|
|
72
|
+
| [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [ServiceCall](#interface-servicecall) | [WalletStorageReader](#interface-walletstoragereader) |
|
|
73
|
+
| [FindOutputTagsArgs](#interface-findoutputtagsargs) | [ServiceCallHistory](#interface-servicecallhistory) | [WalletStorageSync](#interface-walletstoragesync) |
|
|
74
|
+
| [FindOutputsArgs](#interface-findoutputsargs) | [ServiceCallHistoryCounts](#interface-servicecallhistorycounts) | [WalletStorageSyncReader](#interface-walletstoragesyncreader) |
|
|
75
|
+
| [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [ServiceToCall](#interface-servicetocall) | [WalletStorageWriter](#interface-walletstoragewriter) |
|
|
76
|
+
| [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [SetupClientWalletArgs](#interface-setupclientwalletargs) | [WalletTheme](#interface-wallettheme) |
|
|
77
|
+
| [FindProvenTxsArgs](#interface-findproventxsargs) | [SetupClientWalletClientArgs](#interface-setupclientwalletclientargs) | [WhatsOnChainServicesOptions](#interface-whatsonchainservicesoptions) |
|
|
78
|
+
| [FindSincePagedArgs](#interface-findsincepagedargs) | [SetupWallet](#interface-setupwallet) | [WocChainInfo](#interface-wocchaininfo) |
|
|
79
|
+
| [FindSyncStatesArgs](#interface-findsyncstatesargs) | [SetupWalletClient](#interface-setupwalletclient) | [WocGetHeaderByteFileLinks](#interface-wocgetheaderbytefilelinks) |
|
|
80
|
+
| [FindTransactionsArgs](#interface-findtransactionsargs) | [SetupWalletIdb](#interface-setupwalletidb) | [WocGetHeadersHeader](#interface-wocgetheadersheader) |
|
|
81
|
+
| [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [SetupWalletIdbArgs](#interface-setupwalletidbargs) | [WocHeader](#interface-wocheader) |
|
|
82
|
+
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [SignActionResultX](#interface-signactionresultx) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
|
|
83
|
+
| [FindUsersArgs](#interface-findusersargs) | [StartAuthResponse](#interface-startauthresponse) | |
|
|
83
84
|
|
|
84
85
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
85
86
|
|
|
@@ -186,6 +187,104 @@ See also: [blockHash](./services.md#function-blockhash)
|
|
|
186
187
|
|
|
187
188
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
188
189
|
|
|
190
|
+
---
|
|
191
|
+
##### Interface: ArcSSEClientOptions
|
|
192
|
+
|
|
193
|
+
```ts
|
|
194
|
+
export interface ArcSSEClientOptions {
|
|
195
|
+
baseUrl: string;
|
|
196
|
+
callbackToken: string;
|
|
197
|
+
onEvent: (event: ArcSSEEvent) => void;
|
|
198
|
+
onError?: (error: Event) => void;
|
|
199
|
+
onConnected?: () => void;
|
|
200
|
+
onDisconnected?: () => void;
|
|
201
|
+
lastEventId?: string;
|
|
202
|
+
}
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
See also: [ArcSSEEvent](./services.md#interface-arcsseevent)
|
|
206
|
+
|
|
207
|
+
###### Property baseUrl
|
|
208
|
+
|
|
209
|
+
Base URL of the Arcade instance (e.g. "https://arcade-us-1.bsvb.tech")
|
|
210
|
+
|
|
211
|
+
```ts
|
|
212
|
+
baseUrl: string
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
###### Property callbackToken
|
|
216
|
+
|
|
217
|
+
Stable per-wallet token matching the X-CallbackToken sent on broadcast
|
|
218
|
+
|
|
219
|
+
```ts
|
|
220
|
+
callbackToken: string
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
###### Property lastEventId
|
|
224
|
+
|
|
225
|
+
Initial lastEventId for catchup on first connect
|
|
226
|
+
|
|
227
|
+
```ts
|
|
228
|
+
lastEventId?: string
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
###### Property onConnected
|
|
232
|
+
|
|
233
|
+
Called when connection is established
|
|
234
|
+
|
|
235
|
+
```ts
|
|
236
|
+
onConnected?: () => void
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
###### Property onDisconnected
|
|
240
|
+
|
|
241
|
+
Called when connection is lost
|
|
242
|
+
|
|
243
|
+
```ts
|
|
244
|
+
onDisconnected?: () => void
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
###### Property onError
|
|
248
|
+
|
|
249
|
+
Called when a connection error occurs
|
|
250
|
+
|
|
251
|
+
```ts
|
|
252
|
+
onError?: (error: Event) => void
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
###### Property onEvent
|
|
256
|
+
|
|
257
|
+
Called for each status event received
|
|
258
|
+
|
|
259
|
+
```ts
|
|
260
|
+
onEvent: (event: ArcSSEEvent) => void
|
|
261
|
+
```
|
|
262
|
+
See also: [ArcSSEEvent](./services.md#interface-arcsseevent)
|
|
263
|
+
|
|
264
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
265
|
+
|
|
266
|
+
---
|
|
267
|
+
##### Interface: ArcSSEEvent
|
|
268
|
+
|
|
269
|
+
SSE (Server-Sent Events) client for Arcade transaction status updates.
|
|
270
|
+
|
|
271
|
+
Connects to Arcade's `GET /events?callbackToken=<token>` endpoint
|
|
272
|
+
and receives real-time status updates for transactions submitted
|
|
273
|
+
with the matching `X-CallbackToken` header.
|
|
274
|
+
|
|
275
|
+
Supports pause/resume for mobile app lifecycle (background/foreground)
|
|
276
|
+
with automatic catchup via the `Last-Event-ID` mechanism.
|
|
277
|
+
|
|
278
|
+
```ts
|
|
279
|
+
export interface ArcSSEEvent {
|
|
280
|
+
txid: string;
|
|
281
|
+
txStatus: string;
|
|
282
|
+
timestamp: string;
|
|
283
|
+
}
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
287
|
+
|
|
189
288
|
---
|
|
190
289
|
##### Interface: AuthId
|
|
191
290
|
|
|
@@ -3659,13 +3758,26 @@ export interface MonitorOptions {
|
|
|
3659
3758
|
abandonedMsecs: number;
|
|
3660
3759
|
unprovenAttemptsLimitTest: number;
|
|
3661
3760
|
unprovenAttemptsLimitMain: number;
|
|
3761
|
+
callbackToken?: string;
|
|
3662
3762
|
onTransactionBroadcasted?: (broadcastResult: ReviewActionResult) => Promise<void>;
|
|
3663
3763
|
onTransactionProven?: (txStatus: ProvenTransactionStatus) => Promise<void>;
|
|
3764
|
+
onTransactionStatusChanged?: (txid: string, newStatus: string) => Promise<void>;
|
|
3664
3765
|
}
|
|
3665
3766
|
```
|
|
3666
3767
|
|
|
3667
3768
|
See also: [Chain](./client.md#type-chain), [Chaintracks](./services.md#class-chaintracks), [ChaintracksClientApi](./services.md#interface-chaintracksclientapi), [MonitorStorage](./monitor.md#type-monitorstorage), [ProvenTransactionStatus](./client.md#interface-proventransactionstatus), [ReviewActionResult](./client.md#interface-reviewactionresult), [Services](./services.md#class-services)
|
|
3668
3769
|
|
|
3770
|
+
###### Property callbackToken
|
|
3771
|
+
|
|
3772
|
+
Stable callback token for ARC SSE event streaming.
|
|
3773
|
+
When set, TaskArcSSE will open an SSE connection to Arcade's
|
|
3774
|
+
/events endpoint and receive real-time transaction status updates.
|
|
3775
|
+
Must match the X-CallbackToken header sent during broadcast.
|
|
3776
|
+
|
|
3777
|
+
```ts
|
|
3778
|
+
callbackToken?: string
|
|
3779
|
+
```
|
|
3780
|
+
|
|
3669
3781
|
###### Property msecsWaitPerMerkleProofServiceReq
|
|
3670
3782
|
|
|
3671
3783
|
How many msecs to wait after each getMerkleProof service request.
|
|
@@ -8203,41 +8315,41 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
8203
8315
|
|
|
8204
8316
|
| | | |
|
|
8205
8317
|
| --- | --- | --- |
|
|
8206
|
-
| [ARC](#class-arc) | [
|
|
8207
|
-
| [
|
|
8208
|
-
| [
|
|
8209
|
-
| [
|
|
8210
|
-
| [
|
|
8211
|
-
| [
|
|
8212
|
-
| [
|
|
8213
|
-
| [
|
|
8214
|
-
| [
|
|
8215
|
-
| [
|
|
8216
|
-
| [
|
|
8217
|
-
| [
|
|
8218
|
-
| [
|
|
8219
|
-
| [
|
|
8220
|
-
| [
|
|
8221
|
-
| [
|
|
8222
|
-
| [
|
|
8223
|
-
| [
|
|
8224
|
-
| [
|
|
8225
|
-
| [
|
|
8226
|
-
| [
|
|
8227
|
-
| [
|
|
8228
|
-
| [
|
|
8229
|
-
| [
|
|
8230
|
-
| [
|
|
8231
|
-
| [
|
|
8232
|
-
| [
|
|
8233
|
-
| [
|
|
8234
|
-
| [
|
|
8235
|
-
| [
|
|
8236
|
-
| [
|
|
8237
|
-
| [
|
|
8238
|
-
| [
|
|
8239
|
-
| [
|
|
8240
|
-
| [
|
|
8318
|
+
| [ARC](#class-arc) | [EntityOutputTagMap](#class-entityoutputtagmap) | [TaskNewHeader](#class-tasknewheader) |
|
|
8319
|
+
| [ArcSSEClient](#class-arcsseclient) | [EntityProvenTx](#class-entityproventx) | [TaskPurge](#class-taskpurge) |
|
|
8320
|
+
| [AuthMethodInteractor](#class-authmethodinteractor) | [EntityProvenTxReq](#class-entityproventxreq) | [TaskReorg](#class-taskreorg) |
|
|
8321
|
+
| [BHServiceClient](#class-bhserviceclient) | [EntitySyncState](#class-entitysyncstate) | [TaskReviewStatus](#class-taskreviewstatus) |
|
|
8322
|
+
| [Bitails](#class-bitails) | [EntityTransaction](#class-entitytransaction) | [TaskSendWaiting](#class-tasksendwaiting) |
|
|
8323
|
+
| [BulkFileDataManager](#class-bulkfiledatamanager) | [EntityTxLabel](#class-entitytxlabel) | [TaskSyncWhenIdle](#class-tasksyncwhenidle) |
|
|
8324
|
+
| [BulkFileDataReader](#class-bulkfiledatareader) | [EntityTxLabelMap](#class-entitytxlabelmap) | [TaskUnFail](#class-taskunfail) |
|
|
8325
|
+
| [BulkFilesReader](#class-bulkfilesreader) | [EntityUser](#class-entityuser) | [TwilioPhoneInteractor](#class-twiliophoneinteractor) |
|
|
8326
|
+
| [BulkFilesReaderFs](#class-bulkfilesreaderfs) | [HeightRange](#class-heightrange) | [WABClient](#class-wabclient) |
|
|
8327
|
+
| [BulkFilesReaderStorage](#class-bulkfilesreaderstorage) | [LiveIngestorBase](#class-liveingestorbase) | [WERR_BAD_REQUEST](#class-werr_bad_request) |
|
|
8328
|
+
| [BulkHeaderFile](#class-bulkheaderfile) | [LiveIngestorWhatsOnChainPoll](#class-liveingestorwhatsonchainpoll) | [WERR_BROADCAST_UNAVAILABLE](#class-werr_broadcast_unavailable) |
|
|
8329
|
+
| [BulkHeaderFileFs](#class-bulkheaderfilefs) | [MergeEntity](#class-mergeentity) | [WERR_INSUFFICIENT_FUNDS](#class-werr_insufficient_funds) |
|
|
8330
|
+
| [BulkHeaderFileStorage](#class-bulkheaderfilestorage) | [Monitor](#class-monitor) | [WERR_INTERNAL](#class-werr_internal) |
|
|
8331
|
+
| [BulkHeaderFiles](#class-bulkheaderfiles) | [OverlayUMPTokenInteractor](#class-overlayumptokeninteractor) | [WERR_INVALID_MERKLE_ROOT](#class-werr_invalid_merkle_root) |
|
|
8332
|
+
| [BulkIngestorBase](#class-bulkingestorbase) | [PersonaIDInteractor](#class-personaidinteractor) | [WERR_INVALID_OPERATION](#class-werr_invalid_operation) |
|
|
8333
|
+
| [BulkIngestorCDN](#class-bulkingestorcdn) | [PrivilegedKeyManager](#class-privilegedkeymanager) | [WERR_INVALID_PARAMETER](#class-werr_invalid_parameter) |
|
|
8334
|
+
| [BulkIngestorCDNBabbage](#class-bulkingestorcdnbabbage) | [ScriptTemplateBRC29](#class-scripttemplatebrc29) | [WERR_INVALID_PUBLIC_KEY](#class-werr_invalid_public_key) |
|
|
8335
|
+
| [BulkIngestorWhatsOnChainCdn](#class-bulkingestorwhatsonchaincdn) | [SdkWhatsOnChain](#class-sdkwhatsonchain) | [WERR_MISSING_PARAMETER](#class-werr_missing_parameter) |
|
|
8336
|
+
| [BulkStorageBase](#class-bulkstoragebase) | [ServiceCollection](#class-servicecollection) | [WERR_NETWORK_CHAIN](#class-werr_network_chain) |
|
|
8337
|
+
| [CWIStyleWalletManager](#class-cwistylewalletmanager) | [Services](#class-services) | [WERR_NOT_ACTIVE](#class-werr_not_active) |
|
|
8338
|
+
| [Chaintracks](#class-chaintracks) | [SetupClient](#class-setupclient) | [WERR_NOT_IMPLEMENTED](#class-werr_not_implemented) |
|
|
8339
|
+
| [ChaintracksChainTracker](#class-chaintrackschaintracker) | [SimpleWalletManager](#class-simplewalletmanager) | [WERR_REVIEW_ACTIONS](#class-werr_review_actions) |
|
|
8340
|
+
| [ChaintracksFetch](#class-chaintracksfetch) | [SingleWriterMultiReaderLock](#class-singlewritermultireaderlock) | [WERR_UNAUTHORIZED](#class-werr_unauthorized) |
|
|
8341
|
+
| [ChaintracksServiceClient](#class-chaintracksserviceclient) | [StorageClient](#class-storageclient) | [Wallet](#class-wallet) |
|
|
8342
|
+
| [ChaintracksStorageBase](#class-chaintracksstoragebase) | [StorageIdb](#class-storageidb) | [WalletAuthenticationManager](#class-walletauthenticationmanager) |
|
|
8343
|
+
| [ChaintracksStorageIdb](#class-chaintracksstorageidb) | [StorageProvider](#class-storageprovider) | [WalletError](#class-walleterror) |
|
|
8344
|
+
| [ChaintracksStorageNoDb](#class-chaintracksstoragenodb) | [StorageReader](#class-storagereader) | [WalletLogger](#class-walletlogger) |
|
|
8345
|
+
| [DevConsoleInteractor](#class-devconsoleinteractor) | [StorageReaderWriter](#class-storagereaderwriter) | [WalletMonitorTask](#class-walletmonitortask) |
|
|
8346
|
+
| [EntityBase](#class-entitybase) | [StorageSyncReader](#class-storagesyncreader) | [WalletPermissionsManager](#class-walletpermissionsmanager) |
|
|
8347
|
+
| [EntityCertificate](#class-entitycertificate) | [TaskArcSSE](#class-taskarcsse) | [WalletSettingsManager](#class-walletsettingsmanager) |
|
|
8348
|
+
| [EntityCertificateField](#class-entitycertificatefield) | [TaskCheckForProofs](#class-taskcheckforproofs) | [WalletSigner](#class-walletsigner) |
|
|
8349
|
+
| [EntityCommission](#class-entitycommission) | [TaskCheckNoSends](#class-taskchecknosends) | [WalletStorageManager](#class-walletstoragemanager) |
|
|
8350
|
+
| [EntityOutput](#class-entityoutput) | [TaskClock](#class-taskclock) | [WhatsOnChain](#class-whatsonchain) |
|
|
8351
|
+
| [EntityOutputBasket](#class-entityoutputbasket) | [TaskFailAbandoned](#class-taskfailabandoned) | [WhatsOnChainNoServices](#class-whatsonchainnoservices) |
|
|
8352
|
+
| [EntityOutputTag](#class-entityoutputtag) | [TaskMonitorCallHistory](#class-taskmonitorcallhistory) | [WhatsOnChainServices](#class-whatsonchainservices) |
|
|
8241
8353
|
|
|
8242
8354
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8243
8355
|
|
|
@@ -8336,6 +8448,41 @@ See also: [PostTxResultForTxid](./client.md#interface-posttxresultfortxid)
|
|
|
8336
8448
|
|
|
8337
8449
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8338
8450
|
|
|
8451
|
+
---
|
|
8452
|
+
##### Class: ArcSSEClient
|
|
8453
|
+
|
|
8454
|
+
```ts
|
|
8455
|
+
export class ArcSSEClient {
|
|
8456
|
+
constructor(private readonly options: ArcSSEClientOptions)
|
|
8457
|
+
get lastEventId(): string | undefined
|
|
8458
|
+
get connected(): boolean
|
|
8459
|
+
connect(): void
|
|
8460
|
+
disconnect(): void
|
|
8461
|
+
pause(): void
|
|
8462
|
+
resume(): void
|
|
8463
|
+
}
|
|
8464
|
+
```
|
|
8465
|
+
|
|
8466
|
+
See also: [ArcSSEClientOptions](./services.md#interface-arcsseclientoptions)
|
|
8467
|
+
|
|
8468
|
+
###### Method pause
|
|
8469
|
+
|
|
8470
|
+
Close the SSE connection but preserve lastEventId for later catchup
|
|
8471
|
+
|
|
8472
|
+
```ts
|
|
8473
|
+
pause(): void
|
|
8474
|
+
```
|
|
8475
|
+
|
|
8476
|
+
###### Method resume
|
|
8477
|
+
|
|
8478
|
+
Reopen the SSE connection; server replays missed events via Last-Event-ID
|
|
8479
|
+
|
|
8480
|
+
```ts
|
|
8481
|
+
resume(): void
|
|
8482
|
+
```
|
|
8483
|
+
|
|
8484
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8485
|
+
|
|
8339
8486
|
---
|
|
8340
8487
|
##### Class: AuthMethodInteractor
|
|
8341
8488
|
|
|
@@ -11248,6 +11395,7 @@ export class Monitor {
|
|
|
11248
11395
|
headersSubscriptionPromise?: Promise<string>;
|
|
11249
11396
|
onTransactionBroadcasted?: (broadcastResult: ReviewActionResult) => Promise<void>;
|
|
11250
11397
|
onTransactionProven?: (txStatus: ProvenTransactionStatus) => Promise<void>;
|
|
11398
|
+
onTransactionStatusChanged?: (txid: string, newStatus: string) => Promise<void>;
|
|
11251
11399
|
constructor(options: MonitorOptions)
|
|
11252
11400
|
async destroy(): Promise<void>
|
|
11253
11401
|
static readonly oneSecond = 1000;
|
|
@@ -11284,6 +11432,9 @@ export class Monitor {
|
|
|
11284
11432
|
processNewBlockHeader(header: BlockHeader): void
|
|
11285
11433
|
callOnBroadcastedTransaction(broadcastResult: ReviewActionResult): void
|
|
11286
11434
|
callOnProvenTransaction(txStatus: ProvenTransactionStatus): void
|
|
11435
|
+
callOnTransactionStatusChanged(txid: string, newStatus: string): void
|
|
11436
|
+
pauseSSE(): void
|
|
11437
|
+
resumeSSE(): void
|
|
11287
11438
|
deactivatedHeaders: DeactivedHeader[] = [];
|
|
11288
11439
|
processReorg(depth: number, oldTip: BlockHeader, newTip: BlockHeader, deactivatedHeaders?: BlockHeader[]): void
|
|
11289
11440
|
processHeader(header: BlockHeader): void
|
|
@@ -11350,6 +11501,23 @@ callOnProvenTransaction(txStatus: ProvenTransactionStatus): void
|
|
|
11350
11501
|
```
|
|
11351
11502
|
See also: [ProvenTransactionStatus](./client.md#interface-proventransactionstatus)
|
|
11352
11503
|
|
|
11504
|
+
###### Method callOnTransactionStatusChanged
|
|
11505
|
+
|
|
11506
|
+
Called by TaskArcSSE when an SSE status event is received from Arcade.
|
|
11507
|
+
|
|
11508
|
+
```ts
|
|
11509
|
+
callOnTransactionStatusChanged(txid: string, newStatus: string): void
|
|
11510
|
+
```
|
|
11511
|
+
|
|
11512
|
+
###### Method pauseSSE
|
|
11513
|
+
|
|
11514
|
+
Pause the SSE connection (e.g. when mobile app goes to background).
|
|
11515
|
+
The lastEventId is preserved for catchup on resume.
|
|
11516
|
+
|
|
11517
|
+
```ts
|
|
11518
|
+
pauseSSE(): void
|
|
11519
|
+
```
|
|
11520
|
+
|
|
11353
11521
|
###### Method processHeader
|
|
11354
11522
|
|
|
11355
11523
|
Handler for new header events from Chaintracks.
|
|
@@ -11389,6 +11557,15 @@ processReorg(depth: number, oldTip: BlockHeader, newTip: BlockHeader, deactivate
|
|
|
11389
11557
|
```
|
|
11390
11558
|
See also: [BlockHeader](./client.md#interface-blockheader)
|
|
11391
11559
|
|
|
11560
|
+
###### Method resumeSSE
|
|
11561
|
+
|
|
11562
|
+
Resume the SSE connection (e.g. when mobile app returns to foreground).
|
|
11563
|
+
Missed events are replayed by the server via Last-Event-ID.
|
|
11564
|
+
|
|
11565
|
+
```ts
|
|
11566
|
+
resumeSSE(): void
|
|
11567
|
+
```
|
|
11568
|
+
|
|
11392
11569
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11393
11570
|
|
|
11394
11571
|
---
|
|
@@ -13549,6 +13726,33 @@ See also: [AuthId](./client.md#interface-authid), [RequestSyncChunkArgs](./clien
|
|
|
13549
13726
|
|
|
13550
13727
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13551
13728
|
|
|
13729
|
+
---
|
|
13730
|
+
##### Class: TaskArcSSE
|
|
13731
|
+
|
|
13732
|
+
Monitor task that manages an SSE connection to Arcade for real-time
|
|
13733
|
+
transaction status updates.
|
|
13734
|
+
|
|
13735
|
+
Events are queued by the SSE callback and processed on each monitor cycle.
|
|
13736
|
+
On MINED events, triggers TaskCheckForProofs to fetch merkle proofs.
|
|
13737
|
+
|
|
13738
|
+
```ts
|
|
13739
|
+
export class TaskArcSSE extends WalletMonitorTask {
|
|
13740
|
+
static taskName = "ArcSSE";
|
|
13741
|
+
constructor(monitor: Monitor)
|
|
13742
|
+
override async asyncSetup(): Promise<void>
|
|
13743
|
+
trigger(_nowMsecsSinceEpoch: number): {
|
|
13744
|
+
run: boolean;
|
|
13745
|
+
}
|
|
13746
|
+
async runTask(): Promise<string>
|
|
13747
|
+
pause(): void
|
|
13748
|
+
resume(): void
|
|
13749
|
+
}
|
|
13750
|
+
```
|
|
13751
|
+
|
|
13752
|
+
See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
13753
|
+
|
|
13754
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13755
|
+
|
|
13552
13756
|
---
|
|
13553
13757
|
##### Class: TaskCheckForProofs
|
|
13554
13758
|
|