@cowprotocol/cow-sdk 2.3.0 → 2.4.0-rc.0

package/dist/order-book/api.d.ts

@@ -2,36 +2,230 @@ import 'cross-fetch/polyfill';
 import { Address, AppDataDocument, AppDataHash, NativePriceResponse, OrderCancellations, OrderCreation, OrderQuoteRequest, OrderQuoteResponse, SolverCompetitionResponse, TotalSurplus, Trade, TransactionHash, UID } from './generated';
 import { ApiContext, ApiBaseUrls, PartialApiContext, RequestOptions } from '../common/configs';
 import { EnrichedOrder } from './types';
+/**
+ * An object containing *production* environment base URLs for each supported `chainId`.
+ * @see {@link https://api.cow.fi/docs/#/}
+ */
 export declare const ORDER_BOOK_PROD_CONFIG: ApiBaseUrls;
+/**
+ * An object containing *staging* environment base URLs for each supported `chainId`.
+ */
 export declare const ORDER_BOOK_STAGING_CONFIG: ApiBaseUrls;
+/**
+ * The parameters for the `getOrders` request.
+ */
+export type GetOrdersRequest = {
+    owner: Address;
+    offset?: number;
+    limit?: number;
+};
+/**
+ * The CoW Protocol OrderBook API client.
+ *
+ * This is the main entry point for interacting with the CoW Protocol OrderBook API. The main advantage of using
+ * this client is the batteries-included approach to interacting with the API. It handles:
+ *
+ * - Environment configuration (mainnet, staging, etc.)
+ * - Rate limiting
+ * - Retries
+ * - Backoff
+ * - Error handling
+ * - Request signing
+ * - Request validation
+ *
+ * @example
+ *
+ * ```typescript
+ * import { OrderBookApi, OrderSigningUtils, SupportedChainId } from '@cowprotocol/cow-sdk'
+ * import { Web3Provider } from '@ethersproject/providers'
+ *
+ * const account = 'YOUR_WALLET_ADDRESS'
+ * const chainId = 5 // Goerli
+ * const provider = new Web3Provider(window.ethereum)
+ * const signer = provider.getSigner()
+ *
+ * const quoteRequest = {
+ *   sellToken: '0xb4fbf271143f4fbf7b91a5ded31805e42b2208d6', // WETH goerli
+ *   buyToken: '0x02abbdbaaa7b1bb64b5c878f7ac17f8dda169532', // GNO goerli
+ *   from: account,
+ *   receiver: account,
+ *   sellAmountBeforeFee: (0.4 * 10 ** 18).toString(), // 0.4 WETH
+ *   kind: OrderQuoteSide.kind.SELL,
+ * }
+ *
+ * const orderBookApi = new OrderBookApi({ chainId: SupportedChainId.GOERLI })
+ *
+ * async function main() {
+ *     const { quote } = await orderBookApi.getQuote(quoteRequest)
+ *
+ *     const orderSigningResult = await OrderSigningUtils.signOrder(quote, chainId, signer)
+ *
+ *     const orderId = await orderBookApi.sendOrder({ ...quote, ...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 })
+ * }
+ * ```
+ *
+ * @see {@link Swagger documentation https://api.cow.fi/docs/#/}
+ * @see {@link OrderBook API https://github.com/cowprotocol/services}
+ */
 export declare class OrderBookApi {
     context: ApiContext & RequestOptions;
     private rateLimiter;
+    /**
+     * Creates a new instance of the CoW Protocol OrderBook API client.
+     * @param context - The API context to use. If not provided, the default context will be used.
+     */
     constructor(context?: PartialApiContext & RequestOptions);
+    /**
+     * Get the version of the API.
+     * @param contextOverride Optional context override for this request.
+     * @returns The version of the API.
+     * @see {@link https://api.cow.fi/docs/#/default/get_api_v1_version}
+     */
     getVersion(contextOverride?: PartialApiContext): Promise<string>;
+    /**
+     * Get all the trades for either an `owner` **OR** `orderUid`.
+     *
+     * Given that an order *may* be partially fillable, it is possible that a discrete order (`orderUid`)
+     * may have *multiple* trades. Therefore, this method returns a list of trades, either for *all* the orders
+     * of a given `owner`, or for a discrete order (`orderUid`).
+     * @param request Either an `owner` or an `orderUid` **MUST** be specified.
+     * @param contextOverride Optional context override for this request.
+     * @returns A list of trades matching the request.
+     */
     getTrades(request: {
         owner?: Address;
         orderUid?: UID;
     }, contextOverride?: PartialApiContext): Promise<Array<Trade>>;
-    getOrders({ owner, offset, limit, }: {
-        owner: Address;
-        offset?: number;
-        limit?: number;
-    }, contextOverride?: PartialApiContext): Promise<Array<EnrichedOrder>>;
+    /**
+     * Get a list of orders for a given `owner`.
+     * @param request The request parameters with `request.offset = 0` and `request.limit = 1000` by default.
+     * @param contextOverride Optional context override for this request.
+     * @returns A list of orders matching the request.
+     * @see {@link GetOrdersRequest}
+     * @see {@link EnrichedOrder}
+     */
+    getOrders({ owner, offset, limit }: GetOrdersRequest, contextOverride?: PartialApiContext): Promise<Array<EnrichedOrder>>;
+    /**
+     * Get a list of orders from a given settlement transaction hash.
+     * @param txHash The transaction hash.
+     * @param contextOverride Optional context override for this request.
+     * @returns A list of orders matching the request.
+     * @see {@link EnrichedOrder}
+     */
     getTxOrders(txHash: TransactionHash, contextOverride?: PartialApiContext): Promise<Array<EnrichedOrder>>;
-    getOrder(uid: UID, contextOverride?: PartialApiContext): Promise<EnrichedOrder>;
-    getOrderMultiEnv(uid: UID, contextOverride?: PartialApiContext): Promise<EnrichedOrder>;
+    /**
+     * Get an order by its unique identifier, `orderUid`.
+     * @param orderUid The unique identifier of the order.
+     * @param contextOverride Optional context override for this request.
+     * @returns The order matching the request.
+     */
+    getOrder(orderUid: UID, contextOverride?: PartialApiContext): Promise<EnrichedOrder>;
+    /**
+     * Attempt to get an order by its unique identifier, `orderUid`, from multiple environments.
+     *
+     * **NOTE**: The environment refers to either `prod` or `staging`. This allows a conveience method to
+     * attempt to get an order from both environments, in the event that the order is not found in the
+     * environment specified in the context.
+     * @param orderUid The unique identifier of the order.
+     * @param contextOverride Optional context override for this request.
+     * @returns The order matching the request.
+     * @throws {OrderBookApiError} If the order is not found in any of the environments.
+     */
+    getOrderMultiEnv(orderUid: UID, contextOverride?: PartialApiContext): Promise<EnrichedOrder>;
+    /**
+     * Get a quote for an order.
+     * This allows for the calculation of the total cost of an order, including fees, before signing and submitting.
+     * @param requestBody The parameters for the order quote request.
+     * @param contextOverride Optional context override for this request.
+     * @returns A hydrated order matching the request ready to be signed.
+     */
     getQuote(requestBody: OrderQuoteRequest, contextOverride?: PartialApiContext): Promise<OrderQuoteResponse>;
+    /**
+     * Cancel one or more orders.
+     *
+     * **NOTE**: Cancellation is on a best-effort basis. Orders that are already in the process of being settled
+     * (ie. transaction has been submitted to chain by the solver) cannot not be cancelled.
+     * **CAUTION**: This method can only be used to cancel orders that were signed using `EIP-712` or `eth_sign (EIP-191)`.
+     * @param requestBody Orders to be cancelled and signed instructions to cancel them.
+     * @param contextOverride Optional context override for this request.
+     * @returns A list of order unique identifiers that were successfully cancelled.
+     */
     sendSignedOrderCancellations(requestBody: OrderCancellations, contextOverride?: PartialApiContext): Promise<void>;
+    /**
+     * Submit an order to the order book.
+     * @param requestBody The signed order to be submitted.
+     * @param contextOverride Optional context override for this request.
+     * @returns The unique identifier of the order.
+     */
     sendOrder(requestBody: OrderCreation, contextOverride?: PartialApiContext): Promise<UID>;
+    /**
+     * Get the native price of a token.
+     *
+     * **NOTE**: The native price is the price of the token in the native currency of the chain. For example, on Ethereum
+     * this would be the price of the token in ETH.
+     * @param tokenAddress The address of the ERC-20 token.
+     * @param contextOverride Optional context override for this request.
+     * @returns The native price of the token.
+     */
     getNativePrice(tokenAddress: Address, contextOverride?: PartialApiContext): Promise<NativePriceResponse>;
+    /**
+     * Given a user's address, get the total surplus that they have earned.
+     * @param address The user's address
+     * @param contextOverride Optional context override for this request.
+     * @returns Calculated user's surplus
+     */
     getTotalSurplus(address: Address, contextOverride?: PartialApiContext): Promise<TotalSurplus>;
+    /**
+     * Retrieve the full app data for a given app data hash.
+     * @param appDataHash `bytes32` hash of the app data
+     * @param contextOverride Optional context override for this request.
+     * @returns Full app data that was uploaded
+     */
     getAppData(appDataHash: AppDataHash, contextOverride?: PartialApiContext): Promise<AppDataDocument>;
+    /**
+     * Upload the full app data that corresponds to a given app data hash.
+     * @param appDataHash `bytes32` hash of the app data
+     * @param fullAppData Full app data to be uploaded
+     * @param contextOverride Optional context override for this request.
+     * @returns The string encoding of the full app data that was uploaded.
+     */
     uploadAppData(appDataHash: AppDataHash, fullAppData: string, contextOverride?: PartialApiContext): Promise<AppDataDocument>;
     getSolverCompetition(auctionId: number, contextOverride?: PartialApiContext): Promise<SolverCompetitionResponse>;
     getSolverCompetition(txHash: string, contextOverride?: PartialApiContext): Promise<SolverCompetitionResponse>;
-    getOrderLink(uid: UID, contextOverride?: PartialApiContext): string;
+    /**
+     * Generate an API endpoint for an order by its unique identifier, `orderUid`.
+     * @param orderUid The unique identifier of the order.
+     * @param contextOverride Optional context override for this request.
+     * @returns The API endpoint to get the order.
+     */
+    getOrderLink(orderUid: UID, contextOverride?: PartialApiContext): string;
+    /**
+     * Apply an override to the context for a request.
+     * @param contextOverride Optional context override for this request.
+     * @returns New context with the override applied.
+     */
     private getContextWithOverride;
+    /**
+     * Get the base URLs for the API endpoints given the environment.
+     * @param env The environment to get the base URLs for.
+     * @returns The base URLs for the API endpoints.
+     */
     private getApiBaseUrls;
+    /**
+     * Make a request to the API.
+     * @param params The parameters for the request.
+     * @param contextOverride Optional context override for this request.
+     * @returns The response from the API.
+     */
     private fetch;
 }

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

@@ -25,7 +25,9 @@ export type { OrderParameters } from './models/OrderParameters';
 export { OrderPostError } from './models/OrderPostError';
 export type { OrderQuoteRequest } from './models/OrderQuoteRequest';
 export type { OrderQuoteResponse } from './models/OrderQuoteResponse';
-export { OrderQuoteSide } from './models/OrderQuoteSide';
+export type { OrderQuoteSide } from './models/OrderQuoteSide';
+export { OrderQuoteSideKindBuy } from './models/OrderQuoteSideKindBuy';
+export { OrderQuoteSideKindSell } from './models/OrderQuoteSideKindSell';
 export type { OrderQuoteValidity } from './models/OrderQuoteValidity';
 export { OrderStatus } from './models/OrderStatus';
 export type { PreSignature } from './models/PreSignature';

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

@@ -1,9 +1,11 @@
+import type { OrderQuoteSideKindBuy } from './OrderQuoteSideKindBuy';
+import type { OrderQuoteSideKindSell } from './OrderQuoteSideKindSell';
 import type { TokenAmount } from './TokenAmount';
 /**
  * The buy or sell side when quoting an order.
  */
 export type OrderQuoteSide = ({
-    kind: OrderQuoteSide.kind;
+    kind: OrderQuoteSideKindSell;
     /**
      * The total amount that is available for the order. From this value, the fee
      * is deducted and the buy amount is calculated.
@@ -11,20 +13,15 @@ export type OrderQuoteSide = ({
      */
     sellAmountBeforeFee: TokenAmount;
 } | {
-    kind: OrderQuoteSide.kind;
+    kind: OrderQuoteSideKindSell;
     /**
      * The `sellAmount` for the order.
      */
     sellAmountAfterFee: TokenAmount;
 } | {
-    kind: OrderQuoteSide.kind;
+    kind: OrderQuoteSideKindBuy;
     /**
      * The `buyAmount` for the order.
      */
     buyAmountAfterFee: TokenAmount;
 });
-export declare namespace OrderQuoteSide {
-    enum kind {
-        SELL = "sell"
-    }
-}

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

@@ -0,0 +1,3 @@
+export declare enum OrderQuoteSideKindBuy {
+    BUY = "buy"
+}

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

@@ -0,0 +1,3 @@
+export declare enum OrderQuoteSideKindSell {
+    SELL = "sell"
+}

package/dist/order-book/request.d.ts

@@ -1,16 +1,49 @@
 import { BackoffOptions } from 'exponential-backoff';
 import { RateLimiter, RateLimiterOpts } from 'limiter';
+/**
+ * Error thrown when the CoW Protocol OrderBook API returns an error.
+ */
 export declare class OrderBookApiError<T = unknown> extends Error {
     readonly response: Response;
     readonly body: T;
+    /**
+     * Error thrown when the CoW Protocol OrderBook API returns an error.
+     * @param response The response from the CoW Protocol OrderBook API.
+     * @param body The body of the response.
+     * @constructor
+     */
     constructor(response: Response, body: T);
 }
+/**
+ * The default backoff options for CoW Protocol's API
+ * @see {@link Backoff configuration: https://www.npmjs.com/package/@insertish/exponential-backoff}
+ */
 export declare const DEFAULT_BACKOFF_OPTIONS: BackoffOptions;
+/**
+ * The default rate limiter options for CoW Protocol's API.
+ *
+ * **CAUTION**: The CoW Protocol OrderBook API is limited to 5 requests per second per IP.
+ */
 export declare const DEFAULT_LIMITER_OPTIONS: RateLimiterOpts;
+/**
+ * Describe the parameters for a fetch request.
+ */
 export interface FetchParams {
     path: string;
     method: 'GET' | 'POST' | 'DELETE' | 'PUT';
     body?: unknown;
     query?: URLSearchParams;
 }
+/**
+ * Helper function to make a rate-limited request to an API.
+ * @param baseUrl The base URL of the API.
+ * @param path The path of the request.
+ * @param query The query parameters of the request.
+ * @param method The HTTP method of the request.
+ * @param body The body of the request.
+ * @param rateLimiter The rate limiter to use.
+ * @param backoffOpts The backoff options to use.
+ * @returns The response of the request.
+ * @throws If the API returns an error or if the request fails.
+ */
 export declare function request<T>(baseUrl: string, { path, query, method, body }: FetchParams, rateLimiter: RateLimiter, backoffOpts: BackoffOptions): Promise<T>;

package/dist/order-book/transformOrder.d.ts

@@ -1,4 +1,10 @@
 import { Order } from './generated';
 import { EnrichedOrder } from './types';
-export declare const BUY_ETH_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
+/**
+ * Apply programmatic transformations to an order.
+ *
+ * For example, transformations may be applied to an order to recognise it as a Native EthFlow order.
+ * @param order to apply transformations to
+ * @returns An order with the total fee added.
+ */
 export declare function transformOrder(order: Order): EnrichedOrder;

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

@@ -1,4 +1,7 @@
 import { Order } from './generated';
+/**
+ * An order with the total fee added.
+ */
 export interface EnrichedOrder extends Order {
     totalFee: string;
 }

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

@@ -2,9 +2,86 @@ import type { SupportedChainId } from '../common';
 import type { Signer } from '@ethersproject/abstract-signer';
 import type { TypedDataDomain } 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 } from '@cowprotocol/cow-sdk'
+ * import { Web3Provider } from '@ethersproject/providers'
+ *
+ * const account = 'YOUR_WALLET_ADDRESS'
+ * const chainId = 5 // Goerli
+ * const provider = new Web3Provider(window.ethereum)
+ * const signer = provider.getSigner()
+ *
+ * async function main() {
+ *     const { order: Order } = { ... }
+ *     const orderSigningResult = await OrderSigningUtils.signOrder(quote, chainId, signer)
+ *
+ *     const orderId = await orderBookApi.sendOrder({ ...quote, ...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>;
-    static signOrderCancellation(orderId: string, chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
-    static signOrderCancellations(orderUid: string[], 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 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.
+     * @return The EIP-712 typed domain data.
+     * @see https://eips.ethereum.org/EIPS/eip-712
+     */
     static getDomain(chainId: SupportedChainId): Promise<TypedDataDomain>;
+    /**
+     * 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, any>;
 }

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

@@ -1,25 +1,52 @@
 import type { SupportedChainId } from '../common';
 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;
-    orderId: string;
+    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;

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

@@ -5,7 +5,6 @@ import { SupportedChainId } from '../common';
 /**
  * Returns the signature for the specified order with the signing scheme encoded
  * into the signature.
- * @export
  * @param {UnsignedOrder} order The order to sign.
  * @param {SupportedChainId} chainId The chain Id
  * @param {Signer} signer The owner for the order used to sign.
@@ -15,13 +14,26 @@ export declare function signOrder(order: UnsignedOrder, chainId: SupportedChainI
 /**
  * Returns the signature for the Order Cancellation with the signing scheme encoded
  * into the signature.
- *
- * @export
- * @param {string} orderId The unique identifier of the order being cancelled.
+ * @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(orderId: string, chainId: SupportedChainId, signer: Signer): Promise<SigningResult>;
+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;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/cow-sdk",
-  "version": "2.3.0",
+  "version": "2.4.0-rc.0",
   "license": "(MIT OR Apache-2.0)",
   "files": [
     "/dist"
@@ -22,19 +22,22 @@
     "format": "prettier --write \"src/**/*.+(ts|json)\"",
     "test": "jest",
     "test:coverage": "jest --coverage --json --outputFile=jest.results.json && cat ./coverage/lcov.info | coveralls",
-    "codegen": "npm run graphql:codegen && npm run swagger:codegen",
+    "test:coverage:html": "jest --silent=false --coverage --coverageReporters html",
+    "codegen": "npm run graphql:codegen && npm run swagger:codegen && npm run typechain:codegen",
     "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/main/crates/orderbook/openapi.yml --output src/order-book/generated --exportServices false --exportCore false"
+    "swagger:codegen": " openapi --input https://raw.githubusercontent.com/cowprotocol/services/v2.119.0/crates/orderbook/openapi.yml --output src/order-book/generated --exportServices false --exportCore false",
+    "typechain:codegen": "typechain --target ethers-v5 --out-dir ./src/composable/generated './abi/*.json'"
   },
   "dependencies": {
     "@cowprotocol/contracts": "^1.4.0",
     "@ethersproject/abstract-signer": "^5.7.0",
-    "exponential-backoff": "^3.1.1",
-    "limiter": "^2.1.0",
+    "@openzeppelin/merkle-tree": "^1.0.5",
     "cross-fetch": "^3.1.5",
-    "graphql-request": "^4.3.0"
+    "exponential-backoff": "^3.1.1",
+    "graphql-request": "^4.3.0",
+    "limiter": "^2.1.0"
   },
   "peerDependencies": {
     "ethers": "^5.7.2"
@@ -47,6 +50,7 @@
     "@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": "^18.13.0",
     "@typescript-eslint/eslint-plugin": "^5.51.0",
@@ -56,6 +60,7 @@
     "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.7.2",
     "graphql": "^16.3.0",
     "jest": "^29.4.2",
@@ -65,6 +70,7 @@
     "prettier": "^2.5.1",
     "ts-mockito": "^2.6.1",
     "tsc-watch": "^6.0.0",
+    "typechain": "^8.2.0",
     "typescript": "^4.9.5"
   },
   "jest": {
@@ -75,6 +81,9 @@
     ],
     "collectCoverageFrom": [
       "src/**/*.{ts,tsx}"
+    ],
+    "coveragePathIgnorePatterns": [
+      "src/composable/generated"
     ]
   },
   "keywords": [