2021-05-18 12:17:00 -07:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Developer tools - The halo2 Book< / title >
<!-- 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" / >
2021-10-14 03:44:50 -07:00
< link rel = "icon" href = "../favicon.svg" >
< link rel = "shortcut icon" href = "../favicon.png" >
< link rel = "stylesheet" href = "../css/variables.css" >
2021-05-18 12:17:00 -07:00
< link rel = "stylesheet" href = "../css/general.css" >
< link rel = "stylesheet" href = "../css/chrome.css" >
2021-10-14 03:44:50 -07:00
< link rel = "stylesheet" href = "../css/print.css" media = "print" >
2021-05-18 12:17:00 -07:00
<!-- Fonts -->
< link rel = "stylesheet" href = "../FontAwesome/css/font-awesome.css" >
2021-10-14 03:44:50 -07:00
< link rel = "stylesheet" href = "../fonts/fonts.css" >
2021-05-18 12:17:00 -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 -->
2021-10-14 03:44:50 -07:00
< / head >
2021-05-18 12:17:00 -07:00
< 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-10-18 09:58:24 -07:00
< ol class = "chapter" > < li class = "chapter-item expanded affix " > < a href = "../index.html" > halo2< / 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/proofs.html" > < strong aria-hidden = "true" > 1.1.< / strong > Proof systems< / a > < / li > < li class = "chapter-item expanded " > < a href = "../concepts/arithmetization.html" > < strong aria-hidden = "true" > 1.2.< / strong > PLONKish Arithmetization< / a > < / li > < li class = "chapter-item expanded " > < a href = "../concepts/chips.html" > < strong aria-hidden = "true" > 1.3.< / strong > Chips< / a > < / li > < li class = "chapter-item expanded " > < a href = "../concepts/gadgets.html" > < strong aria-hidden = "true" > 1.4.< / strong > Gadgets< / 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/dev-tools.html" class = "active" > < strong aria-hidden = "true" > 2.1.< / strong > Developer tools< / a > < / li > < li class = "chapter-item expanded " > < a href = "../user/simple-example.html" > < strong aria-hidden = "true" > 2.2.< / strong > A simple example< / a > < / li > < li class = "chapter-item expanded " > < a href = "../user/lookup-tables.html" > < strong aria-hidden = "true" > 2.3.< / strong > Lookup tables< / a > < / li > < li class = "chapter-item expanded " > < a href = "../user/gadgets.html" > < strong aria-hidden = "true" > 2.4.< / strong > Gadgets< / a > < / li > < li class = "chapter-item expanded " > < a href = "../user/tips-and-tricks.html" > < strong aria-hidden = "true" > 2.5.< / strong > Tips and tricks< / a > < / li > < li class = "chapter-item expanded " > < a href = "../user/wasm-port.html" > < strong aria-hidden = "true" > 2.6.< / strong > WASM Guide< / 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/proving-system.html" > < strong aria-hidden = "true" > 3.1.< / strong > Proving system< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../design/proving-system/lookup.html" > < strong aria-hidden = "true" > 3.1.1.< / strong > Lookup argument< / a > < / li > < li class = "chapter-item expanded " > < a href = "../design/proving-system/permutation.html" > < strong aria-hidden = "true" > 3.1.2.< / strong > Permutation argument< / a > < / li > < li class = "chapter-item expanded " > < a href = "../design/proving-system/circuit-commitments.html" > < strong aria-hidden = "true" > 3.1.3.< / strong > Circuit commitments< / a > < / li > < li class = "chapter-item expanded " > < a href = "../design/proving-system/vanishing.html" > < strong aria-hidden = "true" > 3.1.4.< / strong > Vanishing argument< / a > < / li > < li class = "chapter-item expanded " > < a href = "../design/proving-system/multipoint-opening.html" > < strong aria-hidden = "true" > 3.1.5.< / strong > Multipoint opening argument< / a > < / li > < li class = "chapter-item expanded " > < a href = "../design/proving-system/inner-product.html" > < strong aria-hidden = "true" > 3.1.6.< / strong > Inner product argument< / a > < / li > < li class = "chapter-item expanded " > < a href = "../design/proving-system/comparison.html" > < strong aria-hidden = "true" > 3.1.7.< / strong > Comparison to other work< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../design/protocol.html" > < strong aria-hidden = "true" > 3.2.< / strong > Protocol Description< / a > < / li > < li class = "chapter-item expanded " > < a href = "../design/implementation.html" > < strong aria-hidden = "true" > 3.3.< / strong > Implementation< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../design/implementation/proofs.html" > < strong aria-hidden = "true" > 3.3.1.< / strong > Proofs< / a > < / li > < li class = "chapter-item expanded " > < a href = "../design/implementation/fields.html" > < strong aria-hidden = "true" > 3.3.2.< / strong > Fields< / a > < / li > < li class = "chapter-item expanded " > < a href = "../design/implementation/selector-combining.html" > < strong aria-hidden = "true" > 3.3.3.< / strong > Selector combining< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../design/gadgets.html" > < strong aria-hidden = "true" > 3.4.< / strong > Gadgets< / a > < / li > < li > <
2021-10-14 03:44:50 -07:00
< / div >
2021-05-18 12:17:00 -07:00
< 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 >
2021-10-14 03:44:50 -07:00
< 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" >
2021-05-18 12:17:00 -07:00
< i class = "fa fa-search" > < / i >
< / button >
2021-10-14 03:44:50 -07:00
< / div >
2021-05-18 12:17:00 -07:00
< h1 class = "menu-title" > The halo2 Book< / h1 >
< div class = "right-buttons" >
2021-10-14 03:44:50 -07:00
< a href = "../print.html" title = "Print this book" aria-label = "Print this book" >
2021-05-18 12:17:00 -07:00
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
< / div >
< / div >
2021-10-14 03:44:50 -07:00
< div id = "search-wrapper" class = "hidden" >
2021-05-18 12:17:00 -07:00
< form id = "searchbar-outer" class = "searchbar-outer" >
2021-06-05 03:42:23 -07:00
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
2021-05-18 12:17:00 -07:00
< / 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 >
< 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" >
2021-06-05 03:42:23 -07:00
< h1 id = "developer-tools" > < a class = "header" href = "#developer-tools" > Developer tools< / a > < / h1 >
2021-05-18 12:17:00 -07:00
< p > The < code > halo2< / code > crate includes several utilities to help you design and implement your
circuits.< / p >
2021-06-05 03:42:23 -07:00
< h2 id = "mock-prover" > < a class = "header" href = "#mock-prover" > Mock prover< / a > < / h2 >
2022-02-03 17:33:56 -08:00
< p > < code > halo2_proofs::dev::MockProver< / code > is a tool for debugging circuits, as well as cheaply verifying
2021-05-18 12:17:00 -07:00
their correctness in unit tests. The private and public inputs to the circuit are
constructed as would normally be done to create a proof, but < code > MockProver::run< / code > instead
creates an object that will test every constraint in the circuit directly. It returns
granular error messages that indicate which specific constraint (if any) is not satisfied.< / p >
2021-06-05 03:42:23 -07:00
< h2 id = "circuit-visualizations" > < a class = "header" href = "#circuit-visualizations" > Circuit visualizations< / a > < / h2 >
2021-05-18 12:17:00 -07:00
< p > The < code > dev-graph< / code > feature flag exposes several helper methods for creating graphical
representations of circuits.< / p >
2021-11-11 15:17:43 -08:00
< p > On Debian systems, you will need the following additional packages:< / p >
< pre > < code class = "language-plaintext" > sudo apt install cmake libexpat1-dev libfreetype6-dev
< / code > < / pre >
2021-11-10 06:54:44 -08:00
< h3 id = "circuit-layout" > < a class = "header" href = "#circuit-layout" > Circuit layout< / a > < / h3 >
2022-02-03 17:33:56 -08:00
< p > < code > halo2_proofs::dev::CircuitLayout< / code > renders the circuit layout as a grid:< / p >
2021-11-10 06:54:44 -08:00
< pre > < code class = "language-rust ignore no_run" > fn main() {
// Prepare the circuit you want to render.
// You don't need to include any witness variables.
2022-01-05 00:08:15 -08:00
let a = Fp::random(OsRng);
2021-11-10 06:54:44 -08:00
let instance = Fp::one() + Fp::one();
let lookup_table = vec![instance, a, a, Fp::zero()];
let circuit: MyCircuit< Fp> = MyCircuit {
2022-06-13 08:47:25 -07:00
a: Value::unknown(),
2021-11-10 06:54:44 -08:00
lookup_table,
};
// Create the area you want to draw on.
// Use SVGBackend if you want to render to .svg instead.
use plotters::prelude::*;
let root = BitMapBackend::new(" layout.png" , (1024, 768)).into_drawing_area();
root.fill(& WHITE).unwrap();
let root = root
.titled(" Example Circuit Layout" , (" sans-serif" , 60))
.unwrap();
2022-02-03 17:33:56 -08:00
halo2_proofs::dev::CircuitLayout::default()
2021-11-10 06:54:44 -08:00
// You can optionally render only a section of the circuit.
.view_width(0..2)
.view_height(0..16)
// You can hide labels, which can be useful with smaller areas.
.show_labels(false)
// Render the circuit onto your area!
// The first argument is the size parameter for the circuit.
.render(5, & circuit, & root)
.unwrap();
}
< / code > < / pre >
2021-05-18 12:17:00 -07:00
< ul >
2021-12-31 06:19:41 -08:00
< li > Columns are laid out from left to right as instance, advice and fixed. The order of
2021-05-18 12:17:00 -07:00
columns is otherwise without meaning.
< ul >
< li > Instance columns have a white background.< / li >
2021-11-10 06:54:44 -08:00
< li > Advice columns have a red background.< / li >
2021-05-18 12:17:00 -07:00
< li > Fixed columns have a blue background.< / li >
< / ul >
< / li >
< li > Regions are shown as labelled green boxes (overlaying the background colour). A region
may appear as multiple boxes if some of its columns happen to not be adjacent.< / li >
< li > Cells that have been assigned to by the circuit will be shaded in grey. If any cells are
assigned to more than once (which is usually a mistake), they will be shaded darker than
the surrounding cells.< / li >
< / ul >
2021-11-10 06:54:44 -08:00
< h3 id = "circuit-structure" > < a class = "header" href = "#circuit-structure" > Circuit structure< / a > < / h3 >
2022-02-03 17:33:56 -08:00
< p > < code > halo2_proofs::dev::circuit_dot_graph< / code > builds a < a href = "https://graphviz.org/doc/info/lang.html" > DOT graph string< / a > representing the given
2021-12-31 06:19:41 -08:00
circuit, which can then be rendered with a variety of < a href = "https://en.wikipedia.org/wiki/DOT_(graph_description_language)#Layout_programs" > layout programs< / a > . The graph is built
2021-05-18 12:17:00 -07:00
from calls to < code > Layouter::namespace< / code > both within the circuit, and inside the gadgets and
chips that it uses.< / p >
2021-11-10 06:54:44 -08:00
< pre > < code class = "language-rust ignore no_run" > fn main() {
// Prepare the circuit you want to render.
// You don't need to include any witness variables.
let a = Fp::rand();
let instance = Fp::one() + Fp::one();
let lookup_table = vec![instance, a, a, Fp::zero()];
let circuit: MyCircuit< Fp> = MyCircuit {
a: None,
lookup_table,
};
// Generate the DOT graph string.
2022-02-03 17:33:56 -08:00
let dot_string = halo2_proofs::dev::circuit_dot_graph(& circuit);
2021-11-10 06:54:44 -08:00
// Now you can either handle it in Rust, or just
// print it out to use with command-line tools.
print!(" {}" , dot_string);
}
< / code > < / pre >
2021-06-05 03:42:23 -07:00
< h2 id = "cost-estimator" > < a class = "header" href = "#cost-estimator" > Cost estimator< / a > < / h2 >
2021-05-18 12:17:00 -07:00
< p > The < code > cost-model< / code > binary takes high-level parameters for a circuit design, and estimates
the verification cost, as well as resulting proof size.< / p >
2021-05-18 13:03:10 -07:00
< pre > < code class = "language-plaintext" > Usage: cargo run --example cost-model -- [OPTIONS] k
2021-05-18 12:17:00 -07:00
Positional arguments:
k 2^K bound on the number of rows.
Optional arguments:
-h, --help Print this message.
-a, --advice R[,R..] An advice column with the given rotations. May be repeated.
-i, --instance R[,R..] An instance column with the given rotations. May be repeated.
-f, --fixed R[,R..] A fixed column with the given rotations. May be repeated.
-g, --gate-degree D Maximum degree of the custom gates.
-l, --lookup N,I,T A lookup over N columns with max input degree I and max table degree T. May be repeated.
-p, --permutation N A permutation over N columns. May be repeated.
< / code > < / pre >
< p > For example, to estimate the cost of a circuit with three advice columns and one fixed
column (with various rotations), and a maximum gate degree of 4:< / p >
2021-11-10 06:54:44 -08:00
< pre > < code class = "language-plaintext" > > cargo run --example cost-model -- -a 0,1 -a 0 -a-0,-1,1 -f 0 -g 4 11
Finished dev [unoptimized + debuginfo] target(s) in 0.03s
Running `target/debug/examples/cost-model -a 0,1 -a 0 -a 0,-1,1 -f 0 -g 4 11`
Circuit {
k: 11,
max_deg: 4,
advice_columns: 3,
lookups: 0,
permutations: [],
column_queries: 7,
point_sets: 3,
estimator: Estimator,
}
Proof size: 1440 bytes
Verification: at least 81.689ms
< / code > < / pre >
2021-05-18 12:17:00 -07:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2021-10-14 03:44:50 -07:00
< a rel = "prev" href = "../user.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-05-18 12:17:00 -07:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2021-10-14 03:44:50 -07:00
< a rel = "next" href = "../user/simple-example.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-05-18 12:17:00 -07:00
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2021-10-14 03:44:50 -07:00
< a rel = "prev" href = "../user.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-05-18 12:17:00 -07:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2021-10-14 03:44:50 -07:00
< a rel = "next" href = "../user/simple-example.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-05-18 12:17:00 -07:00
< i class = "fa fa-angle-right" > < / i >
< / a >
2021-10-14 03:44:50 -07:00
< / nav >
2021-05-18 12:17:00 -07:00
< / div >
2021-10-14 03:44:50 -07:00
< script type = "text/javascript" >
2021-05-18 12:17:00 -07:00
window.playground_copyable = true;
< / script >
2021-10-14 03:44:50 -07:00
< script src = "../elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
2021-05-18 12:17:00 -07:00
< 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 >
