@coinbase/cdp-sdk 1.32.0 → 1.34.0

package/actions/evm/listSpendPermissions.ts

@@ -1,5 +1,25 @@
-import type { ListSpendPermissionsOptions } from "../../client/evm/evm.types.js";
-import type { CdpOpenApiClient, ListSpendPermissionsResult } from "../../openapi-client/index.js";
+import type {
+  CdpOpenApiClient,
+  ListResponse,
+  SpendPermissionResponseObject as SpendPermissionResponseObjectApi,
+} from "../../openapi-client/index.js";
+import type {
+  ListSpendPermissionsOptions,
+  SpendPermission,
+} from "../../spend-permissions/types.js";
+import type { Address, Hex } from "../../types/misc.js";
+
+export type SpendPermissionResponseObject = Omit<
+  SpendPermissionResponseObjectApi,
+  "permission" | "permissionHash"
+> & {
+  permissionHash: Hex;
+  permission: SpendPermission;
+};
+
+export type ListSpendPermissionsResult = ListResponse & {
+  spendPermissions: SpendPermissionResponseObject[];
+};
 
 /**
  * Lists the spend permissions for a smart account.
@@ -13,8 +33,27 @@ export async function listSpendPermissions(
   client: typeof CdpOpenApiClient,
   options: ListSpendPermissionsOptions,
 ): Promise<ListSpendPermissionsResult> {
-  return await client.listSpendPermissions(options.address, {
+  const result = await client.listSpendPermissions(options.address, {
     pageSize: options.pageSize,
     pageToken: options.pageToken,
   });
+
+  return {
+    spendPermissions: result.spendPermissions.map(permission => ({
+      ...permission,
+      permissionHash: permission.permissionHash as Hex,
+      permission: {
+        ...permission.permission,
+        account: permission.permission.account as Address,
+        spender: permission.permission.spender as Address,
+        token: permission.permission.token as Address,
+        allowance: BigInt(permission.permission.allowance),
+        period: Number(permission.permission.period),
+        start: Number(permission.permission.start),
+        end: Number(permission.permission.end),
+        salt: BigInt(permission.permission.salt),
+        extraData: permission.permission.extraData as Hex,
+      },
+    })),
+  };
 }

package/actions/evm/spend-permissions/resolveSpendPermission.ts

@@ -0,0 +1,85 @@
+import { UserInputValidationError } from "../../../errors.js";
+import { resolveTokenAddress } from "../../../spend-permissions/utils.js";
+
+import type { SpendPermissionNetwork } from "../../../openapi-client/index.js";
+import type { SpendPermission, SpendPermissionInput } from "../../../spend-permissions/types.js";
+
+/**
+ * Generate a random salt using crypto.getRandomValues().
+ *
+ * @returns A random bigint salt.
+ */
+function generateRandomSalt(): bigint {
+  const randomBytes = new Uint8Array(32);
+  crypto.getRandomValues(randomBytes);
+
+  // Convert bytes to bigint
+  let result = 0n;
+  for (let i = 0; i < randomBytes.length; i++) {
+    result = (result << 8n) + BigInt(randomBytes[i]);
+  }
+
+  return result;
+}
+
+/**
+ * Resolve a spend permission input to a spend permission.
+ *
+ * @param spendPermissionInput - The spend permission input to resolve.
+ * @param network - The network to resolve the spend permission for.
+ *
+ * @returns The resolved spend permission.
+ */
+export function resolveSpendPermission(
+  spendPermissionInput: SpendPermissionInput,
+  network: SpendPermissionNetwork,
+): SpendPermission {
+  // Validate that either period or periodInDays is provided, but not both
+  if (
+    spendPermissionInput.period !== undefined &&
+    spendPermissionInput.periodInDays !== undefined
+  ) {
+    throw new UserInputValidationError(
+      "Cannot specify both 'period' and 'periodInDays'. Please provide only one.",
+    );
+  }
+
+  if (
+    spendPermissionInput.period === undefined &&
+    spendPermissionInput.periodInDays === undefined
+  ) {
+    throw new UserInputValidationError(
+      "Must specify either 'period' (in seconds) or 'periodInDays'.",
+    );
+  }
+
+  // Convert periodInDays to period in seconds if provided
+  const period = spendPermissionInput.period ?? spendPermissionInput.periodInDays! * 24 * 60 * 60;
+
+  // Set defaults for start and end
+  const now = new Date();
+  const startDate = spendPermissionInput.start ?? now;
+
+  /*
+   * For end date default, we need to handle the max uint48 value carefully
+   * JavaScript Date max is around year 275760, but uint48 max (281474976710655) is much larger
+   * So we'll use the max uint48 value directly for end if no end date is provided
+   */
+  const endDate = spendPermissionInput.end;
+
+  // Convert Date objects to seconds since epoch for the contract
+  const start = Math.floor(startDate.getTime() / 1000);
+  const end = endDate ? Math.floor(endDate.getTime() / 1000) : 281474976710655; // Max uint48 value (never expires)
+
+  const { periodInDays: _periodInDays, ...inputWithoutPeriodInDays } = spendPermissionInput;
+
+  return {
+    ...inputWithoutPeriodInDays,
+    token: resolveTokenAddress(spendPermissionInput.token, network),
+    period,
+    start,
+    end,
+    salt: spendPermissionInput.salt ?? generateRandomSalt(),
+    extraData: spendPermissionInput.extraData ?? "0x",
+  };
+}

package/actions/evm/spend-permissions/types.ts

@@ -1,4 +1,5 @@
-import type { SpendPermission, SpendPermissionNetworks } from "../../../spend-permissions/types.js";
+import type { SpendPermissionNetwork } from "../../../openapi-client/index.js";
+import type { SpendPermission } from "../../../spend-permissions/types.js";
 
 /**
  * Options for using a spend permission
@@ -9,5 +10,5 @@ export type UseSpendPermissionOptions = {
   /** The amount to spend (must be <= allowance) */
   value: bigint;
   /** The network to execute the transaction on */
-  network: SpendPermissionNetworks;
+  network: SpendPermissionNetwork;
 };

package/actions/evm/types.ts

@@ -356,8 +356,6 @@ export type AccountActions = Actions & {
   swap: (options: AccountSwapOptions) => Promise<AccountSwapResult>;
 
   /**
-   * @deprecated Experimental! This method name will change, and is subject to other breaking changes.
-   *
    * Uses a spend permission to execute a transaction.
    * This allows the account to spend tokens that have been approved via a spend permission.
    *
@@ -384,16 +382,14 @@ export type AccountActions = Actions & {
    *   extraData: "0x",
    * };
    *
-   * const result = await account.__experimental_useSpendPermission({
+   * const result = await account.useSpendPermission({
    *   spendPermission,
    *   value: parseEther("0.001"), // Spend 0.001 ETH
    *   network: "base-sepolia",
    * });
    * ```
    */
-  __experimental_useSpendPermission: (
-    options: UseSpendPermissionOptions,
-  ) => Promise<TransactionResult>;
+  useSpendPermission: (options: UseSpendPermissionOptions) => Promise<TransactionResult>;
 };
 
 export type SmartAccountActions = Actions & {
@@ -683,8 +679,6 @@ export type SmartAccountActions = Actions & {
   ) => Promise<Hex>;
 
   /**
-   * @deprecated Experimental! This method name will change, and is subject to other breaking changes.
-   *
    * Uses a spend permission to execute a transaction via user operation.
    * This allows the smart account to spend tokens that have been approved via a spend permission.
    *
@@ -711,14 +705,12 @@ export type SmartAccountActions = Actions & {
    *   extraData: "0x",
    * };
    *
-   * const result = await smartAccount.__experimental_useSpendPermission({
+   * const result = await smartAccount.useSpendPermission({
    *   spendPermission,
    *   value: parseEther("0.001"), // Spend 0.001 ETH
    *   network: "base-sepolia",
    * });
    * ```
    */
-  __experimental_useSpendPermission: (
-    options: UseSpendPermissionOptions,
-  ) => Promise<SendUserOperationReturnType>;
+  useSpendPermission: (options: UseSpendPermissionOptions) => Promise<SendUserOperationReturnType>;
 };

package/client/evm/evm.ts

@@ -5,8 +5,6 @@ import { type Address, getTypesForEIP712Domain } from "viem";
 import {
   CreateServerAccountOptions,
   CreateSmartAccountOptions,
-  CreateSpendPermissionOptions,
-  RevokeSpendPermissionOptions,
   CreateSwapQuoteOptions,
   CreateSwapQuoteResult,
   EvmClientInterface,
@@ -23,7 +21,6 @@ import {
   ListServerAccountsOptions,
   ListSmartAccountResult,
   ListSmartAccountsOptions,
-  ListSpendPermissionsOptions,
   PrepareUserOperationOptions,
   ServerAccount,
   SignatureResult,
@@ -41,7 +38,10 @@ import {
 import { toEvmServerAccount } from "../../accounts/evm/toEvmServerAccount.js";
 import { toEvmSmartAccount } from "../../accounts/evm/toEvmSmartAccount.js";
 import { getUserOperation } from "../../actions/evm/getUserOperation.js";
-import { listSpendPermissions } from "../../actions/evm/listSpendPermissions.js";
+import {
+  listSpendPermissions,
+  ListSpendPermissionsResult,
+} from "../../actions/evm/listSpendPermissions.js";
 import {
   listTokenBalances,
   ListTokenBalancesOptions,
@@ -58,6 +58,7 @@ import {
   SendUserOperationOptions,
   SendUserOperationReturnType,
 } from "../../actions/evm/sendUserOperation.js";
+import { resolveSpendPermission } from "../../actions/evm/spend-permissions/resolveSpendPermission.js";
 import { createSwapQuote } from "../../actions/evm/swap/createSwapQuote.js";
 import { getSwapPrice } from "../../actions/evm/swap/getSwapPrice.js";
 import {
@@ -70,7 +71,6 @@ import { UserInputValidationError } from "../../errors.js";
 import { APIError } from "../../openapi-client/errors.js";
 import {
   CdpOpenApiClient,
-  ListSpendPermissionsResult,
   EIP712Message as OpenAPIEIP712Message,
 } from "../../openapi-client/index.js";
 import { SPEND_PERMISSION_MANAGER_ADDRESS } from "../../spend-permissions/constants.js";
@@ -81,6 +81,11 @@ import type {
   SendTransactionOptions,
   TransactionResult,
 } from "../../actions/evm/sendTransaction.js";
+import type {
+  CreateSpendPermissionOptions,
+  ListSpendPermissionsOptions,
+  RevokeSpendPermissionOptions,
+} from "../../spend-permissions/types.js";
 
 /**
  * The namespace containing all EVM methods.
@@ -358,18 +363,22 @@ export class EvmClient implements EvmClientInterface {
       action: "create_spend_permission",
     });
 
+    const resolvedSpendPermission = resolveSpendPermission(
+      options.spendPermission,
+      options.network,
+    );
+
     const userOperation = await CdpOpenApiClient.createSpendPermission(
-      options.spendPermission.account,
+      resolvedSpendPermission.account,
       {
-        account: options.spendPermission.account,
-        spender: options.spendPermission.spender,
-        token: options.spendPermission.token,
-        allowance: options.spendPermission.allowance.toString(),
-        period: options.spendPermission.period.toString(),
-        start: options.spendPermission.start.toString(),
-        end: options.spendPermission.end.toString(),
-        salt: options.spendPermission.salt.toString(),
-        extraData: options.spendPermission.extraData,
+        spender: resolvedSpendPermission.spender,
+        token: resolvedSpendPermission.token,
+        allowance: resolvedSpendPermission.allowance.toString(),
+        period: resolvedSpendPermission.period.toString(),
+        start: resolvedSpendPermission.start.toString(),
+        end: resolvedSpendPermission.end.toString(),
+        salt: resolvedSpendPermission.salt.toString(),
+        extraData: resolvedSpendPermission.extraData,
         network: options.network,
         paymasterUrl: options.paymasterUrl,
       },
@@ -1436,7 +1445,7 @@ export class EvmClient implements EvmClientInterface {
   ): Promise<SmartAccount> {
     const owners = [options.owner.address];
 
-    if (options.__experimental_enableSpendPermission) {
+    if (options.enableSpendPermissions) {
       owners.push(SPEND_PERMISSION_MANAGER_ADDRESS);
     }
 

package/client/evm/evm.types.ts

@@ -1,10 +1,9 @@
-import { SpendPermission } from "../../spend-permissions/types.js";
-
 import type {
   EvmAccount as Account,
   EvmServerAccount as ServerAccount,
   EvmSmartAccount as SmartAccount,
 } from "../../accounts/evm/types.js";
+import type { ListSpendPermissionsResult } from "../../actions/evm/listSpendPermissions.js";
 import type {
   ListTokenBalancesOptions,
   ListTokenBalancesResult,
@@ -23,12 +22,12 @@ import type {
   EvmSwapsNetwork,
   EvmUserOperationNetwork,
   EvmUserOperationStatus,
-  ListSpendPermissionsResult,
   OpenApiEvmMethods,
   UpdateEvmAccountBody as UpdateEvmAccount,
   UpdateEvmSmartAccountBody as UpdateEvmSmartAccount,
   UserOperationReceipt,
 } from "../../openapi-client/index.js";
+import type { ListSpendPermissionsOptions } from "../../spend-permissions/types.js";
 import type { Calls } from "../../types/calls.js";
 import type { Address, EIP712Message, Hex } from "../../types/misc.js";
 import type { WaitOptions } from "../../utils/wait.js";
@@ -266,39 +265,6 @@ export interface CreateSwapQuoteResult {
   execute: (options?: ExecuteSwapQuoteOptions) => Promise<ExecuteSwapQuoteResult>;
 }
 
-export interface CreateSpendPermissionOptions {
-  /** The spend permission. */
-  spendPermission: SpendPermission;
-  /** The network. */
-  network: EvmUserOperationNetwork;
-  /** The paymaster URL. */
-  paymasterUrl?: string;
-  /** The idempotency key. */
-  idempotencyKey?: string;
-}
-
-export interface ListSpendPermissionsOptions {
-  /** The address of the smart account. */
-  address: Address;
-  /** The page size to paginate through the spend permissions. */
-  pageSize?: number;
-  /** The page token to paginate through the spend permissions. */
-  pageToken?: string;
-}
-
-export interface RevokeSpendPermissionOptions {
-  /** The address of the smart account. */
-  address: Address;
-  /** The hash of the spend permission to revoke. */
-  permissionHash: Hex;
-  /** The network. */
-  network: EvmUserOperationNetwork;
-  /** The paymaster URL. */
-  paymasterUrl?: string;
-  /** The idempotency key. */
-  idempotencyKey?: string;
-}
-
 /**
  * Options for getting a user operation.
  */
@@ -439,12 +405,8 @@ export interface GetOrCreateSmartAccountOptions {
   name: string;
   /** The owner of the account. */
   owner: Account;
-  /**
-   * @deprecated Experimental! This method name will change, and is subject to other breaking changes.
-   *
-   * The flag to enable spend permission.
-   */
-  __experimental_enableSpendPermission?: boolean;
+  /** The flag to enable spend permissions. */
+  enableSpendPermissions?: boolean;
 }
 
 /**
@@ -540,12 +502,8 @@ export interface CreateSmartAccountOptions {
   idempotencyKey?: string;
   /** The name of the account. */
   name?: string;
-  /**
-   * @deprecated Experimental! This method name will change, and is subject to other breaking changes.
-   *
-   * The flag to enable spend permission.
-   */
-  __experimental_enableSpendPermission?: boolean;
+  /** The flag to enable spend permissions. */
+  enableSpendPermissions?: boolean;
 }
 
 /**

package/index.ts

@@ -8,7 +8,8 @@ export {
   type UpdatePolicyBody,
 } from "./policies/types.js";
 export { NetworkError } from "./openapi-client/errors.js";
-export type { SpendPermission } from "./spend-permissions/types.js";
+export type { SpendPermission, SpendPermissionInput } from "./spend-permissions/types.js";
+export type { SpendPermissionNetwork } from "./openapi-client/index.js";
 export {
   SPEND_PERMISSION_MANAGER_ABI as spendPermissionManagerAbi,
   SPEND_PERMISSION_MANAGER_ADDRESS as spendPermissionManagerAddress,