gate-evm-tools 1.0.27 → 1.0.31

package/runtime/delivery/create2.ts

@@ -0,0 +1,57 @@
+import { ParamType } from "ethers";
+import type { Create2FieldKind } from "../workflow/lib/validation";
+import { copyOwnData } from "./data";
+import { DEFERRED } from "./references";
+import { validateAbiValue, validateTransactionValue } from "./abi";
+
+/** Check supplied fields before shared extraction can discard or fall back from them. */
+export function validateCreate2Fields(
+  raw: unknown,
+  kind: Create2FieldKind,
+  allowDeferred = false,
+): Record<string, unknown> {
+  const value = copyOwnData(
+    raw, `CREATE2 ${kind}`, allowDeferred ? DEFERRED : undefined,
+  );
+  if (!value || typeof value !== "object" || Array.isArray(value))
+    throw new Error(`CREATE2 ${kind} requires an object`);
+  const fields = value as Record<string, unknown>;
+  const addresses = kind === "step"
+    ? ["factory", "expectedAddress"]
+    : kind === "target"
+      ? ["factory", "caller"]
+      : kind === "uups" ? ["placeholderImplementation"] : ["controlledMulticall"];
+  for (const key of addresses) {
+    if (!Object.hasOwn(fields, key)) continue;
+    validateAbiValue(
+      ParamType.from("address"), fields[key], `CREATE2 ${kind}.${key}`, allowDeferred,
+    );
+    if (typeof fields[key] === "string" && /^0x0{40}$/i.test(fields[key]))
+      throw new Error(`CREATE2 ${kind}.${key} requires a nonzero address`);
+  }
+  if (
+    kind === "target" && Object.hasOwn(fields, "scheme") &&
+    !(allowDeferred && fields.scheme === DEFERRED) && fields.scheme !== "evm"
+  )
+    throw new Error("Delivery CREATE2 scheme must be evm");
+  if (kind === "step" && Object.hasOwn(fields, "salt"))
+    validateAbiValue(ParamType.from("bytes32"), fields.salt, "CREATE2 salt", allowDeferred);
+  if (
+    (kind === "step" || kind === "target") && Object.hasOwn(fields, "leadingZeroBytes")
+  ) {
+    const zeroes = fields.leadingZeroBytes;
+    if (
+      !(allowDeferred && zeroes === DEFERRED) &&
+      (typeof zeroes !== "number" || !Number.isSafeInteger(zeroes) || zeroes < 0 || zeroes > 20)
+    )
+      throw new Error("CREATE2 leadingZeroBytes must be an integer from 0 to 20");
+  }
+  if (kind === "step") {
+    for (const key of ["create2ForwardValue", "callForwardValue"]) {
+      if (!Object.hasOwn(fields, key)) continue;
+      validateTransactionValue(fields[key], allowDeferred);
+      if (typeof fields[key] === "number") fields[key] = String(fields[key]);
+    }
+  }
+  return fields;
+}