alphaswap-sdk/README.md

🛠 An SDK for building applications on top of Uniswap on KCC.

## 🧱 Alpha Swap SDK 🧱


### Getting Started

Simply install alphaswap-sdk via npm.

```
npm install alphaswap-sdk
```

### Address Modifications

When deploying a new instance on KCC, you need to modify the address in the following files:

WETH: `./src/entities/token.ts`


Factory: `./src/constants.ts`

### Running tests

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

### First clone the repository:

```sh
git clone https://github.com/cusdt-LINK/alphaswap-sdk
```

### Move into the alphaswap-sdk working directory

```sh
cd alphaswap-sdk/
```

### Install dependencies

```sh
yarn install
```

### Run tests

```sh
yarn test
```

### You should see output like:

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