@exodus/solana-api 3.8.2 → 3.9.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.9.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-api@3.8.3...@exodus/solana-api@3.9.0) (2024-07-08)
+
+
+### Features
+
+* reuse SOL API results for getAccount and getTokenAccounts ([#2666](https://github.com/ExodusMovement/assets/issues/2666)) ([4e96f4c](https://github.com/ExodusMovement/assets/commit/4e96f4c66d7783b113f0cbdf73d30bb605ae0534))
+
+
+### Bug Fixes
+
+* update SOL staking info on balance change ([#2672](https://github.com/ExodusMovement/assets/issues/2672)) ([bc2043c](https://github.com/ExodusMovement/assets/commit/bc2043ce226128d3e321937a325e20382f12f874))
+
+
+
+## [3.8.3](https://github.com/ExodusMovement/assets/compare/@exodus/solana-api@3.8.2...@exodus/solana-api@3.8.3) (2024-06-27)
+
+**Note:** Version bump only for package @exodus/solana-api
+
+
+
+
+
 ## [3.8.2](https://github.com/ExodusMovement/assets/compare/@exodus/solana-api@3.8.1...@exodus/solana-api@3.8.2) (2024-06-27)
 
 **Note:** Version bump only for package @exodus/solana-api

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/solana-api",
-  "version": "3.8.2",
+  "version": "3.9.0",
   "description": "Exodus internal Solana asset API wrapper",
   "main": "src/index.js",
   "files": [
@@ -32,6 +32,7 @@
     "@exodus/simple-retry": "^0.0.6",
     "@exodus/solana-lib": "^3.4.2",
     "@exodus/solana-meta": "^1.0.7",
+    "@exodus/timer": "^1.0.0",
     "bn.js": "^4.11.0",
     "debug": "^4.1.1",
     "delay": "^4.0.1",
@@ -46,7 +47,7 @@
     "@exodus/assets-testing": "^1.0.0",
     "@solana/web3.js": "^1.91.8"
   },
-  "gitHead": "f4f1b639d0c5d6dbb24b9c5349759c1a802e50bd",
+  "gitHead": "4690c7dc577330b5d317d762972343660111495d",
   "bugs": {
     "url": "https://github.com/ExodusMovement/assets/issues?q=is%3Aissue+is%3Aopen+label%3Asolana-api"
   },

package/src/index.js

@@ -5,7 +5,7 @@ import assetsList from '@exodus/solana-meta'
 import { Api } from './api'
 
 export { default as SolanaFeeMonitor } from './fee-monitor'
-export { SolanaMonitor } from './tx-log'
+export { SolanaMonitor, SolanaAutoWithdrawMonitor } from './tx-log'
 export { createAccountState } from './account-state'
 export { getSolStakedFee, getStakingInfo, getUnstakingFee } from './staking-utils'
 export {

package/src/tx-log/index.js

@@ -1 +1,2 @@
 export * from './solana-monitor'
+export * from './solana-auto-withdraw-monitor'

package/src/tx-log/me-solana-monitor.js

@@ -53,9 +53,9 @@ export class MeSolanaMonitor extends SolanaMonitor {
     return !this.useMeMonitor
   }
 
-  async getTokenAccounts({ address }) {
+  async getAccountsAndBalances({ refresh, address, accountState, walletAccount }) {
     if (!this.useMeMonitor) {
-      return super.getTokenAccounts({ address })
+      return super.getAccountsAndBalances({ refresh, address, accountState, walletAccount })
     }
 
     const tokens = this.getTokens()
@@ -68,75 +68,62 @@ export class MeSolanaMonitor extends SolanaMonitor {
 
     const { balances } = await this.request('v1/wallet/balances/fungible').post(body).json()
     const metadata = new Map()
-    balances.forEach((balance) => {
-      if (balance.asset?.id) {
-        metadata.set(balance.asset.id, { imageURL: balance.image })
+
+    const account = {
+      balance: this.asset.currency.ZERO,
+      tokenBalances: {},
+    }
+    const tokenAccounts = []
+
+    balances.forEach((assetBalance) => {
+      const { asset: assetData, balance } = assetBalance
+      const mintAddress = assetData.mintAddress
+
+      if (assetBalance.asset?.id) {
+        metadata.set(assetBalance.asset.id, { imageURL: assetBalance.image })
       }
-    })
-    this.emit('token-metadata', { source: 'solana', metadata })
 
-    return balances
-      .filter((balance) => balance.asset.mintAddress !== SOL_NATIVE)
-      .map((balance) => {
-        const asset = balance.asset
-        const mintAddress = asset.mintAddress
+      if (mintAddress === SOL_NATIVE) {
+        // SOL balance
+        account.balance = this.asset.currency.baseUnit(balance.rawBalance)
+      } else {
+        // Fungible token balances
         const token = tokens.get(mintAddress) || {
           // name here is the exodus unique identifier not the display name
           name: 'unknown',
-          ticker: asset.symbol,
+          ticker: assetData.symbol,
           decimals: balance.decimals,
         }
 
-        return {
-          tokenAccountAddress: asset.tokenAccount,
-          owner: balance.owner,
+        if (tokens.get(mintAddress)) {
+          const tokenKey = token.name
+          account.tokenBalances[tokenKey] = token.currency.baseUnit(balance.rawBalance)
+        }
+
+        const tokenAccount = {
+          tokenAccountAddress: assetData.tokenAccount,
+          owner: assetBalance.owner,
           tokenName: token.name,
           ticker: token.ticker,
-          balance: balance.balance.rawBalance,
+          balance: assetBalance.balance.rawBalance,
           mintAddress,
-          tokenProgram: asset.tokenProgram,
+          tokenProgram: assetData.tokenProgram,
           decimals: token.decimals,
-          feeBasisPoints: asset.feeBasisPoints ?? 0,
-          maximumFee: asset.maximumFee ?? 0,
+          feeBasisPoints: assetData.feeBasisPoints ?? 0,
+          maximumFee: assetData.maximumFee ?? 0,
         }
-      })
-  }
-
-  async getAccount({ address, staking, tokenAccounts }) {
-    if (!this.useMeMonitor) {
-      return super.getAccount({ address, staking, tokenAccounts })
-    }
-
-    const tokens = this.getTokens()
-    const body = [
-      {
-        address,
-        chain: 'solana',
-      },
-    ]
-
-    const { balances } = await this.request('v1/wallet/balances/fungible').post(body).json()
-
-    const result = {
-      balance: this.asset.currency.ZERO,
-      tokenBalances: {},
-    }
-
-    balances.forEach((balanceData) => {
-      const { asset: responseAsset, balance } = balanceData
-      const mintAddress = responseAsset.mintAddress
-
-      if (mintAddress === SOL_NATIVE) {
-        // SOL balance
-        result.balance = this.asset.currency.baseUnit(balance.rawBalance)
-      } else if (tokens.has(mintAddress)) {
-        // Fungible token balances
-        const token = tokens.get(mintAddress)
-        const tokenKey = token.name
-        result.tokenBalances[tokenKey] = token.currency.baseUnit(balance.rawBalance)
+        tokenAccounts.push(tokenAccount)
       }
     })
+    this.emit('token-metadata', { source: 'solana', metadata })
+
+    const fetchStakingInfo =
+      refresh || this.tickCount[walletAccount] % this.ticksBetweenStakeFetches === 0
+    const staking =
+      this.isStakingEnabled() && fetchStakingInfo
+        ? await this.getStakingInfo({ address, walletAccount })
+        : { ...accountState.mem, staking: this.staking }
 
-    return result
+    return { account, tokenAccounts, staking }
   }
 }

package/src/tx-log/solana-auto-withdraw-monitor.js

@@ -0,0 +1,81 @@
+import { Timer } from '@exodus/timer'
+import { get } from 'lodash'
+import ms from 'ms'
+import assert from 'assert'
+
+const INTERVAL = ms('30s')
+
+export class SolanaAutoWithdrawMonitor {
+  constructor({ interval = INTERVAL, assetClientInterface, createAndSendStake }) {
+    this.assetName = 'solana'
+    this.timer = new Timer(interval)
+    this.aci = assetClientInterface
+    this.createAndSendStake = createAndSendStake
+    assert(typeof createAndSendStake === 'function', 'createAndSendStake is required')
+    this.cursors = {}
+  }
+
+  start = async () => {
+    const assets = await this.aci.getAssetsForNetwork({ baseAssetName: this.assetName })
+    this.asset = assets[this.assetName]
+    await this.timer.start(() => this.tick())
+  }
+
+  async tick() {
+    const walletAccounts = await this.aci.getWalletAccounts({ assetName: this.assetName })
+    await Promise.all(walletAccounts.map((walletAccount) => this._tick({ walletAccount })))
+  }
+
+  async _tick({ walletAccount }) {
+    const accountState = await this.aci.getAccountState({
+      assetName: this.assetName,
+      walletAccount,
+    })
+    const { cursor, mem } = accountState
+    const { loaded, withdrawable } = mem
+
+    if (!Array.isArray(this.cursors[walletAccount])) this.cursors[walletAccount] = []
+    const cursorChanged = !this.cursors[walletAccount].includes(cursor)
+
+    if (loaded && cursorChanged && withdrawable.isPositive) {
+      this.cursors[walletAccount].push(cursor)
+      try {
+        const txIds = await this.tryWithdraw({ accountState, walletAccount })
+        this.cursors[walletAccount].push(...txIds)
+      } catch (e) {
+        console.log('solana auto withdraw error:', e)
+      }
+    }
+  }
+
+  async tryWithdraw({ accountState, walletAccount }) {
+    const stakingInfo = accountState.mem
+    const feeData = await this.aci.getFeeData({ assetName: this.assetName })
+    const fee = get(feeData, 'fee', this.asset.currency.ZERO)
+
+    const solBalance = get(accountState, 'balance', this.asset.currency.ZERO)
+    if (solBalance.lt(fee) || stakingInfo.withdrawable.isZero) return []
+
+    const promises = await this.createAndSendStake(
+      {
+        method: 'withdraw',
+        walletAccount,
+        amount: stakingInfo.withdrawable,
+      },
+      { watchForTxConfirmation: false }
+    )
+
+    return Promise.all(promises)
+  }
+}
+
+/*
+const _solanaAutoWithdrawMonitor = new SolanaAutoWithdrawMonitor({ interval: INTERVAL })
+
+export const solanaAutoWithdrawMonitor = {
+  start:
+    ({ assetClientInterface, createAndSendStake }) =>
+    async () =>
+      _solanaAutoWithdrawMonitor.start({ assetClientInterface, createAndSendStake }),
+}
+*/

package/src/tx-log/solana-monitor.js

@@ -134,14 +134,23 @@ export class SolanaMonitor extends BaseMonitor {
     return clearedLogItems
   }
 
-  async getTokenAccounts({ address }) {
-    return this.api.getTokenAccountsByOwner(address)
-  }
-
   isStakingEnabled() {
     return true
   }
 
+  async getAccountsAndBalances({ refresh, address, accountState, walletAccount }) {
+    const tokenAccounts = await this.api.getTokenAccountsByOwner(address)
+    const { account, staking } = await this.getAccount({
+      refresh,
+      address,
+      tokenAccounts,
+      accountState,
+      walletAccount,
+    })
+
+    return { account, tokenAccounts, staking }
+  }
+
   async tick({ walletAccount, refresh }) {
     // Check for new wallet account
     await this.initWalletAccount({ walletAccount })
@@ -152,17 +161,13 @@ export class SolanaMonitor extends BaseMonitor {
 
     const accountState = await this.aci.getAccountState({ assetName, walletAccount })
     const address = await this.aci.getReceiveAddress({ assetName, walletAccount, useCache: true })
-    const stakingAddresses = await this.getStakingAddressesFromTxLog({ assetName, walletAccount })
-
-    const fetchStakingInfo = this.tickCount[walletAccount] % this.ticksBetweenStakeFetches === 0
-    const staking =
-      this.isStakingEnabled() && fetchStakingInfo
-        ? await this.getStakingInfo({ address, stakingAddresses })
-        : { ...accountState.mem, staking: this.staking }
-
-    const tokenAccounts = await this.getTokenAccounts({ address })
-    const account = await this.getAccount({ address, staking, tokenAccounts })
 
+    const { account, tokenAccounts, staking } = await this.getAccountsAndBalances({
+      refresh,
+      address,
+      accountState,
+      walletAccount,
+    })
     const balanceChanged = this.#balanceChanged({ account: accountState, newAccount: account })
 
     const isHistoryUpdateTick =
@@ -278,13 +283,34 @@ export class SolanaMonitor extends BaseMonitor {
     }
   }
 
-  async getAccount({ address, staking, tokenAccounts }) {
+  async getAccount({ refresh, address, tokenAccounts, accountState, walletAccount }) {
     const tokens = Object.keys(this.assets).filter((name) => name !== this.asset.name)
     const [solBalance, splBalances] = await Promise.all([
       this.api.getBalance(address),
       this.api.getTokensBalance({ address, filterByTokens: tokens, tokenAccounts }),
     ])
 
+    const tokenBalances = _.mapValues(splBalances, (balance, name) =>
+      this.assets[name].currency.baseUnit(balance).toDefault()
+    )
+
+    const solBalanceChanged = this.#balanceChanged({
+      account: accountState,
+      newAccount: {
+        balance: this.asset.currency.baseUnit(solBalance), // balance without staking
+        tokenBalances,
+      },
+    })
+    const fetchStakingInfo =
+      refresh ||
+      solBalanceChanged ||
+      this.tickCount[walletAccount] % this.ticksBetweenStakeFetches === 0
+
+    const staking =
+      this.isStakingEnabled() && fetchStakingInfo
+        ? await this.getStakingInfo({ address, walletAccount })
+        : { ...accountState.mem, staking: this.staking }
+
     const stakedBalance = this.asset.currency.baseUnit(staking.locked)
     const withdrawableBalance = this.asset.currency.baseUnit(staking.withdrawable)
     const pendingBalance = this.asset.currency.baseUnit(staking.pending)
@@ -295,13 +321,12 @@ export class SolanaMonitor extends BaseMonitor {
       .add(pendingBalance)
       .toDefault()
 
-    const tokenBalances = _.mapValues(splBalances, (balance, name) =>
-      this.assets[name].currency.baseUnit(balance).toDefault()
-    )
-
     return {
-      balance,
-      tokenBalances,
+      account: {
+        balance,
+        tokenBalances,
+      },
+      staking,
     }
   }
 
@@ -311,8 +336,12 @@ export class SolanaMonitor extends BaseMonitor {
     return this.updateAccountState({ newData, walletAccount })
   }
 
-  async getStakingInfo({ address, stakingAddresses = [] }) {
+  async getStakingInfo({ address, walletAccount }) {
     const stakingInfo = await this.api.getStakeAccountsInfo(address)
+    const stakingAddresses = await this.getStakingAddressesFromTxLog({
+      assetName: this.asset.name,
+      walletAccount,
+    })
     // merge current and old staking addresses
     const allStakingAddresses = _.uniq([...Object.keys(stakingInfo.accounts), ...stakingAddresses])
     const rewards = await this.api.getRewards(allStakingAddresses)