Merge pull request #150 from peanutprotocol/feat/x-chain-request

Changing fee estimation function

src/consts/interfaces.consts.ts

@@ -169,6 +169,7 @@ export interface IPrepareDepositTxsResponse {
 
 export interface IPrepareXchainRequestFulfillmentTransactionProps {
 	unsignedTxs: IPeanutUnsignedTransaction[]
+	feeEstimation: string
 }
 
 //signAndSubmitTx
@@ -206,6 +207,7 @@ export interface ISquidRoute {
 	value: BigNumber
 	calldata: string
 	to: string
+	txEstimation?: any
 }
 
 //getCrossChainoptionsForLink

src/index.ts

@@ -2326,6 +2326,7 @@ async function getSquidRoute(args: interfaces.IGetSquidRouteParams): Promise<int
 			value: BigNumber.from(data.route.transactionRequest.value),
 			calldata: data.route.transactionRequest.data,
 			to: data.route.transactionRequest.target,
+			txEstimation: data.route.estimate,
 		}
 	}
 

src/request.ts

@@ -244,6 +244,27 @@ export async function prepareXchainRequestFulfillmentTransaction({
 		toAddress: recipientAddress,
 		enableBoost: true,
 	})
+
+	// Transaction estimation from Squid API allows us to know the transaction fees (gas and fee), then we can iterate over them and add the values ​​that are in dollars
+	// Explanation:
+	// feeCosts: Service fees that may be charged by the Squid.
+	// gasCosts: Network gas fees charged for blockchain transactions.
+	// feeEstimation: The total estimated fee, which is the sum of both feeCosts and gasCosts.
+	// Why loops?: Each of these costs can contain multiple items (multiple txs such as approve, swap, etc), so we iterate through each to add their USD values to the total estimated fee.
+
+	let feeEstimation = 0
+	if (routeResult.txEstimation.feeCosts.length > 0) {
+		routeResult.txEstimation.feeCosts.forEach((fee) => {
+			feeEstimation += Number(fee.amountUsd)
+		})
+	}
+
+	if (routeResult.txEstimation.gasCosts.length > 0) {
+		routeResult.txEstimation.gasCosts.forEach((gas) => {
+			feeEstimation += Number(gas.amountUsd)
+		})
+	}
+
 	if (tokenType == EPeanutLinkType.native) {
 		txOptions = {
 			...txOptions,
@@ -297,31 +318,7 @@ export async function prepareXchainRequestFulfillmentTransaction({
 
 	unsignedTxs.push(unsignedTx)
 
-	return { unsignedTxs }
-}
-
-export function calculateCrossChainTxFee({
-	unsignedTxs,
-	isNativeTxValue,
-	fromAmount,
-}: {
-	unsignedTxs: IPeanutUnsignedTransaction[]
-	isNativeTxValue: boolean
-	fromAmount: string
-}): bigint {
-	let totalFee = BigInt(0)
-
-	for (const tx of unsignedTxs) {
-		if (tx.value) {
-			totalFee += BigInt(tx.value.toString())
-		}
-	}
-
-	if (isNativeTxValue) {
-		totalFee = totalFee - ethers.utils.parseEther(fromAmount).toBigInt()
-	}
-
-	return totalFee
+	return { unsignedTxs, feeEstimation: feeEstimation.toString() }
 }
 
 export function prepareRequestLinkFulfillmentTransaction({

test/basic/RequestLinkXChain.test.ts

@@ -63,13 +63,6 @@ describe('Peanut XChain request links fulfillment tests', function () {
 		})
 		console.log('Computed x chain unsigned fulfillment transactions', xchainUnsignedTxs)
 
-		const fee = await peanut.calculateCrossChainTxFee({
-			unsignedTxs: xchainUnsignedTxs.unsignedTxs,
-			isNativeTxValue: false,
-			fromAmount: amountToTestWith.toString(),
-		})
-		console.log('Fee', ethers.utils.formatEther(fee))
-
 		for (const unsignedTx of xchainUnsignedTxs.unsignedTxs) {
 			const { tx, txHash } = await signAndSubmitTx({
 				unsignedTx,
@@ -144,13 +137,6 @@ describe('Peanut XChain request links fulfillment tests', function () {
 		})
 		console.log('Computed x chain unsigned fulfillment transactions', xchainUnsignedTxs)
 
-		const fee = await peanut.calculateCrossChainTxFee({
-			unsignedTxs: xchainUnsignedTxs.unsignedTxs,
-			isNativeTxValue: true,
-			fromAmount: amountToTestWith.toString(),
-		})
-		console.log('Fee1', ethers.utils.formatEther(fee))
-
 		for (const unsignedTx of xchainUnsignedTxs.unsignedTxs) {
 			const { tx, txHash } = await signAndSubmitTx({
 				unsignedTx,