@pepu-chain/sdk 0.0.0-stage → 0.2.1

package/dist/erc7677-DOW58QBE.d.cts

@@ -0,0 +1,111 @@
+import { Address, Hex } from 'viem';
+
+/**
+ * ERC-7677 paymaster web-service types, for the two JSON-RPC methods PEPU's
+ * paymaster policy service implements: `pm_getPaymasterStubData` and
+ * `pm_getPaymasterData`. See https://eips.ethereum.org/EIPS/eip-7677.
+ *
+ * Pure types plus a few tiny builders: no network, no secrets, safe in a
+ * browser bundle. Quantities are `0x`-prefixed hex strings, as on the wire.
+ *
+ * Note this package never implies sponsorship is available to an app: see
+ * `getSponsorshipStatus()`. These types describe the protocol only.
+ */
+/** An ERC-4337 v0.7 UserOperation in its unpacked JSON-RPC shape. */
+interface Erc7677UserOperation {
+    sender: Address;
+    nonce: Hex;
+    factory?: Address;
+    factoryData?: Hex;
+    callData: Hex;
+    callGasLimit: Hex;
+    verificationGasLimit: Hex;
+    preVerificationGas: Hex;
+    maxFeePerGas: Hex;
+    maxPriorityFeePerGas: Hex;
+    paymaster?: Address;
+    paymasterVerificationGasLimit?: Hex;
+    paymasterPostOpGasLimit?: Hex;
+    paymasterData?: Hex;
+    signature: Hex;
+}
+/** Paymaster-defined, JSON-serializable context (params[3]). */
+type PaymasterContext = Record<string, unknown>;
+type PaymasterRpcParams = readonly [
+    userOperation: Partial<Erc7677UserOperation> & Pick<Erc7677UserOperation, "sender" | "callData">,
+    entryPoint: Address,
+    chainId: Hex,
+    context?: PaymasterContext
+];
+interface PaymasterStubDataRequest {
+    jsonrpc: "2.0";
+    id: number | string;
+    method: "pm_getPaymasterStubData";
+    params: PaymasterRpcParams;
+}
+interface PaymasterDataRequest {
+    jsonrpc: "2.0";
+    id: number | string;
+    method: "pm_getPaymasterData";
+    params: PaymasterRpcParams;
+}
+/** Result of `pm_getPaymasterStubData`. Stub values are for gas estimation only. */
+interface PaymasterStubDataResult {
+    paymaster: Address;
+    paymasterData: Hex;
+    paymasterVerificationGasLimit?: Hex;
+    paymasterPostOpGasLimit?: Hex;
+    /** `true` when the stub values are also the final values. */
+    isFinal?: boolean;
+    sponsor?: {
+        name: string;
+        icon?: string;
+    };
+}
+/** Result of `pm_getPaymasterData`: the signed values to submit. */
+interface PaymasterDataResult {
+    paymaster: Address;
+    paymasterData: Hex;
+    paymasterVerificationGasLimit?: Hex;
+    paymasterPostOpGasLimit?: Hex;
+}
+interface PaymasterRpcError {
+    code: number;
+    message: string;
+    /** PEPU's policy service puts the machine-readable denial reason in `data.reason`. */
+    data?: {
+        reason?: string;
+    } & Record<string, unknown>;
+}
+type PaymasterRpcResponse<TResult> = {
+    jsonrpc: "2.0";
+    id: number | string | null;
+    result: TResult;
+} | {
+    jsonrpc: "2.0";
+    id: number | string | null;
+    error: PaymasterRpcError;
+};
+/**
+ * Build a paymaster `context` object: drops `undefined` entries and throws on
+ * anything that would not survive `JSON.stringify` (bigint, function, symbol),
+ * so a bad value fails here instead of as an opaque RPC error. Returns `{}`
+ * for no input. The context is paymaster-defined; PEPU's policy service
+ * currently accepts and ignores it.
+ */
+declare function buildPaymasterContext(entries?: Readonly<Record<string, unknown>>): PaymasterContext;
+interface BuildPaymasterRequestOptions {
+    userOperation: PaymasterRpcParams[0];
+    /** Defaults to PEPU mainnet's EntryPoint v0.7. */
+    entryPoint?: Address;
+    /** Defaults to 97741 (PEPU mainnet). */
+    chainId?: number;
+    context?: PaymasterContext;
+    id?: number | string;
+}
+/** Build a `pm_getPaymasterStubData` JSON-RPC request body. */
+declare function buildPaymasterStubDataRequest(options: BuildPaymasterRequestOptions): PaymasterStubDataRequest;
+/** Build a `pm_getPaymasterData` JSON-RPC request body. */
+declare function buildPaymasterDataRequest(options: BuildPaymasterRequestOptions): PaymasterDataRequest;
+
+export { type BuildPaymasterRequestOptions as B, type Erc7677UserOperation as E, type PaymasterContext as P, type PaymasterDataRequest as a, type PaymasterDataResult as b, type PaymasterRpcError as c, type PaymasterRpcParams as d, type PaymasterRpcResponse as e, type PaymasterStubDataRequest as f, type PaymasterStubDataResult as g, buildPaymasterContext as h, buildPaymasterDataRequest as i, buildPaymasterStubDataRequest as j };

package/dist/erc7677-DOW58QBE.d.ts

@@ -0,0 +1,111 @@
+import { Address, Hex } from 'viem';
+
+/**
+ * ERC-7677 paymaster web-service types, for the two JSON-RPC methods PEPU's
+ * paymaster policy service implements: `pm_getPaymasterStubData` and
+ * `pm_getPaymasterData`. See https://eips.ethereum.org/EIPS/eip-7677.
+ *
+ * Pure types plus a few tiny builders: no network, no secrets, safe in a
+ * browser bundle. Quantities are `0x`-prefixed hex strings, as on the wire.
+ *
+ * Note this package never implies sponsorship is available to an app: see
+ * `getSponsorshipStatus()`. These types describe the protocol only.
+ */
+/** An ERC-4337 v0.7 UserOperation in its unpacked JSON-RPC shape. */
+interface Erc7677UserOperation {
+    sender: Address;
+    nonce: Hex;
+    factory?: Address;
+    factoryData?: Hex;
+    callData: Hex;
+    callGasLimit: Hex;
+    verificationGasLimit: Hex;
+    preVerificationGas: Hex;
+    maxFeePerGas: Hex;
+    maxPriorityFeePerGas: Hex;
+    paymaster?: Address;
+    paymasterVerificationGasLimit?: Hex;
+    paymasterPostOpGasLimit?: Hex;
+    paymasterData?: Hex;
+    signature: Hex;
+}
+/** Paymaster-defined, JSON-serializable context (params[3]). */
+type PaymasterContext = Record<string, unknown>;
+type PaymasterRpcParams = readonly [
+    userOperation: Partial<Erc7677UserOperation> & Pick<Erc7677UserOperation, "sender" | "callData">,
+    entryPoint: Address,
+    chainId: Hex,
+    context?: PaymasterContext
+];
+interface PaymasterStubDataRequest {
+    jsonrpc: "2.0";
+    id: number | string;
+    method: "pm_getPaymasterStubData";
+    params: PaymasterRpcParams;
+}
+interface PaymasterDataRequest {
+    jsonrpc: "2.0";
+    id: number | string;
+    method: "pm_getPaymasterData";
+    params: PaymasterRpcParams;
+}
+/** Result of `pm_getPaymasterStubData`. Stub values are for gas estimation only. */
+interface PaymasterStubDataResult {
+    paymaster: Address;
+    paymasterData: Hex;
+    paymasterVerificationGasLimit?: Hex;
+    paymasterPostOpGasLimit?: Hex;
+    /** `true` when the stub values are also the final values. */
+    isFinal?: boolean;
+    sponsor?: {
+        name: string;
+        icon?: string;
+    };
+}
+/** Result of `pm_getPaymasterData`: the signed values to submit. */
+interface PaymasterDataResult {
+    paymaster: Address;
+    paymasterData: Hex;
+    paymasterVerificationGasLimit?: Hex;
+    paymasterPostOpGasLimit?: Hex;
+}
+interface PaymasterRpcError {
+    code: number;
+    message: string;
+    /** PEPU's policy service puts the machine-readable denial reason in `data.reason`. */
+    data?: {
+        reason?: string;
+    } & Record<string, unknown>;
+}
+type PaymasterRpcResponse<TResult> = {
+    jsonrpc: "2.0";
+    id: number | string | null;
+    result: TResult;
+} | {
+    jsonrpc: "2.0";
+    id: number | string | null;
+    error: PaymasterRpcError;
+};
+/**
+ * Build a paymaster `context` object: drops `undefined` entries and throws on
+ * anything that would not survive `JSON.stringify` (bigint, function, symbol),
+ * so a bad value fails here instead of as an opaque RPC error. Returns `{}`
+ * for no input. The context is paymaster-defined; PEPU's policy service
+ * currently accepts and ignores it.
+ */
+declare function buildPaymasterContext(entries?: Readonly<Record<string, unknown>>): PaymasterContext;
+interface BuildPaymasterRequestOptions {
+    userOperation: PaymasterRpcParams[0];
+    /** Defaults to PEPU mainnet's EntryPoint v0.7. */
+    entryPoint?: Address;
+    /** Defaults to 97741 (PEPU mainnet). */
+    chainId?: number;
+    context?: PaymasterContext;
+    id?: number | string;
+}
+/** Build a `pm_getPaymasterStubData` JSON-RPC request body. */
+declare function buildPaymasterStubDataRequest(options: BuildPaymasterRequestOptions): PaymasterStubDataRequest;
+/** Build a `pm_getPaymasterData` JSON-RPC request body. */
+declare function buildPaymasterDataRequest(options: BuildPaymasterRequestOptions): PaymasterDataRequest;
+
+export { type BuildPaymasterRequestOptions as B, type Erc7677UserOperation as E, type PaymasterContext as P, type PaymasterDataRequest as a, type PaymasterDataResult as b, type PaymasterRpcError as c, type PaymasterRpcParams as d, type PaymasterRpcResponse as e, type PaymasterStubDataRequest as f, type PaymasterStubDataResult as g, buildPaymasterContext as h, buildPaymasterDataRequest as i, buildPaymasterStubDataRequest as j };

package/dist/errors-CgX1vNj7.d.cts

@@ -0,0 +1,100 @@
+import { Hex } from 'viem';
+
+/**
+ * The SDK error model. Everything the SDK throws is a {@link PepuError}
+ * subclass carrying a stable `code`, a one-sentence `hint` and a `docsUrl`.
+ * Messages never contain secrets: they name environment variables, never
+ * their values.
+ */
+declare const PEPU_ERRORS_DOCS_URL = "https://guide.pepeunchained.com/reference/errors";
+type PepuErrorCode = "CONFIG_MISSING_ENV" | "CONFIG_BAD_URL" | "CONFIG_SERVER_ONLY" | "CONFIG_PRIVY_DASHBOARD" | "CONFIG_PRIVY_CREATE_ON_LOGIN" | "CONFIG_ORIGIN_MISMATCH" | "AUTH_INVALID_TOKEN" | "WALLET_NOT_PROVISIONED" | "WALLET_COINBASE_UNSUPPORTED_CHAIN" | "WALLET_INJECTED_ACTIVE" | "POLICY_UNSCOPED" | "POLICY_NAME_TOO_LONG" | "SESSION_EXPIRED" | "SESSION_NONE" | "SESSION_APPROVAL_MISMATCH" | "PRIVY_CHAIN_REJECTED_97741" | "PRIVY_KEY_QUORUM_MISMATCH" | "BUNDLER_UNREACHABLE" | "BUNDLER_AA_FAILED" | "PAYMASTER_DENIED" | "PAYMASTER_NO_BALANCE" | "PAYMASTER_CAP" | "PAYMASTER_ORIGIN_NOT_ALLOWED" | "PAYMASTER_DESTINATION_NOT_ALLOWED" | "PAYMASTER_PROJECT_NOT_CLAIMED" | "PAYMASTER_PROJECT_OWNER_CHANGED" | "PAYMASTER_PROJECT_PAUSED" | "PAYMASTER_IDENTITY_REQUIRED" | "PAYMASTER_FREE_TIER_UNAVAILABLE" | "PAYMASTER_RATE_LIMITED" | "PAYMASTER_SESSION_REQUIRED" | "PAYMASTER_API_ERROR" | "TX_REVERTED" | "TX_NONCE_RACE" | "TX_GAS_UNDERSHOOT" | "MULTICALL3_CANONICAL_ADDRESS" | "UNKNOWN";
+interface ErrorCatalogEntry {
+    readonly code: PepuErrorCode;
+    readonly title: string;
+    /** What went wrong, in one or two sentences. */
+    readonly cause: string;
+    /** How to fix it. */
+    readonly fix: string;
+    /** Suggested HTTP status for route factories. */
+    readonly status: number;
+    readonly retryable: boolean;
+    /** Tested, in order, against the flattened error text. Empty for code-only entries. */
+    readonly matchers: readonly RegExp[];
+}
+/**
+ * Single source for the SDK `explainError`, the MCP `pepu_explain_error` tool
+ * and the generated docs error page. ORDER MATTERS: the first entry whose
+ * matcher hits wins, so specific entries come before general ones.
+ */
+declare const PEPU_ERROR_CATALOG: readonly ErrorCatalogEntry[];
+/** Look up a catalog entry by code. */
+declare function getErrorEntry(code: PepuErrorCode): ErrorCatalogEntry;
+/** `https://guide.pepeunchained.com/reference/errors#<CODE>` */
+declare function errorDocsUrl(code: PepuErrorCode): string;
+interface PepuErrorOptions {
+    hint?: string;
+    docsUrl?: string;
+    retryable?: boolean;
+    status?: number;
+    details?: unknown;
+    cause?: unknown;
+}
+declare class PepuError extends Error {
+    readonly code: PepuErrorCode;
+    readonly hint: string;
+    readonly docsUrl: string;
+    readonly retryable: boolean;
+    readonly status: number;
+    readonly details?: unknown;
+    constructor(code: PepuErrorCode, message?: string, options?: PepuErrorOptions);
+}
+/** Missing env, bad URL, dashboard misconfiguration. */
+declare class PepuConfigError extends PepuError {
+}
+/** Bad or missing Privy token, wrong owner. */
+declare class PepuAuthError extends PepuError {
+}
+/** Unscoped policy, name too long, expiry, denied by policy. */
+declare class PepuPolicyError extends PepuError {
+}
+/** No session, expired, mismatched approval. */
+declare class PepuSessionError extends PepuError {
+}
+/** AAxx, JSON-RPC errors, timeouts. */
+declare class PepuBundlerError extends PepuError {
+}
+/** Reason codes, caps, balance, origin. */
+declare class PepuPaymasterError extends PepuError {
+}
+/** Revert, nonce race, gas, rpc rate limit. */
+declare class PepuChainError extends PepuError {
+}
+interface ErrorExplanation {
+    code: PepuErrorCode;
+    title: string;
+    cause: string;
+    fix: string;
+    docsUrl: string;
+    matched: "catalog" | "abi-decode" | "unknown";
+}
+/**
+ * Explain an error, an error message, or raw revert data (`0x...`). Pure and
+ * synchronous; never throws.
+ */
+declare function explainError(e: unknown | string | Hex): ErrorExplanation;
+/** Wrap anything thrown into a typed {@link PepuError}. PepuErrors pass through. */
+declare function toPepuError(e: unknown, ctx?: {
+    op: string;
+}): PepuError;
+/** The `{ error: { code, message, hint } }` body route factories return. */
+declare function toErrorBody(e: unknown): {
+    error: {
+        code: PepuErrorCode;
+        message: string;
+        hint: string;
+    };
+};
+/** A JSON `Response` with the error body and the status from the error model. */
+declare function toErrorResponse(e: unknown): Response;
+
+export { type ErrorCatalogEntry as E, PepuError as P, PepuBundlerError as a, PepuPaymasterError as b, type PepuErrorCode as c, type ErrorExplanation as d, PEPU_ERRORS_DOCS_URL as e, PEPU_ERROR_CATALOG as f, PepuAuthError as g, PepuChainError as h, PepuConfigError as i, type PepuErrorOptions as j, PepuPolicyError as k, PepuSessionError as l, errorDocsUrl as m, explainError as n, getErrorEntry as o, toErrorResponse as p, toPepuError as q, toErrorBody as t };

package/dist/errors-CgX1vNj7.d.ts

@@ -0,0 +1,100 @@
+import { Hex } from 'viem';
+
+/**
+ * The SDK error model. Everything the SDK throws is a {@link PepuError}
+ * subclass carrying a stable `code`, a one-sentence `hint` and a `docsUrl`.
+ * Messages never contain secrets: they name environment variables, never
+ * their values.
+ */
+declare const PEPU_ERRORS_DOCS_URL = "https://guide.pepeunchained.com/reference/errors";
+type PepuErrorCode = "CONFIG_MISSING_ENV" | "CONFIG_BAD_URL" | "CONFIG_SERVER_ONLY" | "CONFIG_PRIVY_DASHBOARD" | "CONFIG_PRIVY_CREATE_ON_LOGIN" | "CONFIG_ORIGIN_MISMATCH" | "AUTH_INVALID_TOKEN" | "WALLET_NOT_PROVISIONED" | "WALLET_COINBASE_UNSUPPORTED_CHAIN" | "WALLET_INJECTED_ACTIVE" | "POLICY_UNSCOPED" | "POLICY_NAME_TOO_LONG" | "SESSION_EXPIRED" | "SESSION_NONE" | "SESSION_APPROVAL_MISMATCH" | "PRIVY_CHAIN_REJECTED_97741" | "PRIVY_KEY_QUORUM_MISMATCH" | "BUNDLER_UNREACHABLE" | "BUNDLER_AA_FAILED" | "PAYMASTER_DENIED" | "PAYMASTER_NO_BALANCE" | "PAYMASTER_CAP" | "PAYMASTER_ORIGIN_NOT_ALLOWED" | "PAYMASTER_DESTINATION_NOT_ALLOWED" | "PAYMASTER_PROJECT_NOT_CLAIMED" | "PAYMASTER_PROJECT_OWNER_CHANGED" | "PAYMASTER_PROJECT_PAUSED" | "PAYMASTER_IDENTITY_REQUIRED" | "PAYMASTER_FREE_TIER_UNAVAILABLE" | "PAYMASTER_RATE_LIMITED" | "PAYMASTER_SESSION_REQUIRED" | "PAYMASTER_API_ERROR" | "TX_REVERTED" | "TX_NONCE_RACE" | "TX_GAS_UNDERSHOOT" | "MULTICALL3_CANONICAL_ADDRESS" | "UNKNOWN";
+interface ErrorCatalogEntry {
+    readonly code: PepuErrorCode;
+    readonly title: string;
+    /** What went wrong, in one or two sentences. */
+    readonly cause: string;
+    /** How to fix it. */
+    readonly fix: string;
+    /** Suggested HTTP status for route factories. */
+    readonly status: number;
+    readonly retryable: boolean;
+    /** Tested, in order, against the flattened error text. Empty for code-only entries. */
+    readonly matchers: readonly RegExp[];
+}
+/**
+ * Single source for the SDK `explainError`, the MCP `pepu_explain_error` tool
+ * and the generated docs error page. ORDER MATTERS: the first entry whose
+ * matcher hits wins, so specific entries come before general ones.
+ */
+declare const PEPU_ERROR_CATALOG: readonly ErrorCatalogEntry[];
+/** Look up a catalog entry by code. */
+declare function getErrorEntry(code: PepuErrorCode): ErrorCatalogEntry;
+/** `https://guide.pepeunchained.com/reference/errors#<CODE>` */
+declare function errorDocsUrl(code: PepuErrorCode): string;
+interface PepuErrorOptions {
+    hint?: string;
+    docsUrl?: string;
+    retryable?: boolean;
+    status?: number;
+    details?: unknown;
+    cause?: unknown;
+}
+declare class PepuError extends Error {
+    readonly code: PepuErrorCode;
+    readonly hint: string;
+    readonly docsUrl: string;
+    readonly retryable: boolean;
+    readonly status: number;
+    readonly details?: unknown;
+    constructor(code: PepuErrorCode, message?: string, options?: PepuErrorOptions);
+}
+/** Missing env, bad URL, dashboard misconfiguration. */
+declare class PepuConfigError extends PepuError {
+}
+/** Bad or missing Privy token, wrong owner. */
+declare class PepuAuthError extends PepuError {
+}
+/** Unscoped policy, name too long, expiry, denied by policy. */
+declare class PepuPolicyError extends PepuError {
+}
+/** No session, expired, mismatched approval. */
+declare class PepuSessionError extends PepuError {
+}
+/** AAxx, JSON-RPC errors, timeouts. */
+declare class PepuBundlerError extends PepuError {
+}
+/** Reason codes, caps, balance, origin. */
+declare class PepuPaymasterError extends PepuError {
+}
+/** Revert, nonce race, gas, rpc rate limit. */
+declare class PepuChainError extends PepuError {
+}
+interface ErrorExplanation {
+    code: PepuErrorCode;
+    title: string;
+    cause: string;
+    fix: string;
+    docsUrl: string;
+    matched: "catalog" | "abi-decode" | "unknown";
+}
+/**
+ * Explain an error, an error message, or raw revert data (`0x...`). Pure and
+ * synchronous; never throws.
+ */
+declare function explainError(e: unknown | string | Hex): ErrorExplanation;
+/** Wrap anything thrown into a typed {@link PepuError}. PepuErrors pass through. */
+declare function toPepuError(e: unknown, ctx?: {
+    op: string;
+}): PepuError;
+/** The `{ error: { code, message, hint } }` body route factories return. */
+declare function toErrorBody(e: unknown): {
+    error: {
+        code: PepuErrorCode;
+        message: string;
+        hint: string;
+    };
+};
+/** A JSON `Response` with the error body and the status from the error model. */
+declare function toErrorResponse(e: unknown): Response;
+
+export { type ErrorCatalogEntry as E, PepuError as P, PepuBundlerError as a, PepuPaymasterError as b, type PepuErrorCode as c, type ErrorExplanation as d, PEPU_ERRORS_DOCS_URL as e, PEPU_ERROR_CATALOG as f, PepuAuthError as g, PepuChainError as h, PepuConfigError as i, type PepuErrorOptions as j, PepuPolicyError as k, PepuSessionError as l, errorDocsUrl as m, explainError as n, getErrorEntry as o, toErrorResponse as p, toPepuError as q, toErrorBody as t };