LKL SDK

⚠️ This is a work in progress! ⚠️

This repo provides an SDK for developers to use when interacting with and building on Lockless smart contracts.

Install

npm install git+https://github.com/LocklessFinance/lkl-sdk.git
npm run generate-interfaces

Since this repo is not an npm package, it can be helpful to include this simple script to upgrade your project to the latest commit:

 "scripts": {
    "update-lkl-sdk": "npm install git+https://github.com/LocklessFinance/lkl-sdk.git"
  },

Build

npm run build

Configure

To use the Lockless SDK you need to configure some env variables. For linux and mac run the following:

1. Copy lkl.default.env

cp lkl.default.env lkl.env

2. Update lkl.env with your private key and alchemy api key

export MAINNET_PROVIDER_URL=[MAINNET_PROVIDER_URL_HERE]
export GOERLI_PROVIDER_URL=[GOERLI_PROVIDER_URL_HERE]
export PRIVATE_KEY=[PRIVATE_KEY_HERE]

3. Source the env file

source lkl.env

Run Example Script:

npx hardhat run examples/poolDetails.ts --network mumbai