@exodus/ethereum-api 6.2.3 → 6.2.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "6.2.3",
+  "version": "6.2.5",
   "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.1.0",
+    "@exodus/ethereum-lib": "^3.3.0",
     "@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": "6df51df0f2625839988bd554c83e86660ba488c8"
+  "gitHead": "70cc3abc876af2d29d08586bf7cbbca056cee69b"
 }

package/src/staking/matic-staking.js

@@ -1,15 +1,20 @@
+import BN from 'bn.js'
 import { createContract } from '@exodus/ethereum-lib'
+import { asset as polygon } from '@exodus/matic-meta'
 import { getServerByName } from '../exodus-eth-server'
 import { retry } from '@exodus/simple-retry'
 import { bufferToHex } from '@exodus/ethereumjs-util'
 
-export const EVERSTAKE_VALIDATOR_ADDR = '0xf30cf4ed712d3734161fdaab5b1dbb49fd2d0e5c'
-export const STAKING_MANAGER_ADDR = '0x5e3ef299fddf15eaa0432e6e66473ace8c13d908'
+const EVERSTAKE_VALIDATOR_CONTRACT_ADDR = '0xf30cf4ed712d3734161fdaab5b1dbb49fd2d0e5c'
+const STAKING_MANAGER_ADDR = '0x5e3ef299fddf15eaa0432e6e66473ace8c13d908'
 
 const RETRY_DELAYS = ['10s']
 
 export class MaticStaking {
-  constructor(validatorId = EVERSTAKE_VALIDATOR_ADDR, stakeManagerAddr = STAKING_MANAGER_ADDR) {
+  constructor(
+    validatorId = EVERSTAKE_VALIDATOR_CONTRACT_ADDR,
+    stakeManagerAddr = STAKING_MANAGER_ADDR
+  ) {
     this.validatorShareContract = createContract(validatorId, 'maticValidatorShare')
     this.stakingManagerContract = createContract(stakeManagerAddr, 'maticStakingManager')
   }
@@ -19,7 +24,7 @@ export class MaticStaking {
     return txData
   }
 
-  processRead = (contract, method, ...args) => {
+  callReadFunctionContract = (contract, method, ...args) => {
     const callData = this.buildTxData(contract, method, ...args)
     const data = {
       data: bufferToHex(callData),
@@ -27,29 +32,22 @@ export class MaticStaking {
       tag: 'latest',
     }
 
-    // TODO: why 'ethereum' if this is matic staking?
     const eth = getServerByName('ethereum')
     return retry(eth.ethCall, { delayTimesMs: RETRY_DELAYS })(data)
   }
 
   /**
-   * Get current checkpoint
-   * @returns {number}
+   * A checkpoint is an epoch value that increments in the contract, every epoch is
+   * stored in a list and points the events that happened in that epoch. (timeline)
    */
   getCurrentCheckpoint = async () => {
-    const currentEpoch = await this.processRead(this.stakingManagerContract, 'epoch')
-    return parseInt(currentEpoch, 16)
-  }
-
-  getCurrentUnbondNonce = async (address) => {
-    const result = await this.processRead(this.validatorShareContract, 'unbondNonces', address)
-    return parseInt(result, 16)
+    const currentEpoch = await this.callReadFunctionContract(this.stakingManagerContract, 'epoch')
+    return toBN(currentEpoch)
   }
 
   /**
-   * Get unbond info by supplying unbondNonces
-   * @param {string} address
-   * @param {number} nonce
+   * Unbond is a struct in the staking contract that holds the number of shares and
+   * the withdrawEpoch for a delegator (used when delegators unstaked their tokens)
    * @returns {number}
    */
   getUnboundInfo = async (address, nonce) => {
@@ -58,104 +56,95 @@ export class MaticStaking {
       _nonce = await this.getCurrentUnbondNonce(address)
     }
 
-    const unboundInfo = await this.processRead(
+    const unboundInfo = await this.callReadFunctionContract(
       this.validatorShareContract,
       'unbonds_new',
       address,
       _nonce
     )
-    const [withdrawEpoch, shares] = this._removeHexPrefix(unboundInfo).match(/.{1,64}/g) || []
+
+    const [withdrawEpoch, shares] = splitIn32BytesArray(unboundInfo)
     return {
-      withdrawEpoch: parseInt(withdrawEpoch, 16),
-      shares: parseInt(shares, 16),
+      withdrawEpoch: toBN(withdrawEpoch, 16),
+      shares: toBN(shares, 16),
     }
   }
 
   /**
-   * Get current Liquid rewards
-   * @param {string} address
-   * @returns {number}
+   * UnbondNonce is a counter stored in the contract that tracks each time a delegator unstakes
+   * @param address delegator address
+   * @return current unbonded nonce
    */
+  getCurrentUnbondNonce = async (address) => {
+    const unbondNonce = await this.callReadFunctionContract(
+      this.validatorShareContract,
+      'unbondNonces',
+      address
+    )
+    return parseInt(unbondNonce, 16)
+  }
+
   getLiquidRewards = async (address) => {
-    const currentEpoch = await this.processRead(
+    const liquidRewards = await this.callReadFunctionContract(
       this.validatorShareContract,
       'getLiquidRewards',
       address
     )
-    return parseInt(currentEpoch, 16)
+    return polygon.currency.baseUnit(liquidRewards)
   }
 
-  /**
-   * Get total staked amount
-   * @param {string} address
-   * @returns {number}
-   */
   getTotalStake = async (address) => {
-    const stakeInfo = await this.processRead(this.validatorShareContract, 'getTotalStake', address)
-    const [amount] = this._removeHexPrefix(stakeInfo).match(/.{1,64}/g) || []
-    return parseInt(amount, 16)
+    const stakeInfo = await this.callReadFunctionContract(
+      this.validatorShareContract,
+      'getTotalStake',
+      address
+    )
+    const [amount] = splitIn32BytesArray(stakeInfo)
+    return polygon.currency.baseUnit(toBN(amount).toString())
   }
 
-  /**
-   * Get tx data of method to restake the earned rewards
-   */
   restakeReward = () => {
     return this.buildTxData(this.validatorShareContract, 'restake')
   }
 
-  /**
-   * Get tx data of method to withdraw earned rewards
-   */
   withdrawRewards = () => {
     return this.buildTxData(this.validatorShareContract, 'withdrawRewards')
   }
 
-  /**
-   * Get tx data of method to delegate (stake) amount to validator
-   * internally it calls method - **buyVoucher**
-   *  @param {string} param.amount
-   */
-  delegateAmount = ({ amount }) => {
-    return this.buildTxData(this.validatorShareContract, 'buyVoucher', amount, 0)
+  delegate = ({ amount }) => {
+    return this.buildTxData(this.validatorShareContract, 'buyVoucher', amount.toBaseString(), 0)
   }
 
-  /**
-   * Get tx data of method to unstake delegated amount
-   * internally it calls - **sellVoucher_new**
-   * @param {string} param.amount
-   * @param {string} param.maximumSharesToBurn
-   * @returns {string}
-   */
-  unbond = ({ amount, maximumSharesToBurn }) => {
+  undelegate = ({ amount, maximumSharesToBurn }) => {
     const _maximumSharesToBurn = maximumSharesToBurn || amount
     return this.buildTxData(
       this.validatorShareContract,
       'sellVoucher_new',
-      amount,
-      _maximumSharesToBurn
+      amount.toBaseString(),
+      _maximumSharesToBurn.toBaseString()
     )
   }
 
   /**
-   * Get tx data of method to claim the delegated amount by supplying nonce
-   * internally it calls method - **unstakeClaimTokens_new**
-   * @param {number} nonce
-   * @returns {string}
+   * @param {number} nonce the unbond nonce from where delegator claim its staked tokens
    */
-  claimStake = (nonce) => {
+  claimStake = ({ nonce }) => {
     return this.buildTxData(this.validatorShareContract, 'unstakeClaimTokens_new', nonce)
   }
+}
 
-  /**
-   * Remove 0x prefix of a hex string
-   * @param {string} str
-   * @returns {string}
-   */
-  _removeHexPrefix = (str) => {
-    if (typeof str !== 'string' || str === '') {
-      return str
-    }
+// see arguments encoding standard (padded 32 bytes)
+// https://docs.soliditylang.org/en/v0.8.15/abi-spec.html?highlight=abi.encode#function-selector-and-argument-encoding
+const splitIn32BytesArray = (output) => removeHexPrefix(output).match(/[0-9a-f]{1,64}/gi) || []
+
+const toBN = (str) => new BN(removeLeadingZeroes(removeHexPrefix(str)), 16)
 
-    return str.startsWith('0x') ? str.slice(2) : str
+const removeLeadingZeroes = (str) => str.replace(/^0+/, '')
+
+const removeHexPrefix = (str) => {
+  if (typeof str !== 'string' || str === '') {
+    return str
   }
+
+  return str.startsWith('0x') ? str.slice(2) : str
 }