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

package/dist/schemas/trading/QuoterParameters.ts

@@ -1,31 +0,0 @@
-export default {
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "account": {
-      "type": "string"
-    },
-    "chainId": {
-      "type": "number",
-      "enum": [
-        1,
-        100,
-        42161,
-        8453,
-        11155111
-      ],
-      "description": "Supported chains and their `chainId` for the SDK."
-    },
-    "appCode": {
-      "type": "string",
-      "description": "The code identifying the CLI, UI, service generating the order."
-    }
-  },
-  "required": [
-    "account",
-    "appCode",
-    "chainId"
-  ],
-  "definitions": {}
-} as const

package/dist/schemas/trading/SwapAdvancedSettings.ts

@@ -1,334 +0,0 @@
-export default {
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "properties": {
-    "quoteRequest": {
-      "type": "object",
-      "properties": {
-        "sellAmountBeforeFee": {
-          "type": "string",
-          "description": "The total amount that is available for the order. From this value, the fee is deducted and the buy amount is calculated."
-        },
-        "validTo": {
-          "type": "number",
-          "description": "Unix timestamp (`uint32`) until which the order is valid."
-        },
-        "sellToken": {
-          "type": "string",
-          "description": "ERC-20 token to be sold"
-        },
-        "buyToken": {
-          "type": "string",
-          "description": "ERC-20 token to be bought"
-        },
-        "receiver": {
-          "anyOf": [
-            {
-              "type": "string",
-              "description": "20 byte Ethereum address encoded as a hex with `0x` prefix."
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "description": "An optional address to receive the proceeds of the trade instead of the `owner` (i.e. the order signer)."
-        },
-        "appData": {
-          "anyOf": [
-            {
-              "type": "string",
-              "description": "The string encoding of a JSON object representing some `appData`. The format of the JSON expected in the `appData` field is defined [here](https://github.com/cowprotocol/app-data)."
-            },
-            {
-              "type": "string",
-              "description": "32 bytes encoded as hex with `0x` prefix. It's expected to be the hash of the stringified JSON object representing the `appData`."
-            }
-          ],
-          "description": "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."
-        },
-        "appDataHash": {
-          "type": "string",
-          "description": "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."
-        },
-        "sellTokenBalance": {
-          "type": "string",
-          "enum": [
-            "erc20",
-            "internal",
-            "external"
-          ],
-          "description": "Where should the `sellToken` be drawn from?"
-        },
-        "buyTokenBalance": {
-          "type": "string",
-          "enum": [
-            "erc20",
-            "internal"
-          ],
-          "description": "Where should the `buyToken` be transferred to?"
-        },
-        "from": {
-          "type": "string",
-          "description": "20 byte Ethereum address encoded as a hex with `0x` prefix."
-        },
-        "priceQuality": {
-          "type": "string",
-          "enum": [
-            "fast",
-            "optimal",
-            "verified"
-          ],
-          "description": "How good should the price estimate be?\n\nFast: 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.\n\n**NOTE**: Orders are supposed to be created from `verified` or `optimal` price estimates."
-        },
-        "signingScheme": {
-          "type": "string",
-          "enum": [
-            "eip712",
-            "ethsign",
-            "presign",
-            "eip1271"
-          ],
-          "description": "How was the order signed?"
-        },
-        "onchainOrder": {
-          "description": "Flag to signal whether the order is intended for on-chain order placement. Only valid for non ECDSA-signed orders.\""
-        },
-        "validFor": {
-          "type": "number",
-          "description": "Number (`uint32`) of seconds that the order should be valid for."
-        },
-        "sellAmountAfterFee": {
-          "type": "string",
-          "description": "The `sellAmount` for the order."
-        },
-        "buyAmountAfterFee": {
-          "type": "string",
-          "description": "The `buyAmount` for the order."
-        }
-      },
-      "additionalProperties": false
-    },
-    "appData": {
-      "type": "object",
-      "properties": {
-        "appCode": {
-          "type": "string",
-          "description": "The code identifying the CLI, UI, service generating the order."
-        },
-        "environment": {
-          "type": "string",
-          "description": "Environment from which the order came from."
-        },
-        "metadata": {
-          "type": "object",
-          "properties": {
-            "signer": {
-              "type": "string",
-              "description": "The address of the trader who signs the CoW Swap order. This field should normally be omitted; it is recommended to use it if the signer is a smart-contract wallet using EIP-1271 signatures."
-            },
-            "referrer": {
-              "type": "object",
-              "properties": {
-                "address": {
-                  "type": "string"
-                }
-              },
-              "required": [
-                "address"
-              ],
-              "additionalProperties": false
-            },
-            "utm": {
-              "type": "object",
-              "properties": {
-                "utmSource": {
-                  "type": "string",
-                  "description": "Tracks in which medium the traffic originated from (twitter, facebook, etc.)"
-                },
-                "utmMedium": {
-                  "type": "string",
-                  "description": "Tracks in which medium the traffic originated from (mail, CPC, social, etc.)"
-                },
-                "utmCampaign": {
-                  "type": "string",
-                  "description": "Track the performance of a specific campaign"
-                },
-                "utmContent": {
-                  "type": "string",
-                  "description": "Track which link was clicked"
-                },
-                "utmTerm": {
-                  "type": "string",
-                  "description": "Track which keyword term a website visitor came from"
-                }
-              },
-              "additionalProperties": false
-            },
-            "quote": {
-              "type": "object",
-              "properties": {
-                "slippageBips": {
-                  "type": "number",
-                  "description": "Slippage tolerance that was applied to the order to get the limit price. Expressed in Basis Points (BPS). One basis point is equivalent to 0.01% (1/100th of a percent)"
-                },
-                "smartSlippage": {
-                  "type": "boolean",
-                  "description": "Whether the given slippageBips used is originated from a Smart slippage suggestion"
-                }
-              },
-              "required": [
-                "slippageBips"
-              ],
-              "additionalProperties": false
-            },
-            "orderClass": {
-              "type": "object",
-              "properties": {
-                "orderClass": {
-                  "type": "string",
-                  "enum": [
-                    "market",
-                    "limit",
-                    "liquidity",
-                    "twap"
-                  ],
-                  "description": "Indicator of the order class."
-                }
-              },
-              "required": [
-                "orderClass"
-              ],
-              "additionalProperties": false
-            },
-            "hooks": {
-              "type": "object",
-              "properties": {
-                "version": {
-                  "type": "string",
-                  "description": "Semantic versioning of document."
-                },
-                "pre": {
-                  "type": "array",
-                  "items": {
-                    "type": "object",
-                    "properties": {
-                      "target": {
-                        "type": "string",
-                        "description": "The contract to call for the hook"
-                      },
-                      "callData": {
-                        "type": "string",
-                        "description": "The calldata to use when calling the hook"
-                      },
-                      "gasLimit": {
-                        "type": "string",
-                        "description": "The gas limit (in gas units) for the hook"
-                      },
-                      "dappId": {
-                        "type": "string",
-                        "description": "CoW Swap has an interface that allows dApps to build hooks for orders. This field is used to identify the dApp that has built the hook."
-                      }
-                    },
-                    "required": [
-                      "target",
-                      "callData",
-                      "gasLimit"
-                    ],
-                    "additionalProperties": false
-                  },
-                  "description": "CoW Hooks to call before an order executes"
-                },
-                "post": {
-                  "type": "array",
-                  "items": {
-                    "type": "object",
-                    "properties": {
-                      "target": {
-                        "type": "string",
-                        "description": "The contract to call for the hook"
-                      },
-                      "callData": {
-                        "type": "string",
-                        "description": "The calldata to use when calling the hook"
-                      },
-                      "gasLimit": {
-                        "type": "string",
-                        "description": "The gas limit (in gas units) for the hook"
-                      },
-                      "dappId": {
-                        "type": "string",
-                        "description": "CoW Swap has an interface that allows dApps to build hooks for orders. This field is used to identify the dApp that has built the hook."
-                      }
-                    },
-                    "required": [
-                      "target",
-                      "callData",
-                      "gasLimit"
-                    ],
-                    "additionalProperties": false
-                  },
-                  "description": "CoW Hooks to call after an order executes"
-                }
-              },
-              "additionalProperties": false,
-              "description": "Optional Pre and Post order interaction hooks attached to a single order"
-            },
-            "widget": {
-              "type": "object",
-              "properties": {
-                "appCode": {
-                  "type": "string",
-                  "description": "The code identifying the UI powering the widget"
-                },
-                "environment": {
-                  "type": "string",
-                  "description": "Environment from which the order came from."
-                }
-              },
-              "required": [
-                "appCode"
-              ],
-              "additionalProperties": false
-            },
-            "partnerFee": {
-              "type": "object",
-              "properties": {
-                "bps": {
-                  "type": "number",
-                  "description": "The fee in basis points (BPS) to be paid to the partner. One basis point is equivalent to 0.01% (1/100th of a percent)"
-                },
-                "recipient": {
-                  "type": "string",
-                  "description": "The Ethereum address of the partner to receive the fee."
-                }
-              },
-              "required": [
-                "bps",
-                "recipient"
-              ],
-              "additionalProperties": false
-            },
-            "replacedOrder": {
-              "type": "object",
-              "properties": {
-                "uid": {
-                  "type": "string",
-                  "description": "The replaced order UID."
-                }
-              },
-              "required": [
-                "uid"
-              ],
-              "additionalProperties": false
-            }
-          },
-          "additionalProperties": false,
-          "description": "Each metadata will specify one aspect of the order."
-        }
-      },
-      "additionalProperties": false
-    }
-  },
-  "additionalProperties": false,
-  "definitions": {}
-} as const

package/dist/schemas/trading/TradeParameters.ts

@@ -1,93 +0,0 @@
-export default {
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "env": {
-      "type": "string",
-      "enum": [
-        "prod",
-        "staging"
-      ],
-      "description": "The environment to use for the Cow API."
-    },
-    "partiallyFillable": {
-      "type": "boolean",
-      "description": "Is the order fill-or-kill or partially fillable?"
-    },
-    "slippageBps": {
-      "type": "number",
-      "description": "Slippage tolerance that was applied to the order to get the limit price. Expressed in Basis Points (BPS). One basis point is equivalent to 0.01% (1/100th of a percent)"
-    },
-    "receiver": {
-      "anyOf": [
-        {
-          "type": "string",
-          "description": "20 byte Ethereum address encoded as a hex with `0x` prefix."
-        },
-        {
-          "type": "null"
-        }
-      ],
-      "description": "An optional Ethereum address to receive the proceeds of the trade instead of the owner (i.e. the order signer)."
-    },
-    "validFor": {
-      "type": "number",
-      "description": "Unix timestamp (`uint32`) until which the order is valid."
-    },
-    "partnerFee": {
-      "type": "object",
-      "properties": {
-        "bps": {
-          "type": "number",
-          "description": "The fee in basis points (BPS) to be paid to the partner. One basis point is equivalent to 0.01% (1/100th of a percent)"
-        },
-        "recipient": {
-          "type": "string",
-          "description": "The Ethereum address of the partner to receive the fee."
-        }
-      },
-      "required": [
-        "bps",
-        "recipient"
-      ],
-      "additionalProperties": false
-    },
-    "kind": {
-      "type": "string",
-      "enum": [
-        "buy",
-        "sell"
-      ],
-      "description": "Is this order a buy or sell?"
-    },
-    "sellToken": {
-      "type": "string",
-      "description": "ERC-20 token to be sold."
-    },
-    "sellTokenDecimals": {
-      "type": "number"
-    },
-    "buyToken": {
-      "type": "string",
-      "description": "ERC-20 token to be bought."
-    },
-    "buyTokenDecimals": {
-      "type": "number"
-    },
-    "amount": {
-      "type": "string",
-      "description": "Amount of a token. `uint256` encoded in decimal."
-    }
-  },
-  "required": [
-    "amount",
-    "buyToken",
-    "buyTokenDecimals",
-    "kind",
-    "sellToken",
-    "sellTokenDecimals"
-  ],
-  "description": "Trade type, assets, amounts, and optional parameters.",
-  "definitions": {}
-} as const

package/dist/trading/appDataUtils.d.ts

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

package/dist/trading/calculateUniqueOrderId.d.ts

@@ -1,6 +0,0 @@
-import { UnsignedOrder } from '../order-signing';
-import { CowEnv, SupportedChainId } from '../common';
-export interface EthFlowOrderExistsCallback {
-    (orderId: string, orderDigest: string): Promise<boolean>;
-}
-export declare function calculateUniqueOrderId(chainId: SupportedChainId, order: UnsignedOrder, checkEthFlowOrderExists?: EthFlowOrderExistsCallback, env?: CowEnv): Promise<string>;

package/dist/trading/consts.d.ts

@@ -1,8 +0,0 @@
-import { SigningScheme } from '../order-book';
-export declare const log: (text: string) => void;
-export declare const DEFAULT_QUOTE_VALIDITY: number;
-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 +0,0 @@
-import { Signer } from 'ethers';
-import { LimitTradeParameters, TransactionParams } from './types';
-import { EthFlowOrderExistsCallback } from './calculateUniqueOrderId';
-export declare function getEthFlowTransaction(signer: Signer, appDataKeccak256: string, _params: LimitTradeParameters, networkCostsAmount?: string, checkEthFlowOrderExists?: EthFlowOrderExistsCallback): Promise<{
-    orderId: string;
-    transaction: TransactionParams;
-}>;

package/dist/trading/getOrderToSign.d.ts

@@ -1,8 +0,0 @@
-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 {};

package/dist/trading/getOrderTypedData.d.ts

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

package/dist/trading/getPreSignTransaction.d.ts

@@ -1,4 +0,0 @@
-import { SupportedChainId } from '../common';
-import type { Signer } from 'ethers';
-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 +0,0 @@
-import { QuoteResults, QuoterParameters, SwapAdvancedSettings, SwapParameters, TradeParameters } from './types';
-import { OrderBookApi } from '../order-book';
-import { Signer } from 'ethers';
-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>;

package/dist/trading/index.d.ts

@@ -1,19 +0,0 @@
-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 { postOnChainTrade } from './postOnChainTrade';
-export { getEthFlowTransaction } from './getEthFlowTransaction';
-export { getPreSignTransaction } from './getPreSignTransaction';
-/**
- * Helpers
- */
-export * from './appDataUtils';
-export * from './calculateUniqueOrderId';
-export { swapParamsToLimitOrderParams, mapQuoteAmountsAndCosts } from './utils';

package/dist/trading/postCoWProtocolTrade.d.ts

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

package/dist/trading/postLimitOrder.d.ts

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

package/dist/trading/postOnChainTrade.d.ts

@@ -1,8 +0,0 @@
-import { Signer } from 'ethers';
-import { AppDataInfo, LimitTradeParameters } from './types';
-import { EthFlowOrderExistsCallback } from './calculateUniqueOrderId';
-import { OrderBookApi } from '../order-book';
-export declare function postOnChainTrade(orderBookApi: OrderBookApi, signer: Signer, appData: Pick<AppDataInfo, 'fullAppData' | 'appDataKeccak256'>, _params: LimitTradeParameters, networkCostsAmount?: string, checkEthFlowOrderExists?: EthFlowOrderExistsCallback): Promise<{
-    txHash: string;
-    orderId: string;
-}>;

package/dist/trading/postSwapOrder.d.ts

@@ -1,4 +0,0 @@
-import { SwapAdvancedSettings, SwapParameters } from './types';
-import { QuoteResultsWithSigner } from './getQuote';
-export declare function postSwapOrder(params: SwapParameters, advancedSettings?: SwapAdvancedSettings): Promise<string>;
-export declare function postSwapOrderFromQuote({ orderBookApi, result: { signer, appDataInfo, quoteResponse, tradeParameters, amountsAndCosts }, }: QuoteResultsWithSigner): Promise<string>;

package/dist/trading/tradingSdk.d.ts

@@ -1,11 +0,0 @@
-import { LimitOrderAdvancedSettings, LimitTradeParameters, QuoteAndPost, SwapAdvancedSettings, TradeParameters, TraderParameters } from './types';
-import { postOnChainTrade } from './postOnChainTrade';
-export declare class TradingSdk {
-    readonly traderParams: TraderParameters;
-    constructor(traderParams: TraderParameters);
-    postSwapOrder(params: TradeParameters, advancedSettings?: SwapAdvancedSettings): Promise<string>;
-    postLimitOrder(params: LimitTradeParameters, advancedSettings?: LimitOrderAdvancedSettings): Promise<string>;
-    postOnChainTrade(params: TradeParameters, advancedSettings?: SwapAdvancedSettings): Promise<ReturnType<typeof postOnChainTrade>>;
-    getQuote(params: TradeParameters, advancedSettings?: SwapAdvancedSettings): Promise<QuoteAndPost>;
-    private mergeParams;
-}