README.md

Polarfox SDK

In-depth documentation on this SDK is being written and will be available soon.

Running tests

To run the tests, follow these steps. You must have at least node v10 and yarn installed.

First clone the repository:

git clone https://github.com/Polarfox-DEX/polarfox-sdk.git

Move into the polarfox-sdk working directory

cd polarfox-sdk/

Install dependencies

yarn install

Run tests

yarn test

You should see output like the following:

yarn run v1.22.10
$ tsdx test
 PASS  test/constants.test.ts    
 PASS  test/route.test.ts
 PASS  test/token.test.ts
 PASS  test/miscellaneous.test.ts
 PASS  test/router.test.ts
 PASS  test/entities.test.ts
 PASS  test/fraction.test.ts
 PASS  test/trade.test.ts
 PASS  test/pair.test.ts

Test Suites: 1 skipped, 9 passed, 9 of 10 total
Tests:       3 skipped, 124 passed, 127 total
Snapshots:   0 total
Time:        8.121s
Ran all test suites.
Done in 6.61s.