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

package/dist/types/index.d.ts

@@ -1,15 +0,0 @@
-export * from '../api/cow/types';
-export * from '../api/0x/types';
-export * from '../api/paraswap/types';
-export * from '../api/metadata/types';
-export * from './sdk';
-export * from './utilities';
-export { OrderKind } from '@cowprotocol/contracts';
-export declare class Token {
-    symbol: string;
-    address: string;
-    constructor(symbol: string, address: string);
-}
-export declare type WithEnabled = {
-    enabled: boolean;
-};

package/dist/types/sdk.d.ts

@@ -1,39 +0,0 @@
-import { LogLevelDesc } from 'loglevel';
-import { ExtendsObject } from 'utilities';
-import { WithEnabled } from '.';
-import { ZeroXApi } from '../api/0x';
-import { ZeroXOptions } from '../api/0x/types';
-import ParaswapApi from '../api/paraswap';
-import { ParaswapOptions } from '../api/paraswap/types';
-export declare type SdkOptions = {
-    loglevel?: LogLevelDesc;
-    zeroXOptions?: Partial<ZeroXOptions> & WithEnabled;
-    paraswapOptions?: Partial<ParaswapOptions> & WithEnabled;
-};
-export declare type OptionsWithZeroXEnabled = SdkOptions & {
-    zeroXOptions: Partial<ZeroXOptions> & {
-        enabled: true;
-    };
-};
-export declare type OptionsWithParaswapEnabled = SdkOptions & {
-    paraswapOptions: Partial<ParaswapOptions> & {
-        enabled: true;
-    };
-};
-export declare type ZeroXEnabled<Opt> = ExtendsObject<Opt, OptionsWithZeroXEnabled, ZeroXApi, undefined>;
-export declare type ParaswapEnabled<Opt> = ExtendsObject<Opt, OptionsWithParaswapEnabled, ParaswapApi, undefined>;
-export declare type OptionsWithApisEnabledStatus = SdkOptions & ({
-    paraswapOptions: Partial<ParaswapOptions> & {
-        enabled: true;
-    };
-    zeroXOptions: Partial<ZeroXOptions> & {
-        enabled: true;
-    };
-} | {
-    paraswapOptions: Partial<ParaswapOptions> & {
-        enabled: false;
-    };
-    zeroXOptions: Partial<ZeroXOptions> & {
-        enabled: false;
-    };
-});

package/dist/types/utilities.d.ts

@@ -1,5 +0,0 @@
-declare type UnionKeys<T> = T extends T ? keyof T : never;
-declare type StrictUnionHelper<T, TAll> = T extends unknown ? T & Partial<Record<Exclude<UnionKeys<TAll>, keyof T>, never>> : never;
-export declare type StrictUnion<T> = StrictUnionHelper<T, T>;
-export declare type ExtendsObject<ExtendingObject, ExtendableObject, ResultingType, FallbackType> = ExtendingObject extends ExtendableObject ? ResultingType : FallbackType;
-export {};

package/dist/utils/appData.d.ts

@@ -1,3 +0,0 @@
-import { AnyAppDataDocVersion } from '../types';
-export declare function getSerializedCID(hash: string): Promise<void | string>;
-export declare function loadIpfsFromCid(cid: string, ipfsUri?: string): Promise<AnyAppDataDocVersion>;

package/dist/utils/common.d.ts

@@ -1,9 +0,0 @@
-export declare class CowError extends Error {
-    error_code?: string;
-    constructor(message: string, error_code?: string);
-}
-export declare function objectToQueryString(o: {
-    [key: string]: string | number | undefined;
-}): string;
-export declare const logPrefix = "cow-sdk:";
-export declare function fromHexString(hexString: string): Uint8Array | undefined;

package/dist/utils/context.d.ts

@@ -1,42 +0,0 @@
-import { Signer } from 'ethers';
-import { SupportedChainId as ChainId, SupportedChainId } from '../constants/chains';
-export declare type Env = 'prod' | 'staging';
-export interface Ipfs {
-    uri?: string;
-    writeUri?: string;
-    readUri?: string;
-    pinataApiKey?: string;
-    pinataApiSecret?: string;
-}
-export interface CowContext {
-    appDataHash?: string;
-    env?: Env;
-    signer?: Signer;
-    ipfs?: Ipfs;
-    subgraphBaseUrls?: Partial<Record<SupportedChainId, string>>;
-}
-export declare const DefaultCowContext: {
-    appDataHash: string;
-    ipfs: Ipfs;
-    env: Env;
-};
-/**
- *
- *
- * @export
- * @class Context
- * @implements {Required<CowContext>}
- */
-export declare class Context implements Partial<CowContext> {
-    #private;
-    updateContext(cowContext: CowContext, chainId: ChainId): void;
-    constructor(chainId: ChainId, context: CowContext);
-    private setParams;
-    updateChainId(chainId: ChainId): ChainId;
-    get chainId(): Promise<ChainId>;
-    get appDataHash(): string;
-    get env(): Env;
-    get signer(): Signer | undefined;
-    get ipfs(): Ipfs;
-    get subgraphBaseUrls(): Partial<Record<SupportedChainId, string>>;
-}

package/dist/utils/ipfs.d.ts

@@ -1,10 +0,0 @@
-import { Ipfs } from './context';
-import { AnyAppDataDocVersion } from '../api/metadata/types';
-declare type PinataPinResponse = {
-    IpfsHash: string;
-    PinSize: number;
-    Timestamp: string;
-};
-export declare function pinJSONToIPFS(file: unknown, { writeUri, pinataApiKey, pinataApiSecret }: Ipfs): Promise<PinataPinResponse>;
-export declare function calculateIpfsCidV0(doc: AnyAppDataDocVersion): Promise<string>;
-export {};

package/dist/utils/market.d.ts

@@ -1,16 +0,0 @@
-import { OrderKind } from '@cowprotocol/contracts';
-interface Market<T = string> {
-    baseToken: T;
-    quoteToken: T;
-}
-export interface CanonicalMarketParams<T> {
-    sellToken: T;
-    buyToken: T;
-    kind: OrderKind;
-}
-export interface TokensFromMarketParams<T> extends Market<T> {
-    kind: OrderKind;
-}
-export declare function getCanonicalMarket<T>({ sellToken, buyToken, kind }: CanonicalMarketParams<T>): Market<T>;
-export declare function getTokensFromMarket<T>({ quoteToken, baseToken, kind, }: TokensFromMarketParams<T>): Omit<CanonicalMarketParams<T>, 'kind'>;
-export {};

package/dist/utils/sign.d.ts

@@ -1,55 +0,0 @@
-import { Order, OrderCancellation as OrderCancellationGp, SigningScheme } from '@cowprotocol/contracts';
-import { SupportedChainId as ChainId } from '../constants/chains';
-import { Signer } from '@ethersproject/abstract-signer';
-export declare type UnsignedOrder = Omit<Order, 'receiver'> & {
-    receiver: string;
-};
-export interface SignOrderParams {
-    chainId: ChainId;
-    signer: Signer;
-    order: UnsignedOrder;
-    signingScheme: SigningScheme;
-}
-export interface OrderCreation extends UnsignedOrder {
-    signingScheme: SigningScheme;
-    signature: string;
-    quoteId?: number | null;
-}
-export interface SingOrderCancellationParams {
-    chainId: ChainId;
-    signer: Signer;
-    orderId: string;
-    signingScheme: SigningScheme;
-}
-export interface OrderCancellation extends OrderCancellationGp {
-    signature: string;
-    signingScheme: SigningScheme;
-}
-export declare type SigningSchemeValue = 'eip712' | 'ethsign' | 'eip1271' | 'presign';
-export declare function getSigningSchemeApiValue(ecdaSigningScheme: SigningScheme): string;
-export declare function getSigningSchemeLibValue(ecdaSigningScheme: SigningScheme): number;
-export declare type SigningResult = {
-    signature?: string;
-    signingScheme: SigningScheme;
-};
-/**
- * Returns the signature for the specified order with the signing scheme encoded
- * into the signature.
- * @export
- * @param {UnsignedOrder} order The order to sign.
- * @param {ChainId} chainId The chain Id
- * @param {Signer} signer The owner for the order used to sign.
- * @return {*} Encoded signature including signing scheme for the order.
- */
-export declare function signOrder(order: UnsignedOrder, chainId: ChainId, signer: Signer): Promise<SigningResult>;
-/**
- * Returns the signature for the Order Cancellation with the signing scheme encoded
- * into the signature.
- *
- * @export
- * @param {string} orderId The unique identifier of the order being cancelled.
- * @param {ChainId} chainId The chain Id
- * @param {Signer} signer The owner for the order used to sign.
- * @return {*} Encoded signature including signing scheme for the order.
- */
-export declare function signOrderCancellation(orderId: string, chainId: ChainId, signer: Signer): Promise<SigningResult>;

package/dist/utils/tokens.d.ts

@@ -1,2 +0,0 @@
-import { SupportedChainId as ChainId } from '../constants/chains';
-export declare function toErc20Address(tokenAddress: string, chainId: ChainId): string;