Streamflow

Streamflow is a token vesting and streaming payments platform.

There are several ways to use Streamflow:

• (easiest) app.streamflow.finance (React application that uses JS SDK directly)
• JS SDK to interact with the protocol => NPM package
• Rust SDK to integrate within a Solana program => Rust Crate

Security audit passed ✅

Protocol audits available here.
Partner oracle audit available here.

Documentation

API Documentation available here: docs site →

JS SDK to interact with Streamflow protocols

This repo consists of js-sdk to interact with several protocol exposed by streamflow:

• packages/stream - Core Streamflow Protocol that allows to create a vesting/payment/lock Stream to a Recipient;
• packages/distributor - Distributor Streamflow Protocol that allows to Airdrop tokens to large amount of Recipients (thousands or even millions);
• packages/common - Common utilities and types used by Streamflow SDK;

Installation

Install Stream Protocol SDK

npm i -s @streamflow/stream
# or
yarn add @streamflow/stream

Install Distributor Protocol SDK

npm i -s @streamflow/common @streamflow/distributor
# or
yarn add @streamflow/common @streamflow/distributor

Environments

For web browser runtimes polyfills might be required. SDKs use node: prefixed modules, for instance: node:crypto. However, transitive 3rd parties might use non-prefixed modules so both ways of importing should be polyfilled.

The easiest way to achieve it is using a bundler's plugin. For polyfills take a look on these libraries:

1. Vite - https://www.npmjs.com/package/vite-plugin-node-polyfills
2. Rsbuild - https://github.com/rspack-contrib/rsbuild-plugin-node-polyfill
3. Webpack - https://www.npmjs.com/package/node-polyfill-webpack-plugin

Contributing

To contribute to this repository, please follow these steps:

1. Fork the repository
2. Clone your forked repository
3. Navigate to the /packages folder
4. Install dependencies using pnpm:

   pnpm install

5. Build the project:

   pnpm build

6. Make your changes
7. Commit and push your changes
8. Create a pull request

Please ensure that you have pnpm installed on your system before contributing.

News

Stay updated on our X/Twitter.