@cowprotocol/cow-sdk 6.0.0-RC.9 → 6.0.0

package/dist/order-signing/orderSigningUtils.d.ts

@@ -1,97 +1,97 @@
-import type { SupportedChainId } from '../chains';
-import type { Signer } from '@ethersproject/abstract-signer';
-import type { Order, TypedDataDomain, OrderUidParams } from '@cowprotocol/contracts';
-import type { SigningResult, UnsignedOrder } from './types';
-/**
- * Utility class for signing order intents and cancellations.
- *
- * @remarks This class only supports `eth_sign` and wallet-native EIP-712 signing. For use of
- *          `presign` and `eip1271` {@link https://docs.cow.fi/ | see the docs}.
- * @example
- *
- * ```typescript
- * import { OrderSigningUtils, SupportedChainId, UnsignedOrder } from '@cowprotocol/cow-sdk'
- * import { Web3Provider } from '@ethersproject/providers'
- *
- * const account = 'YOUR_WALLET_ADDRESS'
- * const chainId = 100 // Gnosis chain
- * const provider = new Web3Provider(window.ethereum)
- * const signer = provider.getSigner()
- *
- * async function main() {
- *     const orderToSign: UnsignedOrder = { ... }
- *     const orderSigningResult = await OrderSigningUtils.signOrder(orderToSign, chainId, signer)
- *
- *     const orderId = await orderBookApi.sendOrder({ ...orderToSign, ...orderSigningResult })
- *
- *     const order = await orderBookApi.getOrder(orderId)
- *
- *     const trades = await orderBookApi.getTrades({ orderId })
- *
- *     const orderCancellationSigningResult = await OrderSigningUtils.signOrderCancellations([orderId], chainId, signer)
- *
- *     const cancellationResult = await orderBookApi.sendSignedOrderCancellations({...orderCancellationSigningResult, orderUids: [orderId] })
- *
- *     console.log('Results: ', { orderId, order, trades, orderCancellationSigningResult, cancellationResult })
- * }
- * ```
- */
-export declare class OrderSigningUtils {
-    /**
-     * Sign the order intent with the specified signer.
-     *
-     * @remarks If the API reports an error with the signature, it is likely to be due to an incorrectly
-     *          specified `chainId`. Please ensure that the `chainId` is correct for the network you are
-     *          using.
-     * @param {UnsignedOrder} order The unsigned order intent to be placed.
-     * @param {SupportedChainId} chainId The CoW Protocol `chainId` context that's being used.
-     * @param {Signer} signer The signer who is placing the order intent.
-     * @returns {Promise<SigningResult>} Encoded signature including signing scheme for the order.
-     */
-    static signOrder(order: UnsignedOrder, chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
-    /**
-     * Sign a cancellation message of an order intent with the specified signer.
-     * @param {string} orderUid The unique identifier of the order to cancel.
-     * @param {SupportedChainId} chainId The CoW Protocol `chainid` context that's being used.
-     * @param {Signer} signer The signer who initially placed the order intent.
-     * @returns {Promise<SigningResult>} Encoded signature including signing scheme for the cancellation.
-     */
-    static signOrderCancellation(orderUid: string, chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
-    /**
-     * Sign a cancellation message of multiple order intents with the specified signer.
-     * @param {string[]} orderUids An array of `orderUid` to cancel.
-     * @param {SupportedChainId} chainId The CoW Protocol `chainId` context that's being used.
-     * @param {Signer} signer The signer who initially placed the order intents.
-     * @returns {Promise<SigningResult>} Encoded signature including signing scheme for the cancellation.
-     */
-    static signOrderCancellations(orderUids: string[], chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
-    /**
-     * Get the EIP-712 typed domain data being used for signing.
-     * @param {SupportedChainId} chainId The CoW Protocol `chainId` context that's being used.
-     * @return The EIP-712 typed domain data.
-     * @see https://eips.ethereum.org/EIPS/eip-712
-     */
-    static getDomain(chainId: SupportedChainId): Promise<TypedDataDomain>;
-    /**
-     * Hashes the order intent and generate deterministic order ID.
-     * @param {SupportedChainId} chainId The CoW Protocol `chainId` context that's being used.
-     * @param {Order} order order to sign
-     * @param {Pick<OrderUidParams, 'owner'>} params order unique identifier parameters.
-     */
-    static generateOrderId(chainId: SupportedChainId, order: Order, params: Pick<OrderUidParams, 'owner'>): Promise<{
-        orderId: string;
-        orderDigest: string;
-    }>;
-    /**
-     * Get the domain separator hash for the EIP-712 typed domain data being used for signing.
-     * @param chainId {SupportedChainId} chainId The CoW Protocol protocol `chainId` context that's being used.
-     * @returns A string representation of the EIP-712 typed domain data hash.
-     */
-    static getDomainSeparator(chainId: SupportedChainId): Promise<string>;
-    /**
-     * 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.
-     */
-    static getEIP712Types(): Record<string, unknown>;
-}
+import type { SupportedChainId } from '../chains';
+import type { Signer } from '@ethersproject/abstract-signer';
+import type { Order, TypedDataDomain, OrderUidParams } from '@cowprotocol/contracts';
+import type { SigningResult, UnsignedOrder } from './types';
+/**
+ * Utility class for signing order intents and cancellations.
+ *
+ * @remarks This class only supports `eth_sign` and wallet-native EIP-712 signing. For use of
+ *          `presign` and `eip1271` {@link https://docs.cow.fi/ | see the docs}.
+ * @example
+ *
+ * ```typescript
+ * import { OrderSigningUtils, SupportedChainId, UnsignedOrder } from '@cowprotocol/cow-sdk'
+ * import { Web3Provider } from '@ethersproject/providers'
+ *
+ * const account = 'YOUR_WALLET_ADDRESS'
+ * const chainId = 100 // Gnosis chain
+ * const provider = new Web3Provider(window.ethereum)
+ * const signer = provider.getSigner()
+ *
+ * async function main() {
+ *     const orderToSign: UnsignedOrder = { ... }
+ *     const orderSigningResult = await OrderSigningUtils.signOrder(orderToSign, chainId, signer)
+ *
+ *     const orderId = await orderBookApi.sendOrder({ ...orderToSign, ...orderSigningResult })
+ *
+ *     const order = await orderBookApi.getOrder(orderId)
+ *
+ *     const trades = await orderBookApi.getTrades({ orderId })
+ *
+ *     const orderCancellationSigningResult = await OrderSigningUtils.signOrderCancellations([orderId], chainId, signer)
+ *
+ *     const cancellationResult = await orderBookApi.sendSignedOrderCancellations({...orderCancellationSigningResult, orderUids: [orderId] })
+ *
+ *     console.log('Results: ', { orderId, order, trades, orderCancellationSigningResult, cancellationResult })
+ * }
+ * ```
+ */
+export declare class OrderSigningUtils {
+    /**
+     * Sign the order intent with the specified signer.
+     *
+     * @remarks If the API reports an error with the signature, it is likely to be due to an incorrectly
+     *          specified `chainId`. Please ensure that the `chainId` is correct for the network you are
+     *          using.
+     * @param {UnsignedOrder} order The unsigned order intent to be placed.
+     * @param {SupportedChainId} chainId The CoW Protocol `chainId` context that's being used.
+     * @param {Signer} signer The signer who is placing the order intent.
+     * @returns {Promise<SigningResult>} Encoded signature including signing scheme for the order.
+     */
+    static signOrder(order: UnsignedOrder, chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
+    /**
+     * Sign a cancellation message of an order intent with the specified signer.
+     * @param {string} orderUid The unique identifier of the order to cancel.
+     * @param {SupportedChainId} chainId The CoW Protocol `chainid` context that's being used.
+     * @param {Signer} signer The signer who initially placed the order intent.
+     * @returns {Promise<SigningResult>} Encoded signature including signing scheme for the cancellation.
+     */
+    static signOrderCancellation(orderUid: string, chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
+    /**
+     * Sign a cancellation message of multiple order intents with the specified signer.
+     * @param {string[]} orderUids An array of `orderUid` to cancel.
+     * @param {SupportedChainId} chainId The CoW Protocol `chainId` context that's being used.
+     * @param {Signer} signer The signer who initially placed the order intents.
+     * @returns {Promise<SigningResult>} Encoded signature including signing scheme for the cancellation.
+     */
+    static signOrderCancellations(orderUids: string[], chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
+    /**
+     * Get the EIP-712 typed domain data being used for signing.
+     * @param {SupportedChainId} chainId The CoW Protocol `chainId` context that's being used.
+     * @return The EIP-712 typed domain data.
+     * @see https://eips.ethereum.org/EIPS/eip-712
+     */
+    static getDomain(chainId: SupportedChainId): Promise<TypedDataDomain>;
+    /**
+     * Hashes the order intent and generate deterministic order ID.
+     * @param {SupportedChainId} chainId The CoW Protocol `chainId` context that's being used.
+     * @param {Order} order order to sign
+     * @param {Pick<OrderUidParams, 'owner'>} params order unique identifier parameters.
+     */
+    static generateOrderId(chainId: SupportedChainId, order: Order, params: Pick<OrderUidParams, 'owner'>): Promise<{
+        orderId: string;
+        orderDigest: string;
+    }>;
+    /**
+     * Get the domain separator hash for the EIP-712 typed domain data being used for signing.
+     * @param chainId {SupportedChainId} chainId The CoW Protocol protocol `chainId` context that's being used.
+     * @returns A string representation of the EIP-712 typed domain data hash.
+     */
+    static getDomainSeparator(chainId: SupportedChainId): Promise<string>;
+    /**
+     * 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.
+     */
+    static getEIP712Types(): Record<string, unknown>;
+}

package/dist/order-signing/types.d.ts

@@ -1,55 +1,55 @@
-import type { SupportedChainId } from '../chains';
-import type { Signer } from '@ethersproject/abstract-signer';
-import type { OrderParameters, EcdsaSigningScheme } from '../order-book';
-/**
- * Unsigned order intent to be placed.
- */
-export type UnsignedOrder = Omit<OrderParameters, 'receiver'> & {
-    receiver: string;
-};
-/**
- * Encoded signature including signing scheme for the order.
- */
-export type SigningResult = {
-    signature: string;
-    signingScheme: EcdsaSigningScheme;
-};
-/**
- * Parameters for signing an order intent.
- * @param chainId The CoW Protocol `chainId` context that's being used.
- * @param signer The signer who is placing the order intent.
- * @param order The unsigned order intent to be placed.
- * @param signingScheme The signing scheme to use for the signature.
- */
-export interface SignOrderParams {
-    chainId: SupportedChainId;
-    signer: Signer;
-    order: UnsignedOrder;
-    signingScheme: EcdsaSigningScheme;
-}
-/**
- * Parameters for signing an order cancellation.
- * @param chainId The CoW Protocol `chainId` context that's being used.
- * @param signer The signer who initially placed the order intent.
- * @param orderUid The unique identifier of the order to cancel.
- * @param signingScheme The signing scheme to use for the signature.
- */
-export interface SignOrderCancellationParams {
-    chainId: SupportedChainId;
-    signer: Signer;
-    orderUid: string;
-    signingScheme: EcdsaSigningScheme;
-}
-/**
- * Parameters for signing multiple bulk order cancellations.
- * @param chainId The CoW Protocol `chainId` context that's being used.
- * @param signer The signer who initially placed the order intents.
- * @param orderUids An array of `orderUid` to cancel.
- * @param signingScheme The signing scheme to use for the signature.
- */
-export interface SignOrderCancellationsParams {
-    chainId: SupportedChainId;
-    signer: Signer;
-    orderUids: string[];
-    signingScheme: EcdsaSigningScheme;
-}
+import type { SupportedChainId } from '../chains';
+import type { Signer } from '@ethersproject/abstract-signer';
+import type { OrderParameters, EcdsaSigningScheme } from '../order-book';
+/**
+ * Unsigned order intent to be placed.
+ */
+export type UnsignedOrder = Omit<OrderParameters, 'receiver'> & {
+    receiver: string;
+};
+/**
+ * Encoded signature including signing scheme for the order.
+ */
+export type SigningResult = {
+    signature: string;
+    signingScheme: EcdsaSigningScheme;
+};
+/**
+ * Parameters for signing an order intent.
+ * @param chainId The CoW Protocol `chainId` context that's being used.
+ * @param signer The signer who is placing the order intent.
+ * @param order The unsigned order intent to be placed.
+ * @param signingScheme The signing scheme to use for the signature.
+ */
+export interface SignOrderParams {
+    chainId: SupportedChainId;
+    signer: Signer;
+    order: UnsignedOrder;
+    signingScheme: EcdsaSigningScheme;
+}
+/**
+ * Parameters for signing an order cancellation.
+ * @param chainId The CoW Protocol `chainId` context that's being used.
+ * @param signer The signer who initially placed the order intent.
+ * @param orderUid The unique identifier of the order to cancel.
+ * @param signingScheme The signing scheme to use for the signature.
+ */
+export interface SignOrderCancellationParams {
+    chainId: SupportedChainId;
+    signer: Signer;
+    orderUid: string;
+    signingScheme: EcdsaSigningScheme;
+}
+/**
+ * Parameters for signing multiple bulk order cancellations.
+ * @param chainId The CoW Protocol `chainId` context that's being used.
+ * @param signer The signer who initially placed the order intents.
+ * @param orderUids An array of `orderUid` to cancel.
+ * @param signingScheme The signing scheme to use for the signature.
+ */
+export interface SignOrderCancellationsParams {
+    chainId: SupportedChainId;
+    signer: Signer;
+    orderUids: string[];
+    signingScheme: EcdsaSigningScheme;
+}

package/dist/order-signing/utils.d.ts

@@ -1,49 +1,49 @@
-import type { TypedDataDomain, Order, OrderUidParams } from '@cowprotocol/contracts';
-import type { Signer } from '@ethersproject/abstract-signer';
-import type { SigningResult, UnsignedOrder } from './types';
-import type { SupportedChainId } from '../chains';
-/**
- * Returns the signature for the specified order with the signing scheme encoded
- * into the signature.
- * @param {UnsignedOrder} order The order to sign.
- * @param {SupportedChainId} chainId The chain Id
- * @param {Signer} signer The owner for the order used to sign.
- * @return {*} Encoded signature including signing scheme for the order.
- */
-export declare function signOrder(order: UnsignedOrder, chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
-/**
- * Returns the signature for the Order Cancellation with the signing scheme encoded
- * into the signature.
- * @param {string} orderUid The unique identifier of the order being cancelled.
- * @param {SupportedChainId} chainId The chain Id
- * @param {Signer} signer The owner for the order used to sign.
- * @return {*} Encoded signature including signing scheme for the order.
- */
-export declare function signOrderCancellation(orderUid: string, chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
-/**
- * Returns the signature for the Order Cancellations with the signing scheme encoded
- * into the signature.
- *
- * @param {string[]} orderUids The unique identifiers of the orders being cancelled.
- * @param {SupportedChainId} chainId The CoW Protocol protocol `chainId` context that's being used.
- * @param {Signer} signer The owner that had placed the orders used to sign.
- * @returns {*} Encoded signature including signing scheme for the order.
- */
-export declare function signOrderCancellations(orderUids: string[], chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
-/**
- * Returns the TypedDataDomain used for signing for the specified chainId.
- * @param {SupportedChainId} chainId The chain Id
- * @return {*} The TypedDataDomain for the specified chainId.
- * @throws {CowError} If the chainId is not supported.
- */
-export declare function getDomain(chainId: SupportedChainId): TypedDataDomain;
-/**
- * Generate a deterministic order ID for the specified order.
- * @param {SupportedChainId} chainId The chain Id
- * @param {Order} order order to sign
- * @param {Pick<OrderUidParams, 'owner'>} params order unique identifier parameters.
- */
-export declare function generateOrderId(chainId: SupportedChainId, order: Order, params: Pick<OrderUidParams, 'owner'>): Promise<{
-    orderId: string;
-    orderDigest: string;
-}>;
+import type { TypedDataDomain, Order, OrderUidParams } from '@cowprotocol/contracts';
+import type { Signer } from '@ethersproject/abstract-signer';
+import type { SigningResult, UnsignedOrder } from './types';
+import type { SupportedChainId } from '../chains';
+/**
+ * Returns the signature for the specified order with the signing scheme encoded
+ * into the signature.
+ * @param {UnsignedOrder} order The order to sign.
+ * @param {SupportedChainId} chainId The chain Id
+ * @param {Signer} signer The owner for the order used to sign.
+ * @return {*} Encoded signature including signing scheme for the order.
+ */
+export declare function signOrder(order: UnsignedOrder, chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
+/**
+ * Returns the signature for the Order Cancellation with the signing scheme encoded
+ * into the signature.
+ * @param {string} orderUid The unique identifier of the order being cancelled.
+ * @param {SupportedChainId} chainId The chain Id
+ * @param {Signer} signer The owner for the order used to sign.
+ * @return {*} Encoded signature including signing scheme for the order.
+ */
+export declare function signOrderCancellation(orderUid: string, chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
+/**
+ * Returns the signature for the Order Cancellations with the signing scheme encoded
+ * into the signature.
+ *
+ * @param {string[]} orderUids The unique identifiers of the orders being cancelled.
+ * @param {SupportedChainId} chainId The CoW Protocol protocol `chainId` context that's being used.
+ * @param {Signer} signer The owner that had placed the orders used to sign.
+ * @returns {*} Encoded signature including signing scheme for the order.
+ */
+export declare function signOrderCancellations(orderUids: string[], chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
+/**
+ * Returns the TypedDataDomain used for signing for the specified chainId.
+ * @param {SupportedChainId} chainId The chain Id
+ * @return {*} The TypedDataDomain for the specified chainId.
+ * @throws {CowError} If the chainId is not supported.
+ */
+export declare function getDomain(chainId: SupportedChainId): TypedDataDomain;
+/**
+ * Generate a deterministic order ID for the specified order.
+ * @param {SupportedChainId} chainId The chain Id
+ * @param {Order} order order to sign
+ * @param {Pick<OrderUidParams, 'owner'>} params order unique identifier parameters.
+ */
+export declare function generateOrderId(chainId: SupportedChainId, order: Order, params: Pick<OrderUidParams, 'owner'>): Promise<{
+    orderId: string;
+    orderDigest: string;
+}>;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/cow-sdk",
-  "version": "6.0.0-RC.9",
+  "version": "6.0.0",
   "license": "(MIT OR Apache-2.0)",
   "files": [
     "/dist"
@@ -19,7 +19,7 @@
     "start": "microbundle -f modern,esm,cjs watch",
     "copy-md-files": "npx cpx \"**/*.md\" dist",
     "postbuild": "cp package.json dist && yarn copy-md-files && yarn run trading:generateSchemas",
-    "lint": "eslint src",
+    "lint": "eslint ./src",
     "format": "prettier --write \"src/**/*.+(ts|json)\"",
     "test": "jest",
     "test:coverage": "jest --coverage --json --outputFile=jest.results.json && cat ./coverage/lcov.info | coveralls",
@@ -33,14 +33,15 @@
     "trading:generateSchemas": "ts-node scripts/generateTradingSchemas.ts"
   },
   "dependencies": {
-    "@cowprotocol/app-data": "^2.4.0",
-    "@cowprotocol/contracts": "^1.6.0",
-    "@ethersproject/abstract-signer": "^5.7.0",
-    "@openzeppelin/merkle-tree": "^1.0.5",
+    "@cowprotocol/app-data": "^3.2.0",
+    "@cowprotocol/contracts": "^1.8.0",
+    "@ethersproject/abstract-signer": "^5.8.0",
+    "@openzeppelin/merkle-tree": "^1.0.8",
     "@weiroll/weiroll.js": "^0.3.0",
-    "cross-fetch": "^3.1.5",
-    "exponential-backoff": "^3.1.1",
-    "graphql": "^16.3.0",
+    "cross-fetch": "^3.2.0",
+    "deepmerge": "^4.3.1",
+    "exponential-backoff": "^3.1.2",
+    "graphql": "^16.11.0",
     "graphql-request": "^4.3.0",
     "limiter": "^3.0.0"
   },
@@ -50,37 +51,34 @@
   "devDependencies": {
     "@babel/plugin-proposal-nullish-coalescing-operator": "^7.18.6",
     "@babel/plugin-proposal-private-methods": "^7.18.6",
-    "@babel/preset-env": "^7.20.2",
-    "@babel/preset-typescript": "^7.18.6",
-    "@graphql-codegen/cli": "3.0.0",
-    "@graphql-codegen/typescript": "3.0.0",
-    "@graphql-codegen/typescript-operations": "^3.0.0",
-    "@typechain/ethers-v5": "^11.0.0",
-    "@types/jest": "^29.4.0",
-    "@types/node": "^22.9.0",
-    "@typescript-eslint/eslint-plugin": "^5.51.0",
-    "@typescript-eslint/parser": "^5.51.0",
+    "@babel/preset-env": "^7.27.2",
+    "@babel/preset-typescript": "^7.27.1",
+    "@eslint/js": "^9.26.0",
+    "@graphql-codegen/cli": "5.0.6",
+    "@graphql-codegen/typescript": "4.1.6",
+    "@graphql-codegen/typescript-operations": "^4.6.1",
+    "@typechain/ethers-v5": "^11.1.2",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.15.17",
     "babel-plugin-inline-import": "^3.0.0",
     "coveralls": "^3.1.1",
     "cpx": "^1.5.0",
-    "eslint": "^8.33.0",
-    "eslint-config-prettier": "^8.6.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-unused-imports": "^3.0.0",
-    "ethers": "^5.8.0",
-    "jest": "^29.6.4",
+    "eslint": "^9.26.0",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "jest": "^29.7.0",
     "jest-fetch-mock": "^3.0.3",
     "microbundle": "^0.15.1",
-    "openapi-typescript-codegen": "^0.23.0",
-    "prettier": "^2.5.1",
-    "ts-json-schema-generator": "^2.3.0",
+    "openapi-typescript-codegen": "^0.29.0",
+    "prettier": "^3.5.3",
+    "ts-json-schema-generator": "^2.4.0",
     "ts-mockito": "^2.6.1",
-    "tsc-watch": "^6.0.0",
-    "typechain": "^8.2.0",
-    "typescript": "^4.9.5"
+    "ts-node": "^10.9.2",
+    "tsc-watch": "^6.2.1",
+    "typechain": "^8.3.2",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.32.1"
   },
   "jest": {
-    "maxWorkers": 1,
     "automock": false,
     "resetMocks": false,
     "setupFiles": [
@@ -90,6 +88,7 @@
       "src/**/*.{ts,tsx}"
     ],
     "coveragePathIgnorePatterns": [
+      "src/common/generated",
       "src/composable/generated"
     ],
     "moduleDirectories": [