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

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 {};