2020-03-23 15:06:58 -07:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< title > Configuration Structure Reference< / title >
< link rel = "stylesheet" type = "text/css" href = "../../css/jazzy.css" / >
< link rel = "stylesheet" type = "text/css" href = "../../css/highlight.css" / >
< meta charset = 'utf-8' >
< script src = "../../js/jquery.min.js" defer > < / script >
< script src = "../../js/jazzy.js" defer > < / script >
< / head >
< body >
< a name = "//apple_ref/swift/Struct/Configuration" class = "dashAnchor" > < / a >
< a title = "Configuration Structure Reference" > < / a >
< header >
< div class = "content-wrapper" >
2020-04-06 10:06:13 -07:00
< p > < a href = "../../index.html" > ZcashLightClientKit Docs< / a > (71% documented)< / p >
2020-03-23 15:06:58 -07:00
< / div >
< / header >
< div class = "content-wrapper" >
< p id = "breadcrumbs" >
< a href = "../../index.html" > ZcashLightClientKit Reference< / a >
< img id = "carat" src = "../../img/carat.png" / >
Configuration Structure Reference
< / p >
< / div >
< div class = "content-wrapper" >
< nav class = "sidebar" >
< ul class = "nav-groups" >
< li class = "nav-group-name" >
< a href = "../../Classes.html" > Classes< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "../../Classes/CompactBlockProcessor.html" > CompactBlockProcessor< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Classes/CompactBlockProcessor/Configuration.html" > – < / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Classes/CompactBlockProcessor/State.html" > – < / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Classes/Initializer.html" > Initializer< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Classes/LightWalletGRPCService.html" > LightWalletGRPCService< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Classes/SDKSynchronizer.html" > SDKSynchronizer< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Classes/SDKSynchronizer/NotificationKeys.html" > – < / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Classes/ZcashSDK.html" > ZcashSDK< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "../../Enums.html" > Enumerations< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "../../Enums/CompactBlockProcessorError.html" > CompactBlockProcessorError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Enums/InitializerError.html" > InitializerError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Enums/LightWalletServiceError.html" > LightWalletServiceError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Enums/ResourceProviderError.html" > ResourceProviderError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Enums/RustWeldingError.html" > RustWeldingError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Enums/Status.html" > Status< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Enums/SynchronizerError.html" > SynchronizerError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Enums/TransactionEncoderError.html" > TransactionEncoderError< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Enums/TransactionKind.html" > TransactionKind< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "../../Extensions.html" > Extensions< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "../../Extensions/Array.html" > Array< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Extensions/BlockHeight.html" > BlockHeight< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Extensions/Collection.html" > Collection< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Extensions/CompactBlockRange.html" > CompactBlockRange< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Extensions/Data.html" > Data< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Extensions/Data/HexEncodingOptions.html" > – < / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Extensions/Notification.html" > Notification< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Extensions/Notification/Name.html" > – < / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Extensions/String.html" > String< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "../../Protocols.html" > Protocols< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "../../Protocols/AbstractTransaction.html" > AbstractTransaction< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/CompactBlockDownloading.html" > CompactBlockDownloading< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/ConfirmedTransactionEntity.html" > ConfirmedTransactionEntity< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/LightWalletService.html" > LightWalletService< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/LightWalletServiceResponse.html" > LightWalletServiceResponse< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/Logger.html" > Logger< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/MinedTransactionEntity.html" > MinedTransactionEntity< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/PaginatedTransactionRepository.html" > PaginatedTransactionRepository< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/PendingTransactionEntity.html" > PendingTransactionEntity< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/RawIdentifiable.html" > RawIdentifiable< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/ResourceProvider.html" > ResourceProvider< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/SeedProvider.html" > SeedProvider< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/SignedTransactionEntity.html" > SignedTransactionEntity< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/Synchronizer.html" > Synchronizer< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/TransactionEntity.html" > TransactionEntity< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Protocols/ZcashRustBackendWelding.html" > ZcashRustBackendWelding< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "../../Structs.html" > Structures< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "../../Structs/CompactBlockProcessorNotificationKey.html" > CompactBlockProcessorNotificationKey< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Structs/DefaultResourceProvider.html" > DefaultResourceProvider< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Structs/LightWalletEndpoint.html" > LightWalletEndpoint< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Structs/WalletBirthday.html" > WalletBirthday< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Structs/ZcashCompactBlock.html" > ZcashCompactBlock< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Structs.html#/s:19ZcashLightClientKit0A27RustBackendWeldingConstantsV" > ZcashRustBackendWeldingConstants< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "../../Typealiases.html" > Type Aliases< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "../../Typealiases.html#/s:19ZcashLightClientKit11BlockHeighta" > BlockHeight< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../../Typealiases.html#/s:19ZcashLightClientKit17CompactBlockRangea" > CompactBlockRange< / a >
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< article class = "main-content" >
< section >
< section class = "section" >
< h1 > Configuration< / h1 >
< div class = "declaration" >
< div class = "language" >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "kd" > struct< / span > < span class = "kt" > Configuration< / span > < / code > < / pre >
< / div >
< / div >
< p > Compact Block Processor configuration< / p >
< p > Property: cacheDbPath absolute file path of the DB where raw, unprocessed compact blocks are stored.
Property: dataDbPath absolute file path of the DB where all information derived from the cache DB is stored.< / p >
< / section >
< section class = "section task-group-section" >
< div class = "task-group" >
< ul >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV7cacheDb10Foundation3URLVvp" > < / a >
< a name = "//apple_ref/swift/Property/cacheDb" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV7cacheDb10Foundation3URLVvp" > cacheDb< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Undocumented< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "k" > var< / span > < span class = "nv" > cacheDb< / span > < span class = "p" > :< / span > < span class = "kt" > URL< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV6dataDb10Foundation3URLVvp" > < / a >
< a name = "//apple_ref/swift/Property/dataDb" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV6dataDb10Foundation3URLVvp" > dataDb< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Undocumented< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "k" > var< / span > < span class = "nv" > dataDb< / span > < span class = "p" > :< / span > < span class = "kt" > URL< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV17downloadBatchSizeSivp" > < / a >
< a name = "//apple_ref/swift/Property/downloadBatchSize" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV17downloadBatchSizeSivp" > downloadBatchSize< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Undocumented< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "k" > var< / span > < span class = "nv" > downloadBatchSize< / span > < span class = "p" > :< / span > < span class = "kt" > Int< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV17blockPollIntervalSdvp" > < / a >
< a name = "//apple_ref/swift/Property/blockPollInterval" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV17blockPollIntervalSdvp" > blockPollInterval< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Undocumented< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "k" > var< / span > < span class = "nv" > blockPollInterval< / span > < span class = "p" > :< / span > < span class = "kt" > TimeInterval< / span > < span class = "p" > {< / span > < span class = "k" > get< / span > < span class = "p" > }< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV7retriesSivp" > < / a >
< a name = "//apple_ref/swift/Property/retries" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV7retriesSivp" > retries< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Undocumented< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "k" > var< / span > < span class = "nv" > retries< / span > < span class = "p" > :< / span > < span class = "kt" > Int< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV18maxBackoffIntervalSdvp" > < / a >
< a name = "//apple_ref/swift/Property/maxBackoffInterval" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV18maxBackoffIntervalSdvp" > maxBackoffInterval< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Undocumented< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "k" > var< / span > < span class = "nv" > maxBackoffInterval< / span > < span class = "p" > :< / span > < span class = "kt" > TimeInterval< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV14rewindDistanceSivp" > < / a >
< a name = "//apple_ref/swift/Property/rewindDistance" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV14rewindDistanceSivp" > rewindDistance< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Undocumented< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "k" > var< / span > < span class = "nv" > rewindDistance< / span > < span class = "p" > :< / span > < span class = "kt" > Int< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV14walletBirthdaySivp" > < / a >
< a name = "//apple_ref/swift/Property/walletBirthday" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV14walletBirthdaySivp" > walletBirthday< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Undocumented< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "k" > var< / span > < span class = "nv" > walletBirthday< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../../Typealiases.html#/s:19ZcashLightClientKit11BlockHeighta" > BlockHeight< / a > < / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV7cacheDb04dataJ014walletBirthdayAE10Foundation3URLV_AKSitcfc" > < / a >
< a name = "//apple_ref/swift/Method/init(cacheDb:dataDb:walletBirthday:)" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV7cacheDb04dataJ014walletBirthdayAE10Foundation3URLV_AKSitcfc" > init(cacheDb:dataDb:walletBirthday:)< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Undocumented< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "nf" > init< / span > < span class = "p" > (< / span > < span class = "nv" > cacheDb< / span > < span class = "p" > :< / span > < span class = "kt" > URL< / span > < span class = "p" > ,< / span > < span class = "nv" > dataDb< / span > < span class = "p" > :< / span > < span class = "kt" > URL< / span > < span class = "p" > ,< / span > < span class = "nv" > walletBirthday< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../../Typealiases.html#/s:19ZcashLightClientKit11BlockHeighta" > BlockHeight< / a > < / span > < span class = "o" > =< / span > < span class = "kt" > < a href = "../../Classes/ZcashSDK.html" > ZcashSDK< / a > < / span > < span class = "o" > .< / span > < span class = "kt" > SAPLING_ACTIVATION_HEIGHT< / span > < span class = "p" > )< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV8standardAEvpZ" > < / a >
< a name = "//apple_ref/swift/Variable/standard" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit21CompactBlockProcessorC13ConfigurationV8standardAEvpZ" > standard< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Standard configuration for most compact block processors< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > static< / span > < span class = "k" > var< / span > < span class = "nv" > standard< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../../Classes/CompactBlockProcessor.html" > CompactBlockProcessor< / a > < / span > < span class = "o" > .< / span > < span class = "kt" > Configuration< / span > < span class = "p" > {< / span > < span class = "k" > get< / span > < span class = "p" > }< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< / ul >
< / div >
< / section >
< / section >
< section id = "footer" >
2020-04-06 10:06:13 -07:00
< p > © 2020 < a class = "link" href = "https://github.com/zcash/ZcashLightClientKit" target = "_blank" rel = "external" > Francisco Gindre and Jack Grigg< / a > . All rights reserved. (Last updated: 2020-04-06)< / p >
2020-03-23 15:06:58 -07:00
< p > Generated by < a class = "link" href = "https://github.com/realm/jazzy" target = "_blank" rel = "external" > jazzy ♪♫ v0.13.1< / a > , a < a class = "link" href = "https://realm.io" target = "_blank" rel = "external" > Realm< / a > project.< / p >
< / section >
< / article >
< / div >
< / body >
< / div >
< / html >
