feat(docs): (78814d8) feat: ed25519 derivation (#161)

Signed-off-by: Curtis Harding <[email protected]>
hyperledger · May 22, 2024 · 46ef06d · 46ef06d
1 parent 7a135e3
commit 46ef06d
Show file tree

Hide file tree

Showing 36 changed files with 1,879 additions and 107 deletions.
diff --git a/-apollo/org.hyperledger.identus.apollo.derivation/-ed-h-d-key/--index--.html b/-apollo/org.hyperledger.identus.apollo.derivation/-ed-h-d-key/--index--.html
@@ -0,0 +1,84 @@
+<!DOCTYPE html>
+<html class="no-js">
+<head>
+    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
+    <title>index</title>
+    <link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
+    <script>var pathToRoot = "../../../";</script>
+    <script>document.documentElement.classList.replace("no-js","js");</script>
+    <script>const storage = localStorage.getItem("dokka-dark-mode")
+    if (storage == null) {
+        const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
+        if (osDarkSchemePreferred === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    } else {
+        const savedDarkMode = JSON.parse(storage)
+        if(savedDarkMode === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    }
+    </script>
+<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
+<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
+<link href="../../../styles/style.css" rel="Stylesheet">
+<link href="../../../styles/main.css" rel="Stylesheet">
+<link href="../../../styles/prism.css" rel="Stylesheet">
+<link href="../../../styles/logo-styles.css" rel="Stylesheet">
+<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
+<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
+<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
+<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
+<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
+<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
+<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
+</head>
+<body>
+    <div class="root">
+<nav class="navigation" id="navigation-wrapper">
+    <div class="navigation--inner">
+        <div class="navigation-title">
+            <button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
+            <div class="library-name">
+                    <a class="library-name--link" href="../../../index.html">
+                            Apollo
+                    </a>
+            </div>
+            <div class="library-version">
+1.2.16            </div>
+        </div>
+        <div class="filter-section" id="filter-section">
+                <button class="platform-tag platform-selector common-like" data-active="" data-filter=":apollo:dokkaHtml/commonMain">common</button>
+                <button class="platform-tag platform-selector js-like" data-active="" data-filter=":apollo:dokkaHtml/jsMain">js</button>
+                <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":apollo:dokkaHtml/jvmMain">jvm</button>
+        </div>
+    </div>
+    <div class="navigation-controls">
+        <button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
+        <div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
+    </div>
+</nav>
+        <div id="container">
+            <div class="sidebar" id="leftColumn">
+                <div class="sidebar--inner" id="sideMenu"></div>
+            </div>
+            <div id="main">
+<div class="main-content" data-page-type="member" id="content" pageIds="Apollo::org.hyperledger.identus.apollo.derivation/EdHDKey/index/#/PointingToDeclaration//-1606045687">
+  <div class="breadcrumbs"><a href="../../../index.html">Apollo</a><span class="delimiter">/</span><a href="../index.html">org.hyperledger.identus.apollo.derivation</a><span class="delimiter">/</span><a href="index.html">EdHDKey</a><span class="delimiter">/</span><span class="current">index</span></div>
+  <div class="cover ">
+    <h1 class="cover"><span><span>index</span></span></h1>
+  </div>
+  <div class="platform-hinted  with-platform-tabs" data-platform-hinted="data-platform-hinted">
+    <div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":apollo:dokkaHtml/commonMain" data-filterable-set=":apollo:dokkaHtml/commonMain" data-active="" data-toggle=":apollo:dokkaHtml/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":apollo:dokkaHtml/jsMain" data-filterable-set=":apollo:dokkaHtml/jsMain" data-toggle=":apollo:dokkaHtml/jsMain">js</button><button class="platform-bookmark" data-filterable-current=":apollo:dokkaHtml/jvmMain" data-filterable-set=":apollo:dokkaHtml/jvmMain" data-toggle=":apollo:dokkaHtml/jvmMain">jvm</button></div>
+<div class="content sourceset-dependent-content" data-active="" data-togglable=":apollo:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">expect </span><span class="token keyword">val </span><a href="--index--.html">index</a><span class="token operator">: </span><a href="../-big-integer-wrapper/index.html">BigIntegerWrapper</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/input-output-hk/atala-prism-apollo/tree/main/src/commonMain/kotlin/org/hyperledger/identus/apollo/derivation/EdHDKey.kt#L15">source</a>)</span></span></div></div><div class="content sourceset-dependent-content" data-togglable=":apollo:dokkaHtml/jsMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">val </span><a href="--index--.html">index</a><span class="token operator">: </span><a href="../-big-integer-wrapper/index.html">BigIntegerWrapper</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/input-output-hk/atala-prism-apollo/tree/main/src/jsMain/kotlin/org/hyperledger/identus/apollo/derivation/EdHDKey.kt#L16">source</a>)</span></span></div></div><div class="content sourceset-dependent-content" data-togglable=":apollo:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">val </span><a href="--index--.html">index</a><span class="token operator">: </span><a href="../-big-integer-wrapper/index.html">BigIntegerWrapper</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/input-output-hk/atala-prism-apollo/tree/main/src/jvmMain/kotlin/org/hyperledger/identus/apollo/derivation/EdHDKey.kt#L15">source</a>)</span></span></div></div>  </div>
+</div>
+      <div class="footer">
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>(c) 2024 HyberLedger Copyright</span><span
+                class="pull-right"><span>Generated by </span><a
+                href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
+      </div>
+            </div>
+        </div>
+    </div>
+</body>
+</html>
diff --git a/-apollo/org.hyperledger.identus.apollo.derivation/-ed-h-d-key/-companion/index.html b/-apollo/org.hyperledger.identus.apollo.derivation/-ed-h-d-key/-companion/index.html
@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html class="no-js">
+<head>
+    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
+    <title>Companion</title>
+    <link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
+    <script>var pathToRoot = "../../../../";</script>
+    <script>document.documentElement.classList.replace("no-js","js");</script>
+    <script>const storage = localStorage.getItem("dokka-dark-mode")
+    if (storage == null) {
+        const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
+        if (osDarkSchemePreferred === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    } else {
+        const savedDarkMode = JSON.parse(storage)
+        if(savedDarkMode === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    }
+    </script>
+<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
+<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
+<link href="../../../../styles/style.css" rel="Stylesheet">
+<link href="../../../../styles/main.css" rel="Stylesheet">
+<link href="../../../../styles/prism.css" rel="Stylesheet">
+<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
+<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
+<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
+<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
+<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
+<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
+<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
+<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
+</head>
+<body>
+    <div class="root">
+<nav class="navigation" id="navigation-wrapper">
+    <div class="navigation--inner">
+        <div class="navigation-title">
+            <button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
+            <div class="library-name">
+                    <a class="library-name--link" href="../../../../index.html">
+                            Apollo
+                    </a>
+            </div>
+            <div class="library-version">
+1.2.16            </div>
+        </div>
+        <div class="filter-section" id="filter-section">
+                <button class="platform-tag platform-selector common-like" data-active="" data-filter=":apollo:dokkaHtml/commonMain">common</button>
+                <button class="platform-tag platform-selector js-like" data-active="" data-filter=":apollo:dokkaHtml/jsMain">js</button>
+                <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":apollo:dokkaHtml/jvmMain">jvm</button>
+        </div>
+    </div>
+    <div class="navigation-controls">
+        <button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
+        <div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
+    </div>
+</nav>
+        <div id="container">
+            <div class="sidebar" id="leftColumn">
+                <div class="sidebar--inner" id="sideMenu"></div>
+            </div>
+            <div id="main">
+<div class="main-content" data-page-type="classlike" id="content" pageIds="Apollo::org.hyperledger.identus.apollo.derivation/EdHDKey.Companion///PointingToDeclaration//-1606045687">
+  <div class="breadcrumbs"><a href="../../../../index.html">Apollo</a><span class="delimiter">/</span><a href="../../index.html">org.hyperledger.identus.apollo.derivation</a><span class="delimiter">/</span><a href="../index.html">EdHDKey</a><span class="delimiter">/</span><span class="current">Companion</span></div>
+  <div class="cover ">
+    <h1 class="cover"><span><span>Companion</span></span></h1>
+    <div class="platform-hinted  with-platform-tabs" data-platform-hinted="data-platform-hinted">
+      <div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":apollo:dokkaHtml/commonMain" data-filterable-set=":apollo:dokkaHtml/commonMain" data-active="" data-toggle=":apollo:dokkaHtml/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":apollo:dokkaHtml/jsMain" data-filterable-set=":apollo:dokkaHtml/jsMain" data-toggle=":apollo:dokkaHtml/jsMain">js</button><button class="platform-bookmark" data-filterable-current=":apollo:dokkaHtml/jvmMain" data-filterable-set=":apollo:dokkaHtml/jvmMain" data-toggle=":apollo:dokkaHtml/jvmMain">jvm</button></div>
+<div class="content sourceset-dependent-content" data-active="" data-togglable=":apollo:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">expect </span><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/input-output-hk/atala-prism-apollo/tree/main/src/commonMain/kotlin/org/hyperledger/identus/apollo/derivation/EdHDKey.kt#L31">source</a>)</span></span></div></div><div class="content sourceset-dependent-content" data-togglable=":apollo:dokkaHtml/jsMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/input-output-hk/atala-prism-apollo/tree/main/src/jsMain/kotlin/org/hyperledger/identus/apollo/derivation/EdHDKey.kt#L66">source</a>)</span></span></div></div><div class="content sourceset-dependent-content" data-togglable=":apollo:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/input-output-hk/atala-prism-apollo/tree/main/src/jvmMain/kotlin/org/hyperledger/identus/apollo/derivation/EdHDKey.kt#L72">source</a>)</span></span></div></div>    </div>
+  </div>
+  <div class="tabbedcontent">
+    <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
+    <div class="tabs-section-body">
+      <div data-togglable="FUNCTION">
+        <h2 class="">Functions</h2>
+        <div class="table"><a data-name="-1678262331%2FFunctions%2F-1606045687" anchor-label="initFromSeed" id="-1678262331%2FFunctions%2F-1606045687" data-filterable-set=":apollo:dokkaHtml/commonMain,:apollo:dokkaHtml/jsMain,:apollo:dokkaHtml/jvmMain"></a>
+          <div class="table-row" data-filterable-current=":apollo:dokkaHtml/commonMain,:apollo:dokkaHtml/jsMain,:apollo:dokkaHtml/jvmMain" data-filterable-set=":apollo:dokkaHtml/commonMain,:apollo:dokkaHtml/jsMain,:apollo:dokkaHtml/jvmMain">
+            <div class="main-subrow keyValue ">
+              <div class=""><span class="inline-flex">
+                  <div><a href="init-from-seed.html"><span>init</span><wbr></wbr><span>From</span><wbr></wbr><span><span>Seed</span></span></a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1678262331%2FFunctions%2F-1606045687"></span>
+                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
+                  </span></span></div>
+              <div>
+                <div class="title">
+                  <div class="platform-hinted  with-platform-tabs" data-platform-hinted="data-platform-hinted">
+                    <div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":apollo:dokkaHtml/commonMain" data-filterable-set=":apollo:dokkaHtml/commonMain" data-active="" data-toggle=":apollo:dokkaHtml/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":apollo:dokkaHtml/jsMain" data-filterable-set=":apollo:dokkaHtml/jsMain" data-toggle=":apollo:dokkaHtml/jsMain">js</button><button class="platform-bookmark" data-filterable-current=":apollo:dokkaHtml/jvmMain" data-filterable-set=":apollo:dokkaHtml/jvmMain" data-toggle=":apollo:dokkaHtml/jvmMain">jvm</button></div>
+<div class="content sourceset-dependent-content" data-active="" data-togglable=":apollo:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">expect </span><span class="token keyword">fun </span><a href="init-from-seed.html"><span class="token function">initFromSeed</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">seed<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">EdHDKey</a></div><div class="brief "><p class="paragraph">Constructs a new EdHDKey object from a seed</p></div></div><div class="content sourceset-dependent-content" data-togglable=":apollo:dokkaHtml/jsMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">fun </span><a href="init-from-seed.html"><span class="token function">initFromSeed</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">seed<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">EdHDKey</a></div><div class="brief "><p class="paragraph">Constructs a new EdHDKey object from a seed</p></div></div><div class="content sourceset-dependent-content" data-togglable=":apollo:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">fun </span><a href="init-from-seed.html"><span class="token function">initFromSeed</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">seed<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">EdHDKey</a></div><div class="brief "><p class="paragraph">Constructs a new EdHDKey object from a seed</p></div></div>                  </div>
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+      <div class="footer">
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>(c) 2024 HyberLedger Copyright</span><span
+                class="pull-right"><span>Generated by </span><a
+                href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
+      </div>
+            </div>
+        </div>
+    </div>
+</body>
+</html>