@cowprotocol/cow-sdk 0.0.1 → 0.0.9

package/LICENSE-APACHE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Gnosis Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,8 +1,206 @@
-# CoW protocol SDK
 <p align="center">
-  <img width="400" src="docs/images/CoW.png">
+  <img width="400" src="https://raw.githubusercontent.com/cowprotocol/cow-sdk/main/docs/images/CoW.png">
 </p>
 
+# CoW protocol SDK
+
+[![Styled With Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io/)
+[![Coverage Status](https://coveralls.io/repos/github/cowprotocol/cow-sdk/badge.svg?branch=main)](https://coveralls.io/github/cowprotocol/cow-sdk?branch=main)
+
+> ⚠️⚠️ THE SDK IS IN Beta ⚠️⚠️
+> It is being currently develop and is a work in progress, also it's API is subjected to change.
+> If you experience any problems, please open an issue in Github trying to describe your problem.
+
+### Getting started
+
+Install the SDK:
+
+```bash
+yarn add @cowprotocol/cow-sdk
+```
+
+Instantiate the SDK:
+
+```js
+import { CowSdk } from 'cow-sdk'
+
+const chainId = 4 // Rinkeby
+const cowSdk = new CowSdk(chainId)
+```
+
+The SDK will expose the CoW API operations (`cowSdk.cowApi`) and some convenient method that will facilitate signing orders (`cowSdk.signOrder`). Future version will provide easy access to The Graph data and some other convenient utils.
+
+```js
+// i.e. Get last 5 orders for a given trader
+const trades = await cowSdk.cowApi.getOrders({
+  owner: '0x00000000005ef87f8ca7014309ece7260bbcdaeb', // Trader
+  limit: 5,
+  offset: 0,
+})
+console.log(trades)
+```
+
+Let's see a full example on how to submit an order to CowSwap.
+
+> ⚠️ Before starting, the protocol requires you to approve the sell token before the order can be considered.
+> For more details see https://docs.cow.fi/tutorials/how-to-submit-orders-via-the-api/1.-set-allowance-for-the-sell-token
+
+In this example, we will:
+
+- 1. **Instantiate the SDK and a wallet**: Used for signing orders
+- 2. **Get a price/fee quote from the API**: Get current market price and required protocol fee to settle your trade.
+- 3. **Sign the order using your wallet**: Only signed orders are considered by the protocol.
+- 4. **Post the signed order to the API**: Post the order so it can be executed.
+
+```js
+import { Wallet } from 'ethers'
+import { CowSdk, OrderKind } from 'cow-sdk'
+
+// 1. Instantiate wallet and SDK
+const mnemonic = 'fall dirt bread cactus...'
+const wallet = Wallet.fromMnemonic(mnemonic)
+const cowSdk = new CowSdk(4, { signer: wallet })
+
+// 2. Get a price/fee quote from the API
+//    It will return the price and fee to "Sell 1 ETH for USDC"
+const quoteResponse = await cowSdk.cowApi.getQuote({
+  kind: OrderKind.SELL, // Sell order (could also be BUY)
+  sellToken: '0xc778417e063141139fce010982780140aa0cd5ab', // WETH
+  buyToken: '0x4dbcdf9b62e891a7cec5a2568c3f4faf9e8abe2b', // USDC
+  amount: '1000000000000000000', // 1 WETH
+  userAddress: '0x1811be0994930fe9480eaede25165608b093ad7a', // Trader
+  validTo: 2524608000,
+})
+
+const { sellToken, buyToken, validTo, buyAmount, sellAmount, receiver, feeAmount } = quoteResponse.quote
+const order = {
+  kind: OrderKind.SELL,
+  partiallyFillable: false, // Allow partial executions of an order (true would be for a "Fill or Kill" order, which is not yet supported but will be added soon)
+  sellToken,
+  buyToken,
+  validTo,
+  buyAmount,
+  sellAmount,
+  receiver,
+  feeAmount,
+}
+
+// 3. Sign the order using your wallet
+const signedOrder = await cowSdk.signOrder(order)
+
+// 4. Post the signed order to the API
+const orderId = await cowSdk.cowApi.sendOrder({
+  order: { ...order, ...signedOrder },
+  owner: '0x1811be0994930fe9480eaede25165608b093ad7a',
+})
+
+// We can inspect the Order details in the CoW Protocol Explorer
+console.log(`https://explorer.cow.fi/rinkeby/orders/${orderId}`)
+```
+
+SDK also includes a Metadata API to interact with AppData documents and IPFS CIDs
+
+```js
+const chainId = 4 // Rinkeby
+const cowSdk = new CowSdk(chainId)
+let hash = '0xa6c81f4ca727252a05b108f1742a07430f28d474d2a3492d8f325746824d22e5'
+
+// Decode AppData document given a CID hash
+const appDataDoc = await cowSdk.metadataApi.decodeAppData(hash)
+console.log(appDataDoc)
+/* {
+      "appCode": "CowSwap",
+      "metadata": {
+          "referrer": {
+              "address": "0x1f5B740436Fc5935622e92aa3b46818906F416E9",
+              "version": "0.1.0"
+          }
+      },
+      "version": "0.1.0"
+  } */
+
+const cid = 'QmUf2TrpSANVXdgcYfAAACe6kg551cY3rAemB7xfEMjYvs'
+
+// Decode CID hash to AppData Hex
+const decodedAppDataHex = await cowSdk.metadataApi.cidToAppDataHex(cid)
+console.log(decodedAppDataHex) //0x5ddb2c8207c10b96fac92cb934ef9ba004bc007a073c9e5b13edc422f209ed80
+
+hash = '0x5ddb2c8207c10b96fac92cb934ef9ba004bc007a073c9e5b13edc422f209ed80'
+
+// Decode AppData Hex to CID
+const decodedAppDataHex = await cowSdk.metadataApi.appDataHexToCid(hash)
+console.log(decodedAppDataHex) //QmUf2TrpSANVXdgcYfAAACe6kg551cY3rAemB7xfEMjYvs
+
+/*Create an AppData Document with empty metadata and default appCode
+  generateAppDataDoc receives as parameters: 
+    - metadata: MetadataDoc (Default: {})
+    - appCode: string (Default: 'Cowswap')
+*/
+const appDataDoc = cowSdk.metadataApi.generateAppDataDoc({})
+/* {
+      version: '0.1.0',
+      appCode: 'CowSwap',
+      metadata: {},
+    } 
+*/
+
+// Create an AppData Document with custom metadata and appCode
+const appDataDoc = cowSdk.metadataApi.generateAppDataDoc(
+  {
+    referrer: {
+      address: '0x1f5B740436Fc5935622e92aa3b46818906F416E9',
+      version: '0.1.0',
+    },
+  },
+  'CowApp'
+)
+/* {
+      version: '0.1.0',
+      appCode: 'CowApp',
+      metadata: {
+        referrer: {
+          address: '0x1f5B740436Fc5935622e92aa3b46818906F416E9',
+          version: '0.1.0',
+        },
+      },
+    } 
+*/
+
+// Upload AppDataDoc to IPFS (Pinata)
+const cowSdk = new CowSdk(4, {
+  ipfs: { pinataApiKey: 'YOUR_PINATA_API_KEY', pinataApiSecret: 'YOUR_PINATA_API_SECRET' },
+})
+
+await cowSdk.metadataApi.uploadMetadataDocToIpfs(appDataDoc)
+/* 0x5ddb2c8207c10b96fac92cb934ef9ba004bc007a073c9e5b13edc422f209ed80 */
+```
+
+#### Querying the Cow Subgraph
+
+You can query the Cow Subgraph either by running some common queries exposed by the `CowSubgraphApi` or by building your own ones:
+
+```js
+const chainId = 1 // Mainnet
+const cowSdk = new CowSdk(chainId)
+
+// Get Cow Protocol totals
+const { totals } = await cowSdk.cowSubgraphApi.getTotals()
+const { tokens, orders, traders, settlements, volumeUsd, volumeEth, feesUsd, feesEth } = totals
+console.log({ tokens, orders, traders, settlements, volumeUsd, volumeEth, feesUsd, feesEth })
+
+// Get the last 5 batches
+const query = `
+query LastBatches($n: Int!) {
+  settlements(orderBy: timestamp, orderDirection: desc, first: $n) {
+    txHash
+    timestamp
+  }
+}
+`
+const variables = { n: 5 }
+const response = await cowSdk.cowSubgraphApi.runQuery(query, variables)
+console.log(response.data.settlements)
+```
 
 ### Install Dependencies
 
@@ -14,11 +212,8 @@ yarn
 
 ```bash
 yarn build
-```
 
-### Run
-
-```bash
+# Build in watch mode
 yarn start
 ```
 
@@ -27,4 +222,3 @@ yarn start
 ```bash
 yarn test
 ```
-

package/dist/CowSdk.d.ts

@@ -0,0 +1,23 @@
+import { Signer } from 'ethers';
+import { LogLevelDesc } from 'loglevel';
+import { CowApi, CowSubgraphApi, MetadataApi } from './api';
+import { SupportedChainId as ChainId } from './constants/chains';
+import { validateAppDataDocument } from './utils/appData';
+import { Context, CowContext } from './utils/context';
+import { UnsignedOrder } from './utils/sign';
+declare type Options = {
+    loglevel?: LogLevelDesc;
+};
+export declare class CowSdk<T extends ChainId> {
+    context: Context;
+    cowApi: CowApi;
+    metadataApi: MetadataApi;
+    cowSubgraphApi: CowSubgraphApi;
+    constructor(chainId: T, cowContext?: CowContext, options?: Options);
+    updateChainId: (chainId: ChainId) => void;
+    validateAppDataDocument: typeof validateAppDataDocument;
+    signOrder(order: Omit<UnsignedOrder, 'appData'>): Promise<import("./utils/sign").SigningResult>;
+    signOrderCancellation(orderId: string): Promise<import("./utils/sign").SigningResult>;
+    _checkSigner(signer?: Signer | undefined): Signer;
+}
+export default CowSdk;

package/dist/api/cow/errors/OperatorError.d.ts

@@ -0,0 +1,63 @@
+import { CowError } from '../../../utils/common';
+declare type ApiActionType = 'get' | 'create' | 'delete';
+export interface ApiErrorObject {
+    errorType: ApiErrorCodes;
+    description: string;
+    data?: any;
+}
+export declare enum ApiErrorCodes {
+    DuplicateOrder = "DuplicateOrder",
+    InvalidSignature = "InvalidSignature",
+    MissingOrderData = "MissingOrderData",
+    InsufficientValidTo = "InsufficientValidTo",
+    InsufficientAllowance = "InsufficientAllowance",
+    InsufficientBalance = "InsufficientBalance",
+    InsufficientFee = "InsufficientFee",
+    WrongOwner = "WrongOwner",
+    NotFound = "NotFound",
+    OrderNotFound = "OrderNotFound",
+    AlreadyCancelled = "AlreadyCancelled",
+    OrderFullyExecuted = "OrderFullyExecuted",
+    OrderExpired = "OrderExpired",
+    NoLiquidity = "NoLiquidity",
+    UnsupportedToken = "UnsupportedToken",
+    AmountIsZero = "AmountIsZero",
+    SellAmountDoesNotCoverFee = "SellAmountDoesNotCoverFee",
+    TransferEthToContract = "TransferEthToContract",
+    UNHANDLED_GET_ERROR = "UNHANDLED_GET_ERROR",
+    UNHANDLED_CREATE_ERROR = "UNHANDLED_CREATE_ERROR",
+    UNHANDLED_DELETE_ERROR = "UNHANDLED_DELETE_ERROR"
+}
+export declare enum ApiErrorCodeDetails {
+    DuplicateOrder = "There was another identical order already submitted. Please try again.",
+    InsufficientFee = "The signed fee is insufficient. It's possible that is higher now due to a change in the gas price, ether price, or the sell token price. Please try again to get an updated fee quote.",
+    InvalidSignature = "The order signature is invalid. Check whether your Wallet app supports off-chain signing.",
+    MissingOrderData = "The order has missing information",
+    InsufficientValidTo = "The order you are signing is already expired. This can happen if you set a short expiration in the settings and waited too long before signing the transaction. Please try again.",
+    InsufficientAllowance = "The account doesn't have enough funds",
+    InsufficientBalance = "The account needs to approve the selling token in order to trade",
+    WrongOwner = "The signature is invalid.\n\nIt's likely that the signing method provided by your wallet doesn't comply with the standards required by CowSwap.\n\nCheck whether your Wallet app supports off-chain signing (EIP-712 or ETHSIGN).",
+    NotFound = "Token pair selected has insufficient liquidity",
+    OrderNotFound = "The order you are trying to cancel does not exist",
+    AlreadyCancelled = "Order is already cancelled",
+    OrderFullyExecuted = "Order is already filled",
+    OrderExpired = "Order is expired",
+    NoLiquidity = "Token pair selected has insufficient liquidity",
+    UnsupportedToken = "One of the tokens you are trading is unsupported. Please read the FAQ for more info.",
+    AmountIsZero = "Amount is zero",
+    SellAmountDoesNotCoverFee = "Sell amount does not sufficiently cover the current fee",
+    TransferEthToContract = "Sending the native currency to smart contract wallets is not currently supported",
+    UNHANDLED_GET_ERROR = "Order fetch failed. This may be due to a server or network connectivity issue. Please try again later.",
+    UNHANDLED_CREATE_ERROR = "The order was not accepted by the network",
+    UNHANDLED_DELETE_ERROR = "The order cancellation was not accepted by the network"
+}
+export default class OperatorError extends CowError {
+    name: string;
+    description: ApiErrorObject['description'];
+    static apiErrorDetails: typeof ApiErrorCodeDetails;
+    static getErrorMessage(response: Response, action: ApiActionType): Promise<string>;
+    static getErrorFromStatusCode(response: Response, action: 'create' | 'delete'): Promise<string>;
+    constructor(apiError: ApiErrorObject);
+}
+export declare function isValidOperatorError(error: any): error is OperatorError;
+export {};

package/dist/api/cow/errors/QuoteError.d.ts

@@ -0,0 +1,32 @@
+import { CowError } from '../../../utils/common';
+import { ApiErrorObject } from './OperatorError';
+export interface GpQuoteErrorObject {
+    errorType: GpQuoteErrorCodes;
+    description: string;
+    data?: any;
+}
+export declare enum GpQuoteErrorCodes {
+    UnsupportedToken = "UnsupportedToken",
+    InsufficientLiquidity = "InsufficientLiquidity",
+    FeeExceedsFrom = "FeeExceedsFrom",
+    ZeroPrice = "ZeroPrice",
+    UNHANDLED_ERROR = "UNHANDLED_ERROR"
+}
+export declare enum GpQuoteErrorDetails {
+    UnsupportedToken = "One of the tokens you are trading is unsupported. Please read the FAQ for more info.",
+    InsufficientLiquidity = "Token pair selected has insufficient liquidity",
+    FeeExceedsFrom = "Current fee exceeds entered \"from\" amount",
+    ZeroPrice = "Quoted price is zero. This is likely due to a significant price difference between the two tokens. Please try increasing amounts.",
+    UNHANDLED_ERROR = "Quote fetch failed. This may be due to a server or network connectivity issue. Please try again later."
+}
+export declare function mapOperatorErrorToQuoteError(error?: ApiErrorObject): GpQuoteErrorObject;
+export default class GpQuoteError extends CowError {
+    name: string;
+    description: string;
+    data?: any;
+    static quoteErrorDetails: typeof GpQuoteErrorDetails;
+    static getErrorMessage(response: Response): Promise<string>;
+    static getErrorFromStatusCode(response: Response): Promise<string>;
+    constructor(quoteError: GpQuoteErrorObject);
+}
+export declare function isValidQuoteError(error: any): error is GpQuoteError;

package/dist/api/cow/index.d.ts

@@ -0,0 +1,38 @@
+import { SupportedChainId as ChainId } from '../../constants/chains';
+import { OrderCreation } from '../../utils/sign';
+import { FeeQuoteParams, PriceInformation, PriceQuoteParams, SimpleGetQuoteResponse } from '../../utils/price';
+import { GetOrdersParams, GetTradesParams, OrderCancellationParams, OrderID, OrderMetaData, ProfileData, TradeMetaData } from './types';
+import { Context } from '../../utils/context';
+export declare class CowApi {
+    context: Context;
+    API_NAME: string;
+    constructor(context: Context);
+    get DEFAULT_HEADERS(): {
+        'Content-Type': string;
+        'X-AppId': string;
+    };
+    get API_BASE_URL(): Partial<Record<ChainId, string>>;
+    get PROFILE_API_BASE_URL(): Partial<Record<ChainId, string>>;
+    getProfileData(address: string): Promise<ProfileData | null>;
+    getTrades(params: GetTradesParams): Promise<TradeMetaData[]>;
+    getOrders(params: GetOrdersParams): Promise<OrderMetaData[]>;
+    getTxOrders(txHash: string): Promise<OrderMetaData[]>;
+    getOrder(orderId: string): Promise<OrderMetaData | null>;
+    getPriceQuoteLegacy(params: PriceQuoteParams): Promise<PriceInformation | null>;
+    getQuote(params: FeeQuoteParams): Promise<SimpleGetQuoteResponse>;
+    sendSignedOrderCancellation(params: OrderCancellationParams): Promise<void>;
+    sendOrder(params: {
+        order: Omit<OrderCreation, 'appData'>;
+        owner: string;
+    }): Promise<OrderID>;
+    getOrderLink(orderId: OrderID): string;
+    private mapNewToLegacyParams;
+    private getApiBaseUrl;
+    private getProfileApiBaseUrl;
+    private fetch;
+    private fetchProfile;
+    private post;
+    private get;
+    private getProfile;
+    private delete;
+}