2020-10-20 15:04:07 -07:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
2021-01-08 08:58:47 -08:00
< title > Design - The Orchard Book< / title >
2020-10-20 15:04:07 -07:00
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< 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" >
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "fonts/fonts.css" >
<!-- 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 -->
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
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 -->
< script type = "text/javascript" >
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 -->
< script type = "text/javascript" >
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 -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
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" >
2022-04-28 09:45:52 -07:00
< ol class = "chapter" > < li class = "chapter-item expanded affix " > < a href = "index.html" > Orchard< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts.html" > < strong aria-hidden = "true" > 1.< / strong > Concepts< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "concepts/preliminaries.html" > < strong aria-hidden = "true" > 1.1.< / strong > Preliminaries< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "user.html" > < strong aria-hidden = "true" > 2.< / strong > User Documentation< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "user/keys.html" > < strong aria-hidden = "true" > 2.1.< / strong > Creating keys and addresses< / a > < / li > < li class = "chapter-item expanded " > < a href = "user/creating-notes.html" > < strong aria-hidden = "true" > 2.2.< / strong > Creating notes< / a > < / li > < li class = "chapter-item expanded " > < a href = "user/spending-notes.html" > < strong aria-hidden = "true" > 2.3.< / strong > Spending notes< / a > < / li > < li class = "chapter-item expanded " > < a href = "user/integration.html" > < strong aria-hidden = "true" > 2.4.< / strong > Integration into an existing chain< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "design.html" class = "active" > < strong aria-hidden = "true" > 3.< / strong > Design< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "design/keys.html" > < strong aria-hidden = "true" > 3.1.< / strong > Keys and addresses< / a > < / li > < li class = "chapter-item expanded " > < a href = "design/actions.html" > < strong aria-hidden = "true" > 3.2.< / strong > Actions< / a > < / li > < li class = "chapter-item expanded " > < a href = "design/commitments.html" > < strong aria-hidden = "true" > 3.3.< / strong > Commitments< / a > < / li > < li class = "chapter-item expanded " > < a href = "design/commitment-tree.html" > < strong aria-hidden = "true" > 3.4.< / strong > Commitment tree< / a > < / li > < li class = "chapter-item expanded " > < a href = "design/nullifiers.html" > < strong aria-hidden = "true" > 3.5.< / strong > Nullifiers< / a > < / li > < li class = "chapter-item expanded " > < a href = "design/signatures.html" > < strong aria-hidden = "true" > 3.6.< / strong > Signatures< / a > < / li > < li class = "chapter-item expanded " > < a href = "design/circuit.html" > < strong aria-hidden = "true" > 3.7.< / strong > Circuit< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "design/circuit/gadgets.html" > < strong aria-hidden = "true" > 3.7.1.< / strong > Gadgets< / a > < / li > < li class = "chapter-item expanded " > < a href = "design/circuit/commit-ivk.html" > < strong aria-hidden = "true" > 3.7.2.< / strong > CommitIvk< / a > < / li > < li class = "chapter-item expanded " > < a href = "design/circuit/note-commit.html" > < strong aria-hidden = "true" > 3.7.3.< / strong > NoteCommit< / a > < / li > < / ol > < / li > < / ol > < / li > < / ol >
2020-10-20 15:04:07 -07:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< 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" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
< 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 >
2021-01-08 08:58:47 -08:00
< h1 class = "menu-title" > The Orchard Book< / h1 >
2020-10-20 15:04:07 -07:00
< 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 >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" name = "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 >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
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 >
2021-01-08 09:28:54 -08:00
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/katex.min.css" integrity = "sha384-AfEj0r4/OFrOo5t7NnNe46zW/tFgW6x/bCJG8FqQCEo3+Aro6EYUG4+cU+KJWu/X" crossorigin = "anonymous" >
< h1 > < a class = "header" href = "#design" id = "design" > Design< / a > < / h1 >
< h2 > < a class = "header" href = "#general-design-notes" id = "general-design-notes" > General design notes< / a > < / h2 >
< h3 > < a class = "header" href = "#requirements" id = "requirements" > Requirements< / a > < / h3 >
< ul >
< li > Keep the design close to Sapling, while eliminating aspects we don't like.< / li >
< / ul >
< h3 > < a class = "header" href = "#non-requirements" id = "non-requirements" > Non-requirements< / a > < / h3 >
< ul >
< li > Delegated proving with privacy from the prover.
< ul >
< li > We know how to do this, but it would require a discrete log equality proof, and the
most efficient way to do this would be to do RedDSA and this at the same time, which
means more work for e.g. hardware wallets.< / li >
< / ul >
< / li >
< / ul >
< h3 > < a class = "header" href = "#open-issues" id = "open-issues" > Open issues< / a > < / h3 >
< ul >
< li > Should we have one memo per output, or one memo per transaction, or 0..n memos?
< ul >
< li > Variable, or (1 or n), is a potential privacy leak.< / li >
< li > Need to consider the privacy issue related to light clients requesting individual
memos vs being able to fetch all memos.< / li >
< / ul >
< / li >
< / ul >
< h3 > < a class = "header" href = "#note-structure" id = "note-structure" > Note structure< / a > < / h3 >
< ul >
< li > TODO: UDAs: arbitrary vs whitelisted< / li >
< / ul >
< h3 > < a class = "header" href = "#typed-variables-vs-byte-encodings" id = "typed-variables-vs-byte-encodings" > Typed variables vs byte encodings< / a > < / h3 >
< p > For Sapling, we have encountered multiple places where the specification uses typed
variables to define the consensus rules, but the C++ implementation in zcashd relied on
byte encodings to implement them. This resulted in subtly-different consensus rules being
deployed than were intended, for example where a particular type was not round-trip
encodable.< / p >
< p > In Orchard, we avoid this by defining the consensus rules in terms of the byte encodings
of all variables, and being explicit about any types that are not round-trip encodable.
This makes consensus compatibility between strongly-typed implementations (such as this
crate) and byte-oriented implementations easier to achieve.< / p >
2020-10-20 15:04:07 -07:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2020-10-28 11:08:29 -07:00
< a rel = "prev" href = "user/integration.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
2020-10-20 15:04:07 -07:00
2021-02-11 11:16:22 -08:00
< a rel = "next" href = "design/keys.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-01-08 09:28:54 -08:00
< i class = "fa fa-angle-right" > < / i >
< / a >
2020-10-20 15:04:07 -07:00
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2020-10-28 11:08:29 -07:00
< a rel = "prev" href = "user/integration.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
2020-10-20 15:04:07 -07:00
2021-02-11 11:16:22 -08:00
< a rel = "next" href = "design/keys.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-01-08 09:28:54 -08:00
< i class = "fa fa-angle-right" > < / i >
< / a >
2020-10-20 15:04:07 -07:00
< / nav >
< / div >
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
< script src = "elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< / body >
< / html >
