@exodus/ethereum-api 6.0.3 → 6.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "6.0.3",
+  "version": "6.1.0",
   "description": "Ethereum Api",
   "main": "src/index.js",
   "files": [
@@ -16,7 +16,7 @@
   "dependencies": {
     "@exodus/asset-lib": "^3.7.1",
     "@exodus/crypto": "^1.0.0-rc.0",
-    "@exodus/ethereum-lib": "^3.0.2",
+    "@exodus/ethereum-lib": "^3.0.3",
     "@exodus/ethereumjs-util": "^7.1.0-exodus.6",
     "@exodus/fetch": "^1.2.1",
     "@exodus/simple-retry": "^0.0.6",
@@ -36,5 +36,5 @@
   "devDependencies": {
     "@exodus/models": "^8.10.4"
   },
-  "gitHead": "b5bbf65b92737f9fb2bf6ac3412cc9e0bb803483"
+  "gitHead": "2de4be14ec048af2830b2a2c21ddd8dbc5d06d4d"
 }

package/src/allowance/constants.js

@@ -0,0 +1,14 @@
+// assets that require setting allowance to zero by calling `approve(_spender, 0)`
+// before setting a non-zero allowance
+export const ZERO_ALLOWANCE_ASSETS = [
+  'tetherusd',
+  'aragon',
+  'bancor',
+  'status',
+  'decentraland',
+  'dent',
+  'lidodao',
+]
+
+export const APPROVAL_GAS_LIMIT = 60000
+export const ALLOWANCE_TX_TIMEOUT = 60000 * 5

package/src/allowance/index.js

@@ -0,0 +1,121 @@
+import { fetchGasLimit, getServer } from '../'
+import { ALLOWANCE_TX_TIMEOUT, APPROVAL_GAS_LIMIT, ZERO_ALLOWANCE_ASSETS } from './constants'
+
+export { APPROVAL_GAS_LIMIT, ZERO_ALLOWANCE_ASSETS }
+
+export const isZeroAllowanceAsset = (assetName) => ZERO_ALLOWANCE_ASSETS.includes(assetName)
+
+export async function getSpendingAllowance({ asset, fromAddress, spenderAddress }) {
+  const data = asset.contract.allowance.build(fromAddress, spenderAddress)
+
+  const res = await getServer(asset)
+    .ethCall({
+      data: '0x' + data.toString('hex'),
+      to: asset.contract.address,
+    })
+    .catch(() => 0)
+
+  return asset.currency.baseUnit(res)
+}
+
+export async function isSpendingApprovalRequired({
+  asset,
+  fromAddress,
+  spenderAddress,
+  tokenAmount,
+}) {
+  const allowance = await getSpendingAllowance({ asset, fromAddress, spenderAddress })
+  return tokenAmount.gt(allowance)
+}
+
+export const createApprove = ({ sendTx }) => async ({
+  walletAccount,
+  fromAddress,
+  spenderAddress,
+  asset,
+  feeData,
+  feeAmount,
+  approveAmount,
+  gasLimit,
+  txInput: preTxInput,
+}) => {
+  const baseAsset = asset.baseAsset
+  const txInput =
+    preTxInput ?? asset.contract.approve.build(spenderAddress, approveAmount.toBaseString())
+
+  const toAddress = asset.contract.address
+  const gasLimitOptions = {
+    asset: baseAsset,
+    amount: baseAsset.currency.ZERO,
+    fromAddress,
+    toAddress,
+    txInput,
+    feeData,
+    isContract: true,
+  }
+
+  gasLimit = gasLimit || (await fetchGasLimit(gasLimitOptions))
+
+  const txData = await sendTx({
+    asset: baseAsset.name,
+    walletAccount,
+    receiver: {
+      address: toAddress,
+      amount: baseAsset.currency.ZERO,
+    },
+    txInput,
+    gasPrice: feeData.gasPrice,
+    gasLimit,
+    feeAmount,
+    silent: true,
+  })
+
+  if (!txData || !txData.txId) {
+    throw new Error(`Failed to approve ${asset.displayTicker} - ${spenderAddress}`)
+  }
+
+  return txData
+}
+
+const createSendApprovalAndWatchConfirmation = ({ sendTx, watchTxConfirmation }) => async (
+  data
+) => {
+  // To change the approve amount you first have to reduce the addresses`
+  // allowance to zero by calling `approve(_spender, 0)` if it is not
+  // already 0 to mitigate the race condition described here:
+  // see: https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
+  // see: https://etherscan.io/address/0xdac17f958d2ee523a2206206994597c13d831ec7#code
+  const approve = createApprove({ sendTx })
+  const { txId } = await approve(data)
+  await watchTxConfirmation(
+    { asset: data.asset.baseAsset.name, walletAccount: data.walletAccount },
+    txId,
+    ALLOWANCE_TX_TIMEOUT
+  )
+
+  return txId
+}
+
+export const createApproveSpendingTokens = ({ sendTx, watchTxConfirmation }) => async (data) => {
+  const txIds = []
+  const sendApprovalAndWatchConfirmation = createSendApprovalAndWatchConfirmation({
+    sendTx,
+    watchTxConfirmation,
+  })
+  if (ZERO_ALLOWANCE_ASSETS.includes(data.asset.name) && !data.approveAmount.isZero) {
+    const revokeTokenApprovalTxId = await sendApprovalAndWatchConfirmation({
+      ...data,
+      txInput: undefined,
+      approveAmount: data.asset.currency.ZERO,
+    })
+
+    txIds.push(revokeTokenApprovalTxId)
+    // Hardcoded min gas limit. Otherwise `fetchGasLimit` will fail since `approve(_spender, 0)` is not yet confirmed
+    data.gasLimit = Math.max(data.gasLimit || 0, APPROVAL_GAS_LIMIT)
+  }
+
+  const tokenApprovalTxId = await sendApprovalAndWatchConfirmation({ ...data, sendTx })
+  txIds.push(tokenApprovalTxId)
+
+  return txIds
+}

package/src/index.js

@@ -9,3 +9,4 @@ export * from './tx-log'
 export * from './get-balances'
 export * from './staking'
 export * from './simulate-tx'
+export * from './allowance'