🛠 An SDK for building applications on top of Oikos Swap.

Usage no npm install needed!

<script type="module">
  import oikosSwapSdk from 'https://cdn.skypack.dev/@oikos/swap-sdk';


Oikos Swap SDK

code style: prettier Actions Status npm version npm bundle size (scoped version)

Port of Uniswap SDK for Tron.

In-depth documentation on this SDK is available at uniswap.org.


npm install @oikos/swap-sdk

Adding a pair

Add liquidity to the pair using https://swap2.oikos.cash (ignore the alert message). Add the pair here, see this commit.

Running tests

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

First clone the repository:

git clone https://github.com/oikos-cash/swap-sdk.git

Move into the swap-sdk working directory

cd swap-sdk/

Install dependencies

npm install

Run tests

npm test

You should see output like the following:

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