@xoxno/sdk-js 0.1.183 → 0.1.185

package/dist/collection/index.d.ts

@@ -0,0 +1,297 @@
+import { AnalyticsGraphs, NftData, StakingSummaryPools } from '../types';
+import { CollectionsNFTsResponse, GetCollectionsArgs, ICollectionAttributes, ICollectionProfile, GetNFTsArgs, SearchNFTsResponse, SuggestNFTsArgs, SuggestResults, CollectionVolume, IOwners, ISingleHolder, GetGlobalOffersArgs, GlobalOffersResult, GetCollectionMintInfo, GetCollectionStatsArgs, CollectionStatsResults, CollectionRanksExport, CollectionStatsDoc, GETDropsArgs, GetDropsResponse, CollectionListings } from '../types/collection';
+import { TradincActivityArgs, TradingActivityResponse } from '../types/trading';
+/**
+ * CollectionModule provides a set of methods to interact with NFT collections.
+ * It includes methods for getting collection profile information, floor price,
+ * collection attributes, and searching NFTs within a collection.
+ *
+ * @example
+ * const collectionModule = new CollectionModule();
+ */
+export declare class CollectionModule {
+    private api;
+    constructor();
+    /**
+     * @public
+     * @async
+     * @function getCollectionProfile
+     * @param {string} collection - The ticker of the collection to fetch the profile for.
+     * @returns {Promise<ICollectionProfile>} A promise that resolves to the fetched collection profile.
+     *
+     * This function fetches the profile of a given collection. It takes the following parameter:
+     * - collection (string): The ticker of the collection to fetch the profile for.
+     *
+     * The function first validates the input ticker and checks if it is a valid collection ticker.
+     * If it is valid, the function fetches the collection profile using the API.
+     * Finally, it returns a promise that resolves to the fetched collection profile.
+     */
+    getCollectionProfile: (collection: string) => Promise<ICollectionProfile>;
+    /**
+     * @public
+     * @async
+     * @function getDailyTrending
+     * @returns {Promise<NftData[]>} 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<NftData[]>;
+    /**
+     * Fetches the floor price of a collection.
+     * @param collection - The ticker of the collection.
+     * @param token - The token for the floor price calculation (default: 'EGLD').
+     * @returns A Promise that resolves to the collection's floor price as a number.
+     * @throws An error if the provided collection ticker is invalid.
+     */
+    getCollectionFloorPrice: (collection: string, token?: string) => Promise<number>;
+    /**
+     * @public
+     * @async
+     * @function getCollectionAttributes
+     * @param {string} collection - The ticker of the collection to fetch the attributes for.
+     * @returns {Promise<ICollectionAttributes>} A promise that resolves to the fetched collection attributes.
+     *
+     * This function fetches the attributes of a given collection. It takes the following parameter:
+     * - collection (string): The ticker of the collection to fetch the attributes for.
+     *
+     * The function first validates the input ticker and checks if it is a valid collection ticker.
+     * If it is valid, the function fetches the collection attributes using the API.
+     * Finally, it returns a promise that resolves to the fetched collection attributes.
+     */
+    getCollectionAttributes: (collection: string) => Promise<ICollectionAttributes>;
+    /**
+     * Searches for NFTs based on the provided arguments.
+     * @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 100.
+     */
+    getNFTs: (args: GetNFTsArgs) => Promise<SearchNFTsResponse>;
+    /**
+     * Searches for NFTs based on the provided arguments.
+     * @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 100.
+     */
+    getSearchNFTs: (args: GetNFTsArgs) => Promise<SearchNFTsResponse>;
+    /**
+     * @public
+     * @async
+     * @function suggestCollections
+     * @param {SuggestNFTsArgs} args - An object containing the necessary parameters to fetch suggested collections results.
+     * @returns {Promise<SuggestResults>} A promise that resolves to the fetched collections results.
+     *
+     * This function fetches suggested collections results based on the provided arguments. It takes an object with the following properties:
+     * - name (string): The name to search for (required).
+     * - top (number, optional): The maximum number of results to return (default is 35, cannot be greater than 100).
+     * - skip (number, optional): The number of results to skip (default is 0).
+     *
+     * Finally, it returns a promise that resolves to the fetched collections results.
+     */
+    suggestCollections: (args: SuggestNFTsArgs) => Promise<SuggestResults>;
+    /**
+     * @public
+     * @async
+     * @function collectionListingsAnalytics
+     * @param {string} ticker - The unique collection identifier called ticker
+     * @returns {Promise<CollectionListings>} A promise that resolves to the distribution of listings
+     */
+    collectionListingsAnalytics: (ticker: string) => Promise<CollectionListings>;
+    /**
+     * 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>;
+    /**
+     * Fetch collections profiles based on the provided arguments.
+     * @param {GetCollectionsArgs} args - The GetCollectionsArgs object containing the search parameters.
+     * @returns {Promise<CollectionsNFTsResponse>} A Promise that resolves to the CollectionsNFTsResponse object.
+     * @throws An error if the 'top' value is greater than 100.
+     */
+    getCollections: (args?: GetCollectionsArgs) => Promise<CollectionsNFTsResponse>;
+    /**
+     * Fetch global offers based on the provided arguments.
+     * @param {GetGlobalOffersArgs} args - The GetCollectionsArgs object containing the search parameters.
+     * @returns {Promise<GlobalOffersResult>} A Promise that resolves to the GlobalOffersResult object.
+     * @throws An error if the 'top' value is greater than 100.
+     */
+    getGlobalOffers: (args?: GetGlobalOffersArgs) => Promise<GlobalOffersResult>;
+    /**
+     * @public
+     * @async
+     * @function getCollectionVolume
+     * @param {string} collection - The ticker of the collection to fetch the volume for (e.g., 'EAPES-8f3c1f').
+     * @param {string} after - The start date (inclusive) of the date range for the volume data (e.g., '2023-04-17').
+     * @param {string} before - The end date (inclusive) of the date range for the volume data (e.g., '2023-04-25').
+     * @param {string} bin - The binning period for the volume data (e.g., '1d' for 1 day).
+     * @returns {Promise<CollectionVolume[]>} A promise that resolves to an array of collection volume data.
+     *
+     * This function fetches volume data for a given collection within a specified date range and binning period. It takes the following parameters:
+     * - collection (string): The ticker of the collection to fetch the volume for (e.g., 'EAPES-8f3c1f').
+     * - after (string): The start date (inclusive) of the date range for the volume data (e.g., '2023-04-17').
+     * - before (string): The end date (inclusive) of the date range for the volume data (e.g., '2023-04-25').
+     * - bin (string): The binning period for the volume data (e.g., '1d' for 1 day).
+     *
+     * The function first validates the input collection ticker and checks if it is a valid collection ticker.
+     * If it is valid, the function fetches the collection volume data using the API with the specified query parameters.
+     * Finally, it returns a promise that resolves to an array of collection volume data.
+     */
+    getCollectionVolume: (collection: string, after: string, before: string, bin: string) => Promise<CollectionVolume[]>;
+    /**
+     * @public
+     * @async
+     * @function getMarketplaceVolume
+     * @param {string} after - The start date (inclusive) of the date range for the volume data (e.g., '2023-04-17').
+     * @param {string} before - The end date (inclusive) of the date range for the volume data (e.g., '2023-04-25').
+     * @param {string} bin - The binning period for the volume data (e.g., '1d' for 1 day).
+     * @returns {Promise<CollectionVolume[]>} A promise that resolves to an array of collection volume data.
+     *
+     * This function fetches volume data for a given collection within a specified date range and binning period. It takes the following parameters:
+     * - collection (string): The ticker of the collection to fetch the volume for (e.g., 'EAPES-8f3c1f').
+     * - after (string): The start date (inclusive) of the date range for the volume data (e.g., '2023-04-17').
+     * - before (string): The end date (inclusive) of the date range for the volume data (e.g., '2023-04-25').
+     * - bin (string): The binning period for the volume data (e.g., '1d' for 1 day).
+     *
+     * The function first validates the input collection ticker and checks if it is a valid collection ticker.
+     * If it is valid, the function fetches the collection volume data using the API with the specified query parameters.
+     * Finally, it returns a promise that resolves to an array of collection volume data.
+     */
+    getMarketplaceVolume: (after: string, before: string, bin: string) => Promise<CollectionVolume[]>;
+    /**
+     * @public
+     * @async
+     * @function getCollectionOwners
+     * @param {string} collection - The ticker of the collection to fetch the owner information for (e.g., 'EAPES-8f3c1f').
+     * @returns {Promise<IOwners>} A promise that resolves a struct of collection information about holders
+     *
+     * This function fetches owner information for a given collection. It takes the following parameter:
+     * - collection (string): The ticker of the collection to fetch the owner information for (e.g., 'EAPES-8f3c1f').
+     *
+     * The function first validates the input collection ticker and checks if it is a valid collection ticker.
+     * If it is valid, the function fetches the collection owner information using the API.
+     * Finally, it returns a promise that resolves a struct of collection information about holders
+     */
+    getCollectionOwners: (collection: string) => Promise<IOwners>;
+    /**
+     * @public
+     * @async
+     * @function getExportOwners
+     * @param {string} collection - The ticker of the collection to fetch the owner information for (e.g., 'EAPES-8f3c1f').
+     * @returns {Promise<ISingleHolder[]>} A promise that resolves an array of holders part of the collection.
+     *
+     * This function fetches owners information for a given collection. It takes the following parameter:
+     * - collection (string): The ticker of the collection to fetch the owner information for (e.g., 'EAPES-8f3c1f').
+     *
+     * The function first validates the input collection ticker and checks if it is a valid collection ticker.
+     * If it is valid, the function fetches the collection owner information using the API.
+     * Finally, it returns a promise that resolves to an array of collection owner information.
+     */
+    getExportOwners: (collection: string) => Promise<ISingleHolder[]>;
+    /**
+     * @public
+     * @async
+     * @function getCollectionsStatistics
+     * @param {GetCollectionStatsArgs} args - The filter payload for the collection statsitics
+     * @returns {Promise<CollectionStatsResults>} A promise that resolves to a struct with information
+     * Finally, it returns a promise that resolves a struct with information
+     */
+    getCollectionsStatistics: (args: GetCollectionStatsArgs) => Promise<CollectionStatsResults>;
+    /**
+     * @public
+     * @async
+     * @function getCollectionStats
+     * @param {GetCollectionStatsArgs} args - The filter payload for the collection statsitics
+     * @returns {Promise<CollectionStatsDoc>} A promise that resolves to a struct with information
+     * Finally, it returns a promise that resolves a struct with information
+     */
+    getCollectionStats: (ticker: string) => Promise<CollectionStatsDoc>;
+    getAwaitEmpty: (delay: number) => Promise<boolean>;
+    /**
+     * @public
+     * @async
+     * @function getCollectionMintInfo
+     * @param {string} ticker - The ticker of the collection to fetch the owner information for (e.g., 'EAPES-8f3c1f').
+     * @returns {Promise<GetCollectionMintInfo>} A promise that resolves to a struct with information
+     * Finally, it returns a promise that resolves a struct with information
+     */
+    getCollectionMintInfo: ({ ticker, extra, }: {
+        ticker: string;
+        extra?: RequestInit;
+    }) => Promise<GetCollectionMintInfo>;
+    /**
+     * @public
+     * @async
+     * @function getCollectionRanks
+     * @param {string} ticker - The ticker of the collection to fetch the owner information for (e.g., 'EAPES-8f3c1f').
+     * @returns {Promise<CollectionRanksExport[]>} A promise that resolves to a struct with information
+     * Finally, it returns a promise that resolves a struct with information
+     */
+    getCollectionRanks: ({ ticker, extra, }: {
+        ticker: string;
+        extra?: RequestInit;
+    }) => Promise<CollectionRanksExport[]>;
+    /**
+     * @public
+     * @async
+     * @function getDropInfo
+     * @param {string} collectionTag - The unique ID of the collection part of the launchpad smart contract
+     * @param {string} creatorTag - The unique ID of the creator part of the launchpad smart contract
+     * @returns {Promise<GetCollectionMintInfo>} A promise that resolves to a struct with information
+     * Finally, it returns a promise that resolves a struct with information
+     */
+    getDropInfo: ({ collectionTag, creatorTag, extra, }: {
+        collectionTag: string;
+        creatorTag: string;
+        extra?: RequestInit;
+    }) => Promise<GetCollectionMintInfo>;
+    /**
+     * @public
+     * @async
+     * @function getCollectionGraphData
+     * @param category - The ticker of the collection.
+     * @returns {Promise<AnalyticsGraphs>} A promise the required analytics data
+     * This function gets the global graph data
+     */
+    getCollectionGraphData: (collection: string, startTime: string, endTime: string, bin: string) => Promise<AnalyticsGraphs>;
+    /**
+     * @public
+     * @async
+     * @function getPinnedCollections
+     * @returns {Promise<ICollectionProfile[]>} A promise that resolves to the fetched pinned collections.
+     */
+    getPinnedCollections: () => Promise<ICollectionProfile[]>;
+    /**
+     * Get drops based on the provided arguments.
+     * @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 100.
+     */
+    getSearchDrops: (args: GETDropsArgs) => Promise<GetDropsResponse>;
+    /**
+     * Get drops based on the provided arguments.
+     * @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 100.
+     */
+    getDrops: (args: GETDropsArgs) => Promise<GetDropsResponse>;
+    /** Gets collection staking info
+     * @param {String} collection - User's address
+     * @returns {StakingSummaryPools[]} Collection's staking info
+     * @throws {Error} Throws an error if the collection is invalid
+     *  */
+    getCollectionStakingSummary: ({ collection, extra, }: {
+        collection: string;
+        extra?: RequestInit;
+    }) => Promise<StakingSummaryPools[]>;
+    /**
+     * @public
+     * @async
+     * @function getCollectionsFloor
+     * @param collections - The tickers of the collection.
+     * @returns {Promise<Record<string, number>>} Floor price of the collections
+     * This function gets the floor price of the collections
+     */
+    getCollectionsFloor: (collections: string[]) => Promise<Record<string, number>>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/collection/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/collection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACzE,OAAO,EACL,uBAAuB,EACvB,kBAAkB,EAClB,qBAAqB,EACrB,kBAAkB,EAElB,WAAW,EACX,kBAAkB,EAClB,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,OAAO,EACP,aAAa,EACb,mBAAmB,EACnB,kBAAkB,EAElB,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,kBAAkB,EAElB,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAKhF;;;;;;;GAOG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,GAAG,CAAc;;IAKzB;;;;;;;;;;;;;OAaG;IACI,oBAAoB,eACb,MAAM,KACjB,OAAO,CAAC,kBAAkB,CAAC,CAc5B;IAEF;;;;;;OAMG;IACI,gBAAgB,QAAa,OAAO,CAAC,OAAO,EAAE,CAAC,CAWpD;IAEF;;;;;;OAMG;IACI,uBAAuB,eAChB,MAAM,qBAEjB,OAAO,CAAC,MAAM,CAAC,CAehB;IAEF;;;;;;;;;;;;;OAaG;IACI,uBAAuB,eAChB,MAAM,KACjB,OAAO,CAAC,qBAAqB,CAAC,CAc/B;IAEF;;;;;OAKG;IACI,OAAO,SAAgB,WAAW,KAAG,OAAO,CAAC,kBAAkB,CAAC,CAmFrE;IAEF;;;;;OAKG;IACI,aAAa,SACZ,WAAW,KAChB,OAAO,CAAC,kBAAkB,CAAC,CAmF5B;IAEF;;;;;;;;;;;;;OAaG;IACI,kBAAkB,SACjB,eAAe,KACpB,OAAO,CAAC,cAAc,CAAC,CAuBxB;IAEF;;;;;;OAMG;IACI,2BAA2B,WACxB,MAAM,KACb,OAAO,CAAC,kBAAkB,CAAC,CAU5B;IAEF;;;;;;OAMG;IACI,kBAAkB,SACjB,mBAAmB,KACxB,OAAO,CAAC,uBAAuB,CAAC,CAEjC;IAEF;;;;;OAKG;IACI,cAAc,UACZ,kBAAkB,KACxB,OAAO,CAAC,uBAAuB,CAAC,CA0CjC;IAEF;;;;;OAKG;IACI,eAAe,UACb,mBAAmB,KACzB,OAAO,CAAC,kBAAkB,CAAC,CA2C5B;IAEF;;;;;;;;;;;;;;;;;;;OAmBG;IACI,mBAAmB,eACZ,MAAM,SACX,MAAM,UACL,MAAM,OACT,MAAM,KACV,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAc5B;IAEF;;;;;;;;;;;;;;;;;;OAkBG;IACI,oBAAoB,UAClB,MAAM,UACL,MAAM,OACT,MAAM,KACV,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAW5B;IAEF;;;;;;;;;;;;;OAaG;IACI,mBAAmB,eAAsB,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC,CAevE;IAEF;;;;;;;;;;;;;OAaG;IACI,eAAe,eACR,MAAM,KACjB,OAAO,CAAC,aAAa,EAAE,CAAC,CAczB;IAEF;;;;;;;OAOG;IACI,wBAAwB,SACvB,sBAAsB,KAC3B,OAAO,CAAC,sBAAsB,CAAC,CAwBhC;IAEF;;;;;;;OAOG;IACI,kBAAkB,WACf,MAAM,KACb,OAAO,CAAC,kBAAkB,CAAC,CAc5B;IAEK,aAAa,UAAiB,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC,CAM5D;IAEF;;;;;;;OAOG;IACI,qBAAqB,uBAGzB;QACD,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,WAAW,CAAC;KACrB,KAAG,OAAO,CAAC,qBAAqB,CAAC,CAehC;IAEF;;;;;;;OAOG;IACI,kBAAkB,uBAGtB;QACD,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,WAAW,CAAC;KACrB,KAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAelC;IAEF;;;;;;;;OAQG;IACI,WAAW,0CAIf;QACD,aAAa,EAAE,MAAM,CAAC;QACtB,UAAU,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,WAAW,CAAC;KACrB,KAAG,OAAO,CAAC,qBAAqB,CAAC,CAYhC;IAEF;;;;;;;OAOG;IACI,sBAAsB,eACf,MAAM,aACP,MAAM,WACR,MAAM,OACV,MAAM,KACV,OAAO,CAAC,eAAe,CAAC,CAmBzB;IAEF;;;;;OAKG;IACI,oBAAoB,QAAa,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAWnE;IAEF;;;;;OAKG;IACI,cAAc,SACb,YAAY,KACjB,OAAO,CAAC,gBAAgB,CAAC,CAmD1B;IAEF;;;;;OAKG;IACI,QAAQ,SAAgB,YAAY,KAAG,OAAO,CAAC,gBAAgB,CAAC,CAmDrE;IAEF;;;;UAIM;IACC,2BAA2B,2BAG/B;QACD,UAAU,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,WAAW,CAAC;KACrB,KAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAYhC;IAEF;;;;;;;OAOG;IACI,mBAAmB,gBACX,MAAM,EAAE,KACpB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAehC;CACH"}

package/dist/common/index.d.ts

@@ -0,0 +1,71 @@
+import { AssetCategory, FungibleAssetsMap, SuggestNFTsArgs, SuggestResults } from '../types/collection';
+import { AnalyticsGraphs, AshSwapPaymentData, StakingExplore, StatisticsSummary, TokenUSDPrices } from '../types/common';
+export declare class CommonModule {
+    private api;
+    constructor();
+    /** Gets all tokens usd price
+     * @returns {TokenUSDPrices} User's creator info
+     *  */
+    getTokensUsdPrice: () => Promise<TokenUSDPrices>;
+    /** Gets all tokens usd price
+     * @returns {TokenUSDPrices} User's creator info
+     *  */
+    getAshSwapAmount: ({ originalToken, originalTokenValue, paymentToken, }: {
+        originalToken: string;
+        originalTokenValue: string;
+        paymentToken: string;
+    }) => Promise<AshSwapPaymentData>;
+    /**
+     * @public
+     * @async
+     * @function getFungibleTokens
+     * @param category - The ticker of the collection.
+     * @returns {Promise<FungibleAssetsMap>} A promise that resolves a map of ESDT tokens and their info
+     * This function fetches all branded fungible assets and their info
+     */
+    getFungibleTokens: (categories?: AssetCategory[], identifiers?: string[]) => Promise<FungibleAssetsMap>;
+    /**
+     * @public
+     * @async
+     * @function getGlobalGraphData
+     * @param category - The ticker of the collection.
+     * @returns {Promise<AnalyticsGraphs>} A promise the required analytics data
+     * This function gets the global graph data
+     */
+    getGlobalGraphData: (startTime: string, endTime: string, bin: string) => Promise<AnalyticsGraphs>;
+    /**
+     * @public
+     * @async
+     * @function getAnalyticsOverview
+     * @returns {Promise<StatisticsSummary>} A promise the required analytics data
+     * This function gets the global graph data
+     */
+    getAnalyticsOverview: () => Promise<StatisticsSummary>;
+    /**
+     * @public
+     * @async
+     * @function suggestResults
+     * @param {SuggestNFTsArgs} args - An object containing the necessary parameters to fetch suggested NFT results.
+     * @returns {Promise<SuggestResults>} A promise that resolves to the fetched NFT results.
+     *
+     * This function fetches suggested NFT results based on the provided arguments. It takes an object with the following properties:
+     * - name (string): The name to search for (required).
+     * - orderBy (SuggestOrderBy[], optional): An array of ordering preferences for the results.
+     * - top (number, optional): The maximum number of results to return (default is 35, cannot be greater than 100).
+     * - skip (number, optional): The number of results to skip (default is 0).
+     *
+     * The function first validates the input arguments and constructs a payload body with the provided parameters.
+     * Then, it converts the payload body into a base64 string and fetches the suggested results using the API.
+     * Finally, it returns a promise that resolves to the fetched NFT results.
+     */
+    suggestResults: (args: SuggestNFTsArgs) => Promise<SuggestResults>;
+    /**
+     * @public
+     * @async
+     * @function getExploreStaking
+     * @returns {Promise<StakingExplore[]>} A promise that resolves to the fetched staking explore data.
+     * This function fetches the staking explore data.
+     */
+    getExploreStaking: () => Promise<StakingExplore[]>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/common/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,cAAc,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,cAAc,EACf,MAAM,iBAAiB,CAAC;AAGzB,qBAAa,YAAY;IACvB,OAAO,CAAC,GAAG,CAAc;;IAIzB;;UAEM;IACC,iBAAiB,QAAa,OAAO,CAAC,cAAc,CAAC,CAI1D;IAEF;;UAEM;IACC,gBAAgB,yDAIpB;QACD,aAAa,EAAE,MAAM,CAAC;QACtB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,YAAY,EAAE,MAAM,CAAC;KACtB,KAAG,OAAO,CAAC,kBAAkB,CAAC,CAY7B;IAEF;;;;;;;OAOG;IACI,iBAAiB,gBACV,aAAa,EAAE,gBACb,MAAM,EAAE,KACrB,OAAO,CAAC,iBAAiB,CAAC,CAsB3B;IAEF;;;;;;;OAOG;IACI,kBAAkB,cACZ,MAAM,WACR,MAAM,OACV,MAAM,KACV,OAAO,CAAC,eAAe,CAAC,CAgBzB;IAEF;;;;;;OAMG;IACI,oBAAoB,QAAa,OAAO,CAAC,iBAAiB,CAAC,CAWhE;IAEF;;;;;;;;;;;;;;;;OAgBG;IACI,cAAc,SACb,eAAe,KACpB,OAAO,CAAC,cAAc,CAAC,CAoBxB;IAEF;;;;;;OAMG;IACI,iBAAiB,QAAa,OAAO,CAAC,cAAc,EAAE,CAAC,CAW5D;CACH"}

package/dist/email/Markdown.d.ts

@@ -0,0 +1,4 @@
+import React, { type ComponentProps } from 'react';
+import ReactMarkdown from 'react-markdown';
+export declare function Markdown(props: ComponentProps<typeof ReactMarkdown>): React.JSX.Element;
+//# sourceMappingURL=Markdown.d.ts.map

package/dist/email/Markdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Markdown.d.ts","sourceRoot":"","sources":["../../src/email/Markdown.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,EAAE,KAAK,cAAc,EAAE,MAAM,OAAO,CAAC;AAGnD,OAAO,aAAa,MAAM,gBAAgB,CAAC;AAgD3C,wBAAgB,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC,OAAO,aAAa,CAAC,qBAEnE"}

package/dist/email/email.d.ts

@@ -0,0 +1,31 @@
+import { type ComponentProps } from 'react';
+import { IBaseNotification, IEmailActivityType } from './types';
+import React from 'react';
+import { IHost } from './utils';
+export type IProps = {
+    host?: IHost;
+} & ({
+    activityType: Exclude<IEmailActivityType, 'verifyEmail'>;
+    payload: {
+        name: string;
+        address: string;
+        nft: Pick<IBaseNotification, 'asset' | 'owner' | 'activity'>;
+        code?: never;
+    };
+} | {
+    activityType: Extract<IEmailActivityType, 'verifyEmail'>;
+    payload: {
+        name: string;
+        address?: never;
+        nft?: never;
+        code: string;
+    };
+});
+declare const XOXNOEmail: ({ host, ...props }: IProps) => React.JSX.Element;
+export declare const renderEmail: (props: ComponentProps<typeof XOXNOEmail>) => Promise<{
+    html: string;
+    plainText: string;
+    subject: string;
+}>;
+export {};
+//# sourceMappingURL=email.d.ts.map

package/dist/email/email.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email.d.ts","sourceRoot":"","sources":["../../src/email/email.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,cAAc,EAAE,MAAM,OAAO,CAAC;AAc3D,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAanB,MAAM,SAAS,CAAC;AAEjB,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAEL,KAAK,EAYN,MAAM,SAAS,CAAC;AA0HjB,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,CAAC,EAAE,KAAK,CAAC;CACd,GAAG,CACA;IACE,YAAY,EAAE,OAAO,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;IACzD,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,GAAG,EAAE,IAAI,CAAC,iBAAiB,EAAE,OAAO,GAAG,OAAO,GAAG,UAAU,CAAC,CAAC;QAC7D,IAAI,CAAC,EAAE,KAAK,CAAC;KACd,CAAC;CACH,GACD;IACE,YAAY,EAAE,OAAO,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;IACzD,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,KAAK,CAAC;QAChB,GAAG,CAAC,EAAE,KAAK,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CACJ,CAAC;AAIF,QAAA,MAAM,UAAU,uBAAsC,MAAM,sBAsH3D,CAAC;AAEF,eAAO,MAAM,WAAW,UAAiB,cAAc,CAAC,OAAO,UAAU,CAAC;;;;EAIzE,CAAC"}

package/dist/email/event-email.d.ts

@@ -0,0 +1,20 @@
+import { type ComponentProps } from 'react';
+import React from 'react';
+import { IHost } from './utils';
+import { IEvent } from './types';
+export type IProps = {
+    host?: IHost;
+    name: string;
+    event: IEvent;
+    style?: {
+        backgroundColor: string;
+    };
+};
+declare const EventEmail: ({ host, event, name, style, }: IProps) => React.JSX.Element;
+export declare const renderEventEmail: (props: ComponentProps<typeof EventEmail>) => Promise<{
+    html: string;
+    plainText: string;
+    subject: string;
+}>;
+export {};
+//# sourceMappingURL=event-email.d.ts.map

package/dist/email/event-email.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-email.d.ts","sourceRoot":"","sources":["../../src/email/event-email.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,cAAc,EAAE,MAAM,OAAO,CAAC;AAc3D,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAGL,KAAK,EAUN,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAoBjC,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE;QACN,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH,CAAC;AAIF,QAAA,MAAM,UAAU,kCAKb,MAAM,sBAsHR,CAAC;AAEF,eAAO,MAAM,gBAAgB,UACpB,cAAc,CAAC,OAAO,UAAU,CAAC;;;;EAKzC,CAAC"}

package/dist/email/post-email.d.ts

@@ -0,0 +1,19 @@
+import { type ComponentProps } from 'react';
+import React from 'react';
+import { IHost } from './utils';
+export type IProps = {
+    host?: IHost;
+    subject: string;
+    message: string;
+    style?: {
+        backgroundColor: string;
+    };
+};
+declare const PostEmail: ({ host, subject, message, style, }: IProps) => React.JSX.Element;
+export declare const renderPostEmail: (props: ComponentProps<typeof PostEmail>) => Promise<{
+    html: string;
+    plainText: string;
+    subject: string;
+}>;
+export {};
+//# sourceMappingURL=post-email.d.ts.map

package/dist/email/post-email.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"post-email.d.ts","sourceRoot":"","sources":["../../src/email/post-email.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,cAAc,EAAE,MAAM,OAAO,CAAC;AAc3D,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAGL,KAAK,EAUN,MAAM,SAAS,CAAC;AAsBjB,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE;QACN,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH,CAAC;AAIF,QAAA,MAAM,SAAS,uCAKZ,MAAM,sBAsDR,CAAC;AAEF,eAAO,MAAM,eAAe,UACnB,cAAc,CAAC,OAAO,SAAS,CAAC;;;;EAKxC,CAAC"}

package/dist/email/types.d.ts

@@ -0,0 +1,68 @@
+import { NftActivityType } from '../types';
+export declare const offerTradeTypes: readonly [NftActivityType.OFFER_TRADE, NftActivityType.GLOBAL_OFFER_TRADE];
+export declare const tradeTypes: readonly [NftActivityType.TRADE, NftActivityType.BULK_TRADE, NftActivityType.OTHER_TRADE];
+export declare const offerTypes: readonly [NftActivityType.OFFER_CREATE, NftActivityType.OFFER_REJECT];
+export declare const bidTypes: readonly [NftActivityType.AUCTION_BID, NftActivityType.AUCTION_OUT_BID];
+export declare const depositTypes: readonly ["deposit", "withdrawDeposit"];
+export declare const verifyEmailTypes: readonly ["verifyEmail"];
+export type IOfferTradeTypes = (typeof offerTradeTypes)[number];
+export type ITradeTypes = (typeof tradeTypes)[number];
+export type IDepositTypes = (typeof depositTypes)[number];
+export type IBidTypes = (typeof bidTypes)[number];
+export type IOfferTypes = (typeof offerTypes)[number];
+export type IVerifyEmailTypes = (typeof verifyEmailTypes)[number];
+declare const emailActivityTypes: readonly [NftActivityType.OFFER_TRADE, NftActivityType.GLOBAL_OFFER_TRADE, NftActivityType.TRADE, NftActivityType.BULK_TRADE, NftActivityType.OTHER_TRADE, NftActivityType.OFFER_CREATE, NftActivityType.OFFER_REJECT, "deposit", "withdrawDeposit", NftActivityType.AUCTION_BID, NftActivityType.AUCTION_OUT_BID, "verifyEmail"];
+export type IEmailActivityType = (typeof emailActivityTypes)[number];
+export declare enum NotificationAssetType {
+    NFT = "nft",
+    USER = "user",
+    CHAT = "chat"
+}
+export interface IBaseNotification {
+    id: string;
+    isRead: boolean;
+    txHash: string;
+    source: string;
+    activityType: IEmailActivityType | '';
+    message?: string;
+    asset: {
+        type: NotificationAssetType;
+        collection?: string;
+        identifier?: string;
+        address?: string;
+        name?: string;
+        url?: string;
+    };
+    activity: {
+        price?: number;
+        paymentToken?: string;
+        quantity?: number;
+        buyer?: string;
+        seller?: string;
+        previousBidder?: string;
+        deadline?: number;
+        unreadCount?: number;
+    };
+    owner: string;
+    timestamp: number;
+}
+export interface INotification extends Omit<IBaseNotification, 'asset'> {
+    asset: Omit<IBaseNotification['asset'], 'url'> & {
+        url: string[];
+    };
+}
+export interface IEvent {
+    name: string;
+    backgroundImage: string;
+    ticketImage: string;
+    time: string;
+    location: {
+        lat: number;
+        lng: number;
+        value: string;
+    };
+    ticketId: string;
+    eventId: string;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/email/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/email/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C,eAAO,MAAM,eAAe,4EAGlB,CAAC;AAEX,eAAO,MAAM,UAAU,2FAIb,CAAC;AAEX,eAAO,MAAM,UAAU,uEAGb,CAAC;AAEX,eAAO,MAAM,QAAQ,yEAGX,CAAC;AAEX,eAAO,MAAM,YAAY,yCAA0C,CAAC;AAEpE,eAAO,MAAM,gBAAgB,0BAA2B,CAAC;AAEzD,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhE,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtD,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1D,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;AAElD,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtD,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAElE,QAAA,MAAM,kBAAkB,mUAOd,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAErE,oBAAY,qBAAqB;IAC/B,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,IAAI,SAAS;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,kBAAkB,GAAG,EAAE,CAAC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE;QACL,IAAI,EAAE,qBAAqB,CAAC;QAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;IACF,QAAQ,EAAE;QACR,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACrE,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,GAAG;QAAE,GAAG,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CACpE;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/email/utils.d.ts

@@ -0,0 +1,84 @@
+import { PropsWithChildren, ReactElement } from 'react';
+import React from 'react';
+export declare const MEDIA = "https://media.xoxno.com";
+export declare const GeneralEmail: ({ title, children, }: PropsWithChildren<{
+    title: string;
+}>) => React.JSX.Element;
+export declare function Center({ children }: PropsWithChildren): React.JSX.Element;
+export declare const headingStyle: {
+    color: "var(--color-palettes-primary-text-fill, #FFF)";
+    fontFamily: "Heading, Verdana";
+    textAlign: "center";
+    fontSize: string;
+    fontStyle: "normal";
+    fontWeight: number;
+    lineHeight: string;
+};
+export declare const linkStyle: {
+    color: "var(--color-palettes-lime-fill, #AEFB4F)";
+    fontFamily: "Body, Verdana";
+    fontSize: string;
+    fontStyle: "normal";
+    fontWeight: "500";
+    lineHeight: string;
+    whiteSpace: "nowrap";
+};
+export declare const bodyStyle: {
+    color: "var(--color-palettes-button-tertiary-text, #D0D0D0)";
+    textAlign: "center";
+    fontFamily: "Body, Verdana";
+    fontSize: string;
+    fontStyle: "normal";
+    fontWeight: "400";
+    lineHeight: string;
+};
+export declare const hintStyle: {
+    color: "var(--color-palettes-button-tertiary-text, #D0D0D0)";
+    textAlign: "center";
+    fontFamily: "Body, Verdana";
+    fontSize: string;
+    fontStyle: "normal";
+    fontWeight: "300";
+    lineHeight: string;
+};
+export declare const highlightStyle: {
+    color: "var(--color-palettes-primary-text-fill, #FFF)";
+    fontFamily: "Body, Verdana";
+    fontSize: string;
+    fontStyle: "normal";
+    fontWeight: "500";
+    lineHeight: string;
+};
+export declare const buttonStyle: {
+    fontFamily: "Button, Verdana";
+    padding: string;
+    borderRadius: string;
+    background: string;
+    color: "var(--color-palettes-button-primary-text, #000)";
+    fontSize: string;
+    fontStyle: "normal";
+    fontWeight: "500";
+    lineHeight: string;
+};
+declare const locales: readonly ["en", "de"];
+type ILocale = (typeof locales)[number];
+export type Translations<T = object> = {
+    namespace: string;
+    translations: {
+        en: T;
+    } & Partial<{
+        [key in Exclude<ILocale, 'en'>]: Partial<T>;
+    }>;
+};
+export declare const defaultHost = "https://xoxno.com";
+declare const hosts: readonly ["https://xoxno.com", "https://next.xoxno.com", "https://devnet.xoxno.com"];
+export declare function getHost(propHost: IHost): "https://xoxno.com" | "https://next.xoxno.com" | "https://devnet.xoxno.com";
+export type IHost = (typeof hosts)[number];
+export declare const apiMappers: Record<IHost, string>;
+export declare function renderGenericEmail(Email: ReactElement): Promise<{
+    html: string;
+    plainText: string;
+    subject: string;
+}>;
+export {};
+//# sourceMappingURL=utils.d.ts.map

package/dist/email/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/email/utils.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAsB,MAAM,OAAO,CAAC;AAU5E,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,eAAO,MAAM,KAAK,4BAA4B,CAAC;AA+B/C,eAAO,MAAM,YAAY,yBAGtB,iBAAiB,CAAC;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,sBA+CtC,CAAC;AAEF,wBAAgB,MAAM,CAAC,EAAE,QAAQ,EAAE,EAAE,iBAAiB,qBAQrD;AAED,eAAO,MAAM,YAAY;;;;;;;;CAQA,CAAC;AAE1B,eAAO,MAAM,SAAS;;;;;;;;CAQG,CAAC;AAE1B,eAAO,MAAM,SAAS;;;;;;;;CAQG,CAAC;AAE1B,eAAO,MAAM,SAAS;;;;;;;;CAQG,CAAC;AAE1B,eAAO,MAAM,cAAc;;;;;;;CAOF,CAAC;AAE1B,eAAO,MAAM,WAAW;;;;;;;;;;CAUC,CAAC;AAE1B,QAAA,MAAM,OAAO,uBAAwB,CAAC;AAEtC,KAAK,OAAO,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AACxC,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,MAAM,IAAI;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACZ,EAAE,EAAE,CAAC,CAAC;KACP,GAAG,OAAO,CAAC;SAAG,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;KAAE,CAAC,CAAC;CAC9D,CAAC;AAEF,eAAO,MAAM,WAAW,sBAAsB,CAAC;AAE/C,QAAA,MAAM,KAAK,sFAID,CAAC;AAEX,wBAAgB,OAAO,CAAC,QAAQ,EAAE,KAAK,+EAEtC;AAED,MAAM,MAAM,KAAK,GAAG,CAAC,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3C,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAI5C,CAAC;AAEF,wBAAsB,kBAAkB,CAAC,KAAK,EAAE,YAAY;;;;GAY3D"}