The main client for interacting with the CDP API.

Constructors

Properties

Constructors

  • The CdpClient is the main class for interacting with the CDP API.

    There are a few required parameters that are configured in the CDP Portal:

    • CDP Secret API Key (apiKeyId & apiKeySecret): These are used to authenticate requests to the entire suite of APIs offered on Coinbase Developer Platform. Read more about CDP API keys.
    • Wallet Secret (walletSecret): This secret is used specifically to authenticate requests to POST, and DELETE endpoints in the EVM and Solana Account APIs.

    These parameters can be set as environment variables:

    CDP_API_KEY_ID=your-api-key-id
    CDP_API_KEY_SECRET=your-api-key-secret
    CDP_WALLET_SECRET=your-wallet-secret

    Or passed as options to the constructor:

    const cdp = new CdpClient({
    apiKeyId: "your-api-key-id",
    apiKeySecret: "your-api-key-secret",
    walletSecret: "your-wallet-secret",
    });

    The CdpClient is namespaced by chain type: evm or solana.

    As an example, to create a new EVM account, use cdp.evm.createAccount().

    To create a new Solana account, use cdp.solana.createAccount().

    Parameters

    • Optionaloptions: CdpClientOptions = {}

      Configuration options for the CdpClient.

    Returns CdpClient

Properties

Namespace containing all EVM methods.

solana: SolanaClient

Namespace containing all Solana methods.