Skip to content

Commit 6091dcd

Browse files
wottpalwottpal
committed
chore: Update docs
1 parent 93da52e commit 6091dcd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+424
-93
lines changed

‎docs/assets/search.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/enums/SubstrateWalletPlatform.html

+6-4
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<li><a href="SubstrateWalletPlatform.html">SubstrateWalletPlatform</a></li></ul>
1717
<h1>Enumeration SubstrateWalletPlatform</h1></div><aside class="tsd-sources">
1818
<ul>
19-
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/07ce560/src/wallets.ts#L17">src/wallets.ts:17</a></li></ul></aside>
19+
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/eb86be7/src/wallets.ts#L22">src/wallets.ts:22</a></li></ul></aside>
2020
<section class="tsd-panel-group tsd-index-group">
2121
<section class="tsd-panel tsd-index-panel">
2222
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -34,17 +34,17 @@ <h2>Enumeration Members</h2>
3434
<h3 class="tsd-anchor-link"><span>Android</span><a href="#Android" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
3535
<div class="tsd-signature">Android<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;android&quot;</span></div><aside class="tsd-sources">
3636
<ul>
37-
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/07ce560/src/wallets.ts#L19">src/wallets.ts:19</a></li></ul></aside></section>
37+
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/eb86be7/src/wallets.ts#L24">src/wallets.ts:24</a></li></ul></aside></section>
3838
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Browser" class="tsd-anchor"></a>
3939
<h3 class="tsd-anchor-link"><span>Browser</span><a href="#Browser" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
4040
<div class="tsd-signature">Browser<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;browser&quot;</span></div><aside class="tsd-sources">
4141
<ul>
42-
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/07ce560/src/wallets.ts#L18">src/wallets.ts:18</a></li></ul></aside></section>
42+
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/eb86be7/src/wallets.ts#L23">src/wallets.ts:23</a></li></ul></aside></section>
4343
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="iOS" class="tsd-anchor"></a>
4444
<h3 class="tsd-anchor-link"><span>iOS</span><a href="#iOS" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
4545
<div class="tsd-signature">iOS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ios&quot;</span></div><aside class="tsd-sources">
4646
<ul>
47-
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/07ce560/src/wallets.ts#L20">src/wallets.ts:20</a></li></ul></aside></section></section></div>
47+
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/eb86be7/src/wallets.ts#L25">src/wallets.ts:25</a></li></ul></aside></section></section></div>
4848
<div class="col-sidebar">
4949
<div class="page-menu">
5050
<div class="tsd-navigation settings">
@@ -101,6 +101,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
101101
<li><a href="../functions/contractTx.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>contract<wbr/>Tx</span></a></li>
102102
<li><a href="../functions/decodeOutput.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>decode<wbr/>Output</span></a></li>
103103
<li><a href="../functions/deployContract.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>deploy<wbr/>Contract</span></a></li>
104+
<li><a href="../functions/enableWallet.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>enable<wbr/>Wallet</span></a></li>
104105
<li><a href="../functions/formatBalance.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>format<wbr/>Balance</span></a></li>
105106
<li><a href="../functions/formatBalanceToFixed.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>format<wbr/>Balance<wbr/>To<wbr/>Fixed</span></a></li>
106107
<li><a href="../functions/getAbiMessage.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Abi<wbr/>Message</span></a></li>
@@ -112,6 +113,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
112113
<li><a href="../functions/getSubstrateChain.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Substrate<wbr/>Chain</span></a></li>
113114
<li><a href="../functions/getSubstrateWallet.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Substrate<wbr/>Wallet</span></a></li>
114115
<li><a href="../functions/initPolkadotJs.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>init<wbr/>Polkadot<wbr/>Js</span></a></li>
116+
<li><a href="../functions/isWalletInstalled.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>is<wbr/>Wallet<wbr/>Installed</span></a></li>
115117
<li><a href="../functions/registerDeployment.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>register<wbr/>Deployment</span></a></li>
116118
<li><a href="../functions/registerDeployments.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>register<wbr/>Deployments</span></a></li>
117119
<li><a href="../functions/transferBalance.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>transfer<wbr/>Balance</span></a></li>

‎docs/enums/UseInkathonErrorCode.html

+6-4
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ <h1>Enumeration UseInkathonErrorCode</h1></div>
1919
<div class="tsd-comment tsd-typography"><p>Helper Types</p>
2020
</div></section><aside class="tsd-sources">
2121
<ul>
22-
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/07ce560/src/provider.tsx#L26">src/provider.tsx:26</a></li></ul></aside>
22+
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/eb86be7/src/provider.tsx#L34">src/provider.tsx:34</a></li></ul></aside>
2323
<section class="tsd-panel-group tsd-index-group">
2424
<section class="tsd-panel tsd-index-panel">
2525
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -37,17 +37,17 @@ <h2>Enumeration Members</h2>
3737
<h3 class="tsd-anchor-link"><span>Initialization<wbr/>Error</span><a href="#InitializationError" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
3838
<div class="tsd-signature">Initialization<wbr/>Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><aside class="tsd-sources">
3939
<ul>
40-
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/07ce560/src/provider.tsx#L27">src/provider.tsx:27</a></li></ul></aside></section>
40+
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/eb86be7/src/provider.tsx#L35">src/provider.tsx:35</a></li></ul></aside></section>
4141
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="NoAccountInjected" class="tsd-anchor"></a>
4242
<h3 class="tsd-anchor-link"><span>No<wbr/>Account<wbr/>Injected</span><a href="#NoAccountInjected" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
4343
<div class="tsd-signature">No<wbr/>Account<wbr/>Injected<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources">
4444
<ul>
45-
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/07ce560/src/provider.tsx#L29">src/provider.tsx:29</a></li></ul></aside></section>
45+
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/eb86be7/src/provider.tsx#L37">src/provider.tsx:37</a></li></ul></aside></section>
4646
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="NoSubstrateExtensionDetected" class="tsd-anchor"></a>
4747
<h3 class="tsd-anchor-link"><span>No<wbr/>Substrate<wbr/>Extension<wbr/>Detected</span><a href="#NoSubstrateExtensionDetected" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
4848
<div class="tsd-signature">No<wbr/>Substrate<wbr/>Extension<wbr/>Detected<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources">
4949
<ul>
50-
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/07ce560/src/provider.tsx#L28">src/provider.tsx:28</a></li></ul></aside></section></section></div>
50+
<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/eb86be7/src/provider.tsx#L36">src/provider.tsx:36</a></li></ul></aside></section></section></div>
5151
<div class="col-sidebar">
5252
<div class="page-menu">
5353
<div class="tsd-navigation settings">
@@ -104,6 +104,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
104104
<li><a href="../functions/contractTx.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>contract<wbr/>Tx</span></a></li>
105105
<li><a href="../functions/decodeOutput.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>decode<wbr/>Output</span></a></li>
106106
<li><a href="../functions/deployContract.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>deploy<wbr/>Contract</span></a></li>
107+
<li><a href="../functions/enableWallet.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>enable<wbr/>Wallet</span></a></li>
107108
<li><a href="../functions/formatBalance.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>format<wbr/>Balance</span></a></li>
108109
<li><a href="../functions/formatBalanceToFixed.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>format<wbr/>Balance<wbr/>To<wbr/>Fixed</span></a></li>
109110
<li><a href="../functions/getAbiMessage.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Abi<wbr/>Message</span></a></li>
@@ -115,6 +116,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
115116
<li><a href="../functions/getSubstrateChain.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Substrate<wbr/>Chain</span></a></li>
116117
<li><a href="../functions/getSubstrateWallet.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Substrate<wbr/>Wallet</span></a></li>
117118
<li><a href="../functions/initPolkadotJs.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>init<wbr/>Polkadot<wbr/>Js</span></a></li>
119+
<li><a href="../functions/isWalletInstalled.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>is<wbr/>Wallet<wbr/>Installed</span></a></li>
118120
<li><a href="../functions/registerDeployment.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>register<wbr/>Deployment</span></a></li>
119121
<li><a href="../functions/registerDeployments.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>register<wbr/>Deployments</span></a></li>
120122
<li><a href="../functions/transferBalance.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>transfer<wbr/>Balance</span></a></li>

‎docs/functions/UseInkathonProvider.html

+2
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
7878
<li><a href="contractTx.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>contract<wbr/>Tx</span></a></li>
7979
<li><a href="decodeOutput.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>decode<wbr/>Output</span></a></li>
8080
<li><a href="deployContract.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>deploy<wbr/>Contract</span></a></li>
81+
<li><a href="enableWallet.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>enable<wbr/>Wallet</span></a></li>
8182
<li><a href="formatBalance.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>format<wbr/>Balance</span></a></li>
8283
<li><a href="formatBalanceToFixed.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>format<wbr/>Balance<wbr/>To<wbr/>Fixed</span></a></li>
8384
<li><a href="getAbiMessage.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Abi<wbr/>Message</span></a></li>
@@ -89,6 +90,7 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
8990
<li><a href="getSubstrateChain.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Substrate<wbr/>Chain</span></a></li>
9091
<li><a href="getSubstrateWallet.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Substrate<wbr/>Wallet</span></a></li>
9192
<li><a href="initPolkadotJs.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>init<wbr/>Polkadot<wbr/>Js</span></a></li>
93+
<li><a href="isWalletInstalled.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>is<wbr/>Wallet<wbr/>Installed</span></a></li>
9294
<li><a href="registerDeployment.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>register<wbr/>Deployment</span></a></li>
9395
<li><a href="registerDeployments.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>register<wbr/>Deployments</span></a></li>
9496
<li><a href="transferBalance.html" class="tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>transfer<wbr/>Balance</span></a></li>

0 commit comments

Comments
 (0)