Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/streamflow-finance/js-sdk
Web3 Distribution Layer. For Token vesting and Airdrops
https://github.com/streamflow-finance/js-sdk
money-stream money-streaming solana solana-token spl-token stream-payments token-vesting vesting vesting-schedule
Last synced: about 1 month ago
JSON representation
Web3 Distribution Layer. For Token vesting and Airdrops
- Host: GitHub
- URL: https://github.com/streamflow-finance/js-sdk
- Owner: streamflow-finance
- License: gpl-3.0
- Created: 2021-08-25T15:40:45.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-24T16:10:34.000Z (about 2 months ago)
- Last Synced: 2024-07-24T18:37:19.770Z (about 2 months ago)
- Topics: money-stream, money-streaming, solana, solana-token, spl-token, stream-payments, token-vesting, vesting, vesting-schedule
- Language: TypeScript
- Homepage: https://app.streamflow.finance
- Size: 2.83 MB
- Stars: 101
- Watchers: 9
- Forks: 26
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Streamflow
Streamflow is a token vesting and streaming payments platform.
There are several ways to use **Streamflow**:
- **(easiest) [app.streamflow.finance](https://app.streamflow.finance?utm_medium=github.com&utm_source=referral&utm_campaign=js-sdk-repo)** (React application that uses JS SDK directly)
- **[JS SDK](https://github.com/streamflow-finance/js-sdk)** to interact with the protocol => [NPM package](https://www.npmjs.com/package/@streamflow/stream)
- **[Rust SDK](https://github.com/streamflow-finance/rust-sdk)** to integrate within a Solana program => [Rust Crate](https://docs.rs/streamflow-sdk/)**Security audit passed ✅**
Protocol audits available [here](https://www.notion.so/streamflow/Streamflow-Security-Audits-3250070c0b3a4a0690385d96316d645c).
Partner oracle audit available here [here](https://github.com/streamflow-finance/rust-sdk/blob/main/partner_oracle_audit.pdf).## Documentation
API Documentation available here: [docs site →](https://streamflow-finance.github.io/js-sdk/)## 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` - Distirbutor 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
### Instal 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`