Merge pull request #78 from atomex-protocol/feat/atm-326-calculation-…

…of-estimated-fees-ethereum Implement fees calculation for ethereum operations
atomex-protocol · Aug 19, 2022 · 872dadb · 872dadb
2 parents 5ea807c + f68546d
commit 872dadb
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 16 deletions.
diff --git a/src/ethereum/atomexProtocol/erc20EthereumWeb3AtomexProtocolV1.ts b/src/ethereum/atomexProtocol/erc20EthereumWeb3AtomexProtocolV1.ts
@@ -28,8 +28,8 @@ export class ERC20EthereumWeb3AtomexProtocolV1 extends Web3AtomexProtocolV1 {
     throw new Error('Method not implemented.');
   }
 
-  getInitiateFees(_params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
-    throw new Error('Method not implemented.');
+  getInitiateFees(params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
+    return super.getInitiateFees(params);
   }
 
   redeem(_params: AtomexProtocolV1RedeemParameters): Promise<Transaction> {
@@ -40,15 +40,15 @@ export class ERC20EthereumWeb3AtomexProtocolV1 extends Web3AtomexProtocolV1 {
     throw new Error('Method not implemented.');
   }
 
-  getRedeemFees(_params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
-    throw new Error('Method not implemented.');
+  getRedeemFees(params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
+    return super.getRedeemFees(params);
   }
 
   refund(_params: AtomexProtocolV1RefundParameters): Promise<Transaction> {
     throw new Error('Method not implemented.');
   }
 
-  getRefundFees(_params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
-    throw new Error('Method not implemented.');
+  getRefundFees(params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
+    return super.getRefundFees(params);
   }
 }
diff --git a/src/ethereum/atomexProtocol/ethereumWeb3AtomexProtocolV1.ts b/src/ethereum/atomexProtocol/ethereumWeb3AtomexProtocolV1.ts
@@ -24,8 +24,8 @@ export class EthereumWeb3AtomexProtocolV1 extends Web3AtomexProtocolV1 {
     throw new Error('Method not implemented.');
   }
 
-  async getInitiateFees(_params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
-    throw new Error('Method not implemented.');
+  getInitiateFees(params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
+    return super.getInitiateFees(params);
   }
 
   redeem(_params: AtomexProtocolV1RedeemParameters): Promise<Transaction> {
@@ -36,15 +36,15 @@ export class EthereumWeb3AtomexProtocolV1 extends Web3AtomexProtocolV1 {
     throw new Error('Method not implemented.');
   }
 
-  getRedeemFees(_params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
-    throw new Error('Method not implemented.');
+  getRedeemFees(params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
+    return super.getRedeemFees(params);
   }
 
   refund(_params: AtomexProtocolV1RefundParameters): Promise<Transaction> {
     throw new Error('Method not implemented.');
   }
 
-  getRefundFees(_params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
-    throw new Error('Method not implemented.');
+  getRefundFees(params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
+    return super.getRefundFees(params);
   }
 }
diff --git a/src/evm/atomexProtocol/web3AtomexProtocolV1.ts b/src/evm/atomexProtocol/web3AtomexProtocolV1.ts
@@ -1,4 +1,4 @@
-import type BigNumber from 'bignumber.js';
+import BigNumber from 'bignumber.js';
 import type Web3 from 'web3';
 
 import type {
@@ -8,9 +8,11 @@ import type {
 } from '../../blockchain/index';
 import type { AtomexNetwork } from '../../common/index';
 import type { DeepReadonly } from '../../core/index';
+import { web3Helper } from '../helpers';
 import type { Web3AtomexProtocolV1Options } from '../models/index';
 
 export abstract class Web3AtomexProtocolV1 implements AtomexProtocolV1 {
+  protected static maxNetworkFeeMultiplier = new BigNumber(1.2);
   readonly version = 1;
 
   constructor(
@@ -28,17 +30,49 @@ export abstract class Web3AtomexProtocolV1 implements AtomexProtocolV1 {
 
   abstract initiate(_params: AtomexProtocolV1InitiateParameters): Promise<Transaction>;
 
-  abstract getInitiateFees(_params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo>;
+  async getInitiateFees(params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
+    const toolkit = await this.getReadonlyWeb3();
+    const gasPriceInWei = await web3Helper.getGasPriceInWei(toolkit);
+    const gasLimitOptions = this.atomexProtocolOptions.initiateOperation.gasLimit;
+    const hasRewardForRedeem = params.rewardForRedeem?.isGreaterThan(0);
+    const gasLimit = new BigNumber(hasRewardForRedeem ? gasLimitOptions.withReward : gasLimitOptions.withoutReward);
+
+    const estimatedWei = gasPriceInWei.multipliedBy(gasLimit).multipliedBy(Web3AtomexProtocolV1.maxNetworkFeeMultiplier);
+    const estimated = web3Helper.convertFromWei(toolkit, estimatedWei, 'ether');
+    const result: FeesInfo = { estimated, max: estimated };
+
+    return Promise.resolve(result);
+  }
 
   abstract redeem(_params: AtomexProtocolV1RedeemParameters): Promise<Transaction>;
 
   abstract getRedeemReward(_nativeTokenPriceInUsd: number, _nativeTokenPriceInCurrency: number): Promise<BigNumber>;
 
-  abstract getRedeemFees(_params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo>;
+  async getRedeemFees(_params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
+    const toolkit = await this.getReadonlyWeb3();
+    const gasPriceInWei = await web3Helper.getGasPriceInWei(toolkit);
+    const gasLimit = this.atomexProtocolOptions.redeemOperation.gasLimit;
+
+    const estimatedWei = gasPriceInWei.multipliedBy(gasLimit).multipliedBy(Web3AtomexProtocolV1.maxNetworkFeeMultiplier);
+    const estimated = web3Helper.convertFromWei(toolkit, estimatedWei, 'ether');
+    const result: FeesInfo = { estimated, max: estimated };
+
+    return Promise.resolve(result);
+  }
 
   abstract refund(_params: AtomexProtocolV1RefundParameters): Promise<Transaction>;
 
-  abstract getRefundFees(_params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo>;
+  async getRefundFees(_params: Partial<AtomexProtocolV1InitiateParameters>): Promise<FeesInfo> {
+    const toolkit = await this.getReadonlyWeb3();
+    const gasPriceInWei = await web3Helper.getGasPriceInWei(toolkit);
+    const gasLimit = this.atomexProtocolOptions.refundOperation.gasLimit;
+
+    const estimatedWei = gasPriceInWei.multipliedBy(gasLimit).multipliedBy(Web3AtomexProtocolV1.maxNetworkFeeMultiplier);
+    const estimated = web3Helper.convertFromWei(toolkit, estimatedWei, 'ether');
+    const result: FeesInfo = { estimated, max: estimated };
+
+    return Promise.resolve(result);
+  }
 
   protected async getReadonlyWeb3(): Promise<Web3> {
     const toolkit = await this.atomexBlockchainProvider.getReadonlyToolkit<Web3>('web3', this.blockchain);

diff --git a/src/evm/helpers/index.ts b/src/evm/helpers/index.ts
@@ -0,0 +1 @@
+export * as web3Helper from './web3Helper';
diff --git a/src/evm/helpers/web3Helper.ts b/src/evm/helpers/web3Helper.ts
@@ -0,0 +1,16 @@
+import BigNumber from 'bignumber.js';
+import type Web3 from 'web3';
+import type { Unit } from 'web3-utils';
+
+export const getGasPriceInWei = async (toolkit: Web3): Promise<BigNumber> => {
+  const gasPrice = await toolkit.eth.getGasPrice();
+
+  return new BigNumber(gasPrice);
+};
+
+export const convertFromWei = (toolkit: Web3, value: BigNumber | string, unit: Unit): BigNumber => {
+  const stringValue = typeof value === 'string' ? value : value.toString(10);
+  const result = toolkit.utils.fromWei(stringValue, unit);
+
+  return new BigNumber(result);
+};