@xoxno/sdk-js 0.1.354 → 1.0.0

package/dist/types/user.d.ts

@@ -1,311 +0,0 @@
-import type { ISocials } from './collection';
-import type { ActivityChain, NftData, Owner } from './nft';
-import type { StakingSummaryPools } from './staking';
-export interface BulkAccount {
-    address: string;
-    nonce: number;
-    username?: string;
-    balance: string;
-    balanceShort: number;
-}
-export interface IUserProfileSearch {
-    address: string;
-    isVerified: boolean;
-    profile: string;
-    herotag: string;
-    addressTrimmed: string;
-    chain?: ActivityChain;
-}
-export interface IUserSettings {
-    dataType: 'userSettings';
-    emailNotifications: {
-        enabled: boolean;
-        emailAddress: string;
-        isEmailVerificationPending: boolean;
-        isEmailVerified: boolean;
-        isWeb2User: boolean;
-        timestamp?: number;
-    };
-    notificationPreferences: {
-        sales: boolean;
-        bids: boolean;
-        offersReceived: boolean;
-        offersAccepted: boolean;
-        offersRejected: boolean;
-        deposits: boolean;
-    };
-    address: string;
-    id: string;
-    _ts: number;
-}
-export interface IUserProfile {
-    dataType: 'userProfile';
-    hasKYC?: boolean;
-    address: string;
-    isBanned: boolean;
-    isVerified: boolean;
-    socials: ISocials;
-    favorites: string[];
-    joinedDate: number;
-    id: string;
-    profile: string;
-    banner: string;
-    description: string;
-    herotag: string;
-    isCreator: boolean;
-    creatorInfo: {
-        contractAddress?: string;
-        name?: string;
-    };
-    isPoolOwner: boolean;
-    followedCollections: string[];
-    userDeposit: UserDeposit[];
-    _ts: number;
-    shard: number;
-    followCount: number;
-    userSettings?: IUserSettings;
-    chain?: ActivityChain;
-}
-export interface UserDeposit {
-    balanceShort: number;
-    balance: string;
-    paymentToken: string;
-    paymentTokenNonce: number;
-    usdPrice: number;
-}
-export interface UserInventory {
-    collection: string;
-    inventoryCount: number;
-    listedCount: number;
-    stakedCount: number;
-    floorPrice: number;
-    name: string;
-    isVerified: boolean;
-    profile: string;
-    banner: string;
-    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;
-    collection: string;
-    offerId: number;
-    paymentToken: string;
-    paymentTokenNonce: number;
-    price: string;
-    priceShort: number;
-    deadline: number;
-    timestamp: number;
-    owner: Owner;
-    quantity: number;
-    marketplace: string;
-    id: string;
-    _ts: number;
-    nftInfo: NftData;
-    isActive: boolean;
-    usdValue: number;
-    floorPriceMargin: number;
-    floorPrice: number;
-    chain?: ActivityChain;
-}
-export type Nfts = {
-    count: number;
-    resultsCount: number;
-    results: NftData[];
-    empty: boolean;
-};
-export declare enum Type {
-    NonFungibleESDT = "NonFungibleESDT"
-}
-export type TickerElement = {
-    ticker: string;
-    name: string;
-};
-export type UserTokenInventory = {
-    tokens: EsdtToken[];
-    esdts: TokenWorth;
-    stables: TokenWorth;
-    wallet: TokenWorth;
-    chain?: ActivityChain;
-};
-export type TokenWorth = {
-    usdValue: number;
-    egldValue: number;
-    weight: number;
-};
-export type UserNetworkAccount = {
-    address: string;
-    nonce: number;
-    balance: string;
-    balanceShort: number;
-    usdValue: number;
-    username?: string;
-    shard: number;
-    guarded: boolean;
-    activeGuardian: ActiveGuardian;
-};
-export type ActiveGuardian = {
-    activationEpoch: number;
-    address: string;
-    serviceUID: string;
-};
-export interface SuiCoinObject {
-    objectId: string;
-    balance: string;
-    digest: string;
-    version: string;
-}
-export type EsdtToken = {
-    nonce: number;
-    identifier: string;
-    decimals: number;
-    balance: string;
-    ticker: string;
-    name: string;
-    shortBalance: number;
-    usdPrice: number;
-    usdValue: number;
-    egldValue: number;
-    assets: Assets;
-    isAshSupported: boolean;
-    weight: number;
-    objects?: SuiCoinObject[];
-};
-export type Assets = {
-    pngUrl: string;
-    svgUrl: string;
-};
-export type CreatorProfile = {
-    name: string;
-    profile: string;
-    banner: string;
-    description?: string;
-    socials?: ISocials;
-    joinedDate?: number;
-    contractAddress: string;
-    ticketingContractAddress?: string;
-    address: string;
-    followCount: number;
-    creatorTag: string;
-    _ts: number;
-};
-export interface RewardStakinSummary {
-    tokenIdentifier: string;
-    tokenNonce: number;
-    amount: string;
-    amountShort: number;
-    usdValue: number;
-}
-export interface RewardAvaiblePools {
-    tokenIdentifier: string;
-    tokenNonce: number;
-    rewardPerEpochShort: number;
-    rewardBalanceShort: number;
-    rewardBalance: string;
-    rewardPerDayPerNft: number;
-    usdValue: number;
-}
-export interface UserPoolStakingInfo {
-    nftDocs: NftData[];
-    poolDoc: StakingSummaryPools;
-}
-export interface UserAnalyticSummary {
-    Purchase: Purchase;
-    Sale: Purchase;
-}
-export interface Purchase {
-    count: number;
-    volume: number;
-    min: Max;
-    max: Max;
-    avg: Avg;
-}
-export interface Avg {
-    price: number;
-}
-export interface Max {
-    price: number;
-    txHash: string;
-    timestamp: number;
-    identifier: string;
-}
-export interface UserStats {
-    wallet: Wallet & {
-        isCreator: boolean;
-        owned: number;
-        listed: number;
-        followCount: number;
-    };
-    totalVolume: number;
-    totalTrades: number;
-    totalCollections: number;
-    totalNfts: number;
-    totalPartners: number;
-    buyerVolume: number;
-    buyerTrades: number;
-    buyerNfts: number;
-    buyerCollections: number;
-    buyerPartners: number;
-    buyerMaxPriceData: PriceData | null;
-    buyerMinPriceData: PriceData | null;
-    sellerVolume: number;
-    sellerTrades: number;
-    sellerNfts: number;
-    sellerCollections: number;
-    sellerPartners: number;
-    sellerMaxPriceData: PriceData;
-    sellerMinPriceData: PriceData;
-}
-export interface PriceData {
-    price: number;
-    timestamp: number;
-    identifier: string;
-    txHash: string;
-    usdValue: number;
-    nftInfo: Pick<NftData, 'identifier' | 'collection' | 'name' | 'metadata' | 'url' | 'wasProcessed' | 'media'>;
-}
-export interface StakingCreatorInfo {
-    address: string;
-    ownedPools: number[];
-    ownedCollections: string[];
-    cutFee: number;
-    _ts: number;
-}
-export interface UserXOXNODrop {
-    wallet: Wallet;
-    rank: number;
-    tokenAllocation: number;
-    totalScore: number;
-}
-export interface Wallet {
-    address: string;
-    addressTrimmed: string;
-    profile: string;
-    username: string;
-    isVerified: boolean;
-    chain?: ActivityChain;
-}
-export interface IOwnerInfo {
-    registered: string[];
-    availableForRegister: string[];
-}
-export type IApiShareholder = {
-    address: string;
-    share: number;
-};

package/dist/users/index.d.ts

@@ -1,209 +0,0 @@
-import type { NftDocFilter } from '@xoxno/types';
-import type { CollectionCreatorInfo, CreatorInfo, EventCreatorInfo, PublicOnly, 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';
-export declare class UserModule {
-    private api;
-    private collection;
-    constructor();
-    /**
-     * Returns the user profile
-     *
-     * @param {String} address - Address of the user
-     * @returns {IUserProfile}
-     */
-    getUserProfile: (address: string) => Promise<IUserProfile>;
-    /**
-     * Returns the wallet accounts
-     *
-     * @param {String[]} addresses - Addresses of the user
-     * @returns {BulkAccount[]}
-     */
-    getBulkAccounts: (addresses: string[]) => Promise<BulkAccount[]>;
-    /**
-     * Returns the user account info that inclues nonce, guardian data, esdtTokens
-     *
-     * @param {String} address - Address of the user
-     * @returns {UserAccountInfo}
-     */
-    getUserAccount: (address: string) => Promise<UserNetworkAccount>;
-    /**
-     * Returns the user account info that inclues nonce, guardian data, esdtTokens
-     *
-     * @param {String} address - Address of the user
-     * @returns {UserAccountInfo}
-     */
-    getUserTokenInventory: (address: string) => Promise<UserTokenInventory>;
-    /**
-     * Gets user's inventory
-     *
-     * @param {String} address - User's address
-     * @returns {UserInventory} User's inventory
-     */
-    getUserSummaryInventory: (address: string, activeAuctions?: boolean) => Promise<UserInventory[]>;
-    /**
-     * Fetches the user's NFTs listed on the marketplaces
-     * @param address - The user's address
-     * @returns {UserInventory} - A list of token ids and the price
-     */
-    getUserNFTs: (args: PublicOnly<NftDocFilter>) => Promise<import("@xoxno/types").NftCosmosResponse>;
-    /**
-     * @name getUserOffers
-     * @description Fetches all offers sent or received associated with a user address
-     * @param {String} address - The user's wallet address
-     * @returns {UserOffers} - The user's listings
-     */
-    getUserOffers: (args: ArgsUserOffers) => Promise<UserOffers>;
-    /**
-     * @public
-     * @async
-     * @function suggestUsers
-     * @param {SuggestNFTsArgs} args - An object containing the necessary parameters to fetch suggested users results.
-     * @returns {Promise<SuggestResults>} A promise that resolves to the fetched users results.
-     *
-     * This function fetches suggested users 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 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>;
-    /** Gets user's creator profile
-     * @param {String} address - User's address
-     * @returns {CreatorProfile} User's creator profile struct
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getUserCreatorProfile: (address: string) => Promise<CreatorProfile>;
-    /** Gets user's creator profile
-     * @param {String} address - User's address
-     * @returns {IMintInfo[]} User's creator profile struct
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getCreatorListings: (address: string) => Promise<CollectionCreatorInfo>;
-    /** Gets user's creator info
-     * @param {String} address - User's address
-     * @returns {EventCreatorInfo} User's creator info
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getCreatorEvents: (address: string, extra?: RequestInit) => Promise<EventCreatorInfo>;
-    /** Gets user's staking info
-     * @param {String} address - User's address
-     * @returns {UserStakingSummary[]} User's staking info
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getUserStakingSummary: (address: string) => Promise<StakingSummaryPoolsSlim[]>;
-    /** Gets user's staking info
-     * @param {String} address - User's address
-     * @returns {UserStakingAvaiblePools[]} User's staking info
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getUserStakingAailable: (address: string) => Promise<StakingSummaryPools[]>;
-    /** Gets user's creator info
-     * @param {String} address - User's address
-     * @returns {CreatorInfo} User's creator info
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getUserCreatorInfo: (address: string, extra?: RequestInit) => Promise<CreatorInfo>;
-    /** Gets pool details
-     * @param {String} address - User's address
-     * @param {String} collection - Collection ticker
-     * @returns {UserCollectionStaking} User's creator info
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getUserCollectionStaking: (address: string, collection: string) => Promise<StakingSummaryPools[]>;
-    /** Gets pool details
-     * @param {number} poolId - User's address
-     * @returns {CreatoPoolDetailsrInfo} User's creator info
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getUserPoolStaking: (address: string, poolId: number, status: StakingStatus) => Promise<UserPoolStakingInfo>;
-    /** Gets owned pools by address
-     * @param {string} address - User's address
-     * @returns {StakingSummaryPools[]} User pools
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getOwnedPoolsByAddress: (address: string) => Promise<StakingSummaryPools[]>;
-    /**
-     * Gets user's analytics summary
-     *
-     * @param {String} address - User's address
-     * @returns {UserAnalyticSummary} User's analytics summary
-     */
-    getUserAnalyticsSummary: (address: string) => Promise<UserAnalyticSummary>;
-    /** Gets user's favorite NFTs
-     * @param {String} address - User's address
-     * @param {number} top - Top
-     * @param {number} skip - Skip
-     * @returns {NftDoc[]} Array of NFTs
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getUserFavoriteNFTs: (address: string, top: number, skip: number) => Promise<SearchNFTsResponse>;
-    /** Gets user's favorite collection tickers
-     * @param {String} address - User's address
-     * @returns {String[]} Array of tickers
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getUserFavoriteCollectionTickers: (address: string) => Promise<string[]>;
-    /** Get if the creator tag is registered already
-     * @param {String} creatorTag - The creator tag that needs to be checked
-     * @returns {StatusResponse} True or false
-     *  */
-    getIsCreatorRegistered: (creatorTag: string) => Promise<StatusResponse>;
-    /**
-     * @public
-     * @async
-     * @function getUsersStats
-     * @returns {Promise<UserStats[]>} A promise that resolves to the fetched users results.
-     */
-    getUsersStats: ({ top, skip, orderBy, orderDirection, }: {
-        top: number;
-        skip: number;
-        orderBy: string;
-        orderDirection?: string;
-    }) => Promise<UserStats[]>;
-    /**
-     * @public
-     * @async
-     * @function getStakingCreatorInfo
-     * @param {String} address - The user's address.
-     * @returns {Promise<StakingCreatorInfo>} A promise that resolves to the fetched staking creator info.
-     */
-    getStakingCreatorInfo: (address: string) => Promise<StakingCreatorInfo>;
-    /**
-     * @public
-     * @async
-     * @function getUsersDrop
-     * @returns {Promise<UserXOXNODrop[]>} A promise that resolves to the fetched users results.
-     */
-    getUsersDrop: ({ top, skip, address, }: {
-        top: number;
-        skip: number;
-        address?: string;
-    }) => Promise<UserXOXNODrop[]>;
-    /** Gets user's creator info
-     * @param {String} address - User's address
-     * @returns {IOwnerInfo} User's creator info
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getUserOwnerCollections: (address: string) => Promise<IOwnerInfo>;
-    /** Gets royalties shares creator info
-     * @param {String} address - User's address
-     * @returns {IApiShareholder[]} Royalties shares creator info
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getRoyaltiesSharesCreator: (address: string) => Promise<IApiShareholder[]>;
-    /** Gets mint shares creator info
-     * @param {String} address - User's address
-     * @returns {IApiShareholder[]} Mint revenue shares creator info
-     * @throws {Error} Throws an error if the address is invalid
-     *  */
-    getMintSharesCreator: (address: string, collectionTag: string) => Promise<IApiShareholder[]>;
-}

package/dist/utils/getActivity.d.ts

@@ -1,10 +0,0 @@
-import type { TradincActivityArgs, TradingActivityResponse } from '../types/trading';
-import type { XOXNOClient } from './api';
-/**
- * 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>;