@bsv/wallet-toolbox 1.1.34 → 1.1.35
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 +215 -213
- package/docs/setup.md +2 -2
- package/docs/storage.md +140 -34
- package/docs/wallet.md +215 -213
- package/out/src/Setup.d.ts.map +1 -1
- package/out/src/Setup.js +2 -2
- package/out/src/Setup.js.map +1 -1
- package/out/src/sdk/WERR_errors.d.ts +1 -1
- package/out/src/sdk/WERR_errors.d.ts.map +1 -1
- package/out/src/sdk/WERR_errors.js +2 -2
- package/out/src/sdk/WERR_errors.js.map +1 -1
- package/out/src/sdk/WalletStorage.interfaces.d.ts +107 -0
- package/out/src/sdk/WalletStorage.interfaces.d.ts.map +1 -1
- package/out/src/sdk/index.d.ts +0 -2
- package/out/src/sdk/index.d.ts.map +1 -1
- package/out/src/sdk/index.js +0 -2
- package/out/src/sdk/index.js.map +1 -1
- package/out/src/services/__tests/verifyBeef.test.d.ts +2 -0
- package/out/src/services/__tests/verifyBeef.test.d.ts.map +1 -0
- package/out/src/services/__tests/verifyBeef.test.js +16 -0
- package/out/src/services/__tests/verifyBeef.test.js.map +1 -0
- package/out/src/services/providers/__tests/WhatsOnChain.test.js +11 -0
- package/out/src/services/providers/__tests/WhatsOnChain.test.js.map +1 -1
- package/out/src/storage/StorageReader.d.ts +1 -1
- package/out/src/storage/StorageReader.d.ts.map +1 -1
- package/out/src/storage/StorageReaderWriter.d.ts.map +1 -1
- package/out/src/storage/StorageReaderWriter.js +2 -1
- package/out/src/storage/StorageReaderWriter.js.map +1 -1
- package/out/src/storage/StorageSyncReader.d.ts +2 -18
- package/out/src/storage/StorageSyncReader.d.ts.map +1 -1
- package/out/src/storage/StorageSyncReader.js +1 -105
- package/out/src/storage/StorageSyncReader.js.map +1 -1
- package/out/src/storage/WalletStorageManager.d.ts +86 -10
- package/out/src/storage/WalletStorageManager.d.ts.map +1 -1
- package/out/src/storage/WalletStorageManager.js +235 -78
- package/out/src/storage/WalletStorageManager.js.map +1 -1
- package/out/src/storage/schema/KnexMigrations.d.ts.map +1 -1
- package/out/src/storage/schema/KnexMigrations.js +19 -0
- package/out/src/storage/schema/KnexMigrations.js.map +1 -1
- package/out/src/storage/schema/entities/User.d.ts +2 -2
- package/out/src/storage/schema/entities/User.d.ts.map +1 -1
- package/out/src/storage/schema/entities/User.js +1 -1
- package/out/src/storage/schema/entities/User.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/SyncStateTests.test.js +2 -1
- package/out/src/storage/schema/entities/__tests/SyncStateTests.test.js.map +1 -1
- package/out/src/storage/schema/entities/__tests/usersTests.test.js +12 -6
- package/out/src/storage/schema/entities/__tests/usersTests.test.js.map +1 -1
- package/out/src/storage/schema/tables/User.d.ts +1 -1
- package/out/src/storage/schema/tables/User.d.ts.map +1 -1
- package/out/src/storage/sync/StorageMySQLDojoReader.d.ts +1 -1
- package/out/src/storage/sync/StorageMySQLDojoReader.d.ts.map +1 -1
- package/out/src/storage/sync/StorageMySQLDojoReader.js +4 -5
- package/out/src/storage/sync/StorageMySQLDojoReader.js.map +1 -1
- package/out/test/Wallet/sync/Wallet.updateWalletLegacyTestData.man.test.js +25 -13
- package/out/test/Wallet/sync/Wallet.updateWalletLegacyTestData.man.test.js.map +1 -1
- package/out/test/Wallet/sync/setActive.test.d.ts +2 -0
- package/out/test/Wallet/sync/setActive.test.d.ts.map +1 -0
- package/out/test/Wallet/sync/setActive.test.js +60 -0
- package/out/test/Wallet/sync/setActive.test.js.map +1 -0
- package/out/test/examples/{backup.test.d.ts → backup.man.test.d.ts} +1 -1
- package/out/test/examples/backup.man.test.d.ts.map +1 -0
- package/out/test/examples/{backup.test.js → backup.man.test.js} +1 -1
- package/out/test/examples/backup.man.test.js.map +1 -0
- package/out/test/storage/StorageMySQLDojoReader.man.test.js.map +1 -1
- package/out/test/storage/count.test.js +1 -0
- package/out/test/storage/count.test.js.map +1 -1
- package/out/test/storage/find.test.js +1 -0
- package/out/test/storage/find.test.js.map +1 -1
- package/out/test/storage/update.test.js +3 -1
- package/out/test/storage/update.test.js.map +1 -1
- package/out/test/storage/update2.test.js +5 -2
- package/out/test/storage/update2.test.js.map +1 -1
- package/out/test/utils/TestUtilsWalletStorage.d.ts.map +1 -1
- package/out/test/utils/TestUtilsWalletStorage.js +5 -4
- package/out/test/utils/TestUtilsWalletStorage.js.map +1 -1
- package/out/test/wallet/sync/Wallet.sync.test.js +1 -3
- package/out/test/wallet/sync/Wallet.sync.test.js.map +1 -1
- package/out/tsconfig.all.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/Setup.ts +3 -2
- package/src/sdk/WERR_errors.ts +3 -2
- package/src/sdk/WalletStorage.interfaces.ts +117 -0
- package/src/sdk/index.ts +0 -2
- package/src/services/__tests/verifyBeef.test.ts +18 -0
- package/src/services/providers/__tests/WhatsOnChain.test.ts +16 -1
- package/src/storage/StorageReader.ts +1 -1
- package/src/storage/StorageReaderWriter.ts +2 -1
- package/src/storage/StorageSyncReader.ts +2 -109
- package/src/storage/WalletStorageManager.ts +307 -86
- package/src/storage/schema/KnexMigrations.ts +23 -1
- package/src/storage/schema/entities/User.ts +2 -2
- package/src/storage/schema/entities/__tests/SyncStateTests.test.ts +2 -1
- package/src/storage/schema/entities/__tests/usersTests.test.ts +12 -6
- package/src/storage/schema/tables/User.ts +1 -1
- package/src/storage/sync/StorageMySQLDojoReader.ts +8 -6
- package/test/Wallet/sync/Wallet.updateWalletLegacyTestData.man.test.ts +30 -13
- package/test/Wallet/sync/setActive.test.ts +67 -0
- package/test/storage/StorageMySQLDojoReader.man.test.ts +1 -1
- package/test/storage/count.test.ts +1 -0
- package/test/storage/find.test.ts +1 -0
- package/test/storage/update.test.ts +3 -1
- package/test/storage/update2.test.ts +5 -2
- package/test/utils/TestUtilsWalletStorage.ts +5 -4
- package/test/wallet/sync/Wallet.sync.test.ts +1 -3
- package/out/src/sdk/StorageSyncReader.d.ts +0 -121
- package/out/src/sdk/StorageSyncReader.d.ts.map +0 -1
- package/out/src/sdk/StorageSyncReader.js +0 -3
- package/out/src/sdk/StorageSyncReader.js.map +0 -1
- package/out/src/sdk/StorageSyncReaderWriter.d.ts +0 -89
- package/out/src/sdk/StorageSyncReaderWriter.d.ts.map +0 -1
- package/out/src/sdk/StorageSyncReaderWriter.js +0 -3
- package/out/src/sdk/StorageSyncReaderWriter.js.map +0 -1
- package/out/test/examples/backup.test.d.ts.map +0 -1
- package/out/test/examples/backup.test.js.map +0 -1
- package/src/sdk/StorageSyncReader.ts +0 -173
- package/src/sdk/StorageSyncReaderWriter.ts +0 -277
- /package/test/examples/{backup.test.ts → backup.man.test.ts} +0 -0
package/docs/client.md
CHANGED
|
@@ -14,55 +14,55 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
14
14
|
|
|
15
15
|
| | | |
|
|
16
16
|
| --- | --- | --- |
|
|
17
|
-
| [ArcConfig](#interface-arcconfig) | [PostBeefResult](#interface-postbeefresult) | [
|
|
18
|
-
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [
|
|
19
|
-
| [AuthId](#interface-authid) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [
|
|
20
|
-
| [BaseBlockHeader](#interface-baseblockheader) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [
|
|
21
|
-
| [BlockHeader](#interface-blockheader) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [
|
|
22
|
-
| [BsvExchangeRate](#interface-bsvexchangerate) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [
|
|
23
|
-
| [CertOpsWallet](#interface-certopswallet) | [PostTxsResult](#interface-posttxsresult) | [
|
|
24
|
-
| [CommitNewTxResults](#interface-commitnewtxresults) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [
|
|
25
|
-
| [EntitySyncMap](#interface-entitysyncmap) | [ProvenOrRawTx](#interface-provenorrawtx) | [
|
|
26
|
-
| [EntityTimeStamp](#interface-entitytimestamp) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [
|
|
27
|
-
| [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [
|
|
28
|
-
| [FiatExchangeRates](#interface-fiatexchangerates) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [
|
|
29
|
-
| [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [
|
|
30
|
-
| [FindCertificatesArgs](#interface-findcertificatesargs) | [PurgeParams](#interface-purgeparams) | [
|
|
31
|
-
| [FindCommissionsArgs](#interface-findcommissionsargs) | [PurgeResults](#interface-purgeresults) | [
|
|
32
|
-
| [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [
|
|
33
|
-
| [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [
|
|
34
|
-
| [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [
|
|
35
|
-
| [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [StorageCreateActionResult](#interface-storagecreateactionresult) | [
|
|
36
|
-
| [FindOutputTagsArgs](#interface-findoutputtagsargs) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) | [
|
|
37
|
-
| [FindOutputsArgs](#interface-findoutputsargs) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) | [
|
|
38
|
-
| [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [StorageFeeModel](#interface-storagefeemodel) | [
|
|
39
|
-
| [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) | [
|
|
40
|
-
| [FindProvenTxsArgs](#interface-findproventxsargs) | [StorageIdentity](#interface-storageidentity) | [
|
|
41
|
-
| [FindSincePagedArgs](#interface-findsincepagedargs) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) | [
|
|
42
|
-
| [FindSyncStatesArgs](#interface-findsyncstatesargs) | [StorageProcessActionArgs](#interface-storageprocessactionargs) | [
|
|
43
|
-
| [FindTransactionsArgs](#interface-findtransactionsargs) | [StorageProcessActionResults](#interface-storageprocessactionresults) | [
|
|
44
|
-
| [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [StorageProvenOrReq](#interface-storageprovenorreq) | [
|
|
45
|
-
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [StorageProviderOptions](#interface-storageprovideroptions) | [
|
|
46
|
-
| [FindUsersArgs](#interface-findusersargs) | [StorageReaderOptions](#interface-storagereaderoptions) | [
|
|
47
|
-
| [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) | [
|
|
48
|
-
| [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [
|
|
49
|
-
| [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [
|
|
50
|
-
| [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [
|
|
51
|
-
| [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [
|
|
52
|
-
| [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [
|
|
53
|
-
| [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [
|
|
54
|
-
| [GetMerklePathResult](#interface-getmerklepathresult) | [
|
|
55
|
-
| [GetRawTxResult](#interface-getrawtxresult) | [
|
|
56
|
-
| [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [
|
|
57
|
-
| [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [
|
|
58
|
-
| [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [
|
|
59
|
-
| [GetUtxoStatusResult](#interface-getutxostatusresult) | [
|
|
60
|
-
| [KeyPair](#interface-keypair) | [
|
|
61
|
-
| [MonitorOptions](#interface-monitoroptions) | [
|
|
62
|
-
| [OutPoint](#interface-outpoint) | [
|
|
63
|
-
| [Paged](#interface-paged) | [
|
|
64
|
-
| [PendingSignAction](#interface-pendingsignaction) | [
|
|
65
|
-
| [PendingStorageInput](#interface-pendingstorageinput) | [
|
|
17
|
+
| [ArcConfig](#interface-arcconfig) | [PostBeefResult](#interface-postbeefresult) | [TableSyncState](#interface-tablesyncstate) |
|
|
18
|
+
| [ArcMinerGetTxData](#interface-arcminergettxdata) | [PostBeefResultForTxidApi](#interface-postbeefresultfortxidapi) | [TableTransaction](#interface-tabletransaction) |
|
|
19
|
+
| [AuthId](#interface-authid) | [PostReqsToNetworkDetails](#interface-postreqstonetworkdetails) | [TableTxLabel](#interface-tabletxlabel) |
|
|
20
|
+
| [BaseBlockHeader](#interface-baseblockheader) | [PostReqsToNetworkResult](#interface-postreqstonetworkresult) | [TableTxLabelMap](#interface-tabletxlabelmap) |
|
|
21
|
+
| [BlockHeader](#interface-blockheader) | [PostTxResultForTxid](#interface-posttxresultfortxid) | [TableUser](#interface-tableuser) |
|
|
22
|
+
| [BsvExchangeRate](#interface-bsvexchangerate) | [PostTxResultForTxidError](#interface-posttxresultfortxiderror) | [TaskPurgeParams](#interface-taskpurgeparams) |
|
|
23
|
+
| [CertOpsWallet](#interface-certopswallet) | [PostTxsResult](#interface-posttxsresult) | [TrxToken](#interface-trxtoken) |
|
|
24
|
+
| [CommitNewTxResults](#interface-commitnewtxresults) | [ProcessSyncChunkResult](#interface-processsyncchunkresult) | [TscMerkleProofApi](#interface-tscmerkleproofapi) |
|
|
25
|
+
| [EntitySyncMap](#interface-entitysyncmap) | [ProvenOrRawTx](#interface-provenorrawtx) | [TxScriptOffsets](#interface-txscriptoffsets) |
|
|
26
|
+
| [EntityTimeStamp](#interface-entitytimestamp) | [ProvenTxFromTxidResult](#interface-proventxfromtxidresult) | [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs) |
|
|
27
|
+
| [ExchangeRatesIoApi](#interface-exchangeratesioapi) | [ProvenTxReqHistory](#interface-proventxreqhistory) | [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult) |
|
|
28
|
+
| [FiatExchangeRates](#interface-fiatexchangerates) | [ProvenTxReqHistorySummaryApi](#interface-proventxreqhistorysummaryapi) | [ValidAbortActionArgs](#interface-validabortactionargs) |
|
|
29
|
+
| [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs) | [ProvenTxReqNotify](#interface-proventxreqnotify) | [ValidAcquireCertificateArgs](#interface-validacquirecertificateargs) |
|
|
30
|
+
| [FindCertificatesArgs](#interface-findcertificatesargs) | [PurgeParams](#interface-purgeparams) | [ValidAcquireDirectCertificateArgs](#interface-validacquiredirectcertificateargs) |
|
|
31
|
+
| [FindCommissionsArgs](#interface-findcommissionsargs) | [PurgeResults](#interface-purgeresults) | [ValidAcquireIssuanceCertificateArgs](#interface-validacquireissuancecertificateargs) |
|
|
32
|
+
| [FindForUserSincePagedArgs](#interface-findforusersincepagedargs) | [RequestSyncChunkArgs](#interface-requestsyncchunkargs) | [ValidBasketInsertion](#interface-validbasketinsertion) |
|
|
33
|
+
| [FindMonitorEventsArgs](#interface-findmonitoreventsargs) | [ScriptTemplateParamsBRC29](#interface-scripttemplateparamsbrc29) | [ValidCreateActionArgs](#interface-validcreateactionargs) |
|
|
34
|
+
| [FindOutputBasketsArgs](#interface-findoutputbasketsargs) | [ScriptTemplateUnlock](#interface-scripttemplateunlock) | [ValidCreateActionInput](#interface-validcreateactioninput) |
|
|
35
|
+
| [FindOutputTagMapsArgs](#interface-findoutputtagmapsargs) | [StorageCreateActionResult](#interface-storagecreateactionresult) | [ValidCreateActionOptions](#interface-validcreateactionoptions) |
|
|
36
|
+
| [FindOutputTagsArgs](#interface-findoutputtagsargs) | [StorageCreateTransactionSdkInput](#interface-storagecreatetransactionsdkinput) | [ValidCreateActionOutput](#interface-validcreateactionoutput) |
|
|
37
|
+
| [FindOutputsArgs](#interface-findoutputsargs) | [StorageCreateTransactionSdkOutput](#interface-storagecreatetransactionsdkoutput) | [ValidDiscoverByAttributesArgs](#interface-validdiscoverbyattributesargs) |
|
|
38
|
+
| [FindPartialSincePagedArgs](#interface-findpartialsincepagedargs) | [StorageFeeModel](#interface-storagefeemodel) | [ValidDiscoverByIdentityKeyArgs](#interface-validdiscoverbyidentitykeyargs) |
|
|
39
|
+
| [FindProvenTxReqsArgs](#interface-findproventxreqsargs) | [StorageGetBeefOptions](#interface-storagegetbeefoptions) | [ValidInternalizeActionArgs](#interface-validinternalizeactionargs) |
|
|
40
|
+
| [FindProvenTxsArgs](#interface-findproventxsargs) | [StorageIdentity](#interface-storageidentity) | [ValidInternalizeOutput](#interface-validinternalizeoutput) |
|
|
41
|
+
| [FindSincePagedArgs](#interface-findsincepagedargs) | [StorageInternalizeActionResult](#interface-storageinternalizeactionresult) | [ValidListActionsArgs](#interface-validlistactionsargs) |
|
|
42
|
+
| [FindSyncStatesArgs](#interface-findsyncstatesargs) | [StorageProcessActionArgs](#interface-storageprocessactionargs) | [ValidListCertificatesArgs](#interface-validlistcertificatesargs) |
|
|
43
|
+
| [FindTransactionsArgs](#interface-findtransactionsargs) | [StorageProcessActionResults](#interface-storageprocessactionresults) | [ValidListOutputsArgs](#interface-validlistoutputsargs) |
|
|
44
|
+
| [FindTxLabelMapsArgs](#interface-findtxlabelmapsargs) | [StorageProvenOrReq](#interface-storageprovenorreq) | [ValidProcessActionArgs](#interface-validprocessactionargs) |
|
|
45
|
+
| [FindTxLabelsArgs](#interface-findtxlabelsargs) | [StorageProviderOptions](#interface-storageprovideroptions) | [ValidProcessActionOptions](#interface-validprocessactionoptions) |
|
|
46
|
+
| [FindUsersArgs](#interface-findusersargs) | [StorageReaderOptions](#interface-storagereaderoptions) | [ValidProveCertificateArgs](#interface-validprovecertificateargs) |
|
|
47
|
+
| [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput) | [StorageReaderWriterOptions](#interface-storagereaderwriteroptions) | [ValidRelinquishCertificateArgs](#interface-validrelinquishcertificateargs) |
|
|
48
|
+
| [GenerateChangeSdkChangeOutput](#interface-generatechangesdkchangeoutput) | [StorageSyncReaderOptions](#interface-storagesyncreaderoptions) | [ValidRelinquishOutputArgs](#interface-validrelinquishoutputargs) |
|
|
49
|
+
| [GenerateChangeSdkInput](#interface-generatechangesdkinput) | [SyncChunk](#interface-syncchunk) | [ValidSignActionArgs](#interface-validsignactionargs) |
|
|
50
|
+
| [GenerateChangeSdkOutput](#interface-generatechangesdkoutput) | [SyncError](#interface-syncerror) | [ValidSignActionOptions](#interface-validsignactionoptions) |
|
|
51
|
+
| [GenerateChangeSdkParams](#interface-generatechangesdkparams) | [SyncMap](#interface-syncmap) | [ValidWalletPayment](#interface-validwalletpayment) |
|
|
52
|
+
| [GenerateChangeSdkResult](#interface-generatechangesdkresult) | [TableCertificate](#interface-tablecertificate) | [ValidWalletSignerArgs](#interface-validwalletsignerargs) |
|
|
53
|
+
| [GenerateChangeSdkStorageChange](#interface-generatechangesdkstoragechange) | [TableCertificateField](#interface-tablecertificatefield) | [ValidateGenerateChangeSdkParamsResult](#interface-validategeneratechangesdkparamsresult) |
|
|
54
|
+
| [GetMerklePathResult](#interface-getmerklepathresult) | [TableCertificateX](#interface-tablecertificatex) | [WalletArgs](#interface-walletargs) |
|
|
55
|
+
| [GetRawTxResult](#interface-getrawtxresult) | [TableCommission](#interface-tablecommission) | [WalletServices](#interface-walletservices) |
|
|
56
|
+
| [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail) | [TableMonitorEvent](#interface-tablemonitorevent) | [WalletServicesOptions](#interface-walletservicesoptions) |
|
|
57
|
+
| [GetReqsAndBeefResult](#interface-getreqsandbeefresult) | [TableOutput](#interface-tableoutput) | [WalletSigner](#interface-walletsigner) |
|
|
58
|
+
| [GetUtxoStatusDetails](#interface-getutxostatusdetails) | [TableOutputBasket](#interface-tableoutputbasket) | [WalletStorage](#interface-walletstorage) |
|
|
59
|
+
| [GetUtxoStatusResult](#interface-getutxostatusresult) | [TableOutputTag](#interface-tableoutputtag) | [WalletStorageProvider](#interface-walletstorageprovider) |
|
|
60
|
+
| [KeyPair](#interface-keypair) | [TableOutputTagMap](#interface-tableoutputtagmap) | [WalletStorageReader](#interface-walletstoragereader) |
|
|
61
|
+
| [MonitorOptions](#interface-monitoroptions) | [TableOutputX](#interface-tableoutputx) | [WalletStorageSync](#interface-walletstoragesync) |
|
|
62
|
+
| [OutPoint](#interface-outpoint) | [TableProvenTx](#interface-tableproventx) | [WalletStorageSyncReader](#interface-walletstoragesyncreader) |
|
|
63
|
+
| [Paged](#interface-paged) | [TableProvenTxReq](#interface-tableproventxreq) | [WalletStorageWriter](#interface-walletstoragewriter) |
|
|
64
|
+
| [PendingSignAction](#interface-pendingsignaction) | [TableProvenTxReqDynamics](#interface-tableproventxreqdynamics) | [XValidCreateActionOutput](#interface-xvalidcreateactionoutput) |
|
|
65
|
+
| [PendingStorageInput](#interface-pendingstorageinput) | [TableSettings](#interface-tablesettings) | |
|
|
66
66
|
|
|
67
67
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
68
68
|
|
|
@@ -1944,39 +1944,6 @@ See also: [StorageReaderOptions](./storage.md#interface-storagereaderoptions)
|
|
|
1944
1944
|
|
|
1945
1945
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1946
1946
|
|
|
1947
|
-
---
|
|
1948
|
-
##### Interface: StorageSyncReader
|
|
1949
|
-
|
|
1950
|
-
This is the minimal interface required for a WalletStorageProvider to export data to another provider.
|
|
1951
|
-
|
|
1952
|
-
```ts
|
|
1953
|
-
export interface StorageSyncReader {
|
|
1954
|
-
isAvailable(): boolean;
|
|
1955
|
-
makeAvailable(): Promise<TableSettings>;
|
|
1956
|
-
destroy(): Promise<void>;
|
|
1957
|
-
getSettings(): TableSettings;
|
|
1958
|
-
findUserByIdentityKey(key: string): Promise<TableUser | undefined>;
|
|
1959
|
-
findSyncStates(args: sdk.FindSyncStatesArgs): Promise<TableSyncState[]>;
|
|
1960
|
-
findCertificateFields(args: sdk.FindCertificateFieldsArgs): Promise<TableCertificateField[]>;
|
|
1961
|
-
findCertificates(args: sdk.FindCertificatesArgs): Promise<TableCertificateX[]>;
|
|
1962
|
-
findCommissions(args: sdk.FindCommissionsArgs): Promise<TableCommission[]>;
|
|
1963
|
-
findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>;
|
|
1964
|
-
findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>;
|
|
1965
|
-
findOutputTags(args: sdk.FindOutputTagsArgs): Promise<TableOutputTag[]>;
|
|
1966
|
-
findTransactions(args: sdk.FindTransactionsArgs): Promise<TableTransaction[]>;
|
|
1967
|
-
findTxLabels(args: sdk.FindTxLabelsArgs): Promise<TableTxLabel[]>;
|
|
1968
|
-
getProvenTxsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableProvenTx[]>;
|
|
1969
|
-
getProvenTxReqsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableProvenTxReq[]>;
|
|
1970
|
-
getTxLabelMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableTxLabelMap[]>;
|
|
1971
|
-
getOutputTagMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableOutputTagMap[]>;
|
|
1972
|
-
getSyncChunk(args: RequestSyncChunkArgs): Promise<SyncChunk>;
|
|
1973
|
-
}
|
|
1974
|
-
```
|
|
1975
|
-
|
|
1976
|
-
See also: [FindCertificateFieldsArgs](./client.md#interface-findcertificatefieldsargs), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindCommissionsArgs](./client.md#interface-findcommissionsargs), [FindForUserSincePagedArgs](./client.md#interface-findforusersincepagedargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputTagsArgs](./client.md#interface-findoutputtagsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindSyncStatesArgs](./client.md#interface-findsyncstatesargs), [FindTransactionsArgs](./client.md#interface-findtransactionsargs), [FindTxLabelsArgs](./client.md#interface-findtxlabelsargs), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [SyncChunk](./client.md#interface-syncchunk), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableCommission](./storage.md#interface-tablecommission), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [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), [getSyncChunk](./storage.md#function-getsyncchunk)
|
|
1977
|
-
|
|
1978
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1979
|
-
|
|
1980
1947
|
---
|
|
1981
1948
|
##### Interface: StorageSyncReaderOptions
|
|
1982
1949
|
|
|
@@ -1990,102 +1957,6 @@ See also: [Chain](./client.md#type-chain)
|
|
|
1990
1957
|
|
|
1991
1958
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1992
1959
|
|
|
1993
|
-
---
|
|
1994
|
-
##### Interface: StorageSyncReaderWriter
|
|
1995
|
-
|
|
1996
|
-
This is the minimal interface required for a WalletStorageProvider to import and export data to another provider.
|
|
1997
|
-
|
|
1998
|
-
```ts
|
|
1999
|
-
export interface StorageSyncReaderWriter extends sdk.StorageSyncReader {
|
|
2000
|
-
getProvenOrRawTx(txid: string, trx?: sdk.TrxToken): Promise<sdk.ProvenOrRawTx>;
|
|
2001
|
-
purgeData(params: sdk.PurgeParams, trx?: sdk.TrxToken): Promise<sdk.PurgeResults>;
|
|
2002
|
-
transaction<T>(scope: (trx: sdk.TrxToken) => Promise<T>, trx?: sdk.TrxToken): Promise<T>;
|
|
2003
|
-
findOutputTagMaps(args: sdk.FindOutputTagMapsArgs): Promise<TableOutputTagMap[]>;
|
|
2004
|
-
findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>;
|
|
2005
|
-
findProvenTxs(args: sdk.FindProvenTxsArgs): Promise<TableProvenTx[]>;
|
|
2006
|
-
findTxLabelMaps(args: sdk.FindTxLabelMapsArgs): Promise<TableTxLabelMap[]>;
|
|
2007
|
-
countOutputTagMaps(args: sdk.FindOutputTagMapsArgs): Promise<number>;
|
|
2008
|
-
countProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<number>;
|
|
2009
|
-
countProvenTxs(args: sdk.FindProvenTxsArgs): Promise<number>;
|
|
2010
|
-
countTxLabelMaps(args: sdk.FindTxLabelMapsArgs): Promise<number>;
|
|
2011
|
-
insertProvenTx(tx: TableProvenTx, trx?: sdk.TrxToken): Promise<number>;
|
|
2012
|
-
insertProvenTxReq(tx: TableProvenTxReq, trx?: sdk.TrxToken): Promise<number>;
|
|
2013
|
-
insertUser(user: TableUser, trx?: sdk.TrxToken): Promise<number>;
|
|
2014
|
-
insertCertificate(certificate: TableCertificate, trx?: sdk.TrxToken): Promise<number>;
|
|
2015
|
-
insertCertificateField(certificateField: TableCertificateField, trx?: sdk.TrxToken): Promise<void>;
|
|
2016
|
-
insertOutputBasket(basket: TableOutputBasket, trx?: sdk.TrxToken): Promise<number>;
|
|
2017
|
-
insertTransaction(tx: TableTransaction, trx?: sdk.TrxToken): Promise<number>;
|
|
2018
|
-
insertCommission(commission: TableCommission, trx?: sdk.TrxToken): Promise<number>;
|
|
2019
|
-
insertOutput(output: TableOutput, trx?: sdk.TrxToken): Promise<number>;
|
|
2020
|
-
insertOutputTag(tag: TableOutputTag, trx?: sdk.TrxToken): Promise<number>;
|
|
2021
|
-
insertOutputTagMap(tagMap: TableOutputTagMap, trx?: sdk.TrxToken): Promise<void>;
|
|
2022
|
-
insertTxLabel(label: TableTxLabel, trx?: sdk.TrxToken): Promise<number>;
|
|
2023
|
-
insertTxLabelMap(labelMap: TableTxLabelMap, trx?: sdk.TrxToken): Promise<void>;
|
|
2024
|
-
insertSyncState(syncState: TableSyncState, trx?: sdk.TrxToken): Promise<number>;
|
|
2025
|
-
updateCertificateField(certificateId: number, fieldName: string, update: Partial<TableCertificateField>, trx?: sdk.TrxToken): Promise<number>;
|
|
2026
|
-
updateCertificate(id: number, update: Partial<TableCertificate>, trx?: sdk.TrxToken): Promise<number>;
|
|
2027
|
-
updateCommission(id: number, update: Partial<TableCommission>, trx?: sdk.TrxToken): Promise<number>;
|
|
2028
|
-
updateOutputBasket(id: number, update: Partial<TableOutputBasket>, trx?: sdk.TrxToken): Promise<number>;
|
|
2029
|
-
updateOutput(id: number, update: Partial<TableOutput>, trx?: sdk.TrxToken): Promise<number>;
|
|
2030
|
-
updateOutputTagMap(outputId: number, tagId: number, update: Partial<TableOutputTagMap>, trx?: sdk.TrxToken): Promise<number>;
|
|
2031
|
-
updateOutputTag(id: number, update: Partial<TableOutputTag>, trx?: sdk.TrxToken): Promise<number>;
|
|
2032
|
-
updateProvenTxReq(id: number | number[], update: Partial<TableProvenTxReq>, trx?: sdk.TrxToken): Promise<number>;
|
|
2033
|
-
updateProvenTxReqDynamics(id: number, update: Partial<TableProvenTxReqDynamics>, trx?: sdk.TrxToken): Promise<number>;
|
|
2034
|
-
updateProvenTxReqWithNewProvenTx(args: sdk.UpdateProvenTxReqWithNewProvenTxArgs): Promise<sdk.UpdateProvenTxReqWithNewProvenTxResult>;
|
|
2035
|
-
updateProvenTx(id: number, update: Partial<TableProvenTx>, trx?: sdk.TrxToken): Promise<number>;
|
|
2036
|
-
updateSyncState(id: number, update: Partial<TableSyncState>, trx?: sdk.TrxToken): Promise<number>;
|
|
2037
|
-
updateTransaction(id: number | number[], update: Partial<TableTransaction>, trx?: sdk.TrxToken): Promise<number>;
|
|
2038
|
-
updateTransactionStatus(status: sdk.TransactionStatus, transactionId?: number, userId?: number, reference?: string, trx?: sdk.TrxToken): Promise<void>;
|
|
2039
|
-
updateTransactionsStatus(transactionIds: number[], status: sdk.TransactionStatus): Promise<void>;
|
|
2040
|
-
updateTxLabelMap(transactionId: number, txLabelId: number, update: Partial<TableTxLabelMap>, trx?: sdk.TrxToken): Promise<number>;
|
|
2041
|
-
updateTxLabel(id: number, update: Partial<TableTxLabel>, trx?: sdk.TrxToken): Promise<number>;
|
|
2042
|
-
updateUser(id: number, update: Partial<TableUser>, trx?: sdk.TrxToken): Promise<number>;
|
|
2043
|
-
findCertificateById(id: number, trx?: sdk.TrxToken): Promise<TableCertificate | undefined>;
|
|
2044
|
-
findCommissionById(id: number, trx?: sdk.TrxToken): Promise<TableCommission | undefined>;
|
|
2045
|
-
findOutputById(id: number, trx?: sdk.TrxToken, noScript?: boolean): Promise<TableOutput | undefined>;
|
|
2046
|
-
findOutputBasketById(id: number, trx?: sdk.TrxToken): Promise<TableOutputBasket | undefined>;
|
|
2047
|
-
findProvenTxById(id: number, trx?: sdk.TrxToken | undefined): Promise<TableProvenTx | undefined>;
|
|
2048
|
-
findProvenTxReqById(id: number, trx?: sdk.TrxToken | undefined): Promise<TableProvenTxReq | undefined>;
|
|
2049
|
-
findSyncStateById(id: number, trx?: sdk.TrxToken): Promise<TableSyncState | undefined>;
|
|
2050
|
-
findTransactionById(id: number, trx?: sdk.TrxToken, noRawTx?: boolean): Promise<TableTransaction | undefined>;
|
|
2051
|
-
findTxLabelById(id: number, trx?: sdk.TrxToken): Promise<TableTxLabel | undefined>;
|
|
2052
|
-
findOutputTagById(id: number, trx?: sdk.TrxToken): Promise<TableOutputTag | undefined>;
|
|
2053
|
-
findUserById(id: number, trx?: sdk.TrxToken): Promise<TableUser | undefined>;
|
|
2054
|
-
findOrInsertUser(identityKey: string, trx?: sdk.TrxToken): Promise<{
|
|
2055
|
-
user: TableUser;
|
|
2056
|
-
isNew: boolean;
|
|
2057
|
-
}>;
|
|
2058
|
-
findOrInsertTransaction(newTx: TableTransaction, trx?: sdk.TrxToken): Promise<{
|
|
2059
|
-
tx: TableTransaction;
|
|
2060
|
-
isNew: boolean;
|
|
2061
|
-
}>;
|
|
2062
|
-
findOrInsertOutputBasket(userId: number, name: string, trx?: sdk.TrxToken): Promise<TableOutputBasket>;
|
|
2063
|
-
findOrInsertTxLabel(userId: number, label: string, trx?: sdk.TrxToken): Promise<TableTxLabel>;
|
|
2064
|
-
findOrInsertTxLabelMap(transactionId: number, txLabelId: number, trx?: sdk.TrxToken): Promise<TableTxLabelMap>;
|
|
2065
|
-
findOrInsertOutputTag(userId: number, tag: string, trx?: sdk.TrxToken): Promise<TableOutputTag>;
|
|
2066
|
-
findOrInsertOutputTagMap(outputId: number, outputTagId: number, trx?: sdk.TrxToken): Promise<TableOutputTagMap>;
|
|
2067
|
-
findOrInsertSyncStateAuth(auth: sdk.AuthId, storageIdentityKey: string, storageName: string): Promise<{
|
|
2068
|
-
syncState: TableSyncState;
|
|
2069
|
-
isNew: boolean;
|
|
2070
|
-
}>;
|
|
2071
|
-
findOrInsertProvenTxReq(newReq: TableProvenTxReq, trx?: sdk.TrxToken): Promise<{
|
|
2072
|
-
req: TableProvenTxReq;
|
|
2073
|
-
isNew: boolean;
|
|
2074
|
-
}>;
|
|
2075
|
-
findOrInsertProvenTx(newProven: TableProvenTx, trx?: sdk.TrxToken): Promise<{
|
|
2076
|
-
proven: TableProvenTx;
|
|
2077
|
-
isNew: boolean;
|
|
2078
|
-
}>;
|
|
2079
|
-
findUsers(args: sdk.FindUsersArgs): Promise<TableUser[]>;
|
|
2080
|
-
tagOutput(partial: Partial<TableOutput>, tag: string, trx?: sdk.TrxToken): Promise<void>;
|
|
2081
|
-
processSyncChunk(args: sdk.RequestSyncChunkArgs, chunk: sdk.SyncChunk): Promise<sdk.ProcessSyncChunkResult>;
|
|
2082
|
-
}
|
|
2083
|
-
```
|
|
2084
|
-
|
|
2085
|
-
See also: [AuthId](./client.md#interface-authid), [FindOutputTagMapsArgs](./client.md#interface-findoutputtagmapsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [FindProvenTxsArgs](./client.md#interface-findproventxsargs), [FindTxLabelMapsArgs](./client.md#interface-findtxlabelmapsargs), [FindUsersArgs](./client.md#interface-findusersargs), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [ProvenOrRawTx](./client.md#interface-provenorrawtx), [PurgeParams](./client.md#interface-purgeparams), [PurgeResults](./client.md#interface-purgeresults), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageSyncReader](./storage.md#class-storagesyncreader), [SyncChunk](./client.md#interface-syncchunk), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateField](./storage.md#interface-tablecertificatefield), [TableCommission](./storage.md#interface-tablecommission), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableOutputTag](./storage.md#interface-tableoutputtag), [TableOutputTagMap](./storage.md#interface-tableoutputtagmap), [TableProvenTx](./storage.md#interface-tableproventx), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableProvenTxReqDynamics](./storage.md#interface-tableproventxreqdynamics), [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), [UpdateProvenTxReqWithNewProvenTxArgs](./client.md#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](./client.md#interface-updateproventxreqwithnewproventxresult), [purgeData](./storage.md#function-purgedata)
|
|
2086
|
-
|
|
2087
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2088
|
-
|
|
2089
1960
|
---
|
|
2090
1961
|
##### Interface: SyncChunk
|
|
2091
1962
|
|
|
@@ -2678,7 +2549,7 @@ export interface TableUser extends sdk.EntityTimeStamp {
|
|
|
2678
2549
|
updated_at: Date;
|
|
2679
2550
|
userId: number;
|
|
2680
2551
|
identityKey: string;
|
|
2681
|
-
activeStorage
|
|
2552
|
+
activeStorage: string;
|
|
2682
2553
|
}
|
|
2683
2554
|
```
|
|
2684
2555
|
|
|
@@ -2689,7 +2560,7 @@ See also: [EntityTimeStamp](./client.md#interface-entitytimestamp)
|
|
|
2689
2560
|
The storageIdentityKey value of the active wallet storage.
|
|
2690
2561
|
|
|
2691
2562
|
```ts
|
|
2692
|
-
activeStorage
|
|
2563
|
+
activeStorage: string
|
|
2693
2564
|
```
|
|
2694
2565
|
|
|
2695
2566
|
###### Property identityKey
|
|
@@ -3678,6 +3549,31 @@ export interface WalletStorageSync extends WalletStorageWriter {
|
|
|
3678
3549
|
|
|
3679
3550
|
See also: [AuthId](./client.md#interface-authid), [ProcessSyncChunkResult](./client.md#interface-processsyncchunkresult), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [SyncChunk](./client.md#interface-syncchunk), [TableSyncState](./storage.md#interface-tablesyncstate), [WalletStorageWriter](./client.md#interface-walletstoragewriter), [getSyncChunk](./storage.md#function-getsyncchunk)
|
|
3680
3551
|
|
|
3552
|
+
###### Method setActive
|
|
3553
|
+
|
|
3554
|
+
Updagte the `activeStorage` property of the authenticated user by their `userId`.
|
|
3555
|
+
|
|
3556
|
+
```ts
|
|
3557
|
+
setActive(auth: sdk.AuthId, newActiveStorageIdentityKey: string): Promise<number>
|
|
3558
|
+
```
|
|
3559
|
+
See also: [AuthId](./client.md#interface-authid)
|
|
3560
|
+
|
|
3561
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3562
|
+
|
|
3563
|
+
---
|
|
3564
|
+
##### Interface: WalletStorageSyncReader
|
|
3565
|
+
|
|
3566
|
+
This is the minimal interface required for a WalletStorageProvider to export data to another provider.
|
|
3567
|
+
|
|
3568
|
+
```ts
|
|
3569
|
+
export interface WalletStorageSyncReader {
|
|
3570
|
+
makeAvailable(): Promise<TableSettings>;
|
|
3571
|
+
getSyncChunk(args: RequestSyncChunkArgs): Promise<SyncChunk>;
|
|
3572
|
+
}
|
|
3573
|
+
```
|
|
3574
|
+
|
|
3575
|
+
See also: [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [SyncChunk](./client.md#interface-syncchunk), [TableSettings](./storage.md#interface-tablesettings), [getSyncChunk](./storage.md#function-getsyncchunk)
|
|
3576
|
+
|
|
3681
3577
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3682
3578
|
|
|
3683
3579
|
---
|
|
@@ -4842,7 +4738,7 @@ export class EntityUser extends EntityBase<TableUser> {
|
|
|
4842
4738
|
get identityKey()
|
|
4843
4739
|
set identityKey(v: string)
|
|
4844
4740
|
get activeStorage()
|
|
4845
|
-
set activeStorage(v: string
|
|
4741
|
+
set activeStorage(v: string)
|
|
4846
4742
|
override get id(): number
|
|
4847
4743
|
override set id(v: number)
|
|
4848
4744
|
override get entityName(): string
|
|
@@ -5966,7 +5862,7 @@ The ability to construct a properly configured instance of this class implies au
|
|
|
5966
5862
|
As such there are no user specific authenticated access checks implied in the implementation of any of these methods.
|
|
5967
5863
|
|
|
5968
5864
|
```ts
|
|
5969
|
-
export abstract class StorageReader implements sdk.
|
|
5865
|
+
export abstract class StorageReader implements sdk.WalletStorageSyncReader {
|
|
5970
5866
|
chain: sdk.Chain;
|
|
5971
5867
|
_settings?: TableSettings;
|
|
5972
5868
|
whenLastAccess?: Date;
|
|
@@ -6015,7 +5911,7 @@ export abstract class StorageReader implements sdk.StorageSyncReader {
|
|
|
6015
5911
|
}
|
|
6016
5912
|
```
|
|
6017
5913
|
|
|
6018
|
-
See also: [Chain](./client.md#type-chain), [DBType](./storage.md#type-dbtype), [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), [FindOutputTagsArgs](./client.md#interface-findoutputtagsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindSyncStatesArgs](./client.md#interface-findsyncstatesargs), [FindTransactionsArgs](./client.md#interface-findtransactionsargs), [FindTxLabelsArgs](./client.md#interface-findtxlabelsargs), [FindUsersArgs](./client.md#interface-findusersargs), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageReaderOptions](./storage.md#interface-storagereaderoptions), [
|
|
5914
|
+
See also: [Chain](./client.md#type-chain), [DBType](./storage.md#type-dbtype), [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), [FindOutputTagsArgs](./client.md#interface-findoutputtagsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindSyncStatesArgs](./client.md#interface-findsyncstatesargs), [FindTransactionsArgs](./client.md#interface-findtransactionsargs), [FindTxLabelsArgs](./client.md#interface-findtxlabelsargs), [FindUsersArgs](./client.md#interface-findusersargs), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageReaderOptions](./storage.md#interface-storagereaderoptions), [SyncChunk](./client.md#interface-syncchunk), [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), [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), [TrxToken](./client.md#interface-trxtoken), [WalletStorageSyncReader](./client.md#interface-walletstoragesyncreader), [getSyncChunk](./storage.md#function-getsyncchunk)
|
|
6019
5915
|
|
|
6020
5916
|
###### Method validateEntityDate
|
|
6021
5917
|
|
|
@@ -6139,31 +6035,15 @@ Constructed from an `auth` object that must minimally include the authenticated
|
|
|
6139
6035
|
and the `StorageBaseReader` to be protected.
|
|
6140
6036
|
|
|
6141
6037
|
```ts
|
|
6142
|
-
export class StorageSyncReader implements sdk.
|
|
6038
|
+
export class StorageSyncReader implements sdk.WalletStorageSyncReader {
|
|
6143
6039
|
constructor(public auth: sdk.AuthId, public storage: StorageReader)
|
|
6144
|
-
isAvailable(): boolean
|
|
6145
6040
|
async makeAvailable(): Promise<TableSettings>
|
|
6146
6041
|
destroy(): Promise<void>
|
|
6147
|
-
getSettings(): TableSettings
|
|
6148
6042
|
async getSyncChunk(args: sdk.RequestSyncChunkArgs): Promise<sdk.SyncChunk>
|
|
6149
|
-
async findUserByIdentityKey(key: string): Promise<TableUser | undefined>
|
|
6150
|
-
async findSyncStates(args: sdk.FindSyncStatesArgs): Promise<TableSyncState[]>
|
|
6151
|
-
async findCertificateFields(args: sdk.FindCertificateFieldsArgs): Promise<TableCertificateField[]>
|
|
6152
|
-
async findCertificates(args: sdk.FindCertificatesArgs): Promise<TableCertificateX[]>
|
|
6153
|
-
async findCommissions(args: sdk.FindCommissionsArgs): Promise<TableCommission[]>
|
|
6154
|
-
async findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>
|
|
6155
|
-
async findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>
|
|
6156
|
-
async findOutputTags(args: sdk.FindOutputTagsArgs): Promise<TableOutputTag[]>
|
|
6157
|
-
async findTransactions(args: sdk.FindTransactionsArgs): Promise<TableTransaction[]>
|
|
6158
|
-
async findTxLabels(args: sdk.FindTxLabelsArgs): Promise<TableTxLabel[]>
|
|
6159
|
-
async getProvenTxsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableProvenTx[]>
|
|
6160
|
-
async getProvenTxReqsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableProvenTxReq[]>
|
|
6161
|
-
async getTxLabelMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableTxLabelMap[]>
|
|
6162
|
-
async getOutputTagMapsForUser(args: sdk.FindForUserSincePagedArgs): Promise<TableOutputTagMap[]>
|
|
6163
6043
|
}
|
|
6164
6044
|
```
|
|
6165
6045
|
|
|
6166
|
-
See also: [AuthId](./client.md#interface-authid), [
|
|
6046
|
+
See also: [AuthId](./client.md#interface-authid), [RequestSyncChunkArgs](./client.md#interface-requestsyncchunkargs), [StorageReader](./storage.md#class-storagereader), [SyncChunk](./client.md#interface-syncchunk), [TableSettings](./storage.md#interface-tablesettings), [WalletStorageSyncReader](./client.md#interface-walletstoragesyncreader), [getSyncChunk](./storage.md#function-getsyncchunk)
|
|
6167
6047
|
|
|
6168
6048
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6169
6049
|
|
|
@@ -6605,7 +6485,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6605
6485
|
---
|
|
6606
6486
|
##### Class: WERR_NOT_ACTIVE
|
|
6607
6487
|
|
|
6608
|
-
WalletStorageManager is not accessing user's active storage.
|
|
6488
|
+
WalletStorageManager is not accessing user's active storage or there are conflicting active stores configured.
|
|
6609
6489
|
|
|
6610
6490
|
```ts
|
|
6611
6491
|
export class WERR_NOT_ACTIVE extends WalletError {
|
|
@@ -6940,10 +6820,13 @@ for these services.
|
|
|
6940
6820
|
|
|
6941
6821
|
```ts
|
|
6942
6822
|
export class WalletStorageManager implements sdk.WalletStorage {
|
|
6943
|
-
|
|
6823
|
+
_stores: ManagedStorage[] = [];
|
|
6824
|
+
_isAvailable: boolean = false;
|
|
6825
|
+
_active?: ManagedStorage;
|
|
6826
|
+
_backups?: ManagedStorage[];
|
|
6827
|
+
_conflictingActives?: ManagedStorage[];
|
|
6944
6828
|
_authId: sdk.AuthId;
|
|
6945
6829
|
_services?: sdk.WalletServices;
|
|
6946
|
-
_userIdentityKeyToId: Record<string, number> = {};
|
|
6947
6830
|
_readerCount: number = 0;
|
|
6948
6831
|
_writerCount: number = 0;
|
|
6949
6832
|
_isSingleWriter: boolean = true;
|
|
@@ -6951,9 +6834,19 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
6951
6834
|
_storageProviderLocked: boolean = false;
|
|
6952
6835
|
constructor(identityKey: string, active?: sdk.WalletStorageProvider, backups?: sdk.WalletStorageProvider[])
|
|
6953
6836
|
isStorageProvider(): boolean
|
|
6954
|
-
|
|
6837
|
+
isAvailable(): boolean
|
|
6838
|
+
get isActiveEnabled(): boolean
|
|
6839
|
+
canMakeAvailable(): boolean
|
|
6840
|
+
async makeAvailable(): Promise<TableSettings>
|
|
6955
6841
|
async getAuth(mustBeActive?: boolean): Promise<sdk.AuthId>
|
|
6842
|
+
async getUserId(): Promise<number>
|
|
6956
6843
|
getActive(): sdk.WalletStorageProvider
|
|
6844
|
+
getActiveSettings(): TableSettings
|
|
6845
|
+
getActiveUser(): TableUser
|
|
6846
|
+
getActiveStore(): string
|
|
6847
|
+
getBackupStores(): string[]
|
|
6848
|
+
getConflictingStores(): string[]
|
|
6849
|
+
getAllStores(): string[]
|
|
6957
6850
|
async getActiveForWriter(): Promise<sdk.WalletStorageWriter>
|
|
6958
6851
|
async getActiveForReader(): Promise<sdk.WalletStorageReader>
|
|
6959
6852
|
async getActiveForSync(): Promise<sdk.WalletStorageSync>
|
|
@@ -6963,12 +6856,10 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
6963
6856
|
async runAsSync<R>(sync: (active: sdk.WalletStorageSync) => Promise<R>, activeSync?: sdk.WalletStorageSync): Promise<R>
|
|
6964
6857
|
async runAsStorageProvider<R>(sync: (active: StorageProvider) => Promise<R>): Promise<R>
|
|
6965
6858
|
isActiveStorageProvider(): boolean
|
|
6966
|
-
isAvailable(): boolean
|
|
6967
6859
|
async addWalletStorageProvider(provider: sdk.WalletStorageProvider): Promise<void>
|
|
6968
6860
|
setServices(v: sdk.WalletServices)
|
|
6969
6861
|
getServices(): sdk.WalletServices
|
|
6970
6862
|
getSettings(): TableSettings
|
|
6971
|
-
async makeAvailable(): Promise<TableSettings>
|
|
6972
6863
|
async migrate(storageName: string, storageIdentityKey: string): Promise<string>
|
|
6973
6864
|
async destroy(): Promise<void>
|
|
6974
6865
|
async findOrInsertUser(identityKey: string): Promise<{
|
|
@@ -6989,17 +6880,63 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
6989
6880
|
async findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>
|
|
6990
6881
|
async findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>
|
|
6991
6882
|
async findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>
|
|
6992
|
-
async syncFromReader(identityKey: string, reader:
|
|
6993
|
-
|
|
6994
|
-
|
|
6883
|
+
async syncFromReader(identityKey: string, reader: sdk.WalletStorageSyncReader, activeSync?: sdk.WalletStorageSync, log: string = ""): Promise<{
|
|
6884
|
+
inserts: number;
|
|
6885
|
+
updates: number;
|
|
6886
|
+
log: string;
|
|
6887
|
+
}>
|
|
6888
|
+
async syncToWriter(auth: sdk.AuthId, writer: sdk.WalletStorageProvider, activeSync?: sdk.WalletStorageSync, log: string = ""): Promise<{
|
|
6995
6889
|
inserts: number;
|
|
6996
6890
|
updates: number;
|
|
6891
|
+
log: string;
|
|
6997
6892
|
}>
|
|
6998
|
-
async
|
|
6893
|
+
async updateBackups(activeSync?: sdk.WalletStorageSync)
|
|
6894
|
+
async setActive(storageIdentityKey: string): Promise<string>
|
|
6999
6895
|
}
|
|
7000
6896
|
```
|
|
7001
6897
|
|
|
7002
|
-
See also: [AuthId](./client.md#interface-authid), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [StorageProvider](./storage.md#class-storageprovider), [
|
|
6898
|
+
See also: [AuthId](./client.md#interface-authid), [FindCertificatesArgs](./client.md#interface-findcertificatesargs), [FindOutputBasketsArgs](./client.md#interface-findoutputbasketsargs), [FindOutputsArgs](./client.md#interface-findoutputsargs), [FindProvenTxReqsArgs](./client.md#interface-findproventxreqsargs), [StorageCreateActionResult](./client.md#interface-storagecreateactionresult), [StorageProcessActionArgs](./client.md#interface-storageprocessactionargs), [StorageProcessActionResults](./client.md#interface-storageprocessactionresults), [StorageProvider](./storage.md#class-storageprovider), [TableCertificate](./storage.md#interface-tablecertificate), [TableCertificateX](./storage.md#interface-tablecertificatex), [TableOutput](./storage.md#interface-tableoutput), [TableOutputBasket](./storage.md#interface-tableoutputbasket), [TableProvenTxReq](./storage.md#interface-tableproventxreq), [TableSettings](./storage.md#interface-tablesettings), [TableUser](./storage.md#interface-tableuser), [ValidCreateActionArgs](./client.md#interface-validcreateactionargs), [ValidListActionsArgs](./client.md#interface-validlistactionsargs), [ValidListCertificatesArgs](./client.md#interface-validlistcertificatesargs), [ValidListOutputsArgs](./client.md#interface-validlistoutputsargs), [WalletServices](./client.md#interface-walletservices), [WalletStorage](./client.md#interface-walletstorage), [WalletStorageProvider](./client.md#interface-walletstorageprovider), [WalletStorageReader](./client.md#interface-walletstoragereader), [WalletStorageSync](./client.md#interface-walletstoragesync), [WalletStorageSyncReader](./client.md#interface-walletstoragesyncreader), [WalletStorageWriter](./client.md#interface-walletstoragewriter), [createAction](./storage.md#function-createaction), [internalizeAction](./storage.md#function-internalizeaction), [listActions](./storage.md#function-listactions), [listCertificates](./storage.md#function-listcertificates), [listOutputs](./storage.md#function-listoutputs), [processAction](./storage.md#function-processaction)
|
|
6899
|
+
|
|
6900
|
+
###### Property _active
|
|
6901
|
+
|
|
6902
|
+
The current active store which is only enabled if the store's user record activeStorage property matches its settings record storageIdentityKey property
|
|
6903
|
+
|
|
6904
|
+
```ts
|
|
6905
|
+
_active?: ManagedStorage
|
|
6906
|
+
```
|
|
6907
|
+
|
|
6908
|
+
###### Property _authId
|
|
6909
|
+
|
|
6910
|
+
identityKey is always valid, userId and isActive are valid only if _isAvailable
|
|
6911
|
+
|
|
6912
|
+
```ts
|
|
6913
|
+
_authId: sdk.AuthId
|
|
6914
|
+
```
|
|
6915
|
+
See also: [AuthId](./client.md#interface-authid)
|
|
6916
|
+
|
|
6917
|
+
###### Property _backups
|
|
6918
|
+
|
|
6919
|
+
Stores to which state is pushed by updateBackups.
|
|
6920
|
+
|
|
6921
|
+
```ts
|
|
6922
|
+
_backups?: ManagedStorage[]
|
|
6923
|
+
```
|
|
6924
|
+
|
|
6925
|
+
###### Property _conflictingActives
|
|
6926
|
+
|
|
6927
|
+
Stores whose user record activeStorage property disagrees with the active store's user record activeStorage property.
|
|
6928
|
+
|
|
6929
|
+
```ts
|
|
6930
|
+
_conflictingActives?: ManagedStorage[]
|
|
6931
|
+
```
|
|
6932
|
+
|
|
6933
|
+
###### Property _isAvailable
|
|
6934
|
+
|
|
6935
|
+
True if makeAvailable has been run and access to managed stores (active) is allowed
|
|
6936
|
+
|
|
6937
|
+
```ts
|
|
6938
|
+
_isAvailable: boolean = false
|
|
6939
|
+
```
|
|
7003
6940
|
|
|
7004
6941
|
###### Property _isSingleWriter
|
|
7005
6942
|
|
|
@@ -7010,6 +6947,23 @@ queue the blocked requests so they get executed in order when released.
|
|
|
7010
6947
|
_isSingleWriter: boolean = true
|
|
7011
6948
|
```
|
|
7012
6949
|
|
|
6950
|
+
###### Property _readerCount
|
|
6951
|
+
|
|
6952
|
+
How many read access operations are pending
|
|
6953
|
+
|
|
6954
|
+
```ts
|
|
6955
|
+
_readerCount: number = 0
|
|
6956
|
+
```
|
|
6957
|
+
|
|
6958
|
+
###### Property _services
|
|
6959
|
+
|
|
6960
|
+
Configured services if any. If valid, shared with stores (which may ignore it).
|
|
6961
|
+
|
|
6962
|
+
```ts
|
|
6963
|
+
_services?: sdk.WalletServices
|
|
6964
|
+
```
|
|
6965
|
+
See also: [WalletServices](./client.md#interface-walletservices)
|
|
6966
|
+
|
|
7013
6967
|
###### Property _storageProviderLocked
|
|
7014
6968
|
|
|
7015
6969
|
if true, allow no new reader or writers or sync to proceed.
|
|
@@ -7019,6 +6973,14 @@ queue the blocked requests so they get executed in order when released.
|
|
|
7019
6973
|
_storageProviderLocked: boolean = false
|
|
7020
6974
|
```
|
|
7021
6975
|
|
|
6976
|
+
###### Property _stores
|
|
6977
|
+
|
|
6978
|
+
All configured stores including current active, backups, and conflicting actives.
|
|
6979
|
+
|
|
6980
|
+
```ts
|
|
6981
|
+
_stores: ManagedStorage[] = []
|
|
6982
|
+
```
|
|
6983
|
+
|
|
7022
6984
|
###### Property _syncLocked
|
|
7023
6985
|
|
|
7024
6986
|
if true, allow no new reader or writers to proceed.
|
|
@@ -7028,6 +6990,24 @@ queue the blocked requests so they get executed in order when released.
|
|
|
7028
6990
|
_syncLocked: boolean = false
|
|
7029
6991
|
```
|
|
7030
6992
|
|
|
6993
|
+
###### Property _writerCount
|
|
6994
|
+
|
|
6995
|
+
How many write access operations are pending
|
|
6996
|
+
|
|
6997
|
+
```ts
|
|
6998
|
+
_writerCount: number = 0
|
|
6999
|
+
```
|
|
7000
|
+
|
|
7001
|
+
###### Method canMakeAvailable
|
|
7002
|
+
|
|
7003
|
+
```ts
|
|
7004
|
+
canMakeAvailable(): boolean
|
|
7005
|
+
```
|
|
7006
|
+
|
|
7007
|
+
Returns
|
|
7008
|
+
|
|
7009
|
+
true if at least one WalletStorageProvider has been added.
|
|
7010
|
+
|
|
7031
7011
|
###### Method isActiveStorageProvider
|
|
7032
7012
|
|
|
7033
7013
|
```ts
|
|
@@ -7038,6 +7018,26 @@ Returns
|
|
|
7038
7018
|
|
|
7039
7019
|
true if the active `WalletStorageProvider` also implements `StorageProvider`
|
|
7040
7020
|
|
|
7021
|
+
###### Method makeAvailable
|
|
7022
|
+
|
|
7023
|
+
This async function must be called after construction and before
|
|
7024
|
+
any other async function can proceed.
|
|
7025
|
+
|
|
7026
|
+
Runs through `_stores` validating all properties and partitioning across `_active`, `_backups`, `_conflictingActives`.
|
|
7027
|
+
|
|
7028
|
+
```ts
|
|
7029
|
+
async makeAvailable(): Promise<TableSettings>
|
|
7030
|
+
```
|
|
7031
|
+
See also: [TableSettings](./storage.md#interface-tablesettings)
|
|
7032
|
+
|
|
7033
|
+
Returns
|
|
7034
|
+
|
|
7035
|
+
from the active storage.
|
|
7036
|
+
|
|
7037
|
+
Throws
|
|
7038
|
+
|
|
7039
|
+
WERR_INVALID_PARAMETER if canMakeAvailable returns false.
|
|
7040
|
+
|
|
7041
7041
|
###### Method runAsSync
|
|
7042
7042
|
|
|
7043
7043
|
```ts
|
|
@@ -7056,8 +7056,10 @@ Argument Details
|
|
|
7056
7056
|
|
|
7057
7057
|
Updates backups and switches to new active storage provider from among current backup providers.
|
|
7058
7058
|
|
|
7059
|
+
Also resolves conflicting actives.
|
|
7060
|
+
|
|
7059
7061
|
```ts
|
|
7060
|
-
async setActive(storageIdentityKey: string): Promise<
|
|
7062
|
+
async setActive(storageIdentityKey: string): Promise<string>
|
|
7061
7063
|
```
|
|
7062
7064
|
|
|
7063
7065
|
Argument Details
|
package/docs/setup.md
CHANGED
|
@@ -493,7 +493,7 @@ DEV_KEYS = '{
|
|
|
493
493
|
const identityKey = rootKey.toPublicKey().toString();
|
|
494
494
|
const keyDeriver = new KeyDeriver(rootKey);
|
|
495
495
|
const storage = new WalletStorageManager(identityKey, args.active, args.backups);
|
|
496
|
-
if (storage.
|
|
496
|
+
if (storage.canMakeAvailable())
|
|
497
497
|
await storage.makeAvailable();
|
|
498
498
|
const serviceOptions = Services.createDefaultOptions(chain);
|
|
499
499
|
serviceOptions.taalApiKey = args.env.taalApiKey;
|
|
@@ -691,7 +691,7 @@ static async createWallet(args: SetupWalletArgs): Promise<SetupWallet> {
|
|
|
691
691
|
const identityKey = rootKey.toPublicKey().toString();
|
|
692
692
|
const keyDeriver = new KeyDeriver(rootKey);
|
|
693
693
|
const storage = new WalletStorageManager(identityKey, args.active, args.backups);
|
|
694
|
-
if (storage.
|
|
694
|
+
if (storage.canMakeAvailable())
|
|
695
695
|
await storage.makeAvailable();
|
|
696
696
|
const serviceOptions = Services.createDefaultOptions(chain);
|
|
697
697
|
serviceOptions.taalApiKey = args.env.taalApiKey;
|