@provable-games/budokan-sdk 0.1.22 → 0.1.24

package/dist/{client-DlXvzneQ.d.cts → player-C2GE9Lop.d.cts}

@@ -56,7 +56,18 @@ interface Tournament {
     hasEntryRequirement: boolean | null;
     schedule: Schedule | null;
     gameConfig: GameConfig | null;
+    /** Built-in entry fee (EntryFeeKind::BuiltIn). Null for free OR extension-fee tournaments. */
     entryFee: EntryFee | null;
+    /**
+     * Discriminates the on-chain `EntryFeeKind`: `"builtin"` (see `entryFee`),
+     * `"extension"` (see `entryFeeExtension`), or `null` when there's no fee.
+     */
+    entryFeeKind: "builtin" | "extension" | null;
+    /** External entry-fee extension (EntryFeeKind::Extension). Set only when entryFeeKind === "extension". */
+    entryFeeExtension: {
+        address: string;
+        config: string[];
+    } | null;
     entryRequirement: EntryRequirement | null;
     leaderboardConfig: LeaderboardConfig | null;
     entryCount: number;
@@ -156,8 +167,14 @@ interface Prize {
     prizeId: string;
     tournamentId: string;
     payoutPosition: number;
-    tokenAddress: string;
-    tokenType: "erc20" | "erc721";
+    /** Token contract for built-in prizes; `null` for `tokenType === "extension"`. */
+    tokenAddress: string | null;
+    /**
+     * `erc20` / `erc721` are built-in token prizes. `extension` is an external
+     * `IPrizeExtension` prize (the #269 path): the token fields below are null
+     * and `extensionAddress` / `extensionConfig` are populated instead.
+     */
+    tokenType: "erc20" | "erc721" | "extension";
     amount: string | null;
     tokenId: string | null;
     distributionType: string | null;
@@ -167,6 +184,10 @@ interface Prize {
     distributionShares: number[] | null;
     distributionCount: number | null;
     sponsorAddress: string;
+    /** Extension contract address; only set when `tokenType === "extension"`. */
+    extensionAddress: string | null;
+    /** Opaque `Span<felt252>` config; only set when `tokenType === "extension"`. */
+    extensionConfig: string[] | null;
 }
 /**
  * Discriminator for `RewardClaim.claimKind`. Picks one of the six terminal
@@ -175,11 +196,11 @@ interface Prize {
  * variant-specific fields below are populated only for the kinds that carry
  * them; the two pure-marker creator kinds leave all four nullable fields null.
  */
-type RewardClaimKind = "prize_single" | "prize_distributed" | "entry_fee_position" | "entry_fee_tournament_creator" | "entry_fee_game_creator" | "entry_fee_refund";
+type RewardClaimKind = "prize_single" | "prize_distributed" | "entry_fee_position" | "entry_fee_tournament_creator" | "entry_fee_game_creator" | "entry_fee_refund" | "prize_extension" | "entry_fee_extension";
 interface RewardClaim {
     tournamentId: string;
     claimKind: RewardClaimKind;
-    /** Populated for `prize_single` and `prize_distributed`. Stringified u64. */
+    /** Populated for `prize_single`, `prize_distributed`, `prize_extension`. Stringified u64. */
     prizeId: string | null;
     /** Populated for `prize_distributed`. */
     payoutIndex: number | null;
@@ -187,6 +208,10 @@ interface RewardClaim {
     position: number | null;
     /** Populated for `entry_fee_refund`. felt252 hex string of the game token. */
     refundTokenId: string | null;
+    /** Game token id, for `prize_extension` / `entry_fee_extension` (Option → null when absent). */
+    extensionTokenId: string | null;
+    /** Opaque payout/claim params (`Span<felt252>`), for the extension claim kinds. */
+    extensionParams: string[] | null;
     claimed: boolean;
 }
 interface PrizeAggregation {
@@ -482,4 +507,39 @@ declare class BudokanClient {
  */
 declare function createBudokanClient(config: BudokanClientConfig): BudokanClient;
 
-export { BudokanClient as B, type ConnectionMode as C, type DataSource as D, type GameConfig as G, type LeaderboardConfig as L, type PrizeAggregation as P, type QualificationEntry as Q, type Registration as R, type Schedule as S, type Tournament as T, type WSSubscribeOptions as W, type Prize as a, type PaginatedResult as b, type RewardClaim as c, type RewardClaimSummary as d, type TournamentListParams as e, type PlatformStats as f, type PrizeStats as g, type WSEventHandler as h, type BudokanClientConfig as i, ConnectionStatus as j, type ConnectionStatusState as k, type LeaderboardEntry as l, type Phase as m, type WSChannel as n, type WSEventMessage as o, type WSMessage as p, type WSSubscribeMessage as q, type WSUnsubscribeMessage as r, createBudokanClient as s };
+/**
+ * One row per (player token, tournament) where the token's final rank fell
+ * inside a paid position. Multiple placements per tournament are possible
+ * when the player owns several tokens entered into the same tournament.
+ */
+interface PlayerPlacement {
+    tournamentId: string;
+    tokenId: string;
+    /** 1-indexed rank in the tournament's final leaderboard. */
+    position: number;
+    /** Token's final score as a decimal string (preserves felt252 precision). */
+    score: string;
+}
+/**
+ * Aggregate rewards summary for a player address. Computed against current
+ * NFT ownership (denshokan), not historical attribution — see PR #243.
+ *
+ * `tournaments`, `prizes`, and `rewardClaims` are restricted to tournaments
+ * where the player has at least one placement. Consumers compute USD values
+ * by walking placements + prize/entry-fee data + token prices client-side.
+ */
+interface PlayerRewards {
+    /** Count of placements that landed on a paid position. */
+    wins: number;
+    /** Lowest position number across all placements; null when no wins. */
+    bestPlacement: number | null;
+    placements: PlayerPlacement[];
+    /** Tournaments where the player placed (subset of currently-held entries). */
+    tournaments: Tournament[];
+    /** All sponsored prizes for those tournaments. */
+    prizes: Prize[];
+    /** All reward claims for those tournaments. */
+    rewardClaims: RewardClaim[];
+}
+
+export { BudokanClient as B, type ConnectionMode as C, type DataSource as D, type GameConfig as G, type LeaderboardConfig as L, type PrizeAggregation as P, type QualificationEntry as Q, type Registration as R, type Schedule as S, type Tournament as T, type WSSubscribeOptions as W, type Prize as a, type PaginatedResult as b, type RewardClaim as c, type RewardClaimSummary as d, type TournamentListParams as e, type PlatformStats as f, type PrizeStats as g, type WSEventHandler as h, type BudokanClientConfig as i, ConnectionStatus as j, type ConnectionStatusState as k, type LeaderboardEntry as l, type Phase as m, type PlayerPlacement as n, type PlayerRewards as o, type WSChannel as p, type WSEventMessage as q, type WSMessage as r, type WSSubscribeMessage as s, type WSUnsubscribeMessage as t, createBudokanClient as u };

package/dist/{client-DlXvzneQ.d.ts → player-C2GE9Lop.d.ts}

@@ -56,7 +56,18 @@ interface Tournament {
     hasEntryRequirement: boolean | null;
     schedule: Schedule | null;
     gameConfig: GameConfig | null;
+    /** Built-in entry fee (EntryFeeKind::BuiltIn). Null for free OR extension-fee tournaments. */
     entryFee: EntryFee | null;
+    /**
+     * Discriminates the on-chain `EntryFeeKind`: `"builtin"` (see `entryFee`),
+     * `"extension"` (see `entryFeeExtension`), or `null` when there's no fee.
+     */
+    entryFeeKind: "builtin" | "extension" | null;
+    /** External entry-fee extension (EntryFeeKind::Extension). Set only when entryFeeKind === "extension". */
+    entryFeeExtension: {
+        address: string;
+        config: string[];
+    } | null;
     entryRequirement: EntryRequirement | null;
     leaderboardConfig: LeaderboardConfig | null;
     entryCount: number;
@@ -156,8 +167,14 @@ interface Prize {
     prizeId: string;
     tournamentId: string;
     payoutPosition: number;
-    tokenAddress: string;
-    tokenType: "erc20" | "erc721";
+    /** Token contract for built-in prizes; `null` for `tokenType === "extension"`. */
+    tokenAddress: string | null;
+    /**
+     * `erc20` / `erc721` are built-in token prizes. `extension` is an external
+     * `IPrizeExtension` prize (the #269 path): the token fields below are null
+     * and `extensionAddress` / `extensionConfig` are populated instead.
+     */
+    tokenType: "erc20" | "erc721" | "extension";
     amount: string | null;
     tokenId: string | null;
     distributionType: string | null;
@@ -167,6 +184,10 @@ interface Prize {
     distributionShares: number[] | null;
     distributionCount: number | null;
     sponsorAddress: string;
+    /** Extension contract address; only set when `tokenType === "extension"`. */
+    extensionAddress: string | null;
+    /** Opaque `Span<felt252>` config; only set when `tokenType === "extension"`. */
+    extensionConfig: string[] | null;
 }
 /**
  * Discriminator for `RewardClaim.claimKind`. Picks one of the six terminal
@@ -175,11 +196,11 @@ interface Prize {
  * variant-specific fields below are populated only for the kinds that carry
  * them; the two pure-marker creator kinds leave all four nullable fields null.
  */
-type RewardClaimKind = "prize_single" | "prize_distributed" | "entry_fee_position" | "entry_fee_tournament_creator" | "entry_fee_game_creator" | "entry_fee_refund";
+type RewardClaimKind = "prize_single" | "prize_distributed" | "entry_fee_position" | "entry_fee_tournament_creator" | "entry_fee_game_creator" | "entry_fee_refund" | "prize_extension" | "entry_fee_extension";
 interface RewardClaim {
     tournamentId: string;
     claimKind: RewardClaimKind;
-    /** Populated for `prize_single` and `prize_distributed`. Stringified u64. */
+    /** Populated for `prize_single`, `prize_distributed`, `prize_extension`. Stringified u64. */
     prizeId: string | null;
     /** Populated for `prize_distributed`. */
     payoutIndex: number | null;
@@ -187,6 +208,10 @@ interface RewardClaim {
     position: number | null;
     /** Populated for `entry_fee_refund`. felt252 hex string of the game token. */
     refundTokenId: string | null;
+    /** Game token id, for `prize_extension` / `entry_fee_extension` (Option → null when absent). */
+    extensionTokenId: string | null;
+    /** Opaque payout/claim params (`Span<felt252>`), for the extension claim kinds. */
+    extensionParams: string[] | null;
     claimed: boolean;
 }
 interface PrizeAggregation {
@@ -482,4 +507,39 @@ declare class BudokanClient {
  */
 declare function createBudokanClient(config: BudokanClientConfig): BudokanClient;
 
-export { BudokanClient as B, type ConnectionMode as C, type DataSource as D, type GameConfig as G, type LeaderboardConfig as L, type PrizeAggregation as P, type QualificationEntry as Q, type Registration as R, type Schedule as S, type Tournament as T, type WSSubscribeOptions as W, type Prize as a, type PaginatedResult as b, type RewardClaim as c, type RewardClaimSummary as d, type TournamentListParams as e, type PlatformStats as f, type PrizeStats as g, type WSEventHandler as h, type BudokanClientConfig as i, ConnectionStatus as j, type ConnectionStatusState as k, type LeaderboardEntry as l, type Phase as m, type WSChannel as n, type WSEventMessage as o, type WSMessage as p, type WSSubscribeMessage as q, type WSUnsubscribeMessage as r, createBudokanClient as s };
+/**
+ * One row per (player token, tournament) where the token's final rank fell
+ * inside a paid position. Multiple placements per tournament are possible
+ * when the player owns several tokens entered into the same tournament.
+ */
+interface PlayerPlacement {
+    tournamentId: string;
+    tokenId: string;
+    /** 1-indexed rank in the tournament's final leaderboard. */
+    position: number;
+    /** Token's final score as a decimal string (preserves felt252 precision). */
+    score: string;
+}
+/**
+ * Aggregate rewards summary for a player address. Computed against current
+ * NFT ownership (denshokan), not historical attribution — see PR #243.
+ *
+ * `tournaments`, `prizes`, and `rewardClaims` are restricted to tournaments
+ * where the player has at least one placement. Consumers compute USD values
+ * by walking placements + prize/entry-fee data + token prices client-side.
+ */
+interface PlayerRewards {
+    /** Count of placements that landed on a paid position. */
+    wins: number;
+    /** Lowest position number across all placements; null when no wins. */
+    bestPlacement: number | null;
+    placements: PlayerPlacement[];
+    /** Tournaments where the player placed (subset of currently-held entries). */
+    tournaments: Tournament[];
+    /** All sponsored prizes for those tournaments. */
+    prizes: Prize[];
+    /** All reward claims for those tournaments. */
+    rewardClaims: RewardClaim[];
+}
+
+export { BudokanClient as B, type ConnectionMode as C, type DataSource as D, type GameConfig as G, type LeaderboardConfig as L, type PrizeAggregation as P, type QualificationEntry as Q, type Registration as R, type Schedule as S, type Tournament as T, type WSSubscribeOptions as W, type Prize as a, type PaginatedResult as b, type RewardClaim as c, type RewardClaimSummary as d, type TournamentListParams as e, type PlatformStats as f, type PrizeStats as g, type WSEventHandler as h, type BudokanClientConfig as i, ConnectionStatus as j, type ConnectionStatusState as k, type LeaderboardEntry as l, type Phase as m, type PlayerPlacement as n, type PlayerRewards as o, type WSChannel as p, type WSEventMessage as q, type WSMessage as r, type WSSubscribeMessage as s, type WSUnsubscribeMessage as t, createBudokanClient as u };