Add fee message on exchange estimate

omni · Apr 27, 2020 · 1a9ccdc · 1a9ccdc
1 parent ada93ab
commit 1a9ccdc
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 9 deletions.
diff --git a/burner-wallet-plugin/tokenbridge-bw-exchange/src/burner-wallet/pairs/Mediator.ts b/burner-wallet-plugin/tokenbridge-bw-exchange/src/burner-wallet/pairs/Mediator.ts
@@ -1,6 +1,6 @@
 import BN from 'bn.js'
-import { Bridge, ValueTypes } from '@burner-wallet/exchange'
-import { waitForEvent } from '../../utils'
+import { Bridge, EstimateReturn, ValueTypes } from '@burner-wallet/exchange'
+import { waitForEvent, constants } from '../../utils'
 import { MEDIATOR_ABI, MEDIATOR_FEE_MANAGER_ABI, ZERO_ADDRESS } from '../../../../../commons'
 import { toBN } from 'web3-utils'
 
@@ -42,7 +42,8 @@ export default class Mediator extends Bridge {
     }
   }
 
-  async estimateAtoB(value: ValueTypes) {
+  // @ts-ignore
+  async estimateAtoB(value: ValueTypes): Promise<EstimateReturn> {
     const web3 = this.getExchange()
       .getAsset(this.assetB)
       .getWeb3()
@@ -53,10 +54,14 @@ export default class Mediator extends Bridge {
     const feeAmount = await this.getFeeAmount(web3, contract, userAmount)
     const finalAmount = toBN(userAmount).sub(feeAmount)
 
-    return finalAmount.toString()
+    return {
+      estimate: finalAmount.toString(),
+      estimateInfo: feeAmount.isZero() ? null : constants.ESTIMATE_FEE_MESSAGE
+    }
   }
 
-  async estimateBtoA(value: ValueTypes) {
+  // @ts-ignore
+  async estimateBtoA(value: ValueTypes): Promise<EstimateReturn> {
     const web3 = this.getExchange()
       .getAsset(this.assetA)
       .getWeb3()
@@ -67,7 +72,10 @@ export default class Mediator extends Bridge {
     const feeAmount = await this.getFeeAmount(web3, contract, userAmount)
     const finalAmount = toBN(userAmount).sub(feeAmount)
 
-    return finalAmount.toString()
+    return {
+      estimate: finalAmount.toString(),
+      estimateInfo: feeAmount.isZero() ? null : constants.ESTIMATE_FEE_MESSAGE
+    }
   }
 
   async getFeeAmount(web3, contract, value): Promise<BN> {

diff --git a/burner-wallet-plugin/tokenbridge-bw-exchange/src/utils/utils.ts b/burner-wallet-plugin/tokenbridge-bw-exchange/src/utils/utils.ts
@@ -5,7 +5,8 @@ export const wait = (time: number) => new Promise(resolve => setTimeout(resolve,
 
 export const constants = {
   EXCHANGE_TIMEOUT: 300000,
-  MAX_FEE: toWei('1', 'ether')
+  MAX_FEE: toWei('1', 'ether'),
+  ESTIMATE_FEE_MESSAGE: 'Estimation takes fee charges into consideration.'
 }
 
 export const waitForEvent = async (web3, contract: Contract, event: string, callback: Function) => {

diff --git a/burner-wallet-plugin/tokenbridge-bw-exchange/src/wetc-bridge/WETCBridge.ts b/burner-wallet-plugin/tokenbridge-bw-exchange/src/wetc-bridge/WETCBridge.ts
@@ -62,7 +62,10 @@ export default class WETCBridge extends Mediator {
         .div(toBN(constants.MAX_FEE))
       const finalAmount = toBN(this._getValue(value)).sub(feeAmount)
 
-      return finalAmount.toString()
+      return {
+        estimate: finalAmount.toString(),
+        estimateInfo: feeAmount.isZero() ? null : constants.ESTIMATE_FEE_MESSAGE
+      }
     } else {
       return await super.estimateAtoB(value)
     }
@@ -83,7 +86,10 @@ export default class WETCBridge extends Mediator {
         .div(toBN(constants.MAX_FEE))
       const finalAmount = toBN(this._getValue(value)).sub(feeAmount)
 
-      return finalAmount.toString()
+      return {
+        estimate: finalAmount.toString(),
+        estimateInfo: feeAmount.isZero() ? null : constants.ESTIMATE_FEE_MESSAGE
+      }
     } else {
       return await super.estimateBtoA(value)
     }