Skip to content

Commit

Permalink
Deploy 64c410b
Browse files Browse the repository at this point in the history
  • Loading branch information
@antonbaliasnikov
antonbaliasnikov authored and Deploy from CI committed Dec 10, 2024
0 parents commit dc4e18a
Show file tree
Hide file tree
Showing 103 changed files with 21,931 additions and 0 deletions.
1 change: 1 addition & 0 deletions latest
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v1.5.8
1 change: 1 addition & 0 deletions v1.5.7/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This file makes sure that Github Pages doesn't process mdBook's output.
454 changes: 454 additions & 0 deletions v1.5.7/01-installation.html

Large diffs are not rendered by default.

511 changes: 511 additions & 0 deletions v1.5.7/02-command-line-interface.html

Large diffs are not rendered by default.

529 changes: 529 additions & 0 deletions v1.5.7/03-standard-json.html

Large diffs are not rendered by default.

294 changes: 294 additions & 0 deletions v1.5.7/04-combined-json.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,294 @@
<!DOCTYPE HTML>
<html lang="en" class="light" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Combined JSON - ZKsync Solidity Compiler Toolchain Documentation</title>


<!-- 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 -->
<link rel="stylesheet" href="css/version-box.css">

</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 "><a href="01-installation.html"><strong aria-hidden="true">1.</strong> Installation</a></li><li class="chapter-item expanded "><a href="02-command-line-interface.html"><strong aria-hidden="true">2.</strong> Command Line Interface</a></li><li class="chapter-item expanded "><a href="03-standard-json.html"><strong aria-hidden="true">3.</strong> Standard JSON</a></li><li class="chapter-item expanded "><a href="04-combined-json.html" class="active"><strong aria-hidden="true">4.</strong> Combined JSON</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">ZKsync Solidity Compiler Toolchain Documentation</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="combined-json"><a class="header" href="#combined-json">Combined JSON</a></h1>
<p>Combined JSON is an I/O mode designed to provide a middle-ground experience between basic CLI and standard JSON. In this mode, input data is provided by the user via CLI, and JSON output can be easily read by both humans and programs calling <em>zksolc</em> as a child process.</p>
<h2 id="usage"><a class="header" href="#usage">Usage</a></h2>
<p>To use combined JSON, pass the <code>--combined-json</code> flag to <em>zksolc</em> with the desired comma-separated output selectors:</p>
<pre><code class="language-shell">zksolc MyContract.sol --combined-json ast,abi,metadata
</code></pre>
<p>The following selectors are supported:</p>
<div class="table-wrapper"><table><thead><tr><th style="text-align: center">Selector</th><th style="text-align: center">Description</th><th style="text-align: center">Type</th></tr></thead><tbody>
<tr><td style="text-align: center"><strong>ast</strong></td><td style="text-align: center">AST of the source file</td><td style="text-align: center">JSON</td></tr>
<tr><td style="text-align: center"><strong>abi</strong></td><td style="text-align: center">Solidity ABI</td><td style="text-align: center">JSON</td></tr>
<tr><td style="text-align: center"><strong>hashes</strong></td><td style="text-align: center">Solidity function hashes</td><td style="text-align: center">JSON</td></tr>
<tr><td style="text-align: center"><strong>storage-layout</strong></td><td style="text-align: center">Solidity storage layout</td><td style="text-align: center">JSON</td></tr>
<tr><td style="text-align: center"><strong>metadata</strong></td><td style="text-align: center">Metadata</td><td style="text-align: center">Stringified JSON</td></tr>
<tr><td style="text-align: center"><strong>devdoc</strong></td><td style="text-align: center">Developer documentation</td><td style="text-align: center">JSON (NatSpec)</td></tr>
<tr><td style="text-align: center"><strong>userdoc</strong></td><td style="text-align: center">User documentation</td><td style="text-align: center">JSON (NatSpec)</td></tr>
</tbody></table>
</div><div class="warning">
It is only possible to use Combined JSON with Solidity input, so the path to <b>solc</b> must be always provided to *zksolc*.
Support for other languages is planned for future releases.
</div>
<h2 id="output-format"><a class="header" href="#output-format">Output Format</a></h2>
<p>The format below is a modification of the original combined JSON <a href="https://docs.soliditylang.org/en/latest/using-the-compiler.html#output-description">output</a> format implemented by <em>solc</em>. It means that there are:</p>
<ul>
<li><em>zksolc</em>-specific options that are not present in the original format: they are marked as <em>zksolc</em> in the specification below.</li>
<li><em>solc</em>-specific options that are not supported by <em>zksolc</em>: they are not mentioned in the specification below.</li>
</ul>
<pre><code class="language-javascript">{
// Required: Contract outputs.
"contracts": {
"MyContract.sol:Test": {
// Optional: Emitted if "hashes" selector is provided.
"hashes": {/* ... */},
// Optional: Emitted if "abi" selector is provided.
"abi": [/* ... */],
// Optional: Emitted if "metadata" selector is provided.
"metadata": "/* ... */",
// Optional: Emitted if "devdoc" selector is provided.
"devdoc": {/* ... */},
// Optional: Emitted if "userdoc" selector is provided.
"userdoc": {/* ... */},
// Optional: Emitted if "storage-layout" selector is provided.
"storage-layout": {/* ... */},
// Required: Bytecode is always emitted.
"bin": "0000008003000039000000400030043f0000000100200190000000130000c13d...",
// Required: Bytecode is always emitted.
"bin-runtime": "0000008003000039000000400030043f0000000100200190000000130000c13d...",
// Required, zksolc: Mapping between bytecode hashes and full contract identifiers (e.g. "MyContract.sol:Test").
"factory-deps": {/* ... */}
}
},
// Optional: List of input files.
// Only emitted if "ast" selector is provided.
"sourceList": [
"MyContract.sol"
],
// Optional: List of input sources.
// Only emitted if "ast" selector is provided.
"sources": {
"MyContract.sol": {
// Required: Contract AST.
"AST": {/* ... */}
// Required: Contract index in "sourceList".
"id": 0
}
},
// Required: Version of solc.
"version": "0.8.28+commit.acc7d8f9.Darwin.appleclang",
// Required, zksolc: Version of zksolc.
"zk_version": "1.5.6"
}
</code></pre>

</main>

<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="03-standard-json.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>


<div style="clear: both"></div>
</nav>
</div>
</div>

<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="03-standard-json.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>

</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 src="js/version-box.js"></script>


</div>
</body>
</html>
Loading

0 comments on commit dc4e18a

Please sign in to comment.