@coinbase/cdp-sdk 1.6.0 → 1.7.0

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";

package/openapi-client/generated/coinbaseDeveloperPlatformAPIs.schemas.ts

@@ -33,6 +33,7 @@ export type ErrorType = (typeof ErrorType)[keyof typeof ErrorType];
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const ErrorType = {
   already_exists: "already_exists",
+  bad_gateway: "bad_gateway",
   faucet_limit_exceeded: "faucet_limit_exceeded",
   forbidden: "forbidden",
   idempotency_error: "idempotency_error",
@@ -43,9 +44,11 @@ export const ErrorType = {
   not_found: "not_found",
   rate_limit_exceeded: "rate_limit_exceeded",
   request_canceled: "request_canceled",
+  service_unavailable: "service_unavailable",
   timed_out: "timed_out",
   unauthorized: "unauthorized",
   policy_violation: "policy_violation",
+  policy_in_use: "policy_in_use",
 } as const;
 
 /**
@@ -197,6 +200,201 @@ export interface TokenBalance {
   token: Token;
 }
 
+/**
+ * The type of criterion to use. This should be `ethValue`.
+ */
+export type EthValueCriterionType =
+  (typeof EthValueCriterionType)[keyof typeof EthValueCriterionType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const EthValueCriterionType = {
+  ethValue: "ethValue",
+} as const;
+
+/**
+ * The operator to use for the comparison. The transaction's `value` field will be on the left-hand side of the operator, and the `ethValue` field will be on the right-hand side.
+ */
+export type EthValueCriterionOperator =
+  (typeof EthValueCriterionOperator)[keyof typeof EthValueCriterionOperator];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const EthValueCriterionOperator = {
+  ">": ">",
+  ">=": ">=",
+  "<": "<",
+  "<=": "<=",
+  "==": "==",
+} as const;
+
+/**
+ * A schema for specifying a criterion for the `value` field of an EVM transaction.
+ */
+export interface EthValueCriterion {
+  /** The type of criterion to use. This should be `ethValue`. */
+  type: EthValueCriterionType;
+  /**
+   * The amount of ETH, in wei, that the transaction's `value` field should be compared to.
+   * @pattern ^[0-9]+$
+   */
+  ethValue: string;
+  /** The operator to use for the comparison. The transaction's `value` field will be on the left-hand side of the operator, and the `ethValue` field will be on the right-hand side. */
+  operator: EthValueCriterionOperator;
+}
+
+/**
+ * The type of criterion to use. This should be `evmAddress`.
+ */
+export type EvmAddressCriterionType =
+  (typeof EvmAddressCriterionType)[keyof typeof EvmAddressCriterionType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const EvmAddressCriterionType = {
+  evmAddress: "evmAddress",
+} as const;
+
+/**
+ * The operator to use for the comparison. The transaction's `to` field will be on the left-hand side of the operator, and the `addresses` field will be on the right-hand side.
+ */
+export type EvmAddressCriterionOperator =
+  (typeof EvmAddressCriterionOperator)[keyof typeof EvmAddressCriterionOperator];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const EvmAddressCriterionOperator = {
+  in: "in",
+  not_in: "not in",
+} as const;
+
+/**
+ * A schema for specifying a criterion for the `to` field of an EVM transaction.
+ */
+export interface EvmAddressCriterion {
+  /** The type of criterion to use. This should be `evmAddress`. */
+  type: EvmAddressCriterionType;
+  /** A list of 0x-prefixed EVM addresses that the transaction's `to` field should be compared to. There is a limit of 100 addresses per criterion. */
+  addresses: string[];
+  /** The operator to use for the comparison. The transaction's `to` field will be on the left-hand side of the operator, and the `addresses` field will be on the right-hand side. */
+  operator: EvmAddressCriterionOperator;
+}
+
+export type SignEvmTransactionCriteriaItem = EthValueCriterion | EvmAddressCriterion;
+
+/**
+ * A schema for specifying the rejection criteria for the SignEvmTransaction operation.
+ */
+export type SignEvmTransactionCriteria = SignEvmTransactionCriteriaItem[];
+
+/**
+ * The type of criterion to use. This should be `solAddress`.
+ */
+export type SolAddressCriterionType =
+  (typeof SolAddressCriterionType)[keyof typeof SolAddressCriterionType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const SolAddressCriterionType = {
+  solAddress: "solAddress",
+} as const;
+
+/**
+ * The operator to use for the comparison. Each of the addresses in the transaction's `accountKeys` (for legacy transactions) or `staticAccountKeys` (for V0 transactions) array will be on the left-hand side of the operator, and the addresses field will be on the right-hand side.
+ */
+export type SolAddressCriterionOperator =
+  (typeof SolAddressCriterionOperator)[keyof typeof SolAddressCriterionOperator];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const SolAddressCriterionOperator = {
+  in: "in",
+  not_in: "not in",
+} as const;
+
+/**
+ * The criterion for the recipient addresses of a Solana transaction.
+ */
+export interface SolAddressCriterion {
+  /** The type of criterion to use. This should be `solAddress`. */
+  type: SolAddressCriterionType;
+  /** The Solana addresses that are compared to the list of addresses in the transaction's `accountKeys` (for legacy transactions) or `staticAccountKeys` (for V0 transactions) array. */
+  addresses: string[];
+  /** The operator to use for the comparison. Each of the addresses in the transaction's `accountKeys` (for legacy transactions) or `staticAccountKeys` (for V0 transactions) array will be on the left-hand side of the operator, and the addresses field will be on the right-hand side. */
+  operator: SolAddressCriterionOperator;
+}
+
+/**
+ * A schema for specifying the rejection criteria for the SignSolTransaction operation.
+ */
+export type SignSolTransactionCriteria = SolAddressCriterion[];
+
+/**
+ * Whether matching the rule will cause the request to be rejected or accepted.
+ */
+export type RuleAction = (typeof RuleAction)[keyof typeof RuleAction];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const RuleAction = {
+  reject: "reject",
+  accept: "accept",
+} as const;
+
+/**
+ * The operation to which the rule applies. Every element of the `criteria` array must match the specified operation.
+ */
+export type RuleOperation = (typeof RuleOperation)[keyof typeof RuleOperation];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const RuleOperation = {
+  signEvmTransaction: "signEvmTransaction",
+  signSolTransaction: "signSolTransaction",
+} as const;
+
+/**
+ * The set of criteria for the rule. There is a limit of 10 criteria per rule.
+ */
+export type RuleCriteria = SignEvmTransactionCriteria | SignSolTransactionCriteria;
+
+/**
+ * A rule that limits the behavior of an account.
+ */
+export interface Rule {
+  /** Whether matching the rule will cause the request to be rejected or accepted. */
+  action: RuleAction;
+  /** The operation to which the rule applies. Every element of the `criteria` array must match the specified operation. */
+  operation: RuleOperation;
+  /** The set of criteria for the rule. There is a limit of 10 criteria per rule. */
+  criteria: RuleCriteria;
+}
+
+/**
+ * The scope of the policy. Only one project-level policy can exist at any time.
+ */
+export type PolicyScope = (typeof PolicyScope)[keyof typeof PolicyScope];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const PolicyScope = {
+  project: "project",
+  account: "account",
+} as const;
+
+export interface Policy {
+  /**
+   * The unique identifier for the policy.
+   * @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+   */
+  id: string;
+  /**
+   * An optional human-readable description of the policy. 
+Policy descriptions can consist of alphanumeric characters, spaces, commas, and periods, and be 50 characters or less.
+   * @pattern ^[A-Za-z0-9 ,.]{1,50}$
+   */
+  description?: string;
+  /** The scope of the policy. Only one project-level policy can exist at any time. */
+  scope: PolicyScope;
+  /** A list of rules that comprise the policy. */
+  rules: Rule[];
+  /** The ISO 8601 timestamp at which the Policy was created. */
+  createdAt: string;
+  /** The ISO 8601 timestamp at which the Policy was last updated. */
+  updatedAt: string;
+}
+
 export interface SolanaAccount {
   /**
    * The base58 encoded Solana address.
@@ -217,6 +415,16 @@ Account names are guaranteed to be unique across all Solana accounts in the deve
  */
 export type InternalServerErrorResponse = Error;
 
+/**
+ * Bad gateway.
+ */
+export type BadGatewayErrorResponse = Error;
+
+/**
+ * Service unavailable.
+ */
+export type ServiceUnavailableErrorResponse = Error;
+
 /**
  * Idempotency key conflict.
  */
@@ -436,6 +644,72 @@ export type RequestEvmFaucet200 = {
   transactionHash: string;
 };
 
+export type ListPoliciesParams = {
+  /**
+   * The number of policies to return per page.
+   */
+  pageSize?: number;
+  /**
+   * The token for the next page of policies, if any.
+   */
+  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?: ListPoliciesScope;
+};
+
+export type ListPoliciesScope = (typeof ListPoliciesScope)[keyof typeof ListPoliciesScope];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ListPoliciesScope = {
+  project: "project",
+  account: "account",
+} as const;
+
+export type ListPolicies200AllOf = {
+  /** The list of policies. */
+  policies: Policy[];
+};
+
+export type ListPolicies200 = ListPolicies200AllOf & ListResponse;
+
+/**
+ * The scope of the policy.
+ */
+export type CreatePolicyBodyScope =
+  (typeof CreatePolicyBodyScope)[keyof typeof CreatePolicyBodyScope];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const CreatePolicyBodyScope = {
+  project: "project",
+  account: "account",
+} as const;
+
+export type CreatePolicyBody = {
+  /** The scope of the policy. */
+  scope: CreatePolicyBodyScope;
+  /**
+   * An optional human-readable description for the policy.
+Policy descriptions can consist of alphanumeric characters, spaces, commas, and periods, and be 50 characters or less.
+   * @pattern ^[A-Za-z0-9 ,.]{1,50}$
+   */
+  description?: string;
+  /** A list of rules that comprise the policy. There is a limit of 10 rules per policy. */
+  rules: Rule[];
+};
+
+export type UpdatePolicyBody = {
+  /**
+   * An optional human-readable description for the policy.
+Policy descriptions can consist of alphanumeric characters, spaces, commas, and periods, and be 50 characters or less.
+   * @pattern ^[A-Za-z0-9 ,.]{1,50}$
+   */
+  description?: string;
+  /** A list of rules that comprise the policy. There is a limit of 10 rules per policy. */
+  rules: Rule[];
+};
+
 export type ListSolanaAccountsParams = {
   /**
    * The number of accounts to return per page.

package/openapi-client/generated/index.msw.ts

@@ -1,5 +1,6 @@
-export * from "./evm-accounts/evm-accounts.msw.js";
 export * from "./faucets/faucets.msw.js";
-export * from "./evm-smart-accounts/evm-smart-accounts.msw.js";
+export * from "./evm-accounts/evm-accounts.msw.js";
 export * from "./evm-token-balances/evm-token-balances.msw.js";
+export * from "./evm-smart-accounts/evm-smart-accounts.msw.js";
+export * from "./policy-engine/policy-engine.msw.js";
 export * from "./solana-accounts/solana-accounts.msw.js";