@exodus/ethereum-api 8.23.2 → 8.24.0

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.
 
+## [8.24.0](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.23.2...@exodus/ethereum-api@8.24.0) (2024-12-17)
+
+
+### Features
+
+
+* feat: evm staking send simplification (#4681)
+
+
+
 ## [8.23.2](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.23.1...@exodus/ethereum-api@8.23.2) (2024-12-17)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "8.23.2",
+  "version": "8.24.0",
   "description": "Transaction monitors, fee monitors, RPC with the blockchain node, and other networking code for Ethereum and EVM-based blockchains",
   "type": "module",
   "main": "src/index.js",
@@ -38,6 +38,7 @@
     "@exodus/solidity-contract": "^1.1.3",
     "@exodus/web3-ethereum-utils": "^3.27.1",
     "bn.js": "^5.2.1",
+    "delay": "^4.0.1",
     "events": "^1.1.1",
     "idna-uts46-hx": "^2.3.1",
     "lodash": "^4.17.15",
@@ -54,8 +55,7 @@
     "@exodus/ethereumgoerli-meta": "^2.0.0",
     "@exodus/ethereumsepolia-meta": "^2.0.0",
     "@exodus/fantommainnet-meta": "^2.0.0",
-    "@exodus/rootstock-meta": "^2.0.0",
-    "delay": "4.0.1"
+    "@exodus/rootstock-meta": "^2.0.0"
   },
   "bugs": {
     "url": "https://github.com/ExodusMovement/assets/issues?q=is%3Aissue+is%3Aopen+label%3Aethereum-api"
@@ -64,5 +64,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "2036bf64aa16ee26a864a4aa971b050fc4631104"
+  "gitHead": "cb07ad7e423a04b4da350bbf159e55b4490e3eae"
 }

package/src/staking/ethereum/service.js

@@ -3,6 +3,7 @@ import { isNumberUnit } from '@exodus/currency'
 import { getServer } from '../../exodus-eth-server/index.js'
 import { estimateGasLimit } from '../../gas-estimation.js'
 import { fromHexToBigInt } from '../../number-utils.js'
+import { createWatchTx as defaultCreateWatch } from '../../watch-tx.js'
 import { stakingProviderClientFactory } from '../staking-provider-client.js'
 import { EthereumStaking } from './api.js'
 
@@ -11,7 +12,7 @@ const extraGasLimit = 20_000 // extra gas Limit to prevent tx failing if somethi
 export function createEthereumStakingService({
   asset,
   assetClientInterface,
-  createAndBroadcastTX,
+  createWatchTx = defaultCreateWatch,
 }) {
   const staking = new EthereumStaking(asset)
   const stakingProvider = stakingProviderClientFactory()
@@ -33,7 +34,7 @@ export function createEthereumStakingService({
       amount,
     })
 
-    const { gasPrice, gasLimit, fee } = await estimateTxFee(delegatorAddress, to, amount, data)
+    const { gasPrice, gasLimit } = await estimateTxFee(delegatorAddress, to, amount, data)
 
     console.log(
       `delegator address ${delegatorAddress} staking ${amount.toDefaultString({
@@ -48,7 +49,6 @@ export function createEthereumStakingService({
       txData: data,
       gasPrice,
       gasLimit,
-      fee,
     })
 
     // Goerli is not supported
@@ -226,7 +226,7 @@ export function createEthereumStakingService({
     })
     if (withdrawRequest) {
       const { to, data } = withdrawRequest
-      const { gasPrice, gasLimit, fee } = await estimateTxFee(delegatorAddress, to, null, data)
+      const { gasPrice, gasLimit } = await estimateTxFee(delegatorAddress, to, null, data)
       return prepareAndSendTx({
         asset,
         walletAccount,
@@ -234,7 +234,6 @@ export function createEthereumStakingService({
         txData: data,
         gasPrice,
         gasLimit,
-        fee,
       })
     }
   }
@@ -314,7 +313,6 @@ export function createEthereumStakingService({
       txData: txInput,
       gasPrice,
       gasLimit,
-      fee,
       waitForConfirmation = false,
     } = Object.create(null)
   ) {
@@ -323,28 +321,27 @@ export function createEthereumStakingService({
       walletAccount,
       address: to,
       amount: amount || asset.currency.ZERO,
-      // unified tx-send param
       shouldLog: true,
-      txInput,
-      feeAmount: fee,
-      feeOpts: {
-        gasPrice,
-        gasLimit,
-      },
-      // mobile: tx-send parms
       options: {
         shouldLog: true,
         txInput,
         gasPrice,
         gasLimit,
-        feeAmount: fee,
       },
-      waitForConfirmation,
     }
 
-    console.log('sending staking tx:', sendTxArgs)
+    const { txId } = await asset.baseAsset.api.sendTx(sendTxArgs)
 
-    const { txId } = await createAndBroadcastTX(sendTxArgs)
+    const baseAsset = asset.baseAsset
+    if (waitForConfirmation) {
+      const getTxLog = (...args) => assetClientInterface.getTxLog(...args)
+      const watchTx = createWatchTx({
+        walletAccount,
+        getTxLog,
+        baseAsset,
+      })
+      await watchTx(txId)
+    }
 
     return txId
   }

package/src/staking/matic/service.js

@@ -3,10 +3,14 @@ import BN from 'bn.js'
 
 import { getServer } from '../../exodus-eth-server/index.js'
 import { estimateGasLimit } from '../../gas-estimation.js'
+import { createWatchTx as defaultCreateWatch } from '../../watch-tx.js'
 import { stakingProviderClientFactory } from '../staking-provider-client.js'
 import { MaticStakingApi } from './api.js'
 
-export function createPolygonStakingService({ assetClientInterface, createAndBroadcastTX }) {
+export function createPolygonStakingService({
+  assetClientInterface,
+  createWatchTx = defaultCreateWatch,
+}) {
   const stakingApi = new MaticStakingApi()
   const assetName = 'ethereum'
   const stakingProvider = stakingProviderClientFactory()
@@ -33,7 +37,7 @@ export function createPolygonStakingService({ assetClientInterface, createAndBro
     amount = amountToCurrency({ asset, amount })
 
     const txApproveData = await stakingApi.approveStakeManager(amount)
-    let { gasPrice, gasLimit, fee } = await estimateTxFee(
+    let { gasPrice, gasLimit } = await estimateTxFee(
       delegatorAddress,
       stakingApi.polygonContract.address,
       txApproveData
@@ -45,11 +49,10 @@ export function createPolygonStakingService({ assetClientInterface, createAndBro
       txData: txApproveData,
       gasPrice,
       gasLimit,
-      fee,
     })
 
     const txDelegateData = await stakingApi.delegate({ amount })
-    ;({ gasPrice, gasLimit, fee } = await estimateTxFee(
+    ;({ gasPrice, gasLimit } = await estimateTxFee(
       delegatorAddress,
       stakingApi.validatorShareContract.address,
       txDelegateData
@@ -61,7 +64,6 @@ export function createPolygonStakingService({ assetClientInterface, createAndBro
       txData: txDelegateData,
       gasPrice,
       gasLimit,
-      fee,
     })
 
     await stakingProvider.notifyStaking({
@@ -85,7 +87,7 @@ export function createPolygonStakingService({ assetClientInterface, createAndBro
     amount = amountToCurrency({ asset, amount })
 
     const txUndelegateData = await stakingApi.undelegate({ amount })
-    const { gasPrice, gasLimit, fee } = await estimateTxFee(
+    const { gasPrice, gasLimit } = await estimateTxFee(
       delegatorAddress.toLowerCase(),
       stakingApi.validatorShareContract.address,
       txUndelegateData
@@ -96,7 +98,6 @@ export function createPolygonStakingService({ assetClientInterface, createAndBro
       txData: txUndelegateData,
       gasPrice,
       gasLimit,
-      fee,
     })
   }
 
@@ -108,7 +109,7 @@ export function createPolygonStakingService({ assetClientInterface, createAndBro
     const delegatorAddress = address.toLowerCase()
 
     const txWithdrawRewardsData = await stakingApi.withdrawRewards()
-    const { gasPrice, gasLimit, fee } = await estimateTxFee(
+    const { gasPrice, gasLimit } = await estimateTxFee(
       delegatorAddress,
       stakingApi.validatorShareContract.address,
       txWithdrawRewardsData
@@ -119,7 +120,6 @@ export function createPolygonStakingService({ assetClientInterface, createAndBro
       txData: txWithdrawRewardsData,
       gasPrice,
       gasLimit,
-      fee,
     })
   }
 
@@ -267,37 +267,37 @@ export function createPolygonStakingService({ assetClientInterface, createAndBro
     txData: txInput,
     gasPrice,
     gasLimit,
-    fee,
     waitForConfirmation = false,
   } = {}) {
-    const { ethereum } = await assetClientInterface.getAssetsForNetwork({
+    const { ethereum: asset } = await assetClientInterface.getAssetsForNetwork({
       baseAssetName: 'ethereum',
     })
     const sendTxArgs = {
-      asset: ethereum,
+      asset,
       walletAccount,
       address: to,
-      amount: ethereum.currency.ZERO,
-      // unified tx-send param
-      shouldLog: true,
-      txInput,
-      feeAmount: fee,
-      feeOpts: {
-        gasPrice,
-        gasLimit,
-      },
-      // mobile: tx-send parms
+      amount: asset.currency.ZERO,
       options: {
         shouldLog: true,
         txInput,
         gasPrice,
         gasLimit,
-        feeAmount: fee,
       },
       waitForConfirmation,
     }
 
-    const { txId } = await createAndBroadcastTX(sendTxArgs)
+    const { txId } = await asset.baseAsset.api.sendTx(sendTxArgs)
+
+    const baseAsset = asset.baseAsset
+    if (waitForConfirmation) {
+      const getTxLog = (...args) => assetClientInterface.getTxLog(...args)
+      const watchTx = createWatchTx({
+        walletAccount,
+        getTxLog,
+        baseAsset,
+      })
+      await watchTx(txId)
+    }
 
     return txId
   }

package/src/watch-tx.js

@@ -0,0 +1,32 @@
+import delay from 'delay'
+import ms from 'ms'
+
+const WATCH_TX_DELAY = ms('5s')
+const WATCH_TX_TIMEOUT = ms('5m')
+
+// this could go to asset-lib
+export const createWatchTx =
+  ({
+    walletAccount,
+    getTxLog,
+    baseAsset,
+    watchTxDelay = WATCH_TX_DELAY,
+    watchTxTimeout = WATCH_TX_TIMEOUT,
+  }) =>
+  async (txId) => {
+    const start = Date.now()
+    let txConfirmed = false
+    let hasTimedOut = false
+
+    while (!hasTimedOut && !txConfirmed) {
+      await delay(watchTxDelay)
+      const baseAssetTxLog = await getTxLog({
+        assetName: baseAsset.name,
+        walletAccount,
+      })
+      txConfirmed = baseAssetTxLog.get(txId)?.confirmed
+      hasTimedOut = Date.now() - start > watchTxTimeout
+    }
+
+    return { txId, confirmed: txConfirmed, hasTimedOut }
+  }