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

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

@@ -1,10 +1,10 @@
-/**
- * The total surplus.
- *
- */
-export type TotalSurplus = {
-    /**
-     * The total surplus.
-     */
-    totalSurplus?: string;
-};
+/**
+ * The total surplus.
+ *
+ */
+export type TotalSurplus = {
+    /**
+     * The total surplus.
+     */
+    totalSurplus?: string;
+};

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

@@ -1,57 +1,57 @@
-import type { Address } from './Address';
-import type { BigUint } from './BigUint';
-import type { ExecutedProtocolFee } from './ExecutedProtocolFee';
-import type { TokenAmount } from './TokenAmount';
-import type { TransactionHash } from './TransactionHash';
-import type { UID } from './UID';
-/**
- * Trade data such as executed amounts, fees, `orderUid` and `block` number.
- *
- */
-export type Trade = {
-    /**
-     * Block in which trade occurred.
-     */
-    blockNumber: number;
-    /**
-     * Index in which transaction was included in block.
-     */
-    logIndex: number;
-    /**
-     * UID of the order matched by this trade.
-     */
-    orderUid: UID;
-    /**
-     * Address of trader.
-     */
-    owner: Address;
-    /**
-     * Address of token sold.
-     */
-    sellToken: Address;
-    /**
-     * Address of token bought.
-     */
-    buyToken: Address;
-    /**
-     * Total amount of `sellToken` that has been executed for this trade (including fees).
-     */
-    sellAmount: TokenAmount;
-    /**
-     * The total amount of `sellToken` that has been executed for this order without fees.
-     */
-    sellAmountBeforeFees: BigUint;
-    /**
-     * Total amount of `buyToken` received in this trade.
-     */
-    buyAmount: TokenAmount;
-    /**
-     * Transaction hash of the corresponding settlement transaction containing the trade (if available).
-     */
-    txHash: TransactionHash | null;
-    /**
-     * Executed protocol fees for this trade, together with the fee policies used. Listed in the order they got applied.
-     *
-     */
-    executedProtocolFees?: Array<ExecutedProtocolFee>;
-};
+import type { Address } from './Address';
+import type { BigUint } from './BigUint';
+import type { ExecutedProtocolFee } from './ExecutedProtocolFee';
+import type { TokenAmount } from './TokenAmount';
+import type { TransactionHash } from './TransactionHash';
+import type { UID } from './UID';
+/**
+ * Trade data such as executed amounts, fees, `orderUid` and `block` number.
+ *
+ */
+export type Trade = {
+    /**
+     * Block in which trade occurred.
+     */
+    blockNumber: number;
+    /**
+     * Index in which transaction was included in block.
+     */
+    logIndex: number;
+    /**
+     * UID of the order matched by this trade.
+     */
+    orderUid: UID;
+    /**
+     * Address of trader.
+     */
+    owner: Address;
+    /**
+     * Address of token sold.
+     */
+    sellToken: Address;
+    /**
+     * Address of token bought.
+     */
+    buyToken: Address;
+    /**
+     * Total amount of `sellToken` that has been executed for this trade (including fees).
+     */
+    sellAmount: TokenAmount;
+    /**
+     * The total amount of `sellToken` that has been executed for this order without fees.
+     */
+    sellAmountBeforeFees: BigUint;
+    /**
+     * Total amount of `buyToken` received in this trade.
+     */
+    buyAmount: TokenAmount;
+    /**
+     * Transaction hash of the corresponding settlement transaction containing the trade (if available).
+     */
+    txHash: TransactionHash | null;
+    /**
+     * Executed protocol fees for this trade, together with the fee policies used. Listed in the order they got applied.
+     *
+     */
+    executedProtocolFees?: Array<ExecutedProtocolFee>;
+};

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

@@ -1,4 +1,4 @@
-/**
- * 32 byte digest encoded as a hex with `0x` prefix.
- */
-export type TransactionHash = string;
+/**
+ * 32 byte digest encoded as a hex with `0x` prefix.
+ */
+export type TransactionHash = string;

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

@@ -1,8 +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.
- */
-export type UID = string;
+/**
+ * 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-book/generated/models/Volume.d.ts

@@ -1,6 +1,6 @@
-/**
- * The protocol fee is taken as a percent of the order volume.
- */
-export type Volume = {
-    factor: number;
-};
+/**
+ * The protocol fee is taken as a percent of the order volume.
+ */
+export type Volume = {
+    factor: number;
+};

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

@@ -1,5 +1,5 @@
-export * from './api';
-export * from './types';
-export * from './generated';
-export * from './request';
-export * from './quoteAmountsAndCostsUtils';
+export * from './api';
+export * from './types';
+export * from './generated';
+export * from './request';
+export * from './quoteAmountsAndCostsUtils';

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

@@ -1,63 +1,63 @@
-export declare const AUCTION: {
-    auctionId: number;
-    transactionHash: string;
-    gasPrice: number;
-    auctionStartBlock: number;
-    liquidityCollectedBlock: number;
-    competitionSimulationBlock: number;
-    auction: {
-        orders: string[];
-        prices: {
-            '0x6b175474e89094c44da98b954eedeac495271d0f': string;
-            '0x853d955acef822db058eb8505911ed77f175b99e': string;
-            '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48': string;
-            '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2': string;
-            '0xdac17f958d2ee523a2206206994597c13d831ec7': string;
-        };
-    };
-    solutions: ({
-        solver: string;
-        solverAddress: string;
-        objective: {
-            total: number;
-            surplus: number;
-            fees: number;
-            cost: number;
-            gas: number;
-        };
-        scoreDiscounted: string;
-        ranking: number;
-        clearingPrices: {
-            '0x6b175474e89094c44da98b954eedeac495271d0f': string;
-            '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2': string;
-        };
-        orders: {
-            id: string;
-            executedAmount: string;
-        }[];
-        callData: string;
-        score?: undefined;
-    } | {
-        solver: string;
-        solverAddress: string;
-        objective: {
-            total: number;
-            surplus: number;
-            fees: number;
-            cost: number;
-            gas: number;
-        };
-        score: string;
-        ranking: number;
-        clearingPrices: {
-            '0x6b175474e89094c44da98b954eedeac495271d0f': string;
-            '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2': string;
-        };
-        orders: {
-            id: string;
-            executedAmount: string;
-        }[];
-        callData: string;
-        scoreDiscounted?: undefined;
-    })[];
-};
+export declare const AUCTION: {
+    auctionId: number;
+    transactionHash: string;
+    gasPrice: number;
+    auctionStartBlock: number;
+    liquidityCollectedBlock: number;
+    competitionSimulationBlock: number;
+    auction: {
+        orders: string[];
+        prices: {
+            '0x6b175474e89094c44da98b954eedeac495271d0f': string;
+            '0x853d955acef822db058eb8505911ed77f175b99e': string;
+            '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48': string;
+            '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2': string;
+            '0xdac17f958d2ee523a2206206994597c13d831ec7': string;
+        };
+    };
+    solutions: ({
+        solver: string;
+        solverAddress: string;
+        objective: {
+            total: number;
+            surplus: number;
+            fees: number;
+            cost: number;
+            gas: number;
+        };
+        scoreDiscounted: string;
+        ranking: number;
+        clearingPrices: {
+            '0x6b175474e89094c44da98b954eedeac495271d0f': string;
+            '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2': string;
+        };
+        orders: {
+            id: string;
+            executedAmount: string;
+        }[];
+        callData: string;
+        score?: undefined;
+    } | {
+        solver: string;
+        solverAddress: string;
+        objective: {
+            total: number;
+            surplus: number;
+            fees: number;
+            cost: number;
+            gas: number;
+        };
+        score: string;
+        ranking: number;
+        clearingPrices: {
+            '0x6b175474e89094c44da98b954eedeac495271d0f': string;
+            '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2': string;
+        };
+        orders: {
+            id: string;
+            executedAmount: string;
+        }[];
+        callData: string;
+        scoreDiscounted?: undefined;
+    })[];
+};

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

@@ -1,22 +1,35 @@
-import { QuoteAmountsAndCosts } from './types';
-import { type OrderParameters } from './generated';
-export interface QuoteAmountsAndCostsParams {
-    orderParams: OrderParameters;
-    sellDecimals: number;
-    buyDecimals: number;
-    slippagePercentBps: number;
-    partnerFeeBps: number | undefined;
-}
-export declare function getQuoteAmountsAndCosts(params: QuoteAmountsAndCostsParams): QuoteAmountsAndCosts;
-type BigNumber = {
-    big: bigint;
-    num: number;
-};
-/**
- * BigInt works well with subtraction and addition, but it's not very good with multiplication and division
- * To multiply/divide token amounts we have to convert them to numbers, but we have to be careful with precision
- * @param value
- * @param decimals
- */
-export declare function getBigNumber(value: string | bigint | number, decimals: number): BigNumber;
-export {};
+import { QuoteAmountsAndCosts } from './types';
+import { type OrderParameters } from './generated';
+export interface QuoteAmountsAndCostsParams {
+    orderParams: OrderParameters;
+    sellDecimals: number;
+    buyDecimals: number;
+    slippagePercentBps: number;
+    partnerFeeBps: number | undefined;
+}
+export declare function getQuoteAmountsWithCosts(params: {
+    sellDecimals: number;
+    buyDecimals: number;
+    orderParams: OrderParameters;
+}): {
+    isSell: boolean;
+    quotePrice: number;
+    sellAmountAfterNetworkCosts: bigint;
+    buyAmountAfterNetworkCosts: bigint;
+    buyAmountBeforeNetworkCosts: bigint;
+    networkCostAmount: bigint;
+    sellAmountBeforeNetworkCosts: bigint;
+};
+export declare function getQuoteAmountsAndCosts(params: QuoteAmountsAndCostsParams): QuoteAmountsAndCosts;
+type BigNumber = {
+    big: bigint;
+    num: number;
+};
+/**
+ * BigInt works well with subtraction and addition, but it's not very good with multiplication and division
+ * To multiply/divide token amounts we have to convert them to numbers, but we have to be careful with precision
+ * @param value
+ * @param decimals
+ */
+export declare function getBigNumber(value: string | bigint | number, decimals: number): BigNumber;
+export {};

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

@@ -1,49 +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>;
+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,10 +1,10 @@
-import { Order } from './generated';
-import { EnrichedOrder } from './types';
-/**
- * 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;
+import { Order } from './generated';
+import { EnrichedOrder } from './types';
+/**
+ * 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,74 +1,74 @@
-import { Order } from './generated';
-/**
- * An order with the total fee added.
- */
-export interface EnrichedOrder extends Order {
-    totalFee: string;
-}
-export interface Amounts<T> {
-    sellAmount: T;
-    buyAmount: T;
-}
-export interface Costs<T> {
-    networkFee: {
-        amountInSellCurrency: T;
-        amountInBuyCurrency: T;
-    };
-    partnerFee: {
-        amount: T;
-        bps: number;
-    };
-}
-/**
- * Details about costs and amounts, costs and fees of a quote.
- *
- * CoW Protocol quote has amounts (sell/buy) and costs (network fee), there is also partner fees.
- * Besides that, CoW Protocol supports both sell and buy orders and the fees and costs are calculated differently.
- *
- * The order of adding fees and costs is as follows:
- * 1. Network fee is always added to the sell amount
- * 2. Partner fee is added to the surplus amount (sell amount for sell-orders, buy amount for buy-orders)
- *
- * For sell-orders the partner fee is subtracted from the buy amount after network costs.
- * For buy-orders the partner fee is added on top of the sell amount after network costs.
- */
-export interface QuoteAmountsAndCosts<T = bigint> {
-    /**
-     * Whether the quote is a sell or buy order.
-     */
-    isSell: boolean;
-    /**
-     * Estimated costs of settling the order.
-     *
-     * Costs are only payed if the order is executed. They cover the concept of gas costs to pay the solver for settling
-     * your order onchain for you.
-     *
-     * They are payed in the sell token although for convenience, the costs data includes also the buy token
-     * so UIs can decide how to show it to the user.
-     */
-    costs: Costs<T>;
-    /**
-     * Amounts before network costs. This amount could be shown to the user to reflect how much they are expected to get
-     * before applying any costs or fees (if costs and fees are displayed separately).
-     */
-    beforeNetworkCosts: Amounts<T>;
-    /**
-     * Amounts after including network costs.
-     */
-    afterNetworkCosts: Amounts<T>;
-    /**
-     * Amounts after including partner fees (if any).
-     *
-     * This amount could be shown to the user, as the expected to receive amount already including any fees or costs.
-     */
-    afterPartnerFees: Amounts<T>;
-    /**
-     * Amounts after including the slippage tolerance.
-     *
-     * This is the minimum that the user will receive and the amount they will sign.
-     *
-     * It already accounts for all costs, fees and some slippage tolerance so they can execute the order even in the
-     * event of the buy token appreciating.
-     */
-    afterSlippage: Amounts<T>;
-}
+import { Order } from './generated';
+/**
+ * An order with the total fee added.
+ */
+export interface EnrichedOrder extends Order {
+    totalFee: string;
+}
+export interface Amounts<T> {
+    sellAmount: T;
+    buyAmount: T;
+}
+export interface Costs<T> {
+    networkFee: {
+        amountInSellCurrency: T;
+        amountInBuyCurrency: T;
+    };
+    partnerFee: {
+        amount: T;
+        bps: number;
+    };
+}
+/**
+ * Details about costs and amounts, costs and fees of a quote.
+ *
+ * CoW Protocol quote has amounts (sell/buy) and costs (network fee), there is also partner fees.
+ * Besides that, CoW Protocol supports both sell and buy orders and the fees and costs are calculated differently.
+ *
+ * The order of adding fees and costs is as follows:
+ * 1. Network fee is always added to the sell amount
+ * 2. Partner fee is added to the surplus amount (sell amount for sell-orders, buy amount for buy-orders)
+ *
+ * For sell-orders the partner fee is subtracted from the buy amount after network costs.
+ * For buy-orders the partner fee is added on top of the sell amount after network costs.
+ */
+export interface QuoteAmountsAndCosts<T = bigint> {
+    /**
+     * Whether the quote is a sell or buy order.
+     */
+    isSell: boolean;
+    /**
+     * Estimated costs of settling the order.
+     *
+     * Costs are only payed if the order is executed. They cover the concept of gas costs to pay the solver for settling
+     * your order onchain for you.
+     *
+     * They are payed in the sell token although for convenience, the costs data includes also the buy token
+     * so UIs can decide how to show it to the user.
+     */
+    costs: Costs<T>;
+    /**
+     * Amounts before network costs. This amount could be shown to the user to reflect how much they are expected to get
+     * before applying any costs or fees (if costs and fees are displayed separately).
+     */
+    beforeNetworkCosts: Amounts<T>;
+    /**
+     * Amounts after including network costs.
+     */
+    afterNetworkCosts: Amounts<T>;
+    /**
+     * Amounts after including partner fees (if any).
+     *
+     * This amount could be shown to the user, as the expected to receive amount already including any fees or costs.
+     */
+    afterPartnerFees: Amounts<T>;
+    /**
+     * Amounts after including the slippage tolerance.
+     *
+     * This is the minimum that the user will receive and the amount they will sign.
+     *
+     * It already accounts for all costs, fees and some slippage tolerance so they can execute the order even in the
+     * event of the buy token appreciating.
+     */
+    afterSlippage: Amounts<T>;
+}

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

@@ -1,2 +1,2 @@
-export * from './orderSigningUtils';
-export * from './types';
+export * from './orderSigningUtils';
+export * from './types';