@provable-games/budokan-sdk 0.1.23 → 0.1.25

package/dist/{player-BUynfv7D.d.cts → player-P6Dd1lNb.d.cts}

@@ -53,10 +53,29 @@ interface Tournament {
     leaderboardGameMustBeOver: boolean | null;
     entryFeeToken: string | null;
     entryFeeAmount: string | null;
+    /**
+     * Effective protocol-fee rate (basis points) snapshotted for this tournament
+     * at creation — the slice of the built-in entry-fee pool routed to the DAO
+     * buyback/treasury. `0` when no protocol fee applies. Sourced from the
+     * `TournamentCreated` event via the indexer/API; `null` over the RPC/viewer
+     * data source (the per-tournament snapshot has no on-chain getter).
+     */
+    protocolFeeShare: number | null;
     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 +175,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,19 +192,49 @@ 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;
 }
+type Erc20Prize = Prize & {
+    tokenType: "erc20";
+    tokenAddress: string;
+    amount: string;
+    tokenId: null;
+    extensionAddress: null;
+    extensionConfig: null;
+};
+type Erc721Prize = Prize & {
+    tokenType: "erc721";
+    tokenAddress: string;
+    amount: null;
+    tokenId: string;
+    extensionAddress: null;
+    extensionConfig: null;
+};
+type TokenPrize = Erc20Prize | Erc721Prize;
+type ExtensionPrize = Prize & {
+    tokenType: "extension";
+    tokenAddress: null;
+    amount: null;
+    tokenId: null;
+    extensionAddress: string;
+    extensionConfig: string[] | null;
+};
 /**
- * Discriminator for `RewardClaim.claimKind`. Picks one of the six terminal
+ * Discriminator for `RewardClaim.claimKind`. Picks one of the seven terminal
  * variants of the on-chain `RewardType` enum (Prize::Single, Prize::Distributed,
- * EntryFee::Position / TournamentCreator / GameCreator / Refund). The
- * 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.
+ * EntryFee::Position / TournamentCreator / GameCreator / Refund / ProtocolFee).
+ * The variant-specific fields below are populated only for the kinds that carry
+ * them; the three pure-marker kinds (tournament_creator, game_creator,
+ * protocol_fee) 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_protocol_fee" | "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 +242,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 {
@@ -517,4 +576,4 @@ interface PlayerRewards {
     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 };
+export { BudokanClient as B, type ConnectionMode as C, type DataSource as D, type ExtensionPrize as E, 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 TokenPrize as i, type BudokanClientConfig as j, ConnectionStatus as k, type ConnectionStatusState as l, type Erc20Prize as m, type Erc721Prize as n, type LeaderboardEntry as o, type Phase as p, type PlayerPlacement as q, type PlayerRewards as r, type WSChannel as s, type WSEventMessage as t, type WSMessage as u, type WSSubscribeMessage as v, type WSUnsubscribeMessage as w, createBudokanClient as x };

package/dist/{player-BUynfv7D.d.ts → player-P6Dd1lNb.d.ts}

@@ -53,10 +53,29 @@ interface Tournament {
     leaderboardGameMustBeOver: boolean | null;
     entryFeeToken: string | null;
     entryFeeAmount: string | null;
+    /**
+     * Effective protocol-fee rate (basis points) snapshotted for this tournament
+     * at creation — the slice of the built-in entry-fee pool routed to the DAO
+     * buyback/treasury. `0` when no protocol fee applies. Sourced from the
+     * `TournamentCreated` event via the indexer/API; `null` over the RPC/viewer
+     * data source (the per-tournament snapshot has no on-chain getter).
+     */
+    protocolFeeShare: number | null;
     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 +175,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,19 +192,49 @@ 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;
 }
+type Erc20Prize = Prize & {
+    tokenType: "erc20";
+    tokenAddress: string;
+    amount: string;
+    tokenId: null;
+    extensionAddress: null;
+    extensionConfig: null;
+};
+type Erc721Prize = Prize & {
+    tokenType: "erc721";
+    tokenAddress: string;
+    amount: null;
+    tokenId: string;
+    extensionAddress: null;
+    extensionConfig: null;
+};
+type TokenPrize = Erc20Prize | Erc721Prize;
+type ExtensionPrize = Prize & {
+    tokenType: "extension";
+    tokenAddress: null;
+    amount: null;
+    tokenId: null;
+    extensionAddress: string;
+    extensionConfig: string[] | null;
+};
 /**
- * Discriminator for `RewardClaim.claimKind`. Picks one of the six terminal
+ * Discriminator for `RewardClaim.claimKind`. Picks one of the seven terminal
  * variants of the on-chain `RewardType` enum (Prize::Single, Prize::Distributed,
- * EntryFee::Position / TournamentCreator / GameCreator / Refund). The
- * 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.
+ * EntryFee::Position / TournamentCreator / GameCreator / Refund / ProtocolFee).
+ * The variant-specific fields below are populated only for the kinds that carry
+ * them; the three pure-marker kinds (tournament_creator, game_creator,
+ * protocol_fee) 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_protocol_fee" | "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 +242,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 {
@@ -517,4 +576,4 @@ interface PlayerRewards {
     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 };
+export { BudokanClient as B, type ConnectionMode as C, type DataSource as D, type ExtensionPrize as E, 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 TokenPrize as i, type BudokanClientConfig as j, ConnectionStatus as k, type ConnectionStatusState as l, type Erc20Prize as m, type Erc721Prize as n, type LeaderboardEntry as o, type Phase as p, type PlayerPlacement as q, type PlayerRewards as r, type WSChannel as s, type WSEventMessage as t, type WSMessage as u, type WSSubscribeMessage as v, type WSUnsubscribeMessage as w, createBudokanClient as x };