@xoxno/sdk-js 0.0.1 → 0.0.3-alpha

package/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
+```

package/dist/xoxno.min.js

@@ -0,0 +1 @@
+!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.XOXNO=e():t.XOXNO=e()}(self,(()=>(()=>{"use strict";var t={d:(e,o)=>{for(var i in o)t.o(o,i)&&!t.o(e,i)&&Object.defineProperty(e,i,{enumerable:!0,get:o[i]})},o:(t,e)=>Object.prototype.hasOwnProperty.call(t,e),r:t=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})}},e={};t.r(e),t.d(e,{XOXNO:()=>r});class o{static instance;apiUrl;apiKey;constructor(t,e){this.apiUrl=t,this.apiKey=e}static init(t,e){return o.instance||(o.instance=new o(t,e)),o.instance}static getClient(){if(!o.instance)throw new Error("APIClient has not been initialized");return o.instance}fetchWithTimeout=async(t,e={},o=4e4)=>{const i=new AbortController,{signal:n}=i,r=Math.round((new Date).getTime()/1e3),a=setTimeout((()=>{i.abort()}),o);let s;const c={"Accept-Encoding":"gzip,deflate,br","xo-time":`Sent-At:${r}`,Referer:"https://xoxno.dev","User-Agent":"XOXNO/1.0/SDK",..."POST"===e.method?{"Content-Type":"application/json"}:{},...e.headers??{}};try{if(s=await fetch(`${this.apiUrl}${t}${e.params?"?"+Object.keys(e.params).map((t=>`${t}=${encodeURIComponent(e.params[t])}`)).join("&"):""}`,{signal:n,...e,...Object.keys(c).length?{headers:c}:{},method:e.method??"GET"}),!s.ok){const t=await(s?.text());throw new Error(t)}return clearTimeout(a),await s.json()}catch(o){throw new Error("Something went wrong inside fetchWithTimeout "+t+" "+JSON.stringify(e)+" "+o)}}}const i=t=>/^[A-Z0-9]{3,10}-[a-z0-9]{6}$/.test(t);class n{api;constructor(){this.api=o.getClient()}getCollectionProfile=async t=>{if(!i(t))throw new Error("Invalid collection ticker: "+t);return await this.api.fetchWithTimeout(`/getCollectionProfile/${t}`)};getCollectionFloorPrice=async(t,e="EGLD")=>{if(!i(t))throw new Error("Invalid collection ticker: "+t);return await this.api.fetchWithTimeout(`/getFloorPrice/${t}/${e}`)};getCollectionAttributes=async t=>{if(!i(t))throw new Error("Invalid collection ticker: "+t);return await this.api.fetchWithTimeout(`/getCollectionAttributes/${t}`)};searchNFTs=async t=>{if(!i(t.collection))throw new Error("Invalid collection ticker: "+t.collection);if(t.top&&t.top>35)throw new Error("Top cannot be greater than 35");const e={filters:{onSale:t.onlyOnSale||!1,marketplace:t.listedOnlyOn||void 0,auctionTypes:t.onlyOnSale?t.onlyAuctions?["NftBid","SftAll"]:["Nft","SftOnePerPayment"]:void 0,tokens:t.listedInToken||void 0,attributes:t.attributes||void 0,range:t.priceRange?{...t.priceRange,type:t.onlyAuctions?"saleInfoNft/current_bid_short":"saleInfoNft/min_bid_short"}:void 0,rankRange:t.rankRange||void 0,levelRange:t.cantinaLevelRange||void 0},name:t.searchName||"",orderBy:t.orderBy||void 0,collection:t.collection,top:t.top||35,skip:t.skip||0},o=Buffer.from(JSON.stringify(e)).toString("base64"),n=await this.api.fetchWithTimeout(`/searchNFTs/${o}`);return{...n,getNextPagePayload:{...t,skip:(t.skip??0)+(t.top??35)},hasMoreResults:n.resultsCount>(t.skip??0)+(t.top??35)}};getTradingActivity=async t=>await(async(t,e)=>{if(t.top&&t.top>35)throw new Error("Top cannot be greater than 35");const o={filters:{collection:t.collections,identifier:t.identifier||void 0,address:t.owners||void 0,tokens:t.placedInToken||void 0,marketplace:t.marketplaces||void 0,action:t.actions||void 0,range:t.priceRange,rankRange:t.rankRange,timestampRange:t.timestampRange,attributes:t.attributes},orderBy:t.orderBy,select:t.select,top:t.top||35,skip:t.skip||0},i=Buffer.from(JSON.stringify(o)).toString("base64"),n=await e.fetchWithTimeout(`/getTradingActivity/${i}`);return{...n,getNextPagePayload:{...t,skip:(t.skip??0)+(t.top??35)},empty:0===n.resources.length}})(t,this.api)}class r{collection;constructor(t="https://proxy-api.xoxno.com",e=""){o.init(t,e),this.collection=new n}}return e})()));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xoxno/sdk-js",
-  "version": "0.0.1",
+  "version": "0.0.3-alpha",
   "description": "The SDK to interact with the XOXNO Protocol!",
   "main": "./src/index.ts",
   "scripts": {

package/src/collection/__tests__/collection.test.ts

@@ -1,12 +1,12 @@
 import { CollectionModule } from './../index';
 import { APIClient } from '../../utils/api';
-import { FieldsToSelect } from '../../types';
+import { CollectionsFieldsToSelect, FieldsToSelect } from '../../types';
 
 describe('CollectionModule', () => {
   let collectionModule: CollectionModule;
   const inputCollection = 'BANANA-e955fd';
   beforeAll(() => {
-    APIClient.init('https://api.xoxno.com', '');
+    APIClient.init('https://proxy-api.xoxno.com', '');
     collectionModule = new CollectionModule();
   });
 
@@ -16,6 +16,13 @@ describe('CollectionModule', () => {
     expect(result.collection).toEqual(inputCollection);
   });
 
+  test('getCollectionProfiles should return the correct results', async () => {
+    const collectionModule = new CollectionModule();
+    const result = await collectionModule.getCollections();
+    expect(result).toBeDefined();
+    expect(result.results).toHaveLength(25);
+  });
+
   it('should get the floor price of a collection', async () => {
     const floorPrice = await collectionModule.getCollectionFloorPrice(
       inputCollection

package/src/collection/index.ts

@@ -1,4 +1,6 @@
 import {
+  CollectionsNFTsResponse,
+  GetCollectionsArgs,
   ICollectionAttributes,
   ICollectionProfile,
   SearchNFTs,
@@ -83,8 +85,8 @@ export class CollectionModule {
 
   /**
    * Searches for NFTs in a collection based on the provided arguments.
-   * @param args - The SearchNFTsArgs object containing the search parameters.
-   * @returns A Promise that resolves to the SearchNFTsResponse object.
+   * @param {SearchNFTsArgs} args - The SearchNFTsArgs object containing the search parameters.
+   * @returns {Promise<SearchNFTsResponse>} A Promise that resolves to the SearchNFTsResponse object.
    * @throws An error if the provided collection ticker is invalid or if the 'top' value is greater than 35.
    */
   public searchNFTs = async (
@@ -155,4 +157,48 @@ export class CollectionModule {
   ): Promise<TradingActivityResponse> => {
     return await getActivity(args, this.api);
   };
+
+  /**
+   * Searches for NFTs in a collection based on the provided arguments.
+   * @param {GetCollectionsArgs} args - The SearchNFTsArgs object containing the search parameters.
+   * @returns {Promise<CollectionsNFTsResponse>} A Promise that resolves to the CollectionsNFTsResponse object.
+   * @throws An error if the provided collection ticker is invalid or if the 'top' value is greater than 35.
+   */
+  public getCollections = async (
+    args?: GetCollectionsArgs
+  ): Promise<CollectionsNFTsResponse> => {
+    if (args?.top && args.top > 25) {
+      throw new Error('Top cannot be greater than 25');
+    }
+
+    const payloadBody = {
+      skip: args?.skip || 0,
+      top: args?.top || 25,
+      select: args?.onlySelectFields || [],
+      filters: {
+        dataType: 'collectionProfile',
+        isMintable: args?.onlyMintable || undefined,
+        ...(args?.collections &&
+          args.collections.length > 0 && {
+            collection: args.collections,
+          }),
+      },
+      orderBy: [args?.orderBy || 'statistics.tradeData.weekEgldVolume desc'],
+    };
+
+    const buffer = Buffer.from(JSON.stringify(payloadBody)).toString('base64');
+    const response = await this.api.fetchWithTimeout<ICollectionProfile[]>(
+      `/collections/${buffer}`
+    );
+    return {
+      results: response,
+      resultsCount: response.length,
+      empty: response.length === 0,
+      getNextPagePayload: {
+        ...args,
+        skip: (args?.skip || 0) + (args?.top || 25),
+      },
+      hasMoreResults: response.length < (args?.top || 25),
+    };
+  };
 }

package/src/launchpad/__tests__/market.test.ts

@@ -0,0 +1,25 @@
+import { LaunchpadModule } from '../index';
+import { APIClient } from '../../utils/api';
+
+describe('SCInteraction', () => {
+  let sc: LaunchpadModule;
+  beforeAll(async () => {
+    APIClient.init();
+    sc = await LaunchpadModule.init(
+      'erd1qqqqqqqqqqqqqpgqtwtp5uz97u232zvzd973upqxwe2xnqv2ys5s3c7jx9'
+    );
+  });
+
+  it('should return all the unique tags of the launchpad SC', async () => {
+    const tags = await sc.getAllUniqueTags();
+    expect(tags).toBeDefined();
+    expect(tags).toContain('Elonverse');
+  });
+
+  it('should return all the unique stages of a collection from the launchpad SC', async () => {
+    const tags = await sc.getStages('Elonverse');
+    expect(tags).toBeDefined();
+    // expect(tags).toContain('Elonverse');
+    // console.log(tags);
+  });
+});

package/src/launchpad/index.ts

@@ -0,0 +1,166 @@
+import { SmartContract, Address, Interaction } from '@multiversx/sdk-core/out';
+import { SmartContractAbis } from '../utils/SmartContractAbis';
+import { getSmartContract } from '../utils/SmartContractService';
+import { ContractQueryRunner } from '../utils/scCalls';
+
+/**
+ * LaunchpadModule provides methods to interact with the minter smart contract.
+ * @class
+ */
+export class LaunchpadModule {
+  private minter: SmartContract;
+  private call: ContractQueryRunner;
+  /**
+   * @constructor
+   * @param {SmartContract} minterAbiXOXNO - The minter smart contract instance.
+   */
+  constructor(minterAbiXOXNO: SmartContract) {
+    this.minter = minterAbiXOXNO;
+    this.call = new ContractQueryRunner();
+  }
+
+  /**
+   * Executes the provided interaction and returns the result.
+   * @private
+   * @param {Interaction} interaction - The smart contract interaction.
+   * @returns {Promise<any>} The result of the interaction.
+   */
+  private async getResult(interaction: Interaction) {
+    return await this.call.runQuery(this.minter, interaction);
+  }
+
+  /**
+   * Initializes the LaunchpadModule with a minter smart contract instance.
+   * @static
+   * @param {string} minterSC - The minter smart contract address.
+   * @returns {Promise<LaunchpadModule>} A new instance of LaunchpadModule.
+   */
+  static async init(minterSC: string) {
+    const minterAbiXOXNO = await SmartContractAbis.getMinter();
+    const minter_abi = getSmartContract(
+      minterAbiXOXNO,
+      new Address(minterSC),
+      'Minter'
+    );
+    return new LaunchpadModule(minter_abi);
+  }
+
+  /**
+   * Fetches all unique tags from the minter smart contract.
+   * @public
+   * @returns {Promise<string[]>} An array of unique tags.
+   */
+  public getAllUniqueTags = async (): Promise<string[]> => {
+    const interaction = this.minter.methods.collections();
+    const result = await this.getResult(interaction);
+    return result.firstValue?.valueOf().map((x: any) => x.toString());
+  };
+
+  /**
+   * Fetches the global buy count for a user and tag.
+   * @public
+   * @param {string} user - The user's address.
+   * @param {string} tag - The tag.
+   * @returns {Promise<number>} The global buy count.
+   */
+  public getWalletGlobalBuyCount = async (
+    user: string,
+    tag: string
+  ): Promise<number> => {
+    const interaction = this.minter.methods.buysPerWallet([user, tag]);
+    const result = await this.getResult(interaction);
+    return result.firstValue?.valueOf();
+  };
+
+  /**
+   * Fetches the stage buy count for a user, tag, and stage.
+   * @public
+   * @param {string} user - The user's address.
+   * @param {string} tag - The tag.
+   * @param {string} stage - The stage.
+   * @returns {Promise<number>} The stage buy count.
+   */
+  public getWalletStageBuyCount = async (
+    user: string,
+    tag: string,
+    stage: string
+  ): Promise<number> => {
+    const interaction = this.minter.methods.buysStagePerWallet([
+      user,
+      tag,
+      stage,
+    ]);
+    const result = await this.getResult(interaction);
+    return result.firstValue?.valueOf();
+  };
+
+  /**
+   * Fetches the local owner's address from the minter smart contract.
+   * @public
+   * @returns {Promise<string>} The local owner's address.
+   */
+  public getLocalOwner = async (): Promise<string> => {
+    const interaction = this.minter.methods.localOwner();
+    const result = await this.getResult(interaction);
+    return result.firstValue?.valueOf();
+  };
+
+  /**
+   * Fetches the launchpad cut fee percentage from the minter smart contract.
+   * @public
+   * @returns {Promise<number>} The launchpad cut fee percentage.
+   */
+
+  public getLaunchpadCutFee = async (): Promise<number> => {
+    const interaction = this.minter.methods.cutPercentage();
+    const result = await this.getResult(interaction);
+    return result.firstValue?.valueOf();
+  };
+
+  /**
+   * Fetches the stage whitelist of wallets for a tag and stage.
+   * @public
+   * @param {string} tag - The tag.
+   * @param {string} stage - The stage.
+   * @returns {Promise<string[]>} An array of whitelisted wallet addresses.
+   */
+  public getStageWhitelist = async (
+    tag: string,
+    stage: string
+  ): Promise<string[]> => {
+    const interaction = this.minter.methods.getWhitelistedWallets([tag, stage]);
+    const result = await this.getResult(interaction);
+    return result.firstValue?.valueOf().map((x: any) => x.toString());
+  };
+
+  /**
+   * Fetches the list of stages for a tag.
+   * @public
+   * @param {string} tag - The tag.
+   * @returns {Promise<string[]>} An array of stages.
+   */
+  public getStages = async (tag: string): Promise<string[]> => {
+    const interaction = this.minter.methods.mintStage([tag]);
+    const result = await this.getResult(interaction);
+    return result.firstValue?.valueOf().map((x: any) => {
+      const body = x[1].valueOf();
+      body.name = body.name.toString();
+      body.tag = body.name.toString();
+      body.start_time = parseInt(body.start_time.toString());
+      body.end_time = parseInt(body.end_time.toString());
+      body.mint_limit = parseInt(body.mint_limit.toString());
+      body.mint_count = parseInt(body.mint_count.toString());
+      body.max_per_wallet = parseInt(body.max_per_wallet.toString());
+      body.prices = body.prices.map((x: any) => {
+        const pr = x.valueOf();
+        return {
+          ...pr,
+          token_nonce: parseInt(pr.token_nonce.toString()),
+          amount: pr.amount.toString(),
+        };
+      });
+
+      return body;
+    });
+  };
+}

package/src/types/collection.d.ts

@@ -155,6 +155,43 @@ export const enum SearchOrderBy {
   OldestListed = 'saleInfoNft/timestamp asc',
 }
 
+export const enum CollectionsOrderBy {
+  WeekVolumeHighToLow = 'statistics.tradeData.weekEgldVolume desc',
+  WeekVolumeLowToHigh = 'statistics.tradeData.weekEgldVolume asc',
+  DailyVolumeHighToLow = 'statistics.tradeData.dayEgldVolume desc',
+  DailyVolumeLowToHigh = 'statistics.tradeData.dayEgldVolume asc',
+  TotalVolumeHighToLow = 'statistics.tradeData.totalEgldVolume desc',
+  TotalVolumeLowToHigh = 'statistics.tradeData.totalEgldVolume asc',
+  AvgVolumePriceHighToLow = 'statistics.tradeData.averageEgldPrice desc',
+  AvgVolumePriceLowToHigh = 'statistics.tradeData.averageEgldPrice asc',
+  ATHHighToLow = 'statistics.tradeData.athEgldPrice desc',
+  ATHLowToHigh = 'statistics.tradeData.athEgldPrice asc',
+  TotalTradesHighToLow = 'statistics.tradeData.totalTrades desc',
+  TotalTradesLowToHigh = 'statistics.tradeData.totalTrades asc',
+  SupplyHighToLow = 'statistics.other.nftCount desc',
+  SupplyLowToHigh = 'statistics.other.nftCount asc',
+  FollowersHighToLow = 'statistics.other.followCount desc',
+  FollowersLowToHigh = 'statistics.other.followCount asc',
+}
+
+export const enum CollectionsFieldsToSelect {
+  Profile = 'profile',
+  Description = 'description',
+  Creator = 'creator',
+  Owner = 'owner',
+  Socials = 'socials',
+  Type = 'type',
+  HasStaking = 'hasStaking',
+  MintInfo = 'mintInfo',
+  MintStages = 'mintStages',
+  Name = 'name',
+  Banner = 'banner',
+  IsVerified = 'isVerified',
+  IsMintable = 'isMintable',
+  Statistics = 'statistics',
+  Collection = 'collection',
+}
+
 export interface Filter {
   marketplace?: Marketplace[];
   onSale?: boolean;
@@ -265,3 +302,31 @@ export interface TradingActivity {
   webpUrl: string;
   _ts: number;
 }
+
+export interface GetCollectionsArgs {
+  /**  The collections to fetch the profile */
+  collections?: string[];
+  /** If true, will return only NFTs that are mintable */
+  onlyMintable?: boolean;
+  /** The number of results to return */
+  top?: number;
+  /** The order by to use */
+  skip?: number;
+  /** The order of the results based on a field */
+  orderBy?: CollectionsOrderBy;
+  /** If set, will return only the specified fields */
+  onlySelectFields?: CollectionsFieldsToSelect[];
+}
+
+export interface CollectionsNFTsResponse {
+  /** The results count for the current page */
+  resultsCount: number;
+  /** The results for the current page */
+  results: ICollectionProfile[];
+  /** If the results are empty */
+  empty: boolean;
+  /** The payload to use to get the next page */
+  getNextPagePayload: GetCollectionsArgs;
+  /** If there are more results to fetch */
+  hasMoreResults: boolean;
+}

package/.github/workflows/npm-publish-github-packages.yml

@@ -1,36 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - run: npm ci
-      - run: npm test
-
-  publish-gpr:
-    needs: build
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://npm.pkg.github.com/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/.vscode/settings.json

@@ -1,3 +0,0 @@
-{
-    "livePreview.defaultPreviewPath": "/docs/index.html"
-}