@xoxno/sdk-js 0.0.6-alpha → 0.0.7-alpha

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

@@ -1,25 +0,0 @@
-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

@@ -1,163 +0,0 @@
-import type { Interaction } from '@multiversx/sdk-core/out/smartcontracts/interaction';
-import { SmartContractAbis } from '../utils/SmartContractAbis';
-import { getSmartContract } from '../utils/SmartContractService';
-import { ContractQueryRunner } from '../utils/scCalls';
-import type { SmartContract } from '@multiversx/sdk-core/out/smartcontracts/smartContract';
-
-/**
- * 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, minterSC);
-    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/nft/__tests__/nft.test.ts

@@ -1,84 +0,0 @@
-import { NFTModule } from '../index';
-import { APIClient } from '../../utils/api';
-import { OrderByTradingActivity } from '../../types';
-
-describe('NFTModule', () => {
-  let nftModule: NFTModule;
-  const inputIdentifier = 'BANANA-e955fd-01';
-  const collection = 'BANANA-e955fd';
-  const nonce = 1;
-  const nonceHex = '01';
-  beforeAll(() => {
-    APIClient.init();
-    nftModule = new NFTModule();
-  });
-
-  it('should return NFT data when given a valid identifier', async () => {
-    const nftData = await nftModule.getNFTByIdentifier(inputIdentifier);
-    expect(nftData).toBeDefined();
-    expect(nftData.identifier).toEqual(inputIdentifier);
-  });
-
-  it('should return NFT data when given a valid collection and nonce', async () => {
-    const nftData = await nftModule.getNFTByCollectionAndNonce(
-      collection,
-      nonce
-    );
-    expect(nftData).toBeDefined();
-    expect(nftData.identifier).toEqual(inputIdentifier);
-  });
-
-  it('should return NFT data when given a valid collection and nonce as hex', async () => {
-    const nftData = await nftModule.getNFTByCollectionAndNonceHex(
-      collection,
-      nonceHex
-    );
-    expect(nftData).toBeDefined();
-    expect(nftData.identifier).toEqual(inputIdentifier);
-  });
-
-  it('should return empty NFT trading activity', async () => {
-    const nftTradingActivity = await nftModule.getTradingActivity({
-      identifiers: [inputIdentifier],
-    });
-    expect(nftTradingActivity).toBeDefined();
-    expect(nftTradingActivity.empty).toEqual(true);
-  });
-
-  it('should return NFT trading activity', async () => {
-    const nftTradingActivity = await nftModule.getTradingActivity({
-      identifiers: ['BANANA-e955fd-05d9'],
-      orderBy: [OrderByTradingActivity.OldestPlaced],
-      top: 1,
-    });
-    expect(nftTradingActivity).toBeDefined();
-    expect(nftTradingActivity.empty).toEqual(false);
-    expect(nftTradingActivity.resources.length).toEqual(1);
-    expect(nftTradingActivity.resources[0]).toMatchObject({
-      txHash:
-        'f2cc0f9abbe6e18855cec144cecee5a6e7e0fdf2249a7e2b487935c4630aec3d',
-      collection: 'BANANA-e955fd',
-      identifier: 'BANANA-e955fd-05d9',
-      timestamp: 1642523586,
-      action: 'buy',
-      price: 0.1,
-      paymentToken: 'EGLD',
-      buyer: 'erd1ecae8gpcsf5fk9na69my54c4t3dw27pdgk009huaj0ekjcp02u4qtw9e9d',
-      seller: 'erd1kkp6kcs5qpmfmcs4vj4v07kq750anpdz579mh2962r2suum2hfjsfrdaav',
-      usdPrice: 17.24,
-      egldValue: 0.1,
-      name: 'Banana #1497',
-      url: 'https://media.elrond.com/nfts/asset/QmZzdYmNtQw5F8WGY4eFmyqcFcziPa73DMSypMJWTxRdqa/1337.png',
-      avifUrl:
-        'https://trustmarket.blob.core.windows.net/nftmedia/BANANA-e955fd/BANANA-e955fd-05d9.avif',
-      webpUrl:
-        'https://trustmarket.blob.core.windows.net/nftmedia/BANANA-e955fd/BANANA-e955fd-05d9.webp',
-      rank: 480,
-      marketplace: 'XO',
-      id: '4505a7ae-eab9-4591-9f81-81671e63a9a3',
-      _ts: 1677342781,
-      sellerUsername: '@denysvicol',
-      buyerUsername: '@stefanmorar',
-    });
-  });
-});

package/src/nft/index.ts

@@ -1,98 +0,0 @@
-import { NftData } from '../types/nft';
-import { TradingActivityResponse, TradincActivityArgs } from '../types/trading';
-import { APIClient } from '../utils/api';
-import { getActivity } from '../utils/getActivity';
-import { getIdentifierFromColAndNonce } from '../utils/helpers';
-import { isValidCollectionTicker, isValidNftIdentifier } from '../utils/regex';
-
-/**
- * NFTModule provides a set of methods to interact with single NFTs.
- * It includes methods for getting single NFT information, and searching NFTs by collection and nonce.
- *
- * @example
- * const xoxno = new XOXNO({ apiURL: 'https://api.xoxno.com', apiKey: 'your-api-key' });
- * const nftModule = xoxno.nft;
- */
-
-export class NFTModule {
-  private api: APIClient;
-  constructor() {
-    this.api = APIClient.getClient();
-  }
-
-  /**
-   * Get the NFT data for the specified identifier.
-   * @param identifier The NFT identifier. Must be a valid NFT identifier.
-   * @returns {Promise<NftData>} The NFT data.
-   */
-  public getNFTByIdentifier = async (identifier: string): Promise<NftData> => {
-    if (!isValidNftIdentifier(identifier)) {
-      throw new Error('Invalid identifier: ' + identifier);
-    }
-    const response = await this.api.fetchWithTimeout<NftData>(
-      `/nfts/${identifier}`
-    );
-    return response;
-  };
-
-  /**
-   * Gets an NFT by collection and nonce.
-   * @param collection The collection ticker.
-   * @param nonce The nonce of the NFT.
-   * @returns {Promise<NftData>} The NFT data.
-   * @throws Throws an error when the collection ticker is invalid.
-   */
-  public getNFTByCollectionAndNonce = async (
-    collection: string,
-    nonce: number
-  ): Promise<NftData> => {
-    if (!isValidCollectionTicker(collection)) {
-      throw new Error('Invalid collection ticker: ' + collection);
-    }
-
-    const response = await this.api.fetchWithTimeout<NftData>(
-      `/nfts/${getIdentifierFromColAndNonce(collection, nonce)}`
-    );
-    return response;
-  };
-
-  /**
-   * Get NFT by collection and nonce hex
-   *
-   * @param collection - collection ticker
-   * @param nonceHex - nonce hex
-   * @return {Promise<NftData>} NFT data
-   */
-
-  public getNFTByCollectionAndNonceHex = async (
-    collection: string,
-    nonceHex: string
-  ): Promise<NftData> => {
-    // check that collection is valid
-    if (!isValidCollectionTicker(collection)) {
-      throw new Error('Invalid collection ticker: ' + collection);
-    }
-    // make sure nonceHex is even
-    if (nonceHex.length % 2 !== 0) {
-      nonceHex = '0' + nonceHex;
-    }
-    // fetch the NFT data
-    const response = await this.api.fetchWithTimeout<NftData>(
-      `/nfts/${[collection, nonceHex].join('-')}`
-    );
-    return response;
-  };
-
-  /**
-   * Retrieves trading history based on the provided arguments.
-   *
-   * @param {TradincActivityArgs} args - The arguments for filtering the trading activity.
-   * @returns {Promise<TradingActivityResponse>} A promise resolving to a TradingActivityResponse object containing the activity.
-   * @throws {Error} Throws an error if the 'top' argument is greater than 35.
-   */
-  public getTradingActivity = async (
-    args: TradincActivityArgs
-  ): Promise<TradingActivityResponse> => {
-    return await getActivity(args, this.api);
-  };
-}

package/src/types/collection.ts

@@ -1,332 +0,0 @@
-import { NftData } from './nft';
-
-export interface ISocials {
-  twitter: string;
-  instagram: string;
-  website: string;
-  telegram: string;
-  discord: string;
-  facebook: string;
-  youtube: string;
-}
-
-export interface IMintInfo {
-  contractAddress: string;
-  totalNftMinted: number;
-  collectionTag: string;
-  cid: string;
-  mediaType: string;
-  collectionSize: number;
-  nftTransferLimited: string;
-  allowsPublicBurn: string;
-  kycRequired: string;
-  allowsRefund: string;
-  hasReveal: string;
-}
-
-export interface ICollectionProfile {
-  dataType: 'collectionProfile';
-  collection: string;
-  name: string;
-  description: string;
-  isVisible: boolean;
-  isVerified: boolean;
-  profile: string;
-  banner: string;
-  statistics: {
-    tradeData: {
-      dayEgldVolume: number;
-      weekEgldVolume: number;
-      totalEgldVolume: number;
-      averageEgldPrice: number;
-      athEgldPrice: number;
-      athTxHash: string;
-      totalTrades: number;
-    };
-    mintData: {
-      totalMintEgldVolume: number;
-      weekMintEgldVolume: number;
-      dayMintEgldVolume: number;
-    };
-    other: {
-      nftCount: number;
-      followCount: number;
-      holdersCount?: number;
-    };
-  };
-  owner: string;
-  creator: string;
-  isMintable: boolean;
-  mintInfo: IMintInfo;
-  mintStages: {
-    name: string;
-    collectionTag: string;
-    mintEnabled: boolean;
-    isWhitelist: boolean;
-    startTime: number;
-    endTime: number;
-    mintLimit: number;
-    mintCount: number;
-    prices: {
-      tokenIdentifier: string;
-      tokenNonce: string;
-      amount: string;
-    }[];
-    walletLimit: number;
-  }[];
-  hasStaking: boolean;
-  id: string;
-  socials: ISocials;
-  type: string;
-  lastVerifiedTimestamp: number;
-  lastVerifiedBy: string;
-  _ts: number;
-}
-
-export interface AttributeData {
-  attributeOccurrence: number;
-  FloorPrice: number;
-  OnSale: number;
-}
-
-export interface MetadataAttribute {
-  trait_type: string;
-  value: string;
-}
-
-export interface TraitValues {
-  [traitValue: string]: AttributeData;
-}
-
-export interface ICollectionAttributes {
-  [traitType: string]: TraitValues;
-}
-export enum Marketplace {
-  XO = 'XO',
-  FM = 'FM',
-  DR = 'DR',
-  KG = 'KG',
-}
-
-export interface GlobalOffer {
-  attributes: MetadataAttribute[];
-  collection: string;
-  isActive: boolean;
-  marketplace: string;
-  offer_id: number;
-  owner: string;
-  ownerProfile?: string;
-  ownerUsername?: string;
-  payment_nonce: number;
-  payment_token: string;
-  price: string;
-  quantity: number;
-  short_price: number;
-  timestamp: number;
-}
-
-export enum FieldsToSelect {
-  Rank = 'metadata/rarity/rank',
-  Attributes = 'metadata/attributes',
-  Description = 'metadata/description',
-  Name = 'name',
-  OnSale = 'onSale',
-  SaleInfo = 'saleInfoNft',
-  Royalties = 'royalties',
-  Identifier = 'identifier',
-  Collection = 'collection',
-  OriginalURL = 'url',
-  Nonce = 'nonce',
-  ContentType = 'originalMedia/contentType',
-  WasProcessed = 'wasProcessed',
-  AvifURL = 'avifUrl',
-  WebpURL = 'webpUrl',
-  Type = 'type',
-}
-
-export enum SearchOrderBy {
-  PriceHighToLow = 'saleInfoNft/min_bid_short desc',
-  PriceLowToHigh = 'saleInfoNft/min_bid_short asc',
-  RarityHighToLow = 'metadata/rarity/rank desc',
-  RarityLowToHigh = 'metadata/rarity/rank asc',
-  NonceHighToLow = 'nonce desc',
-  NonceLowToHigh = 'nonce asc',
-  RecentListed = 'saleInfoNft/timestamp desc',
-  OldestListed = 'saleInfoNft/timestamp asc',
-}
-
-export 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 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;
-  auctionTypes?: string[];
-  tokens?: string[];
-  attributes?: MetadataAttribute[];
-  range?: {
-    min: number;
-    max: number;
-    type: string;
-  };
-  rankRange?: {
-    min?: number;
-    max?: number;
-  };
-  levelRange?: {
-    min?: number;
-    max?: number;
-  };
-}
-
-export interface SearchNFTs {
-  filters: Filter;
-  name?: string;
-  orderBy?: SearchOrderBy[];
-  collection: string;
-  top: number;
-  skip: number;
-  select?: FieldsToSelect[];
-}
-
-export interface SearchNFTsArgs {
-  /**  The collection to search in */
-  collection: string;
-  /** If true, will return only NFTs that are on sale */
-  onlyOnSale?: boolean;
-  /** If true, will return only NFTs that are on auction */
-  onlyAuctions?: boolean;
-  /** If set, will return only NFTs with a price in the specified range */
-  priceRange?: {
-    min: number;
-    max: number;
-  };
-  /** If set, will return only NFTs listed in the specified tokens */
-  listedInToken?: string[];
-  /** If set, will return only NFTs with a rank in the specified range */
-  rankRange?: {
-    min: number;
-    max: number;
-  };
-  /** If set, will return only NFTs with a cantina level in the specified range */
-  cantinaLevelRange?: {
-    min: number;
-    max: number;
-  };
-  /** If set, will return only NFTs with a name that contains the specified string */
-  searchName?: string;
-  /** 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?: SearchOrderBy[];
-  /** If set, will return only the specified fields */
-  onlySelectFields?: FieldsToSelect[];
-  /** If set, will return only NFTs listed in the specified marketplaces */
-  listedOnlyOn?: Marketplace[];
-  /** If set, will return only NFTs with the specified attributes */
-  attributes?: MetadataAttribute[];
-}
-
-export interface SearchNFTsResponse {
-  /** The total count of the results for the specific query */
-  count: number;
-  /** The results count for the current page */
-  resultsCount: number;
-  /** The results for the current page */
-  results: NftData[];
-  /** If the results are empty */
-  empty: boolean;
-  /** The payload to use to get the next page */
-  getNextPagePayload: SearchNFTsArgs;
-  /** If there are more results to fetch */
-  hasMoreResults: boolean;
-}
-
-export interface TradingActivity {
-  action: string;
-  attributes: MetadataAttribute[];
-  avifUrl: string;
-  buyer: string;
-  buyerUsername: string;
-  collection: string;
-  egldValue: number;
-  id: string;
-  identifier: string;
-  marketplace: Marketplace;
-  name: string;
-  paymentToken: string;
-  price: number;
-  rank: number;
-  seller: string;
-  sellerUsername: string;
-  timestamp: number;
-  txHash: string;
-  url: string;
-  usdPrice: number;
-  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/src/types/index.ts

@@ -1,3 +0,0 @@
-export * from './collection';
-export * from './nft';
-export * from './trading';