@xoxno/sdk-js 0.1.353 → 0.1.355

package/dist/nft/index.d.ts

@@ -1,6 +1,6 @@
-import type { ActivityChain, NftData } from '../types/nft';
-import type { TradincActivityArgs, TradingActivityResponse } from '../types/trading';
-import type { UserOffers } from '../types/user';
+import type { GetSingleNftOfferResponseDto, NftDoc } from '@xoxno/types';
+import type { ArgsQueryTop } from '../types';
+import type { ActivityChain } from '../types/nft';
 /**
  * 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.
@@ -16,7 +16,7 @@ export declare class NFTModule {
      * @async
      * @function getNFTByIdentifier
      * @param {string} identifier - The identifier of the NFT to fetch data for.
-     * @returns {Promise<NftData>} A promise that resolves to the fetched NFT data.
+     * @returns {Promise<NftDoc>} A promise that resolves to the fetched NFT data.
      *
      * This function fetches data for a given NFT by its identifier. It takes the following parameter:
      * - identifier (string): The identifier of the NFT to fetch data for.
@@ -25,13 +25,13 @@ export declare class NFTModule {
      * If it is valid, the function fetches the NFT data using the API.
      * Finally, it returns a promise that resolves to the fetched NFT data.
      */
-    getNFTByIdentifier: (identifier: string, extra?: RequestInit) => Promise<NftData>;
+    getNFTByIdentifier: (identifier: string, extra?: RequestInit) => Promise<NftDoc>;
     /**
      * @public
      * @async
      * @function getNFTByIdentifier
      * @param {string} identifier - The identifier of the NFT to fetch data for.
-     * @returns {Promise<NftData>} A promise that resolves to the fetched NFT data.
+     * @returns {Promise<NftDoc>} A promise that resolves to the fetched NFT data.
      *
      * This function fetches data for a given NFT by its identifier. It takes the following parameter:
      * - identifier (string): The identifier of the NFT to fetch data for.
@@ -40,36 +40,36 @@ export declare class NFTModule {
      * If it is valid, the function fetches the NFT data using the API.
      * Finally, it returns a promise that resolves to the fetched NFT data.
      */
-    getNFTsOffers: (identifier: string, skip?: number, top?: number) => Promise<UserOffers>;
+    getNFTsOffers: ({ identifier, ...args }: ArgsQueryTop) => Promise<GetSingleNftOfferResponseDto>;
     /**
      * 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.
+     * @returns {Promise<NftDoc>} The NFT data.
      * @throws Throws an error when the collection ticker is invalid.
      */
-    getNFTByCollectionAndNonce: (collection: string, nonce: number) => Promise<NftData>;
+    getNFTByCollectionAndNonce: (collection: string, nonce: number) => Promise<NftDoc>;
+    /**
+     * @public
+     * @async
+     * @function getDailyTrending
+     * @returns {Promise<NftDoc[]>} A promise that resolves to the array of trending NFTs.
+     * This function fetches the top NFTs that are trending today based on their floor and volumes
+     */
+    getDailyTrending: () => Promise<NftDoc[]>;
     /**
      * @public
      * @async
      * @function getPinnedNFTs
-     * @returns {Promise<NftData[]>} A promise that resolves to the fetched pinned collections.
+     * @returns {Promise<NftDoc[]>} A promise that resolves to the fetched pinned collections.
      */
-    getPinnedNFTs: (chain?: ActivityChain) => Promise<NftData[]>;
+    getPinnedNFTs: (chain?: ActivityChain) => Promise<NftDoc[]>;
     /**
      * Get NFT by collection and nonce hex
      *
      * @param collection - collection ticker
      * @param nonceHex - nonce hex
-     * @return {Promise<NftData>} NFT data
-     */
-    getNFTByCollectionAndNonceHex: (collection: string, nonceHex: string) => Promise<NftData>;
-    /**
-     * 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 100.
+     * @return {Promise<NftDoc>} NFT data
      */
-    getTradingActivity: (args: TradincActivityArgs) => Promise<TradingActivityResponse>;
+    getNFTByCollectionAndNonceHex: (collection: string, nonceHex: string) => Promise<NftDoc>;
 }

package/dist/types/collection.d.ts

@@ -1,7 +1,7 @@
 import type { IEventDoc } from './event';
 import type { ActivityChain, CollectionInfo, Media, NftData, NFTMetadata, Owner, SaleInfo } from './nft';
 import type { NftActivityType } from './trading';
-import type { CreatorProfile, IUserProfileSearch, OfferBody } from './user';
+import type { CreatorProfile, IUserProfileSearch } from './user';
 export interface ISocials {
     twitter: string;
     instagram: string;
@@ -281,69 +281,6 @@ export declare enum AuctionTypes {
     All = "All",
     AllListed = "AllListed"
 }
-export interface GetNFTsArgs {
-    /** Listed by different users */
-    listedBy?: string[];
-    /** Owned by different users */
-    ownedBy?: string[];
-    identifiers?: string[];
-    auctionType: AuctionTypes;
-    /** If set, will return only NFTs from the specified collections */
-    collections?: string[];
-    chain?: ActivityChain[];
-    /** If set, will return only NFTs from verified collections */
-    onlyVerified?: boolean;
-    /** If true, will return only NFTs that are on sale */
-    onlyOnSale?: boolean;
-    /** If true, will return only NFTs that are active, deadline not expired */
-    activeAuctions?: boolean;
-    /** If true the extra details of an NFT will be appended to each NFT, such as collection size and owners name */
-    applyNftExtraDetails?: 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 the total count of the NFTs, recommended to be set true only for the first call, then false for the next pages */
-    includeCount?: boolean;
-    /** If set, will apply the extra manual filters on top of the main payload */
-    extraSearch?: string[];
-    /** 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;
-    /** Document type */
-    dataType?: string[];
-    /** The nonces of the NFTs */
-    nonces?: number[];
-    /** If set, will return only NFTs that are staked */
-    isStaked?: boolean;
-    /** 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[];
-    /** If set, will return only the selected fields */
-    strictSelect?: boolean;
-    name?: string;
-}
 export interface GETDropsArgs {
     name?: string;
     /** If set, will return only NFTs from the specified collections */
@@ -380,26 +317,6 @@ export interface SuggestNFTsArgs {
     orderBy?: SuggestOrderBy[];
     chain?: ActivityChain[];
 }
-export interface SearchNFTsResponse {
-    /** The total count of the results for the specific query */
-    count?: number;
-    /** The results for the current page */
-    resources: NftData[];
-    /** The payload to use to get the next page */
-    getNextPagePayload: GetNFTsArgs;
-    /** If there are more results to fetch */
-    hasMoreResults: boolean;
-}
-export interface GetDropsResponse {
-    /** The total count of the results for the specific query */
-    count?: number;
-    /** The results for the current page */
-    resources: GetCollectionMintInfo[];
-    /** The payload to use to get the next page */
-    getNextPagePayload: GETDropsArgs;
-    /** If there are more results to fetch */
-    hasMoreResults: boolean;
-}
 export interface OfferFilters {
     isActive?: boolean[];
     identifier?: string[];
@@ -422,11 +339,6 @@ export interface GetOffersArgs {
     includeCount?: boolean;
     filters?: OfferFilters;
 }
-export interface GetOffersResponse {
-    count?: number;
-    resources: OfferBody[];
-    hasMoreResults: boolean;
-}
 export type ActivityData = {
     collection: string;
     identifier: string;
@@ -501,17 +413,10 @@ export interface CollectionsNFTsResponse {
     /** 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;
 }
-export interface SuggestResults {
-    count: number;
-    hasMoreResults: boolean;
-    resources: ResultsBody;
-}
 export interface ResultsBody {
     collections: (ICollectionProfile & {
         floorPrice: number;
@@ -641,12 +546,6 @@ export type HoldedDetails = {
 export interface AvgHolder extends HoldedDetails {
     avgPerHodler: number;
 }
-export type GlobalOffersResult = {
-    resources: GlobalOffers[];
-    hasMoreResults: boolean;
-    lastSkip: number;
-    getNextPagePayload?: GetGlobalOffersArgs;
-};
 export type GlobalOffers = {
     offerId: number;
     collection: string;
@@ -716,11 +615,6 @@ export type StagePrice = {
     usdValue: number;
     decimals: number;
 };
-export type CollectionStatsResults = {
-    resources: CollectionStatsDoc[];
-    hasMoreResults: boolean;
-    getNextPagePayload?: GetCollectionStatsArgs;
-};
 export type GetCollectionStatsArgs = {
     filters?: {
         chain?: ActivityChain[];

package/dist/types/index.d.ts

@@ -6,3 +6,18 @@ export * from './staking';
 export * from './user';
 export * from './common';
 export * from './event';
+export type PublicOnly<T> = {
+    [K in keyof T as T[K] extends Function ? never : K]: T[K];
+};
+export interface ArgsQueryTop {
+    identifier: string;
+    skip: number;
+    top: number;
+}
+export interface ArgsUserOffers extends ArgsQueryTop {
+    type: OfferType;
+}
+export declare enum OfferType {
+    Received = "received",
+    Placed = "placed"
+}

package/dist/types/trading.d.ts

@@ -1,4 +1,4 @@
-import type { Marketplace, MetadataAttribute, RangeFilter, TradingActivity } from './collection';
+import type { Marketplace, MetadataAttribute, RangeFilter } from './collection';
 import type { ActivityChain } from './nft';
 export declare enum NftActivityType {
     NFT_CREATE = "nftCreate",
@@ -109,11 +109,3 @@ export declare enum SelectFieldsTradingActivity {
     'marketplace' = 8,
     'payment_token' = 9
 }
-export interface TradingActivityResponse {
-    hasMoreResults: boolean;
-    /** The total count of the results for the specific query */
-    count?: number;
-    resources: TradingActivity[];
-    getNextPagePayload: TradincActivityArgs;
-    empty: boolean;
-}

package/dist/types/user.d.ts

@@ -86,21 +86,6 @@ export interface UserInventory {
     value: number;
     chain?: ActivityChain;
 }
-export interface UserOffers {
-    hasMoreResults: boolean;
-    count: number;
-    resources: OfferBody[];
-}
-export interface ArgsUserOffers {
-    address: string;
-    type: OfferType;
-    skip: number;
-    top: number;
-}
-export declare enum OfferType {
-    Received = "received",
-    Placed = "placed"
-}
 export interface OfferBody {
     dataType: string;
     identifier: string;
@@ -124,12 +109,6 @@ export interface OfferBody {
     floorPrice: number;
     chain?: ActivityChain;
 }
-export type Nfts = {
-    count: number;
-    resultsCount: number;
-    results: NftData[];
-    empty: boolean;
-};
 export declare enum Type {
     NonFungibleESDT = "NonFungibleESDT"
 }

package/dist/users/index.d.ts

@@ -1,5 +1,6 @@
-import type { CollectionCreatorInfo, CreatorInfo, EventCreatorInfo, GetNFTsArgs, SearchNFTsResponse, StakingStatus, StakingSummaryPools, StakingSummaryPoolsSlim, StatusResponse, SuggestNFTsArgs, SuggestResults, TradincActivityArgs, TradingActivityResponse } from '../types';
-import type { ArgsUserOffers, BulkAccount, CreatorProfile, IApiShareholder, IOwnerInfo, IUserProfile, StakingCreatorInfo, UserAnalyticSummary, UserInventory, UserNetworkAccount, UserOffers, UserPoolStakingInfo, UserStats, UserTokenInventory, UserXOXNODrop } from '../types/user';
+import type { FilterQueryDto, GetUserOffersResponseDto, GlobalSearchResponseDto, NftCosmosResponse, NftDocFilter } from '@xoxno/types';
+import type { ArgsQueryTop, ArgsUserOffers, CollectionCreatorInfo, CreatorInfo, EventCreatorInfo, PublicOnly, StakingStatus, StakingSummaryPools, StakingSummaryPoolsSlim, StatusResponse } from '../types';
+import type { BulkAccount, CreatorProfile, IApiShareholder, IOwnerInfo, IUserProfile, StakingCreatorInfo, UserAnalyticSummary, UserInventory, UserNetworkAccount, UserPoolStakingInfo, UserStats, UserTokenInventory, UserXOXNODrop } from '../types/user';
 export declare class UserModule {
     private api;
     private collection;
@@ -44,14 +45,14 @@ export declare class UserModule {
      * @param address - The user's address
      * @returns {UserInventory} - A list of token ids and the price
      */
-    getUserNFTs: (args: GetNFTsArgs) => Promise<SearchNFTsResponse>;
+    getUserNFTs: (args: PublicOnly<NftDocFilter>) => Promise<NftCosmosResponse>;
     /**
      * @name getUserOffers
      * @description Fetches all offers sent or received associated with a user address
-     * @param {String} address - The user's wallet address
+     * @param {ArgsUserOffers} address - The user's wallet address
      * @returns {UserOffers} - The user's listings
      */
-    getUserOffers: (args: ArgsUserOffers) => Promise<UserOffers>;
+    getUserOffers: ({ identifier: address, ...args }: ArgsUserOffers) => Promise<GetUserOffersResponseDto>;
     /**
      * @public
      * @async
@@ -66,15 +67,7 @@ export declare class UserModule {
      *
      * Finally, it returns a promise that resolves to the fetched users results.
      */
-    suggestUsers: (args: SuggestNFTsArgs) => Promise<SuggestResults>;
-    /**
-     * 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 100.
-     */
-    getTradingActivity: (args: TradincActivityArgs) => Promise<TradingActivityResponse>;
+    suggestUsers: (args: PublicOnly<FilterQueryDto>) => Promise<GlobalSearchResponseDto>;
     /** Gets user's creator profile
      * @param {String} address - User's address
      * @returns {CreatorProfile} User's creator profile struct
@@ -141,10 +134,10 @@ export declare class UserModule {
      * @param {String} address - User's address
      * @param {number} top - Top
      * @param {number} skip - Skip
-     * @returns {NftData[]} Array of NFTs
+     * @returns {NftDoc[]} Array of NFTs
      * @throws {Error} Throws an error if the address is invalid
      *  */
-    getUserFavoriteNFTs: (address: string, top: number, skip: number) => Promise<SearchNFTsResponse>;
+    getUserFavoriteNFTs: ({ identifier: address, ...args }: ArgsQueryTop) => Promise<NftCosmosResponse>;
     /** Gets user's favorite collection tickers
      * @param {String} address - User's address
      * @returns {String[]} Array of tickers

package/dist/utils/api.d.ts

@@ -26,5 +26,7 @@ export declare class XOXNOClient {
         chain?: Chain;
     }>): XOXNOClient;
     static getInstance(): XOXNOClient;
-    fetchWithTimeout: <T>(path: string, options?: Record<string, any>) => Promise<T>;
+    fetchWithTimeout: <T>(path: string, options?: RequestInit & {
+        params?: Record<string, any>;
+    }) => Promise<T>;
 }

package/dist/utils/errors.d.ts

@@ -0,0 +1,12 @@
+export declare class CollectionNotFoundError extends Error {
+    constructor(item: string);
+}
+export declare class AddressNotFoundError extends Error {
+    constructor(item: string);
+}
+export declare class NFTNotFoundError extends Error {
+    constructor(item: string);
+}
+export declare class PaginatedTopError extends Error {
+    constructor(top: number);
+}

package/dist/utils/guards.d.ts

@@ -0,0 +1,7 @@
+export declare function collectionGuard<T>(collection: string, callback: Promise<T>): Promise<T>;
+export declare function addressGuard<T>(address: string, callback: Promise<T>): Promise<T>;
+export declare function nftGuard<T>(identifier: string, callback: Promise<T>): Promise<T>;
+export declare function collectionGuardOnly(collection: string): Promise<void>;
+export declare function paginatedGuard<T extends {
+    top?: number;
+}, R>(filter: T, callback: (filter: string) => Promise<R>): Promise<R>;

package/dist/utils/types.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xoxno/sdk-js",
-  "version": "0.1.353",
+  "version": "0.1.355",
   "description": "The SDK to interact with the XOXNO Protocol!",
   "type": "module",
   "exports": {
@@ -98,6 +98,7 @@
   "dependencies": {
     "@multiversx/sdk-core": "^13.17.2",
     "@multiversx/sdk-network-providers": "^2.9.3",
+    "@xoxno/types": "^1.0.11",
     "axios": "^1.7.9",
     "protobufjs": "^7.4.0",
     "webpack-bundle-analyzer": "^4.10.2"

package/dist/utils/getActivity.d.ts

@@ -1,10 +0,0 @@
-import type { XOXNOClient } from '..';
-import type { TradincActivityArgs, TradingActivityResponse } from '../types/trading';
-/**
- * Fetches the trading activity of the given collections
- * @param args - The trading activity arguments
- * @param api - The API client
- * @returns - The trading activity response
- * @throws - If the top is greater than 100
- */
-export declare const getActivity: (args: TradincActivityArgs, api: XOXNOClient) => Promise<TradingActivityResponse>;