@atxp/worldchain 0.10.8 → 0.10.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atxp/worldchain",
-  "version": "0.10.8",
+  "version": "0.10.11",
   "description": "ATXP for World Chain Mini Apps",
   "license": "MIT",
   "repository": {
@@ -33,8 +33,8 @@
     "pack:dry": "npm pack --dry-run"
   },
   "dependencies": {
-    "@atxp/client": "0.10.8",
-    "@atxp/common": "0.10.8",
+    "@atxp/client": "0.10.11",
+    "@atxp/common": "0.10.11",
     "@worldcoin/minikit-js": "^1.9.6",
     "bignumber.js": "^9.3.0",
     "viem": "^2.34.0"

package/dist/cache.d.ts

@@ -1,19 +0,0 @@
-import { SpendPermission } from './types.js';
-import { Hex } from '@atxp/client';
-import { type ICache, JsonCache, BrowserCache, MemoryCache } from '@atxp/common';
-/**
- * Stored permission data structure
- */
-export interface Intermediary {
-    /** Ephemeral wallet private key */
-    privateKey: Hex;
-    /** Spend permission from World Chain */
-    permission: SpendPermission;
-}
-/**
- * Type-safe cache wrapper for permission data
- */
-export declare class IntermediaryCache extends JsonCache<Intermediary> {
-}
-export { type ICache, BrowserCache, MemoryCache };
-//# sourceMappingURL=cache.d.ts.map

package/dist/mainWalletPaymentMaker.d.ts

@@ -1,29 +0,0 @@
-import { Logger, Currency, PaymentMaker, AccountId, PaymentIdentifier, Destination } from '@atxp/common';
-import BigNumber from 'bignumber.js';
-export type MainWalletProvider = {
-    request: (params: {
-        method: string;
-        params?: unknown[];
-    }) => Promise<unknown>;
-};
-export declare class MainWalletPaymentMaker implements PaymentMaker {
-    private walletAddress;
-    private provider;
-    private logger;
-    private chainId;
-    private customRpcUrl?;
-    constructor(walletAddress: string, provider: MainWalletProvider, logger?: Logger, chainId?: number, customRpcUrl?: string);
-    getSourceAddress(_params: {
-        amount: BigNumber;
-        currency: Currency;
-        receiver: string;
-        memo: string;
-    }): string;
-    generateJWT({ paymentRequestId, codeChallenge, accountId }: {
-        paymentRequestId: string;
-        codeChallenge: string;
-        accountId?: AccountId | null;
-    }): Promise<string>;
-    makePayment(destinations: Destination[], memo: string, _paymentRequestId?: string): Promise<PaymentIdentifier | null>;
-}
-//# sourceMappingURL=mainWalletPaymentMaker.d.ts.map

package/dist/minikit.d.ts

@@ -1,76 +0,0 @@
-import type { MiniKit as MiniKitType } from "@worldcoin/minikit-js";
-import { Logger } from "@atxp/common";
-import { WorldchainAccount } from "./worldchainAccount.js";
-/**
- * Loads and initializes a Worldchain account with MiniKit integration
- *
- * This function creates a Worldchain account that can interact with the World Chain network
- * using MiniKit for transaction signing and wallet operations. It sets up a custom provider
- * that handles various Ethereum JSON-RPC methods through MiniKit's interface.
- *
- * @param walletAddress - The wallet address to use for the account
- * @param logger - Optional logger instance for debugging and monitoring
- * @param customRpcUrl - Optional custom RPC URL for Worldchain. If not provided, uses the public RPC endpoint
- * @param chainId - Optional chain ID (defaults to 480 for mainnet, can be 4801 for sepolia)
- * @param miniKit - The MiniKit instance to use for transactions and signing
- * @returns Promise that resolves to an initialized WorldchainAccount instance
- *
- * @example
- * ```typescript
- * // Using public RPC endpoint (mainnet)
- * const account = await createMiniKitWorldchainAccount({
- *   walletAddress: "0x1234...",
- *   logger: new ConsoleLogger(),
- *   miniKit: MiniKit
- * });
- *
- * // Using sepolia testnet
- * const account = await createMiniKitWorldchainAccount({
- *   walletAddress: "0x1234...",
- *   logger: new ConsoleLogger(),
- *   chainId: 4801,
- *   miniKit: MiniKit
- * });
- * ```
- *
- * @remarks
- * The function creates a custom provider that supports:
- * - `eth_accounts`: Returns the wallet address
- * - `eth_chainId`: Returns Worldchain chain ID (configurable)
- * - `eth_requestAccounts`: Returns the wallet address
- * - `eth_sendTransaction`: Handles USDC transfers and other transactions via MiniKit
- * - `personal_sign`: Signs messages using MiniKit
- *
- * The account is configured with:
- * - 10 USDC allowance
- * - 30-day period for permissions
- * - Worldchain RPC endpoint (public or custom)
- * - Regular wallet mode (no ephemeral wallet)
- *
- * @throws {Error} When MiniKit operations fail or unsupported transaction types are encountered
- */
-export declare const createMiniKitWorldchainAccount: ({ walletAddress, logger: loggerParam, customRpcUrl, chainId, miniKit }: {
-    walletAddress: string;
-    logger?: Logger;
-    customRpcUrl?: string;
-    chainId?: number;
-    miniKit: typeof MiniKitType;
-}) => Promise<WorldchainAccount>;
-/**
- * Resolves a MiniKit transaction ID to the actual blockchain transaction hash
- * using the World API
- */
-export declare function resolveTransactionHash(transactionId: string, logger: Logger): Promise<{
-    transactionHash: string;
-    status: string;
-} | null>;
-/**
- * Waits for a MiniKit transaction to be confirmed and returns the transaction hash
- * Polls the World API until the transaction is confirmed or times out
- */
-export declare function waitForTransactionConfirmation(transactionId: string, logger: Logger, timeoutMs?: number, // 2 minutes
-pollIntervalMs?: number): Promise<{
-    transactionHash: string;
-    status: string;
-} | null>;
-//# sourceMappingURL=minikit.d.ts.map

package/dist/smartWalletHelpers.d.ts

@@ -1,26 +0,0 @@
-import { type Account, type Address, type Hex } from 'viem';
-import { type BundlerClient, type SmartAccount } from 'viem/account-abstraction';
-export declare const DEFAULT_WORLD_CHAIN_MAINNET_RPC = "https://worldchain-mainnet.g.alchemy.com/public";
-export declare const DEFAULT_WORLD_CHAIN_SEPOLIA_RPC = "https://worldchain-sepolia.g.alchemy.com/public";
-/**
- * Get default RPC URL for a World Chain by chain ID
- */
-export declare const getDefaultWorldChainRPC: (chainId: number) => string;
-export interface EphemeralSmartWallet {
-    address: Address;
-    client: BundlerClient;
-    account: SmartAccount;
-    signer: Account;
-}
-/**
- * Creates an ephemeral smart wallet for World Chain
- * Note: This implementation uses Coinbase's smart wallet infrastructure
- * adapted for World Chain. This may need updates when World Chain
- * provides their own account abstraction infrastructure.
- *
- * @param privateKey - Private key for the wallet signer
- * @param rpcUrl - Optional custom RPC URL
- * @param chainId - Chain ID (defaults to 480 for mainnet)
- */
-export declare function toEphemeralSmartWallet(privateKey: Hex, rpcUrl?: string, chainId?: number): Promise<EphemeralSmartWallet>;
-//# sourceMappingURL=smartWalletHelpers.d.ts.map

package/dist/spendPermissionShim.d.ts

@@ -1,19 +0,0 @@
-import { Eip1193Provider, SpendPermission } from "./types.js";
-export declare function requestSpendPermission(params: {
-    account: string;
-    spender: string;
-    token: string;
-    chainId: number;
-    allowance: bigint;
-    periodInDays: number;
-    provider: Eip1193Provider;
-}): Promise<SpendPermission>;
-export declare function prepareSpendCallData(params: {
-    permission: SpendPermission;
-    amount: bigint;
-}): Promise<{
-    to: string;
-    data: string;
-    value: bigint;
-}[]>;
-//# sourceMappingURL=spendPermissionShim.d.ts.map

package/dist/testHelpers.d.ts

@@ -1,104 +0,0 @@
-import type { SpendPermission } from './types.js';
-import type { EphemeralSmartWallet } from './smartWalletHelpers.js';
-import { WorldchainPaymentMaker, type ConfirmationDelays, type WorldchainPaymentMakerOptions } from './worldchainPaymentMaker.js';
-import type { Address } from 'viem';
-export declare const TEST_WALLET_ADDRESS: Address;
-export declare const TEST_SMART_WALLET_ADDRESS: Address;
-export declare const TEST_RECEIVER_ADDRESS: Address;
-export declare const TEST_PRIVATE_KEY: `0x${string}`;
-export declare const TEST_PAYMASTER_URL = "https://worldchain-bundler.example.com";
-export declare const TEST_BUNDLER_URL = "https://worldchain-bundler.example.com";
-export declare const TEST_CONFIRMATION_DELAYS: ConfirmationDelays;
-export declare function mockProvider({ request }?: {
-    request?: import("vitest").Mock<import("@vitest/spy").Procedure> | undefined;
-}): {
-    request: import("vitest").Mock<import("@vitest/spy").Procedure>;
-};
-export declare function mockSpendPermission({ signature, account, spender, token, allowance, // 10 USDC
-period, // 7 days
-start, end, salt, extraData, chainId }?: {
-    signature?: `0x${string}` | undefined;
-    account?: `0x${string}` | undefined;
-    spender?: `0x${string}` | undefined;
-    token?: string | undefined;
-    allowance?: string | undefined;
-    period?: number | undefined;
-    start?: number | undefined;
-    end?: number | undefined;
-    salt?: string | undefined;
-    extraData?: `0x${string}` | undefined;
-    chainId?: number | undefined;
-}): SpendPermission;
-export declare function removeTimestamps<T extends Record<string, any>>(obj: T): T;
-export declare function expectTimestampAround(timestamp: number, expectedOffset?: number, tolerance?: number): void;
-export declare function mockExpiredSpendPermission(overrides?: {}): SpendPermission;
-export declare function mockSmartAccount({ address, signMessage }?: {
-    address?: `0x${string}` | undefined;
-    signMessage?: import("vitest").Mock<import("@vitest/spy").Procedure> | undefined;
-}): any;
-export declare function mockBundlerClient({ sendUserOperation, waitForUserOperationReceipt, waitForTransactionReceipt }?: {
-    sendUserOperation?: import("vitest").Mock<import("@vitest/spy").Procedure> | undefined;
-    waitForUserOperationReceipt?: import("vitest").Mock<import("@vitest/spy").Procedure> | undefined;
-    waitForTransactionReceipt?: import("vitest").Mock<import("@vitest/spy").Procedure> | undefined;
-}): any;
-export declare function mockFailedBundlerClient({ failureType }?: {
-    failureType?: string | undefined;
-}): any;
-export declare function mockEphemeralSmartWallet({ address, account, client, privateKey }?: {
-    address?: `0x${string}` | undefined;
-    account?: any;
-    client?: any;
-    privateKey?: `0x${string}` | undefined;
-}): EphemeralSmartWallet;
-export declare function mockSpendCalls({ calls }?: {
-    calls?: {
-        to: string;
-        data: string;
-        value: string;
-    }[] | undefined;
-}): {
-    to: string;
-    data: string;
-    value: string;
-}[];
-/**
- * Helper to create a WorldchainPaymentMaker for testing with fast confirmation delays
- *
- * @param permission - Spend permission (defaults to mock)
- * @param smartWallet - Smart wallet (defaults to mock)
- * @param options - Additional options
- * @returns WorldchainPaymentMaker configured for testing
- */
-export declare function createTestWorldchainPaymentMaker(permission?: SpendPermission, smartWallet?: EphemeralSmartWallet, options?: Partial<WorldchainPaymentMakerOptions>): WorldchainPaymentMaker;
-/**
- * Builder pattern for creating test payment makers with fluent API
- */
-export declare class TestWorldchainPaymentMakerBuilder {
-    private permission?;
-    private smartWallet?;
-    private options;
-    withPermission(permission: SpendPermission): this;
-    withSmartWallet(wallet: EphemeralSmartWallet): this;
-    withTestDelays(delays?: ConfirmationDelays): this;
-    withChainId(chainId: number): this;
-    withCustomRpc(rpcUrl: string): this;
-    build(): WorldchainPaymentMaker;
-}
-export declare function setupInitializationMocks({ provider, smartAccount, bundlerClient, spendPermission, ephemeralWallet }?: {
-    provider?: {
-        request: import("vitest").Mock<import("@vitest/spy").Procedure>;
-    } | undefined;
-    smartAccount?: any;
-    bundlerClient?: any;
-    spendPermission?: SpendPermission | undefined;
-    ephemeralWallet?: EphemeralSmartWallet | undefined;
-}): Promise<any>;
-export declare function setupPaymentMocks({ spendCalls }?: {
-    spendCalls?: {
-        to: string;
-        data: string;
-        value: string;
-    }[] | undefined;
-}): Promise<any>;
-export declare function getCacheKey(walletAddress: string): string;
-//# sourceMappingURL=testHelpers.d.ts.map

package/dist/types.d.ts

@@ -1,41 +0,0 @@
-/**
- * Represents a spending permission with limits
- */
-export type SpendPermission = {
-    /** UTC timestamp for when the permission was granted */
-    createdAt?: number;
-    /** Hash of the permission in hex format */
-    permissionHash?: string;
-    /** Cryptographic signature in hex format */
-    signature: string;
-    /** Chain ID */
-    chainId?: number;
-    /** The permission details */
-    permission: {
-        /** Wallet address of the account */
-        account: string;
-        /** Address of the contract/entity allowed to spend */
-        spender: string;
-        /** Address of the token being spent */
-        token: string;
-        /** Maximum amount allowed as base 10 numeric string */
-        allowance: string;
-        /** Time period in seconds */
-        period: number;
-        /** Start time in unix seconds */
-        start: number;
-        /** Expiration time in unix seconds */
-        end: number;
-        /** Salt as base 10 numeric string */
-        salt: string;
-        /** Additional data in hex format */
-        extraData: string;
-    };
-};
-export type Eip1193Provider = {
-    request: (params: {
-        method: string;
-        params?: unknown[];
-    }) => Promise<unknown>;
-};
-//# sourceMappingURL=types.d.ts.map

package/dist/worldchainPaymentMaker.d.ts

@@ -1,80 +0,0 @@
-import { Logger, Currency, PaymentMaker, AccountId, PaymentIdentifier, Destination } from '@atxp/common';
-import BigNumber from 'bignumber.js';
-import { SpendPermission } from './types.js';
-import { type EphemeralSmartWallet } from './smartWalletHelpers.js';
-/**
- * Configuration for transaction confirmation delays
- */
-export interface ConfirmationDelays {
-    /** Network propagation delay in milliseconds (must be >= 0) */
-    networkPropagationMs: number;
-    /** Confirmation failed delay in milliseconds (must be >= 0) */
-    confirmationFailedMs: number;
-}
-/**
- * Options for configuring WorldchainPaymentMaker
- */
-export interface WorldchainPaymentMakerOptions {
-    /** Logger instance for debug output */
-    logger?: Logger;
-    /** Chain ID (defaults to World Chain Mainnet) */
-    chainId?: number;
-    /** Custom RPC URL for the chain */
-    customRpcUrl?: string;
-    /** Custom confirmation delays (defaults to production values) */
-    confirmationDelays?: ConfirmationDelays;
-}
-/**
- * Gets default confirmation delays based on environment
- */
-export declare const getDefaultConfirmationDelays: () => ConfirmationDelays;
-/**
- * Payment maker for World Chain transactions using smart wallets and spend permissions
- *
- * @example
- * ```typescript
- * // For production use (default delays)
- * const paymentMaker = new WorldchainPaymentMaker(permission, wallet);
- *
- * // For testing (fast delays)
- * const paymentMaker = new WorldchainPaymentMaker(permission, wallet, {
- *   confirmationDelays: { networkPropagationMs: 10, confirmationFailedMs: 20 }
- * });
- *
- * // With custom configuration
- * const paymentMaker = new WorldchainPaymentMaker(permission, wallet, {
- *   chainId: 480, // World Chain Mainnet
- *   customRpcUrl: 'https://my-rpc.com',
- *   logger: myLogger
- * });
- * ```
- */
-export declare class WorldchainPaymentMaker implements PaymentMaker {
-    private logger;
-    private spendPermission;
-    private smartWallet;
-    private chainId;
-    private customRpcUrl?;
-    private confirmationDelays;
-    /**
-     * Creates a new WorldchainPaymentMaker instance
-     *
-     * @param spendPermission - The spend permission for transactions
-     * @param smartWallet - The smart wallet instance to use
-     * @param options - Optional configuration
-     */
-    constructor(spendPermission: SpendPermission, smartWallet: EphemeralSmartWallet, options?: WorldchainPaymentMakerOptions);
-    getSourceAddress(_params: {
-        amount: BigNumber;
-        currency: Currency;
-        receiver: string;
-        memo: string;
-    }): string;
-    generateJWT({ paymentRequestId, codeChallenge, accountId }: {
-        paymentRequestId: string;
-        codeChallenge: string;
-        accountId?: AccountId | null;
-    }): Promise<string>;
-    makePayment(destinations: Destination[], memo: string, _paymentRequestId?: string): Promise<PaymentIdentifier | null>;
-}
-//# sourceMappingURL=worldchainPaymentMaker.d.ts.map