@exodus/solana-api 3.14.6 → 3.15.0

package/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.15.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-api@3.14.7...@exodus/solana-api@3.15.0) (2025-04-03)
+
+
+### Features
+
+
+* feat(solana): add optional addExternalFeePayerToTransaction (#5345)
+
+
+
+## [3.14.7](https://github.com/ExodusMovement/assets/compare/@exodus/solana-api@3.14.6...@exodus/solana-api@3.14.7) (2025-04-03)
+
+**Note:** Version bump only for package @exodus/solana-api
+
+
+
+
+
 ## [3.14.6](https://github.com/ExodusMovement/assets/compare/@exodus/solana-api@3.14.5...@exodus/solana-api@3.14.6) (2025-04-01)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/solana-api",
-  "version": "3.14.6",
+  "version": "3.15.0",
   "description": "Transaction monitors, fee monitors, RPC with the blockchain node, and other networking code for Solana",
   "type": "module",
   "main": "src/index.js",
@@ -30,7 +30,7 @@
     "@exodus/fetch": "^1.7.3",
     "@exodus/models": "^12.0.1",
     "@exodus/simple-retry": "^0.0.6",
-    "@exodus/solana-lib": "^3.9.4",
+    "@exodus/solana-lib": "^3.10.0",
     "@exodus/solana-meta": "^2.0.2",
     "@exodus/timer": "^1.1.1",
     "bn.js": "^4.11.0",
@@ -46,7 +46,7 @@
     "@exodus/assets-testing": "^1.0.0",
     "@exodus/solana-web3.js": "^1.63.1-exodus.9-rc3"
   },
-  "gitHead": "310d0d34a574d1da978f862e42c481de1e57bade",
+  "gitHead": "59c4d4a4a7404eb915e4fa722a2afe01d1556046",
   "bugs": {
     "url": "https://github.com/ExodusMovement/assets/issues?q=is%3Aissue+is%3Aopen+label%3Asolana-api"
   },

package/src/create-unsigned-tx-for-send.js

@@ -1,9 +1,12 @@
 import {
   createUnsignedTx,
+  deserializeTransaction,
   findAssociatedTokenAddress,
+  parseTxBuffer,
   prepareForSigning,
   TOKEN_2022_PROGRAM_ID,
   TOKEN_PROGRAM_ID,
+  verifyOnlyFeePayerChanged,
 } from '@exodus/solana-lib'
 
 const CU_FOR_COMPUTE_BUDGET_INSTRUCTIONS = 300
@@ -18,6 +21,8 @@ export const createUnsignedTxForSend = async ({
   reference,
   memo,
   nft,
+  feePayerApiUrl,
+  useFeePayer = true,
   // token related
   tokenStandard,
   customMintAddress,
@@ -142,6 +147,7 @@ export const createUnsignedTxForSend = async ({
     recentBlockhash,
     reference,
     memo,
+    useFeePayer,
     ...tokenParams,
     ...stakingParams,
     ...magicEdenParams,
@@ -205,5 +211,72 @@ export const createUnsignedTxForSend = async ({
     throw err
   }
 
-  return unsignedTx
+  return maybeAddFeePayer({
+    unsignedTx,
+    feePayerApiUrl,
+    assetName: asset.name,
+    useFeePayer,
+  })
+}
+
+export const extractTxLogData = async ({ unsignedTx, api }) => {
+  if (!unsignedTx.txData.transactionBuffer)
+    return {
+      method: unsignedTx.txData.method,
+      from: unsignedTx.txData.from,
+      to: unsignedTx.txData.to,
+      amount: unsignedTx.txData.amount,
+      stakingParams: unsignedTx.txMeta.stakingParams,
+      usedFeePayer: unsignedTx.txMeta.usedFeePayer,
+      fee: unsignedTx.txMeta.fee,
+    }
+
+  const txData = await parseTxBuffer(unsignedTx.txData.transactionBuffer, api)
+  return {
+    ...txData,
+    stakingParams: unsignedTx.txMeta.stakingParams,
+    usedFeePayer: unsignedTx.txMeta.usedFeePayer,
+    fee: unsignedTx.txMeta.fee,
+  }
+}
+
+export const maybeAddFeePayer = async ({ unsignedTx, feePayerApiUrl, assetName }) => {
+  let unsignedTxWithFeePayer = unsignedTx
+  let newFeePayer = false
+  if (feePayerApiUrl && unsignedTx.txMeta.useFeePayer !== false) {
+    try {
+      const unsignedTxVersionedTransaction = prepareForSigning(unsignedTx)
+
+      const newTransactionResponse = await fetch(new URL(feePayerApiUrl).toString(), {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({
+          assetName,
+          transaction: Buffer.from(unsignedTxVersionedTransaction.serialize()).toString('base64'),
+        }),
+      })
+      const { transaction: newTransactionString } = await newTransactionResponse.json()
+
+      const newTransactionBuffer = Buffer.from(newTransactionString, 'base64')
+      const newTransaction = deserializeTransaction(newTransactionBuffer)
+
+      verifyOnlyFeePayerChanged(unsignedTxVersionedTransaction, newTransaction)
+
+      unsignedTxWithFeePayer = {
+        txData: {
+          transactionBuffer: newTransactionBuffer,
+        },
+        txMeta: unsignedTx.txMeta,
+      }
+      newFeePayer = true
+    } catch (err) {
+      console.log('error adding a new fee payer, sending original transaction', err)
+    }
+  }
+
+  unsignedTxWithFeePayer.txMeta.usedFeePayer = newFeePayer
+
+  return unsignedTxWithFeePayer
 }

package/src/get-fees.js

@@ -13,6 +13,7 @@ export const getFeeAsyncFactory = ({ api }) => {
         api,
         amount: amount ?? asset.currency.baseUnit(1),
         toAddress: toAddress ?? rest.fromAddress,
+        useFeePayer: false,
         ...rest,
       }))
 

package/src/index.js

@@ -4,7 +4,7 @@ import assetsList from '@exodus/solana-meta'
 
 import { Api } from './api.js'
 
-export { SolanaMonitor, SolanaAutoWithdrawMonitor } from './tx-log/index.js'
+export { SolanaMonitor } from './tx-log/index.js'
 export { createAccountState } from './account-state.js'
 export { getSolStakedFee, getStakingInfo, getUnstakingFee } from './staking-utils.js'
 export {

package/src/tx-log/index.js

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

package/src/tx-send.js

@@ -1,9 +1,9 @@
 import assert from 'minimalistic-assert'
 
-import { createUnsignedTxForSend } from './create-unsigned-tx-for-send.js'
+import { createUnsignedTxForSend, extractTxLogData } from './create-unsigned-tx-for-send.js'
 
 export const createAndBroadcastTXFactory =
-  ({ api, assetClientInterface }) =>
+  ({ api, assetClientInterface, feePayerApiUrl }) =>
   async ({ asset, walletAccount, unsignedTx: predefinedUnsignedTx, ...legacyParams }) => {
     const assetName = asset.name
     assert(assetClientInterface, `assetClientInterface must be supplied in sendTx for ${assetName}`)
@@ -15,6 +15,7 @@ export const createAndBroadcastTXFactory =
         return predefinedUnsignedTx
       }
 
+      // handle legacy mode
       const feeData = await assetClientInterface.getFeeData({ assetName })
       const fromAddress = await assetClientInterface.getReceiveAddress({
         assetName: baseAsset.name,
@@ -26,6 +27,7 @@ export const createAndBroadcastTXFactory =
         asset,
         feeData,
         fromAddress,
+        feePayerApiUrl,
         amount: legacyParams.amount,
         toAddress: legacyParams.address,
         ...legacyParams.options,
@@ -48,12 +50,16 @@ export const createAndBroadcastTXFactory =
 
     try {
       // collecting data from unsignedTx, it should be sufficient
-      const method = unsignedTx.txData.method
-      const fromAddress = unsignedTx.txData.from
-      const toAddress = unsignedTx.txData.to
+      const txLogData = await extractTxLogData({ unsignedTx, api })
+
+      const method = txLogData.method
+      const fromAddress = txLogData.from
+      const toAddress = txLogData.to
       const selfSend = fromAddress === toAddress
-      const amount = asset.currency.baseUnit(unsignedTx.txData.amount)
-      const feeAmount = asset.feeAsset.currency.baseUnit(unsignedTx.txMeta.fee)
+      const amount = asset.currency.baseUnit(txLogData.amount)
+      const feeAmount = txLogData.usedFeePayer
+        ? asset.feeAsset.currency.ZERO
+        : asset.feeAsset.currency.baseUnit(txLogData.fee)
 
       const isStakingTx = ['delegate', 'undelegate', 'withdraw'].includes(method)
       const coinAmount =
@@ -62,7 +68,10 @@ export const createAndBroadcastTXFactory =
 
       let data
       if (isStakingTx) {
-        data = { ...unsignedTx?.txMeta.stakingParams, stake: coinAmount.toBaseNumber() }
+        data = {
+          ...txLogData.stakingParams,
+          stake: coinAmount.toBaseNumber(),
+        }
       } else {
         data = Object.create(null)
       }
@@ -77,9 +86,16 @@ export const createAndBroadcastTXFactory =
         selfSend,
         to: toAddress,
         data,
-        currencies: { [assetName]: asset.currency, [asset.feeAsset.name]: asset.feeAsset.currency },
+        currencies: {
+          [assetName]: asset.currency,
+          [asset.feeAsset.name]: asset.feeAsset.currency,
+        },
       }
-      await assetClientInterface.updateTxLogAndNotify({ assetName, walletAccount, txs: [tx] })
+      await assetClientInterface.updateTxLogAndNotify({
+        assetName,
+        walletAccount,
+        txs: [tx],
+      })
 
       if (isToken) {
         // write tx entry in solana for token fee

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

@@ -1,90 +0,0 @@
-import { Timer } from '@exodus/timer'
-import assert from 'minimalistic-assert'
-import ms from 'ms'
-
-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 })
-    for (const walletAccount of walletAccounts) {
-      await this._tick({ walletAccount })
-    }
-  }
-
-  async _tick({ walletAccount }) {
-    this.processing = this.processing || new Set()
-    if (this.processing.has(walletAccount)) return
-    this.processing.add(walletAccount)
-
-    try {
-      const accountState = await this.aci.getAccountState({
-        assetName: this.assetName,
-        walletAccount,
-      })
-      const { cursor, stakingInfo } = accountState
-      const { loaded, withdrawable } = stakingInfo
-
-      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)
-        }
-      }
-    } finally {
-      this.processing.delete(walletAccount)
-    }
-  }
-
-  async tryWithdraw({ accountState, walletAccount }) {
-    const stakingInfo = accountState.stakingInfo
-    const feeData = await this.aci.getFeeData({ assetName: this.assetName })
-    const fee = feeData?.fee ?? this.asset.currency.ZERO
-
-    const solBalance = 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 }),
-}
-*/