Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Milerius committed Nov 1, 2024
1 parent fa7e34a commit 6562352
Show file tree
Hide file tree
Showing 12 changed files with 528 additions and 4 deletions.
6 changes: 6 additions & 0 deletions -wallet-core/package-list
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,7 @@ $dokka.location:wallet.core.jni/DataVector/get/#int/PointingToDeclaration/-wall
$dokka.location:wallet.core.jni/DataVector/size/#/PointingToDeclaration/-wallet-core/wallet.core.jni/-data-vector/size.html
$dokka.location:wallet.core.jni/Derivation.BITCOINLEGACY///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-wallet-core/wallet.core.jni/-derivation/-b-i-t-c-o-i-n-l-e-g-a-c-y/index.html
$dokka.location:wallet.core.jni/Derivation.BITCOINSEGWIT///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-wallet-core/wallet.core.jni/-derivation/-b-i-t-c-o-i-n-s-e-g-w-i-t/index.html
$dokka.location:wallet.core.jni/Derivation.BITCOINTAPROOT///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-wallet-core/wallet.core.jni/-derivation/-b-i-t-c-o-i-n-t-a-p-r-o-o-t/index.html
$dokka.location:wallet.core.jni/Derivation.BITCOINTESTNET///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-wallet-core/wallet.core.jni/-derivation/-b-i-t-c-o-i-n-t-e-s-t-n-e-t/index.html
$dokka.location:wallet.core.jni/Derivation.CUSTOM///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-wallet-core/wallet.core.jni/-derivation/-c-u-s-t-o-m/index.html
$dokka.location:wallet.core.jni/Derivation.DEFAULT///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-wallet-core/wallet.core.jni/-derivation/-d-e-f-a-u-l-t/index.html
Expand Down Expand Up @@ -800,6 +801,7 @@ $dokka.location:wallet.core.jni/Purpose.BIP1852///PointingToDeclaration/{"org.je
$dokka.location:wallet.core.jni/Purpose.BIP44///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-wallet-core/wallet.core.jni/-purpose/-b-i-p44/index.html
$dokka.location:wallet.core.jni/Purpose.BIP49///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-wallet-core/wallet.core.jni/-purpose/-b-i-p49/index.html
$dokka.location:wallet.core.jni/Purpose.BIP84///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-wallet-core/wallet.core.jni/-purpose/-b-i-p84/index.html
$dokka.location:wallet.core.jni/Purpose.BIP86///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-wallet-core/wallet.core.jni/-purpose/-b-i-p86/index.html
$dokka.location:wallet.core.jni/Purpose///PointingToDeclaration/-wallet-core/wallet.core.jni/-purpose/index.html
$dokka.location:wallet.core.jni/Purpose/createFromValue/#int/PointingToDeclaration/-wallet-core/wallet.core.jni/-purpose/create-from-value.html
$dokka.location:wallet.core.jni/Purpose/value/#/PointingToDeclaration/-wallet-core/wallet.core.jni/-purpose/value.html
Expand Down Expand Up @@ -834,6 +836,10 @@ $dokka.location:wallet.core.jni/SolanaAddress/defaultTokenAddress/#java.lang.Str
$dokka.location:wallet.core.jni/SolanaAddress/description/#/PointingToDeclaration/-wallet-core/wallet.core.jni/-solana-address/description.html
$dokka.location:wallet.core.jni/SolanaAddress/token2022Address/#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-solana-address/token2022-address.html
$dokka.location:wallet.core.jni/SolanaTransaction///PointingToDeclaration/-wallet-core/wallet.core.jni/-solana-transaction/index.html
$dokka.location:wallet.core.jni/SolanaTransaction/getComputeUnitLimit/#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-solana-transaction/get-compute-unit-limit.html
$dokka.location:wallet.core.jni/SolanaTransaction/getComputeUnitPrice/#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-solana-transaction/get-compute-unit-price.html
$dokka.location:wallet.core.jni/SolanaTransaction/setComputeUnitLimit/#java.lang.String#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-solana-transaction/set-compute-unit-limit.html
$dokka.location:wallet.core.jni/SolanaTransaction/setComputeUnitPrice/#java.lang.String#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-solana-transaction/set-compute-unit-price.html
$dokka.location:wallet.core.jni/SolanaTransaction/updateBlockhashAndSign/#java.lang.String#java.lang.String#DataVector/PointingToDeclaration/-wallet-core/wallet.core.jni/-solana-transaction/update-blockhash-and-sign.html
$dokka.location:wallet.core.jni/StarkExMessageSigner///PointingToDeclaration/-wallet-core/wallet.core.jni/-stark-ex-message-signer/index.html
$dokka.location:wallet.core.jni/StarkExMessageSigner/signMessage/#PrivateKey#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-stark-ex-message-signer/sign-message.html
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>BITCOINTAPROOT</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../../";</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="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/jetbrains-mono.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">
<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="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>WalletCore</span>
</a>
</div>
<div>
</div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="WalletCore::wallet.core.jni/Derivation.BITCOINTAPROOT///PointingToDeclaration/{&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;:{&quot;key&quot;:&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;}}/274653044">
<div class="breadcrumbs"><a href="../../../../index.html">WalletCore</a><span class="delimiter">/</span><a href="../../index.html">wallet.core.jni</a><span class="delimiter">/</span><a href="../index.html">Derivation</a><span class="delimiter">/</span><span class="current">BITCOINTAPROOT</span></div>
<div class="cover ">
<h1 class="cover"><span><span>BITCOINTAPROOT</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="WalletCore/TrustWallet"><div class="symbol monospace"><div class="block"><a href="index.html">BITCOINTAPROOT</a></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"></div>
<div class="tabs-section-body"></div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 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>
</body>
</html>
17 changes: 16 additions & 1 deletion -wallet-core/wallet.core.jni/-derivation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
<div class="breadcrumbs"><a href="../../../index.html">WalletCore</a><span class="delimiter">/</span><a href="../index.html">wallet.core.jni</a><span class="delimiter">/</span><span class="current">Derivation</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Derivation</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="WalletCore/TrustWallet"><div class="symbol monospace"><span class="token keyword">enum </span><a href="index.html">Derivation</a></div><p class="paragraph">Non-default coin address derivation names (default, unnamed derivations are not included).</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="WalletCore/TrustWallet"><div class="symbol monospace"><span class="token keyword">enum </span><a href="index.html">Derivation</a></div><p class="paragraph">Non-default coin address derivation names (default, unnamed derivations are not included). Note the enum variant must be sync with `TWDerivation` enum in Rust: https://github.com/trustwallet/wallet-core/blob/master/rust/tw_coin_registry/src/tw_derivation.rs</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Entries">Entries</button><button class="section-tab" data-togglable="Functions">Functions</button></div>
Expand Down Expand Up @@ -181,6 +181,21 @@ <h2 class="tabbedcontent">Entries</h2>
</div>
</div>
</div>
<a data-name="1149380174%2FClasslikes%2F274653044" anchor-label="BITCOINTAPROOT" id="1149380174%2FClasslikes%2F274653044" data-filterable-set="WalletCore/TrustWallet"></a>
<div class="table-row" data-filterable-current="WalletCore/TrustWallet" data-filterable-set="WalletCore/TrustWallet">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-b-i-t-c-o-i-n-t-a-p-r-o-o-t/index.html">BITCOINTAPROOT</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1149380174%2FClasslikes%2F274653044"></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 " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="WalletCore/TrustWallet"><div class="symbol monospace"><div class="block"><a href="-b-i-t-c-o-i-n-t-a-p-r-o-o-t/index.html">BITCOINTAPROOT</a></div></div></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="1360387597%2FFunctions%2F274653044" anchor-label="createFromValue" id="1360387597%2FFunctions%2F274653044" data-filterable-set="WalletCore/TrustWallet"></a>
Expand Down
73 changes: 73 additions & 0 deletions -wallet-core/wallet.core.jni/-purpose/-b-i-p86/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>BIP86</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../../";</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="../../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/jetbrains-mono.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">
<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="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../../index.html">
<span>WalletCore</span>
</a>
</div>
<div>
</div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="WalletCore::wallet.core.jni/Purpose.BIP86///PointingToDeclaration/{&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;:{&quot;key&quot;:&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;}}/274653044">
<div class="breadcrumbs"><a href="../../../../index.html">WalletCore</a><span class="delimiter">/</span><a href="../../index.html">wallet.core.jni</a><span class="delimiter">/</span><a href="../index.html">Purpose</a><span class="delimiter">/</span><span class="current">BIP86</span></div>
<div class="cover ">
<h1 class="cover"><span><span>BIP86</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="WalletCore/TrustWallet"><div class="symbol monospace"><div class="block"><a href="index.html">BIP86</a></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"></div>
<div class="tabs-section-body"></div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 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>
</body>
</html>
15 changes: 15 additions & 0 deletions -wallet-core/wallet.core.jni/-purpose/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,21 @@ <h2 class="tabbedcontent">Entries</h2>
</div>
</div>
</div>
<a data-name="325899559%2FClasslikes%2F274653044" anchor-label="BIP86" id="325899559%2FClasslikes%2F274653044" data-filterable-set="WalletCore/TrustWallet"></a>
<div class="table-row" data-filterable-current="WalletCore/TrustWallet" data-filterable-set="WalletCore/TrustWallet">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-b-i-p86/index.html">BIP86</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="325899559%2FClasslikes%2F274653044"></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 " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="WalletCore/TrustWallet"><div class="symbol monospace"><div class="block"><a href="-b-i-p86/index.html">BIP86</a></div></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-987601555%2FClasslikes%2F274653044" anchor-label="BIP1852" id="-987601555%2FClasslikes%2F274653044" data-filterable-set="WalletCore/TrustWallet"></a>
<div class="table-row" data-filterable-current="WalletCore/TrustWallet" data-filterable-set="WalletCore/TrustWallet">
<div class="main-subrow keyValue ">
Expand Down
Loading

0 comments on commit 6562352

Please sign in to comment.