@cowprotocol/cow-sdk 5.8.0 → 5.10.0-RC.0

package/dist/order-book/generated/index.d.ts

@@ -40,7 +40,6 @@ export type { PreSignature } from './models/PreSignature';
 export { PriceEstimationError } from './models/PriceEstimationError';
 export type { PriceImprovement } from './models/PriceImprovement';
 export { PriceQuality } from './models/PriceQuality';
-export type { ProtocolAppData } from './models/ProtocolAppData';
 export type { Quote } from './models/Quote';
 export { SellTokenSource } from './models/SellTokenSource';
 export type { Signature } from './models/Signature';

package/dist/order-book/generated/models/Auction.d.ts

@@ -12,19 +12,10 @@ export type Auction = {
      */
     id?: number;
     /**
-     * The block number for the auction. Orders and prices are guaranteed to be valid on this
-     * block. Proposed settlements should be valid for this block as well.
+     * The block number for the auction. Orders and prices are guaranteed to be valid on this block. Proposed settlements should be valid for this block as well.
      *
      */
     block?: number;
-    /**
-     * The latest block on which a settlement has been processed.
-     *
-     * **NOTE**: Under certain conditions it is possible for a settlement to have been mined as
-     * part of `block` but not have yet been processed.
-     *
-     */
-    latestSettlementBlock?: number;
     /**
      * The solvable orders included in the auction.
      *

package/dist/order-book/generated/models/AuctionPrices.d.ts

@@ -1,9 +1,6 @@
 import type { BigUint } from './BigUint';
 /**
- * The reference prices for all traded tokens in the auction as a mapping from token
- * addresses to a price denominated in native token (i.e. 1e18 represents a token that
- * trades one to one with the native token). These prices are used for solution competition
- * for computing surplus and converting fees to native token.
+ * The reference prices for all traded tokens in the auction as a mapping from token addresses to a price denominated in native token (i.e. 1e18 represents a token that trades one to one with the native token). These prices are used for solution competition for computing surplus and converting fees to native token.
  *
  */
 export type AuctionPrices = Record<string, BigUint>;

package/dist/order-book/generated/models/CompetitionOrderStatus.d.ts

@@ -2,9 +2,11 @@ import type { ExecutedAmounts } from './ExecutedAmounts';
 export type CompetitionOrderStatus = {
     type: CompetitionOrderStatus.type;
     /**
-     * A list of solvers who participated in the latest competition, sorted by score in ascending order, where the last element is the winner.
-     * The presence of executed amounts defines whether the solver provided a solution for the desired order.
+     * A list of solvers who participated in the latest competition, sorted
+     * by score in ascending order, where the last element is the winner.
      *
+     * The presence of executed amounts defines whether the solver provided
+     * a solution for the desired order.
      */
     value?: Array<{
         /**

package/dist/order-book/generated/models/ExecutedProtocolFee.d.ts

@@ -3,12 +3,6 @@ import type { FeePolicy } from './FeePolicy';
 import type { TokenAmount } from './TokenAmount';
 export type ExecutedProtocolFee = {
     policy?: FeePolicy;
-    /**
-     * Fee amount taken
-     */
     amount?: TokenAmount;
-    /**
-     * The token in which the fee is taken
-     */
     token?: Address;
 };

package/dist/order-book/generated/models/OnchainOrderData.d.ts

@@ -1,25 +1,19 @@
 import type { Address } from './Address';
 export type OnchainOrderData = {
     /**
-     * If orders are placed as on-chain orders, the owner of the order might
-     * be a smart contract, but not the user placing the order. The
-     * actual user will be provided in this field.
+     * If orders are placed as on-chain orders, the owner of the order might be a smart contract, but not the user placing the order. The actual user will be provided in this field.
      *
      */
     sender: Address;
     /**
-     * Describes the error, if the order placement was not successful. This could
-     * happen, for example, if the `validTo` is too high, or no valid quote was
-     * found or generated.
+     * Describes the error, if the order placement was not successful. This could happen, for example, if the `validTo` is too high, or no valid quote was found or generated.
      *
      */
     placementError?: OnchainOrderData.placementError;
 };
 export declare namespace OnchainOrderData {
     /**
-     * Describes the error, if the order placement was not successful. This could
-     * happen, for example, if the `validTo` is too high, or no valid quote was
-     * found or generated.
+     * Describes the error, if the order placement was not successful. This could happen, for example, if the `validTo` is too high, or no valid quote was found or generated.
      *
      */
     enum placementError {

package/dist/order-book/generated/models/OrderCreation.d.ts

@@ -58,30 +58,22 @@ export type OrderCreation = {
     signingScheme: SigningScheme;
     signature: Signature;
     /**
-     * If set, the backend enforces that this address matches what is decoded as the *signer* of
-     * the signature. This helps catch errors with invalid signature encodings as the backend
-     * might otherwise silently work with an unexpected address that for example does not have
-     * any balance.
+     * If set, the backend enforces that this address matches what is decoded as the *signer* of the signature. This helps catch errors with invalid signature encodings as the backend might otherwise silently work with an unexpected address that for example does not have any balance.
      *
      */
     from?: Address | null;
     /**
-     * Orders can optionally include a quote ID. This way the order can be linked to a quote
-     * and enable providing more metadata when analysing order slippage.
+     * Orders can optionally include a quote ID. This way the order can be linked to a quote and enable providing more metadata when analysing order slippage.
      *
      */
     quoteId?: number | null;
     /**
-     * This field comes in two forms for backward compatibility. The hash form will eventually
-     * stop being accepted.
+     * This field comes in two forms for backward compatibility. The hash form will eventually stop being accepted.
      *
      */
     appData: (AppData | AppDataHash);
     /**
-     * May be set for debugging purposes. If set, this field is compared to what the backend
-     * internally calculates as the app data hash based on the contents of `appData`. If the
-     * hash does not match, an error is returned. If this field is set, then `appData` **MUST** be
-     * a string encoding of a JSON object.
+     * May be set for debugging purposes. If set, this field is compared to what the backend internally calculates as the app data hash based on the contents of `appData`. If the hash does not match, an error is returned. If this field is set, then `appData` **MUST** be a string encoding of a JSON object.
      *
      */
     appDataHash?: AppDataHash | null;

package/dist/order-book/generated/models/OrderMetaData.d.ts

@@ -7,8 +7,7 @@ import type { OrderStatus } from './OrderStatus';
 import type { TokenAmount } from './TokenAmount';
 import type { UID } from './UID';
 /**
- * Extra order data that is returned to users when querying orders but not provided by users
- * when creating orders.
+ * Extra order data that is returned to users when querying orders but not provided by users when creating orders.
  *
  */
 export type OrderMetaData = {
@@ -57,40 +56,44 @@ export type OrderMetaData = {
      */
     fullFeeAmount?: TokenAmount;
     /**
-     * Liquidity orders are functionally the same as normal smart contract orders but are not
-     * placed with the intent of actively getting traded. Instead they facilitate the
-     * trade of normal orders by allowing them to be matched against liquidity orders which
-     * uses less gas and can have better prices than external liquidity.
-     *
-     * As such liquidity orders will only be used in order to improve settlement of normal
-     * orders. They should not be expected to be traded otherwise and should not expect to get
-     * surplus.
+     * Liquidity orders are functionally the same as normal smart contract
+     * orders but are not placed with the intent of actively getting
+     * traded. Instead they facilitate the trade of normal orders by
+     * allowing them to be matched against liquidity orders which uses less
+     * gas and can have better prices than external liquidity.
      *
+     * As such liquidity orders will only be used in order to improve
+     * settlement of normal orders. They should not be expected to be
+     * traded otherwise and should not expect to get surplus.
      */
     isLiquidityOrder?: boolean;
     ethflowData?: EthflowData;
     /**
      * This represents the actual trader of an on-chain order.
-     *
      * ### ethflow orders
-     *
      * In this case, the `owner` would be the `EthFlow` contract and *not* the actual trader.
      *
      */
     onchainUser?: Address;
     /**
-     * There is some data only available for orders that are placed on-chain. This data
-     * can be found in this object.
+     * There is some data only available for orders that are placed on-chain. This data can be found in this object.
      *
      */
     onchainOrderData?: OnchainOrderData;
     /**
      * Surplus fee that the limit order was executed with.
      */
-    executedSurplusFee?: BigUint | null;
+    executedSurplusFee?: BigUint;
+    /**
+     * Total fee charged for execution of the order. Contains network fee and protocol fees.
+     */
+    executedFee?: BigUint;
+    /**
+     * Token the executed fee was captured in.
+     */
+    executedFeeToken?: Address;
     /**
-     * Full `appData`, which the contract-level `appData` is a hash of. See `OrderCreation`
-     * for more information.
+     * Full `appData`, which the contract-level `appData` is a hash of. See `OrderCreation` for more information.
      *
      */
     fullAppData?: string | null;

package/dist/order-book/generated/models/OrderParameters.d.ts

@@ -18,8 +18,7 @@ export type OrderParameters = {
      */
     buyToken: Address;
     /**
-     * An optional Ethereum address to receive the proceeds of the trade instead
-     * of the owner (i.e. the order signer).
+     * An optional Ethereum address to receive the proceeds of the trade instead of the owner (i.e. the order signer).
      *
      */
     receiver?: Address | null;

package/dist/order-book/generated/models/OrderQuoteRequest.d.ts

@@ -27,17 +27,22 @@ export type OrderQuoteRequest = (OrderQuoteSide & OrderQuoteValidity & {
     receiver?: Address | null;
     /**
      * AppData which will be assigned to the order.
-     * Expects either a string JSON doc as defined on [AppData](https://github.com/cowprotocol/app-data) or a
-     * hex encoded string for backwards compatibility.
-     * When the first format is used, it's possible to provide the derived appDataHash field.
      *
+     * Expects either a string JSON doc as defined on
+     * [AppData](https://github.com/cowprotocol/app-data) or a hex
+     * encoded string for backwards compatibility.
+     *
+     * When the first format is used, it's possible to provide the
+     * derived appDataHash field.
      */
     appData?: (AppData | AppDataHash);
     /**
      * The hash of the stringified JSON appData doc.
-     * If present, `appData` field must be set with the aforementioned data where this hash is derived from.
-     * In case they differ, the call will fail.
      *
+     * If present, `appData` field must be set with the aforementioned
+     * data where this hash is derived from.
+     *
+     * In case they differ, the call will fail.
      */
     appDataHash?: AppDataHash;
     sellTokenBalance?: SellTokenSource;
@@ -46,8 +51,7 @@ export type OrderQuoteRequest = (OrderQuoteSide & OrderQuoteValidity & {
     priceQuality?: PriceQuality;
     signingScheme?: SigningScheme;
     /**
-     * Flag to signal whether the order is intended for on-chain order placement. Only valid
-     * for non ECDSA-signed orders."
+     * Flag to signal whether the order is intended for on-chain order placement. Only valid for non ECDSA-signed orders."
      *
      */
     onchainOrder?: any;

package/dist/order-book/generated/models/OrderQuoteResponse.d.ts

@@ -15,8 +15,7 @@ export type OrderQuoteResponse = {
      */
     expiration: string;
     /**
-     * Quote ID linked to a quote to enable providing more metadata when analysing
-     * order slippage.
+     * Quote ID linked to a quote to enable providing more metadata when analysing order slippage.
      *
      */
     id?: number;

package/dist/order-book/generated/models/OrderQuoteSide.d.ts

@@ -7,8 +7,7 @@ import type { TokenAmount } from './TokenAmount';
 export type OrderQuoteSide = ({
     kind: OrderQuoteSideKindSell;
     /**
-     * The total amount that is available for the order. From this value, the fee
-     * is deducted and the buy amount is calculated.
+     * The total amount that is available for the order. From this value, the fee is deducted and the buy amount is calculated.
      *
      */
     sellAmountBeforeFee: TokenAmount;

package/dist/order-book/generated/models/PriceQuality.d.ts

@@ -3,10 +3,11 @@
  *
  * Fast: The price estimate is chosen among the fastest N price estimates.
  * Optimal: The price estimate is chosen among all price estimates.
- * Verified: The price estimate is chosen among all verified/simulated price estimates.
- *
- * **NOTE**: Orders are supposed to be created from `verified` or `optimal` price estimates.
+ * Verified: The price estimate is chosen among all verified/simulated
+ * price estimates.
  *
+ * **NOTE**: Orders are supposed to be created from `verified` or `optimal`
+ * price estimates.
  */
 export declare enum PriceQuality {
     FAST = "fast",

package/dist/order-book/generated/models/SolverSettlement.d.ts

@@ -7,8 +7,9 @@ export type SolverSettlement = {
     solver?: string;
     /**
      * The address used by the solver to execute the settlement on-chain.
-     * This field is missing for old settlements, the zero address has been used instead.
      *
+     * This field is missing for old settlements, the zero address has been
+     * used instead.
      */
     solverAddress?: string;
     objective?: {
@@ -39,4 +40,8 @@ export type SolverSettlement = {
         id?: UID;
         executedAmount?: BigUint;
     }>;
+    /**
+     * whether the solution is a winner (received the right to get executed) or not
+     */
+    isWinner?: boolean;
 };

package/dist/order-book/generated/models/UID.d.ts

@@ -1,7 +1,8 @@
 /**
- * Unique identifier for the order: 56 bytes encoded as hex with `0x` prefix.
- * Bytes 0..32 are the order digest, bytes 30..52 the owner address and bytes
- * 52..56 the expiry (`validTo`) as a `uint32` unix epoch timestamp.
+ * Unique identifier for the order: 56 bytes encoded as hex with `0x`
+ * prefix.
  *
+ * Bytes 0..32 are the order digest, bytes 30..52 the owner address and
+ * bytes 52..56 the expiry (`validTo`) as a `uint32` unix epoch timestamp.
  */
 export type UID = string;

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

@@ -1,6 +1,6 @@
 import type { SupportedChainId } from '../common';
 import type { Signer } from '@ethersproject/abstract-signer';
-import type { TypedDataDomain } from '@cowprotocol/contracts';
+import type { Order, TypedDataDomain, OrderUidParams } from '@cowprotocol/contracts';
 import type { SigningResult, UnsignedOrder } from './types';
 /**
  * Utility class for signing order intents and cancellations.
@@ -10,7 +10,7 @@ import type { SigningResult, UnsignedOrder } from './types';
  * @example
  *
  * ```typescript
- * import { OrderSigningUtils, SupportedChainId } from '@cowprotocol/cow-sdk'
+ * import { OrderSigningUtils, SupportedChainId, UnsignedOrder } from '@cowprotocol/cow-sdk'
  * import { Web3Provider } from '@ethersproject/providers'
  *
  * const account = 'YOUR_WALLET_ADDRESS'
@@ -19,10 +19,10 @@ import type { SigningResult, UnsignedOrder } from './types';
  * const signer = provider.getSigner()
  *
  * async function main() {
- *     const { order: Order } = { ... }
- *     const orderSigningResult = await OrderSigningUtils.signOrder(quote, chainId, signer)
+ *     const orderToSign: UnsignedOrder = { ... }
+ *     const orderSigningResult = await OrderSigningUtils.signOrder(orderToSign, chainId, signer)
  *
- *     const orderId = await orderBookApi.sendOrder({ ...quote, ...orderSigningResult })
+ *     const orderId = await orderBookApi.sendOrder({ ...orderToSign, ...orderSigningResult })
  *
  *     const order = await orderBookApi.getOrder(orderId)
  *
@@ -60,18 +60,28 @@ export declare class OrderSigningUtils {
     /**
      * 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 protocol `chainId` context that's being used.
+     * @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 protocol `chainId` context that's being used.
+     * @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.
@@ -83,5 +93,5 @@ export declare class OrderSigningUtils {
      * 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, any>;
+    static getEIP712Types(): Record<string, unknown>;
 }

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

@@ -1,4 +1,4 @@
-import type { TypedDataDomain } from '@cowprotocol/contracts';
+import type { TypedDataDomain, Order, OrderUidParams } from '@cowprotocol/contracts';
 import type { Signer } from '@ethersproject/abstract-signer';
 import type { SigningResult, UnsignedOrder } from './types';
 import { SupportedChainId } from '../common';
@@ -37,3 +37,13 @@ export declare function signOrderCancellations(orderUids: string[], chainId: Sup
  * @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": "5.8.0",
+  "version": "5.10.0-RC.0",
   "license": "(MIT OR Apache-2.0)",
   "files": [
     "/dist"
@@ -17,7 +17,7 @@
     "prebuild": "rm -rf dist && yarn run codegen",
     "build": "microbundle -f modern,esm,cjs",
     "start": "microbundle -f modern,esm,cjs watch",
-    "postbuild": "cp package.json dist && cp README.md dist",
+    "postbuild": "cp package.json dist && cp README.md dist && yarn run trading:generateSchemas",
     "lint": "eslint src",
     "format": "prettier --write \"src/**/*.+(ts|json)\"",
     "test": "jest",
@@ -27,10 +27,12 @@
     "prepare": "npm run build",
     "prepublishOnly": "npm test && npm run lint",
     "graphql:codegen": "graphql-codegen --config graphql-codegen.yml",
-    "swagger:codegen": " openapi --input https://raw.githubusercontent.com/cowprotocol/services/v2.281.0/crates/orderbook/openapi.yml --output src/order-book/generated --exportServices false --exportCore false",
-    "typechain:codegen": "typechain --target ethers-v5 --out-dir ./src/common/generated './abi/*.json'"
+    "swagger:codegen": " openapi --input https://raw.githubusercontent.com/cowprotocol/services/v2.291.0/crates/orderbook/openapi.yml --output src/order-book/generated --exportServices false --exportCore false",
+    "typechain:codegen": "typechain --target ethers-v5 --out-dir ./src/common/generated './abi/*.json'",
+    "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",
@@ -53,7 +55,7 @@
     "@graphql-codegen/typescript-operations": "^3.0.0",
     "@typechain/ethers-v5": "^11.0.0",
     "@types/jest": "^29.4.0",
-    "@types/node": "^18.13.0",
+    "@types/node": "^22.9.0",
     "@typescript-eslint/eslint-plugin": "^5.51.0",
     "@typescript-eslint/parser": "^5.51.0",
     "babel-plugin-inline-import": "^3.0.0",
@@ -68,6 +70,7 @@
     "microbundle": "^0.15.1",
     "openapi-typescript-codegen": "^0.23.0",
     "prettier": "^2.5.1",
+    "ts-json-schema-generator": "^2.3.0",
     "ts-mockito": "^2.6.1",
     "tsc-watch": "^6.0.0",
     "typechain": "^8.2.0",