SDK

For easier integration, Enso provides a JavaScript/TypeScript SDK that wraps the API functionality in a convenient interface.

​

Installation

Install the Enso SDK using your preferred package manager:

npm install @ensofinance/sdk

​

Quick Start

This example shows how to swap ETH directly to a Yearn vault position:

import { EnsoClient } from '@ensofinance/sdk';

const enso = new EnsoClient({
  apiKey: 'YOUR_API_KEY',
});

async function enterYearnVault() {
  // First, get the transaction data
  const routeData = await enso.getRouterData({
    fromAddress: '0xYourWalletAddress',
    receiver: '0xYourWalletAddress',
    spender: '0xYourWalletAddress',
    chainId: 1,
    amountIn: '1000000000000000000', // 1 ETH
    tokenIn: '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee', // ETH
    tokenOut: '0xa258C4606Ca8206D8aA700cE2143D7db854D168c', // yvWETH
    slippage: 50,
    routingStrategy: 'router',
  });
  
  // The routeData.tx object can now be sent using your preferred web3 library
  // Example with ethers.js:
  // const provider = new ethers.providers.Web3Provider(window.ethereum);
  // const signer = provider.getSigner();
  // const tx = await signer.sendTransaction(routeData.tx);
  // await tx.wait();
  
  console.log('Transaction data:', routeData.tx);
  console.log('Expected yvWETH amount:', routeData.amountOut);
}

enterYearnVault();

​

Core Concepts

The Enso SDK abstracts complex DeFi operations through several key components:

1. EnsoClient: The main entry point for all SDK functionalities
2. Routing: Determines the most efficient path for token conversions
3. Approvals: Manages token allowances for DeFi interactions
4. Quotes: Provides price quotes without executing transactions
5. Token Data: Retrieves detailed information about tokens and protocols

​

Methods Reference

Below are the primary methods available in the EnsoClient:

​

getRouterData(params: RouteParams)

Calculates the optimal route for entering or exiting any DeFi position or swapping tokens. Returns transaction data ready for submission to the blockchain.

const routeData = await enso.getRouterData({
  fromAddress: '0xYourWalletAddress',
  receiver: '0xYourWalletAddress',
  spender: '0xYourWalletAddress',
  chainId: 1,
  amountIn: '1000000000000000000', // 1 ETH in wei
  tokenIn: '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee', // ETH
  tokenOut: '0x6b175474e89094c44da98b954eedeac495271d0f', // DAI
  slippage: 50, // 0.5%
  routingStrategy: 'router', // Options: 'router', 'delegate', 'ensowallet'
});

​

getQuoteData(params: QuoteParams)

Provides a quote for a potential swap without requiring token approvals. Useful for showing prices before executing transactions.

const quote = await enso.getQuoteData({
  chainId: 1,
  fromAddress: '0xYourWalletAddress',
  tokenIn: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', // WETH
  tokenOut: '0x6b175474e89094c44da98b954eedeac495271d0f', // DAI
  amountIn: '1000000000000000000', // 1 WETH in wei
});

​

getApprovalData(params: ApproveParams)

Generates transaction data for approving tokens to be spent by Enso contracts.

const approvalData = await enso.getApprovalData({
  fromAddress: '0xYourWalletAddress',
  tokenAddress: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', // WETH
  chainId: 1,
  amount: '1000000000000000000', // 1 WETH in wei
  routingStrategy: 'router',
});

​

getBalances(params: BalanceParams)

Retrieves token balances for a given wallet address.

const balances = await enso.getBalances({
  chainId: 1,
  eoaAddress: '0xYourWalletAddress',
  useEoa: true, // true for EOA, false for Enso Smart Wallet
});

​

getTokenData(params: TokenParams)

Fetches detailed information about tokens, including DeFi tokens and their underlying assets.

const tokens = await enso.getTokenData({
  chainId: 1,
  address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', // USDC
  includeMetadata: true,
});

​

getPriceData(params: PriceParams)

Gets the current price data for a specific token.

const price = await enso.getPriceData({
  chainId: 1,
  address: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', // WETH
});

​

getProtocolData(params?: ProtocolParams)

Retrieves information about DeFi protocols supported by Enso.

// Get all protocols
const allProtocols = await enso.getProtocolData();

// Get a specific protocol
const aaveProtocol = await enso.getProtocolData({
  slug: 'aave-v2',
});

​

Key Features

• Token Routing: Find the best path for token swaps across multiple DEXs and liquidity pools
• DeFi Position Management: Enter, exit, and manage DeFi positions (lending, farming, staking)
• Token Data: Access comprehensive token information including prices, balances, and metadata
• Transaction Building: Generate executable transaction data for wallets and smart contracts
• Protocol Interactions: Easily interact with supported DeFi protocols using standardized interfaces

​

Next Steps

Explore these resources to fully leverage the Enso SDK:

• Routing Strategies - Learn about the different routing options (router, delegate, ensowallet) and when to use each one
• Available Actions for Bundle API - Explore all supported DeFi actions like swaps, deposits, borrows, and more
• Shortcuts - See practical examples of common DeFi operations implemented with the SDK
• Non-tokenized Positions - Discover how to interact with non-tokenized DeFi positions like Aave borrows or Liquity CDPs
• GitHub Repository - Access the source code, report issues, or contribute to the SDK
• Developer Chat - Join our Telegram group for technical support and discussions