ZcashLightClientKit/Sources/ZcashLightClientKit/Error/ZcashErrorCode.swift

307 lines
19 KiB
Swift
Raw Normal View History

[#361] Introduce ZcashError (#1005) This PR introduces `ZcashError` enum. This enum represents any error that can be thrown inside of the SDK and outside of the SDK. Also `ZcashError` is used in `LightWalletGRPCService` and handled in `CompactBlockProcessor` as example. Why enum? First I tried this with some structure which contained code, message and underlyingError. Problem was when some specific place in the SDK would like to attach some additional data to error. I didn't want to add some generic dictionary to store anything with the error. So I used enum to identify error. Each member can have specified amount of associated values. So specific error can bring some context data. And it's type safe. Each error has also a code. Relationship between errors and codes is 1:1. It may looks bit redundant but it's important. The client app now can choose how to process errors. Either identify those by the error itself or by code. Definition or errors and codes is in `ZcashErrorDefinition`. And then `ZcashError` and `ZcashErrorCode` are generated by Sourcery. Thanks to this it is easier to maintain the final code. And it gives us ability to generate any kind of documentation for the errors and codes. I created simple example of this in this PR. And it doesn't make the SDK completely dependent on the Sourcery. Final structures aren't super complicated and can be written manually if needed. [#923] Update error handling in DatabaseStorageManager.swift - cleanup of DatabaseStorageManager, not used anymore - ZcashError for SimpleConnectionProvider Revert "[#923] Update error handling in DatabaseStorageManager.swift" This reverts commit 94e028d31a0f6635800c297eb741db74c6a6ff45. Fix script which generates ZcashError [#922] Update error handling in DatabaseMigrationManager.swift Closes #922 [#923] Update error handling in DatabaseStorageManager.swift - The DatabaseStorageManager is not used so I deleted it - SimpleConnectionProvider's errors updated Fix tests [#955] Update error handling in SaplingParameterDownloader Closes #955 [#936] Update error handling in NotesDao Closes #936 [#935] Update error handling in BlockDao Closes #935 [#931] InternalSyncProgress.computeNextState doesn't need to throw Closes #931 [#950] Update error handling in rust backend Closes #949 Closes #950 [#941] Update error handling in AccountEntity Closes #941 [#928] Update error handling in FSCompactBlockRepository Closes #928 [#925] Update error handling in BlockDownloaderService (#974) - BlockDownloaderService errors updated [#924] Update error handling in BlockDownloader (#973) - BlockDownloaderStream nextBlock updated [#942] Update error handling in TransactionEntity (#977) - ZcashTransaction init errors converted to the ZcashError [#939] Update error handling in TransactionDao (#976) - TransactionRepositoryError removed and replaced with ZcashError - all TransactionDAO errors converted to ZcashError [#943] Update error handling in ZcashCompactBlock Closes #943 [#945] Update error handling in Memo Closes #945 [#934] Update error handling in Checkpoint Closes #944 Closes #934 [#938] Update error handling in PendingTransactionDao Closes #938 [#926] Update error handling in BlockEnhancer - WIP, switching to transaction repository to unblock this ticket [#926] Update error handling in BlockEnhancer - enhancer's errors done [#926] Update error handling in BlockEnhancer (#994) - cleanup [#952] Update error handling in DerivationTool Closes #952 [#932] Update error handling in BlockValidator Closes #932 [#940] Update error handling in UnspentTransactionOutputDao Closes #940 [#946] Update error handling in WalletTypes Closes #946 [#954] Update error handling in WalletTransactionEncoder Closes #954 [#953] Update error handling in PersistentTransactionManager Closes #953 [#956] Update error handling in Initializer Closes #956 [#947] Update error handling in Zatoshi (#996) - Zatoshi's errors converted to ZcashError [#927] Update error handling in UTXOFetcher (#997) - UTXOFetcher resolved Use let instead of var where applicable In the SDK `var` was used on places where `let` would be sufficient. And default strategy in Swift should use use `let` until mutability is required. So all these places are changed. No logic is changed. [#933] Update error handling in CompactBlockProcessor - CompactBlockProcessor's errors refactored to ZcashError [#933] Update error handling in CompactBlockProcessor #999 - comments addressed [#951] Update error handling in SDKSynchronizer - SDKSynchronizer's errors refactored to ZcashError [#951] Update error handling in SDKSynchronizer (#1002) - comments resolved Make DerivationTool constructor public DerivationTool.init should be public. This was removed by accident when adopting async. [#361] Add changelog
2023-04-24 14:15:20 -07:00
// Generated using Sourcery 2.0.2 https://github.com/krzysztofzablocki/Sourcery
// DO NOT EDIT
/*
!!!!! To edit this file go to ZcashErrorCodeDefinition first and udate/add codes. Then run generateErrorCode.sh script to regenerate this file.
By design each error code should be used only at one place in the app. Thanks to that it is possible to identify exact line in the code from which the
error originates. And it can help with debugging.
*/
public enum ZcashErrorCode: String {
/// Some error happened that is not handled as `ZcashError`.
case unknown = "ZUNKWN0001"
[#361] Introduce ZcashError (#1005) This PR introduces `ZcashError` enum. This enum represents any error that can be thrown inside of the SDK and outside of the SDK. Also `ZcashError` is used in `LightWalletGRPCService` and handled in `CompactBlockProcessor` as example. Why enum? First I tried this with some structure which contained code, message and underlyingError. Problem was when some specific place in the SDK would like to attach some additional data to error. I didn't want to add some generic dictionary to store anything with the error. So I used enum to identify error. Each member can have specified amount of associated values. So specific error can bring some context data. And it's type safe. Each error has also a code. Relationship between errors and codes is 1:1. It may looks bit redundant but it's important. The client app now can choose how to process errors. Either identify those by the error itself or by code. Definition or errors and codes is in `ZcashErrorDefinition`. And then `ZcashError` and `ZcashErrorCode` are generated by Sourcery. Thanks to this it is easier to maintain the final code. And it gives us ability to generate any kind of documentation for the errors and codes. I created simple example of this in this PR. And it doesn't make the SDK completely dependent on the Sourcery. Final structures aren't super complicated and can be written manually if needed. [#923] Update error handling in DatabaseStorageManager.swift - cleanup of DatabaseStorageManager, not used anymore - ZcashError for SimpleConnectionProvider Revert "[#923] Update error handling in DatabaseStorageManager.swift" This reverts commit 94e028d31a0f6635800c297eb741db74c6a6ff45. Fix script which generates ZcashError [#922] Update error handling in DatabaseMigrationManager.swift Closes #922 [#923] Update error handling in DatabaseStorageManager.swift - The DatabaseStorageManager is not used so I deleted it - SimpleConnectionProvider's errors updated Fix tests [#955] Update error handling in SaplingParameterDownloader Closes #955 [#936] Update error handling in NotesDao Closes #936 [#935] Update error handling in BlockDao Closes #935 [#931] InternalSyncProgress.computeNextState doesn't need to throw Closes #931 [#950] Update error handling in rust backend Closes #949 Closes #950 [#941] Update error handling in AccountEntity Closes #941 [#928] Update error handling in FSCompactBlockRepository Closes #928 [#925] Update error handling in BlockDownloaderService (#974) - BlockDownloaderService errors updated [#924] Update error handling in BlockDownloader (#973) - BlockDownloaderStream nextBlock updated [#942] Update error handling in TransactionEntity (#977) - ZcashTransaction init errors converted to the ZcashError [#939] Update error handling in TransactionDao (#976) - TransactionRepositoryError removed and replaced with ZcashError - all TransactionDAO errors converted to ZcashError [#943] Update error handling in ZcashCompactBlock Closes #943 [#945] Update error handling in Memo Closes #945 [#934] Update error handling in Checkpoint Closes #944 Closes #934 [#938] Update error handling in PendingTransactionDao Closes #938 [#926] Update error handling in BlockEnhancer - WIP, switching to transaction repository to unblock this ticket [#926] Update error handling in BlockEnhancer - enhancer's errors done [#926] Update error handling in BlockEnhancer (#994) - cleanup [#952] Update error handling in DerivationTool Closes #952 [#932] Update error handling in BlockValidator Closes #932 [#940] Update error handling in UnspentTransactionOutputDao Closes #940 [#946] Update error handling in WalletTypes Closes #946 [#954] Update error handling in WalletTransactionEncoder Closes #954 [#953] Update error handling in PersistentTransactionManager Closes #953 [#956] Update error handling in Initializer Closes #956 [#947] Update error handling in Zatoshi (#996) - Zatoshi's errors converted to ZcashError [#927] Update error handling in UTXOFetcher (#997) - UTXOFetcher resolved Use let instead of var where applicable In the SDK `var` was used on places where `let` would be sufficient. And default strategy in Swift should use use `let` until mutability is required. So all these places are changed. No logic is changed. [#933] Update error handling in CompactBlockProcessor - CompactBlockProcessor's errors refactored to ZcashError [#933] Update error handling in CompactBlockProcessor #999 - comments addressed [#951] Update error handling in SDKSynchronizer - SDKSynchronizer's errors refactored to ZcashError [#951] Update error handling in SDKSynchronizer (#1002) - comments resolved Make DerivationTool constructor public DerivationTool.init should be public. This was removed by accident when adopting async. [#361] Add changelog
2023-04-24 14:15:20 -07:00
/// Updating of paths in `Initilizer` according to alias failed.
case initializerCantUpdateURLWithAlias = "ZINIT0001"
/// Alias used to create this instance of the `SDKSynchronizer` is already used by other instance.
case initializerAliasAlreadyInUse = "ZINIT0002"
/// Unknown GRPC Service error
case serviceUnknownError = "ZSRVC0001"
/// LightWalletService.getInfo failed.
case serviceGetInfoFailed = "ZSRVC0002"
/// LightWalletService.latestBlock failed.
case serviceLatestBlockFailed = "ZSRVC0003"
/// LightWalletService.latestBlockHeight failed.
case serviceLatestBlockHeightFailed = "ZSRVC0004"
/// LightWalletService.blockRange failed.
case serviceBlockRangeFailed = "ZSRVC0005"
/// LightWalletService.submit failed.
case serviceSubmitFailed = "ZSRVC0006"
/// LightWalletService.fetchTransaction failed.
case serviceFetchTransactionFailed = "ZSRVC0007"
/// LightWalletService.fetchUTXOs failed.
case serviceFetchUTXOsFailed = "ZSRVC0008"
/// LightWalletService.blockStream failed.
case serviceBlockStreamFailed = "ZSRVC0000"
/// SimpleConnectionProvider init of Connection failed.
case simpleConnectionProvider = "ZSCPC0001"
/// Downloaded file with sapling spending parameters isn't valid.
case saplingParamsInvalidSpendParams = "ZSAPP0001"
/// Downloaded file with sapling output parameters isn't valid.
case saplingParamsInvalidOutputParams = "ZSAPP0002"
/// Failed to download sapling parameters file
case saplingParamsDownload = "ZSAPP0003"
/// Failed to move sapling parameters file to final destination after download.
case saplingParamsCantMoveDownloadedFile = "ZSAPP0004"
/// SQLite query failed when fetching block information from database.
case blockDAOBlock = "ZBDAO0001"
/// Fetched block information from DB but can't decode them.
case blockDAOCantDecode = "ZBDAO0002"
/// SQLite query failed when fetching height of the latest block from the database.
case blockDAOLatestBlockHeight = "ZBDAO0003"
/// SQLite query failed when fetching the latest block from the database.
case blockDAOLatestBlock = "ZBDAO0004"
/// Fetched latesxt block information from DB but can't decode them.
case blockDAOLatestBlockCantDecode = "ZBDAO0005"
/// Error from rust layer when calling ZcashRustBackend.createAccount
case rustCreateAccount = "ZRUST0001"
/// Error from rust layer when calling ZcashRustBackend.createToAddress
case rustCreateToAddress = "ZRUST0002"
/// Error from rust layer when calling ZcashRustBackend.decryptAndStoreTransaction
case rustDecryptAndStoreTransaction = "ZRUST0003"
/// Error from rust layer when calling ZcashRustBackend.getBalance
case rustGetBalance = "ZRUST0004"
/// Error from rust layer when calling ZcashRustBackend.getCurrentAddress
case rustGetCurrentAddress = "ZRUST0005"
/// Unified address generated by rust layer is invalid when calling ZcashRustBackend.getCurrentAddress
case rustGetCurrentAddressInvalidAddress = "ZRUST0006"
/// Error from rust layer when calling ZcashRustBackend.getNearestRewindHeight
case rustGetNearestRewindHeight = "ZRUST0007"
/// Error from rust layer when calling ZcashRustBackend.getNextAvailableAddress
case rustGetNextAvailableAddress = "ZRUST0008"
/// Unified address generated by rust layer is invalid when calling ZcashRustBackend.getNextAvailableAddress
case rustGetNextAvailableAddressInvalidAddress = "ZRUST0009"
/// account parameter is lower than 0 when calling ZcashRustBackend.getTransparentBalance
case rustGetTransparentBalanceNegativeAccount = "ZRUST0010"
/// Error from rust layer when calling ZcashRustBackend.getTransparentBalance
case rustGetTransparentBalance = "ZRUST0011"
/// Error from rust layer when calling ZcashRustBackend.getVerifiedBalance
case rustGetVerifiedBalance = "ZRUST0012"
/// account parameter is lower than 0 when calling ZcashRustBackend.getVerifiedTransparentBalance
case rustGetVerifiedTransparentBalanceNegativeAccount = "ZRUST0013"
/// Error from rust layer when calling ZcashRustBackend.getVerifiedTransparentBalance
case rustGetVerifiedTransparentBalance = "ZRUST0014"
/// Error from rust layer when calling ZcashRustBackend.initDataDb
case rustInitDataDb = "ZRUST0015"
/// Any of the viewing keys passed to the ZcashRustBackend.initAccountsTable method contains null bytes before end
case rustInitAccountsTableViewingKeyCotainsNullBytes = "ZRUST0016"
/// Any of the viewing keys passed to the ZcashRustBackend.initAccountsTable method isn't valid
case rustInitAccountsTableViewingKeyIsInvalid = "ZRUST0017"
/// Error from rust layer when calling ZcashRustBackend.initAccountsTable
case rustInitAccountsTableDataDbNotEmpty = "ZRUST0018"
/// Error from rust layer when calling ZcashRustBackend.initAccountsTable
case rustInitAccountsTable = "ZRUST0019"
/// Error from rust layer when calling ZcashRustBackend.initBlockMetadataDb
case rustInitBlockMetadataDb = "ZRUST0020"
/// Unable to allocate memory required to write blocks when calling ZcashRustBackend.writeBlocksMetadata
case rustWriteBlocksMetadataAllocationProblem = "ZRUST0021"
/// Error from rust layer when calling ZcashRustBackend.writeBlocksMetadata
case rustWriteBlocksMetadata = "ZRUST0022"
/// hash passed to the ZcashRustBackend.initBlocksTable method contains null bytes before end
case rustInitBlocksTableHashContainsNullBytes = "ZRUST0023"
/// saplingTree passed to the ZcashRustBackend.initBlocksTable method contains null bytes before end
case rustInitBlocksTableSaplingTreeContainsNullBytes = "ZRUST0024"
/// Error from rust layer when calling ZcashRustBackend.initBlocksTable
case rustInitBlocksTableDataDbNotEmpty = "ZRUST0025"
/// Error from rust layer when calling ZcashRustBackend.initBlocksTable
case rustInitBlocksTable = "ZRUST0026"
/// Error from rust layer when calling ZcashRustBackend.listTransparentReceivers
case rustListTransparentReceivers = "ZRUST0027"
/// Transparent receiver generated by rust layer is invalid when calling ZcashRustBackend.listTransparentReceivers
case rustListTransparentReceiversInvalidAddress = "ZRUST0028"
/// Error from rust layer when calling ZcashRustBackend.putUnspentTransparentOutput
case rustPutUnspentTransparentOutput = "ZRUST0029"
/// Error unrelated to chain validity from rust layer when calling ZcashRustBackend.validateCombinedChain
case rustValidateCombinedChainValidationFailed = "ZRUST0030"
/// Error from rust layer which means that combined chain isn't valid.
case rustValidateCombinedChainInvalidChain = "ZRUST0031"
/// Error from rust layer when calling ZcashRustBackend.rewindToHeight
case rustRewindToHeight = "ZRUST0032"
/// Error from rust layer when calling ZcashRustBackend.rewindCacheToHeight
case rustRewindCacheToHeight = "ZRUST0033"
/// Error from rust layer when calling ZcashRustBackend.scanBlocks
case rustScanBlocks = "ZRUST0034"
/// Error from rust layer when calling ZcashRustBackend.shieldFunds
case rustShieldFunds = "ZRUST0035"
/// Error from rust layer when calling ZcashRustBackend.consensusBranchIdFor
case rustNoConsensusBranchId = "ZRUST0036"
/// address passed to the ZcashRustBackend.receiverTypecodesOnUnifiedAddress method contains null bytes before end
case rustReceiverTypecodesOnUnifiedAddressContainsNullBytes = "ZRUST0037"
/// Error from rust layer when calling ZcashRustBackend.receiverTypecodesOnUnifiedAddress
case rustRustReceiverTypecodesOnUnifiedAddressMalformed = "ZRUST0038"
/// Error from rust layer when calling ZcashRustBackend.deriveUnifiedSpendingKey
case rustDeriveUnifiedSpendingKey = "ZRUST0039"
/// Error from rust layer when calling ZcashRustBackend.deriveUnifiedFullViewingKey
case rustDeriveUnifiedFullViewingKey = "ZRUST0040"
/// Viewing key derived by rust layer is invalid when calling ZcashRustBackend.deriveUnifiedFullViewingKey
case rustDeriveUnifiedFullViewingKeyInvalidDerivedKey = "ZRUST0041"
/// Error from rust layer when calling ZcashRustBackend.getSaplingReceiver
case rustGetSaplingReceiverInvalidAddress = "ZRUST0042"
/// Sapling receiver generated by rust layer is invalid when calling ZcashRustBackend.getSaplingReceiver
case rustGetSaplingReceiverInvalidReceiver = "ZRUST0043"
/// Error from rust layer when calling ZcashRustBackend.getTransparentReceiver
case rustGetTransparentReceiverInvalidAddress = "ZRUST0044"
/// Transparent receiver generated by rust layer is invalid when calling ZcashRustBackend.getTransparentReceiver
case rustGetTransparentReceiverInvalidReceiver = "ZRUST0045"
/// SQLite query failed when fetching all accounts from the database.
case accountDAOGetAll = "ZADAO0001"
/// Fetched accounts from SQLite but can't decode them.
case accountDAOGetAllCantDecode = "ZADAO0002"
/// SQLite query failed when seaching for accounts in the database.
case accountDAOFindBy = "ZADAO0003"
/// Fetched accounts from SQLite but can't decode them.
case accountDAOFindByCantDecode = "ZADAO0004"
/// Object passed to update() method conforms to `AccountEntity` protocol but isn't exactly `Account` type.
case accountDAOUpdateInvalidAccount = "ZADAO0005"
/// SQLite query failed when updating account in the database.
case accountDAOUpdate = "ZADAO0006"
/// Update of the account updated 0 rows in the database. One row should be updated.
case accountDAOUpdatedZeroRows = "ZADAO0007"
/// Failed to write block to disk.
case blockRepositoryWriteBlock = "ZBLRP00001"
/// Failed to get filename for the block from file URL.
case blockRepositoryGetFilename = "ZBLRP0002"
/// Failed to parse block height from filename.
case blockRepositoryParseHeightFromFilename = "ZBLRP0003"
/// Failed to remove existing block from disk.
case blockRepositoryRemoveExistingBlock = "ZBLRP0004"
/// Failed to get filename and information if url points to directory from file URL.
case blockRepositoryGetFilenameAndIsDirectory = "ZBLRP0005"
/// Failed to create blocks cache directory.
case blockRepositoryCreateBlocksCacheDirectory = "ZBLRP0006"
/// Failed to read content of directory.
case blockRepositoryReadDirectoryContent = "ZBLRP0007"
/// Failed to remove block from disk after rewind operation.
case blockRepositoryRemoveBlockAfterRewind = "ZBLRP0008"
/// Failed to remove blocks cache directory while clearing storage.
case blockRepositoryRemoveBlocksCacheDirectory = "ZBLRP0009"
/// Failed to remove block from cache when clearing cache up to some height.
case blockRepositoryRemoveBlockClearingCache = "ZBLRP0010"
/// Trying to download blocks before sync range is set in `BlockDownloaderImpl`. This means that download stream is not created and download cant' start.
case blockDownloadSyncRangeNotSet = "ZBDWN0001"
[#361] Introduce ZcashError (#1005) This PR introduces `ZcashError` enum. This enum represents any error that can be thrown inside of the SDK and outside of the SDK. Also `ZcashError` is used in `LightWalletGRPCService` and handled in `CompactBlockProcessor` as example. Why enum? First I tried this with some structure which contained code, message and underlyingError. Problem was when some specific place in the SDK would like to attach some additional data to error. I didn't want to add some generic dictionary to store anything with the error. So I used enum to identify error. Each member can have specified amount of associated values. So specific error can bring some context data. And it's type safe. Each error has also a code. Relationship between errors and codes is 1:1. It may looks bit redundant but it's important. The client app now can choose how to process errors. Either identify those by the error itself or by code. Definition or errors and codes is in `ZcashErrorDefinition`. And then `ZcashError` and `ZcashErrorCode` are generated by Sourcery. Thanks to this it is easier to maintain the final code. And it gives us ability to generate any kind of documentation for the errors and codes. I created simple example of this in this PR. And it doesn't make the SDK completely dependent on the Sourcery. Final structures aren't super complicated and can be written manually if needed. [#923] Update error handling in DatabaseStorageManager.swift - cleanup of DatabaseStorageManager, not used anymore - ZcashError for SimpleConnectionProvider Revert "[#923] Update error handling in DatabaseStorageManager.swift" This reverts commit 94e028d31a0f6635800c297eb741db74c6a6ff45. Fix script which generates ZcashError [#922] Update error handling in DatabaseMigrationManager.swift Closes #922 [#923] Update error handling in DatabaseStorageManager.swift - The DatabaseStorageManager is not used so I deleted it - SimpleConnectionProvider's errors updated Fix tests [#955] Update error handling in SaplingParameterDownloader Closes #955 [#936] Update error handling in NotesDao Closes #936 [#935] Update error handling in BlockDao Closes #935 [#931] InternalSyncProgress.computeNextState doesn't need to throw Closes #931 [#950] Update error handling in rust backend Closes #949 Closes #950 [#941] Update error handling in AccountEntity Closes #941 [#928] Update error handling in FSCompactBlockRepository Closes #928 [#925] Update error handling in BlockDownloaderService (#974) - BlockDownloaderService errors updated [#924] Update error handling in BlockDownloader (#973) - BlockDownloaderStream nextBlock updated [#942] Update error handling in TransactionEntity (#977) - ZcashTransaction init errors converted to the ZcashError [#939] Update error handling in TransactionDao (#976) - TransactionRepositoryError removed and replaced with ZcashError - all TransactionDAO errors converted to ZcashError [#943] Update error handling in ZcashCompactBlock Closes #943 [#945] Update error handling in Memo Closes #945 [#934] Update error handling in Checkpoint Closes #944 Closes #934 [#938] Update error handling in PendingTransactionDao Closes #938 [#926] Update error handling in BlockEnhancer - WIP, switching to transaction repository to unblock this ticket [#926] Update error handling in BlockEnhancer - enhancer's errors done [#926] Update error handling in BlockEnhancer (#994) - cleanup [#952] Update error handling in DerivationTool Closes #952 [#932] Update error handling in BlockValidator Closes #932 [#940] Update error handling in UnspentTransactionOutputDao Closes #940 [#946] Update error handling in WalletTypes Closes #946 [#954] Update error handling in WalletTransactionEncoder Closes #954 [#953] Update error handling in PersistentTransactionManager Closes #953 [#956] Update error handling in Initializer Closes #956 [#947] Update error handling in Zatoshi (#996) - Zatoshi's errors converted to ZcashError [#927] Update error handling in UTXOFetcher (#997) - UTXOFetcher resolved Use let instead of var where applicable In the SDK `var` was used on places where `let` would be sufficient. And default strategy in Swift should use use `let` until mutability is required. So all these places are changed. No logic is changed. [#933] Update error handling in CompactBlockProcessor - CompactBlockProcessor's errors refactored to ZcashError [#933] Update error handling in CompactBlockProcessor #999 - comments addressed [#951] Update error handling in SDKSynchronizer - SDKSynchronizer's errors refactored to ZcashError [#951] Update error handling in SDKSynchronizer (#1002) - comments resolved Make DerivationTool constructor public DerivationTool.init should be public. This was removed by accident when adopting async. [#361] Add changelog
2023-04-24 14:15:20 -07:00
/// Stream downloading the given block range failed.
case blockDownloaderServiceDownloadBlockRange = "ZBDSEO0001"
/// Initialization of `ZcashTransaction.Overview` failed.
case zcashTransactionOverviewInit = "ZTEZT0001"
/// Initialization of `ZcashTransaction.Received` failed.
case zcashTransactionReceivedInit = "ZTEZT0002"
/// Initialization of `ZcashTransaction.Sent` failed.
case zcashTransactionSentInit = "ZTEZT0003"
[#1001] Remove PendingDb in favor of `v_transactions` and `v_tx_output` Views (#1001) Removes `PendingTransactionEntity` and all of its related components. Pending items are still tracked and visualized by the existing APIs but they are retrieved from the `TransactionRepository` instead by returning `ZcashTransaction.Overview` instead. `pendingDbURL` is removed from every place it was required. Its deletion is responsibility of wallet developers. `ClearedTransactions` are now just `transactions`. `MigrationManager` is deleted. Now all migrations are in charge of the rust welding layer. `PendingTransactionDao.swift` is removed. Implementation of `AccountEntity` called `Account` is now `DbAccount` `ZcashTransaction.Overview` can be checked for "pending-ness" by calling `.isPending(latestHeight:)` latest height must be provided so that minedHeight can be compared with the lastest and the `defaultStaleTolerance` constant. `TransactionRecipient` is now a public type. protocol `PendingTransactionRepository` is removed. `TransactionManagerError` and `PersistentTransactionManager` are deleted. `OutboundTransactionManager` is deleted and replaced by `TransactionEncoder` which now incorporates `submit(encoded:)` functionality `WalletTransactionEncoder` now uses a `LightWalletService` to submit the encoded transactions. Add changelog changes Delete references to PendingDb from tests and documentation. Fixes some typos. Adds the ability to trace transaction repository SQL queries from test Fix rebase conflicts and generate code [#837] Memo tests regarding transparent address Closes #837 Add model for transaction output Point to FFI branch Fix issue where sync wouldn't resume after wipe. Becasue GRPC channel would be closed Fix Tests Fix testPendingTransactionMinedHeightUpdated Fix testLastStates [#921] Fix broken SynchronizerDarksideTests Add ZcashTransaction.Output API to Synchronizer Changelog + comment fix Add Assertions for transaction outputs and recipients Point to FFI 0.3.1 Fix Demo App Compiler errors Fix Demo App Compiler errors fix cacheDb warnings Fix Tests and compiler errors of rebase build demo app Remove `ZcashTransaction.Sent` and `.Received`. Add `.State` and tests Fix SPM warning PR Suggestions Removes errors that are not used anymore fix warnings
2023-05-05 10:30:47 -07:00
/// Initialization of `ZcashTransaction.Output` failed.
case zcashTransactionOutputInit = "ZTEZT0004"
/// Initialization of `ZcashTransaction.Output` failed because there an inconsistency in the output recipient.
case zcashTransactionOutputInconsistentRecipient = "ZTEZT0005"
[#361] Introduce ZcashError (#1005) This PR introduces `ZcashError` enum. This enum represents any error that can be thrown inside of the SDK and outside of the SDK. Also `ZcashError` is used in `LightWalletGRPCService` and handled in `CompactBlockProcessor` as example. Why enum? First I tried this with some structure which contained code, message and underlyingError. Problem was when some specific place in the SDK would like to attach some additional data to error. I didn't want to add some generic dictionary to store anything with the error. So I used enum to identify error. Each member can have specified amount of associated values. So specific error can bring some context data. And it's type safe. Each error has also a code. Relationship between errors and codes is 1:1. It may looks bit redundant but it's important. The client app now can choose how to process errors. Either identify those by the error itself or by code. Definition or errors and codes is in `ZcashErrorDefinition`. And then `ZcashError` and `ZcashErrorCode` are generated by Sourcery. Thanks to this it is easier to maintain the final code. And it gives us ability to generate any kind of documentation for the errors and codes. I created simple example of this in this PR. And it doesn't make the SDK completely dependent on the Sourcery. Final structures aren't super complicated and can be written manually if needed. [#923] Update error handling in DatabaseStorageManager.swift - cleanup of DatabaseStorageManager, not used anymore - ZcashError for SimpleConnectionProvider Revert "[#923] Update error handling in DatabaseStorageManager.swift" This reverts commit 94e028d31a0f6635800c297eb741db74c6a6ff45. Fix script which generates ZcashError [#922] Update error handling in DatabaseMigrationManager.swift Closes #922 [#923] Update error handling in DatabaseStorageManager.swift - The DatabaseStorageManager is not used so I deleted it - SimpleConnectionProvider's errors updated Fix tests [#955] Update error handling in SaplingParameterDownloader Closes #955 [#936] Update error handling in NotesDao Closes #936 [#935] Update error handling in BlockDao Closes #935 [#931] InternalSyncProgress.computeNextState doesn't need to throw Closes #931 [#950] Update error handling in rust backend Closes #949 Closes #950 [#941] Update error handling in AccountEntity Closes #941 [#928] Update error handling in FSCompactBlockRepository Closes #928 [#925] Update error handling in BlockDownloaderService (#974) - BlockDownloaderService errors updated [#924] Update error handling in BlockDownloader (#973) - BlockDownloaderStream nextBlock updated [#942] Update error handling in TransactionEntity (#977) - ZcashTransaction init errors converted to the ZcashError [#939] Update error handling in TransactionDao (#976) - TransactionRepositoryError removed and replaced with ZcashError - all TransactionDAO errors converted to ZcashError [#943] Update error handling in ZcashCompactBlock Closes #943 [#945] Update error handling in Memo Closes #945 [#934] Update error handling in Checkpoint Closes #944 Closes #934 [#938] Update error handling in PendingTransactionDao Closes #938 [#926] Update error handling in BlockEnhancer - WIP, switching to transaction repository to unblock this ticket [#926] Update error handling in BlockEnhancer - enhancer's errors done [#926] Update error handling in BlockEnhancer (#994) - cleanup [#952] Update error handling in DerivationTool Closes #952 [#932] Update error handling in BlockValidator Closes #932 [#940] Update error handling in UnspentTransactionOutputDao Closes #940 [#946] Update error handling in WalletTypes Closes #946 [#954] Update error handling in WalletTransactionEncoder Closes #954 [#953] Update error handling in PersistentTransactionManager Closes #953 [#956] Update error handling in Initializer Closes #956 [#947] Update error handling in Zatoshi (#996) - Zatoshi's errors converted to ZcashError [#927] Update error handling in UTXOFetcher (#997) - UTXOFetcher resolved Use let instead of var where applicable In the SDK `var` was used on places where `let` would be sufficient. And default strategy in Swift should use use `let` until mutability is required. So all these places are changed. No logic is changed. [#933] Update error handling in CompactBlockProcessor - CompactBlockProcessor's errors refactored to ZcashError [#933] Update error handling in CompactBlockProcessor #999 - comments addressed [#951] Update error handling in SDKSynchronizer - SDKSynchronizer's errors refactored to ZcashError [#951] Update error handling in SDKSynchronizer (#1002) - comments resolved Make DerivationTool constructor public DerivationTool.init should be public. This was removed by accident when adopting async. [#361] Add changelog
2023-04-24 14:15:20 -07:00
/// Entity not found in the database, result of `createEntity` execution.
case transactionRepositoryEntityNotFound = "ZTREE0001"
/// `Find` call is missing fields, required fields are transaction `index` and `blockTime`.
case transactionRepositoryTransactionMissingRequiredFields = "ZTREE0002"
/// Counting all transactions failed.
case transactionRepositoryCountAll = "ZTREE0003"
/// Counting all unmined transactions failed.
case transactionRepositoryCountUnmined = "ZTREE0004"
/// Execution of a query failed.
case transactionRepositoryQueryExecute = "ZTREE0005"
/// Finding memos in the database failed.
case transactionRepositoryFindMemos = "ZTREE0006"
/// Can't encode `ZcashCompactBlock` object.
case compactBlockEncode = "ZCMPB0001"
/// Invalid UTF-8 Bytes where detected when attempting to create a MemoText.
case memoTextInvalidUTF8 = "ZMEMO0001"
/// Trailing null-bytes were found when attempting to create a MemoText.
case memoTextInputEndsWithNullBytes = "ZMEMO0002"
/// The resulting bytes provided are too long to be stored as a MemoText.
case memoTextInputTooLong = "ZMEMO0003"
/// The resulting bytes provided are too long to be stored as a MemoBytes.
case memoBytesInputTooLong = "ZMEMO0004"
/// Invalid UTF-8 Bytes where detected when attempting to convert MemoBytes to Memo.
case memoBytesInvalidUTF8 = "ZMEMO0005"
/// Failed to load JSON with checkpoint from disk.
case checkpointCantLoadFromDisk = "ZCHKP0001"
/// Failed to decode `Checkpoint` object.
case checkpointDecode = "ZCHKP0002"
/// Invalid account when trying to derive spending key
case derivationToolSpendingKeyInvalidAccount = "ZDRVT0001"
/// Creation of the table for unspent transaction output failed.
case unspentTransactionOutputDAOCreateTable = "ZUTOD0001"
/// SQLite query failed when storing unspent transaction output.
case unspentTransactionOutputDAOStore = "ZUTOD0002"
/// SQLite query failed when removing all the unspent transation outputs.
case unspentTransactionOutputDAOClearAll = "ZUTOD0003"
/// Fetched information about unspent transaction output from the DB but it can't be decoded to `UTXO` object.
case unspentTransactionOutputDAOGetAllCantDecode = "ZUTOD0004"
/// SQLite query failed when getting all the unspent transation outputs.
case unspentTransactionOutputDAOGetAll = "ZUTOD0005"
/// SQLite query failed when getting balance.
case unspentTransactionOutputDAOBalance = "ZUTOD0006"
/// Can't create `SaplingExtendedSpendingKey` because input is invalid.
case spendingKeyInvalidInput = "ZWLTP0001"
/// Can't create `UnifiedFullViewingKey` because input is invalid.
case unifiedFullViewingKeyInvalidInput = "ZWLTP0002"
/// Can't create `SaplingExtendedFullViewingKey` because input is invalid.
case extetendedFullViewingKeyInvalidInput = "ZWLTP0003"
/// Can't create `TransparentAddress` because input is invalid.
case transparentAddressInvalidInput = "ZWLTP0004"
/// Can't create `SaplingAddress` because input is invalid.
case saplingAddressInvalidInput = "ZWLTP0005"
/// Can't create `UnifiedAddress` because input is invalid.
case unifiedAddressInvalidInput = "ZWLTP0006"
/// Can't create `Recipient` because input is invalid.
case recipientInvalidInput = "ZWLTP0007"
/// WalletTransactionEncoder wants to create transaction but files with sapling parameters are not present on disk.
case walletTransEncoderCreateTransactionMissingSaplingParams = "ZWLTE0001"
/// WalletTransactionEncoder wants to shield funds but files with sapling parameters are not present on disk.
case walletTransEncoderShieldFundsMissingSaplingParams = "ZWLTE0002"
/// Initiatilzation fo `Zatoshi` from a decoder failed.
case zatoshiDecode = "ZTSHO0001"
/// Encode of `Zatoshi` failed.
case zatoshiEncode = "ZTSHO0002"
/// Awaiting transactions from the stream failed.
case unspentTransactionFetcherStream = "ZUTXO0001"
/// CompactBlockProcessor was started with an invalid configuration.
case compactBlockProcessorInvalidConfiguration = "ZCBPEO0001"
/// CompactBlockProcessor was set up with path but that location couldn't be reached.
case compactBlockProcessorMissingDbPath = "ZCBPEO0002"
/// Data Db file couldn't be initialized at path.
case compactBlockProcessorDataDbInitFailed = "ZCBPEO0003"
/// There's a problem with the network connection.
case compactBlockProcessorConnection = "ZCBPEO0004"
/// Error on gRPC happened.
case compactBlockProcessorGrpcError = "ZCBPEO0005"
/// Network connection timeout.
case compactBlockProcessorConnectionTimeout = "ZCBPEO0006"
/// Compact Block failed and reached the maximum amount of retries it was set up to do.
case compactBlockProcessorMaxAttemptsReached = "ZCBPEO0007"
/// Unspecified error occured.
case compactBlockProcessorUnspecified = "ZCBPEO0008"
/// Critical error occured.
case compactBlockProcessorCritical = "ZCBPEO0009"
/// Invalid Account.
case compactBlockProcessorInvalidAccount = "ZCBPEO0010"
/// The remote server you are connecting to is publishing a different branch ID than the one your App is expecting This could be caused by your App being out of date or the server you are connecting you being either on a different network or out of date after a network upgrade.
case compactBlockProcessorWrongConsensusBranchId = "ZCBPEO0011"
/// A server was reached, but it's targeting the wrong network Type. Make sure you are pointing to the right server.
case compactBlockProcessorNetworkMismatch = "ZCBPEO0012"
/// A server was reached, it's showing a different sapling activation. Are you sure you are pointing to the right server?
case compactBlockProcessorSaplingActivationMismatch = "ZCBPEO0013"
/// when the given URL is the same URL than the one provided as `self.fsBlockDbRoot` assuming that's a programming error being the `legacyCacheDbURL` a sqlite database file and not a directory
case compactBlockProcessorCacheDbMigrationFsCacheMigrationFailedSameURL = "ZCBPEO0014"
/// Deletion of readable file at the provided URL failed.
case compactBlockProcessorCacheDbMigrationFailedToDeleteLegacyDb = "ZCBPEO0015"
/// Chain name does not match. Expected either 'test' or 'main'. This is probably an API or programming error.
case compactBlockProcessorChainName = "ZCBPEO0016"
/// Consensus BranchIDs don't match this is probably an API or programming error.
case compactBlockProcessorConsensusBranchID = "ZCBPEO0017"
/// The synchronizer is unprepared.
case synchronizerNotPrepared = "ZSYNCO0001"
/// Memos can't be sent to transparent addresses.
case synchronizerSendMemoToTransparentAddress = "ZSYNCO0002"
/// There is not enough transparent funds to cover fee for the shielding.
case synchronizerShieldFundsInsuficientTransparentFunds = "ZSYNCO0003"
/// LatestUTXOs for the address failed, invalid t-address.
case synchronizerLatestUTXOsInvalidTAddress = "ZSYNCO0004"
/// Rewind failed, unknown archor height
case synchronizerRewindUnknownArchorHeight = "ZSYNCO0005"
/// Indicates that this Synchronizer is disconnected from its lightwalletd server.
case synchronizerDisconnected = "ZSYNCO0006"
[#361] Introduce ZcashError (#1005) This PR introduces `ZcashError` enum. This enum represents any error that can be thrown inside of the SDK and outside of the SDK. Also `ZcashError` is used in `LightWalletGRPCService` and handled in `CompactBlockProcessor` as example. Why enum? First I tried this with some structure which contained code, message and underlyingError. Problem was when some specific place in the SDK would like to attach some additional data to error. I didn't want to add some generic dictionary to store anything with the error. So I used enum to identify error. Each member can have specified amount of associated values. So specific error can bring some context data. And it's type safe. Each error has also a code. Relationship between errors and codes is 1:1. It may looks bit redundant but it's important. The client app now can choose how to process errors. Either identify those by the error itself or by code. Definition or errors and codes is in `ZcashErrorDefinition`. And then `ZcashError` and `ZcashErrorCode` are generated by Sourcery. Thanks to this it is easier to maintain the final code. And it gives us ability to generate any kind of documentation for the errors and codes. I created simple example of this in this PR. And it doesn't make the SDK completely dependent on the Sourcery. Final structures aren't super complicated and can be written manually if needed. [#923] Update error handling in DatabaseStorageManager.swift - cleanup of DatabaseStorageManager, not used anymore - ZcashError for SimpleConnectionProvider Revert "[#923] Update error handling in DatabaseStorageManager.swift" This reverts commit 94e028d31a0f6635800c297eb741db74c6a6ff45. Fix script which generates ZcashError [#922] Update error handling in DatabaseMigrationManager.swift Closes #922 [#923] Update error handling in DatabaseStorageManager.swift - The DatabaseStorageManager is not used so I deleted it - SimpleConnectionProvider's errors updated Fix tests [#955] Update error handling in SaplingParameterDownloader Closes #955 [#936] Update error handling in NotesDao Closes #936 [#935] Update error handling in BlockDao Closes #935 [#931] InternalSyncProgress.computeNextState doesn't need to throw Closes #931 [#950] Update error handling in rust backend Closes #949 Closes #950 [#941] Update error handling in AccountEntity Closes #941 [#928] Update error handling in FSCompactBlockRepository Closes #928 [#925] Update error handling in BlockDownloaderService (#974) - BlockDownloaderService errors updated [#924] Update error handling in BlockDownloader (#973) - BlockDownloaderStream nextBlock updated [#942] Update error handling in TransactionEntity (#977) - ZcashTransaction init errors converted to the ZcashError [#939] Update error handling in TransactionDao (#976) - TransactionRepositoryError removed and replaced with ZcashError - all TransactionDAO errors converted to ZcashError [#943] Update error handling in ZcashCompactBlock Closes #943 [#945] Update error handling in Memo Closes #945 [#934] Update error handling in Checkpoint Closes #944 Closes #934 [#938] Update error handling in PendingTransactionDao Closes #938 [#926] Update error handling in BlockEnhancer - WIP, switching to transaction repository to unblock this ticket [#926] Update error handling in BlockEnhancer - enhancer's errors done [#926] Update error handling in BlockEnhancer (#994) - cleanup [#952] Update error handling in DerivationTool Closes #952 [#932] Update error handling in BlockValidator Closes #932 [#940] Update error handling in UnspentTransactionOutputDao Closes #940 [#946] Update error handling in WalletTypes Closes #946 [#954] Update error handling in WalletTransactionEncoder Closes #954 [#953] Update error handling in PersistentTransactionManager Closes #953 [#956] Update error handling in Initializer Closes #956 [#947] Update error handling in Zatoshi (#996) - Zatoshi's errors converted to ZcashError [#927] Update error handling in UTXOFetcher (#997) - UTXOFetcher resolved Use let instead of var where applicable In the SDK `var` was used on places where `let` would be sufficient. And default strategy in Swift should use use `let` until mutability is required. So all these places are changed. No logic is changed. [#933] Update error handling in CompactBlockProcessor - CompactBlockProcessor's errors refactored to ZcashError [#933] Update error handling in CompactBlockProcessor #999 - comments addressed [#951] Update error handling in SDKSynchronizer - SDKSynchronizer's errors refactored to ZcashError [#951] Update error handling in SDKSynchronizer (#1002) - comments resolved Make DerivationTool constructor public DerivationTool.init should be public. This was removed by accident when adopting async. [#361] Add changelog
2023-04-24 14:15:20 -07:00
}