@coinbase/cdp-core 0.0.98 → 0.0.99

package/dist/web-types/eip1193/errors.d.ts

@@ -1,6 +1,9 @@
 import { Chain } from 'viem';
 import { EvmAddress, User } from '../types.js';
 import * as ox_Provider from "ox/Provider";
+/**
+ * Standard error codes for EIP1193 providers and JSON-RPC methods
+ */
 export declare const STANDARD_ERROR_CODES: {
     rpc: {
         invalidInput: -32000;
@@ -24,33 +27,135 @@ export declare const STANDARD_ERROR_CODES: {
         unsupportedChain: 4902;
     };
 };
+/**
+ * Standard error codes for EIP1193 providers and JSON-RPC methods
+ */
 export type ErrorCodes = typeof STANDARD_ERROR_CODES;
+/**
+ * EIP1193-defined error codes
+ */
 export type EIP1193ErrorCode = (typeof STANDARD_ERROR_CODES)["provider"][keyof (typeof STANDARD_ERROR_CODES)["provider"]];
+/**
+ * Standard JSON-RPC error codes
+ */
 export type RPCErrorCode = (typeof STANDARD_ERROR_CODES)["rpc"][keyof (typeof STANDARD_ERROR_CODES)["rpc"]];
+/**
+ * Error values for EIP1193 and RPC error codes
+ */
 export declare const errorValues: Record<`${EIP1193ErrorCode | RPCErrorCode}`, {
     standard: string;
     message: string;
 }>;
+/**
+ * EIP-1193 provider error.
+ */
 export declare class EIP1193ProviderError extends Error {
+    /**
+     * The error code from EIP1193ErrorCode enum.
+     */
     code: EIP1193ErrorCode;
+    /**
+     * Creates a new EIP-1193 Provider error.
+     *
+     * @param code - The error code from EIP1193ErrorCode enum.
+     * @param message - The error message.
+     */
     constructor(code: EIP1193ErrorCode, message: string);
 }
+/**
+ * Invalid JSON-RPC params error
+ */
 export declare class RPCRequestError extends Error {
+    /**
+     * The error code from RPCErrorCode type.
+     */
     code: RPCErrorCode;
+    /**
+     * Creates a new RPC Invalid Params error.
+     *
+     * @param code - The error code from RPCErrorCode type.
+     * @param message - The error message.
+     */
     constructor(code: RPCErrorCode, message: string);
 }
+/**
+ * Used when a method is attempted to be used with an account type that is not supported.
+ * E.g sendTransaction with a smart account.
+ */
 export declare class AccountTypeMismatchError extends Error {
+    /**
+     * Creates a new AccountTypeMismatchError.
+     *
+     * @param message - The error message.
+     */
     constructor(message: string);
 }
+/**
+ * Validates the args passed to provider.request
+ * Returns nothing if successful, throws an error if the request is not supported or the params
+ * are malformed
+ *
+ * @param request - The request object to validate
+ * @param config - The configuration for the provider
+ * @param config.chains - The chains with which the provider is configured
+ */
 export declare function validateRequest(request: Parameters<ReturnType<typeof ox_Provider.from>["request"]>[0], { chains }: {
     chains: readonly [Chain, ...Chain[]];
 }): void;
+/**
+ * Validates that a user is connected and returns the user object.
+ * Throws an EIP1193ProviderError if the user is not connected.
+ *
+ * @returns The connected user object
+ */
 export declare function validateUserConnected(): Promise< User>;
+/**
+ * Validates that a user is connected and owns the specified address.
+ * Throws an EIP1193ProviderError if the user is not connected or doesn't own the address.
+ *
+ * @param address - The address to validate ownership for
+ * @returns The connected user object
+ */
 export declare function validateUserOwnsAddress(address: EvmAddress): Promise< User>;
+/**
+ * Validates that a user is connected and owns the specified address.
+ * Throws an EIP1193ProviderError if the user is not connected or doesn't own the address.
+ *
+ * @param address - The address to validate ownership for
+ * @returns The connected user object
+ */
 export declare function validateUserOwnsEOA(address: EvmAddress): Promise< User>;
+/**
+ * Validates that a user is connected and owns the specified smart account.
+ * Throws an EIP1193ProviderError if the user is not connected or doesn't own the address.
+ *
+ * @param address - The address to validate ownership for
+ * @returns The connected user object
+ */
 export declare function validateUserOwnsSmartAccount(address: EvmAddress): Promise< User>;
+/**
+ * Validates that a user is connected and has at least one EVM account.
+ * Throws an EIP1193ProviderError if the user is not connected or has no EVM accounts.
+ *
+ * @returns The connected user object with at least one EVM account
+ */
 export declare function validateUserHasEvmAccount(): Promise< User>;
+/**
+ * Validates that a user is connected and has at least one EVM account.
+ * Throws an EIP1193ProviderError if the user is not connected or has no EVM accounts.
+ *
+ * @returns The connected user object with at least one EVM account
+ */
 export declare function validateUserHasEvmSmartAccount(): Promise< User>;
+/**
+ * Validates that a user is using an EOA.
+ * Throws an AccountTypeMismatchError if the user is using a smart account.
+ *
+ * @param root0 - The error message to throw if the user is using a smart account.
+ * @param root0.errorMessage - The error message to throw if the user is using a smart account.
+ *
+ * @returns The connected user object
+ */
 export declare function validateIsUsingEOA({ errorMessage }?: {
     errorMessage?: string;
 }): Promise< User>;

package/dist/web-types/eip1193/eventEmitter.d.ts

@@ -1,8 +1,37 @@
+/**
+ * Events we currently support.
+ */
 export type SupportedEvent = "accountsChanged" | "chainChanged" | "connect" | "disconnect";
+/**
+ * Simple event emitter implementation.
+ */
 export declare class EventEmitter {
     private events;
+    /**
+     * Add an event listener.
+     *
+     * @param event - The name of the event to listen for.
+     * @param listener - The function to call when the event is emitted.
+     */
     on(event: SupportedEvent, listener: (...args: unknown[]) => void): void;
+    /**
+     * Remove an event listener.
+     *
+     * @param event - The name of the event to remove the listener from.
+     * @param listener - The function to remove from the event listeners.
+     */
     removeListener(event: SupportedEvent, listener: (...args: unknown[]) => void): void;
+    /**
+     * Emit an event.
+     *
+     * @param event - The name of the event to emit.
+     * @param args - The arguments to pass to the event listeners.
+     */
     emit(event: SupportedEvent, ...args: unknown[]): void;
+    /**
+     * Remove all listeners for an event.
+     *
+     * @param event - The name of the event to remove all listeners from. If not provided, removes all listeners for all events.
+     */
     removeAllListeners(event?: SupportedEvent): void;
 }

package/dist/web-types/eip1193/handlers/createEOAHandlers.d.ts

@@ -1,2 +1,8 @@
 import { ProviderHandlers } from './types.js';
+/**
+ * Creates handlers for EOA (Externally Owned Account) mode.
+ * These handlers support standard Ethereum signing and transaction operations.
+ *
+ * @returns An object containing all EOA-compatible handler functions
+ */
 export declare function createEOAHandlers(): ProviderHandlers;

package/dist/web-types/eip1193/handlers/createSmartAccountHandlers.d.ts

@@ -1,2 +1,8 @@
 import { ProviderHandlers } from './types.js';
+/**
+ * Creates handlers for Smart Account mode.
+ * These handlers support EIP-4337 user operations and batch calls.
+ *
+ * @returns An object containing all Smart Account-compatible handler functions
+ */
 export declare function createSmartAccountHandlers(): ProviderHandlers;

package/dist/web-types/eip1193/handlers/eoa/handleAccounts.d.ts

@@ -1,2 +1,8 @@
 import { Address } from 'ox/Address';
+/**
+ * Handle eth_accounts request.
+ * Returns the list of accounts the provider is managing.
+ *
+ * @returns The list of account addresses.
+ */
 export declare function handleAccounts(): Promise<Address[]>;

package/dist/web-types/eip1193/handlers/eoa/handleEthSign.d.ts

@@ -1,3 +1,10 @@
 import { EthSignRequest } from '../../types.js';
 import { Hex } from 'ox/Hex';
+/**
+ * Handle eth_sign request.
+ * Signs a hash using the user's primary account.
+ *
+ * @param params - The parameters array containing [hash, address].
+ * @returns The signature of the hash.
+ */
 export declare function handleEthSign(params: EthSignRequest["params"]): Promise<Hex>;

package/dist/web-types/eip1193/handlers/eoa/handleGetCallsStatus.d.ts

@@ -1,3 +1,11 @@
 import { GetCallsStatusRequest, ProviderStoreInstance } from '../../types.js';
 import { Capabilities, WalletGetCallsStatusReturnType } from 'viem';
+/**
+ * Handles getting the status of one or more calls
+ *
+ * @param params - provider.request params
+ * @param store - the provider store instance
+ * @returns {object} - The status of the calls
+ * @see https://eips.ethereum.org/EIPS/eip-5792#wallet_getcallsstatus
+ */
 export declare function handleGetCallsStatus(params: GetCallsStatusRequest["params"], store: ProviderStoreInstance): Promise<WalletGetCallsStatusReturnType<Capabilities, number, bigint | undefined, string | undefined>>;

package/dist/web-types/eip1193/handlers/eoa/handleGetCapabilities.d.ts

@@ -1,2 +1,8 @@
 import { WalletCapabilities } from '../../types.js';
+/**
+ * Handles getting the capabilities of the wallet
+ *
+ * @returns {WalletCapabilities} - The capabilities of the wallet by chainId
+ * @see https://eips.ethereum.org/EIPS/eip-5792#wallet_getcapabilities
+ */
 export declare function handleGetCapabilities(): Promise<WalletCapabilities>;

package/dist/web-types/eip1193/handlers/eoa/handlePersonalSign.d.ts

@@ -1,3 +1,10 @@
 import { PersonalSignRequest } from '../../types.js';
 import { Hex } from 'ox/Hex';
+/**
+ * Handle personal_sign request.
+ * Signs a message using the user's primary account.
+ *
+ * @param params - The parameters array containing [message, address].
+ * @returns The signature of the message.
+ */
 export declare function handlePersonalSign(params: PersonalSignRequest["params"]): Promise<Hex>;

package/dist/web-types/eip1193/handlers/eoa/handleRequestAccounts.d.ts

@@ -1,4 +1,14 @@
 import { EventEmitter } from '../../eventEmitter.js';
 import { ProviderStoreInstance } from '../../types.js';
 import { Address } from 'ox/Address';
+/**
+ * Handle eth_requestAccounts request.
+ * This should prompt the user to connect their wallet.
+ * For now, we just return the current accounts.
+ *
+ * @param eventEmitter - The event emitter to emit the connect event on.
+ * @param store - The provider store instance.
+ *
+ * @returns The list of account addresses.
+ */
 export declare function handleRequestAccounts(eventEmitter: EventEmitter, store: ProviderStoreInstance): Promise<Address[]>;

package/dist/web-types/eip1193/handlers/eoa/handleSendCalls.d.ts

@@ -1,3 +1,10 @@
 import { ProviderStoreInstance, SendCallsRequest } from '../../types.js';
 import { Hex } from 'ox/Hex';
+/**
+ * Handles sending one or more calls to the specified Ethereum chain
+ *
+ * @param params - provider.request params
+ * @param store - the provider store instance
+ * @returns The user operation hash.
+ */
 export declare function handleSendCalls(params: SendCallsRequest["params"], store: ProviderStoreInstance): Promise<Hex>;

package/dist/web-types/eip1193/handlers/eoa/handleSendTransaction.d.ts

@@ -1,4 +1,13 @@
 import { ProviderStoreInstance, SendTransactionRequest } from '../../types.js';
 import { Hex } from 'ox/Hex';
 import { Transport } from 'viem';
+/**
+ * Handle eth_sendTransaction request.
+ * Sends a transaction using the user's primary account.
+ *
+ * @param params - The parameters array containing [transaction].
+ * @param store - The provider store instance.
+ * @param transports - The transports for the provider.
+ * @returns The transaction hash.
+ */
 export declare function handleSendTransaction(params: SendTransactionRequest["params"], store: ProviderStoreInstance, transports: Record<number, Transport>): Promise<Hex>;

package/dist/web-types/eip1193/handlers/eoa/handleSignTypedData.d.ts

@@ -1,3 +1,10 @@
 import { SignTypedDataRequest } from '../../types.js';
 import { Hex } from 'ox/Hex';
+/**
+ * Handle eth_signTypedData_v4 request.
+ * Signs EIP-712 typed data using the user's primary account.
+ *
+ * @param params - The parameters array containing [address, typedData].
+ * @returns The signature of the typed data.
+ */
 export declare function handleSignTypedData(params: SignTypedDataRequest["params"]): Promise<Hex>;

package/dist/web-types/eip1193/handlers/shared/handleChainId.d.ts

@@ -1,3 +1,10 @@
 import { ProviderStoreInstance } from '../../types.js';
 import { Hex } from 'ox/Hex';
+/**
+ * Handle eth_chainId request.
+ * Returns the current chain ID.
+ *
+ * @param store - The provider store instance
+ * @returns The chain ID as a hex string.
+ */
 export declare function handleChainId(store: ProviderStoreInstance): Promise<Hex>;

package/dist/web-types/eip1193/handlers/shared/handleDisconnect.d.ts

@@ -1 +1,7 @@
+/**
+ * Handle wallet_disconnect request.
+ * Disconnects the user from the wallet.
+ *
+ * @returns The error object.
+ */
 export declare function handleDisconnect(): Promise<void>;

package/dist/web-types/eip1193/handlers/shared/handleSwitchEthereumChain.d.ts

@@ -1,2 +1,8 @@
 import { ProviderStoreInstance, SwitchEthereumChainRequest } from '../../types.js';
+/**
+ * Handles switching to the specified ethereum chain
+ *
+ * @param params - provider.request params
+ * @param store - the provider store instance
+ */
 export declare function handleSwitchEthereumChain(params: SwitchEthereumChainRequest["params"], store: ProviderStoreInstance): void;

package/dist/web-types/eip1193/handlers/smart-account/handleAccounts.d.ts

@@ -1,2 +1,8 @@
 import { Address } from 'ox/Address';
+/**
+ * Handle eth_accounts request.
+ * Returns the list of accounts the provider is managing.
+ *
+ * @returns The list of account addresses.
+ */
 export declare function handleAccounts(): Promise<Address[]>;

package/dist/web-types/eip1193/handlers/smart-account/handleEthSign.d.ts

@@ -1,3 +1,11 @@
 import { EthSignRequest, ProviderStoreInstance } from '../../types.js';
 import { Hex } from 'ox/Hex';
+/**
+ * Handle eth_sign request.
+ * Signs a hash using the user's primary account.
+ *
+ * @param params - The parameters array containing [hash, address].
+ * @param store - The provider store instance.
+ * @returns The signature of the hash.
+ */
 export declare function handleEthSign(params: EthSignRequest["params"], store: ProviderStoreInstance): Promise<Hex>;

package/dist/web-types/eip1193/handlers/smart-account/handleGetCallsStatus.d.ts

@@ -1,3 +1,11 @@
 import { GetCallsStatusRequest, ProviderStoreInstance } from '../../types.js';
 import { WalletGetCallsStatusReturnType, Capabilities } from 'viem';
+/**
+ * Handles getting the status of one or more calls
+ *
+ * @param params - provider.request params
+ * @param store - the provider store instance
+ * @returns {WalletGetCallsStatusReturnType} - The status of the calls
+ * @see https://eips.ethereum.org/EIPS/eip-5792#wallet_getcallsstatus
+ */
 export declare function handleGetCallsStatus(params: GetCallsStatusRequest["params"], store: ProviderStoreInstance): Promise<WalletGetCallsStatusReturnType<Capabilities, number, bigint | undefined, string | undefined>>;

package/dist/web-types/eip1193/handlers/smart-account/handleGetCapabilities.d.ts

@@ -1,2 +1,8 @@
 import { WalletCapabilities } from '../../types.js';
+/**
+ * Handles getting the capabilities of the wallet
+ *
+ * @returns { WalletCapabilities } - The capabilities of the wallet by chainId
+ * @see https://eips.ethereum.org/EIPS/eip-5792#wallet_getcapabilities
+ */
 export declare function handleGetCapabilities(): Promise<WalletCapabilities>;

package/dist/web-types/eip1193/handlers/smart-account/handlePersonalSign.d.ts

@@ -1,3 +1,11 @@
 import { PersonalSignRequest, ProviderStoreInstance } from '../../types.js';
 import { Hex } from 'ox/Hex';
+/**
+ * Handle personal_sign request.
+ * Signs a message using the user's primary account.
+ *
+ * @param params - The parameters array containing [message, address].
+ * @param store - The provider store instance.
+ * @returns The signature of the message.
+ */
 export declare function handlePersonalSign(params: PersonalSignRequest["params"], store: ProviderStoreInstance): Promise<Hex>;

package/dist/web-types/eip1193/handlers/smart-account/handleRequestAccounts.d.ts

@@ -1,4 +1,14 @@
 import { EventEmitter } from '../../eventEmitter.js';
 import { ProviderStoreInstance } from '../../types.js';
 import { Address } from 'ox/Address';
+/**
+ * Handle eth_requestAccounts request.
+ * This should prompt the user to connect their wallet.
+ * For now, we just return the current accounts.
+ *
+ * @param eventEmitter - The event emitter to emit the connect event on.
+ * @param store - The provider store instance.
+ *
+ * @returns The list of account addresses.
+ */
 export declare function handleRequestAccounts(eventEmitter: EventEmitter, store: ProviderStoreInstance): Promise<Address[]>;

package/dist/web-types/eip1193/handlers/smart-account/handleSendCalls.d.ts

@@ -1,3 +1,10 @@
 import { ProviderStoreInstance, SendCallsRequest } from '../../types.js';
 import { Hex } from 'ox/Hex';
+/**
+ * Handles sending one or more calls to the specified Ethereum chain
+ *
+ * @param params - provider.request params
+ * @param store - the provider store instance
+ * @returns The user operation hash.
+ */
 export declare function handleSendCalls(params: SendCallsRequest["params"], store: ProviderStoreInstance): Promise<Hex>;

package/dist/web-types/eip1193/handlers/smart-account/handleSendTransaction.d.ts

@@ -1,4 +1,13 @@
 import { SendTransactionRequest, ProviderStoreInstance } from '../../types.js';
 import { Hex } from 'ox/Hex';
 import { Transport } from 'viem';
+/**
+ * Handle eth_sendTransaction request.
+ * Sends a transaction using the user's primary account.
+ *
+ * @param params - The parameters array containing [transaction].
+ * @param store - The provider store instance.
+ * @param transports - The transports for the provider.
+ * @returns The transaction hash.
+ */
 export declare function handleSendTransaction(params: SendTransactionRequest["params"], store: ProviderStoreInstance, transports: Record<number, Transport>): Promise<Hex>;

package/dist/web-types/eip1193/handlers/smart-account/handleSignTypedData.d.ts

@@ -1,3 +1,11 @@
 import { ProviderStoreInstance, SignTypedDataRequest } from '../../types.js';
 import { Hex } from 'ox/Hex';
+/**
+ * Handle eth_signTypedData_v4 request.
+ * Signs EIP-712 typed data using the user's primary account.
+ *
+ * @param params - The parameters array containing [address, typedData].
+ * @param store - The provider store instance.
+ * @returns The signature of the typed data.
+ */
 export declare function handleSignTypedData(params: SignTypedDataRequest["params"], store: ProviderStoreInstance): Promise<Hex>;

package/dist/web-types/eip1193/handlers/types.d.ts

@@ -2,6 +2,9 @@ import { EvmAddress, Hex } from '../../types.js';
 import { EventEmitter } from '../eventEmitter.js';
 import { ProviderStoreInstance, PersonalSignRequest, SendTransactionRequest, SignTypedDataRequest, EthSignRequest, SwitchEthereumChainRequest, SendCallsRequest, GetCallsStatusRequest } from '../types.js';
 import { Transport } from 'viem';
+/**
+ * Interface for all available handler methods
+ */
 export interface ProviderHandlers {
     eth_accounts: () => Promise<EvmAddress[]>;
     eth_requestAccounts: (eventEmitter: EventEmitter, store: ProviderStoreInstance) => Promise<EvmAddress[]>;