@cowprotocol/sdk-bridging 0.4.6 → 0.5.0

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { cowAppDataLatestScheme } from '@cowprotocol/sdk-app-data';
 import { Amounts, OrderKind, Address, EnrichedOrder, OrderBookApi } from '@cowprotocol/sdk-order-book';
-import { ChainInfo, TargetChainId, SupportedChainId, TokenInfo, EvmCall, ChainId, CowEnv } from '@cowprotocol/sdk-config';
+import { ChainInfo, TargetChainId, SupportedChainId, TokenInfo, ChainId, EvmCall, CowEnv } from '@cowprotocol/sdk-config';
 import { QuoterParameters, TraderParameters, TradeOptionalParameters, QuoteAndPost, QuoteResults, SwapAdvancedSettings, SigningStepManager, OrderPostingResult, TradingSdk } from '@cowprotocol/sdk-trading';
 import { AccountAddress, SignerLike, TTLCache, AbstractProviderAdapter } from '@cowprotocol/sdk-common';
 import { CowShedSdk, CowShedSdkOptions } from '@cowprotocol/sdk-cow-shed';
@@ -122,7 +122,13 @@ interface BridgeDeposit extends Omit<QuoteBridgeRequest, 'amount'> {
     sellTokenAmount: string;
     minBuyAmount: string;
 }
+/**
+ * Main interface for a bridge provider.
+ *
+ * It contains the main information about the provider, and the methods to get the quote, the bridging params, the status, the cancelling and the refunding of the bridging.
+ */
 interface BridgeProvider<Q extends BridgeQuoteResult> {
+    type: 'ReceiverAccountBridgeProvider' | 'HookBridgeProvider';
     info: BridgeProviderInfo;
     /**
      * Get basic supported chains
@@ -147,6 +153,53 @@ interface BridgeProvider<Q extends BridgeQuoteResult> {
      * @param request - The quote request
      */
     getQuote(request: QuoteBridgeRequest): Promise<Q>;
+    /**
+     * Get the identifier of the bridging transaction from the settlement transaction.
+     * @param chainId
+     * @param orderUid - The unique identifier of the order
+     * @param txHash - The hash of the settlement transaction in which the bridging post-hook was executed
+     */
+    getBridgingParams(chainId: ChainId, orderUid: string, txHash: string): Promise<{
+        params: BridgingDepositParams;
+        status: BridgeStatusResult;
+    } | null>;
+    /**
+     * Get the explorer url for a bridging id.
+     *
+     * @param bridgingId - The bridging id
+     */
+    getExplorerUrl(bridgingId: string): string;
+    /**
+     * Get the status of a bridging transaction.
+     *
+     * @param bridgingId - The bridging id
+     * @param originChainId - id of network where funds were deposited
+     */
+    getStatus(bridgingId: string, originChainId: SupportedChainId): Promise<BridgeStatusResult>;
+    getCancelBridgingTx(bridgingId: string): Promise<EvmCall>;
+    getRefundBridgingTx(bridgingId: string): Promise<EvmCall>;
+}
+/**
+ * A basic bridge provider that relies on sending the tokens to a specific account.
+ * This provider doesn't rely on hooks to initiate the bridge.
+ */
+interface ReceiverAccountBridgeProvider<Q extends BridgeQuoteResult> extends BridgeProvider<Q> {
+    type: 'ReceiverAccountBridgeProvider';
+    /**
+     * Get the receiver account to where the tokens will be sent in the source chain so they are automatically bridged to the destination chain.
+     *
+     * @param quoteRequest - The quote request
+     * @param quoteResult - The quote result
+     * @returns The receiver account
+     */
+    getBridgeReceiverOverride(quoteRequest: QuoteBridgeRequest, quoteResult: Q): Promise<string>;
+}
+/**
+ * A bridge provider that uses a hook to initiate the bridge.
+ *
+ */
+interface HookBridgeProvider<Q extends BridgeQuoteResult> extends BridgeProvider<Q> {
+    type: 'HookBridgeProvider';
     /**
      * Get an unsigned bridge call for a quote.
      *
@@ -196,31 +249,6 @@ interface BridgeProvider<Q extends BridgeQuoteResult> {
      * @param hook - The bridge hook
      */
     decodeBridgeHook(hook: cowAppDataLatestScheme.CoWHook): Promise<BridgeDeposit>;
-    /**
-     * Get the identifier of the bridging transaction from the settlement transaction.
-     * @param chainId
-     * @param orderUid - The unique identifier of the order
-     * @param txHash - The hash of the settlement transaction in which the bridging post-hook was executed
-     */
-    getBridgingParams(chainId: ChainId, orderUid: string, txHash: string): Promise<{
-        params: BridgingDepositParams;
-        status: BridgeStatusResult;
-    } | null>;
-    /**
-     * Get the explorer url for a bridging id.
-     *
-     * @param bridgingId - The bridging id
-     */
-    getExplorerUrl(bridgingId: string): string;
-    /**
-     * Get the status of a bridging transaction.
-     *
-     * @param bridgingId - The bridging id
-     * @param originChainId - id of network where funds were deposited
-     */
-    getStatus(bridgingId: string, originChainId: SupportedChainId): Promise<BridgeStatusResult>;
-    getCancelBridgingTx(bridgingId: string): Promise<EvmCall>;
-    getRefundBridgingTx(bridgingId: string): Promise<EvmCall>;
 }
 /**
  * A quote and post for a cross-chain swap.
@@ -303,7 +331,11 @@ interface BridgeQuoteResults extends BridgeQuoteResult {
     /**
      * Bridge call details
      */
-    bridgeCallDetails: BridgeCallDetails;
+    bridgeCallDetails?: BridgeCallDetails;
+    /**
+     * Bridge recipient override
+     */
+    bridgeReceiverOverride?: string;
 }
 interface BridgingDepositParams {
     inputTokenAddress: Address;
@@ -418,6 +450,8 @@ declare function assertIsBridgeQuoteAndPost(quote: CrossChainQuoteAndPost): asse
 declare function assertIsQuoteAndPost(quote: CrossChainQuoteAndPost): asserts quote is QuoteAndPost;
 declare function getPostHooks(fullAppData?: string): cowAppDataLatestScheme.CoWHook[];
 declare function isAppDoc(appData: unknown): appData is cowAppDataLatestScheme.AppDataRootSchema;
+declare function isHookBridgeProvider<Q extends BridgeQuoteResult>(provider: BridgeProvider<Q>): provider is HookBridgeProvider<Q>;
+declare function isReceiverAccountBridgeProvider<Q extends BridgeQuoteResult>(provider: BridgeProvider<Q>): provider is ReceiverAccountBridgeProvider<Q>;
 
 type BridgingSdkConfig = Required<Omit<BridgingSdkOptions, 'enableLogging' | 'cacheConfig'>>;
 /**
@@ -851,7 +885,8 @@ interface AcrossBridgeProviderOptions {
 interface AcrossQuoteResult extends BridgeQuoteResult {
     suggestedFees: SuggestedFeesResponse;
 }
-declare class AcrossBridgeProvider implements BridgeProvider<AcrossQuoteResult> {
+declare class AcrossBridgeProvider implements HookBridgeProvider<AcrossQuoteResult> {
+    type: "HookBridgeProvider";
     protected api: AcrossApi;
     protected cowShedSdk: CowShedSdk;
     private supportedTokens;
@@ -1171,8 +1206,9 @@ interface BungeeQuoteResult extends BridgeQuoteResult {
     bungeeQuote: BungeeQuote;
     buildTx: BungeeBuildTx;
 }
-declare class BungeeBridgeProvider implements BridgeProvider<BungeeQuoteResult> {
+declare class BungeeBridgeProvider implements HookBridgeProvider<BungeeQuoteResult> {
     private options;
+    type: "HookBridgeProvider";
     protected api: BungeeApi;
     protected cowShedSdk: CowShedSdk;
     constructor(options: BungeeBridgeProviderOptions, _adapter?: AbstractProviderAdapter);
@@ -1196,4 +1232,4 @@ declare class BungeeBridgeProvider implements BridgeProvider<BungeeQuoteResult>
     private isExtraGasRequired;
 }
 
-export { AcrossBridgeProvider, type AcrossBridgeProviderOptions, type AcrossQuoteResult, type BestQuoteProgressCallback, type BestQuoteProviderContext, type BridgeCallDetails, type BridgeCosts, type BridgeDeposit, type BridgeHook, BridgeOrderParsingError, type BridgeProvider, BridgeProviderError, type BridgeProviderInfo, BridgeProviderQuoteError, type BridgeQuoteAmountsAndCosts, type BridgeQuoteAndPost, BridgeQuoteErrors, type BridgeQuoteResult, type BridgeQuoteResults, BridgeStatus, type BridgeStatusResult, type BridgingDepositParams, BridgingSdk, BungeeBridgeProvider, type BungeeBridgeProviderOptions, type BungeeQuoteResult, type BuyTokensParams, COW_SHED_PROXY_CREATION_GAS, type CrossChainOrder, type CrossChainQuoteAndPost, DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION, DEFAULT_EXTRA_GAS_PROXY_CREATION, DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION, type GetProviderBuyTokens, HOOK_DAPP_BRIDGE_PROVIDER_PREFIX, type MultiQuoteOptions, type MultiQuoteProgressCallback, type MultiQuoteRequest, type MultiQuoteResult, type ProviderQuoteContext, type QuoteBridgeRequest, type QuoteBridgeRequestWithoutAmount, RAW_PROVIDERS_FILES_PATH, assertIsBridgeQuoteAndPost, assertIsQuoteAndPost, getCrossChainOrder, getPostHooks, isAppDoc, isBridgeQuoteAndPost, isQuoteAndPost };
+export { AcrossBridgeProvider, type AcrossBridgeProviderOptions, type AcrossQuoteResult, type BestQuoteProgressCallback, type BestQuoteProviderContext, type BridgeCallDetails, type BridgeCosts, type BridgeDeposit, type BridgeHook, BridgeOrderParsingError, type BridgeProvider, BridgeProviderError, type BridgeProviderInfo, BridgeProviderQuoteError, type BridgeQuoteAmountsAndCosts, type BridgeQuoteAndPost, BridgeQuoteErrors, type BridgeQuoteResult, type BridgeQuoteResults, BridgeStatus, type BridgeStatusResult, type BridgingDepositParams, BridgingSdk, BungeeBridgeProvider, type BungeeBridgeProviderOptions, type BungeeQuoteResult, type BuyTokensParams, COW_SHED_PROXY_CREATION_GAS, type CrossChainOrder, type CrossChainQuoteAndPost, DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION, DEFAULT_EXTRA_GAS_PROXY_CREATION, DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION, type GetProviderBuyTokens, HOOK_DAPP_BRIDGE_PROVIDER_PREFIX, type HookBridgeProvider, type MultiQuoteOptions, type MultiQuoteProgressCallback, type MultiQuoteRequest, type MultiQuoteResult, type ProviderQuoteContext, type QuoteBridgeRequest, type QuoteBridgeRequestWithoutAmount, RAW_PROVIDERS_FILES_PATH, type ReceiverAccountBridgeProvider, assertIsBridgeQuoteAndPost, assertIsQuoteAndPost, getCrossChainOrder, getPostHooks, isAppDoc, isBridgeQuoteAndPost, isHookBridgeProvider, isQuoteAndPost, isReceiverAccountBridgeProvider };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { cowAppDataLatestScheme } from '@cowprotocol/sdk-app-data';
 import { Amounts, OrderKind, Address, EnrichedOrder, OrderBookApi } from '@cowprotocol/sdk-order-book';
-import { ChainInfo, TargetChainId, SupportedChainId, TokenInfo, EvmCall, ChainId, CowEnv } from '@cowprotocol/sdk-config';
+import { ChainInfo, TargetChainId, SupportedChainId, TokenInfo, ChainId, EvmCall, CowEnv } from '@cowprotocol/sdk-config';
 import { QuoterParameters, TraderParameters, TradeOptionalParameters, QuoteAndPost, QuoteResults, SwapAdvancedSettings, SigningStepManager, OrderPostingResult, TradingSdk } from '@cowprotocol/sdk-trading';
 import { AccountAddress, SignerLike, TTLCache, AbstractProviderAdapter } from '@cowprotocol/sdk-common';
 import { CowShedSdk, CowShedSdkOptions } from '@cowprotocol/sdk-cow-shed';
@@ -122,7 +122,13 @@ interface BridgeDeposit extends Omit<QuoteBridgeRequest, 'amount'> {
     sellTokenAmount: string;
     minBuyAmount: string;
 }
+/**
+ * Main interface for a bridge provider.
+ *
+ * It contains the main information about the provider, and the methods to get the quote, the bridging params, the status, the cancelling and the refunding of the bridging.
+ */
 interface BridgeProvider<Q extends BridgeQuoteResult> {
+    type: 'ReceiverAccountBridgeProvider' | 'HookBridgeProvider';
     info: BridgeProviderInfo;
     /**
      * Get basic supported chains
@@ -147,6 +153,53 @@ interface BridgeProvider<Q extends BridgeQuoteResult> {
      * @param request - The quote request
      */
     getQuote(request: QuoteBridgeRequest): Promise<Q>;
+    /**
+     * Get the identifier of the bridging transaction from the settlement transaction.
+     * @param chainId
+     * @param orderUid - The unique identifier of the order
+     * @param txHash - The hash of the settlement transaction in which the bridging post-hook was executed
+     */
+    getBridgingParams(chainId: ChainId, orderUid: string, txHash: string): Promise<{
+        params: BridgingDepositParams;
+        status: BridgeStatusResult;
+    } | null>;
+    /**
+     * Get the explorer url for a bridging id.
+     *
+     * @param bridgingId - The bridging id
+     */
+    getExplorerUrl(bridgingId: string): string;
+    /**
+     * Get the status of a bridging transaction.
+     *
+     * @param bridgingId - The bridging id
+     * @param originChainId - id of network where funds were deposited
+     */
+    getStatus(bridgingId: string, originChainId: SupportedChainId): Promise<BridgeStatusResult>;
+    getCancelBridgingTx(bridgingId: string): Promise<EvmCall>;
+    getRefundBridgingTx(bridgingId: string): Promise<EvmCall>;
+}
+/**
+ * A basic bridge provider that relies on sending the tokens to a specific account.
+ * This provider doesn't rely on hooks to initiate the bridge.
+ */
+interface ReceiverAccountBridgeProvider<Q extends BridgeQuoteResult> extends BridgeProvider<Q> {
+    type: 'ReceiverAccountBridgeProvider';
+    /**
+     * Get the receiver account to where the tokens will be sent in the source chain so they are automatically bridged to the destination chain.
+     *
+     * @param quoteRequest - The quote request
+     * @param quoteResult - The quote result
+     * @returns The receiver account
+     */
+    getBridgeReceiverOverride(quoteRequest: QuoteBridgeRequest, quoteResult: Q): Promise<string>;
+}
+/**
+ * A bridge provider that uses a hook to initiate the bridge.
+ *
+ */
+interface HookBridgeProvider<Q extends BridgeQuoteResult> extends BridgeProvider<Q> {
+    type: 'HookBridgeProvider';
     /**
      * Get an unsigned bridge call for a quote.
      *
@@ -196,31 +249,6 @@ interface BridgeProvider<Q extends BridgeQuoteResult> {
      * @param hook - The bridge hook
      */
     decodeBridgeHook(hook: cowAppDataLatestScheme.CoWHook): Promise<BridgeDeposit>;
-    /**
-     * Get the identifier of the bridging transaction from the settlement transaction.
-     * @param chainId
-     * @param orderUid - The unique identifier of the order
-     * @param txHash - The hash of the settlement transaction in which the bridging post-hook was executed
-     */
-    getBridgingParams(chainId: ChainId, orderUid: string, txHash: string): Promise<{
-        params: BridgingDepositParams;
-        status: BridgeStatusResult;
-    } | null>;
-    /**
-     * Get the explorer url for a bridging id.
-     *
-     * @param bridgingId - The bridging id
-     */
-    getExplorerUrl(bridgingId: string): string;
-    /**
-     * Get the status of a bridging transaction.
-     *
-     * @param bridgingId - The bridging id
-     * @param originChainId - id of network where funds were deposited
-     */
-    getStatus(bridgingId: string, originChainId: SupportedChainId): Promise<BridgeStatusResult>;
-    getCancelBridgingTx(bridgingId: string): Promise<EvmCall>;
-    getRefundBridgingTx(bridgingId: string): Promise<EvmCall>;
 }
 /**
  * A quote and post for a cross-chain swap.
@@ -303,7 +331,11 @@ interface BridgeQuoteResults extends BridgeQuoteResult {
     /**
      * Bridge call details
      */
-    bridgeCallDetails: BridgeCallDetails;
+    bridgeCallDetails?: BridgeCallDetails;
+    /**
+     * Bridge recipient override
+     */
+    bridgeReceiverOverride?: string;
 }
 interface BridgingDepositParams {
     inputTokenAddress: Address;
@@ -418,6 +450,8 @@ declare function assertIsBridgeQuoteAndPost(quote: CrossChainQuoteAndPost): asse
 declare function assertIsQuoteAndPost(quote: CrossChainQuoteAndPost): asserts quote is QuoteAndPost;
 declare function getPostHooks(fullAppData?: string): cowAppDataLatestScheme.CoWHook[];
 declare function isAppDoc(appData: unknown): appData is cowAppDataLatestScheme.AppDataRootSchema;
+declare function isHookBridgeProvider<Q extends BridgeQuoteResult>(provider: BridgeProvider<Q>): provider is HookBridgeProvider<Q>;
+declare function isReceiverAccountBridgeProvider<Q extends BridgeQuoteResult>(provider: BridgeProvider<Q>): provider is ReceiverAccountBridgeProvider<Q>;
 
 type BridgingSdkConfig = Required<Omit<BridgingSdkOptions, 'enableLogging' | 'cacheConfig'>>;
 /**
@@ -851,7 +885,8 @@ interface AcrossBridgeProviderOptions {
 interface AcrossQuoteResult extends BridgeQuoteResult {
     suggestedFees: SuggestedFeesResponse;
 }
-declare class AcrossBridgeProvider implements BridgeProvider<AcrossQuoteResult> {
+declare class AcrossBridgeProvider implements HookBridgeProvider<AcrossQuoteResult> {
+    type: "HookBridgeProvider";
     protected api: AcrossApi;
     protected cowShedSdk: CowShedSdk;
     private supportedTokens;
@@ -1171,8 +1206,9 @@ interface BungeeQuoteResult extends BridgeQuoteResult {
     bungeeQuote: BungeeQuote;
     buildTx: BungeeBuildTx;
 }
-declare class BungeeBridgeProvider implements BridgeProvider<BungeeQuoteResult> {
+declare class BungeeBridgeProvider implements HookBridgeProvider<BungeeQuoteResult> {
     private options;
+    type: "HookBridgeProvider";
     protected api: BungeeApi;
     protected cowShedSdk: CowShedSdk;
     constructor(options: BungeeBridgeProviderOptions, _adapter?: AbstractProviderAdapter);
@@ -1196,4 +1232,4 @@ declare class BungeeBridgeProvider implements BridgeProvider<BungeeQuoteResult>
     private isExtraGasRequired;
 }
 
-export { AcrossBridgeProvider, type AcrossBridgeProviderOptions, type AcrossQuoteResult, type BestQuoteProgressCallback, type BestQuoteProviderContext, type BridgeCallDetails, type BridgeCosts, type BridgeDeposit, type BridgeHook, BridgeOrderParsingError, type BridgeProvider, BridgeProviderError, type BridgeProviderInfo, BridgeProviderQuoteError, type BridgeQuoteAmountsAndCosts, type BridgeQuoteAndPost, BridgeQuoteErrors, type BridgeQuoteResult, type BridgeQuoteResults, BridgeStatus, type BridgeStatusResult, type BridgingDepositParams, BridgingSdk, BungeeBridgeProvider, type BungeeBridgeProviderOptions, type BungeeQuoteResult, type BuyTokensParams, COW_SHED_PROXY_CREATION_GAS, type CrossChainOrder, type CrossChainQuoteAndPost, DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION, DEFAULT_EXTRA_GAS_PROXY_CREATION, DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION, type GetProviderBuyTokens, HOOK_DAPP_BRIDGE_PROVIDER_PREFIX, type MultiQuoteOptions, type MultiQuoteProgressCallback, type MultiQuoteRequest, type MultiQuoteResult, type ProviderQuoteContext, type QuoteBridgeRequest, type QuoteBridgeRequestWithoutAmount, RAW_PROVIDERS_FILES_PATH, assertIsBridgeQuoteAndPost, assertIsQuoteAndPost, getCrossChainOrder, getPostHooks, isAppDoc, isBridgeQuoteAndPost, isQuoteAndPost };
+export { AcrossBridgeProvider, type AcrossBridgeProviderOptions, type AcrossQuoteResult, type BestQuoteProgressCallback, type BestQuoteProviderContext, type BridgeCallDetails, type BridgeCosts, type BridgeDeposit, type BridgeHook, BridgeOrderParsingError, type BridgeProvider, BridgeProviderError, type BridgeProviderInfo, BridgeProviderQuoteError, type BridgeQuoteAmountsAndCosts, type BridgeQuoteAndPost, BridgeQuoteErrors, type BridgeQuoteResult, type BridgeQuoteResults, BridgeStatus, type BridgeStatusResult, type BridgingDepositParams, BridgingSdk, BungeeBridgeProvider, type BungeeBridgeProviderOptions, type BungeeQuoteResult, type BuyTokensParams, COW_SHED_PROXY_CREATION_GAS, type CrossChainOrder, type CrossChainQuoteAndPost, DEFAULT_EXTRA_GAS_FOR_HOOK_ESTIMATION, DEFAULT_EXTRA_GAS_PROXY_CREATION, DEFAULT_GAS_COST_FOR_HOOK_ESTIMATION, type GetProviderBuyTokens, HOOK_DAPP_BRIDGE_PROVIDER_PREFIX, type HookBridgeProvider, type MultiQuoteOptions, type MultiQuoteProgressCallback, type MultiQuoteRequest, type MultiQuoteResult, type ProviderQuoteContext, type QuoteBridgeRequest, type QuoteBridgeRequestWithoutAmount, RAW_PROVIDERS_FILES_PATH, type ReceiverAccountBridgeProvider, assertIsBridgeQuoteAndPost, assertIsQuoteAndPost, getCrossChainOrder, getPostHooks, isAppDoc, isBridgeQuoteAndPost, isHookBridgeProvider, isQuoteAndPost, isReceiverAccountBridgeProvider };