mirror of
https://github.com/semaphore-protocol/semaphore.git
synced 2026-04-28 03:00:41 -04:00
316 lines
16 KiB
HTML
316 lines
16 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="sidebar-visible no-js light">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Usage - </title>
|
|
|
|
|
|
<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="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 href="https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800" rel="stylesheet" type="text/css">
|
|
<link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500" rel="stylesheet" type="text/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 ? "light" : "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 id="sidebar-scrollbox" class="sidebar-scrollbox">
|
|
<ol class="chapter"><li class="expanded "><a href="about.html"><strong aria-hidden="true">1.</strong> About</a></li><li class="expanded "><a href="howitworks.html"><strong aria-hidden="true">2.</strong> How it works</a></li><li class="expanded "><a href="quickstart.html"><strong aria-hidden="true">3.</strong> Quick start</a></li><li class="expanded "><a href="usage.html" class="active"><strong aria-hidden="true">4.</strong> Usage</a></li><li class="expanded "><a href="api.html"><strong aria-hidden="true">5.</strong> Contract API</a></li><li class="expanded "><a href="libsemaphore.html"><strong aria-hidden="true">6.</strong> libsemaphore</a></li><li class="expanded "><a href="trustedsetup.html"><strong aria-hidden="true">7.</strong> Trusted setup</a></li><li class="expanded "><a href="audit.html"><strong aria-hidden="true">8.</strong> Security audit</a></li><li class="expanded "><a href="creditsandresources.html"><strong aria-hidden="true">9.</strong> Credits and resources</a></li></ol>
|
|
</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" class="menu-bar">
|
|
<div id="menu-bar-sticky-container">
|
|
<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>
|
|
|
|
<h1 class="menu-title"></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>
|
|
|
|
</div>
|
|
</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>
|
|
<h1><a class="header" href="#usage" id="usage">Usage</a></h1>
|
|
<p>The Semaphore contract forms a base layer for other contracts to create
|
|
applications that rely on anonymous signaling.</p>
|
|
<p>First, you should ensure that the proving key, verification key, and circuit
|
|
file, which are static, be easily available to your users. These may be hosted
|
|
in a CDN or bundled with your application code.</p>
|
|
<p>The Semaphore team has not performed a trusted setup yet, so trustworthy
|
|
versions of these files are not available yet.</p>
|
|
<p>Untrusted versions of these files, however, may be obtained via the
|
|
<code>circuits/scripts/download_snarks.sh</code> script.</p>
|
|
<p>Next, to have full flexibility over Semaphore's mechanisms, write a Client
|
|
contract and set the owner of the Semaphore contract as the address of the
|
|
Client contract. You may also write a Client contract which deploys a Semaphore
|
|
contract in its constructor, or on the fly. </p>
|
|
<p>With the Client contract as the owner of the Semaphore contract, the Client
|
|
contract may call owner-only Semaphore functions such as
|
|
<code>addExternalNullifier()</code>.</p>
|
|
<h2><a class="header" href="#add-deactivate-or-reactivate-external-nullifiiers" id="add-deactivate-or-reactivate-external-nullifiiers">Add, deactivate, or reactivate external nullifiiers</a></h2>
|
|
<p>These functions add, deactivate, and reactivate an external nullifier respectively.
|
|
As each identity can only signal once to an external nullifier, and as a signal
|
|
can only be successfully broadcasted to an active external nullifier, these
|
|
functions enable use cases where it is necessary to have multiple external
|
|
nullifiers or to activate and/or deactivate them.</p>
|
|
<p>Refer to the <a href="https://medium.com/coinmonks/to-mixers-and-beyond-presenting-semaphore-a-privacy-gadget-built-on-ethereum-4c8b00857c9b">high-level explanation of
|
|
Semaphore</a>
|
|
for more details.</p>
|
|
<h2><a class="header" href="#set-broadcast-permissioning" id="set-broadcast-permissioning">Set broadcast permissioning</a></h2>
|
|
<p>Note that <code>Semaphore.broadcastSignal()</code> is permissioned by default, so if you
|
|
wish for anyone to be able to broadcast a signal, the owner of the Semaphore
|
|
contract (either a Client contract or externally owned account) must first
|
|
invoke <code>setPermissioning(false)</code>.</p>
|
|
<p>See <a href="https://github.com/appliedzkp/semaphore/blob/master/contracts/sol/SemaphoreClient.sol">SemaphoreClient.sol</a> for an example.</p>
|
|
<h2><a class="header" href="#insert-identities" id="insert-identities">Insert identities</a></h2>
|
|
<p>To generate an identity commitment, use the <code>libsemaphore</code> functions
|
|
<code>genIdentity()</code> and <code>genIdentityCommitment()</code> Typescript (or Javascript)
|
|
functions:</p>
|
|
<pre><code class="language-ts">const identity: Identity = genIdentity()
|
|
const identityCommitment = genIdentityCommitment(identity)
|
|
</code></pre>
|
|
<p>Be sure to store <code>identity</code> somewhere safe. The <code>serialiseIdentity()</code> function
|
|
can help with this:</p>
|
|
<p><code>const serialisedId: string = serialiseIdentity(identity: Identity)</code></p>
|
|
<p>It converts an <code>Identity</code> into a JSON string which looks like this:</p>
|
|
<pre><code class="language-text">["e82cc2b8654705e427df423c6300307a873a2e637028fab3163cf95b18bb172e","a02e517dfb3a4184adaa951d02bfe0fe092d1ee34438721d798db75b8db083","15c6540bf7bddb0616984fccda7e954a0fb5ea4679ac686509dc4bd7ba9c3b"]
|
|
</code></pre>
|
|
<p>To convert this string back into an <code>Identity</code>, use <code>unSerialiseIdentity()</code>.</p>
|
|
<p><code>const id: Identity = unSerialiseIdentity(serialisedId)</code></p>
|
|
<h2><a class="header" href="#broadcast-signals" id="broadcast-signals">Broadcast signals</a></h2>
|
|
<p>First obtain the leaves of the identity tree (in sequence, up to the user's
|
|
identity commitment, or more).</p>
|
|
<pre><code class="language-ts">const leaves = <list of leaves>
|
|
</code></pre>
|
|
<p>Next, load the circuit from disk (or from a remote source):</p>
|
|
<pre><code class="language-ts">const circuitPath = path.join(__dirname, '/path/to/circuit.json')
|
|
const cirDef = JSON.parse(fs.readFileSync(circuitPath).toString())
|
|
const circuit = genCircuit(cirDef)
|
|
</code></pre>
|
|
<p>Next, use <code>libsemaphore</code>'s <code>genWitness()</code> helper function as such:</p>
|
|
<pre><code>const result = await genWitness(
|
|
signal,
|
|
circuit,
|
|
identity,
|
|
leaves,
|
|
num_levels,
|
|
external_nullifier,
|
|
)
|
|
</code></pre>
|
|
<ul>
|
|
<li><code>signal</code>: a string which is the signal to broadcast.</li>
|
|
<li><code>circuit</code>: the output of <code>genCircuit()</code> (see above).</li>
|
|
<li><code>identity</code>: the user's identity as an <code>Identity</code> object.</li>
|
|
<li><code>leaves</code> the list of leaves in the tree (see above).</li>
|
|
<li><code>num_levels</code>: the depth of the Merkle tree.</li>
|
|
<li><code>external_nullifier</code>: the external nullifier at which to broadcast.</li>
|
|
</ul>
|
|
<p>Load the proving key from disk (or from a remote source):</p>
|
|
<pre><code class="language-ts">const provingKeyPath = path.join(__dirname, '/path/to/proving_key.bin')
|
|
const provingKey: SnarkProvingKey = fs.readFileSync(provingKeyPath)
|
|
</code></pre>
|
|
<p>Generate the proof (this takes about 30-45 seconds on a modern laptop):</p>
|
|
<pre><code class="language-ts">const proof = await genProof(result.witness, provingKey)
|
|
</code></pre>
|
|
<p>Generate the <code>broadcastSignal()</code> parameters:</p>
|
|
<pre><code class="language-ts">const publicSignals = genPublicSignals(result.witness, circuit)
|
|
const params = genBroadcastSignalParams(result, proof, publicSignals)
|
|
</code></pre>
|
|
<p>Finally, invoke <code>broadcastSignal()</code> with the parameters:</p>
|
|
<pre><code class="language-ts">const tx = await semaphoreClientContract.broadcastSignal(
|
|
ethers.utils.toUtf8Bytes(signal),
|
|
params.proof,
|
|
params.root,
|
|
params.nullifiersHash,
|
|
external_nullifier,
|
|
{ gasLimit: 500000 },
|
|
)
|
|
</code></pre>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
|
|
<a rel="prev" href="quickstart.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
|
|
<a rel="next" href="api.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<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">
|
|
|
|
<a href="quickstart.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
|
|
<a href="api.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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
window.playpen_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>
|