@coinbase/cdp-sdk 1.4.0 → 1.6.0

package/client/evm/evm.types.ts

@@ -1,19 +1,30 @@
-import {
+import type {
   EvmAccount as Account,
   EvmServerAccount as ServerAccount,
   EvmSmartAccount as SmartAccount,
 } from "../../accounts/types.js";
-import { SendUserOperationReturnType } from "../../actions/evm/sendUserOperation.js";
-import {
+import type {
+  ListTokenBalancesOptions,
+  ListTokenBalancesResult,
+} from "../../actions/evm/listTokenBalances.js";
+import type { RequestFaucetOptions, RequestFaucetResult } from "../../actions/evm/requestFaucet.js";
+import type {
+  TransactionResult,
+  SendTransactionOptions,
+} from "../../actions/evm/sendTransaction.js";
+import type {
+  SendUserOperationOptions,
+  SendUserOperationReturnType,
+} from "../../actions/evm/sendUserOperation.js";
+import type { Actions } from "../../actions/evm/types.js";
+import type {
   EvmUserOperationNetwork,
   EvmUserOperationStatus,
   OpenApiEvmMethods,
-  ListEvmTokenBalancesNetwork,
-  SendEvmTransactionBodyNetwork,
 } from "../../openapi-client/index.js";
-import { Call, Calls } from "../../types/calls.js";
-import { Address, Hex, TransactionRequestEIP1559 } from "../../types/misc.js";
-import { WaitOptions } from "../../utils/wait.js";
+import type { Calls } from "../../types/calls.js";
+import type { Address, Hex } from "../../types/misc.js";
+import type { WaitOptions } from "../../utils/wait.js";
 
 /**
  * The EvmClient type, where all OpenApiEvmMethods methods are wrapped.
@@ -41,6 +52,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>;
@@ -48,7 +60,9 @@ export type EvmClientInterface = Omit<
   prepareUserOperation: (options: PrepareUserOperationOptions) => Promise<UserOperation>;
   requestFaucet: (options: RequestFaucetOptions) => Promise<RequestFaucetResult>;
   sendTransaction: (options: SendTransactionOptions) => Promise<TransactionResult>;
-  sendUserOperation: (options: SendUserOperationOptions) => Promise<SendUserOperationReturnType>;
+  sendUserOperation: (
+    options: SendUserOperationOptions<unknown[]>,
+  ) => Promise<SendUserOperationReturnType>;
   signHash: (options: SignHashOptions) => Promise<SignatureResult>;
   signMessage: (options: SignMessageOptions) => Promise<SignatureResult>;
   signTransaction: (options: SignTransactionOptions) => Promise<SignatureResult>;
@@ -146,6 +160,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 +181,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[];
 }
@@ -212,67 +234,6 @@ export interface CreateSmartAccountOptions {
   idempotencyKey?: string;
 }
 
-/**
- * Options for requesting funds from an EVM faucet.
- */
-export interface RequestFaucetOptions {
-  /** The address of the account. */
-  address: string;
-  /** The network to request funds from. */
-  network: "base-sepolia" | "ethereum-sepolia";
-  /** The token to request funds for. */
-  token: "eth" | "usdc" | "eurc" | "cbbtc";
-  /** The idempotency key. */
-  idempotencyKey?: string;
-}
-
-/**
- * The result of requesting funds from an EVM faucet.
- */
-export interface RequestFaucetResult {
-  /** The transaction hash. */
-  transactionHash: Hex;
-}
-
-/**
- * Options for sending an EVM transaction.
- */
-export interface SendTransactionOptions {
-  /** The address of the account. */
-  address: Address;
-  /**
-   * The transaction to send. The chainId is ignored in favor of the `network` field.
-   *
-   * This can be either:
-   * - An RLP-encoded transaction to sign and send, as a 0x-prefixed hex string, or
-   * - An EIP-1559 transaction request object.
-   */
-  transaction: Hex | TransactionRequestEIP1559;
-  /**
-   * The network to send the transaction to.
-   * The chainId in the `transaction` field is ignored in favor of this field.
-   */
-  network: SendEvmTransactionBodyNetwork;
-  /** The idempotency key. */
-  idempotencyKey?: string;
-}
-
-/**
- * Options for sending a user operation.
- */
-export interface SendUserOperationOptions {
-  /** The smart account. */
-  smartAccount: SmartAccount;
-  /** The network. */
-  network: EvmUserOperationNetwork;
-  /** The calls. */
-  calls: Call[];
-  /** The paymaster URL. */
-  paymasterUrl?: string;
-  /** The idempotency key. */
-  idempotencyKey?: string;
-}
-
 /**
  * Options for signing an EVM hash.
  */
@@ -317,14 +278,6 @@ export interface SignatureResult {
   signature: Hex;
 }
 
-/**
- * Result of a transaction
- */
-export interface TransactionResult {
-  /** The hash of the transaction. */
-  transactionHash: Hex;
-}
-
 /**
  * Options for waiting for a user operation.
  */
@@ -336,73 +289,3 @@ export interface WaitForUserOperationOptions {
   /** The wait options. */
   waitOptions?: WaitOptions;
 }
-
-/**
- * Options for listing EVM token balances.
- */
-export interface ListTokenBalancesOptions {
-  /** The address of the account. */
-  address: Address;
-  /** The network. */
-  network: ListEvmTokenBalancesNetwork;
-  /** The page size to paginate through the token balances. */
-  pageSize?: number;
-  /** The page token to paginate through the token balances. */
-  pageToken?: string;
-}
-
-/**
- * A token on an EVM network, which is either an ERC-20 or a native token (i.e. ETH).
- */
-export interface EvmToken {
-  /**
-   * The contract address of the token. For Ether, the contract address is 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE
-   * per EIP-7528. For ERC-20 tokens, this is the contract address where the token is deployed.
-   */
-  contractAddress: Address;
-  /** The network the token is on. */
-  network: ListEvmTokenBalancesNetwork;
-  /**
-   * The symbol of the token, which is optional and non-unique. Note: This field
-   * may not be present for most tokens while the API is still under development.
-   */
-  symbol?: string;
-  /**
-   * The name of the token, which is optional and non-unique. Note: This field
-   * may not be present for most tokens while the API is still under development.
-   */
-  name?: string;
-}
-
-/**
- * A token amount on an EVM network.
- */
-export interface EvmTokenAmount {
-  /** The amount of the token in the smallest indivisible unit of the token. */
-  amount: bigint;
-  /** The number of decimals in the token. */
-  decimals: bigint;
-}
-
-/**
- * An EVM token balance.
- */
-export interface EvmTokenBalance {
-  /** The token. */
-  token: EvmToken;
-  /** The amount of the token. */
-  amount: EvmTokenAmount;
-}
-
-/**
- * The result of listing EVM token balances.
- */
-export interface ListTokenBalancesResult {
-  /** The token balances. */
-  balances: EvmTokenBalance[];
-  /**
-   * The next page token to paginate through the token balances.
-   * If undefined, there are no more token balances to paginate through.
-   */
-  nextPageToken?: string;
-}

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.4.0",
+  "version": "1.6.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.4.0";
+export const version = "1.6.0";