ssv-keys
Version:
Tool for splitting a validator key into a predefined threshold of shares via Shamir-Secret-Sharing (SSS), and encrypt them with a set of operator keys.
30 lines (27 loc) • 4.22 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ssv-keys</title><meta name="description" content="Documentation for ssv-keys"/><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 async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">ssv-keys</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1> ssv-keys </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
<a href="#ssv-keys" id="ssv-keys" style="color: inherit; text-decoration: none;">
<h1>SSV Keys</h1>
</a>
<p><a href="https://github.com/metachris/typescript-boilerplate/actions?query=workflow%3A%22Build+and+test%22"><img src="https://github.com/metachris/typescript-boilerplate/workflows/Lint%20and%20test/badge.svg" alt="Build and test status"></a></p>
<p>Library and CLI to work with ETH keystore file, decrypt private key from it using password,
use that private key to get shares for operators and to build final payload for transaction
to use it in SSV Network.</p>
<ul>
<li><a href="docs/install.md">Installation</a></li>
<li><a href="docs/cli.md">Running CLI</a></li>
<li><a href="docs/library.md">Using in your projects</a></li>
<li><a href="docs/arch.md">Code Architecture</a></li>
<li><a href="docs/dev.md">Development</a></li>
</ul>
<a href="#todo" id="todo" style="color: inherit; text-decoration: none;">
<h2>Todo</h2>
</a>
<ul>
<li>Make it possible to use specific number of signers and fails in shares generation, use four by default.
Read: <a href="https://www.gsd.inesc-id.pt/~mpc/pubs/bc2f+1.pdf">From Crash to Byzantine Consensus with 2f + 1 Processes</a></li>
</ul>
<a href="#license" id="license" style="color: inherit; text-decoration: none;">
<h2>License</h2>
</a>
<p>MIT License</p>
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/main.html">main</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>