@coinbase/cdp-hooks - Coinbase Developer Documentation

This package provides React hooks for conveniently accessing embedded wallet functionality. Built on top of @coinbase/cdp-core, it offers a React-friendly interface for end user authentication and embedded wallet operations.

Quickstart

This guide will help you get started with @coinbase/cdp-hooks. You’ll learn how to install the package, set up the provider, and use the hooks in a variety of ways.

Installation

First, add the package to your project using your preferred package manager.

# With npm
npm install @coinbase/cdp-core @coinbase/cdp-hooks

# With pnpm
pnpm add @coinbase/cdp-core @coinbase/cdp-hooks

# With yarn
yarn add @coinbase/cdp-core @coinbase/cdp-hooks

Gather your CDP Project Information

Sign in or create an account on the CDP Portal
On your dashboard, select a project from the dropdown at the at the top, and copy the Project ID

Allowlist your local app

Navigate to the Embedded Wallet Configuration in CDP Portal, and click Add origin to include your local app
Enter the origin of your locally running app - e.g., http://localhost:3000
Click Add origin again to save your changes

Setup Provider

Next, you need to wrap your application with the CDPHooksProvider, which provides the necessary context for hooks to work correctly. Update your main application file (e.g., main.tsx) to include the provider:

import { CDPHooksProvider } from "@coinbase/cdp-hooks";
import { App } from './App'; // Your main App component

function App() {
  return (
    <CDPHooksProvider 
      config={{
        // Copy and paste your project ID here.
        projectId: "your-project-id",
      }}
    >
      <App />
    </CDPHooksProvider>
  );
}

Smart Account Configuration

You can configure the provider to automatically create Smart Accounts for new users:

function App() {
  return (
    <CDPHooksProvider
      config={{
        projectId: "your-project-id",
        createAccountOnLogin: "evm-smart", // Creates Smart Accounts instead of EOAs
      }}
    >
      <App />
    </CDPHooksProvider>
  );
}

When createAccountOnLogin is set to "evm-smart", new users will automatically get both an EOA and a Smart Account.

End user authentication proceeds in two steps:

The user inputs their email address to initiate the authentication flow, which will send the user a One Time Password (OTP) and return a flowId
The user submits the six-digit OTP and flowId, after which the user will be authenticated, returning a User object.

The following code demonstrates this flow:

import { useSignInWithEmail, useVerifyEmailOTP } from "@coinbase/cdp-hooks";

function SignIn() {
  const { signInWithEmail } = useSignInWithEmail();
  const { verifyEmailOTP } = useVerifyEmailOTP();

  const handleSignIn = async (email: string) => {
    try {
      // Start sign in flow
      const { flowId } = await signInWithEmail({ email });

      // In a real application, you would prompt the user for the OTP they received
      // in their email. Here, we hardcode it for convenience.
      const otp = "123456";

      // Complete sign in
      const { user, isNewUser } = await verifyEmailOTP({
        flowId,
        otp
      });

      console.log("Signed in user:", user);
      console.log("User EVM address (EOA):", user.evmAccounts[0]);
      console.log("User Smart Account:", user.evmSmartAccounts?.[0]);
    } catch (error) {
      console.error("Sign in failed:", error);
    }
  };

  return <button onClick={() => handleSignIn("user@example.com")}>Sign In</button>;
}

View User Information

Once the end user has signed in, you can display their information in your application:

import { useCurrentUser, useEvmAddress } from "@coinbase/cdp-hooks";

function UserInformation() {
  const { currentUser: user } = useCurrentUser();
  const { evmAddress } = useEvmAddress();

  if (!user) {
    return <div>Please sign in</div>;
  }

  const emailAddress = user.authenticationMethods.email?.email;

  return (
    <div>
      <h2>User Information</h2>
      <p>User ID: {user.userId}</p>
      <p>EVM Address (EOA): {evmAddress}</p>
      {user.evmSmartAccounts?.[0] && (
        <p>Smart Account: {user.evmSmartAccounts[0]}</p>
      )}
      { email && <p>EmailAddress: {emailAddress}</p>}
    </div>
  );
}

Send a Transaction

We support signing and sending a Blockchain transaction in a single action on the following networks:

Base
Base Sepolia
Ethereum
Ethereum Sepolia
Avalanche
Arbitrum
Optimism
Polygon

import { useSendEvmTransaction, useEvmAddress } from "@coinbase/cdp-hooks";

function SendTransaction() {
  const { sendEvmTransaction: sendTransaction } = useSendEvmTransaction();
  const { evmAddress } = useEvmAddress();

  const handleSend = async () => {
    if (!evmAddress) return;

    try {
      const result = await sendTransaction({
        evmAccount: evmAddress,
        transaction: {
          to: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          value: 100000000000000n, // 0.0001 ETH in wei
          nonce: 0,
          gas: 21000n,
          maxFeePerGas: 30000000000n,
          maxPriorityFeePerGas: 1000000000n,
          chainId: 84532, // Base Sepolia
          type: "eip1559",
        }
      });

      console.log("Transaction hash:", result.transactionHash);
    } catch (error) {
      console.error("Transaction failed:", error);
    }
  };

  return <button onClick={handleSend}>Send Transaction</button>;
}

For networks other than those supported by the CDP APIs, your end user must sign the transaction, and then you must broadcast the transaction yourself. This example uses the public client from viem to broadcast the transaction.

import { useSignEvmTransaction, useEvmAddress } from "@coinbase/cdp-hooks";
import { http, createPublicClient } from "viem";
import { tron } from "viem/chains";

function CrossChainTransaction() {
  const { signEvmTransaction: signTransaction } = useSignEvmTransaction();
  const { evmAddress } = useEvmAddress();

  const handleSend = async () => {
    if (!evmAddress) return;

    try {
      // Sign the transaction
      const { signedTransaction } = await signTransaction({
        evmAccount: evmAddress,
        transaction: {
          to: "0x...",
          value: 100000000000000n,
          nonce: 0,
          gas: 21000n,
          maxFeePerGas: 30000000000n,
          maxPriorityFeePerGas: 1000000000n,
          chainId: 728126428, // Tron
          type: "eip1559",
        }
      });

      // Broadcast using a different client
      const client = createPublicClient({
        chain: tron,
        transport: http()
      });

      const hash = await client.sendRawTransaction({
        serializedTransaction: signedTransaction
      });

      console.log("Transaction hash:", hash);
    } catch (error) {
      console.error("Transaction failed:", error);
    }
  };

  return <button onClick={handleSend}>Send Transaction</button>;
}

Sign Messages and Typed Data

End users can sign EVM messages, hashes, and typed data to generate signatures for various onchain applications.

import { useSignEvmMessage, useSignEvmTypedData, useEvmAddress } from "@coinbase/cdp-hooks";

function SignData() {
  const { signEvmMessage: signMessage } = useSignEvmMessage();
  const { signEvmTypedData: signTypedData } = useSignEvmTypedData();
  const { signEvmHash: signHash } = useSignEvmHash();
  const { evmAddress } = useEvmAddress();

  const handleSignHash = async () => {
    if (!evmAddress) return;

    const result = await signMessage({
      evmAccount: evmAddress,
      message: "Hello World"
    });

    console.log("Message signature:", result.signature);
  }

  const handleSignMessage = async () => {
    if (!evmAddress) return;

    const result = await signMessage({
      evmAccount: evmAddress,
      message: "Hello World"
    });

    console.log("Message signature:", result.signature);
  };

  const handleSignTypedData = async () => {
    if (!evmAddress) return;

    const result = await signTypedData({
      evmAccount: evmAddress,
      typedData: {
        domain: {
          name: "Example DApp",
          version: "1",
          chainId: 84532,
        },
        types: {
          Person: [
            { name: "name", type: "string" },
            { name: "wallet", type: "address" }
          ]
        },
        primaryType: "Person",
        message: {
          name: "Bob",
          wallet: evmAddress
        }
      }
    });

    console.log("Typed data signature:", result.signature);
  };

  return (
    <div>
      <button onClick={handleSignMessage}>Sign Message</button>
      <button onClick={handleSignTypedData}>Sign Typed Data</button>
      <button onClick={handleSignHash}>Sign Hash</button>
    </div>
  );
}

Export Private Key

End users can export their private keys from their embedded wallet, allowing them to import it into an EVM-compatible wallet of their choice.

import { useExportEvmAccount, useEvmAddress } from "@coinbase/cdp-hooks";

function ExportKey() {
  const { exportEvmAccount: exportAccount } = useExportEvmAccount();
  const { evmAddress } = useEvmAddress();

  const handleExport = async () => {
    if (!evmAddress) return;

    try {
      const { privateKey } = await exportAccount({
        evmAccount: evmAddress
      });

      console.log("Private Key:", privateKey);
      // Warning: Handle private keys with extreme care!
    } catch (error) {
      console.error("Export failed:", error);
    }
  };

  return <button onClick={handleExport}>Export Private Key</button>;
}

Smart Account Operations

Smart Accounts provide advanced account abstraction features with React hooks.

Send User Operations

Send user operations from Smart Accounts with support for multiple calls and paymaster sponsorship. The hook returns a method to execute the user operation and status, data, and error properties to read the result of the user operation:

import { useSendUserOperation, useCurrentUser } from "@coinbase/cdp-hooks";

function SendUserOperation() {
  const { sendUserOperation, status, data, error } = useSendUserOperation();
  const { currentUser } = useCurrentUser();

  const handleSendUserOperation = async () => {
    const smartAccount = currentUser?.evmSmartAccounts?.[0];
    if (!smartAccount) return;

    try {
      // This will automatically start tracking the user operation status
      const result = await sendUserOperation({
        evmSmartAccount: smartAccount,
        network: "base-sepolia",
        calls: [{
          to: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          value: 1000000000000000000n,
          data: "0x",
        }],
      });

      console.log("User Operation Hash:", result.userOperationHash);
    } catch (error) {
      console.error("Failed to send user operation:", error);
    }
  };

  return (
    <div>
      {status === "idle" && <p>Ready to send user operation</p>}
      
      {status === "pending" && (
        <div>
          <p>User operation pending...</p>
          {data && <p>User Op Hash: {data.userOpHash}</p>}
        </div>
      )}
      
      {status === "success" && data && (
        <div>
          <p>User operation successful!</p>
          <p>Transaction Hash: {data.transactionHash}</p>
          <p>Status: {data.status}</p>
        </div>
      )}
      
      {status === "error" && (
        <div>
          <p>User operation failed</p>
          <p>Error: {error?.message}</p>
        </div>
      )}
      
      <button onClick={handleSendUserOperation} disabled={status === "pending"}>
        {status === "pending" ? "Sending..." : "Send User Operation"}
      </button>
    </div>
  );
}

Track User Operation Status

Use the useWaitForUserOperation hook to poll for user operation status and provide real-time updates. This hook immediately fires off a query to get the result of the user operation:

import { useWaitForUserOperation, useState } from "react";

function WaitForUserOperation() {
  const { status, data, error } = useWaitForUserOperation({
    userOperationHash: "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    evmSmartAccount: "0x1234567890123456789012345678901234567890",
    network: "base-sepolia"
  });

  return (
    <div>
      {status === "idle" && <p>No user operation being tracked</p>}
      
      {status === "pending" && (
        <div>
          <p>User operation pending...</p>
          {data && <p>User Op Hash: {data.userOpHash}</p>}
        </div>
      )}
      
      {status === "success" && data && (
        <div>
          <p>User operation successful!</p>
          <p>Transaction Hash: {data.transactionHash}</p>
          <p>Status: {data.status}</p>
        </div>
      )}
      
      {status === "error" && (
        <div>
          <p>User operation failed</p>
          <p>Error: {error?.message}</p>
        </div>
      )}
    </div>
  );
}

Conditional Polling

You can control when the useWaitForUserOperation hook should start polling using the enabled parameter:

function ConditionalWaitForUserOperation() {
  const [shouldPoll, setShouldPoll] = useState(false);
  
  const { status, data, error } = useWaitForUserOperation({
    userOperationHash: "0x1234...",
    evmSmartAccount: "0x5678...", 
    network: "base-sepolia",
    enabled: shouldPoll // Only poll when this is true
  });

  return (
    <div>
      <button onClick={() => setShouldPoll(true)}>
        Start Polling
      </button>
      <button onClick={() => setShouldPoll(false)}>
        Stop Polling  
      </button>
      
      <p>Status: {status}</p>
      {data && <p>User Operation Status: {data.status}</p>}
      {error && <p>Error: {error.message}</p>}
    </div>
  );
}

Functions

useConfig()

function useConfig(): object;

Hook to get the CDP being used by the SDK.

Returns

object

config

config: Config;

Example

function App() {
  const { config } = useConfig();

  return (
    <div>
      <p>Project ID: {config.projectId}</p>
    </div>
  );
}

useIsInitialized()

function useIsInitialized(): object;

Hook to check if the CDP client has been properly initialized. This should be used before attempting any CDP operations to ensure the client is ready.

Returns

object

isInitialized

isInitialized: boolean;

Example

function LoadingGuard({ children }) {
  const { isInitialized } = useIsInitialized();

  if (!isInitialized) {
    return <div>Loading...</div>;
  }

  return children;
}

useSignInWithEmail()

function useSignInWithEmail(): object;

Hook that provides access to the email-based sign-in functionality. This is the first step in the email authentication flow.

Returns

object

signInWithEmail()

signInWithEmail: (options) => Promise<SignInWithEmailResult>;

Parameters

Parameter	Type
`options`	`SignInWithEmailOptions`

Returns

Promise<SignInWithEmailResult>

Example

function SignInForm() {
  const [email, setEmail] = useState("");
  const [flowId, setFlowId] = useState("");
  const { signInWithEmail } = useSignInWithEmail();

  const handleSubmit = async (e) => {
    e.preventDefault();
    try {
      const result = await signInWithEmail({ email });
      setFlowId(result.flowId);
    } catch (error) {
      console.error("Failed to sign in:", error);
    }
  };

  return (
    <form onSubmit={handleSubmit}>
      <input
        type="email"
        value={email}
        onChange={(e) => setEmail(e.target.value)}
        placeholder="Enter your email"
        aria-label="Enter your email"
      />
      <button type="submit">Sign In</button>
    </form>
  );
}

useSignInWithSms()

function useSignInWithSms(): object;

Hook that provides access to the SMS-based sign-in functionality. This is the first step in the SMS authentication flow.

Returns

object

signInWithSms()

signInWithSms: (options) => Promise<SignInWithSmsResult>;

Parameters

Parameter	Type
`options`	`SignInWithSmsOptions`

Returns

Promise<SignInWithSmsResult>

Example

function SignInForm() {
  const [phoneNumber, setPhoneNumber] = useState("");
  const [flowId, setFlowId] = useState("");
  const { signInWithSms } = useSignInWithSms();

  const handleSubmit = async (e) => {
    e.preventDefault();
    try {
      const result = await signInWithSms({ phoneNumber });
      setFlowId(result.flowId);
    } catch (error) {
      console.error("Failed to sign in:", error);
    }
  };

  return (
    <form onSubmit={handleSubmit}>
      <input
        type="tel"
        value={phoneNumber}
        onChange={(e) => setPhoneNumber(e.target.value)}
        placeholder="Enter your phone number"
        aria-label="Enter your phone number"
      />
      <button type="submit">Sign In</button>
    </form>
  );
}

useVerifyEmailOTP()

function useVerifyEmailOTP(): object;

Hook that provides access to the email OTP verification functionality. This is the second step in the email authentication flow, used after signInWithEmail.

Returns

object

verifyEmailOTP()

verifyEmailOTP: (options) => Promise<VerifyEmailOTPResult>;

Parameters

Parameter	Type
`options`	`VerifyEmailOTPOptions`

Returns

Promise<VerifyEmailOTPResult>

Example

function OTPVerification(flowId: string) {
  const [otp, setOTP] = useState("");
  const { verifyEmailOTP } = useVerifyEmailOTP();

  const otpIsValid = useMemo(() => {
    // Check if the OTP is a 6 digit number
    return /^[0-9]{6}$/.test(otp);
  }, [otp]);

  const handleSubmit = async (e) => {
    e.preventDefault();

    try {
      const { user } = await verifyEmailOTP({
        flowId,
        otp
      });

      // Handle the result
      console.log(user);
    } catch (error) {
      console.error("Failed to verify OTP:", error);
    }
  };

  return (
    <form onSubmit={handleSubmit}>
      <input
        type="text"
        value={otp}
        onChange={(e) => setOTP(e.target.value)}
        placeholder="Enter OTP from email"
        aria-label="Enter OTP from email"
      />
      <button type="submit" disabled={!otpIsValid}>Verify OTP</button>
    </form>
  );
}

useVerifySmsOTP()

function useVerifySmsOTP(): object;

Hook that provides access to the SMS OTP verification functionality. This is the second step in the SMS authentication flow, used after signInWithSms.

Returns

object

verifySmsOTP()

verifySmsOTP: (options) => Promise<VerifySmsOTPResult>;

Parameters

Parameter	Type
`options`	`VerifySmsOTPOptions`

Returns

Promise<VerifySmsOTPResult>

Example

function OTPVerification(flowId: string) {
  const [otp, setOTP] = useState("");
  const { verifySmsOTP } = useVerifySmsOTP();

  const otpIsValid = useMemo(() => {
    // Check if the OTP is a 6 digit number
    return /^[0-9]{6}$/.test(otp);
  }, [otp]);

  const handleSubmit = async (e) => {
    e.preventDefault();

    try {
      const { user } = await verifySmsOTP({
        flowId,
        otp
      });

      // Handle the result
      console.log(user);
    } catch (error) {
      console.error("Failed to verify OTP:", error);
    }
  };

  return (
    <form onSubmit={handleSubmit}>
      <input
        type="text"
        value={otp}
        onChange={(e) => setOTP(e.target.value)}
        placeholder="Enter OTP from SMS"
        aria-label="Enter OTP from SMS"
      />
      <button type="submit" disabled={!otpIsValid}>Verify OTP</button>
    </form>
  );
}

useIsSignedIn()

function useIsSignedIn(): object;

Hook to check if a user is currently signed in. Use this to gate authenticated-only features in your application.

Returns

object

isSignedIn

isSignedIn: boolean;

Example

function AuthGuard({ children }) {
  const { isSignedIn } = useIsSignedIn();

  if (!isSignedIn) {
    return <Navigate to="/sign-in" />;
  }

  return children;
}

useCurrentUser()

function useCurrentUser(): object;

Hook to access the currently authenticated user’s information.

Returns

object

currentUser

currentUser: null | User;

Example

function UserProfile() {
  const { currentUser } = useCurrentUser();

  if (!currentUser) {
    return null;
  }

  return (
    <div>
      <h2>User Profile</h2>
      <p>User ID: {currentUser.userId}</p>
      <p>EVM Accounts: {currentUser.evmAccounts.join(", ")}</p>
    </div>
  );
}

useSignOut()

function useSignOut(): object;

Hook that provides a wrapped sign-out function with authentication checks. This hook uses useEnforceAuthenticated to ensure the user is signed in before attempting to sign out.

Returns

object

signOut()

signOut: () => Promise<void>;

Returns

Promise<void>

Example

function SignOutButton() {
  const { signOut } = useSignOut();
  const navigate = useNavigate();

  const handleSignOut = async () => {
    try {
      await signOut();
      navigate("/sign-in");
    } catch (error) {
      console.error("Failed to sign out:", error);
    }
  };

  return (
    <button onClick={handleSignOut}>
      Sign Out
    </button>
  );
}

useGetAccessToken()

function useGetAccessToken(): object;

Hook to get the access token for the current user.

Returns

object Function to get the access token for the current user

getAccessToken()

getAccessToken: () => Promise<null | string>;

Returns

Promise<null | string>

Example

const { getAccessToken } = useGetAccessToken();

const handleGetAccessToken = async () => {
  const accessToken = await getAccessToken();
  console.log("Access Token:", accessToken);
};

useEvmAddress()

function useEvmAddress(): object;

Hook to access the user’s primary EVM (Ethereum Virtual Machine) address. If the user has a Smart Account, this will return the Smart Account address. If the user has an EOA, this will return the EOA address. If the user has neither, this will return null.

Returns

object

evmAddress

evmAddress: null | `0x${string}`;

Example

function WalletInfo() {
  const { evmAddress } = useEvmAddress();

  if (!evmAddress) {
    return <p>No wallet connected</p>;
  }

  return (
    <div>
      <h3>Your Wallet</h3>
      <p>Address: {evmAddress}</p>
    </div>
  );
}

useSignEvmHash()

function useSignEvmHash(): object;

Hook that provides a wrapped function to sign EVM messages with authentication checks. This hook uses useEnforceAuthenticated to ensure the user is signed in before attempting to sign.

Returns

object

signEvmHash()

signEvmHash: (options) => Promise<SignEvmHashResult>;

Parameters

Parameter	Type
`options`	`SignEvmHashOptions`

Returns

Promise<SignEvmHashResult>

Example

function SignHash() {
  const { signEvmHash } = useSignEvmHash();
  const { evmAddress } = useEvmAddress();

  const handleSign = async () => {
    if (!evmAddress) return;

    try {
      const result = await signEvmHash({
        evmAccount: evmAddress,
        hash: "0x3ea2f1d0abf3fc66cf29eebb70cbd4e7fe762ef8a09bcc06c8edf641230afec0"
      });
      console.log("Signature:", result.signature);
    } catch (error) {
      console.error("Failed to sign hash:", error);
    }
  };

  return (
    <button onClick={handleSign}>Sign Hash</button>
  );
}

useSignEvmTransaction()

function useSignEvmTransaction(): object;

Hook that provides a wrapped function to sign EVM transactions with authentication checks. This hook uses useEnforceAuthenticated to ensure the user is signed in before attempting to sign.

Returns

object

signEvmTransaction()

signEvmTransaction: (options) => Promise<SignEvmTransactionResult>;

Parameters

Parameter	Type
`options`	`SignEvmTransactionOptions`

Returns

Promise<SignEvmTransactionResult>

Example

function SignTransaction() {
  const { signEvmTransaction } = useSignEvmTransaction();
  const { evmAddress } = useEvmAddress();

  const handleSign = async () => {
    if (!evmAddress) return;

    try {
      const result = await signEvmTransaction({
        evmAccount: evmAddress,
        transaction: {
          to: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          value: 100000000000000n, // 0.0001 ETH in wei
          nonce: 0,
          gas: 21000n,
          maxFeePerGas: 30000000000n,
          maxPriorityFeePerGas: 1000000000n,
          chainId: 84532, // Base Sepolia
          type: "eip1559"
        }
      });
      console.log("Signed Transaction:", result.signedTransaction);
    } catch (error) {
      console.error("Failed to sign transaction:", error);
    }
  };

  return (
    <button onClick={handleSign}>Sign Transaction</button>
  );
}

useSendEvmTransaction()

function useSendEvmTransaction(): object;

Hook that provides a wrapped function to send EVM transactions with authentication checks. This hook uses useEnforceAuthenticated to ensure the user is signed in before attempting to send. The hook internally waits for transactions to succeed and returns the related success/error via the data discriminated union object. Note: The data returned from the hook only represents the last sent transaction. If you wish to call one instance of the hook multiple times in quick succession it is recommended to save the txHash returned from sendEvmTransaction yourself and handle waiting for the receipt.

Returns

object

sendEvmTransaction()

sendEvmTransaction: (options) => Promise<SendEvmTransactionResult>;

Parameters

Parameter	Type
`options`	`SendEvmTransactionOptions`

Returns

Promise<SendEvmTransactionResult>

data

data: TransactionState;

Example

function SendTransaction() {
  const { sendEvmTransaction, data } = useSendEvmTransaction();
  const { evmAddress } = useEvmAddress();

  const handleSend = async () => {
    if (!evmAddress) return;

    try {
      const result = await sendEvmTransaction({
        evmAccount: evmAddress,
        network: "base-sepolia",
        transaction: {
          to: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          value: 100000000000000n, // 0.0001 ETH in wei
          nonce: 0,
          gas: 21000n,
          maxFeePerGas: 30000000000n,
          maxPriorityFeePerGas: 1000000000n,
          chainId: 84532, // Base Sepolia
          type: "eip1559"
        }
      });
      console.log("Transaction Hash:", result.transactionHash);
    } catch (error) {
      console.error("Failed to send transaction:", error);
    }
  };

  return (
    <div>
      {(() => {
        switch (data.status) {
          case "idle":
            return <p>No transaction in progress</p>;
          case "pending":
            return (
              <div>
                <p>Transaction pending...</p>
                <p>Hash: {data.hash}</p>
              </div>
            );
          case "success":
            return (
              <div>
                <p>Transaction successful!</p>
                <p>Block: {data.receipt.blockNumber.toString()}</p>
                <p>Gas used: {data.receipt.gasUsed.toString()}</p>
              </div>
            );
          case "error":
            return (
              <div>
                <p>Transaction failed</p>
                <p>Error: {data.error.message}</p>
              </div>
            );
        }
      })()}
    </div>
    <button onClick={handleSend}>Send Transaction</button>
  );
}

useSignEvmMessage()

function useSignEvmMessage(): object;

Hook that provides a wrapped function to sign EVM messages with authentication checks. This hook uses useEnforceAuthenticated to ensure the user is signed in before attempting to sign.

Returns

object

signEvmMessage()

signEvmMessage: (options) => Promise<SignEvmMessageResult>;

Parameters

Parameter	Type
`options`	`SignEvmMessageOptions`

Returns

Promise<SignEvmMessageResult>

Example

function SignMessage() {
  const { signEvmMessage } = useSignEvmMessage();
  const { evmAddress } = useEvmAddress();

  const handleSign = async () => {
    if (!evmAddress) return;

    try {
      const result = await signEvmMessage({
        evmAccount: evmAddress,
        message: "Welcome to our dApp! Click to sign in."
      });
      console.log("Signature:", result.signature);
    } catch (error) {
      console.error("Failed to sign message:", error);
    }
  };

  return (
    <button onClick={handleSign}>Sign Message</button>
  );
}

useSignEvmTypedData()

function useSignEvmTypedData(): object;

Hook that provides a wrapped function to sign EIP-712 typed data with authentication checks. This hook uses useEnforceAuthenticated to ensure the user is signed in before attempting to sign.

Returns

object

signEvmTypedData()

signEvmTypedData: (options) => Promise<SignEvmTypedDataResult>;

Parameters

Parameter	Type
`options`	`SignEvmTypedDataOptions`

Returns

Promise<SignEvmTypedDataResult>

Example

function SignTypedData() {
  const { signEvmTypedData } = useSignEvmTypedData();
  const { evmAddress } = useEvmAddress();

  const handleSign = async () => {
    if (!evmAddress) return;

    try {
      const result = await signEvmTypedData({
        evmAccount: evmAddress,
        typedData: {
          domain: {
            name: "USDC",
            version: "2",
            chainId: 84532,
            verifyingContract: "0x036CbD53842c5426634e7929541eC2318f3dCF7e"
          },
          types: {
            EIP712Domain: [
              { name: "name", type: "string" },
              { name: "version", type: "string" },
              { name: "chainId", type: "uint256" },
              { name: "verifyingContract", type: "address" }
            ],
            TransferWithAuthorization: [
              { name: "from", type: "address" },
              { name: "to", type: "address" },
              { name: "value", type: "uint256" },
              { name: "validAfter", type: "uint256" },
              { name: "validBefore", type: "uint256" },
              { name: "nonce", type: "bytes32" }
            ]
          },
          primaryType: "TransferWithAuthorization",
          message: {
            from: evmAddress,
            to: "0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB",
            value: "1000000", // 1 USDC
            validAfter: 0,
            validBefore: 2524604400,
            nonce: 0
          }
        }
      });
      console.log("Signature:", result.signature);
    } catch (error) {
      console.error("Failed to sign typed data:", error);
    }
  };

  return (
    <button onClick={handleSign}>Sign Typed Data</button>
  );
}

useExportEvmAccount()

function useExportEvmAccount(): object;

Hook that provides a wrapped function to export EVM account private keys with authentication checks. This hook uses useEnforceAuthenticated to ensure the user is signed in before attempting to export.

Returns

object

exportEvmAccount()

exportEvmAccount: (options) => Promise<ExportEvmAccountResult>;

Parameters

Parameter	Type
`options`	`ExportEvmAccountOptions`

Returns

Promise<ExportEvmAccountResult>

Example

function ExportPrivateKey() {
  const { exportEvmAccount } = useExportEvmAccount();
  const { evmAddress } = useEvmAddress();

  const handleExport = async () => {
    if (!evmAddress) return;

    try {
      const { privateKey } = await exportEvmAccount({
        evmAccount: evmAddress
      });
      console.log("Private Key:", privateKey);
    } catch (error) {
      console.error("Failed to export private key:", error);
    }
  };

  return (
    <button onClick={handleExport}>Export Private Key</button>
  );
}

useEnforceAuthenticated()

function useEnforceAuthenticated<TArgs, TReturn>(callback): (...args) => Promise<TReturn>;

Higher-order hook that wraps a callback with authentication enforcement. This ensures that the wrapped function can only be called when the user is signed in.

Type Parameters

Type Parameter	Description
`TArgs` extends `unknown`[]	Array type representing the arguments of the callback
`TReturn`	Type representing the return value of the callback

Parameters

Parameter	Type	Description
`callback`	(…`args`) => `Promise`<`TReturn`>	The async function to wrap with authentication check

Returns

A wrapped version of the callback that checks authentication

(...args): Promise<TReturn>;

Parameters

Parameter	Type
…`args`	`TArgs`

Returns

Promise<TReturn>

Throws

Throws an error if the user is not authenticated when the callback is invoked

useEnforceUnauthenticated()

function useEnforceUnauthenticated<TArgs, TReturn>(callback): (...args) => Promise<TReturn>;

Higher-order hook that wraps a callback with unauthenticated enforcement. This ensures that the wrapped function can only be called when the user is not signed in.

Type Parameters

Type Parameter	Description
`TArgs` extends `unknown`[]	Array type representing the arguments of the callback
`TReturn`	Type representing the return value of the callback

Parameters

Parameter	Type	Description
`callback`	(…`args`) => `Promise`<`TReturn`>	The async function to wrap with authentication check

Returns

A wrapped version of the callback that checks authentication

(...args): Promise<TReturn>;

Parameters

Parameter	Type
…`args`	`TArgs`

Returns

Promise<TReturn>

Throws

Throws an error if the user is authenticated when the callback is invoked

useSendUserOperation()

function useSendUserOperation(): UseSendUserOperationReturnType;

Hook that provides a wrapped function to send user operations from Smart Accounts with authentication checks. This hook uses useEnforceAuthenticated to ensure the user is signed in before attempting to send user operations. The hook internally waits for user operations to succeed and returns the related success/error via the data discriminated union object. Note: The data returned from the hook only represents the last sent user operation. If you wish to call one instance of the hook multiple times in quick succession it is recommended to save the userOperationHash returned from sendUserOperation yourself and handle waiting for the result.

Returns

UseSendUserOperationReturnType

Example

function SendUserOperation() {
  const { sendUserOperation, data, isError, error } = useSendUserOperation();
  const { currentUser } = useCurrentUser();

  const handleSendUserOperation = async () => {
    const smartAccount = currentUser?.evmSmartAccounts?.[0];
    if (!smartAccount) return;

    try {
      const result = await sendUserOperation({
        evmAccount: smartAccount,
        network: "base-sepolia",
        calls: [{
          to: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          value: "0x0",
          data: "0x",
        }],
      });
      console.log("User Operation Hash:", result.userOperationHash);
    } catch (error) {
      console.error("Failed to send user operation:", error);
    }
  };

  return (
    <div>
      {isError && <p>Error: {error?.message}</p>}
      {data && (
        <div>
          <p>User operation successful!</p>
          <p>Transaction Hash: {data.transactionHash}</p>
        </div>
      )}
      <button onClick={handleSendUserOperation}>Send User Operation</button>
    </div>
  );
}

useWaitForUserOperation()

function useWaitForUserOperation(parameters): UseWaitForUserOperationReturnType;

Hook that waits for a user operation to be confirmed and provides its current state. This hook polls the user operation status until it’s confirmed or fails. Note: The data returned from the hook only represents the last sent user operation. If you wish to call one instance of the hook multiple times in quick succession it is recommended to save the userOpHash returned from waitForUserOperation yourself and handle waiting for the result.

Parameters

Parameter	Type	Description
`parameters`	`UseWaitForUserOperationParameters`	Configuration object for waiting for user operation

Returns

UseWaitForUserOperationReturnType Query result with data, loading state, and error information

Example

function WaitForUserOperation() {
  const { status, data, error } = useWaitForUserOperation({
    userOperationHash: "0x1234...",
    evmSmartAccount: "0x1234567890123456789012345678901234567890",
    network: "base-sepolia"
  });

  return (
    <div>
      {status === "error" && <p>Error: {error?.message}</p>}
      {status === "success" && (
        <div>
          <p>User operation successful!</p>
          <p>Transaction Hash: {data.transactionHash}</p>
        </div>
      )}
    </div>
  );
}

CDPHooksProvider()

function CDPHooksProvider(props): Element;

Provider component that initializes the CDP SDK and manages authentication state. This must be placed at the root of your application or above any components that need CDP functionality.

Parameters

Parameter	Type	Description
`props`	`CDPHooksProviderProps`	The component props

Returns

Element A React context provider wrapping the children with CDP functionality

Example

const cdpConfig = {
  projectId: "your-project-id" // Your project ID from the CDP Portal
}

function App() {
  return (
    <CDPHooksProvider config={cdpConfig}>
      <YourApp />
    </CDPHooksProvider>
  );
}

Classes

APIError

Extends

Error

Constructors

Constructor

new APIError(
   statusCode, 
   errorType, 
   errorMessage, 
   correlationId?, 
   errorLink?, 
   cause?): APIError;

Parameters

Parameter	Type
`statusCode`	`number`
`errorType`	`APIErrorType`
`errorMessage`	`string`
`correlationId?`	`string`
`errorLink?`	`string`
`cause?`	`Error`

Returns

APIError

Overrides

Error.constructor

Methods

toJSON()

toJSON(): object;

Returns

object

errorLink?

optional errorLink: string;

correlationId?

optional correlationId: string;

name

name: string;

statusCode

statusCode: number;

errorType

errorType: APIErrorType;

errorMessage

errorMessage: string;

Properties

Property	Type
`statusCode`	`number`
`errorType`	`APIErrorType`
`errorMessage`	`string`
`correlationId?`	`string`
`errorLink?`	`string`

Interfaces

CDPHooksProviderProps

Props for the CDP Provider component

Properties

Property	Type	Description
`children`	`ReactNode`	React children to be rendered within the provider
`config`	`Config`	Configuration object for initializing the CDP SDK

CDPContextValue

Core context value interface for the CDP (Coinbase Developer Platform) provider.

Properties

Property	Type	Description
`isInitialized`	`boolean`	Whether the CDP SDK has completed initialization
`currentUser`	`null` \| `User`	The currently authenticated user, or null if not signed in
`isSignedIn`	`boolean`	Convenience boolean indicating if there is an authenticated user
`config`	`Config`	The CDP config

EIP712TypedData

Properties

Property	Type
`domain`	`EIP712Domain`
`types`	`EIP712Types`
`primaryType`	`string`
`message`	`EIP712Message`

Type Aliases

Config

type Config = CoreConfig & object;

The config for the CDP hooks.

Type declaration

transports?

optional transports: Record<typeof base.id | typeof baseSepolia.id, Transport>;

Param

The optional transports to use for the public clients. If not provided, the default http() transport is used.

Returns

The config for the CDP hooks.

TransactionState

type TransactionState = 
  | {
  status: "idle";
}
  | {
  status: "pending";
  hash: Hex;
}
  | {
  status: "success";
  receipt: TransactionReceipt;
}
  | {
  status: "error";
  error: Error;
};

Represents the state of an EVM transaction.

“idle”: No transaction in progress.
“pending”: Transaction sent, waiting for confirmation.
“success”: Transaction confirmed, includes receipt.
“error”: Transaction failed, includes error details.

Status

type Status = "idle" | "pending" | "success" | "error";

Represents the status of a request.

“idle”: No request in progress.
“pending”: Request sent, waiting for confirmation.
“success”: Request confirmed, includes result.
“error”: Request failed, includes error details.

UseSendUserOperationReturnType

type UseSendUserOperationReturnType = object;

Represents the return type of the useSendUserOperation hook.

Properties

Property	Type
`sendUserOperation`	(`options`) => `Promise`<`SendUserOperationResult`>
`data`	\| `GetUserOperationResult` \| `undefined`
`error`	`Error` \| `undefined`
`status`	`Status`

UseWaitForUserOperationParameters

type UseWaitForUserOperationParameters = object;

Represents the parameters for the useWaitForUserOperation hook.

Properties

Property	Type
`userOperationHash?`	`Hex`
`evmSmartAccount?`	`EvmAddress`
`network?`	`SendEvmTransactionWithEndUserAccountBodyNetwork`
`enabled?`	`boolean`

UseWaitForUserOperationReturnType

type UseWaitForUserOperationReturnType = object;

Represents the return type of the useWaitForUserOperation hook.

Properties

Property	Type
`status`	`Status`
`data`	\| `GetUserOperationResult` \| `undefined`
`error`	`Error` \| `undefined`

AllowedEvmTransactionType

type AllowedEvmTransactionType = TransactionSerializableEIP1559;

APIErrorType

type APIErrorType = 
  | ErrorType
  | HttpErrorType;

EvmAddress

type EvmAddress = `0x${string}`;

ExportEvmAccountOptions

type ExportEvmAccountOptions = object;

Properties

Property	Type
`evmAccount`	`EvmAddress`

ExportEvmAccountResult

type ExportEvmAccountResult = object;

Properties

Property	Type
`privateKey`	`string`

GetUserOperationResult

type GetUserOperationResult = EvmUserOperation;

Hex

type Hex = `0x${string}`;

SendEvmTransactionOptions

type SendEvmTransactionOptions = object;

Properties

Property	Type
`evmAccount`	`EvmAddress`
`network`	`SendEvmTransactionWithEndUserAccountBodyNetwork`
`transaction`	`AllowedEvmTransactionType`

SendEvmTransactionResult

type SendEvmTransactionResult = object;

Properties

Property	Type
`transactionHash`	`Hex`

SignEvmHashOptions

type SignEvmHashOptions = object;

Properties

Property	Type
`evmAccount`	`EvmAddress`
`hash`	`Hex`

SignEvmHashResult

type SignEvmHashResult = object;

Properties

Property	Type
`signature`	`Hex`

SignEvmMessageOptions

type SignEvmMessageOptions = object;

Properties

Property	Type
`evmAccount`	`EvmAddress`
`message`	`string`

SignEvmMessageResult

type SignEvmMessageResult = object;

Properties

Property	Type
`signature`	`Hex`

SignEvmTransactionOptions

type SignEvmTransactionOptions = object;

Properties

Property	Type
`evmAccount`	`EvmAddress`
`transaction`	`AllowedEvmTransactionType`

SignEvmTransactionResult

type SignEvmTransactionResult = object;

Properties

Property	Type
`signedTransaction`	`Hex`

SignEvmTypedDataOptions

type SignEvmTypedDataOptions = object;

Properties

Property	Type
`evmAccount`	`EvmAddress`
`typedData`	`EIP712TypedData`

SignEvmTypedDataResult

type SignEvmTypedDataResult = object;

Properties

Property	Type
`signature`	`Hex`

SignInWithEmailOptions

type SignInWithEmailOptions = object;

Properties

Property	Type
`email`	`string`

SignInWithEmailResult

type SignInWithEmailResult = object;

Properties

Property	Type
`message`	`string`
`flowId`	`string`

User

type User = object;

Properties

Property	Type
`userId`	`string`
`authenticationMethods`	`AuthenticationMethods`
`evmAccounts?`	`EvmAddress`[]
`evmSmartAccounts?`	`EvmAddress`[]

VerifyEmailOTPOptions

type VerifyEmailOTPOptions = object;

Properties

Property	Type
`flowId`	`string`
`otp`	`string`

VerifyEmailOTPResult

type VerifyEmailOTPResult = object;

Properties

Property	Type
`user`	`User`
`message`	`string`
`isNewUser`	`boolean`

Variables

CDPContext

const CDPContext: Context<
  | null
| CDPContextValue>;

Context for the CDP provider.

SDKs

BUILD ONCHAIN

CONSUMER APIs

INSTITUTIONAL APIs

​Quickstart

​Installation

​Gather your CDP Project Information

​Allowlist your local app

​Setup Provider

​Smart Account Configuration

​Sign In a User

​View User Information

​Send a Transaction

​Sign Messages and Typed Data

​Export Private Key

​Smart Account Operations

​Send User Operations

​Track User Operation Status

​Conditional Polling

​Functions

​useConfig()

​Returns

config

​Example

​useIsInitialized()

​Returns

isInitialized

​Example

​useSignInWithEmail()

​Returns

signInWithEmail()

Parameters

Returns

​Example

​useSignInWithSms()

​Returns

signInWithSms()

Parameters

Returns

​Example

​useVerifyEmailOTP()

​Returns

verifyEmailOTP()

Parameters

Returns

​Example

​useVerifySmsOTP()

​Returns

verifySmsOTP()

Parameters

Returns

​Example

​useIsSignedIn()

​Returns

isSignedIn

​Example

​useCurrentUser()

​Returns

currentUser

​Example

​useSignOut()

​Returns

signOut()

Returns

​Example

​useGetAccessToken()

​Returns

getAccessToken()

Returns

​Example

​useEvmAddress()

​Returns

evmAddress

​Example

​useSignEvmHash()

​Returns

signEvmHash()

Parameters

Returns

​Example

Quickstart

Installation

Gather your CDP Project Information

Allowlist your local app

Setup Provider

Smart Account Configuration

Sign In a User

View User Information

Send a Transaction

Sign Messages and Typed Data

Export Private Key

Smart Account Operations

Send User Operations

Track User Operation Status

Conditional Polling

Functions

useConfig()

Returns

Example

useIsInitialized()

Returns

Example

useSignInWithEmail()

Returns

Example

useSignInWithSms()

Returns

Example

useVerifyEmailOTP()

Returns

Example

useVerifySmsOTP()

Returns

Example

useIsSignedIn()

Returns

Example

useCurrentUser()

Returns

Example

useSignOut()

Returns

Example

useGetAccessToken()

Returns

Example

useEvmAddress()

Returns

Example

useSignEvmHash()

Returns

Example

useSignEvmTransaction()

Returns

Example

useSendEvmTransaction()

Returns

Example

useSignEvmMessage()

Returns

Example

useSignEvmTypedData()

Returns

Example

useExportEvmAccount()

Returns

Example

useEnforceAuthenticated()

Type Parameters

Parameters

Returns

Throws

useEnforceUnauthenticated()

Type Parameters

Parameters

Returns

Throws

useSendUserOperation()

Returns

Example