/algofi-javascript-sdk

algofi-javascript-sdk is the official JavaScript SDK of the Algofi Lending V2 protocol. The SDK supports lending, borrowing, and participating in Algorand Foundation Governance / Consensus via the Algofi Vault. The SDK also provides access to live market analytics. The Python SDKs of all Algofi protocols (V1 Lending, AMM, Governance, Vault) will be migrated to this package.

Primary LanguageTypeScript

algofi-javascript-sdk

CircleCI

Official JavaScript SDK for the Algofi Protocol

Documentation

https://algofiorg.github.io/algofi-javascript-sdk

Design Goal

This SDK is useful for developers who want to programatically interact with the Algofi Protocol.

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-javascript-sdk.git && cd algofi-javascript-sdk
npm install
cd test && npm install && cd ..

Generate Documentation

To generate docs, cd into the root folder and run

npx typedoc src/index.ts