@scuro/sdk 0.1.0-beta.1

package/dist/internal/enums.d.ts

@@ -0,0 +1,11 @@
+import type { BaccaratOutcomeLabel, BaccaratSideLabel, BlackjackActionLabel, BlackjackActionMaskLabel, BlackjackSessionPhaseLabel, GameModeLabel, ModuleStatusLabel, PokerHandPhaseLabel, PokerMatchStateLabel } from "./types";
+export declare function decodeGameMode(value: number | bigint): GameModeLabel;
+export declare function decodeModuleStatus(value: number | bigint): ModuleStatusLabel;
+export declare function decodeBaccaratSide(value: number | bigint): BaccaratSideLabel;
+export declare function decodeBaccaratOutcome(value: number | bigint): BaccaratOutcomeLabel;
+export declare function decodeBlackjackSessionPhase(value: number | bigint): BlackjackSessionPhaseLabel;
+export declare function decodeBlackjackAction(value: number | bigint): BlackjackActionLabel;
+export declare function decodePokerMatchState(value: number | bigint): PokerMatchStateLabel;
+export declare function decodePokerHandPhase(value: number | bigint): PokerHandPhaseLabel;
+export declare function decodeBlackjackActionMask(mask: number | bigint): BlackjackActionMaskLabel[];
+export declare function isPokerPlayerClockPhase(phase: PokerHandPhaseLabel): phase is "PreDrawBetting" | "DrawDeclaration" | "PostDrawBetting";

package/dist/internal/errors.d.ts

@@ -0,0 +1,23 @@
+export declare class ScuroSdkError extends Error {
+    readonly code: string;
+    readonly details?: unknown;
+    constructor(code: string, message: string, details?: unknown);
+}
+export declare class MissingDeploymentLabelError extends ScuroSdkError {
+    constructor(label: string);
+}
+export declare class UnknownEnumValueError extends ScuroSdkError {
+    constructor(enumName: string, value: number | bigint);
+}
+export declare class InvalidLifecycleStateError extends ScuroSdkError {
+    constructor(message: string, details?: unknown);
+}
+export declare class ExpiredDeadlineError extends ScuroSdkError {
+    constructor(deadlineAt: bigint);
+}
+export declare class MissingWalletClientError extends ScuroSdkError {
+    constructor();
+}
+export declare class UnsupportedFactoryFamilyError extends ScuroSdkError {
+    constructor(family: string);
+}

package/dist/internal/types.d.ts

@@ -0,0 +1,192 @@
+import type { Abi, Address, Hex, PublicClient, WalletClient } from "viem";
+import type { ContractDeploymentLabel, ContractName, DeploymentOutputLabel } from "../generated/protocol";
+import { deploymentOutputLabelGroups } from "../generated/protocol";
+export type ActorLabel = (typeof deploymentOutputLabelGroups.actors)[number];
+export type ModuleIdLabel = (typeof deploymentOutputLabelGroups.module_ids)[number];
+export type ExpressionLabel = (typeof deploymentOutputLabelGroups.expressions)[number];
+export type BuiltinProfileKey = "anvil-local" | "testnet-beta";
+export interface DeploymentProfile {
+    key: string;
+    name: string;
+    chainId: number;
+    rpcUrl?: string;
+    labels: Partial<Record<DeploymentOutputLabel, string>>;
+    privateKeys?: Partial<Record<ActorLabel | "Admin", Hex>>;
+}
+export interface NormalizedDeployment {
+    raw: Partial<Record<DeploymentOutputLabel, string>>;
+    contracts: Partial<Record<ContractDeploymentLabel, Address>>;
+    actors: Partial<Record<ActorLabel | "Admin", Address>>;
+    moduleIds: Partial<Record<ModuleIdLabel, bigint>>;
+    expressions: Partial<Record<ExpressionLabel, bigint>>;
+}
+export interface CreateScuroClientOptions {
+    publicClient: PublicClient;
+    walletClient?: WalletClient;
+    deployment: Partial<Record<DeploymentOutputLabel, string>> | DeploymentProfile | NormalizedDeployment;
+    chainId?: number;
+}
+export type EnumName = "GameCatalog.GameMode" | "GameCatalog.ModuleStatus" | "BaccaratTypes.BaccaratSide" | "BaccaratTypes.BaccaratOutcome" | "SingleDeckBlackjackEngine.SessionPhase" | "SingleDeckBlackjackEngine.Action" | "SingleDeckBlackjackEngine.ActionMask" | "SingleDraw2To7Engine.MatchState" | "SingleDraw2To7Engine.HandPhase";
+export type GameModeLabel = "Solo" | "PvP" | "Tournament";
+export type ModuleStatusLabel = "LIVE" | "RETIRED" | "DISABLED";
+export type BaccaratSideLabel = "Player" | "Banker" | "Tie";
+export type BaccaratOutcomeLabel = "PlayerWin" | "BankerWin" | "Tie";
+export type BlackjackSessionPhaseLabel = "Inactive" | "AwaitingInitialDeal" | "AwaitingPlayerAction" | "AwaitingCoordinator" | "Completed";
+export type BlackjackActionLabel = "ACTION_HIT" | "ACTION_STAND" | "ACTION_DOUBLE" | "ACTION_SPLIT";
+export type BlackjackActionMaskLabel = "ALLOW_HIT" | "ALLOW_STAND" | "ALLOW_DOUBLE" | "ALLOW_SPLIT";
+export type PokerMatchStateLabel = "Inactive" | "Active" | "Completed";
+export type PokerHandPhaseLabel = "None" | "AwaitingInitialDeal" | "PreDrawBetting" | "DrawDeclaration" | "DrawProofPending" | "PostDrawBetting" | "ShowdownProofPending" | "HandComplete";
+export interface PreparedTransactionRequest {
+    to: Address;
+    data: Hex;
+    value?: bigint;
+}
+export interface ContractEventMetadata {
+    name: string;
+    signature: string;
+    anonymous: boolean;
+}
+export interface ContractMetadata {
+    name: ContractName;
+    category: string;
+    source: string;
+    artifact: string;
+    reference_doc: string;
+    abi_path: string;
+    functions: readonly string[];
+    events: readonly string[];
+}
+export interface ContractDescriptor {
+    address: Address;
+    abi: Abi;
+    publicClient: PublicClient;
+    walletClient: WalletClient | undefined;
+}
+export interface SlotMachinePresetConfigInput {
+    volatilityTier: number;
+    configHash: Hex;
+    reelCount: number;
+    rowCount: number;
+    waysMode: number;
+    minStake: bigint;
+    maxStake: bigint;
+    maxPayoutMultiplierBps: bigint;
+    symbolIds: readonly number[];
+    wildSymbolId: number;
+    scatterSymbolId: number;
+    bonusSymbolId: number;
+    jackpotSymbolId: number;
+    reelWeightOffsets: readonly number[];
+    reelSymbolIds: readonly number[];
+    reelSymbolWeights: readonly number[];
+    paytableSymbolIds: readonly number[];
+    paytableMatchCounts: readonly number[];
+    paytableMultiplierBps: readonly number[];
+    freeSpinTriggerCount: number;
+    freeSpinAwardCounts: readonly number[];
+    maxFreeSpins: number;
+    maxRetriggers: number;
+    freeSpinMultiplierBps: number;
+    pickTriggerCount: number;
+    maxPickReveals: number;
+    pickAwardMultiplierBps: readonly number[];
+    holdTriggerCount: number;
+    holdBoardSize: number;
+    initialRespins: number;
+    maxRespins: number;
+    holdValueMultiplierBps: readonly number[];
+    jackpotTierIds: readonly number[];
+    jackpotAwardMultiplierBps: readonly number[];
+    jackpotTierWeights: readonly number[];
+    maxTotalEvents: number;
+}
+export interface SlotMachinePresetSummary {
+    active: boolean;
+    volatilityTier: number;
+    configHash: Hex;
+    reelCount: number;
+    rowCount: number;
+    waysMode: number;
+    minStake: bigint;
+    maxStake: bigint;
+    maxPayoutMultiplierBps: bigint;
+    maxFreeSpins: number;
+    maxRetriggers: number;
+    maxPickReveals: number;
+    maxRespins: number;
+    maxTotalEvents: number;
+}
+export interface SlotMachineSpinInspection {
+    spin: any;
+    spinResult: any;
+    settlementOutcome: any;
+    settled: boolean;
+    expressionTokenId: bigint;
+    presetSummary: SlotMachinePresetSummary;
+}
+export interface SuperBaccaratRoundInspection {
+    playerCards: readonly [number, number, number];
+    bankerCards: readonly [number, number, number];
+    playerCardCount: number;
+    bankerCardCount: number;
+    playerTotal: number;
+    bankerTotal: number;
+    natural: boolean;
+    outcome: number;
+    outcomeLabel: BaccaratOutcomeLabel;
+    randomWord: bigint;
+    fulfilled: boolean;
+}
+export interface SuperBaccaratSessionInspection {
+    round: SuperBaccaratRoundInspection;
+    settlementOutcome: any;
+    sessionSettled: boolean;
+    expressionTokenId: bigint;
+}
+export interface CheminDeFerTableInspection {
+    table: any;
+    takers: Address[];
+    takerAmounts: Record<Address, bigint>;
+    round: any;
+    resolved: boolean;
+    playerTakeCap: bigint;
+    matchedBankerRisk: bigint;
+}
+export interface GameEngineMetadataInput {
+    engineType: Hex;
+    verifier: Address;
+    configHash: Hex;
+    developerRewardBps: number;
+    active: boolean;
+    supportsTournament: boolean;
+    supportsPvP: boolean;
+    supportsSolo: boolean;
+}
+export interface ScuroContractHelpers {
+    publicClient: PublicClient;
+    walletClient: WalletClient | undefined;
+    deployment: NormalizedDeployment;
+    instances: any;
+    read: any;
+    encode: any;
+    write: any;
+    inspect: any;
+    helpers: any;
+}
+export interface ScuroFlowHelpers {
+    [key: string]: any;
+}
+export interface ScuroCoordinatorHelpers {
+    [key: string]: any;
+}
+export interface ScuroClient {
+    deployment: NormalizedDeployment;
+    contracts: ScuroContractHelpers;
+    flows: ScuroFlowHelpers;
+    coordinator: ScuroCoordinatorHelpers;
+    events: {
+        decode: (...args: any[]) => any;
+    };
+    registry: Record<string, any>;
+    manifest: Record<string, any>;
+}

package/dist/internal/utils.d.ts

@@ -0,0 +1,9 @@
+import { type Address, type Hex, type WalletClient } from "viem";
+export declare function asAddress(value: string): Address;
+export declare function asBigInt(value: string | number | bigint): bigint;
+export declare function requireValue<T>(value: T | undefined, label: string): T;
+export declare function optionalAddress(value: string | undefined): Address | undefined;
+export declare function optionalBigInt(value: string | undefined): bigint | undefined;
+export declare function ensureWalletClient(walletClient: WalletClient | undefined): WalletClient;
+export declare function nowSeconds(value?: number | bigint): bigint;
+export declare function toHex32(value: string): Hex;