Client SDKsTypescript client SDK
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 envs (like React Native).
Quick links
Installation
npm install @superstream/client
npm install @superstream/client
Usage
- Create a
SuperstreamClient
SuperstreamClient
. For more information, view the API documentation
superstream.ts
import { createSuperstreamClient,} from "@superstream/client";const client = createSuperstreamClient("devnet", wallet);// For mainnet-beta, use://// const client = createSuperstreamClient(// "mainnet-beta",// wallet,// );// If you don't need to execute instructions (like creating// or cancelling a stream), you can omit the wallet://// const client = createSuperstreamClient("devnet");
import { createSuperstreamClient,} from "@superstream/client";const client = createSuperstreamClient("devnet", wallet);// For mainnet-beta, use://// const client = createSuperstreamClient(// "mainnet-beta",// wallet,// );// If you don't need to execute instructions (like creating// or cancelling a stream), you can omit the wallet://// const client = createSuperstreamClient("devnet");
- Fetch streams and do other operations using the client. For more information, view the API documentation
superstream.ts
const streams = await client .getAllStreams({ isPrepaid: true, recipient: new PublicKey("public-key-base-58"), });
const streams = await client .getAllStreams({ isPrepaid: true, recipient: new PublicKey("public-key-base-58"), });
- Do operations on streams. For more information, view the API documentation
superstream.ts
const stream = streams[0]// Get stream public keystream.getStreamPublicKey()// Check is current wallet is this stream's senderstream.isSender()// ... and other operations// Get current on-chain time to do even more operations on// streamsconst currentTime = await client.mustGetCurrentTime()// Check if stream has stoppedstream.hasStopped()// Check if stream is solventstream.isSolvent()// Cancel streamawait stream.cancel()// ... and other operations
const stream = streams[0]// Get stream public keystream.getStreamPublicKey()// Check is current wallet is this stream's senderstream.isSender()// ... and other operations// Get current on-chain time to do even more operations on// streamsconst currentTime = await client.mustGetCurrentTime()// Check if stream has stoppedstream.hasStopped()// Check if stream is solventstream.isSolvent()// Cancel streamawait stream.cancel()// ... and other operations