@playmos/sdk 0.3.10 → 0.3.12

package/dist/{errors-Chizbb96.d.cts → errors-CYKgt2VU.d.cts}

@@ -24,11 +24,19 @@ interface GasConfig {
     paymasterUrl?: string;
 }
 interface WalletConfig {
+    /**
+     * Which connector name to use when {@link WalletConfig.provider} is omitted.
+     * - `"injected"` — requires `globalThis.ethereum` (wallet browser / extension).
+     * - `"base-account"` (default) — **not** a built-in Base Account package inside
+     *   `@playmos/sdk`. Resolution: use injected ethereum if present; otherwise you
+     *   must install `@base-org/account` yourself, construct a provider, and pass
+     *   it as `wallet.provider` (sdk#512). No hard dependency on `@base-org/account`.
+     */
     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.
-     * A raw provider is still **timeout-wrapped** on resolve (#462) — not a no-op passthrough.
+     * Pre-built EIP-1193 provider (host-owned). Always preferred when set.
+     * For Base Account / passkey hosts: construct with `@base-org/account` (or the
+     * Base App injection) and pass it here. Still **timeout-wrapped** on resolve (#462).
      */
     provider?: Eip1193Provider;
 }
@@ -38,6 +46,8 @@ interface ContractConfig {
     usdc?: `0x${string}`;
     playmosPay?: `0x${string}`;
     prizePool?: `0x${string}`;
+    /** EpochPrizePool (rolling-epoch reads — sdk#629). Live PrizePool stays on prizePool. */
+    epochPrizePool?: `0x${string}`;
 }
 /**
  * @deprecated Unused — agent routes are enabled server-side (SERVICE_MASTER_SECRET +
@@ -129,6 +139,10 @@ interface PayInput {
     sku: string;
     /** Your opaque user id. */
     playerId: string;
+    /** sdk#508 — max wait for server-settle poll (ms). Default 60_000. */
+    settleTimeoutMs?: number;
+    /** sdk#508 — abort server-settle polling. */
+    signal?: AbortSignal;
     /**
      * 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
@@ -150,6 +164,13 @@ interface EnterRoundInput {
     amount: string;
     playerId: string;
     idempotencyKey?: string;
+    /**
+     * sdk#508 — max wait for server-settle poll (ms). Default 60_000.
+     * Only applies to no-wallet sandbox server-settle path.
+     */
+    settleTimeoutMs?: number;
+    /** sdk#508 — abort server-settle polling. */
+    signal?: AbortSignal;
     metadata?: Record<string, string>;
     /**
      * Exact on-chain round key for Path B / entryProvider (#201 / #204 / #210).
@@ -385,12 +406,34 @@ 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). */
+    /** "iap" (1% external) or "entry" (prize-pool; `split` is a first-party 60/30/10 projection). */
     kind: "iap" | "entry";
+    /**
+     * Requested amount (USD string). For prize-pool **server-settle**, this may
+     * differ from what moved on chain — see {@link Payment.chainAmount} (sdk#507).
+     */
     amount: string;
     fee: string;
     net: string;
-    /** Present for prize-pool entries: the 60/30/10 breakdown in USD. */
+    /**
+     * On-chain entry amount (USD) when the service observed it (server-settle entry).
+     * PrizePool charges the **round open price**, not necessarily {@link Payment.amount}.
+     * Reconcile economics against this field (or a chain `getRound` read), not `amount` alone.
+     */
+    chainAmount?: string;
+    /** On-chain entry amount in micro-USDC (6 dp integer string), when known. */
+    chainAmountMicro?: string;
+    /**
+     * First-party **60/30/10 projection** (pool/seed/rake USD strings) for prize-pool
+     * entries — bookkeeping preview, **not** a studio 60/30/9+1% split and **not** a
+     * chain-derived settlement observation (sdk#514). Numbers come from SDK constants
+     * (`POOL_BPS`/`SEED_BPS`/`RAKE_BPS`), not from reading the deployed pool’s
+     * constructor bps. On-chain, entry only takes the fee off the top; pool/seed
+     * split at **lock**; payable pot also includes inherited seedBank — so
+     * `split.pool` is **not** “what this round pays.” Reconcile money with
+     * {@link Payment.chainAmount} / pool `getRound`.
+     * Field name kept for compatibility (no rename in V1).
+     */
     split?: {
         pool: string;
         seed: string;
@@ -427,9 +470,17 @@ interface Payment {
 interface VerifyResult {
     id: string;
     status: PaymentStatus;
+    /** Requested amount (USD). May differ from {@link VerifyResult.chainAmount} on server-settle entry. */
     amount: string;
     fee: string;
     net: string;
+    /**
+     * On-chain settled entry amount (USD) when known — distinct from {@link VerifyResult.amount}
+     * (sdk#507 / Vault Pop DX-05b). Prefer this for pot/split economics on shared rounds.
+     */
+    chainAmount?: string;
+    /** On-chain settled entry amount in micro-USDC, when known. */
+    chainAmountMicro?: string;
     txHash?: `0x${string}`;
     playerId: string;
     sku?: string;
@@ -440,6 +491,8 @@ interface VerifyResult {
      *  service can never confirm on-chain. */
     verifiedVia?: "chain" | "cache" | "degraded";
     chainReads?: "enabled" | "degraded";
+    /** Echo of on-chain identity when the service returns it (server-settle). */
+    identity?: string;
 }
 type WebhookEventType = "payment.confirmed" | "payment.failed" | "payout.settled" | "refund.processed";
 interface WebhookEvent {
@@ -587,6 +640,22 @@ interface CancelRoundResult {
     status: "cancelling" | "cancelled";
     round?: RoundState;
 }
+/** L34 / sdk#610 — a win is funded only after the push tx, else claimable. */
+type PayoutNoticeStatus = "funded" | "claimable";
+interface PayoutNotice {
+    roundId: string;
+    wallet: `0x${string}`;
+    amountMicro: string;
+    status: PayoutNoticeStatus;
+    /** Present only when status === "funded". */
+    txHash?: `0x${string}`;
+    reason?: string;
+}
+interface PayoutNoticesResult {
+    roundId?: string;
+    status?: string;
+    notices: PayoutNotice[];
+}
 /** What `rounds.prize({ … })` returns — claimable pull-payment balance (issue #41). */
 interface PrizeBalance {
     roundId: string;
@@ -657,6 +726,43 @@ interface SettleRoundResult {
     status: "settled" | "settling";
 }
 
+/**
+ * EIP-5792 batch primitives — ported from the proven game-hub `payEntryOnchain`
+ * path (`OnchainEntry.ts`). One `wallet_sendCalls` sends `approve` + the settling
+ * call as ONE atomic confirmation; the paymaster sponsors gas when configured.
+ * The player sees a single Apple-Pay-style sheet.
+ */
+
+interface Call {
+    to: `0x${string}`;
+    data: `0x${string}`;
+}
+type OnchainStatus = "PENDING" | "CONFIRMED" | "FAILED";
+
+/**
+ * Calldata builders. IAP / PrizePool entry stay on `toBytes32` (keccak of
+ * UTF-8 via toBytes) because live paid entries were written with it.
+ * Epoch execute uses `seriesToBytes32` — hex-shaped series must not drift.
+ */
+
+/** The server derives these identically (keccak256 of UTF-8 bytes) so the
+ *  off-chain record and the on-chain call line up. */
+declare const toBytes32: (s: string) => `0x${string}`;
+interface EpochExecuteSettlementCallArgs {
+    epochPrizePool: `0x${string}`;
+    series: string;
+    epochId: bigint;
+    winners: `0x${string}`[];
+    amounts: bigint[];
+    signature: `0x${string}`;
+}
+/**
+ * EpochPrizePool.executeSignedSettlement — permissionless relay of an
+ * operator-signed podium (sdk#664 E1b). Series hashed with seriesToBytes32
+ * (not this file's toBytes32) so hex-shaped series cannot drift from the chain.
+ */
+declare function buildEpochExecuteSettlementCall(args: EpochExecuteSettlementCallArgs): Call;
+
 /**
  * Typed, actionable errors — the Stripe bar (spec §11).
  *
@@ -728,4 +834,4 @@ declare class NothingToWithdrawError extends PlaymosError {
     constructor(detail?: Record<string, unknown>);
 }
 
-export { type RetryOptions as $, type ActiveSeriesRound as A, type ContractConfig as B, type CancelRoundResult as C, type Eip1193Provider as D, type EscrowHoldInput as E, type GasMode as F, type GasConfig as G, InvalidAmountError as H, InsufficientGasError as I, type ListingStatus as J, type MarketplaceItem as K, type Listing as L, type MarketplaceListInput as M, type Network as N, type MarketplaceSale as O, type PlaymosConfig as P, MissingFieldError as Q, type RoundOpenInput as R, type SettleRoundResult as S, type TransferResult as T, NothingToWithdrawError as U, type VerifyResult as V, type WebhookEvent as W, PaymentFailedError as X, type PaymentStatus as Y, PlaymosError as Z, type PlaymosErrorCode as _, type RoundState as a, type RoundGetVia as a0, type RoundStatus as a1, type WalletConfig as a2, WalletConnectionError as a3, type WalletConnector as a4, WalletTimeoutError as a5, type WebhookEventType as a6, type RoundSettleInput as b, type RoundCancelInput as c, type RoundGetResult as d, type PrizeBalance as e, type WithdrawResult as f, type AgentWallet as g, type AgentFundResult as h, type EscrowHoldResult as i, type EscrowResolveResult as j, type MarketplaceSaleResult as k, type MarketplaceGetResult as l, type PayInput as m, type Payment as n, type EnterRoundInput as o, type TransferReconcile as p, type WaitOptions as q, type TransferInput as r, type TransferConfirmOptions as s, type PayoutRule as t, type ActiveForSeriesResult as u, type AgentEconomyConfig as v, AlreadyEnteredError as w, ApiError as x, AuthError as y, ConfigError as z };
+export { type PaymentStatus as $, type ActiveSeriesRound as A, AuthError as B, type Call as C, ConfigError as D, type EscrowHoldInput as E, type ContractConfig as F, type Eip1193Provider as G, type GasConfig as H, type GasMode as I, InsufficientGasError as J, InvalidAmountError as K, type Listing as L, type MarketplaceListInput as M, type Network as N, type OnchainStatus as O, type PlaymosConfig as P, type ListingStatus as Q, type RoundOpenInput as R, type SettleRoundResult as S, type TransferResult as T, type MarketplaceItem as U, type VerifyResult as V, type WebhookEvent as W, type MarketplaceSale as X, MissingFieldError as Y, NothingToWithdrawError as Z, PaymentFailedError as _, type RoundState as a, type PayoutNotice as a0, type PayoutNoticeStatus as a1, PlaymosError as a2, type PlaymosErrorCode as a3, type RetryOptions as a4, type RoundGetVia as a5, type RoundStatus as a6, type WalletConfig as a7, WalletConnectionError as a8, type WalletConnector as a9, WalletTimeoutError as aa, type WebhookEventType as ab, buildEpochExecuteSettlementCall as ac, toBytes32 as ad, type RoundSettleInput as b, type RoundCancelInput as c, type CancelRoundResult as d, type RoundGetResult as e, type PayoutNoticesResult as f, type PrizeBalance as g, type WithdrawResult as h, type AgentWallet as i, type AgentFundResult as j, type EscrowHoldResult as k, type EscrowResolveResult as l, type MarketplaceSaleResult as m, type MarketplaceGetResult as n, type PayInput as o, type Payment as p, type EnterRoundInput as q, type TransferReconcile as r, type WaitOptions as s, type TransferInput as t, type TransferConfirmOptions as u, type PayoutRule as v, type ActiveForSeriesResult as w, type AgentEconomyConfig as x, AlreadyEnteredError as y, ApiError as z };

package/dist/{errors-Chizbb96.d.ts → errors-CYKgt2VU.d.ts}

@@ -24,11 +24,19 @@ interface GasConfig {
     paymasterUrl?: string;
 }
 interface WalletConfig {
+    /**
+     * Which connector name to use when {@link WalletConfig.provider} is omitted.
+     * - `"injected"` — requires `globalThis.ethereum` (wallet browser / extension).
+     * - `"base-account"` (default) — **not** a built-in Base Account package inside
+     *   `@playmos/sdk`. Resolution: use injected ethereum if present; otherwise you
+     *   must install `@base-org/account` yourself, construct a provider, and pass
+     *   it as `wallet.provider` (sdk#512). No hard dependency on `@base-org/account`.
+     */
     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.
-     * A raw provider is still **timeout-wrapped** on resolve (#462) — not a no-op passthrough.
+     * Pre-built EIP-1193 provider (host-owned). Always preferred when set.
+     * For Base Account / passkey hosts: construct with `@base-org/account` (or the
+     * Base App injection) and pass it here. Still **timeout-wrapped** on resolve (#462).
      */
     provider?: Eip1193Provider;
 }
@@ -38,6 +46,8 @@ interface ContractConfig {
     usdc?: `0x${string}`;
     playmosPay?: `0x${string}`;
     prizePool?: `0x${string}`;
+    /** EpochPrizePool (rolling-epoch reads — sdk#629). Live PrizePool stays on prizePool. */
+    epochPrizePool?: `0x${string}`;
 }
 /**
  * @deprecated Unused — agent routes are enabled server-side (SERVICE_MASTER_SECRET +
@@ -129,6 +139,10 @@ interface PayInput {
     sku: string;
     /** Your opaque user id. */
     playerId: string;
+    /** sdk#508 — max wait for server-settle poll (ms). Default 60_000. */
+    settleTimeoutMs?: number;
+    /** sdk#508 — abort server-settle polling. */
+    signal?: AbortSignal;
     /**
      * 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
@@ -150,6 +164,13 @@ interface EnterRoundInput {
     amount: string;
     playerId: string;
     idempotencyKey?: string;
+    /**
+     * sdk#508 — max wait for server-settle poll (ms). Default 60_000.
+     * Only applies to no-wallet sandbox server-settle path.
+     */
+    settleTimeoutMs?: number;
+    /** sdk#508 — abort server-settle polling. */
+    signal?: AbortSignal;
     metadata?: Record<string, string>;
     /**
      * Exact on-chain round key for Path B / entryProvider (#201 / #204 / #210).
@@ -385,12 +406,34 @@ 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). */
+    /** "iap" (1% external) or "entry" (prize-pool; `split` is a first-party 60/30/10 projection). */
     kind: "iap" | "entry";
+    /**
+     * Requested amount (USD string). For prize-pool **server-settle**, this may
+     * differ from what moved on chain — see {@link Payment.chainAmount} (sdk#507).
+     */
     amount: string;
     fee: string;
     net: string;
-    /** Present for prize-pool entries: the 60/30/10 breakdown in USD. */
+    /**
+     * On-chain entry amount (USD) when the service observed it (server-settle entry).
+     * PrizePool charges the **round open price**, not necessarily {@link Payment.amount}.
+     * Reconcile economics against this field (or a chain `getRound` read), not `amount` alone.
+     */
+    chainAmount?: string;
+    /** On-chain entry amount in micro-USDC (6 dp integer string), when known. */
+    chainAmountMicro?: string;
+    /**
+     * First-party **60/30/10 projection** (pool/seed/rake USD strings) for prize-pool
+     * entries — bookkeeping preview, **not** a studio 60/30/9+1% split and **not** a
+     * chain-derived settlement observation (sdk#514). Numbers come from SDK constants
+     * (`POOL_BPS`/`SEED_BPS`/`RAKE_BPS`), not from reading the deployed pool’s
+     * constructor bps. On-chain, entry only takes the fee off the top; pool/seed
+     * split at **lock**; payable pot also includes inherited seedBank — so
+     * `split.pool` is **not** “what this round pays.” Reconcile money with
+     * {@link Payment.chainAmount} / pool `getRound`.
+     * Field name kept for compatibility (no rename in V1).
+     */
     split?: {
         pool: string;
         seed: string;
@@ -427,9 +470,17 @@ interface Payment {
 interface VerifyResult {
     id: string;
     status: PaymentStatus;
+    /** Requested amount (USD). May differ from {@link VerifyResult.chainAmount} on server-settle entry. */
     amount: string;
     fee: string;
     net: string;
+    /**
+     * On-chain settled entry amount (USD) when known — distinct from {@link VerifyResult.amount}
+     * (sdk#507 / Vault Pop DX-05b). Prefer this for pot/split economics on shared rounds.
+     */
+    chainAmount?: string;
+    /** On-chain settled entry amount in micro-USDC, when known. */
+    chainAmountMicro?: string;
     txHash?: `0x${string}`;
     playerId: string;
     sku?: string;
@@ -440,6 +491,8 @@ interface VerifyResult {
      *  service can never confirm on-chain. */
     verifiedVia?: "chain" | "cache" | "degraded";
     chainReads?: "enabled" | "degraded";
+    /** Echo of on-chain identity when the service returns it (server-settle). */
+    identity?: string;
 }
 type WebhookEventType = "payment.confirmed" | "payment.failed" | "payout.settled" | "refund.processed";
 interface WebhookEvent {
@@ -587,6 +640,22 @@ interface CancelRoundResult {
     status: "cancelling" | "cancelled";
     round?: RoundState;
 }
+/** L34 / sdk#610 — a win is funded only after the push tx, else claimable. */
+type PayoutNoticeStatus = "funded" | "claimable";
+interface PayoutNotice {
+    roundId: string;
+    wallet: `0x${string}`;
+    amountMicro: string;
+    status: PayoutNoticeStatus;
+    /** Present only when status === "funded". */
+    txHash?: `0x${string}`;
+    reason?: string;
+}
+interface PayoutNoticesResult {
+    roundId?: string;
+    status?: string;
+    notices: PayoutNotice[];
+}
 /** What `rounds.prize({ … })` returns — claimable pull-payment balance (issue #41). */
 interface PrizeBalance {
     roundId: string;
@@ -657,6 +726,43 @@ interface SettleRoundResult {
     status: "settled" | "settling";
 }
 
+/**
+ * EIP-5792 batch primitives — ported from the proven game-hub `payEntryOnchain`
+ * path (`OnchainEntry.ts`). One `wallet_sendCalls` sends `approve` + the settling
+ * call as ONE atomic confirmation; the paymaster sponsors gas when configured.
+ * The player sees a single Apple-Pay-style sheet.
+ */
+
+interface Call {
+    to: `0x${string}`;
+    data: `0x${string}`;
+}
+type OnchainStatus = "PENDING" | "CONFIRMED" | "FAILED";
+
+/**
+ * Calldata builders. IAP / PrizePool entry stay on `toBytes32` (keccak of
+ * UTF-8 via toBytes) because live paid entries were written with it.
+ * Epoch execute uses `seriesToBytes32` — hex-shaped series must not drift.
+ */
+
+/** The server derives these identically (keccak256 of UTF-8 bytes) so the
+ *  off-chain record and the on-chain call line up. */
+declare const toBytes32: (s: string) => `0x${string}`;
+interface EpochExecuteSettlementCallArgs {
+    epochPrizePool: `0x${string}`;
+    series: string;
+    epochId: bigint;
+    winners: `0x${string}`[];
+    amounts: bigint[];
+    signature: `0x${string}`;
+}
+/**
+ * EpochPrizePool.executeSignedSettlement — permissionless relay of an
+ * operator-signed podium (sdk#664 E1b). Series hashed with seriesToBytes32
+ * (not this file's toBytes32) so hex-shaped series cannot drift from the chain.
+ */
+declare function buildEpochExecuteSettlementCall(args: EpochExecuteSettlementCallArgs): Call;
+
 /**
  * Typed, actionable errors — the Stripe bar (spec §11).
  *
@@ -728,4 +834,4 @@ declare class NothingToWithdrawError extends PlaymosError {
     constructor(detail?: Record<string, unknown>);
 }
 
-export { type RetryOptions as $, type ActiveSeriesRound as A, type ContractConfig as B, type CancelRoundResult as C, type Eip1193Provider as D, type EscrowHoldInput as E, type GasMode as F, type GasConfig as G, InvalidAmountError as H, InsufficientGasError as I, type ListingStatus as J, type MarketplaceItem as K, type Listing as L, type MarketplaceListInput as M, type Network as N, type MarketplaceSale as O, type PlaymosConfig as P, MissingFieldError as Q, type RoundOpenInput as R, type SettleRoundResult as S, type TransferResult as T, NothingToWithdrawError as U, type VerifyResult as V, type WebhookEvent as W, PaymentFailedError as X, type PaymentStatus as Y, PlaymosError as Z, type PlaymosErrorCode as _, type RoundState as a, type RoundGetVia as a0, type RoundStatus as a1, type WalletConfig as a2, WalletConnectionError as a3, type WalletConnector as a4, WalletTimeoutError as a5, type WebhookEventType as a6, type RoundSettleInput as b, type RoundCancelInput as c, type RoundGetResult as d, type PrizeBalance as e, type WithdrawResult as f, type AgentWallet as g, type AgentFundResult as h, type EscrowHoldResult as i, type EscrowResolveResult as j, type MarketplaceSaleResult as k, type MarketplaceGetResult as l, type PayInput as m, type Payment as n, type EnterRoundInput as o, type TransferReconcile as p, type WaitOptions as q, type TransferInput as r, type TransferConfirmOptions as s, type PayoutRule as t, type ActiveForSeriesResult as u, type AgentEconomyConfig as v, AlreadyEnteredError as w, ApiError as x, AuthError as y, ConfigError as z };
+export { type PaymentStatus as $, type ActiveSeriesRound as A, AuthError as B, type Call as C, ConfigError as D, type EscrowHoldInput as E, type ContractConfig as F, type Eip1193Provider as G, type GasConfig as H, type GasMode as I, InsufficientGasError as J, InvalidAmountError as K, type Listing as L, type MarketplaceListInput as M, type Network as N, type OnchainStatus as O, type PlaymosConfig as P, type ListingStatus as Q, type RoundOpenInput as R, type SettleRoundResult as S, type TransferResult as T, type MarketplaceItem as U, type VerifyResult as V, type WebhookEvent as W, type MarketplaceSale as X, MissingFieldError as Y, NothingToWithdrawError as Z, PaymentFailedError as _, type RoundState as a, type PayoutNotice as a0, type PayoutNoticeStatus as a1, PlaymosError as a2, type PlaymosErrorCode as a3, type RetryOptions as a4, type RoundGetVia as a5, type RoundStatus as a6, type WalletConfig as a7, WalletConnectionError as a8, type WalletConnector as a9, WalletTimeoutError as aa, type WebhookEventType as ab, buildEpochExecuteSettlementCall as ac, toBytes32 as ad, type RoundSettleInput as b, type RoundCancelInput as c, type CancelRoundResult as d, type RoundGetResult as e, type PayoutNoticesResult as f, type PrizeBalance as g, type WithdrawResult as h, type AgentWallet as i, type AgentFundResult as j, type EscrowHoldResult as k, type EscrowResolveResult as l, type MarketplaceSaleResult as m, type MarketplaceGetResult as n, type PayInput as o, type Payment as p, type EnterRoundInput as q, type TransferReconcile as r, type WaitOptions as s, type TransferInput as t, type TransferConfirmOptions as u, type PayoutRule as v, type ActiveForSeriesResult as w, type AgentEconomyConfig as x, AlreadyEnteredError as y, ApiError as z };