@cowprotocol/cow-sdk 6.3.2-RC.2 → 7.0.0-beta.0

package/dist/bridging/providers/across/types.d.ts

@@ -1,242 +0,0 @@
-import type { TargetChainId } from '../../../chains';
-export interface AvailableRoutesRequest {
-    originChainId: string;
-    originToken: string;
-    destinationChainId: string;
-    destinationToken: string;
-}
-export interface Route {
-    originChainId: string;
-    originToken: string;
-    destinationChainId: string;
-    destinationToken: string;
-    originTokenSymbol: string;
-    destinationTokenSymbol: string;
-}
-export interface SuggestedFeesRequest {
-    token: string;
-    originChainId: TargetChainId;
-    destinationChainId: TargetChainId;
-    /**
-     * Amount of the token to transfer.
-     *
-     * Note that this amount is in the native decimals of the token. So, for WETH, this would be the amount of
-     * human-readable WETH multiplied by 1e18.
-     *
-     * For USDC, you would multiply the number of human-readable USDC by 1e6.
-     *
-     * Example: 1000000000000000000
-     */
-    amount: bigint;
-    /**
-     * Recipient of the deposit. Can be an EOA or a contract. If this is an EOA and message is defined, then the API will throw a 4xx error.
-     *
-     * Example: 0xc186fA914353c44b2E33eBE05f21846F1048bEda
-     */
-    recipient?: string;
-    /**
-     * The quote timestamp used to compute the LP fees. When bridging with across, the user only specifies the quote
-     * timestamp in their transaction. The relayer then determines the utilization at that timestamp to determine the
-     * user's fee. This timestamp must be close (within 10 minutes or so) to the current time on the chain where the
-     * user is depositing funds and it should be <= the current block timestamp on mainnet. This allows the user to know
-     * exactly what LP fee they will pay before sending the transaction.
-     *
-     * If this value isn't provided in the request, the API will assume the latest block timestamp on mainnet.
-     *
-     * Example: 1653547649
-     */
-    timestamp?: number;
-    /**
-     * Optionally override the relayer address used to simulate the fillRelay() call that estimates the gas costs
-     * needed to fill a deposit. This simulation result impacts the returned suggested-fees. The reason to customize the
-     * EOA would be primarily if the recipientAddress is a contract and requires a certain relayer to submit the fill,
-     * or if one specific relayer has the necessary token balance to make the fill.
-     *
-     * Example: 0x428AB2BA90Eba0a4Be7aF34C9Ac451ab061AC010
-     */
-    relayer?: string;
-}
-export interface SuggestedFeesLimits {
-    /**
-     * The minimum deposit size in the tokens' units.
-     *
-     * Note: USDC has 6 decimals, so this value would be the number of USDC multiplied by 1e6. For WETH, that would be 1e18.
-     */
-    minDeposit: string;
-    /**
-     * The maximum deposit size in the tokens' units. Note: The formatting of this number is the same as minDeposit.
-     */
-    maxDeposit: string;
-    /**
-     * The max deposit size that can be relayed "instantly" on the destination chain.
-     *
-     * Instantly means that there is relayer capital readily available and that a relayer is expected to relay within
-     * seconds to 5 minutes of the deposit.
-     */
-    maxDepositInstant: string;
-    /**
-     * The max deposit size that can be relayed with a "short delay" on the destination chain.
-     *
-     * This means that there is relayer capital available on mainnet and that a relayer will immediately begin moving
-     * that capital over the canonical bridge to relay the deposit. Depending on the chain, the time for this can vary.
-     *
-     * Polygon is the worst case where it can take between 20 and 35 minutes for the relayer to receive the funds
-     * and relay.
-     *
-     * Arbitrum is much faster, with a range between 5 and 15 minutes. Note: if the transfer size is greater than this,
-     * the estimate should be between 2-4 hours for a slow relay to be processed from the mainnet pool.
-     */
-    maxDepositShortDelay: string;
-    /**
-     * The recommended deposit size that can be relayed "instantly" on the destination chain.
-     *
-     * Instantly means that there is relayer capital readily available and that a relayer is expected to relay
-     * within seconds to 5 minutes of the deposit. Value is in the smallest unit of the respective token.
-     */
-    recommendedDepositInstant: string;
-}
-export interface SuggestedFeesResponse {
-    /**
-     * Percentage of the transfer amount that should go to the relayer as a fee in total. The value is inclusive of lpFee.pct.
-     *
-     * This is the strongly recommended minimum value to ensure a relayer will perform the transfer under the current
-     * network conditions.
-     *
-     * The value returned in this field is guaranteed to be at least 0.03% in order to meet minimum relayer fee requirements
-     */
-    totalRelayFee: PctFee;
-    /**
-     * The percentage of the transfer amount that should go the relayer as a fee to cover relayer capital costs.
-     */
-    relayerCapitalFee: PctFee;
-    /**
-     * The percentage of the transfer amount that should go the relayer as a fee to cover relayer gas costs.
-     */
-    relayerGasFee: PctFee;
-    /**
-     * The percent of the amount that will go to the LPs as a fee for borrowing their funds.
-     */
-    lpFee: PctFee;
-    /**
-     * The quote timestamp that was used to compute the lpFeePct. To pay the quoted LP fee, the user would need to pass
-     * this quote timestamp to the protocol when sending their bridge transaction.
-     */
-    timestamp: string;
-    /**
-     * Is the input amount below the minimum transfer amount.
-     */
-    isAmountTooLow: boolean;
-    /**
-     * The block used associated with this quote, used to compute lpFeePct.
-     */
-    quoteBlock: string;
-    /**
-     * The contract address of the origin SpokePool.
-     */
-    spokePoolAddress: string;
-    /**
-     * The relayer that is suggested to be set as the exclusive relayer for in the depositV3 call for the fastest fill.
-     *
-     * Note: when set to "0x0000000000000000000000000000000000000000", relayer exclusivity will be disabled.
-     * This value is returned in cases where using an exclusive relayer is not recommended.
-     */
-    exclusiveRelayer: string;
-    /**
-     * The suggested exclusivity period (in seconds) the exclusive relayer should be given to fill before other relayers
-     * are allowed to take the fill. Note: when set to "0", relayer exclusivity will be disabled.
-     *
-     * This value is returned in cases where using an exclusive relayer is not recommended.
-     */
-    exclusivityDeadline: string;
-    /**
-     * The expected time (in seconds) for a fill to be made. Represents 75th percentile of the 7-day rolling average of times (updated daily). Times are dynamic by origin/destination token/chain for a given amount.
-     */
-    estimatedFillTimeSec: string;
-    /**
-     * The recommended deadline (UNIX timestamp in seconds) for the relayer to fill the deposit. After this destination chain timestamp, the fill will revert on the destination chain.
-     */
-    fillDeadline: string;
-    limits: SuggestedFeesLimits;
-}
-export interface PctFee {
-    /**
-     * Note: 1% is represented as 1e16, 100% is 1e18, 50% is 5e17, etc. These values are in the same format that the contract understands.
-     *
-     * Example: 100200000000000
-     */
-    pct: string;
-    total: string;
-}
-export interface DepositStatusRequest {
-    originChainId: string;
-    depositId: string;
-}
-export interface DepositStatusResponse {
-    /**
-     * Status of the deposit:
-     * - filled: Deposit has been filled on destination chain (FilledV3Relay event emitted)
-     * - pending: Deposit not yet filled
-     * - expired: Deposit expired and will be refunded
-     * - refunded: Deposit expired and depositor refunded on originChain
-     * - slowFillRequested: Across' relayer fills without requiring another relayer to front capital
-     *   (requires input token and output token to be the same asset)
-     */
-    status: 'filled' | 'pending' | 'expired' | 'refunded' | 'slowFillRequested';
-    /**
-     * Origin chain ID where the deposit was made.
-     */
-    originChainId: string;
-    /**
-     * Unique identifier of the deposit.
-     */
-    depositId: string;
-    /**
-     * Transaction hash of the deposit on the origin chain.
-     */
-    depositTxHash?: string;
-    /**
-     * Transaction hash of the fill on the destination chain.
-     * Only present when fillStatus is 'filled'.
-     */
-    fillTx?: string;
-    /**
-     * Destination chain ID where the fill transaction will occur.
-     */
-    destinationChainId?: string;
-    /**
-     * Transaction hash of the refund on the origin chain.
-     * Only present when fillStatus is 'refunded'.
-     */
-    depositRefundTxHash?: string;
-    /**
-     * Pagination information for the response.
-     */
-    pagination?: {
-        currentIndex: number;
-        maxIndex: number;
-    };
-}
-export interface AcrossDepositEvent {
-    inputToken: string;
-    outputToken: string;
-    inputAmount: string;
-    outputAmount: string;
-    destinationChainId: string;
-    depositId: string;
-    quoteTimestamp: string;
-    fillDeadline: string;
-    exclusivityDeadline: string;
-    depositor: string;
-    recipient: string;
-    exclusiveRelayer: string;
-    message: string;
-}
-export interface CowTradeEvent {
-    owner: string;
-    sellToken: string;
-    buyToken: string;
-    sellAmount: string;
-    buyAmount: string;
-    feeAmount: string;
-    orderUid: string;
-}

package/dist/bridging/providers/across/util.d.ts

@@ -1,43 +0,0 @@
-import { Log } from '@ethersproject/providers';
-import { BridgeStatus, QuoteBridgeRequest } from '../../types';
-import { SupportedChainId, TargetChainId } from '../../../chains';
-import { AcrossDepositEvent, CowTradeEvent, DepositStatusResponse, SuggestedFeesResponse } from './types';
-import { AcrossQuoteResult } from './AcrossBridgeProvider';
-import { AcrossChainConfig } from './const/tokens';
-/**
- * Return the chain configs
- *
- * This is a temporary implementation. We should use the Across API to get the intermediate tokens (see this.getAvailableRoutes())
- */
-export declare function getChainConfigs(sourceChainId: TargetChainId, targetChainId: TargetChainId): {
-    sourceChainConfig: AcrossChainConfig;
-    targetChainConfig: AcrossChainConfig;
-} | undefined;
-export declare function getTokenSymbol(tokenAddress: string, chainConfig: AcrossChainConfig): string | undefined;
-export declare function getTokenAddress(tokenSymbol: string, chainConfig: AcrossChainConfig): string | undefined;
-export declare function toBridgeQuoteResult(request: QuoteBridgeRequest, slippageBps: number, suggestedFees: SuggestedFeesResponse): AcrossQuoteResult;
-/**
- * pct represents a percentage.
- *
- * Note: 1% is represented as 1e16, 100% is 1e18, 50% is 5e17, etc. These values are in the same format that the contract understands.
- *
- * Bps is a percentage in basis points (1/100th of a percent). For example, 1% is 100 bps.
- *
- * @param pct - The percentage to convert to bps
- * @returns The percentage in bps
- * @throws If the percentage is greater than 100% or less than 0%
- */
-export declare function pctToBps(pct: bigint): number;
-/**
- * Apply a percentage fee to an amount.
- *
- * @param amount - The amount to apply the fee to
- * @param pct - The percentage fee to apply
- * @throws If the percentage fee is greater than 100% or less than 0%
- * @returns The amount after the fee has been applied
- */
-export declare function applyPctFee(amount: bigint, pct: bigint): bigint;
-export declare function applyBps(amount: bigint, bps: number): bigint;
-export declare function mapAcrossStatusToBridgeStatus(status: DepositStatusResponse['status']): BridgeStatus;
-export declare function getAcrossDepositEvents(chainId: SupportedChainId, logs: Log[]): AcrossDepositEvent[];
-export declare function getCowTradeEvents(chainId: SupportedChainId, logs: Log[]): CowTradeEvent[];

package/dist/bridging/providers/bungee/BungeeApi.d.ts

@@ -1,67 +0,0 @@
-import { AcrossStatus, BungeeBuildTx, BungeeEvent, BungeeQuote, BungeeQuoteAPIRequest, BungeeQuoteWithBuildTx, SocketRequest, SupportedBridge } from './types';
-import { SignerLike, TokenInfo } from '../../../common';
-import { SupportedChainId, TargetChainId } from '../../../chains';
-import { BuyTokensParams } from '../../types';
-export interface BungeeApiOptions {
-    apiBaseUrl?: string;
-    manualApiBaseUrl?: string;
-    eventsApiBaseUrl?: string;
-    acrossApiBaseUrl?: string;
-    includeBridges?: SupportedBridge[];
-}
-interface IntermediateTokensParams {
-    fromChainId: SupportedChainId;
-    toChainId: TargetChainId;
-    toTokenAddress: string;
-    includeBridges?: SupportedBridge[];
-}
-export declare class BungeeApi {
-    private readonly options;
-    constructor(options?: BungeeApiOptions);
-    validateBridges(includeBridges: SupportedBridge[]): void;
-    getBuyTokens(params: BuyTokensParams, bridgeParams?: {
-        includeBridges?: SupportedBridge[];
-    }): Promise<TokenInfo[]>;
-    getIntermediateTokens(params: IntermediateTokensParams): Promise<TokenInfo[]>;
-    /**
-     * Makes a GET request to Bungee APIs for quote and build tx
-     */
-    getBungeeQuoteWithBuildTx(params: BungeeQuoteAPIRequest): Promise<BungeeQuoteWithBuildTx>;
-    /**
-     * Makes a GET request to Bungee APIs for quote
-     * https://docs.bungee.exchange/bungee-api/api-reference/bungee-controller-quote-v-1
-     */
-    getBungeeQuote(params: BungeeQuoteAPIRequest): Promise<BungeeQuote>;
-    /**
-     * Makes a GET request to Bungee APIs for build tx
-     * https://docs.bungee.exchange/bungee-api/api-reference/bungee-controller-build-tx-v-1
-     */
-    getBungeeBuildTx(quote: BungeeQuote): Promise<BungeeBuildTx>;
-    /**
-     * Verifies the build tx data for a quote using the SocketVerifier contract
-     * @param quote - The quote object
-     * @param buildTx - The build tx object
-     * @param signer - The signer object
-     * @returns True if the build tx data is valid, false otherwise
-     */
-    verifyBungeeBuildTx(quote: BungeeQuote, buildTx: BungeeBuildTx, signer: SignerLike): Promise<boolean>;
-    /**
-     * Verifies the bungee tx data using the SocketVerifier contract
-     * @param originChainId - The origin chain id
-     * @param txData - The tx data
-     * @param routeId - The route id
-     * @param expectedSocketRequest - The expected socket request
-     * @param signer - The signer object
-     * @returns True if the bungee tx data is valid, false otherwise
-     */
-    verifyBungeeBuildTxData(originChainId: SupportedChainId, txData: string, routeId: string, expectedSocketRequest: SocketRequest, signer: SignerLike): Promise<boolean>;
-    getEvents(params: {
-        orderId: string;
-    } | {
-        txHash: string;
-    }): Promise<BungeeEvent[]>;
-    getAcrossStatus(depositTxHash: string): Promise<AcrossStatus>;
-    private getSupportedBridges;
-    private makeApiCall;
-}
-export {};

package/dist/bridging/providers/bungee/BungeeBridgeProvider.d.ts

@@ -1,45 +0,0 @@
-import { latest as latestAppData } from '@cowprotocol/app-data';
-import { BridgeDeposit, BridgeHook, BridgeProvider, BridgeProviderInfo, BridgeQuoteResult, BridgeStatusResult, BridgingDepositParams, BuyTokensParams, GetProviderBuyTokens, QuoteBridgeRequest } from '../../types';
-import { ChainId, ChainInfo, SupportedChainId } from '../../../chains';
-import { EvmCall, TokenInfo } from '../../../common';
-import { BungeeApi, BungeeApiOptions } from './BungeeApi';
-import { CowShedSdk, CowShedSdkOptions } from '../../../cow-shed';
-import { BungeeBuildTx, BungeeQuote } from './types';
-import type { JsonRpcProvider } from '@ethersproject/providers';
-import type { Signer } from 'ethers';
-export declare const BUNGEE_HOOK_DAPP_ID = "cow-sdk://bridging/providers/bungee";
-export declare const BUNGEE_SUPPORTED_NETWORKS: ChainInfo[];
-export interface BungeeBridgeProviderOptions {
-    getRpcProvider(chainId: SupportedChainId): JsonRpcProvider;
-    apiOptions?: BungeeApiOptions;
-    cowShedOptions?: CowShedSdkOptions;
-}
-export interface BungeeQuoteResult extends BridgeQuoteResult {
-    bungeeQuote: BungeeQuote;
-    buildTx: BungeeBuildTx;
-}
-export declare class BungeeBridgeProvider implements BridgeProvider<BungeeQuoteResult> {
-    private options;
-    protected api: BungeeApi;
-    protected cowShedSdk: CowShedSdk;
-    getRpcProvider: (chainId: SupportedChainId) => JsonRpcProvider;
-    constructor(options: BungeeBridgeProviderOptions);
-    info: BridgeProviderInfo;
-    getNetworks(): Promise<ChainInfo[]>;
-    getBuyTokens(params: BuyTokensParams): Promise<GetProviderBuyTokens>;
-    getIntermediateTokens(request: QuoteBridgeRequest): Promise<TokenInfo[]>;
-    getQuote(request: QuoteBridgeRequest): Promise<BungeeQuoteResult>;
-    getUnsignedBridgeCall(request: QuoteBridgeRequest, quote: BungeeQuoteResult): Promise<EvmCall>;
-    getGasLimitEstimationForHook(request: QuoteBridgeRequest): Promise<number>;
-    getSignedHook(chainId: SupportedChainId, unsignedCall: EvmCall, signer: Signer, bridgeHookNonce: string, deadline: bigint, hookGasLimit: number): Promise<BridgeHook>;
-    getBridgingParams(_chainId: ChainId, orderId: string, _txHash: string): Promise<{
-        params: BridgingDepositParams;
-        status: BridgeStatusResult;
-    } | null>;
-    decodeBridgeHook(_hook: latestAppData.CoWHook): Promise<BridgeDeposit>;
-    getExplorerUrl(bridgingId: string): string;
-    getStatus(_bridgingId: string): Promise<BridgeStatusResult>;
-    getCancelBridgingTx(_bridgingId: string): Promise<EvmCall>;
-    getRefundBridgingTx(_bridgingId: string): Promise<EvmCall>;
-    private isExtraGasRequired;
-}

package/dist/bridging/providers/bungee/abi.d.ts

@@ -1,203 +0,0 @@
-export declare const ERC20_ABI: string[];
-export declare const SOCKET_VERIFIER_ABI: ({
-    type: string;
-    inputs: {
-        name: string;
-        type: string;
-        internalType: string;
-    }[];
-    stateMutability: string;
-    name?: undefined;
-    outputs?: undefined;
-    anonymous?: undefined;
-} | {
-    type: string;
-    name: string;
-    inputs: {
-        name: string;
-        type: string;
-        internalType: string;
-    }[];
-    outputs: {
-        name: string;
-        type: string;
-        internalType: string;
-        components: {
-            name: string;
-            type: string;
-            internalType: string;
-        }[];
-    }[];
-    stateMutability: string;
-    anonymous?: undefined;
-} | {
-    type: string;
-    name: string;
-    inputs: {
-        name: string;
-        type: string;
-        internalType: string;
-    }[];
-    outputs: {
-        name: string;
-        type: string;
-        internalType: string;
-    }[];
-    stateMutability: string;
-    anonymous?: undefined;
-} | {
-    type: string;
-    name: string;
-    inputs: ({
-        name: string;
-        type: string;
-        internalType: string;
-        components?: undefined;
-    } | {
-        name: string;
-        type: string;
-        internalType: string;
-        components: ({
-            name: string;
-            type: string;
-            internalType: string;
-            components?: undefined;
-        } | {
-            name: string;
-            type: string;
-            internalType: string;
-            components: {
-                name: string;
-                type: string;
-                internalType: string;
-            }[];
-        })[];
-    })[];
-    outputs: never[];
-    stateMutability: string;
-    anonymous?: undefined;
-} | {
-    type: string;
-    name: string;
-    inputs: {
-        name: string;
-        type: string;
-        indexed: boolean;
-        internalType: string;
-    }[];
-    anonymous: boolean;
-    stateMutability?: undefined;
-    outputs?: undefined;
-} | {
-    type: string;
-    name: string;
-    inputs: never[];
-    stateMutability?: undefined;
-    outputs?: undefined;
-    anonymous?: undefined;
-})[];
-export declare const BUNGEE_COWSWAP_LIB_ABI: ({
-    inputs: never[];
-    name: string;
-    type: string;
-    outputs?: undefined;
-    stateMutability?: undefined;
-} | {
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    stateMutability: string;
-    type: string;
-})[];
-export declare const SOCKET_GATEWAY_ABI: ({
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    stateMutability: string;
-    type: string;
-    name?: undefined;
-    anonymous?: undefined;
-    outputs?: undefined;
-} | {
-    inputs: never[];
-    name: string;
-    type: string;
-    stateMutability?: undefined;
-    anonymous?: undefined;
-    outputs?: undefined;
-} | {
-    anonymous: boolean;
-    inputs: {
-        indexed: boolean;
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    stateMutability?: undefined;
-    outputs?: undefined;
-} | {
-    stateMutability: string;
-    type: string;
-    inputs?: undefined;
-    name?: undefined;
-    anonymous?: undefined;
-    outputs?: undefined;
-} | {
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-} | {
-    inputs: {
-        components: {
-            internalType: string;
-            name: string;
-            type: string;
-        }[];
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-})[];
-export declare const BUNGEE_APPROVE_AND_BRIDGE_V1_ABI: {
-    type: string;
-    name: string;
-    inputs: {
-        name: string;
-        type: string;
-        internalType: string;
-    }[];
-    outputs: never[];
-    stateMutability: string;
-}[];

package/dist/bridging/providers/bungee/const/contracts.d.ts

@@ -1,4 +0,0 @@
-import { TargetChainId } from '../../../../chains';
-export declare const BungeeCowswapLibAddresses: Record<TargetChainId, string | undefined>;
-export declare const SocketVerifierAddresses: Record<TargetChainId, string | undefined>;
-export declare const BungeeApproveAndBridgeV1Addresses: Record<TargetChainId, string | undefined>;

package/dist/bridging/providers/bungee/const/misc.d.ts

@@ -1,8 +0,0 @@
-import { BungeeTxDataBytesIndicesType } from '../types';
-export declare const HOOK_DAPP_BRIDGE_PROVIDER_PREFIX = "cow-sdk://bridging/providers";
-/**
- * Mapping of indices of different fields in the calldata for different bridges
- * Considers the full SocketGateway calldata eg. calldata that goes via SocketGateway.fallback()
- * 0x + routeId (4bytes) + function selector (4bytes) + function input params
- */
-export declare const BungeeTxDataBytesIndices: BungeeTxDataBytesIndicesType;

package/dist/bridging/providers/bungee/createBungeeDepositCall.d.ts

@@ -1,7 +0,0 @@
-import { EvmCall } from '../../../common';
-import { BungeeQuoteResult } from './BungeeBridgeProvider';
-import { QuoteBridgeRequest } from '../../types';
-export declare function createBungeeDepositCall(params: {
-    request: QuoteBridgeRequest;
-    quote: BungeeQuoteResult;
-}): Promise<EvmCall>;

package/dist/bridging/providers/bungee/getBridgingStatusFromEvents.d.ts

@@ -1,3 +0,0 @@
-import { BridgeStatusResult } from '../../types';
-import { AcrossStatus, BungeeEvent } from './types';
-export declare function getBridgingStatusFromEvents(events: BungeeEvent[] | undefined, getAcrossStatus: (depositTxHash: string) => Promise<AcrossStatus>): Promise<BridgeStatusResult>;