@cowprotocol/cow-sdk 6.0.0-RC.46 → 6.0.0-RC.47

package/dist/bridging/BridgingSdk/BridgingSdk.d.ts

@@ -1,8 +1,9 @@
 import { SwapAdvancedSettings, TradingSdk } from '../../trading';
-import { BridgeProvider, BridgeQuoteResult, CrossChainOrder, CrossChainQuoteAndPost, QuoteBridgeRequest } from '../types';
+import { BridgeProvider, BridgeQuoteResult, BridgeStatusResult, CrossChainOrder, CrossChainQuoteAndPost, QuoteBridgeRequest } from '../types';
 import { CowEnv, TokenInfo } from '../../common';
 import { ChainInfo, SupportedChainId, TargetChainId } from '../../chains';
-import { OrderBookApi } from 'src/order-book';
+import { JsonRpcProvider } from '@ethersproject/providers';
+import { OrderBookApi } from '../../order-book';
 export interface BridgingSdkOptions {
     /**
      * Providers for the bridging.
@@ -25,14 +26,18 @@ export interface BridgingSdkOptions {
  * Parameters for the `getOrder` method.
  */
 export interface GetOrderParams {
+    /**
+     * Id of a network where order was settled
+     */
+    chainId: SupportedChainId;
     /**
      * The unique identifier of the order.
      */
     orderId: string;
     /**
-     * The chain ID of the order.
+     * RPC provider to get order transactions details
      */
-    chainId: SupportedChainId;
+    rpcProvider: JsonRpcProvider;
     /**
      * The environment of the order
      */
@@ -61,9 +66,8 @@ export declare class BridgingSdk {
     getTargetNetworks(): Promise<ChainInfo[]>;
     /**
      * Get the available buy tokens for buying in a specific target chain
-     *
-     * @param param
-     * @returns
+  
+     * @param targetChainId
      */
     getBuyTokens(targetChainId: TargetChainId): Promise<TokenInfo[]>;
     /**
@@ -82,5 +86,7 @@ export declare class BridgingSdk {
      * @throws Error if no path is found
      */
     getQuote(quoteBridgeRequest: QuoteBridgeRequest, advancedSettings?: SwapAdvancedSettings): Promise<CrossChainQuoteAndPost>;
-    getOrder(params: GetOrderParams): Promise<CrossChainOrder>;
+    getOrder(params: GetOrderParams): Promise<CrossChainOrder | null>;
+    getOrderBridgingStatus(bridgingId: string, originChainId: SupportedChainId): Promise<BridgeStatusResult>;
+    getProviderFromAppData(fullAppData: string): BridgeProvider<BridgeQuoteResult> | undefined;
 }

package/dist/bridging/BridgingSdk/findBridgeProviderFromHook.d.ts

@@ -0,0 +1,2 @@
+import { BridgeProvider, BridgeQuoteResult } from '../types';
+export declare function findBridgeProviderFromHook(fullAppData: string, providers: BridgeProvider<BridgeQuoteResult>[]): BridgeProvider<BridgeQuoteResult> | undefined;

package/dist/bridging/BridgingSdk/getCrossChainOrder.d.ts

@@ -1,14 +1,18 @@
 import { BridgeProvider, BridgeQuoteResult, CrossChainOrder } from '../types';
-import { SupportedChainId } from '../../chains';
-import { OrderBookApi } from 'src/order-book';
 import { CowEnv } from '../../common';
-/**
- * Fetch a cross-chain order and its status.
- */
-export declare function getCrossChainOrder(params: {
-    orderId: string;
+import { JsonRpcProvider } from '@ethersproject/providers';
+import { SupportedChainId } from '../../chains';
+import { OrderBookApi } from '../../order-book';
+interface GetCrossChainOrderParams {
     chainId: SupportedChainId;
+    orderId: string;
+    rpcProvider: JsonRpcProvider;
     orderBookApi: OrderBookApi;
     providers: BridgeProvider<BridgeQuoteResult>[];
     env: CowEnv;
-}): Promise<CrossChainOrder>;
+}
+/**
+ * Fetch a cross-chain order and its status.
+ */
+export declare function getCrossChainOrder(params: GetCrossChainOrderParams): Promise<CrossChainOrder | null>;
+export {};

package/dist/bridging/const.d.ts

@@ -1,2 +1,3 @@
 export declare const RAW_PROVIDERS_FILES_PATH = "https://raw.githubusercontent.com/cowprotocol/cow-sdk/refs/heads/main/src/bridging/providers";
 export declare const DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION = 200000;
+export declare const HOOK_DAPP_BRIDGE_PROVIDER_PREFIX = "cow-sdk://bridging/providers";

package/dist/bridging/errors.d.ts

@@ -2,3 +2,7 @@ export declare class BridgeProviderQuoteError extends Error {
     readonly context: unknown;
     constructor(message: string, context: unknown);
 }
+export declare class BridgeOrderParsingError extends Error {
+    readonly context?: unknown | undefined;
+    constructor(message: string, context?: unknown | undefined);
+}

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

@@ -1,4 +1,4 @@
-import { AvailableRoutesRequest, Route, SuggestedFeesRequest, SuggestedFeesResponse } from './types';
+import { AvailableRoutesRequest, DepositStatusRequest, DepositStatusResponse, Route, SuggestedFeesRequest, SuggestedFeesResponse } from './types';
 import { TokenInfo } from '../../../common';
 export interface AcrossApiOptions {
     apiBaseUrl?: string;
@@ -25,5 +25,6 @@ export declare class AcrossApi {
      */
     getSuggestedFees(request: SuggestedFeesRequest): Promise<SuggestedFeesResponse>;
     getSupportedTokens(): Promise<TokenInfo[]>;
+    getDepositStatus(request: DepositStatusRequest): Promise<DepositStatusResponse>;
     protected fetchApi<T>(path: string, params: Record<string, string>, isValidResponse?: (response: unknown) => response is T): Promise<T>;
 }

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

@@ -1,11 +1,12 @@
 import { Signer } from 'ethers';
 import { latest as latestAppData } from '@cowprotocol/app-data';
-import { BridgeDeposit, BridgeHook, BridgeProvider, BridgeProviderInfo, BridgeQuoteResult, BridgeStatusResult, QuoteBridgeRequest } from '../../types';
-import { ChainInfo, SupportedChainId, TargetChainId } from '../../../chains';
+import { BridgeDeposit, BridgeHook, BridgeProvider, BridgeProviderInfo, BridgeQuoteResult, BridgeStatusResult, BridgingDepositParams, QuoteBridgeRequest } from '../../types';
+import { ChainId, ChainInfo, SupportedChainId, TargetChainId } from '../../../chains';
 import { EvmCall, TokenInfo } from '../../../common';
 import { AcrossApi, AcrossApiOptions } from './AcrossApi';
 import { CowShedSdk, CowShedSdkOptions } from '../../../cow-shed';
 import { SuggestedFeesResponse } from './types';
+import { JsonRpcProvider } from '@ethersproject/providers';
 export declare const ACROSS_SUPPORTED_NETWORKS: ChainInfo[];
 export interface AcrossBridgeProviderOptions {
     apiOptions?: AcrossApiOptions;
@@ -28,9 +29,9 @@ export declare class AcrossBridgeProvider implements BridgeProvider<AcrossQuoteR
     getGasLimitEstimationForHook(_request: QuoteBridgeRequest): number;
     getSignedHook(chainId: SupportedChainId, unsignedCall: EvmCall, signer: Signer, defaultGasLimit?: bigint): Promise<BridgeHook>;
     decodeBridgeHook(_hook: latestAppData.CoWHook): Promise<BridgeDeposit>;
-    getBridgingId(_orderUid: string, _settlementTx: string, _logIndex: number): Promise<string>;
+    getBridgingParams(chainId: ChainId, provider: JsonRpcProvider, orderUid: string, txHash: string): Promise<BridgingDepositParams | null>;
     getExplorerUrl(bridgingId: string): string;
-    getStatus(_bridgingId: string): Promise<BridgeStatusResult>;
+    getStatus(bridgingId: string, originChainId: SupportedChainId): Promise<BridgeStatusResult>;
     getCancelBridgingTx(_bridgingId: string): Promise<EvmCall>;
     getRefundBridgingTx(_bridgingId: string): Promise<EvmCall>;
     private getSupportedTokensState;

package/dist/bridging/providers/across/const/interfaces.d.ts

@@ -0,0 +1,3 @@
+import { Interface } from 'ethers/lib/utils';
+export declare const ACROSS_DEPOSIT_EVENT_INTERFACE: Interface;
+export declare const COW_TRADE_EVENT_INTERFACE: Interface;

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

@@ -1 +1,2 @@
-export declare const HOOK_DAPP_BRIDGE_PROVIDER_PREFIX = "cow-sdk://bridging/providers";
+export declare const ACROSS_DEPOSIT_EVENT_TOPIC: string;
+export declare const COW_TRADE_EVENT_TOPIC: string;

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

@@ -0,0 +1,4 @@
+import { TransactionReceipt } from '@ethersproject/abstract-provider';
+import { SupportedChainId } from '../../../chains';
+import { BridgingDepositParams } from '../../types';
+export declare function getDepositParams(chainId: SupportedChainId, orderId: string, txReceipt: TransactionReceipt): Promise<BridgingDepositParams | null>;

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

@@ -167,3 +167,76 @@ export interface PctFee {
     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,8 +1,9 @@
-import { QuoteBridgeRequest } from '../../../bridging/types';
-import { TargetChainId } from '../../../chains';
+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';
-import { SuggestedFeesResponse } from './types';
 /**
  * Return the chain configs
  *
@@ -37,3 +38,6 @@ export declare function pctToBps(pct: bigint): number;
  */
 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/mock/MockBridgeProvider.d.ts

@@ -1,8 +1,9 @@
 import { latest as latestAppData } from '@cowprotocol/app-data';
-import { BridgeDeposit, BridgeHook, BridgeProvider, BridgeProviderInfo, BridgeQuoteResult, BridgeStatusResult, QuoteBridgeRequest } from '../../types';
+import { BridgeDeposit, BridgeHook, BridgeProvider, BridgeProviderInfo, BridgeQuoteResult, BridgeStatusResult, BridgingDepositParams, QuoteBridgeRequest } from '../../types';
 import { EvmCall, TokenInfo } from '../../../common';
-import { ChainInfo, SupportedChainId, TargetChainId } from '../../../chains';
+import { ChainId, ChainInfo, SupportedChainId, TargetChainId } from '../../../chains';
 import { Signer } from '@ethersproject/abstract-signer';
+import { JsonRpcProvider } from '@ethersproject/providers';
 export declare class MockBridgeProvider implements BridgeProvider<BridgeQuoteResult> {
     info: BridgeProviderInfo;
     getNetworks(): Promise<ChainInfo[]>;
@@ -13,7 +14,7 @@ export declare class MockBridgeProvider implements BridgeProvider<BridgeQuoteRes
     getUnsignedBridgeCall(_request: QuoteBridgeRequest, _quote: BridgeQuoteResult): Promise<EvmCall>;
     getSignedHook(_chainId: SupportedChainId, _unsignedCall: EvmCall, _signer: Signer): Promise<BridgeHook>;
     decodeBridgeHook(_hook: latestAppData.CoWHook): Promise<BridgeDeposit>;
-    getBridgingId(_orderUid: string, _settlementTx: string, _logIndex: number): Promise<string>;
+    getBridgingParams(_chainId: ChainId, _provider: JsonRpcProvider, _orderUid: string, _txHash: string): Promise<BridgingDepositParams>;
     getExplorerUrl(bridgingId: string): string;
     getStatus(_bridgingId: string): Promise<BridgeStatusResult>;
     getCancelBridgingTx(_bridgingId: string): Promise<EvmCall>;

package/dist/bridging/types.d.ts

@@ -1,14 +1,16 @@
 import { latest as latestAppData } from '@cowprotocol/app-data';
-import { ChainInfo, SupportedChainId, TargetChainId } from '../chains';
+import { ChainId, ChainInfo, SupportedChainId, TargetChainId } from '../chains';
 import { TokenInfo } from '../common/types/tokens';
 import { Address, Amounts, EnrichedOrder, OrderKind } from '../order-book';
 import { EvmCall } from '../common/types/ethereum';
 import type { AccountAddress } from '../common/types/wallets';
 import { OrderPostingResult, QuoteAndPost, QuoteResults, QuoterParameters, SwapAdvancedSettings, TradeOptionalParameters, TraderParameters } from '../trading';
 import { Signer } from '@ethersproject/abstract-signer';
+import { JsonRpcProvider } from '@ethersproject/providers';
 export interface BridgeProviderInfo {
     name: string;
     logoUrl: string;
+    dappId: string;
 }
 interface WithSellToken {
     sellTokenChainId: SupportedChainId;
@@ -78,11 +80,10 @@ export interface BridgeHook {
     recipient: string;
 }
 export declare enum BridgeStatus {
-    NOT_INITIATED = "not_initiated",
     IN_PROGRESS = "in_progress",
     EXECUTED = "executed",
-    FAILED = "failed",
-    EXPIRED = "expired"
+    EXPIRED = "expired",
+    REFUND = "refund"
 }
 export interface BridgeStatusResult {
     status: BridgeStatus;
@@ -169,11 +170,12 @@ export interface BridgeProvider<Q extends BridgeQuoteResult> {
     decodeBridgeHook(hook: latestAppData.CoWHook): Promise<BridgeDeposit>;
     /**
      * Get the identifier of the bridging transaction from the settlement transaction.
+     * @param chainId
+     * @param provider - Provider is needed in order to get transaction details from blockchain.
      * @param orderUid - The unique identifier of the order
-     * @param settlementTx - The settlement transaction in which the bridging post-hook was executed
-     * @param logIndex - The log index of the trade within the settlement transaction
+     * @param txHash - The hash of the settlement transaction in which the bridging post-hook was executed
      */
-    getBridgingId(orderUid: string, settlementTx: string, logIndex: number): Promise<string>;
+    getBridgingParams(chainId: ChainId, provider: JsonRpcProvider, orderUid: string, txHash: string): Promise<BridgingDepositParams | null>;
     /**
      * Get the explorer url for a bridging id.
      *
@@ -184,8 +186,9 @@ export interface BridgeProvider<Q extends BridgeQuoteResult> {
      * Get the status of a bridging transaction.
      *
      * @param bridgingId - The bridging id
+     * @param originChainId - id of network where funds were deposited
      */
-    getStatus(bridgingId: string): Promise<BridgeStatusResult>;
+    getStatus(bridgingId: string, originChainId: SupportedChainId): Promise<BridgeStatusResult>;
     getCancelBridgingTx(bridgingId: string): Promise<EvmCall>;
     getRefundBridgingTx(bridgingId: string): Promise<EvmCall>;
 }
@@ -272,11 +275,25 @@ export interface BridgeQuoteResults extends BridgeQuoteResult {
      */
     bridgeCallDetails: BridgeCallDetails;
 }
+export interface BridgingDepositParams {
+    inputTokenAddress: Address;
+    outputTokenAddress: Address;
+    inputAmount: bigint;
+    outputAmount: bigint;
+    owner: Address;
+    quoteTimestamp: number;
+    fillDeadline: number;
+    recipient: Address;
+    sourceChainId: number;
+    destinationChainId: number;
+    bridgingId: string;
+}
 export interface CrossChainOrder {
     chainId: SupportedChainId;
     order: EnrichedOrder;
     status: BridgeStatus;
-    bridgingId?: string;
+    bridgingParams: BridgingDepositParams;
+    tradeTxHash: string;
     explorerUrl?: string;
     fillTimeInSeconds?: number;
 }