Readonly
getGet the Anchor provider used by the Superstream client.
The Anchor provider
Readonly
getGet the Solana connection used by the Superstream client.
The Solana connection
Readonly
getGet the public key of the Solana wallet used by the Superstream client. If no wallet was provided while creating the client, a default public key will be returned by this method.
The public key of the Solana wallet
Readonly
getGet the current Solana on-chain time in seconds. If there is an issue fetching the time, undefined is returned.
The current Solana on-chain time in seconds or undefined if there was an issue
Readonly
mustGet the current Solana on-chain time in seconds. If there is an issue fetching the time, an error is thrown.
The current Solana on-chain time in seconds
An error is thrown if there is an issue fetching the time
Readonly
maybeGet a stream by public key. If such a stream doesn't exist, undefined is returned. If there is a Solana RPC issue, an error is thrown.
The stream with the given public key or undefined if not found
An error is thrown if there is a Solana RPC issue
Readonly
getGet a stream by public key. If such a stream doesn't exist or there is a Solana RPC issue, an error is thrown.
The stream with the given public key
An error is thrown if a stream with the given public key doesn't exist or there is a Solana RPC issue.
Readonly
getGet multiple streams by public key. If some public keys don't exist, they are excluded from the return list. If there is a Solana RPC issue, an error is thrown.
The streams with the given public keys
An error is thrown if there is a Solana RPC issue
Readonly
getGet all streams that satisfy the given filters. If there is a Solana RPC issue, an error is thrown.
Optional
filters: StreamFiltersThe stream filters
The streams that satisfy the given filters
An error is thrown if there is a Solana RPC issue
Readonly
getGet all streams with pagination that satisfy the given filters. If there is a Solana RPC issue, an error is thrown.
Optional
filters: StreamFiltersThe stream filters
The StreamPagination object which returns all streams that satisfy the given filters
An error is thrown if there is a Solana RPC issue
Readonly
getGet the prepaid amount needed to create a new prepaid stream with the given parameters.
The on-chain time at which the prepaid amount calculation is needed
For more information on the parameters, look at the Stream class documentation
The prepaid amount needed to create a new prepaid stream with the given parameters
Readonly
getGet the deposit amount needed to create a new non-prepaid stream with the given parameters. For more information on the deposit needed, look at the DEPOSIT_AMOUNT_PERIOD_IN_SECS documentation.
The on-chain time at which the deposit amount calculation is needed
For more information on the parameters, look at the Stream class documentation
The deposit amount needed to create a new non-prepaid stream with the given parameters
Readonly
validateValidate the parameters to create a new prepaid stream.
The on-chain time at which the validation is needed
For more information on the parameters, look at the Stream class documentation
An error is thrown is a prepaid stream cannot be created with the given parameters
Readonly
validateValidate the parameters to create a new non-prepaid stream.
The on-chain time at which the validation is needed
The topupAmount
field is the amount that the stream would be topped up with. It should be >= amount
returned by getNonPrepaidDepositNeeded. For more information on the other
parameters, look at the Stream class documentation
An error is thrown is a non-prepaid stream cannot be created with the given parameters
Readonly
createCreate a new prepaid stream.
For more information on the parameters, look at the Stream class documentation
An error is thrown is a prepaid stream cannot be created with the given parameters or a user wallet wasn't provided to the Superstream client or there is a Solana RPC issue
Readonly
createCreate a new non-prepaid stream.
The topupAmount
field is the amount that the stream would be topped up with. It should be >= amount
returned by getNonPrepaidDepositNeeded. For more information on the other
parameters, look at the Stream class documentation
An error is thrown is a non-prepaid stream cannot be created with the given parameters or a user wallet wasn't provided to the Superstream client or there is a Solana RPC issue
Generated using TypeDoc
Superstream client is a client used to interact with on-chain Superstream stream data - fetch streams, create new streams and do operations on those streams. Look at the class methods for more information.