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

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

@@ -49,7 +49,13 @@ export declare class BridgingSdk {
      *
      * This method support both, cross-chain swaps and single-chain swap.
      *
-     * The return type will be either `QuoteAndPost` or `BridgeQuoteAndPost`. To safely assert the type in Typescript, you can use `isBridgeQuoteAndPost(result)` utility.
+     * The return type will be either `QuoteAndPost` or `BridgeQuoteAndPost`.
+     *
+     * To safely assert the type in Typescript, you can use:
+     * - `isBridgeQuoteAndPost(result)` utility.
+     * - `isQuoteAndPost(result)` utility.
+     * - `assertIsBridgeQuoteAndPost(result)` assertion.
+     * - `assertIsQuoteAndPost(result)` assertion.
      *
      * @throws Error if no path is found
      */

package/dist/bridging/types.d.ts

@@ -9,29 +9,28 @@ export interface BridgeProviderInfo {
     name: string;
     logoUrl: string;
 }
-export interface WithSellToken {
+export interface GetBuyTokensParams extends Partial<WithSellToken> {
+    targetChainId: TargetChainId;
+}
+interface WithSellToken {
     sellTokenChainId: SupportedChainId;
     sellTokenAddress: Address;
     sellTokenDecimals: number;
 }
-export interface WithBuyToken {
+interface WithBuyToken {
     buyTokenChainId: TargetChainId;
     buyTokenAddress: Address;
     buyTokenDecimals: number;
 }
-export interface GetBuyTokensParams extends Partial<WithSellToken> {
-    targetChainId: TargetChainId;
-}
+type WithQuoter = Omit<QuoterParameters, 'chainId'>;
+type WithTrader = Pick<TraderParameters, 'signer'>;
 /**
  * Parameters for getting a bridge quote
  */
-export interface QuoteBridgeRequest extends WithSellToken, WithBuyToken, TradeOptionalParameters, Omit<QuoterParameters, 'chainId'>, Pick<TraderParameters, 'signer'> {
+export type QuoteBridgeRequest = {
     kind: OrderKind.SELL;
     amount: bigint;
-    recipient?: string;
-    feeBps?: number;
-    feeRecipient?: string;
-}
+} & WithSellToken & WithBuyToken & WithQuoter & WithTrader & TradeOptionalParameters;
 export type QuoteBridgeRequestWithoutAmount = Omit<QuoteBridgeRequest, 'amount'>;
 export interface BridgeQuoteResult {
     /**
@@ -199,7 +198,6 @@ export interface BridgeCosts<T = bigint> {
         amountInSellCurrency: T;
         amountInBuyCurrency: T;
     };
-    slippageBps: number;
 }
 export interface BridgeQuoteAmountsAndCosts<T = bigint> {
     /**
@@ -220,6 +218,10 @@ export interface BridgeQuoteAmountsAndCosts<T = bigint> {
      * It includes the fees and the slippage tolerance, so its the minimum amount that the user will receive.
      */
     afterSlippage: Amounts<T>;
+    /**
+     * The slippage tolerance in basis points.
+     */
+    slippageBps: number;
 }
 export interface BridgeQuoteResults extends BridgeQuoteResult {
     /**
@@ -227,17 +229,23 @@ export interface BridgeQuoteResults extends BridgeQuoteResult {
      */
     providerInfo: BridgeProviderInfo;
     /**
-     * Unsigned call to initiate the bridge. This call should be executed in the context of user's cow-shed account.
+     * Trade parameters
      */
-    unsignedBridgeCall: EvmCall;
+    tradeParameters: QuoteBridgeRequest;
     /**
-     * Pre-authorized hook to initiate the bridge. This hook has been signed, and is ready to be executed by the
-     * CoW Protocol Trampoline contract after settling the swap order that buys the intermediate token.
+     * Bridge call details
      */
-    preAuthorizedBridgingHook: BridgeHook;
-    /**
-     * Information about the quote response from the order book API.
-     */
-    quoteResponse: BridgeQuoteResult;
+    bridgeCallDetails: {
+        /**
+         * Unsigned call to initiate the bridge. This call should be executed in the context of user's cow-shed account.
+         */
+        unsignedBridgeCall: EvmCall;
+        /**
+         * Pre-authorized hook to initiate the bridge. This hook has been signed, and is ready to be executed by the
+         * CoW Protocol Trampoline contract after settling the swap order that buys the intermediate token.
+         */
+        preAuthorizedBridgingHook: BridgeHook;
+    };
 }
 export type GetErc20Decimals = (chainId: TargetChainId, tokenAddress: string) => Promise<number>;
+export {};

package/dist/bridging/utils.d.ts

@@ -1,2 +1,6 @@
+import { QuoteAndPost } from '../trading';
 import { BridgeQuoteAndPost, CrossChainQuoteAndPost } from './types';
 export declare function isBridgeQuoteAndPost(quote: CrossChainQuoteAndPost): quote is BridgeQuoteAndPost;
+export declare function isQuoteAndPost(quote: CrossChainQuoteAndPost): quote is QuoteAndPost;
+export declare function assertIsBridgeQuoteAndPost(quote: CrossChainQuoteAndPost): asserts quote is BridgeQuoteAndPost;
+export declare function assertIsQuoteAndPost(quote: CrossChainQuoteAndPost): asserts quote is QuoteAndPost;