@playmos/sdk 0.1.6 → 0.3.0

package/dist/errors-B-85VYMv.d.cts

@@ -1,224 +0,0 @@
-/**
- * Public types — pruned to WIRED capability only (fixes #344/I and #335/E).
- *
- * The old vendored surface advertised four wallet connectors that silently
- * returned {connected:false} and config fields the code never read. Here the
- * types expose exactly what V1 does: two connectors, the fields `pay()` /
- * `enterRound()` actually use, and no more.
- */
-type Network = "base" | "base-sepolia";
-/** Only the connectors that are actually implemented. */
-type WalletConnector = "base-account" | "injected";
-type GasMode = "sponsored" | "player";
-type PaymentStatus = "created" | "pending" | "confirmed" | "failed";
-/** Minimal EIP-1193 provider shape (what the wallet must expose). */
-interface Eip1193Provider {
-    request(args: {
-        method: string;
-        params?: unknown[] | object;
-    }): Promise<unknown>;
-}
-interface GasConfig {
-    mode?: GasMode;
-    /** CDP paymaster URL — required only for `mode: "sponsored"`. */
-    paymasterUrl?: string;
-}
-interface WalletConfig {
-    connector?: WalletConnector;
-    /**
-     * Pre-built EIP-1193 provider. If omitted, `injected` uses globalThis.ethereum
-     * and `base-account` expects a provider supplied by the Base Account SDK host.
-     */
-    provider?: Eip1193Provider;
-}
-/** Per-game contract addresses. On testnet these come from the service intent,
- *  but a studio may pin them explicitly (matches the dogfood adapter). */
-interface ContractConfig {
-    usdc?: `0x${string}`;
-    playmosPay?: `0x${string}`;
-    prizePool?: `0x${string}`;
-}
-interface AgentEconomyConfig {
-    enabled?: boolean;
-    /** Tax skimmed to Playmos on each agent↔agent transfer. 100 = 1% (default). */
-    taxBps?: number;
-}
-interface PlaymosConfig {
-    /** pk_test_* (sandbox / Base Sepolia) or pk_live_* (production / Base mainnet).
-     *  The key prefix selects the environment. */
-    apiKey: string;
-    /** Override the network derived from the key. Explicit value wins. */
-    network?: Network;
-    wallet?: WalletConfig;
-    gas?: GasConfig;
-    agentEconomy?: AgentEconomyConfig;
-    contracts?: ContractConfig;
-    /** Escape hatch; defaults to the right env's base URL. */
-    apiBaseUrl?: string;
-    /**
-     * Explicit, clearly-labeled offline unit-test helper — instant, deterministic,
-     * NO network, NO chain. Never the default, never conflated with sandbox. Note:
-     * even mock results use the REAL status union (never a synthetic "mocked").
-     */
-    mock?: boolean;
-}
-interface PayInput {
-    /** USD decimal string ("4.99"). Rejected: ≤ 0, non-numeric, > 2 dp. */
-    amount: string;
-    /** Your product id, echoed on the receipt + webhook. */
-    sku: string;
-    /** Your opaque user id. */
-    playerId: string;
-    /**
-     * The game this IAP belongs to. Optional: when your API key maps to exactly
-     * one game the service resolves it for you (the quickstart). Supply it
-     * explicitly when your key spans multiple games.
-     */
-    gameId?: string;
-    /** The studio wallet that receives the 99%. Falls back to the service default. */
-    studio?: `0x${string}`;
-    /** Supply your own to make retries safe; omit and the SDK generates a ULID. */
-    idempotencyKey?: string;
-    metadata?: Record<string, string>;
-}
-interface EnterRoundInput {
-    /** The game — selects its prize-pool contract. */
-    gameId: string;
-    /** The round being entered. */
-    roundId: string;
-    /** USD entry — grows this round's pool. */
-    amount: string;
-    playerId: string;
-    idempotencyKey?: string;
-    metadata?: Record<string, string>;
-    /**
-     * Advanced (games that manage their own on-chain rounds, e.g. the Playmos
-     * game-hub kit): the EXACT on-chain round key to enter — overrides the default
-     * `${gameId}:${roundId}` derivation. Set it to the value your game's server
-     * verifies `hasEntered` against (e.g. "bjtest:T1").
-     */
-    roundKey?: string;
-    /**
-     * Advanced: the EXACT on-chain identity for this paid attempt (e.g.
-     * "0xWallet#nonce"). Overrides the server-generated identity so the on-chain
-     * entry and your server's `hasEntered` check line up. One entry per identity.
-     */
-    identity?: string;
-}
-interface Payment {
-    /** `pay_…` (IAP) or `entry_…` (prize-pool) — ULID, server-issued, unique. */
-    id: string;
-    status: PaymentStatus;
-    /** "iap" (1% external) or "entry" (60/30/10 prize-pool). */
-    kind: "iap" | "entry";
-    amount: string;
-    fee: string;
-    net: string;
-    /** Present for prize-pool entries: the 60/30/10 breakdown in USD. */
-    split?: {
-        pool: string;
-        seed: string;
-        rake: string;
-    };
-    sku?: string;
-    roundId?: string;
-    gameId?: string;
-    playerId: string;
-    txHash?: `0x${string}`;
-    chain: Network;
-    createdAt: string;
-    metadata?: Record<string, string>;
-    /**
-     * The on-chain identity used for a prize-pool entry (echo of
-     * `EnterRoundInput.identity` or the SDK-derived value) — reconcile against your
-     * server's `hasEntered`.
-     */
-    identity?: string;
-    /** True only when produced by the labeled `mock: true` helper. */
-    mock?: boolean;
-}
-/** What `verify()` resolves to (server reads the chain). */
-interface VerifyResult {
-    id: string;
-    status: PaymentStatus;
-    amount: string;
-    fee: string;
-    net: string;
-    txHash?: `0x${string}`;
-    playerId: string;
-    sku?: string;
-    roundId?: string;
-    chain: Network;
-    /** How the service derived this status: an on-chain read, the honest cache, or
-     *  degraded (chain reads not configured). Lets the SDK stop polling when the
-     *  service can never confirm on-chain. */
-    verifiedVia?: "chain" | "cache" | "degraded";
-    chainReads?: "enabled" | "degraded";
-}
-type WebhookEventType = "payment.confirmed" | "payment.failed" | "payout.settled" | "refund.processed";
-interface WebhookEvent {
-    id: string;
-    type: WebhookEventType;
-    createdAt: string;
-    data: {
-        id: string;
-        status: PaymentStatus;
-        amount: string;
-        fee: string;
-        net: string;
-        playerId: string;
-        sku?: string;
-        txHash?: `0x${string}`;
-        chain: Network;
-        metadata?: Record<string, string>;
-    };
-}
-
-/**
- * Typed, actionable errors — the Stripe bar (spec §11).
- *
- * Every error carries a stable machine-readable `code` and is thrown at the
- * EARLIEST possible layer: input errors fire client-side before any network or
- * chain call, so a studio never pays gas to discover a typo.
- */
-type PlaymosErrorCode = "invalid_amount" | "missing_field" | "insufficient_gas" | "wallet_connection" | "payment_failed" | "auth" | "api_error" | "config";
-declare class PlaymosError extends Error {
-    readonly code: PlaymosErrorCode;
-    /** Optional machine context (e.g. the offending field, the http status). */
-    readonly detail?: Record<string, unknown>;
-    constructor(code: PlaymosErrorCode, message: string, detail?: Record<string, unknown>);
-}
-/** amount ≤ 0, non-numeric, empty, or more than 2 decimal places. */
-declare class InvalidAmountError extends PlaymosError {
-    constructor(amount: unknown);
-}
-/** A required field (sku, playerId, gameId, roundId, agentId…) was empty. */
-declare class MissingFieldError extends PlaymosError {
-    constructor(field: string);
-}
-/** gas mode "player" and the player's ETH is too low to cover gas (pre-check, §7). */
-declare class InsufficientGasError extends PlaymosError {
-    constructor(detail?: Record<string, unknown>);
-}
-/** The player closed or failed the wallet sheet, or no provider is available. */
-declare class WalletConnectionError extends PlaymosError {
-    constructor(message?: string, detail?: Record<string, unknown>);
-}
-/** The on-chain settlement reverted, was cancelled, or timed out. */
-declare class PaymentFailedError extends PlaymosError {
-    constructor(message?: string, detail?: Record<string, unknown>);
-}
-/** Bad, missing, or wrong-environment API key (e.g. a pk_test_ key on a live route). */
-declare class AuthError extends PlaymosError {
-    constructor(message?: string, detail?: Record<string, unknown>);
-}
-/** The Playmos service returned a non-2xx we don't have a more specific error for. */
-declare class ApiError extends PlaymosError {
-    constructor(message: string, detail?: Record<string, unknown>);
-}
-/** SDK misconfiguration (e.g. a missing contract address for on-chain mode). */
-declare class ConfigError extends PlaymosError {
-    constructor(message: string, detail?: Record<string, unknown>);
-}
-
-export { type AgentEconomyConfig as A, ConfigError as C, type EnterRoundInput as E, type GasConfig as G, InsufficientGasError as I, MissingFieldError as M, type Network as N, type PlaymosConfig as P, type VerifyResult as V, type WebhookEvent as W, type PayInput as a, type Payment as b, ApiError as c, AuthError as d, type ContractConfig as e, type Eip1193Provider as f, type GasMode as g, InvalidAmountError as h, PaymentFailedError as i, type PaymentStatus as j, PlaymosError as k, type PlaymosErrorCode as l, type WalletConfig as m, WalletConnectionError as n, type WalletConnector as o, type WebhookEventType as p };

package/dist/errors-B-85VYMv.d.ts

@@ -1,224 +0,0 @@
-/**
- * Public types — pruned to WIRED capability only (fixes #344/I and #335/E).
- *
- * The old vendored surface advertised four wallet connectors that silently
- * returned {connected:false} and config fields the code never read. Here the
- * types expose exactly what V1 does: two connectors, the fields `pay()` /
- * `enterRound()` actually use, and no more.
- */
-type Network = "base" | "base-sepolia";
-/** Only the connectors that are actually implemented. */
-type WalletConnector = "base-account" | "injected";
-type GasMode = "sponsored" | "player";
-type PaymentStatus = "created" | "pending" | "confirmed" | "failed";
-/** Minimal EIP-1193 provider shape (what the wallet must expose). */
-interface Eip1193Provider {
-    request(args: {
-        method: string;
-        params?: unknown[] | object;
-    }): Promise<unknown>;
-}
-interface GasConfig {
-    mode?: GasMode;
-    /** CDP paymaster URL — required only for `mode: "sponsored"`. */
-    paymasterUrl?: string;
-}
-interface WalletConfig {
-    connector?: WalletConnector;
-    /**
-     * Pre-built EIP-1193 provider. If omitted, `injected` uses globalThis.ethereum
-     * and `base-account` expects a provider supplied by the Base Account SDK host.
-     */
-    provider?: Eip1193Provider;
-}
-/** Per-game contract addresses. On testnet these come from the service intent,
- *  but a studio may pin them explicitly (matches the dogfood adapter). */
-interface ContractConfig {
-    usdc?: `0x${string}`;
-    playmosPay?: `0x${string}`;
-    prizePool?: `0x${string}`;
-}
-interface AgentEconomyConfig {
-    enabled?: boolean;
-    /** Tax skimmed to Playmos on each agent↔agent transfer. 100 = 1% (default). */
-    taxBps?: number;
-}
-interface PlaymosConfig {
-    /** pk_test_* (sandbox / Base Sepolia) or pk_live_* (production / Base mainnet).
-     *  The key prefix selects the environment. */
-    apiKey: string;
-    /** Override the network derived from the key. Explicit value wins. */
-    network?: Network;
-    wallet?: WalletConfig;
-    gas?: GasConfig;
-    agentEconomy?: AgentEconomyConfig;
-    contracts?: ContractConfig;
-    /** Escape hatch; defaults to the right env's base URL. */
-    apiBaseUrl?: string;
-    /**
-     * Explicit, clearly-labeled offline unit-test helper — instant, deterministic,
-     * NO network, NO chain. Never the default, never conflated with sandbox. Note:
-     * even mock results use the REAL status union (never a synthetic "mocked").
-     */
-    mock?: boolean;
-}
-interface PayInput {
-    /** USD decimal string ("4.99"). Rejected: ≤ 0, non-numeric, > 2 dp. */
-    amount: string;
-    /** Your product id, echoed on the receipt + webhook. */
-    sku: string;
-    /** Your opaque user id. */
-    playerId: string;
-    /**
-     * The game this IAP belongs to. Optional: when your API key maps to exactly
-     * one game the service resolves it for you (the quickstart). Supply it
-     * explicitly when your key spans multiple games.
-     */
-    gameId?: string;
-    /** The studio wallet that receives the 99%. Falls back to the service default. */
-    studio?: `0x${string}`;
-    /** Supply your own to make retries safe; omit and the SDK generates a ULID. */
-    idempotencyKey?: string;
-    metadata?: Record<string, string>;
-}
-interface EnterRoundInput {
-    /** The game — selects its prize-pool contract. */
-    gameId: string;
-    /** The round being entered. */
-    roundId: string;
-    /** USD entry — grows this round's pool. */
-    amount: string;
-    playerId: string;
-    idempotencyKey?: string;
-    metadata?: Record<string, string>;
-    /**
-     * Advanced (games that manage their own on-chain rounds, e.g. the Playmos
-     * game-hub kit): the EXACT on-chain round key to enter — overrides the default
-     * `${gameId}:${roundId}` derivation. Set it to the value your game's server
-     * verifies `hasEntered` against (e.g. "bjtest:T1").
-     */
-    roundKey?: string;
-    /**
-     * Advanced: the EXACT on-chain identity for this paid attempt (e.g.
-     * "0xWallet#nonce"). Overrides the server-generated identity so the on-chain
-     * entry and your server's `hasEntered` check line up. One entry per identity.
-     */
-    identity?: string;
-}
-interface Payment {
-    /** `pay_…` (IAP) or `entry_…` (prize-pool) — ULID, server-issued, unique. */
-    id: string;
-    status: PaymentStatus;
-    /** "iap" (1% external) or "entry" (60/30/10 prize-pool). */
-    kind: "iap" | "entry";
-    amount: string;
-    fee: string;
-    net: string;
-    /** Present for prize-pool entries: the 60/30/10 breakdown in USD. */
-    split?: {
-        pool: string;
-        seed: string;
-        rake: string;
-    };
-    sku?: string;
-    roundId?: string;
-    gameId?: string;
-    playerId: string;
-    txHash?: `0x${string}`;
-    chain: Network;
-    createdAt: string;
-    metadata?: Record<string, string>;
-    /**
-     * The on-chain identity used for a prize-pool entry (echo of
-     * `EnterRoundInput.identity` or the SDK-derived value) — reconcile against your
-     * server's `hasEntered`.
-     */
-    identity?: string;
-    /** True only when produced by the labeled `mock: true` helper. */
-    mock?: boolean;
-}
-/** What `verify()` resolves to (server reads the chain). */
-interface VerifyResult {
-    id: string;
-    status: PaymentStatus;
-    amount: string;
-    fee: string;
-    net: string;
-    txHash?: `0x${string}`;
-    playerId: string;
-    sku?: string;
-    roundId?: string;
-    chain: Network;
-    /** How the service derived this status: an on-chain read, the honest cache, or
-     *  degraded (chain reads not configured). Lets the SDK stop polling when the
-     *  service can never confirm on-chain. */
-    verifiedVia?: "chain" | "cache" | "degraded";
-    chainReads?: "enabled" | "degraded";
-}
-type WebhookEventType = "payment.confirmed" | "payment.failed" | "payout.settled" | "refund.processed";
-interface WebhookEvent {
-    id: string;
-    type: WebhookEventType;
-    createdAt: string;
-    data: {
-        id: string;
-        status: PaymentStatus;
-        amount: string;
-        fee: string;
-        net: string;
-        playerId: string;
-        sku?: string;
-        txHash?: `0x${string}`;
-        chain: Network;
-        metadata?: Record<string, string>;
-    };
-}
-
-/**
- * Typed, actionable errors — the Stripe bar (spec §11).
- *
- * Every error carries a stable machine-readable `code` and is thrown at the
- * EARLIEST possible layer: input errors fire client-side before any network or
- * chain call, so a studio never pays gas to discover a typo.
- */
-type PlaymosErrorCode = "invalid_amount" | "missing_field" | "insufficient_gas" | "wallet_connection" | "payment_failed" | "auth" | "api_error" | "config";
-declare class PlaymosError extends Error {
-    readonly code: PlaymosErrorCode;
-    /** Optional machine context (e.g. the offending field, the http status). */
-    readonly detail?: Record<string, unknown>;
-    constructor(code: PlaymosErrorCode, message: string, detail?: Record<string, unknown>);
-}
-/** amount ≤ 0, non-numeric, empty, or more than 2 decimal places. */
-declare class InvalidAmountError extends PlaymosError {
-    constructor(amount: unknown);
-}
-/** A required field (sku, playerId, gameId, roundId, agentId…) was empty. */
-declare class MissingFieldError extends PlaymosError {
-    constructor(field: string);
-}
-/** gas mode "player" and the player's ETH is too low to cover gas (pre-check, §7). */
-declare class InsufficientGasError extends PlaymosError {
-    constructor(detail?: Record<string, unknown>);
-}
-/** The player closed or failed the wallet sheet, or no provider is available. */
-declare class WalletConnectionError extends PlaymosError {
-    constructor(message?: string, detail?: Record<string, unknown>);
-}
-/** The on-chain settlement reverted, was cancelled, or timed out. */
-declare class PaymentFailedError extends PlaymosError {
-    constructor(message?: string, detail?: Record<string, unknown>);
-}
-/** Bad, missing, or wrong-environment API key (e.g. a pk_test_ key on a live route). */
-declare class AuthError extends PlaymosError {
-    constructor(message?: string, detail?: Record<string, unknown>);
-}
-/** The Playmos service returned a non-2xx we don't have a more specific error for. */
-declare class ApiError extends PlaymosError {
-    constructor(message: string, detail?: Record<string, unknown>);
-}
-/** SDK misconfiguration (e.g. a missing contract address for on-chain mode). */
-declare class ConfigError extends PlaymosError {
-    constructor(message: string, detail?: Record<string, unknown>);
-}
-
-export { type AgentEconomyConfig as A, ConfigError as C, type EnterRoundInput as E, type GasConfig as G, InsufficientGasError as I, MissingFieldError as M, type Network as N, type PlaymosConfig as P, type VerifyResult as V, type WebhookEvent as W, type PayInput as a, type Payment as b, ApiError as c, AuthError as d, type ContractConfig as e, type Eip1193Provider as f, type GasMode as g, InvalidAmountError as h, PaymentFailedError as i, type PaymentStatus as j, PlaymosError as k, type PlaymosErrorCode as l, type WalletConfig as m, WalletConnectionError as n, type WalletConnector as o, type WebhookEventType as p };