2021-10-05 15:26:28 -07:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > zcashd - The zcashd Book< / title >
2023-04-23 17:24:14 -07:00
2021-10-05 15:26:28 -07:00
<!-- Custom HTML head -->
2023-04-23 17:24:14 -07:00
2021-10-05 15:26:28 -07:00
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
< link rel = "stylesheet" href = "css/print.css" media = "print" >
2023-04-23 17:24:14 -07:00
2021-10-05 15:26:28 -07:00
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "fonts/fonts.css" >
2023-04-23 17:24:14 -07:00
2021-10-05 15:26:28 -07:00
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "highlight.css" >
< link rel = "stylesheet" href = "tomorrow-night.css" >
< link rel = "stylesheet" href = "ayu-highlight.css" >
<!-- Custom theme stylesheets -->
2023-04-23 17:24:14 -07:00
2021-10-05 15:26:28 -07:00
< / head >
< body >
2023-04-23 17:24:14 -07:00
< div id = "body-container" >
2021-10-05 15:26:28 -07:00
<!-- Provide site root to javascript -->
2023-04-23 17:24:14 -07:00
< script >
2021-10-05 15:26:28 -07:00
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
2023-04-23 17:24:14 -07:00
< script >
2021-10-05 15:26:28 -07:00
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
2023-04-23 17:24:14 -07:00
< script >
2021-10-05 15:26:28 -07:00
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
2023-04-23 17:24:14 -07:00
< script >
2021-10-05 15:26:28 -07:00
var html = document.querySelector('html');
2023-04-23 17:24:14 -07:00
var sidebar = null;
2021-10-05 15:26:28 -07:00
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
2023-04-23 17:24:14 -07:00
} else {
sidebar = 'hidden';
2021-10-05 15:26:28 -07:00
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2023-04-23 17:24:14 -07:00
< ol class = "chapter" > < li class = "chapter-item expanded affix " > < a href = "index.html" class = "active" > zcashd< / a > < / li > < li class = "chapter-item expanded " > < a href = "user.html" > < strong aria-hidden = "true" > 1.< / strong > User Documentation< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "user/release-support.html" > < strong aria-hidden = "true" > 1.1.< / strong > Release Support< / a > < / li > < li class = "chapter-item expanded " > < a href = "user/platform-support.html" > < strong aria-hidden = "true" > 1.2.< / strong > Platform Support< / a > < / li > < li class = "chapter-item expanded " > < a href = "user/wallet-backup.html" > < strong aria-hidden = "true" > 1.3.< / strong > Wallet Backup< / a > < / li > < li class = "chapter-item expanded " > < a href = "user/shield-coinbase.html" > < strong aria-hidden = "true" > 1.4.< / strong > Shielding Coinbase Outputs< / a > < / li > < li class = "chapter-item expanded " > < a href = "user/files.html" > < strong aria-hidden = "true" > 1.5.< / strong > Data Directory Structure< / a > < / li > < li class = "chapter-item expanded " > < a href = "user/metrics.html" > < strong aria-hidden = "true" > 1.6.< / strong > Metrics< / a > < / li > < li class = "chapter-item expanded " > < a href = "user/tor.html" > < strong aria-hidden = "true" > 1.7.< / strong > Using zcashd with Tor< / a > < / li > < li class = "chapter-item expanded " > < a href = "user/security-warnings.html" > < strong aria-hidden = "true" > 1.8.< / strong > Security Warnings< / a > < / li > < li class = "chapter-item expanded " > < a href = "user/deprecation.html" > < strong aria-hidden = "true" > 1.9.< / strong > Deprecated Features< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "dev.html" > < strong aria-hidden = "true" > 2.< / strong > Developer Documentation< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "dev/dnsseed-policy.html" > < strong aria-hidden = "true" > 2.1.< / strong > DNS Seeders< / a > < / li > < li class = "chapter-item expanded " > < a href = "dev/rust.html" > < strong aria-hidden = "true" > 2.2.< / strong > Rust in zcashd< / a > < / li > < li class = "chapter-item expanded " > < a href = "dev/regtest.html" > < strong aria-hidden = "true" > 2.3.< / strong > Regtest Tips And Hints< / a > < / li > < li class = "chapter-item expanded " > < a href = "dev/platform-tier-policy.html" > < strong aria-hidden = "true" > 2.4.< / strong > Platform Tier Policy< / a > < / li > < li class = "chapter-item expanded " > < a href = "dev/deprecation.html" > < strong aria-hidden = "true" > 2.5.< / strong > Deprecation Procedure< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "design.html" > < strong aria-hidden = "true" > 3.< / strong > Design< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "design/chain-state.html" > < strong aria-hidden = "true" > 3.1.< / strong > Chain State< / a > < / li > < li class = "chapter-item expanded " > < a href = "design/coins-view.html" > < strong aria-hidden = "true" > 3.2.< / strong > "Coins" View< / a > < / li > < li class = "chapter-item expanded " > < a href = "design/p2p-data-propagation.html" > < strong aria-hidden = "true" > 3.3.< / strong > P2P Data Propagation< / a > < / li > < / ol > < / li > < / ol >
2021-10-05 15:26:28 -07:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
2023-04-23 17:24:14 -07:00
< div id = "menu-bar-hover-placeholder" > < / div >
2021-10-05 15:26:28 -07:00
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
2023-04-23 17:24:14 -07:00
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light< / button > < / li >
2021-10-05 15:26:28 -07:00
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
< / div >
< h1 class = "menu-title" > The zcashd Book< / h1 >
< div class = "right-buttons" >
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
2023-04-23 17:24:14 -07:00
2021-10-05 15:26:28 -07:00
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
2023-04-23 17:24:14 -07:00
2021-10-05 15:26:28 -07:00
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
2023-04-23 17:24:14 -07:00
< script >
2021-10-05 15:26:28 -07:00
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
2023-04-23 17:24:14 -07:00
< h1 > Zcash 5.5.0-rc1
2021-10-05 15:26:28 -07:00
< img align = "right" width = "120" height = "80" src = "doc/imgs/logo.png" > < / h1 >
< h2 id = "what-is-zcash" > < a class = "header" href = "#what-is-zcash" > What is Zcash?< / a > < / h2 >
< p > < a href = "https://z.cash/" > Zcash< / a > is an implementation of the " Zerocash" protocol.
2023-04-23 17:24:14 -07:00
Initially based on Bitcoin's design, Zcash intends to offer a far
higher standard of privacy through a sophisticated zero-knowledge
proving scheme that preserves confidentiality of transaction
metadata. More technical details are available in our < a href = "https://zips.z.cash/protocol/protocol.pdf" > Protocol
Specification< / a > .< / p >
< h2 id = "the-zcashd-full-node" > < a class = "header" href = "#the-zcashd-full-node" > The < code > zcashd< / code > Full Node< / a > < / h2 >
< p > This repository hosts the < code > zcashd< / code > software, a Zcash consensus node
implementation. It downloads and stores the entire history of Zcash
transactions. Depending on the speed of your computer and network
connection, the synchronization process could take several days.< / p >
2021-10-05 15:26:28 -07:00
< p align = "center" >
< img src = "doc/imgs/zcashd_screen.gif" height = "500" >
< / p >
2023-04-23 17:24:14 -07:00
< p > The < code > zcashd< / code > code is derived from a source fork of
< a href = "https://github.com/bitcoin/bitcoin" > Bitcoin Core< / a > . The code was forked
initially from Bitcoin Core v0.11.2, and the two codebases have diverged
substantially.< / p >
2021-10-05 15:26:28 -07:00
< h4 id = "lock-security-warnings" > < a class = "header" href = "#lock-security-warnings" > :lock: Security Warnings< / a > < / h4 >
< p > See important security warnings on the
< a href = "https://z.cash/support/security/" > Security Information page< / a > .< / p >
< p > < strong > Zcash is experimental and a work in progress.< / strong > Use it at your own risk.< / p >
< h4 id = "ledger-deprecation-policy" > < a class = "header" href = "#ledger-deprecation-policy" > :ledger: Deprecation Policy< / a > < / h4 >
< p > This release is considered deprecated 16 weeks after the release day. There
is an automatic deprecation shutdown feature which will halt the node some
time after this 16-week period. The automatic feature is based on block
height.< / p >
2023-04-23 17:24:14 -07:00
< h2 id = "other-zcash-implementations" > < a class = "header" href = "#other-zcash-implementations" > Other Zcash Implementations< / a > < / h2 >
< p > The < a href = "https://github.com/ZcashFoundation/zebra" > Zebra< / a > project offers a
different Zcash consensus node implementation, written largely from the
ground up.< / p >
2021-10-05 15:26:28 -07:00
< h2 id = "getting-started" > < a class = "header" href = "#getting-started" > Getting Started< / a > < / h2 >
2023-04-23 17:24:14 -07:00
< p > Please see our < a href = "https://zcash.readthedocs.io/en/latest/rtd_pages/rtd_docs/user_guide.html" > user
guide< / a >
for instructions on joining the main Zcash network.< / p >
2021-10-05 15:26:28 -07:00
< h3 id = "need-help" > < a class = "header" href = "#need-help" > Need Help?< / a > < / h3 >
< ul >
< li > :blue_book: See the documentation at the < a href = "https://zcash.readthedocs.io" > ReadTheDocs< / a >
for help and more information.< / li >
< li > :incoming_envelope: Ask for help on the < a href = "https://forum.z.cash/" > Zcash< / a > forum.< / li >
< li > :speech_balloon: Join our community on < a href = "https://discordapp.com/invite/PhJY6Pm" > Discord< / a > < / li >
< / ul >
< p > Participation in the Zcash project is subject to a
< a href = "code_of_conduct.html" > Code of Conduct< / a > .< / p >
< h3 id = "building" > < a class = "header" href = "#building" > Building< / a > < / h3 >
< p > Build Zcash along with most dependencies from source by running the following command:< / p >
< pre > < code > ./zcutil/build.sh -j$(nproc)
< / code > < / pre >
< p > Currently, Zcash is only officially supported on Debian and Ubuntu. See the
< a href = "https://zcash.readthedocs.io/en/latest/rtd_pages/Debian-Ubuntu-build.html" > Debian / Ubuntu build< / a >
for detailed instructions.< / p >
< h2 id = "license" > < a class = "header" href = "#license" > License< / a > < / h2 >
< p > For license information see the file < a href = "COPYING" > COPYING< / a > .< / p >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2023-04-23 17:24:14 -07:00
2021-10-05 15:26:28 -07:00
< a rel = "next" href = "user.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
2023-04-23 17:24:14 -07:00
2021-10-05 15:26:28 -07:00
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2023-04-23 17:24:14 -07:00
2021-10-05 15:26:28 -07:00
< a rel = "next" href = "user.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / nav >
< / div >
2023-04-23 17:24:14 -07:00
< script >
2021-10-05 15:26:28 -07:00
window.playground_copyable = true;
< / script >
2023-04-23 17:24:14 -07:00
< script src = "elasticlunr.min.js" > < / script >
< script src = "mark.min.js" > < / script >
< script src = "searcher.js" > < / script >
< script src = "clipboard.min.js" > < / script >
< script src = "highlight.js" > < / script >
< script src = "book.js" > < / script >
2021-10-05 15:26:28 -07:00
<!-- Custom JS scripts -->
2023-04-23 17:24:14 -07:00
< / div >
2021-10-05 15:26:28 -07:00
< / body >
< / html >
