Install LI.FI SDK

The LI.FI SDK package provides access to the LI.FI API to find and execute the best on-chain and cross-chain routes across various bridges and exchanges.

Installation

yarn add @lifi/sdk

pnpm add @lifi/sdk

bun add @lifi/sdk

npm install @lifi/sdk

Ecosystem Providers

To execute transactions, install the provider packages for the ecosystems you need:

yarn add @lifi/sdk-provider-ethereum viem                               # For EVM chains
yarn add @lifi/sdk-provider-solana @wallet-standard/base                # For Solana
yarn add @lifi/sdk-provider-bitcoin @bigmi/core                         # For Bitcoin
yarn add @lifi/sdk-provider-sui @mysten/sui                             # For Sui
yarn add @lifi/sdk-provider-tron @tronweb3/tronwallet-abstract-adapter  # For Tron
yarn add @lifi/sdk-provider-stellar                                     # For Stellar (no ecosystem library needed)

pnpm add @lifi/sdk-provider-ethereum viem                               # For EVM chains
pnpm add @lifi/sdk-provider-solana @wallet-standard/base                # For Solana
pnpm add @lifi/sdk-provider-bitcoin @bigmi/core                         # For Bitcoin
pnpm add @lifi/sdk-provider-sui @mysten/sui                             # For Sui
pnpm add @lifi/sdk-provider-tron @tronweb3/tronwallet-abstract-adapter  # For Tron
pnpm add @lifi/sdk-provider-stellar                                     # For Stellar (no ecosystem library needed)

npm install @lifi/sdk-provider-ethereum viem                               # For EVM chains
npm install @lifi/sdk-provider-solana @wallet-standard/base                # For Solana
npm install @lifi/sdk-provider-bitcoin @bigmi/core                         # For Bitcoin
npm install @lifi/sdk-provider-sui @mysten/sui                             # For Sui
npm install @lifi/sdk-provider-tron @tronweb3/tronwallet-abstract-adapter  # For Tron
npm install @lifi/sdk-provider-stellar                                     # For Stellar (no ecosystem library needed)

Provider packages are only required if you want to execute routes/quotes through the SDK. If you only need to request routes, quotes, or other API data, the core @lifi/sdk package is sufficient.

Each provider bundles its ecosystem library, but you configure a provider by handing it a wallet or client object that you construct. Anything you import in your own code must be a direct dependency — package managers that do not hoist transitive packages, such as pnpm, will otherwise fail to resolve it. That is why the ecosystem library is installed alongside the provider above.The Stellar provider is the exception: it takes a small StellarWallet interface it defines itself. To discover and connect browser wallets such as Freighter, xBull, or Lobstr, also install Stellar Wallets Kit (@creit.tech/stellar-wallets-kit), which the Stellar examples import.

Check out our complete examples in the SDK repository, and feel free to file an issue if you encounter any problems.

Quick Start

Set up the SDK

Firstly, create SDK client with your integrator string.

import { createClient } from '@lifi/sdk';

const client = createClient({
  integrator: 'Your dApp/company name',
});

Request a quote

Now you can interact with the SDK and for example request a quote.

import { ChainId, getQuote } from '@lifi/sdk';

const quote = await getQuote(client, {
  fromAddress: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045',
  fromChain: ChainId.ARB,
  toChain: ChainId.OPT,
  fromToken: '0x0000000000000000000000000000000000000000',
  toToken: '0x0000000000000000000000000000000000000000',
  fromAmount: '1000000000000000000',
});

You can learn more about configuring the SDK in the next section.

Getting Started

Using the SDK

Misc.

Install LI.FI SDK

Installation

Ecosystem Providers

Quick Start

​Installation

​Ecosystem Providers

​Quick Start

Installation

Ecosystem Providers

Quick Start