improve(relayerFeeCalculator): Add logging around relayer fee calculations (#66)

Author: kevinuma

src/relayFeeCalculator/chain-queries/arbitrum.ts

@@ -24,13 +24,13 @@ export class ArbitrumQueries implements QueryInterface {
     return gasPrice.mul(gasEstimate).toString();
   }
 
-  async getTokenPrice(tokenSymbol: string): Promise<string | number> {
+  async getTokenPrice(tokenSymbol: string): Promise<number> {
     if (!this.symbolMapping[tokenSymbol]) throw new Error(`${tokenSymbol} does not exist in mapping`);
     const [, price] = await Coingecko.get().getCurrentPriceByContract(this.symbolMapping[tokenSymbol].address, "eth");
     return price;
   }
 
-  async getTokenDecimals(tokenSymbol: string): Promise<number> {
+  getTokenDecimals(tokenSymbol: string): number {
     if (!this.symbolMapping[tokenSymbol]) throw new Error(`${tokenSymbol} does not exist in mapping`);
     return this.symbolMapping[tokenSymbol].decimals;
   }

src/relayFeeCalculator/chain-queries/boba.ts

@@ -48,7 +48,7 @@ export class BobaQueries implements QueryInterface {
     return price;
   }
 
-  async getTokenDecimals(tokenSymbol: string): Promise<number> {
+  getTokenDecimals(tokenSymbol: string): number {
     if (!this.symbolMapping[tokenSymbol]) throw new Error(`${tokenSymbol} does not exist in mapping`);
     return this.symbolMapping[tokenSymbol].decimals;
   }

src/relayFeeCalculator/chain-queries/ethereum.ts

@@ -87,7 +87,7 @@ export class EthereumQueries implements QueryInterface {
     return price;
   }
 
-  async getTokenDecimals(tokenSymbol: string): Promise<number> {
+  getTokenDecimals(tokenSymbol: string): number {
     if (!this.symbolMapping[tokenSymbol]) throw new Error(`${tokenSymbol} does not exist in mapping`);
     return this.symbolMapping[tokenSymbol].decimals;
   }

src/relayFeeCalculator/chain-queries/optimism.ts

@@ -48,7 +48,7 @@ export class OptimismQueries implements QueryInterface {
     return price;
   }
 
-  async getTokenDecimals(tokenSymbol: string): Promise<number> {
+  getTokenDecimals(tokenSymbol: string): number {
     if (!this.symbolMapping[tokenSymbol]) throw new Error(`${tokenSymbol} does not exist in mapping`);
     return this.symbolMapping[tokenSymbol].decimals;
   }

src/relayFeeCalculator/chain-queries/polygon.ts

@@ -17,7 +17,7 @@ export class PolygonQueries implements QueryInterface {
       .toString();
   }
 
-  async getTokenPrice(tokenSymbol: string): Promise<string | number> {
+  async getTokenPrice(tokenSymbol: string): Promise<number> {
     if (!this.symbolMapping[tokenSymbol]) throw new Error(`${tokenSymbol} does not exist in mapping`);
     const [, tokenPrice] = await Coingecko.get().getCurrentPriceByContract(
       this.symbolMapping[tokenSymbol].address,
@@ -28,7 +28,7 @@ export class PolygonQueries implements QueryInterface {
     return Number((tokenPrice / maticPrice).toFixed(this.symbolMapping["MATIC"].decimals));
   }
 
-  async getTokenDecimals(tokenSymbol: string): Promise<number> {
+  getTokenDecimals(tokenSymbol: string): number {
     if (!this.symbolMapping[tokenSymbol]) throw new Error(`${tokenSymbol} does not exist in mapping`);
     return this.symbolMapping[tokenSymbol].decimals;
   }

src/relayFeeCalculator/relayFeeCalculator.test.ts

@@ -26,10 +26,10 @@ class ExampleQueries implements QueryInterface {
   async getGasCosts(): Promise<BigNumberish> {
     return gasCost(this.defaultGas, "100");
   }
-  async getTokenPrice(): Promise<number | string> {
+  async getTokenPrice(): Promise<number> {
     return 1;
   }
-  async getTokenDecimals(): Promise<number> {
+  getTokenDecimals(): number {
     return 18;
   }
 }

src/relayFeeCalculator/relayFeeCalculator.ts

@@ -7,8 +7,8 @@ const { percent, fixedPointAdjustment } = uma.across.utils;
 // This needs to be implemented for every chain and passed into RelayFeeCalculator
 export interface QueryInterface {
   getGasCosts: (tokenSymbol: string) => Promise<BigNumberish>;
-  getTokenPrice: (tokenSymbol: string) => Promise<number | string>;
-  getTokenDecimals: (tokenSymbol: string) => Promise<number>;
+  getTokenPrice: (tokenSymbol: string) => Promise<number>;
+  getTokenDecimals: (tokenSymbol: string) => number;
 }
 
 export const expectedCapitalCostsKeys = ["lowerBound", "upperBound", "cutoff", "decimals"];
@@ -72,11 +72,16 @@ export class RelayFeeCalculator {
   }
 
   async gasFeePercent(amountToRelay: BigNumberish, tokenSymbol: string): Promise<BigNumber> {
-    const [gasCosts, tokenPrice, decimals] = await Promise.all([
-      this.queries.getGasCosts(tokenSymbol),
-      this.queries.getTokenPrice(tokenSymbol),
-      this.queries.getTokenDecimals(tokenSymbol),
-    ]);
+    const getGasCosts = this.queries.getGasCosts(tokenSymbol).catch((error) => {
+      console.error(`ERROR(gasFeePercent): Error while fetching gas costs ${error}`);
+      throw error;
+    });
+    const getTokenPrice = this.queries.getTokenPrice(tokenSymbol).catch((error) => {
+      console.error(`ERROR(gasFeePercent): Error while fetching token price ${error}`);
+      throw error;
+    });
+    const [gasCosts, tokenPrice] = await Promise.all([getGasCosts, getTokenPrice]);
+    const decimals = this.queries.getTokenDecimals(tokenSymbol);
     const gasFeesInToken = nativeToToken(gasCosts, tokenPrice, decimals, this.nativeTokenDecimals);
     return percent(gasFeesInToken, amountToRelay);
   }
@@ -121,8 +126,10 @@ export class RelayFeeCalculator {
   async relayerFeeDetails(amountToRelay: BigNumberish, tokenSymbol: string) {
     let isAmountTooLow = false;
     const gasFeePercent = await this.gasFeePercent(amountToRelay, tokenSymbol);
+    console.log(`INFO(relayerFeeDetails): Computed gasFeePercent ${gasFeePercent}`);
     const gasFeeTotal = gasFeePercent.mul(amountToRelay).div(fixedPointAdjustment);
     const capitalFeePercent = await this.capitalFeePercent(amountToRelay, tokenSymbol);
+    console.log(`INFO(relayerFeeDetails): Computed capitalFeePercent ${capitalFeePercent}`);
     const capitalFeeTotal = capitalFeePercent.mul(amountToRelay).div(fixedPointAdjustment);
     const relayFeePercent = gasFeePercent.add(capitalFeePercent);
     const relayFeeTotal = gasFeeTotal.add(capitalFeeTotal);