@eth-optimism/actions-sdk 0.4.0 → 0.6.0

package/src/{lend → actions/lend}/namespaces/WalletLendNamespace.ts

@@ -1,4 +1,6 @@
+import { BaseLendNamespace } from '@/actions/lend/namespaces/BaseLendNamespace.js'
 import type { SupportedChainId } from '@/constants/supportedChains.js'
+import { MarketIdRequiredError } from '@/core/error/errors.js'
 import type {
   ClosePositionParams,
   GetPositionParams,
@@ -7,10 +9,10 @@ import type {
   LendTransaction,
   LendTransactionReceipt,
 } from '@/types/lend/index.js'
+import type { LendProviders } from '@/types/providers.js'
+import { executeTransactionBatch } from '@/wallet/core/utils/executeTransactionBatch.js'
 import type { Wallet } from '@/wallet/core/wallets/abstract/Wallet.js'
 
-import { BaseLendNamespace, type LendProviders } from './BaseLendNamespace.js'
-
 /**
  * Wallet Lend Namespace
  * @description Full lending operations available on wallet.lend
@@ -27,8 +29,6 @@ export class WalletLendNamespace extends BaseLendNamespace {
    * Open a lending position
    * @description Signs and sends a lend transaction from the wallet for the given amount and asset
    * @param params - Lending position parameters
-   * @param params.marketId - Market identifier to open position in
-   * @param params.amount - Amount to lend
    * @returns Promise resolving to transaction receipt
    */
   async openPosition(
@@ -41,19 +41,17 @@ export class WalletLendNamespace extends BaseLendNamespace {
       walletAddress: this.wallet.address,
     })
 
-    return this.executeTransaction(lendTransaction, params.marketId.chainId)
+    return this.dispatch(lendTransaction, params.marketId.chainId)
   }
 
   /**
    * Get position information for this wallet
    * @param params - Position query parameters
-   * @param params.marketId - Market identifier (required)
-   * @param params.asset - Asset filter (not yet supported)
    * @returns Promise resolving to position information
    */
   async getPosition(params: GetPositionParams): Promise<LendMarketPosition> {
     if (!params.marketId) {
-      throw new Error('marketId is required')
+      throw new MarketIdRequiredError()
     }
 
     const provider = this.getProviderForMarket(params.marketId)
@@ -68,8 +66,6 @@ export class WalletLendNamespace extends BaseLendNamespace {
   /**
    * Close a lending position (withdraw from market)
    * @param params - Position closing parameters
-   * @param params.marketId - Market identifier to close position in
-   * @param params.amount - Amount to withdraw
    * @returns Promise resolving to transaction receipt
    */
   async closePosition(
@@ -82,25 +78,22 @@ export class WalletLendNamespace extends BaseLendNamespace {
       walletAddress: this.wallet.address,
     })
 
-    return this.executeTransaction(closeTransaction, params.marketId.chainId)
+    return this.dispatch(closeTransaction, params.marketId.chainId)
   }
 
   /**
-   * Execute a lend transaction with optional approval batching
+   * Send a lend transaction, batching an ERC-20 approval ahead of the
+   * position call when one was provided by the provider. Defers to
+   * `executeTransactionBatch` for the actual 1-vs-N send/sendBatch dispatch.
    */
-  private async executeTransaction(
+  private dispatch(
     transaction: LendTransaction,
     chainId: SupportedChainId,
   ): Promise<LendTransactionReceipt> {
     const { transactionData } = transaction
-
-    if (transactionData.approval) {
-      return this.wallet.sendBatch(
-        [transactionData.approval, transactionData.position],
-        chainId,
-      )
-    }
-
-    return this.wallet.send(transactionData.position, chainId)
+    const txs = transactionData.approval
+      ? [transactionData.approval, transactionData.position]
+      : [transactionData.position]
+    return executeTransactionBatch(this.wallet, txs, chainId)
   }
 }

package/src/{lend → actions/lend}/namespaces/__tests__/ActionsLendNamespace.spec.ts

@@ -2,9 +2,9 @@ import type { Address } from 'viem'
 import { beforeEach, describe, expect, it, vi } from 'vitest'
 
 import { getRandomAddress } from '@/__mocks__/utils.js'
-import type { MockLendProvider } from '@/lend/__mocks__/MockLendProvider.js'
-import { createMockLendProvider } from '@/lend/__mocks__/MockLendProvider.js'
-import { ActionsLendNamespace } from '@/lend/namespaces/ActionsLendNamespace.js'
+import type { MockLendProvider } from '@/actions/lend/__mocks__/MockLendProvider.js'
+import { createMockLendProvider } from '@/actions/lend/__mocks__/MockLendProvider.js'
+import { ActionsLendNamespace } from '@/actions/lend/namespaces/ActionsLendNamespace.js'
 
 describe('ActionsLendNamespace', () => {
   let mockProvider: MockLendProvider

package/src/{lend → actions/lend}/namespaces/__tests__/BaseLendNamespace.spec.ts

@@ -2,12 +2,12 @@ import type { Address } from 'viem'
 import { beforeEach, describe, expect, it, vi } from 'vitest'
 
 import { getRandomAddress } from '@/__mocks__/utils.js'
-import type { MockLendProvider } from '@/lend/__mocks__/MockLendProvider.js'
+import type { MockLendProvider } from '@/actions/lend/__mocks__/MockLendProvider.js'
 import {
   createMockLendProvider,
   MockLendProvider as MockLendProviderClass,
-} from '@/lend/__mocks__/MockLendProvider.js'
-import { BaseLendNamespace } from '@/lend/namespaces/BaseLendNamespace.js'
+} from '@/actions/lend/__mocks__/MockLendProvider.js'
+import { BaseLendNamespace } from '@/actions/lend/namespaces/BaseLendNamespace.js'
 import { MockChainManager } from '@/services/__mocks__/MockChainManager.js'
 import type { ChainManager } from '@/services/ChainManager.js'
 

package/src/{lend → actions/lend}/namespaces/__tests__/WalletLendNamespace.spec.ts

@@ -3,9 +3,9 @@ import type { WaitForUserOperationReceiptReturnType } from 'viem/account-abstrac
 import { beforeEach, describe, expect, it, vi } from 'vitest'
 
 import { getRandomAddress } from '@/__mocks__/utils.js'
-import type { MockLendProvider } from '@/lend/__mocks__/MockLendProvider.js'
-import { createMockLendProvider } from '@/lend/__mocks__/MockLendProvider.js'
-import { WalletLendNamespace } from '@/lend/namespaces/WalletLendNamespace.js'
+import type { MockLendProvider } from '@/actions/lend/__mocks__/MockLendProvider.js'
+import { createMockLendProvider } from '@/actions/lend/__mocks__/MockLendProvider.js'
+import { WalletLendNamespace } from '@/actions/lend/namespaces/WalletLendNamespace.js'
 import type { TransactionData } from '@/types/lend/index.js'
 import { createMock as createSmartWalletMock } from '@/wallet/core/wallets/smart/abstract/__mocks__/SmartWallet.js'
 import type { SmartWallet } from '@/wallet/core/wallets/smart/abstract/SmartWallet.js'
@@ -121,7 +121,7 @@ describe('WalletLendNamespace', () => {
       const marketId = mockMarketId
       const mockTransaction = {
         amount: 1000000000n,
-        asset: mockAsset.address[130],
+        assetAddress: mockAsset.address[130] as Address,
         marketId: marketId.address,
         apy: 0.05,
         transactionData: {
@@ -169,7 +169,7 @@ describe('WalletLendNamespace', () => {
 
       const mockTransaction = {
         amount: 100n,
-        asset: getRandomAddress(),
+        assetAddress: getRandomAddress(),
         marketId: closeParams.marketId.address,
         apy: 0.05,
         transactionData: {
@@ -234,7 +234,7 @@ describe('WalletLendNamespace', () => {
     }
     const mockTransaction = {
       amount: 1000000000n,
-      asset: mockAsset.address[130],
+      assetAddress: mockAsset.address[130] as Address,
       marketId: marketId.address,
       apy: 0.05,
       timestamp: Date.now(),

package/src/{lend → actions/lend}/providers/aave/AaveLendProvider.ts

@@ -1,10 +1,11 @@
 import type { Address } from 'viem'
 import { encodeFunctionData, erc20Abi, formatUnits } from 'viem'
 
+import { LendProvider } from '@/actions/lend/core/LendProvider.js'
 import { WETH } from '@/constants/assets.js'
-import { LendProvider } from '@/lend/core/LendProvider.js'
+import { ChainNotSupportedError } from '@/core/error/errors.js'
 import type { ChainManager } from '@/services/ChainManager.js'
-import type { LendProviderConfig } from '@/types/actions.js'
+import type { LendProviderConfig, LendSettings } from '@/types/actions.js'
 import type {
   GetLendMarketsParams,
   GetMarketBalanceParams,
@@ -12,6 +13,7 @@ import type {
   LendMarket,
   LendMarketId,
   LendMarketPosition,
+  LendOpenPosition,
   LendOpenPositionInternalParams,
   LendTransaction,
 } from '@/types/lend/index.js'
@@ -30,35 +32,38 @@ import { getATokenAddress, getReserve, getReserves } from './sdk.js'
  * @description Lending provider implementation using Aave V3 protocol
  */
 export class AaveLendProvider extends LendProvider<LendProviderConfig> {
-  protocolSupportedChainIds(): number[] {
-    return getSupportedChainIds()
+  constructor(
+    config: LendProviderConfig,
+    chainManager: ChainManager,
+    settings?: LendSettings,
+  ) {
+    super(config, chainManager, settings)
   }
 
-  /**
-   * Create a new Aave lending provider
-   * @param config - Aave lending configuration
-   * @param chainManager - Chain manager for blockchain interactions
-   */
-  constructor(config: LendProviderConfig, chainManager: ChainManager) {
-    super(config, chainManager)
+  protocolSupportedChainIds(): number[] {
+    return getSupportedChainIds()
   }
 
   /**
-   * Open a lending position in an Aave market
-   * @description Opens a lending position by supplying assets to an Aave reserve
-   * @param params - Position opening parameters
-   * @returns Promise resolving to lending transaction details
+   * Describe an Aave deposit. The base class wraps this into a
+   * `LendTransaction` with the appropriate ERC-20 approval based on
+   * `params.approvalMode`. Native-ETH paths return `spender: undefined` since
+   * deposits via the WETHGateway send value as `msg.value` rather than via
+   * `transferFrom`.
+   * @param params - Position opening parameters (amount in wei, walletAddress, approvalMode)
+   * @returns Spender + deposit calldata + APY snapshot
    */
   protected async _openPosition(
     params: LendOpenPositionInternalParams,
-  ): Promise<LendTransaction> {
+  ): Promise<LendOpenPosition> {
     try {
       // Get Pool address for this chain
       const poolAddress = getPoolAddress(params.marketId.chainId)
       if (!poolAddress) {
-        throw new Error(
-          `Aave V3 not deployed on chain ${params.marketId.chainId}`,
-        )
+        throw new ChainNotSupportedError({
+          chainId: params.marketId.chainId,
+          supportedChainIds: this.supportedChainIds(),
+        })
       }
 
       // Get market information for APY
@@ -67,13 +72,10 @@ export class AaveLendProvider extends LendProvider<LendProviderConfig> {
         chainId: params.marketId.chainId,
       })
 
-      // Check if this is a native ETH market
       if (isNativeAsset(params.asset)) {
-        return this._openETHPosition(params, poolAddress, marketInfo)
+        return this._buildETHOpenPosition(params, poolAddress, marketInfo)
       }
-
-      // Standard ERC-20 flow
-      return this._openERC20Position(params, poolAddress, marketInfo)
+      return this._buildERC20OpenPosition(params, poolAddress, marketInfo)
     } catch {
       throw new Error(
         `Failed to open position with ${params.amountWei} of ${params.asset.metadata.symbol}`,
@@ -94,9 +96,10 @@ export class AaveLendProvider extends LendProvider<LendProviderConfig> {
       // Get Pool address for this chain
       const poolAddress = getPoolAddress(params.marketId.chainId)
       if (!poolAddress) {
-        throw new Error(
-          `Aave V3 not deployed on chain ${params.marketId.chainId}`,
-        )
+        throw new ChainNotSupportedError({
+          chainId: params.marketId.chainId,
+          supportedChainIds: this.supportedChainIds(),
+        })
       }
 
       const marketInfo = await this.getMarket({
@@ -162,9 +165,10 @@ export class AaveLendProvider extends LendProvider<LendProviderConfig> {
       const poolAddress = getPoolAddress(params.marketId.chainId)
 
       if (!poolAddress) {
-        throw new Error(
-          `Aave V3 not deployed on chain ${params.marketId.chainId}`,
-        )
+        throw new ChainNotSupportedError({
+          chainId: params.marketId.chainId,
+          supportedChainIds: this.supportedChainIds(),
+        })
       }
 
       // Get the aToken address from Pool.getReserveData
@@ -206,22 +210,22 @@ export class AaveLendProvider extends LendProvider<LendProviderConfig> {
   }
 
   /**
-   * Open position for native ETH using WETHGateway
-   * @description Deposits native ETH via WETHGateway which wraps and deposits in one tx
+   * Describe a native-ETH deposit via Aave's WETHGateway. ETH is sent as
+   * `msg.value` and wrapped to aWETH inline — no ERC-20 approval needed.
    */
-  private async _openETHPosition(
+  private async _buildETHOpenPosition(
     params: LendOpenPositionInternalParams,
     poolAddress: Address,
     marketInfo: LendMarket,
-  ): Promise<LendTransaction> {
+  ): Promise<LendOpenPosition> {
     const gatewayAddress = getWETHGatewayAddress(params.marketId.chainId)
     if (!gatewayAddress) {
-      throw new Error(
-        `WETHGateway not available on chain ${params.marketId.chainId}`,
-      )
+      throw new ChainNotSupportedError({
+        chainId: params.marketId.chainId,
+        supportedChainIds: this.supportedChainIds(),
+      })
     }
 
-    // Generate depositETH transaction
     const depositCallData = encodeFunctionData({
       abi: WETH_GATEWAY_ABI,
       functionName: 'depositETH',
@@ -235,33 +239,28 @@ export class AaveLendProvider extends LendProvider<LendProviderConfig> {
     const wethAddress = getAssetAddress(WETH, params.marketId.chainId)
 
     return {
-      amount: params.amountWei,
-      asset: wethAddress,
-      marketId: params.marketId.address,
-      apy: marketInfo.apy.total,
-      transactionData: {
-        position: {
-          to: gatewayAddress,
-          data: depositCallData,
-          value: params.amountWei, // Send ETH as msg.value
-        },
+      assetAddress: wethAddress,
+      transaction: {
+        to: gatewayAddress,
+        data: depositCallData,
+        value: params.amountWei, // Send ETH as msg.value
       },
+      apy: marketInfo.apy.total,
     }
   }
 
   /**
-   * Open position for standard ERC-20 tokens
-   * @description Standard approve + supply flow for non-WETH assets
+   * Describe a standard ERC-20 deposit. The base class builds the approval to
+   * `poolAddress` based on `params.approvalMode`.
    */
-  private async _openERC20Position(
+  private async _buildERC20OpenPosition(
     params: LendOpenPositionInternalParams,
     poolAddress: Address,
     marketInfo: LendMarket,
-  ): Promise<LendTransaction> {
+  ): Promise<LendOpenPosition> {
     // Get asset address for the chain (throws for native assets)
     const assetAddress = getAssetAddress(params.asset, params.marketId.chainId)
 
-    // Generate supply transaction
     const supplyCallData = encodeFunctionData({
       abi: POOL_ABI,
       functionName: 'supply',
@@ -274,22 +273,14 @@ export class AaveLendProvider extends LendProvider<LendProviderConfig> {
     })
 
     return {
-      amount: params.amountWei,
-      asset: assetAddress,
-      marketId: params.marketId.address,
-      apy: marketInfo.apy.total,
-      transactionData: {
-        approval: this.buildApprovalTx(
-          assetAddress,
-          poolAddress,
-          params.amountWei,
-        ),
-        position: {
-          to: poolAddress,
-          data: supplyCallData,
-          value: 0n,
-        },
+      spender: poolAddress,
+      assetAddress,
+      transaction: {
+        to: poolAddress,
+        data: supplyCallData,
+        value: 0n,
       },
+      apy: marketInfo.apy.total,
     }
   }
 
@@ -304,9 +295,10 @@ export class AaveLendProvider extends LendProvider<LendProviderConfig> {
   ): Promise<LendTransaction> {
     const gatewayAddress = getWETHGatewayAddress(params.marketId.chainId)
     if (!gatewayAddress) {
-      throw new Error(
-        `WETHGateway not available on chain ${params.marketId.chainId}`,
-      )
+      throw new ChainNotSupportedError({
+        chainId: params.marketId.chainId,
+        supportedChainIds: this.supportedChainIds(),
+      })
     }
 
     const wethAddress = getAssetAddress(WETH, params.marketId.chainId)
@@ -331,7 +323,7 @@ export class AaveLendProvider extends LendProvider<LendProviderConfig> {
 
     return {
       amount: params.amount,
-      asset: wethAddress,
+      assetAddress: wethAddress,
       marketId: params.marketId.address,
       apy: marketInfo.apy.total,
       transactionData: {
@@ -376,7 +368,7 @@ export class AaveLendProvider extends LendProvider<LendProviderConfig> {
 
     return {
       amount: params.amount,
-      asset: assetAddress,
+      assetAddress,
       marketId: params.marketId.address,
       apy: marketInfo.apy.total,
       transactionData: {

package/src/{lend → actions/lend}/providers/aave/__tests__/AaveLendProvider.test.ts

@@ -1,19 +1,19 @@
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 
-import { MockReceiverAddress } from '@/lend/__mocks__/MockMarkets.js'
+import { MockReceiverAddress } from '@/actions/lend/__mocks__/MockMarkets.js'
 import {
   createMockAaveReserve,
   createMockWETHReserve,
-} from '@/lend/providers/aave/__mocks__/mockReserve.js'
-import { AaveLendProvider } from '@/lend/providers/aave/AaveLendProvider.js'
-import * as aaveSdk from '@/lend/providers/aave/sdk.js'
+} from '@/actions/lend/providers/aave/__mocks__/mockReserve.js'
+import { AaveLendProvider } from '@/actions/lend/providers/aave/AaveLendProvider.js'
+import * as aaveSdk from '@/actions/lend/providers/aave/sdk.js'
 import { MockChainManager } from '@/services/__mocks__/MockChainManager.js'
 import type { ChainManager } from '@/services/ChainManager.js'
 import type { LendProviderConfig } from '@/types/actions.js'
 import type { Asset, LendMarketConfig } from '@/types/index.js'
 
 // Mock the Aave SDK modules
-vi.mock('@/lend/providers/aave/sdk.js', () => ({
+vi.mock('@/actions/lend/providers/aave/sdk.js', () => ({
   getReserve: vi.fn(),
   getReserves: vi.fn(),
   getATokenAddress: vi.fn(),
@@ -139,7 +139,7 @@ describe('AaveLendProvider', () => {
 
       expect(lendTransaction).toHaveProperty('amount', BigInt('1000000000'))
       expect(lendTransaction).toHaveProperty(
-        'asset',
+        'assetAddress',
         asset.address[marketId.chainId],
       )
       expect(lendTransaction).toHaveProperty('marketId', marketId.address)
@@ -228,7 +228,7 @@ describe('AaveLendProvider', () => {
 
       expect(withdrawTransaction).toHaveProperty('amount', BigInt('500000000'))
       expect(withdrawTransaction).toHaveProperty(
-        'asset',
+        'assetAddress',
         asset.address[marketId.chainId],
       )
       expect(withdrawTransaction).toHaveProperty('marketId', marketId.address)

package/src/{lend → actions/lend}/providers/aave/sdk.ts

@@ -3,13 +3,17 @@ import { formatReserves } from '@aave/math-utils'
 import { providers } from 'ethers'
 import type { Address } from 'viem'
 
-import { WETH } from '@/constants/assets.js'
-import type { SupportedChainId } from '@/constants/supportedChains.js'
-import { POOL_GET_RESERVE_DATA_ABI } from '@/lend/providers/aave/abis/pool.js'
+import { POOL_GET_RESERVE_DATA_ABI } from '@/actions/lend/providers/aave/abis/pool.js'
 import {
   getAaveAddresses,
   getPoolAddress,
-} from '@/lend/providers/aave/addresses.js'
+} from '@/actions/lend/providers/aave/addresses.js'
+import { WETH } from '@/constants/assets.js'
+import type { SupportedChainId } from '@/constants/supportedChains.js'
+import {
+  ChainNotSupportedError,
+  MarketNotAllowedError,
+} from '@/core/error/errors.js'
 import type { ChainManager } from '@/services/ChainManager.js'
 import type { LendProviderConfig } from '@/types/actions.js'
 import type {
@@ -95,14 +99,16 @@ export async function getReserve(
     : undefined
 
   if (!marketConfig) {
-    throw new Error(
-      `Market ${params.marketId.address} on chain ${params.marketId.chainId} not found in allowlist`,
-    )
+    throw new MarketNotAllowedError({
+      address: params.marketId.address,
+      chainId: params.marketId.chainId,
+      reason: 'Market not found in allowlist',
+    })
   }
 
   const addresses = getAaveAddresses(params.marketId.chainId)
   if (!addresses) {
-    throw new Error(`Aave V3 not deployed on chain ${params.marketId.chainId}`)
+    throw new ChainNotSupportedError({ chainId: params.marketId.chainId })
   }
 
   const poolAddress = addresses.pool
@@ -244,7 +250,7 @@ export async function getATokenAddress(params: {
 }): Promise<Address> {
   const poolAddress = getPoolAddress(params.chainId)
   if (!poolAddress) {
-    throw new Error(`Aave V3 not deployed on chain ${params.chainId}`)
+    throw new ChainNotSupportedError({ chainId: params.chainId })
   }
 
   try {