fix(sdk): thread relayerFee into cancel order calldata

Author: ddboy19912

sdk/packages/sdk/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hyperbridge/sdk",
-	"version": "1.8.2",
+	"version": "1.8.4",
 	"description": "The hyperclient SDK provides utilities for querying proofs and statuses for cross-chain requests from HyperBridge.",
 	"type": "module",
 	"types": "./dist/node/index.d.ts",

sdk/packages/sdk/src/protocols/intents/IntentGateway.ts

@@ -1,7 +1,7 @@
 import { createSessionKeyStorage, createCancellationStorage, createUsedUserOpsStorage } from "@/storage"
 import { Swap } from "@/utils/swap"
 import type { TransactionReceipt } from "viem"
-import type { Order, HexString } from "@/types"
+import type { Order, HexString, CancelQuote } from "@/types"
 import type {
 	PackedUserOperation,
 	SubmitBidOptions,
@@ -280,6 +280,21 @@ export class IntentGateway {
 		return this.orderCanceller.quoteCancelNative(order, fromDest)
 	}
 
+	/**
+	 * Returns both the native token cost and the relayer fee for cancelling an
+	 * order. Use `relayerFee` to approve the ERC-20 spend before submitting.
+	 *
+	 * Delegates to {@link OrderCanceller.quoteCancelOrder}.
+	 *
+	 * @param order - The order to quote cancellation for.
+	 * @param fromDest - If `true`, quotes the destination-initiated cancellation fee.
+	 * @returns `{ nativeValue }` — native token amount (wei) to send as `value`;
+	 *   `{ relayerFee }` — relayer incentive denominated in the chain's fee token.
+	 */
+	async quoteCancelOrder(order: Order, fromDest: boolean = false): Promise<CancelQuote> {
+		return this.orderCanceller.quoteCancelOrder(order, fromDest)
+	}
+
 	/**
 	 * Async generator that cancels an order and streams status events until
 	 * cancellation is complete.

sdk/packages/sdk/src/protocols/intents/OrderCanceller.ts

@@ -14,7 +14,7 @@ import {
 	sleep,
 } from "@/utils"
 import { STORAGE_KEYS } from "@/storage"
-import type { Order, HexString, IGetRequest, IPostRequest } from "@/types"
+import type { Order, HexString, IGetRequest, IPostRequest, CancelQuote } from "@/types"
 import type { IGetRequestMessage } from "@/chain"
 import type { IProof } from "@/chain"
 import type { IndexerClient } from "@/client"
@@ -62,10 +62,25 @@ export class OrderCanceller {
 	 * @returns The native token amount required to submit the cancel transaction.
 	 */
 	async quoteCancelNative(order: Order, fromDest: boolean = false): Promise<bigint> {
+		const quote = await this.quoteCancelOrder(order, fromDest)
+		return quote.nativeValue
+	}
+
+	/**
+	 * Returns both the native token cost and the relayer fee for cancelling an
+	 * order. Frontends can use `relayerFee` to approve the ERC-20 spend before
+	 * submitting the cancel transaction.
+	 *
+	 * @param order - The order to quote.
+	 * @param fromDest - If `true`, quotes the destination-initiated path.
+	 * @returns `{ nativeValue }` — native token amount (wei) to send as `value`;
+	 *   `{ relayerFee }` — relayer incentive denominated in the chain's fee token.
+	 */
+	async quoteCancelOrder(order: Order, fromDest: boolean = false): Promise<CancelQuote> {
 		if (fromDest) {
-			return this.quoteCancelNativeFromDest(order)
+			return this.quoteCancelFromDest(order)
 		}
-		return this.quoteCancelNativeFromSource(order)
+		return this.quoteCancelFromSource(order)
 	}
 
 	/**
@@ -78,9 +93,12 @@ export class OrderCanceller {
 	 * @param order - The order to quote.
 	 * @returns The native token dispatch fee in wei.
 	 */
-	private async quoteCancelNativeFromSource(order: Order): Promise<bigint> {
-		if (order.source === order.destination) return 0n
+	private async quoteCancelFromSource(order: Order): Promise<CancelQuote> {
+		if (order.source === order.destination) return { nativeValue: 0n, relayerFee: 0n }
 
+		const sourceStateMachine = order.source.startsWith("0x")
+			? hexToString(order.source as HexString)
+			: (order.source as string)
 		const height = order.deadline + 1n
 
 		const destIntentGateway = this.ctx.dest.configService.getIntentGatewayV2Address(
@@ -97,7 +115,7 @@ export class OrderCanceller {
 		const context = encodeWithdrawalRequest(order, order.user as HexString)
 
 		const getRequest: IGetRequest = {
-			source: order.source.startsWith("0x") ? hexToString(order.source as HexString) : (order.source as string),
+			source: sourceStateMachine,
 			dest: order.destination.startsWith("0x")
 				? hexToString(order.destination as HexString)
 				: (order.destination as string),
@@ -109,7 +127,11 @@ export class OrderCanceller {
 			context,
 		}
 
-		return await this.ctx.source.quoteNative(getRequest, 0n)
+		const feeInSourceFeeToken = await convertGasToFeeToken(this.ctx, 400_000n, "source", sourceStateMachine)
+		const relayerFee = (feeInSourceFeeToken * 1005n) / 1000n
+
+		const nativeValue = await this.ctx.source.quoteNative(getRequest, relayerFee)
+		return { nativeValue, relayerFee }
 	}
 
 	/**
@@ -220,18 +242,18 @@ export class OrderCanceller {
 			STORAGE_KEYS.getRequest(orderId),
 		)
 		if (!getRequest) {
-			const value = await this.quoteCancelNativeFromSource(order)
+			const quote = await this.quoteCancelFromSource(order)
 			const data = encodeFunctionData({
 				abi: IntentGatewayV2ABI,
 				functionName: "cancelOrder",
-				args: [transformOrderForContract(order), { relayerFee: 0n, height: destIProof.height }],
+				args: [transformOrderForContract(order), { relayerFee: quote.relayerFee, height: destIProof.height }],
 			}) as HexString
 
 			const signedTransaction = yield {
 				status: "AWAITING_CANCEL_TRANSACTION" as const,
 				data,
 				to: intentGatewayAddress,
-				value,
+				value: quote.nativeValue,
 			}
 
 			const receipt =
@@ -332,8 +354,8 @@ export class OrderCanceller {
 	 * @param order - The order to quote.
 	 * @returns The native token dispatch fee in wei.
 	 */
-	private async quoteCancelNativeFromDest(order: Order): Promise<bigint> {
-		if (order.source === order.destination) return 0n
+	private async quoteCancelFromDest(order: Order): Promise<CancelQuote> {
+		if (order.source === order.destination) return { nativeValue: 0n, relayerFee: 0n }
 
 		const destStateMachine = order.destination.startsWith("0x")
 			? hexToString(order.destination as HexString)
@@ -359,7 +381,8 @@ export class OrderCanceller {
 			timeoutTimestamp: 0n,
 		}
 
-		return await this.ctx.dest.quoteNative(postRequest, relayerFee)
+		const nativeValue = await this.ctx.dest.quoteNative(postRequest, relayerFee)
+		return { nativeValue, relayerFee }
 	}
 
 	/**
@@ -399,18 +422,18 @@ export class OrderCanceller {
 		)
 
 		if (!commitment) {
-			const value = await this.quoteCancelNativeFromDest(order)
+			const quote = await this.quoteCancelFromDest(order)
 			const data = encodeFunctionData({
 				abi: IntentGatewayV2ABI,
 				functionName: "cancelOrder",
-				args: [transformOrderForContract(order), { relayerFee: 0n, height: 0n }],
+				args: [transformOrderForContract(order), { relayerFee: quote.relayerFee, height: 0n }],
 			}) as HexString
 
 			const signedTransaction = yield {
 				status: "AWAITING_CANCEL_TRANSACTION" as const,
 				data,
 				to: intentGatewayAddress,
-				value,
+				value: quote.nativeValue,
 			}
 
 			const receipt =

sdk/packages/sdk/src/types/index.ts

@@ -197,6 +197,11 @@ export enum TeleportStatus {
 	REFUNDED = "REFUNDED",
 }
 
+export interface CancelQuote {
+	nativeValue: bigint
+	relayerFee: bigint
+}
+
 export interface TokenGatewayAssetTeleportedResponse {
 	tokenGatewayAssetTeleportedV2s: {
 		nodes: Array<{