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

package/dist/subgraph/index.d.ts

@@ -1 +1 @@
-export * from './api';
+export * from './api';

package/dist/subgraph/queries.d.ts

@@ -1,14 +1,14 @@
-/**
- * GraphQL query for the total number of tokens, orders, traders, settlements, volume, and fees.
- */
-export declare const TOTALS_QUERY: string;
-/**
- * GraphQL query for the total volume over the last N days.
- * @param days The number of days to query.
- */
-export declare const LAST_DAYS_VOLUME_QUERY: string;
-/**
- * GraphQL query for the total volume over the last N hours.
- * @param hours The number of hours to query.
- */
-export declare const LAST_HOURS_VOLUME_QUERY: string;
+/**
+ * GraphQL query for the total number of tokens, orders, traders, settlements, volume, and fees.
+ */
+export declare const TOTALS_QUERY: string;
+/**
+ * GraphQL query for the total volume over the last N days.
+ * @param days The number of days to query.
+ */
+export declare const LAST_DAYS_VOLUME_QUERY: string;
+/**
+ * GraphQL query for the total volume over the last N hours.
+ * @param hours The number of hours to query.
+ */
+export declare const LAST_HOURS_VOLUME_QUERY: string;

package/dist/test/utils.d.ts

@@ -0,0 +1 @@
+export declare function expectToEqual(actual: unknown, expected: unknown): void;

package/dist/trading/appDataUtils.d.ts

@@ -1,4 +1,5 @@
-import { AppDataInfo, AppDataRootSchema, BuildAppDataParams } from './types';
-import { AppDataParams } from '@cowprotocol/app-data';
-export declare function buildAppData({ slippageBps, appCode, orderClass: orderClassName, partnerFee }: BuildAppDataParams, advancedParams?: AppDataParams): Promise<AppDataInfo>;
-export declare function generateAppDataFromDoc(doc: AppDataRootSchema): Promise<Pick<AppDataInfo, 'fullAppData' | 'appDataKeccak256'>>;
+import { AppDataInfo, AppDataRootSchema, BuildAppDataParams } from './types';
+import { AppDataParams, type LatestAppDataDocVersion } from '@cowprotocol/app-data';
+export declare function buildAppData({ slippageBps, appCode, orderClass: orderClassName, partnerFee }: BuildAppDataParams, advancedParams?: AppDataParams): Promise<AppDataInfo>;
+export declare function generateAppDataFromDoc(doc: AppDataRootSchema): Promise<Pick<AppDataInfo, 'fullAppData' | 'appDataKeccak256'>>;
+export declare function mergeAppDataDoc(_doc: LatestAppDataDocVersion, appDataOverride: AppDataParams): Promise<AppDataInfo>;

package/dist/trading/calculateUniqueOrderId.d.ts

@@ -1,5 +1,5 @@
-import { UnsignedOrder } from '../order-signing';
-import { CowEnv } from '../common';
-import { SupportedChainId } from '../chains';
-import { EthFlowOrderExistsCallback } from './types';
-export declare function calculateUniqueOrderId(chainId: SupportedChainId, order: UnsignedOrder, checkEthFlowOrderExists?: EthFlowOrderExistsCallback, env?: CowEnv): Promise<string>;
+import { UnsignedOrder } from '../order-signing';
+import { CowEnv } from '../common';
+import { SupportedChainId } from '../chains';
+import { EthFlowOrderExistsCallback } from './types';
+export declare function calculateUniqueOrderId(chainId: SupportedChainId, order: UnsignedOrder, checkEthFlowOrderExists?: EthFlowOrderExistsCallback, env?: CowEnv): Promise<string>;

package/dist/trading/consts.d.ts

@@ -1,14 +1,6 @@
-import { SigningScheme } from '../order-book';
-import { SupportedChainId } from '../chains';
-export declare function log(text: string): void;
-export declare namespace log {
-    var enabled: boolean;
-}
-export declare const DEFAULT_QUOTE_VALIDITY: number;
-export declare const DEFAULT_SLIPPAGE_BPS = 50;
-export declare const ETH_FLOW_DEFAULT_SLIPPAGE_BPS: Record<SupportedChainId, number>;
-export declare const SIGN_SCHEME_MAP: {
-    eip712: SigningScheme;
-    ethsign: SigningScheme;
-};
-export declare const GAS_LIMIT_DEFAULT: bigint;
+import { SigningScheme } from '../order-book';
+export declare const SIGN_SCHEME_MAP: {
+    eip712: SigningScheme;
+    ethsign: SigningScheme;
+};
+export declare const GAS_LIMIT_DEFAULT: bigint;

package/dist/trading/getEthFlowTransaction.d.ts

@@ -1,7 +1,12 @@
-import { LimitTradeParametersFromQuote, PostTradeAdditionalParams, TransactionParams } from './types';
-import { SupportedChainId } from '../chains';
-import { Signer } from '@ethersproject/abstract-signer';
-export declare function getEthFlowTransaction(signer: Signer, appDataKeccak256: string, _params: LimitTradeParametersFromQuote, chainId: SupportedChainId, additionalParams?: PostTradeAdditionalParams): Promise<{
-    orderId: string;
-    transaction: TransactionParams;
-}>;
+import { LimitTradeParametersFromQuote, PostTradeAdditionalParams, TransactionParams } from './types';
+import { type EthFlow } from '../common/generated';
+import { CowEnv } from '../common';
+import { SupportedChainId } from '../chains';
+import { Signer } from '@ethersproject/abstract-signer';
+import type { UnsignedOrder } from '../order-signing';
+export declare function getEthFlowTransaction(signer: Signer, appDataKeccak256: string, _params: LimitTradeParametersFromQuote, chainId: SupportedChainId, additionalParams?: PostTradeAdditionalParams): Promise<{
+    orderId: string;
+    transaction: TransactionParams;
+    orderToSign: UnsignedOrder;
+}>;
+export declare function getEthFlowContract(signer: Signer, env?: CowEnv): EthFlow;

package/dist/trading/getOrderToSign.d.ts

@@ -1,8 +1,11 @@
-import { UnsignedOrder } from '../order-signing';
-import { LimitTradeParameters } from './types';
-interface OrderToSignParams {
-    from: string;
-    networkCostsAmount?: string;
-}
-export declare function getOrderToSign({ from, networkCostsAmount }: OrderToSignParams, limitOrderParams: LimitTradeParameters, appDataKeccak256: string): UnsignedOrder;
-export {};
+import { UnsignedOrder } from '../order-signing';
+import { LimitTradeParameters } from './types';
+import { SupportedChainId } from '../chains';
+interface OrderToSignParams {
+    chainId: SupportedChainId;
+    isEthFlow: boolean;
+    from: string;
+    networkCostsAmount?: string;
+}
+export declare function getOrderToSign({ chainId, from, networkCostsAmount, isEthFlow }: OrderToSignParams, limitOrderParams: LimitTradeParameters, appDataKeccak256: string): UnsignedOrder;
+export {};

package/dist/trading/getOrderTypedData.d.ts

@@ -1,4 +1,4 @@
-import { OrderTypedData } from './types';
-import { UnsignedOrder } from '../order-signing';
-import { SupportedChainId } from '../chains';
-export declare function getOrderTypedData(chainId: SupportedChainId, orderToSign: UnsignedOrder): Promise<OrderTypedData>;
+import { OrderTypedData } from './types';
+import { UnsignedOrder } from '../order-signing';
+import { SupportedChainId } from '../chains';
+export declare function getOrderTypedData(chainId: SupportedChainId, orderToSign: UnsignedOrder): Promise<OrderTypedData>;

package/dist/trading/getPreSignTransaction.d.ts

@@ -1,4 +1,4 @@
-import { SupportedChainId } from '../chains';
-import type { Signer } from '@ethersproject/abstract-signer';
-import { TransactionParams } from './types';
-export declare function getPreSignTransaction(signer: Signer, chainId: SupportedChainId, account: string, orderId: string): Promise<TransactionParams>;
+import { SupportedChainId } from '../chains';
+import type { Signer } from '@ethersproject/abstract-signer';
+import { TransactionParams } from './types';
+export declare function getPreSignTransaction(signer: Signer, chainId: SupportedChainId, account: string, orderId: string): Promise<TransactionParams>;

package/dist/trading/getQuote.d.ts

@@ -1,14 +1,26 @@
-import { QuoteResults, QuoterParameters, SwapAdvancedSettings, SwapParameters, TradeParameters } from './types';
-import { OrderBookApi } from '../order-book';
-import { Signer } from '@ethersproject/abstract-signer';
-export type QuoteResultsWithSigner = {
-    result: QuoteResults & {
-        signer: Signer;
-    };
-    orderBookApi: OrderBookApi;
-};
-export declare function getQuote(_tradeParameters: TradeParameters, trader: QuoterParameters, advancedSettings?: SwapAdvancedSettings, _orderBookApi?: OrderBookApi): Promise<{
-    result: QuoteResults;
-    orderBookApi: OrderBookApi;
-}>;
-export declare function getQuoteWithSigner(swapParameters: SwapParameters, advancedSettings?: SwapAdvancedSettings, orderBookApi?: OrderBookApi): Promise<QuoteResultsWithSigner>;
+import { AppDataInfo, QuoteResults, QuoterParameters, SwapAdvancedSettings, SwapParameters, TradeParameters } from './types';
+import { Signer } from '@ethersproject/abstract-signer';
+import { OrderBookApi, OrderQuoteResponse } from '../order-book';
+export type QuoteResultsWithSigner = {
+    result: QuoteResults & {
+        signer: Signer;
+    };
+    orderBookApi: OrderBookApi;
+};
+interface GetQuoteRawResult {
+    isEthFlow: boolean;
+    quote: OrderQuoteResponse;
+    appDataInfo: AppDataInfo;
+    orderBookApi: OrderBookApi;
+    tradeParameters: TradeParameters;
+    slippageBps: number;
+    suggestedSlippageBps: number;
+}
+export declare function getQuoteRaw(_tradeParameters: TradeParameters, trader: QuoterParameters, advancedSettings?: SwapAdvancedSettings, _orderBookApi?: OrderBookApi): Promise<GetQuoteRawResult>;
+export declare function getQuote(_tradeParameters: TradeParameters, trader: QuoterParameters, advancedSettings?: SwapAdvancedSettings, _orderBookApi?: OrderBookApi): Promise<{
+    result: QuoteResults;
+    orderBookApi: OrderBookApi;
+}>;
+export declare function getTrader(signer: Signer, swapParameters: SwapParameters): Promise<QuoterParameters>;
+export declare function getQuoteWithSigner(swapParameters: SwapParameters, advancedSettings?: SwapAdvancedSettings, orderBookApi?: OrderBookApi): Promise<QuoteResultsWithSigner>;
+export {};

package/dist/trading/index.d.ts

@@ -1,19 +1,21 @@
-export * from './types';
-export * from './tradingSdk';
-/**
- * Main trading functions
- */
-export { getQuote, getQuoteWithSigner } from './getQuote';
-export { postSwapOrder, postSwapOrderFromQuote } from './postSwapOrder';
-export { postLimitOrder } from './postLimitOrder';
-export { postCoWProtocolTrade } from './postCoWProtocolTrade';
-export { getOrderToSign } from './getOrderToSign';
-export { postSellNativeCurrencyOrder } from './postSellNativeCurrencyOrder';
-export { getEthFlowTransaction } from './getEthFlowTransaction';
-export { getPreSignTransaction } from './getPreSignTransaction';
-/**
- * Helpers
- */
-export * from './appDataUtils';
-export * from './calculateUniqueOrderId';
-export { swapParamsToLimitOrderParams, mapQuoteAmountsAndCosts } from './utils';
+export * from './tradingSdk';
+export * from './types';
+/**
+ * Main trading functions
+ */
+export { getEthFlowTransaction } from './getEthFlowTransaction';
+export { getOrderToSign } from './getOrderToSign';
+export { getPreSignTransaction } from './getPreSignTransaction';
+export { getQuote, getQuoteWithSigner } from './getQuote';
+export { postCoWProtocolTrade } from './postCoWProtocolTrade';
+export { postLimitOrder } from './postLimitOrder';
+export { postSellNativeCurrencyOrder } from './postSellNativeCurrencyOrder';
+export { postSwapOrder, postSwapOrderFromQuote } from './postSwapOrder';
+export { suggestSlippageBps } from './suggestSlippageBps';
+/**
+ * Helpers
+ */
+export * from './appDataUtils';
+export * from './calculateUniqueOrderId';
+export { getPartnerFeeBps } from './utils/getPartnerFeeBps';
+export { mapQuoteAmountsAndCosts, swapParamsToLimitOrderParams } from './utils/misc';

package/dist/trading/postCoWProtocolTrade.d.ts

@@ -1,4 +1,4 @@
-import { OrderBookApi } from '../order-book';
-import type { Signer } from '@ethersproject/abstract-signer';
-import { AppDataInfo, LimitTradeParameters, PostTradeAdditionalParams } from './types';
-export declare function postCoWProtocolTrade(orderBookApi: OrderBookApi, signer: Signer, appData: AppDataInfo, params: LimitTradeParameters, additionalParams?: PostTradeAdditionalParams): Promise<string>;
+import { OrderBookApi } from '../order-book';
+import type { Signer } from '@ethersproject/abstract-signer';
+import { AppDataInfo, LimitTradeParameters, OrderPostingResult, PostTradeAdditionalParams } from './types';
+export declare function postCoWProtocolTrade(orderBookApi: OrderBookApi, signer: Signer, appData: AppDataInfo, params: LimitTradeParameters, additionalParams?: PostTradeAdditionalParams): Promise<OrderPostingResult>;

package/dist/trading/postLimitOrder.d.ts

@@ -1,3 +1,3 @@
-import { LimitOrderAdvancedSettings, LimitOrderParameters } from './types';
-import { OrderBookApi } from '../order-book';
-export declare function postLimitOrder(params: LimitOrderParameters, advancedSettings?: LimitOrderAdvancedSettings, _orderBookApi?: OrderBookApi): Promise<string>;
+import { LimitOrderAdvancedSettings, LimitOrderParameters, OrderPostingResult } from './types';
+import { OrderBookApi } from '../order-book';
+export declare function postLimitOrder(params: LimitOrderParameters, advancedSettings?: LimitOrderAdvancedSettings, _orderBookApi?: OrderBookApi): Promise<OrderPostingResult>;

package/dist/trading/postSellNativeCurrencyOrder.d.ts

@@ -1,7 +1,4 @@
-import { Signer } from 'ethers';
-import { AppDataInfo, LimitTradeParametersFromQuote, PostTradeAdditionalParams } from './types';
-import { OrderBookApi } from '../order-book';
-export declare function postSellNativeCurrencyOrder(orderBookApi: OrderBookApi, signer: Signer, appData: Pick<AppDataInfo, 'fullAppData' | 'appDataKeccak256'>, _params: LimitTradeParametersFromQuote, additionalParams?: PostTradeAdditionalParams): Promise<{
-    txHash: string;
-    orderId: string;
-}>;
+import { Signer } from 'ethers';
+import { AppDataInfo, LimitTradeParametersFromQuote, OrderPostingResult, PostTradeAdditionalParams } from './types';
+import { OrderBookApi } from '../order-book';
+export declare function postSellNativeCurrencyOrder(orderBookApi: OrderBookApi, signer: Signer, appData: Pick<AppDataInfo, 'fullAppData' | 'appDataKeccak256'>, _params: LimitTradeParametersFromQuote, additionalParams?: PostTradeAdditionalParams): Promise<OrderPostingResult>;

package/dist/trading/postSwapOrder.d.ts

@@ -1,5 +1,5 @@
-import { SwapAdvancedSettings, SwapParameters } from './types';
-import { QuoteResultsWithSigner } from './getQuote';
-import { OrderBookApi } from '../order-book';
-export declare function postSwapOrder(params: SwapParameters, advancedSettings?: SwapAdvancedSettings, orderBookApi?: OrderBookApi): Promise<string>;
-export declare function postSwapOrderFromQuote(quoteResults: QuoteResultsWithSigner, advancedSettings?: SwapAdvancedSettings): Promise<string>;
+import { OrderPostingResult, SwapAdvancedSettings, SwapParameters } from './types';
+import { QuoteResultsWithSigner } from './getQuote';
+import { OrderBookApi } from '../order-book';
+export declare function postSwapOrder(params: SwapParameters, advancedSettings?: SwapAdvancedSettings, orderBookApi?: OrderBookApi): Promise<OrderPostingResult>;
+export declare function postSwapOrderFromQuote({ orderBookApi, result: { signer, appDataInfo: _appDataInfo, quoteResponse, tradeParameters }, }: QuoteResultsWithSigner, advancedSettings?: SwapAdvancedSettings): Promise<OrderPostingResult>;

package/dist/trading/suggestSlippageBps.d.ts

@@ -0,0 +1,13 @@
+import { OrderQuoteResponse } from '../order-book';
+import { QuoterParameters, SwapAdvancedSettings, TradeParameters } from './types';
+export interface SuggestSlippageBps {
+    isEthFlow: boolean;
+    tradeParameters: Pick<TradeParameters, 'sellTokenDecimals' | 'buyTokenDecimals'>;
+    quote: OrderQuoteResponse;
+    trader: QuoterParameters;
+    advancedSettings?: SwapAdvancedSettings;
+}
+/**
+ * Return the slippage in BPS that would allow the fee to increase by the multiplying factor percent.
+ */
+export declare function suggestSlippageBps(params: SuggestSlippageBps): number;

package/dist/trading/suggestSlippageFromFee.d.ts

@@ -0,0 +1,19 @@
+export interface SuggestSlippageFromFeeParams {
+    /**
+     * Fee amount in the sell token returned by the quote
+     */
+    feeAmount: bigint;
+    /**
+     * The factor to multiply the fee amount by to get the suggested slippage.
+     *
+     * For example, if the factor is 50% it would calculate which slippage would allow the fee to increase by 50% and still go through.
+     */
+    multiplyingFactorPercent: number;
+}
+/**
+ * Return the absolute slippage in the sell token that would allow the order to execute, even if the fee increases by the multiplying factor percent.
+ *
+ * @returns The slippage amount in the same units as the fee (sell token amount)
+ * @throws Error if feeAmount or multiplyingFactorPercent is negative
+ */
+export declare function suggestSlippageFromFee(params: SuggestSlippageFromFeeParams): bigint;

package/dist/trading/suggestSlippageFromVolume.d.ts

@@ -0,0 +1,10 @@
+export interface SuggestSlippageFromVolumeParams {
+    sellAmountBeforeNetworkCosts: bigint;
+    sellAmountAfterNetworkCosts: bigint;
+    isSell: boolean;
+    slippagePercent: number;
+}
+/**
+ * Return the absolute slippage in sell token for the traded amount
+ */
+export declare function suggestSlippageFromVolume(params: SuggestSlippageFromVolumeParams): bigint;

package/dist/trading/tradingSdk.d.ts

@@ -1,26 +1,26 @@
-import { LimitOrderAdvancedSettings, LimitTradeParameters, QuoteAndPost, SwapAdvancedSettings, TradeParameters, TraderParameters } from './types';
-import { QuoteResultsWithSigner } from './getQuote';
-import { postSellNativeCurrencyOrder } from './postSellNativeCurrencyOrder';
-import { getPreSignTransaction } from './getPreSignTransaction';
-import { OrderBookApi } from '../order-book';
-export type WithPartialTraderParams<T> = T & Partial<TraderParameters>;
-export interface TradingSdkOptions {
-    enableLogging: boolean;
-    orderBookApi: OrderBookApi;
-}
-export declare class TradingSdk {
-    traderParams: Partial<TraderParameters>;
-    readonly options: Partial<TradingSdkOptions>;
-    constructor(traderParams?: Partial<TraderParameters>, options?: Partial<TradingSdkOptions>);
-    setTraderParams(params: Partial<TraderParameters>): this;
-    getQuote(params: WithPartialTraderParams<TradeParameters>, advancedSettings?: SwapAdvancedSettings): Promise<QuoteAndPost>;
-    getQuoteResults(params: TradeParameters, advancedSettings?: SwapAdvancedSettings): Promise<QuoteResultsWithSigner>;
-    postSwapOrder(params: WithPartialTraderParams<TradeParameters>, advancedSettings?: SwapAdvancedSettings): Promise<string>;
-    postLimitOrder(params: WithPartialTraderParams<LimitTradeParameters>, advancedSettings?: LimitOrderAdvancedSettings): Promise<string>;
-    postSellNativeCurrencyOrder(params: WithPartialTraderParams<TradeParameters>, advancedSettings?: SwapAdvancedSettings): Promise<ReturnType<typeof postSellNativeCurrencyOrder>>;
-    getPreSignTransaction(params: WithPartialTraderParams<{
-        orderId: string;
-        account: string;
-    }>): ReturnType<typeof getPreSignTransaction>;
-    private mergeParams;
-}
+import { LimitOrderAdvancedSettings, LimitTradeParameters, OrderPostingResult, QuoteAndPost, SwapAdvancedSettings, TradeParameters, TraderParameters } from './types';
+import { QuoteResultsWithSigner } from './getQuote';
+import { postSellNativeCurrencyOrder } from './postSellNativeCurrencyOrder';
+import { getPreSignTransaction } from './getPreSignTransaction';
+import { OrderBookApi } from '../order-book';
+export type WithPartialTraderParams<T> = T & Partial<TraderParameters>;
+export interface TradingSdkOptions {
+    enableLogging: boolean;
+    orderBookApi: OrderBookApi;
+}
+export declare class TradingSdk {
+    traderParams: Partial<TraderParameters>;
+    readonly options: Partial<TradingSdkOptions>;
+    constructor(traderParams?: Partial<TraderParameters>, options?: Partial<TradingSdkOptions>);
+    setTraderParams(params: Partial<TraderParameters>): this;
+    getQuote(params: WithPartialTraderParams<TradeParameters>, advancedSettings?: SwapAdvancedSettings): Promise<QuoteAndPost>;
+    getQuoteResults(params: WithPartialTraderParams<TradeParameters>, advancedSettings?: SwapAdvancedSettings): Promise<QuoteResultsWithSigner>;
+    postSwapOrder(params: WithPartialTraderParams<TradeParameters>, advancedSettings?: SwapAdvancedSettings): Promise<OrderPostingResult>;
+    postLimitOrder(params: WithPartialTraderParams<LimitTradeParameters>, advancedSettings?: LimitOrderAdvancedSettings): Promise<OrderPostingResult>;
+    postSellNativeCurrencyOrder(params: WithPartialTraderParams<TradeParameters>, advancedSettings?: SwapAdvancedSettings): Promise<ReturnType<typeof postSellNativeCurrencyOrder>>;
+    getPreSignTransaction(params: WithPartialTraderParams<{
+        orderId: string;
+        account: string;
+    }>): ReturnType<typeof getPreSignTransaction>;
+    private mergeParams;
+}