Skip to content

Commit 21c5814

Browse files
committed
Update docs
1 parent d701c64 commit 21c5814

File tree

9 files changed

+393
-43
lines changed

9 files changed

+393
-43
lines changed

-wallet-core/package-list

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,10 @@ $dokka.location:wallet.core.jni/AsnParser///PointingToDeclaration/-wallet-core/
4141
$dokka.location:wallet.core.jni/AsnParser/ecdsaSignatureFromDer/#byte[]/PointingToDeclaration/-wallet-core/wallet.core.jni/-asn-parser/ecdsa-signature-from-der.html
4242
$dokka.location:wallet.core.jni/Barz///PointingToDeclaration/-wallet-core/wallet.core.jni/-barz/index.html
4343
$dokka.location:wallet.core.jni/Barz/getCounterfactualAddress/#byte[]/PointingToDeclaration/-wallet-core/wallet.core.jni/-barz/get-counterfactual-address.html
44+
$dokka.location:wallet.core.jni/Barz/getDiamondCutCode/#byte[]/PointingToDeclaration/-wallet-core/wallet.core.jni/-barz/get-diamond-cut-code.html
4445
$dokka.location:wallet.core.jni/Barz/getFormattedSignature/#byte[]#byte[]#byte[]#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-barz/get-formatted-signature.html
4546
$dokka.location:wallet.core.jni/Barz/getInitCode/#java.lang.String#PublicKey#java.lang.String#int/PointingToDeclaration/-wallet-core/wallet.core.jni/-barz/get-init-code.html
47+
$dokka.location:wallet.core.jni/Barz/getPrefixedMsgHash/#byte[]#java.lang.String#int/PointingToDeclaration/-wallet-core/wallet.core.jni/-barz/get-prefixed-msg-hash.html
4648
$dokka.location:wallet.core.jni/Base32///PointingToDeclaration/-wallet-core/wallet.core.jni/-base32/index.html
4749
$dokka.location:wallet.core.jni/Base32/decode/#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-base32/decode.html
4850
$dokka.location:wallet.core.jni/Base32/decodeWithAlphabet/#java.lang.String#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-base32/decode-with-alphabet.html
@@ -801,6 +803,8 @@ $dokka.location:wallet.core.jni/SolanaAddress///PointingToDeclaration/-wallet-c
801803
$dokka.location:wallet.core.jni/SolanaAddress/SolanaAddress/#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-solana-address/-solana-address.html
802804
$dokka.location:wallet.core.jni/SolanaAddress/defaultTokenAddress/#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-solana-address/default-token-address.html
803805
$dokka.location:wallet.core.jni/SolanaAddress/description/#/PointingToDeclaration/-wallet-core/wallet.core.jni/-solana-address/description.html
806+
$dokka.location:wallet.core.jni/SolanaTransaction///PointingToDeclaration/-wallet-core/wallet.core.jni/-solana-transaction/index.html
807+
$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
804808
$dokka.location:wallet.core.jni/StarkExMessageSigner///PointingToDeclaration/-wallet-core/wallet.core.jni/-stark-ex-message-signer/index.html
805809
$dokka.location:wallet.core.jni/StarkExMessageSigner/signMessage/#PrivateKey#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-stark-ex-message-signer/sign-message.html
806810
$dokka.location:wallet.core.jni/StarkExMessageSigner/verifyMessage/#PublicKey#java.lang.String#java.lang.String/PointingToDeclaration/-wallet-core/wallet.core.jni/-stark-ex-message-signer/verify-message.html
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>getDiamondCutCode</title>
6+
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../../";</script>
8+
<script>const storage = localStorage.getItem("dokka-dark-mode")
9+
if (storage == null) {
10+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
11+
if (osDarkSchemePreferred === true) {
12+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
13+
}
14+
} else {
15+
const savedDarkMode = JSON.parse(storage)
16+
if(savedDarkMode === true) {
17+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
18+
}
19+
}
20+
</script>
21+
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
22+
<link href="../../../styles/style.css" rel="Stylesheet">
23+
<link href="../../../styles/jetbrains-mono.css" rel="Stylesheet">
24+
<link href="../../../styles/main.css" rel="Stylesheet">
25+
<link href="../../../styles/prism.css" rel="Stylesheet">
26+
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
27+
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
28+
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
29+
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
30+
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
31+
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
32+
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
33+
</head>
34+
<body>
35+
<div class="navigation-wrapper" id="navigation-wrapper">
36+
<div id="leftToggler"><span class="icon-toggler"></span></div>
37+
<div class="library-name">
38+
<a href="../../../index.html">
39+
<span>WalletCore</span>
40+
</a>
41+
</div>
42+
<div>
43+
</div>
44+
<div class="pull-right d-flex">
45+
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
46+
<div id="searchBar"></div>
47+
</div>
48+
</div>
49+
<div id="container">
50+
<div id="leftColumn">
51+
<div id="sideMenu"></div>
52+
</div>
53+
<div id="main">
54+
<div class="main-content" id="content" pageIds="WalletCore::wallet.core.jni/Barz/getDiamondCutCode/#byte[]/PointingToDeclaration//274653044">
55+
<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">Barz</a><span class="delimiter">/</span><span class="current">getDiamondCutCode</span></div>
56+
<div class="cover ">
57+
<h1 class="cover"><span>get</span><wbr></wbr><span>Diamond</span><wbr></wbr><span>Cut</span><wbr></wbr><span><span>Code</span></span></h1>
58+
</div>
59+
<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="get-diamond-cut-code.html"><span class="token function">getDiamondCutCode</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">input<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html">Byte</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html">Byte</a><span class="token operator">&gt;</span></div><p class="paragraph">Returns the encoded diamondCut function call for Barz contract upgrades</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">The encoded bytes of diamondCut function call</p></span><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><span>input</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The serialized data of DiamondCutInput</p></div></div></div></div></div></div></div></div></div>
60+
</div>
61+
<div class="footer">
62+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
63+
class="pull-right"><span>Generated by </span><a
64+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
65+
</div>
66+
</div>
67+
</div>
68+
</body>
69+
</html>
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>getPrefixedMsgHash</title>
6+
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../../";</script>
8+
<script>const storage = localStorage.getItem("dokka-dark-mode")
9+
if (storage == null) {
10+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
11+
if (osDarkSchemePreferred === true) {
12+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
13+
}
14+
} else {
15+
const savedDarkMode = JSON.parse(storage)
16+
if(savedDarkMode === true) {
17+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
18+
}
19+
}
20+
</script>
21+
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
22+
<link href="../../../styles/style.css" rel="Stylesheet">
23+
<link href="../../../styles/jetbrains-mono.css" rel="Stylesheet">
24+
<link href="../../../styles/main.css" rel="Stylesheet">
25+
<link href="../../../styles/prism.css" rel="Stylesheet">
26+
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
27+
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
28+
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
29+
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
30+
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
31+
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
32+
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
33+
</head>
34+
<body>
35+
<div class="navigation-wrapper" id="navigation-wrapper">
36+
<div id="leftToggler"><span class="icon-toggler"></span></div>
37+
<div class="library-name">
38+
<a href="../../../index.html">
39+
<span>WalletCore</span>
40+
</a>
41+
</div>
42+
<div>
43+
</div>
44+
<div class="pull-right d-flex">
45+
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
46+
<div id="searchBar"></div>
47+
</div>
48+
</div>
49+
<div id="container">
50+
<div id="leftColumn">
51+
<div id="sideMenu"></div>
52+
</div>
53+
<div id="main">
54+
<div class="main-content" id="content" pageIds="WalletCore::wallet.core.jni/Barz/getPrefixedMsgHash/#byte[]#java.lang.String#int/PointingToDeclaration//274653044">
55+
<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">Barz</a><span class="delimiter">/</span><span class="current">getPrefixedMsgHash</span></div>
56+
<div class="cover ">
57+
<h1 class="cover"><span>get</span><wbr></wbr><span>Prefixed</span><wbr></wbr><span>Msg</span><wbr></wbr><span><span>Hash</span></span></h1>
58+
</div>
59+
<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="get-prefixed-msg-hash.html"><span class="token function">getPrefixedMsgHash</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">msgHash<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html">Byte</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">barzAddress<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">chainId<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html">Byte</a><span class="token operator">&gt;</span></div><p class="paragraph">Returns the final hash to be signed by Barz for signing messages &typed data</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">The final hash to be signed</p></span><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>msg</span><wbr></wbr><span><span>Hash</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Original msgHash</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>barz</span><wbr></wbr><span><span>Address</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The address of Barz wallet signing the message</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>chain</span><wbr></wbr><span><span>Id</span></span></u></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The chainId of the network the verification will happen</p></div></div></div></div></div></div></div></div></div>
60+
</div>
61+
<div class="footer">
62+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
63+
class="pull-right"><span>Generated by </span><a
64+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
65+
</div>
66+
</div>
67+
</div>
68+
</body>
69+
</html>

0 commit comments

Comments
 (0)