@cowprotocol/cow-sdk 6.3.2-RC.2 → 7.0.0-beta.0

package/dist/schemas/trading/SwapAdvancedSettings.ts

@@ -1,708 +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.\n\nExpects either a string JSON doc as defined on [AppData](https://github.com/cowprotocol/app-data) or a hex encoded string for backwards compatibility.\n\nWhen 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.\n\nIf present, `appData` field must be set with the aforementioned data where this hash is derived from.\n\nIn 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": {
-              "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": {
-                "uid": {
-                  "type": "string",
-                  "description": "The replaced order UID."
-                }
-              },
-              "required": [
-                "uid"
-              ],
-              "additionalProperties": false
-            },
-            "bridging": {
-              "type": "object",
-              "properties": {
-                "destinationChainId": {
-                  "type": "string",
-                  "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": [
-                "destinationChainId",
-                "destinationTokenAddress"
-              ],
-              "additionalProperties": false
-            },
-            "flashloan": {
-              "type": "object",
-              "properties": {
-                "lender": {
-                  "type": "string",
-                  "description": "The Ethereum address of the flashloan lender"
-                },
-                "borrower": {
-                  "type": "string",
-                  "description": "The Ethereum address of the flashloan borrower"
-                },
-                "token": {
-                  "type": "string",
-                  "description": "The Ethereum address of the token being borrowed"
-                },
-                "amount": {
-                  "type": "string",
-                  "description": "The amount of tokens to be flash loaned (in token units, as uint256)"
-                }
-              },
-              "required": [
-                "lender",
-                "borrower",
-                "token",
-                "amount"
-              ],
-              "additionalProperties": false,
-              "description": "Information about flashloan parameters for the order"
-            }
-          },
-          "additionalProperties": false,
-          "description": "Each metadata will specify one aspect of the order."
-        }
-      },
-      "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,
-  "definitions": {}
-} as const