-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
34 lines (34 loc) · 7.73 KB
/
index.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
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@nebrazkp/upa</title><meta name="description" content="Documentation for @nebrazkp/upa"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@nebrazkp/upa</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@nebrazkp/upa</h2></div><div class="tsd-panel tsd-typography"><a id="md:upa-contracts-client-sdk-and-tools" class="tsd-anchor"></a><h1><a href="#md:upa-contracts-client-sdk-and-tools">UPA contracts, client SDK and tools</a></h1><p>UPA is Nebra's "Universal Proof Aggregator". This package contains the client
SDK for buiding apps that leverage the UPA to reduce the cost of on-chain ZKP
verification.</p>
<p>This package also includes the <code>upa</code> tool for interacting with UPA
deployments.</p>
<p>Full documentation is available at docs.nebra.one.</p>
<p><a href="#md:release-notes">RELEASE NOTES</a></p>
<a id="md:requirements" class="tsd-anchor"></a><h2><a href="#md:requirements">Requirements</a></h2><ul>
<li>node.js>=18</li>
</ul>
<a id="md:installation" class="tsd-anchor"></a><h2><a href="#md:installation">Installation</a></h2><pre><code class="language-console"><span class="hl-0">$ yarn add @nebrazkp/upa</span>
</code><button>Copy</button></pre>
<p>Run the <code>upa</code> tool</p>
<pre><code class="language-console"><span class="hl-0">$ ./node_modules/bin/upa --help</span>
</code><button>Copy</button></pre>
<a id="md:development" class="tsd-anchor"></a><h3><a href="#md:development">Development</a></h3><p>See [DEVELOPMENT.md].</p>
<a id="md:release-notes" class="tsd-anchor"></a><h2><a href="#md:release-notes">Release notes</a></h2><a id="md:v100" class="tsd-anchor"></a><h3><a href="#md:v100">v1.0.0</a></h3><p>This version of the package provides:</p>
<ul>
<li>A Typescript library including full support for client-side proof submission
and detection of aggregation.</li>
<li>Solidity contract interfaces and library for on-chain verification from
application smart contracts.</li>
<li>A <code>upa</code> CLI tools for performing operations on a deployed instance, as well
as for setting up development environments for end-to-end application testing.</li>
</ul>
<p>NOTE: The SDK defines types <code>application.Proof</code> and <code>application.VerifyingKey</code>
for Groth16 verifying keys and proofs, describing the format expected for
these objects. Functions to convert from keys and proofs as output from
<code>snarkjs</code> are also included. Proofs generated by other implementations
(gnark, arkworks, etc) must be converted to the <code>application</code> types by the
caller (see the definitions of these types in <code>application.d.ts</code> for details).</p>
<p>Conversion function for more Groth16 implementations will be provided in
upcoming versions.</p>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:upa-contracts-client-sdk-and-tools"><span>UPA contracts, client SDK and tools</span></a><ul><li><a href="#md:requirements"><span>Requirements</span></a></li><li><a href="#md:installation"><span>Installation</span></a></li><li><ul><li><a href="#md:development"><span>Development</span></a></li></ul></li><li><a href="#md:release-notes"><span>Release notes</span></a></li><li><ul><li><a href="#md:v100"><span>v1.0.0</span></a></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@nebrazkp/upa</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html>