@cowprotocol/sdk-bridging 0.7.0 → 0.8.1

package/dist/index.d.mts

@@ -37,6 +37,14 @@ type QuoteBridgeRequest = {
 } & WithSellToken & WithBuyToken & WithQuoter & WithTrader & TradeOptionalParameters;
 type QuoteBridgeRequestWithoutAmount = Omit<QuoteBridgeRequest, 'amount'>;
 interface BridgeQuoteResult {
+    /**
+     * Unique ID of a quote
+     */
+    id?: string;
+    /**
+     * Provider who implement ReceiverAccountBridgeProvider must return a signature of a quote than will be used to verify the quote deposit address validity
+     */
+    signature?: string;
     /**
      * Whether the quote is a sell or buy order.
      */
@@ -1280,7 +1288,10 @@ declare class NearIntentsBridgeProvider implements ReceiverAccountBridgeProvider
     getStatus(bridgingId: string, _originChainId: SupportedChainId): Promise<BridgeStatusResult>;
     getCancelBridgingTx(_bridgingId: string): Promise<EvmCall>;
     getRefundBridgingTx(_bridgingId: string): Promise<EvmCall>;
-    recoverDepositAddress({ quote, quoteRequest, timestamp }: QuoteResponse): Promise<Address$1 | null>;
+    recoverDepositAddress({ quote, quoteRequest, timestamp, }: QuoteResponse): Promise<{
+        address: Address$1;
+        quoteHash: string;
+    } | null>;
 }
 
 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 BridgeProviderType, 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 DefaultBridgeProvider, type GetProviderBuyTokens, HOOK_DAPP_BRIDGE_PROVIDER_PREFIX, type HookBridgeProvider, type MultiQuoteOptions, type MultiQuoteProgressCallback, type MultiQuoteRequest, type MultiQuoteResult, NearIntentsBridgeProvider, type NearIntentsBridgeProviderOptions, type NearIntentsQuoteResult, 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

@@ -37,6 +37,14 @@ type QuoteBridgeRequest = {
 } & WithSellToken & WithBuyToken & WithQuoter & WithTrader & TradeOptionalParameters;
 type QuoteBridgeRequestWithoutAmount = Omit<QuoteBridgeRequest, 'amount'>;
 interface BridgeQuoteResult {
+    /**
+     * Unique ID of a quote
+     */
+    id?: string;
+    /**
+     * Provider who implement ReceiverAccountBridgeProvider must return a signature of a quote than will be used to verify the quote deposit address validity
+     */
+    signature?: string;
     /**
      * Whether the quote is a sell or buy order.
      */
@@ -1280,7 +1288,10 @@ declare class NearIntentsBridgeProvider implements ReceiverAccountBridgeProvider
     getStatus(bridgingId: string, _originChainId: SupportedChainId): Promise<BridgeStatusResult>;
     getCancelBridgingTx(_bridgingId: string): Promise<EvmCall>;
     getRefundBridgingTx(_bridgingId: string): Promise<EvmCall>;
-    recoverDepositAddress({ quote, quoteRequest, timestamp }: QuoteResponse): Promise<Address$1 | null>;
+    recoverDepositAddress({ quote, quoteRequest, timestamp, }: QuoteResponse): Promise<{
+        address: Address$1;
+        quoteHash: string;
+    } | null>;
 }
 
 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 BridgeProviderType, 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 DefaultBridgeProvider, type GetProviderBuyTokens, HOOK_DAPP_BRIDGE_PROVIDER_PREFIX, type HookBridgeProvider, type MultiQuoteOptions, type MultiQuoteProgressCallback, type MultiQuoteRequest, type MultiQuoteResult, NearIntentsBridgeProvider, type NearIntentsBridgeProviderOptions, type NearIntentsQuoteResult, type ProviderQuoteContext, type QuoteBridgeRequest, type QuoteBridgeRequestWithoutAmount, RAW_PROVIDERS_FILES_PATH, type ReceiverAccountBridgeProvider, assertIsBridgeQuoteAndPost, assertIsQuoteAndPost, getCrossChainOrder, getPostHooks, isAppDoc, isBridgeQuoteAndPost, isHookBridgeProvider, isQuoteAndPost, isReceiverAccountBridgeProvider };

package/dist/index.js

@@ -507,6 +507,11 @@ async function getQuoteWithReceiverAccountBridge(provider, params) {
     });
     (0, import_sdk_common4.log)(`Bridge receiver override: ${bridgeReceiverOverride}`);
     swapResult.tradeParameters.receiver = bridgeReceiverOverride;
+    swapResult.appDataInfo = await (0, import_sdk_trading.mergeAppDataDoc)(swapResult.appDataInfo.doc, {
+      metadata: {
+        bridging: overrideAppDataWithBridgingQuoteDetails(swapResult.appDataInfo.doc.metadata.bridging, bridgeResult)
+      }
+    });
     return {
       bridgeResult,
       swapResult: {
@@ -622,6 +627,8 @@ async function getAccountBridgeResult(provider, context) {
   const bridgingQuote = await provider.getQuote(bridgeRequest);
   const bridgeReceiverOverride = await provider.getBridgeReceiverOverride(bridgeRequest, bridgingQuote);
   const bridgeResult = {
+    id: bridgingQuote.id,
+    signature: bridgingQuote.signature,
     providerInfo: provider.info,
     tradeParameters: bridgeRequest,
     // Just the bridge (not the swap & bridge)
@@ -653,6 +660,7 @@ async function getHookBridgeResult(provider, context) {
   });
   const appDataInfo = await (0, import_sdk_trading.mergeAppDataDoc)(swapAppData.doc, {
     metadata: {
+      bridging: overrideAppDataWithBridgingQuoteDetails(swapResult.appDataInfo.doc.metadata.bridging, bridgingQuote),
       hooks: {
         pre: swapResultHooks?.pre,
         post: [...postHooks, ...[bridgeHook.postHook]]
@@ -676,6 +684,15 @@ async function getHookBridgeResult(provider, context) {
   };
   return { bridgeResult, bridgeHook, appDataInfo };
 }
+function overrideAppDataWithBridgingQuoteDetails(bridgingMetaData, quote) {
+  if (!bridgingMetaData)
+    return bridgingMetaData;
+  return {
+    ...bridgingMetaData,
+    ...quote.id ? { quoteId: quote.id } : void 0,
+    ...quote.signature ? { quoteSignature: quote.signature } : void 0
+  };
+}
 
 // src/BridgingSdk/strategies/QuoteStrategy.ts
 var QuoteStrategy = class {
@@ -3735,6 +3752,7 @@ function toBridgeQuoteResult2(request, slippageBps, bungeeQuoteWithBuildTx) {
   const { kind } = request;
   const { bungeeQuote, buildTx } = bungeeQuoteWithBuildTx;
   return {
+    id: bungeeQuoteWithBuildTx.bungeeQuote.route.quoteId.toString(),
     isSell: kind === import_sdk_order_book5.OrderKind.SELL,
     amountsAndCosts: toAmountsAndCosts2(request, slippageBps, bungeeQuote),
     quoteTimestamp: Number(bungeeQuote.quoteTimestamp),
@@ -5035,7 +5053,7 @@ var NearIntentsBridgeProvider = class {
       throw new BridgeProviderQuoteError("NO_ROUTES" /* NO_ROUTES */);
     const quoteResponse = await this.api.getQuote({
       dry: false,
-      swapType: import_one_click_sdk_typescript2.QuoteRequest.swapType.EXACT_INPUT,
+      swapType: import_one_click_sdk_typescript2.QuoteRequest.swapType.FLEX_INPUT,
       slippageTolerance: request.slippageBps ?? 100,
       originAsset: sellToken.assetId,
       depositType: import_one_click_sdk_typescript2.QuoteRequest.depositType.ORIGIN_CHAIN,
@@ -5049,7 +5067,7 @@ var NearIntentsBridgeProvider = class {
       referral: REFERRAL
     });
     const recoveredDepositAddress = await this.recoverDepositAddress(quoteResponse);
-    if (recoveredDepositAddress?.toLowerCase() !== ATTESTATOR_ADDRESS.toLowerCase()) {
+    if (recoveredDepositAddress?.address.toLowerCase() !== ATTESTATOR_ADDRESS.toLowerCase()) {
       throw new BridgeProviderQuoteError("QUOTE_DOES_NOT_MATCH_DEPOSIT_ADDRESS" /* QUOTE_DOES_NOT_MATCH_DEPOSIT_ADDRESS */);
     }
     const { quote, timestamp: isoDate } = quoteResponse;
@@ -5060,6 +5078,8 @@ var NearIntentsBridgeProvider = class {
     const feeAmountInSellCurrency = Math.trunc(Number(quote.amountOut) * slippage);
     const bridgeFee = Math.trunc(Number(quote.amountIn) * slippage);
     return {
+      id: recoveredDepositAddress.quoteHash,
+      signature: quoteResponse.signature,
       isSell: request.kind === import_sdk_order_book7.OrderKind.SELL,
       depositAddress: quote.depositAddress,
       quoteTimestamp: new Date(isoDate).getTime(),
@@ -5167,7 +5187,11 @@ var NearIntentsBridgeProvider = class {
   getRefundBridgingTx(_bridgingId) {
     throw new Error("Not implemented");
   }
-  async recoverDepositAddress({ quote, quoteRequest, timestamp }) {
+  async recoverDepositAddress({
+    quote,
+    quoteRequest,
+    timestamp
+  }) {
     try {
       if (!quote?.depositAddress)
         return null;
@@ -5183,7 +5207,10 @@ var NearIntentsBridgeProvider = class {
       const payload = utils.hexConcat([depositAddr, quoteHash]);
       const messageBytes = utils.hexConcat([ATTESTATION_PREFIX_CONST, ATTESTION_VERSION_BYTE, payload]);
       const hash = utils.keccak256(messageBytes);
-      return utils.recoverAddress(hash, signature);
+      return {
+        address: await utils.recoverAddress(hash, signature),
+        quoteHash
+      };
     } catch {
       return null;
     }

package/dist/index.mjs

@@ -452,6 +452,11 @@ async function getQuoteWithReceiverAccountBridge(provider, params) {
     });
     log3(`Bridge receiver override: ${bridgeReceiverOverride}`);
     swapResult.tradeParameters.receiver = bridgeReceiverOverride;
+    swapResult.appDataInfo = await mergeAppDataDoc(swapResult.appDataInfo.doc, {
+      metadata: {
+        bridging: overrideAppDataWithBridgingQuoteDetails(swapResult.appDataInfo.doc.metadata.bridging, bridgeResult)
+      }
+    });
     return {
       bridgeResult,
       swapResult: {
@@ -567,6 +572,8 @@ async function getAccountBridgeResult(provider, context) {
   const bridgingQuote = await provider.getQuote(bridgeRequest);
   const bridgeReceiverOverride = await provider.getBridgeReceiverOverride(bridgeRequest, bridgingQuote);
   const bridgeResult = {
+    id: bridgingQuote.id,
+    signature: bridgingQuote.signature,
     providerInfo: provider.info,
     tradeParameters: bridgeRequest,
     // Just the bridge (not the swap & bridge)
@@ -598,6 +605,7 @@ async function getHookBridgeResult(provider, context) {
   });
   const appDataInfo = await mergeAppDataDoc(swapAppData.doc, {
     metadata: {
+      bridging: overrideAppDataWithBridgingQuoteDetails(swapResult.appDataInfo.doc.metadata.bridging, bridgingQuote),
       hooks: {
         pre: swapResultHooks?.pre,
         post: [...postHooks, ...[bridgeHook.postHook]]
@@ -621,6 +629,15 @@ async function getHookBridgeResult(provider, context) {
   };
   return { bridgeResult, bridgeHook, appDataInfo };
 }
+function overrideAppDataWithBridgingQuoteDetails(bridgingMetaData, quote) {
+  if (!bridgingMetaData)
+    return bridgingMetaData;
+  return {
+    ...bridgingMetaData,
+    ...quote.id ? { quoteId: quote.id } : void 0,
+    ...quote.signature ? { quoteSignature: quote.signature } : void 0
+  };
+}
 
 // src/BridgingSdk/strategies/QuoteStrategy.ts
 var QuoteStrategy = class {
@@ -3686,6 +3703,7 @@ function toBridgeQuoteResult2(request, slippageBps, bungeeQuoteWithBuildTx) {
   const { kind } = request;
   const { bungeeQuote, buildTx } = bungeeQuoteWithBuildTx;
   return {
+    id: bungeeQuoteWithBuildTx.bungeeQuote.route.quoteId.toString(),
     isSell: kind === OrderKind4.SELL,
     amountsAndCosts: toAmountsAndCosts2(request, slippageBps, bungeeQuote),
     quoteTimestamp: Number(bungeeQuote.quoteTimestamp),
@@ -4995,7 +5013,7 @@ var NearIntentsBridgeProvider = class {
       throw new BridgeProviderQuoteError("NO_ROUTES" /* NO_ROUTES */);
     const quoteResponse = await this.api.getQuote({
       dry: false,
-      swapType: QuoteRequest.swapType.EXACT_INPUT,
+      swapType: QuoteRequest.swapType.FLEX_INPUT,
       slippageTolerance: request.slippageBps ?? 100,
       originAsset: sellToken.assetId,
       depositType: QuoteRequest.depositType.ORIGIN_CHAIN,
@@ -5009,7 +5027,7 @@ var NearIntentsBridgeProvider = class {
       referral: REFERRAL
     });
     const recoveredDepositAddress = await this.recoverDepositAddress(quoteResponse);
-    if (recoveredDepositAddress?.toLowerCase() !== ATTESTATOR_ADDRESS.toLowerCase()) {
+    if (recoveredDepositAddress?.address.toLowerCase() !== ATTESTATOR_ADDRESS.toLowerCase()) {
       throw new BridgeProviderQuoteError("QUOTE_DOES_NOT_MATCH_DEPOSIT_ADDRESS" /* QUOTE_DOES_NOT_MATCH_DEPOSIT_ADDRESS */);
     }
     const { quote, timestamp: isoDate } = quoteResponse;
@@ -5020,6 +5038,8 @@ var NearIntentsBridgeProvider = class {
     const feeAmountInSellCurrency = Math.trunc(Number(quote.amountOut) * slippage);
     const bridgeFee = Math.trunc(Number(quote.amountIn) * slippage);
     return {
+      id: recoveredDepositAddress.quoteHash,
+      signature: quoteResponse.signature,
       isSell: request.kind === OrderKind6.SELL,
       depositAddress: quote.depositAddress,
       quoteTimestamp: new Date(isoDate).getTime(),
@@ -5127,7 +5147,11 @@ var NearIntentsBridgeProvider = class {
   getRefundBridgingTx(_bridgingId) {
     throw new Error("Not implemented");
   }
-  async recoverDepositAddress({ quote, quoteRequest, timestamp }) {
+  async recoverDepositAddress({
+    quote,
+    quoteRequest,
+    timestamp
+  }) {
     try {
       if (!quote?.depositAddress)
         return null;
@@ -5143,7 +5167,10 @@ var NearIntentsBridgeProvider = class {
       const payload = utils.hexConcat([depositAddr, quoteHash]);
       const messageBytes = utils.hexConcat([ATTESTATION_PREFIX_CONST, ATTESTION_VERSION_BYTE, payload]);
       const hash = utils.keccak256(messageBytes);
-      return utils.recoverAddress(hash, signature);
+      return {
+        address: await utils.recoverAddress(hash, signature),
+        quoteHash
+      };
     } catch {
       return null;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/sdk-bridging",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "description": "Bridging for CoW Protocol",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -16,13 +16,13 @@
   "dependencies": {
     "@defuse-protocol/one-click-sdk-typescript": "0.1.1-0.2",
     "json-stable-stringify": "^1.3.0",
-    "@cowprotocol/sdk-app-data": "4.2.0",
     "@cowprotocol/sdk-common": "0.4.0",
+    "@cowprotocol/sdk-app-data": "4.3.0",
     "@cowprotocol/sdk-config": "0.4.0",
-    "@cowprotocol/sdk-contracts-ts": "0.6.0",
-    "@cowprotocol/sdk-cow-shed": "0.2.1",
+    "@cowprotocol/sdk-cow-shed": "0.2.2",
+    "@cowprotocol/sdk-contracts-ts": "0.7.0",
     "@cowprotocol/sdk-order-book": "0.3.0",
-    "@cowprotocol/sdk-trading": "0.5.0",
+    "@cowprotocol/sdk-trading": "0.5.1",
     "@cowprotocol/sdk-weiroll": "0.1.6"
   },
   "devDependencies": {
@@ -38,11 +38,11 @@
     "tsup": "^7.2.0",
     "typescript": "^5.2.2",
     "viem": "^2.28.4",
+    "@cow-sdk/typescript-config": "0.0.0-beta.0",
     "@cowprotocol/sdk-ethers-v5-adapter": "0.3.0",
     "@cowprotocol/sdk-ethers-v6-adapter": "0.3.0",
-    "@cow-sdk/typescript-config": "0.0.0-beta.0",
-    "@cowprotocol/sdk-order-signing": "0.1.12",
-    "@cowprotocol/sdk-viem-adapter": "0.3.0"
+    "@cowprotocol/sdk-viem-adapter": "0.3.0",
+    "@cowprotocol/sdk-order-signing": "0.1.13"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",