@coinbase/cdp-sdk 1.5.0 → 1.7.0

package/client/evm/evm.types.ts

@@ -1,20 +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 { Actions } from "../../actions/evm/types.js";
-import {
+} from "../../accounts/evm/types.js";
+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 { SmartAccountActions } 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.
@@ -50,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>;
@@ -169,7 +181,8 @@ export interface ListServerAccountsOptions {
 /**
  * A smart account that only contains the owner address.
  */
-export interface ReadonlySmartAccount extends Omit<SmartAccount, "owners" | keyof Actions> {
+export interface ReadonlySmartAccount
+  extends Omit<SmartAccount, "owners" | keyof SmartAccountActions> {
   /** The owners of the smart account. */
   owners: Address[];
 }
@@ -222,67 +235,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.
  */
@@ -327,14 +279,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.
  */
@@ -346,73 +290,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

@@ -1,16 +1,20 @@
 import {
-  SolanaClientInterface,
-  Account,
   CreateAccountOptions,
   GetAccountOptions,
+  GetOrCreateAccountOptions,
   ListAccountsOptions,
-  RequestFaucetOptions,
   ListAccountsResult,
+  RequestFaucetOptions,
   SignatureResult,
   SignMessageOptions,
   SignTransactionOptions,
-  GetOrCreateAccountOptions,
+  SolanaClientInterface,
 } from "./solana.types.js";
+import { toSolanaAccount } from "../../accounts/solana/toSolanaAccount.js";
+import { SolanaAccount } from "../../accounts/solana/types.js";
+import { requestFaucet } from "../../actions/solana/requestFaucet.js";
+import { signMessage } from "../../actions/solana/signMessage.js";
+import { signTransaction } from "../../actions/solana/signTransaction.js";
 import { APIError } from "../../openapi-client/errors.js";
 import { CdpOpenApiClient } from "../../openapi-client/index.js";
 
@@ -48,8 +52,12 @@ export class SolanaClient implements SolanaClientInterface {
    *          await cdp.solana.createAccount({ idempotencyKey });
    *          ```
    */
-  async createAccount(options: CreateAccountOptions = {}): Promise<Account> {
-    return CdpOpenApiClient.createSolanaAccount(options, options.idempotencyKey);
+  async createAccount(options: CreateAccountOptions = {}): Promise<SolanaAccount> {
+    const account = await CdpOpenApiClient.createSolanaAccount(options, options.idempotencyKey);
+
+    return toSolanaAccount(CdpOpenApiClient, {
+      account,
+    });
   }
 
   /**
@@ -77,13 +85,19 @@ export class SolanaClient implements SolanaClientInterface {
    *          });
    *          ```
    */
-  async getAccount(options: GetAccountOptions): Promise<Account> {
+  async getAccount(options: GetAccountOptions): Promise<SolanaAccount> {
     if (options.address) {
-      return CdpOpenApiClient.getSolanaAccount(options.address);
+      const account = await CdpOpenApiClient.getSolanaAccount(options.address);
+      return toSolanaAccount(CdpOpenApiClient, {
+        account,
+      });
     }
 
     if (options.name) {
-      return CdpOpenApiClient.getSolanaAccountByName(options.name);
+      const account = await CdpOpenApiClient.getSolanaAccountByName(options.name);
+      return toSolanaAccount(CdpOpenApiClient, {
+        account,
+      });
     }
 
     throw new Error("Either address or name must be provided");
@@ -104,7 +118,7 @@ export class SolanaClient implements SolanaClientInterface {
    * });
    * ```
    */
-  async getOrCreateAccount(options: GetOrCreateAccountOptions): Promise<Account> {
+  async getOrCreateAccount(options: GetOrCreateAccountOptions): Promise<SolanaAccount> {
     try {
       const account = await this.getAccount(options);
       return account;
@@ -165,7 +179,11 @@ export class SolanaClient implements SolanaClientInterface {
     });
 
     return {
-      accounts: solAccounts.accounts,
+      accounts: solAccounts.accounts.map(account =>
+        toSolanaAccount(CdpOpenApiClient, {
+          account,
+        }),
+      ),
       nextPageToken: solAccounts.nextPageToken,
     };
   }
@@ -189,14 +207,7 @@ export class SolanaClient implements SolanaClientInterface {
    *          ```
    */
   async requestFaucet(options: RequestFaucetOptions): Promise<SignatureResult> {
-    const signature = await CdpOpenApiClient.requestSolanaFaucet(
-      { address: options.address, token: options.token },
-      options.idempotencyKey,
-    );
-
-    return {
-      signature: signature.transactionSignature,
-    };
+    return requestFaucet(CdpOpenApiClient, options);
   }
 
   /**
@@ -222,13 +233,7 @@ export class SolanaClient implements SolanaClientInterface {
    * ```
    */
   async signMessage(options: SignMessageOptions): Promise<SignatureResult> {
-    return CdpOpenApiClient.signSolanaMessage(
-      options.address,
-      {
-        message: options.message,
-      },
-      options.idempotencyKey,
-    );
+    return signMessage(CdpOpenApiClient, options);
   }
 
   /**
@@ -265,16 +270,6 @@ export class SolanaClient implements SolanaClientInterface {
    * ```
    */
   async signTransaction(options: SignTransactionOptions): Promise<SignatureResult> {
-    const signature = await CdpOpenApiClient.signSolanaTransaction(
-      options.address,
-      {
-        transaction: options.transaction,
-      },
-      options.idempotencyKey,
-    );
-
-    return {
-      signature: signature.signedTransaction,
-    };
+    return signTransaction(CdpOpenApiClient, options);
   }
 }

package/client/solana/solana.types.ts

@@ -1,7 +1,6 @@
-import {
-  OpenApiSolanaMethods,
-  SolanaAccount as OpenAPISolanaAccount,
-} from "../../openapi-client/index.js";
+import { Account, SolanaAccount } from "../../accounts/solana/types.js";
+import { OpenApiSolanaMethods } from "../../openapi-client/index.js";
+
 /**
  * The SolanaClient type, where all OpenApiSolanaMethods methods are wrapped.
  */
@@ -23,10 +22,14 @@ export type SolanaClientInterface = Omit<
   signMessage: (options: SignMessageOptions) => Promise<SignatureResult>;
   signTransaction: (options: SignTransactionOptions) => Promise<SignatureResult>;
 };
+
 /**
- * A Solana account.
+ * A Solana signature result.
  */
-export type Account = OpenAPISolanaAccount;
+export interface SignatureResult {
+  /** The signature. */
+  signature: string;
+}
 
 /**
  * Options for creating a Solana account.
@@ -71,7 +74,7 @@ export interface ListAccountsOptions {
  */
 export interface ListAccountsResult {
   /** The accounts. */
-  accounts: Account[];
+  accounts: SolanaAccount[];
   /**
    * The token for the next page of accounts, if any.
    */
@@ -113,11 +116,3 @@ export interface SignTransactionOptions {
   /** The idempotency key. */
   idempotencyKey?: string;
 }
-
-/**
- * A Solana signature result.
- */
-export interface SignatureResult {
-  /** The signature. */
-  signature: string;
-}

package/index.ts

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