@exodus/ethereum-api 8.19.0 → 8.20.0

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.20.0](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.19.1...@exodus/ethereum-api@8.20.0) (2024-10-09)
+
+
+### Features
+
+* **ethereum-api:** use exodus/crypto instead of js-sha3 for ens ([#4147](https://github.com/ExodusMovement/assets/issues/4147)) ([8b46675](https://github.com/ExodusMovement/assets/commit/8b466751247f92f950fecf1d36adddd876091d75))
+
+
+### 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))
+
+
+
+## [8.19.1](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.19.0...@exodus/ethereum-api@8.19.1) (2024-09-29)
+
+
+### Bug Fixes
+
+* ethereum-api bump asset-lib dep ([#4021](https://github.com/ExodusMovement/assets/issues/4021)) ([a4e1fe9](https://github.com/ExodusMovement/assets/commit/a4e1fe9cb4067b6f7a9e73b21b1602a183b77baa))
+
+
+
 ## [8.19.0](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.18.3...@exodus/ethereum-api@8.19.0) (2024-09-26)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "8.19.0",
+  "version": "8.20.0",
   "description": "Ethereum Api",
   "type": "module",
   "main": "src/index.js",
@@ -22,11 +22,11 @@
   },
   "dependencies": {
     "@exodus/asset": "^2.0.0",
-    "@exodus/asset-lib": "^5.0.0",
+    "@exodus/asset-lib": "^5.1.0",
     "@exodus/assets": "^11.0.0",
     "@exodus/basic-utils": "^3.0.1",
     "@exodus/bip44-constants": "^195.0.0",
-    "@exodus/crypto": "^1.0.0-rc.0",
+    "@exodus/crypto": "^1.0.0-rc.13",
     "@exodus/currency": "^5.0.2",
     "@exodus/ethereum-lib": "^5.4.0",
     "@exodus/ethereum-meta": "^2.0.0",
@@ -40,7 +40,6 @@
     "bn.js": "^5.2.1",
     "events": "^1.1.1",
     "idna-uts46-hx": "^2.3.1",
-    "js-sha3": "^0.8.0",
     "lodash": "^4.17.15",
     "make-concurrent": "^4.0.0",
     "minimalistic-assert": "^1.0.1",
@@ -65,5 +64,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "5ed11ccb5d6268dad10582ffd1df7aeae6993f09"
+  "gitHead": "a3826445e762843c0bccc5d9f94ecbb9dfe9648d"
 }

package/src/ens/index.js

@@ -1,12 +1,11 @@
+import { keccak256 } from '@exodus/crypto/keccak'
 import { ABI } from '@exodus/ethereum-lib'
 import SolidityContract from '@exodus/solidity-contract'
 import idna from 'idna-uts46-hx'
-import jsSha3 from 'js-sha3'
 
 import ENS_REGISTRY_ADDRESSES from './addresses.js'
 
 const { toUnicode } = idna
-const { keccak256 } = jsSha3
 
 const registry = new SolidityContract(ABI.ensRegistry)
 const resolver = new SolidityContract(ABI.ensResolver)
@@ -20,24 +19,16 @@ function namehash(inputName) {
   // Implementation based on @ensdomains/eth-ens-namehash package
 
   // Reject empty names:
-  var node = ''
-  var i
-  for (i = 0; i < 32; i++) {
-    node += '00'
-  }
-
-  var name = normalize(inputName)
+  let node = Buffer.alloc(32)
 
+  const name = normalize(inputName)
   if (name) {
-    var labels = name.split('.')
-
-    for (i = labels.length - 1; i >= 0; i--) {
-      var labelSha = keccak256(labels[i])
-      node = keccak256(Buffer.from(node + labelSha, 'hex'))
+    for (const label of name.split('.').reverse()) {
+      node = keccak256([node, keccak256(label)])
     }
   }
 
-  return '0x' + node
+  return '0x' + node.toString('hex')
 }
 
 // ENS only available on mainnet atm

package/src/number-utils.js

@@ -1,8 +1,40 @@
+import BN from 'bn.js'
+
 export function fromHexToString(value) {
   return fromHexToBigInt(value).toString()
 }
 
 export function fromHexToBigInt(value) {
-  const hex = value.startsWith('0x') ? value : '0x' + value
-  return BigInt(hex)
+  return BigInt(addHexPrefix(value))
+}
+
+export const addHexPrefix = (str) => {
+  if (typeof str !== 'string') {
+    return str
+  }
+
+  return str.startsWith('0x') ? str : '0x' + str
+}
+
+export const removeHexPrefix = (str) => {
+  if (typeof str !== 'string' || str === '') {
+    return str
+  }
+
+  return str.startsWith('0x') ? str.slice(2) : str
+}
+
+export const splitIn32BytesArray = (output) => {
+  const trimmed = removeHexPrefix(output)
+  const result = trimmed.match(/^([\da-f]{64})+$/gi)
+  if (result) {
+    return trimmed.match(/.{64}/g)
+  }
+
+  throw new Error(`${output} is not a 64 bytes hex that can be split`)
 }
+
+export const removeLeadingZeroes = (str) => str.replace(/^0+/, '')
+
+// Deprecated, use BigInt
+export const fromHexToBN = (str) => new BN(removeLeadingZeroes(removeHexPrefix(str)), 16)

package/src/staking/ethereum/api.js

@@ -48,12 +48,12 @@ export class EthereumStaking {
     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,
@@ -68,13 +68,16 @@ export class EthereumStaking {
 
   /** Return total deposited and activated pool balance */
   async poolsBalance() {
-    const totalPoolBalance = await this.callReadFunctionContract(this.contractAccounting, 'balance')
+    const totalPoolBalance = await this.#callReadFunctionContract(
+      this.contractAccounting,
+      'balance'
+    )
     return this.asset.currency.baseUnit(totalPoolBalance)
   }
 
   /** Return pool pending balance. Always < 32 ETH */
   async poolPendingBalance() {
-    const pendingBalance = await this.callReadFunctionContract(
+    const pendingBalance = await this.#callReadFunctionContract(
       this.contractAccounting,
       'pendingBalance'
     )
@@ -83,7 +86,7 @@ export class EthereumStaking {
 
   /** Return user pending balance (waiting to be added from the Pool contract to the ETH2 validator) */
   async pendingBalanceOf(address) {
-    let pendingBalance = await this.callReadFunctionContract(
+    let pendingBalance = await this.#callReadFunctionContract(
       this.contractAccounting,
       'pendingBalanceOf',
       address
@@ -94,7 +97,7 @@ export class EthereumStaking {
 
   /** Return total user autocompound balance. Part of this balance could be in pending state after rewards autocompound */
   async autocompoundBalanceOf(address) {
-    const userBalance = await this.callReadFunctionContract(
+    const userBalance = await this.#callReadFunctionContract(
       this.contractAccounting,
       'autocompoundBalanceOf',
       address
@@ -104,7 +107,7 @@ export class EthereumStaking {
 
   /** Return user pending deposited balance. Balance which deposited into validator but not active yet. Pending deposited balance can't be unstake till validator activation */
   async pendingDepositedBalanceOf(address) {
-    const userBalance = await this.callReadFunctionContract(
+    const userBalance = await this.#callReadFunctionContract(
       this.contractAccounting,
       'pendingDepositedBalanceOf',
       address
@@ -114,7 +117,7 @@ export class EthereumStaking {
 
   /** Return user active origin deposited balance */
   async depositedBalanceOf(address) {
-    const depositedBalance = await this.callReadFunctionContract(
+    const depositedBalance = await this.#callReadFunctionContract(
       this.contractAccounting,
       'depositedBalanceOf',
       address
@@ -133,7 +136,7 @@ export class EthereumStaking {
 
   /** Return withdrawable unstaked amount  */
   async withdrawRequest(address) {
-    let amounts = await this.callReadFunctionContract(
+    let amounts = await this.#callReadFunctionContract(
       this.contractAccounting,
       'withdrawRequest',
       address
@@ -153,7 +156,7 @@ export class EthereumStaking {
       return {
         to: this.poolAddress,
         amount,
-        data: bufferToHex(this.buildTxData(this.contractPool, 'stake', source)), // tx data field
+        data: bufferToHex(this.#buildTxData(this.contractPool, 'stake', source)), // tx data field
       }
     }
 
@@ -170,7 +173,7 @@ export class EthereumStaking {
         to: this.poolAddress,
         amount: this.asset.currency.ZERO,
         data: bufferToHex(
-          this.buildTxData(this.contractPool, 'unstake', amountWei, allowedInterchangeNum, source)
+          this.#buildTxData(this.contractPool, 'unstake', amountWei, allowedInterchangeNum, source)
         ),
       }
     }
@@ -186,7 +189,7 @@ export class EthereumStaking {
         return {
           to: this.accountingAddress,
           amount: this.asset.currency.ZERO,
-          data: bufferToHex(this.buildTxData(this.contractAccounting, 'claimWithdrawRequest')),
+          data: bufferToHex(this.#buildTxData(this.contractAccounting, 'claimWithdrawRequest')),
         }
       }
 
@@ -206,7 +209,7 @@ export class EthereumStaking {
         return {
           to: this.poolAddress,
           amount: this.asset.currency.ZERO,
-          data: bufferToHex(this.buildTxData(this.contractPool, 'unstakePending', amountWei)),
+          data: bufferToHex(this.#buildTxData(this.contractPool, 'unstakePending', amountWei)),
         }
       } catch (err) {
         throw new Error(err)

package/src/staking/fantom-staking.js

@@ -7,7 +7,7 @@ export class FantomStaking {
     this.sfcContract = createContract(SFC_ADDRESS, 'fantomSfc')
   }
 
-  buildTxData = (contract, method, ...args) => {
+  #buildTxData = (contract, method, ...args) => {
     return contract[method].build(...args)
   }
 
@@ -16,7 +16,7 @@ export class FantomStaking {
    */
   delegate = ({ validatorId }) => {
     this.#validateValidatorId(validatorId)
-    return this.buildTxData(this.sfcContract, 'delegate', validatorId)
+    return this.#buildTxData(this.sfcContract, 'delegate', validatorId)
   }
 
   /**
@@ -31,7 +31,7 @@ export class FantomStaking {
   undelegate = ({ requestId, validatorId, amount }) => {
     this.#validateRequestId(requestId)
     this.#validateValidatorId(validatorId)
-    return this.buildTxData(this.sfcContract, 'undelegate', validatorId, requestId, amount)
+    return this.#buildTxData(this.sfcContract, 'undelegate', validatorId, requestId, amount)
   }
 
   /**
@@ -44,7 +44,7 @@ export class FantomStaking {
   withdraw = ({ requestId, validatorId }) => {
     this.#validateRequestId(requestId)
     this.#validateValidatorId(validatorId)
-    return this.buildTxData(this.sfcContract, 'withdraw', validatorId, requestId)
+    return this.#buildTxData(this.sfcContract, 'withdraw', validatorId, requestId)
   }
 
   /**
@@ -53,7 +53,7 @@ export class FantomStaking {
    */
   claimRewards = ({ validatorId }) => {
     this.#validateValidatorId(validatorId)
-    return this.buildTxData(this.sfcContract, 'claimRewards', validatorId)
+    return this.#buildTxData(this.sfcContract, 'claimRewards', validatorId)
   }
 
   /**
@@ -62,7 +62,7 @@ export class FantomStaking {
    */
   restakeRewards = ({ validatorId }) => {
     this.#validateValidatorId(validatorId)
-    return this.buildTxData(this.sfcContract, 'restakeRewards', validatorId)
+    return this.#buildTxData(this.sfcContract, 'restakeRewards', validatorId)
   }
 
   /**
@@ -71,7 +71,7 @@ export class FantomStaking {
   lockStake = ({ validatorId, amount, durationSeconds }) => {
     this.#validateValidatorId(validatorId)
     this.#validateDuration(durationSeconds)
-    return this.buildTxData(this.sfcContract, 'lockStake', validatorId, durationSeconds, amount)
+    return this.#buildTxData(this.sfcContract, 'lockStake', validatorId, durationSeconds, amount)
   }
 
   /**
@@ -80,7 +80,7 @@ export class FantomStaking {
   relockStake = ({ validatorId, amount, durationSeconds }) => {
     this.#validateValidatorId(validatorId)
     this.#validateDuration(durationSeconds)
-    return this.buildTxData(this.sfcContract, 'relockStake', validatorId, durationSeconds, amount)
+    return this.#buildTxData(this.sfcContract, 'relockStake', validatorId, durationSeconds, amount)
   }
 
   /**
@@ -88,7 +88,7 @@ export class FantomStaking {
    */
   unlockStake = ({ validatorId, amount }) => {
     this.#validateValidatorId(validatorId)
-    return this.buildTxData(this.sfcContract, 'unlockStake', validatorId, amount)
+    return this.#buildTxData(this.sfcContract, 'unlockStake', validatorId, amount)
   }
 
   #validateValidatorId = (validatorId) => {

package/src/staking/matic/api.js

@@ -5,6 +5,7 @@ import { retry } from '@exodus/simple-retry'
 import BN from 'bn.js'
 
 import { getServerByName } from '../../exodus-eth-server/index.js'
+import { fromHexToBN, fromHexToString, splitIn32BytesArray } from '../../number-utils.js'
 
 const polygonEthToken = ethAssets.find(({ name: tokenName }) => tokenName === 'polygon')
 
@@ -27,12 +28,12 @@ export class MaticStakingApi {
     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,
@@ -44,15 +45,15 @@ export class MaticStakingApi {
   }
 
   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'
     )
@@ -64,8 +65,8 @@ export class MaticStakingApi {
    * 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)
   }
 
   /**
@@ -79,7 +80,7 @@ export class MaticStakingApi {
       _nonce = await this.getCurrentUnbondNonce(address)
     }
 
-    const unboundInfo = await this.callReadFunctionContract(
+    const unboundInfo = await this.#callReadFunctionContract(
       this.validatorShareContract,
       'unbonds_new',
       address,
@@ -88,8 +89,8 @@ export class MaticStakingApi {
 
     const [shares, withdrawEpoch] = splitIn32BytesArray(unboundInfo)
     return {
-      withdrawEpoch: toBN(withdrawEpoch),
-      shares: toBN(shares),
+      withdrawEpoch: fromHexToBN(withdrawEpoch),
+      shares: fromHexToBN(shares),
     }
   }
 
@@ -99,7 +100,7 @@ export class MaticStakingApi {
    * @returns current unbonded nonce
    */
   getCurrentUnbondNonce = async (address) => {
-    const unbondNonce = await this.callReadFunctionContract(
+    const unbondNonce = await this.#callReadFunctionContract(
       this.validatorShareContract,
       'unbondNonces',
       address
@@ -108,7 +109,7 @@ export class MaticStakingApi {
   }
 
   getLiquidRewards = async (address) => {
-    const liquidRewards = await this.callReadFunctionContract(
+    const liquidRewards = await this.#callReadFunctionContract(
       this.validatorShareContract,
       'getLiquidRewards',
       address
@@ -117,22 +118,22 @@ export class MaticStakingApi {
   }
 
   getTotalStake = async (address) => {
-    const stakeInfo = await this.callReadFunctionContract(
+    const stakeInfo = await this.#callReadFunctionContract(
       this.validatorShareContract,
       'getTotalStake',
       address
     )
     const [amount] = splitIn32BytesArray(stakeInfo)
-    return polygonEthToken.currency.baseUnit(toBN(amount).toString())
+    return polygonEthToken.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)
   }
 
   /**
@@ -145,7 +146,7 @@ export class MaticStakingApi {
    * @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,
@@ -154,20 +155,20 @@ export class MaticStakingApi {
   }
 
   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(),
@@ -179,22 +180,6 @@ export class MaticStakingApi {
    * @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
-}