x0oo11235oo0x / algofi-amm-js-sdk

algofi-amm-js-sdk is the official JavaScript SDK of the Algofi AMM protocol. The SDK supports swapping, stable swapping, and liquidity providing. The SDK also provides access to live pool analytics.

algofi-amm-js-sdk

Official Javascript SDK for the Algofi AMM + NanoSwap protocols

Documentation

https://algofiorg.github.io/algofi-amm-js-sdk/

Design Goal

This SDK is useful for developers who want to programatically interact with the Algofi AMM + NanoSwap protocols.

Status

This SDK is currently under active early development and should not be considered stable.

Installation

Node.js

git clone git@github.com:Algofiorg/algofi-amm-js-sdk.git && cd algofi-amm-js-sdk
npm install
cd test && npm install && cd ..

Generate Documentation

To generate docs, cd into the root folder and run

npx typedoc --out docs src/index.ts

License

algofi-amm-js-sdk is licensed under a MIT license except for the exceptions listed below. See the LICENSE file for details.

x0oo11235oo0x / algofi-amm-js-sdk