chore: Update docs

Author: wottpal

docs/assets/search.js

@@ -16,7 +16,7 @@
 <li><a href="SubstrateWalletPlatform.html">SubstrateWalletPlatform</a></li></ul>
 <h1>Enumeration SubstrateWalletPlatform</h1></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/wallets.ts#L22">src/wallets.ts:22</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/wallets.ts#L22">src/wallets.ts:22</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <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>
 <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>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">Android</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;android&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/wallets.ts#L24">src/wallets.ts:24</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/wallets.ts#L24">src/wallets.ts:24</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="Browser" class="tsd-anchor"></a>
 <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>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">Browser</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;browser&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/wallets.ts#L23">src/wallets.ts:23</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/wallets.ts#L23">src/wallets.ts:23</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="iOS" class="tsd-anchor"></a>
 <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>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">iOS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ios&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/wallets.ts#L25">src/wallets.ts:25</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/wallets.ts#L25">src/wallets.ts:25</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/enums/SubstrateWalletPlatform.html

@@ -19,7 +19,7 @@ <h1>Enumeration UseInkathonErrorCode</h1></div>
 <div class="tsd-comment tsd-typography"><p>Helper Types</p>
 </div></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/provider.tsx#L34">src/provider.tsx:34</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/provider.tsx#L34">src/provider.tsx:34</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <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>
 <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>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">Initialization<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/provider.tsx#L35">src/provider.tsx:35</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/provider.tsx#L35">src/provider.tsx:35</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="NoAccountInjected" class="tsd-anchor"></a>
 <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>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">No<wbr/>Account<wbr/>Injected</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/provider.tsx#L37">src/provider.tsx:37</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/provider.tsx#L37">src/provider.tsx:37</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="NoSubstrateExtensionDetected" class="tsd-anchor"></a>
 <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>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">No<wbr/>Substrate<wbr/>Extension<wbr/>Detected</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/provider.tsx#L36">src/provider.tsx:36</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/provider.tsx#L36">src/provider.tsx:36</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/enums/UseInkathonErrorCode.html

@@ -31,7 +31,7 @@ <h5><span class="tsd-kind-parameter">a1</span>: <span class="tsd-signature-type
 <h5><span class="tsd-kind-parameter">a2</span>: <span class="tsd-signature-type ">InjectedAccount</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/helpers/accountsAreEqual.ts#L17">src/helpers/accountsAreEqual.ts:17</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/helpers/accountsAreEqual.ts#L17">src/helpers/accountsAreEqual.ts:17</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/accountArraysAreEqual.html

@@ -30,7 +30,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">a2</span>: <span class="tsd-signature-type ">InjectedAccount</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/helpers/accountsAreEqual.ts#L6">src/helpers/accountsAreEqual.ts:6</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/helpers/accountsAreEqual.ts#L6">src/helpers/accountsAreEqual.ts:6</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/accountsAreEqual.html

@@ -39,7 +39,7 @@ <h5><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-
 <h5><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">ContractCallOutcome</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/helpers/contractCall.ts#L22">src/helpers/contractCall.ts:22</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/helpers/contractCall.ts#L22">src/helpers/contractCall.ts:22</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/contractCallDryRun.html

@@ -38,7 +38,7 @@ <h5><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-
 <h5><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">ContractCallOutcome</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/helpers/contractCall.ts#L48">src/helpers/contractCall.ts:48</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/helpers/contractCall.ts#L48">src/helpers/contractCall.ts:48</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/contractQuery.html

@@ -49,7 +49,7 @@ <h5><span class="tsd-kind-parameter">result</span>: <span class="tsd-signature-t
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ContractTxResult.html" class="tsd-signature-type tsd-kind-type-alias">ContractTxResult</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/helpers/contractCall.ts#L74">src/helpers/contractCall.ts:74</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/helpers/contractCall.ts#L74">src/helpers/contractCall.ts:74</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/contractTx.html

@@ -41,7 +41,7 @@ <h5><span class="tsd-kind-property">is<wbr/>Error</span><span class="tsd-signatu
 <li class="tsd-parameter">
 <h5><span class="tsd-kind-property">output</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5></li></ul><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/helpers/decodeOutput.ts#L39">src/helpers/decodeOutput.ts:39</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/helpers/decodeOutput.ts#L39">src/helpers/decodeOutput.ts:39</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/decodeOutput.html

@@ -40,7 +40,7 @@ <h5><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-typ
 <h5><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">ContractOptions</span><span class="tsd-signature-symbol"> = ...</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">address</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">block</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">SignedBlock</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">blockNumber</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">hash</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/helpers/deployContract.ts#L12">src/helpers/deployContract.ts:12</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/helpers/deployContract.ts#L12">src/helpers/deployContract.ts:12</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/deployContract.html

@@ -30,7 +30,7 @@ <h5><span class="tsd-kind-parameter">wallet</span>: <a href="../interfaces/Subst
 <h5><span class="tsd-kind-parameter">appName</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">InjectedExtension</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/wallets.ts#L136">src/wallets.ts:136</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/wallets.ts#L136">src/wallets.ts:136</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/enableWallet.html

@@ -30,7 +30,7 @@ <h5><span class="tsd-kind-parameter">contract</span>: <span class="tsd-signature
 <h5><span class="tsd-kind-parameter">method</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AbiMessage</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/helpers/getAbiMessage.ts#L7">src/helpers/getAbiMessage.ts:7</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/helpers/getAbiMessage.ts#L7">src/helpers/getAbiMessage.ts:7</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/getAbiMessage.html

@@ -30,7 +30,7 @@ <h5><span class="tsd-kind-parameter">api</span>: <span class="tsd-signature-type
 <h5><span class="tsd-kind-parameter">address</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AccountId</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">balance</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">BN</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">balanceFormatted</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">freeBalance</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">BN</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">reservedBalance</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">BN</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">tokenDecimals</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">tokenSymbol</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/5ac3867/src/helpers/getBalance.ts#L8">src/helpers/getBalance.ts:8</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/scio-labs/use-inkathon/blob/89f332c/src/helpers/getBalance.ts#L8">src/helpers/getBalance.ts:8</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">