Renamed CDP env vars to modern convention

README.md

@@ -68,7 +68,7 @@ npm create onchain-agent@latest
 # Navigate to your project directory
 cd onchain-agent
 
-# At this point, fill in your CDP API key name, OpenAI API key, and any other environment variables in the .env.local file.
+# At this point, fill in your CDP API key id/secret, OpenAI API key, and any other environment variables in the .env.local file.
 # Then, rename the .env.local file to .env
 mv .env.local .env
 
@@ -104,7 +104,7 @@ pipx run create-onchain-agent
 # Navigate to your project directory
 cd onchain-agent
 
-# At this point, fill in your CDP API key name, OpenAI API key, and any other environment variables in the .env.local file.
+# At this point, fill in your CDP API key id/secret, OpenAI API key, and any other environment variables in the .env.local file.
 # Then, rename the .env.local file to .env
 mv .env.local .env
 

python/coinbase-agentkit/README.md

@@ -70,8 +70,8 @@ from coinbase_agentkit import (
 )
 
 wallet_provider = CdpWalletProvider(CdpWalletProviderConfig(
-    api_key_name="CDP API KEY NAME",
-    api_key_private="CDP API KEY PRIVATE KEY",
+    api_key_id="CDP API KEY NAME",
+    api_key_secret="CDP API KEY SECRET",
     network_id="base-mainnet"
 ))
 
@@ -94,8 +94,8 @@ agent_kit = AgentKit(AgentKitConfig(
     wallet_provider=wallet_provider,
     action_providers=[
         cdp_api_action_provider(
-            api_key_name="CDP API KEY NAME",
-            api_key_private="CDP API KEY PRIVATE KEY"
+            api_key_id="CDP API KEY NAME",
+            api_key_secret="CDP API KEY SECRET"
         ),
         pyth_action_provider()
     ]
@@ -206,8 +206,8 @@ class MyActionProvider(ActionProvider[WalletProvider]):
 
 ```python
 agent_kit = AgentKit(AgentKitConfig(
-    cdp_api_key_name="CDP API KEY NAME",
-    cdp_api_key_private="CDP API KEY PRIVATE KEY",
+    cdp_api_key_id="CDP API KEY ID",
+    cdp_api_key_secret="CDP API KEY SECRET",
     action_providers=[my_action_provider()]
 ))
 ```

python/coinbase-agentkit/changelog.d/+3bd9f8f2.feature.md

@@ -0,0 +1 @@
+Renamed CDP env vars to modern naming convention

python/create-onchain-agent/changelog.d/+4cc563fc.feature.md

@@ -0,0 +1 @@
+Renamed CDP env vars to modern naming convention

python/create-onchain-agent/templates/beginner/.env.local.jinja

@@ -4,10 +4,10 @@
 ## Required
 # Place your OpenAI API key here
 OPENAI_API_KEY=
-# Place your CDP API key name here
-CDP_API_KEY_NAME=
-# Place your CDP API private key here
-CDP_API_KEY_PRIVATE_KEY=
+# Place your CDP API key id here
+CDP_API_KEY_ID=
+# Place your CDP API key secret here
+CDP_API_KEY_SECRET=
 
 ## Optional
 NETWORK_ID=base-sepolia

python/create-onchain-agent/templates/chatbot/.env.local.jinja

@@ -37,8 +37,8 @@ OWNER_PRIVATE_KEY=
 
 # Optional - Set PAYMASTER_URL to sponsor transactions: https://docs.cdp.coinbase.com/paymaster/docs/welcome
 PAYMASTER_URL={% endif %}{% if _wallet_provider == "eth"%}# Required
-CDP_API_KEY_NAME= # Place your CDP API key name here
-CDP_API_KEY_PRIVATE_KEY= # Place your CDP API key private key here
+CDP_API_KEY_ID= # Place your CDP API key id here
+CDP_API_KEY_SECRET= # Place your CDP API key secret here
 OPENAI_API_KEY= # Place your OpenAI API key here
 
 # Optional - Set PRIVATE_KEY if you have an existing private key. Otherwise, a new account will be created.

python/examples/langchain-cdp-server-chatbot/README.md

@@ -32,8 +32,8 @@ uv sync
 
 ### Set ENV Vars
 - Ensure the following ENV Vars are set:
-  - "CDP_API_KEY_NAME"
-  - "CDP_API_KEY_PRIVATE_KEY"
+  - "CDP_API_KEY_ID"
+  - "CDP_API_KEY_SECRET"
   - "OPENAI_API_KEY"
   - "NETWORK_ID" (Defaults to `base-sepolia`)
 

python/examples/langchain-cdp-smart-wallet-chatbot/README.md

@@ -38,8 +38,8 @@ You'll need the following API keys:
 Once you have them, rename the `.env.local` file to `.env` and make sure you set the API keys to their corresponding environment variables:
 
 #### Required:
-  - `CDP_API_KEY_NAME=`
-  - `CDP_API_KEY_PRIVATE_KEY=`
+  - `CDP_API_KEY_ID=`
+  - `CDP_API_KEY_SECRET=`
   - `OPENAI_API_KEY=`
 
 #### Optional:

python/examples/langchain-eth-account-chatbot/.env.local

@@ -1,6 +1,6 @@
 # Required
-CDP_API_KEY_NAME= # Place your CDP API key name here
-CDP_API_KEY_PRIVATE_KEY= # Place your CDP API key private key here
+CDP_API_KEY_ID= # Place your CDP API key id here
+CDP_API_KEY_SECRET= # Place your CDP API key secret here
 OPENAI_API_KEY= # Place your OpenAI API key here
 
 # Optional - Set PRIVATE_KEY if you have an existing private key. Otherwise, a new account will be created.

python/examples/langchain-eth-account-chatbot/README.md

@@ -32,8 +32,8 @@ uv sync
 
 ### Set ENV Vars
 - Ensure the following ENV Vars are set:
-  - "CDP_API_KEY_NAME"
-  - "CDP_API_KEY_PRIVATE_KEY"
+  - "CDP_API_KEY_ID"
+  - "CDP_API_KEY_SECRET"
   - "OPENAI_API_KEY"
   - "NETWORK_ID" (Defaults to `base-sepolia`)
 

python/examples/langchain-nillion-secretvault-chatbot/.env.local

@@ -1,5 +1,5 @@
-CDP_API_KEY_NAME= # Place your CDP API key name here
-CDP_API_KEY_PRIVATE_KEY= # Place your CDP API key private key here
+CDP_API_KEY_ID= # Place your CDP API key id here
+CDP_API_KEY_SECRET= # Place your CDP API key secret here
 OPENAI_API_KEY= # Place your OpenAI API key here
 NILLION_ORG_ID= # Place your Nillion SecretVault organization did here
 NILLION_SECRET_KEY= # Place your Nillion SecretVault organization private key here

python/examples/langchain-nillion-secretvault-chatbot/README.md

@@ -35,8 +35,8 @@ uv sync
 
 ### Set ENV Vars
 - Ensure the following ENV Vars are set:
-  - "CDP_API_KEY_NAME"
-  - "CDP_API_KEY_PRIVATE_KEY"
+  - "CDP_API_KEY_ID"
+  - "CDP_API_KEY_SECRET"
   - "OPENAI_API_KEY"
   - "NETWORK_ID" (Defaults to `base-sepolia`)
   - "NILLION_ORG_ID"

python/examples/langchain-twitter-chatbot/README.md

@@ -47,8 +47,8 @@ make install
 
 Rename .env.local to .env and ensure the following var are set:
 
-- "CDP_API_KEY_NAME"
-- "CDP_API_KEY_PRIVATE_KEY"
+- "CDP_API_KEY_ID"
+- "CDP_API_KEY_SECRET"
 - "OPENAI_API_KEY"
 - "TWITTER_ACCESS_TOKEN"
 - "TWITTER_ACCESS_TOKEN_SECRET"

python/examples/openai-agents-sdk-cdp-chatbot/README.md

@@ -32,8 +32,8 @@ uv sync
 
 ### Set ENV Vars
 - Ensure the following ENV Vars are set:
-  - "CDP_API_KEY_NAME"
-  - "CDP_API_KEY_PRIVATE_KEY"
+  - "CDP_API_KEY_ID"
+  - "CDP_API_KEY_SECRET"
   - "OPENAI_API_KEY"
   - "PRIVATE_KEY" (optional, will generate a new private key if not provided)
   - "NETWORK_ID" (Defaults to `base-sepolia`)

python/examples/openai-agents-sdk-cdp-voice-chatbot/README.md

@@ -39,8 +39,8 @@ uv install
 ### Set ENV Vars
 
 - Ensure the following ENV Vars are set:
-  - "CDP_API_KEY_NAME"
-  - "CDP_API_KEY_PRIVATE_KEY"
+  - "CDP_API_KEY_ID"
+  - "CDP_API_KEY_SECRET"
   - "OPENAI_API_KEY"
   - "NETWORK_ID" (Defaults to `base-sepolia`)
 

python/examples/openai-agents-sdk-smart-wallet-chatbot/README.md

@@ -32,8 +32,8 @@ uv sync
 
 ### Set ENV Vars
 - Ensure the following ENV Vars are set:
-  - "CDP_API_KEY_NAME"
-  - "CDP_API_KEY_PRIVATE_KEY"
+  - "CDP_API_KEY_ID"
+  - "CDP_API_KEY_SECRET"
   - "OPENAI_API_KEY"
   - "PRIVATE_KEY" (optional, will generate a new private key if not provided)
   - "NETWORK_ID" (Defaults to `base-sepolia`)

python/framework-extensions/langchain/README.md

@@ -21,7 +21,7 @@ Set the following environment variables:
 
 ```bash
 export OPENAI_API_KEY=<your-openai-api-key>
-export CDP_API_KEY_NAME=<your-cdp-api-key-name>
+export CDP_API_KEY_ID=<your-cdp-api-key-id>
 export CDP_API_KEY_PRIVATE=<your-cdp-api-key-private>
 ```
 

python/framework-extensions/openai-agents-sdk/README.md

@@ -21,7 +21,7 @@ Set the following environment variables:
 
 ```bash
 export OPENAI_API_KEY=<your-openai-api-key>
-export CDP_API_KEY_NAME=<your-cdp-api-key-name>
+export CDP_API_KEY_ID=<your-cdp-api-key-id>
 export CDP_API_KEY_PRIVATE=<your-cdp-api-key-private>
 ```
 

typescript/.changeset/fluffy-adults-stay.md

@@ -0,0 +1,6 @@
+---
+"create-onchain-agent": minor
+"@coinbase/agentkit": minor
+---
+
+Renamed CDP env vars to modern naming convention

typescript/agentkit/README.md

@@ -65,8 +65,8 @@ npm install @coinbase/agentkit
 
 ```typescript
 const agentKit = await AgentKit.from({
-  cdpApiKeyName: "CDP API KEY NAME",
-  cdpApiKeyPrivate: "CDP API KEY PRIVATE KEY",
+  cdpApiKeyId: "CDP API KEY NAME",
+  cdpApiKeyPrivate: "CDP API KEY SECRET",
 });
 ```
 
@@ -76,8 +76,8 @@ If no wallet or action provider are specified, the agent will use the `CdpWallet
 
 ```typescript
 const agentKit = await AgentKit.from({
-  cdpApiKeyName: "CDP API KEY NAME",
-  cdpApiKeyPrivate: "CDP API KEY PRIVATE KEY",
+  cdpApiKeyId: "CDP API KEY NAME",
+  cdpApiKeyPrivate: "CDP API KEY SECRET",
 });
 ```
 
@@ -87,8 +87,8 @@ const agentKit = await AgentKit.from({
 import { CdpWalletProvider } from "@coinbase/agentkit";
 
 const walletProvider = await CdpWalletProvider.configureWithWallet({
-    apiKeyName: "CDP API KEY NAME",
-    apiKeyPrivate: "CDP API KEY PRIVATE KEY",
+    apiKeyId: "CDP API KEY NAME",
+    apiKeyPrivate: "CDP API KEY SECRET",
     networkId: "base-mainnet",
 });
 
@@ -106,8 +106,8 @@ const agentKit = await AgentKit.from({
     walletProvider,
     actionProviders: [
         cdpApiActionProvider({
-            apiKeyName: "CDP API KEY NAME",
-            apiKeyPrivate: "CDP API KEY PRIVATE KEY",
+            apiKeyId: "CDP API KEY NAME",
+            apiKeyPrivate: "CDP API KEY SECRET",
         }),
         pythActionProvider(),
     ],
@@ -528,8 +528,8 @@ This gives your agent access to the actions defined in the action provider.
 
 ```typescript
 const agentKit = new AgentKit({
-  cdpApiKeyName: "CDP API KEY NAME",
-  cdpApiKeyPrivate: "CDP API KEY PRIVATE KEY",
+  cdpApiKeyId: "CDP API KEY NAME",
+  cdpApiKeyPrivate: "CDP API KEY SECRET",
   actionProviders: [myActionProvider()],
 });
 ```
@@ -621,8 +621,8 @@ The `CdpWalletProvider` can be configured to use a specific network by passing t
 import { CdpWalletProvider } from "@coinbase/agentkit";
 
 const walletProvider = await CdpWalletProvider.configureWithWallet({
-    apiKeyName: "CDP API KEY NAME",
-    apiKeyPrivate: "CDP API KEY PRIVATE KEY",
+    apiKeyId: "CDP API KEY NAME",
+    apiKeyPrivate: "CDP API KEY SECRET",
     networkId: "base-mainnet",
 });
 ```
@@ -636,8 +636,8 @@ import { CdpWalletProvider } from "@coinbase/agentkit";
 import { Wallet } from "@coinbase/coinbase-sdk";
 const walletProvider = await CdpWalletProvider.configureWithWallet({
     wallet,
-    apiKeyName: "CDP API KEY NAME",
-    apiKeyPrivate: "CDP API KEY PRIVATE KEY",
+    apiKeyId: "CDP API KEY NAME",
+    apiKeyPrivate: "CDP API KEY SECRET",
 });
 ```
 
@@ -678,8 +678,8 @@ import { CdpWalletProvider } from "@coinbase/agentkit";
 
 const walletProvider = await CdpWalletProvider.configureWithWallet({
     cdpWalletData: "WALLET DATA JSON STRING",
-    apiKeyName: "CDP API KEY NAME",
-    apiKeyPrivate: "CDP API KEY PRIVATE KEY",
+    apiKeyId: "CDP API KEY NAME",
+    apiKeyPrivate: "CDP API KEY SECRET",
 });
 ```
 
@@ -692,8 +692,8 @@ import { CdpWalletProvider } from "@coinbase/agentkit";
 
 const walletProvider = await CdpWalletProvider.configureWithWallet({
     cdpWalletData: "WALLET DATA JSON STRING",
-    apiKeyName: "CDP API KEY NAME",
-    apiKeyPrivate: "CDP API KEY PRIVATE KEY",
+    apiKeyId: "CDP API KEY NAME",
+    apiKeyPrivate: "CDP API KEY SECRET",
     gas: {
         gasLimitMultiplier: 2.0,  // Adjusts gas limit estimation
         feePerGasMultiplier: 2.0, // Adjusts max fee per gas
@@ -879,8 +879,8 @@ import { ZeroDevWalletProvider, CdpWalletProvider } from "@coinbase/agentkit";
 
 // First create a CDP wallet provider as the signer
 const cdpWalletProvider = await CdpWalletProvider.configureWithWallet({
-    apiKeyName: "CDP API KEY NAME",
-    apiKeyPrivate: "CDP API KEY PRIVATE KEY",
+    apiKeyId: "CDP API KEY NAME",
+    apiKeyPrivate: "CDP API KEY SECRET",
     networkId: "base-mainnet",
 });
 

typescript/agentkit/src/action-providers/cdp/cdpApiActionProvider.ts

@@ -21,10 +21,10 @@ export class CdpApiActionProvider extends ActionProvider<WalletProvider> {
   constructor(config: CdpProviderConfig = {}) {
     super("cdp_api", []);
 
-    if (config.apiKeyName && config.apiKeyPrivateKey) {
+    if (config.apiKeyId && config.apiKeySecret) {
       Coinbase.configure({
-        apiKeyName: config.apiKeyName,
-        privateKey: config.apiKeyPrivateKey?.replace(/\\n/g, "\n"),
+        apiKeyName: config.apiKeyId,
+        privateKey: config.apiKeySecret?.replace(/\\n/g, "\n"),
         source: "agentkit",
         sourceVersion: version,
       });

typescript/agentkit/src/action-providers/cdp/cdpWalletActionProvider.ts

@@ -22,10 +22,10 @@ export class CdpWalletActionProvider extends ActionProvider<CdpWalletProvider> {
   constructor(config: CdpProviderConfig = {}) {
     super("cdp_wallet", []);
 
-    if (config.apiKeyName && config.apiKeyPrivateKey) {
+    if (config.apiKeyId && config.apiKeySecret) {
       Coinbase.configure({
-        apiKeyName: config.apiKeyName,
-        privateKey: config.apiKeyPrivateKey?.replace(/\\n/g, "\n"),
+        apiKeyName: config.apiKeyId,
+        privateKey: config.apiKeySecret?.replace(/\\n/g, "\n"),
         source: "agentkit",
         sourceVersion: version,
       });

typescript/agentkit/src/agentkit.ts

@@ -5,8 +5,8 @@ import { Action, ActionProvider, walletActionProvider } from "./action-providers
  * Configuration options for AgentKit
  */
 export type AgentKitOptions = {
-  cdpApiKeyName?: string;
-  cdpApiKeyPrivateKey?: string;
+  cdpApiKeyId?: string;
+  cdpApiKeySecret?: string;
   walletProvider?: WalletProvider;
   actionProviders?: ActionProvider[];
 };
@@ -47,15 +47,15 @@ export class AgentKit {
     let walletProvider: WalletProvider | undefined = config.walletProvider;
 
     if (!config.walletProvider) {
-      if (!config.cdpApiKeyName || !config.cdpApiKeyPrivateKey) {
+      if (!config.cdpApiKeyId || !config.cdpApiKeySecret) {
         throw new Error(
-          "cdpApiKeyName and cdpApiKeyPrivateKey are required if not providing a walletProvider",
+          "cdpApiKeyId and cdpApiKeySecret are required if not providing a walletProvider",
         );
       }
 
       walletProvider = await CdpWalletProvider.configureWithWallet({
-        apiKeyName: config.cdpApiKeyName,
-        apiKeyPrivateKey: config.cdpApiKeyPrivateKey,
+        apiKeyId: config.cdpApiKeyId,
+        apiKeySecret: config.cdpApiKeySecret,
       });
     }