Superstream typescript client SDK

What is Superstream?

Superstream is a protocol and a collection of SDKs for real-time money streaming on Solana. It allows anyone to continuously send money to anyone else at any interval upto a second.

Superstream protocol is completely open-source. View it on GitHub.

Learn more about Superstream on superstream.finance.

What is Superstream typescript client SDK?

A typescript SDK to interact with on-chain Superstream program. Developers would use this typically when they want to create a typescript app and integrate streams into that. It's compatible with browsers and native environments (like React Native).

Installation

1# npm
2npm install @superstream/client
3
4# pnpm
5pnpm install @superstream/client
6
7# yarn
8yarn add @superstream/client

Usage

• Create a SuperstreamClient. For complete API documentation, click here

1import { createSuperstreamClient } from '@superstream/client'
2
3const client = createSuperstreamClient('devnet', wallet)
4
5// For mainnet-beta, use:
6// const client = createSuperstreamClient("mainnet-beta", wallet)
7
8// If you don't need to execute instructions (like creating or cancelling a stream), you can omit the wallet
9// const client = createSuperstreamClient("devnet")

• Fetch streams and do other operations using the client. For complete API documentation, click here

1const streams = await client.getAllStreams({ isPrepaid: true, recipient: new PublicKey('public-key-base-58') })

• Do operations on streams. For complete API documentation, click here

1const stream = streams[0]
2
3// Get stream public key
4stream.getStreamPublicKey()
5// Check is current wallet is this stream's sender
6stream.isSender()
7// ... and other operations
8
9// Get current on-chain time to do even more operations on streams
10const currentTime = await client.mustGetCurrentTime()
11
12// Check if stream has stopped
13stream.hasStopped()
14// Check if stream is solvent
15stream.isSolvent()
16// Cancel stream
17await stream.cancel()
18// ... and other operations