SDK Reference@streamflow/stream
index
Core vesting, locks, and streaming payments — SolanaStreamClient, composable API functions, and all stream types.
@streamflow/stream v11.3.1
Classes
Enumerations
Interfaces
- Account
- ApiClient
- ApiClientOptions
- BatchCreationItem
- BatchExecuteResult
- BatchInstructionResult
- BatchItem
- BatchItemError
- BatchItemSuccess
- BuildTransactionOptions
- BuiltTransaction
- ClientCreationOptions
- ContractSchema
- CreateInstructionResult
- DecodedStream
- DynamicContractSchema
- GetContractsOptions
- IBaseStreamConfig
- ICreateExt
- ICreateLockBatchParams
- ICreateLockParams
- ICreateMultiError
- ICreateResult
- ICreateStreamExt
- ICreateStreamInstructions
- ICreateVestingBatchParams
- ICreateVestingParams
- IFees
- IGetAllData
- IGetFeesData
- IInteractData
- IInteractStreamExt
- ILockBatchRecipient
- IMultiTransactionResult
- InstructionResult
- IPrepareCreateStreamExt
- IPrepareStreamExt
- IRecipient
- ISearchStreams
- ITopUpData
- ITopUpStreamExt
- ITransactionExtWithInstructions
- ITransactionResult
- ITransferData
- IUpdateData
- IVestingBatchRecipient
- IWithdrawData
- LinearStream
- MetadataRecipientHashMap
- NativeOptions
- StreamClientOptions
- StreamClientOptionsWithConnection
- TabulariumContract
- TransactionSchedulingOptions
Type Aliases
- AlignedStream
- AlignedStreamData
- AlignedUnlocksContract
- BatchItemResult
- BuildTransactionFn
- CancelFn
- Chain
- ChangeOracleParams
- ContractType
- CreateBatchFn
- CreateFn
- CreateParams
- CreateTestOracleParams
- Env
- ExecuteBatchFn
- ExecuteBatchSequentialFn
- ExecuteFn
- ExecutionEnv
- IAlignedStreamConfig
- ICancelData
- ICreateAlignedStreamData
- ICreateLinearStreamData
- ICreateMultipleAlignedStreamData
- ICreateMultipleLinearStreamData
- ICreateMultipleStreamData
- ICreateStreamData
- IGetOneData
- InstructionGenerator
- Invoker
- OracleType
- OracleTypeName
- PriceOracleType
- SignFn
- Stream
- TestOracle
- TopupFn
- TransferFn
- UpdateFn
- UpdateTestOracleParams
- WithdrawFn
Variables
- AIRDROP_AMOUNT
- AIRDROP_TEST_TOKEN
- ALIGNED_COMPUTE_LIMIT
- ALIGNED_PRECISION_FACTOR_POW
- ALIGNED_UNLOCKS_PROGRAM_ID
- CONTRACT_DISCRIMINATOR
- CONTRACT_SEED
- CREATE_PARAMS_PADDING
- DEFAULT_AUTO_CLAIM_FEE_SOL
- DEFAULT_CREATION_FEE_SOL
- DEFAULT_STREAMFLOW_FEE
- ESCROW_SEED
- FEE_ORACLE_PUBLIC_KEY
- FEES_METADATA_SEED
- getBN
- getNumberFromBN
- MAX_SAFE_UNIX_TIME_VALUE
- METADATA_SEED
- ORIGINAL_CONTRACT_SENDER_OFFSET
- PARTNER_ORACLE_PROGRAM_ID
- PARTNER_SCHEMA
- PARTNERS_SCHEMA
- PROGRAM_ID
- REPOPULATED_METADATA_SEED
- SOLANA_ERROR_MAP
- SOLANA_ERROR_MATCH_REGEX
- STREAM_STRUCT_OFFSET_CLOSED
- STREAM_STRUCT_OFFSET_MINT
- STREAM_STRUCT_OFFSET_OLD_METADATA_KEY
- STREAM_STRUCT_OFFSET_RECIPIENT
- STREAM_STRUCT_OFFSET_SENDER
- STREAM_STRUCT_OFFSETS
- STREAMFLOW_TREASURY_PUBLIC_KEY
- TEST_ORACLE_DISCRIMINATOR
- TEST_ORACLE_SEED
- timelockIDL
- TX_FINALITY_CONFIRMED
- WITHDRAW_AVAILABLE_AMOUNT
- WITHDRAWOR
- WITHDRAWOR_PUBLIC_KEY
Functions
- buildLockBatchParams
- buildLockParams
- buildStreamType
- buildTransaction
- buildVestingBatchParams
- buildVestingParams
- calculateTotalAmountToDeposit
- calculateUnlockedAmount
- cancel
- cancelStreamInstruction
- computeAmountPerPeriod
- create
- createBatch
- createClient
- createClientFromEnv
- createLock
- createLockBatch
- createStreamInstruction
- createStreamV2Instruction
- createUncheckedStreamInstruction
- createUncheckedStreamV2Instruction
- createVesting
- createVestingBatch
- decodeEndTime
- decodeStream
- deriveContractPDA
- deriveEscrowPDA
- deriveRepopulatedMetadataPDA
- deriveStreamMetadataPDA
- deriveTestOraclePDA
- execute
- executeBatch
- executeBatchSequential
- extractSolanaErrorCode
- getMetadataKey
- handleContractError
- isAligned
- isCliffCloseToDepositedAmount
- isCreateAlignedStreamData
- isDynamicLock
- isTokenLock
- isVesting
- resolveConnection
- resolveDuration
- sendAndConfirmStreamRawTransaction
- sign
- signAllTransactionWithRecipients
- topup
- topupStreamInstruction
- transfer
- transferStreamInstruction
- transformContract
- update
- updateStreamInstruction
- withdraw
- withdrawStreamInstruction