@cowprotocol/sdk-order-signing 0.1.6 → 0.1.7

package/dist/index.d.mts

@@ -56,6 +56,17 @@ interface SignOrderCancellationsParams {
     signingScheme: EcdsaSigningScheme;
 }
 
+declare const ORDER_PRIMARY_TYPE: "Order";
+/**
+ * The EIP-712 types used for signing a GPv2Order.Data struct. This is useful for when
+ * signing orders using smart contracts, whereby this SDK cannot do the EIP-1271 signing for you.
+ */
+declare const COW_EIP712_TYPES: {
+    Order: {
+        name: string;
+        type: string;
+    }[];
+};
 /**
  * Utility class for signing order intents and cancellations.
  *
@@ -146,12 +157,32 @@ declare class OrderSigningUtils {
      * @returns A string representation of the EIP-712 typed domain data hash.
      */
     static getDomainSeparator(chainId: SupportedChainId): Promise<string>;
+    static getEIP712Types(): typeof COW_EIP712_TYPES;
     /**
-     * Get the EIP-712 types used for signing a GPv2Order.Data struct. This is useful for when
-     * signing orders using smart contracts, whereby this SDK cannot do the EIP-1271 signing for you.
-     * @returns The EIP-712 types used for signing.
+     * Encodes an order and ECDSA signature for EIP-1271 smart contract signature verification.
+     *
+     * @remarks This method encodes the order data and ECDSA signature into a format suitable for
+     *          EIP-1271 signature verification by smart contracts. The order struct is ABI-encoded
+     *          as a tuple along with the ECDSA signature bytes. String fields in the order are
+     *          hashed using keccak256 before encoding.
+     *
+     * @param {UnsignedOrder} orderToSign The unsigned order to encode for EIP-1271 verification.
+     * @param {string} ecdsaSignature The ECDSA signature (typically 65 bytes hex-encoded) to include in the encoding.
+     * @returns {string} The ABI-encoded order struct and signature, ready for EIP-1271 verification.
+     *
+     * @see https://eips.ethereum.org/EIPS/eip-1271
+     *
+     * @example
+     * ```typescript
+     * const orderToSign: UnsignedOrder = { ... }
+     * const ecdsaSignature = '0x...' // 65 bytes signature from signing the order
+     *
+     * const eip1271Signature = OrderSigningUtils.getEip1271Signature(orderToSign, ecdsaSignature)
+     * // Use eip1271Signature with a smart contract wallet that implements EIP-1271
+     * ```
      */
-    static getEIP712Types(): Record<string, unknown>;
+    static getEip1271Signature(orderToSign: UnsignedOrder, ecdsaSignature: string): string;
+    static encodeUnsignedOrder(orderToSign: UnsignedOrder): Record<string, string>;
 }
 
-export { OrderSigningUtils, type SignOrderCancellationParams, type SignOrderCancellationsParams, type SignOrderParams, type SigningResult, type UnsignedOrder };
+export { COW_EIP712_TYPES, ORDER_PRIMARY_TYPE, OrderSigningUtils, type SignOrderCancellationParams, type SignOrderCancellationsParams, type SignOrderParams, type SigningResult, type UnsignedOrder };

package/dist/index.d.ts

@@ -56,6 +56,17 @@ interface SignOrderCancellationsParams {
     signingScheme: EcdsaSigningScheme;
 }
 
+declare const ORDER_PRIMARY_TYPE: "Order";
+/**
+ * The EIP-712 types used for signing a GPv2Order.Data struct. This is useful for when
+ * signing orders using smart contracts, whereby this SDK cannot do the EIP-1271 signing for you.
+ */
+declare const COW_EIP712_TYPES: {
+    Order: {
+        name: string;
+        type: string;
+    }[];
+};
 /**
  * Utility class for signing order intents and cancellations.
  *
@@ -146,12 +157,32 @@ declare class OrderSigningUtils {
      * @returns A string representation of the EIP-712 typed domain data hash.
      */
     static getDomainSeparator(chainId: SupportedChainId): Promise<string>;
+    static getEIP712Types(): typeof COW_EIP712_TYPES;
     /**
-     * Get the EIP-712 types used for signing a GPv2Order.Data struct. This is useful for when
-     * signing orders using smart contracts, whereby this SDK cannot do the EIP-1271 signing for you.
-     * @returns The EIP-712 types used for signing.
+     * Encodes an order and ECDSA signature for EIP-1271 smart contract signature verification.
+     *
+     * @remarks This method encodes the order data and ECDSA signature into a format suitable for
+     *          EIP-1271 signature verification by smart contracts. The order struct is ABI-encoded
+     *          as a tuple along with the ECDSA signature bytes. String fields in the order are
+     *          hashed using keccak256 before encoding.
+     *
+     * @param {UnsignedOrder} orderToSign The unsigned order to encode for EIP-1271 verification.
+     * @param {string} ecdsaSignature The ECDSA signature (typically 65 bytes hex-encoded) to include in the encoding.
+     * @returns {string} The ABI-encoded order struct and signature, ready for EIP-1271 verification.
+     *
+     * @see https://eips.ethereum.org/EIPS/eip-1271
+     *
+     * @example
+     * ```typescript
+     * const orderToSign: UnsignedOrder = { ... }
+     * const ecdsaSignature = '0x...' // 65 bytes signature from signing the order
+     *
+     * const eip1271Signature = OrderSigningUtils.getEip1271Signature(orderToSign, ecdsaSignature)
+     * // Use eip1271Signature with a smart contract wallet that implements EIP-1271
+     * ```
      */
-    static getEIP712Types(): Record<string, unknown>;
+    static getEip1271Signature(orderToSign: UnsignedOrder, ecdsaSignature: string): string;
+    static encodeUnsignedOrder(orderToSign: UnsignedOrder): Record<string, string>;
 }
 
-export { OrderSigningUtils, type SignOrderCancellationParams, type SignOrderCancellationsParams, type SignOrderParams, type SigningResult, type UnsignedOrder };
+export { COW_EIP712_TYPES, ORDER_PRIMARY_TYPE, OrderSigningUtils, type SignOrderCancellationParams, type SignOrderCancellationsParams, type SignOrderParams, type SigningResult, type UnsignedOrder };

package/dist/index.js

@@ -20,6 +20,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  COW_EIP712_TYPES: () => COW_EIP712_TYPES,
+  ORDER_PRIMARY_TYPE: () => ORDER_PRIMARY_TYPE,
   OrderSigningUtils: () => OrderSigningUtils
 });
 module.exports = __toCommonJS(src_exports);
@@ -150,7 +152,25 @@ async function generateOrderId(chainId, order, params) {
 }
 
 // src/orderSigningUtils.ts
-var OrderSigningUtils = class {
+var import_sdk_order_book2 = require("@cowprotocol/sdk-order-book");
+var ORDER_PRIMARY_TYPE = "Order";
+var COW_EIP712_TYPES = {
+  [ORDER_PRIMARY_TYPE]: [
+    { name: "sellToken", type: "address" },
+    { name: "buyToken", type: "address" },
+    { name: "receiver", type: "address" },
+    { name: "sellAmount", type: "uint256" },
+    { name: "buyAmount", type: "uint256" },
+    { name: "validTo", type: "uint32" },
+    { name: "appData", type: "bytes32" },
+    { name: "feeAmount", type: "uint256" },
+    { name: "kind", type: "string" },
+    { name: "partiallyFillable", type: "bool" },
+    { name: "sellTokenBalance", type: "string" },
+    { name: "buyTokenBalance", type: "string" }
+  ]
+};
+var OrderSigningUtils = class _OrderSigningUtils {
   /**
    * Sign the order intent with the specified signer.
    *
@@ -218,31 +238,69 @@ var OrderSigningUtils = class {
     ];
     return adapter.utils.hashDomain(getDomain(chainId), types);
   }
+  static getEIP712Types() {
+    return COW_EIP712_TYPES;
+  }
   /**
-   * Get the EIP-712 types used for signing a GPv2Order.Data struct. This is useful for when
-   * signing orders using smart contracts, whereby this SDK cannot do the EIP-1271 signing for you.
-   * @returns The EIP-712 types used for signing.
+   * Encodes an order and ECDSA signature for EIP-1271 smart contract signature verification.
+   *
+   * @remarks This method encodes the order data and ECDSA signature into a format suitable for
+   *          EIP-1271 signature verification by smart contracts. The order struct is ABI-encoded
+   *          as a tuple along with the ECDSA signature bytes. String fields in the order are
+   *          hashed using keccak256 before encoding.
+   *
+   * @param {UnsignedOrder} orderToSign The unsigned order to encode for EIP-1271 verification.
+   * @param {string} ecdsaSignature The ECDSA signature (typically 65 bytes hex-encoded) to include in the encoding.
+   * @returns {string} The ABI-encoded order struct and signature, ready for EIP-1271 verification.
+   *
+   * @see https://eips.ethereum.org/EIPS/eip-1271
+   *
+   * @example
+   * ```typescript
+   * const orderToSign: UnsignedOrder = { ... }
+   * const ecdsaSignature = '0x...' // 65 bytes signature from signing the order
+   *
+   * const eip1271Signature = OrderSigningUtils.getEip1271Signature(orderToSign, ecdsaSignature)
+   * // Use eip1271Signature with a smart contract wallet that implements EIP-1271
+   * ```
    */
-  static getEIP712Types() {
-    return {
-      Order: [
-        { name: "sellToken", type: "address" },
-        { name: "buyToken", type: "address" },
-        { name: "receiver", type: "address" },
-        { name: "sellAmount", type: "uint256" },
-        { name: "buyAmount", type: "uint256" },
-        { name: "validTo", type: "uint32" },
-        { name: "appData", type: "bytes32" },
-        { name: "feeAmount", type: "uint256" },
-        { name: "kind", type: "string" },
-        { name: "partiallyFillable", type: "bool" },
-        { name: "sellTokenBalance", type: "string" },
-        { name: "buyTokenBalance", type: "string" }
-      ]
+  static getEip1271Signature(orderToSign, ecdsaSignature) {
+    const adapter = (0, import_sdk_common2.getGlobalAdapter)();
+    const EIP712Types = COW_EIP712_TYPES[ORDER_PRIMARY_TYPE];
+    const components = EIP712Types.map((component) => ({
+      name: component.name,
+      type: component.type === "string" ? "bytes32" : component.type
+    }));
+    const values = Object.values(_OrderSigningUtils.encodeUnsignedOrder(orderToSign));
+    return adapter.utils.encodeAbi(
+      [
+        {
+          components,
+          type: "tuple"
+        },
+        { type: "bytes" }
+      ],
+      [values, ecdsaSignature]
+    );
+  }
+  static encodeUnsignedOrder(orderToSign) {
+    const order = {
+      ...orderToSign,
+      sellTokenBalance: orderToSign.sellTokenBalance ?? import_sdk_order_book2.SellTokenSource.ERC20,
+      buyTokenBalance: orderToSign.buyTokenBalance ?? import_sdk_order_book2.BuyTokenDestination.ERC20
     };
+    const adapter = (0, import_sdk_common2.getGlobalAdapter)();
+    const EIP712Types = COW_EIP712_TYPES[ORDER_PRIMARY_TYPE];
+    return EIP712Types.reduce((acc, { name, type }) => {
+      const value = order[name];
+      acc[name] = type === "string" ? String(adapter.utils.id(value)) : value;
+      return acc;
+    }, {});
   }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  COW_EIP712_TYPES,
+  ORDER_PRIMARY_TYPE,
   OrderSigningUtils
 });

package/dist/index.mjs

@@ -134,7 +134,25 @@ async function generateOrderId(chainId, order, params) {
 }
 
 // src/orderSigningUtils.ts
-var OrderSigningUtils = class {
+import { BuyTokenDestination, SellTokenSource } from "@cowprotocol/sdk-order-book";
+var ORDER_PRIMARY_TYPE = "Order";
+var COW_EIP712_TYPES = {
+  [ORDER_PRIMARY_TYPE]: [
+    { name: "sellToken", type: "address" },
+    { name: "buyToken", type: "address" },
+    { name: "receiver", type: "address" },
+    { name: "sellAmount", type: "uint256" },
+    { name: "buyAmount", type: "uint256" },
+    { name: "validTo", type: "uint32" },
+    { name: "appData", type: "bytes32" },
+    { name: "feeAmount", type: "uint256" },
+    { name: "kind", type: "string" },
+    { name: "partiallyFillable", type: "bool" },
+    { name: "sellTokenBalance", type: "string" },
+    { name: "buyTokenBalance", type: "string" }
+  ]
+};
+var OrderSigningUtils = class _OrderSigningUtils {
   /**
    * Sign the order intent with the specified signer.
    *
@@ -202,30 +220,68 @@ var OrderSigningUtils = class {
     ];
     return adapter.utils.hashDomain(getDomain(chainId), types);
   }
+  static getEIP712Types() {
+    return COW_EIP712_TYPES;
+  }
   /**
-   * Get the EIP-712 types used for signing a GPv2Order.Data struct. This is useful for when
-   * signing orders using smart contracts, whereby this SDK cannot do the EIP-1271 signing for you.
-   * @returns The EIP-712 types used for signing.
+   * Encodes an order and ECDSA signature for EIP-1271 smart contract signature verification.
+   *
+   * @remarks This method encodes the order data and ECDSA signature into a format suitable for
+   *          EIP-1271 signature verification by smart contracts. The order struct is ABI-encoded
+   *          as a tuple along with the ECDSA signature bytes. String fields in the order are
+   *          hashed using keccak256 before encoding.
+   *
+   * @param {UnsignedOrder} orderToSign The unsigned order to encode for EIP-1271 verification.
+   * @param {string} ecdsaSignature The ECDSA signature (typically 65 bytes hex-encoded) to include in the encoding.
+   * @returns {string} The ABI-encoded order struct and signature, ready for EIP-1271 verification.
+   *
+   * @see https://eips.ethereum.org/EIPS/eip-1271
+   *
+   * @example
+   * ```typescript
+   * const orderToSign: UnsignedOrder = { ... }
+   * const ecdsaSignature = '0x...' // 65 bytes signature from signing the order
+   *
+   * const eip1271Signature = OrderSigningUtils.getEip1271Signature(orderToSign, ecdsaSignature)
+   * // Use eip1271Signature with a smart contract wallet that implements EIP-1271
+   * ```
    */
-  static getEIP712Types() {
-    return {
-      Order: [
-        { name: "sellToken", type: "address" },
-        { name: "buyToken", type: "address" },
-        { name: "receiver", type: "address" },
-        { name: "sellAmount", type: "uint256" },
-        { name: "buyAmount", type: "uint256" },
-        { name: "validTo", type: "uint32" },
-        { name: "appData", type: "bytes32" },
-        { name: "feeAmount", type: "uint256" },
-        { name: "kind", type: "string" },
-        { name: "partiallyFillable", type: "bool" },
-        { name: "sellTokenBalance", type: "string" },
-        { name: "buyTokenBalance", type: "string" }
-      ]
+  static getEip1271Signature(orderToSign, ecdsaSignature) {
+    const adapter = getGlobalAdapter();
+    const EIP712Types = COW_EIP712_TYPES[ORDER_PRIMARY_TYPE];
+    const components = EIP712Types.map((component) => ({
+      name: component.name,
+      type: component.type === "string" ? "bytes32" : component.type
+    }));
+    const values = Object.values(_OrderSigningUtils.encodeUnsignedOrder(orderToSign));
+    return adapter.utils.encodeAbi(
+      [
+        {
+          components,
+          type: "tuple"
+        },
+        { type: "bytes" }
+      ],
+      [values, ecdsaSignature]
+    );
+  }
+  static encodeUnsignedOrder(orderToSign) {
+    const order = {
+      ...orderToSign,
+      sellTokenBalance: orderToSign.sellTokenBalance ?? SellTokenSource.ERC20,
+      buyTokenBalance: orderToSign.buyTokenBalance ?? BuyTokenDestination.ERC20
     };
+    const adapter = getGlobalAdapter();
+    const EIP712Types = COW_EIP712_TYPES[ORDER_PRIMARY_TYPE];
+    return EIP712Types.reduce((acc, { name, type }) => {
+      const value = order[name];
+      acc[name] = type === "string" ? String(adapter.utils.id(value)) : value;
+      return acc;
+    }, {});
   }
 };
 export {
+  COW_EIP712_TYPES,
+  ORDER_PRIMARY_TYPE,
   OrderSigningUtils
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/sdk-order-signing",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "TypeScript order signing for CoW Protocol SDK",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -14,10 +14,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@cowprotocol/sdk-common": "0.2.1",
-    "@cowprotocol/sdk-config": "0.1.0",
-    "@cowprotocol/sdk-order-book": "0.1.2",
-    "@cowprotocol/sdk-contracts-ts": "0.4.0"
+    "@cowprotocol/sdk-common": "0.2.2",
+    "@cowprotocol/sdk-config": "0.2.0",
+    "@cowprotocol/sdk-contracts-ts": "0.4.1",
+    "@cowprotocol/sdk-order-book": "0.1.3"
   },
   "devDependencies": {
     "@types/jest": "^29.5.5",
@@ -31,10 +31,10 @@
     "tsup": "^7.2.0",
     "typescript": "^5.2.2",
     "viem": "^2.28.4",
-    "@cowprotocol/sdk-ethers-v5-adapter": "0.1.2",
-    "@cowprotocol/sdk-ethers-v6-adapter": "0.1.2",
+    "@cowprotocol/sdk-ethers-v5-adapter": "0.1.3",
+    "@cowprotocol/sdk-ethers-v6-adapter": "0.1.3",
     "@cow-sdk/typescript-config": "0.0.0-beta.0",
-    "@cowprotocol/sdk-viem-adapter": "0.1.2"
+    "@cowprotocol/sdk-viem-adapter": "0.1.3"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",