@folks-finance/algorand-sdk

The official JavaScript SDK for the Algorand Folks Finance protocol

Installation

Package manager

Using npm:

npm install @folks-finance/algorand-sdk

Using yarn:

yarn add @folks-finance/algorand-sdk

Using pnpm:

pnpm add @folks-finance/algorand-sdk

Using bun:

bun add @folks-finance/algorand-sdk

No extra setup is required if you're just using the sdk as a dependency in your project.

Documentation

Documentation is generated with TypeDoc and available at https://folks-finance.github.io/algorand-js-sdk/.

Running Examples (For Contributors)

If you've forked or cloned this repository, you can run the included examples:

1. Update examples/config.ts with your configuration.
2. Run an example, for example:

pnpm example examples/v2/liquidate.ts