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

package/dist/schemas/trading/QuoteResultsSerialized.ts

@@ -20,7 +20,7 @@ export default {
         },
         "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)"
+          "description": "Slippage in basis points. If not provided, it will use AUTO slippage, which would suggest a slippage based on the quote."
         },
         "receiver": {
           "anyOf": [
@@ -39,22 +39,143 @@ export default {
           "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)"
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "object",
+                    "properties": {
+                      "volumeBps": {
+                        "type": "number",
+                        "description": "The fee in basis points (BPS) to be paid to the partner based on volume. Capped at protocol level to 100 BPS (1%)"
+                      },
+                      "recipient": {
+                        "type": "string",
+                        "description": "The Ethereum address of the partner to receive the fee."
+                      }
+                    },
+                    "required": [
+                      "volumeBps",
+                      "recipient"
+                    ],
+                    "additionalProperties": false
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "surplusBps": {
+                        "type": "number",
+                        "description": "The fee in basis points (BPS) to be paid to the partner based on surplus"
+                      },
+                      "maxVolumeBps": {
+                        "type": "number",
+                        "description": "The maximum volume in basis points (BPS) to be paid to the partner. Capped at protocol level to 100 BPS (1%). You can chose to go lower but not higher"
+                      },
+                      "recipient": {
+                        "type": "string",
+                        "description": "The Ethereum address of the partner to receive the fee."
+                      }
+                    },
+                    "required": [
+                      "surplusBps",
+                      "maxVolumeBps",
+                      "recipient"
+                    ],
+                    "additionalProperties": false
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "priceImprovementBps": {
+                        "type": "number",
+                        "description": "The fee in basis points (BPS) to be paid to the partner based on price improvement"
+                      },
+                      "maxVolumeBps": {
+                        "type": "number",
+                        "description": "The maximum volume in basis points (BPS) to be paid to the partner. Capped at protocol level to 100 BPS (1%). You can chose to go lower but not higher"
+                      },
+                      "recipient": {
+                        "type": "string",
+                        "description": "The Ethereum address of the partner to receive the fee."
+                      }
+                    },
+                    "required": [
+                      "priceImprovementBps",
+                      "maxVolumeBps",
+                      "recipient"
+                    ],
+                    "additionalProperties": false
+                  }
+                ]
+              }
             },
-            "recipient": {
-              "type": "string",
-              "description": "The Ethereum address of the partner to receive the fee."
+            {
+              "type": "object",
+              "properties": {
+                "volumeBps": {
+                  "type": "number",
+                  "description": "The fee in basis points (BPS) to be paid to the partner based on volume. Capped at protocol level to 100 BPS (1%)"
+                },
+                "recipient": {
+                  "type": "string",
+                  "description": "The Ethereum address of the partner to receive the fee."
+                }
+              },
+              "required": [
+                "volumeBps",
+                "recipient"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "surplusBps": {
+                  "type": "number",
+                  "description": "The fee in basis points (BPS) to be paid to the partner based on surplus"
+                },
+                "maxVolumeBps": {
+                  "type": "number",
+                  "description": "The maximum volume in basis points (BPS) to be paid to the partner. Capped at protocol level to 100 BPS (1%). You can chose to go lower but not higher"
+                },
+                "recipient": {
+                  "type": "string",
+                  "description": "The Ethereum address of the partner to receive the fee."
+                }
+              },
+              "required": [
+                "surplusBps",
+                "maxVolumeBps",
+                "recipient"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "priceImprovementBps": {
+                  "type": "number",
+                  "description": "The fee in basis points (BPS) to be paid to the partner based on price improvement"
+                },
+                "maxVolumeBps": {
+                  "type": "number",
+                  "description": "The maximum volume in basis points (BPS) to be paid to the partner. Capped at protocol level to 100 BPS (1%). You can chose to go lower but not higher"
+                },
+                "recipient": {
+                  "type": "string",
+                  "description": "The Ethereum address of the partner to receive the fee."
+                }
+              },
+              "required": [
+                "priceImprovementBps",
+                "maxVolumeBps",
+                "recipient"
+              ],
+              "additionalProperties": false
             }
-          },
-          "required": [
-            "bps",
-            "recipient"
-          ],
-          "additionalProperties": false
+          ]
         },
         "kind": {
           "type": "string",
@@ -96,6 +217,10 @@ export default {
       ],
       "description": "Information about the trade, including the kind of order, the owner, the sell and buy tokens, and the amount."
     },
+    "suggestedSlippageBps": {
+      "type": "number",
+      "description": "The suggested slippage based on the quote."
+    },
     "orderToSign": {
       "type": "object",
       "additionalProperties": false,
@@ -500,33 +625,172 @@ export default {
                   "additionalProperties": false
                 },
                 "partnerFee": {
+                  "anyOf": [
+                    {
+                      "type": "array",
+                      "items": {
+                        "anyOf": [
+                          {
+                            "type": "object",
+                            "properties": {
+                              "volumeBps": {
+                                "type": "number",
+                                "description": "The fee in basis points (BPS) to be paid to the partner based on volume. Capped at protocol level to 100 BPS (1%)"
+                              },
+                              "recipient": {
+                                "type": "string",
+                                "description": "The Ethereum address of the partner to receive the fee."
+                              }
+                            },
+                            "required": [
+                              "volumeBps",
+                              "recipient"
+                            ],
+                            "additionalProperties": false
+                          },
+                          {
+                            "type": "object",
+                            "properties": {
+                              "surplusBps": {
+                                "type": "number",
+                                "description": "The fee in basis points (BPS) to be paid to the partner based on surplus"
+                              },
+                              "maxVolumeBps": {
+                                "type": "number",
+                                "description": "The maximum volume in basis points (BPS) to be paid to the partner. Capped at protocol level to 100 BPS (1%). You can chose to go lower but not higher"
+                              },
+                              "recipient": {
+                                "type": "string",
+                                "description": "The Ethereum address of the partner to receive the fee."
+                              }
+                            },
+                            "required": [
+                              "surplusBps",
+                              "maxVolumeBps",
+                              "recipient"
+                            ],
+                            "additionalProperties": false
+                          },
+                          {
+                            "type": "object",
+                            "properties": {
+                              "priceImprovementBps": {
+                                "type": "number",
+                                "description": "The fee in basis points (BPS) to be paid to the partner based on price improvement"
+                              },
+                              "maxVolumeBps": {
+                                "type": "number",
+                                "description": "The maximum volume in basis points (BPS) to be paid to the partner. Capped at protocol level to 100 BPS (1%). You can chose to go lower but not higher"
+                              },
+                              "recipient": {
+                                "type": "string",
+                                "description": "The Ethereum address of the partner to receive the fee."
+                              }
+                            },
+                            "required": [
+                              "priceImprovementBps",
+                              "maxVolumeBps",
+                              "recipient"
+                            ],
+                            "additionalProperties": false
+                          }
+                        ]
+                      }
+                    },
+                    {
+                      "type": "object",
+                      "properties": {
+                        "volumeBps": {
+                          "type": "number",
+                          "description": "The fee in basis points (BPS) to be paid to the partner based on volume. Capped at protocol level to 100 BPS (1%)"
+                        },
+                        "recipient": {
+                          "type": "string",
+                          "description": "The Ethereum address of the partner to receive the fee."
+                        }
+                      },
+                      "required": [
+                        "volumeBps",
+                        "recipient"
+                      ],
+                      "additionalProperties": false
+                    },
+                    {
+                      "type": "object",
+                      "properties": {
+                        "surplusBps": {
+                          "type": "number",
+                          "description": "The fee in basis points (BPS) to be paid to the partner based on surplus"
+                        },
+                        "maxVolumeBps": {
+                          "type": "number",
+                          "description": "The maximum volume in basis points (BPS) to be paid to the partner. Capped at protocol level to 100 BPS (1%). You can chose to go lower but not higher"
+                        },
+                        "recipient": {
+                          "type": "string",
+                          "description": "The Ethereum address of the partner to receive the fee."
+                        }
+                      },
+                      "required": [
+                        "surplusBps",
+                        "maxVolumeBps",
+                        "recipient"
+                      ],
+                      "additionalProperties": false
+                    },
+                    {
+                      "type": "object",
+                      "properties": {
+                        "priceImprovementBps": {
+                          "type": "number",
+                          "description": "The fee in basis points (BPS) to be paid to the partner based on price improvement"
+                        },
+                        "maxVolumeBps": {
+                          "type": "number",
+                          "description": "The maximum volume in basis points (BPS) to be paid to the partner. Capped at protocol level to 100 BPS (1%). You can chose to go lower but not higher"
+                        },
+                        "recipient": {
+                          "type": "string",
+                          "description": "The Ethereum address of the partner to receive the fee."
+                        }
+                      },
+                      "required": [
+                        "priceImprovementBps",
+                        "maxVolumeBps",
+                        "recipient"
+                      ],
+                      "additionalProperties": false
+                    }
+                  ]
+                },
+                "replacedOrder": {
                   "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": {
+                    "uid": {
                       "type": "string",
-                      "description": "The Ethereum address of the partner to receive the fee."
+                      "description": "The replaced order UID."
                     }
                   },
                   "required": [
-                    "bps",
-                    "recipient"
+                    "uid"
                   ],
                   "additionalProperties": false
                 },
-                "replacedOrder": {
+                "bridging": {
                   "type": "object",
                   "properties": {
-                    "uid": {
+                    "destinationChainId": {
                       "type": "string",
-                      "description": "The replaced order UID."
+                      "description": "Id of a blockchain where funds will be received"
+                    },
+                    "destinationTokenAddress": {
+                      "type": "string",
+                      "description": "Address of a token that will be received at destination chain. The chain might be EVM or non-EVM. Some chains might even not have a token address. E.g.: Bitcoin"
                     }
                   },
                   "required": [
-                    "uid"
+                    "destinationChainId",
+                    "destinationTokenAddress"
                   ],
                   "additionalProperties": false
                 }
@@ -850,6 +1114,7 @@ export default {
     "orderToSign",
     "orderTypedData",
     "quoteResponse",
+    "suggestedSlippageBps",
     "tradeParameters"
   ],
   "additionalProperties": false,

package/dist/schemas/trading/QuoterParameters.ts

@@ -13,6 +13,8 @@ export default {
         100,
         42161,
         8453,
+        137,
+        43114,
         11155111
       ],
       "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."
@@ -20,6 +22,14 @@ export default {
     "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": [