ontology-ts-sdk

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>KeyType | ontology-ts-sdk</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </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.js" 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">ontology-ts-sdk</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> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a> </li> <li> <a href="../modules/_crypto_keytype_.html">"crypto/KeyType"</a> </li> <li> <a href="_crypto_keytype_.keytype.html">KeyType</a> </li> </ul> <h1>Class KeyType</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Type of key. ECDSA is the default one to use.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">KeyType</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="_crypto_keytype_.keytype.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="_crypto_keytype_.keytype.html#defaultschema" class="tsd-kind-icon">default<wbr>Schema</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_crypto_keytype_.keytype.html#hex" class="tsd-kind-icon">hex</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_crypto_keytype_.keytype.html#label" class="tsd-kind-icon">label</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_crypto_keytype_.keytype.html#ecdsa" class="tsd-kind-icon">ECDSA</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_crypto_keytype_.keytype.html#eddsa" class="tsd-kind-icon">EDDSA</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_crypto_keytype_.keytype.html#sm2" class="tsd-kind-icon">SM2</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_crypto_keytype_.keytype.html#values" class="tsd-kind-icon">values</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 tsd-is-static"><a href="_crypto_keytype_.keytype.html#fromhex" class="tsd-kind-icon">from<wbr>Hex</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_crypto_keytype_.keytype.html#fromlabel" class="tsd-kind-icon">from<wbr>Label</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>Type<span class="tsd-signature-symbol">(</span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, hex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, defaultSchema<span class="tsd-signature-symbol">: </span><a href="_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_crypto_keytype_.keytype.html" class="tsd-signature-type">KeyType</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/crypto/KeyType.ts#L61">crypto/KeyType.ts:61</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>label: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>hex: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>defaultSchema: <a href="_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_crypto_keytype_.keytype.html" class="tsd-signature-type">KeyType</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="defaultschema" class="tsd-anchor"></a> <h3>default<wbr>Schema</h3> <div class="tsd-signature tsd-kind-icon">default<wbr>Schema<span class="tsd-signature-symbol">:</span> <a href="_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/crypto/KeyType.ts#L61">crypto/KeyType.ts:61</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="hex" class="tsd-anchor"></a> <h3>hex</h3> <div class="tsd-signature tsd-kind-icon">hex<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/crypto/KeyType.ts#L60">crypto/KeyType.ts:60</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="label" class="tsd-anchor"></a> <h3>label</h3> <div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/crypto/KeyType.ts#L59">crypto/KeyType.ts:59</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="ecdsa" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> ECDSA</h3> <div class="tsd-signature tsd-kind-icon">ECDSA<span class="tsd-signature-symbol">:</span> <a href="_crypto_keytype_.keytype.html" class="tsd-signature-type">KeyType</a><span class="tsd-signature-symbol"> = new KeyType('ECDSA', 0x12, SignatureScheme.ECDSAwithSHA256)</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/crypto/KeyType.ts#L27">crypto/KeyType.ts:27</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="eddsa" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> EDDSA</h3> <div class="tsd-signature tsd-kind-icon">EDDSA<span class="tsd-signature-symbol">:</span> <a href="_crypto_keytype_.keytype.html" class="tsd-signature-type">KeyType</a><span class="tsd-signature-symbol"> = new KeyType('EDDSA', 0x14, SignatureScheme.EDDSAwithSHA512)</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/crypto/KeyType.ts#L29">crypto/KeyType.ts:29</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="sm2" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> SM2</h3> <div class="tsd-signature tsd-kind-icon">SM2<span class="tsd-signature-symbol">:</span> <a href="_crypto_keytype_.keytype.html" class="tsd-signature-type">KeyType</a><span class="tsd-signature-symbol"> = new KeyType('SM2', 0x13, SignatureScheme.SM2withSM3)</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/crypto/KeyType.ts#L28">crypto/KeyType.ts:28</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="values" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> values</h3> <div class="tsd-signature tsd-kind-icon">values<span class="tsd-signature-symbol">:</span> <a href="_crypto_keytype_.keytype.html" class="tsd-signature-type">KeyType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/crypto/KeyType.ts#L25">crypto/KeyType.ts:25</a></li> </ul> </aside> </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 tsd-is-static"> <a name="fromhex" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Hex</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">from<wbr>Hex<span class="tsd-signature-symbol">(</span>hex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_crypto_keytype_.keytype.html" class="tsd-signature-type">KeyType</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/crypto/KeyType.ts#L36">crypto/KeyType.ts:36</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Finds Key type corresponding to specified hex representation.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>hex: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>Byte hex value</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_crypto_keytype_.keytype.html" class="tsd-signature-type">KeyType</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="fromlabel" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Label</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">from<wbr>Label<span class="tsd-signature-symbol">(</span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_crypto_keytype_.keytype.html" class="tsd-signature-type">KeyType</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/crypto/KeyType.ts#L50">crypto/KeyType.ts:50</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Finds Key type corresponding to specified label representation.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>label: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Label</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_crypto_keytype_.keytype.html" class="tsd-signature-type">KeyType</a></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_crypto_keytype_.html">"crypto/<wbr>Key<wbr>Type"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-external-module"> <a href="_crypto_keytype_.keytype.html" class="tsd-kind-icon">Key<wbr>Type</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="_crypto_keytype_.keytype.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_crypto_keytype_.keytype.html#defaultschema" class="tsd-kind-icon">default<wbr>Schema</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_crypto_keytype_.keytype.html#hex" class="tsd-kind-icon">hex</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_crypto_keytype_.keytype.html#label" class="tsd-kind-icon">label</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="_crypto_keytype_.keytype.html#ecdsa" class="tsd-kind-icon">ECDSA</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="_crypto_keytype_.keytype.html#eddsa" class="tsd-kind-icon">EDDSA</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="_crypto_keytype_.keytype.html#sm2" class="tsd-kind-icon">SM2</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="_crypto_keytype_.keytype.html#values" class="tsd-kind-icon">values</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="_crypto_keytype_.keytype.html#fromhex" class="tsd-kind-icon">from<wbr>Hex</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="_crypto_keytype_.keytype.html#fromlabel" class="tsd-kind-icon">from<wbr>Label</a> </li> </ul> </li> </ul> <ul class="after-current"> </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-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <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> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature 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="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>