2020-03-23 15:06:58 -07:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< title > CompactBlockDownloading Protocol 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/Protocol/CompactBlockDownloading" class = "dashAnchor" > < / a >
< a title = "CompactBlockDownloading Protocol 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" / >
CompactBlockDownloading Protocol 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 > CompactBlockDownloading< / h1 >
< div class = "declaration" >
< div class = "language" >
< pre class = "highlight swift" > < code > < span class = "kd" > public< / span > < span class = "kd" > protocol< / span > < span class = "kt" > CompactBlockDownloading< / span > < / code > < / pre >
< / div >
< / div >
< p > Represents what a compact block downloaded should provide to its clients< / p >
< / section >
< section class = "section task-group-section" >
< div class = "task-group" >
< ul >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit23CompactBlockDownloadingP08downloadF5Range_10completionySNySiG_ys5Error_pSgctF" > < / a >
< a name = "//apple_ref/swift/Method/downloadBlockRange(_:completion:)" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit23CompactBlockDownloadingP08downloadF5Range_10completionySNySiG_ys5Error_pSgctF" > downloadBlockRange(_:completion:)< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Downloads and stores the given block range.
Non-Blocking< / 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" > func< / span > < span class = "nf" > downloadBlockRange< / span > < span class = "p" > (< / span > < span class = "n" > _< / span > < span class = "nv" > heightRange< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../Typealiases.html#/s:19ZcashLightClientKit17CompactBlockRangea" > CompactBlockRange< / a > < / span > < span class = "p" > ,< / span > < span class = "nv" > completion< / span > < span class = "p" > :< / span > < span class = "kd" > @escaping< / span > < span class = "p" > (< / span > < span class = "kt" > Error< / span > < span class = "p" > ?)< / span > < span class = "o" > -> < / span > < span class = "kt" > Void< / span > < span class = "p" > )< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit23CompactBlockDownloadingP6rewind2to10completionySi_ys5Error_pSgctF" > < / a >
< a name = "//apple_ref/swift/Method/rewind(to:completion:)" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit23CompactBlockDownloadingP6rewind2to10completionySi_ys5Error_pSgctF" > rewind(to:completion:)< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Remove newer blocks and go back to the given height< / 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" > func< / span > < span class = "nf" > rewind< / span > < span class = "p" > (< / span > < span class = "n" > to< / span > < span class = "nv" > height< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../Typealiases.html#/s:19ZcashLightClientKit11BlockHeighta" > BlockHeight< / a > < / span > < span class = "p" > ,< / span > < span class = "nv" > completion< / span > < span class = "p" > :< / span > < span class = "kd" > @escaping< / span > < span class = "p" > (< / span > < span class = "kt" > Error< / span > < span class = "p" > ?)< / span > < span class = "o" > -> < / span > < span class = "kt" > Void< / span > < span class = "p" > )< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > height< / em >
< / code >
< / td >
< td >
< div >
< p > the given height to rewind to< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > completion< / em >
< / code >
< / td >
< td >
< div >
< p > block to be executed after completing rewind< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit23CompactBlockDownloadingP014lastDownloadedF6Height6resultyys6ResultOySis5Error_pGc_tF" > < / a >
< a name = "//apple_ref/swift/Method/lastDownloadedBlockHeight(result:)" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit23CompactBlockDownloadingP014lastDownloadedF6Height6resultyys6ResultOySis5Error_pGc_tF" > lastDownloadedBlockHeight(result:)< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > returns the height of the latest compact block stored locally
BlockHeight.empty() if no blocks are stored yet
non-blocking< / 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" > func< / span > < span class = "nf" > lastDownloadedBlockHeight< / span > < span class = "p" > (< / span > < span class = "nv" > result< / span > < span class = "p" > :< / span > < span class = "kd" > @escaping< / span > < span class = "p" > (< / span > < span class = "kt" > Result< / span > < span class = "o" > < < / span > < span class = "kt" > < a href = "../Typealiases.html#/s:19ZcashLightClientKit11BlockHeighta" > BlockHeight< / a > < / span > < span class = "p" > ,< / span > < span class = "kt" > Error< / span > < span class = "o" > > < / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kt" > Void< / span > < span class = "p" > )< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit23CompactBlockDownloadingP06latestF6Height6resultyys6ResultOySis5Error_pGc_tF" > < / a >
< a name = "//apple_ref/swift/Method/latestBlockHeight(result:)" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit23CompactBlockDownloadingP06latestF6Height6resultyys6ResultOySis5Error_pGc_tF" > latestBlockHeight(result:)< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Returns the last height on the blockchain
Non-blocking< / 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" > func< / span > < span class = "nf" > latestBlockHeight< / span > < span class = "p" > (< / span > < span class = "nv" > result< / span > < span class = "p" > :< / span > < span class = "kd" > @escaping< / span > < span class = "p" > (< / span > < span class = "kt" > Result< / span > < span class = "o" > < < / span > < span class = "kt" > < a href = "../Typealiases.html#/s:19ZcashLightClientKit11BlockHeighta" > BlockHeight< / a > < / span > < span class = "p" > ,< / span > < span class = "kt" > Error< / span > < span class = "o" > > < / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kt" > Void< / span > < span class = "p" > )< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit23CompactBlockDownloadingP08downloadF5RangeyySNySiGKF" > < / a >
< a name = "//apple_ref/swift/Method/downloadBlockRange(_:)" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit23CompactBlockDownloadingP08downloadF5RangeyySNySiGKF" > downloadBlockRange(_:)< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Downloads and stores the given block range.
Blocking< / 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" > func< / span > < span class = "nf" > downloadBlockRange< / span > < span class = "p" > (< / span > < span class = "n" > _< / span > < span class = "nv" > range< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../Typealiases.html#/s:19ZcashLightClientKit17CompactBlockRangea" > CompactBlockRange< / a > < / span > < span class = "p" > )< / span > < span class = "k" > throws< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit23CompactBlockDownloadingP6rewind2toySi_tKF" > < / a >
< a name = "//apple_ref/swift/Method/rewind(to:)" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit23CompactBlockDownloadingP6rewind2toySi_tKF" > rewind(to:)< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Restore the download progress up to the given height.< / 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" > func< / span > < span class = "nf" > rewind< / span > < span class = "p" > (< / span > < span class = "n" > to< / span > < span class = "nv" > height< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../Typealiases.html#/s:19ZcashLightClientKit11BlockHeighta" > BlockHeight< / a > < / span > < span class = "p" > )< / span > < span class = "k" > throws< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:19ZcashLightClientKit23CompactBlockDownloadingP014lastDownloadedF6HeightSiyKF" > < / a >
< a name = "//apple_ref/swift/Method/lastDownloadedBlockHeight()" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit23CompactBlockDownloadingP014lastDownloadedF6HeightSiyKF" > lastDownloadedBlockHeight()< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > returns the height of the latest compact block stored locally.
BlockHeight.empty() if no blocks are stored yet
Blocking< / 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" > func< / span > < span class = "nf" > lastDownloadedBlockHeight< / span > < span class = "p" > ()< / span > < span class = "k" > throws< / span > < span class = "o" > -> < / 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:19ZcashLightClientKit23CompactBlockDownloadingP06latestF6HeightSiyKF" > < / a >
< a name = "//apple_ref/swift/Method/latestBlockHeight()" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:19ZcashLightClientKit23CompactBlockDownloadingP06latestF6HeightSiyKF" > latestBlockHeight()< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Returns the latest block height
Blocking< / 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" > func< / span > < span class = "nf" > latestBlockHeight< / span > < span class = "p" > ()< / span > < span class = "k" > throws< / span > < span class = "o" > -> < / span > < span class = "kt" > < a href = "../Typealiases.html#/s:19ZcashLightClientKit11BlockHeighta" > BlockHeight< / a > < / 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 >
