@bsv/wallet-toolbox 1.2.4 → 1.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/client.md +1617 -113
- package/docs/monitor.md +52 -0
- package/docs/wallet.md +1617 -113
- package/out/src/monitor/Monitor.d.ts.map +1 -1
- package/out/src/monitor/Monitor.js +3 -0
- package/out/src/monitor/Monitor.js.map +1 -1
- package/out/src/monitor/tasks/TaskUnFail.d.ts +40 -0
- package/out/src/monitor/tasks/TaskUnFail.d.ts.map +1 -0
- package/out/src/monitor/tasks/TaskUnFail.js +145 -0
- package/out/src/monitor/tasks/TaskUnFail.js.map +1 -0
- package/out/src/sdk/types.d.ts +3 -1
- package/out/src/sdk/types.d.ts.map +1 -1
- package/out/src/sdk/types.js.map +1 -1
- package/out/src/storage/StorageKnex.js +1 -1
- package/out/src/storage/StorageKnex.js.map +1 -1
- package/out/src/storage/StorageProvider.js +2 -2
- package/out/src/storage/StorageProvider.js.map +1 -1
- package/out/tsconfig.all.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/monitor/Monitor.ts +3 -0
- package/src/monitor/tasks/TaskUnFail.ts +151 -0
- package/src/sdk/types.ts +3 -0
- package/src/storage/StorageKnex.ts +1 -1
- package/src/storage/StorageProvider.ts +2 -2
package/docs/wallet.md
CHANGED
|
@@ -13,61 +13,65 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
13
13
|
|
|
14
14
|
| | | |
|
|
15
15
|
| --- | --- | --- |
|
|
16
|
-
| [ArcConfig](#interface-arcconfig) | [
|
|
17
|
-
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [
|
|
18
|
-
| [AuthId](#interface-authid) | [
|
|
19
|
-
| [AuthPayload](#interface-authpayload) | [
|
|
20
|
-
| [BaseBlockHeader](#interface-baseblockheader) | [
|
|
21
|
-
| [BitailsConfig](#interface-bitailsconfig) | [
|
|
22
|
-
| [BitailsMerkleProof](#interface-bitailsmerkleproof) | [
|
|
23
|
-
| [BlockHeader](#interface-blockheader) | [
|
|
24
|
-
| [BsvExchangeRate](#interface-bsvexchangerate) | [
|
|
25
|
-
| [CertOpsWallet](#interface-certopswallet) | [
|
|
26
|
-
| [Certifier](#interface-certifier) | [
|
|
27
|
-
| [CommitNewTxResults](#interface-commitnewtxresults) | [
|
|
28
|
-
| [CompleteAuthResponse](#interface-completeauthresponse) | [
|
|
29
|
-
| [EntitySyncMap](#interface-entitysyncmap) | [
|
|
30
|
-
| [EntityTimeStamp](#interface-entitytimestamp) | [
|
|
31
|
-
| [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [
|
|
32
|
-
| [ExtendedVerifiableCertificate](#interface-extendedverifiablecertificate) | [
|
|
33
|
-
| [FiatExchangeRates](#interface-fiatexchangerates) | [
|
|
34
|
-
| [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [
|
|
35
|
-
| [FindCertificatesArgs](#interface-findcertificatesargs) | [
|
|
36
|
-
| [FindCommissionsArgs](#interface-findcommissionsargs) | [
|
|
37
|
-
| [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [
|
|
38
|
-
| [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [
|
|
39
|
-
| [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [
|
|
40
|
-
| [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [
|
|
41
|
-
| [FindOutputTagsArgs](#interface-findoutputtagsargs) | [
|
|
42
|
-
| [FindOutputsArgs](#interface-findoutputsargs) | [
|
|
43
|
-
| [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [
|
|
44
|
-
| [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [
|
|
45
|
-
| [FindProvenTxsArgs](#interface-findproventxsargs) | [
|
|
46
|
-
| [FindSincePagedArgs](#interface-findsincepagedargs) | [
|
|
47
|
-
| [FindSyncStatesArgs](#interface-findsyncstatesargs) | [
|
|
48
|
-
| [FindTransactionsArgs](#interface-findtransactionsargs) | [
|
|
49
|
-
| [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [
|
|
50
|
-
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [
|
|
51
|
-
| [FindUsersArgs](#interface-findusersargs) | [
|
|
52
|
-
| [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [
|
|
53
|
-
| [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [
|
|
54
|
-
| [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [
|
|
55
|
-
| [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [
|
|
56
|
-
| [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [
|
|
57
|
-
| [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [
|
|
58
|
-
| [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [
|
|
59
|
-
| [GetMerklePathResult](#interface-getmerklepathresult) | [
|
|
60
|
-
| [GetRawTxResult](#interface-getrawtxresult) | [
|
|
61
|
-
| [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [
|
|
62
|
-
| [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [
|
|
63
|
-
| [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [
|
|
64
|
-
| [GetUtxoStatusResult](#interface-getutxostatusresult) | [
|
|
65
|
-
| [KeyPair](#interface-keypair) | [
|
|
66
|
-
| [
|
|
67
|
-
| [
|
|
68
|
-
| [
|
|
69
|
-
| [
|
|
70
|
-
| [
|
|
16
|
+
| [ArcConfig](#interface-arcconfig) | [PermissionsManagerConfig](#interface-permissionsmanagerconfig) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) |
|
|
17
|
+
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [PostBeefResult](#interface-postbeefresult) | [TableSettings](#interface-tablesettings) |
|
|
18
|
+
| [AuthId](#interface-authid) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [TableSyncState](#interface-tablesyncstate) |
|
|
19
|
+
| [AuthPayload](#interface-authpayload) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [TableTransaction](#interface-tabletransaction) |
|
|
20
|
+
| [BaseBlockHeader](#interface-baseblockheader) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [TableTxLabel](#interface-tabletxlabel) |
|
|
21
|
+
| [BitailsConfig](#interface-bitailsconfig) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [TableTxLabelMap](#interface-tabletxlabelmap) |
|
|
22
|
+
| [BitailsMerkleProof](#interface-bitailsmerkleproof) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [TableUser](#interface-tableuser) |
|
|
23
|
+
| [BlockHeader](#interface-blockheader) | [PostTxsResult](#interface-posttxsresult) | [TaskPurgeParams](#interface-taskpurgeparams) |
|
|
24
|
+
| [BsvExchangeRate](#interface-bsvexchangerate) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [TrustSettings](#interface-trustsettings) |
|
|
25
|
+
| [CertOpsWallet](#interface-certopswallet) | [ProvenOrRawTx](#interface-provenorrawtx) | [TrxToken](#interface-trxtoken) |
|
|
26
|
+
| [Certifier](#interface-certifier) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
|
|
27
|
+
| [CommitNewTxResults](#interface-commitnewtxresults) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [TxScriptOffsets](#interface-txscriptoffsets) |
|
|
28
|
+
| [CompleteAuthResponse](#interface-completeauthresponse) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [UMPToken](#interface-umptoken) |
|
|
29
|
+
| [EntitySyncMap](#interface-entitysyncmap) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [UMPTokenInteractor](#interface-umptokeninteractor) |
|
|
30
|
+
| [EntityTimeStamp](#interface-entitytimestamp) | [PurgeParams](#interface-purgeparams) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
|
|
31
|
+
| [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [PurgeResults](#interface-purgeresults) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
|
|
32
|
+
| [ExtendedVerifiableCertificate](#interface-extendedverifiablecertificate) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [ValidAbortActionArgs](#interface-validabortactionargs) |
|
|
33
|
+
| [FiatExchangeRates](#interface-fiatexchangerates) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [ValidAcquireCertificateArgs](#interface-validacquirecertificateargs) |
|
|
34
|
+
| [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [ValidAcquireDirectCertificateArgs](#interface-validacquiredirectcertificateargs) |
|
|
35
|
+
| [FindCertificatesArgs](#interface-findcertificatesargs) | [SetupEnv](#interface-setupenv) | [ValidAcquireIssuanceCertificateArgs](#interface-validacquireissuancecertificateargs) |
|
|
36
|
+
| [FindCommissionsArgs](#interface-findcommissionsargs) | [SetupWallet](#interface-setupwallet) | [ValidBasketInsertion](#interface-validbasketinsertion) |
|
|
37
|
+
| [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [SetupWalletArgs](#interface-setupwalletargs) | [ValidCreateActionArgs](#interface-validcreateactionargs) |
|
|
38
|
+
| [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [SetupWalletClient](#interface-setupwalletclient) | [ValidCreateActionInput](#interface-validcreateactioninput) |
|
|
39
|
+
| [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [SetupWalletClientArgs](#interface-setupwalletclientargs) | [ValidCreateActionOptions](#interface-validcreateactionoptions) |
|
|
40
|
+
| [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [SetupWalletKnex](#interface-setupwalletknex) | [ValidCreateActionOutput](#interface-validcreateactionoutput) |
|
|
41
|
+
| [FindOutputTagsArgs](#interface-findoutputtagsargs) | [SetupWalletKnexArgs](#interface-setupwalletknexargs) | [ValidDiscoverByAttributesArgs](#interface-validdiscoverbyattributesargs) |
|
|
42
|
+
| [FindOutputsArgs](#interface-findoutputsargs) | [SetupWalletMySQLArgs](#interface-setupwalletmysqlargs) | [ValidDiscoverByIdentityKeyArgs](#interface-validdiscoverbyidentitykeyargs) |
|
|
43
|
+
| [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [SetupWalletSQLiteArgs](#interface-setupwalletsqliteargs) | [ValidInternalizeActionArgs](#interface-validinternalizeactionargs) |
|
|
44
|
+
| [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [StartAuthResponse](#interface-startauthresponse) | [ValidInternalizeOutput](#interface-validinternalizeoutput) |
|
|
45
|
+
| [FindProvenTxsArgs](#interface-findproventxsargs) | [StorageCreateActionResult](#interface-storagecreateactionresult) | [ValidListActionsArgs](#interface-validlistactionsargs) |
|
|
46
|
+
| [FindSincePagedArgs](#interface-findsincepagedargs) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) | [ValidListCertificatesArgs](#interface-validlistcertificatesargs) |
|
|
47
|
+
| [FindSyncStatesArgs](#interface-findsyncstatesargs) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) | [ValidListOutputsArgs](#interface-validlistoutputsargs) |
|
|
48
|
+
| [FindTransactionsArgs](#interface-findtransactionsargs) | [StorageFeeModel](#interface-storagefeemodel) | [ValidProcessActionArgs](#interface-validprocessactionargs) |
|
|
49
|
+
| [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) | [ValidProcessActionOptions](#interface-validprocessactionoptions) |
|
|
50
|
+
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [StorageIdentity](#interface-storageidentity) | [ValidProveCertificateArgs](#interface-validprovecertificateargs) |
|
|
51
|
+
| [FindUsersArgs](#interface-findusersargs) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) | [ValidRelinquishCertificateArgs](#interface-validrelinquishcertificateargs) |
|
|
52
|
+
| [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StorageKnexOptions](#interface-storageknexoptions) | [ValidRelinquishOutputArgs](#interface-validrelinquishoutputargs) |
|
|
53
|
+
| [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [StorageProcessActionArgs](#interface-storageprocessactionargs) | [ValidSignActionArgs](#interface-validsignactionargs) |
|
|
54
|
+
| [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [StorageProcessActionResults](#interface-storageprocessactionresults) | [ValidSignActionOptions](#interface-validsignactionoptions) |
|
|
55
|
+
| [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [StorageProvenOrReq](#interface-storageprovenorreq) | [ValidWalletPayment](#interface-validwalletpayment) |
|
|
56
|
+
| [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [StorageProviderOptions](#interface-storageprovideroptions) | [ValidWalletSignerArgs](#interface-validwalletsignerargs) |
|
|
57
|
+
| [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [StorageReaderOptions](#interface-storagereaderoptions) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
|
|
58
|
+
| [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) | [WalletArgs](#interface-walletargs) |
|
|
59
|
+
| [GetMerklePathResult](#interface-getmerklepathresult) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) | [WalletBalance](#interface-walletbalance) |
|
|
60
|
+
| [GetRawTxResult](#interface-getrawtxresult) | [SyncChunk](#interface-syncchunk) | [WalletPermissionsManagerCallbacks](#interface-walletpermissionsmanagercallbacks) |
|
|
61
|
+
| [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [SyncError](#interface-syncerror) | [WalletServices](#interface-walletservices) |
|
|
62
|
+
| [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [SyncMap](#interface-syncmap) | [WalletServicesOptions](#interface-walletservicesoptions) |
|
|
63
|
+
| [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [TableCertificate](#interface-tablecertificate) | [WalletSettings](#interface-walletsettings) |
|
|
64
|
+
| [GetUtxoStatusResult](#interface-getutxostatusresult) | [TableCertificateField](#interface-tablecertificatefield) | [WalletSettingsManagerConfig](#interface-walletsettingsmanagerconfig) |
|
|
65
|
+
| [KeyPair](#interface-keypair) | [TableCertificateX](#interface-tablecertificatex) | [WalletSigner](#interface-walletsigner) |
|
|
66
|
+
| [KeyPairAddress](#interface-keypairaddress) | [TableCommission](#interface-tablecommission) | [WalletStorage](#interface-walletstorage) |
|
|
67
|
+
| [MonitorDaemonSetup](#interface-monitordaemonsetup) | [TableMonitorEvent](#interface-tablemonitorevent) | [WalletStorageProvider](#interface-walletstorageprovider) |
|
|
68
|
+
| [MonitorOptions](#interface-monitoroptions) | [TableOutput](#interface-tableoutput) | [WalletStorageReader](#interface-walletstoragereader) |
|
|
69
|
+
| [OutPoint](#interface-outpoint) | [TableOutputBasket](#interface-tableoutputbasket) | [WalletStorageServerOptions](#interface-walletstorageserveroptions) |
|
|
70
|
+
| [Paged](#interface-paged) | [TableOutputTag](#interface-tableoutputtag) | [WalletStorageSync](#interface-walletstoragesync) |
|
|
71
|
+
| [PendingSignAction](#interface-pendingsignaction) | [TableOutputTagMap](#interface-tableoutputtagmap) | [WalletStorageSyncReader](#interface-walletstoragesyncreader) |
|
|
72
|
+
| [PendingStorageInput](#interface-pendingstorageinput) | [TableOutputX](#interface-tableoutputx) | [WalletStorageWriter](#interface-walletstoragewriter) |
|
|
73
|
+
| [PermissionRequest](#interface-permissionrequest) | [TableProvenTx](#interface-tableproventx) | [WalletTheme](#interface-wallettheme) |
|
|
74
|
+
| [PermissionToken](#interface-permissiontoken) | [TableProvenTxReq](#interface-tableproventxreq) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
|
|
71
75
|
|
|
72
76
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
73
77
|
|
|
@@ -1150,6 +1154,44 @@ export interface KeyPair {
|
|
|
1150
1154
|
|
|
1151
1155
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1152
1156
|
|
|
1157
|
+
---
|
|
1158
|
+
##### Interface: KeyPairAddress
|
|
1159
|
+
|
|
1160
|
+
A private key and associated public key and address.
|
|
1161
|
+
|
|
1162
|
+
```ts
|
|
1163
|
+
export interface KeyPairAddress {
|
|
1164
|
+
privateKey: PrivateKey;
|
|
1165
|
+
publicKey: PublicKey;
|
|
1166
|
+
address: string;
|
|
1167
|
+
}
|
|
1168
|
+
```
|
|
1169
|
+
|
|
1170
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1171
|
+
|
|
1172
|
+
---
|
|
1173
|
+
##### Interface: MonitorDaemonSetup
|
|
1174
|
+
|
|
1175
|
+
```ts
|
|
1176
|
+
export interface MonitorDaemonSetup {
|
|
1177
|
+
chain?: sdk.Chain;
|
|
1178
|
+
sqliteFilename?: string;
|
|
1179
|
+
mySQLConnection?: string;
|
|
1180
|
+
knexConfig?: Knex.Config;
|
|
1181
|
+
knex?: Knex<any, any[]>;
|
|
1182
|
+
storageKnexOptions?: StorageKnexOptions;
|
|
1183
|
+
storageProvider?: StorageProvider;
|
|
1184
|
+
storageManager?: WalletStorageManager;
|
|
1185
|
+
servicesOptions?: sdk.WalletServicesOptions;
|
|
1186
|
+
services?: Services;
|
|
1187
|
+
monitor?: Monitor;
|
|
1188
|
+
}
|
|
1189
|
+
```
|
|
1190
|
+
|
|
1191
|
+
See also: [Chain](./client.md#type-chain), [Monitor](./monitor.md#class-monitor), [Services](./services.md#class-services), [StorageKnexOptions](./storage.md#interface-storageknexoptions), [StorageProvider](./storage.md#class-storageprovider), [WalletServicesOptions](./client.md#interface-walletservicesoptions), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
1192
|
+
|
|
1193
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1194
|
+
|
|
1153
1195
|
---
|
|
1154
1196
|
##### Interface: MonitorOptions
|
|
1155
1197
|
|
|
@@ -2122,6 +2164,378 @@ export interface ScriptTemplateUnlock {
|
|
|
2122
2164
|
|
|
2123
2165
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2124
2166
|
|
|
2167
|
+
---
|
|
2168
|
+
##### Interface: SetupEnv
|
|
2169
|
+
|
|
2170
|
+
`SetupEnv` provides a starting point for managing secrets that
|
|
2171
|
+
must not appear in source code.
|
|
2172
|
+
|
|
2173
|
+
The `makeEnv` and `getEnv` functions of the `Setup` and `SetupClient` classes
|
|
2174
|
+
provide an easy way to create and import these secrets and related properties.
|
|
2175
|
+
|
|
2176
|
+
```ts
|
|
2177
|
+
export interface SetupEnv {
|
|
2178
|
+
chain: sdk.Chain;
|
|
2179
|
+
identityKey: string;
|
|
2180
|
+
identityKey2: string;
|
|
2181
|
+
filePath: string | undefined;
|
|
2182
|
+
taalApiKey: string;
|
|
2183
|
+
devKeys: Record<string, string>;
|
|
2184
|
+
mySQLConnection: string;
|
|
2185
|
+
}
|
|
2186
|
+
```
|
|
2187
|
+
|
|
2188
|
+
See also: [Chain](./client.md#type-chain)
|
|
2189
|
+
|
|
2190
|
+
###### Property chain
|
|
2191
|
+
|
|
2192
|
+
The chan being accessed: 'main' for mainnet, 'test' for 'testnet'.
|
|
2193
|
+
|
|
2194
|
+
```ts
|
|
2195
|
+
chain: sdk.Chain
|
|
2196
|
+
```
|
|
2197
|
+
See also: [Chain](./client.md#type-chain)
|
|
2198
|
+
|
|
2199
|
+
###### Property devKeys
|
|
2200
|
+
|
|
2201
|
+
A map of public keys (identity keys, hex strings) to private keys (hex strings).
|
|
2202
|
+
|
|
2203
|
+
```ts
|
|
2204
|
+
devKeys: Record<string, string>
|
|
2205
|
+
```
|
|
2206
|
+
|
|
2207
|
+
###### Property filePath
|
|
2208
|
+
|
|
2209
|
+
Filepath to sqlite file to be used for identityKey wallet.
|
|
2210
|
+
|
|
2211
|
+
```ts
|
|
2212
|
+
filePath: string | undefined
|
|
2213
|
+
```
|
|
2214
|
+
|
|
2215
|
+
###### Property identityKey
|
|
2216
|
+
|
|
2217
|
+
The user's primary identity key (public key).
|
|
2218
|
+
|
|
2219
|
+
```ts
|
|
2220
|
+
identityKey: string
|
|
2221
|
+
```
|
|
2222
|
+
|
|
2223
|
+
###### Property identityKey2
|
|
2224
|
+
|
|
2225
|
+
A secondary identity key (public key), used to test exchanges with other users.
|
|
2226
|
+
|
|
2227
|
+
```ts
|
|
2228
|
+
identityKey2: string
|
|
2229
|
+
```
|
|
2230
|
+
|
|
2231
|
+
###### Property mySQLConnection
|
|
2232
|
+
|
|
2233
|
+
A MySQL connection string including user and password properties.
|
|
2234
|
+
Must be valid to make use of MySQL `Setup` class support.
|
|
2235
|
+
|
|
2236
|
+
```ts
|
|
2237
|
+
mySQLConnection: string
|
|
2238
|
+
```
|
|
2239
|
+
|
|
2240
|
+
###### Property taalApiKey
|
|
2241
|
+
|
|
2242
|
+
A vaild TAAL API key for use by `Services`
|
|
2243
|
+
|
|
2244
|
+
```ts
|
|
2245
|
+
taalApiKey: string
|
|
2246
|
+
```
|
|
2247
|
+
|
|
2248
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2249
|
+
|
|
2250
|
+
---
|
|
2251
|
+
##### Interface: SetupWallet
|
|
2252
|
+
|
|
2253
|
+
When creating a BRC-100 compatible `Wallet`, many components come into play.
|
|
2254
|
+
|
|
2255
|
+
All of the `createWallet` functions in the `Setup` and `SetupClient` classes return
|
|
2256
|
+
an object with direct access to each component to facilitate experimentation, testing
|
|
2257
|
+
and customization.
|
|
2258
|
+
|
|
2259
|
+
```ts
|
|
2260
|
+
export interface SetupWallet {
|
|
2261
|
+
rootKey: PrivateKey;
|
|
2262
|
+
identityKey: string;
|
|
2263
|
+
keyDeriver: KeyDeriver;
|
|
2264
|
+
chain: sdk.Chain;
|
|
2265
|
+
storage: WalletStorageManager;
|
|
2266
|
+
services: Services;
|
|
2267
|
+
monitor: Monitor;
|
|
2268
|
+
wallet: Wallet;
|
|
2269
|
+
}
|
|
2270
|
+
```
|
|
2271
|
+
|
|
2272
|
+
See also: [Chain](./client.md#type-chain), [Monitor](./monitor.md#class-monitor), [Services](./services.md#class-services), [Wallet](./client.md#class-wallet), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
2273
|
+
|
|
2274
|
+
###### Property chain
|
|
2275
|
+
|
|
2276
|
+
The chain ('main' or 'test') which the wallet accesses.
|
|
2277
|
+
|
|
2278
|
+
```ts
|
|
2279
|
+
chain: sdk.Chain
|
|
2280
|
+
```
|
|
2281
|
+
See also: [Chain](./client.md#type-chain)
|
|
2282
|
+
|
|
2283
|
+
###### Property identityKey
|
|
2284
|
+
|
|
2285
|
+
The pubilc key associated with the `rootKey` which also serves as the wallet's identity.
|
|
2286
|
+
|
|
2287
|
+
```ts
|
|
2288
|
+
identityKey: string
|
|
2289
|
+
```
|
|
2290
|
+
|
|
2291
|
+
###### Property keyDeriver
|
|
2292
|
+
|
|
2293
|
+
The `KeyDeriver` component used by the wallet for key derivation and cryptographic functions.
|
|
2294
|
+
|
|
2295
|
+
```ts
|
|
2296
|
+
keyDeriver: KeyDeriver
|
|
2297
|
+
```
|
|
2298
|
+
|
|
2299
|
+
###### Property monitor
|
|
2300
|
+
|
|
2301
|
+
The background task `Monitor` component available to the wallet to offload tasks
|
|
2302
|
+
that speed up wallet operations and maintain data integrity.
|
|
2303
|
+
|
|
2304
|
+
```ts
|
|
2305
|
+
monitor: Monitor
|
|
2306
|
+
```
|
|
2307
|
+
See also: [Monitor](./monitor.md#class-monitor)
|
|
2308
|
+
|
|
2309
|
+
###### Property rootKey
|
|
2310
|
+
|
|
2311
|
+
The rootKey of the `KeyDeriver`. The private key from which other keys are derived.
|
|
2312
|
+
|
|
2313
|
+
```ts
|
|
2314
|
+
rootKey: PrivateKey
|
|
2315
|
+
```
|
|
2316
|
+
|
|
2317
|
+
###### Property services
|
|
2318
|
+
|
|
2319
|
+
The network `Services` component which provides the wallet with access to external services hosted
|
|
2320
|
+
on the public network.
|
|
2321
|
+
|
|
2322
|
+
```ts
|
|
2323
|
+
services: Services
|
|
2324
|
+
```
|
|
2325
|
+
See also: [Services](./services.md#class-services)
|
|
2326
|
+
|
|
2327
|
+
###### Property storage
|
|
2328
|
+
|
|
2329
|
+
The `WalletStorageManager` that manages all the configured storage providers (active and backups)
|
|
2330
|
+
accessed by the wallet.
|
|
2331
|
+
|
|
2332
|
+
```ts
|
|
2333
|
+
storage: WalletStorageManager
|
|
2334
|
+
```
|
|
2335
|
+
See also: [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
2336
|
+
|
|
2337
|
+
###### Property wallet
|
|
2338
|
+
|
|
2339
|
+
The actual BRC-100 `Wallet` to which all the other properties and components contribute.
|
|
2340
|
+
|
|
2341
|
+
Note that internally, the wallet is itself linked to all these properties and components.
|
|
2342
|
+
They are included in this interface to facilitate access after wallet construction for
|
|
2343
|
+
experimentation, testing and customization. Any changes made to the configuration of these
|
|
2344
|
+
components after construction may disrupt the normal operation of the wallet.
|
|
2345
|
+
|
|
2346
|
+
```ts
|
|
2347
|
+
wallet: Wallet
|
|
2348
|
+
```
|
|
2349
|
+
See also: [Wallet](./client.md#class-wallet)
|
|
2350
|
+
|
|
2351
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2352
|
+
|
|
2353
|
+
---
|
|
2354
|
+
##### Interface: SetupWalletArgs
|
|
2355
|
+
|
|
2356
|
+
Arguments used by `createWallet` to construct a `SetupWallet`.
|
|
2357
|
+
|
|
2358
|
+
Extension `SetupWalletClientArgs` used by `createWalletClient` to construct a `SetupWalletClient`.
|
|
2359
|
+
|
|
2360
|
+
Extension `SetupWalletKnexArgs` used by `createWalletKnex` to construct a `SetupWalletKnex`.
|
|
2361
|
+
|
|
2362
|
+
Extension `SetupWalletMySQLArgs` used by `createWalletMySQL` to construct a `SetupWalletKnex`.
|
|
2363
|
+
|
|
2364
|
+
Extension `SetupWalletSQLiteArgs` used by `createWalletSQLite` to construct a `SetupWalletKnex`.
|
|
2365
|
+
|
|
2366
|
+
```ts
|
|
2367
|
+
export interface SetupWalletArgs {
|
|
2368
|
+
env: SetupEnv;
|
|
2369
|
+
rootKeyHex?: string;
|
|
2370
|
+
privilegedKeyGetter?: () => Promise<PrivateKey>;
|
|
2371
|
+
active?: sdk.WalletStorageProvider;
|
|
2372
|
+
backups?: sdk.WalletStorageProvider[];
|
|
2373
|
+
}
|
|
2374
|
+
```
|
|
2375
|
+
|
|
2376
|
+
See also: [SetupEnv](./setup.md#interface-setupenv), [WalletStorageProvider](./client.md#interface-walletstorageprovider)
|
|
2377
|
+
|
|
2378
|
+
###### Property active
|
|
2379
|
+
|
|
2380
|
+
Optional. Active wallet storage. Can be added later.
|
|
2381
|
+
|
|
2382
|
+
```ts
|
|
2383
|
+
active?: sdk.WalletStorageProvider
|
|
2384
|
+
```
|
|
2385
|
+
See also: [WalletStorageProvider](./client.md#interface-walletstorageprovider)
|
|
2386
|
+
|
|
2387
|
+
###### Property backups
|
|
2388
|
+
|
|
2389
|
+
Optional. One or more storage providers managed as backup destinations. Can be added later.
|
|
2390
|
+
|
|
2391
|
+
```ts
|
|
2392
|
+
backups?: sdk.WalletStorageProvider[]
|
|
2393
|
+
```
|
|
2394
|
+
See also: [WalletStorageProvider](./client.md#interface-walletstorageprovider)
|
|
2395
|
+
|
|
2396
|
+
###### Property env
|
|
2397
|
+
|
|
2398
|
+
Configuration "secrets" typically obtained by `Setup.makeEnv` and `Setup.getEnv` functions.
|
|
2399
|
+
|
|
2400
|
+
```ts
|
|
2401
|
+
env: SetupEnv
|
|
2402
|
+
```
|
|
2403
|
+
See also: [SetupEnv](./setup.md#interface-setupenv)
|
|
2404
|
+
|
|
2405
|
+
###### Property privilegedKeyGetter
|
|
2406
|
+
|
|
2407
|
+
Optional. The privileged private key getter used to initialize the `PrivilegedKeyManager`.
|
|
2408
|
+
Defaults to undefined.
|
|
2409
|
+
|
|
2410
|
+
```ts
|
|
2411
|
+
privilegedKeyGetter?: () => Promise<PrivateKey>
|
|
2412
|
+
```
|
|
2413
|
+
|
|
2414
|
+
###### Property rootKeyHex
|
|
2415
|
+
|
|
2416
|
+
Optional. The non-privileged private key used to initialize the `KeyDeriver` and determine the `identityKey`.
|
|
2417
|
+
Defaults to `env.devKeys[env.identityKey]
|
|
2418
|
+
|
|
2419
|
+
```ts
|
|
2420
|
+
rootKeyHex?: string
|
|
2421
|
+
```
|
|
2422
|
+
|
|
2423
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2424
|
+
|
|
2425
|
+
---
|
|
2426
|
+
##### Interface: SetupWalletClient
|
|
2427
|
+
|
|
2428
|
+
Extension `SetupWalletClient` of `SetupWallet` is returned by `createWalletClient`
|
|
2429
|
+
|
|
2430
|
+
```ts
|
|
2431
|
+
export interface SetupWalletClient extends SetupWallet {
|
|
2432
|
+
endpointUrl: string;
|
|
2433
|
+
}
|
|
2434
|
+
```
|
|
2435
|
+
|
|
2436
|
+
See also: [SetupWallet](./setup.md#interface-setupwallet)
|
|
2437
|
+
|
|
2438
|
+
###### Property endpointUrl
|
|
2439
|
+
|
|
2440
|
+
The endpoint URL of the service hosting the `StorageServer` JSON-RPC service to
|
|
2441
|
+
which a `StorageClient` instance is connected to function as
|
|
2442
|
+
the active storage provider of the wallet.
|
|
2443
|
+
|
|
2444
|
+
```ts
|
|
2445
|
+
endpointUrl: string
|
|
2446
|
+
```
|
|
2447
|
+
|
|
2448
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2449
|
+
|
|
2450
|
+
---
|
|
2451
|
+
##### Interface: SetupWalletClientArgs
|
|
2452
|
+
|
|
2453
|
+
Extension `SetupWalletClientArgs` of `SetupWalletArgs` is used by `createWalletClient`
|
|
2454
|
+
to construct a `SetupWalletClient`.
|
|
2455
|
+
|
|
2456
|
+
```ts
|
|
2457
|
+
export interface SetupWalletClientArgs extends SetupWalletArgs {
|
|
2458
|
+
endpointUrl?: string;
|
|
2459
|
+
}
|
|
2460
|
+
```
|
|
2461
|
+
|
|
2462
|
+
See also: [SetupWalletArgs](./setup.md#interface-setupwalletargs)
|
|
2463
|
+
|
|
2464
|
+
###### Property endpointUrl
|
|
2465
|
+
|
|
2466
|
+
The endpoint URL of a service hosting the `StorageServer` JSON-RPC service to
|
|
2467
|
+
which a `StorageClient` instance should connect to function as
|
|
2468
|
+
the active storage provider of the newly created wallet.
|
|
2469
|
+
|
|
2470
|
+
```ts
|
|
2471
|
+
endpointUrl?: string
|
|
2472
|
+
```
|
|
2473
|
+
|
|
2474
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2475
|
+
|
|
2476
|
+
---
|
|
2477
|
+
##### Interface: SetupWalletKnex
|
|
2478
|
+
|
|
2479
|
+
```ts
|
|
2480
|
+
export interface SetupWalletKnex extends SetupWallet {
|
|
2481
|
+
activeStorage: StorageKnex;
|
|
2482
|
+
userId: number;
|
|
2483
|
+
rootKey: PrivateKey;
|
|
2484
|
+
identityKey: string;
|
|
2485
|
+
keyDeriver: KeyDeriver;
|
|
2486
|
+
chain: sdk.Chain;
|
|
2487
|
+
storage: WalletStorageManager;
|
|
2488
|
+
services: Services;
|
|
2489
|
+
monitor: Monitor;
|
|
2490
|
+
wallet: Wallet;
|
|
2491
|
+
}
|
|
2492
|
+
```
|
|
2493
|
+
|
|
2494
|
+
See also: [Chain](./client.md#type-chain), [Monitor](./monitor.md#class-monitor), [Services](./services.md#class-services), [SetupWallet](./setup.md#interface-setupwallet), [StorageKnex](./storage.md#class-storageknex), [Wallet](./client.md#class-wallet), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
2495
|
+
|
|
2496
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2497
|
+
|
|
2498
|
+
---
|
|
2499
|
+
##### Interface: SetupWalletKnexArgs
|
|
2500
|
+
|
|
2501
|
+
```ts
|
|
2502
|
+
export interface SetupWalletKnexArgs extends SetupWalletArgs {
|
|
2503
|
+
knex: Knex<any, any[]>;
|
|
2504
|
+
databaseName: string;
|
|
2505
|
+
}
|
|
2506
|
+
```
|
|
2507
|
+
|
|
2508
|
+
See also: [SetupWalletArgs](./setup.md#interface-setupwalletargs)
|
|
2509
|
+
|
|
2510
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2511
|
+
|
|
2512
|
+
---
|
|
2513
|
+
##### Interface: SetupWalletMySQLArgs
|
|
2514
|
+
|
|
2515
|
+
```ts
|
|
2516
|
+
export interface SetupWalletMySQLArgs extends SetupWalletArgs {
|
|
2517
|
+
databaseName: string;
|
|
2518
|
+
}
|
|
2519
|
+
```
|
|
2520
|
+
|
|
2521
|
+
See also: [SetupWalletArgs](./setup.md#interface-setupwalletargs)
|
|
2522
|
+
|
|
2523
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2524
|
+
|
|
2525
|
+
---
|
|
2526
|
+
##### Interface: SetupWalletSQLiteArgs
|
|
2527
|
+
|
|
2528
|
+
```ts
|
|
2529
|
+
export interface SetupWalletSQLiteArgs extends SetupWalletArgs {
|
|
2530
|
+
filePath: string;
|
|
2531
|
+
databaseName: string;
|
|
2532
|
+
}
|
|
2533
|
+
```
|
|
2534
|
+
|
|
2535
|
+
See also: [SetupWalletArgs](./setup.md#interface-setupwalletargs)
|
|
2536
|
+
|
|
2537
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2538
|
+
|
|
2125
2539
|
---
|
|
2126
2540
|
##### Interface: StartAuthResponse
|
|
2127
2541
|
|
|
@@ -2367,6 +2781,27 @@ txid: string
|
|
|
2367
2781
|
|
|
2368
2782
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2369
2783
|
|
|
2784
|
+
---
|
|
2785
|
+
##### Interface: StorageKnexOptions
|
|
2786
|
+
|
|
2787
|
+
```ts
|
|
2788
|
+
export interface StorageKnexOptions extends StorageProviderOptions {
|
|
2789
|
+
knex: Knex;
|
|
2790
|
+
}
|
|
2791
|
+
```
|
|
2792
|
+
|
|
2793
|
+
See also: [StorageProviderOptions](./storage.md#interface-storageprovideroptions)
|
|
2794
|
+
|
|
2795
|
+
###### Property knex
|
|
2796
|
+
|
|
2797
|
+
Knex database interface initialized with valid connection configuration.
|
|
2798
|
+
|
|
2799
|
+
```ts
|
|
2800
|
+
knex: Knex
|
|
2801
|
+
```
|
|
2802
|
+
|
|
2803
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2804
|
+
|
|
2370
2805
|
---
|
|
2371
2806
|
##### Interface: StorageProcessActionArgs
|
|
2372
2807
|
|
|
@@ -4309,6 +4744,22 @@ See also: [AuthId](./client.md#interface-authid), [FindCertificatesArgs](./clien
|
|
|
4309
4744
|
|
|
4310
4745
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4311
4746
|
|
|
4747
|
+
---
|
|
4748
|
+
##### Interface: WalletStorageServerOptions
|
|
4749
|
+
|
|
4750
|
+
```ts
|
|
4751
|
+
export interface WalletStorageServerOptions {
|
|
4752
|
+
port: number;
|
|
4753
|
+
wallet: Wallet;
|
|
4754
|
+
monetize: boolean;
|
|
4755
|
+
calculateRequestPrice?: (req: Request) => number | Promise<number>;
|
|
4756
|
+
}
|
|
4757
|
+
```
|
|
4758
|
+
|
|
4759
|
+
See also: [Wallet](./client.md#class-wallet)
|
|
4760
|
+
|
|
4761
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4762
|
+
|
|
4312
4763
|
---
|
|
4313
4764
|
##### Interface: WalletStorageSync
|
|
4314
4765
|
|
|
@@ -4412,28 +4863,30 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4412
4863
|
|
|
4413
4864
|
| | | |
|
|
4414
4865
|
| --- | --- | --- |
|
|
4415
|
-
| [ARC](#class-arc) | [PersonaIDInteractor](#class-personaidinteractor) | [
|
|
4416
|
-
| [AuthMethodInteractor](#class-authmethodinteractor) | [PrivilegedKeyManager](#class-privilegedkeymanager) | [
|
|
4417
|
-
| [Bitails](#class-bitails) | [ScriptTemplateBRC29](#class-scripttemplatebrc29) | [
|
|
4418
|
-
| [CWIStyleWalletManager](#class-cwistylewalletmanager) | [SdkWhatsOnChain](#class-sdkwhatsonchain) | [
|
|
4419
|
-
| [EntityBase](#class-entitybase) | [ServiceCollection](#class-servicecollection) | [
|
|
4420
|
-
| [EntityCertificate](#class-entitycertificate) | [Services](#class-services) | [
|
|
4421
|
-
| [EntityCertificateField](#class-entitycertificatefield) | [
|
|
4422
|
-
| [EntityCommission](#class-entitycommission) | [
|
|
4423
|
-
| [EntityOutput](#class-entityoutput) | [
|
|
4424
|
-
| [EntityOutputBasket](#class-entityoutputbasket) | [
|
|
4425
|
-
| [EntityOutputTag](#class-entityoutputtag) | [
|
|
4426
|
-
| [EntityOutputTagMap](#class-entityoutputtagmap) | [
|
|
4427
|
-
| [EntityProvenTx](#class-entityproventx) | [
|
|
4428
|
-
| [EntityProvenTxReq](#class-entityproventxreq) | [
|
|
4429
|
-
| [EntitySyncState](#class-entitysyncstate) | [
|
|
4430
|
-
| [EntityTransaction](#class-entitytransaction) | [
|
|
4431
|
-
| [EntityTxLabel](#class-entitytxlabel) | [
|
|
4432
|
-
| [EntityTxLabelMap](#class-entitytxlabelmap) | [
|
|
4433
|
-
| [EntityUser](#class-entityuser) | [
|
|
4434
|
-
| [
|
|
4435
|
-
| [
|
|
4436
|
-
| [
|
|
4866
|
+
| [ARC](#class-arc) | [PersonaIDInteractor](#class-personaidinteractor) | [TwilioPhoneInteractor](#class-twiliophoneinteractor) |
|
|
4867
|
+
| [AuthMethodInteractor](#class-authmethodinteractor) | [PrivilegedKeyManager](#class-privilegedkeymanager) | [WABClient](#class-wabclient) |
|
|
4868
|
+
| [Bitails](#class-bitails) | [ScriptTemplateBRC29](#class-scripttemplatebrc29) | [WERR_BAD_REQUEST](#class-werr_bad_request) |
|
|
4869
|
+
| [CWIStyleWalletManager](#class-cwistylewalletmanager) | [SdkWhatsOnChain](#class-sdkwhatsonchain) | [WERR_BROADCAST_UNAVAILABLE](#class-werr_broadcast_unavailable) |
|
|
4870
|
+
| [EntityBase](#class-entitybase) | [ServiceCollection](#class-servicecollection) | [WERR_INSUFFICIENT_FUNDS](#class-werr_insufficient_funds) |
|
|
4871
|
+
| [EntityCertificate](#class-entitycertificate) | [Services](#class-services) | [WERR_INTERNAL](#class-werr_internal) |
|
|
4872
|
+
| [EntityCertificateField](#class-entitycertificatefield) | [Setup](#class-setup) | [WERR_INVALID_OPERATION](#class-werr_invalid_operation) |
|
|
4873
|
+
| [EntityCommission](#class-entitycommission) | [SimpleWalletManager](#class-simplewalletmanager) | [WERR_INVALID_PARAMETER](#class-werr_invalid_parameter) |
|
|
4874
|
+
| [EntityOutput](#class-entityoutput) | [StorageClient](#class-storageclient) | [WERR_INVALID_PUBLIC_KEY](#class-werr_invalid_public_key) |
|
|
4875
|
+
| [EntityOutputBasket](#class-entityoutputbasket) | [StorageKnex](#class-storageknex) | [WERR_MISSING_PARAMETER](#class-werr_missing_parameter) |
|
|
4876
|
+
| [EntityOutputTag](#class-entityoutputtag) | [StorageProvider](#class-storageprovider) | [WERR_NETWORK_CHAIN](#class-werr_network_chain) |
|
|
4877
|
+
| [EntityOutputTagMap](#class-entityoutputtagmap) | [StorageReader](#class-storagereader) | [WERR_NOT_ACTIVE](#class-werr_not_active) |
|
|
4878
|
+
| [EntityProvenTx](#class-entityproventx) | [StorageReaderWriter](#class-storagereaderwriter) | [WERR_NOT_IMPLEMENTED](#class-werr_not_implemented) |
|
|
4879
|
+
| [EntityProvenTxReq](#class-entityproventxreq) | [StorageServer](#class-storageserver) | [WERR_UNAUTHORIZED](#class-werr_unauthorized) |
|
|
4880
|
+
| [EntitySyncState](#class-entitysyncstate) | [StorageSyncReader](#class-storagesyncreader) | [Wallet](#class-wallet) |
|
|
4881
|
+
| [EntityTransaction](#class-entitytransaction) | [TaskCheckForProofs](#class-taskcheckforproofs) | [WalletAuthenticationManager](#class-walletauthenticationmanager) |
|
|
4882
|
+
| [EntityTxLabel](#class-entitytxlabel) | [TaskClock](#class-taskclock) | [WalletError](#class-walleterror) |
|
|
4883
|
+
| [EntityTxLabelMap](#class-entitytxlabelmap) | [TaskFailAbandoned](#class-taskfailabandoned) | [WalletMonitorTask](#class-walletmonitortask) |
|
|
4884
|
+
| [EntityUser](#class-entityuser) | [TaskNewHeader](#class-tasknewheader) | [WalletPermissionsManager](#class-walletpermissionsmanager) |
|
|
4885
|
+
| [KnexMigrations](#class-knexmigrations) | [TaskPurge](#class-taskpurge) | [WalletSettingsManager](#class-walletsettingsmanager) |
|
|
4886
|
+
| [MergeEntity](#class-mergeentity) | [TaskReviewStatus](#class-taskreviewstatus) | [WalletSigner](#class-walletsigner) |
|
|
4887
|
+
| [Monitor](#class-monitor) | [TaskSendWaiting](#class-tasksendwaiting) | [WalletStorageManager](#class-walletstoragemanager) |
|
|
4888
|
+
| [MonitorDaemon](#class-monitordaemon) | [TaskSyncWhenIdle](#class-tasksyncwhenidle) | [WhatsOnChain](#class-whatsonchain) |
|
|
4889
|
+
| [OverlayUMPTokenInteractor](#class-overlayumptokeninteractor) | [TaskUnFail](#class-taskunfail) | |
|
|
4437
4890
|
|
|
4438
4891
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4439
4892
|
|
|
@@ -5869,6 +6322,76 @@ See also: [EntityBase](./storage.md#class-entitybase), [EntityStorage](./storage
|
|
|
5869
6322
|
|
|
5870
6323
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5871
6324
|
|
|
6325
|
+
---
|
|
6326
|
+
##### Class: KnexMigrations
|
|
6327
|
+
|
|
6328
|
+
```ts
|
|
6329
|
+
export class KnexMigrations implements MigrationSource<string> {
|
|
6330
|
+
migrations: Record<string, Migration> = {};
|
|
6331
|
+
constructor(public chain: sdk.Chain, public storageName: string, public storageIdentityKey: string, public maxOutputScriptLength: number)
|
|
6332
|
+
async getMigrations(): Promise<string[]>
|
|
6333
|
+
getMigrationName(migration: string)
|
|
6334
|
+
async getMigration(migration: string): Promise<Migration>
|
|
6335
|
+
async getLatestMigration(): Promise<string>
|
|
6336
|
+
static async latestMigration(): Promise<string>
|
|
6337
|
+
setupMigrations(chain: string, storageName: string, storageIdentityKey: string, maxOutputScriptLength: number): Record<string, Migration>
|
|
6338
|
+
static async dbtype(knex: Knex<any, any[]>): Promise<DBType> {
|
|
6339
|
+
try {
|
|
6340
|
+
const q = `SELECT
|
|
6341
|
+
CASE
|
|
6342
|
+
WHEN (SELECT VERSION() LIKE '%MariaDB%') = 1 THEN 'Unknown'
|
|
6343
|
+
WHEN (SELECT VERSION()) IS NOT NULL THEN 'MySQL'
|
|
6344
|
+
ELSE 'Unknown'
|
|
6345
|
+
END AS database_type;`;
|
|
6346
|
+
let r = await knex.raw(q);
|
|
6347
|
+
if (!r[0]["database_type"])
|
|
6348
|
+
r = r[0];
|
|
6349
|
+
if (r["rows"])
|
|
6350
|
+
r = r.rows;
|
|
6351
|
+
const dbtype: "SQLite" | "MySQL" | "Unknown" = r[0].database_type;
|
|
6352
|
+
if (dbtype === "Unknown")
|
|
6353
|
+
throw new sdk.WERR_NOT_IMPLEMENTED(`Attempting to create database on unsuported engine.`);
|
|
6354
|
+
return dbtype;
|
|
6355
|
+
}
|
|
6356
|
+
catch (eu: unknown) {
|
|
6357
|
+
const e = sdk.WalletError.fromUnknown(eu);
|
|
6358
|
+
if (e.code === "SQLITE_ERROR")
|
|
6359
|
+
return "SQLite";
|
|
6360
|
+
throw new sdk.WERR_NOT_IMPLEMENTED(`Attempting to create database on unsuported engine.`);
|
|
6361
|
+
}
|
|
6362
|
+
}
|
|
6363
|
+
}
|
|
6364
|
+
```
|
|
6365
|
+
|
|
6366
|
+
See also: [Chain](./client.md#type-chain), [DBType](./storage.md#type-dbtype), [WERR_NOT_IMPLEMENTED](./client.md#class-werr_not_implemented), [WalletError](./client.md#class-walleterror)
|
|
6367
|
+
|
|
6368
|
+
###### Constructor
|
|
6369
|
+
|
|
6370
|
+
```ts
|
|
6371
|
+
constructor(public chain: sdk.Chain, public storageName: string, public storageIdentityKey: string, public maxOutputScriptLength: number)
|
|
6372
|
+
```
|
|
6373
|
+
See also: [Chain](./client.md#type-chain)
|
|
6374
|
+
|
|
6375
|
+
Argument Details
|
|
6376
|
+
|
|
6377
|
+
+ **storageName**
|
|
6378
|
+
+ human readable name for this storage instance
|
|
6379
|
+
+ **maxOutputScriptLength**
|
|
6380
|
+
+ limit for scripts kept in outputs table, longer scripts will be pulled from rawTx
|
|
6381
|
+
|
|
6382
|
+
###### Method dbtype
|
|
6383
|
+
|
|
6384
|
+
```ts
|
|
6385
|
+
static async dbtype(knex: Knex<any, any[]>): Promise<DBType>
|
|
6386
|
+
```
|
|
6387
|
+
See also: [DBType](./storage.md#type-dbtype)
|
|
6388
|
+
|
|
6389
|
+
Returns
|
|
6390
|
+
|
|
6391
|
+
connected database engine variant
|
|
6392
|
+
|
|
6393
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6394
|
+
|
|
5872
6395
|
---
|
|
5873
6396
|
##### Class: MergeEntity
|
|
5874
6397
|
|
|
@@ -6024,6 +6547,28 @@ See also: [BlockHeader](./client.md#interface-blockheader)
|
|
|
6024
6547
|
|
|
6025
6548
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6026
6549
|
|
|
6550
|
+
---
|
|
6551
|
+
##### Class: MonitorDaemon
|
|
6552
|
+
|
|
6553
|
+
```ts
|
|
6554
|
+
export class MonitorDaemon {
|
|
6555
|
+
setup?: MonitorDaemonSetup;
|
|
6556
|
+
doneListening?: Promise<void>;
|
|
6557
|
+
doneTasks?: Promise<void>;
|
|
6558
|
+
stopDaemon: boolean = false;
|
|
6559
|
+
constructor(public args: MonitorDaemonSetup, public noRunTasks?: boolean)
|
|
6560
|
+
async createSetup(): Promise<void>
|
|
6561
|
+
async start(): Promise<void>
|
|
6562
|
+
async stop(): Promise<void>
|
|
6563
|
+
async destroy(): Promise<void>
|
|
6564
|
+
async runDaemon(): Promise<void>
|
|
6565
|
+
}
|
|
6566
|
+
```
|
|
6567
|
+
|
|
6568
|
+
See also: [MonitorDaemonSetup](./monitor.md#interface-monitordaemonsetup)
|
|
6569
|
+
|
|
6570
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6571
|
+
|
|
6027
6572
|
---
|
|
6028
6573
|
##### Class: OverlayUMPTokenInteractor
|
|
6029
6574
|
|
|
@@ -6328,7 +6873,454 @@ export class Services implements sdk.WalletServices {
|
|
|
6328
6873
|
}
|
|
6329
6874
|
```
|
|
6330
6875
|
|
|
6331
|
-
See also: [ARC](./services.md#class-arc), [Bitails](./services.md#class-bitails), [BlockHeader](./client.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), [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), [UpdateFiatExchangeRateService](./client.md#type-updatefiatexchangerateservice), [WalletServices](./client.md#interface-walletservices), [WalletServicesOptions](./client.md#interface-walletservicesoptions), [WhatsOnChain](./services.md#class-whatsonchain)
|
|
6876
|
+
See also: [ARC](./services.md#class-arc), [Bitails](./services.md#class-bitails), [BlockHeader](./client.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), [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), [UpdateFiatExchangeRateService](./client.md#type-updatefiatexchangerateservice), [WalletServices](./client.md#interface-walletservices), [WalletServicesOptions](./client.md#interface-walletservicesoptions), [WhatsOnChain](./services.md#class-whatsonchain)
|
|
6877
|
+
|
|
6878
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6879
|
+
|
|
6880
|
+
---
|
|
6881
|
+
##### Class: Setup
|
|
6882
|
+
|
|
6883
|
+
The 'Setup` class provides static setup functions to construct BRC-100 compatible
|
|
6884
|
+
wallets in a variety of configurations.
|
|
6885
|
+
|
|
6886
|
+
It serves as a starting point for experimentation and customization.
|
|
6887
|
+
|
|
6888
|
+
```ts
|
|
6889
|
+
export abstract class Setup {
|
|
6890
|
+
static noEnv(chain: sdk.Chain): boolean
|
|
6891
|
+
static makeEnv(): string {
|
|
6892
|
+
const testPrivKey1 = PrivateKey.fromRandom();
|
|
6893
|
+
const testIdentityKey1 = testPrivKey1.toPublicKey().toString();
|
|
6894
|
+
const testPrivKey2 = PrivateKey.fromRandom();
|
|
6895
|
+
const testIdentityKey2 = testPrivKey2.toPublicKey().toString();
|
|
6896
|
+
const mainPrivKey1 = PrivateKey.fromRandom();
|
|
6897
|
+
const mainIdentityKey1 = mainPrivKey1.toPublicKey().toString();
|
|
6898
|
+
const mainPrivKey2 = PrivateKey.fromRandom();
|
|
6899
|
+
const mainIdentityKey2 = mainPrivKey2.toPublicKey().toString();
|
|
6900
|
+
const log = `
|
|
6901
|
+
# .env file template for working with wallet-toolbox Setup functions.
|
|
6902
|
+
MY_TEST_IDENTITY = '${testIdentityKey1}'
|
|
6903
|
+
MY_TEST_IDENTITY2 = '${testIdentityKey2}'
|
|
6904
|
+
MY_MAIN_IDENTITY = '${mainIdentityKey1}'
|
|
6905
|
+
MY_MAIN_IDENTITY2 = '${mainIdentityKey2}'
|
|
6906
|
+
MAIN_TAAL_API_KEY='mainnet_9596de07e92300c6287e4393594ae39c'
|
|
6907
|
+
TEST_TAAL_API_KEY='testnet_0e6cf72133b43ea2d7861da2a38684e3'
|
|
6908
|
+
MYSQL_CONNECTION='{"port":3306,"host":"127.0.0.1","user":"root","password":"your_password","database":"your_database", "timezone": "Z"}'
|
|
6909
|
+
DEV_KEYS = '{
|
|
6910
|
+
"${testIdentityKey1}": "${testPrivKey1.toString()}",
|
|
6911
|
+
"${testIdentityKey2}": "${testPrivKey2.toString()}",
|
|
6912
|
+
"${mainIdentityKey1}": "${mainPrivKey1.toString()}",
|
|
6913
|
+
"${mainIdentityKey2}": "${mainPrivKey2.toString()}"
|
|
6914
|
+
}'
|
|
6915
|
+
`;
|
|
6916
|
+
console.log(log);
|
|
6917
|
+
return log;
|
|
6918
|
+
}
|
|
6919
|
+
static getEnv(chain: sdk.Chain): SetupEnv {
|
|
6920
|
+
const identityKey = chain === "main" ? process.env.MY_MAIN_IDENTITY : process.env.MY_TEST_IDENTITY;
|
|
6921
|
+
const identityKey2 = chain === "main" ? process.env.MY_MAIN_IDENTITY2 : process.env.MY_TEST_IDENTITY2;
|
|
6922
|
+
const filePath = chain === "main" ? process.env.MY_MAIN_FILEPATH : process.env.MY_TEST_FILEPATH;
|
|
6923
|
+
const DEV_KEYS = process.env.DEV_KEYS || "{}";
|
|
6924
|
+
const mySQLConnection = process.env.MYSQL_CONNECTION || "{}";
|
|
6925
|
+
const taalApiKey = verifyTruthy(chain === "main" ? process.env.MAIN_TAAL_API_KEY : process.env.TEST_TAAL_API_KEY, `.env value for '${chain.toUpperCase()}_TAAL_API_KEY' is required.`);
|
|
6926
|
+
if (!identityKey || !identityKey2)
|
|
6927
|
+
throw new sdk.WERR_INVALID_OPERATION(".env is not a valid SetupEnv configuration.");
|
|
6928
|
+
return {
|
|
6929
|
+
chain,
|
|
6930
|
+
identityKey,
|
|
6931
|
+
identityKey2,
|
|
6932
|
+
filePath,
|
|
6933
|
+
taalApiKey,
|
|
6934
|
+
devKeys: JSON.parse(DEV_KEYS) as Record<string, string>,
|
|
6935
|
+
mySQLConnection
|
|
6936
|
+
};
|
|
6937
|
+
}
|
|
6938
|
+
static async createWallet(args: SetupWalletArgs): Promise<SetupWallet> {
|
|
6939
|
+
const chain = args.env.chain;
|
|
6940
|
+
args.rootKeyHex ||= args.env.devKeys[args.env.identityKey];
|
|
6941
|
+
const rootKey = PrivateKey.fromHex(args.rootKeyHex);
|
|
6942
|
+
const identityKey = rootKey.toPublicKey().toString();
|
|
6943
|
+
const keyDeriver = new KeyDeriver(rootKey);
|
|
6944
|
+
const storage = new WalletStorageManager(identityKey, args.active, args.backups);
|
|
6945
|
+
if (storage.canMakeAvailable())
|
|
6946
|
+
await storage.makeAvailable();
|
|
6947
|
+
const serviceOptions = Services.createDefaultOptions(chain);
|
|
6948
|
+
serviceOptions.taalApiKey = args.env.taalApiKey;
|
|
6949
|
+
const services = new Services(serviceOptions);
|
|
6950
|
+
const monopts = Monitor.createDefaultWalletMonitorOptions(chain, storage, services);
|
|
6951
|
+
const monitor = new Monitor(monopts);
|
|
6952
|
+
monitor.addDefaultTasks();
|
|
6953
|
+
const privilegedKeyManager = args.privilegedKeyGetter
|
|
6954
|
+
? new sdk.PrivilegedKeyManager(args.privilegedKeyGetter)
|
|
6955
|
+
: undefined;
|
|
6956
|
+
const wallet = new Wallet({
|
|
6957
|
+
chain,
|
|
6958
|
+
keyDeriver,
|
|
6959
|
+
storage,
|
|
6960
|
+
services,
|
|
6961
|
+
monitor,
|
|
6962
|
+
privilegedKeyManager
|
|
6963
|
+
});
|
|
6964
|
+
const r: SetupWallet = {
|
|
6965
|
+
rootKey,
|
|
6966
|
+
identityKey,
|
|
6967
|
+
keyDeriver,
|
|
6968
|
+
chain,
|
|
6969
|
+
storage,
|
|
6970
|
+
services,
|
|
6971
|
+
monitor,
|
|
6972
|
+
wallet
|
|
6973
|
+
};
|
|
6974
|
+
return r;
|
|
6975
|
+
}
|
|
6976
|
+
static async createWalletClientNoEnv(args: {
|
|
6977
|
+
chain: sdk.Chain;
|
|
6978
|
+
rootKeyHex: string;
|
|
6979
|
+
storageUrl?: string;
|
|
6980
|
+
privilegedKeyGetter?: () => Promise<PrivateKey>;
|
|
6981
|
+
}): Promise<Wallet>
|
|
6982
|
+
static async createWalletClient(args: SetupWalletClientArgs): Promise<SetupWalletClient> {
|
|
6983
|
+
const wo = await Setup.createWallet(args);
|
|
6984
|
+
const endpointUrl = args.endpointUrl || `https://${args.env.chain !== "main" ? "staging-" : ""}storage.babbage.systems`;
|
|
6985
|
+
const client = new StorageClient(wo.wallet, endpointUrl);
|
|
6986
|
+
await wo.storage.addWalletStorageProvider(client);
|
|
6987
|
+
await wo.storage.makeAvailable();
|
|
6988
|
+
return {
|
|
6989
|
+
...wo,
|
|
6990
|
+
endpointUrl
|
|
6991
|
+
};
|
|
6992
|
+
}
|
|
6993
|
+
static getKeyPair(priv?: string | PrivateKey): KeyPairAddress {
|
|
6994
|
+
if (priv === undefined)
|
|
6995
|
+
priv = PrivateKey.fromRandom();
|
|
6996
|
+
else if (typeof priv === "string")
|
|
6997
|
+
priv = new PrivateKey(priv, "hex");
|
|
6998
|
+
const pub = PublicKey.fromPrivateKey(priv);
|
|
6999
|
+
const address = pub.toAddress();
|
|
7000
|
+
return { privateKey: priv, publicKey: pub, address };
|
|
7001
|
+
}
|
|
7002
|
+
static getLockP2PKH(address: string): LockingScript {
|
|
7003
|
+
const p2pkh = new P2PKH();
|
|
7004
|
+
const lock = p2pkh.lock(address);
|
|
7005
|
+
return lock;
|
|
7006
|
+
}
|
|
7007
|
+
static getUnlockP2PKH(priv: PrivateKey, satoshis: number): sdk.ScriptTemplateUnlock {
|
|
7008
|
+
const p2pkh = new P2PKH();
|
|
7009
|
+
const lock = Setup.getLockP2PKH(Setup.getKeyPair(priv).address);
|
|
7010
|
+
const unlock = p2pkh.unlock(priv, "all", false, satoshis, lock);
|
|
7011
|
+
return unlock;
|
|
7012
|
+
}
|
|
7013
|
+
static createP2PKHOutputs(outputs: {
|
|
7014
|
+
address: string;
|
|
7015
|
+
satoshis: number;
|
|
7016
|
+
outputDescription?: string;
|
|
7017
|
+
basket?: string;
|
|
7018
|
+
tags?: string[];
|
|
7019
|
+
}[]): CreateActionOutput[] {
|
|
7020
|
+
const os: CreateActionOutput[] = [];
|
|
7021
|
+
const count = outputs.length;
|
|
7022
|
+
for (let i = 0; i < count; i++) {
|
|
7023
|
+
const o = outputs[i];
|
|
7024
|
+
os.push({
|
|
7025
|
+
basket: o.basket,
|
|
7026
|
+
tags: o.tags,
|
|
7027
|
+
satoshis: o.satoshis,
|
|
7028
|
+
lockingScript: Setup.getLockP2PKH(o.address).toHex(),
|
|
7029
|
+
outputDescription: o.outputDescription || `p2pkh ${i}`
|
|
7030
|
+
});
|
|
7031
|
+
}
|
|
7032
|
+
return os;
|
|
7033
|
+
}
|
|
7034
|
+
static async createP2PKHOutputsAction(wallet: WalletInterface, outputs: {
|
|
7035
|
+
address: string;
|
|
7036
|
+
satoshis: number;
|
|
7037
|
+
outputDescription?: string;
|
|
7038
|
+
basket?: string;
|
|
7039
|
+
tags?: string[];
|
|
7040
|
+
}[], options?: CreateActionOptions): Promise<{
|
|
7041
|
+
cr: CreateActionResult;
|
|
7042
|
+
outpoints: string[] | undefined;
|
|
7043
|
+
}> {
|
|
7044
|
+
const os = Setup.createP2PKHOutputs(outputs);
|
|
7045
|
+
const createArgs: CreateActionArgs = {
|
|
7046
|
+
description: `createP2PKHOutputs`,
|
|
7047
|
+
outputs: os,
|
|
7048
|
+
options: {
|
|
7049
|
+
...options,
|
|
7050
|
+
randomizeOutputs: false
|
|
7051
|
+
}
|
|
7052
|
+
};
|
|
7053
|
+
const cr = await wallet.createAction(createArgs);
|
|
7054
|
+
let outpoints: string[] | undefined;
|
|
7055
|
+
if (cr.txid) {
|
|
7056
|
+
outpoints = os.map((o, i) => `${cr.txid}.${i}`);
|
|
7057
|
+
}
|
|
7058
|
+
return { cr, outpoints };
|
|
7059
|
+
}
|
|
7060
|
+
static async fundWalletFromP2PKHOutpoints(wallet: WalletInterface, outpoints: string[], p2pkhKey: KeyPairAddress, inputBEEF?: BEEF) {
|
|
7061
|
+
}
|
|
7062
|
+
static async createWalletKnex(args: SetupWalletKnexArgs): Promise<SetupWalletKnex> {
|
|
7063
|
+
const wo = await Setup.createWallet(args);
|
|
7064
|
+
const activeStorage = await Setup.createStorageKnex(args);
|
|
7065
|
+
await wo.storage.addWalletStorageProvider(activeStorage);
|
|
7066
|
+
const { user, isNew } = await activeStorage.findOrInsertUser(wo.identityKey);
|
|
7067
|
+
const userId = user.userId;
|
|
7068
|
+
const r: SetupWalletKnex = {
|
|
7069
|
+
...wo,
|
|
7070
|
+
activeStorage,
|
|
7071
|
+
userId
|
|
7072
|
+
};
|
|
7073
|
+
return r;
|
|
7074
|
+
}
|
|
7075
|
+
static async createStorageKnex(args: SetupWalletKnexArgs): Promise<StorageKnex>
|
|
7076
|
+
static createSQLiteKnex(filename: string): Knex {
|
|
7077
|
+
const config: Knex.Config = {
|
|
7078
|
+
client: "sqlite3",
|
|
7079
|
+
connection: { filename },
|
|
7080
|
+
useNullAsDefault: true
|
|
7081
|
+
};
|
|
7082
|
+
const knex = makeKnex(config);
|
|
7083
|
+
return knex;
|
|
7084
|
+
}
|
|
7085
|
+
static createMySQLKnex(connection: string, database?: string): Knex {
|
|
7086
|
+
const c: Knex.MySql2ConnectionConfig = JSON.parse(connection);
|
|
7087
|
+
if (database) {
|
|
7088
|
+
c.database = database;
|
|
7089
|
+
}
|
|
7090
|
+
const config: Knex.Config = {
|
|
7091
|
+
client: "mysql2",
|
|
7092
|
+
connection: c,
|
|
7093
|
+
useNullAsDefault: true,
|
|
7094
|
+
pool: { min: 0, max: 7, idleTimeoutMillis: 15000 }
|
|
7095
|
+
};
|
|
7096
|
+
const knex = makeKnex(config);
|
|
7097
|
+
return knex;
|
|
7098
|
+
}
|
|
7099
|
+
static async createWalletMySQL(args: SetupWalletMySQLArgs): Promise<SetupWalletKnex> {
|
|
7100
|
+
return await this.createWalletKnex({
|
|
7101
|
+
...args,
|
|
7102
|
+
knex: Setup.createMySQLKnex(args.env.mySQLConnection, args.databaseName)
|
|
7103
|
+
});
|
|
7104
|
+
}
|
|
7105
|
+
static async createWalletSQLite(args: SetupWalletSQLiteArgs): Promise<SetupWalletKnex> {
|
|
7106
|
+
return await this.createWalletKnex({
|
|
7107
|
+
...args,
|
|
7108
|
+
knex: Setup.createSQLiteKnex(args.filePath)
|
|
7109
|
+
});
|
|
7110
|
+
}
|
|
7111
|
+
}
|
|
7112
|
+
```
|
|
7113
|
+
|
|
7114
|
+
See also: [Chain](./client.md#type-chain), [KeyPairAddress](./setup.md#interface-keypairaddress), [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [ScriptTemplateUnlock](./client.md#interface-scripttemplateunlock), [Services](./services.md#class-services), [SetupEnv](./setup.md#interface-setupenv), [SetupWallet](./setup.md#interface-setupwallet), [SetupWalletArgs](./setup.md#interface-setupwalletargs), [SetupWalletClient](./setup.md#interface-setupwalletclient), [SetupWalletClientArgs](./setup.md#interface-setupwalletclientargs), [SetupWalletKnex](./setup.md#interface-setupwalletknex), [SetupWalletKnexArgs](./setup.md#interface-setupwalletknexargs), [SetupWalletMySQLArgs](./setup.md#interface-setupwalletmysqlargs), [SetupWalletSQLiteArgs](./setup.md#interface-setupwalletsqliteargs), [StorageClient](./storage.md#class-storageclient), [StorageKnex](./storage.md#class-storageknex), [WERR_INVALID_OPERATION](./client.md#class-werr_invalid_operation), [Wallet](./client.md#class-wallet), [WalletStorageManager](./storage.md#class-walletstoragemanager), [createAction](./storage.md#function-createaction), [verifyTruthy](./client.md#function-verifytruthy)
|
|
7115
|
+
|
|
7116
|
+
###### Method createStorageKnex
|
|
7117
|
+
|
|
7118
|
+
```ts
|
|
7119
|
+
static async createStorageKnex(args: SetupWalletKnexArgs): Promise<StorageKnex>
|
|
7120
|
+
```
|
|
7121
|
+
See also: [SetupWalletKnexArgs](./setup.md#interface-setupwalletknexargs), [StorageKnex](./storage.md#class-storageknex)
|
|
7122
|
+
|
|
7123
|
+
Returns
|
|
7124
|
+
|
|
7125
|
+
- `Knex` based storage provider for a wallet. May be used for either active storage or backup storage.
|
|
7126
|
+
|
|
7127
|
+
###### Method createWallet
|
|
7128
|
+
|
|
7129
|
+
Create a `Wallet`. Storage can optionally be provided or configured later.
|
|
7130
|
+
|
|
7131
|
+
The following components are configured: KeyDeriver, WalletStorageManager, WalletService, WalletStorage.
|
|
7132
|
+
Optionally, PrivilegedKeyManager is also configured.
|
|
7133
|
+
|
|
7134
|
+
```ts
|
|
7135
|
+
static async createWallet(args: SetupWalletArgs): Promise<SetupWallet> {
|
|
7136
|
+
const chain = args.env.chain;
|
|
7137
|
+
args.rootKeyHex ||= args.env.devKeys[args.env.identityKey];
|
|
7138
|
+
const rootKey = PrivateKey.fromHex(args.rootKeyHex);
|
|
7139
|
+
const identityKey = rootKey.toPublicKey().toString();
|
|
7140
|
+
const keyDeriver = new KeyDeriver(rootKey);
|
|
7141
|
+
const storage = new WalletStorageManager(identityKey, args.active, args.backups);
|
|
7142
|
+
if (storage.canMakeAvailable())
|
|
7143
|
+
await storage.makeAvailable();
|
|
7144
|
+
const serviceOptions = Services.createDefaultOptions(chain);
|
|
7145
|
+
serviceOptions.taalApiKey = args.env.taalApiKey;
|
|
7146
|
+
const services = new Services(serviceOptions);
|
|
7147
|
+
const monopts = Monitor.createDefaultWalletMonitorOptions(chain, storage, services);
|
|
7148
|
+
const monitor = new Monitor(monopts);
|
|
7149
|
+
monitor.addDefaultTasks();
|
|
7150
|
+
const privilegedKeyManager = args.privilegedKeyGetter
|
|
7151
|
+
? new sdk.PrivilegedKeyManager(args.privilegedKeyGetter)
|
|
7152
|
+
: undefined;
|
|
7153
|
+
const wallet = new Wallet({
|
|
7154
|
+
chain,
|
|
7155
|
+
keyDeriver,
|
|
7156
|
+
storage,
|
|
7157
|
+
services,
|
|
7158
|
+
monitor,
|
|
7159
|
+
privilegedKeyManager
|
|
7160
|
+
});
|
|
7161
|
+
const r: SetupWallet = {
|
|
7162
|
+
rootKey,
|
|
7163
|
+
identityKey,
|
|
7164
|
+
keyDeriver,
|
|
7165
|
+
chain,
|
|
7166
|
+
storage,
|
|
7167
|
+
services,
|
|
7168
|
+
monitor,
|
|
7169
|
+
wallet
|
|
7170
|
+
};
|
|
7171
|
+
return r;
|
|
7172
|
+
}
|
|
7173
|
+
```
|
|
7174
|
+
See also: [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [Services](./services.md#class-services), [SetupWallet](./setup.md#interface-setupwallet), [SetupWalletArgs](./setup.md#interface-setupwalletargs), [Wallet](./client.md#class-wallet), [WalletStorageManager](./storage.md#class-walletstoragemanager)
|
|
7175
|
+
|
|
7176
|
+
###### Method createWalletClientNoEnv
|
|
7177
|
+
|
|
7178
|
+
Setup a new `Wallet` without requiring a .env file.
|
|
7179
|
+
|
|
7180
|
+
```ts
|
|
7181
|
+
static async createWalletClientNoEnv(args: {
|
|
7182
|
+
chain: sdk.Chain;
|
|
7183
|
+
rootKeyHex: string;
|
|
7184
|
+
storageUrl?: string;
|
|
7185
|
+
privilegedKeyGetter?: () => Promise<PrivateKey>;
|
|
7186
|
+
}): Promise<Wallet>
|
|
7187
|
+
```
|
|
7188
|
+
See also: [Chain](./client.md#type-chain), [Wallet](./client.md#class-wallet)
|
|
7189
|
+
|
|
7190
|
+
Argument Details
|
|
7191
|
+
|
|
7192
|
+
+ **args.chain**
|
|
7193
|
+
+ 'main' or 'test'
|
|
7194
|
+
+ **args.rootKeyHex**
|
|
7195
|
+
+ Root private key for wallet's key deriver.
|
|
7196
|
+
+ **args.storageUrl**
|
|
7197
|
+
+ Optional. `StorageClient` and `chain` compatible endpoint URL.
|
|
7198
|
+
+ **args.privilegedKeyGetter**
|
|
7199
|
+
+ Optional. Method that will return the privileged `PrivateKey`, on demand.
|
|
7200
|
+
|
|
7201
|
+
###### Method createWalletKnex
|
|
7202
|
+
|
|
7203
|
+
Adds `Knex` based storage to a `Wallet` configured by `Setup.createWalletOnly`
|
|
7204
|
+
|
|
7205
|
+
```ts
|
|
7206
|
+
static async createWalletKnex(args: SetupWalletKnexArgs): Promise<SetupWalletKnex> {
|
|
7207
|
+
const wo = await Setup.createWallet(args);
|
|
7208
|
+
const activeStorage = await Setup.createStorageKnex(args);
|
|
7209
|
+
await wo.storage.addWalletStorageProvider(activeStorage);
|
|
7210
|
+
const { user, isNew } = await activeStorage.findOrInsertUser(wo.identityKey);
|
|
7211
|
+
const userId = user.userId;
|
|
7212
|
+
const r: SetupWalletKnex = {
|
|
7213
|
+
...wo,
|
|
7214
|
+
activeStorage,
|
|
7215
|
+
userId
|
|
7216
|
+
};
|
|
7217
|
+
return r;
|
|
7218
|
+
}
|
|
7219
|
+
```
|
|
7220
|
+
See also: [Setup](./setup.md#class-setup), [SetupWalletKnex](./setup.md#interface-setupwalletknex), [SetupWalletKnexArgs](./setup.md#interface-setupwalletknexargs)
|
|
7221
|
+
|
|
7222
|
+
Argument Details
|
|
7223
|
+
|
|
7224
|
+
+ **args.knex**
|
|
7225
|
+
+ `Knex` object configured for either MySQL or SQLite database access.
|
|
7226
|
+
Schema will be created and migrated as needed.
|
|
7227
|
+
For MySQL, a schema corresponding to databaseName must exist with full access permissions.
|
|
7228
|
+
+ **args.databaseName**
|
|
7229
|
+
+ Name for this storage. For MySQL, the schema name within the MySQL instance.
|
|
7230
|
+
+ **args.chain**
|
|
7231
|
+
+ Which chain this wallet is on: 'main' or 'test'. Defaults to 'test'.
|
|
7232
|
+
|
|
7233
|
+
###### Method getEnv
|
|
7234
|
+
|
|
7235
|
+
Reads a .env file of the format created by `makeEnv`.
|
|
7236
|
+
|
|
7237
|
+
Returns values for designated `chain`.
|
|
7238
|
+
|
|
7239
|
+
Access private keys through the `devKeys` object: `devKeys[identityKey]`
|
|
7240
|
+
|
|
7241
|
+
```ts
|
|
7242
|
+
static getEnv(chain: sdk.Chain): SetupEnv {
|
|
7243
|
+
const identityKey = chain === "main" ? process.env.MY_MAIN_IDENTITY : process.env.MY_TEST_IDENTITY;
|
|
7244
|
+
const identityKey2 = chain === "main" ? process.env.MY_MAIN_IDENTITY2 : process.env.MY_TEST_IDENTITY2;
|
|
7245
|
+
const filePath = chain === "main" ? process.env.MY_MAIN_FILEPATH : process.env.MY_TEST_FILEPATH;
|
|
7246
|
+
const DEV_KEYS = process.env.DEV_KEYS || "{}";
|
|
7247
|
+
const mySQLConnection = process.env.MYSQL_CONNECTION || "{}";
|
|
7248
|
+
const taalApiKey = verifyTruthy(chain === "main" ? process.env.MAIN_TAAL_API_KEY : process.env.TEST_TAAL_API_KEY, `.env value for '${chain.toUpperCase()}_TAAL_API_KEY' is required.`);
|
|
7249
|
+
if (!identityKey || !identityKey2)
|
|
7250
|
+
throw new sdk.WERR_INVALID_OPERATION(".env is not a valid SetupEnv configuration.");
|
|
7251
|
+
return {
|
|
7252
|
+
chain,
|
|
7253
|
+
identityKey,
|
|
7254
|
+
identityKey2,
|
|
7255
|
+
filePath,
|
|
7256
|
+
taalApiKey,
|
|
7257
|
+
devKeys: JSON.parse(DEV_KEYS) as Record<string, string>,
|
|
7258
|
+
mySQLConnection
|
|
7259
|
+
};
|
|
7260
|
+
}
|
|
7261
|
+
```
|
|
7262
|
+
See also: [Chain](./client.md#type-chain), [SetupEnv](./setup.md#interface-setupenv), [WERR_INVALID_OPERATION](./client.md#class-werr_invalid_operation), [verifyTruthy](./client.md#function-verifytruthy)
|
|
7263
|
+
|
|
7264
|
+
Returns
|
|
7265
|
+
|
|
7266
|
+
with configuration environment secrets used by `Setup` functions.
|
|
7267
|
+
|
|
7268
|
+
Argument Details
|
|
7269
|
+
|
|
7270
|
+
+ **chain**
|
|
7271
|
+
+ Which chain to use: 'test' or 'main'
|
|
7272
|
+
|
|
7273
|
+
###### Method makeEnv
|
|
7274
|
+
|
|
7275
|
+
Creates content for .env file with some private keys, identity keys, sample API keys, and sample MySQL connection string.
|
|
7276
|
+
|
|
7277
|
+
Two new, random private keys are generated each time, with their associated public identity keys.
|
|
7278
|
+
|
|
7279
|
+
Loading secrets from a .env file is intended only for experimentation and getting started.
|
|
7280
|
+
Private keys should never be included directly in your source code.
|
|
7281
|
+
|
|
7282
|
+
```ts
|
|
7283
|
+
static makeEnv(): string {
|
|
7284
|
+
const testPrivKey1 = PrivateKey.fromRandom();
|
|
7285
|
+
const testIdentityKey1 = testPrivKey1.toPublicKey().toString();
|
|
7286
|
+
const testPrivKey2 = PrivateKey.fromRandom();
|
|
7287
|
+
const testIdentityKey2 = testPrivKey2.toPublicKey().toString();
|
|
7288
|
+
const mainPrivKey1 = PrivateKey.fromRandom();
|
|
7289
|
+
const mainIdentityKey1 = mainPrivKey1.toPublicKey().toString();
|
|
7290
|
+
const mainPrivKey2 = PrivateKey.fromRandom();
|
|
7291
|
+
const mainIdentityKey2 = mainPrivKey2.toPublicKey().toString();
|
|
7292
|
+
const log = `
|
|
7293
|
+
# .env file template for working with wallet-toolbox Setup functions.
|
|
7294
|
+
MY_TEST_IDENTITY = '${testIdentityKey1}'
|
|
7295
|
+
MY_TEST_IDENTITY2 = '${testIdentityKey2}'
|
|
7296
|
+
MY_MAIN_IDENTITY = '${mainIdentityKey1}'
|
|
7297
|
+
MY_MAIN_IDENTITY2 = '${mainIdentityKey2}'
|
|
7298
|
+
MAIN_TAAL_API_KEY='mainnet_9596de07e92300c6287e4393594ae39c'
|
|
7299
|
+
TEST_TAAL_API_KEY='testnet_0e6cf72133b43ea2d7861da2a38684e3'
|
|
7300
|
+
MYSQL_CONNECTION='{"port":3306,"host":"127.0.0.1","user":"root","password":"your_password","database":"your_database", "timezone": "Z"}'
|
|
7301
|
+
DEV_KEYS = '{
|
|
7302
|
+
"${testIdentityKey1}": "${testPrivKey1.toString()}",
|
|
7303
|
+
"${testIdentityKey2}": "${testPrivKey2.toString()}",
|
|
7304
|
+
"${mainIdentityKey1}": "${mainPrivKey1.toString()}",
|
|
7305
|
+
"${mainIdentityKey2}": "${mainPrivKey2.toString()}"
|
|
7306
|
+
}'
|
|
7307
|
+
`;
|
|
7308
|
+
console.log(log);
|
|
7309
|
+
return log;
|
|
7310
|
+
}
|
|
7311
|
+
```
|
|
7312
|
+
See also: [Setup](./setup.md#class-setup)
|
|
7313
|
+
|
|
7314
|
+
###### Method noEnv
|
|
7315
|
+
|
|
7316
|
+
```ts
|
|
7317
|
+
static noEnv(chain: sdk.Chain): boolean
|
|
7318
|
+
```
|
|
7319
|
+
See also: [Chain](./client.md#type-chain)
|
|
7320
|
+
|
|
7321
|
+
Returns
|
|
7322
|
+
|
|
7323
|
+
true if .env is not valid for chain
|
|
6332
7324
|
|
|
6333
7325
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6334
7326
|
|
|
@@ -7180,6 +8172,307 @@ See also: [EntityTimeStamp](./client.md#interface-entitytimestamp)
|
|
|
7180
8172
|
|
|
7181
8173
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7182
8174
|
|
|
8175
|
+
---
|
|
8176
|
+
##### Class: StorageKnex
|
|
8177
|
+
|
|
8178
|
+
```ts
|
|
8179
|
+
export class StorageKnex extends StorageProvider implements sdk.WalletStorageProvider {
|
|
8180
|
+
knex: Knex;
|
|
8181
|
+
constructor(options: StorageKnexOptions)
|
|
8182
|
+
async readSettings(): Promise<TableSettings>
|
|
8183
|
+
override async getProvenOrRawTx(txid: string, trx?: sdk.TrxToken): Promise<sdk.ProvenOrRawTx>
|
|
8184
|
+
dbTypeSubstring(source: string, fromOffset: number, forLength?: number)
|
|
8185
|
+
override async getRawTxOfKnownValidTransaction(txid?: string, offset?: number, length?: number, trx?: sdk.TrxToken): Promise<number[] | undefined>
|
|
8186
|
+
getProvenTxsForUserQuery(args: sdk.FindForUserSincePagedArgs): Knex.QueryBuilder
|
|
8187
|
+
override async getProvenTxsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableProvenTx[]>
|
|
8188
|
+
getProvenTxReqsForUserQuery(args: sdk.FindForUserSincePagedArgs): Knex.QueryBuilder
|
|
8189
|
+
override async getProvenTxReqsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableProvenTxReq[]>
|
|
8190
|
+
getTxLabelMapsForUserQuery(args: sdk.FindForUserSincePagedArgs): Knex.QueryBuilder
|
|
8191
|
+
override async getTxLabelMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableTxLabelMap[]>
|
|
8192
|
+
getOutputTagMapsForUserQuery(args: sdk.FindForUserSincePagedArgs): Knex.QueryBuilder
|
|
8193
|
+
override async getOutputTagMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableOutputTagMap[]>
|
|
8194
|
+
override async listActions(auth: sdk.AuthId, vargs: sdk.ValidListActionsArgs): Promise<ListActionsResult>
|
|
8195
|
+
override async listOutputs(auth: sdk.AuthId, vargs: sdk.ValidListOutputsArgs): Promise<ListOutputsResult>
|
|
8196
|
+
override async insertProvenTx(tx: TableProvenTx, trx?: sdk.TrxToken): Promise<number>
|
|
8197
|
+
override async insertProvenTxReq(tx: TableProvenTxReq, trx?: sdk.TrxToken): Promise<number>
|
|
8198
|
+
override async insertUser(user: TableUser, trx?: sdk.TrxToken): Promise<number>
|
|
8199
|
+
override async insertCertificateAuth(auth: sdk.AuthId, certificate: TableCertificateX): Promise<number>
|
|
8200
|
+
override async insertCertificate(certificate: TableCertificateX, trx?: sdk.TrxToken): Promise<number>
|
|
8201
|
+
override async insertCertificateField(certificateField: TableCertificateField, trx?: sdk.TrxToken): Promise<void>
|
|
8202
|
+
override async insertOutputBasket(basket: TableOutputBasket, trx?: sdk.TrxToken): Promise<number>
|
|
8203
|
+
override async insertTransaction(tx: TableTransaction, trx?: sdk.TrxToken): Promise<number>
|
|
8204
|
+
override async insertCommission(commission: TableCommission, trx?: sdk.TrxToken): Promise<number>
|
|
8205
|
+
override async insertOutput(output: TableOutput, trx?: sdk.TrxToken): Promise<number>
|
|
8206
|
+
override async insertOutputTag(tag: TableOutputTag, trx?: sdk.TrxToken): Promise<number>
|
|
8207
|
+
override async insertOutputTagMap(tagMap: TableOutputTagMap, trx?: sdk.TrxToken): Promise<void>
|
|
8208
|
+
override async insertTxLabel(label: TableTxLabel, trx?: sdk.TrxToken): Promise<number>
|
|
8209
|
+
override async insertTxLabelMap(labelMap: TableTxLabelMap, trx?: sdk.TrxToken): Promise<void>
|
|
8210
|
+
override async insertMonitorEvent(event: TableMonitorEvent, trx?: sdk.TrxToken): Promise<number>
|
|
8211
|
+
override async insertSyncState(syncState: TableSyncState, trx?: sdk.TrxToken): Promise<number>
|
|
8212
|
+
override async updateCertificateField(certificateId: number, fieldName: string, update: Partial<TableCertificateField>, trx?: sdk.TrxToken): Promise<number>
|
|
8213
|
+
override async updateCertificate(id: number, update: Partial<TableCertificate>, trx?: sdk.TrxToken): Promise<number>
|
|
8214
|
+
override async updateCommission(id: number, update: Partial<TableCommission>, trx?: sdk.TrxToken): Promise<number>
|
|
8215
|
+
override async updateOutputBasket(id: number, update: Partial<TableOutputBasket>, trx?: sdk.TrxToken): Promise<number>
|
|
8216
|
+
override async updateOutput(id: number, update: Partial<TableOutput>, trx?: sdk.TrxToken): Promise<number>
|
|
8217
|
+
override async updateOutputTagMap(outputId: number, tagId: number, update: Partial<TableOutputTagMap>, trx?: sdk.TrxToken): Promise<number>
|
|
8218
|
+
override async updateOutputTag(id: number, update: Partial<TableOutputTag>, trx?: sdk.TrxToken): Promise<number>
|
|
8219
|
+
override async updateProvenTxReq(id: number | number[], update: Partial<TableProvenTxReq>, trx?: sdk.TrxToken): Promise<number>
|
|
8220
|
+
override async updateProvenTx(id: number, update: Partial<TableProvenTx>, trx?: sdk.TrxToken): Promise<number>
|
|
8221
|
+
override async updateSyncState(id: number, update: Partial<TableSyncState>, trx?: sdk.TrxToken): Promise<number>
|
|
8222
|
+
override async updateTransaction(id: number | number[], update: Partial<TableTransaction>, trx?: sdk.TrxToken): Promise<number>
|
|
8223
|
+
override async updateTxLabelMap(transactionId: number, txLabelId: number, update: Partial<TableTxLabelMap>, trx?: sdk.TrxToken): Promise<number>
|
|
8224
|
+
override async updateTxLabel(id: number, update: Partial<TableTxLabel>, trx?: sdk.TrxToken): Promise<number>
|
|
8225
|
+
override async updateUser(id: number, update: Partial<TableUser>, trx?: sdk.TrxToken): Promise<number>
|
|
8226
|
+
override async updateMonitorEvent(id: number, update: Partial<TableMonitorEvent>, trx?: sdk.TrxToken): Promise<number>
|
|
8227
|
+
setupQuery<T extends object>(table: string, args: sdk.FindPartialSincePagedArgs<T>): Knex.QueryBuilder
|
|
8228
|
+
findCertificateFieldsQuery(args: sdk.FindCertificateFieldsArgs): Knex.QueryBuilder
|
|
8229
|
+
findCertificatesQuery(args: sdk.FindCertificatesArgs): Knex.QueryBuilder
|
|
8230
|
+
findCommissionsQuery(args: sdk.FindCommissionsArgs): Knex.QueryBuilder
|
|
8231
|
+
findOutputBasketsQuery(args: sdk.FindOutputBasketsArgs): Knex.QueryBuilder
|
|
8232
|
+
findOutputsQuery(args: sdk.FindOutputsArgs, count?: boolean): Knex.QueryBuilder
|
|
8233
|
+
findOutputTagMapsQuery(args: sdk.FindOutputTagMapsArgs): Knex.QueryBuilder
|
|
8234
|
+
findOutputTagsQuery(args: sdk.FindOutputTagsArgs): Knex.QueryBuilder
|
|
8235
|
+
findProvenTxReqsQuery(args: sdk.FindProvenTxReqsArgs): Knex.QueryBuilder
|
|
8236
|
+
findProvenTxsQuery(args: sdk.FindProvenTxsArgs): Knex.QueryBuilder
|
|
8237
|
+
findSyncStatesQuery(args: sdk.FindSyncStatesArgs): Knex.QueryBuilder
|
|
8238
|
+
findTransactionsQuery(args: sdk.FindTransactionsArgs, count?: boolean): Knex.QueryBuilder
|
|
8239
|
+
findTxLabelMapsQuery(args: sdk.FindTxLabelMapsArgs): Knex.QueryBuilder
|
|
8240
|
+
findTxLabelsQuery(args: sdk.FindTxLabelsArgs): Knex.QueryBuilder
|
|
8241
|
+
findUsersQuery(args: sdk.FindUsersArgs): Knex.QueryBuilder
|
|
8242
|
+
findMonitorEventsQuery(args: sdk.FindMonitorEventsArgs): Knex.QueryBuilder
|
|
8243
|
+
override async findCertificatesAuth(auth: sdk.AuthId, args: sdk.FindCertificatesArgs): Promise<TableCertificateX[]>
|
|
8244
|
+
override async findOutputBasketsAuth(auth: sdk.AuthId, args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>
|
|
8245
|
+
override async findOutputsAuth(auth: sdk.AuthId, args: sdk.FindOutputsArgs): Promise<TableOutput[]>
|
|
8246
|
+
override async findCertificateFields(args: sdk.FindCertificateFieldsArgs): Promise<TableCertificateField[]>
|
|
8247
|
+
override async findCertificates(args: sdk.FindCertificatesArgs): Promise<TableCertificateX[]>
|
|
8248
|
+
override async findCommissions(args: sdk.FindCommissionsArgs): Promise<TableCommission[]>
|
|
8249
|
+
override async findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>
|
|
8250
|
+
override async findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>
|
|
8251
|
+
override async findOutputTagMaps(args: sdk.FindOutputTagMapsArgs): Promise<TableOutputTagMap[]>
|
|
8252
|
+
override async findOutputTags(args: sdk.FindOutputTagsArgs): Promise<TableOutputTag[]>
|
|
8253
|
+
override async findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>
|
|
8254
|
+
override async findProvenTxs(args: sdk.FindProvenTxsArgs): Promise<TableProvenTx[]>
|
|
8255
|
+
override async findSyncStates(args: sdk.FindSyncStatesArgs): Promise<TableSyncState[]>
|
|
8256
|
+
override async findTransactions(args: sdk.FindTransactionsArgs): Promise<TableTransaction[]>
|
|
8257
|
+
override async findTxLabelMaps(args: sdk.FindTxLabelMapsArgs): Promise<TableTxLabelMap[]>
|
|
8258
|
+
override async findTxLabels(args: sdk.FindTxLabelsArgs): Promise<TableTxLabel[]>
|
|
8259
|
+
override async findUsers(args: sdk.FindUsersArgs): Promise<TableUser[]>
|
|
8260
|
+
override async findMonitorEvents(args: sdk.FindMonitorEventsArgs): Promise<TableMonitorEvent[]>
|
|
8261
|
+
async getCount<T extends object>(q: Knex.QueryBuilder<T, T[]>): Promise<number>
|
|
8262
|
+
override async countCertificateFields(args: sdk.FindCertificateFieldsArgs): Promise<number>
|
|
8263
|
+
override async countCertificates(args: sdk.FindCertificatesArgs): Promise<number>
|
|
8264
|
+
override async countCommissions(args: sdk.FindCommissionsArgs): Promise<number>
|
|
8265
|
+
override async countOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<number>
|
|
8266
|
+
override async countOutputs(args: sdk.FindOutputsArgs): Promise<number>
|
|
8267
|
+
override async countOutputTagMaps(args: sdk.FindOutputTagMapsArgs): Promise<number>
|
|
8268
|
+
override async countOutputTags(args: sdk.FindOutputTagsArgs): Promise<number>
|
|
8269
|
+
override async countProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<number>
|
|
8270
|
+
override async countProvenTxs(args: sdk.FindProvenTxsArgs): Promise<number>
|
|
8271
|
+
override async countSyncStates(args: sdk.FindSyncStatesArgs): Promise<number>
|
|
8272
|
+
override async countTransactions(args: sdk.FindTransactionsArgs): Promise<number>
|
|
8273
|
+
override async countTxLabelMaps(args: sdk.FindTxLabelMapsArgs): Promise<number>
|
|
8274
|
+
override async countTxLabels(args: sdk.FindTxLabelsArgs): Promise<number>
|
|
8275
|
+
override async countUsers(args: sdk.FindUsersArgs): Promise<number>
|
|
8276
|
+
override async countMonitorEvents(args: sdk.FindMonitorEventsArgs): Promise<number>
|
|
8277
|
+
override async destroy(): Promise<void>
|
|
8278
|
+
override async migrate(storageName: string, storageIdentityKey: string): Promise<string>
|
|
8279
|
+
override async dropAllData(): Promise<void>
|
|
8280
|
+
override async transaction<T>(scope: (trx: sdk.TrxToken) => Promise<T>, trx?: sdk.TrxToken): Promise<T>
|
|
8281
|
+
toDb(trx?: sdk.TrxToken)
|
|
8282
|
+
async validateRawTransaction(t: TableTransaction, trx?: sdk.TrxToken): Promise<void>
|
|
8283
|
+
async validateOutputScript(o: TableOutput, trx?: sdk.TrxToken): Promise<void>
|
|
8284
|
+
_verifiedReadyForDatabaseAccess: boolean = false;
|
|
8285
|
+
async verifyReadyForDatabaseAccess(trx?: sdk.TrxToken): Promise<DBType>
|
|
8286
|
+
validatePartialForUpdate<T extends sdk.EntityTimeStamp>(update: Partial<T>, dateFields?: string[], booleanFields?: string[]): Partial<T>
|
|
8287
|
+
async validateEntityForInsert<T extends sdk.EntityTimeStamp>(entity: T, trx?: sdk.TrxToken, dateFields?: string[], booleanFields?: string[]): Promise<any>
|
|
8288
|
+
override async getLabelsForTransactionId(transactionId?: number, trx?: sdk.TrxToken): Promise<TableTxLabel[]>
|
|
8289
|
+
async extendOutput(o: TableOutput, includeBasket = false, includeTags = false, trx?: sdk.TrxToken): Promise<TableOutputX>
|
|
8290
|
+
override async getTagsForOutputId(outputId: number, trx?: sdk.TrxToken): Promise<TableOutputTag[]>
|
|
8291
|
+
override async purgeData(params: sdk.PurgeParams, trx?: sdk.TrxToken): Promise<sdk.PurgeResults>
|
|
8292
|
+
override async reviewStatus(args: {
|
|
8293
|
+
agedLimit: Date;
|
|
8294
|
+
trx?: sdk.TrxToken;
|
|
8295
|
+
}): Promise<{
|
|
8296
|
+
log: string;
|
|
8297
|
+
}>
|
|
8298
|
+
async countChangeInputs(userId: number, basketId: number, excludeSending: boolean): Promise<number>
|
|
8299
|
+
async allocateChangeInput(userId: number, basketId: number, targetSatoshis: number, exactSatoshis: number | undefined, excludeSending: boolean, transactionId: number): Promise<TableOutput | undefined> {
|
|
8300
|
+
const status: sdk.TransactionStatus[] = ["completed", "unproven"];
|
|
8301
|
+
if (!excludeSending)
|
|
8302
|
+
status.push("sending");
|
|
8303
|
+
const statusText = status.map(s => `'${s}'`).join(",");
|
|
8304
|
+
const r: TableOutput | undefined = await this.knex.transaction(async (trx) => {
|
|
8305
|
+
const txStatusCondition = `AND (SELECT status FROM transactions WHERE outputs.transactionId = transactions.transactionId) in (${statusText})`;
|
|
8306
|
+
let outputId: number | undefined;
|
|
8307
|
+
const setOutputId = async (rawQuery: string): Promise<void> => {
|
|
8308
|
+
let oidr = await trx.raw(rawQuery);
|
|
8309
|
+
outputId = undefined;
|
|
8310
|
+
if (!oidr["outputId"] && oidr.length > 0)
|
|
8311
|
+
oidr = oidr[0];
|
|
8312
|
+
if (!oidr["outputId"] && oidr.length > 0)
|
|
8313
|
+
oidr = oidr[0];
|
|
8314
|
+
if (oidr["outputId"])
|
|
8315
|
+
outputId = Number(oidr["outputId"]);
|
|
8316
|
+
};
|
|
8317
|
+
if (exactSatoshis !== undefined) {
|
|
8318
|
+
await setOutputId(`
|
|
8319
|
+
SELECT outputId
|
|
8320
|
+
FROM outputs
|
|
8321
|
+
WHERE userId = ${userId}
|
|
8322
|
+
AND spendable = 1
|
|
8323
|
+
AND basketId = ${basketId}
|
|
8324
|
+
${txStatusCondition}
|
|
8325
|
+
AND satoshis = ${exactSatoshis}
|
|
8326
|
+
LIMIT 1;
|
|
8327
|
+
`);
|
|
8328
|
+
}
|
|
8329
|
+
if (outputId === undefined) {
|
|
8330
|
+
await setOutputId(`
|
|
8331
|
+
SELECT outputId
|
|
8332
|
+
FROM outputs
|
|
8333
|
+
WHERE userId = ${userId}
|
|
8334
|
+
AND spendable = 1
|
|
8335
|
+
AND basketId = ${basketId}
|
|
8336
|
+
${txStatusCondition}
|
|
8337
|
+
AND satoshis - ${targetSatoshis} = (
|
|
8338
|
+
SELECT MIN(satoshis - ${targetSatoshis})
|
|
8339
|
+
FROM outputs
|
|
8340
|
+
WHERE userId = ${userId}
|
|
8341
|
+
AND spendable = 1
|
|
8342
|
+
AND basketId = ${basketId}
|
|
8343
|
+
${txStatusCondition}
|
|
8344
|
+
AND satoshis - ${targetSatoshis} >= 0
|
|
8345
|
+
)
|
|
8346
|
+
LIMIT 1;
|
|
8347
|
+
`);
|
|
8348
|
+
}
|
|
8349
|
+
if (outputId === undefined) {
|
|
8350
|
+
await setOutputId(`
|
|
8351
|
+
SELECT outputId
|
|
8352
|
+
FROM outputs
|
|
8353
|
+
WHERE userId = ${userId}
|
|
8354
|
+
AND spendable = 1
|
|
8355
|
+
AND basketId = ${basketId}
|
|
8356
|
+
${txStatusCondition}
|
|
8357
|
+
AND satoshis - ${targetSatoshis} = (
|
|
8358
|
+
SELECT MAX(satoshis - ${targetSatoshis})
|
|
8359
|
+
FROM outputs
|
|
8360
|
+
WHERE userId = ${userId}
|
|
8361
|
+
AND spendable = 1
|
|
8362
|
+
AND basketId = ${basketId}
|
|
8363
|
+
${txStatusCondition}
|
|
8364
|
+
AND satoshis - ${targetSatoshis} < 0
|
|
8365
|
+
)
|
|
8366
|
+
LIMIT 1;
|
|
8367
|
+
`);
|
|
8368
|
+
}
|
|
8369
|
+
if (outputId === undefined)
|
|
8370
|
+
return undefined;
|
|
8371
|
+
await this.updateOutput(outputId, {
|
|
8372
|
+
spendable: false,
|
|
8373
|
+
spentBy: transactionId
|
|
8374
|
+
}, trx);
|
|
8375
|
+
const r = verifyTruthy(await this.findOutputById(outputId, trx));
|
|
8376
|
+
return r;
|
|
8377
|
+
});
|
|
8378
|
+
return r;
|
|
8379
|
+
}
|
|
8380
|
+
validateEntity<T extends sdk.EntityTimeStamp>(entity: T, dateFields?: string[], booleanFields?: string[]): T
|
|
8381
|
+
validateEntities<T extends sdk.EntityTimeStamp>(entities: T[], dateFields?: string[], booleanFields?: string[]): T[]
|
|
8382
|
+
}
|
|
8383
|
+
```
|
|
8384
|
+
|
|
8385
|
+
See also: [AuthId](./client.md#interface-authid), [DBType](./storage.md#type-dbtype), [EntityTimeStamp](./client.md#interface-entitytimestamp), [FindCertificateFieldsArgs](./client.md#interface-findcertificatefieldsargs), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindCommissionsArgs](./client.md#interface-findcommissionsargs), [FindForUserSincePagedArgs](./client.md#interface-findforusersincepagedargs), [FindMonitorEventsArgs](./client.md#interface-findmonitoreventsargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputTagMapsArgs](./client.md#interface-findoutputtagmapsargs), [FindOutputTagsArgs](./client.md#interface-findoutputtagsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindPartialSincePagedArgs](./client.md#interface-findpartialsincepagedargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [FindProvenTxsArgs](./client.md#interface-findproventxsargs), [FindSyncStatesArgs](./client.md#interface-findsyncstatesargs), [FindTransactionsArgs](./client.md#interface-findtransactionsargs), [FindTxLabelMapsArgs](./client.md#interface-findtxlabelmapsargs), [FindTxLabelsArgs](./client.md#interface-findtxlabelsargs), [FindUsersArgs](./client.md#interface-findusersargs), [ProvenOrRawTx](./client.md#interface-provenorrawtx), [PurgeParams](./client.md#interface-purgeparams), [PurgeResults](./client.md#interface-purgeresults), [StorageKnexOptions](./storage.md#interface-storageknexoptions), [StorageProvider](./storage.md#class-storageprovider), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableCommission](./storage.md#interface-tablecommission), [TableMonitorEvent](./storage.md#interface-tablemonitorevent), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [TableOutputX](./storage.md#interface-tableoutputx), [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableSyncState](./storage.md#interface-tablesyncstate), [TableTransaction](./storage.md#interface-tabletransaction), [TableTxLabel](./storage.md#interface-tabletxlabel), [TableTxLabelMap](./storage.md#interface-tabletxlabelmap), [TableUser](./storage.md#interface-tableuser), [TransactionStatus](./client.md#type-transactionstatus), [TrxToken](./client.md#interface-trxtoken), [ValidListActionsArgs](./client.md#interface-validlistactionsargs), [ValidListOutputsArgs](./client.md#interface-validlistoutputsargs), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [listActions](./storage.md#function-listactions), [listOutputs](./storage.md#function-listoutputs), [purgeData](./storage.md#function-purgedata), [reviewStatus](./storage.md#function-reviewstatus), [verifyTruthy](./client.md#function-verifytruthy)
|
|
8386
|
+
|
|
8387
|
+
###### Method allocateChangeInput
|
|
8388
|
+
|
|
8389
|
+
Finds closest matching available change output to use as input for new transaction.
|
|
8390
|
+
|
|
8391
|
+
Transactionally allocate the output such that
|
|
8392
|
+
|
|
8393
|
+
```ts
|
|
8394
|
+
async allocateChangeInput(userId: number, basketId: number, targetSatoshis: number, exactSatoshis: number | undefined, excludeSending: boolean, transactionId: number): Promise<TableOutput | undefined>
|
|
8395
|
+
```
|
|
8396
|
+
See also: [TableOutput](./storage.md#interface-tableoutput)
|
|
8397
|
+
|
|
8398
|
+
###### Method countChangeInputs
|
|
8399
|
+
|
|
8400
|
+
Finds closest matching available change output to use as input for new transaction.
|
|
8401
|
+
|
|
8402
|
+
Transactionally allocate the output such that
|
|
8403
|
+
|
|
8404
|
+
```ts
|
|
8405
|
+
async countChangeInputs(userId: number, basketId: number, excludeSending: boolean): Promise<number>
|
|
8406
|
+
```
|
|
8407
|
+
|
|
8408
|
+
###### Method toDb
|
|
8409
|
+
|
|
8410
|
+
Convert the standard optional `TrxToken` parameter into either a direct knex database instance,
|
|
8411
|
+
or a Knex.Transaction as appropriate.
|
|
8412
|
+
|
|
8413
|
+
```ts
|
|
8414
|
+
toDb(trx?: sdk.TrxToken)
|
|
8415
|
+
```
|
|
8416
|
+
See also: [TrxToken](./client.md#interface-trxtoken)
|
|
8417
|
+
|
|
8418
|
+
###### Method validateEntities
|
|
8419
|
+
|
|
8420
|
+
Helper to force uniform behavior across database engines.
|
|
8421
|
+
Use to process all arrays of records with time stamps retreived from database.
|
|
8422
|
+
|
|
8423
|
+
```ts
|
|
8424
|
+
validateEntities<T extends sdk.EntityTimeStamp>(entities: T[], dateFields?: string[], booleanFields?: string[]): T[]
|
|
8425
|
+
```
|
|
8426
|
+
See also: [EntityTimeStamp](./client.md#interface-entitytimestamp)
|
|
8427
|
+
|
|
8428
|
+
Returns
|
|
8429
|
+
|
|
8430
|
+
input `entities` array with contained values validated.
|
|
8431
|
+
|
|
8432
|
+
###### Method validateEntity
|
|
8433
|
+
|
|
8434
|
+
Helper to force uniform behavior across database engines.
|
|
8435
|
+
Use to process all individual records with time stamps retreived from database.
|
|
8436
|
+
|
|
8437
|
+
```ts
|
|
8438
|
+
validateEntity<T extends sdk.EntityTimeStamp>(entity: T, dateFields?: string[], booleanFields?: string[]): T
|
|
8439
|
+
```
|
|
8440
|
+
See also: [EntityTimeStamp](./client.md#interface-entitytimestamp)
|
|
8441
|
+
|
|
8442
|
+
###### Method validateEntityForInsert
|
|
8443
|
+
|
|
8444
|
+
Helper to force uniform behavior across database engines.
|
|
8445
|
+
Use to process new entities being inserted into the database.
|
|
8446
|
+
|
|
8447
|
+
```ts
|
|
8448
|
+
async validateEntityForInsert<T extends sdk.EntityTimeStamp>(entity: T, trx?: sdk.TrxToken, dateFields?: string[], booleanFields?: string[]): Promise<any>
|
|
8449
|
+
```
|
|
8450
|
+
See also: [EntityTimeStamp](./client.md#interface-entitytimestamp), [TrxToken](./client.md#interface-trxtoken)
|
|
8451
|
+
|
|
8452
|
+
###### Method validatePartialForUpdate
|
|
8453
|
+
|
|
8454
|
+
Helper to force uniform behavior across database engines.
|
|
8455
|
+
Use to process the update template for entities being updated.
|
|
8456
|
+
|
|
8457
|
+
```ts
|
|
8458
|
+
validatePartialForUpdate<T extends sdk.EntityTimeStamp>(update: Partial<T>, dateFields?: string[], booleanFields?: string[]): Partial<T>
|
|
8459
|
+
```
|
|
8460
|
+
See also: [EntityTimeStamp](./client.md#interface-entitytimestamp)
|
|
8461
|
+
|
|
8462
|
+
###### Method verifyReadyForDatabaseAccess
|
|
8463
|
+
|
|
8464
|
+
Make sure database is ready for access:
|
|
8465
|
+
|
|
8466
|
+
- dateScheme is known
|
|
8467
|
+
- foreign key constraints are enabled
|
|
8468
|
+
|
|
8469
|
+
```ts
|
|
8470
|
+
async verifyReadyForDatabaseAccess(trx?: sdk.TrxToken): Promise<DBType>
|
|
8471
|
+
```
|
|
8472
|
+
See also: [DBType](./storage.md#type-dbtype), [TrxToken](./client.md#interface-trxtoken)
|
|
8473
|
+
|
|
8474
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8475
|
+
|
|
7183
8476
|
---
|
|
7184
8477
|
##### Class: StorageProvider
|
|
7185
8478
|
|
|
@@ -7499,6 +8792,47 @@ See also: [AuthId](./client.md#interface-authid), [FindOutputTagMapsArgs](./clie
|
|
|
7499
8792
|
|
|
7500
8793
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7501
8794
|
|
|
8795
|
+
---
|
|
8796
|
+
##### Class: StorageServer
|
|
8797
|
+
|
|
8798
|
+
```ts
|
|
8799
|
+
export class StorageServer {
|
|
8800
|
+
constructor(storage: StorageProvider, options: WalletStorageServerOptions)
|
|
8801
|
+
public start(): void
|
|
8802
|
+
validateDate(date: Date | string | number): Date
|
|
8803
|
+
validateEntity<T extends sdk.EntityTimeStamp>(entity: T, dateFields?: string[]): T
|
|
8804
|
+
validateEntities<T extends sdk.EntityTimeStamp>(entities: T[], dateFields?: string[]): T[]
|
|
8805
|
+
}
|
|
8806
|
+
```
|
|
8807
|
+
|
|
8808
|
+
See also: [EntityTimeStamp](./client.md#interface-entitytimestamp), [StorageProvider](./storage.md#class-storageprovider), [WalletStorageServerOptions](./storage.md#interface-walletstorageserveroptions)
|
|
8809
|
+
|
|
8810
|
+
###### Method validateEntities
|
|
8811
|
+
|
|
8812
|
+
Helper to force uniform behavior across database engines.
|
|
8813
|
+
Use to process all arrays of records with time stamps retreived from database.
|
|
8814
|
+
|
|
8815
|
+
```ts
|
|
8816
|
+
validateEntities<T extends sdk.EntityTimeStamp>(entities: T[], dateFields?: string[]): T[]
|
|
8817
|
+
```
|
|
8818
|
+
See also: [EntityTimeStamp](./client.md#interface-entitytimestamp)
|
|
8819
|
+
|
|
8820
|
+
Returns
|
|
8821
|
+
|
|
8822
|
+
input `entities` array with contained values validated.
|
|
8823
|
+
|
|
8824
|
+
###### Method validateEntity
|
|
8825
|
+
|
|
8826
|
+
Helper to force uniform behavior across database engines.
|
|
8827
|
+
Use to process all individual records with time stamps retreived from database.
|
|
8828
|
+
|
|
8829
|
+
```ts
|
|
8830
|
+
validateEntity<T extends sdk.EntityTimeStamp>(entity: T, dateFields?: string[]): T
|
|
8831
|
+
```
|
|
8832
|
+
See also: [EntityTimeStamp](./client.md#interface-entitytimestamp)
|
|
8833
|
+
|
|
8834
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
8835
|
+
|
|
7502
8836
|
---
|
|
7503
8837
|
##### Class: StorageSyncReader
|
|
7504
8838
|
|
|
@@ -7785,6 +9119,57 @@ See also: [Monitor](./monitor.md#class-monitor), [WalletMonitorTask](./monitor.m
|
|
|
7785
9119
|
|
|
7786
9120
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7787
9121
|
|
|
9122
|
+
---
|
|
9123
|
+
##### Class: TaskUnFail
|
|
9124
|
+
|
|
9125
|
+
Setting provenTxReq status to 'unfail' when 'invalid' will attempt to find a merklePath, and if successful:
|
|
9126
|
+
|
|
9127
|
+
1. set the req status to 'unmined'
|
|
9128
|
+
2. set the referenced txs to 'unproven'
|
|
9129
|
+
3. determine if any inputs match user's existing outputs and if so update spentBy and spendable of those outputs.
|
|
9130
|
+
4. set the txs outputs to spendable
|
|
9131
|
+
|
|
9132
|
+
If it fails (to find a merklePath), returns the req status to 'invalid'.
|
|
9133
|
+
|
|
9134
|
+
```ts
|
|
9135
|
+
export class TaskUnFail extends WalletMonitorTask {
|
|
9136
|
+
static taskName = "UnFail";
|
|
9137
|
+
static checkNow = false;
|
|
9138
|
+
constructor(monitor: Monitor, public triggerMsecs = monitor.oneMinute * 10)
|
|
9139
|
+
trigger(nowMsecsSinceEpoch: number): {
|
|
9140
|
+
run: boolean;
|
|
9141
|
+
}
|
|
9142
|
+
async runTask(): Promise<string>
|
|
9143
|
+
async unfail(reqs: TableProvenTxReq[], indent = 0): Promise<{
|
|
9144
|
+
log: string;
|
|
9145
|
+
}>
|
|
9146
|
+
async unfailReq(req: EntityProvenTxReq, indent: number): Promise<string>
|
|
9147
|
+
}
|
|
9148
|
+
```
|
|
9149
|
+
|
|
9150
|
+
See also: [EntityProvenTxReq](./storage.md#class-entityproventxreq), [Monitor](./monitor.md#class-monitor), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [WalletMonitorTask](./monitor.md#class-walletmonitortask)
|
|
9151
|
+
|
|
9152
|
+
###### Property checkNow
|
|
9153
|
+
|
|
9154
|
+
Set to true to trigger running this task
|
|
9155
|
+
|
|
9156
|
+
```ts
|
|
9157
|
+
static checkNow = false
|
|
9158
|
+
```
|
|
9159
|
+
|
|
9160
|
+
###### Method unfailReq
|
|
9161
|
+
|
|
9162
|
+
2. set the referenced txs to 'unproven'
|
|
9163
|
+
3. determine if any inputs match user's existing outputs and if so update spentBy and spendable of those outputs.
|
|
9164
|
+
4. set the txs outputs to spendable
|
|
9165
|
+
|
|
9166
|
+
```ts
|
|
9167
|
+
async unfailReq(req: EntityProvenTxReq, indent: number): Promise<string>
|
|
9168
|
+
```
|
|
9169
|
+
See also: [EntityProvenTxReq](./storage.md#class-entityproventxreq)
|
|
9170
|
+
|
|
9171
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9172
|
+
|
|
7788
9173
|
---
|
|
7789
9174
|
##### Class: TwilioPhoneInteractor
|
|
7790
9175
|
|
|
@@ -9330,41 +10715,43 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
9330
10715
|
|
|
9331
10716
|
| | | |
|
|
9332
10717
|
| --- | --- | --- |
|
|
9333
|
-
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [
|
|
9334
|
-
| [arcDefaultUrl](#function-arcdefaulturl) | [
|
|
9335
|
-
| [arraysEqual](#function-arraysequal) | [
|
|
9336
|
-
| [asArray](#function-asarray) | [
|
|
9337
|
-
| [
|
|
9338
|
-
| [
|
|
9339
|
-
| [
|
|
9340
|
-
| [
|
|
10718
|
+
| [acquireDirectCertificate](#function-acquiredirectcertificate) | [lockScriptWithKeyOffsetFromPubKey](#function-lockscriptwithkeyoffsetfrompubkey) | [validateDiscoverByAttributesArgs](#function-validatediscoverbyattributesargs) |
|
|
10719
|
+
| [arcDefaultUrl](#function-arcdefaulturl) | [makeAtomicBeef](#function-makeatomicbeef) | [validateDiscoverByIdentityKeyArgs](#function-validatediscoverbyidentitykeyargs) |
|
|
10720
|
+
| [arraysEqual](#function-arraysequal) | [makeAtomicBeef](#function-makeatomicbeef) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) |
|
|
10721
|
+
| [asArray](#function-asarray) | [makeChangeLock](#function-makechangelock) | [validateGenerateChangeSdkResult](#function-validategeneratechangesdkresult) |
|
|
10722
|
+
| [asArray](#function-asarray) | [maxDate](#function-maxdate) | [validateInteger](#function-validateinteger) |
|
|
10723
|
+
| [asBsvSdkPrivateKey](#function-asbsvsdkprivatekey) | [offsetPubKey](#function-offsetpubkey) | [validateInternalizeActionArgs](#function-validateinternalizeactionargs) |
|
|
10724
|
+
| [asBsvSdkPublickKey](#function-asbsvsdkpublickkey) | [optionalArraysEqual](#function-optionalarraysequal) | [validateInternalizeOutput](#function-validateinternalizeoutput) |
|
|
10725
|
+
| [asBsvSdkScript](#function-asbsvsdkscript) | [parseTxScriptOffsets](#function-parsetxscriptoffsets) | [validateListActionsArgs](#function-validatelistactionsargs) |
|
|
10726
|
+
| [asBsvSdkTx](#function-asbsvsdktx) | [parseWalletOutpoint](#function-parsewalletoutpoint) | [validateListCertificatesArgs](#function-validatelistcertificatesargs) |
|
|
10727
|
+
| [asBuffer](#function-asbuffer) | [processAction](#function-processaction) | [validateListOutputsArgs](#function-validatelistoutputsargs) |
|
|
10728
|
+
| [asString](#function-asstring) | [processAction](#function-processaction) | [validateOptionalInteger](#function-validateoptionalinteger) |
|
|
9341
10729
|
| [asString](#function-asstring) | [proveCertificate](#function-provecertificate) | [validateOptionalOutpointString](#function-validateoptionaloutpointstring) |
|
|
9342
|
-
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [
|
|
9343
|
-
| [buildSignableTransaction](#function-buildsignabletransaction) | [
|
|
9344
|
-
| [completeSignedTransaction](#function-completesignedtransaction) | [
|
|
9345
|
-
| [completeSignedTransaction](#function-completesignedtransaction) | [
|
|
9346
|
-
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [
|
|
9347
|
-
| [createAction](#function-createaction) | [
|
|
9348
|
-
| [createAction](#function-createaction) | [
|
|
9349
|
-
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [
|
|
9350
|
-
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [
|
|
9351
|
-
| [createSyncMap](#function-createsyncmap) | [
|
|
9352
|
-
| [doubleSha256BE](#function-doublesha256be) | [
|
|
9353
|
-
| [doubleSha256HashLE](#function-doublesha256hashle) | [
|
|
9354
|
-
| [generateChangeSdk](#function-generatechangesdk) | [
|
|
9355
|
-
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [
|
|
9356
|
-
| [getBeefForTransaction](#function-getbeeffortransaction) | [
|
|
9357
|
-
| [getExchangeRatesIo](#function-getexchangeratesio) | [
|
|
9358
|
-
| [getIdentityKey](#function-getidentitykey) | [
|
|
9359
|
-
| [getSyncChunk](#function-getsyncchunk) | [
|
|
9360
|
-
| [internalizeAction](#function-internalizeaction) | [
|
|
9361
|
-
| [internalizeAction](#function-internalizeaction) | [
|
|
9362
|
-
| [isHexString](#function-ishexstring) | [
|
|
9363
|
-
| [isSpecOp](#function-isspecop) | [
|
|
9364
|
-
| [
|
|
9365
|
-
| [
|
|
9366
|
-
| [
|
|
9367
|
-
| [makeAtomicBeef](#function-makeatomicbeef) | [validateGenerateChangeSdkParams](#function-validategeneratechangesdkparams) | |
|
|
10730
|
+
| [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork) | [purgeData](#function-purgedata) | [validateOriginator](#function-validateoriginator) |
|
|
10731
|
+
| [buildSignableTransaction](#function-buildsignabletransaction) | [randomBytes](#function-randombytes) | [validateOutpointString](#function-validateoutpointstring) |
|
|
10732
|
+
| [completeSignedTransaction](#function-completesignedtransaction) | [randomBytesBase64](#function-randombytesbase64) | [validatePositiveIntegerOrZero](#function-validatepositiveintegerorzero) |
|
|
10733
|
+
| [completeSignedTransaction](#function-completesignedtransaction) | [randomBytesHex](#function-randombyteshex) | [validateProveCertificateArgs](#function-validateprovecertificateargs) |
|
|
10734
|
+
| [convertProofToMerklePath](#function-convertprooftomerklepath) | [reviewStatus](#function-reviewstatus) | [validateRelinquishCertificateArgs](#function-validaterelinquishcertificateargs) |
|
|
10735
|
+
| [createAction](#function-createaction) | [sha256Hash](#function-sha256hash) | [validateRelinquishOutputArgs](#function-validaterelinquishoutputargs) |
|
|
10736
|
+
| [createAction](#function-createaction) | [signAction](#function-signaction) | [validateSatoshis](#function-validatesatoshis) |
|
|
10737
|
+
| [createDefaultWalletServicesOptions](#function-createdefaultwalletservicesoptions) | [stampLog](#function-stamplog) | [validateScriptHash](#function-validatescripthash) |
|
|
10738
|
+
| [createStorageServiceChargeScript](#function-createstorageservicechargescript) | [stampLogFormat](#function-stamplogformat) | [validateSecondsSinceEpoch](#function-validatesecondssinceepoch) |
|
|
10739
|
+
| [createSyncMap](#function-createsyncmap) | [toBinaryBaseBlockHeader](#function-tobinarybaseblockheader) | [validateSignActionArgs](#function-validatesignactionargs) |
|
|
10740
|
+
| [doubleSha256BE](#function-doublesha256be) | [toWalletNetwork](#function-towalletnetwork) | [validateSignActionOptions](#function-validatesignactionoptions) |
|
|
10741
|
+
| [doubleSha256HashLE](#function-doublesha256hashle) | [transactionInputSize](#function-transactioninputsize) | [validateStorageFeeModel](#function-validatestoragefeemodel) |
|
|
10742
|
+
| [generateChangeSdk](#function-generatechangesdk) | [transactionOutputSize](#function-transactionoutputsize) | [validateStringLength](#function-validatestringlength) |
|
|
10743
|
+
| [generateChangeSdkMakeStorage](#function-generatechangesdkmakestorage) | [transactionSize](#function-transactionsize) | [validateWalletPayment](#function-validatewalletpayment) |
|
|
10744
|
+
| [getBeefForTransaction](#function-getbeeffortransaction) | [updateChaintracksFiatExchangeRates](#function-updatechaintracksfiatexchangerates) | [varUintSize](#function-varuintsize) |
|
|
10745
|
+
| [getExchangeRatesIo](#function-getexchangeratesio) | [updateExchangeratesapi](#function-updateexchangeratesapi) | [verifyHexString](#function-verifyhexstring) |
|
|
10746
|
+
| [getIdentityKey](#function-getidentitykey) | [validateAbortActionArgs](#function-validateabortactionargs) | [verifyId](#function-verifyid) |
|
|
10747
|
+
| [getSyncChunk](#function-getsyncchunk) | [validateAcquireCertificateArgs](#function-validateacquirecertificateargs) | [verifyInteger](#function-verifyinteger) |
|
|
10748
|
+
| [internalizeAction](#function-internalizeaction) | [validateAcquireDirectCertificateArgs](#function-validateacquiredirectcertificateargs) | [verifyNumber](#function-verifynumber) |
|
|
10749
|
+
| [internalizeAction](#function-internalizeaction) | [validateAcquireIssuanceCertificateArgs](#function-validateacquireissuancecertificateargs) | [verifyOne](#function-verifyone) |
|
|
10750
|
+
| [isHexString](#function-ishexstring) | [validateBasketInsertion](#function-validatebasketinsertion) | [verifyOneOrNone](#function-verifyoneornone) |
|
|
10751
|
+
| [isSpecOp](#function-isspecop) | [validateCreateActionArgs](#function-validatecreateactionargs) | [verifyOptionalHexString](#function-verifyoptionalhexstring) |
|
|
10752
|
+
| [listActions](#function-listactions) | [validateCreateActionInput](#function-validatecreateactioninput) | [verifyTruthy](#function-verifytruthy) |
|
|
10753
|
+
| [listCertificates](#function-listcertificates) | [validateCreateActionOptions](#function-validatecreateactionoptions) | [wait](#function-wait) |
|
|
10754
|
+
| [listOutputs](#function-listoutputs) | [validateCreateActionOutput](#function-validatecreateactionoutput) | |
|
|
9368
10755
|
|
|
9369
10756
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9370
10757
|
|
|
@@ -9411,6 +10798,15 @@ export function asArray(val: string | number[]): number[]
|
|
|
9411
10798
|
|
|
9412
10799
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9413
10800
|
|
|
10801
|
+
---
|
|
10802
|
+
##### Function: asArray
|
|
10803
|
+
|
|
10804
|
+
```ts
|
|
10805
|
+
export function asArray(val: Buffer | string | number[], encoding?: BufferEncoding): number[]
|
|
10806
|
+
```
|
|
10807
|
+
|
|
10808
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
10809
|
+
|
|
9414
10810
|
---
|
|
9415
10811
|
##### Function: asBsvSdkPrivateKey
|
|
9416
10812
|
|
|
@@ -9479,6 +10875,37 @@ export function asBsvSdkTx(tx: HexString | number[] | Transaction): Transaction
|
|
|
9479
10875
|
|
|
9480
10876
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9481
10877
|
|
|
10878
|
+
---
|
|
10879
|
+
##### Function: asBuffer
|
|
10880
|
+
|
|
10881
|
+
Coerce a value to Buffer if currently encoded as a string or
|
|
10882
|
+
|
|
10883
|
+
```ts
|
|
10884
|
+
export function asBuffer(val: Buffer | string | number[], encoding?: BufferEncoding): Buffer {
|
|
10885
|
+
let b: Buffer;
|
|
10886
|
+
if (Buffer.isBuffer(val))
|
|
10887
|
+
b = val;
|
|
10888
|
+
else if (typeof val === "string")
|
|
10889
|
+
b = Buffer.from(val, encoding ?? "hex");
|
|
10890
|
+
else
|
|
10891
|
+
b = Buffer.from(val);
|
|
10892
|
+
return b;
|
|
10893
|
+
}
|
|
10894
|
+
```
|
|
10895
|
+
|
|
10896
|
+
Returns
|
|
10897
|
+
|
|
10898
|
+
input val if it is a Buffer or new Buffer from string val
|
|
10899
|
+
|
|
10900
|
+
Argument Details
|
|
10901
|
+
|
|
10902
|
+
+ **val**
|
|
10903
|
+
+ Buffer or string or number[]. If string, encoding param applies. If number[], Buffer.from constructor is used.
|
|
10904
|
+
+ **encoding**
|
|
10905
|
+
+ defaults to 'hex'. Only applies to val of type string
|
|
10906
|
+
|
|
10907
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
10908
|
+
|
|
9482
10909
|
---
|
|
9483
10910
|
##### Function: asString
|
|
9484
10911
|
|
|
@@ -9503,6 +10930,32 @@ Argument Details
|
|
|
9503
10930
|
|
|
9504
10931
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9505
10932
|
|
|
10933
|
+
---
|
|
10934
|
+
##### Function: asString
|
|
10935
|
+
|
|
10936
|
+
Coerce a value to an encoded string if currently a Buffer or number[]
|
|
10937
|
+
|
|
10938
|
+
```ts
|
|
10939
|
+
export function asString(val: Buffer | string | number[], encoding?: BufferEncoding): string {
|
|
10940
|
+
if (Array.isArray(val))
|
|
10941
|
+
val = Buffer.from(val);
|
|
10942
|
+
return Buffer.isBuffer(val) ? val.toString(encoding ?? "hex") : val;
|
|
10943
|
+
}
|
|
10944
|
+
```
|
|
10945
|
+
|
|
10946
|
+
Returns
|
|
10947
|
+
|
|
10948
|
+
input val if it is a string; or if number[], first converted to Buffer then as Buffer; if Buffer encoded using `encoding`
|
|
10949
|
+
|
|
10950
|
+
Argument Details
|
|
10951
|
+
|
|
10952
|
+
+ **val**
|
|
10953
|
+
+ Buffer or string or number[]. If string, encoding param applies. If number[], Buffer.from constructor is used.
|
|
10954
|
+
+ **encoding**
|
|
10955
|
+
+ defaults to 'hex'
|
|
10956
|
+
|
|
10957
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
10958
|
+
|
|
9506
10959
|
---
|
|
9507
10960
|
##### Function: attemptToPostReqsToNetwork
|
|
9508
10961
|
|
|
@@ -9867,6 +11320,17 @@ Argument Details
|
|
|
9867
11320
|
|
|
9868
11321
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9869
11322
|
|
|
11323
|
+
---
|
|
11324
|
+
##### Function: listActions
|
|
11325
|
+
|
|
11326
|
+
```ts
|
|
11327
|
+
export async function listActions(storage: StorageKnex, auth: sdk.AuthId, vargs: sdk.ValidListActionsArgs): Promise<ListActionsResult>
|
|
11328
|
+
```
|
|
11329
|
+
|
|
11330
|
+
See also: [AuthId](./client.md#interface-authid), [StorageKnex](./storage.md#class-storageknex), [ValidListActionsArgs](./client.md#interface-validlistactionsargs)
|
|
11331
|
+
|
|
11332
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11333
|
+
|
|
9870
11334
|
---
|
|
9871
11335
|
##### Function: listCertificates
|
|
9872
11336
|
|
|
@@ -9878,6 +11342,17 @@ See also: [AuthId](./client.md#interface-authid), [StorageProvider](./storage.md
|
|
|
9878
11342
|
|
|
9879
11343
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
9880
11344
|
|
|
11345
|
+
---
|
|
11346
|
+
##### Function: listOutputs
|
|
11347
|
+
|
|
11348
|
+
```ts
|
|
11349
|
+
export async function listOutputs(dsk: StorageKnex, auth: sdk.AuthId, vargs: sdk.ValidListOutputsArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<ListOutputsResult>
|
|
11350
|
+
```
|
|
11351
|
+
|
|
11352
|
+
See also: [AuthId](./client.md#interface-authid), [StorageKnex](./storage.md#class-storageknex), [ValidListOutputsArgs](./client.md#interface-validlistoutputsargs)
|
|
11353
|
+
|
|
11354
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11355
|
+
|
|
9881
11356
|
---
|
|
9882
11357
|
##### Function: lockScriptWithKeyOffsetFromPubKey
|
|
9883
11358
|
|
|
@@ -10007,6 +11482,17 @@ See also: [AuthId](./client.md#interface-authid), [ValidProveCertificateArgs](./
|
|
|
10007
11482
|
|
|
10008
11483
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
10009
11484
|
|
|
11485
|
+
---
|
|
11486
|
+
##### Function: purgeData
|
|
11487
|
+
|
|
11488
|
+
```ts
|
|
11489
|
+
export async function purgeData(storage: StorageKnex, params: sdk.PurgeParams, trx?: sdk.TrxToken): Promise<sdk.PurgeResults>
|
|
11490
|
+
```
|
|
11491
|
+
|
|
11492
|
+
See also: [PurgeParams](./client.md#interface-purgeparams), [PurgeResults](./client.md#interface-purgeresults), [StorageKnex](./storage.md#class-storageknex), [TrxToken](./client.md#interface-trxtoken)
|
|
11493
|
+
|
|
11494
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11495
|
+
|
|
10010
11496
|
---
|
|
10011
11497
|
##### Function: randomBytes
|
|
10012
11498
|
|
|
@@ -10046,6 +11532,22 @@ count cryptographically secure random bytes as hex encoded string
|
|
|
10046
11532
|
|
|
10047
11533
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
10048
11534
|
|
|
11535
|
+
---
|
|
11536
|
+
##### Function: reviewStatus
|
|
11537
|
+
|
|
11538
|
+
```ts
|
|
11539
|
+
export async function reviewStatus(storage: StorageKnex, args: {
|
|
11540
|
+
agedLimit: Date;
|
|
11541
|
+
trx?: sdk.TrxToken;
|
|
11542
|
+
}): Promise<{
|
|
11543
|
+
log: string;
|
|
11544
|
+
}>
|
|
11545
|
+
```
|
|
11546
|
+
|
|
11547
|
+
See also: [StorageKnex](./storage.md#class-storageknex), [TrxToken](./client.md#interface-trxtoken)
|
|
11548
|
+
|
|
11549
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
11550
|
+
|
|
10049
11551
|
---
|
|
10050
11552
|
##### Function: sha256Hash
|
|
10051
11553
|
|
|
@@ -11016,8 +12518,10 @@ invalid: rawTx is structuraly invalid or was rejected by the network. Will never
|
|
|
11016
12518
|
|
|
11017
12519
|
completed: proven_txs record added, and notifications are complete.
|
|
11018
12520
|
|
|
12521
|
+
unfail: asigned to force review of a currently invalid ProvenTxReq.
|
|
12522
|
+
|
|
11019
12523
|
```ts
|
|
11020
|
-
export type ProvenTxReqStatus = "sending" | "unsent" | "nosend" | "unknown" | "nonfinal" | "unprocessed" | "unmined" | "callback" | "unconfirmed" | "completed" | "invalid" | "doubleSpend"
|
|
12524
|
+
export type ProvenTxReqStatus = "sending" | "unsent" | "nosend" | "unknown" | "nonfinal" | "unprocessed" | "unmined" | "callback" | "unconfirmed" | "completed" | "invalid" | "doubleSpend" | "unfail"
|
|
11021
12525
|
```
|
|
11022
12526
|
|
|
11023
12527
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|