@coinbase/cdp-sdk 1.0.1 → 1.1.0

package/README.md

@@ -27,19 +27,55 @@ npm install @coinbase/cdp-sdk
 
 ## API Keys
 
-To start, [create a CDP API Key](https://portal.cdp.coinbase.com/access/api). Save the `API Key ID` and `API Key Secret` for use in the SDK. You will also need to create a wallet secret in the [CDP Portal](https://portal.cdp.coinbase.com/products/wallet-api) to sign transactions.
+To start, [create a CDP API Key](https://portal.cdp.coinbase.com/access/api). Save the `API Key ID` and `API Key Secret` for use in the SDK. You will also need to create a wallet secret in the Portal to sign transactions.
 
 ## Usage
 
 ### Initialization
 
-#### You can import the SDK as follows:
+#### Load client config from shell
+
+One option is to export your CDP API Key and Wallet Secret as environment variables:
+
+```bash
+export CDP_API_KEY_NAME="YOUR_API_KEY_ID"
+export CDP_API_KEY_SECRET="YOUR_API_KEY_SECRET"
+export CDP_WALLET_SECRET="YOUR_WALLET_SECRET"
+```
+
+Then, initialize the client:
 
 ```typescript
 import { CdpClient } from "@coinbase/cdp-sdk";
+
+const cdp = new CdpClient();
 ```
 
-#### Then, initialize the client as follows:
+#### Load client config from `.env` file
+
+Another option is to save your CDP API Key and Wallet Secret in a `.env` file:
+
+```bash
+touch .env
+echo "CDP_API_KEY_NAME=YOUR_API_KEY_ID" >> .env
+echo "CDP_API_KEY_SECRET=YOUR_API_KEY_SECRET" >> .env
+echo "CDP_WALLET_SECRET=YOUR_WALLET_SECRET" >> .env
+```
+
+Then, load the client config from the `.env` file:
+
+```typescript
+import { CdpClient } from "@coinbase/cdp-sdk";
+import dotenv from "dotenv";
+
+dotenv.config();
+
+const cdp = new CdpClient();
+```
+
+#### Pass the API Key and Wallet Secret to the client
+
+Another option is to directly pass the API Key and Wallet Secret to the client:
 
 ```typescript
 const cdp = new CdpClient({

package/dist/auth/utils/http.js

@@ -25,7 +25,7 @@ async function getAuthHeaders(options) {
     // Add wallet auth if needed
     if (requiresWalletAuth(options.requestMethod, options.requestPath)) {
         if (!options.walletSecret) {
-            throw new Error("Wallet Secret not configured. Call configure() first.");
+            throw new Error("Wallet Secret not configured. Please set the CDP_WALLET_SECRET environment variable, or pass it as an option to the CdpClient constructor.");
         }
         const walletAuthToken = await (0, jwt_1.generateWalletJwt)({
             walletSecret: options.walletSecret,

package/dist/client/cdp.d.ts

@@ -2,11 +2,11 @@ import { EvmClient } from "./evm";
 import { SolanaClient } from "./solana";
 interface CdpClientOptions {
     /** The API key ID. */
-    apiKeyId: string;
+    apiKeyId?: string;
     /** The API key secret. */
-    apiKeySecret: string;
+    apiKeySecret?: string;
     /** The wallet secret. */
-    walletSecret: string;
+    walletSecret?: string;
     /** Whether to enable debugging. */
     debugging?: boolean;
     /** The host URL to connect to. */
@@ -30,14 +30,31 @@ export declare class CdpClient {
      * - **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_NAME=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:
+     *
+     * ```typescript
+     * 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()`.
      *
-     * @param {CdpClientOptions} options - Configuration options for the CdpClient.
+     * @param {CdpClientOptions} [options] - Configuration options for the CdpClient.
      */
-    constructor(options: CdpClientOptions);
+    constructor(options?: CdpClientOptions);
 }
 export {};

package/dist/client/cdp.js

@@ -19,17 +19,71 @@ class CdpClient {
      * - **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_NAME=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:
+     *
+     * ```typescript
+     * 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()`.
      *
-     * @param {CdpClientOptions} options - Configuration options for the CdpClient.
+     * @param {CdpClientOptions} [options] - Configuration options for the CdpClient.
      */
-    constructor(options) {
+    constructor(options = {}) {
+        const apiKeyId = options.apiKeyId ?? process.env.CDP_API_KEY_NAME;
+        const apiKeySecret = options.apiKeySecret ?? process.env.CDP_API_KEY_SECRET;
+        const walletSecret = options.walletSecret ?? process.env.CDP_WALLET_SECRET;
+        if (!apiKeyId || !apiKeySecret) {
+            throw new Error(`
+\nMissing required CDP Secret API Key configuration parameters.
+
+You can set them as environment variables:
+
+CDP_API_KEY_NAME=your-api-key-id
+CDP_API_KEY_SECRET=your-api-key-secret
+
+You can also pass them as options to the constructor:
+
+const cdp = new CdpClient({
+  apiKeyId: "your-api-key-id",
+  apiKeySecret: "your-api-key-secret",
+});
+
+If you're performing write operations, make sure to also set your wallet secret:
+
+CDP_WALLET_SECRET=your-wallet-secret
+
+This is also available as an option to the constructor:
+
+const cdp = new CdpClient({
+  apiKeyId: "your-api-key-id",
+  apiKeySecret: "your-api-key-secret",
+  walletSecret: "your-wallet-secret",
+});
+
+For more information, see: https://github.com/coinbase/cdp-sdk/blob/main/typescript/README.md#api-keys.
+`);
+        }
         openapi_client_1.CdpOpenApiClient.configure({
             ...options,
+            apiKeyId,
+            apiKeySecret,
+            walletSecret,
             source: "sdk",
             sourceVersion: package_json_1.version,
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coinbase/cdp-sdk",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "CDP SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -53,6 +53,10 @@
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./auth": {
+      "types": "./dist/auth/index.d.ts",
+      "default": "./dist/auth/index.js"
     }
   },
   "scripts": {