@coinbase/cdp-sdk 1.15.0 → 1.17.0

package/policies/schema.ts

@@ -1,4 +1,4 @@
-import { Address } from "abitype/zod";
+import { Abi, Address } from "abitype/zod";
 import { z } from "zod";
 
 /**
@@ -121,6 +121,90 @@ export const EvmMessageCriterionSchema = z.object({
 });
 export type EvmMessageCriterion = z.infer<typeof EvmMessageCriterionSchema>;
 
+/**
+ * A list of comparables to apply against encoded arguments in the transaction's `data` field.
+ */
+export const EvmDataParameterConditionListSchema = z.object({
+  /**
+   * The name of the parameter to check against a transaction's calldata.
+   * If name is unknown, or is not named, you may supply an array index, e.g., `0` for first parameter.
+   */
+  name: z.union([z.string().min(1), z.string().regex(/^\d+$/)]),
+  /**
+   * The operator to use for the comparison. The value resolved at the `name` will be on the
+   * left-hand side of the operator, and the `values` field will be on the right-hand side.
+   */
+  operator: z.enum(["in", "not in"]),
+  /**
+   * Values to compare against the resolved `name` value.
+   * All values are encoded as strings. Refer to the table in the documentation for how values
+   * should be encoded, and which operators are supported for each type.
+   */
+  values: z.array(z.string()),
+});
+export type EvmDataParameterConditionList = z.infer<typeof EvmDataParameterConditionListSchema>;
+
+/**
+ * A single condition to apply against encoded arguments in the transaction's `data` field.
+ */
+export const EvmDataParameterConditionSchema = z.object({
+  /**
+   * The name of the parameter to check against a transaction's calldata.
+   * If name is unknown, or is not named, you may supply an array index, e.g., `0` for first parameter.
+   */
+  name: z.union([z.string().min(1), z.string().regex(/^\d+$/)]),
+  /**
+   * The operator to use for the comparison. The value resolved at the `name` will be on the
+   * left-hand side of the operator, and the `value` field will be on the right-hand side.
+   */
+  operator: EthValueOperatorEnum,
+  /**
+   * A single value to compare the value resolved at `name` to.
+   * All values are encoded as strings. Refer to the table in the documentation for how values
+   * should be encoded, and which operators are supported for each type.
+   */
+  value: z.string(),
+});
+export type EvmDataParameterCondition = z.infer<typeof EvmDataParameterConditionSchema>;
+
+/**
+ * A single condition to apply against the function and encoded arguments in the transaction's `data` field.
+ * Each `parameter` configuration must be successfully evaluated against the corresponding function argument
+ * in order for a policy to be accepted.
+ */
+export const EvmDataConditionSchema = z.object({
+  /**
+   * The name of a smart contract function being called.
+   */
+  function: z.string().min(1),
+  /**
+   * An optional list of parameter conditions to apply against encoded arguments in the transaction's `data` field.
+   */
+  params: z
+    .array(z.union([EvmDataParameterConditionSchema, EvmDataParameterConditionListSchema]))
+    .min(1)
+    .optional(),
+});
+export type EvmDataCondition = z.infer<typeof EvmDataConditionSchema>;
+
+/**
+ * Schema for EVM data criterion
+ */
+export const EvmDataCriterionSchema = z.object({
+  /** The type of criterion, must be "evmData" for EVM transaction rules. */
+  type: z.literal("evmData"),
+  /**
+   * The ABI of the smart contract being called. This can be a partial structure with only specific functions.
+   */
+  abi: z.union([z.enum(["erc20", "erc721", "erc1155"]), Abi]),
+  /**
+   * A list of conditions to apply against the function and encoded arguments in the transaction's `data` field.
+   * Each condition must be met in order for this policy to be accepted or rejected.
+   */
+  conditions: z.array(EvmDataConditionSchema).min(1),
+});
+export type EvmDataCriterion = z.infer<typeof EvmDataCriterionSchema>;
+
 /**
  * Schema for Solana address criterions
  */
@@ -145,7 +229,13 @@ export type SolAddressCriterion = z.infer<typeof SolAddressCriterionSchema>;
  * Schema for criteria used in SignEvmTransaction operations
  */
 export const SignEvmTransactionCriteriaSchema = z
-  .array(z.discriminatedUnion("type", [EthValueCriterionSchema, EvmAddressCriterionSchema]))
+  .array(
+    z.discriminatedUnion("type", [
+      EthValueCriterionSchema,
+      EvmAddressCriterionSchema,
+      EvmDataCriterionSchema,
+    ]),
+  )
   .max(10)
   .min(1);
 /**
@@ -176,15 +266,13 @@ export const SendEvmTransactionCriteriaSchema = z
       EthValueCriterionSchema,
       EvmAddressCriterionSchema,
       EvmNetworkCriterionSchema,
+      EvmDataCriterionSchema,
     ]),
   )
   .max(10)
   .min(1);
 
-/**
- * Type representing a set of criteria for the sendEvmTransaction operation.
- * Can contain up to 10 individual criterion objects of ETH value or EVM address types.
- */
+// Type representing a set of criteria for the sendEvmTransaction operation. Can contain up to 10 individual criterion objects of ETH value or EVM address types.
 export type SendEvmTransactionCriteria = z.infer<typeof SendEvmTransactionCriteriaSchema>;
 
 /**

package/utils/uuidV4.ts

@@ -0,0 +1,23 @@
+import { createHash } from "crypto";
+
+/**
+ * Deterministically generates a UUIDv4 from a given input string.
+ * This is necessary when we need to generate downstream idempotency keys for operations that have multiple calls.
+ *
+ * @param input - The input string to derive from
+ * @param salt - Optional salt to append to the input (defaults to "salt")
+ * @returns A UUIDv4 formatted string
+ */
+export function createDeterministicUuidV4(input: string, salt = "salt"): string {
+  const hash = createHash("sha256")
+    .update(input + "-" + salt)
+    .digest("hex");
+  // Format as UUIDv4: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+  return [
+    hash.slice(0, 8),
+    hash.slice(8, 12),
+    "4" + hash.slice(13, 16), // Version 4
+    ((parseInt(hash.slice(16, 17), 16) & 0x3) | 0x8).toString(16) + hash.slice(17, 20), // Variant bits
+    hash.slice(20, 32),
+  ].join("-");
+}

package/version.ts

@@ -1 +1 @@
-export const version = "1.15.0";
+export const version = "1.17.0";