feat(component): add extra functions for launchpad module

Added interactions with the XOXNO Launchpad, creators can integrate their mint on other dApps via the SDK
XOXNO · Apr 3, 2023 · 1283158 · 1283158
1 parent c8df4ad
commit 1283158
Show file tree

Hide file tree

Showing 80 changed files with 940 additions and 696 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 node_modules
-dist
+dist
+coverage
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,2 @@
+docs
+coverage
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# XOXNO SDK
+
+XOXNO SDK is a JavaScript library that simplifies the interaction with the XOXNO Protocol for developers. It includes a set of helper functions and modules that make it easy to fetch, filter, and interact with data from the XOXNO Protocol and its NFT marketplace.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Initialization](#initialization)
+  - [Fetching Data](#fetching-data)
+  - [Interacting with the Smart Contract](#interacting-with-the-smart-contract)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+To install the XOXNO SDK, simply run the following command in your project's root directory:
+
+```bash
+npm install xoxno-sdk
+```
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -1,16 +1,16 @@
 :root {
-    --light-hl-0: #0000FF;
-    --dark-hl-0: #569CD6;
-    --light-hl-1: #000000;
-    --dark-hl-1: #D4D4D4;
-    --light-hl-2: #0070C1;
-    --dark-hl-2: #4FC1FF;
-    --light-hl-3: #795E26;
-    --dark-hl-3: #DCDCAA;
-    --light-hl-4: #001080;
-    --dark-hl-4: #9CDCFE;
-    --light-hl-5: #A31515;
-    --dark-hl-5: #CE9178;
+    --light-hl-0: #000000;
+    --dark-hl-0: #D4D4D4;
+    --light-hl-1: #A31515;
+    --dark-hl-1: #CE9178;
+    --light-hl-2: #0000FF;
+    --dark-hl-2: #569CD6;
+    --light-hl-3: #0070C1;
+    --dark-hl-3: #4FC1FF;
+    --light-hl-4: #795E26;
+    --dark-hl-4: #DCDCAA;
+    --light-hl-5: #001080;
+    --dark-hl-5: #9CDCFE;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }

diff --git a/docs/classes/collection.CollectionModule.html b/docs/classes/collection.CollectionModule.html
@@ -1,18 +1,18 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CollectionModule | xoxno-sdk-js</title><meta name="description" content="Documentation for xoxno-sdk-js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CollectionModule | @xoxno/sdk-js</title><meta name="description" content="Documentation for @xoxno/sdk-js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
 <div class="tsd-toolbar-contents container">
 <div class="table-cell" id="tsd-search" data-base="..">
 <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
 <div class="field">
 <div id="tsd-toolbar-links"></div></div>
 <ul class="results">
 <li class="state loading">Preparing search index...</li>
-<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xoxno-sdk-js</a></div>
+<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@xoxno/sdk-js</a></div>
 <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
 <div class="container container-main">
 <div class="col-8 col-content">
 <div class="tsd-page-title">
 <ul class="tsd-breadcrumb">
-<li><a href="../modules.html">xoxno-sdk-js</a></li>
+<li><a href="../modules.html">@xoxno/sdk-js</a></li>
 <li><a href="../modules/collection.html">collection</a></li>
 <li><a href="collection.CollectionModule.html">CollectionModule</a></li></ul>
 <h1>Class CollectionModule</h1></div>
@@ -21,15 +21,15 @@ <h1>Class CollectionModule</h1></div>
 It includes methods for getting collection profile information, floor price,
 collection attributes, and searching NFTs within a collection.</p>
 
-<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">xoxno</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">XOXNO</span><span class="hl-1">({ </span><span class="hl-4">apiURL:</span><span class="hl-1"> </span><span class="hl-5">&#39;https://api.xoxno.com&#39;</span><span class="hl-1">, </span><span class="hl-4">apiKey:</span><span class="hl-1"> </span><span class="hl-5">&#39;your-api-key&#39;</span><span class="hl-1"> });</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">collectionModule</span><span class="hl-1"> = </span><span class="hl-4">xoxno</span><span class="hl-1">.</span><span class="hl-4">collection</span><span class="hl-1">;</span>
+<h3>Example</h3><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">xoxno</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">XOXNO</span><span class="hl-0">({ </span><span class="hl-5">apiURL:</span><span class="hl-0"> </span><span class="hl-1">&#39;https://api.xoxno.com&#39;</span><span class="hl-0">, </span><span class="hl-5">apiKey:</span><span class="hl-0"> </span><span class="hl-1">&#39;your-api-key&#39;</span><span class="hl-0"> });</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">collectionModule</span><span class="hl-0"> = </span><span class="hl-5">xoxno</span><span class="hl-0">.</span><span class="hl-5">collection</span><span class="hl-0">;</span>
 </code></pre>
 </div></section>
 <section class="tsd-panel tsd-hierarchy">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">CollectionModule</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XOXNO/xoxno-sdk-js/blob/aa4ec71/src/collection/index.ts#L22">collection/index.ts:22</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/XOXNO/sdk-js/blob/c8df4ad/src/collection/index.ts#L22">collection/index.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">
@@ -60,14 +60,14 @@ <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <a href="collection.CollectionModule.html" class="tsd-signature-type" data-tsd-kind="Class">CollectionModule</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XOXNO/xoxno-sdk-js/blob/aa4ec71/src/collection/index.ts#L24">collection/index.ts:24</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/XOXNO/sdk-js/blob/c8df4ad/src/collection/index.ts#L24">collection/index.ts:24</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 tsd-is-private"><a id="api" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>api</span><a href="#api" 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">api<span class="tsd-signature-symbol">:</span> <a href="utils_api.APIClient.html" class="tsd-signature-type" data-tsd-kind="Class">APIClient</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XOXNO/xoxno-sdk-js/blob/aa4ec71/src/collection/index.ts#L23">collection/index.ts:23</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/XOXNO/sdk-js/blob/c8df4ad/src/collection/index.ts#L23">collection/index.ts:23</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="getCollectionAttributes" class="tsd-anchor"></a>
@@ -90,7 +90,7 @@ <h5>collection: <span class="tsd-signature-type">string</span></h5>
 </div></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="../interfaces/types_collection.ICollectionAttributes.html" class="tsd-signature-type" data-tsd-kind="Interface">ICollectionAttributes</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XOXNO/xoxno-sdk-js/blob/aa4ec71/src/collection/index.ts#L72">collection/index.ts:72</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/XOXNO/sdk-js/blob/c8df4ad/src/collection/index.ts#L72">collection/index.ts:72</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getCollectionFloorPrice" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>get<wbr/>Collection<wbr/>Floor<wbr/>Price</span><a href="#getCollectionFloorPrice" 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">
@@ -115,7 +115,7 @@ <h5>token: <span class="tsd-signature-type">string</span><span class="tsd-signat
 </div></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">number</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XOXNO/xoxno-sdk-js/blob/aa4ec71/src/collection/index.ts#L53">collection/index.ts:53</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/XOXNO/sdk-js/blob/c8df4ad/src/collection/index.ts#L53">collection/index.ts:53</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getCollectionProfile" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>get<wbr/>Collection<wbr/>Profile</span><a href="#getCollectionProfile" 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">
@@ -136,7 +136,7 @@ <h5>collection: <span class="tsd-signature-type">string</span></h5>
 </div></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="../interfaces/types_collection.ICollectionProfile.html" class="tsd-signature-type" data-tsd-kind="Interface">ICollectionProfile</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XOXNO/xoxno-sdk-js/blob/aa4ec71/src/collection/index.ts#L34">collection/index.ts:34</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/XOXNO/sdk-js/blob/c8df4ad/src/collection/index.ts#L34">collection/index.ts:34</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTradingActivity" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>get<wbr/>Trading<wbr/>Activity</span><a href="#getTradingActivity" 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">
@@ -157,7 +157,7 @@ <h5>args: <a href="../interfaces/types_trading.TradincActivityArgs.html" class="
 </div></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="../interfaces/types_trading.TradingActivityResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TradingActivityResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XOXNO/xoxno-sdk-js/blob/aa4ec71/src/collection/index.ts#L153">collection/index.ts:153</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/XOXNO/sdk-js/blob/c8df4ad/src/collection/index.ts#L153">collection/index.ts:153</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="searchNFTs" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>searchNFTs</span><a href="#searchNFTs" 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">
@@ -178,7 +178,7 @@ <h5>args: <a href="../interfaces/types_collection.SearchNFTsArgs.html" class="ts
 </div></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="../interfaces/types_collection.SearchNFTsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchNFTsResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XOXNO/xoxno-sdk-js/blob/aa4ec71/src/collection/index.ts#L90">collection/index.ts:90</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/XOXNO/sdk-js/blob/c8df4ad/src/collection/index.ts#L90">collection/index.ts:90</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">
@@ -198,7 +198,7 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
 <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
 <div class="tsd-accordion-details">
 <ul>
-<li class="current"><a href="../modules.html">xoxno-<wbr/>sdk-<wbr/>js</a>
+<li class="current"><a href="../modules.html">@xoxno/sdk-<wbr/>js</a>
 <ul>
 <li class="current tsd-kind-module"><a href="../modules/collection.html">collection</a></li>
 <li class="tsd-kind-module"><a href="../modules/interactions.html">interactions</a></li>