feat: gRPC method to calculate transaction fees

lib/Utils.ts

@@ -1,7 +1,12 @@
 import { Transaction, crypto } from 'bitcoinjs-lib';
 import { OutputType, Scripts } from 'boltz-core';
 import { randomBytes } from 'crypto';
-import { ContractTransactionResponse, getAddress } from 'ethers';
+import {
+  ContractTransactionResponse,
+  TransactionReceipt,
+  TransactionResponse,
+  getAddress,
+} from 'ethers';
 import { Transaction as LiquidTransaction, confidential } from 'liquidjs-lib';
 import os from 'os';
 import path from 'path';
@@ -551,7 +556,7 @@ export const calculateLiquidTransactionFee = (
  * Calculates the transaction fee of an Ethereum contract interaction and rounds it to 10 ** -8 decimals
  */
 export const calculateEthereumTransactionFee = (
-  transaction: ContractTransactionResponse,
+  transaction: TransactionResponse | ContractTransactionResponse,
 ): number => {
   return Number(
     (transaction.gasLimit! *
@@ -562,6 +567,12 @@ export const calculateEthereumTransactionFee = (
   );
 };
 
+export const calculateEthereumTransactionFeeWithReceipt = (
+  receipt: TransactionReceipt,
+): number => {
+  return Number((receipt.gasUsed * receipt.gasPrice) / etherDecimals);
+};
+
 /**
  * Hashes an arbitrary UTF-8 string with SHA256
  *

lib/cli/commands/CalculateTransactionFee.ts

@@ -0,0 +1,42 @@
+import { Arguments } from 'yargs';
+import { CalculateTransactionFeeRequest } from '../../proto/boltzrpc_pb';
+import BuilderComponents, { ApiType, BuilderTypes } from '../BuilderComponents';
+import { callback, loadBoltzClient } from '../Command';
+
+export const command = 'txfee <symbol> <transactionId>';
+
+export const describe = 'calculate the fee of a transaction';
+
+export const builder = {
+  symbol: BuilderComponents.symbol,
+  transactionId: {
+    type: 'string',
+    describe: 'ID or hash of the transaction',
+  },
+};
+
+export const handler = async (
+  argv: Arguments<BuilderTypes<typeof builder> & ApiType>,
+) => {
+  const request = new CalculateTransactionFeeRequest();
+  request.setSymbol(argv.symbol);
+  request.setTransactionId(argv.transactionId);
+
+  loadBoltzClient(argv).calculateTransactionFee(
+    request,
+    callback((res) => {
+      const data: Record<string, number> = {
+        absolute: res.getAbsolute(),
+      };
+
+      if (res.hasSatPerVbyte()) {
+        data.satPerVbyte = res.getSatPerVbyte();
+      }
+      if (res.hasGwei()) {
+        data.gwei = res.getGwei();
+      }
+
+      return data;
+    }),
+  );
+};

lib/grpc/GrpcServer.ts

@@ -42,6 +42,7 @@ class GrpcServer {
       getPendingSweeps: grpcService.getPendingSweeps,
       getLabel: grpcService.getLabel,
       setLogLevel: grpcService.setLogLevel,
+      calculateTransactionFee: grpcService.calculateTransactionFee,
     });
   }
 

lib/grpc/GrpcService.ts

@@ -432,6 +432,30 @@ class GrpcService {
     });
   };
 
+  public calculateTransactionFee: handleUnaryCall<
+    boltzrpc.CalculateTransactionFeeRequest,
+    boltzrpc.CalculateTransactionFeeResponse
+  > = async (call, callback) => {
+    await this.handleCallback(call, callback, async () => {
+      const { symbol, transactionId } = call.request.toObject();
+
+      const { absolute, satPerVbyte, gwei } =
+        await this.service.calculateTransactionFee(symbol, transactionId);
+
+      const res = new boltzrpc.CalculateTransactionFeeResponse();
+      res.setAbsolute(absolute);
+
+      if (satPerVbyte !== undefined) {
+        res.setSatPerVbyte(satPerVbyte);
+      }
+      if (gwei !== undefined) {
+        res.setGwei(gwei);
+      }
+
+      return res;
+    });
+  };
+
   private handleCallback = async <R, T>(
     call: R,
     callback: (error: any, res: T | null) => void,