# @locklessfi/sdk

> [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/LocklessFinance/lkl-sdk/blob/master/LICENSE)

Latest version **1.0.3-alpha.2** (published 2022-04-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install @locklessfi/sdk
pnpm add @locklessfi/sdk
yarn add @locklessfi/sdk
bun add @locklessfi/sdk
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3-alpha.2 |
| Published | 2022-04-04 |
| First published | 2022-04-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 587.5 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | lienhage |

## Links

- npm: https://www.npmjs.com/package/@locklessfi/sdk
- npm.io page: https://npm.io/package/@locklessfi/sdk

## Dependencies (8)

- [tsc](https://npm.io/package/tsc.md) ^2.0.4
- [axios](https://npm.io/package/axios.md) ^0.24.0
- [date-fns](https://npm.io/package/date-fns.md) ^2.25.0
- [ts-money](https://npm.io/package/ts-money.md) ^0.4.6
- [ntypescript](https://npm.io/package/ntypescript.md) ^1.201706190042.1
- [lodash.keyby](https://npm.io/package/lodash.keyby.md) ^4.6.0
- [@locklessfi/tokenlist](https://npm.io/package/@locklessfi/tokenlist.md) ^1.0.1
- [@locklessfi/core-typechain](https://npm.io/package/@locklessfi/core-typechain.md) ^1.0.2

## Recent versions

- 1.0.3-alpha.2 (latest) — 2022-04-04
- 1.0.3-alpha.1 — 2022-04-04
- 1.0.3 — 2022-04-04
- 1.0.2 — 2022-04-04
- 1.0.1 — 2022-04-04
- 1.0.0 — 2022-04-04

## README

# LKL SDK
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/LocklessFinance/lkl-sdk/blob/master/LICENSE)

**⚠️ 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

```bash
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

```bash
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`

```bash
cp lkl.default.env lkl.env
```

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

```bash
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

```bash
source lkl.env
```

## Run Example Script:

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

---
_Source: https://npm.io/package/@locklessfi/sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._