@xoxno/types 1.0.368 → 1.0.370

package/dist/cache/cache-keys.d.ts

@@ -0,0 +1,289 @@
+/**
+ * Shared cache key definitions for use across xoxno-api-v2 and xoxno-az-functions.
+ * This ensures consistent cache keys and TTLs across all repositories.
+ *
+ * IMPORTANT: When adding/modifying cache keys:
+ * 1. Define the key pattern here
+ * 2. Update both API and az-functions to use these shared definitions
+ * 3. Ensure TTLs are appropriate for the data's update frequency
+ */
+export interface CacheKeyConfig {
+    key: string;
+    ttl: number;
+}
+/**
+ * Cache key generators for commonly used patterns.
+ * These ensure consistent key formats across repositories.
+ */
+export declare const CacheKeys: {
+    UserProfile: (address: string) => CacheKeyConfig;
+    UserSettings: (address: string) => CacheKeyConfig;
+    UserInventorySummary: (address: string, activeAuction: boolean) => CacheKeyConfig;
+    UserHerotag: (address: string) => CacheKeyConfig;
+    UserFavorite: (address: string, favoriteId: string) => CacheKeyConfig;
+    UserOffers: (address: string, offerType: string) => CacheKeyConfig;
+    UserPlacedOffersCount: (address: string, offerType: string) => CacheKeyConfig;
+    UserFavoriteUserAddresses: (address: string) => CacheKeyConfig;
+    UserFavoriteCollectionTickers: (address: string) => CacheKeyConfig;
+    UserFavoriteNftIdentifiers: (address: string) => CacheKeyConfig;
+    UserTradingSummary: (address: string) => CacheKeyConfig;
+    UserOwnedAndListedSummary: (address: string) => CacheKeyConfig;
+    UserStatistics: (hash: string) => CacheKeyConfig;
+    UserSearch: (filter: string) => CacheKeyConfig;
+    UserCount: (chain?: string[]) => CacheKeyConfig;
+    AddressEsdt: (address: string) => CacheKeyConfig;
+    UserXoxnoDropScore: (skip: number, top: number, address?: string) => CacheKeyConfig;
+    EmailVerificationCode: (address: string) => CacheKeyConfig;
+    CollectionProfile: (collection: string) => CacheKeyConfig;
+    CollectionStats: (collection: string) => CacheKeyConfig;
+    CollectionFloorPrice: (collection: string, token: string) => CacheKeyConfig;
+    CollectionTraitMap: (collection: string) => CacheKeyConfig;
+    CollectionRanks: (collection: string) => CacheKeyConfig;
+    CollectionMintProfile: (collection: string) => CacheKeyConfig;
+    CollectionMintStages: (collection: string, enabledOnly: boolean) => CacheKeyConfig;
+    CollectionListedCount: (collection: string) => CacheKeyConfig;
+    CollectionListingDistribution: (collection: string) => CacheKeyConfig;
+    CollectionFloorPriceByAttribute: (collection: string) => CacheKeyConfig;
+    CollectionHoldersDetailed: (key: string, realOwners: boolean) => CacheKeyConfig;
+    CollectionHoldersCount: (key: string) => CacheKeyConfig;
+    CollectionHoldersDocCount: (collection: string) => CacheKeyConfig;
+    SftTotalSupplyCount: (collection: string) => CacheKeyConfig;
+    CollectionProfileDocs: (hash: string) => CacheKeyConfig;
+    CollectionStatsDocs: (query: string) => CacheKeyConfig;
+    CollectionOfferDocs: (hash: string) => CacheKeyConfig;
+    CollectionSearch: (filter: string) => CacheKeyConfig;
+    CollectionTickerByTags: (creatorTag: string, collectionTag: string) => CacheKeyConfig;
+    CollectionListings: (collection: string) => CacheKeyConfig;
+    AllBannedCollections: () => CacheKeyConfig;
+    AllVerifiedCollections: () => CacheKeyConfig;
+    NftDoc: (identifier: string) => CacheKeyConfig;
+    NftHasOffer: (identifier: string) => CacheKeyConfig;
+    NftOffers: (identifier: string) => CacheKeyConfig;
+    NftDataDocs: (query: string) => CacheKeyConfig;
+    NftSearch: (filter: string) => CacheKeyConfig;
+    NftMetadataUrl: (url: string) => CacheKeyConfig;
+    NftMetadata: (identifier: string) => CacheKeyConfig;
+    StakingPoolDoc: (poolId: number) => CacheKeyConfig;
+    StakingWlNonces: (poolId: number) => CacheKeyConfig;
+    StakingUserReward: (address: string, poolId: number) => CacheKeyConfig;
+    StakingDataDocs: (query: string) => CacheKeyConfig;
+    StakingPoolsByCollection: (collections: string[], activePoolsOnly: boolean) => CacheKeyConfig;
+    StakingPoolsSummaryByCollection: () => CacheKeyConfig;
+    StakingProviderOwner: (provider: string) => CacheKeyConfig;
+    StakingCreatedDelegationContract: (address: string) => CacheKeyConfig;
+    StakingProviderUserRewards: (address: string, currentEpoch: number) => CacheKeyConfig;
+    StakingProviderEpochRewards: (provider: string, epoch: number) => CacheKeyConfig;
+    ClaimableRewards: (address: string, delegationContract: string) => CacheKeyConfig;
+    AllUserDelegations: (address: string) => CacheKeyConfig;
+    EgldStakingProviders: (providers: string[], withIdentityInfo?: boolean) => CacheKeyConfig;
+    EgldStakingProvider: (provider: string) => CacheKeyConfig;
+    GetLastUpdatedEpoch: (provider: string, epoch: number) => CacheKeyConfig;
+    LendingMarketProfileDoc: (token: string) => CacheKeyConfig;
+    LendingAccountProfileDoc: (identifier: string, token: string) => CacheKeyConfig;
+    LendingTokenEModeProfileDoc: (token: string, eModeCategory: string) => CacheKeyConfig;
+    LendingPoolContracts: (controllerAddress: string) => CacheKeyConfig;
+    LendingAllActiveAccounts: () => CacheKeyConfig;
+    LendingAccountAttributes: (nonce: number) => CacheKeyConfig;
+    LendingLiquidateablePositions: () => CacheKeyConfig;
+    LendingMarketIndexes: (tokens: string[]) => CacheKeyConfig;
+    LendingAllMarketsTokens: () => CacheKeyConfig;
+    LendingAccountPosition: (identifier: string) => CacheKeyConfig;
+    LendingFaucetClaimed: (address: string) => CacheKeyConfig;
+    LendingBulkOraclePrice: (tokens: string[], returnAsUsd: boolean) => CacheKeyConfig;
+    LendingTokenPriceAsUsd: (token: string) => CacheKeyConfig;
+    LendingTokenPriceAsEgld: (token: string) => CacheKeyConfig;
+    LendingOverallStats: () => CacheKeyConfig;
+    LendingTopMarketParticipants: (token: string) => CacheKeyConfig;
+    LendingMarketParticipantsCount: (token: string) => CacheKeyConfig;
+    LendingPositionLeaderboard: (hash: string) => CacheKeyConfig;
+    LendingEModeCategoryProfileDoc: (id: string) => CacheKeyConfig;
+    LendingMarketStatsGraphData: (startTime: string, endTime: string, bin: string, token?: string) => CacheKeyConfig;
+    LendingMarketAverageGraphData: (token: string) => CacheKeyConfig;
+    EventProfileDoc: (eventId: string) => CacheKeyConfig;
+    EventStageDoc: (eventId: string, stageId: string) => CacheKeyConfig;
+    EventTicketProfileDoc: (eventId: string, ticketId: string) => CacheKeyConfig;
+    EventGuestDoc: (eventId: string, address: string) => CacheKeyConfig;
+    EventStartsFromPrice: (eventId: string) => CacheKeyConfig;
+    EventQuestions: (eventId: string) => CacheKeyConfig;
+    EventVoucherDoc: (eventId: string, voucherId: string) => CacheKeyConfig;
+    EventUserRoleDoc: (eventId: string, address: string) => CacheKeyConfig;
+    EventGuestSummary: (eventId: string) => CacheKeyConfig;
+    EventVoucherDocByCode: (eventId: string, code: string) => CacheKeyConfig;
+    EventIdBySlug: (slug: string) => CacheKeyConfig;
+    EventReferralConfigDoc: (eventId: string, configId: string) => CacheKeyConfig;
+    EventReferralDoc: (eventId: string, referralCode: string) => CacheKeyConfig;
+    TokenDecimals: (token: string) => CacheKeyConfig;
+    TokenProperties: (tokenIdentifier: string) => CacheKeyConfig;
+    TokenData: (token: string) => CacheKeyConfig;
+    TokenSupply: (token: string) => CacheKeyConfig;
+    TokenSummary: (token: string) => CacheKeyConfig;
+    MvxTokenSummary: (token: string) => CacheKeyConfig;
+    TokenFiatPrice: (fiatCurrencies: string[], token: string) => CacheKeyConfig;
+    TokenUsdcValue: (token: string, timestamp: number) => CacheKeyConfig;
+    LpTokenInfo: (token: string) => CacheKeyConfig;
+    AllSwapTokens: () => CacheKeyConfig;
+    AllTokensMap: () => CacheKeyConfig;
+    AshTokenUsdValue: (token: string) => CacheKeyConfig;
+    AshSupportedTokens: () => CacheKeyConfig;
+    TokenAccountsCount: (token: string) => CacheKeyConfig;
+    TokensByIdentifier: (tokens: string[], returnMap: boolean) => CacheKeyConfig;
+    TokensByFilterString: (identifier: string[], category: string[], chain: string[]) => CacheKeyConfig;
+    FilteredTokenDocs: (identifier: string[], category: string[], chain: string[]) => CacheKeyConfig;
+    LaunchpadAllRegisteredContracts: () => CacheKeyConfig;
+    UserCreatorProfile: (address: string) => CacheKeyConfig;
+    UserCreatorProfileByTag: (creatorTag: string) => CacheKeyConfig;
+    UserCreatorTagRegistered: (tag: string) => CacheKeyConfig;
+    GetCreatorProfileByContractAddress: (contractAddress: string) => CacheKeyConfig;
+    MinterLocalOwner: (address: string) => CacheKeyConfig;
+    MinterUserMintsGlobal: (collectionTag: string, contractAddress: string, userAddress: string) => CacheKeyConfig;
+    MinterUserMintsPerStage: (collectionTag: string, contractAddress: string, userAddress: string, stageName: string) => CacheKeyConfig;
+    MinterMintShareholders: (collectionTag: string, contractAddress: string) => CacheKeyConfig;
+    MinterRoyaltiesShareholders: (contractAddress: string) => CacheKeyConfig;
+    MinterIsUserWhitelisted: (collectionTag: string, contractAddress: string, userAddress: string, stageName: string) => CacheKeyConfig;
+    CurrentEpoch: () => CacheKeyConfig;
+    EpochEndTimestamp: () => CacheKeyConfig;
+    ShardCount: () => CacheKeyConfig;
+    CurrentTokenValue: () => CacheKeyConfig;
+    NextRelayWalletIndex: (shard: number) => CacheKeyConfig;
+    AccumulatorCreators: () => CacheKeyConfig;
+    LowVolumeCollections: () => CacheKeyConfig;
+    EGLDLiquidStats: () => CacheKeyConfig;
+    XoxnoLiquidStats: () => CacheKeyConfig;
+    XoxnoLiquidApy: () => CacheKeyConfig;
+    ExchangeRateLiquidXOXNO: () => CacheKeyConfig;
+    ExchangeRateLiquidXOXNOEGLD: () => CacheKeyConfig;
+    SEgldExchangeRate: () => CacheKeyConfig;
+    FeesXOXNOEGLD: () => CacheKeyConfig;
+    PendingDelegateXOXNOEGLD: () => CacheKeyConfig;
+    VirtualEGLDReserveXOXNOEGLD: () => CacheKeyConfig;
+    TotalWithdrawnXOXNOEGLD: () => CacheKeyConfig;
+    ValidatorsLiquidXOXNOEGLD: () => CacheKeyConfig;
+    AprLiquidXOXNOEGLD: () => CacheKeyConfig;
+    PendingUnstakeXOXNOEGLD: () => CacheKeyConfig;
+    GovernanceVotesProviders: () => CacheKeyConfig;
+    GovernanceVotes: () => CacheKeyConfig;
+    PerpSpotBalance: (user: string, coin: string) => CacheKeyConfig;
+    PerpPerpBalance: (user: string, coin: string) => CacheKeyConfig;
+    PerpOpenOrders: (user: string) => CacheKeyConfig;
+    PerpFilledOrders: (user: string) => CacheKeyConfig;
+    PerpSpotUsers: () => CacheKeyConfig;
+    PerpTermsAccepted: (user: string) => CacheKeyConfig;
+    GetBoberBattleBiggestWinners: () => CacheKeyConfig;
+    GetAllBoberBattleTokens: () => CacheKeyConfig;
+    BoberWheelWinners: () => CacheKeyConfig;
+    BoberWheelConfig: () => CacheKeyConfig;
+    BoberWheelScheduledSpin: () => CacheKeyConfig;
+    BoberBattleLeaderboard: (hash: string) => CacheKeyConfig;
+    BoberBattleSingleLeaderboard: (hash: string) => CacheKeyConfig;
+    AllGroupChatIds: () => CacheKeyConfig;
+    GroupChatProfile: (chatId: string) => CacheKeyConfig;
+    ConversationDeleteTimestamp: (chatId: string, address: string) => CacheKeyConfig;
+    IsSenderBlockedByReceiver: (sender: string, receiver: string) => CacheKeyConfig;
+    UserLastReadChatMessage: (chatId: string, address: string) => CacheKeyConfig;
+    UserLastSentChatMessage: (chatId: string, address: string) => CacheKeyConfig;
+    Web2NativeWalletAddress: (userId: string) => CacheKeyConfig;
+    Web2UserDoc: (userId: string) => CacheKeyConfig;
+    LocationPolygon: (query: string) => CacheKeyConfig;
+    GetCountries: () => CacheKeyConfig;
+    PinnedNftsApiResponse: () => CacheKeyConfig;
+    DropsPinnedCollectionsApiResponse: () => CacheKeyConfig;
+    HomePinnedCollectionsApiResponse: () => CacheKeyConfig;
+    ListingCount: (chain?: string[]) => CacheKeyConfig;
+    TradingStatistics: (chain?: string[]) => CacheKeyConfig;
+    HatomTokenValues: () => CacheKeyConfig;
+    PendingExternalPayments: () => CacheKeyConfig;
+    TwispayCallbackProcessed: (transactionId: string) => CacheKeyConfig;
+    ActivityQuery: (queryHash: string) => CacheKeyConfig;
+    VolumeGraphData: (startTime: string, endTime: string, bin: string, collection?: string, chain?: string[]) => CacheKeyConfig;
+    GlobalSearch: (filter: string) => CacheKeyConfig;
+    DropsSearch: (filter: string) => CacheKeyConfig;
+    DataApiTokens: () => CacheKeyConfig;
+    DataApiTokenPrice: (identifier: string, dateString: string, isCurrentDate: boolean) => CacheKeyConfig;
+    GetAbi: (abiName: string) => CacheKeyConfig;
+    SuiTransactionSender: (txDigest: string) => CacheKeyConfig;
+    SuiObject: (objectId: string) => CacheKeyConfig;
+    SuiEvents: (packageId: string, startTime: number, endTime: number, eventTypes: string[]) => CacheKeyConfig;
+    SuiUserCoins: (userAddress: string) => CacheKeyConfig;
+    SuiCollectionInfo: (collectionType: string) => CacheKeyConfig;
+    SuiAllCollectionTypes: () => CacheKeyConfig;
+    SuiTokenPrices: (coinTypes: string[]) => CacheKeyConfig;
+    SuiQueryEventsPage: (moveEventType: string, order: "ascending" | "descending" | null | undefined, limit: number | null | undefined, cursor: {
+        txDigest: string;
+        eventSeq: string;
+    } | null | undefined) => CacheKeyConfig;
+    KustoXoxnoLiquidStats: () => CacheKeyConfig;
+    KustoEgldLiquidStats: () => CacheKeyConfig;
+};
+/**
+ * Cache key patterns for invalidation.
+ * Used by az-functions to find and delete related cache entries.
+ *
+ * @deprecated Use CacheIndexKeys with index sets instead of SCAN patterns.
+ * SCAN is expensive in serverless environments and causes connection saturation.
+ */
+export declare const CachePatterns: {
+    UserAll: (address: string) => string;
+    CollectionAll: (collection: string) => string;
+    NftAll: (identifier: string) => string;
+    StakingPoolAll: (poolId: number) => string;
+    LendingTokenAll: (token: string) => string;
+    EventAll: (eventId: string) => string;
+};
+/**
+ * Index set keys for efficient cache invalidation.
+ *
+ * Instead of using SCAN to find cache keys by pattern (expensive in serverless),
+ * we maintain Redis SETs that track which cache keys belong to which collection/address.
+ *
+ * Usage:
+ * - API: When setting a cache, also SADD the key to relevant index sets
+ * - Azure Functions: When invalidating, use SMEMBERS to get keys from index sets
+ *
+ * This reduces O(n) SCAN operations to O(1) SMEMBERS lookups.
+ */
+export declare const CacheIndexKeys: {
+    /**
+     * Index of all NFT query cache keys for a specific collection.
+     * When API caches an NFT query result, it adds the cache key to this set.
+     * When invalidating, az-functions reads this set instead of SCAN.
+     */
+    NftQueryByCollection: (collection: string) => string;
+    /**
+     * Index of all NFT query cache keys for a specific address (owner, seller).
+     */
+    NftQueryByAddress: (address: string) => string;
+    /**
+     * Index of all global/wildcard NFT query cache keys (explore pages).
+     * These are queries with no specific collection or address filter.
+     */
+    NftQueryGlobal: string;
+    OfferQueryByCollection: (collection: string) => string;
+    OfferQueryByAddress: (address: string) => string;
+    OfferQueryByIdentifier: (identifier: string) => string;
+    OfferQueryGlobal: string;
+    CollectionQueryByTicker: (ticker: string) => string;
+    CollectionStatsQueryByTicker: (ticker: string) => string;
+    CollectionOffersQueryByTicker: (ticker: string) => string;
+    CollectionQueryGlobal: string;
+    ActivityQueryByCollection: (collection: string) => string;
+    ActivityQueryByAddress: (address: string) => string;
+    ActivityQueryGlobal: string;
+};
+/**
+ * Metadata for cache index registration.
+ * When setting a cache key, this metadata determines which index sets to add it to.
+ */
+export interface CacheIndexMetadata {
+    /** Collections that this cache key relates to */
+    collections?: string[];
+    /** Addresses (owners, sellers, buyers) that this cache key relates to */
+    addresses?: string[];
+    /** NFT identifiers that this cache key relates to */
+    identifiers?: string[];
+    /** True if this is a global/wildcard query (no specific filters) */
+    isGlobal?: boolean;
+}
+/**
+ * Type of query cache for determining which index keys to use.
+ */
+export type CacheIndexType = 'nft' | 'offer' | 'collection' | 'activity';