@xoxno/sdk-js 0.0.2-alpha → 0.0.3-alpha

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xoxno/sdk-js",
-  "version": "0.0.2-alpha",
+  "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

@@ -20,6 +20,6 @@ describe('SCInteraction', () => {
     const tags = await sc.getStages('Elonverse');
     expect(tags).toBeDefined();
     // expect(tags).toContain('Elonverse');
-    console.log(tags);
+    // console.log(tags);
   });
 });

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/.github/workflows/npm-publish.yml

@@ -1,33 +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-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.vscode/settings.json

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