@provable-games/metagame-sdk 0.1.0 → 0.1.2

package/dist/extensions-BskkhEHk.d.cts

@@ -0,0 +1,101 @@
+import { BigNumberish } from 'starknet';
+
+/**
+ * RPC calls for EGS entry requirement extensions.
+ *
+ * These functions call the shared extension contracts on Starknet.
+ * They take a starknet.js provider (or any object with callContract)
+ * and return parsed results.
+ *
+ * Every metagame that uses the entry requirement system needs these
+ * same calls — they're not app-specific, they call the same contracts.
+ */
+
+/** Minimal provider interface — anything with callContract works */
+interface StarknetCallProvider {
+    callContract(call: {
+        contractAddress: string;
+        entrypoint: string;
+        calldata: string[];
+    }): Promise<string[]>;
+}
+/**
+ * Check if a player has a valid entry for an extension-gated event.
+ *
+ * Calls `valid_entry(context_id, player_address, qualification)` on the
+ * extension contract.
+ *
+ * @param provider - Starknet RPC provider
+ * @param extensionAddress - The extension contract address
+ * @param contextId - The metagame event ID (tournament ID, quest ID, etc.)
+ * @param playerAddress - The player's address
+ * @param qualification - Proof data (felt252 array)
+ * @returns Whether the entry is valid
+ */
+declare function checkExtensionValidEntry(provider: StarknetCallProvider, extensionAddress: string, contextId: BigNumberish, playerAddress: string, qualification: string[]): Promise<boolean>;
+/**
+ * Get the number of entries left for a player via an extension.
+ *
+ * Calls `entries_left(context_id, player_address, qualification)` on the
+ * extension contract. Returns null if the extension has no entry limit
+ * (Option::None).
+ *
+ * @returns Number of entries remaining, or null if unlimited
+ */
+declare function getExtensionEntriesLeft(provider: StarknetCallProvider, extensionAddress: string, contextId: BigNumberish, playerAddress: string, qualification: string[]): Promise<number | null>;
+/**
+ * Check if a player's entry should be banned via an extension.
+ *
+ * Calls `should_ban(context_id, game_token_id, current_owner, proof)`.
+ *
+ * @param gameTokenId - The game token ID to check (felt252)
+ * @param currentOwner - Current owner of the game token
+ * @param proof - Ban proof data (felt252 array)
+ * @returns Whether the entry should be banned
+ */
+declare function checkExtensionShouldBan(provider: StarknetCallProvider, extensionAddress: string, contextId: BigNumberish, gameTokenId: string, currentOwner: string, proof: string[]): Promise<boolean>;
+/**
+ * Get the context owner for an entry requirement extension contract.
+ *
+ * Extensions are multi-tenant: each context_id has its own owner
+ * (set by the first caller to configure that context via add_config).
+ *
+ * @param provider - Starknet RPC provider
+ * @param extensionAddress - The extension contract address
+ * @param contextId - The metagame event ID (tournament ID, quest ID, etc.)
+ * @returns The owner address for that context, or empty string if unclaimed
+ */
+declare function getEntryRequirementContextOwner(provider: StarknetCallProvider, extensionAddress: string, contextId: BigNumberish): Promise<string>;
+/**
+ * Get all trove IDs owned by a user from the Opus Abbot contract.
+ *
+ * @param provider - Starknet RPC provider
+ * @param userAddress - The user's address
+ * @param abbotAddress - Override Abbot address (defaults to mainnet)
+ * @returns Array of trove IDs
+ */
+declare function getUserTroveIds(provider: StarknetCallProvider, userAddress: BigNumberish, abbotAddress?: string): Promise<bigint[]>;
+/**
+ * Get a trove's debt from the Opus Shrine contract.
+ *
+ * Calls `get_trove_health(trove_id)` which returns [value, threshold, ltv, debt].
+ * We extract the debt (18 decimals, denominated in CASH which is 1:1 USD).
+ *
+ * @param provider - Starknet RPC provider
+ * @param troveId - The trove ID
+ * @param shrineAddress - Override Shrine address (defaults to mainnet)
+ * @returns Debt amount in CASH (18 decimals), or null on error
+ */
+declare function getTroveDebt(provider: StarknetCallProvider, troveId: BigNumberish, shrineAddress?: string): Promise<bigint | null>;
+/**
+ * Get total debt across all of a user's troves.
+ *
+ * Convenience function that calls getUserTroveIds then getTroveDebt for each.
+ *
+ * @param provider - Starknet RPC provider
+ * @param userAddress - The user's address
+ * @returns Total debt in CASH (18 decimals)
+ */
+declare function getUserTotalTroveDebt(provider: StarknetCallProvider, userAddress: BigNumberish, abbotAddress?: string, shrineAddress?: string): Promise<bigint>;
+
+export { type StarknetCallProvider as S, checkExtensionValidEntry as a, getExtensionEntriesLeft as b, checkExtensionShouldBan as c, getTroveDebt as d, getUserTotalTroveDebt as e, getUserTroveIds as f, getEntryRequirementContextOwner as g };

package/dist/extensions-BskkhEHk.d.ts

@@ -0,0 +1,101 @@
+import { BigNumberish } from 'starknet';
+
+/**
+ * RPC calls for EGS entry requirement extensions.
+ *
+ * These functions call the shared extension contracts on Starknet.
+ * They take a starknet.js provider (or any object with callContract)
+ * and return parsed results.
+ *
+ * Every metagame that uses the entry requirement system needs these
+ * same calls — they're not app-specific, they call the same contracts.
+ */
+
+/** Minimal provider interface — anything with callContract works */
+interface StarknetCallProvider {
+    callContract(call: {
+        contractAddress: string;
+        entrypoint: string;
+        calldata: string[];
+    }): Promise<string[]>;
+}
+/**
+ * Check if a player has a valid entry for an extension-gated event.
+ *
+ * Calls `valid_entry(context_id, player_address, qualification)` on the
+ * extension contract.
+ *
+ * @param provider - Starknet RPC provider
+ * @param extensionAddress - The extension contract address
+ * @param contextId - The metagame event ID (tournament ID, quest ID, etc.)
+ * @param playerAddress - The player's address
+ * @param qualification - Proof data (felt252 array)
+ * @returns Whether the entry is valid
+ */
+declare function checkExtensionValidEntry(provider: StarknetCallProvider, extensionAddress: string, contextId: BigNumberish, playerAddress: string, qualification: string[]): Promise<boolean>;
+/**
+ * Get the number of entries left for a player via an extension.
+ *
+ * Calls `entries_left(context_id, player_address, qualification)` on the
+ * extension contract. Returns null if the extension has no entry limit
+ * (Option::None).
+ *
+ * @returns Number of entries remaining, or null if unlimited
+ */
+declare function getExtensionEntriesLeft(provider: StarknetCallProvider, extensionAddress: string, contextId: BigNumberish, playerAddress: string, qualification: string[]): Promise<number | null>;
+/**
+ * Check if a player's entry should be banned via an extension.
+ *
+ * Calls `should_ban(context_id, game_token_id, current_owner, proof)`.
+ *
+ * @param gameTokenId - The game token ID to check (felt252)
+ * @param currentOwner - Current owner of the game token
+ * @param proof - Ban proof data (felt252 array)
+ * @returns Whether the entry should be banned
+ */
+declare function checkExtensionShouldBan(provider: StarknetCallProvider, extensionAddress: string, contextId: BigNumberish, gameTokenId: string, currentOwner: string, proof: string[]): Promise<boolean>;
+/**
+ * Get the context owner for an entry requirement extension contract.
+ *
+ * Extensions are multi-tenant: each context_id has its own owner
+ * (set by the first caller to configure that context via add_config).
+ *
+ * @param provider - Starknet RPC provider
+ * @param extensionAddress - The extension contract address
+ * @param contextId - The metagame event ID (tournament ID, quest ID, etc.)
+ * @returns The owner address for that context, or empty string if unclaimed
+ */
+declare function getEntryRequirementContextOwner(provider: StarknetCallProvider, extensionAddress: string, contextId: BigNumberish): Promise<string>;
+/**
+ * Get all trove IDs owned by a user from the Opus Abbot contract.
+ *
+ * @param provider - Starknet RPC provider
+ * @param userAddress - The user's address
+ * @param abbotAddress - Override Abbot address (defaults to mainnet)
+ * @returns Array of trove IDs
+ */
+declare function getUserTroveIds(provider: StarknetCallProvider, userAddress: BigNumberish, abbotAddress?: string): Promise<bigint[]>;
+/**
+ * Get a trove's debt from the Opus Shrine contract.
+ *
+ * Calls `get_trove_health(trove_id)` which returns [value, threshold, ltv, debt].
+ * We extract the debt (18 decimals, denominated in CASH which is 1:1 USD).
+ *
+ * @param provider - Starknet RPC provider
+ * @param troveId - The trove ID
+ * @param shrineAddress - Override Shrine address (defaults to mainnet)
+ * @returns Debt amount in CASH (18 decimals), or null on error
+ */
+declare function getTroveDebt(provider: StarknetCallProvider, troveId: BigNumberish, shrineAddress?: string): Promise<bigint | null>;
+/**
+ * Get total debt across all of a user's troves.
+ *
+ * Convenience function that calls getUserTroveIds then getTroveDebt for each.
+ *
+ * @param provider - Starknet RPC provider
+ * @param userAddress - The user's address
+ * @returns Total debt in CASH (18 decimals)
+ */
+declare function getUserTotalTroveDebt(provider: StarknetCallProvider, userAddress: BigNumberish, abbotAddress?: string, shrineAddress?: string): Promise<bigint>;
+
+export { type StarknetCallProvider as S, checkExtensionValidEntry as a, getExtensionEntriesLeft as b, checkExtensionShouldBan as c, getTroveDebt as d, getUserTotalTroveDebt as e, getUserTroveIds as f, getEntryRequirementContextOwner as g };