Skip to content

Commit 46ef06d

Browse files
committed
feat(docs): (78814d8) feat: ed25519 derivation (#161)
Signed-off-by: Curtis Harding <[email protected]>
1 parent 7a135e3 commit 46ef06d

36 files changed

+1879
-107
lines changed
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>index</title>
6+
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../../styles/style.css" rel="Stylesheet">
25+
<link href="../../../styles/main.css" rel="Stylesheet">
26+
<link href="../../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
30+
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
31+
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
32+
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
33+
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
34+
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
35+
</head>
36+
<body>
37+
<div class="root">
38+
<nav class="navigation" id="navigation-wrapper">
39+
<div class="navigation--inner">
40+
<div class="navigation-title">
41+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
42+
<div class="library-name">
43+
<a class="library-name--link" href="../../../index.html">
44+
Apollo
45+
</a>
46+
</div>
47+
<div class="library-version">
48+
1.2.16 </div>
49+
</div>
50+
<div class="filter-section" id="filter-section">
51+
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":apollo:dokkaHtml/commonMain">common</button>
52+
<button class="platform-tag platform-selector js-like" data-active="" data-filter=":apollo:dokkaHtml/jsMain">js</button>
53+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":apollo:dokkaHtml/jvmMain">jvm</button>
54+
</div>
55+
</div>
56+
<div class="navigation-controls">
57+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
58+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
59+
</div>
60+
</nav>
61+
<div id="container">
62+
<div class="sidebar" id="leftColumn">
63+
<div class="sidebar--inner" id="sideMenu"></div>
64+
</div>
65+
<div id="main">
66+
<div class="main-content" data-page-type="member" id="content" pageIds="Apollo::org.hyperledger.identus.apollo.derivation/EdHDKey/index/#/PointingToDeclaration//-1606045687">
67+
<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>
68+
<div class="cover ">
69+
<h1 class="cover"><span><span>index</span></span></h1>
70+
</div>
71+
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
72+
<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>
73+
<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>
74+
</div>
75+
<div class="footer">
76+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>(c) 2024 HyberLedger Copyright</span><span
77+
class="pull-right"><span>Generated by </span><a
78+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
79+
</div>
80+
</div>
81+
</div>
82+
</div>
83+
</body>
84+
</html>
Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>Companion</title>
6+
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../../../styles/style.css" rel="Stylesheet">
25+
<link href="../../../../styles/main.css" rel="Stylesheet">
26+
<link href="../../../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
30+
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
31+
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
32+
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
33+
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
34+
<script type="text/javascript" src="../../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
35+
</head>
36+
<body>
37+
<div class="root">
38+
<nav class="navigation" id="navigation-wrapper">
39+
<div class="navigation--inner">
40+
<div class="navigation-title">
41+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
42+
<div class="library-name">
43+
<a class="library-name--link" href="../../../../index.html">
44+
Apollo
45+
</a>
46+
</div>
47+
<div class="library-version">
48+
1.2.16 </div>
49+
</div>
50+
<div class="filter-section" id="filter-section">
51+
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":apollo:dokkaHtml/commonMain">common</button>
52+
<button class="platform-tag platform-selector js-like" data-active="" data-filter=":apollo:dokkaHtml/jsMain">js</button>
53+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":apollo:dokkaHtml/jvmMain">jvm</button>
54+
</div>
55+
</div>
56+
<div class="navigation-controls">
57+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
58+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
59+
</div>
60+
</nav>
61+
<div id="container">
62+
<div class="sidebar" id="leftColumn">
63+
<div class="sidebar--inner" id="sideMenu"></div>
64+
</div>
65+
<div id="main">
66+
<div class="main-content" data-page-type="classlike" id="content" pageIds="Apollo::org.hyperledger.identus.apollo.derivation/EdHDKey.Companion///PointingToDeclaration//-1606045687">
67+
<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>
68+
<div class="cover ">
69+
<h1 class="cover"><span><span>Companion</span></span></h1>
70+
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
71+
<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>
72+
<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>
73+
</div>
74+
<div class="tabbedcontent">
75+
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
76+
<div class="tabs-section-body">
77+
<div data-togglable="FUNCTION">
78+
<h2 class="">Functions</h2>
79+
<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>
80+
<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">
81+
<div class="main-subrow keyValue ">
82+
<div class=""><span class="inline-flex">
83+
<div><a href="init-from-seed.html"><span>init</span><wbr></wbr><span>From</span><wbr></wbr><span><span>Seed</span></span></a></div>
84+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1678262331%2FFunctions%2F-1606045687"></span>
85+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
86+
</span></span></div>
87+
<div>
88+
<div class="title">
89+
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
90+
<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>
91+
<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>
92+
</div>
93+
</div>
94+
</div>
95+
</div>
96+
</div>
97+
</div>
98+
</div>
99+
</div>
100+
</div>
101+
<div class="footer">
102+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>(c) 2024 HyberLedger Copyright</span><span
103+
class="pull-right"><span>Generated by </span><a
104+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
105+
</div>
106+
</div>
107+
</div>
108+
</div>
109+
</body>
110+
</html>

0 commit comments

Comments
 (0)