<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>KeyPair | @fluencelabs/fluence</title> <meta name="description" content="Documentation for @fluencelabs/fluence"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <script async src="../assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </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">@fluencelabs/fluence</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"> <ul class="tsd-breadcrumb"> <li> <a href="../modules.html">@fluencelabs/fluence</a> </li> <li> <a href="KeyPair.html">KeyPair</a> </li> </ul> <h1>Class KeyPair</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">KeyPair</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="KeyPair.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyPair.html#Libp2pPeerId" class="tsd-kind-icon">Libp2p<wbr>Peer<wbr>Id</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyPair.html#toEd25519PrivateKey" class="tsd-kind-icon">to<wbr>Ed25519<wbr>Private<wbr>Key</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="KeyPair.html#fromEd25519SK" class="tsd-kind-icon">from<wbr>Ed25519SK</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="KeyPair.html#randomEd25519" class="tsd-kind-icon">random<wbr>Ed25519</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Key<wbr>Pair<span class="tsd-signature-symbol">(</span>libp2pPeerId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PeerId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="KeyPair.html" class="tsd-signature-type" data-tsd-kind="Class">KeyPair</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/KeyPair.ts#L26">internal/KeyPair.ts:26</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>libp2pPeerId: <span class="tsd-signature-type">PeerId</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="KeyPair.html" class="tsd-signature-type" data-tsd-kind="Class">KeyPair</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="Libp2pPeerId" class="tsd-anchor"></a> <h3>Libp2p<wbr>Peer<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">Libp2p<wbr>Peer<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PeerId</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/KeyPair.ts#L24">internal/KeyPair.ts:24</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Key pair in libp2p format. Used for backward compatibility with the current FluencePeer implementation</p> </div> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="toEd25519PrivateKey" class="tsd-anchor"></a> <h3>to<wbr>Ed25519<wbr>Private<wbr>Key</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">to<wbr>Ed25519<wbr>Private<wbr>Key<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/KeyPair.ts#L54">internal/KeyPair.ts:54</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4> <p>32 byte private key</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="fromEd25519SK" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Ed25519SK</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">from<wbr>Ed25519SK<span class="tsd-signature-symbol">(</span>arr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeyPair.html" class="tsd-signature-type" data-tsd-kind="Class">KeyPair</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/KeyPair.ts#L35">internal/KeyPair.ts:35</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Generates new KeyPair from ed25519 private key represented as a 32 byte array</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>arr: <span class="tsd-signature-type">Uint8Array</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeyPair.html" class="tsd-signature-type" data-tsd-kind="Class">KeyPair</a><span class="tsd-signature-symbol">></span></h4> <ul> <li>Promise with the created KeyPair</li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="randomEd25519" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> random<wbr>Ed25519</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">random<wbr>Ed25519<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeyPair.html" class="tsd-signature-type" data-tsd-kind="Class">KeyPair</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/fluencelabs/fluence-js/blob/1fcd76a/src/internal/KeyPair.ts#L46">internal/KeyPair.ts:46</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Generates new KeyPair with a random secret key</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeyPair.html" class="tsd-signature-type" data-tsd-kind="Class">KeyPair</a><span class="tsd-signature-symbol">></span></h4> <ul> <li>Promise with the created KeyPair</li> </ul> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class=" "> <a href="../modules.html">Exports</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class"> <a href="FluencePeer.html" class="tsd-kind-icon">Fluence<wbr>Peer</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="KeyPair.html" class="tsd-kind-icon">Key<wbr>Pair</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="KeyPair.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="KeyPair.html#Libp2pPeerId" class="tsd-kind-icon">Libp2p<wbr>Peer<wbr>Id</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="KeyPair.html#toEd25519PrivateKey" class="tsd-kind-icon">to<wbr>Ed25519<wbr>Private<wbr>Key</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="KeyPair.html#fromEd25519SK" class="tsd-kind-icon">from<wbr>Ed25519SK</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="KeyPair.html#randomEd25519" class="tsd-kind-icon">random<wbr>Ed25519</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-has-type-parameter"> <a href="../interfaces/CallParams.html" class="tsd-kind-icon">Call<wbr>Params</a> </li> <li class=" tsd-kind-interface"> <a href="../interfaces/PeerConfig.html" class="tsd-kind-icon">Peer<wbr>Config</a> </li> <li class=" tsd-kind-interface"> <a href="../interfaces/PeerStatus.html" class="tsd-kind-icon">Peer<wbr>Status</a> </li> <li class=" tsd-kind-type-alias"> <a href="../modules.html#AvmLoglevel" class="tsd-kind-icon">Avm<wbr>Loglevel</a> </li> <li class=" tsd-kind-type-alias"> <a href="../modules.html#PeerIdB58" class="tsd-kind-icon">Peer<wbr>IdB58</a> </li> <li class=" tsd-kind-variable"> <a href="../modules.html#Fluence" class="tsd-kind-icon">Fluence</a> </li> <li class=" tsd-kind-function"> <a href="../modules.html#setLogLevel" class="tsd-kind-icon">set<wbr>Log<wbr>Level</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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </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/js/main.js"></script> </body> </html>