@eth-optimism/actions-sdk 0.1.0 → 0.2.0

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

@@ -1,12 +1,17 @@
-import type { AccrualPosition } from '@morpho-org/blue-sdk'
-import { fetchAccrualVault } from '@morpho-org/blue-sdk-viem'
-import type { Address } from 'viem'
-import { parseEther } from 'viem'
+import { type AccrualPosition, ChainId } from '@morpho-org/blue-sdk'
+import {
+  adaptiveCurveIrmAbi,
+  blueAbi,
+  fetchAccrualVault,
+  metaMorphoAbi,
+} from '@morpho-org/blue-sdk-viem'
+import type { Address, PublicClient } from 'viem'
 
 import {
   fetchRewards,
   type RewardsBreakdown,
 } from '@/lend/providers/morpho/api.js'
+import { getMorphoContracts } from '@/lend/providers/morpho/contracts.js'
 import type { ChainManager } from '@/services/ChainManager.js'
 import { SUPPORTED_TOKENS } from '@/supported/tokens.js'
 import type { LendProviderConfig } from '@/types/actions.js'
@@ -15,7 +20,9 @@ import type {
   LendMarket,
   LendMarketConfig,
   LendMarketId,
+  MorphoContracts,
 } from '@/types/lend/index.js'
+import { SECONDS_PER_YEAR } from '@/utils/constants.js'
 
 /**
  * Fetch and calculate rewards breakdown from Morpho GraphQL API
@@ -91,41 +98,179 @@ export function calculateBaseApy(vault: any): number {
   }
 }
 
+async function fetchVaultInfo(vaultAddress: Address, client: PublicClient) {
+  const [totalAssets, totalSupply, fee, owner, curator, supplyQueueLength] =
+    await Promise.all([
+      client.readContract({
+        address: vaultAddress,
+        abi: metaMorphoAbi,
+        functionName: 'totalAssets',
+      }),
+      client.readContract({
+        address: vaultAddress,
+        abi: metaMorphoAbi,
+        functionName: 'totalSupply',
+      }),
+      client.readContract({
+        address: vaultAddress,
+        abi: metaMorphoAbi,
+        functionName: 'fee',
+      }),
+      client.readContract({
+        address: vaultAddress,
+        abi: metaMorphoAbi,
+        functionName: 'owner',
+      }),
+      client.readContract({
+        address: vaultAddress,
+        abi: metaMorphoAbi,
+        functionName: 'curator',
+      }),
+      client.readContract({
+        address: vaultAddress,
+        abi: metaMorphoAbi,
+        functionName: 'supplyQueueLength',
+      }),
+    ])
+  return { totalAssets, totalSupply, fee, owner, curator, supplyQueueLength }
+}
+
+async function fetchMarketAllocation(
+  vaultAddress: Address,
+  marketIdHash: `0x${string}`,
+  contracts: MorphoContracts,
+  client: PublicClient,
+): Promise<{ vaultSupplyAssets: bigint; supplyApy: bigint } | null> {
+  const [marketParams, marketState, vaultPosition] = await Promise.all([
+    client.readContract({
+      address: contracts.morphoBlue,
+      abi: blueAbi,
+      functionName: 'idToMarketParams',
+      args: [marketIdHash],
+    }),
+    client.readContract({
+      address: contracts.morphoBlue,
+      abi: blueAbi,
+      functionName: 'market',
+      args: [marketIdHash],
+    }),
+    client.readContract({
+      address: contracts.morphoBlue,
+      abi: blueAbi,
+      functionName: 'position',
+      args: [marketIdHash, vaultAddress],
+    }),
+  ])
+
+  const [
+    supplyAssets,
+    supplyShares,
+    borrowAssets,
+    borrowShares,
+    lastUpdate,
+    marketFee,
+  ] = marketState
+  const [vaultSupplyShares] = vaultPosition
+
+  if (vaultSupplyShares === 0n) return null
+  const vaultSupplyAssets =
+    supplyShares > 0n ? (vaultSupplyShares * supplyAssets) / supplyShares : 0n
+  if (vaultSupplyAssets === 0n || supplyAssets === 0n) return null
+
+  const borrowRate = await client.readContract({
+    address: contracts.irm,
+    abi: adaptiveCurveIrmAbi,
+    functionName: 'borrowRateView',
+    args: [
+      {
+        loanToken: marketParams[0],
+        collateralToken: marketParams[1],
+        oracle: marketParams[2],
+        irm: marketParams[3],
+        lltv: marketParams[4],
+      },
+      {
+        totalSupplyAssets: supplyAssets,
+        totalSupplyShares: supplyShares,
+        totalBorrowAssets: borrowAssets,
+        totalBorrowShares: borrowShares,
+        lastUpdate,
+        fee: marketFee,
+      },
+    ],
+  })
+
+  const utilization =
+    supplyAssets > 0n ? (borrowAssets * BigInt(1e18)) / supplyAssets : 0n
+  const supplyApy = (borrowRate * utilization * SECONDS_PER_YEAR) / BigInt(1e18)
+  return { vaultSupplyAssets, supplyApy }
+}
+
+async function calculateVaultApy(
+  vaultAddress: Address,
+  supplyQueueLength: bigint,
+  contracts: MorphoContracts,
+  client: PublicClient,
+): Promise<number> {
+  let totalWeightedApy = 0n
+  let totalSupply = 0n
+
+  for (let i = 0n; i < supplyQueueLength; i++) {
+    const marketIdHash = (await client.readContract({
+      address: vaultAddress,
+      abi: metaMorphoAbi,
+      functionName: 'supplyQueue',
+      args: [i],
+    })) as `0x${string}`
+
+    const allocation = await fetchMarketAllocation(
+      vaultAddress,
+      marketIdHash,
+      contracts,
+      client,
+    )
+    if (!allocation) continue
+    totalWeightedApy += allocation.supplyApy * allocation.vaultSupplyAssets
+    totalSupply += allocation.vaultSupplyAssets
+  }
+
+  return totalSupply > 0n ? Number(totalWeightedApy / totalSupply) / 1e18 : 0
+}
+
 /**
- * TEMPORARY - To be removed in https://github.com/ethereum-optimism/actions/issues/112
- * Create mock vault data for Base Sepolia (testnet)
- * @param marketId - Market identifier
- * @param marketConfig - Market configuration from allowlist
- * @returns Mock vault data with realistic values
+ * Fetch vault data via direct on-chain queries (for testnets)
  */
-function createMockVaultData(
+async function fetchVaultDataOnChain(
   marketId: LendMarketId,
   marketConfig: LendMarketConfig,
-): LendMarket {
-  const mockApyBreakdown: ApyBreakdown = {
-    total: 0.0542, // 5.42% net APY
-    native: 0.058, // 5.8% gross APY
-    totalRewards: 0.0235, // Total rewards APR
-    usdc: 0.0125, // USDC rewards
-    morpho: 0.008, // MORPHO token rewards
-    other: 0.003, // Other protocol rewards
-    performanceFee: 0.065, // 6.5% performance fee
-  }
+  client: PublicClient,
+  contracts: MorphoContracts,
+): Promise<LendMarket> {
+  const info = await fetchVaultInfo(marketId.address, client)
+  const nativeApy = await calculateVaultApy(
+    marketId.address,
+    info.supplyQueueLength,
+    contracts,
+    client,
+  )
+  const performanceFee = Number(info.fee) / 1e18
 
   return {
     marketId,
     name: marketConfig.name,
     asset: marketConfig.asset,
-    supply: {
-      totalAssets: parseEther('125000'), // ~$125K TVL
-      totalShares: parseEther('120000'), // Slightly lower shares (some yield accrued)
+    supply: { totalAssets: info.totalAssets, totalShares: info.totalSupply },
+    apy: {
+      total: nativeApy * (1 - performanceFee),
+      native: nativeApy,
+      totalRewards: 0,
+      performanceFee,
     },
-    apy: mockApyBreakdown,
     metadata: {
-      owner: '0x742d35Cc6464C42C0b15De2C4c98F7E8c3e0F1d9' as Address, // Mock owner
-      curator: '0x8f3Cf7ad23Cd3CaDbD9735aff958023239c6A063' as Address, // Mock curator
-      fee: mockApyBreakdown.performanceFee,
-      lastUpdate: Math.floor(Date.now() / 1000) - 300, // 5 minutes ago
+      owner: info.owner,
+      curator: info.curator,
+      fee: performanceFee,
+      lastUpdate: Math.floor(Date.now() / 1000),
     },
   }
 }
@@ -159,6 +304,13 @@ function findMarketInAllowlist(
   )
 }
 
+/**
+ * Check if chain is supported by Morpho SDK
+ */
+function isSdkSupportedChain(chainId: number): boolean {
+  return ChainId[chainId] !== undefined
+}
+
 /**
  * Get detailed vault information with enhanced rewards data
  * @param params - Named parameters object
@@ -176,69 +328,65 @@ export async function getVault(params: GetVaultParams): Promise<LendMarket> {
     )
   }
 
-  // Morpho sdk doesn't support base sepolia, so we need to use the mock vault
-  if (params.marketId.chainId === 84532) {
-    return createMockVaultData(params.marketId, marketConfig)
-  }
+  const publicClient = params.chainManager.getPublicClient(
+    params.marketId.chainId,
+  )
 
-  try {
-    // Fetch live vault data from Morpho SDK
-    const vault = await fetchAccrualVault(
-      params.marketId.address,
-      params.chainManager.getPublicClient(params.marketId.chainId),
-    ).catch((error) => {
-      console.error('Failed to fetch vault info:', error)
-      return {
-        totalAssets: 0n,
-        totalSupply: 0n,
-        owner: '0x' as Address,
-        curator: '0x' as Address,
-      }
-    })
+  // Try SDK first for supported chains (mainnets)
+  if (isSdkSupportedChain(params.marketId.chainId)) {
+    try {
+      const vault = await fetchAccrualVault(
+        params.marketId.address,
+        publicClient,
+      )
+
+      // Fetch rewards data from API
+      const rewardsBreakdown = await fetchAndCalculateRewards(
+        params.marketId.address,
+      ).catch((error) => {
+        console.error('Failed to fetch rewards data:', error)
+        return { usdc: 0, morpho: 0, other: 0, totalRewards: 0 }
+      })
+
+      const apyBreakdown = calculateApyBreakdown(vault, rewardsBreakdown)
+      const currentTimestampSeconds = Math.floor(Date.now() / 1000)
 
-    // Fetch rewards data from API
-    const rewardsBreakdown = await fetchAndCalculateRewards(
-      params.marketId.address,
-    ).catch((error) => {
-      console.error('Failed to fetch rewards data:', error)
       return {
-        usdc: 0,
-        morpho: 0,
-        other: 0,
-        totalRewards: 0,
+        marketId: params.marketId,
+        name: marketConfig.name,
+        asset: marketConfig.asset,
+        supply: {
+          totalAssets: vault.totalAssets,
+          totalShares: vault.totalSupply,
+        },
+        apy: apyBreakdown,
+        metadata: {
+          owner: vault.owner,
+          curator: vault.curator,
+          fee: apyBreakdown.performanceFee,
+          lastUpdate: currentTimestampSeconds,
+        },
       }
-    })
-
-    // Calculate APY breakdown
-    const apyBreakdown = calculateApyBreakdown(vault, rewardsBreakdown)
-
-    // Return comprehensive vault information
-    const currentTimestampSeconds = Math.floor(Date.now() / 1000)
-
-    return {
-      marketId: params.marketId,
-      name: marketConfig.name,
-      asset: marketConfig.asset,
-      supply: {
-        totalAssets: vault.totalAssets,
-        totalShares: vault.totalSupply,
-      },
-      apy: apyBreakdown,
-      metadata: {
-        owner: vault.owner,
-        curator: vault.curator,
-        fee: apyBreakdown.performanceFee,
-        lastUpdate: currentTimestampSeconds,
-      },
+    } catch (error) {
+      console.error('SDK fetch failed, trying on-chain fallback:', error)
     }
-  } catch (error) {
-    console.error('Failed to get vault info:', error)
-    throw new Error(
-      `Failed to get vault info for ${params.marketId.address}: ${
-        error instanceof Error ? error.message : 'Unknown error'
-      }`,
+  }
+
+  // Fallback to direct on-chain queries for testnets or if SDK fails
+  const contracts = getMorphoContracts(params.marketId.chainId)
+  if (contracts) {
+    return fetchVaultDataOnChain(
+      params.marketId,
+      marketConfig,
+      publicClient,
+      contracts,
     )
   }
+
+  // No SDK support and no contracts configured
+  throw new Error(
+    `Chain ${params.marketId.chainId} not supported by Morpho SDK and no contracts configured`,
+  )
 }
 
 interface GetVaultsParams {

package/src/services/tokenBalance.spec.ts

@@ -2,11 +2,11 @@ import type { Address } from 'viem'
 import { unichain } from 'viem/chains'
 import { beforeEach, describe, expect, it } from 'vitest'
 
+import { MockUSDCAsset } from '@/__mocks__/MockAssets.js'
 import { ETH } from '@/constants/assets.js'
+import { MockChainManager } from '@/services/__mocks__/MockChainManager.js'
 import type { ChainManager } from '@/services/ChainManager.js'
 import { fetchERC20Balance, fetchETHBalance } from '@/services/tokenBalance.js'
-import { MockUSDCAsset } from '@/test/MockAssets.js'
-import { MockChainManager } from '@/test/MockChainManager.js'
 import type { Asset } from '@/types/asset.js'
 
 describe('TokenBalance', () => {

package/src/services/tokenBalance.ts

@@ -1,7 +1,6 @@
 import type { Address } from 'viem'
 import { erc20Abi, formatEther, formatUnits } from 'viem'
 
-import { ETH } from '@/constants/assets.js'
 import type { SupportedChainId } from '@/constants/supportedChains.js'
 import type { ChainManager } from '@/services/ChainManager.js'
 import type { Asset, TokenBalance } from '@/types/asset.js'
@@ -25,7 +24,7 @@ export async function fetchETHBalance(
     return {
       chainId,
       balance,
-      tokenAddress: ETH.address[chainId]!,
+      tokenAddress: 'native' as const,
       formattedBalance: formatEther(balance),
     }
   })
@@ -92,7 +91,7 @@ async function fetchERC20BalanceForChain(
   chainId: SupportedChainId,
   walletAddress: Address,
   chainManager: ChainManager,
-): Promise<{ balance: bigint; tokenAddress: Address }> {
+): Promise<{ balance: bigint; tokenAddress: Address | 'native' }> {
   const tokenAddress = asset.address[chainId]
   if (!tokenAddress) {
     throw new Error(
@@ -103,20 +102,20 @@ async function fetchERC20BalanceForChain(
   const publicClient = chainManager.getPublicClient(chainId)
 
   // Handle native ETH balance
-  if (asset.type === 'native') {
+  if (asset.type === 'native' || tokenAddress === 'native') {
     return {
       balance: await publicClient.getBalance({
         address: walletAddress,
       }),
-      tokenAddress: ETH.address[chainId]!,
+      tokenAddress: 'native',
     }
   }
 
   const balance = await publicClient.readContract({
-    address: tokenAddress as Address,
+    address: tokenAddress,
     abi: erc20Abi,
     functionName: 'balanceOf',
     args: [walletAddress],
   })
-  return { balance, tokenAddress: tokenAddress as Address }
+  return { balance, tokenAddress }
 }

package/src/supported/tokens.ts

@@ -1,91 +1,18 @@
 import type { Address } from 'viem'
-import {
-  base,
-  baseSepolia,
-  mainnet,
-  optimismSepolia,
-  unichain,
-} from 'viem/chains'
 
+import { ETH, MORPHO, USDC, USDC_DEMO, WETH } from '@/constants/assets.js'
 import type { SupportedChainId } from '@/constants/supportedChains.js'
 import type { Asset } from '@/types/asset.js'
 
-export const SUPPORTED_TOKENS: Asset[] = [
-  {
-    address: {
-      [mainnet.id]: '0x0000000000000000000000000000000000000000',
-      [unichain.id]: '0x0000000000000000000000000000000000000000',
-      [base.id]: '0x0000000000000000000000000000000000000000',
-      [baseSepolia.id]: '0x0000000000000000000000000000000000000000',
-      [optimismSepolia.id]: '0x0000000000000000000000000000000000000000',
-    },
-    metadata: {
-      symbol: 'ETH',
-      name: 'Ethereum',
-      decimals: 18,
-    },
-    type: 'native',
-  },
-  {
-    address: {
-      [mainnet.id]: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
-      [base.id]: '0x4200000000000000000000000000000000000006',
-      [baseSepolia.id]: '0x4200000000000000000000000000000000000006',
-      [optimismSepolia.id]: '0x4200000000000000000000000000000000000006',
-      [unichain.id]: '0x4200000000000000000000000000000000000006',
-    },
-    metadata: {
-      symbol: 'WETH',
-      name: 'Wrapped Ether',
-      decimals: 18,
-    },
-    type: 'erc20',
-  },
-  {
-    address: {
-      [mainnet.id]: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
-      [unichain.id]: '0x078d782b760474a361dda0af3839290b0ef57ad6',
-      [baseSepolia.id]: '0x036CbD53842c5426634e7929541eC2318f3dCF7e',
-    },
-    metadata: {
-      symbol: 'USDC',
-      name: 'USDC',
-      decimals: 6,
-    },
-    type: 'erc20',
-  },
-  {
-    address: {
-      [baseSepolia.id]: '0x87c25229afbc30418d0144e8dfb2bcf8efd92c6c',
-    },
-    metadata: {
-      symbol: 'USDC_DEMO',
-      name: 'USDC',
-      decimals: 6,
-    },
-    type: 'erc20',
-  },
-  {
-    address: {
-      [mainnet.id]: '0x58D97B57BB95320F9a05dC918Aef65434969c2B2',
-      [base.id]: '0xBAa5CC21fd487B8Fcc2F632f3F4E8D37262a0842',
-    },
-    metadata: {
-      symbol: 'MORPHO',
-      name: 'Morpho Token',
-      decimals: 18,
-    },
-    type: 'erc20',
-  },
-]
+export const SUPPORTED_TOKENS: Asset[] = [ETH, WETH, USDC, USDC_DEMO, MORPHO]
 
 /**
- * Find token by address and chain ID
+ * Get token by address and chain ID
  * @param address Token address
  * @param chainId Chain ID
  * @returns Token symbol or null if not found
  */
-export function findTokenByAddress(
+export function getTokenByAddress(
   address: Address,
   chainId: SupportedChainId,
 ): string | null {
@@ -105,12 +32,12 @@ export function findTokenByAddress(
  * Get token address for a specific chain
  * @param symbol Token symbol
  * @param chainId Chain ID
- * @returns Token address or null if not supported on that chain
+ * @returns Token address, 'native' for native assets, or null if not supported
  */
 export function getTokenAddress(
   symbol: string,
   chainId: SupportedChainId,
-): Address | null {
+): Address | 'native' | null {
   const token = SUPPORTED_TOKENS.find((t) => t.metadata.symbol === symbol)
   return token?.address[chainId] || null
 }

package/src/types/asset.ts

@@ -6,8 +6,8 @@ import type { SupportedChainId } from '@/constants/supportedChains.js'
  * Asset type inspired by EIP 7811 but adapted for multi-chain asset definitions
  */
 export interface Asset {
-  /** Multi-chain address mapping */
-  address: Partial<Record<SupportedChainId, Address>>
+  /** Multi-chain address mapping. Native assets use 'native' string to prevent accidental contract calls. */
+  address: Partial<Record<SupportedChainId, Address | 'native'>>
   /** Asset metadata */
   metadata: {
     decimals: number
@@ -28,7 +28,7 @@ export interface TokenBalance {
   chainBalances: Array<{
     chainId: SupportedChainId
     balance: bigint
-    tokenAddress: Address
+    tokenAddress: Address | 'native'
     formattedBalance: string
   }>
 }

package/src/types/lend/base.ts

@@ -83,16 +83,13 @@ export interface LendTransaction {
   marketId: string
   /** Estimated APY at time of lending */
   apy: number
-  /** Transaction data for execution (optional) */
-  transactionData?: {
+  /** Transaction data for execution */
+  transactionData: {
     /** Approval transaction (if needed) */
     approval?: TransactionData
-    /** Main operation transaction (openPosition or closePosition) */
-    openPosition?: TransactionData
-    closePosition?: TransactionData
+    /** Main position transaction */
+    position: TransactionData
   }
-  /** Slippage tolerance used */
-  slippage?: number
 }
 
 /**
@@ -204,8 +201,6 @@ export interface LendMarket {
  * @description Configuration options for lending operations
  */
 export interface LendOptions {
-  /** Maximum slippage tolerance (basis points) */
-  slippage?: number
   /** Deadline for transaction (timestamp) */
   deadline?: number
   /** Gas limit override */
@@ -268,8 +263,10 @@ export interface LendOpenPositionParams extends LendOpenPositionBaseParams {
 /**
  * Internal parameters for provider _openPosition method with amount already converted to wei
  */
-export interface LendOpenPositionInternalParams
-  extends Omit<LendOpenPositionBaseParams, 'walletAddress'> {
+export interface LendOpenPositionInternalParams extends Omit<
+  LendOpenPositionBaseParams,
+  'walletAddress'
+> {
   /** Amount to lend in wei */
   amountWei: bigint
   /** Wallet address for receiving shares and as owner (required in internal params) */

package/src/types/lend/contracts.ts

@@ -0,0 +1,18 @@
+import type { Address } from 'viem'
+
+/**
+ * Morpho contract addresses needed per chain
+ */
+export interface MorphoContracts {
+  /** Morpho Blue core contract - market state, positions, supply/withdraw */
+  morphoBlue: Address
+  /** Interest Rate Model contract - borrow rate calculation for APY */
+  irm: Address
+  /** MetaMorpho vault factory (optional, only for vault creation) */
+  metaMorphoFactory?: Address
+}
+
+/**
+ * Registry mapping chainId to Morpho contracts
+ */
+export type MorphoContractsRegistry = Record<number, MorphoContracts>

package/src/types/lend/index.ts

@@ -1,2 +1,3 @@
 export * from '@/types/lend/base.js'
+export * from '@/types/lend/contracts.js'
 export * from '@/types/lend/morpho.js'

package/src/utils/assets.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest'
 
-import { MockUSDCAsset, MockWETHAsset } from '@/test/MockAssets.js'
+import { MockUSDCAsset, MockWETHAsset } from '@/__mocks__/MockAssets.js'
 import { isAssetSupportedOnChain } from '@/utils/assets.js'
 
 describe('Asset Utilities', () => {

package/src/utils/assets.ts

@@ -37,6 +37,15 @@ export function formatAssetAmount(amount: bigint, decimals: number): number {
   return parseFloat(result)
 }
 
+/**
+ * Check if asset is a native asset (e.g. ETH)
+ * @param asset - Asset definition
+ * @returns Whether the asset is native
+ */
+export function isNativeAsset(asset: Asset): boolean {
+  return asset.type === 'native'
+}
+
 /**
  * Check if asset is supported on a specific chain
  * @param asset - Asset definition
@@ -55,7 +64,7 @@ export function isAssetSupportedOnChain(
  * @param asset - Asset definition
  * @param chainId - Chain ID
  * @returns Asset address on the specified chain
- * @throws Error if asset is not supported on the chain
+ * @throws Error if asset is not supported on the chain or is a native asset
  */
 export function getAssetAddress(
   asset: Asset,
@@ -67,5 +76,10 @@ export function getAssetAddress(
       `Asset ${asset.metadata.symbol} is not supported on chain ${chainId}`,
     )
   }
+  if (address === 'native') {
+    throw new Error(
+      `Asset ${asset.metadata.symbol} is a native asset and has no contract address.`,
+    )
+  }
   return address
 }

package/src/utils/constants.ts

@@ -0,0 +1,4 @@
+/**
+ * Seconds per year for APY calculations (365 days)
+ */
+export const SECONDS_PER_YEAR = 31536000n