update doc

honey-protocol · Mar 21, 2023 · 1947070 · 1947070
1 parent fea896d
commit 1947070
Show file tree

Hide file tree

Showing 248 changed files with 7,177 additions and 4,930 deletions.
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -5,16 +5,20 @@
     --dark-hl-1: #6A9955;
     --light-hl-2: #001080;
     --dark-hl-2: #9CDCFE;
-    --light-hl-3: #795E26;
-    --dark-hl-3: #DCDCAA;
-    --light-hl-4: #AF00DB;
-    --dark-hl-4: #C586C0;
+    --light-hl-3: #000000;
+    --dark-hl-3: #C8C8C8;
+    --light-hl-4: #A31515;
+    --dark-hl-4: #CE9178;
     --light-hl-5: #0000FF;
     --dark-hl-5: #569CD6;
-    --light-hl-6: #A31515;
-    --dark-hl-6: #CE9178;
-    --light-hl-7: #0070C1;
-    --dark-hl-7: #4FC1FF;
+    --light-hl-6: #795E26;
+    --dark-hl-6: #DCDCAA;
+    --light-hl-7: #098658;
+    --dark-hl-7: #B5CEA8;
+    --light-hl-8: #AF00DB;
+    --dark-hl-8: #C586C0;
+    --light-hl-9: #0070C1;
+    --dark-hl-9: #4FC1FF;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -28,6 +32,8 @@
     --hl-5: var(--light-hl-5);
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
     --code-background: var(--light-code-background);
 } }
 
@@ -40,6 +46,8 @@
     --hl-5: var(--dark-hl-5);
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
     --code-background: var(--dark-code-background);
 } }
 
@@ -52,6 +60,8 @@
     --hl-5: var(--light-hl-5);
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
     --code-background: var(--light-code-background);
 }
 
@@ -64,6 +74,8 @@
     --hl-5: var(--dark-hl-5);
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
     --code-background: var(--dark-code-background);
 }
 
@@ -75,4 +87,6 @@
 .hl-5 { color: var(--hl-5); }
 .hl-6 { color: var(--hl-6); }
 .hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
 pre, code { background: var(--code-background); }
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/Amount.html b/docs/classes/Amount.html
@@ -18,7 +18,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">Amount</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/57ec826/src/wrappers/index.ts#L17">src/wrappers/index.ts:17</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/fea896d/src/wrappers/index.ts#L17">src/wrappers/index.ts:17</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">
@@ -55,60 +55,60 @@ <h5>units: <a href="../modules/wrappers.html" class="tsd-signature-type" data-ts
 <h5>value: <span class="tsd-signature-type">BN</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../modules/wrappers.html" class="tsd-signature-type" data-tsd-kind="Namespace">wrappers</a><span class="tsd-signature-symbol">.</span><a href="wrappers.Amount.html" class="tsd-signature-type" data-tsd-kind="Class">Amount</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/57ec826/src/wrappers/index.ts#L18">src/wrappers/index.ts:18</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/fea896d/src/wrappers/index.ts#L18">src/wrappers/index.ts:18</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="units" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>units</span><a href="#units" 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">units<span class="tsd-signature-symbol">:</span> <a href="../modules/wrappers.html" class="tsd-signature-type" data-tsd-kind="Namespace">wrappers</a><span class="tsd-signature-symbol">.</span><a href="../types/wrappers.AmountUnits.html" class="tsd-signature-type" data-tsd-kind="Type alias">AmountUnits</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/57ec826/src/wrappers/index.ts#L18">src/wrappers/index.ts:18</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/fea896d/src/wrappers/index.ts#L18">src/wrappers/index.ts:18</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="value" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BN</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/57ec826/src/wrappers/index.ts#L18">src/wrappers/index.ts:18</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/fea896d/src/wrappers/index.ts#L18">src/wrappers/index.ts:18</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="depositNotes" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>deposit<wbr/>Notes</span><a href="#depositNotes" 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>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
-<li class="tsd-signature tsd-anchor-link" id="depositNotes.depositNotes-1">deposit<wbr/>Notes<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/wrappers.html" class="tsd-signature-type" data-tsd-kind="Namespace">wrappers</a><span class="tsd-signature-symbol">.</span><a href="wrappers.Amount.html" class="tsd-signature-type" data-tsd-kind="Class">Amount</a><a href="#depositNotes.depositNotes-1" 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></li>
+<li class="tsd-signature tsd-anchor-link" id="depositNotes.depositNotes-1">deposit<wbr/>Notes<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/wrappers.html" class="tsd-signature-type" data-tsd-kind="Namespace">wrappers</a><span class="tsd-signature-symbol">.</span><a href="wrappers.Amount.html" class="tsd-signature-type" data-tsd-kind="Class">Amount</a><a href="#depositNotes.depositNotes-1" 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></li>
 <li class="tsd-description">
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li>
-<h5>amount: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">u64</span></h5></li></ul></div>
+<h5>amount: <span class="tsd-signature-type">any</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../modules/wrappers.html" class="tsd-signature-type" data-tsd-kind="Namespace">wrappers</a><span class="tsd-signature-symbol">.</span><a href="wrappers.Amount.html" class="tsd-signature-type" data-tsd-kind="Class">Amount</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/57ec826/src/wrappers/index.ts#L24">src/wrappers/index.ts:24</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/fea896d/src/wrappers/index.ts#L24">src/wrappers/index.ts:24</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="loanNotes" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>loan<wbr/>Notes</span><a href="#loanNotes" 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>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
-<li class="tsd-signature tsd-anchor-link" id="loanNotes.loanNotes-1">loan<wbr/>Notes<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/wrappers.html" class="tsd-signature-type" data-tsd-kind="Namespace">wrappers</a><span class="tsd-signature-symbol">.</span><a href="wrappers.Amount.html" class="tsd-signature-type" data-tsd-kind="Class">Amount</a><a href="#loanNotes.loanNotes-1" 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></li>
+<li class="tsd-signature tsd-anchor-link" id="loanNotes.loanNotes-1">loan<wbr/>Notes<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/wrappers.html" class="tsd-signature-type" data-tsd-kind="Namespace">wrappers</a><span class="tsd-signature-symbol">.</span><a href="wrappers.Amount.html" class="tsd-signature-type" data-tsd-kind="Class">Amount</a><a href="#loanNotes.loanNotes-1" 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></li>
 <li class="tsd-description">
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li>
-<h5>amount: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">u64</span></h5></li></ul></div>
+<h5>amount: <span class="tsd-signature-type">any</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../modules/wrappers.html" class="tsd-signature-type" data-tsd-kind="Namespace">wrappers</a><span class="tsd-signature-symbol">.</span><a href="wrappers.Amount.html" class="tsd-signature-type" data-tsd-kind="Class">Amount</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/57ec826/src/wrappers/index.ts#L28">src/wrappers/index.ts:28</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/fea896d/src/wrappers/index.ts#L28">src/wrappers/index.ts:28</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="tokens" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>tokens</span><a href="#tokens" 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>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
-<li class="tsd-signature tsd-anchor-link" id="tokens.tokens-1">tokens<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/wrappers.html" class="tsd-signature-type" data-tsd-kind="Namespace">wrappers</a><span class="tsd-signature-symbol">.</span><a href="wrappers.Amount.html" class="tsd-signature-type" data-tsd-kind="Class">Amount</a><a href="#tokens.tokens-1" 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></li>
+<li class="tsd-signature tsd-anchor-link" id="tokens.tokens-1">tokens<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/wrappers.html" class="tsd-signature-type" data-tsd-kind="Namespace">wrappers</a><span class="tsd-signature-symbol">.</span><a href="wrappers.Amount.html" class="tsd-signature-type" data-tsd-kind="Class">Amount</a><a href="#tokens.tokens-1" 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></li>
 <li class="tsd-description">
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li>
-<h5>amount: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">u64</span></h5></li></ul></div>
+<h5>amount: <span class="tsd-signature-type">any</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../modules/wrappers.html" class="tsd-signature-type" data-tsd-kind="Namespace">wrappers</a><span class="tsd-signature-symbol">.</span><a href="wrappers.Amount.html" class="tsd-signature-type" data-tsd-kind="Class">Amount</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/57ec826/src/wrappers/index.ts#L20">src/wrappers/index.ts:20</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/honey-labs/honey-sdk/blob/fea896d/src/wrappers/index.ts#L20">src/wrappers/index.ts:20</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">