@bsv/wallet-toolbox 1.3.28 → 1.3.30
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 +24 -0
- package/docs/client.md +550 -172
- package/docs/monitor.md +25 -7
- package/docs/services.md +136 -23
- package/docs/storage.md +53 -22
- package/docs/wallet.md +550 -172
- package/mobile/out/src/monitor/Monitor.js +1 -1
- package/mobile/out/src/monitor/Monitor.js.map +1 -1
- package/mobile/out/src/sdk/WalletServices.interfaces.d.ts.map +1 -1
- package/mobile/out/src/services/ServiceCollection.d.ts +3 -2
- package/mobile/out/src/services/ServiceCollection.d.ts.map +1 -1
- package/mobile/out/src/services/ServiceCollection.js +5 -4
- package/mobile/out/src/services/ServiceCollection.js.map +1 -1
- package/mobile/out/src/services/Services.d.ts +1 -0
- package/mobile/out/src/services/Services.d.ts.map +1 -1
- package/mobile/out/src/services/Services.js +29 -7
- package/mobile/out/src/services/Services.js.map +1 -1
- package/mobile/out/src/services/createDefaultWalletServicesOptions.d.ts.map +1 -1
- package/mobile/out/src/services/createDefaultWalletServicesOptions.js +1 -3
- package/mobile/out/src/services/createDefaultWalletServicesOptions.js.map +1 -1
- package/mobile/out/src/signer/methods/completeSignedTransaction.d.ts +10 -0
- package/mobile/out/src/signer/methods/completeSignedTransaction.d.ts.map +1 -0
- package/mobile/out/src/signer/methods/completeSignedTransaction.js +104 -0
- package/mobile/out/src/signer/methods/completeSignedTransaction.js.map +1 -0
- package/mobile/out/src/signer/methods/createAction.d.ts +2 -3
- package/mobile/out/src/signer/methods/createAction.d.ts.map +1 -1
- package/mobile/out/src/signer/methods/createAction.js +8 -46
- package/mobile/out/src/signer/methods/createAction.js.map +1 -1
- package/mobile/out/src/signer/methods/signAction.d.ts +2 -4
- package/mobile/out/src/signer/methods/signAction.d.ts.map +1 -1
- package/mobile/out/src/signer/methods/signAction.js +7 -54
- package/mobile/out/src/signer/methods/signAction.js.map +1 -1
- package/mobile/out/src/storage/methods/createAction.d.ts.map +1 -1
- package/mobile/out/src/storage/methods/createAction.js.map +1 -1
- package/mobile/package-lock.json +2 -2
- package/mobile/package.json +1 -1
- package/out/src/monitor/Monitor.js +1 -1
- package/out/src/monitor/Monitor.js.map +1 -1
- package/out/src/sdk/WalletServices.interfaces.d.ts.map +1 -1
- package/out/src/services/ServiceCollection.d.ts +3 -2
- package/out/src/services/ServiceCollection.d.ts.map +1 -1
- package/out/src/services/ServiceCollection.js +5 -4
- package/out/src/services/ServiceCollection.js.map +1 -1
- package/out/src/services/Services.d.ts +1 -0
- package/out/src/services/Services.d.ts.map +1 -1
- package/out/src/services/Services.js +29 -7
- package/out/src/services/Services.js.map +1 -1
- package/out/src/services/createDefaultWalletServicesOptions.d.ts.map +1 -1
- package/out/src/services/createDefaultWalletServicesOptions.js +1 -3
- package/out/src/services/createDefaultWalletServicesOptions.js.map +1 -1
- package/out/src/signer/methods/completeSignedTransaction.d.ts +10 -0
- package/out/src/signer/methods/completeSignedTransaction.d.ts.map +1 -0
- package/out/src/signer/methods/completeSignedTransaction.js +104 -0
- package/out/src/signer/methods/completeSignedTransaction.js.map +1 -0
- package/out/src/signer/methods/createAction.d.ts +2 -3
- package/out/src/signer/methods/createAction.d.ts.map +1 -1
- package/out/src/signer/methods/createAction.js +8 -46
- package/out/src/signer/methods/createAction.js.map +1 -1
- package/out/src/signer/methods/signAction.d.ts +2 -4
- package/out/src/signer/methods/signAction.d.ts.map +1 -1
- package/out/src/signer/methods/signAction.js +7 -54
- package/out/src/signer/methods/signAction.js.map +1 -1
- package/out/src/storage/StorageKnex.d.ts.map +1 -1
- package/out/src/storage/StorageKnex.js +7 -2
- package/out/src/storage/StorageKnex.js.map +1 -1
- package/out/src/storage/methods/createAction.d.ts.map +1 -1
- package/out/src/storage/methods/createAction.js.map +1 -1
- package/out/test/Wallet/support/operations.man.test.js +23 -5
- package/out/test/Wallet/support/operations.man.test.js.map +1 -1
- package/out/test/wallet/action/createAction2.test.d.ts.map +1 -1
- package/out/test/wallet/action/createAction2.test.js +1 -0
- package/out/test/wallet/action/createAction2.test.js.map +1 -1
- package/out/tsconfig.all.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/monitor/Monitor.ts +1 -1
- package/src/sdk/WalletServices.interfaces.ts +2 -2
- package/src/services/ServiceCollection.ts +15 -10
- package/src/services/Services.ts +53 -42
- package/src/services/createDefaultWalletServicesOptions.ts +1 -4
- package/src/signer/methods/completeSignedTransaction.ts +115 -0
- package/src/signer/methods/createAction.ts +9 -68
- package/src/signer/methods/signAction.ts +11 -78
- package/src/storage/StorageKnex.ts +45 -14
- package/src/storage/StorageProvider.ts +1 -1
- package/src/storage/methods/createAction.ts +4 -1
- package/test/Wallet/support/operations.man.test.ts +29 -10
- package/test/wallet/action/createAction2.test.ts +1 -0
package/docs/wallet.md
CHANGED
|
@@ -13,74 +13,90 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
13
13
|
|
|
14
14
|
| | | |
|
|
15
15
|
| --- | --- | --- |
|
|
16
|
-
| [
|
|
17
|
-
| [
|
|
18
|
-
| [
|
|
19
|
-
| [
|
|
20
|
-
| [
|
|
21
|
-
| [BaseBlockHeader](#interface-baseblockheader) | [
|
|
22
|
-
| [
|
|
23
|
-
| [
|
|
24
|
-
| [
|
|
25
|
-
| [BlockHeader](#interface-blockheader) | [
|
|
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
|
-
| [
|
|
16
|
+
| [AdminStatsResult](#interface-adminstatsresult) | [PendingStorageInput](#interface-pendingstorageinput) | [TableOutputBasket](#interface-tableoutputbasket) |
|
|
17
|
+
| [ArcConfig](#interface-arcconfig) | [PermissionRequest](#interface-permissionrequest) | [TableOutputTag](#interface-tableoutputtag) |
|
|
18
|
+
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [PermissionToken](#interface-permissiontoken) | [TableOutputTagMap](#interface-tableoutputtagmap) |
|
|
19
|
+
| [AuthId](#interface-authid) | [PermissionsManagerConfig](#interface-permissionsmanagerconfig) | [TableOutputX](#interface-tableoutputx) |
|
|
20
|
+
| [AuthPayload](#interface-authpayload) | [PostBeefResult](#interface-postbeefresult) | [TableProvenTx](#interface-tableproventx) |
|
|
21
|
+
| [BaseBlockHeader](#interface-baseblockheader) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [TableProvenTxReq](#interface-tableproventxreq) |
|
|
22
|
+
| [BaseBlockHeader](#interface-baseblockheader) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) |
|
|
23
|
+
| [BitailsConfig](#interface-bitailsconfig) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [TableSettings](#interface-tablesettings) |
|
|
24
|
+
| [BitailsMerkleProof](#interface-bitailsmerkleproof) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [TableSyncState](#interface-tablesyncstate) |
|
|
25
|
+
| [BlockHeader](#interface-blockheader) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [TableTransaction](#interface-tabletransaction) |
|
|
26
|
+
| [BlockHeader](#interface-blockheader) | [PostTxsResult](#interface-posttxsresult) | [TableTxLabel](#interface-tabletxlabel) |
|
|
27
|
+
| [BsvExchangeRate](#interface-bsvexchangerate) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [TableTxLabelMap](#interface-tabletxlabelmap) |
|
|
28
|
+
| [CertOpsWallet](#interface-certopswallet) | [Profile](#interface-profile) | [TableUser](#interface-tableuser) |
|
|
29
|
+
| [Certifier](#interface-certifier) | [ProvenOrRawTx](#interface-provenorrawtx) | [TaskPurgeParams](#interface-taskpurgeparams) |
|
|
30
|
+
| [CommitNewTxResults](#interface-commitnewtxresults) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [TrustSettings](#interface-trustsettings) |
|
|
31
|
+
| [CompleteAuthResponse](#interface-completeauthresponse) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [TrxToken](#interface-trxtoken) |
|
|
32
|
+
| [CreateActionResultX](#interface-createactionresultx) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
|
|
33
|
+
| [EntitySyncMap](#interface-entitysyncmap) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [TxScriptOffsets](#interface-txscriptoffsets) |
|
|
34
|
+
| [EntityTimeStamp](#interface-entitytimestamp) | [ProviderCallHistory](#interface-providercallhistory) | [UMPToken](#interface-umptoken) |
|
|
35
|
+
| [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [PurgeParams](#interface-purgeparams) | [UMPTokenInteractor](#interface-umptokeninteractor) |
|
|
36
|
+
| [ExtendedVerifiableCertificate](#interface-extendedverifiablecertificate) | [PurgeResults](#interface-purgeresults) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
|
|
37
|
+
| [FiatExchangeRates](#interface-fiatexchangerates) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
|
|
38
|
+
| [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [ReviewActionResult](#interface-reviewactionresult) | [ValidAbortActionArgs](#interface-validabortactionargs) |
|
|
39
|
+
| [FindCertificatesArgs](#interface-findcertificatesargs) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [ValidAcquireCertificateArgs](#interface-validacquirecertificateargs) |
|
|
40
|
+
| [FindCommissionsArgs](#interface-findcommissionsargs) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [ValidAcquireDirectCertificateArgs](#interface-validacquiredirectcertificateargs) |
|
|
41
|
+
| [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [ServiceCall](#interface-servicecall) | [ValidAcquireIssuanceCertificateArgs](#interface-validacquireissuancecertificateargs) |
|
|
42
|
+
| [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [ServiceCall](#interface-servicecall) | [ValidBasketInsertion](#interface-validbasketinsertion) |
|
|
43
|
+
| [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [ServiceCallHistory](#interface-servicecallhistory) | [ValidCreateActionArgs](#interface-validcreateactionargs) |
|
|
44
|
+
| [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [ServiceCallHistoryCounts](#interface-servicecallhistorycounts) | [ValidCreateActionInput](#interface-validcreateactioninput) |
|
|
45
|
+
| [FindOutputTagsArgs](#interface-findoutputtagsargs) | [ServiceToCall](#interface-servicetocall) | [ValidCreateActionOptions](#interface-validcreateactionoptions) |
|
|
46
|
+
| [FindOutputsArgs](#interface-findoutputsargs) | [SetupClientWalletArgs](#interface-setupclientwalletargs) | [ValidCreateActionOutput](#interface-validcreateactionoutput) |
|
|
47
|
+
| [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [SetupClientWalletClientArgs](#interface-setupclientwalletclientargs) | [ValidDiscoverByAttributesArgs](#interface-validdiscoverbyattributesargs) |
|
|
48
|
+
| [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [SetupWallet](#interface-setupwallet) | [ValidDiscoverByIdentityKeyArgs](#interface-validdiscoverbyidentitykeyargs) |
|
|
49
|
+
| [FindProvenTxsArgs](#interface-findproventxsargs) | [SetupWalletClient](#interface-setupwalletclient) | [ValidInternalizeActionArgs](#interface-validinternalizeactionargs) |
|
|
50
|
+
| [FindSincePagedArgs](#interface-findsincepagedargs) | [SetupWalletIdb](#interface-setupwalletidb) | [ValidInternalizeOutput](#interface-validinternalizeoutput) |
|
|
51
|
+
| [FindSyncStatesArgs](#interface-findsyncstatesargs) | [SetupWalletIdbArgs](#interface-setupwalletidbargs) | [ValidListActionsArgs](#interface-validlistactionsargs) |
|
|
52
|
+
| [FindTransactionsArgs](#interface-findtransactionsargs) | [SignActionResultX](#interface-signactionresultx) | [ValidListCertificatesArgs](#interface-validlistcertificatesargs) |
|
|
53
|
+
| [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [StartAuthResponse](#interface-startauthresponse) | [ValidListOutputsArgs](#interface-validlistoutputsargs) |
|
|
54
|
+
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [StatusForTxidResult](#interface-statusfortxidresult) | [ValidProcessActionArgs](#interface-validprocessactionargs) |
|
|
55
|
+
| [FindUsersArgs](#interface-findusersargs) | [StorageAdminStats](#interface-storageadminstats) | [ValidProcessActionOptions](#interface-validprocessactionoptions) |
|
|
56
|
+
| [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StorageCreateActionResult](#interface-storagecreateactionresult) | [ValidProveCertificateArgs](#interface-validprovecertificateargs) |
|
|
57
|
+
| [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) | [ValidRelinquishCertificateArgs](#interface-validrelinquishcertificateargs) |
|
|
58
|
+
| [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) | [ValidRelinquishOutputArgs](#interface-validrelinquishoutputargs) |
|
|
59
|
+
| [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [StorageFeeModel](#interface-storagefeemodel) | [ValidSignActionArgs](#interface-validsignactionargs) |
|
|
60
|
+
| [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) | [ValidSignActionOptions](#interface-validsignactionoptions) |
|
|
61
|
+
| [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [StorageIdbOptions](#interface-storageidboptions) | [ValidWalletPayment](#interface-validwalletpayment) |
|
|
62
|
+
| [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [StorageIdbSchema](#interface-storageidbschema) | [ValidWalletSignerArgs](#interface-validwalletsignerargs) |
|
|
63
|
+
| [GetMerklePathResult](#interface-getmerklepathresult) | [StorageIdentity](#interface-storageidentity) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
|
|
64
|
+
| [GetRawTxResult](#interface-getrawtxresult) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) | [WalletArgs](#interface-walletargs) |
|
|
65
|
+
| [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [StorageProcessActionArgs](#interface-storageprocessactionargs) | [WalletBalance](#interface-walletbalance) |
|
|
66
|
+
| [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [StorageProcessActionResults](#interface-storageprocessactionresults) | [WalletPermissionsManagerCallbacks](#interface-walletpermissionsmanagercallbacks) |
|
|
67
|
+
| [GetScriptHashHistory](#interface-getscripthashhistory) | [StorageProvenOrReq](#interface-storageprovenorreq) | [WalletServices](#interface-walletservices) |
|
|
68
|
+
| [GetScriptHashHistoryResult](#interface-getscripthashhistoryresult) | [StorageProviderOptions](#interface-storageprovideroptions) | [WalletServicesOptions](#interface-walletservicesoptions) |
|
|
69
|
+
| [GetStatusForTxidsResult](#interface-getstatusfortxidsresult) | [StorageReaderOptions](#interface-storagereaderoptions) | [WalletSettings](#interface-walletsettings) |
|
|
70
|
+
| [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) | [WalletSettingsManagerConfig](#interface-walletsettingsmanagerconfig) |
|
|
71
|
+
| [GetUtxoStatusResult](#interface-getutxostatusresult) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) | [WalletSigner](#interface-walletsigner) |
|
|
72
|
+
| [KeyPair](#interface-keypair) | [SyncChunk](#interface-syncchunk) | [WalletStorage](#interface-walletstorage) |
|
|
73
|
+
| [KeyPairAddress](#interface-keypairaddress) | [SyncError](#interface-syncerror) | [WalletStorageInfo](#interface-walletstorageinfo) |
|
|
74
|
+
| [ListActionsSpecOp](#interface-listactionsspecop) | [SyncMap](#interface-syncmap) | [WalletStorageProvider](#interface-walletstorageprovider) |
|
|
75
|
+
| [ListOutputsSpecOp](#interface-listoutputsspecop) | [TableCertificate](#interface-tablecertificate) | [WalletStorageReader](#interface-walletstoragereader) |
|
|
76
|
+
| [LiveBlockHeader](#interface-liveblockheader) | [TableCertificateField](#interface-tablecertificatefield) | [WalletStorageSync](#interface-walletstoragesync) |
|
|
77
|
+
| [MonitorOptions](#interface-monitoroptions) | [TableCertificateX](#interface-tablecertificatex) | [WalletStorageSyncReader](#interface-walletstoragesyncreader) |
|
|
78
|
+
| [OutPoint](#interface-outpoint) | [TableCommission](#interface-tablecommission) | [WalletStorageWriter](#interface-walletstoragewriter) |
|
|
79
|
+
| [Paged](#interface-paged) | [TableMonitorEvent](#interface-tablemonitorevent) | [WalletTheme](#interface-wallettheme) |
|
|
80
|
+
| [PendingSignAction](#interface-pendingsignaction) | [TableOutput](#interface-tableoutput) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
|
|
81
|
+
|
|
82
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
##### Interface: AdminStatsResult
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
export interface AdminStatsResult extends StorageAdminStats {
|
|
90
|
+
servicesStats?: ServicesCallHistory;
|
|
91
|
+
monitorStats?: ServicesCallHistory;
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
See also: [ServicesCallHistory](./client.md#type-servicescallhistory), [StorageAdminStats](./storage.md#interface-storageadminstats)
|
|
79
96
|
|
|
80
97
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
81
98
|
|
|
82
99
|
---
|
|
83
|
-
|
|
84
100
|
##### Interface: ArcConfig
|
|
85
101
|
|
|
86
102
|
Configuration options for the ARC broadcaster.
|
|
@@ -793,11 +809,21 @@ export interface FindSincePagedArgs {
|
|
|
793
809
|
since?: Date;
|
|
794
810
|
paged?: Paged;
|
|
795
811
|
trx?: TrxToken;
|
|
812
|
+
orderDescending?: boolean;
|
|
796
813
|
}
|
|
797
814
|
```
|
|
798
815
|
|
|
799
816
|
See also: [Paged](./client.md#interface-paged), [TrxToken](./client.md#interface-trxtoken)
|
|
800
817
|
|
|
818
|
+
###### Property orderDescending
|
|
819
|
+
|
|
820
|
+
Support for orderDescending is implemented in StorageKnex for basic table find methods,
|
|
821
|
+
excluding certificate_fields table, map tables, and settings (singleton row table).
|
|
822
|
+
|
|
823
|
+
```ts
|
|
824
|
+
orderDescending?: boolean
|
|
825
|
+
```
|
|
826
|
+
|
|
801
827
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
802
828
|
|
|
803
829
|
---
|
|
@@ -2389,6 +2415,55 @@ export interface ProvenTxReqNotify {
|
|
|
2389
2415
|
|
|
2390
2416
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2391
2417
|
|
|
2418
|
+
---
|
|
2419
|
+
##### Interface: ProviderCallHistory
|
|
2420
|
+
|
|
2421
|
+
History of service calls for a single service, single provider.
|
|
2422
|
+
|
|
2423
|
+
```ts
|
|
2424
|
+
export interface ProviderCallHistory {
|
|
2425
|
+
providerName: string;
|
|
2426
|
+
serviceName: string;
|
|
2427
|
+
calls: ServiceCall[];
|
|
2428
|
+
totalCounts: ServiceCallHistoryCounts;
|
|
2429
|
+
resetCounts: ServiceCallHistoryCounts[];
|
|
2430
|
+
}
|
|
2431
|
+
```
|
|
2432
|
+
|
|
2433
|
+
See also: [ServiceCall](./services.md#interface-servicecall), [ServiceCallHistoryCounts](./client.md#interface-servicecallhistorycounts)
|
|
2434
|
+
|
|
2435
|
+
###### Property calls
|
|
2436
|
+
|
|
2437
|
+
Most recent service calls.
|
|
2438
|
+
Array length is limited by Services configuration.
|
|
2439
|
+
|
|
2440
|
+
```ts
|
|
2441
|
+
calls: ServiceCall[]
|
|
2442
|
+
```
|
|
2443
|
+
See also: [ServiceCall](./services.md#interface-servicecall)
|
|
2444
|
+
|
|
2445
|
+
###### Property resetCounts
|
|
2446
|
+
|
|
2447
|
+
Entry [0] is always the current interval being extended by new calls.
|
|
2448
|
+
when `getServiceCallHistory` with `reset` true is called, a new interval with zero counts is added to the start of array.
|
|
2449
|
+
Array length is limited by Services configuration.
|
|
2450
|
+
|
|
2451
|
+
```ts
|
|
2452
|
+
resetCounts: ServiceCallHistoryCounts[]
|
|
2453
|
+
```
|
|
2454
|
+
See also: [ServiceCallHistoryCounts](./client.md#interface-servicecallhistorycounts)
|
|
2455
|
+
|
|
2456
|
+
###### Property totalCounts
|
|
2457
|
+
|
|
2458
|
+
Counts since creation of Services instance.
|
|
2459
|
+
|
|
2460
|
+
```ts
|
|
2461
|
+
totalCounts: ServiceCallHistoryCounts
|
|
2462
|
+
```
|
|
2463
|
+
See also: [ServiceCallHistoryCounts](./client.md#interface-servicecallhistorycounts)
|
|
2464
|
+
|
|
2465
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2466
|
+
|
|
2392
2467
|
---
|
|
2393
2468
|
##### Interface: PurgeParams
|
|
2394
2469
|
|
|
@@ -2599,6 +2674,207 @@ export interface ScriptTemplateUnlock {
|
|
|
2599
2674
|
|
|
2600
2675
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2601
2676
|
|
|
2677
|
+
---
|
|
2678
|
+
##### Interface: ServiceCall
|
|
2679
|
+
|
|
2680
|
+
Minimum data tracked for each service call.
|
|
2681
|
+
|
|
2682
|
+
```ts
|
|
2683
|
+
export interface ServiceCall {
|
|
2684
|
+
when: Date | string;
|
|
2685
|
+
msecs: number;
|
|
2686
|
+
success: boolean;
|
|
2687
|
+
result?: string;
|
|
2688
|
+
error?: {
|
|
2689
|
+
message: string;
|
|
2690
|
+
code: string;
|
|
2691
|
+
};
|
|
2692
|
+
}
|
|
2693
|
+
```
|
|
2694
|
+
|
|
2695
|
+
###### Property error
|
|
2696
|
+
|
|
2697
|
+
Error code and message iff success is false and a exception was thrown.
|
|
2698
|
+
|
|
2699
|
+
```ts
|
|
2700
|
+
error?: {
|
|
2701
|
+
message: string;
|
|
2702
|
+
code: string;
|
|
2703
|
+
}
|
|
2704
|
+
```
|
|
2705
|
+
|
|
2706
|
+
###### Property result
|
|
2707
|
+
|
|
2708
|
+
Simple text summary of result. e.g. `not a valid utxo` or `valid utxo`
|
|
2709
|
+
|
|
2710
|
+
```ts
|
|
2711
|
+
result?: string
|
|
2712
|
+
```
|
|
2713
|
+
|
|
2714
|
+
###### Property success
|
|
2715
|
+
|
|
2716
|
+
true iff service provider successfully processed the request
|
|
2717
|
+
false iff service provider failed to process the request which includes thrown errors.
|
|
2718
|
+
|
|
2719
|
+
```ts
|
|
2720
|
+
success: boolean
|
|
2721
|
+
```
|
|
2722
|
+
|
|
2723
|
+
###### Property when
|
|
2724
|
+
|
|
2725
|
+
string value must be Date's toISOString format.
|
|
2726
|
+
|
|
2727
|
+
```ts
|
|
2728
|
+
when: Date | string
|
|
2729
|
+
```
|
|
2730
|
+
|
|
2731
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2732
|
+
|
|
2733
|
+
---
|
|
2734
|
+
##### Interface: ServiceCall
|
|
2735
|
+
|
|
2736
|
+
```ts
|
|
2737
|
+
export interface ServiceCall {
|
|
2738
|
+
when: Date | string;
|
|
2739
|
+
msecs: number;
|
|
2740
|
+
success: boolean;
|
|
2741
|
+
result?: string;
|
|
2742
|
+
error?: {
|
|
2743
|
+
message: string;
|
|
2744
|
+
code: string;
|
|
2745
|
+
};
|
|
2746
|
+
}
|
|
2747
|
+
```
|
|
2748
|
+
|
|
2749
|
+
###### Property error
|
|
2750
|
+
|
|
2751
|
+
Error code and message iff success is false and a exception was thrown.
|
|
2752
|
+
|
|
2753
|
+
```ts
|
|
2754
|
+
error?: {
|
|
2755
|
+
message: string;
|
|
2756
|
+
code: string;
|
|
2757
|
+
}
|
|
2758
|
+
```
|
|
2759
|
+
|
|
2760
|
+
###### Property result
|
|
2761
|
+
|
|
2762
|
+
Simple text summary of result. e.g. `not a valid utxo` or `valid utxo`
|
|
2763
|
+
|
|
2764
|
+
```ts
|
|
2765
|
+
result?: string
|
|
2766
|
+
```
|
|
2767
|
+
|
|
2768
|
+
###### Property success
|
|
2769
|
+
|
|
2770
|
+
true iff service provider successfully processed the request
|
|
2771
|
+
false iff service provider failed to process the request which includes thrown errors.
|
|
2772
|
+
|
|
2773
|
+
```ts
|
|
2774
|
+
success: boolean
|
|
2775
|
+
```
|
|
2776
|
+
|
|
2777
|
+
###### Property when
|
|
2778
|
+
|
|
2779
|
+
string value must be Date's toISOString format.
|
|
2780
|
+
|
|
2781
|
+
```ts
|
|
2782
|
+
when: Date | string
|
|
2783
|
+
```
|
|
2784
|
+
|
|
2785
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2786
|
+
|
|
2787
|
+
---
|
|
2788
|
+
##### Interface: ServiceCallHistory
|
|
2789
|
+
|
|
2790
|
+
History of service calls for a single service, all providers.
|
|
2791
|
+
|
|
2792
|
+
```ts
|
|
2793
|
+
export interface ServiceCallHistory {
|
|
2794
|
+
serviceName: string;
|
|
2795
|
+
historyByProvider: Record<string, ProviderCallHistory>;
|
|
2796
|
+
}
|
|
2797
|
+
```
|
|
2798
|
+
|
|
2799
|
+
See also: [ProviderCallHistory](./client.md#interface-providercallhistory)
|
|
2800
|
+
|
|
2801
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2802
|
+
|
|
2803
|
+
---
|
|
2804
|
+
##### Interface: ServiceCallHistoryCounts
|
|
2805
|
+
|
|
2806
|
+
Counts of service calls over a time interval.
|
|
2807
|
+
|
|
2808
|
+
```ts
|
|
2809
|
+
export interface ServiceCallHistoryCounts {
|
|
2810
|
+
success: number;
|
|
2811
|
+
failure: number;
|
|
2812
|
+
error: number;
|
|
2813
|
+
since: Date | string;
|
|
2814
|
+
until: Date | string;
|
|
2815
|
+
}
|
|
2816
|
+
```
|
|
2817
|
+
|
|
2818
|
+
###### Property error
|
|
2819
|
+
|
|
2820
|
+
of failures (success false), count of calls with valid error code and message.
|
|
2821
|
+
|
|
2822
|
+
```ts
|
|
2823
|
+
error: number
|
|
2824
|
+
```
|
|
2825
|
+
|
|
2826
|
+
###### Property failure
|
|
2827
|
+
|
|
2828
|
+
count of calls returning success false.
|
|
2829
|
+
|
|
2830
|
+
```ts
|
|
2831
|
+
failure: number
|
|
2832
|
+
```
|
|
2833
|
+
|
|
2834
|
+
###### Property since
|
|
2835
|
+
|
|
2836
|
+
Counts are of calls over interval `since` to `until`.
|
|
2837
|
+
string value must be Date's toISOString format.
|
|
2838
|
+
|
|
2839
|
+
```ts
|
|
2840
|
+
since: Date | string
|
|
2841
|
+
```
|
|
2842
|
+
|
|
2843
|
+
###### Property success
|
|
2844
|
+
|
|
2845
|
+
count of calls returning success true.
|
|
2846
|
+
|
|
2847
|
+
```ts
|
|
2848
|
+
success: number
|
|
2849
|
+
```
|
|
2850
|
+
|
|
2851
|
+
###### Property until
|
|
2852
|
+
|
|
2853
|
+
Counts are of calls over interval `since` to `until`.
|
|
2854
|
+
string value must be Date's toISOString format.
|
|
2855
|
+
|
|
2856
|
+
```ts
|
|
2857
|
+
until: Date | string
|
|
2858
|
+
```
|
|
2859
|
+
|
|
2860
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2861
|
+
|
|
2862
|
+
---
|
|
2863
|
+
##### Interface: ServiceToCall
|
|
2864
|
+
|
|
2865
|
+
```ts
|
|
2866
|
+
export interface ServiceToCall<T> {
|
|
2867
|
+
providerName: string;
|
|
2868
|
+
serviceName: string;
|
|
2869
|
+
service: T;
|
|
2870
|
+
call: ServiceCall;
|
|
2871
|
+
}
|
|
2872
|
+
```
|
|
2873
|
+
|
|
2874
|
+
See also: [ServiceCall](./services.md#interface-servicecall)
|
|
2875
|
+
|
|
2876
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2877
|
+
|
|
2602
2878
|
---
|
|
2603
2879
|
##### Interface: SetupClientWalletArgs
|
|
2604
2880
|
|
|
@@ -5012,10 +5288,11 @@ export interface WalletServices {
|
|
|
5012
5288
|
hashToHeader(hash: string): Promise<BlockHeader>;
|
|
5013
5289
|
nLockTimeIsFinal(txOrLockTime: string | number[] | BsvTransaction | number): Promise<boolean>;
|
|
5014
5290
|
getBeefForTxid(txid: string): Promise<Beef>;
|
|
5291
|
+
getServicesCallHistory(reset?: boolean): ServicesCallHistory;
|
|
5015
5292
|
}
|
|
5016
5293
|
```
|
|
5017
5294
|
|
|
5018
|
-
See also: [BlockHeader](./services.md#interface-blockheader), [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [GetRawTxResult](./client.md#interface-getrawtxresult), [GetScriptHashHistoryResult](./client.md#interface-getscripthashhistoryresult), [GetStatusForTxidsResult](./client.md#interface-getstatusfortxidsresult), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult), [PostBeefResult](./client.md#interface-postbeefresult), [TableOutput](./storage.md#interface-tableoutput), [getBeefForTxid](./services.md#function-getbeeffortxid)
|
|
5295
|
+
See also: [BlockHeader](./services.md#interface-blockheader), [Chain](./client.md#type-chain), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [GetRawTxResult](./client.md#interface-getrawtxresult), [GetScriptHashHistoryResult](./client.md#interface-getscripthashhistoryresult), [GetStatusForTxidsResult](./client.md#interface-getstatusfortxidsresult), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult), [PostBeefResult](./client.md#interface-postbeefresult), [ServicesCallHistory](./client.md#type-servicescallhistory), [TableOutput](./storage.md#interface-tableoutput), [getBeefForTxid](./services.md#function-getbeeffortxid)
|
|
5019
5296
|
|
|
5020
5297
|
###### Property chain
|
|
5021
5298
|
|
|
@@ -5150,6 +5427,22 @@ Argument Details
|
|
|
5150
5427
|
+ **useNext**
|
|
5151
5428
|
+ optional, forces skip to next service before starting service requests cycle.
|
|
5152
5429
|
|
|
5430
|
+
###### Method getServicesCallHistory
|
|
5431
|
+
|
|
5432
|
+
```ts
|
|
5433
|
+
getServicesCallHistory(reset?: boolean): ServicesCallHistory
|
|
5434
|
+
```
|
|
5435
|
+
See also: [ServicesCallHistory](./client.md#type-servicescallhistory)
|
|
5436
|
+
|
|
5437
|
+
Returns
|
|
5438
|
+
|
|
5439
|
+
a history of service calls made to the configured services.
|
|
5440
|
+
|
|
5441
|
+
Argument Details
|
|
5442
|
+
|
|
5443
|
+
+ **reset**
|
|
5444
|
+
+ if true, ends current interval and starts a new one.
|
|
5445
|
+
|
|
5153
5446
|
###### Method getStatusForTxids
|
|
5154
5447
|
|
|
5155
5448
|
For an array of one or more txids, returns for each wether it is a 'known', 'mined', or 'unknown' transaction.
|
|
@@ -5272,10 +5565,12 @@ export interface WalletServicesOptions {
|
|
|
5272
5565
|
chaintracks?: ChaintracksServiceClient;
|
|
5273
5566
|
arcUrl: string;
|
|
5274
5567
|
arcConfig: ArcConfig;
|
|
5568
|
+
arcGorillaPoolUrl?: string;
|
|
5569
|
+
arcGorillaPoolConfig?: ArcConfig;
|
|
5275
5570
|
}
|
|
5276
5571
|
```
|
|
5277
5572
|
|
|
5278
|
-
See also: [ArcConfig](./services.md#interface-arcconfig), [BsvExchangeRate](./client.md#interface-bsvexchangerate), [Chain](./client.md#type-chain), [FiatExchangeRates](./client.md#interface-fiatexchangerates)
|
|
5573
|
+
See also: [ArcConfig](./services.md#interface-arcconfig), [BsvExchangeRate](./client.md#interface-bsvexchangerate), [Chain](./client.md#type-chain), [FiatExchangeRates](./client.md#interface-fiatexchangerates), [arcGorillaPoolUrl](./services.md#function-arcgorillapoolurl)
|
|
5279
5574
|
|
|
5280
5575
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5281
5576
|
|
|
@@ -5551,30 +5846,30 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5551
5846
|
|
|
5552
5847
|
| | | |
|
|
5553
5848
|
| --- | --- | --- |
|
|
5554
|
-
| [ARC](#class-arc) | [ScriptTemplateBRC29](#class-scripttemplatebrc29) | [
|
|
5555
|
-
| [AuthMethodInteractor](#class-authmethodinteractor) | [SdkWhatsOnChain](#class-sdkwhatsonchain) | [
|
|
5556
|
-
| [Bitails](#class-bitails) | [ServiceCollection](#class-servicecollection) | [
|
|
5557
|
-
| [CWIStyleWalletManager](#class-cwistylewalletmanager) | [Services](#class-services) | [
|
|
5558
|
-
| [EntityBase](#class-entitybase) | [SetupClient](#class-setupclient) | [
|
|
5559
|
-
| [EntityCertificate](#class-entitycertificate) | [SimpleWalletManager](#class-simplewalletmanager) | [
|
|
5560
|
-
| [EntityCertificateField](#class-entitycertificatefield) | [StorageClient](#class-storageclient) | [
|
|
5561
|
-
| [EntityCommission](#class-entitycommission) | [StorageIdb](#class-storageidb) | [
|
|
5562
|
-
| [EntityOutput](#class-entityoutput) | [StorageProvider](#class-storageprovider) | [
|
|
5563
|
-
| [EntityOutputBasket](#class-entityoutputbasket) | [StorageReader](#class-storagereader) | [
|
|
5564
|
-
| [EntityOutputTag](#class-entityoutputtag) | [StorageReaderWriter](#class-storagereaderwriter) | [
|
|
5565
|
-
| [EntityOutputTagMap](#class-entityoutputtagmap) | [StorageSyncReader](#class-storagesyncreader) | [
|
|
5566
|
-
| [EntityProvenTx](#class-entityproventx) | [TaskCheckForProofs](#class-taskcheckforproofs) | [
|
|
5567
|
-
| [EntityProvenTxReq](#class-entityproventxreq) | [TaskCheckNoSends](#class-taskchecknosends) | [
|
|
5568
|
-
| [EntitySyncState](#class-entitysyncstate) | [TaskClock](#class-taskclock) | [
|
|
5569
|
-
| [EntityTransaction](#class-entitytransaction) | [TaskFailAbandoned](#class-taskfailabandoned) | [
|
|
5570
|
-
| [EntityTxLabel](#class-entitytxlabel) | [
|
|
5571
|
-
| [EntityTxLabelMap](#class-entitytxlabelmap) | [
|
|
5572
|
-
| [EntityUser](#class-entityuser) | [
|
|
5573
|
-
| [MergeEntity](#class-mergeentity) | [
|
|
5574
|
-
| [Monitor](#class-monitor) | [
|
|
5575
|
-
| [OverlayUMPTokenInteractor](#class-overlayumptokeninteractor) | [
|
|
5576
|
-
| [PersonaIDInteractor](#class-personaidinteractor) | [
|
|
5577
|
-
| [PrivilegedKeyManager](#class-privilegedkeymanager) | [
|
|
5849
|
+
| [ARC](#class-arc) | [ScriptTemplateBRC29](#class-scripttemplatebrc29) | [WABClient](#class-wabclient) |
|
|
5850
|
+
| [AuthMethodInteractor](#class-authmethodinteractor) | [SdkWhatsOnChain](#class-sdkwhatsonchain) | [WERR_BAD_REQUEST](#class-werr_bad_request) |
|
|
5851
|
+
| [Bitails](#class-bitails) | [ServiceCollection](#class-servicecollection) | [WERR_BROADCAST_UNAVAILABLE](#class-werr_broadcast_unavailable) |
|
|
5852
|
+
| [CWIStyleWalletManager](#class-cwistylewalletmanager) | [Services](#class-services) | [WERR_INSUFFICIENT_FUNDS](#class-werr_insufficient_funds) |
|
|
5853
|
+
| [EntityBase](#class-entitybase) | [SetupClient](#class-setupclient) | [WERR_INTERNAL](#class-werr_internal) |
|
|
5854
|
+
| [EntityCertificate](#class-entitycertificate) | [SimpleWalletManager](#class-simplewalletmanager) | [WERR_INVALID_OPERATION](#class-werr_invalid_operation) |
|
|
5855
|
+
| [EntityCertificateField](#class-entitycertificatefield) | [StorageClient](#class-storageclient) | [WERR_INVALID_PARAMETER](#class-werr_invalid_parameter) |
|
|
5856
|
+
| [EntityCommission](#class-entitycommission) | [StorageIdb](#class-storageidb) | [WERR_INVALID_PUBLIC_KEY](#class-werr_invalid_public_key) |
|
|
5857
|
+
| [EntityOutput](#class-entityoutput) | [StorageProvider](#class-storageprovider) | [WERR_MISSING_PARAMETER](#class-werr_missing_parameter) |
|
|
5858
|
+
| [EntityOutputBasket](#class-entityoutputbasket) | [StorageReader](#class-storagereader) | [WERR_NETWORK_CHAIN](#class-werr_network_chain) |
|
|
5859
|
+
| [EntityOutputTag](#class-entityoutputtag) | [StorageReaderWriter](#class-storagereaderwriter) | [WERR_NOT_ACTIVE](#class-werr_not_active) |
|
|
5860
|
+
| [EntityOutputTagMap](#class-entityoutputtagmap) | [StorageSyncReader](#class-storagesyncreader) | [WERR_NOT_IMPLEMENTED](#class-werr_not_implemented) |
|
|
5861
|
+
| [EntityProvenTx](#class-entityproventx) | [TaskCheckForProofs](#class-taskcheckforproofs) | [WERR_REVIEW_ACTIONS](#class-werr_review_actions) |
|
|
5862
|
+
| [EntityProvenTxReq](#class-entityproventxreq) | [TaskCheckNoSends](#class-taskchecknosends) | [WERR_UNAUTHORIZED](#class-werr_unauthorized) |
|
|
5863
|
+
| [EntitySyncState](#class-entitysyncstate) | [TaskClock](#class-taskclock) | [Wallet](#class-wallet) |
|
|
5864
|
+
| [EntityTransaction](#class-entitytransaction) | [TaskFailAbandoned](#class-taskfailabandoned) | [WalletAuthenticationManager](#class-walletauthenticationmanager) |
|
|
5865
|
+
| [EntityTxLabel](#class-entitytxlabel) | [TaskMonitorCallHistory](#class-taskmonitorcallhistory) | [WalletError](#class-walleterror) |
|
|
5866
|
+
| [EntityTxLabelMap](#class-entitytxlabelmap) | [TaskNewHeader](#class-tasknewheader) | [WalletMonitorTask](#class-walletmonitortask) |
|
|
5867
|
+
| [EntityUser](#class-entityuser) | [TaskPurge](#class-taskpurge) | [WalletPermissionsManager](#class-walletpermissionsmanager) |
|
|
5868
|
+
| [MergeEntity](#class-mergeentity) | [TaskReviewStatus](#class-taskreviewstatus) | [WalletSettingsManager](#class-walletsettingsmanager) |
|
|
5869
|
+
| [Monitor](#class-monitor) | [TaskSendWaiting](#class-tasksendwaiting) | [WalletSigner](#class-walletsigner) |
|
|
5870
|
+
| [OverlayUMPTokenInteractor](#class-overlayumptokeninteractor) | [TaskSyncWhenIdle](#class-tasksyncwhenidle) | [WalletStorageManager](#class-walletstoragemanager) |
|
|
5871
|
+
| [PersonaIDInteractor](#class-personaidinteractor) | [TaskUnFail](#class-taskunfail) | [WhatsOnChain](#class-whatsonchain) |
|
|
5872
|
+
| [PrivilegedKeyManager](#class-privilegedkeymanager) | [TwilioPhoneInteractor](#class-twiliophoneinteractor) | |
|
|
5578
5873
|
|
|
5579
5874
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5580
5875
|
|
|
@@ -5586,15 +5881,16 @@ Represents an ARC transaction broadcaster.
|
|
|
5586
5881
|
|
|
5587
5882
|
```ts
|
|
5588
5883
|
export class ARC {
|
|
5884
|
+
readonly name: string;
|
|
5589
5885
|
readonly URL: string;
|
|
5590
5886
|
readonly apiKey: string | undefined;
|
|
5591
5887
|
readonly deploymentId: string;
|
|
5592
5888
|
readonly callbackUrl: string | undefined;
|
|
5593
5889
|
readonly callbackToken: string | undefined;
|
|
5594
5890
|
readonly headers: Record<string, string> | undefined;
|
|
5595
|
-
constructor(URL: string, config?: ArcConfig);
|
|
5596
|
-
constructor(URL: string, apiKey?: string);
|
|
5597
|
-
constructor(URL: string, config?: string | ArcConfig)
|
|
5891
|
+
constructor(URL: string, config?: ArcConfig, name?: string);
|
|
5892
|
+
constructor(URL: string, apiKey?: string, name?: string);
|
|
5893
|
+
constructor(URL: string, config?: string | ArcConfig, name?: string)
|
|
5598
5894
|
async postRawTx(rawTx: HexString, txids?: string[]): Promise<sdk.PostTxResultForTxid>
|
|
5599
5895
|
async postBeef(beef: Beef, txids: string[]): Promise<sdk.PostBeefResult>
|
|
5600
5896
|
async getTxData(txid: string): Promise<ArcMinerGetTxData>
|
|
@@ -5608,7 +5904,7 @@ See also: [ArcConfig](./services.md#interface-arcconfig), [ArcMinerGetTxData](./
|
|
|
5608
5904
|
Constructs an instance of the ARC broadcaster.
|
|
5609
5905
|
|
|
5610
5906
|
```ts
|
|
5611
|
-
constructor(URL: string, config?: ArcConfig)
|
|
5907
|
+
constructor(URL: string, config?: ArcConfig, name?: string)
|
|
5612
5908
|
```
|
|
5613
5909
|
See also: [ArcConfig](./services.md#interface-arcconfig)
|
|
5614
5910
|
|
|
@@ -5624,7 +5920,7 @@ Argument Details
|
|
|
5624
5920
|
Constructs an instance of the ARC broadcaster.
|
|
5625
5921
|
|
|
5626
5922
|
```ts
|
|
5627
|
-
constructor(URL: string, apiKey?: string)
|
|
5923
|
+
constructor(URL: string, apiKey?: string, name?: string)
|
|
5628
5924
|
```
|
|
5629
5925
|
|
|
5630
5926
|
Argument Details
|
|
@@ -7407,7 +7703,9 @@ export class ServiceCollection<T> {
|
|
|
7407
7703
|
service: T;
|
|
7408
7704
|
}[];
|
|
7409
7705
|
_index: number;
|
|
7410
|
-
|
|
7706
|
+
readonly since: Date;
|
|
7707
|
+
_historyByProvider: Record<string, ProviderCallHistory> = {};
|
|
7708
|
+
constructor(public serviceName: string, services?: {
|
|
7411
7709
|
name: string;
|
|
7412
7710
|
service: T;
|
|
7413
7711
|
}[])
|
|
@@ -7418,15 +7716,45 @@ export class ServiceCollection<T> {
|
|
|
7418
7716
|
remove(name: string): void
|
|
7419
7717
|
get name()
|
|
7420
7718
|
get service()
|
|
7719
|
+
getServiceToCall(i: number): ServiceToCall<T>
|
|
7720
|
+
get serviceToCall(): ServiceToCall<T>
|
|
7721
|
+
get allServicesToCall(): ServiceToCall<T>[]
|
|
7421
7722
|
get allServices()
|
|
7422
7723
|
get count()
|
|
7423
7724
|
get index()
|
|
7424
7725
|
reset()
|
|
7425
7726
|
next(): number
|
|
7426
7727
|
clone(): ServiceCollection<T>
|
|
7728
|
+
_addServiceCall(providerName: string, call: ServiceCall): ProviderCallHistory
|
|
7729
|
+
getDuration(since: Date | string): number
|
|
7730
|
+
addServiceCallSuccess(stc: ServiceToCall<T>, result?: string): void
|
|
7731
|
+
addServiceCallFailure(stc: ServiceToCall<T>, result?: string): void
|
|
7732
|
+
addServiceCallError(stc: ServiceToCall<T>, error: WalletError): void
|
|
7733
|
+
getServiceCallHistory(reset?: boolean): ServiceCallHistory
|
|
7427
7734
|
}
|
|
7428
7735
|
```
|
|
7429
7736
|
|
|
7737
|
+
See also: [ProviderCallHistory](./client.md#interface-providercallhistory), [ServiceCall](./services.md#interface-servicecall), [ServiceCallHistory](./client.md#interface-servicecallhistory), [ServiceToCall](./services.md#interface-servicetocall), [WalletError](./client.md#class-walleterror)
|
|
7738
|
+
|
|
7739
|
+
###### Property since
|
|
7740
|
+
|
|
7741
|
+
Start of currentCounts interval. Initially instance construction time.
|
|
7742
|
+
|
|
7743
|
+
```ts
|
|
7744
|
+
readonly since: Date
|
|
7745
|
+
```
|
|
7746
|
+
|
|
7747
|
+
###### Method getServiceCallHistory
|
|
7748
|
+
|
|
7749
|
+
```ts
|
|
7750
|
+
getServiceCallHistory(reset?: boolean): ServiceCallHistory
|
|
7751
|
+
```
|
|
7752
|
+
See also: [ServiceCallHistory](./client.md#interface-servicecallhistory)
|
|
7753
|
+
|
|
7754
|
+
Returns
|
|
7755
|
+
|
|
7756
|
+
A copy of current service call history
|
|
7757
|
+
|
|
7430
7758
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7431
7759
|
|
|
7432
7760
|
---
|
|
@@ -7437,7 +7765,8 @@ export class Services implements sdk.WalletServices {
|
|
|
7437
7765
|
static createDefaultOptions(chain: sdk.Chain): sdk.WalletServicesOptions
|
|
7438
7766
|
options: sdk.WalletServicesOptions;
|
|
7439
7767
|
whatsonchain: WhatsOnChain;
|
|
7440
|
-
|
|
7768
|
+
arcTaal: ARC;
|
|
7769
|
+
arcGorillaPool?: ARC;
|
|
7441
7770
|
bitails: Bitails;
|
|
7442
7771
|
getMerklePathServices: ServiceCollection<sdk.GetMerklePathService>;
|
|
7443
7772
|
getRawTxServices: ServiceCollection<sdk.GetRawTxService>;
|
|
@@ -7448,6 +7777,7 @@ export class Services implements sdk.WalletServices {
|
|
|
7448
7777
|
updateFiatExchangeRateServices: ServiceCollection<sdk.UpdateFiatExchangeRateService>;
|
|
7449
7778
|
chain: sdk.Chain;
|
|
7450
7779
|
constructor(optionsOrChain: sdk.Chain | sdk.WalletServicesOptions)
|
|
7780
|
+
getServicesCallHistory(reset?: boolean): ServicesCallHistory
|
|
7451
7781
|
async getChainTracker(): Promise<ChainTracker>
|
|
7452
7782
|
async getBsvExchangeRate(): Promise<number>
|
|
7453
7783
|
async getFiatExchangeRate(currency: "USD" | "GBP" | "EUR", base?: "USD" | "GBP" | "EUR"): Promise<number>
|
|
@@ -7460,7 +7790,7 @@ export class Services implements sdk.WalletServices {
|
|
|
7460
7790
|
async isUtxo(output: TableOutput): Promise<boolean>
|
|
7461
7791
|
async getUtxoStatus(output: string, outputFormat?: sdk.GetUtxoStatusOutputFormat, outpoint?: string, useNext?: boolean): Promise<sdk.GetUtxoStatusResult>
|
|
7462
7792
|
async getScriptHashHistory(hash: string, useNext?: boolean): Promise<sdk.GetScriptHashHistoryResult>
|
|
7463
|
-
|
|
7793
|
+
postBeefMode: "PromiseAll" | "UntilSuccess" = "UntilSuccess";
|
|
7464
7794
|
async postBeef(beef: Beef, txids: string[]): Promise<sdk.PostBeefResult[]>
|
|
7465
7795
|
async getRawTx(txid: string, useNext?: boolean): Promise<sdk.GetRawTxResult>
|
|
7466
7796
|
async invokeChaintracksWithRetry<R>(method: () => Promise<R>): Promise<R>
|
|
@@ -7475,7 +7805,7 @@ export class Services implements sdk.WalletServices {
|
|
|
7475
7805
|
}
|
|
7476
7806
|
```
|
|
7477
7807
|
|
|
7478
|
-
See also: [ARC](./services.md#class-arc), [Bitails](./services.md#class-bitails), [BlockHeader](./services.md#interface-blockheader), [Chain](./client.md#type-chain), [FiatExchangeRates](./client.md#interface-fiatexchangerates), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [GetMerklePathService](./client.md#type-getmerklepathservice), [GetRawTxResult](./client.md#interface-getrawtxresult), [GetRawTxService](./client.md#type-getrawtxservice), [GetScriptHashHistoryResult](./client.md#interface-getscripthashhistoryresult), [GetScriptHashHistoryService](./client.md#type-getscripthashhistoryservice), [GetStatusForTxidsResult](./client.md#interface-getstatusfortxidsresult), [GetStatusForTxidsService](./client.md#type-getstatusfortxidsservice), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult), [GetUtxoStatusService](./client.md#type-getutxostatusservice), [PostBeefResult](./client.md#interface-postbeefresult), [PostBeefService](./client.md#type-postbeefservice), [ServiceCollection](./services.md#class-servicecollection), [TableOutput](./storage.md#interface-tableoutput), [UpdateFiatExchangeRateService](./client.md#type-updatefiatexchangerateservice), [WalletServices](./client.md#interface-walletservices), [WalletServicesOptions](./client.md#interface-walletservicesoptions), [WhatsOnChain](./services.md#class-whatsonchain), [getBeefForTxid](./services.md#function-getbeeffortxid)
|
|
7808
|
+
See also: [ARC](./services.md#class-arc), [Bitails](./services.md#class-bitails), [BlockHeader](./services.md#interface-blockheader), [Chain](./client.md#type-chain), [FiatExchangeRates](./client.md#interface-fiatexchangerates), [GetMerklePathResult](./client.md#interface-getmerklepathresult), [GetMerklePathService](./client.md#type-getmerklepathservice), [GetRawTxResult](./client.md#interface-getrawtxresult), [GetRawTxService](./client.md#type-getrawtxservice), [GetScriptHashHistoryResult](./client.md#interface-getscripthashhistoryresult), [GetScriptHashHistoryService](./client.md#type-getscripthashhistoryservice), [GetStatusForTxidsResult](./client.md#interface-getstatusfortxidsresult), [GetStatusForTxidsService](./client.md#type-getstatusfortxidsservice), [GetUtxoStatusOutputFormat](./client.md#type-getutxostatusoutputformat), [GetUtxoStatusResult](./client.md#interface-getutxostatusresult), [GetUtxoStatusService](./client.md#type-getutxostatusservice), [PostBeefResult](./client.md#interface-postbeefresult), [PostBeefService](./client.md#type-postbeefservice), [ServiceCollection](./services.md#class-servicecollection), [ServicesCallHistory](./client.md#type-servicescallhistory), [TableOutput](./storage.md#interface-tableoutput), [UpdateFiatExchangeRateService](./client.md#type-updatefiatexchangerateservice), [WalletServices](./client.md#interface-walletservices), [WalletServicesOptions](./client.md#interface-walletservicesoptions), [WhatsOnChain](./services.md#class-whatsonchain), [getBeefForTxid](./services.md#function-getbeeffortxid)
|
|
7479
7809
|
|
|
7480
7810
|
###### Method hashOutputScript
|
|
7481
7811
|
|
|
@@ -8904,7 +9234,7 @@ export abstract class StorageProvider extends StorageReaderWriter implements sdk
|
|
|
8904
9234
|
abstract findOutputBasketsAuth(auth: sdk.AuthId, args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>;
|
|
8905
9235
|
abstract findOutputsAuth(auth: sdk.AuthId, args: sdk.FindOutputsArgs): Promise<TableOutput[]>;
|
|
8906
9236
|
abstract insertCertificateAuth(auth: sdk.AuthId, certificate: TableCertificateX): Promise<number>;
|
|
8907
|
-
abstract adminStats(adminIdentityKey: string): Promise<
|
|
9237
|
+
abstract adminStats(adminIdentityKey: string): Promise<AdminStatsResult>;
|
|
8908
9238
|
override isStorageProvider(): boolean
|
|
8909
9239
|
setServices(v: sdk.WalletServices)
|
|
8910
9240
|
getServices(): sdk.WalletServices
|
|
@@ -8937,7 +9267,7 @@ export abstract class StorageProvider extends StorageReaderWriter implements sdk
|
|
|
8937
9267
|
}
|
|
8938
9268
|
```
|
|
8939
9269
|
|
|
8940
|
-
See also: [AuthId](./client.md#interface-authid), [Chain](./client.md#type-chain), [EntityProvenTxReq](./storage.md#class-entityproventxreq), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [GetReqsAndBeefResult](./storage.md#interface-getreqsandbeefresult), [PostReqsToNetworkResult](./storage.md#interface-postreqstonetworkresult), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [ProvenOrRawTx](./client.md#interface-provenorrawtx), [PurgeParams](./client.md#interface-purgeparams), [PurgeResults](./client.md#interface-purgeresults), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [
|
|
9270
|
+
See also: [AdminStatsResult](./storage.md#interface-adminstatsresult), [AuthId](./client.md#interface-authid), [Chain](./client.md#type-chain), [EntityProvenTxReq](./storage.md#class-entityproventxreq), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [GetReqsAndBeefResult](./storage.md#interface-getreqsandbeefresult), [PostReqsToNetworkResult](./storage.md#interface-postreqstonetworkresult), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [ProvenOrRawTx](./client.md#interface-provenorrawtx), [PurgeParams](./client.md#interface-purgeparams), [PurgeResults](./client.md#interface-purgeresults), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageFeeModel](./client.md#interface-storagefeemodel), [StorageGetBeefOptions](./client.md#interface-storagegetbeefoptions), [StorageInternalizeActionResult](./client.md#interface-storageinternalizeactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [StorageProvenOrReq](./client.md#interface-storageprovenorreq), [StorageProviderOptions](./storage.md#interface-storageprovideroptions), [StorageReaderWriter](./storage.md#class-storagereaderwriter), [SyncChunk](./client.md#interface-syncchunk), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableMonitorEvent](./storage.md#interface-tablemonitorevent), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputX](./storage.md#interface-tableoutputx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableProvenTxReqDynamics](./storage.md#interface-tableproventxreqdynamics), [TableTxLabel](./storage.md#interface-tabletxlabel), [TransactionStatus](./client.md#type-transactionstatus), [TrxToken](./client.md#interface-trxtoken), [UpdateProvenTxReqWithNewProvenTxArgs](./client.md#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](./client.md#interface-updateproventxreqwithnewproventxresult), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs), [ValidListActionsArgs](./client.md#interface-validlistactionsargs), [ValidListCertificatesArgs](./client.md#interface-validlistcertificatesargs), [ValidListOutputsArgs](./client.md#interface-validlistoutputsargs), [WalletServices](./client.md#interface-walletservices), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [attemptToPostReqsToNetwork](./storage.md#function-attempttopostreqstonetwork), [createAction](./storage.md#function-createaction), [getBeefForTransaction](./storage.md#function-getbeeffortransaction), [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), [purgeData](./storage.md#function-purgedata), [reviewStatus](./storage.md#function-reviewstatus)
|
|
8941
9271
|
|
|
8942
9272
|
###### Method confirmSpendableOutputs
|
|
8943
9273
|
|
|
@@ -9358,6 +9688,24 @@ See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.m
|
|
|
9358
9688
|
|
|
9359
9689
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9360
9690
|
|
|
9691
|
+
---
|
|
9692
|
+
##### Class: TaskMonitorCallHistory
|
|
9693
|
+
|
|
9694
|
+
```ts
|
|
9695
|
+
export class TaskMonitorCallHistory extends WalletMonitorTask {
|
|
9696
|
+
static taskName = "MonitorCallHistory";
|
|
9697
|
+
constructor(monitor: Monitor, public triggerMsecs = monitor.oneMinute * 12)
|
|
9698
|
+
trigger(nowMsecsSinceEpoch: number): {
|
|
9699
|
+
run: boolean;
|
|
9700
|
+
}
|
|
9701
|
+
async runTask(): Promise<string>
|
|
9702
|
+
}
|
|
9703
|
+
```
|
|
9704
|
+
|
|
9705
|
+
See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
9706
|
+
|
|
9707
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9708
|
+
|
|
9361
9709
|
---
|
|
9362
9710
|
##### Class: TaskNewHeader
|
|
9363
9711
|
|
|
@@ -11305,45 +11653,45 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
11305
11653
|
|
|
11306
11654
|
| | | |
|
|
11307
11655
|
| --- | --- | --- |
|
|
11308
|
-
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [listActionsIdb](#function-listactionsidb) | [
|
|
11309
|
-
| [arcDefaultUrl](#function-arcdefaulturl) | [listCertificates](#function-listcertificates) | [
|
|
11310
|
-
| [
|
|
11311
|
-
| [
|
|
11312
|
-
| [
|
|
11313
|
-
| [
|
|
11314
|
-
| [
|
|
11315
|
-
| [
|
|
11316
|
-
| [
|
|
11317
|
-
| [
|
|
11318
|
-
| [
|
|
11319
|
-
| [
|
|
11320
|
-
| [completeSignedTransaction](#function-completesignedtransaction) | [processAction](#function-processaction) | [
|
|
11321
|
-
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [
|
|
11322
|
-
| [createAction](#function-createaction) | [proveCertificate](#function-provecertificate) | [validateOptionalOutpointString](#function-validateoptionaloutpointstring) |
|
|
11656
|
+
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [listActionsIdb](#function-listactionsidb) | [validateCreateActionOptions](#function-validatecreateactionoptions) |
|
|
11657
|
+
| [arcDefaultUrl](#function-arcdefaulturl) | [listCertificates](#function-listcertificates) | [validateCreateActionOutput](#function-validatecreateactionoutput) |
|
|
11658
|
+
| [arcGorillaPoolUrl](#function-arcgorillapoolurl) | [listOutputsIdb](#function-listoutputsidb) | [validateDiscoverByAttributesArgs](#function-validatediscoverbyattributesargs) |
|
|
11659
|
+
| [arraysEqual](#function-arraysequal) | [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [validateDiscoverByIdentityKeyArgs](#function-validatediscoverbyidentitykeyargs) |
|
|
11660
|
+
| [asArray](#function-asarray) | [makeAtomicBeef](#function-makeatomicbeef) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) |
|
|
11661
|
+
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [makeChangeLock](#function-makechangelock) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) |
|
|
11662
|
+
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [maxDate](#function-maxdate) | [validateInteger](#function-validateinteger) |
|
|
11663
|
+
| [asBsvSdkScript](#function-asbsvsdkscript) | [offsetPubKey](#function-offsetpubkey) | [validateInternalizeActionArgs](#function-validateinternalizeactionargs) |
|
|
11664
|
+
| [asBsvSdkTx](#function-asbsvsdktx) | [optionalArraysEqual](#function-optionalarraysequal) | [validateInternalizeOutput](#function-validateinternalizeoutput) |
|
|
11665
|
+
| [asString](#function-asstring) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [validateListActionsArgs](#function-validatelistactionsargs) |
|
|
11666
|
+
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [parseWalletOutpoint](#function-parsewalletoutpoint) | [validateListCertificatesArgs](#function-validatelistcertificatesargs) |
|
|
11667
|
+
| [buildSignableTransaction](#function-buildsignabletransaction) | [processAction](#function-processaction) | [validateListOutputsArgs](#function-validatelistoutputsargs) |
|
|
11668
|
+
| [completeSignedTransaction](#function-completesignedtransaction) | [processAction](#function-processaction) | [validateOptionalInteger](#function-validateoptionalinteger) |
|
|
11669
|
+
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [proveCertificate](#function-provecertificate) | [validateOptionalOutpointString](#function-validateoptionaloutpointstring) |
|
|
11323
11670
|
| [createAction](#function-createaction) | [purgeDataIdb](#function-purgedataidb) | [validateOriginator](#function-validateoriginator) |
|
|
11324
|
-
| [
|
|
11325
|
-
| [
|
|
11326
|
-
| [
|
|
11327
|
-
| [
|
|
11328
|
-
| [
|
|
11329
|
-
| [
|
|
11330
|
-
| [
|
|
11331
|
-
| [
|
|
11332
|
-
| [
|
|
11333
|
-
| [
|
|
11334
|
-
| [
|
|
11335
|
-
| [
|
|
11336
|
-
| [
|
|
11337
|
-
| [
|
|
11671
|
+
| [createAction](#function-createaction) | [randomBytes](#function-randombytes) | [validateOutpointString](#function-validateoutpointstring) |
|
|
11672
|
+
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [randomBytesBase64](#function-randombytesbase64) | [validatePositiveIntegerOrZero](#function-validatepositiveintegerorzero) |
|
|
11673
|
+
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [randomBytesHex](#function-randombyteshex) | [validateProveCertificateArgs](#function-validateprovecertificateargs) |
|
|
11674
|
+
| [createSyncMap](#function-createsyncmap) | [reviewStatusIdb](#function-reviewstatusidb) | [validateRelinquishCertificateArgs](#function-validaterelinquishcertificateargs) |
|
|
11675
|
+
| [doubleSha256BE](#function-doublesha256be) | [setDisableDoubleSpendCheckForTest](#function-setdisabledoublespendcheckfortest) | [validateRelinquishOutputArgs](#function-validaterelinquishoutputargs) |
|
|
11676
|
+
| [doubleSha256LE](#function-doublesha256le) | [sha256Hash](#function-sha256hash) | [validateSatoshis](#function-validatesatoshis) |
|
|
11677
|
+
| [generateChangeSdk](#function-generatechangesdk) | [shareReqsWithWorld](#function-sharereqswithworld) | [validateScriptHash](#function-validatescripthash) |
|
|
11678
|
+
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [signAction](#function-signaction) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
|
|
11679
|
+
| [getBeefForTransaction](#function-getbeeffortransaction) | [stampLog](#function-stamplog) | [validateSignActionArgs](#function-validatesignactionargs) |
|
|
11680
|
+
| [getBeefForTxid](#function-getbeeffortxid) | [stampLogFormat](#function-stamplogformat) | [validateSignActionOptions](#function-validatesignactionoptions) |
|
|
11681
|
+
| [getExchangeRatesIo](#function-getexchangeratesio) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
|
|
11682
|
+
| [getIdentityKey](#function-getidentitykey) | [toWalletNetwork](#function-towalletnetwork) | [validateStringLength](#function-validatestringlength) |
|
|
11683
|
+
| [getProofs](#function-getproofs) | [transactionInputSize](#function-transactioninputsize) | [validateWalletPayment](#function-validatewalletpayment) |
|
|
11684
|
+
| [getSyncChunk](#function-getsyncchunk) | [transactionOutputSize](#function-transactionoutputsize) | [varUintSize](#function-varuintsize) |
|
|
11338
11685
|
| [internalizeAction](#function-internalizeaction) | [transactionSize](#function-transactionsize) | [verifyHexString](#function-verifyhexstring) |
|
|
11339
|
-
| [
|
|
11340
|
-
| [
|
|
11341
|
-
| [
|
|
11342
|
-
| [
|
|
11343
|
-
| [
|
|
11344
|
-
| [
|
|
11345
|
-
| [
|
|
11346
|
-
| [
|
|
11686
|
+
| [internalizeAction](#function-internalizeaction) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) | [verifyId](#function-verifyid) |
|
|
11687
|
+
| [isBaseBlockHeader](#function-isbaseblockheader) | [updateExchangeratesapi](#function-updateexchangeratesapi) | [verifyInteger](#function-verifyinteger) |
|
|
11688
|
+
| [isBlockHeader](#function-isblockheader) | [validateAbortActionArgs](#function-validateabortactionargs) | [verifyNumber](#function-verifynumber) |
|
|
11689
|
+
| [isCreateActionSpecOp](#function-iscreateactionspecop) | [validateAcquireCertificateArgs](#function-validateacquirecertificateargs) | [verifyOne](#function-verifyone) |
|
|
11690
|
+
| [isHexString](#function-ishexstring) | [validateAcquireDirectCertificateArgs](#function-validateacquiredirectcertificateargs) | [verifyOneOrNone](#function-verifyoneornone) |
|
|
11691
|
+
| [isListActionsSpecOp](#function-islistactionsspecop) | [validateAcquireIssuanceCertificateArgs](#function-validateacquireissuancecertificateargs) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
|
|
11692
|
+
| [isListOutputsSpecOp](#function-islistoutputsspecop) | [validateBasketInsertion](#function-validatebasketinsertion) | [verifyTruthy](#function-verifytruthy) |
|
|
11693
|
+
| [isLive](#function-islive) | [validateCreateActionArgs](#function-validatecreateactionargs) | [verifyUnlockScripts](#function-verifyunlockscripts) |
|
|
11694
|
+
| [isLiveBlockHeader](#function-isliveblockheader) | [validateCreateActionInput](#function-validatecreateactioninput) | [wait](#function-wait) |
|
|
11347
11695
|
|
|
11348
11696
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11349
11697
|
|
|
@@ -11370,6 +11718,17 @@ See also: [Chain](./client.md#type-chain)
|
|
|
11370
11718
|
|
|
11371
11719
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11372
11720
|
|
|
11721
|
+
---
|
|
11722
|
+
##### Function: arcGorillaPoolUrl
|
|
11723
|
+
|
|
11724
|
+
```ts
|
|
11725
|
+
export function arcGorillaPoolUrl(chain: sdk.Chain): string | undefined
|
|
11726
|
+
```
|
|
11727
|
+
|
|
11728
|
+
See also: [Chain](./client.md#type-chain)
|
|
11729
|
+
|
|
11730
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11731
|
+
|
|
11373
11732
|
---
|
|
11374
11733
|
##### Function: arraysEqual
|
|
11375
11734
|
|
|
@@ -11523,17 +11882,6 @@ See also: [PendingSignAction](./client.md#interface-pendingsignaction), [Wallet]
|
|
|
11523
11882
|
|
|
11524
11883
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11525
11884
|
|
|
11526
|
-
---
|
|
11527
|
-
##### Function: completeSignedTransaction
|
|
11528
|
-
|
|
11529
|
-
```ts
|
|
11530
|
-
export async function completeSignedTransaction(prior: PendingSignAction, spends: Record<number, SignActionSpend>, wallet: Wallet): Promise<BsvTransaction>
|
|
11531
|
-
```
|
|
11532
|
-
|
|
11533
|
-
See also: [PendingSignAction](./client.md#interface-pendingsignaction), [Wallet](./client.md#class-wallet)
|
|
11534
|
-
|
|
11535
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11536
|
-
|
|
11537
11885
|
---
|
|
11538
11886
|
##### Function: convertProofToMerklePath
|
|
11539
11887
|
|
|
@@ -12037,15 +12385,6 @@ export function makeAtomicBeef(tx: Transaction, beef: number[] | Beef): number[]
|
|
|
12037
12385
|
|
|
12038
12386
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
12039
12387
|
|
|
12040
|
-
---
|
|
12041
|
-
##### Function: makeAtomicBeef
|
|
12042
|
-
|
|
12043
|
-
```ts
|
|
12044
|
-
export function makeAtomicBeef(tx: BsvTransaction, beef: number[] | Beef): number[]
|
|
12045
|
-
```
|
|
12046
|
-
|
|
12047
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
12048
|
-
|
|
12049
12388
|
---
|
|
12050
12389
|
##### Function: makeChangeLock
|
|
12051
12390
|
|
|
@@ -13010,6 +13349,26 @@ export function verifyTruthy<T>(v: T | null | undefined, description?: string):
|
|
|
13010
13349
|
|
|
13011
13350
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13012
13351
|
|
|
13352
|
+
---
|
|
13353
|
+
##### Function: verifyUnlockScripts
|
|
13354
|
+
|
|
13355
|
+
```ts
|
|
13356
|
+
export function verifyUnlockScripts(txid: string, beef: Beef): void
|
|
13357
|
+
```
|
|
13358
|
+
|
|
13359
|
+
Argument Details
|
|
13360
|
+
|
|
13361
|
+
+ **txid**
|
|
13362
|
+
+ The TXID of a transaction in the beef for which all unlocking scripts must be valid.
|
|
13363
|
+
+ **beef**
|
|
13364
|
+
+ Must contain transactions for txid and all its inputs.
|
|
13365
|
+
|
|
13366
|
+
Throws
|
|
13367
|
+
|
|
13368
|
+
WERR_INVALID_PARAMETER if any unlocking script is invalid, if sourceTXID is invalid, if beef doesn't contain required transactions.
|
|
13369
|
+
|
|
13370
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13371
|
+
|
|
13013
13372
|
---
|
|
13014
13373
|
##### Function: wait
|
|
13015
13374
|
|
|
@@ -13026,20 +13385,17 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
13026
13385
|
---
|
|
13027
13386
|
#### Types
|
|
13028
13387
|
|
|
13029
|
-
| | |
|
|
13030
|
-
| --- | --- |
|
|
13031
|
-
| [Chain](#type-chain) | [
|
|
13032
|
-
| [DBType](#type-dbtype) | [
|
|
13033
|
-
| [DescriptionString5to2000Bytes](#type-descriptionstring5to2000bytes) | [
|
|
13034
|
-
| [EntityStorage](#type-entitystorage) | [
|
|
13035
|
-
| [GetMerklePathService](#type-getmerklepathservice) | [
|
|
13036
|
-
| [GetRawTxService](#type-getrawtxservice) | [
|
|
13037
|
-
| [GetScriptHashHistoryService](#type-getscripthashhistoryservice) | [
|
|
13038
|
-
| [GetStatusForTxidsService](#type-getstatusfortxidsservice) | [
|
|
13039
|
-
| [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat) | [
|
|
13040
|
-
| [GetUtxoStatusService](#type-getutxostatusservice) | [SyncStatus](#type-syncstatus) |
|
|
13041
|
-
| [MonitorStorage](#type-monitorstorage) | [TransactionStatus](#type-transactionstatus) |
|
|
13042
|
-
| [PermissionEventHandler](#type-permissioneventhandler) | [UpdateFiatExchangeRateService](#type-updatefiatexchangerateservice) |
|
|
13388
|
+
| | | |
|
|
13389
|
+
| --- | --- | --- |
|
|
13390
|
+
| [Chain](#type-chain) | [GetUtxoStatusService](#type-getutxostatusservice) | [ScriptHashFormat](#type-scripthashformat) |
|
|
13391
|
+
| [DBType](#type-dbtype) | [MonitorStorage](#type-monitorstorage) | [ServicesCallHistory](#type-servicescallhistory) |
|
|
13392
|
+
| [DescriptionString5to2000Bytes](#type-descriptionstring5to2000bytes) | [PermissionEventHandler](#type-permissioneventhandler) | [StorageProvidedBy](#type-storageprovidedby) |
|
|
13393
|
+
| [EntityStorage](#type-entitystorage) | [PostBeefService](#type-postbeefservice) | [SyncProtocolVersion](#type-syncprotocolversion) |
|
|
13394
|
+
| [GetMerklePathService](#type-getmerklepathservice) | [PostReqsToNetworkDetailsStatus](#type-postreqstonetworkdetailsstatus) | [SyncStatus](#type-syncstatus) |
|
|
13395
|
+
| [GetRawTxService](#type-getrawtxservice) | [PostTxsService](#type-posttxsservice) | [TransactionStatus](#type-transactionstatus) |
|
|
13396
|
+
| [GetScriptHashHistoryService](#type-getscripthashhistoryservice) | [ProvenTxReqStatus](#type-proventxreqstatus) | [UpdateFiatExchangeRateService](#type-updatefiatexchangerateservice) |
|
|
13397
|
+
| [GetStatusForTxidsService](#type-getstatusfortxidsservice) | [ReqHistoryNote](#type-reqhistorynote) | |
|
|
13398
|
+
| [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat) | [ReviewActionResultStatus](#type-reviewactionresultstatus) | |
|
|
13043
13399
|
|
|
13044
13400
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13045
13401
|
|
|
@@ -13296,6 +13652,28 @@ export type ScriptHashFormat = "hashLE" | "hashBE" | "script"
|
|
|
13296
13652
|
|
|
13297
13653
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13298
13654
|
|
|
13655
|
+
---
|
|
13656
|
+
##### Type: ServicesCallHistory
|
|
13657
|
+
|
|
13658
|
+
Type for the service call history returned by Services.getServicesCallHistory.
|
|
13659
|
+
|
|
13660
|
+
```ts
|
|
13661
|
+
export type ServicesCallHistory = {
|
|
13662
|
+
version: number;
|
|
13663
|
+
getMerklePath: ServiceCallHistory;
|
|
13664
|
+
getRawTx: ServiceCallHistory;
|
|
13665
|
+
postBeef: ServiceCallHistory;
|
|
13666
|
+
getUtxoStatus: ServiceCallHistory;
|
|
13667
|
+
getStatusForTxids: ServiceCallHistory;
|
|
13668
|
+
getScriptHashHistory: ServiceCallHistory;
|
|
13669
|
+
updateFiatExchangeRates: ServiceCallHistory;
|
|
13670
|
+
}
|
|
13671
|
+
```
|
|
13672
|
+
|
|
13673
|
+
See also: [ServiceCallHistory](./client.md#interface-servicecallhistory)
|
|
13674
|
+
|
|
13675
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
13676
|
+
|
|
13299
13677
|
---
|
|
13300
13678
|
##### Type: StorageProvidedBy
|
|
13301
13679
|
|