Add deposit token with approve

.eslintrc

@@ -9,6 +9,7 @@
             "error",
             120
         ],
+        "no-await-in-loop": "off",
         "no-shadow": "off",
         "no-underscore-dangle": "off",
         "object-curly-newline": [

CHANGELOG.md

@@ -11,6 +11,7 @@ Release date: 2019-02-REPLEACE_ME.
 ### Added
 
 - [CLI withdraw command](https://github.com/eidoo/hybrid-exchange-sdk/issues/13)
+- [Deposit Token with approve](https://github.com/eidoo/hybrid-exchange-sdk/issues/11)
 - [Allowance](https://github.com/eidoo/hybrid-exchange-sdk/issues/7).
 - [Private key from mnemonic](https://github.com/eidoo/hybrid-exchange-sdk/issues/5).
 - [Pair fee](https://github.com/eidoo/hybrid-exchange-sdk/issues/1).

README.md

@@ -50,6 +50,7 @@ In order to deposit the above assets your ethereum wallet needs to be funded.<br
 
 Please note that as soon as you are ready to deposit some ERC20 token you must [approve](./examples/lib/tradingWallet/approve/approve.js) your trading wallet as spender of the deposit amount since the trading wallet will perform a `transferFrom` of the token from your ethereum wallet to itself.<br>
 You can check the status of the approval verifying the [allowance](./examples/lib/tradingWallet/allowance/getAllowance.js).
+You can decide also to deposit ERC20 token with auto managed approve operation ([example](./examples/lib/tradingWallet/depositToken/depositTokenWithApprove.js)).
 
 You will always be the only one able to withdraw [ERC20 token](./examples/lib/tradingWallet/withdraw/withdraw.js) and [ether](./examples/lib/tradingWallet/withdraw/withdraw.js) from your trading wallet to the connected ethereum wallet.
 

examples/lib/Erc20TokenBalances/balanceOf.js

@@ -0,0 +1,13 @@
+(async () => {
+  const { Erc20TokenServiceBuilder } = require('@eidoo/hybrid-exchange-sdk').factories
+
+  const tokenAddress = '0x9727e2fb13f7f42d5a6f1a4a9877d4a7e0404d6a'
+  const personalWalletAddress = '0xcf4b07a79b5d29988f488f30c4a676ecaad35c02'
+
+  const erc20TokenServiceBuilder = new Erc20TokenServiceBuilder(tokenAddress)
+  const erc20TokenService = erc20TokenServiceBuilder.build()
+  const assetBalance = await erc20TokenService.getBalanceOfAsync(
+    personalWalletAddress,
+  )
+  console.log('allowance: ', assetBalance)
+})()

examples/lib/tradingWallet/approve/approve.js

@@ -11,7 +11,7 @@
   const erc20TokenServiceBuilder = new Erc20TokenServiceBuilder(tokenAddress)
   const erc20TokenService = erc20TokenServiceBuilder.build()
 
-  const transactionHash = await erc20TokenService.approveTrasferAsync(
+  const transactionHash = await erc20TokenService.approveTransferAsync(
     personalWalletAddress,
     tradingWalletAddress,
     toDeposit,

examples/lib/tradingWallet/depositToken/depositTokenWithApprove.js

@@ -0,0 +1,45 @@
+(async () => {
+  const { TradingWalletTransactionBuilder, Erc20TokenServiceBuilder, Erc20TokenTransactionBuilder } = require('@eidoo/hybrid-exchange-sdk').factories
+  const { TradingWalletFacade } = require('@eidoo/hybrid-exchange-sdk').facades
+  const { TransactionLib } = require('@eidoo/hybrid-exchange-sdk').lib.TransactionLib
+
+  const Web3 = require('web3')
+  const providerUrl = 'providerUrl'
+  const web3 = new Web3(new Web3.providers.HttpProvider(providerUrl))
+
+  const tokenAddress = '0x9727e2fb13f7f42d5a6f1a4a9877d4a7e0404d6a'
+  const personalWalletAddress = '0xcf4b07a79b5d29988f488f30c4a676ecaad35c02'
+  const tradingWalletAddress = '0x9c6d1840381cc570235a4ed867bf8465e32ce753'
+  const privateKey = '0x4c7ee440ad699493b22732031e4a3277d2d8aa834b727aa0b358e3310aa37384'
+  const quantityToDeposit = '500000000000000000'
+
+  const tradingWalletTransactionBuilder = new TradingWalletTransactionBuilder(web3)
+  const erc20TokenServiceBuilder = new Erc20TokenServiceBuilder(tokenAddress)
+  const transactionLib = new TransactionLib()
+  const erc20TokenTransactionBuilder = new Erc20TokenTransactionBuilder(
+    web3,
+    { erc20TokenSmartContractAddress: tokenAddress,
+      transactionLib },
+  )
+  const tradingWalletFacade = new TradingWalletFacade(
+    tradingWalletTransactionBuilder,
+    erc20TokenServiceBuilder.build(),
+    erc20TokenTransactionBuilder,
+  )
+
+  const {
+    approveToZeroTransactionHash,
+    approveTransactionHash,
+    depositTransactionHash,
+  } = await tradingWalletFacade.depositTokenAsync(
+    personalWalletAddress,
+    tradingWalletAddress,
+    quantityToDeposit,
+    tokenAddress,
+    privateKey,
+  )
+
+  console.log('approveToZeroTransactionHash: ', approveToZeroTransactionHash)
+  console.log('approveTransactionHash: ', approveTransactionHash)
+  console.log('depositTransactionHash: ', depositTransactionHash)
+})()

src/facades/TradingWalletFacade.js

@@ -0,0 +1,151 @@
+const log = require('../logger')
+const { QuantityNotEnoughError } = require('../utils').errors
+const { TransactionLibBuilder } = require('../factories')
+
+/**
+ * Class representing a facade of tradingWallet utilities.
+ */
+
+class TradingWalletFacade {
+  constructor(tradingWalletTransactionBuilder, erc20TokenService, erc20TokenTransactionBuilder,
+    transactionLib = TransactionLibBuilder.build(), logger = log) {
+    if (!logger) {
+      throw new TypeError(`Invalid "logger" value: ${logger}`)
+    }
+    this.log = logger.child({ module: this.constructor.name })
+
+    if (!tradingWalletTransactionBuilder) {
+      const errorMessage = `Invalid "tradingWalletTransactionBuilder" value: ${tradingWalletTransactionBuilder}`
+      throw new TypeError(errorMessage)
+    }
+    this.tradingWalletTransactionBuilder = tradingWalletTransactionBuilder
+
+    if (!erc20TokenService) {
+      const errorMessage = `Invalid "erc20TokenService" value: ${erc20TokenService}`
+      throw new TypeError(errorMessage)
+    }
+    this.erc20TokenService = erc20TokenService
+
+    if (!erc20TokenTransactionBuilder) {
+      const errorMessage = `Invalid "erc20TokenTransactionBuilder" value: ${erc20TokenTransactionBuilder}`
+      throw new TypeError(errorMessage)
+    }
+    this.erc20TokenTransactionBuilder = erc20TokenTransactionBuilder
+
+    if (!transactionLib) {
+      const errorMessage = `Invalid "transactionLib" value: ${transactionLib}`
+      throw new TypeError(errorMessage)
+    }
+    this.transactionLib = transactionLib
+  }
+
+  async throwIfTokenWalletEnought(personalWalletAddress, quantity) {
+    const assetBalance = await this.erc20TokenService.getBalanceOfAsync(personalWalletAddress)
+
+    const assetBalanceToBigNumber = this.transactionLib.web3.toBigNumber(assetBalance)
+    const quantityToBigNumber = this.transactionLib.web3.toBigNumber(quantity)
+    if (assetBalanceToBigNumber.lt(quantityToBigNumber)) {
+      const errorMessage = 'The asset balance is < than the quantity to depoist!'
+      this.log.info({
+        personalWalletAddress,
+        quantity,
+        assetBalance,
+        fn: 'checkIfTokenWalletEnought',
+      },
+      errorMessage)
+      throw new QuantityNotEnoughError(errorMessage)
+    }
+  }
+
+  async depositTokenAsync(personalWalletAddress, tradingWalletAddress, quantity, tokenAddress, privateKey) {
+    this.log.info({
+      fn: 'depositTokenAsync',
+      personalWalletAddress,
+      tradingWalletAddress,
+      tokenAddress,
+      quantity,
+    }, 'Deposit token.')
+
+    let approveToZeroTransactionHash = null
+    let approveTransactionHash = null
+
+    await this.throwIfTokenWalletEnought(personalWalletAddress, quantity)
+
+    const allowance = await this.erc20TokenService.getAllowanceAsync(personalWalletAddress, tradingWalletAddress)
+    const allowanceToInt = +allowance
+
+    if (quantity > allowance && allowance > 0) {
+      this.log.info({
+        personalWalletAddress,
+        tradingWalletAddress,
+        quantity,
+        tokenAddress,
+        allowance,
+        fn: 'depositTokenAsync',
+      },
+      'The quantity to deposit is not completely allowed!')
+
+      const zeroQuantity = 0
+      approveToZeroTransactionHash = await this.erc20TokenService.approveTransferAsync(
+        personalWalletAddress,
+        tradingWalletAddress,
+        zeroQuantity,
+        privateKey,
+      )
+    }
+
+    const approveTransactionDraftObject = await this.erc20TokenTransactionBuilder.buildApproveTrasferTransactionDraft(
+      personalWalletAddress,
+      tradingWalletAddress,
+      quantity,
+    )
+    const gasEstimationForApprove = await this.transactionLib.getGasEstimation(approveTransactionDraftObject)
+    const nonceForApprove = await this.transactionLib.getNonce(personalWalletAddress)
+
+    if (allowanceToInt === 0 || (quantity > allowanceToInt && allowanceToInt > 0)) {
+      const signedApproveData = await this.transactionLib.sign(
+        approveTransactionDraftObject,
+        privateKey,
+        nonceForApprove,
+        gasEstimationForApprove.gas,
+        gasEstimationForApprove.gasPrice,
+      )
+      approveTransactionHash = await this.transactionLib.execute(signedApproveData)
+    }
+
+    const depositTokenTransactionDraft = await this.tradingWalletTransactionBuilder
+      .buildDepositTokenTransactionDraft(personalWalletAddress, tradingWalletAddress, quantity, tokenAddress)
+    const depositTokenFixedGasEstimation = 100000
+
+    const signedTransactionDataForDeposit = await this.transactionLib.sign(
+      depositTokenTransactionDraft,
+      privateKey,
+      nonceForApprove + 1,
+      depositTokenFixedGasEstimation,
+      gasEstimationForApprove.gasPrice,
+    )
+
+    const depositTransactionHash = await this.transactionLib
+      .execute(signedTransactionDataForDeposit, privateKey)
+
+    this.log.info({
+      fn: 'depositTokenAsync',
+      personalWalletAddress,
+      tradingWalletAddress,
+      quantity,
+      tokenAddress,
+      approveToZeroTransactionHash,
+      approveTransactionHash,
+      depositTransactionHash,
+    },
+    'Deposit token completed successfully.')
+
+    return {
+      approveToZeroTransactionHash,
+      approveTransactionHash,
+      depositTransactionHash,
+    }
+  }
+}
+
+module.exports = TradingWalletFacade

src/facades/index.js

@@ -0,0 +1,5 @@
+const TradingWalletFacade = require('./TradingWalletFacade')
+
+module.exports = {
+  TradingWalletFacade,
+}

src/factories/Erc20TokenTransactionBuilder.js

@@ -87,6 +87,25 @@ class Erc20TokenTransactionBuilder extends BaseTransactionBuilder {
     )
     return transactionDraft
   }
+
+  buildGetBalanceOfTransactionDraft(personalWalletAddress) {
+    this.constructor.checkEtherumAddress(personalWalletAddress)
+
+    const smartContractMethodName = 'balanceOf'
+    const smartContractParams = [personalWalletAddress]
+    const transactionParams = {
+      from: personalWalletAddress,
+      to: this.erc20TokenSmartContractAddress,
+    }
+
+    const transactionDraft = this.transactionLib.buildDraft(this.erc20TokenSmartContractInstance,
+      transactionParams, smartContractMethodName, smartContractParams)
+    this.log.debug(
+      { fn: 'buildGetBalanceOfTransactionDraft', personalWalletAddress },
+      'Erc20 token get balance of transaction draft builded successfully.',
+    )
+    return transactionDraft
+  }
 }
 
 module.exports = Erc20TokenTransactionBuilder

src/factories/TransactionLibBuilder.js

@@ -0,0 +1,19 @@
+const Web3 = require('web3')
+
+const logger = require('../logger')
+
+const { TransactionLib } = require('../lib/TransactionLib')
+
+const providerUrl = 'urlToProvider'
+const web3 = new Web3(new Web3.providers.HttpProvider(providerUrl))
+
+/**
+   * Class representing a simple factory to build Transaction lib object.
+   */
+class TransactionLibBuilder {
+  static build() {
+    return new TransactionLib(web3, logger)
+  }
+}
+
+module.exports = TransactionLibBuilder

src/factories/index.js

@@ -3,11 +3,13 @@ const Erc20TokenServiceBuilder = require('./Erc20TokenServiceBuilder')
 const OrderPayloadBuilder = require('./OrderPayloadBuilder')
 const TradingWalletServiceBuilder = require('./TradingWalletServiceBuilder')
 const TradingWalletTransactionBuilder = require('./TradingWalletTransactionBuilder')
+const TransactionLibBuilder = require('./TransactionLibBuilder')
 
 module.exports = {
   Erc20TokenTransactionBuilder,
   Erc20TokenServiceBuilder,
   OrderPayloadBuilder,
   TradingWalletServiceBuilder,
   TradingWalletTransactionBuilder,
+  TransactionLibBuilder,
 }

src/index.js

@@ -1,5 +1,6 @@
 const commands = require('./commands')
 const config = require('./config')
+const facades = require('./facades')
 const factories = require('./factories')
 const helpers = require('./helpers')
 const lib = require('./lib')
@@ -11,6 +12,7 @@ const validators = require('./validators')
 module.exports = {
   commands,
   config,
+  facades,
   factories,
   helpers,
   lib,

src/lib/TransactionLib/ITransactionLib.js

@@ -7,6 +7,16 @@ class ITransactionLib {
     return Promise.reject(new Error('Method "buildDraft" has not been implemented yet.'))
   }
 
+  // eslint-disable-next-line class-methods-use-this
+  getGasEstimation() {
+    return Promise.reject(new Error('Method "getGasEstimation" has not been implemented yet.'))
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  getNonce() {
+    return Promise.reject(new Error('Method "getNonce" has not been implemented yet.'))
+  }
+
   // eslint-disable-next-line class-methods-use-this
   sign() {
     return Promise.reject(new Error('Method "sign" has not been implemented yet.'))