@cowprotocol/cow-sdk 5.10.2 → 5.11.0-RC.0

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

@@ -1,5 +1,5 @@
 import 'cross-fetch/polyfill';
-import { ApiBaseUrls, ApiContext, PartialApiContext } from '../common/configs';
+import { ApiBaseUrls, ApiContext, PartialApiContext } from '../common/types/config';
 import { Address, AppDataHash, AppDataObject, CompetitionOrderStatus, NativePriceResponse, OrderCancellations, OrderCreation, OrderQuoteRequest, OrderQuoteResponse, SolverCompetitionResponse, TotalSurplus, Trade, TransactionHash, UID } from './generated';
 import { EnrichedOrder } from './types';
 /**

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

@@ -1,11 +1,22 @@
 import { QuoteAmountsAndCosts } from './types';
 import { type OrderParameters } from './generated';
-interface Params {
+export interface QuoteAmountsAndCostsParams {
     orderParams: OrderParameters;
     sellDecimals: number;
     buyDecimals: number;
     slippagePercentBps: number;
     partnerFeeBps: number | undefined;
 }
-export declare function getQuoteAmountsAndCosts(params: Params): QuoteAmountsAndCosts;
+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/types.d.ts

@@ -5,7 +5,23 @@ import { Order } from './generated';
 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.
  *
@@ -16,23 +32,43 @@ export interface EnrichedOrder extends Order {
  * 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<AmountType = bigint, Amounts = {
-    sellAmount: AmountType;
-    buyAmount: AmountType;
-}> {
+export interface QuoteAmountsAndCosts<T = bigint> {
+    /**
+     * Whether the quote is a sell or buy order.
+     */
     isSell: boolean;
-    costs: {
-        networkFee: {
-            amountInSellCurrency: AmountType;
-            amountInBuyCurrency: AmountType;
-        };
-        partnerFee: {
-            amount: AmountType;
-            bps: number;
-        };
-    };
-    beforeNetworkCosts: Amounts;
-    afterNetworkCosts: Amounts;
-    afterPartnerFees: Amounts;
-    afterSlippage: Amounts;
+    /**
+     * 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/orderSigningUtils.d.ts

@@ -1,4 +1,4 @@
-import type { SupportedChainId } from '../common';
+import type { SupportedChainId } from '../chains';
 import type { Signer } from '@ethersproject/abstract-signer';
 import type { Order, TypedDataDomain, OrderUidParams } from '@cowprotocol/contracts';
 import type { SigningResult, UnsignedOrder } from './types';

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

@@ -1,4 +1,4 @@
-import type { SupportedChainId } from '../common';
+import type { SupportedChainId } from '../chains';
 import type { Signer } from '@ethersproject/abstract-signer';
 import type { OrderParameters, EcdsaSigningScheme } from '../order-book';
 /**

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

@@ -1,7 +1,7 @@
 import type { TypedDataDomain, Order, OrderUidParams } from '@cowprotocol/contracts';
 import type { Signer } from '@ethersproject/abstract-signer';
 import type { SigningResult, UnsignedOrder } from './types';
-import { SupportedChainId } from '../common';
+import type { SupportedChainId } from '../chains';
 /**
  * Returns the signature for the specified order with the signing scheme encoded
  * into the signature.

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/cow-sdk",
-  "version": "5.10.2",
+  "version": "5.11.0-RC.0",
   "license": "(MIT OR Apache-2.0)",
   "files": [
     "/dist"
@@ -33,13 +33,15 @@
     "trading:generateSchemas": "ts-node scripts/generateTradingSchemas.ts"
   },
   "dependencies": {
-    "@cowprotocol/app-data": "^2.4.0",
-    "@cowprotocol/contracts": "^1.6.0",
-    "@ethersproject/abstract-signer": "^5.7.0",
-    "@openzeppelin/merkle-tree": "^1.0.5",
-    "cross-fetch": "^3.1.5",
-    "exponential-backoff": "^3.1.1",
-    "graphql": "^16.3.0",
+    "@cowprotocol/app-data": "^3.0.0",
+    "@cowprotocol/contracts": "^1.8.0",
+    "@ethersproject/abstract-signer": "^5.8.0",
+    "@openzeppelin/merkle-tree": "^1.0.8",
+    "@weiroll/weiroll.js": "^0.3.0",
+    "cross-fetch": "^3.2.0",
+    "deepmerge": "^4.3.1",
+    "exponential-backoff": "^3.1.2",
+    "graphql": "^16.11.0",
     "graphql-request": "^4.3.0",
     "limiter": "^3.0.0"
   },
@@ -55,7 +57,7 @@
     "@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/jest": "^29.5.14",
     "@types/node": "^22.9.0",
     "@typescript-eslint/eslint-plugin": "^5.51.0",
     "@typescript-eslint/parser": "^5.51.0",
@@ -66,8 +68,8 @@
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-unused-imports": "^3.0.0",
-    "ethers": "^5.7.2",
-    "jest": "^29.6.4",
+    "ethers": "^5.8.0",
+    "jest": "^29.7.0",
     "jest-fetch-mock": "^3.0.3",
     "microbundle": "^0.15.1",
     "openapi-typescript-codegen": "^0.23.0",

package/dist/schemas/trading/LimitOrderAdvancedSettings.ts

@@ -221,6 +221,32 @@ export default {
         }
       },
       "additionalProperties": false
+    },
+    "additionalParams": {
+      "type": "object",
+      "properties": {
+        "checkEthFlowOrderExists": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "Selling native token orders are special, because they are created from smart-contract, and their validTo is always the same. Because of that, you might get the same orderId when trying to create an order with the same parameters The callback is needed to check if there is already an order with the same orderId"
+        },
+        "networkCostsAmount": {
+          "type": "string",
+          "description": "Cost of executing the order onchain. The value is used in getQuoteAmountsAndCosts in order to calculate proper amounts"
+        },
+        "signingScheme": {
+          "type": "string",
+          "enum": [
+            "eip712",
+            "ethsign",
+            "presign",
+            "eip1271"
+          ],
+          "description": "By default, is EIP712 for EOA wallets. You might need other types of signing, for example PRESIGN when sign order via Smart Contract wallets."
+        }
+      },
+      "additionalProperties": false,
+      "description": "Additional parameters for posting orders. In most of the cases you don't need to use them."
     }
   },
   "additionalProperties": false,

package/dist/schemas/trading/LimitTradeParameters.ts

@@ -10,6 +10,9 @@ export default {
       ],
       "description": "Is this order a buy or sell?"
     },
+    "owner": {
+      "type": "string"
+    },
     "sellToken": {
       "type": "string",
       "description": "ERC-20 token to be sold."

package/dist/schemas/trading/QuoteResultsSerialized.ts

@@ -64,6 +64,9 @@ export default {
           ],
           "description": "Is this order a buy or sell?"
         },
+        "owner": {
+          "type": "string"
+        },
         "sellToken": {
           "type": "string",
           "description": "ERC-20 token to be sold."
@@ -91,7 +94,7 @@ export default {
         "sellToken",
         "sellTokenDecimals"
       ],
-      "description": "Trade type, assets, amounts, and optional parameters."
+      "description": "Information about the trade, including the kind of order, the owner, the sell and buy tokens, and the amount."
     },
     "orderToSign": {
       "type": "object",
@@ -180,7 +183,7 @@ export default {
         "sellToken",
         "validTo"
       ],
-      "description": "Unsigned order intent to be placed."
+      "description": "Information about the order to be signed.\n\nFor signining, please use orderTypedData (EIP-712 typed data, which also includes the unsigned order)"
     },
     "quoteResponse": {
       "type": "object",
@@ -305,7 +308,7 @@ export default {
         "verified"
       ],
       "additionalProperties": false,
-      "description": "An order quoted by the backend that can be directly signed and submitted to the order creation backend."
+      "description": "Information about the quote response from the order book API."
     },
     "appDataInfo": {
       "type": "object",
@@ -554,7 +557,7 @@ export default {
         "appDataKeccak256"
       ],
       "additionalProperties": false,
-      "description": "https://github.com/cowprotocol/app-data"
+      "description": "Information about the app-data, including the JSON document and the keccak256 hash of the full document."
     },
     "orderTypedData": {
       "type": "object",
@@ -708,13 +711,14 @@ export default {
         "message"
       ],
       "additionalProperties": false,
-      "description": "EIP-712 typed data for an order."
+      "description": "EIP-712 typed data for the order ready to be signed."
     },
     "amountsAndCosts": {
       "type": "object",
       "properties": {
         "isSell": {
-          "type": "boolean"
+          "type": "boolean",
+          "description": "Whether the quote is a sell or buy order."
         },
         "costs": {
           "type": "object",
@@ -756,7 +760,8 @@ export default {
             "networkFee",
             "partnerFee"
           ],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "description": "Estimated costs of settling the order.\n\nCosts 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.\n\nThey 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."
         },
         "beforeNetworkCosts": {
           "type": "object",
@@ -772,7 +777,8 @@ export default {
             "sellAmount",
             "buyAmount"
           ],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "description": "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)."
         },
         "afterNetworkCosts": {
           "type": "object",
@@ -788,7 +794,8 @@ export default {
             "sellAmount",
             "buyAmount"
           ],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "description": "Amounts after including network costs."
         },
         "afterPartnerFees": {
           "type": "object",
@@ -804,7 +811,8 @@ export default {
             "sellAmount",
             "buyAmount"
           ],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "description": "Amounts after including partner fees (if any).\n\nThis amount could be shown to the user, as the expected to receive amount already including any fees or costs."
         },
         "afterSlippage": {
           "type": "object",
@@ -820,7 +828,8 @@ export default {
             "sellAmount",
             "buyAmount"
           ],
-          "additionalProperties": false
+          "additionalProperties": false,
+          "description": "Amounts after including the slippage tolerance.\n\nThis is the minimum that the user will receive and the amount they will sign.\n\nIt 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."
         }
       },
       "required": [
@@ -832,7 +841,7 @@ export default {
         "afterSlippage"
       ],
       "additionalProperties": false,
-      "description": "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.\n\nThe 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)\n\nFor 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."
+      "description": "Details about costs and amounts, costs and fees of a quote.\n\nCoW 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.\n\nThe 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)\n\nFor 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."
     }
   },
   "required": [

package/dist/schemas/trading/QuoterParameters.ts

@@ -13,13 +13,23 @@ export default {
         100,
         42161,
         8453,
+        137,
+        43114,
         11155111
       ],
-      "description": "Supported chains and their `chainId` for the SDK."
+      "description": "Supported chains and their `chainId` for the SDK.\n\nA supported chain, is a chain where CoW Protocol is deployed, so you can sell tokens from there."
     },
     "appCode": {
       "type": "string",
       "description": "The code identifying the CLI, UI, service generating the order."
+    },
+    "env": {
+      "type": "string",
+      "enum": [
+        "prod",
+        "staging"
+      ],
+      "description": "The environment to use for the Cow API."
     }
   },
   "required": [

package/dist/schemas/trading/SwapAdvancedSettings.ts

@@ -327,6 +327,212 @@ export default {
         }
       },
       "additionalProperties": false
+    },
+    "additionalParams": {
+      "type": "object",
+      "properties": {
+        "checkEthFlowOrderExists": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "Selling native token orders are special, because they are created from smart-contract, and their validTo is always the same. Because of that, you might get the same orderId when trying to create an order with the same parameters The callback is needed to check if there is already an order with the same orderId"
+        },
+        "networkCostsAmount": {
+          "type": "string",
+          "description": "Cost of executing the order onchain. The value is used in getQuoteAmountsAndCosts in order to calculate proper amounts"
+        },
+        "signingScheme": {
+          "type": "string",
+          "enum": [
+            "eip712",
+            "ethsign",
+            "presign",
+            "eip1271"
+          ],
+          "description": "By default, is EIP712 for EOA wallets. You might need other types of signing, for example PRESIGN when sign order via Smart Contract wallets."
+        }
+      },
+      "additionalProperties": false,
+      "description": "Additional parameters for posting orders. In most of the cases you don't need to use them."
+    },
+    "quoteSigner": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "provider": {
+              "type": "object",
+              "properties": {
+                "_isProvider": {
+                  "type": "boolean"
+                }
+              },
+              "required": [
+                "_isProvider"
+              ],
+              "additionalProperties": false
+            },
+            "_isSigner": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "_isSigner"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "isMetaMask": {
+              "type": "boolean"
+            },
+            "isStatus": {
+              "type": "boolean"
+            },
+            "host": {
+              "type": "string"
+            },
+            "path": {
+              "type": "string"
+            },
+            "sendAsync": {
+              "$comment": "(request: {\n        method: string;\n        params?: Array<any>;\n    }, callback: (error: any, response: any) => void) => void",
+              "type": "object",
+              "properties": {
+                "namedArgs": {
+                  "type": "object",
+                  "properties": {
+                    "request": {
+                      "type": "object",
+                      "properties": {
+                        "method": {
+                          "type": "string"
+                        },
+                        "params": {
+                          "type": "array",
+                          "items": {}
+                        }
+                      },
+                      "required": [
+                        "method"
+                      ],
+                      "additionalProperties": false
+                    },
+                    "callback": {
+                      "$comment": "(error: any, response: any) => void",
+                      "type": "object",
+                      "properties": {
+                        "namedArgs": {
+                          "type": "object",
+                          "properties": {
+                            "error": {},
+                            "response": {}
+                          },
+                          "required": [
+                            "error",
+                            "response"
+                          ],
+                          "additionalProperties": false
+                        }
+                      }
+                    }
+                  },
+                  "required": [
+                    "request",
+                    "callback"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            },
+            "send": {
+              "$comment": "(request: {\n        method: string;\n        params?: Array<any>;\n    }, callback: (error: any, response: any) => void) => void",
+              "type": "object",
+              "properties": {
+                "namedArgs": {
+                  "type": "object",
+                  "properties": {
+                    "request": {
+                      "type": "object",
+                      "properties": {
+                        "method": {
+                          "type": "string"
+                        },
+                        "params": {
+                          "type": "array",
+                          "items": {}
+                        }
+                      },
+                      "required": [
+                        "method"
+                      ],
+                      "additionalProperties": false
+                    },
+                    "callback": {
+                      "$comment": "(error: any, response: any) => void",
+                      "type": "object",
+                      "properties": {
+                        "namedArgs": {
+                          "type": "object",
+                          "properties": {
+                            "error": {},
+                            "response": {}
+                          },
+                          "required": [
+                            "error",
+                            "response"
+                          ],
+                          "additionalProperties": false
+                        }
+                      }
+                    }
+                  },
+                  "required": [
+                    "request",
+                    "callback"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            },
+            "request": {
+              "$comment": "(request: {\n        method: string;\n        params?: Array<any>;\n    }) => Promise<any>",
+              "type": "object",
+              "properties": {
+                "namedArgs": {
+                  "type": "object",
+                  "properties": {
+                    "request": {
+                      "type": "object",
+                      "properties": {
+                        "method": {
+                          "type": "string"
+                        },
+                        "params": {
+                          "type": "array",
+                          "items": {}
+                        }
+                      },
+                      "required": [
+                        "method"
+                      ],
+                      "additionalProperties": false
+                    }
+                  },
+                  "required": [
+                    "request"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "string"
+        }
+      ]
     }
   },
   "additionalProperties": false,

package/dist/schemas/trading/TradeParameters.ts

@@ -61,6 +61,9 @@ export default {
       ],
       "description": "Is this order a buy or sell?"
     },
+    "owner": {
+      "type": "string"
+    },
     "sellToken": {
       "type": "string",
       "description": "ERC-20 token to be sold."

package/dist/src/bridging/README.md

@@ -0,0 +1,54 @@
+# Bridging SDK
+
+SDK for swapping between chains.
+
+## Usage
+
+```ts
+import { SupportedChainId, BridgingSdk, QuoteBridgeRequest, OrderKind, assertIsBridgeQuoteAndPost } from '@cowprotocol/cow-sdk'
+
+const sdk = new BridgingSdk()
+
+const parameters: QuoteBridgeRequest = {
+  // Cross-chain orders, are always SELL orders (BUY not supported yet)
+  kind: OrderKind.SELL,
+
+  // Sell token (and source chain)
+  sellTokenChainId: SupportedChainId.ARBITRUM_ONE,
+  sellTokenAddress: '0xfff9976782d46cc05630d1f6ebab18b2324d6b14',
+  sellTokenDecimals: 18,
+
+  // Buy token (and target chain)
+  buyTokenChainId: SupportedChainId.BASE,
+  buyTokenAddress: '0x0625afb445c3b6b7b929342a04a22599fd5dbb59',
+  buyTokenDecimals: 18,
+
+  // Amount to sell
+  amount: '120000000000000000'
+
+  signer: '<privateKeyOrEthersSigner>',
+
+  // Optional parameters
+  appCode: '<YOUR_APP_CODE>',
+}
+
+// Get a quote (and the post callback) for a cross-chain swap
+const quoteResult = await sdk.getQuote(parameters)
+assertIsBridgeQuoteAndPost(quoteResult) // Assert that the quote result is of type BridgeQuoteAndPost (type for cross-chain quotes, as opposed to QuoteAndPost for single-chain quotes). The assertion makes typescript happy.
+const { swap, bridge, postSwapOrderFromQuote } = quoteResult
+
+// Display all data related to the swap (costs, amounts, appData including the bridging hook, etc.) 🐮
+console.log('Swap info', swap)
+
+// Display all data related to the bridge (costs, amounts, provider info, hook, and the bridging quote) ✉️
+console.log('Bridge info', bridge)
+
+// Get the buy amount after slippage in the target chain
+const { buyAmount } = bridge.amountsAndCosts.afterSlippage
+
+if (confirm(`You will get at least: ${buyAmount}, ok?`)) {
+  const orderId = await postSwapOrderFromQuote()
+
+  console.log('Order created, id: ', orderId)
+}
+```