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