@eth-optimism/actions-sdk 0.3.0 → 0.5.0

package/src/lend/core/LendProvider.ts

@@ -1,7 +1,8 @@
 import type { Address } from 'viem'
-import { encodeFunctionData, erc20Abi, parseUnits } from 'viem'
+import { parseUnits } from 'viem'
 
 import type { SupportedChainId } from '@/constants/supportedChains.js'
+import { ACTIONS_SUPPORTED_CHAIN_IDS } from '@/constants/supportedChains.js'
 import type { ChainManager } from '@/services/ChainManager.js'
 import type { LendProviderConfig } from '@/types/actions.js'
 import type { Asset } from '@/types/asset.js'
@@ -20,6 +21,7 @@ import type {
   LendTransaction,
   TransactionData,
 } from '@/types/lend/index.js'
+import { buildErc20ApprovalTx } from '@/utils/approve.js'
 import { validateMarketAsset } from '@/utils/markets.js'
 import { validateChainSupported } from '@/utils/validation.js'
 
@@ -36,12 +38,6 @@ export abstract class LendProvider<
   /** Chain manager for blockchain interactions */
   protected readonly chainManager: ChainManager
 
-  /**
-   * Supported chain IDs
-   * @description Array of chain IDs that this provider supports
-   */
-  protected abstract readonly SUPPORTED_CHAIN_IDS: readonly number[]
-
   /**
    * Create a new lending provider
    * @param config - Provider-specific lending configuration
@@ -57,12 +53,27 @@ export abstract class LendProvider<
   }
 
   /**
-   * Get supported chain IDs
-   * @description Returns an array of chain IDs that this provider supports
-   * @returns Array of supported chain IDs
+   * Chain IDs supported by the underlying protocol.
+   * @description Each provider implements this to declare the chains its protocol
+   * is deployed on, without any SDK-level or developer-config filtering.
+   * @returns Array of chain IDs the protocol natively supports
+   */
+  abstract protocolSupportedChainIds(): number[]
+
+  /**
+   * Effective supported chain IDs.
+   * @description Intersection of the protocol's supported chains,
+   * the Actions SDK's known chains, and the developer's ActionsConfig.chains.
+   * All validation in public methods uses this set.
+   * @returns Array of chain IDs usable through this provider instance
    */
   supportedChainIds(): number[] {
-    return [...this.SUPPORTED_CHAIN_IDS]
+    const configuredChains = this.chainManager.getSupportedChains()
+    return this.protocolSupportedChainIds().filter(
+      (id) =>
+        (ACTIONS_SUPPORTED_CHAIN_IDS as readonly number[]).includes(id) &&
+        (configuredChains as number[]).includes(id),
+    )
   }
 
   /**
@@ -78,7 +89,6 @@ export abstract class LendProvider<
       throw new Error('walletAddress is required')
     }
 
-    validateChainSupported(params.marketId.chainId, this.SUPPORTED_CHAIN_IDS)
     this.validateConfigSupported(params.marketId)
 
     // Convert human-readable amount to wei using the asset's decimals
@@ -106,7 +116,6 @@ export abstract class LendProvider<
       chainId: params.chainId,
     }
 
-    validateChainSupported(params.chainId, this.SUPPORTED_CHAIN_IDS)
     this.validateConfigSupported(marketId)
     return this._getMarket(marketId)
   }
@@ -118,7 +127,7 @@ export abstract class LendProvider<
    */
   async getMarkets(params: GetLendMarketsParams = {}): Promise<LendMarket[]> {
     if (params.chainId !== undefined)
-      validateChainSupported(params.chainId, this.SUPPORTED_CHAIN_IDS)
+      validateChainSupported(params.chainId, this.supportedChainIds())
 
     const filteredMarkets = this.filterMarketConfigs(
       params.chainId,
@@ -157,7 +166,6 @@ export abstract class LendProvider<
       )
     }
 
-    validateChainSupported(marketId.chainId, this.SUPPORTED_CHAIN_IDS)
     this.validateConfigSupported(marketId)
 
     return this._getPosition({ marketId, walletAddress })
@@ -177,7 +185,6 @@ export abstract class LendProvider<
       throw new Error('walletAddress is required')
     }
 
-    validateChainSupported(params.marketId.chainId, this.SUPPORTED_CHAIN_IDS)
     this.validateConfigSupported(params.marketId)
 
     const market = await this.getMarket({
@@ -215,7 +222,7 @@ export abstract class LendProvider<
    * @returns true if chain is supported, false otherwise
    */
   protected isChainSupported(chainId: number): boolean {
-    return this.SUPPORTED_CHAIN_IDS.includes(chainId)
+    return this.supportedChainIds().includes(chainId)
   }
 
   /**
@@ -224,6 +231,8 @@ export abstract class LendProvider<
    * @throws Error if market allowlist is configured but market is not in it
    */
   protected validateConfigSupported(marketId: LendMarketId): void {
+    validateChainSupported(marketId.chainId, this.supportedChainIds())
+
     if (
       !this._config.marketAllowlist ||
       this._config.marketAllowlist.length === 0
@@ -275,17 +284,7 @@ export abstract class LendProvider<
     spender: Address,
     amount: bigint,
   ): TransactionData {
-    const approvalCallData = encodeFunctionData({
-      abi: erc20Abi,
-      functionName: 'approve',
-      args: [spender, amount],
-    })
-
-    return {
-      to: tokenAddress,
-      data: approvalCallData,
-      value: 0n,
-    }
+    return buildErc20ApprovalTx(tokenAddress, spender, amount)
   }
 
   /**

package/src/lend/namespaces/BaseLendNamespace.ts

@@ -1,18 +1,14 @@
-import type { LendProvider } from '@/lend/core/LendProvider.js'
 import type { AaveLendProvider } from '@/lend/providers/aave/AaveLendProvider.js'
 import type { MorphoLendProvider } from '@/lend/providers/morpho/MorphoLendProvider.js'
-import type { LendProviderConfig } from '@/types/actions.js'
 import type {
   GetLendMarketParams,
   GetLendMarketsParams,
   LendMarket,
   LendMarketId,
 } from '@/types/lend/index.js'
+import type { LendProviders } from '@/types/providers.js'
 
-export type LendProviders = {
-  morpho?: LendProvider<LendProviderConfig>
-  aave?: LendProvider<LendProviderConfig>
-}
+export type { LendProviders } from '@/types/providers.js'
 
 /**
  * Base Lend Namespace

package/src/lend/namespaces/__tests__/BaseLendNamespace.spec.ts

@@ -3,8 +3,13 @@ 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 {
+  createMockLendProvider,
+  MockLendProvider as MockLendProviderClass,
+} from '@/lend/__mocks__/MockLendProvider.js'
 import { BaseLendNamespace } from '@/lend/namespaces/BaseLendNamespace.js'
+import { MockChainManager } from '@/services/__mocks__/MockChainManager.js'
+import type { ChainManager } from '@/services/ChainManager.js'
 
 // Concrete implementation for testing
 class TestLendNamespace extends BaseLendNamespace {}
@@ -109,10 +114,12 @@ describe('BaseLendNamespace', () => {
 
   describe('supportedChainIds', () => {
     it('should return unique chain IDs from all providers', () => {
-      const namespace = new TestLendNamespace({
-        morpho: mockMorphoProvider,
-        aave: mockAaveProvider,
-      })
+      const chainManager = new MockChainManager({
+        supportedChains: [1, 130, 8453, 84532],
+      }) as unknown as ChainManager
+      const morpho = new MockLendProviderClass({}, undefined, chainManager)
+      const aave = new MockLendProviderClass({}, undefined, chainManager)
+      const namespace = new TestLendNamespace({ morpho, aave })
 
       const chainIds = namespace.supportedChainIds()
 

package/src/lend/providers/aave/AaveLendProvider.ts

@@ -25,18 +25,14 @@ import {
 } from './addresses.js'
 import { getATokenAddress, getReserve, getReserves } from './sdk.js'
 
-/**
- * Supported chain IDs for Aave lending
- * @description Array of chain IDs where Aave V3 is available on Optimism Superchain
- */
-export const SUPPORTED_CHAIN_IDS = getSupportedChainIds() as readonly number[]
-
 /**
  * Aave lending provider implementation
  * @description Lending provider implementation using Aave V3 protocol
  */
 export class AaveLendProvider extends LendProvider<LendProviderConfig> {
-  protected readonly SUPPORTED_CHAIN_IDS = SUPPORTED_CHAIN_IDS
+  protocolSupportedChainIds(): number[] {
+    return getSupportedChainIds()
+  }
 
   /**
    * Create a new Aave lending provider

package/src/lend/providers/aave/__tests__/AaveLendProvider.test.ts

@@ -88,22 +88,31 @@ describe('AaveLendProvider', () => {
     })
   })
 
-  describe('supportedChainIds', () => {
-    it('should return array of supported chain IDs', () => {
-      const chainIds = provider.supportedChainIds()
+  describe('protocolSupportedChainIds', () => {
+    it('should return all Aave V3 deployment chains', () => {
+      const chainIds = provider.protocolSupportedChainIds()
 
-      expect(chainIds).toHaveLength(4)
+      expect(chainIds).toHaveLength(6)
       expect(chainIds).toContain(10) // Optimism
       expect(chainIds).toContain(8453) // Base
+      expect(chainIds).toContain(1868) // Soneium
+      expect(chainIds).toContain(57073) // Ink
       expect(chainIds).toContain(11155420) // Optimism Sepolia
       expect(chainIds).toContain(84532) // Base Sepolia
     })
+  })
 
-    it('should return unique chain IDs', () => {
+  describe('supportedChainIds', () => {
+    it('should return only chains present in ActionsConfig', () => {
+      // mockChainManager is configured with supportedChains: [8453]
       const chainIds = provider.supportedChainIds()
-      const uniqueIds = [...new Set(chainIds)]
 
-      expect(chainIds.length).toBe(uniqueIds.length)
+      expect(chainIds).toEqual([8453])
+    })
+
+    it('should return unique chain IDs', () => {
+      const chainIds = provider.supportedChainIds()
+      expect(chainIds.length).toBe(new Set(chainIds).size)
     })
   })
 

package/src/lend/providers/aave/addresses.ts

@@ -1,95 +1,113 @@
 import type { Address } from 'viem'
-import { base, baseSepolia, optimism, optimismSepolia } from 'viem/chains'
+import {
+  base,
+  baseSepolia,
+  ink,
+  optimism,
+  optimismSepolia,
+  soneium,
+} from 'viem/chains'
 
-/**
- * Aave V3 Pool addresses for Optimism Superchain networks
- * @description Hardcoded Pool contract addresses for each supported chain
- */
+import type { SupportedChainId } from '@/constants/supportedChains.js'
 
 /**
- * Mainnet Pool addresses
+ * Aave V3 contract addresses per chain
  */
-export const POOL_ADDRESSES_MAINNET: Record<number, Address> = {
-  [optimism.id]: '0x794a61358D6845594F94dc1DB02A252b5b4814aD',
-  [base.id]: '0xA238Dd80C259a72e81d7e4664a9801593F98d1c5',
-} as const
+export interface AaveAddresses {
+  pool: Address
+  wethGateway: Address
+  uiPoolDataProvider: Address
+  poolAddressesProvider: Address
+}
 
 /**
- * Testnet Pool addresses
+ * Aave V3 contract addresses for OP Stack chains
+ * @see https://github.com/bgd-labs/aave-address-book
  */
-export const POOL_ADDRESSES_TESTNET: Record<number, Address> = {
-  [optimismSepolia.id]: '0xb50201558b00496a145fe76f7424749556e326d8',
-  [baseSepolia.id]: '0x8bAB6d1b75f19e9eD9fCe8b9BD338844fF79aE27',
-} as const
+const AAVE_ADDRESSES: Partial<Record<SupportedChainId, AaveAddresses>> = {
+  [optimism.id]: {
+    pool: '0x794a61358D6845594F94dc1DB02A252b5b4814aD',
+    wethGateway: '0x5f2508cAE9923b02316254026CD43d7902866725',
+    uiPoolDataProvider: '0x69FA688f1Dc47d4B5d8029D5a35FB7a548310654',
+    poolAddressesProvider: '0xa97684ead0e402dC232d5A977953DF7ECBaB3CDb',
+  },
+  [base.id]: {
+    pool: '0xA238Dd80C259a72e81d7e4664a9801593F98d1c5',
+    wethGateway: '0xa0d9C1E9E48Ca30c8d8C3B5D69FF5dc1f6DFfC24',
+    uiPoolDataProvider: '0xd82a47fdebB5bf5329b09441C3DaB4b5df2153Ad',
+    poolAddressesProvider: '0xe20fCBdBfFC4Dd138cE8b2E6FBb6CB49777ad64D',
+  },
+  [soneium.id]: {
+    pool: '0xDd3d7A7d03D9fD9ef45f3E587287922eF65CA38B',
+    wethGateway: '0x6376D4df995f32f308f2d5049a7a320943023232',
+    uiPoolDataProvider: '0xc69299Ddd3a704F6954c8Ae1AD00e0892d77Aee4',
+    poolAddressesProvider: '0x82405D1a189bd6cE4667809C35B37fBE136A4c5B',
+  },
+  [ink.id]: {
+    pool: '0x2816cf15F6d2A220E789aA011D5EE4eB6c47FEbA',
+    wethGateway: '0xDe090EfCD6ef4b86792e2D84E55a5fa8d49D25D2',
+    uiPoolDataProvider: '0xF1485fb7DBFa5db0B368FeA808FD6ff945c36064',
+    poolAddressesProvider: '0x4172E6aAEC070ACB31aaCE343A58c93E4C70f44D',
+  },
+  [optimismSepolia.id]: {
+    pool: '0xb50201558b00496a145fe76f7424749556e326d8',
+    wethGateway: '0x589750BA8aF186cE5B55391B0b7148cAD43a1619',
+    uiPoolDataProvider: '0x86E2938daE289763D4e09a7e42c5cCcA62Cf9809',
+    poolAddressesProvider: '0x36616cf17557639614c1cdDb356b1B83fc0B2132',
+  },
+  [baseSepolia.id]: {
+    pool: '0x8bAB6d1b75f19e9eD9fCe8b9BD338844fF79aE27',
+    wethGateway: '0x0568130e794429D2eEBC4dafE18f25Ff1a1ed8b6',
+    uiPoolDataProvider: '0xBc9f5b7E248451CdD7cA54e717a2BFe1F32b566b',
+    poolAddressesProvider: '0xE4C23309117Aa30342BFaae6c95c6478e0A4Ad00',
+  },
+}
 
 /**
- * All Pool addresses (mainnet + testnet)
+ * Get all Aave addresses for a chain
  */
-export const POOL_ADDRESSES: Record<number, Address> = {
-  ...POOL_ADDRESSES_MAINNET,
-  ...POOL_ADDRESSES_TESTNET,
-} as const
+export function getAaveAddresses(chainId: number): AaveAddresses | undefined {
+  return AAVE_ADDRESSES[chainId as SupportedChainId]
+}
 
 /**
  * Get Pool address for a given chain ID
- * @param chainId - Chain ID
- * @returns Pool address if supported, undefined otherwise
  */
 export function getPoolAddress(chainId: number): Address | undefined {
-  return POOL_ADDRESSES[chainId]
+  return getAaveAddresses(chainId)?.pool
 }
 
 /**
- * Check if a chain ID has Aave V3 deployed
- * @param chainId - Chain ID to check
- * @returns true if Aave V3 is deployed on this chain
+ * Get WETHGateway address for a given chain ID
  */
-export function isAaveChainSupported(chainId: number): boolean {
-  return chainId in POOL_ADDRESSES
+export function getWETHGatewayAddress(chainId: number): Address | undefined {
+  return getAaveAddresses(chainId)?.wethGateway
 }
 
 /**
  * Get all supported chain IDs
- * @returns Array of chain IDs with Aave V3 deployed
  */
 export function getSupportedChainIds(): number[] {
-  return Object.keys(POOL_ADDRESSES).map(Number)
+  return Object.keys(AAVE_ADDRESSES).map(Number)
 }
 
-/**
- * Aave V3 WETHGateway addresses for Optimism Superchain networks
- * @description Gateway contracts that handle native ETH wrapping and depositing
- */
-
-/**
- * Mainnet WETHGateway addresses
- */
+export const POOL_ADDRESSES_MAINNET: Record<number, Address> = {
+  [optimism.id]: AAVE_ADDRESSES[optimism.id]!.pool,
+  [base.id]: AAVE_ADDRESSES[base.id]!.pool,
+  [soneium.id]: AAVE_ADDRESSES[soneium.id]!.pool,
+  [ink.id]: AAVE_ADDRESSES[ink.id]!.pool,
+}
+export const POOL_ADDRESSES_TESTNET: Record<number, Address> = {
+  [optimismSepolia.id]: AAVE_ADDRESSES[optimismSepolia.id]!.pool,
+  [baseSepolia.id]: AAVE_ADDRESSES[baseSepolia.id]!.pool,
+}
 export const WETH_GATEWAY_ADDRESSES_MAINNET: Record<number, Address> = {
-  [optimism.id]: '0x5f2508cAE9923b02316254026CD43d7902866725',
-  [base.id]: '0xa0d9C1E9E48Ca30c8d8C3B5D69FF5dc1f6DFfC24',
-} as const
-
-/**
- * Testnet WETHGateway addresses
- */
+  [optimism.id]: AAVE_ADDRESSES[optimism.id]!.wethGateway,
+  [base.id]: AAVE_ADDRESSES[base.id]!.wethGateway,
+  [soneium.id]: AAVE_ADDRESSES[soneium.id]!.wethGateway,
+  [ink.id]: AAVE_ADDRESSES[ink.id]!.wethGateway,
+}
 export const WETH_GATEWAY_ADDRESSES_TESTNET: Record<number, Address> = {
-  [optimismSepolia.id]: '0x589750BA8aF186cE5B55391B0b7148cAD43a1619',
-  [baseSepolia.id]: '0x0568130e794429D2eEBC4dafE18f25Ff1a1ed8b6',
-} as const
-
-/**
- * All WETHGateway addresses (mainnet + testnet)
- */
-export const WETH_GATEWAY_ADDRESSES: Record<number, Address> = {
-  ...WETH_GATEWAY_ADDRESSES_MAINNET,
-  ...WETH_GATEWAY_ADDRESSES_TESTNET,
-} as const
-
-/**
- * Get WETHGateway address for a given chain ID
- * @param chainId - Chain ID
- * @returns WETHGateway address if supported, undefined otherwise
- */
-export function getWETHGatewayAddress(chainId: number): Address | undefined {
-  return WETH_GATEWAY_ADDRESSES[chainId]
+  [optimismSepolia.id]: AAVE_ADDRESSES[optimismSepolia.id]!.wethGateway,
+  [baseSepolia.id]: AAVE_ADDRESSES[baseSepolia.id]!.wethGateway,
 }

package/src/lend/providers/aave/sdk.ts

@@ -2,12 +2,14 @@ import { UiPoolDataProvider } from '@aave/contract-helpers'
 import { formatReserves } from '@aave/math-utils'
 import { providers } from 'ethers'
 import type { Address } from 'viem'
-import { base, baseSepolia, optimism, optimismSepolia } from 'viem/chains'
 
 import { WETH } from '@/constants/assets.js'
-import type { SUPPORTED_CHAIN_IDS } from '@/constants/supportedChains.js'
+import type { SupportedChainId } from '@/constants/supportedChains.js'
 import { POOL_GET_RESERVE_DATA_ABI } from '@/lend/providers/aave/abis/pool.js'
-import { getPoolAddress } from '@/lend/providers/aave/addresses.js'
+import {
+  getAaveAddresses,
+  getPoolAddress,
+} from '@/lend/providers/aave/addresses.js'
 import type { ChainManager } from '@/services/ChainManager.js'
 import type { LendProviderConfig } from '@/types/actions.js'
 import type {
@@ -18,27 +20,6 @@ import type {
 } from '@/types/lend/index.js'
 import { getAssetAddress } from '@/utils/assets.js'
 
-/**
- * UI Pool Data Provider addresses for each chain
- * @description Contract addresses for UiPoolDataProvider on each supported chain
- */
-const UI_POOL_DATA_PROVIDER_ADDRESSES: Record<number, Address> = {
-  [optimism.id]: '0x69FA688f1Dc47d4B5d8029D5a35FB7a548310654',
-  [base.id]: '0xd82a47fdebB5bf5329b09441C3DaB4b5df2153Ad',
-  [optimismSepolia.id]: '0x86E2938daE289763D4e09a7e42c5cCcA62Cf9809',
-  [baseSepolia.id]: '0xBc9f5b7E248451CdD7cA54e717a2BFe1F32b566b',
-} as const
-
-/**
- * Pool Addresses Provider addresses for each chain
- */
-const POOL_ADDRESSES_PROVIDER: Record<number, Address> = {
-  [optimism.id]: '0xa97684ead0e402dC232d5A977953DF7ECBaB3CDb',
-  [base.id]: '0xe20fCBdBfFC4Dd138cE8b2E6FBb6CB49777ad64D',
-  [optimismSepolia.id]: '0x36616cf17557639614c1cdDb356b1B83fc0B2132',
-  [baseSepolia.id]: '0xE4C23309117Aa30342BFaae6c95c6478e0A4Ad00',
-} as const
-
 /**
  * Parameters for getReserve function
  */
@@ -119,20 +100,14 @@ export async function getReserve(
     )
   }
 
-  const poolAddress = getPoolAddress(params.marketId.chainId)
-  if (!poolAddress) {
+  const addresses = getAaveAddresses(params.marketId.chainId)
+  if (!addresses) {
     throw new Error(`Aave V3 not deployed on chain ${params.marketId.chainId}`)
   }
 
-  const uiPoolDataProviderAddress =
-    UI_POOL_DATA_PROVIDER_ADDRESSES[params.marketId.chainId]
-  const poolAddressesProvider = POOL_ADDRESSES_PROVIDER[params.marketId.chainId]
-
-  if (!uiPoolDataProviderAddress || !poolAddressesProvider) {
-    throw new Error(
-      `UiPoolDataProvider not configured for chain ${params.marketId.chainId}`,
-    )
-  }
+  const poolAddress = addresses.pool
+  const uiPoolDataProviderAddress = addresses.uiPoolDataProvider
+  const poolAddressesProvider = addresses.poolAddressesProvider
 
   try {
     // Get viem public client for this chain
@@ -264,7 +239,7 @@ export async function getReserves(
  */
 export async function getATokenAddress(params: {
   underlyingAsset: Address
-  chainId: (typeof SUPPORTED_CHAIN_IDS)[number]
+  chainId: SupportedChainId
   chainManager: ChainManager
 }): Promise<Address> {
   const poolAddress = getPoolAddress(params.chainId)

package/src/lend/providers/morpho/MorphoLendProvider.ts

@@ -1,9 +1,8 @@
-import { ChainId } from '@morpho-org/blue-sdk'
 import { MetaMorphoAction } from '@morpho-org/blue-sdk-viem'
 import { erc20Abi, formatUnits } from 'viem'
 
-import { SUPPORTED_CHAIN_IDS as ACTIONS_SUPPORTED_CHAIN_IDS } from '@/constants/supportedChains.js'
 import { LendProvider } from '@/lend/core/LendProvider.js'
+import { getSupportedChainIds as getMorphoSupportedChainIds } from '@/lend/providers/morpho/contracts.js'
 import { getVault, getVaults } from '@/lend/providers/morpho/sdk.js'
 import type { ChainManager } from '@/services/ChainManager.js'
 import type { LendProviderConfig } from '@/types/actions.js'
@@ -19,25 +18,14 @@ import type {
 } from '@/types/lend/index.js'
 import { getAssetAddress } from '@/utils/assets.js'
 
-/**
- * Supported chain IDs for Morpho lending
- * @description Array of chain IDs where Morpho is available
- */
-export const SUPPORTED_CHAIN_IDS = [
-  ...new Set([
-    ...Object.values(ChainId).filter(
-      (value): value is number => typeof value === 'number',
-    ),
-    ...ACTIONS_SUPPORTED_CHAIN_IDS,
-  ]),
-] as readonly number[]
-
 /**
  * Morpho lending provider implementation
  * @description Lending provider implementation using Morpho protocol
  */
 export class MorphoLendProvider extends LendProvider<LendProviderConfig> {
-  protected readonly SUPPORTED_CHAIN_IDS = SUPPORTED_CHAIN_IDS
+  protocolSupportedChainIds(): number[] {
+    return getMorphoSupportedChainIds()
+  }
 
   /**
    * Create a new Morpho lending provider