Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 3.21 KB

README.md

File metadata and controls

83 lines (56 loc) · 3.21 KB
Raw

license npm latest package npm downloads Follow on Twitter

LI.FI SDK

LI.FI SDK provides a powerful toolkit for developers to enable seamless cross-chain and on-chain swaps and bridging within their applications. Our JavaScript/TypeScript SDK can be implemented in front-end or back-end environments, allowing you to build robust UX/UI around our advanced bridge and swap functionalities. LI.FI SDK efficiently manages all communications between our smart routing API and smart contracts and ensures optimal performance, security, and scalability for your cross-chain and on-chain needs.

LI.FI SDK features include:

  • All ecosystems, chains, bridges, exchanges, and solvers that LI.FI supports
  • Complete functionality covering full-cycle from obtaining routes/quotes to executing transactions
  • Easy tracking of the route and quote execution through the robust event and hooks handling
  • Highly customizable settings to tailor the SDK to your specific needs including configuration of RPCs and options to allow or deny certain chains, tokens, bridges, exchanges, solvers
  • SDK ecosystem providers are based on industry-standard libraries (Viem, Solana Wallet Standard)
  • Support for arbitrary contract calls on the destination chain
  • Designed for optimal performance with tree-shaking and dead-code elimination, ensuring minimal bundle sizes and faster page load times in front-end environments
  • Compatibility tested with Node.js and popular front-end tools like Vite

Installation

pnpm add @lifi/sdk

or

npm install --save @lifi/sdk

Quick Start

Set up the SDK

Firstly, create SDK config with your integrator string.

import { createConfig } from '@lifi/sdk'

createConfig({
  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({
  fromAddress: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045',
  fromChain: ChainId.ARB,
  toChain: ChainId.OPT,
  fromToken: '0x0000000000000000000000000000000000000000',
  toToken: '0x0000000000000000000000000000000000000000',
  fromAmount: '1000000000000000000',
})

Examples

See examples folder in this repository.

Documentation

Please checkout the SDK documentation and our API reference for further information.

Changelog

The changelog is regularly updated to reflect what's changed in each new release.

License

This project is licensed under the terms of the Apache-2.0.