@coinbase/cdp-sdk 1.26.0 → 1.28.0

package/actions/evm/fund/fund.ts

@@ -1,6 +1,7 @@
 import { formatUnits } from "viem";
 
 import { FundOperationResult } from "./types.js";
+import { UserInputValidationError } from "../../../errors.js";
 import {
   CreatePaymentTransferQuoteBodySourceType,
   CreatePaymentTransferQuoteBodyTargetType,
@@ -42,8 +43,8 @@ export async function fund(
     throw new Error("No card found to fund account");
   }
 
-  if (options.token.toLowerCase() !== "eth" && options.token.toLowerCase() !== "usdc") {
-    throw new Error("Invalid currency, must be eth or usdc");
+  if (options.token !== "eth" && options.token !== "usdc") {
+    throw new UserInputValidationError("Invalid token, must be eth or usdc");
   }
 
   const decimals = options.token === "eth" ? 18 : 6;

package/actions/evm/fund/quoteFund.ts

@@ -1,6 +1,7 @@
 import { formatUnits } from "viem";
 
 import { Quote } from "./Quote.js";
+import { UserInputValidationError } from "../../../errors.js";
 import {
   CreatePaymentTransferQuoteBodySourceType,
   CreatePaymentTransferQuoteBodyTargetType,
@@ -42,8 +43,8 @@ export async function quoteFund(
     throw new Error("No card found to fund account");
   }
 
-  if (options.token.toLowerCase() !== "eth" && options.token.toLowerCase() !== "usdc") {
-    throw new Error("Invalid currency, must be eth or usdc");
+  if (options.token !== "eth" && options.token !== "usdc") {
+    throw new UserInputValidationError("Invalid token, must be eth or usdc");
   }
 
   const decimals = options.token === "eth" ? 18 : 6;

package/actions/solana/sendTransaction.ts

@@ -0,0 +1,38 @@
+import { SendTransactionOptions, TransactionResult } from "../../client/solana/solana.types.js";
+import { CdpOpenApiClientType } from "../../openapi-client/index.js";
+
+/**
+ * Sends a Solana transaction using the Coinbase API.
+ *
+ * @param {CdpOpenApiClientType} apiClient - The API client to use.
+ * @param {SendTransactionOptions} options - Parameters for sending the Solana transaction.
+ * @param {string} options.network - The network to send the transaction to.
+ * @param {string} options.transaction - The base64 encoded transaction to send.
+ * @param {string} [options.idempotencyKey] - An idempotency key.
+ *
+ * @returns A promise that resolves to the transaction result.
+ *
+ * @example
+ * ```ts
+ * const signature = await sendTransaction({
+ *   network: "solana-devnet",
+ *   transaction: "...",
+ * });
+ * ```
+ */
+export async function sendTransaction(
+  apiClient: CdpOpenApiClientType,
+  options: SendTransactionOptions,
+): Promise<TransactionResult> {
+  const signature = await apiClient.sendSolanaTransaction(
+    {
+      network: options.network,
+      transaction: options.transaction,
+    },
+    options.idempotencyKey,
+  );
+
+  return {
+    signature: signature.transactionSignature,
+  };
+}

package/actions/solana/transfer.ts

@@ -7,14 +7,13 @@ import {
 } from "@solana/spl-token";
 import {
   Connection,
-  MessageV0,
   PublicKey,
   SystemProgram,
-  TransactionInstruction,
-  TransactionMessage,
-  VersionedTransaction,
+  SYSVAR_RECENT_BLOCKHASHES_PUBKEY,
+  Transaction,
 } from "@solana/web3.js";
 
+import { sendTransaction } from "./sendTransaction.js";
 import {
   getConnectedNetwork,
   getOrCreateConnection,
@@ -61,11 +60,11 @@ export async function transfer(
   options: TransferOptions,
 ): Promise<SignatureResult> {
   const connection = getOrCreateConnection({ networkOrConnection: options.network });
+  const connectedNetwork = await getConnectedNetwork(connection);
 
   const tx =
     options.token === "sol"
       ? await getNativeTransfer({
-          connection,
           from: options.from,
           to: options.to,
           amount: options.amount,
@@ -75,41 +74,29 @@ export async function transfer(
           from: options.from,
           to: options.to,
           mintAddress:
-            options.token === "usdc"
-              ? getUsdcMintAddress(await getConnectedNetwork(connection))
-              : options.token,
+            options.token === "usdc" ? getUsdcMintAddress(connectedNetwork) : options.token,
           amount: options.amount,
         });
 
-  const serializedTx = Buffer.from(tx.serialize()).toString("base64");
+  const serializedTx = Buffer.from(tx.serialize({ requireAllSignatures: false })).toString(
+    "base64",
+  );
 
-  const signedTxResponse = await apiClient.signSolanaTransaction(options.from, {
+  const signature = await sendTransaction(apiClient, {
+    network: connectedNetwork === "mainnet" ? "solana" : "solana-devnet",
     transaction: serializedTx,
   });
 
-  const decodedSignedTx = Buffer.from(signedTxResponse.signedTransaction, "base64");
-
-  const signature = await connection.sendRawTransaction(decodedSignedTx, {
-    skipPreflight: false,
-    maxRetries: 3,
-  });
-
-  return { signature };
+  return signature;
 }
 
-type GetNativeTransferOptions = Omit<TransferOptions, "token" | "network"> & {
-  /**
-   * The connection to the Solana network
-   */
-  connection: Connection;
-};
+type GetNativeTransferOptions = Omit<TransferOptions, "token" | "network">;
 
 /**
- * Gets the instructions for a native SOL transfer
+ * Gets the transaction for a native SOL transfer
  *
  * @param options - The options for the native SOL transfer
  *
- * @param options.connection - The Solana connection
  * @param options.from - The source address
  * @param options.to - The destination address
  * @param options.amount - The amount to transfer
@@ -117,39 +104,37 @@ type GetNativeTransferOptions = Omit<TransferOptions, "token" | "network"> & {
  * @returns The native SOL transfer transaction
  */
 async function getNativeTransfer({
-  connection,
   from,
   to,
   amount,
-}: GetNativeTransferOptions): Promise<VersionedTransaction> {
-  const { blockhash } = await connection.getLatestBlockhash();
-
-  const instructions = [
+}: GetNativeTransferOptions): Promise<Transaction> {
+  const transaction = new Transaction();
+  transaction.add(
     SystemProgram.transfer({
       fromPubkey: new PublicKey(from),
       toPubkey: new PublicKey(to),
       lamports: amount,
     }),
-  ];
-
-  const messageV0 = new TransactionMessage({
-    payerKey: new PublicKey(from),
-    recentBlockhash: blockhash,
-    instructions,
-  }).compileToV0Message();
+  );
+  transaction.recentBlockhash = SYSVAR_RECENT_BLOCKHASHES_PUBKEY.toBase58();
+  transaction.feePayer = new PublicKey(from);
 
-  return new VersionedTransaction(messageV0);
+  return transaction;
 }
 
-type GetSplTransferOptions = GetNativeTransferOptions & {
+type GetSplTransferOptions = Omit<TransferOptions, "token" | "network"> & {
   /**
    * The mint address of the token
    */
   mintAddress: string;
+  /**
+   * The connection to the Solana network.
+   */
+  connection: Connection;
 };
 
 /**
- * Gets the instructions for a SPL token transfer
+ * Gets the transaction for a SPL token transfer
  *
  * @param options - The options for the SPL token transfer
  *
@@ -167,7 +152,7 @@ async function getSplTransfer({
   to,
   mintAddress,
   amount,
-}: GetSplTransferOptions): Promise<VersionedTransaction> {
+}: GetSplTransferOptions): Promise<Transaction> {
   const fromPubkey = new PublicKey(from);
   const toPubkey = new PublicKey(to);
   const mintPubkey = new PublicKey(mintAddress);
@@ -182,7 +167,7 @@ async function getSplTransfer({
   const sourceAta = await getAssociatedTokenAddress(mintPubkey, fromPubkey);
   const destinationAta = await getAssociatedTokenAddress(mintPubkey, toPubkey);
 
-  const instructions: TransactionInstruction[] = [];
+  const transaction = new Transaction();
 
   const sourceAccount = await getAccount(connection, sourceAta);
   if (sourceAccount.amount < amount) {
@@ -193,12 +178,12 @@ async function getSplTransfer({
   try {
     await getAccount(connection, destinationAta);
   } catch {
-    instructions.push(
+    transaction.add(
       createAssociatedTokenAccountInstruction(fromPubkey, destinationAta, toPubkey, mintPubkey),
     );
   }
 
-  instructions.push(
+  transaction.add(
     createTransferCheckedInstruction(
       sourceAta,
       mintPubkey,
@@ -208,12 +193,8 @@ async function getSplTransfer({
       mintInfo.decimals,
     ),
   );
+  transaction.recentBlockhash = SYSVAR_RECENT_BLOCKHASHES_PUBKEY.toBase58();
+  transaction.feePayer = new PublicKey(from);
 
-  return new VersionedTransaction(
-    MessageV0.compile({
-      payerKey: fromPubkey,
-      instructions: instructions,
-      recentBlockhash: (await connection.getLatestBlockhash()).blockhash,
-    }),
-  );
+  return transaction;
 }

package/actions/solana/utils.ts

@@ -2,13 +2,12 @@ import { Connection } from "@solana/web3.js";
 
 import {
   GENESIS_HASH_MAINNET,
-  GENESIS_HASH_TESTNET,
   GENESIS_HASH_DEVNET,
   USDC_MAINNET_MINT_ADDRESS,
   USDC_DEVNET_MINT_ADDRESS,
 } from "./constants.js";
 
-export type Network = "mainnet" | "devnet" | "testnet";
+export type Network = "mainnet" | "devnet";
 
 type GetOrCreateConnectionOptions = {
   networkOrConnection: Network | Connection;
@@ -33,9 +32,7 @@ export function getOrCreateConnection({
   return new Connection(
     networkOrConnection === "mainnet"
       ? "https://api.mainnet-beta.solana.com"
-      : networkOrConnection === "devnet"
-        ? "https://api.devnet.solana.com"
-        : "https://api.testnet.solana.com",
+      : "https://api.devnet.solana.com",
   );
 }
 
@@ -43,7 +40,7 @@ export function getOrCreateConnection({
  * Get the network of the connected Solana node
  *
  * @param connection - The connection to the Solana network
- * @throws {Error} If the network is not mainnet, devnet, or testnet
+ * @throws {Error} If the network is not mainnet or devnet
  *
  * @returns The network of the connected Solana node
  */
@@ -54,11 +51,9 @@ export async function getConnectedNetwork(connection: Connection): Promise<Netwo
     return "mainnet";
   } else if (genesisHash === GENESIS_HASH_DEVNET) {
     return "devnet";
-  } else if (genesisHash === GENESIS_HASH_TESTNET) {
-    return "testnet";
   }
 
-  throw new Error("Unknown network");
+  throw new Error("Unknown or unsupported network");
 }
 
 /**
@@ -71,9 +66,6 @@ export async function getConnectedNetwork(connection: Connection): Promise<Netwo
 export function getUsdcMintAddress(network: Network): string {
   if (network === "mainnet") {
     return USDC_MAINNET_MINT_ADDRESS;
-  } else if (network === "devnet") {
-    return USDC_DEVNET_MINT_ADDRESS;
-  } else {
-    throw new Error("Testnet is not supported for USDC");
   }
+  return USDC_DEVNET_MINT_ADDRESS;
 }

package/analytics.ts

@@ -1,6 +1,7 @@
 import md5 from "md5";
 
-import { APIError, HttpErrorType } from "./openapi-client/errors.js";
+import { UserInputValidationError } from "./errors.js";
+import { APIError, NetworkError } from "./openapi-client/errors.js";
 import { version } from "./version.js";
 
 /**
@@ -25,7 +26,29 @@ type ErrorEventData = {
   name: "error";
 };
 
-type EventData = ErrorEventData;
+/**
+ * The data in an action event
+ */
+type ActionEventData = {
+  /**
+   * The operation being performed, e.g. "transfer", "swap", "fund", "requestFaucet"
+   */
+  action: string;
+  /**
+   * The account type, e.g. "evm-server", "evm-smart", "solana"
+   */
+  accountType?: "evm_server" | "evm_smart" | "solana";
+  /**
+   * Additional properties specific to the action
+   */
+  properties?: Record<string, unknown>;
+  /**
+   * The name of the event
+   */
+  name: "action";
+};
+
+type EventData = ErrorEventData | ActionEventData;
 
 // This is a public client id for the analytics service
 const publicClientId = "54f2ee2fb3d2b901a829940d70fbfc13";
@@ -35,6 +58,7 @@ export const Analytics = {
   wrapClassWithErrorTracking,
   wrapObjectMethodsWithErrorTracking,
   sendEvent,
+  trackAction,
 };
 
 /**
@@ -44,7 +68,11 @@ export const Analytics = {
  * @returns Promise that resolves when the event is sent
  */
 async function sendEvent(event: EventData): Promise<void> {
-  if (process.env.DISABLE_CDP_ERROR_REPORTING === "true") {
+  if (event.name === "error" && process.env.DISABLE_CDP_ERROR_REPORTING === "true") {
+    return;
+  }
+
+  if (event.name !== "error" && process.env.DISABLE_CDP_USAGE_TRACKING === "true") {
     return;
   }
 
@@ -89,6 +117,39 @@ async function sendEvent(event: EventData): Promise<void> {
   });
 }
 
+/**
+ * Track an action being performed
+ *
+ * @param params - The parameters for tracking an action
+ * @param params.action - The action being performed
+ * @param params.accountType - The type of account
+ * @param params.properties - Additional properties
+ */
+function trackAction(params: {
+  action: string;
+  accountType?: "evm_server" | "evm_smart" | "solana";
+  properties?: Record<string, unknown>;
+}): void {
+  if (
+    params.properties?.network &&
+    typeof params.properties.network === "string" &&
+    params.properties.network.startsWith("http")
+  ) {
+    const url = new URL(params.properties.network);
+    params.properties.customRpcHost = url.hostname;
+    params.properties.network = "custom";
+  }
+
+  sendEvent({
+    action: params.action,
+    accountType: params.accountType,
+    properties: params.properties,
+    name: "action",
+  }).catch(() => {
+    // ignore error
+  });
+}
+
 /**
  * Wraps all methods of a class with error tracking.
  *
@@ -184,7 +245,15 @@ function shouldTrackError(error: unknown): boolean {
     return false;
   }
 
-  if (error instanceof APIError && error.errorType !== HttpErrorType.unexpected_error) {
+  if (error instanceof UserInputValidationError) {
+    return false;
+  }
+
+  if (error instanceof NetworkError) {
+    return true;
+  }
+
+  if (error instanceof APIError && error.errorType !== "unexpected_error") {
     return false;
   }
 

package/auth/utils/jwt.ts

@@ -2,6 +2,7 @@ import { SignJWT, importPKCS8, importJWK, JWTPayload } from "jose";
 import { getRandomValues } from "uncrypto";
 
 import { authHash } from "./hash.js";
+import { UserInputValidationError } from "../../errors.js";
 import { sortKeys } from "../../utils/sortKeys.js";
 import { InvalidWalletSecretFormatError, UndefinedWalletSecretError } from "../errors.js";
 
@@ -164,7 +165,9 @@ export async function generateJwt(options: JwtOptions): Promise<string> {
       randomNonce,
     );
   } else {
-    throw new Error("Invalid key format - must be either PEM EC key or base64 Ed25519 key");
+    throw new UserInputValidationError(
+      "Invalid key format - must be either PEM EC key or base64 Ed25519 key",
+    );
   }
 }
 
@@ -306,7 +309,7 @@ async function buildEdwardsJWT(
     // Decode the base64 key (expecting 64 bytes: 32 for seed + 32 for public key)
     const decoded = Buffer.from(privateKey, "base64");
     if (decoded.length !== 64) {
-      throw new Error("Invalid Ed25519 key length");
+      throw new UserInputValidationError("Invalid Ed25519 key length");
     }
 
     const seed = decoded.subarray(0, 32);

package/client/cdp.ts

@@ -121,8 +121,14 @@ For more information, see: https://github.com/coinbase/cdp-sdk/blob/main/typescr
       sourceVersion: version,
     });
 
-    if (process.env.DISABLE_CDP_ERROR_REPORTING !== "true") {
+    if (
+      process.env.DISABLE_CDP_ERROR_REPORTING !== "true" ||
+      process.env.DISABLE_CDP_USAGE_TRACKING !== "true"
+    ) {
       Analytics.identifier = apiKeyId;
+    }
+
+    if (process.env.DISABLE_CDP_ERROR_REPORTING !== "true") {
       Analytics.wrapClassWithErrorTracking(CdpClient);
       Analytics.wrapClassWithErrorTracking(EvmClient);
       Analytics.wrapClassWithErrorTracking(SolanaClient);