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

package/dist/schemas/trading/SwapAdvancedSettings.ts

@@ -291,33 +291,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
             }
@@ -353,6 +492,186 @@ export default {
       },
       "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

@@ -17,7 +17,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": [
@@ -36,22 +36,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",