Optional
cluster: IClusterOptional
commitment: Commitment | ConnectionConfigOptional
programId: stringOptional
sendRate: numberOptional
sendThrottler: PQueueCreate Stream instance with options
Attempts canceling the specified stream.
Creates a new stream/vesting contract. All fees are paid by sender (escrow metadata account rent, escrow token account rent, recipient's associated token account rent, Streamflow's service fee).
Creates multiple stream/vesting contracts. All fees are paid by sender (escrow metadata account rent, escrow token account rent, recipient's associated token account rent, Streamflow's service fee).
Creates multiple stream/vesting contracts, and send all transactions sequentially. All fees are paid by sender (escrow metadata account rent, escrow token account rent, recipient's associated token account rent, Streamflow's service fee). In most cases, createMultiple should be used instead.
Creates a new stream/vesting contract using unchecked instruction.
Unchecked instruction differs from the regular in:
If you are not sure if you should use create or create_unchecked, go for create to be safer.
Fetch streams/contracts by providing direction. Streams are sorted by start time in ascending order.
Fetch stream data by its id (address).
Returns total fee percent, streamflow fees + partner fees
structure with address for which we need to derive fee, either sender or partner usually
Optional
chainSpecificParams: anyadditional parameters required by chain client
fee as floating number, so if fee is 0.99%, it will return 0.99
Creates Transaction Instructions for cancel
Creates a new stream/vesting contract. All fees are paid by sender (escrow metadata account rent, escrow token account rent, recipient's associated token account rent, Streamflow's service fee).
Create Transaction instructions for createUnchecked
Create Transaction instructions for topup
Attempts changing the stream/vesting contract's recipient (effectively transferring the stream/vesting contract). Potential associated token account rent fee (to make it rent-exempt) is paid by the transaction initiator.
Create Transaction instructions for update
Creates Transaction Instructions for withdrawal
Tops up stream account with specified amount.
Attempts changing the stream/vesting contract's recipient (effectively transferring the stream/vesting contract). Potential associated token account rent fee (to make it rent-exempt) is paid by the transaction initiator.
Attempts updating the stream auto withdrawal params and amount per period
Attempts withdrawing from the specified stream.
Create Stream instance with flat arguments