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