@bscswap/sdk/README.md

🛠 An SDK for building applications on top of BSCswap.

# BSCswap SDK

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Actions Status](https://github.com/bscswap/bscswap-sdk/workflows/CI/badge.svg)](https://github.com/bscswap/bscswap-sdk)
[![npm version](https://img.shields.io/npm/v/@bscswap/sdk/latest.svg)](https://www.npmjs.com/package/@bscswap/sdk/v/latest)
[![npm bundle size (scoped version)](https://img.shields.io/bundlephobia/minzip/@bscswap/sdk/latest.svg)](https://bundlephobia.com/result?p=@bscswap/sdk@latest)

Common library used accross for BSCswap Frontend implementation [https://github.com/bscswap/bscswap-interface](https://github.com/bscswap/bscswap-interface).

In-depth documentation on this SDK is available at [uniswap.org](https://uniswap.org/docs/v2/SDK/getting-started/).

## Running tests

To run the tests, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.

First clone the repository:

```sh
git clone https://github.com/bscswap/bscswap-sdk.git
```

Move into the uniswap-sdk working directory

```sh
cd bscswap-sdk/
```

Install dependencies

```sh
yarn install
```

Run tests

```sh
yarn test
```

You should see output like the following:

```sh
yarn run v1.22.4
$ tsdx test
 PASS  test/constants.test.ts
 PASS  test/pair.test.ts
 PASS  test/fraction.test.ts
 PASS  test/miscellaneous.test.ts
 PASS  test/entities.test.ts
 PASS  test/trade.test.ts

Test Suites: 1 skipped, 6 passed, 6 of 7 total
Tests:       3 skipped, 82 passed, 85 total
Snapshots:   0 total
Time:        5.091s
Ran all test suites.
✨  Done in 6.61s.
```