@exodus/ethereum-plugin 2.4.1 → 2.4.2

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.4.2](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-plugin@2.4.1...@exodus/ethereum-plugin@2.4.2) (2024-10-09)
+
+
+### Bug Fixes
+
+* hardening private methods ([#4165](https://github.com/ExodusMovement/assets/issues/4165)) ([cb04b39](https://github.com/ExodusMovement/assets/commit/cb04b39ee3a70abf9a13697e0998e1d55196aac7))
+* staking splitIn32BytesArray hardening and improvements ([#4170](https://github.com/ExodusMovement/assets/issues/4170)) ([2a178ae](https://github.com/ExodusMovement/assets/commit/2a178aefc590186ee699e746d8e71bac1ab8198e))
+
+
+
 ## [2.4.1](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-plugin@2.4.0...@exodus/ethereum-plugin@2.4.1) (2024-09-12)
 
 **Note:** Version bump only for package @exodus/ethereum-plugin

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-plugin",
-  "version": "2.4.1",
+  "version": "2.4.2",
   "description": "Exodus ethereum-plugin",
   "type": "module",
   "main": "src/index.js",
@@ -22,7 +22,7 @@
   "dependencies": {
     "@exodus/asset-lib": "^5.0.0",
     "@exodus/currency": "^5.0.2",
-    "@exodus/ethereum-api": "^8.18.1",
+    "@exodus/ethereum-api": "^8.20.0",
     "@exodus/ethereum-lib": "^5.4.0",
     "@exodus/ethereum-meta": "^2.0.0",
     "@exodus/ethereumjs-util": "^7.1.0-exodus.7",
@@ -43,5 +43,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "3885dfad0efad7a6f12053aab220f0b127039fcf"
+  "gitHead": "a3826445e762843c0bccc5d9f94ecbb9dfe9648d"
 }

package/src/staking/polygon/api.js

@@ -1,3 +1,4 @@
+import { fromHexToBN, fromHexToString, splitIn32BytesArray } from '@exodus/ethereum-api'
 import { createContract } from '@exodus/ethereum-lib'
 import { bufferToHex } from '@exodus/ethereumjs-util'
 import { retry } from '@exodus/simple-retry'
@@ -25,12 +26,12 @@ class StakingServer {
     this.server = server
   }
 
-  buildTxData = (contract, method, ...args) => {
+  #buildTxData = (contract, method, ...args) => {
     return contract[method].build(...args)
   }
 
-  callReadFunctionContract = (contract, method, ...args) => {
-    const callData = this.buildTxData(contract, method, ...args)
+  #callReadFunctionContract = (contract, method, ...args) => {
+    const callData = this.#buildTxData(contract, method, ...args)
     const data = {
       data: bufferToHex(callData),
       to: contract.address,
@@ -42,15 +43,15 @@ class StakingServer {
   }
 
   getWithdrawalDelay = async () => {
-    const withdrawalDelay = await this.callReadFunctionContract(
+    const withdrawalDelay = await this.#callReadFunctionContract(
       this.stakingManagerContract,
       'withdrawalDelay'
     )
-    return toBN(withdrawalDelay)
+    return fromHexToBN(withdrawalDelay)
   }
 
   getMinRewardsToWithdraw = async () => {
-    const minRewardsToWithdraw = await this.callReadFunctionContract(
+    const minRewardsToWithdraw = await this.#callReadFunctionContract(
       this.validatorShareContract,
       'minAmount'
     )
@@ -62,8 +63,8 @@ class StakingServer {
    * stored in a list and points the events that happened in that epoch. (timeline)
    */
   getCurrentCheckpoint = async () => {
-    const currentEpoch = await this.callReadFunctionContract(this.stakingManagerContract, 'epoch')
-    return toBN(currentEpoch)
+    const currentEpoch = await this.#callReadFunctionContract(this.stakingManagerContract, 'epoch')
+    return fromHexToBN(currentEpoch)
   }
 
   /**
@@ -77,7 +78,7 @@ class StakingServer {
       _nonce = await this.getCurrentUnbondNonce(address)
     }
 
-    const unboundInfo = await this.callReadFunctionContract(
+    const unboundInfo = await this.#callReadFunctionContract(
       this.validatorShareContract,
       'unbonds_new',
       address,
@@ -86,8 +87,8 @@ class StakingServer {
 
     const [shares, withdrawEpoch] = splitIn32BytesArray(unboundInfo)
     return {
-      withdrawEpoch: toBN(withdrawEpoch),
-      shares: toBN(shares),
+      withdrawEpoch: fromHexToBN(withdrawEpoch),
+      shares: fromHexToBN(shares),
     }
   }
 
@@ -97,7 +98,7 @@ class StakingServer {
    * @returns current unbonded nonce
    */
   getCurrentUnbondNonce = async (address) => {
-    const unbondNonce = await this.callReadFunctionContract(
+    const unbondNonce = await this.#callReadFunctionContract(
       this.validatorShareContract,
       'unbondNonces',
       address
@@ -106,7 +107,7 @@ class StakingServer {
   }
 
   getLiquidRewards = async (address) => {
-    const liquidRewards = await this.callReadFunctionContract(
+    const liquidRewards = await this.#callReadFunctionContract(
       this.validatorShareContract,
       'getLiquidRewards',
       address
@@ -115,22 +116,22 @@ class StakingServer {
   }
 
   getTotalStake = async (address) => {
-    const stakeInfo = await this.callReadFunctionContract(
+    const stakeInfo = await this.#callReadFunctionContract(
       this.validatorShareContract,
       'getTotalStake',
       address
     )
     const [amount] = splitIn32BytesArray(stakeInfo)
-    return this.asset.currency.baseUnit(toBN(amount).toString())
+    return this.asset.currency.baseUnit(fromHexToString(amount))
   }
 
   getWithdrawExchangeRate = async () => {
-    const withdrawExchangeRate = await this.callReadFunctionContract(
+    const withdrawExchangeRate = await this.#callReadFunctionContract(
       this.validatorShareContract,
       'withdrawExchangeRate'
     )
 
-    return toBN(withdrawExchangeRate)
+    return fromHexToBN(withdrawExchangeRate)
   }
 
   /**
@@ -143,7 +144,7 @@ class StakingServer {
    * @param amount Matic tokens to be approved for StakeManager to withdraw (polygon currency)
    */
   approveStakeManager = (amount) => {
-    return this.buildTxData(
+    return this.#buildTxData(
       this.polygonContract,
       'increaseAllowance',
       this.stakingManagerContract.address,
@@ -152,20 +153,20 @@ class StakingServer {
   }
 
   restakeReward = () => {
-    return this.buildTxData(this.validatorShareContract, 'restake')
+    return this.#buildTxData(this.validatorShareContract, 'restake')
   }
 
   withdrawRewards = () => {
-    return this.buildTxData(this.validatorShareContract, 'withdrawRewards')
+    return this.#buildTxData(this.validatorShareContract, 'withdrawRewards')
   }
 
   delegate = ({ amount }) => {
-    return this.buildTxData(this.validatorShareContract, 'buyVoucher', amount.toBaseString(), '0')
+    return this.#buildTxData(this.validatorShareContract, 'buyVoucher', amount.toBaseString(), '0')
   }
 
   undelegate = ({ amount, maximumSharesToBurn }) => {
     const _maximumSharesToBurn = maximumSharesToBurn || amount
-    return this.buildTxData(
+    return this.#buildTxData(
       this.validatorShareContract,
       'sellVoucher_new',
       amount.toBaseString(),
@@ -177,25 +178,9 @@ class StakingServer {
    * @param {number} unbondNonce the unbond nonce from where delegator claim its staked tokens
    */
   claimUndelegatedBalance = ({ unbondNonce }) => {
-    return this.buildTxData(this.validatorShareContract, 'unstakeClaimTokens_new', unbondNonce)
+    return this.#buildTxData(this.validatorShareContract, 'unstakeClaimTokens_new', unbondNonce)
   }
 }
 
-// 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(/[\da-f]{1,64}/gi) || []
-
-const toBN = (str) => new BN(removeLeadingZeroes(removeHexPrefix(str)), 16)
-
-const removeLeadingZeroes = (str) => str.replace(/^0+/, '')
-
-const removeHexPrefix = (str) => {
-  if (typeof str !== 'string' || str === '') {
-    return str
-  }
-
-  return str.startsWith('0x') ? str.slice(2) : str
-}
-
 export const stakingServerFactory = ({ asset, contracts, server }) =>
   new StakingServer({ asset, contracts, server })