@orderly.network/trading-leaderboard 2.6.2-alpha.0 → 2.6.3-alpha.0

package/dist/index.d.mts

@@ -208,6 +208,7 @@ interface PrizePool {
     currency: string;
     metric: "volume" | "pnl";
     tiers: PrizePoolTier[];
+    volume_limit?: number;
 }
 interface TicketTierRule {
     value: number;
@@ -229,12 +230,14 @@ interface CampaignConfig {
     campaign_id: number | string;
     title: string;
     description: string;
+    register_time?: string;
     start_time: string;
     end_time: string;
     reward_distribution_time?: string;
     volume_scope?: string | string[];
     referral_codes?: string[] | string;
     prize_pools?: PrizePool[];
+    tiered_prize_pools?: Array<PrizePool[]>;
     ticket_rules?: TicketRules;
     image?: string;
     rule_url?: string;
@@ -256,6 +259,10 @@ interface CampaignConfig {
         terms: DescriptionItem[];
         ruleConfig?: DescriptionConfig;
     };
+    leaderboard_config?: LeaderboardConfig;
+}
+interface LeaderboardConfig {
+    use_general_leaderboard?: boolean;
     exclude_leaderboard_columns?: RankingColumnFields[];
 }
 interface UserData {
@@ -321,6 +328,11 @@ type TradingLeaderboardState = {
             records_per_page: number;
         };
     };
+    campaignDateRange?: {
+        start_time: Date | string;
+        end_time: Date | string;
+    };
+    statistics?: CampaignStatistics;
 };
 /**
  * Trading leaderboard context
@@ -368,6 +380,7 @@ declare function useCampaignRankingScript(options: CampaignRankingScriptOptions)
 type DateRange = {
     from?: Date;
     to?: Date;
+    label?: string;
 };
 declare enum LeaderboardTab {
     Volume = "volume",
@@ -391,7 +404,7 @@ type GeneralRankingData = {
 };
 type GeneralRankingScriptReturn = ReturnType<typeof useGeneralRankingScript>;
 type GeneralRankingScriptOptions = {
-    dateRange?: DateRange;
+    dateRange?: DateRange | null;
     address?: string;
     sortKey?: "perp_volume" | "realized_pnl";
 };
@@ -424,12 +437,27 @@ declare const GeneralRankingWidget: FC<GeneralRankingWidgetProps>;
 type CampaignRankingWidgetProps = Pick<RankingProps, "style" | "className" | "fields"> & CampaignRankingScriptOptions;
 declare const CampaignRankingWidget: FC<CampaignRankingWidgetProps>;
 
+type WeeklyDateRange = {
+    from: Date;
+    to: Date;
+    label: string;
+};
+
 type GeneralLeaderboardScriptReturn = ReturnType<typeof useGeneralLeaderboardScript>;
 declare const FilterDays: readonly [7, 14, 30, 90];
 type TFilterDays = (typeof FilterDays)[number];
-declare function useGeneralLeaderboardScript(): {
+type GeneralLeaderboardScriptOptions = {
+    campaignDateRange?: {
+        start_time: Date | string;
+        end_time: Date | string;
+    };
+};
+declare function useGeneralLeaderboardScript(options?: GeneralLeaderboardScriptOptions): {
     activeTab: LeaderboardTab;
     onTabChange: react.Dispatch<react.SetStateAction<LeaderboardTab>>;
+    useCampaignDateRange: boolean;
+    weeklyRanges: WeeklyDateRange[];
+    currentOrAllTimeRange: WeeklyDateRange | undefined;
     searchValue: string;
     onSearchValueChange: (value: string) => void;
     clearSearchValue: () => void;
@@ -441,15 +469,20 @@ declare function useGeneralLeaderboardScript(): {
     dateRange: DateRange;
     filterDay: 30 | 7 | 14 | 90 | null;
     updateFilterDay: (day: TFilterDays) => void;
+    setDateRange: react.Dispatch<react.SetStateAction<DateRange>>;
 };
 
 type GeneralLeaderboardProps = {
     style?: React.CSSProperties;
     className?: string;
+    campaignDateRange?: {
+        start_time: Date | string;
+        end_time: Date | string;
+    };
 } & GeneralLeaderboardScriptReturn;
 declare const GeneralLeaderboard: FC<GeneralLeaderboardProps>;
 
-type GeneralLeaderboardWidgetProps = Pick<GeneralLeaderboardProps, "style" | "className">;
+type GeneralLeaderboardWidgetProps = Pick<GeneralLeaderboardProps, "style" | "className" | "campaignDateRange">;
 declare const GeneralLeaderboardWidget: FC<GeneralLeaderboardWidgetProps>;
 
 type CampaignLeaderboardScriptReturn = ReturnType<typeof useCampaignLeaderboardScript>;
@@ -484,4 +517,4 @@ declare const LeaderboardTitle: (props: {
     isMobile?: boolean;
 }) => react_jsx_runtime.JSX.Element;
 
-export { type Campaign, type CampaignConfig, CampaignLeaderboard, type CampaignLeaderboardProps, CampaignLeaderboardWidget, type CampaignLeaderboardWidgetProps, CampaignRankingWidget, type CampaignRankingWidgetProps, type CampaignStatistics, type CampaignStatsDetailsResponse, type CampaignStatsResponse, CampaignTagEnum, Campaigns, type CampaignsProps, CampaignsWidget, GeneralLeaderboard, type GeneralLeaderboardProps, GeneralLeaderboardWidget, type GeneralLeaderboardWidgetProps, GeneralRankingWidget, type GeneralRankingWidgetProps, Leaderboard, LeaderboardPage, type LeaderboardPageProps, type LeaderboardProps, LeaderboardSection, LeaderboardTitle, LeaderboardWidget, type LeaderboardWidgetProps, type PrizePool, type PrizePoolTier, Ranking, type RankingProps, type TicketLinearRule, type TicketRules, type TicketTierRule, TradingLeaderboardContext, TradingLeaderboardProvider, type TradingLeaderboardProviderProps, type TradingLeaderboardState, TradingList, type TradingListProps, TradingListWidget, type TradingListWidgetProps, type UserCampaignsResponse, type UserData, useCampaignLeaderboardScript, useCampaignRankingScript, useCampaignsScript, useGeneralLeaderboardScript, useGeneralRankingScript, useLeaderboardScript, useTradingLeaderboardContext, useTradingListScript };
+export { type Campaign, type CampaignConfig, CampaignLeaderboard, type CampaignLeaderboardProps, CampaignLeaderboardWidget, type CampaignLeaderboardWidgetProps, CampaignRankingWidget, type CampaignRankingWidgetProps, type CampaignStatistics, type CampaignStatsDetailsResponse, type CampaignStatsResponse, CampaignTagEnum, Campaigns, type CampaignsProps, CampaignsWidget, GeneralLeaderboard, type GeneralLeaderboardProps, GeneralLeaderboardWidget, type GeneralLeaderboardWidgetProps, GeneralRankingWidget, type GeneralRankingWidgetProps, Leaderboard, type LeaderboardConfig, LeaderboardPage, type LeaderboardPageProps, type LeaderboardProps, LeaderboardSection, LeaderboardTitle, LeaderboardWidget, type LeaderboardWidgetProps, type PrizePool, type PrizePoolTier, Ranking, type RankingProps, type TicketLinearRule, type TicketRules, type TicketTierRule, TradingLeaderboardContext, TradingLeaderboardProvider, type TradingLeaderboardProviderProps, type TradingLeaderboardState, TradingList, type TradingListProps, TradingListWidget, type TradingListWidgetProps, type UserCampaignsResponse, type UserData, useCampaignLeaderboardScript, useCampaignRankingScript, useCampaignsScript, useGeneralLeaderboardScript, useGeneralRankingScript, useLeaderboardScript, useTradingLeaderboardContext, useTradingListScript };

package/dist/index.d.ts

@@ -208,6 +208,7 @@ interface PrizePool {
     currency: string;
     metric: "volume" | "pnl";
     tiers: PrizePoolTier[];
+    volume_limit?: number;
 }
 interface TicketTierRule {
     value: number;
@@ -229,12 +230,14 @@ interface CampaignConfig {
     campaign_id: number | string;
     title: string;
     description: string;
+    register_time?: string;
     start_time: string;
     end_time: string;
     reward_distribution_time?: string;
     volume_scope?: string | string[];
     referral_codes?: string[] | string;
     prize_pools?: PrizePool[];
+    tiered_prize_pools?: Array<PrizePool[]>;
     ticket_rules?: TicketRules;
     image?: string;
     rule_url?: string;
@@ -256,6 +259,10 @@ interface CampaignConfig {
         terms: DescriptionItem[];
         ruleConfig?: DescriptionConfig;
     };
+    leaderboard_config?: LeaderboardConfig;
+}
+interface LeaderboardConfig {
+    use_general_leaderboard?: boolean;
     exclude_leaderboard_columns?: RankingColumnFields[];
 }
 interface UserData {
@@ -321,6 +328,11 @@ type TradingLeaderboardState = {
             records_per_page: number;
         };
     };
+    campaignDateRange?: {
+        start_time: Date | string;
+        end_time: Date | string;
+    };
+    statistics?: CampaignStatistics;
 };
 /**
  * Trading leaderboard context
@@ -368,6 +380,7 @@ declare function useCampaignRankingScript(options: CampaignRankingScriptOptions)
 type DateRange = {
     from?: Date;
     to?: Date;
+    label?: string;
 };
 declare enum LeaderboardTab {
     Volume = "volume",
@@ -391,7 +404,7 @@ type GeneralRankingData = {
 };
 type GeneralRankingScriptReturn = ReturnType<typeof useGeneralRankingScript>;
 type GeneralRankingScriptOptions = {
-    dateRange?: DateRange;
+    dateRange?: DateRange | null;
     address?: string;
     sortKey?: "perp_volume" | "realized_pnl";
 };
@@ -424,12 +437,27 @@ declare const GeneralRankingWidget: FC<GeneralRankingWidgetProps>;
 type CampaignRankingWidgetProps = Pick<RankingProps, "style" | "className" | "fields"> & CampaignRankingScriptOptions;
 declare const CampaignRankingWidget: FC<CampaignRankingWidgetProps>;
 
+type WeeklyDateRange = {
+    from: Date;
+    to: Date;
+    label: string;
+};
+
 type GeneralLeaderboardScriptReturn = ReturnType<typeof useGeneralLeaderboardScript>;
 declare const FilterDays: readonly [7, 14, 30, 90];
 type TFilterDays = (typeof FilterDays)[number];
-declare function useGeneralLeaderboardScript(): {
+type GeneralLeaderboardScriptOptions = {
+    campaignDateRange?: {
+        start_time: Date | string;
+        end_time: Date | string;
+    };
+};
+declare function useGeneralLeaderboardScript(options?: GeneralLeaderboardScriptOptions): {
     activeTab: LeaderboardTab;
     onTabChange: react.Dispatch<react.SetStateAction<LeaderboardTab>>;
+    useCampaignDateRange: boolean;
+    weeklyRanges: WeeklyDateRange[];
+    currentOrAllTimeRange: WeeklyDateRange | undefined;
     searchValue: string;
     onSearchValueChange: (value: string) => void;
     clearSearchValue: () => void;
@@ -441,15 +469,20 @@ declare function useGeneralLeaderboardScript(): {
     dateRange: DateRange;
     filterDay: 30 | 7 | 14 | 90 | null;
     updateFilterDay: (day: TFilterDays) => void;
+    setDateRange: react.Dispatch<react.SetStateAction<DateRange>>;
 };
 
 type GeneralLeaderboardProps = {
     style?: React.CSSProperties;
     className?: string;
+    campaignDateRange?: {
+        start_time: Date | string;
+        end_time: Date | string;
+    };
 } & GeneralLeaderboardScriptReturn;
 declare const GeneralLeaderboard: FC<GeneralLeaderboardProps>;
 
-type GeneralLeaderboardWidgetProps = Pick<GeneralLeaderboardProps, "style" | "className">;
+type GeneralLeaderboardWidgetProps = Pick<GeneralLeaderboardProps, "style" | "className" | "campaignDateRange">;
 declare const GeneralLeaderboardWidget: FC<GeneralLeaderboardWidgetProps>;
 
 type CampaignLeaderboardScriptReturn = ReturnType<typeof useCampaignLeaderboardScript>;
@@ -484,4 +517,4 @@ declare const LeaderboardTitle: (props: {
     isMobile?: boolean;
 }) => react_jsx_runtime.JSX.Element;
 
-export { type Campaign, type CampaignConfig, CampaignLeaderboard, type CampaignLeaderboardProps, CampaignLeaderboardWidget, type CampaignLeaderboardWidgetProps, CampaignRankingWidget, type CampaignRankingWidgetProps, type CampaignStatistics, type CampaignStatsDetailsResponse, type CampaignStatsResponse, CampaignTagEnum, Campaigns, type CampaignsProps, CampaignsWidget, GeneralLeaderboard, type GeneralLeaderboardProps, GeneralLeaderboardWidget, type GeneralLeaderboardWidgetProps, GeneralRankingWidget, type GeneralRankingWidgetProps, Leaderboard, LeaderboardPage, type LeaderboardPageProps, type LeaderboardProps, LeaderboardSection, LeaderboardTitle, LeaderboardWidget, type LeaderboardWidgetProps, type PrizePool, type PrizePoolTier, Ranking, type RankingProps, type TicketLinearRule, type TicketRules, type TicketTierRule, TradingLeaderboardContext, TradingLeaderboardProvider, type TradingLeaderboardProviderProps, type TradingLeaderboardState, TradingList, type TradingListProps, TradingListWidget, type TradingListWidgetProps, type UserCampaignsResponse, type UserData, useCampaignLeaderboardScript, useCampaignRankingScript, useCampaignsScript, useGeneralLeaderboardScript, useGeneralRankingScript, useLeaderboardScript, useTradingLeaderboardContext, useTradingListScript };
+export { type Campaign, type CampaignConfig, CampaignLeaderboard, type CampaignLeaderboardProps, CampaignLeaderboardWidget, type CampaignLeaderboardWidgetProps, CampaignRankingWidget, type CampaignRankingWidgetProps, type CampaignStatistics, type CampaignStatsDetailsResponse, type CampaignStatsResponse, CampaignTagEnum, Campaigns, type CampaignsProps, CampaignsWidget, GeneralLeaderboard, type GeneralLeaderboardProps, GeneralLeaderboardWidget, type GeneralLeaderboardWidgetProps, GeneralRankingWidget, type GeneralRankingWidgetProps, Leaderboard, type LeaderboardConfig, LeaderboardPage, type LeaderboardPageProps, type LeaderboardProps, LeaderboardSection, LeaderboardTitle, LeaderboardWidget, type LeaderboardWidgetProps, type PrizePool, type PrizePoolTier, Ranking, type RankingProps, type TicketLinearRule, type TicketRules, type TicketTierRule, TradingLeaderboardContext, TradingLeaderboardProvider, type TradingLeaderboardProviderProps, type TradingLeaderboardState, TradingList, type TradingListProps, TradingListWidget, type TradingListWidgetProps, type UserCampaignsResponse, type UserData, useCampaignLeaderboardScript, useCampaignRankingScript, useCampaignsScript, useGeneralLeaderboardScript, useGeneralRankingScript, useLeaderboardScript, useTradingLeaderboardContext, useTradingListScript };