@coinbase/cdp-sdk 1.3.2 → 1.5.0

package/client/evm/evm.ts

@@ -27,6 +27,7 @@ import {
   ListTokenBalancesResult,
   SendTransactionOptions,
   TransactionResult,
+  GetOrCreateServerAccountOptions,
 } from "./evm.types.js";
 import { toEvmServerAccount } from "../../accounts/evm/toEvmServerAccount.js";
 import { toEvmSmartAccount } from "../../accounts/evm/toEvmSmartAccount.js";
@@ -38,6 +39,7 @@ import {
   waitForUserOperation,
   WaitForUserOperationReturnType,
 } from "../../actions/evm/waitForUserOperation.js";
+import { APIError } from "../../openapi-client/errors.js";
 import { CdpOpenApiClient } from "../../openapi-client/index.js";
 import { Hex } from "../../types/misc.js";
 
@@ -145,7 +147,7 @@ export class EvmClient implements EvmClientInterface {
       options.idempotencyKey,
     );
 
-    return toEvmSmartAccount({
+    return toEvmSmartAccount(CdpOpenApiClient, {
       smartAccount,
       owner: options.owner,
     });
@@ -216,12 +218,53 @@ export class EvmClient implements EvmClientInterface {
   async getSmartAccount(options: GetSmartAccountOptions): Promise<SmartAccount> {
     const smartAccount = await CdpOpenApiClient.getEvmSmartAccount(options.address);
 
-    return toEvmSmartAccount({
+    return toEvmSmartAccount(CdpOpenApiClient, {
       smartAccount,
       owner: options.owner,
     });
   }
 
+  /**
+   * Gets a CDP EVM account, or creates one if it doesn't exist.
+   *
+   * @param {GetOrCreateServerAccountOptions} options - Parameters for getting or creating the account.
+   * @param {string} [options.name] - The name of the account to get or create.
+   *
+   * @returns A promise that resolves to the account.
+   *
+   * @example
+   * ```ts
+   * const account = await cdp.evm.getOrCreateAccount({
+   *   name: "MyAccount",
+   * });
+   * ```
+   */
+  async getOrCreateAccount(options: GetOrCreateServerAccountOptions): Promise<ServerAccount> {
+    try {
+      const account = await this.getAccount(options);
+      return account;
+    } catch (error) {
+      // If it failed because the account doesn't exist, create it
+      const doesAccountNotExist = error instanceof APIError && error.statusCode === 404;
+      if (doesAccountNotExist) {
+        try {
+          const account = await this.createAccount(options);
+          return account;
+        } catch (error) {
+          // If it failed because the account already exists, throw an error
+          const doesAccountAlreadyExist = error instanceof APIError && error.statusCode === 409;
+          if (doesAccountAlreadyExist) {
+            const account = await this.getAccount(options);
+            return account;
+          }
+          throw error;
+        }
+      }
+
+      throw error;
+    }
+  }
+
   /**
    * Gets a user operation for a smart account by user operation hash.
    *

package/client/evm/evm.types.ts

@@ -4,6 +4,7 @@ import {
   EvmSmartAccount as SmartAccount,
 } from "../../accounts/types.js";
 import { SendUserOperationReturnType } from "../../actions/evm/sendUserOperation.js";
+import { Actions } from "../../actions/evm/types.js";
 import {
   EvmUserOperationNetwork,
   EvmUserOperationStatus,
@@ -41,6 +42,7 @@ export type EvmClientInterface = Omit<
   createSmartAccount: (options: CreateSmartAccountOptions) => Promise<SmartAccount>;
   getAccount: (options: GetServerAccountOptions) => Promise<ServerAccount>;
   getSmartAccount: (options: GetSmartAccountOptions) => Promise<SmartAccount>;
+  getOrCreateAccount: (options: GetOrCreateServerAccountOptions) => Promise<ServerAccount>;
   getUserOperation: (options: GetUserOperationOptions) => Promise<UserOperation>;
   listAccounts: (options: ListServerAccountsOptions) => Promise<ListServerAccountResult>;
   listSmartAccounts: (options: ListSmartAccountsOptions) => Promise<ListSmartAccountResult>;
@@ -146,6 +148,14 @@ export interface GetSmartAccountOptions {
   owner: Account;
 }
 
+/**
+ * Options for getting an EVM account, or creating one if it doesn't exist.
+ */
+export interface GetOrCreateServerAccountOptions {
+  /** The name of the account. */
+  name: string;
+}
+
 /**
  * Options for listing EVM accounts.
  */
@@ -159,7 +169,7 @@ export interface ListServerAccountsOptions {
 /**
  * A smart account that only contains the owner address.
  */
-export interface ReadonlySmartAccount extends Omit<SmartAccount, "owners"> {
+export interface ReadonlySmartAccount extends Omit<SmartAccount, "owners" | keyof Actions> {
   /** The owners of the smart account. */
   owners: Address[];
 }

package/client/solana/solana.ts

@@ -9,7 +9,9 @@ import {
   SignatureResult,
   SignMessageOptions,
   SignTransactionOptions,
+  GetOrCreateAccountOptions,
 } from "./solana.types.js";
+import { APIError } from "../../openapi-client/errors.js";
 import { CdpOpenApiClient } from "../../openapi-client/index.js";
 
 /**
@@ -87,6 +89,47 @@ export class SolanaClient implements SolanaClientInterface {
     throw new Error("Either address or name must be provided");
   }
 
+  /**
+   * Gets a Solana account by its address.
+   *
+   * @param {GetOrCreateAccountOptions} options - Parameters for getting or creating the Solana account.
+   * @param {string} options.name - The name of the account.
+   *
+   * @returns A promise that resolves to the account.
+   *
+   * @example
+   * ```ts
+   * const account = await cdp.solana.getOrCreateAccount({
+   *   name: "MyAccount",
+   * });
+   * ```
+   */
+  async getOrCreateAccount(options: GetOrCreateAccountOptions): Promise<Account> {
+    try {
+      const account = await this.getAccount(options);
+      return account;
+    } catch (error) {
+      // If it failed because the account doesn't exist, create it
+      const doesAccountNotExist = error instanceof APIError && error.statusCode === 404;
+      if (doesAccountNotExist) {
+        try {
+          const account = await this.createAccount(options);
+          return account;
+        } catch (error) {
+          // If it failed because the account already exists, throw an error
+          const doesAccountAlreadyExist = error instanceof APIError && error.statusCode === 409;
+          if (doesAccountAlreadyExist) {
+            const account = await this.getAccount(options);
+            return account;
+          }
+          throw error;
+        }
+      }
+
+      throw error;
+    }
+  }
+
   /**
    * Lists all Solana accounts.
    *

package/client/solana/solana.types.ts

@@ -17,6 +17,7 @@ export type SolanaClientInterface = Omit<
 > & {
   createAccount: (options: CreateAccountOptions) => Promise<Account>;
   getAccount: (options: GetAccountOptions) => Promise<Account>;
+  getOrCreateAccount: (options: GetOrCreateAccountOptions) => Promise<Account>;
   listAccounts: (options: ListAccountsOptions) => Promise<ListAccountsResult>;
   requestFaucet: (options: RequestFaucetOptions) => Promise<SignatureResult>;
   signMessage: (options: SignMessageOptions) => Promise<SignatureResult>;
@@ -47,6 +48,14 @@ export interface GetAccountOptions {
   name?: string;
 }
 
+/**
+ * Options for getting a Solana account.
+ */
+export interface GetOrCreateAccountOptions {
+  /** The name of the account. */
+  name: string;
+}
+
 /**
  * Options for listing Solana accounts.
  */

package/package.json

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

package/utils/serializeTransaction.ts

@@ -0,0 +1,17 @@
+import { serializeTransaction } from "viem";
+
+import { TransactionRequestEIP1559 } from "../types/misc.js";
+
+/**
+ * Serializes a transaction for the Coinbase API.
+ *
+ * @param transaction - The transaction to serialize.
+ * @returns The serialized transaction.
+ */
+export function serializeEIP1559Transaction(transaction: TransactionRequestEIP1559) {
+  return serializeTransaction({
+    ...transaction,
+    chainId: 1, // ignored by Coinbase API
+    type: "eip1559",
+  });
+}

package/version.ts

@@ -1 +1 @@
-export const version = "1.3.2";
+export const version = "1.5.0";