51 lines
11 KiB
HTML
51 lines
11 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>Nimbus Libraries</title>
|
||
<meta name="generator" content="VuePress 1.8.2">
|
||
<link rel="icon" href="/assets/img/logo.png">
|
||
<meta name="description" content="Ethereum 2.0 utilities and more">
|
||
|
||
<link rel="preload" href="/assets/css/0.styles.74783a08.css" as="style"><link rel="preload" href="/assets/js/app.b6b895fe.js" as="script"><link rel="preload" href="/assets/js/2.fd7e9e0b.js" as="script"><link rel="preload" href="/assets/js/7.852d0869.js" as="script"><link rel="preload" href="/assets/js/3.c5869ccf.js" as="script"><link rel="prefetch" href="/assets/js/10.a7e5f96d.js"><link rel="prefetch" href="/assets/js/11.b620ddcc.js"><link rel="prefetch" href="/assets/js/12.cf1bd068.js"><link rel="prefetch" href="/assets/js/13.9dfac9d9.js"><link rel="prefetch" href="/assets/js/14.1ce3f7fe.js"><link rel="prefetch" href="/assets/js/4.b9b777bd.js"><link rel="prefetch" href="/assets/js/5.073c37d9.js"><link rel="prefetch" href="/assets/js/6.7db49fe2.js"><link rel="prefetch" href="/assets/js/8.b8ee59fd.js"><link rel="prefetch" href="/assets/js/9.249d32d4.js">
|
||
<link rel="stylesheet" href="/assets/css/0.styles.74783a08.css">
|
||
</head>
|
||
<body>
|
||
<div id="app" data-server-rendered="true"><div class="theme-container no-sidebar"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/" aria-current="page" class="home-link router-link-exact-active router-link-active"><img src="/assets/img/logo.png" alt="Nimbus Libraries" class="logo"> <span class="site-name can-hide">Nimbus Libraries</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/lib/nim-libp2p/" class="nav-link">
|
||
libp2p
|
||
</a></div><div class="nav-item"><a href="/lib/nim-chronicles/" class="nav-link">
|
||
Chronicles
|
||
</a></div><div class="nav-item"><a href="/lib/nimcrypto/" class="nav-link">
|
||
Nimcrypto
|
||
</a></div><div class="nav-item"><a href="/lib/nim-chronos/" class="nav-link">
|
||
Chronos
|
||
</a></div><div class="nav-item"><a href="/lib/nim-eth/" class="nav-link">
|
||
Eth
|
||
</a></div><div class="nav-item"><a href="/lib/nim-stew/" class="nav-link">
|
||
Stew
|
||
</a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/lib/nim-libp2p/" class="nav-link">
|
||
libp2p
|
||
</a></div><div class="nav-item"><a href="/lib/nim-chronicles/" class="nav-link">
|
||
Chronicles
|
||
</a></div><div class="nav-item"><a href="/lib/nimcrypto/" class="nav-link">
|
||
Nimcrypto
|
||
</a></div><div class="nav-item"><a href="/lib/nim-chronos/" class="nav-link">
|
||
Chronos
|
||
</a></div><div class="nav-item"><a href="/lib/nim-eth/" class="nav-link">
|
||
Eth
|
||
</a></div><div class="nav-item"><a href="/lib/nim-stew/" class="nav-link">
|
||
Stew
|
||
</a></div> <!----></nav> <ul class="sidebar-links"><li><a href="/" aria-current="page" class="active sidebar-link">Home</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/#get-started" class="sidebar-link">Get Started</a></li></ul></li></ul> </aside> <main aria-labelledby="main-title" class="home"><header class="hero"><img src="/assets/img/hero.png" alt="hero"> <h1 id="main-title">
|
||
Nimbus Libraries
|
||
</h1> <p class="description">
|
||
Documentation for Nim libraries produced by the Nimbus team
|
||
</p> <p class="action"><a href="/about.html" class="nav-link action-button">
|
||
Learn more
|
||
</a></p></header> <div class="features"><div class="feature"><h2>Performance</h2> <p>Leveraging Nim's performance makes these components significantly faster than their non-Nim counterparts</p></div><div class="feature"><h2>Security</h2> <p>Originally designed to power the world's programmable money, Ethereum, these components have been built with security in mind from day 0</p></div><div class="feature"><h2>Portability</h2> <p>Each library is independent - whether it's a cryptocurrency wallet or a mobile game, your project can easily make use of them.</p></div></div> <div class="theme-default-content custom content__default"><h1 id="how-the-documentation-is-organized"><a href="#how-the-documentation-is-organized" class="header-anchor">#</a> How the Documentation is organized</h1> <p>Documentation is organized into four categories: tutorials, overviews, API references and how-to guides.</p> <ul><li>Tutorials take you by the hand through a series of steps to put a library / module to use. Start here if you’re new to a library.</li> <li>Overviews discuss key topics and concepts at a fairly high level and provide useful background information and explanation. Those are the things you usually see in READMEs of repos.</li> <li>API references contain technical reference for APIs and other aspects of a module's machinery. They describe how it works and how to use it but assume that you have a basic understanding of key concepts. These are auto-generated from the code, and depend heavily on the programmer's verbosity and the technical writer's persistence.</li> <li>How-to guides are recipes. They guide you through the steps involved in addressing key problems and use-cases. They are more advanced, shorter, and more specific than tutorials and assume some previous knowledge.</li></ul> <h2 id="get-started"><a href="#get-started" class="header-anchor">#</a> Get Started</h2> <p>Use the search field in the header, or find a desired library in the sections below. Each library has its own documentation with a full API reference and guides. If you'd like to contribute to these docs with your own work or some corrections, please file issues or PRs <a href="https://github.com/status-im/nimbus-libs-site" target="_blank" rel="noopener noreferrer">in the Github repo<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a>.</p> <div class="theorem"><p class="title"><a href="/lib/nim-libp2p/">libp2p</a><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>libp2p</span><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>networking</span><span class="badge warn" style="vertical-align:top;" data-v-15b7b770>development</span></p><p>nim-libp2p is an implementation of the libp2p modular peer-to-peer networking stack based on Chronos</p></div><div class="theorem"><p class="title"><a href="/lib/nim-chronicles/">Chronicles</a><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>logging</span><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>stable</span></p><p>Chronicles is a library for structured logging. It adheres to the philosophy that log files shouldn't be based on formatted text strings, but rather on well-defined event records with arbitrary properties that are easy to read for both humans and machines.</p></div><div class="theorem"><p class="title"><a href="/lib/nimcrypto/">Nimcrypto</a><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>cryptography</span><span class="badge warn" style="vertical-align:top;" data-v-15b7b770>development</span></p><p>Nimcrypto is Nim's cryptographic library. It implements several popular cryptographic algorithms and their tests with some <a href="https://github.com/cheatfate/nimcrypto/tree/master/examples" target="_blank" rel="noopener noreferrer">examples<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a>.</p></div><div class="theorem"><p class="title"><a href="/lib/nim-chronos/">Chronos</a><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>async</span><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>stable</span><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>networking</span></p><p>Chronos is an efficient library for asynchronous programming and an alternative to Nim's asyncdispatch.</p></div><div class="theorem"><p class="title"><a href="/lib/nim-eth/">Eth</a><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>eth</span><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>keys</span><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>bloom</span><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>rlp</span><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>encoding</span><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>formatting</span><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>cryptography</span><span class="badge warn" style="vertical-align:top;" data-v-15b7b770>development</span></p><p>Ethereum-related utilities written in Nim. Includes things like Bloom filters, private/public key utilities, devp2p, RLP, and more.</p></div><div class="theorem"><p class="title"><a href="/lib/nim-stew/">Stew</a><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>encoding</span><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>formatting</span><span class="badge warn" style="vertical-align:top;" data-v-15b7b770>development</span><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>utilities</span></p><p>General-purpose utilities and standard library extensions</p></div></div> <div class="footer">
|
||
Dual Licensed - MIT & ApacheV2 | Copyright © 2019-present Nimbus Team
|
||
</div></main></div><div class="global-ui"></div></div>
|
||
<script src="/assets/js/app.b6b895fe.js" defer></script><script src="/assets/js/2.fd7e9e0b.js" defer></script><script src="/assets/js/7.852d0869.js" defer></script><script src="/assets/js/3.c5869ccf.js" defer></script>
|
||
</body>
|
||
</html>
|