Skip to content

Commit

Permalink
Refreshing documentation 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@aorumbayev
aorumbayev committed Sep 3, 2023
1 parent 52a751c commit cac4229
Show file tree
Hide file tree
Showing 27 changed files with 236 additions and 214 deletions.
2 changes: 1 addition & 1 deletion assets/search.js
View file

Large diffs are not rendered by default.

86 changes: 43 additions & 43 deletions classes/SubtopiaClient.html
View file

Large diffs are not rendered by default.

36 changes: 18 additions & 18 deletions classes/SubtopiaRegistryClient.html
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions enums/ChainType.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<li><a href="ChainType.html">ChainType</a></li></ul>
<h1>Enumeration ChainType</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/6a8d797/src/enums/index.ts#L37">enums/index.ts:37</a></li></ul></aside>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/ad6f344/src/enums/index.ts#L37">enums/index.ts:37</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">
Expand All @@ -33,12 +33,12 @@ <h2>Enumeration Members</h2>
<h3 class="tsd-anchor-link"><span>MAINNET</span><a href="#MAINNET" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></g></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">MAINNET</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;mainnet&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/6a8d797/src/enums/index.ts#L39">enums/index.ts:39</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/ad6f344/src/enums/index.ts#L39">enums/index.ts:39</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="TESTNET" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>TESTNET</span><a href="#TESTNET" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">TESTNET</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;testnet&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/6a8d797/src/enums/index.ts#L38">enums/index.ts:38</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/ad6f344/src/enums/index.ts#L38">enums/index.ts:38</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down Expand Up @@ -75,7 +75,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/BaseDiscountRecord.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Discount<wbr/>Record</span></a></li>
<li><a href="../interfaces/DiscountMetadata.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Discount<wbr/>Metadata</span></a></li>
<li><a href="../interfaces/DiscountRecord.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Discount<wbr/>Record</span></a></li>
<li><a href="../interfaces/ProductGlobalState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Product<wbr/>Global<wbr/>State</span></a></li>
<li><a href="../interfaces/ProductState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Product<wbr/>State</span></a></li>
<li><a href="../interfaces/SubscriptionRecord.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Subscription<wbr/>Record</span></a></li>
<li><a href="../variables/LOCKER_VERSION.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>LOCKER_<wbr/>VERSION</span></a></li>
<li><a href="../variables/ORACLE_VERSION.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>ORACLE_<wbr/>VERSION</span></a></li>
Expand Down
8 changes: 4 additions & 4 deletions enums/DiscountType.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<li><a href="DiscountType.html">DiscountType</a></li></ul>
<h1>Enumeration DiscountType</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/6a8d797/src/enums/index.ts#L32">enums/index.ts:32</a></li></ul></aside>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/ad6f344/src/enums/index.ts#L32">enums/index.ts:32</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">
Expand All @@ -33,12 +33,12 @@ <h2>Enumeration Members</h2>
<h3 class="tsd-anchor-link"><span>FIXED</span><a href="#FIXED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></g></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">FIXED</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/subtopia-algo/subtopia-js/blob/6a8d797/src/enums/index.ts#L34">enums/index.ts:34</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/ad6f344/src/enums/index.ts#L34">enums/index.ts:34</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="PERCENTAGE" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>PERCENTAGE</span><a href="#PERCENTAGE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">PERCENTAGE</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/subtopia-algo/subtopia-js/blob/6a8d797/src/enums/index.ts#L33">enums/index.ts:33</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/ad6f344/src/enums/index.ts#L33">enums/index.ts:33</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down Expand Up @@ -75,7 +75,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/BaseDiscountRecord.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Discount<wbr/>Record</span></a></li>
<li><a href="../interfaces/DiscountMetadata.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Discount<wbr/>Metadata</span></a></li>
<li><a href="../interfaces/DiscountRecord.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Discount<wbr/>Record</span></a></li>
<li><a href="../interfaces/ProductGlobalState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Product<wbr/>Global<wbr/>State</span></a></li>
<li><a href="../interfaces/ProductState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Product<wbr/>State</span></a></li>
<li><a href="../interfaces/SubscriptionRecord.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Subscription<wbr/>Record</span></a></li>
<li><a href="../variables/LOCKER_VERSION.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>LOCKER_<wbr/>VERSION</span></a></li>
<li><a href="../variables/ORACLE_VERSION.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>ORACLE_<wbr/>VERSION</span></a></li>
Expand Down
14 changes: 7 additions & 7 deletions enums/Duration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<li><a href="Duration.html">Duration</a></li></ul>
<h1>Enumeration Duration</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/6a8d797/src/enums/index.ts#L19">enums/index.ts:19</a></li></ul></aside>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/ad6f344/src/enums/index.ts#L19">enums/index.ts:19</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">
Expand All @@ -36,27 +36,27 @@ <h2>Enumeration Members</h2>
<h3 class="tsd-anchor-link"><span>ANNUAL</span><a href="#ANNUAL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></g></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">ANNUAL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">31536000</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/6a8d797/src/enums/index.ts#L24">enums/index.ts:24</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/ad6f344/src/enums/index.ts#L24">enums/index.ts:24</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="MONTH" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>MONTH</span><a href="#MONTH" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">MONTH</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2592000</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/6a8d797/src/enums/index.ts#L21">enums/index.ts:21</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/ad6f344/src/enums/index.ts#L21">enums/index.ts:21</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="QUARTER" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>QUARTER</span><a href="#QUARTER" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">QUARTER</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">7776000</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/6a8d797/src/enums/index.ts#L22">enums/index.ts:22</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/ad6f344/src/enums/index.ts#L22">enums/index.ts:22</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="SEMI_ANNUAL" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>SEMI_<wbr/>ANNUAL</span><a href="#SEMI_ANNUAL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">SEMI_<wbr/>ANNUAL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">15552000</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/6a8d797/src/enums/index.ts#L23">enums/index.ts:23</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/ad6f344/src/enums/index.ts#L23">enums/index.ts:23</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="UNLIMITED" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>UNLIMITED</span><a href="#UNLIMITED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">UNLIMITED</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/subtopia-algo/subtopia-js/blob/6a8d797/src/enums/index.ts#L20">enums/index.ts:20</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/subtopia-algo/subtopia-js/blob/ad6f344/src/enums/index.ts#L20">enums/index.ts:20</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down Expand Up @@ -96,7 +96,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/BaseDiscountRecord.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Discount<wbr/>Record</span></a></li>
<li><a href="../interfaces/DiscountMetadata.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Discount<wbr/>Metadata</span></a></li>
<li><a href="../interfaces/DiscountRecord.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Discount<wbr/>Record</span></a></li>
<li><a href="../interfaces/ProductGlobalState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Product<wbr/>Global<wbr/>State</span></a></li>
<li><a href="../interfaces/ProductState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Product<wbr/>State</span></a></li>
<li><a href="../interfaces/SubscriptionRecord.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Subscription<wbr/>Record</span></a></li>
<li><a href="../variables/LOCKER_VERSION.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>LOCKER_<wbr/>VERSION</span></a></li>
<li><a href="../variables/ORACLE_VERSION.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>ORACLE_<wbr/>VERSION</span></a></li>
Expand Down
Loading

0 comments on commit cac4229

Please sign in to comment.