@coinbase/cdp-sdk 1.6.0 → 1.8.0

package/client/policies/policies.types.ts

@@ -0,0 +1,109 @@
+import { OpenApiPoliciesMethods } from "../../openapi-client/index.js";
+import { CreatePolicyBody, PolicyScope, UpdatePolicyBody } from "../../policies/schema.js";
+import { Policy } from "../../policies/types.js";
+
+/**
+ * The PoliciesClient type, where all OpenApiPoliciesMethods methods are wrapped.
+ */
+export type PoliciesClientInterface = Omit<
+  typeof OpenApiPoliciesMethods,
+  | "createPolicy" // mapped to createPolicy
+  | "listPolicies" // mapped to listPolicies
+  | "getPolicyById" // mapped to getPolicyById
+  | "deletePolicy" // mapped to deletePolicy
+  | "updatePolicy" // mapped to updatePolicy
+> & {
+  listPolicies: (options: ListPoliciesOptions) => Promise<ListPoliciesResult>;
+  createPolicy: (options: CreatePolicyOptions) => Promise<Policy>;
+  getPolicyById: (options: GetPolicyByIdOptions) => Promise<Policy>;
+  deletePolicy: (options: DeletePolicyOptions) => Promise<void>;
+  updatePolicy: (options: UpdatePolicyOptions) => Promise<Policy>;
+};
+
+export interface ListPoliciesOptions {
+  /** The page size to paginate through the accounts. */
+  pageSize?: number;
+  /** The page token to paginate through the accounts. */
+  pageToken?: string;
+  /**
+   * The scope of the policies to return. If `project`, the response will include exactly one policy, which is the project-level policy. If `account`, the response will include all account-level policies for the developer's CDP Project.
+   */
+  scope?: PolicyScope;
+}
+
+/**
+ * The result of listing policies.
+ */
+export interface ListPoliciesResult {
+  /** The list of policies matching the query parameters. */
+  policies: Policy[];
+  /**
+   * The next page token to paginate through the policies.
+   * If undefined, there are no more policies to paginate through.
+   */
+  nextPageToken?: string;
+}
+
+/**
+ * Options for creating a Policy.
+ */
+export interface CreatePolicyOptions {
+  /**
+   * The idempotency key to ensure the request is processed exactly once.
+   * Used to safely retry requests without accidentally performing the same operation twice.
+   */
+  idempotencyKey?: string;
+  /**
+   * The policy definition to create.
+   * Contains the scope, description, and rules for the policy.
+   */
+  policy: CreatePolicyBody;
+}
+
+/**
+ * Options for retrieving a Policy by ID.
+ */
+export interface GetPolicyByIdOptions {
+  /**
+   * The unique identifier of the policy to retrieve.
+   * This is a UUID that's generated when the policy is created.
+   */
+  id: string;
+}
+
+/**
+ * Options for deleting a Policy.
+ */
+export interface DeletePolicyOptions {
+  /**
+   * The unique identifier of the policy to delete.
+   * This is a UUID that's generated when the policy is created.
+   */
+  id: string;
+  /**
+   * The idempotency key to ensure the request is processed exactly once.
+   * Used to safely retry requests without accidentally performing the same operation twice.
+   */
+  idempotencyKey?: string;
+}
+
+/**
+ * Options for updating a Policy.
+ */
+export interface UpdatePolicyOptions {
+  /**
+   * The unique identifier of the policy to update.
+   * This is a UUID that's generated when the policy is created.
+   */
+  id: string;
+  /**
+   * The updated policy definition.
+   * Contains the description and rules for the policy.
+   */
+  policy: UpdatePolicyBody;
+  /**
+   * The idempotency key to ensure the request is processed exactly once.
+   * Used to safely retry requests without accidentally performing the same operation twice.
+   */
+  idempotencyKey?: string;
+}

package/client/solana/solana.ts

@@ -1,16 +1,22 @@
 import {
-  SolanaClientInterface,
-  Account,
   CreateAccountOptions,
   GetAccountOptions,
+  GetOrCreateAccountOptions,
   ListAccountsOptions,
-  RequestFaucetOptions,
   ListAccountsResult,
+  RequestFaucetOptions,
   SignatureResult,
   SignMessageOptions,
   SignTransactionOptions,
-  GetOrCreateAccountOptions,
+  SolanaClientInterface,
+  UpdateSolanaAccountOptions,
 } 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 { Analytics } from "../../analytics.js";
 import { APIError } from "../../openapi-client/errors.js";
 import { CdpOpenApiClient } from "../../openapi-client/index.js";
 
@@ -48,8 +54,19 @@ 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 openApiAccount = await CdpOpenApiClient.createSolanaAccount(
+      options,
+      options.idempotencyKey,
+    );
+
+    const account = toSolanaAccount(CdpOpenApiClient, {
+      account: openApiAccount,
+    });
+
+    Analytics.wrapObjectMethodsWithErrorTracking(account);
+
+    return account;
   }
 
   /**
@@ -77,16 +94,26 @@ export class SolanaClient implements SolanaClientInterface {
    *          });
    *          ```
    */
-  async getAccount(options: GetAccountOptions): Promise<Account> {
-    if (options.address) {
-      return CdpOpenApiClient.getSolanaAccount(options.address);
-    }
+  async getAccount(options: GetAccountOptions): Promise<SolanaAccount> {
+    const openApiAccount = await (() => {
+      if (options.address) {
+        return CdpOpenApiClient.getSolanaAccount(options.address);
+      }
 
-    if (options.name) {
-      return CdpOpenApiClient.getSolanaAccountByName(options.name);
-    }
+      if (options.name) {
+        return CdpOpenApiClient.getSolanaAccountByName(options.name);
+      }
+
+      throw new Error("Either address or name must be provided");
+    })();
+
+    const account = toSolanaAccount(CdpOpenApiClient, {
+      account: openApiAccount,
+    });
 
-    throw new Error("Either address or name must be provided");
+    Analytics.wrapObjectMethodsWithErrorTracking(account);
+
+    return account;
   }
 
   /**
@@ -104,7 +131,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 +192,15 @@ export class SolanaClient implements SolanaClientInterface {
     });
 
     return {
-      accounts: solAccounts.accounts,
+      accounts: solAccounts.accounts.map(account => {
+        const solanaAccount = toSolanaAccount(CdpOpenApiClient, {
+          account,
+        });
+
+        Analytics.wrapObjectMethodsWithErrorTracking(solanaAccount);
+
+        return solanaAccount;
+      }),
       nextPageToken: solAccounts.nextPageToken,
     };
   }
@@ -189,14 +224,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 +250,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 +287,63 @@ export class SolanaClient implements SolanaClientInterface {
    * ```
    */
   async signTransaction(options: SignTransactionOptions): Promise<SignatureResult> {
-    const signature = await CdpOpenApiClient.signSolanaTransaction(
+    return signTransaction(CdpOpenApiClient, options);
+  }
+
+  /**
+   * Updates a CDP Solana account.
+   *
+   * @param {UpdateSolanaAccountOptions} [options] - Optional parameters for creating the account.
+   * @param {string} options.address - The address of the account to update
+   * @param {UpdateSolanaAccountBody} options.update - An object containing account fields to update.
+   * @param {string} [options.update.name] - The new name for the account.
+   * @param {string} [options.update.accountPolicy] - The ID of a Policy to apply to the account.
+   * @param {string} [options.idempotencyKey] - An idempotency key.
+   *
+   * @returns A promise that resolves to the updated account.
+   *
+   * @example **With a name**
+   *          ```ts
+   *          const account = await cdp.sol.updateAccount({ address: "...", update: { name: "New Name" } });
+   *          ```
+   *
+   * @example **With an account policy**
+   *          ```ts
+   *          const account = await cdp.sol.updateAccount({ address: "...", update: { accountPolicy: "73bcaeeb-d7af-4615-b064-42b5fe83a31e" } });
+   *          ```
+   *
+   * @example **With an idempotency key**
+   *          ```ts
+   *          const idempotencyKey = uuidv4();
+   *
+   *          // First call
+   *          await cdp.sol.updateAccount({
+   *            address: "0x...",
+   *            update: { accountPolicy: "73bcaeeb-d7af-4615-b064-42b5fe83a31e" },
+   *            idempotencyKey,
+   *          });
+   *
+   *          // Second call with the same idempotency key will not update
+   *          await cdp.sol.updateAccount({
+   *            address: '0x...',
+   *            update: { name: "" },
+   *            idempotencyKey,
+   *          });
+   *          ```
+   */
+  async updateAccount(options: UpdateSolanaAccountOptions): Promise<SolanaAccount> {
+    const openApiAccount = await CdpOpenApiClient.updateSolanaAccount(
       options.address,
-      {
-        transaction: options.transaction,
-      },
+      options.update,
       options.idempotencyKey,
     );
 
-    return {
-      signature: signature.signedTransaction,
-    };
+    const account = toSolanaAccount(CdpOpenApiClient, {
+      account: openApiAccount,
+    });
+
+    Analytics.wrapObjectMethodsWithErrorTracking(account);
+
+    return account;
   }
 }

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, UpdateSolanaAccountBody } from "../../openapi-client/index.js";
+
 /**
  * The SolanaClient type, where all OpenApiSolanaMethods methods are wrapped.
  */
@@ -10,23 +9,30 @@ export type SolanaClientInterface = Omit<
   | "createSolanaAccount" // mapped to createAccount
   | "getSolanaAccount" // mapped to getAccount
   | "getSolanaAccountByName" // mapped to getAccount
+  | "updateSolanaAccount" // mapped to updateAccount
   | "listSolanaAccounts" // mapped to listAccounts
   | "requestSolanaFaucet" // mapped to requestFaucet
   | "signSolanaMessage" // mapped to signMessage
   | "signSolanaTransaction" // mapped to signTransaction
+  | "updateSolanaAccount" // mapped to updateAccount
 > & {
   createAccount: (options: CreateAccountOptions) => Promise<Account>;
   getAccount: (options: GetAccountOptions) => Promise<Account>;
   getOrCreateAccount: (options: GetOrCreateAccountOptions) => Promise<Account>;
+  updateAccount: (options: UpdateSolanaAccountOptions) => Promise<Account>;
   listAccounts: (options: ListAccountsOptions) => Promise<ListAccountsResult>;
   requestFaucet: (options: RequestFaucetOptions) => Promise<SignatureResult>;
   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.
@@ -56,6 +62,18 @@ export interface GetOrCreateAccountOptions {
   name: string;
 }
 
+/**
+ * Options for creating a SOL server account.
+ */
+export interface UpdateSolanaAccountOptions {
+  /** The address of the account. */
+  address: string;
+  /** The updates to apply to the account */
+  update: UpdateSolanaAccountBody;
+  /** The idempotency key. */
+  idempotencyKey?: string;
+}
+
 /**
  * Options for listing Solana accounts.
  */
@@ -71,7 +89,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 +131,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,9 @@
 export { CdpClient } from "./client/cdp.js";
-export type { EvmServerAccount, EvmSmartAccount } from "./accounts/types.js";
+export type { EvmServerAccount, EvmSmartAccount } from "./accounts/evm/types.js";
+export type { Policy } from "./policies/types.js";
+export {
+  CreatePolicyBodySchema,
+  UpdatePolicyBodySchema,
+  type CreatePolicyBody,
+  type UpdatePolicyBody,
+} from "./policies/schema.js";