/sdk

LI.FI - Bridge & DEX aggregation: Any-to-Any Cross-Chain-Swap SDK

Primary LanguageTypeScriptApache License 2.0Apache-2.0

license npm latest package npm downloads Follow on Twitter

LI.FI - SDK

LI.FI Any-to-Any Cross-Chain-Swap SDK
Please checkout the SDK docs and our API reference for further information.

Installation

yarn add @lifi/sdk

or

npm install --save @lifi/sdk

Summary

This package allows accessing to LI.FI API which finds the best cross-chain routes on different bridges. The routes can then be executed via the SDK. Learn more about LI.FI on (https://li.fi).

Check out the Changelog to see what changed in the last releases.

Extend the SDK

Install dependencies:

yarn

Test

Test your code with Jest framework:

yarn test

Build

Build production (distribution) files in your dist folder:

yarn build

Publish

In order to update the package, commit all new changes first. Then run the following command:

yarn release

This will

  • bump the version number according to the types of the last commits (i.e. if it is a major, minor or bug fix release)
  • create a new git tag
  • update the CHANGELOG.md

Next you need to push both, the code and the new version tag:

git push && git push --tags