@coinbase/cdp-sdk 1.3.1 → 1.4.0

package/auth/utils/ws.ts

@@ -0,0 +1,76 @@
+import { getCorrelationData } from "./http.js";
+import { generateJwt } from "./jwt.js";
+
+/**
+ * Options for generating WebSocket authentication headers.
+ */
+export interface GetWebSocketAuthHeadersOptions {
+  /**
+   * The API key ID
+   *
+   * Examples:
+   *  'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+   *  'organizations/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/apiKeys/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+   */
+  apiKeyId: string;
+
+  /**
+   * The API key secret
+   *
+   * Examples:
+   *  'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==' (Edwards key (Ed25519))
+   *  '-----BEGIN EC PRIVATE KEY-----\n...\n...\n...==\n-----END EC PRIVATE KEY-----\n' (EC key (ES256))
+   */
+  apiKeySecret: string;
+
+  /**
+   * The source identifier for the request
+   */
+  source?: string;
+
+  /**
+   * The version of the source making the request
+   */
+  sourceVersion?: string;
+
+  /**
+   * Optional expiration time in seconds (defaults to 120)
+   */
+  expiresIn?: number;
+
+  /**
+   * Optional audience claim for the JWT
+   */
+  audience?: string[];
+}
+
+/**
+ * Gets authentication headers for a WebSocket connection.
+ *
+ * @param options - The configuration options for generating WebSocket auth headers
+ * @returns Object containing the authentication headers
+ */
+export async function getWebSocketAuthHeaders(
+  options: GetWebSocketAuthHeadersOptions,
+): Promise<Record<string, string>> {
+  const headers: Record<string, string> = {};
+
+  // Generate and add JWT token without request parameters for WebSocket
+  const jwt = await generateJwt({
+    apiKeyId: options.apiKeyId,
+    apiKeySecret: options.apiKeySecret,
+    // All request parameters are null for WebSocket
+    requestMethod: null,
+    requestHost: null,
+    requestPath: null,
+    expiresIn: options.expiresIn,
+    audience: options.audience,
+  });
+  headers["Authorization"] = `Bearer ${jwt}`;
+  headers["Content-Type"] = "application/json";
+
+  // Add correlation data
+  headers["Correlation-Context"] = getCorrelationData(options.source, options.sourceVersion);
+
+  return headers;
+}

package/client/cdp.ts

@@ -1,4 +1,4 @@
-import { AnalyticsConfig } from "../analytics.js";
+import { wrapClassWithErrorTracking } from "../analytics.js";
 import { CdpOpenApiClient } from "../openapi-client/index.js";
 import { version } from "../version.js";
 import { EvmClient } from "./evm/evm.js";
@@ -108,7 +108,11 @@ For more information, see: https://github.com/coinbase/cdp-sdk/blob/main/typescr
       sourceVersion: version,
     });
 
-    AnalyticsConfig.set(apiKeyId);
+    if (process.env.DISABLE_CDP_ERROR_REPORTING !== "true") {
+      wrapClassWithErrorTracking(CdpClient, apiKeyId);
+      wrapClassWithErrorTracking(EvmClient, apiKeyId);
+      wrapClassWithErrorTracking(SolanaClient, apiKeyId);
+    }
 
     this.evm = new EvmClient();
     this.solana = new SolanaClient();

package/index.ts

@@ -1,4 +1,2 @@
-import "./analytics.js";
-
 export { CdpClient } from "./client/cdp.js";
 export type { EvmServerAccount, EvmSmartAccount } from "./accounts/types.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coinbase/cdp-sdk",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "SDK for interacting with the Coinbase Developer Platform Wallet API",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",

package/version.ts

@@ -1 +1 @@
-export const version = "1.3.1";
+export const version = "1.4.0";