@coinbase/cdp-sdk 1.36.0 → 1.37.0

package/openapi-client/generated/onramp/onramp.ts

@@ -8,6 +8,8 @@
 import type {
   CreateOnrampOrder201,
   CreateOnrampOrderBody,
+  CreateOnrampSession201,
+  CreateOnrampSessionBody,
   GetOnrampOrderById200,
 } from "../coinbaseDeveloperPlatformAPIs.schemas.js";
 
@@ -50,5 +52,41 @@ export const getOnrampOrderById = (
     options,
   );
 };
+/**
+ * Returns a single-use URL for an Onramp session. This API provides flexible  functionality based on the parameters provided, supporting three cases:
+
+**Important**: The returned URL is single-use only. Once a user visits the URL,  no one else can access it.
+## Use Cases
+### 1. Basic Session (Minimum Parameters)
+**Required**: `destinationAddress`, `purchaseCurrency`, `destinationNetwork`
+
+**Returns**: Basic single-use onramp URL. The `quote` object will not be included in the response.
+### 2. One-Click Onramp URL
+**Required**: Basic parameters + `paymentAmount`, `paymentCurrency`
+
+**Returns**: One-click onramp URL for streamlined checkout. The `quote` object will not be included in the response.
+### 3. One-Click Onramp URL with Quote
+**Required**: One-Click Onramp parameters + `paymentMethod`, `country`, `subdivision`
+
+**Returns**: Complete pricing quote and one-click onramp URL. Both `session` and `quote` objects will be included in the response.
+ * @summary Create an onramp session
+ */
+export const createOnrampSession = (
+  createOnrampSessionBody: CreateOnrampSessionBody,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<CreateOnrampSession201>(
+    {
+      url: `/v2/onramp/sessions`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: createOnrampSessionBody,
+    },
+    options,
+  );
+};
 export type CreateOnrampOrderResult = NonNullable<Awaited<ReturnType<typeof createOnrampOrder>>>;
 export type GetOnrampOrderByIdResult = NonNullable<Awaited<ReturnType<typeof getOnrampOrderById>>>;
+export type CreateOnrampSessionResult = NonNullable<
+  Awaited<ReturnType<typeof createOnrampSession>>
+>;

package/openapi-client/generated/sql-api-alpha/sql-api-alpha.ts

@@ -0,0 +1,60 @@
+/**
+ * Generated by orval v7.6.0 🍺
+ * Do not edit manually.
+ * Coinbase Developer Platform APIs
+ * The Coinbase Developer Platform APIs - leading the world's transition onchain.
+ * OpenAPI spec version: 2.0.0
+ */
+import type {
+  OnchainDataQuery,
+  OnchainDataResult,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+import { cdpApiClient } from "../../cdpApiClient.js";
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+/**
+ * Run a read-only SQL query against indexed blockchain data including transactions, events, and decoded logs.
+
+This endpoint provides direct SQL access to comprehensive blockchain data across supported networks.
+Queries are executed against optimized data structures for high-performance analytics.
+
+### Allowed Queries
+
+  - Standard SQL syntax (ClickHouse dialect)
+  - Read-only queries (SELECT statements)
+  - No DDL or DML operations
+  - No cartesian products
+
+### Supported Tables
+
+  - `base.events` - Base mainnet decoded event logs with parameters, event signature, topics, and more.
+  - `base.transactions` - Base mainnet transaction data including hash, block number, gas usage.
+  - `base.blocks` - Base mainnet block information.
+  - `base.encoded_logs` - Encoded log data of event logs that aren't able to be decoded by our event decoder (ex: log0 opcode).
+  - `base.transfers` - All event logs with event signature `Transfer(address,address,uint256)`. ERC-20, ERC-721, and ERC-1155 transfers are all included.
+
+### Query Limits
+
+  - Maximum result set: 10,000 rows
+  - Query timeout: 30 seconds
+  - Maximum JOINs: 5
+
+ * @summary Run SQL Query
+ */
+export const runSQLQuery = (
+  onchainDataQuery: OnchainDataQuery,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<OnchainDataResult>(
+    {
+      url: `/v2/data/query/run`,
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      data: onchainDataQuery,
+    },
+    options,
+  );
+};
+export type RunSQLQueryResult = NonNullable<Awaited<ReturnType<typeof runSQLQuery>>>;

package/openapi-client/index.ts

@@ -12,6 +12,7 @@ export * from "./generated/onramp/onramp.js";
 export * from "./generated/onchain-data/onchain-data.js";
 export * from "./generated/end-user-accounts/end-user-accounts.js";
 export * from "./generated/x402-facilitator/x402-facilitator.js";
+export * from "./generated/sql-api-alpha/sql-api-alpha.js";
 
 import { configure } from "./cdpApiClient.js";
 import * as endUserAccounts from "./generated/end-user-accounts/end-user-accounts.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coinbase/cdp-sdk",
-  "version": "1.36.0",
+  "version": "1.37.0",
   "description": "SDK for interacting with the Coinbase Developer Platform Wallet API",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",

package/policies/solanaSchema.ts

@@ -60,6 +60,35 @@ export const MintAddressOperatorEnum = z.enum(["in", "not in"]);
  */
 export type MintAddressOperator = z.infer<typeof MintAddressOperatorEnum>;
 
+/**
+ * Enum for ProgramIdOperator values
+ */
+export const ProgramIdOperatorEnum = z.enum(["in", "not in"]);
+/**
+ * Type representing the operators that can be used for program ID comparisons.
+ * These operators determine how transaction program IDs are evaluated against a list.
+ */
+export type ProgramIdOperator = z.infer<typeof ProgramIdOperatorEnum>;
+
+/**
+ * Enum for SolNetworkOperator values
+ */
+export const SolNetworkOperatorEnum = z.enum(["in", "not in"]);
+/**
+ * Type representing the operators that can be used for Solana network comparisons.
+ * These operators determine how transaction networks are evaluated against a list.
+ */
+export type SolNetworkOperator = z.infer<typeof SolNetworkOperatorEnum>;
+
+/**
+ * Enum for supported Solana networks
+ */
+export const SolNetworkEnum = z.enum(["solana-devnet", "solana"]);
+/**
+ * Type representing the supported Solana networks.
+ */
+export type SolNetwork = z.infer<typeof SolNetworkEnum>;
+
 /**
  * Enum for KnownIdlType values
  */
@@ -250,6 +279,58 @@ export const SolDataCriterionSchema = z.object({
 });
 export type SolDataCriterion = z.infer<typeof SolDataCriterionSchema>;
 
+/**
+ * Schema for program ID criterions
+ */
+export const ProgramIdCriterionSchema = z.object({
+  /** The type of criterion, must be "programId" for program ID-based rules. */
+  type: z.literal("programId"),
+  /**
+   * Array of Solana program IDs to compare against.
+   * Each program ID must be a valid Base58-encoded Solana address (32-44 characters).
+   */
+  programIds: z.array(z.string().regex(/^[1-9A-HJ-NP-Za-km-z]{32,44}$/)),
+  /**
+   * The operator to use for evaluating transaction program IDs.
+   * "in" checks if a program ID is in the provided list.
+   * "not in" checks if a program ID is not in the provided list.
+   */
+  operator: ProgramIdOperatorEnum,
+});
+export type ProgramIdCriterion = z.infer<typeof ProgramIdCriterionSchema>;
+
+/**
+ * Schema for Solana network criterions
+ */
+export const SolNetworkCriterionSchema = z.object({
+  /** The type of criterion, must be "solNetwork" for network-based rules. */
+  type: z.literal("solNetwork"),
+  /**
+   * Array of Solana networks to compare against.
+   */
+  networks: z.array(SolNetworkEnum),
+  /**
+   * The operator to use for evaluating transaction network.
+   * "in" checks if the network is in the provided list.
+   * "not in" checks if the network is not in the provided list.
+   */
+  operator: SolNetworkOperatorEnum,
+});
+export type SolNetworkCriterion = z.infer<typeof SolNetworkCriterionSchema>;
+
+/**
+ * Schema for Solana message criterions
+ */
+export const SolMessageCriterionSchema = z.object({
+  /** The type of criterion, must be "solMessage" for message-based rules. */
+  type: z.literal("solMessage"),
+  /**
+   * A regular expression pattern to match against the message.
+   */
+  match: z.string(),
+});
+export type SolMessageCriterion = z.infer<typeof SolMessageCriterionSchema>;
+
 /**
  * Schema for criteria used in SignSolTransaction operations
  */
@@ -262,13 +343,14 @@ export const SignSolTransactionCriteriaSchema = z
       SplValueCriterionSchema,
       MintAddressCriterionSchema,
       SolDataCriterionSchema,
+      ProgramIdCriterionSchema,
     ]),
   )
   .max(10)
   .min(1);
 /**
  * Type representing a set of criteria for the signSolTransaction operation.
- * Can contain up to 10 individual criterion objects for Solana addresses, SOL values, SPL addresses, SPL values, and mint addresses.
+ * Can contain up to 10 individual criterion objects for Solana addresses, SOL values, SPL addresses, SPL values, mint addresses, Solana data, and program IDs.
  */
 export type SignSolTransactionCriteria = z.infer<typeof SignSolTransactionCriteriaSchema>;
 
@@ -284,20 +366,26 @@ export const SendSolTransactionCriteriaSchema = z
       SplValueCriterionSchema,
       MintAddressCriterionSchema,
       SolDataCriterionSchema,
+      ProgramIdCriterionSchema,
+      SolNetworkCriterionSchema,
     ]),
   )
   .max(10)
   .min(1);
 /**
  * Type representing a set of criteria for the sendSolTransaction operation.
- * Can contain up to 10 individual criterion objects for Solana addresses, SOL values, SPL addresses, SPL values, and mint addresses.
+ * Can contain up to 10 individual criterion objects for Solana addresses, SOL values, SPL addresses, SPL values, mint addresses, Solana data, program IDs, and network restrictions.
  */
 export type SendSolTransactionCriteria = z.infer<typeof SendSolTransactionCriteriaSchema>;
 
 /**
  * Enum for Solana Operation types
  */
-export const SolOperationEnum = z.enum(["signSolTransaction", "sendSolTransaction"]);
+export const SolOperationEnum = z.enum([
+  "signSolTransaction",
+  "sendSolTransaction",
+  "signSolMessage",
+]);
 /**
  * Type representing the operations that can be governed by a policy.
  * Defines what Solana operations the policy applies to.
@@ -349,3 +437,36 @@ export const SendSolTransactionRuleSchema = z.object({
   criteria: SendSolTransactionCriteriaSchema,
 });
 export type SendSolTransactionRule = z.infer<typeof SendSolTransactionRuleSchema>;
+
+/**
+ * Schema for criteria used in SignSolMessage operations
+ */
+export const SignSolMessageCriteriaSchema = z.array(SolMessageCriterionSchema).max(10).min(1);
+/**
+ * Type representing a set of criteria for the signSolMessage operation.
+ * Can contain up to 10 individual criterion objects for Solana message matching.
+ */
+export type SignSolMessageCriteria = z.infer<typeof SignSolMessageCriteriaSchema>;
+
+/**
+ * Type representing a 'signSolMessage' policy rule that can accept or reject specific operations
+ * based on a set of criteria.
+ */
+export const SignSolMessageRuleSchema = z.object({
+  /**
+   * Determines whether matching the rule will cause a request to be rejected or accepted.
+   * "accept" will allow the message signing, "reject" will block it.
+   */
+  action: ActionEnum,
+  /**
+   * The operation to which this rule applies.
+   * Must be "signSolMessage".
+   */
+  operation: z.literal("signSolMessage"),
+  /**
+   * The set of criteria that must be matched for this rule to apply.
+   * Must be compatible with the specified operation type.
+   */
+  criteria: SignSolMessageCriteriaSchema,
+});
+export type SignSolMessageRule = z.infer<typeof SignSolMessageRuleSchema>;

package/policies/types.ts

@@ -9,7 +9,11 @@ import {
   SignEvmTypedDataRuleSchema,
   SendUserOperationRuleSchema,
 } from "./evmSchema.js";
-import { SendSolTransactionRuleSchema, SignSolTransactionRuleSchema } from "./solanaSchema.js";
+import {
+  SendSolTransactionRuleSchema,
+  SignSolTransactionRuleSchema,
+  SignSolMessageRuleSchema,
+} from "./solanaSchema.js";
 
 /**
  * A single Policy that can be used to govern the behavior of projects and accounts.
@@ -50,6 +54,7 @@ export const RuleSchema = z.discriminatedUnion("operation", [
   SendEvmTransactionRuleSchema,
   SignSolTransactionRuleSchema,
   SendSolTransactionRuleSchema,
+  SignSolMessageRuleSchema,
   PrepareUserOperationRuleSchema,
   SendUserOperationRuleSchema,
 ]);

package/version.ts

@@ -1 +1 @@
-export const version = "1.36.0";
+export const version = "1.37.0";