-
Notifications
You must be signed in to change notification settings - Fork 0
/
print.html
368 lines (320 loc) · 17.4 KB
/
print.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
<!DOCTYPE HTML>
<html lang="en" class="light" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>The SHARP Book</title>
<meta name="robots" content="noindex">
<!-- Custom HTML head -->
<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 class="sidebar-visible no-js">
<div id="body-container">
<!-- Provide site root to javascript -->
<script>
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>
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>
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('light')
html.classList.add(theme);
var body = document.querySelector('body');
body.classList.remove('no-js')
body.classList.add('js');
</script>
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
<!-- Hide / unhide sidebar before it is displayed -->
<script>
var body = document.querySelector('body');
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
body.classList.remove('sidebar-visible');
body.classList.add("sidebar-" + sidebar);
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item expanded affix "><a href="ch00-00-introduction.html">Introduction</a></li><li class="chapter-item expanded "><a href="ch01-00-architecture.html"><strong aria-hidden="true">1.</strong> Architecture 🚧</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="ch01-01-cairo_pie.html"><strong aria-hidden="true">1.1.</strong> Cairo PIE</a></li><li class="chapter-item expanded "><a href="ch01-02-gateway.html"><strong aria-hidden="true">1.2.</strong> Gateway</a></li><li class="chapter-item expanded "><div><strong aria-hidden="true">1.3.</strong> Validator</div></li><li class="chapter-item expanded "><div><strong aria-hidden="true">1.4.</strong> Scheduler</div></li><li class="chapter-item expanded "><div><strong aria-hidden="true">1.5.</strong> Runner</div></li><li class="chapter-item expanded "><div><strong aria-hidden="true">1.6.</strong> Prover</div></li><li class="chapter-item expanded "><div><strong aria-hidden="true">1.7.</strong> Dispatcher</div></li></ol></li><li class="chapter-item expanded "><a href="ch02-00-playground.html"><strong aria-hidden="true">2.</strong> Playground</a></li></ol>
</div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>
<!-- Track and set sidebar scroll position -->
<script>
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
sidebarScrollbox.addEventListener('click', function(e) {
if (e.target.tagName === 'A') {
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
}
}, { passive: true });
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
sessionStorage.removeItem('sidebar-scroll');
if (sidebarScrollTop) {
// preserve sidebar scroll position when navigating via links within sidebar
sidebarScrollbox.scrollTop = sidebarScrollTop;
} else {
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
var activeSection = document.querySelector('#sidebar .active');
if (activeSection) {
activeSection.scrollIntoView({ block: 'center' });
}
}
</script>
<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">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<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</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">The SHARP 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>
</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>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
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 id="introduction"><a class="header" href="#introduction">Introduction</a></h1>
<p>SHARP (SHARed Prover) is a powerful system designed to generate aggregated STARK proofs for multiple Cairo programs, amortizing the cost of all programs proven across a single proof.</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="architecture"><a class="header" href="#architecture">Architecture</a></h1>
<p>This chapter hopes to shed some light on SHARP's boldly carved but dimly lit tunnel architecture.</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="cairo-pie"><a class="header" href="#cairo-pie">Cairo PIE</a></h1>
<h2 id="making-a-cairo-pie"><a class="header" href="#making-a-cairo-pie">Making a Cairo PIE</a></h2>
<p>Making a <a href="./ch02-01-cairo_pies.html">Cairo PIE</a> is much easier than making a real pie, as demonstrated by the following steps:</p>
<ol>
<li>
<p>Install <a href="https://docs.swmansion.com/scarb/"><code>Scarb</code></a>:</p>
<pre><code> curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh
</code></pre>
</li>
<li>
<p>Create a new Cairo project:</p>
<pre><code> scarb new cairo_pie_example
cd cairo_pie_example
</code></pre>
</li>
<li>
<p>Add the following to your project's <code>Scarb.toml</code>:</p>
<pre><code> [cairo]
enable-gas = false
</code></pre>
</li>
<li>
<p>Compile your project:</p>
<pre><code> scarb build
</code></pre>
</li>
<li>
<p>Install <a href="https://github.com/lambdaclass/cairo-vm/tree/main/cairo1-run"><code>cairo-vm/cairo1-run</code></a>:</p>
<pre><code> git clone https://github.com/lambdaclass/cairo-vm.git
cd cairo-vm/cairo1-run
make deps
</code></pre>
</li>
<li>
<p>Generate your project's Cairo PIE:</p>
<pre><code> cargo run ../../target/dev/cairo_pie_example.sierra.json \
--append_return_values \
--layout=small \
--cairo_pie_output=pie.zip
</code></pre>
</li>
<li>
<p>Bon appétit! 🥧</p>
</li>
</ol>
<div style="break-before: page; page-break-before: always;"></div><h1 id="gateway"><a class="header" href="#gateway">Gateway</a></h1>
<p>The SHARP gateway is an HTTP gateway for all interactions with SHARP.</p>
<h2 id="api"><a class="header" href="#api">API</a></h2>
<h3 id="add_job"><a class="header" href="#add_job"><code>add_job</code></a></h3>
<p><strong>Description:</strong> Adds a Cairo job to SHARP.</p>
<p><strong>URL Parameters:</strong></p>
<ul>
<li><code>customer_id</code>: The customer id</li>
<li><code>cairo_job_key</code>: The Cairo job key</li>
<li><code>offchain_proof</code> (optional): Whether the proof should only be offhcain, defaults to <code>false</code></li>
<li><code>layout_proof</code> (optional): The layout proof, defaults to <code>dynamic</code></li>
</ul>
<p><strong>Data:</strong> A base 64 encoding of a <a href="./ch01-03-making_cairo_pies.html">Cairo PIE</a>.</p>
<p><strong>Example:</strong></p>
<pre><code>$ curl --cert user.crt --key user.key --cacert server.crt \
https://sepolia-recursive.public-testnet.provingservice.io/v1/gateway/add_job?customer_id=the_sharp_book&cairo_job_key=example&offchain_proof=true&proof_layout=small \
-d $(base64 -i pie.zip)
{"code": "JOB_RECEIVED_SUCCESSFULLY"}
</code></pre>
<h3 id="get_status"><a class="header" href="#get_status"><code>get_status</code></a></h3>
<p><strong>Description:</strong> Gets that status of a Cairo job.</p>
<p><strong>URL Parameters:</strong></p>
<ul>
<li><code>customer_id</code>: The customer id</li>
<li><code>cairo_job_key</code>: The Cairo job key</li>
</ul>
<p><strong>Example:</strong></p>
<pre><code>$ curl --cert user.crt --key user.key --cacert server.crt \
https://sepolia-recursive.public-testnet.provingservice.io/v1/gateway/get_status?customer_id=the_sharp_book&cairo_job_key=example
{"status": "PROCESSED"}
</code></pre>
<h3 id="get_proof"><a class="header" href="#get_proof"><code>get_proof</code></a></h3>
<p><strong>Description:</strong> Gets the proof of a Cairo job added with <code>offchain_proof=true</code>.</p>
<p><strong>URL Parameters:</strong></p>
<ul>
<li><code>customer_id</code>: The customer id</li>
<li><code>cairo_job_key</code>: The Cairo job key</li>
</ul>
<p><strong>Example:</strong></p>
<pre><code>$ curl --cert user.crt --key user.key --cacert server.crt \
https://sepolia-recursive.public-testnet.provingservice.io/v1/gateway/get_proof?customer_id=the_sharp_book&cairo_job_key=example
{"annotations": ... }
</code></pre>
<h3 id="is_alive"><a class="header" href="#is_alive"><code>is_alive</code></a></h3>
<p><strong>Description:</strong> Checks that the SHARP gateway is alive.</p>
<p><strong>Example:</strong></p>
<pre><code>$ curl --cert user.crt --key user.key --cacert server.crt \
https://sepolia-recursive.public-testnet.provingservice.io/v1/gateway/is_alive
gateway is alive!</code></pre>
<div style="break-before: page; page-break-before: always;"></div><h1 id="playground"><a class="header" href="#playground">Playground</a></h1>
<p><code>cairo-sharp</code> is a command line utility included in <a href="https://github.com/starkware-libs/cairo-lang">the <code>cairo-lang</code> package</a> that gives free but limited access to <a href="./ch01-01-the_sharp_gateway.html">the SHARP gateway</a>.</p>
<h2 id="commands"><a class="header" href="#commands">Commands</a></h2>
<h3 id="submit"><a class="header" href="#submit"><code>submit</code></a></h3>
<blockquote>
<p><strong><em>NOTE:</em></strong> <code>cairo-sharp submit</code> is rate-limited to prevent a DOS attack on SHARP.</p>
</blockquote>
<p><strong>Description:</strong> Submits a <a href="./ch01-03-making_cairo_pies.html">Cairo PIE</a> to be proven and verified on Sepolia.</p>
<p><strong>Parameters:</strong></p>
<ul>
<li><code>cairo_pie</code>: The Cairo PIE</li>
</ul>
<p><strong>Example:</strong></p>
<pre><code>$ cairo-sharp submit pie.zip
Compiling...
Running...
Submitting to SHARP...
Job sent.
Job key: 699bf741-7c91-4b93-a158-aaddac7534c1s
Fact: 0xca15503f02f8406b599cb220879e842394f5cf2cef753f3ee430647b5981b782
</code></pre>
<h3 id="status"><a class="header" href="#status"><code>status</code></a></h3>
<p><strong>Description:</strong> Gets that status of a job submitted by <code>cairo-sharp submit</code>.</p>
<p><strong>Parameters:</strong></p>
<ul>
<li><code>job_key</code>: The key of a job submitted by <code>cairo-sharp submit</code></li>
</ul>
<p><strong>Example:</strong></p>
<pre><code>$ cairo-sharp status 699bf741-7c91-4b93-a158-aaddac7534c1
PROCESSED
</code></pre>
<h3 id="is_verified"><a class="header" href="#is_verified"><code>is_verified</code></a></h3>
<p><strong>Description:</strong> Checks if a job submitted by <code>cairo-sharp submit</code> has been verified on Sepolia.</p>
<p><strong>Parameters:</strong></p>
<ul>
<li><code>fact</code>: The fact of a job submitted by <code>cairo-sharp submit</code></li>
<li><code>node_url</code>: An Ethereum node url</li>
</ul>
<p><strong>Example:</strong></p>
<pre><code>$ cairo-sharp is_verified 0xca15503f02f8406b599cb220879e842394f5cf2cef753f3ee430647b5981b782 \
--node_url https://ethereum-sepolia-rpc.publicnode.com
True</code></pre>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
</nav>
</div>
<script>
window.playground_copyable = true;
</script>
<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>
<!-- Custom JS scripts -->
<script>
window.addEventListener('load', function() {
window.setTimeout(window.print, 100);
});
</script>
</div>
</body>
</html>