Refreshing documentation 🚀

subtopia-algo · Nov 28, 2023 · 7e3b3c3 · 7e3b3c3
1 parent 7404bae
commit 7e3b3c3
Show file tree

Hide file tree

Showing 36 changed files with 79 additions and 79 deletions.
diff --git a/classes/SubtopiaClient.html b/classes/SubtopiaClient.html
diff --git a/classes/SubtopiaRegistryClient.html b/classes/SubtopiaRegistryClient.html
diff --git a/enums/ChainType.html b/enums/ChainType.html
diff --git a/enums/DiscountType.html b/enums/DiscountType.html
diff --git a/enums/Duration.html b/enums/Duration.html
diff --git a/enums/LifecycleState.html b/enums/LifecycleState.html
diff --git a/enums/LockerType.html b/enums/LockerType.html
diff --git a/enums/PriceNormalizationType.html b/enums/PriceNormalizationType.html
diff --git a/enums/SubscriptionType.html b/enums/SubscriptionType.html
diff --git a/functions/SUBTOPIA_REGISTRY_ID.html b/functions/SUBTOPIA_REGISTRY_ID.html
diff --git a/functions/durationToMonths.html b/functions/durationToMonths.html
diff --git a/functions/getLockerBoxPrefix.html b/functions/getLockerBoxPrefix.html
diff --git a/functions/normalizePrice.html b/functions/normalizePrice.html
diff --git a/functions/optInAsset.html b/functions/optInAsset.html
diff --git a/functions/optOutAsset.html b/functions/optOutAsset.html
diff --git a/index.html b/index.html
@@ -22,7 +22,7 @@
 </ul>
 <a id="md:📦-installation" class="tsd-anchor"></a><h2><a href="#md:📦-installation">📦 Installation</a></h2><a id="md:install-the-package" class="tsd-anchor"></a><h3><a href="#md:install-the-package">Install the package:</a></h3><pre><code class="language-bash"><span class="hl-0"># with npm</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">subtopia-js-sdk</span><br/><br/><span class="hl-0"># or with yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">subtopia-js-sdk</span>
 </code><button>Copy</button></pre>
-<a id="md:import-the-package" class="tsd-anchor"></a><h3><a href="#md:import-the-package">Import the package:</a></h3><pre><code class="language-ts"><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">SubtopiaClient</span><span class="hl-2">, </span><span class="hl-5">SubtopiaRegistryClient</span><span class="hl-2">, </span><span class="hl-5">ChainType</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&quot;subtopia-js-sdk&quot;</span><span class="hl-2">;</span>
+<a id="md:import-the-package" class="tsd-anchor"></a><h3><a href="#md:import-the-package">Import the package:</a></h3><pre><code class="language-ts"><span class="hl-4">import</span><span class="hl-2"> {</span><br/><span class="hl-2">  </span><span class="hl-5">SubtopiaClient</span><span class="hl-2">,</span><br/><span class="hl-2">  </span><span class="hl-5">SubtopiaRegistryClient</span><span class="hl-2">,</span><br/><span class="hl-2">  </span><span class="hl-5">ChainType</span><span class="hl-2">,</span><br/><span class="hl-2">} </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&quot;subtopia-js-sdk&quot;</span><span class="hl-2">;</span>
 </code><button>Copy</button></pre>
 <a id="md:🛠️-usage" class="tsd-anchor"></a><h2><a href="#md:🛠️-usage">🛠️ Usage</a></h2><p>Example snippets of using the Subtopia JS SDK.</p>
 <a id="md:subscriptions" class="tsd-anchor"></a><h3><a href="#md:subscriptions"><strong>Subscriptions</strong></a></h3><a id="md:purchasing-a-subscription" class="tsd-anchor"></a><h3><a href="#md:purchasing-a-subscription">Purchasing a subscription:</a></h3><pre><code class="language-ts"><span class="hl-0">// ... your code</span><br/><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">subtopiaClient</span><span class="hl-2"> = </span><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-5">SubtopiaClient</span><span class="hl-2">.</span><span class="hl-1">init</span><span class="hl-2">({</span><br/><span class="hl-2">  </span><span class="hl-5">algodClient:</span><span class="hl-2"> </span><span class="hl-7">PUT_ALGOD_INSTANCE_HERE</span><span class="hl-2">,</span><br/><span class="hl-2">  </span><span class="hl-5">chainType:</span><span class="hl-2"> </span><span class="hl-7">PUT_CHAIN_TYPE_ENUM_HERE</span><span class="hl-2"> </span><span class="hl-0">// &#39;testnet&#39;|&#39;mainnet&#39;|&#39;localnet&#39;</span><br/><span class="hl-2">  </span><span class="hl-5">productID</span><span class="hl-2">: </span><span class="hl-7">PUT_PRODUCT_ID_HERE</span><span class="hl-2">,</span><br/><span class="hl-2">  </span><span class="hl-5">creator:</span><span class="hl-2"> { </span><span class="hl-5">addr:</span><span class="hl-2"> </span><span class="hl-7">PUT_WALLET_ADDRESS</span><span class="hl-2">, </span><span class="hl-5">signer:</span><span class="hl-2"> </span><span class="hl-7">PUT_WALLET_SIGNER</span><span class="hl-2"> },</span><br/><span class="hl-2">});</span><br/><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">response</span><span class="hl-2"> = </span><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-5">subtopiaClient</span><span class="hl-2">.</span><span class="hl-1">createSubscription</span><span class="hl-2">(</span><br/><span class="hl-2">  { </span><span class="hl-5">addr:</span><span class="hl-2"> </span><span class="hl-7">PUT_WALLET_ADDRESS</span><span class="hl-2">, </span><span class="hl-5">signer:</span><span class="hl-2"> </span><span class="hl-7">PUT_WALLET_SIGNER</span><span class="hl-2"> },</span><br/><span class="hl-2">  </span><span class="hl-7">PUT_DURATION_HERE</span><span class="hl-2"> </span><span class="hl-0">// pick duration from Duration enum. If there is a discount available for this duration, it will be auto applied.</span><br/><span class="hl-2">);</span><br/><br/><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">response</span><span class="hl-2">.</span><span class="hl-5">txID</span><span class="hl-2">); </span><span class="hl-0">// response is of type string</span><br/><br/><span class="hl-0">// ... rest of your code</span>

diff --git a/interfaces/ApplicationSpec.html b/interfaces/ApplicationSpec.html
diff --git a/interfaces/AssetMetadata.html b/interfaces/AssetMetadata.html
diff --git a/interfaces/BaseDiscountRecord.html b/interfaces/BaseDiscountRecord.html
diff --git a/interfaces/DiscountMetadata.html b/interfaces/DiscountMetadata.html
diff --git a/interfaces/DiscountRecord.html b/interfaces/DiscountRecord.html
diff --git a/interfaces/ProductState.html b/interfaces/ProductState.html
diff --git a/interfaces/SubscriptionRecord.html b/interfaces/SubscriptionRecord.html
diff --git a/variables/DEFAULT_TXN_SIGN_TIMEOUT_SECONDS.html b/variables/DEFAULT_TXN_SIGN_TIMEOUT_SECONDS.html
diff --git a/variables/LOCKER_APPROVAL_KEY.html b/variables/LOCKER_APPROVAL_KEY.html
diff --git a/variables/LOCKER_CLEAR_KEY.html b/variables/LOCKER_CLEAR_KEY.html
diff --git a/variables/LOCKER_VERSION.html b/variables/LOCKER_VERSION.html
diff --git a/variables/LOCKER_VERSION_KEY.html b/variables/LOCKER_VERSION_KEY.html
diff --git a/variables/ORACLE_VERSION.html b/variables/ORACLE_VERSION.html
diff --git a/variables/PRODUCT_APPROVAL_KEY.html b/variables/PRODUCT_APPROVAL_KEY.html
diff --git a/variables/PRODUCT_CLEAR_KEY.html b/variables/PRODUCT_CLEAR_KEY.html
diff --git a/variables/PRODUCT_VERSION.html b/variables/PRODUCT_VERSION.html
diff --git a/variables/PRODUCT_VERSION_KEY.html b/variables/PRODUCT_VERSION_KEY.html
diff --git a/variables/REGISTRY_VERSION.html b/variables/REGISTRY_VERSION.html
diff --git a/variables/SUBTOPIA_MAINNET.html b/variables/SUBTOPIA_MAINNET.html
diff --git a/variables/SUBTOPIA_TESTNET.html b/variables/SUBTOPIA_TESTNET.html