@cowprotocol/cow-sdk 1.0.2-RC.7 → 2.0.0-alpha.0

package/README.md

@@ -73,7 +73,6 @@ The next sections will guide you through the process of creating a valid order.
 > For a quick snippet with the full process on posting an order see the [Post an Order Example](./docs/post-order-example.ts).
 
 ### Enable tokens (token approval)
-
 Because of the use of off-chain signing (meta-transactions), users will need to **Enable the sell token** before signed
 orders can be considered as valid ones.
 
@@ -92,9 +91,10 @@ import { CowSdk, OrderKind } from '@cowprotocol/cow-sdk'
 
 const mnemonic = 'fall dirt bread cactus...'
 const wallet = Wallet.fromMnemonic(mnemonic)
-const cowSdk = new CowSdk(100, {
-  // Leaving chainId empty will default to MAINNET
-  signer: wallet, // Provide a signer, so you can sign order
+
+const cowSdk = new CowSdk(
+  100, {            // Leaving chainId empty will default to MAINNET
+  signer: wallet  // Provide a signer, so you can sign order
 })
 ```
 
@@ -102,13 +102,13 @@ const cowSdk = new CowSdk(100, {
 
 To create an order, you need to get a price/fee quote first:
 
-- The SDK will give you easy access to the API, which returns the `Market Price` and the `Fee` for any given trade you intent to do.
-- The returned `Market Price` is not strictly needed, you can use your own pricing logic.
-  - You can choose a price that is below this Market price (**Market Order**), or above Market Price (**Limit Order**).
-- The `Fee` however is very important.
-  - It is the required amount in sell token the trader agrees on paying for executing the order onchain.
-  - Normally, its value is proportional to the current Gas Price of the network.
-  - This fee is never charged if you don't trade.
+  * The SDK will give you easy access to the API, which returns the `Market Price` and the `Fee` for any given trade you intent to do.
+  * The returned `Market Price` is not strictly needed, you can use your own pricing logic.
+    * You can choose a price that is below this Market price (**Market Order**), or above Market Price (**Limit Order**).
+  * The `Fee` however is very important.
+    * It is the required amount in sell token the trader agrees on paying for executing the order onchain.
+    * Normally, its value is proportional to the current Gas Price of the network.
+    * This fee is never charged if you don't trade.
 
 To get the quote, you simply specify the trade you intent to do:
 
@@ -192,7 +192,6 @@ const orderId = await cowSdk.cowApi.sendOrder({
 ```
 
 ### BONUS: Show link to Explorer
-
 Once the order is posted, its good to allow to check the state of it.
 
 One easy is to check in the CoW Explorer. You can create a CoW Explorer link if you have the `orderId`:
@@ -321,7 +320,6 @@ const uploadedAppDataHash = await cowSdk.metadataApi.uploadMetadataDocToIpfs(app
 ```
 
 ## Convert IPFS CIDv0 to AppData (and back)
-
 Given an IPFS CIDv0 you can convert it to an `AppData`
 
 ```js

package/package.json

@@ -1,28 +1,25 @@
 {
   "name": "@cowprotocol/cow-sdk",
-  "version": "1.0.2-RC.7",
+  "version": "2.0.0-alpha.0",
   "license": "(MIT OR Apache-2.0)",
-  "source": "src/index.ts",
-  "main": "./dist/index.js",
-  "module": "./dist/index.module.js",
-  "exports": {
-    "require": "./dist/index.js",
-    "default": "./dist/index.modern.mjs"
-  },
-  "types": "dist/index.d.ts",
   "files": [
     "/dist"
   ],
   "scripts": {
-    "build": "microbundle -f modern,esm,cjs",
-    "start": "microbundle -f modern,esm,cjs watch",
+    "prebuild": "rm -rf dist && yarn run codegen",
+    "build": "tsc --module commonjs",
+    "postbuild": "cp package.json dist && cp README.md dist",
+    "start:metadata": "tsc-watch --noClear -p ./tsconfig.json --onSuccess \"node ./dist/metadata/index.js\"",
+    "start:order-book": "tsc-watch --noClear -p ./tsconfig.json --onSuccess \"node ./dist/order-book/index.js\"",
+    "start:subgraph": "tsc-watch --noClear -p ./tsconfig.json --onSuccess \"node ./dist/subgraph/index.js\"",
     "lint": "eslint src",
     "format": "prettier --write \"src/**/*.+(ts|json)\"",
     "test": "jest",
     "test:coverage": "jest --coverage --json --outputFile=jest.results.json && cat ./coverage/lcov.info | coveralls",
-    "prepare": "npm run build && npm run graphql:codegen",
+    "codegen": "npm run graphql:codegen && npm run swagger:codegen",
     "prepublishOnly": "npm test && npm run lint",
-    "graphql:codegen": "graphql-codegen --config graphql-codegen.yml"
+    "graphql:codegen": "graphql-codegen --config graphql-codegen.yml",
+    "swagger:codegen": " openapi --input https://raw.githubusercontent.com/cowprotocol/services/fix/orderbook-openapi/crates/orderbook/openapi.yml --output src/order-book/generated --client fetch --name OrderBookClient"
   },
   "dependencies": {
     "@cowprotocol/app-data": "^0.0.3-RC.0",
@@ -32,30 +29,31 @@
     "graphql": "^16.3.0",
     "graphql-request": "^4.3.0",
     "ipfs-only-hash": "^4.0.0",
-    "loglevel": "^1.8.0",
-    "multiformats": "^9.6.4",
-    "paraswap": "^5.2.0",
-    "paraswap-core": "^1.0.2"
+    "multiformats": "^9.6.4"
   },
   "devDependencies": {
     "@babel/plugin-proposal-nullish-coalescing-operator": "^7.18.6",
     "@babel/plugin-proposal-private-methods": "^7.18.6",
+    "@babel/preset-env": "^7.20.2",
     "@babel/preset-typescript": "^7.18.6",
-    "@graphql-codegen/cli": "2.6.2",
-    "@graphql-codegen/typescript": "2.4.8",
-    "@graphql-codegen/typescript-operations": "^2.3.5",
-    "@types/jest": "^27.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.9.0",
-    "@typescript-eslint/parser": "^5.9.0",
+    "@graphql-codegen/cli": "3.0.0",
+    "@graphql-codegen/typescript": "3.0.0",
+    "@graphql-codegen/typescript-operations": "^3.0.0",
+    "@types/jest": "^29.4.0",
+    "@types/node": "^18.13.0",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
     "babel-plugin-inline-import": "^3.0.0",
     "coveralls": "^3.1.1",
-    "eslint": "^8.6.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.3.1",
+    "eslint": "^8.33.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.4.2",
     "jest-fetch-mock": "^3.0.3",
-    "microbundle": "^0.15.0",
-    "prettier": "^2.5.1"
+    "openapi-typescript-codegen": "^0.23.0",
+    "prettier": "^2.5.1",
+    "tsc-watch": "^6.0.0",
+    "typescript": "^4.9.5"
   },
   "jest": {
     "automock": false,
@@ -64,8 +62,7 @@
       "./setupTests.js"
     ],
     "collectCoverageFrom": [
-      "src/**/*.{ts,tsx}",
-      "!src/api/cow/errors/*.{ts,tsx}"
+      "src/**/*.{ts,tsx}"
     ]
   },
   "keywords": [

package/dist/CowSdk.d.ts

@@ -1,21 +0,0 @@
-import { Signer } from 'ethers';
-import { CowApi, CowSubgraphApi, MetadataApi } from './api';
-import { SupportedChainId as ChainId } from './constants/chains';
-import { Context, CowContext } from './utils/context';
-import { UnsignedOrder } from './utils/sign';
-import { SdkOptions, ParaswapEnabled, ZeroXEnabled, OptionsWithApisEnabledStatus } from 'sdk';
-export declare class CowSdk<T extends ChainId = ChainId, Opt extends SdkOptions = OptionsWithApisEnabledStatus> {
-    context: Context;
-    cowApi: CowApi;
-    metadataApi: MetadataApi;
-    cowSubgraphApi: CowSubgraphApi;
-    zeroXApi: ZeroXEnabled<Opt>;
-    paraswapApi: ParaswapEnabled<Opt>;
-    constructor(chainId?: T, cowContext?: CowContext, options?: Opt);
-    updateChainId: (chainId: ChainId) => void;
-    updateContext: (cowContext: CowContext, chainId?: ChainId) => Promise<void>;
-    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/0x/error/index.d.ts

@@ -1,21 +0,0 @@
-import { CowError } from '../../../utils/common';
-interface ValidationError {
-    field: string;
-    code: number;
-    reason: string;
-}
-export interface ZeroXErrorResponse {
-    code: number;
-    reason: string;
-    validationErrors?: ValidationError[];
-}
-export declare const logPrefix = "0x-sdk:";
-export default class ZeroXError extends CowError {
-    name: string;
-    description: string;
-    message: string;
-    static getErrorMessage(response: Response): Promise<string>;
-    static getErrorFromStatusCode(response: Response): Promise<string>;
-    constructor(apiError: ZeroXErrorResponse);
-}
-export {};

package/dist/api/0x/index.d.ts

@@ -1,11 +0,0 @@
-import { SupportedChainId } from '../../constants/chains';
-import BaseApi from '../base';
-import { Options, PriceQuoteLegacyParams } from '../cow/types';
-import { ZeroXOptions, ZeroXQuote } from './types';
-export declare class ZeroXApi extends BaseApi {
-    ZEROX_OPTIONS: ZeroXOptions;
-    ZEROX_OPTIONS_URL: string;
-    constructor(chainId: SupportedChainId, options: Partial<ZeroXOptions> | undefined);
-    getQuote(params: PriceQuoteLegacyParams, options?: Options): Promise<ZeroXQuote | null>;
-    updateOptions({ affiliateAddressMap, excludedSources }: Partial<ZeroXOptions>): Promise<void>;
-}

package/dist/api/0x/types.d.ts

@@ -1,87 +0,0 @@
-import { SupportedChainId } from '../../constants/chains';
-interface GetSwapQuoteResponseLiquiditySource {
-    name: string;
-    proportion: string;
-    intermediateToken?: string;
-    hops?: string[];
-}
-interface ZeroXBaseQuote {
-    chainId: SupportedChainId;
-    price: string;
-    buyAmount: string;
-    sellAmount: string;
-    sources: GetSwapQuoteResponseLiquiditySource[];
-    gasPrice: string;
-    estimatedGas: string;
-    sellTokenToEthRate: string;
-    buyTokenToEthRate: string;
-    protocolFee: string;
-    minimumProtocolFee: string;
-    allowanceTarget?: string;
-}
-export interface ZeroXQuote extends ZeroXBaseQuote {
-    sellTokenAddress: string;
-    buyTokenAddress: string;
-    value: string;
-    gas: string;
-}
-export declare type ZeroXOptions = {
-    affiliateAddressMap: Partial<Record<number, string>>;
-    excludedSources: ERC20BridgeSource[];
-};
-export declare enum ERC20BridgeSource {
-    Native = "Native",
-    Uniswap = "Uniswap",
-    UniswapV2 = "Uniswap_V2",
-    Eth2Dai = "Eth2Dai",
-    Kyber = "Kyber",
-    Curve = "Curve",
-    LiquidityProvider = "LiquidityProvider",
-    MultiBridge = "MultiBridge",
-    Balancer = "Balancer",
-    BalancerV2 = "Balancer_V2",
-    Cream = "CREAM",
-    Bancor = "Bancor",
-    MakerPsm = "MakerPsm",
-    MStable = "mStable",
-    Mooniswap = "Mooniswap",
-    MultiHop = "MultiHop",
-    Shell = "Shell",
-    Swerve = "Swerve",
-    SnowSwap = "SnowSwap",
-    SushiSwap = "SushiSwap",
-    Dodo = "DODO",
-    DodoV2 = "DODO_V2",
-    CryptoCom = "CryptoCom",
-    Linkswap = "Linkswap",
-    KyberDmm = "KyberDMM",
-    Smoothy = "Smoothy",
-    Component = "Component",
-    Saddle = "Saddle",
-    XSigma = "xSigma",
-    UniswapV3 = "Uniswap_V3",
-    CurveV2 = "Curve_V2",
-    Lido = "Lido",
-    ShibaSwap = "ShibaSwap",
-    Clipper = "Clipper",
-    PancakeSwap = "PancakeSwap",
-    PancakeSwapV2 = "PancakeSwap_V2",
-    BakerySwap = "BakerySwap",
-    Nerve = "Nerve",
-    Belt = "Belt",
-    Ellipsis = "Ellipsis",
-    ApeSwap = "ApeSwap",
-    CafeSwap = "CafeSwap",
-    CheeseSwap = "CheeseSwap",
-    JulSwap = "JulSwap",
-    ACryptos = "ACryptoS",
-    QuickSwap = "QuickSwap",
-    ComethSwap = "ComethSwap",
-    Dfyn = "Dfyn",
-    WaultSwap = "WaultSwap",
-    Polydex = "Polydex",
-    FirebirdOneSwap = "FirebirdOneSwap",
-    JetSwap = "JetSwap",
-    IronSwap = "IronSwap"
-}
-export {};

package/dist/api/0x/utils.d.ts

@@ -1,17 +0,0 @@
-import { OrderKind } from '@cowprotocol/contracts';
-import { SupportedChainId } from '../../constants/chains';
-import { PriceInformation, PriceQuoteLegacyParams } from '../cow/types';
-import { ZeroXOptions, ZeroXQuote } from './types';
-export declare function get0xUrls(): Partial<Record<SupportedChainId, string>>;
-export declare function normaliseQuoteResponse(priceRaw: ZeroXQuote | null, kind: OrderKind): PriceInformation | null;
-export declare function getMatchaChainId(chainId: SupportedChainId): SupportedChainId | null;
-export declare function optionsToMatchaParamsUrl({ excludedSources, affiliateAddress, }: {
-    excludedSources: ZeroXOptions['excludedSources'];
-    affiliateAddress: string;
-}): string;
-export declare function handleQuoteResponse<T = unknown, P extends PriceQuoteLegacyParams = PriceQuoteLegacyParams>(response: Response, params?: P): Promise<T>;
-export declare function throwOrReturnAffiliateAddress({ affiliateAddressMap, chainId, }: {
-    affiliateAddressMap: ZeroXOptions['affiliateAddressMap'];
-    chainId: SupportedChainId;
-}): string;
-export declare function extractExcludedSources({ excludedSources }: Pick<ZeroXOptions, 'excludedSources'>): string;

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

@@ -1,27 +0,0 @@
-import { SupportedChainId } from '../../constants/chains';
-import { Context } from '../../utils/context';
-import { Options } from '../cow/types';
-interface ConstructorParams {
-    context: Context;
-    name: string;
-    apiVersion?: string;
-    getApiUrl: (...params: any[]) => Partial<Record<SupportedChainId, string>>;
-    defaultHeaders?: HeadersInit;
-}
-export default class BaseApi {
-    context: Context;
-    API_NAME: string;
-    API_VERSION: string;
-    API_URL_GETTER: (...params: any[]) => Partial<Record<SupportedChainId, string>>;
-    DEFAULT_HEADERS: HeadersInit;
-    constructor({ context, name, getApiUrl, defaultHeaders, apiVersion, }: ConstructorParams);
-    protected getApiBaseUrl(...params: unknown[]): Promise<string>;
-    protected post(url: string, data: unknown, options?: Options, onlySingleEnv?: boolean): Promise<Response>;
-    protected get(url: string, options?: Options): Promise<Response>;
-    protected delete(url: string, data: unknown, options?: Options): Promise<Response>;
-    protected fetchSingleEnv(url: string, method: 'GET' | 'POST' | 'DELETE', fetchFn: BaseApi['fetch'], getApiUrl: BaseApi['API_URL_GETTER'], options?: Options, data?: unknown): Promise<Response>;
-    protected fetchMultipleEnvs(url: string, method: 'GET' | 'POST' | 'DELETE', fetchFn: BaseApi['fetch'], getApiUrl: BaseApi['API_URL_GETTER'], options?: Options, data?: unknown): Promise<Response>;
-    protected fetch(url: string, method: 'GET' | 'POST' | 'DELETE', baseUrl: string, data?: unknown, requestOptions?: RequestInit): Promise<Response>;
-    private fetchMultipleEnvsRecursive;
-}
-export {};

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

@@ -1,63 +0,0 @@
-import { CowError } from '../../../utils/common';
-declare type ApiActionType = 'get' | 'create' | 'delete';
-export interface ApiErrorObject {
-    errorType: ApiErrorCodes;
-    description: string;
-    data?: unknown;
-}
-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 = "Not found",
-    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: unknown): error is OperatorError;
-export {};

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

@@ -1,32 +0,0 @@
-import { CowError } from '../../../utils/common';
-import { ApiErrorObject } from './OperatorError';
-export interface GpQuoteErrorObject {
-    errorType: GpQuoteErrorCodes;
-    description: string;
-    data?: unknown;
-}
-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?: unknown;
-    static quoteErrorDetails: typeof GpQuoteErrorDetails;
-    static getErrorMessage(response: Response): Promise<string>;
-    static getErrorFromStatusCode(response: Response): Promise<string>;
-    constructor(quoteError: GpQuoteErrorObject);
-}
-export declare function isValidQuoteError(error: unknown): error is GpQuoteError;

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

@@ -1,26 +0,0 @@
-import { QuoteQuery } from '@cowprotocol/contracts';
-import { OrderCreation } from '../../utils/sign';
-import { FeeQuoteParams, GetOrdersParams, GetTradesParams, Options, OrderCancellationParams, OrderID, OrderMetaData, PriceInformation, PriceQuoteLegacyParams, ProfileData, SimpleGetQuoteResponse, TradeMetaData } from './types';
-import { Context } from '../../utils/context';
-import BaseApi from '../base';
-export declare class CowApi extends BaseApi {
-    constructor(context: Context);
-    getProfileData(address: string, options?: Options): Promise<ProfileData | null>;
-    getTrades(params: GetTradesParams, options?: Options): Promise<TradeMetaData[]>;
-    getOrders(params: GetOrdersParams, options?: Options): Promise<OrderMetaData[]>;
-    getTxOrders(txHash: string, options?: Options): Promise<OrderMetaData[]>;
-    getOrder(orderId: string, options?: Options): Promise<OrderMetaData | null>;
-    getPriceQuoteLegacy(params: PriceQuoteLegacyParams, options?: Options): Promise<PriceInformation | null>;
-    getQuoteLegacyParams(params: FeeQuoteParams, options?: Options): Promise<SimpleGetQuoteResponse>;
-    getQuote(params: QuoteQuery, options?: Options): Promise<SimpleGetQuoteResponse>;
-    sendSignedOrderCancellation(params: OrderCancellationParams, options?: Options): Promise<void>;
-    sendOrder(params: {
-        order: Omit<OrderCreation, 'appData'>;
-        owner: string;
-    }, options?: Options): Promise<OrderID>;
-    getOrderLink(orderId: OrderID): Promise<string>;
-    protected getApiBaseUrl(): Promise<string>;
-    private getProfile;
-    private mapNewToLegacyParams;
-    private fetchProfile;
-}

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

@@ -1,2 +0,0 @@
-import { OrderDto, OrderMetaData } from './types';
-export declare function transformOrder(order: OrderDto): OrderMetaData;

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

@@ -1,133 +0,0 @@
-import { GetQuoteResponse, OrderKind } from '@cowprotocol/contracts';
-import { SupportedChainId as ChainId } from '../../constants/chains';
-import { Env } from '../../utils/context';
-import { OrderCancellation, SigningSchemeValue } from '../../utils/sign';
-import type { StrictUnion } from '../../types/utilities';
-/**
- * Unique identifier for the order, calculated by keccak256(orderDigest, ownerAddress, validTo),
- * where orderDigest = keccak256(orderStruct). bytes32.
- */
-export declare type OrderID = string;
-export declare type ApiOrderStatus = 'fulfilled' | 'expired' | 'cancelled' | 'presignaturePending' | 'open';
-export declare type OrderClass = 'market' | 'limit' | 'liquidity';
-export interface OrderDto {
-    creationDate: string;
-    owner: string;
-    uid: OrderID;
-    availableBalance: string;
-    executedBuyAmount: string;
-    executedSellAmount: string;
-    executedSellAmountBeforeFees: string;
-    executedFeeAmount: string;
-    executedSurplusFee: string | null;
-    invalidated: false;
-    sellToken: string;
-    buyToken: string;
-    sellAmount: string;
-    buyAmount: string;
-    validTo: number;
-    appData: number;
-    feeAmount: string;
-    kind: OrderKind;
-    class: OrderClass;
-    partiallyFillable: false;
-    signature: string;
-    signingScheme: SigningSchemeValue;
-    status: ApiOrderStatus;
-    receiver: string;
-    ethflowData?: EthFlowData;
-    onchainUser?: string;
-}
-export interface OrderMetaData extends OrderDto {
-    totalFee: string;
-}
-declare type EthFlowData = {
-    userValidTo: number;
-    isRefunded: boolean;
-};
-export interface TradeMetaData {
-    blockNumber: number;
-    logIndex: number;
-    orderUid: OrderID;
-    owner: string;
-    sellToken: string;
-    buyToken: string;
-    sellAmount: string;
-    buyAmount: string;
-    sellAmountBeforeFees: string;
-    txHash: string;
-}
-export interface UnsupportedToken {
-    [token: string]: {
-        address: string;
-        dateAdded: number;
-    };
-}
-export declare type PaginationParams = {
-    limit?: number;
-    offset?: number;
-};
-export declare type OrderCancellationParams = {
-    chainId: ChainId;
-    cancellation: OrderCancellation;
-    owner: string;
-};
-export declare type GetOrdersParams = {
-    owner: string;
-} & PaginationParams;
-declare type WithOwner = {
-    owner: string;
-};
-declare type WithOrderId = {
-    orderId: string;
-};
-export declare type GetTradesParams = StrictUnion<WithOwner | WithOrderId>;
-export declare type ProfileData = {
-    totalTrades: number;
-    totalReferrals: number;
-    tradeVolumeUsd: number;
-    referralVolumeUsd: number;
-    lastUpdated: string;
-};
-export interface QuoteParams {
-    quoteParams: FeeQuoteParams;
-    fetchFee: boolean;
-    previousFee?: FeeInformation;
-    isPriceRefresh: boolean;
-}
-export interface FeeInformation {
-    expirationDate: string;
-    amount: string;
-}
-export interface PriceInformation {
-    token: string;
-    amount: string | null;
-    quoteId?: number;
-}
-export declare type SimpleGetQuoteResponse = Pick<GetQuoteResponse, 'from'> & {
-    quote: Omit<GetQuoteResponse['quote'], 'sellAmount' | 'buyAmount' | 'feeAmount' | 'validTo'> & {
-        sellAmount: string;
-        buyAmount: string;
-        validTo: string;
-        feeAmount: string;
-    };
-    expiration: string;
-    id: number | null;
-};
-export declare type FeeQuoteParams = Pick<OrderMetaData, 'sellToken' | 'buyToken' | 'kind'> & {
-    amount: string;
-    userAddress?: string | null;
-    receiver?: string | null;
-    validTo: number;
-};
-export declare type PriceQuoteLegacyParams = Omit<FeeQuoteParams, 'sellToken' | 'buyToken'> & {
-    baseToken: string;
-    quoteToken: string;
-};
-export declare type Options = {
-    chainId?: ChainId;
-    env?: Env;
-    requestOptions?: RequestInit;
-    apiUrlGetterParams?: unknown[];
-};
-export {};