@eth-optimism/actions-sdk 0.3.0 → 0.5.0

package/src/actions.ts

@@ -1,18 +1,19 @@
-import type { LendProvider } from '@/lend/index.js'
+import { EnsNamespace } from '@/ens/index.js'
 import { AaveLendProvider, MorphoLendProvider } from '@/lend/index.js'
 import { ActionsLendNamespace } from '@/lend/namespaces/ActionsLendNamespace.js'
 import { ChainManager } from '@/services/ChainManager.js'
-import { SUPPORTED_TOKENS } from '@/supported/tokens.js'
-import type { SwapProvider } from '@/swap/index.js'
-import { UniswapSwapProvider } from '@/swap/index.js'
+import { UniswapSwapProvider, VelodromeSwapProvider } from '@/swap/index.js'
 import { ActionsSwapNamespace } from '@/swap/namespaces/ActionsSwapNamespace.js'
 import type {
   ActionsConfig,
   AssetsConfig,
-  LendProviderConfig,
-  SwapProviderConfig,
+  LendProviders,
+  SwapProviders,
+  SwapSettings,
 } from '@/types/actions.js'
 import type { Asset } from '@/types/asset.js'
+import { getAllAssetAddresses } from '@/utils/assets.js'
+import { validateConfigAddresses } from '@/utils/validateAddresses.js'
 import { WalletNamespace } from '@/wallet/core/namespace/WalletNamespace.js'
 import type { HostedWalletProvider } from '@/wallet/core/providers/hosted/abstract/HostedWalletProvider.js'
 import type { HostedWalletProviderRegistry } from '@/wallet/core/providers/hosted/registry/HostedWalletProviderRegistry.js'
@@ -47,18 +48,13 @@ export class Actions<
     SmartWalletProvider
   >
   private chainManager: ChainManager
+  private _ens: EnsNamespace
   private _lend?: ActionsLendNamespace
-  private _lendProviders: {
-    morpho?: LendProvider<LendProviderConfig>
-    aave?: LendProvider<LendProviderConfig>
-  } = {}
+  private _lendProviders: LendProviders = {}
   private _swap?: ActionsSwapNamespace
-  private _swapProviders: {
-    uniswap?: SwapProvider<SwapProviderConfig>
-  } = {}
+  private _swapProviders: SwapProviders = {}
+  private _swapSettings?: SwapSettings
   private _assetsConfig?: AssetsConfig
-  private hostedWalletProvider!: THostedWalletProvidersSchema['providerInstances'][THostedWalletProviderType]
-  private smartWalletProvider!: SmartWalletProvider
   private hostedWalletProviderRegistry: HostedWalletProviderRegistry<
     THostedWalletProvidersSchema['providerInstances'],
     THostedWalletProvidersSchema['providerConfigs'],
@@ -80,6 +76,9 @@ export class Actions<
     this.chainManager = new ChainManager(config.chains)
     this.hostedWalletProviderRegistry = deps.hostedWalletProviderRegistry
     this._assetsConfig = config.assets
+    validateConfigAddresses(config)
+
+    this._ens = new EnsNamespace(this.chainManager)
 
     if (config.lend?.morpho) {
       this._lendProviders.morpho = new MorphoLendProvider(
@@ -97,12 +96,28 @@ export class Actions<
       this._lend = new ActionsLendNamespace(this._lendProviders)
     }
 
+    const swapSettings = config.swap?.settings
     if (config.swap?.uniswap) {
       this._swapProviders.uniswap = new UniswapSwapProvider(
         config.swap.uniswap,
         this.chainManager,
+        swapSettings,
+      )
+    }
+    if (config.swap?.velodrome) {
+      this._swapProviders.velodrome = new VelodromeSwapProvider(
+        config.swap.velodrome,
+        this.chainManager,
+        swapSettings,
+      )
+    }
+    this._swapSettings = swapSettings
+    if (Object.values(this._swapProviders).some(Boolean)) {
+      this._swap = new ActionsSwapNamespace(
+        this._swapProviders,
+        (r) => (r ? this._ens.getAddress(r) : Promise.resolve(undefined)),
+        this._swapSettings,
       )
-      this._swap = new ActionsSwapNamespace(this._swapProviders)
     }
 
     this.wallet = this.createWalletNamespace(config.wallet)
@@ -128,13 +143,20 @@ export class Actions<
    * Get the lend provider instances
    * @returns Object containing configured lend providers
    */
-  get lendProviders(): {
-    morpho?: LendProvider<LendProviderConfig>
-    aave?: LendProvider<LendProviderConfig>
-  } {
+  get lendProviders(): LendProviders {
     return this._lendProviders
   }
 
+  /**
+   * Get ENS operations interface
+   * @description Access to Ethereum Name Service operations: resolve, reverseResolve, lookupText.
+   * Requires Ethereum mainnet (chain ID 1) to be included in your chain configuration.
+   * @returns EnsNamespace for ENS operations
+   */
+  get ens(): EnsNamespace {
+    return this._ens
+  }
+
   /**
    * Get swap operations interface
    * @description Access to swap operations like price quotes and markets.
@@ -155,46 +177,35 @@ export class Actions<
    * Get the swap provider instances
    * @returns Object containing configured swap providers
    */
-  get swapProviders(): {
-    uniswap?: SwapProvider<SwapProviderConfig>
-  } {
+  get swapProviders(): SwapProviders {
     return this._swapProviders
   }
 
   /**
    * Get the list of supported assets based on configuration
    * @description Returns filtered assets based on allow/block lists in assets config.
-   * If no config provided, returns all SUPPORTED_TOKENS.
+   * If no config provided, returns empty array. Developers must explicitly configure
+   * their supported assets via ActionsConfig.assets.allow.
    * @returns Array of supported assets
    */
   public getSupportedAssets(): Asset[] {
-    // If no assets config, return all supported tokens
     if (!this._assetsConfig) {
-      return SUPPORTED_TOKENS
+      return []
     }
 
-    // If allow list provided, return only those
-    if (this._assetsConfig.allow && this._assetsConfig.allow.length > 0) {
-      return this._assetsConfig.allow
-    }
+    const allow = this._assetsConfig.allow ?? []
+    const block = this._assetsConfig.block
 
-    // If block list provided, filter out blocked assets
-    if (this._assetsConfig.block && this._assetsConfig.block.length > 0) {
-      const blockedAddresses = new Set(
-        this._assetsConfig.block.flatMap((asset) =>
-          Object.values(asset.address).map((addr) => addr.toLowerCase()),
-        ),
-      )
-      return SUPPORTED_TOKENS.filter((token) => {
-        const tokenAddresses = Object.values(token.address).map((addr) =>
-          addr.toLowerCase(),
-        )
-        return !tokenAddresses.some((addr) => blockedAddresses.has(addr))
-      })
+    if (!block?.length) {
+      return allow
     }
 
-    // Default to all supported tokens
-    return SUPPORTED_TOKENS
+    const blockedAddresses = new Set(block.flatMap(getAllAssetAddresses))
+
+    return allow.filter((asset) => {
+      const addresses = getAllAssetAddresses(asset)
+      return !addresses.some((addr) => blockedAddresses.has(addr))
+    })
   }
 
   /**
@@ -202,16 +213,18 @@ export class Actions<
    * @param config - Wallet configuration
    * @returns WalletProvider instance
    */
-  private createWalletProvider(
+  private async createWalletProvider(
     config: ActionsConfig<
       THostedWalletProviderType,
       THostedWalletProvidersSchema['providerConfigs']
     >['wallet'],
-  ): WalletProvider<
-    THostedWalletProviderType,
-    THostedWalletProvidersSchema['providerToActionsOptions'],
-    THostedWalletProvidersSchema['providerInstances'][THostedWalletProviderType],
-    SmartWalletProvider
+  ): Promise<
+    WalletProvider<
+      THostedWalletProviderType,
+      THostedWalletProvidersSchema['providerToActionsOptions'],
+      THostedWalletProvidersSchema['providerInstances'][THostedWalletProviderType],
+      SmartWalletProvider
+    >
   > {
     const hostedWalletProviderConfig = config.hostedWalletConfig.provider
     const factory = this.hostedWalletProviderRegistry.getFactory(
@@ -227,21 +240,23 @@ export class Actions<
         `Invalid options for hosted wallet provider: ${hostedWalletProviderConfig.type}`,
       )
     }
-    this.hostedWalletProvider = factory.create(
+    const hostedWalletProvider = await factory.create(
       {
         chainManager: this.chainManager,
         lendProviders: this._lendProviders,
         swapProviders: this._swapProviders,
         supportedAssets: this.getSupportedAssets(),
+        swapSettings: this._swapSettings,
       },
       options,
     )
 
+    let smartWalletProvider: SmartWalletProvider
     if (
       !config.smartWalletConfig ||
       config.smartWalletConfig.provider.type === 'default'
     ) {
-      this.smartWalletProvider = new DefaultSmartWalletProvider(
+      smartWalletProvider = new DefaultSmartWalletProvider(
         this.chainManager,
         this._lendProviders,
         this._swapProviders,
@@ -254,16 +269,13 @@ export class Actions<
       )
     }
 
-    const walletProvider = new WalletProvider(
-      this.hostedWalletProvider,
-      this.smartWalletProvider,
-    )
-
-    return walletProvider
+    return new WalletProvider(hostedWalletProvider, smartWalletProvider)
   }
 
   /**
    * Create the wallet namespace instance
+   * @description Creates a WalletNamespace with lazy provider initialization.
+   * The wallet provider is not created until the first wallet method is called.
    * @param config - Wallet configuration
    * @returns WalletNamespace instance
    */
@@ -273,12 +285,12 @@ export class Actions<
       THostedWalletProvidersSchema['providerConfigs']
     >['wallet'],
   ) {
-    const walletProvider = this.createWalletProvider(config)
+    const providerFactory = () => this.createWalletProvider(config)
     return new WalletNamespace<
       THostedWalletProviderType,
       THostedWalletProvidersSchema['providerToActionsOptions'],
       THostedWalletProvidersSchema['providerInstances'][THostedWalletProviderType],
       SmartWalletProvider
-    >(walletProvider)
+    >(providerFactory)
   }
 }