@cowprotocol/cow-sdk 6.0.0-RC.9 → 6.0.0

package/dist/common/types/config.d.ts

@@ -1,70 +1,70 @@
-import { BackoffOptions } from 'exponential-backoff';
-import { RateLimiterOpts } from 'limiter/dist/esm';
-import { SupportedChainId } from '../../chains/types';
-/**
- * IPFS configuration.
- *
- * For production use, consider using {@link Pinata: https://www.pinata.cloud/}
- * @property {string} [uri] The URI of the IPFS node to use.
- * @property {string} [writeUri] The URI of the IPFS node to use for writing.
- * @property {string} [readUri] The URI of the IPFS node to use for reading.
- * @property {string} [pinataApiKey] The API key to use for Pinata.
- * @property {string} [pinataApiSecret] The API secret to use for Pinata.
- */
-export interface IpfsConfig {
-    uri?: string;
-    writeUri?: string;
-    readUri?: string;
-    pinataApiKey?: string;
-    pinataApiSecret?: string;
-}
-/**
- * @property {RateLimiterOpts} [limiterOpts] The options to use for the rate limiter.
- * @property {BackoffOptions} [backoffOpts] The options to use for the backoff.
- */
-export interface RequestOptions {
-    limiterOpts?: RateLimiterOpts;
-    backoffOpts?: BackoffOptions;
-}
-/**
- * The environment to use for the Cow API.
- */
-export type CowEnv = 'prod' | 'staging';
-/**
- * Override some properties of the {@link ApiContext}.
- */
-export type PartialApiContext = Partial<ApiContext>;
-/**
- * @property {string} [1] The base URL for the mainnet API.
- * @property {string} [100] The base URL for the Gnosis Chain API.
- * @property {string} [42161] The base URL for the Arbitrum One API.
- * @property {string} [8453] The base URL for the Base API.
- * @property {string} [11155111] The base URL for the Sepolia testnet API.
- */
-export type ApiBaseUrls = Record<SupportedChainId, string>;
-/**
- * Define the context to use for the CoW Protocol API.
- *
- * CoW Protocol is a set of smart contracts and off-chain services, deployed on **multiple chains**.
- * {@link SupportedChainId Supported chains} are:
- * - Mainnet
- * - Gnosis Chain
- * - Arbitrum One
- * - Base
- * - Sepolia
- *
- * Each chain has it's own API, and each API has it's own base URL.
- *
- * Options may be selectively overridden by passing a {@link PartialApiContext} to the constructor.
- * @see {@link https://api.cow.fi/docs/#/}
- * @property {SupportedChainId} chainId The `chainId`` corresponding to this CoW Protocol API instance.
- * @property {CowEnv} env The environment that this context corresponds to.
- * @property {ApiBaseUrls} [baseUrls] URls that may be used to connect to this context.
- */
-export interface ApiContext {
-    chainId: SupportedChainId;
-    env: CowEnv;
-    baseUrls?: ApiBaseUrls;
-    limiterOpts?: RateLimiterOpts;
-    backoffOpts?: BackoffOptions;
-}
+import { BackoffOptions } from 'exponential-backoff';
+import { RateLimiterOpts } from 'limiter/dist/esm';
+import { SupportedChainId } from '../../chains/types';
+/**
+ * IPFS configuration.
+ *
+ * For production use, consider using {@link Pinata: https://www.pinata.cloud/}
+ * @property {string} [uri] The URI of the IPFS node to use.
+ * @property {string} [writeUri] The URI of the IPFS node to use for writing.
+ * @property {string} [readUri] The URI of the IPFS node to use for reading.
+ * @property {string} [pinataApiKey] The API key to use for Pinata.
+ * @property {string} [pinataApiSecret] The API secret to use for Pinata.
+ */
+export interface IpfsConfig {
+    uri?: string;
+    writeUri?: string;
+    readUri?: string;
+    pinataApiKey?: string;
+    pinataApiSecret?: string;
+}
+/**
+ * @property {RateLimiterOpts} [limiterOpts] The options to use for the rate limiter.
+ * @property {BackoffOptions} [backoffOpts] The options to use for the backoff.
+ */
+export interface RequestOptions {
+    limiterOpts?: RateLimiterOpts;
+    backoffOpts?: BackoffOptions;
+}
+/**
+ * The environment to use for the Cow API.
+ */
+export type CowEnv = 'prod' | 'staging';
+/**
+ * Override some properties of the {@link ApiContext}.
+ */
+export type PartialApiContext = Partial<ApiContext>;
+/**
+ * @property {string} [1] The base URL for the mainnet API.
+ * @property {string} [100] The base URL for the Gnosis Chain API.
+ * @property {string} [42161] The base URL for the Arbitrum One API.
+ * @property {string} [8453] The base URL for the Base API.
+ * @property {string} [11155111] The base URL for the Sepolia testnet API.
+ */
+export type ApiBaseUrls = Record<SupportedChainId, string>;
+/**
+ * Define the context to use for the CoW Protocol API.
+ *
+ * CoW Protocol is a set of smart contracts and off-chain services, deployed on **multiple chains**.
+ * {@link SupportedChainId Supported chains} are:
+ * - Mainnet
+ * - Gnosis Chain
+ * - Arbitrum One
+ * - Base
+ * - Sepolia
+ *
+ * Each chain has it's own API, and each API has it's own base URL.
+ *
+ * Options may be selectively overridden by passing a {@link PartialApiContext} to the constructor.
+ * @see {@link https://api.cow.fi/docs/#/}
+ * @property {SupportedChainId} chainId The `chainId`` corresponding to this CoW Protocol API instance.
+ * @property {CowEnv} env The environment that this context corresponds to.
+ * @property {ApiBaseUrls} [baseUrls] URls that may be used to connect to this context.
+ */
+export interface ApiContext {
+    chainId: SupportedChainId;
+    env: CowEnv;
+    baseUrls?: ApiBaseUrls;
+    limiterOpts?: RateLimiterOpts;
+    backoffOpts?: BackoffOptions;
+}

package/dist/common/types/cow-error.d.ts

@@ -1,4 +1,4 @@
-export declare class CowError extends Error {
-    error_code?: string;
-    constructor(message: string, error_code?: string);
-}
+export declare class CowError extends Error {
+    error_code?: string;
+    constructor(message: string, error_code?: string);
+}

package/dist/common/types/ethereum.d.ts

@@ -1,5 +1,5 @@
-export interface EvmCall {
-    to: string;
-    data: string;
-    value: bigint;
-}
+export interface EvmCall {
+    to: string;
+    data: string;
+    value: bigint;
+}

package/dist/common/types/tokens.d.ts

@@ -1,12 +1,12 @@
-import { ChainId } from '../../chains/types';
-/**
- * Token on a chain.
- */
-export interface TokenInfo {
-    chainId: ChainId;
-    address: string;
-    decimals: number;
-    name?: string;
-    symbol?: string;
-    logoUrl?: string;
-}
+import { ChainId } from '../../chains/types';
+/**
+ * Token on a chain.
+ */
+export interface TokenInfo {
+    chainId: ChainId;
+    address: string;
+    decimals: number;
+    name?: string;
+    symbol?: string;
+    logoUrl?: string;
+}

package/dist/common/types/wallets.d.ts

@@ -1,5 +1,5 @@
-import { Signer } from 'ethers';
-import type { ExternalProvider } from '@ethersproject/providers';
-export type PrivateKey = string;
-export type AccountAddress = `0x${string}`;
-export type SignerLike = Signer | ExternalProvider | PrivateKey;
+import { Signer } from 'ethers';
+import type { ExternalProvider } from '@ethersproject/providers';
+export type PrivateKey = string;
+export type AccountAddress = `0x${string}`;
+export type SignerLike = Signer | ExternalProvider | PrivateKey;

package/dist/common/utils/common.d.ts

@@ -0,0 +1 @@
+export declare const isTruthy: <T>(value: T | null | undefined | false) => value is T;

package/dist/common/utils/config.d.ts

@@ -1,4 +1,4 @@
-import { SupportedChainId } from '../../chains/types';
-export declare function mapSupportedNetworks<T>(value: (chainId: SupportedChainId) => T): Record<SupportedChainId, T>;
-export declare function mapSupportedNetworks<T>(value: T): Record<SupportedChainId, T>;
-export declare function mapAddressToSupportedNetworks(address: string): Record<SupportedChainId, string>;
+import { SupportedChainId } from '../../chains/types';
+export declare function mapSupportedNetworks<T>(value: (chainId: SupportedChainId) => T): Record<SupportedChainId, T>;
+export declare function mapSupportedNetworks<T>(value: T): Record<SupportedChainId, T>;
+export declare function mapAddressToSupportedNetworks(address: string): Record<SupportedChainId, string>;

package/dist/common/utils/log.d.ts

@@ -0,0 +1,2 @@
+export declare function log(text: string): void;
+export declare function enableLogging(enabled: boolean): void;

package/dist/common/utils/math.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Convert a percentage to a bps value.
+ *
+ * It rounds to the nearest integer.
+ *
+ * @param percentage - The percentage to convert
+ * @returns The bps value
+ */
+export declare function percentageToBps(percentage: number | bigint): number;
+/**
+ * Apply a percentage to a bigint value
+ *
+ * Rounds to the nearest integer.
+ *
+ * @param value - The value to apply the percentage to
+ * @param percentage - The percentage to apply
+ * @returns The value after applying the percentage
+ */
+export declare function applyPercentage(value: bigint, percentage: number): bigint;

package/dist/common/utils/order.d.ts

@@ -0,0 +1,4 @@
+import { UnsignedOrder } from '../../order-signing';
+import type { Order } from '@cowprotocol/contracts';
+export declare function getOrderDeadlineFromNow(validFor: number): bigint;
+export declare function unsignedOrderForSigning(order: UnsignedOrder): Order;

package/dist/common/utils/serialize.d.ts

@@ -1 +1 @@
-export declare const jsonReplacer: (_key: string, value: unknown) => unknown;
+export declare const jsonWithBigintReplacer: (_key: string, value: unknown) => unknown;

package/dist/common/utils/wallet.d.ts

@@ -1,3 +1,3 @@
-import { SignerLike } from '../types/wallets';
-import { Signer } from '@ethersproject/abstract-signer';
-export declare function getSigner(signer: SignerLike): Signer;
+import { SignerLike } from '../types/wallets';
+import { Signer } from '@ethersproject/abstract-signer';
+export declare function getSigner(signer: SignerLike): Signer;