Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Milerius committed Aug 23, 2024
1 parent 8884f39 commit bbf5871
Show file tree
Hide file tree
Showing 6 changed files with 187 additions and 7 deletions.
2 changes: 2 additions & 0 deletions -wallet-core/package-list
Original file line number Diff line number Diff line change
Expand Up @@ -921,6 +921,8 @@ $dokka.location:wallet.core.jni/TONAddressConverter///PointingToDeclaration/-wa
$dokka.location:wallet.core.jni/TONAddressConverter/fromBoc/#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-t-o-n-address-converter/from-boc.html
$dokka.location:wallet.core.jni/TONAddressConverter/toBoc/#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-t-o-n-address-converter/to-boc.html
$dokka.location:wallet.core.jni/TONAddressConverter/toUserFriendly/#java.lang.String#boolean#boolean/PointingToDeclaration/-wallet-core/wallet.core.jni/-t-o-n-address-converter/to-user-friendly.html
$dokka.location:wallet.core.jni/TONMessageSigner///PointingToDeclaration/-wallet-core/wallet.core.jni/-t-o-n-message-signer/index.html
$dokka.location:wallet.core.jni/TONMessageSigner/signMessage/#PrivateKey#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-t-o-n-message-signer/sign-message.html
$dokka.location:wallet.core.jni/TONWallet///PointingToDeclaration/-wallet-core/wallet.core.jni/-t-o-n-wallet/index.html
$dokka.location:wallet.core.jni/TONWallet/buildV4R2StateInit/#PublicKey#int#int/PointingToDeclaration/-wallet-core/wallet.core.jni/-t-o-n-wallet/build-v4-r2-state-init.html
$dokka.location:wallet.core.jni/TezosMessageSigner///PointingToDeclaration/-wallet-core/wallet.core.jni/-tezos-message-signer/index.html
Expand Down
91 changes: 91 additions & 0 deletions -wallet-core/wallet.core.jni/-t-o-n-message-signer/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>TONMessageSigner</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/TONMessageSigner///PointingToDeclaration//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><span class="current">TONMessageSigner</span></div>
<div class="cover ">
<h1 class="cover"><span>TONMessage</span><wbr></wbr><span><span>Signer</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">class </span><a href="index.html">TONMessageSigner</a></div><p class="paragraph">TON message signing.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button></div>
<div class="tabs-section-body">
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="2094686166%2FFunctions%2F274653044" anchor-label="signMessage" id="2094686166%2FFunctions%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="sign-message.html"><span>sign</span><wbr></wbr><span><span>Message</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2094686166%2FFunctions%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"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="sign-message.html"><span class="token function">signMessage</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">privateKey<span class="token operator">: </span>PrivateKey<span class="token punctuation">, </span></span><span class="parameter ">message<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html">String</a></div><div class="brief ">Signs an arbitrary message to prove ownership of an address for off-chain services.</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>© 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>
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>signMessage</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/TONMessageSigner/signMessage/#PrivateKey#java.lang.String/PointingToDeclaration//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">TONMessageSigner</a><span class="delimiter">/</span><span class="current">signMessage</span></div>
<div class="cover ">
<h1 class="cover"><span>sign</span><wbr></wbr><span><span>Message</span></span></h1>
</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">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="sign-message.html"><span class="token function">signMessage</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">privateKey<span class="token operator">: </span>PrivateKey<span class="token punctuation">, </span></span><span class="parameter ">message<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html">String</a></div><p class="paragraph">Signs an arbitrary message to prove ownership of an address for off-chain services. https://github.com/ton-foundation/specs/blob/main/specs/wtf-0002.md</p><h4 class="">Parameters</h4><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current="WalletCore/TrustWallet" data-filterable-set="WalletCore/TrustWallet"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span>private</span><wbr></wbr><span><span>Key</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">: the private key used for signing</p></div></div></div></div></div><div class="table-row" data-filterable-current="WalletCore/TrustWallet" data-filterable-set="WalletCore/TrustWallet"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><u><span><span>message</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">: A custom message which is input to the signing.</p></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>© 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/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1065,6 +1065,21 @@ <h2 class="">Types</h2>
</div>
</div>
</div>
<a data-name="-564706705%2FClasslikes%2F274653044" anchor-label="TONMessageSigner" id="-564706705%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="-t-o-n-message-signer/index.html"><span>TONMessage</span><wbr></wbr><span><span>Signer</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-564706705%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"><span class="token keyword">class </span><a href="-t-o-n-message-signer/index.html">TONMessageSigner</a></div><div class="brief ">TON message signing.</div></div></div>
</div>
</div>
</div>
</div>
<a data-name="260801033%2FClasslikes%2F274653044" anchor-label="TONWallet" id="260801033%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
15 changes: 9 additions & 6 deletions navigation.html
Original file line number Diff line number Diff line change
Expand Up @@ -1427,22 +1427,25 @@
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-66" pageId="WalletCore::wallet.core.jni/TONAddressConverter///PointingToDeclaration//274653044">
<div class="overview"><a href="-wallet-core/wallet.core.jni/-t-o-n-address-converter/index.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon class"></span><span class="nav-link-child"><span>TONAddress</span><wbr></wbr><span><span>Converter</span></span></span></span></a></div>
</div>
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-67" pageId="WalletCore::wallet.core.jni/TONWallet///PointingToDeclaration//274653044">
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-67" pageId="WalletCore::wallet.core.jni/TONMessageSigner///PointingToDeclaration//274653044">
<div class="overview"><a href="-wallet-core/wallet.core.jni/-t-o-n-message-signer/index.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon class"></span><span class="nav-link-child"><span>TONMessage</span><wbr></wbr><span><span>Signer</span></span></span></span></a></div>
</div>
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-68" pageId="WalletCore::wallet.core.jni/TONWallet///PointingToDeclaration//274653044">
<div class="overview"><a href="-wallet-core/wallet.core.jni/-t-o-n-wallet/index.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon class"></span><span class="nav-link-child"><span><span>TONWallet</span></span></span></span></a></div>
</div>
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-68" pageId="WalletCore::wallet.core.jni/TransactionCompiler///PointingToDeclaration//274653044">
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-69" pageId="WalletCore::wallet.core.jni/TransactionCompiler///PointingToDeclaration//274653044">
<div class="overview"><a href="-wallet-core/wallet.core.jni/-transaction-compiler/index.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon class"></span><span class="nav-link-child"><span>Transaction</span><wbr></wbr><span><span>Compiler</span></span></span></span></a></div>
</div>
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-69" pageId="WalletCore::wallet.core.jni/TransactionDecoder///PointingToDeclaration//274653044">
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-70" pageId="WalletCore::wallet.core.jni/TransactionDecoder///PointingToDeclaration//274653044">
<div class="overview"><a href="-wallet-core/wallet.core.jni/-transaction-decoder/index.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon class"></span><span class="nav-link-child"><span>Transaction</span><wbr></wbr><span><span>Decoder</span></span></span></span></a></div>
</div>
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-70" pageId="WalletCore::wallet.core.jni/TronMessageSigner///PointingToDeclaration//274653044">
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-71" pageId="WalletCore::wallet.core.jni/TronMessageSigner///PointingToDeclaration//274653044">
<div class="overview"><a href="-wallet-core/wallet.core.jni/-tron-message-signer/index.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon class"></span><span class="nav-link-child"><span>Tron</span><wbr></wbr><span>Message</span><wbr></wbr><span><span>Signer</span></span></span></span></a></div>
</div>
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-71" pageId="WalletCore::wallet.core.jni/WalletConnectRequest///PointingToDeclaration//274653044">
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-72" pageId="WalletCore::wallet.core.jni/WalletConnectRequest///PointingToDeclaration//274653044">
<div class="overview"><a href="-wallet-core/wallet.core.jni/-wallet-connect-request/index.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon class"></span><span class="nav-link-child"><span>Wallet</span><wbr></wbr><span>Connect</span><wbr></wbr><span><span>Request</span></span></span></span></a></div>
</div>
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-72" pageId="WalletCore::wallet.core.jni/WebAuthn///PointingToDeclaration//274653044">
<div class="sideMenuPart" id="WalletCore-nav-submenu-0-73" pageId="WalletCore::wallet.core.jni/WebAuthn///PointingToDeclaration//274653044">
<div class="overview"><a href="-wallet-core/wallet.core.jni/-web-authn/index.html"><span class="nav-link-grid"><span class="nav-link-child nav-icon class"></span><span class="nav-link-child"><span>Web</span><wbr></wbr><span><span>Authn</span></span></span></span></a></div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion scripts/pages.json

Large diffs are not rendered by default.

0 comments on commit bbf5871

Please sign in to comment.