# Streamflow Docs - [Streamflow JS SDK](/docs): TypeScript SDK for token vesting, locks, and streaming payments on Solana. - Overview - [What is Streamflow?](/docs/overview/what-is-streamflow): DeFi infrastructure for token distribution, vesting, staking, and airdrops on Solana. - [Architecture](/docs/overview/architecture): All 5 SDK packages, their dependency graph, API layers, and build output. - Getting Started - [Getting Started](/docs/getting-started): Install the SDK, set up your connection, and create your first stream. - [Installation](/docs/getting-started/installation): Install the Streamflow JS SDK packages - [Quick Setup](/docs/getting-started/quick-setup): Initialize SolanaStreamClient or build the composable API env - two approaches, one protocol. - [Authentication & Wallet Setup](/docs/getting-started/authentication): Keypairs, wallet adapters, and the Invoker type used for signing. - Basics - [Token Amounts & BN Conversions](/docs/getting-started/basics/bn-conversions): Using getBN and getNumberFromBN for correct decimal scaling on Solana. - [prepare* / execute Pattern](/docs/getting-started/basics/prepare-execute-pattern): How every Streamflow client separates instruction building from transaction execution - across stream, staking, and distributor packages. - [Fee System](/docs/getting-started/basics/fee-system): Protocol fees charged on stream creation, withdrawal, and cancellation. - [Stream Lifecycle](/docs/getting-started/basics/stream-lifecycle): State transitions, immutable creation flags, and which operations each flag gates. - Core Concepts - [Streams](/docs/core-concepts/streams): How Streamflow streams work on-chain - account structure, the lock/vesting distinction, and how the protocol classifies them at runtime. - Locks - [Locks](/docs/core-concepts/locks): Token locks - all-at-once release at a specific date or price trigger. - [Time-Based Locks](/docs/core-concepts/locks/time-based): Tokens locked until a Unix timestamp - single cliff release via createLock or SolanaStreamClient. - [Price-Based Locks](/docs/core-concepts/locks/price-based): Oracle-driven unlock conditions - tokens release when a price target is met. - [Guide: Create a Lock](/docs/core-concepts/locks/guide-create-lock): End-to-end walkthrough for creating a time-based token lock - composable API and SolanaStreamClient. - Vesting - [Vesting](/docs/core-concepts/vesting): Gradual token release on a configurable schedule with optional cliff and initial allocation. - [Time-Based Vesting](/docs/core-concepts/vesting/time-based): Linear token release on a period schedule with optional cliff and auto-withdrawal. - [Price-Based Vesting](/docs/core-concepts/vesting/price-based): Oracle-adjusted release amounts - each period scales based on the token price. - [Guide: Create a Vesting Stream](/docs/core-concepts/vesting/guide-create-vesting): End-to-end examples for simple vesting, initial allocation, and class-based creation. - Batch Creation - [Batch Creation](/docs/core-concepts/batch): Create locks or vesting streams for multiple recipients in a single atomic flow. - [Guide: Batch Locks & Vesting](/docs/core-concepts/batch/guide-batch): Full examples for batch lock and vesting creation - composable API and SolanaStreamClient. - Lifecycle Operations - [Lifecycle Operations](/docs/core-concepts/lifecycle): Withdraw, topup, transfer, update, and cancel - params, constraints, and return types for both APIs. - [Guide: Full Lifecycle](/docs/core-concepts/lifecycle/guide-lifecycle): Create a vesting stream then run withdraw, topup, transfer, and cancel - both APIs. - Composable APIs - [Composable APIs](/docs/composable-apis): 3-phase transaction model - get instructions, build, sign, and execute on Solana. - [create / createBatch](/docs/composable-apis/create): Low-level stream creation with full ICreateStreamData parameter control. - [createLock / createLockBatch](/docs/composable-apis/create-lock): ICreateLockParams interface, auto-set fields, and batch lock creation. - [createVesting / createVestingBatch](/docs/composable-apis/create-vesting): ICreateVestingParams, duration resolution, amountPerPeriod formula, and batch vesting. - [Lifecycle Operations](/docs/composable-apis/lifecycle-ops): withdraw, topup, transfer, cancel, and update - signatures, params, and constraints. - [buildTransaction / sign / execute](/docs/composable-apis/build-sign-execute): Full reference for the 3-phase transaction helpers - options, types, and batch execution. - [Public API Client](/docs/composable-apis/public-api-client): createClient - fetch stream contracts by sender or recipient from the Streamflow REST API. - SDK Reference - [SDK Reference](/docs/api): Auto-generated API reference for all @streamflow/* packages. - @streamflow/stream - [index](/docs/api/stream): Core vesting, locks, and streaming payments — SolanaStreamClient, composable API functions, and all stream types. - Classes - [AlignedContract](/docs/api/stream/classes/AlignedContract) - [Contract](/docs/api/stream/classes/Contract) - [ContractError](/docs/api/stream/classes/ContractError) - [SolanaStreamClient](/docs/api/stream/classes/SolanaStreamClient) - Enumerations - [AlignedProxyErrorCode](/docs/api/stream/enumerations/AlignedProxyErrorCode) - [ContractErrorCode](/docs/api/stream/enumerations/ContractErrorCode) - [ICluster](/docs/api/stream/enumerations/ICluster) - [StreamDirection](/docs/api/stream/enumerations/StreamDirection) - [StreamType](/docs/api/stream/enumerations/StreamType) - Functions - [buildLockBatchParams()](/docs/api/stream/functions/buildLockBatchParams) - [buildLockParams()](/docs/api/stream/functions/buildLockParams) - [buildStreamType()](/docs/api/stream/functions/buildStreamType) - [buildTransaction()](/docs/api/stream/functions/buildTransaction) - [buildVestingBatchParams()](/docs/api/stream/functions/buildVestingBatchParams) - [buildVestingParams()](/docs/api/stream/functions/buildVestingParams) - [calculateTotalAmountToDeposit()](/docs/api/stream/functions/calculateTotalAmountToDeposit) - [calculateUnlockedAmount()](/docs/api/stream/functions/calculateUnlockedAmount) - [cancel()](/docs/api/stream/functions/cancel) - [cancelStreamInstruction()](/docs/api/stream/functions/cancelStreamInstruction) - [computeAmountPerPeriod()](/docs/api/stream/functions/computeAmountPerPeriod) - [create()](/docs/api/stream/functions/create) - [createBatch()](/docs/api/stream/functions/createBatch) - [createClient()](/docs/api/stream/functions/createClient) - [createClientFromEnv()](/docs/api/stream/functions/createClientFromEnv) - [createLock()](/docs/api/stream/functions/createLock) - [createLockBatch()](/docs/api/stream/functions/createLockBatch) - [createStreamInstruction()](/docs/api/stream/functions/createStreamInstruction) - [createStreamV2Instruction()](/docs/api/stream/functions/createStreamV2Instruction) - [createUncheckedStreamInstruction()](/docs/api/stream/functions/createUncheckedStreamInstruction) - [createUncheckedStreamV2Instruction()](/docs/api/stream/functions/createUncheckedStreamV2Instruction) - [createVesting()](/docs/api/stream/functions/createVesting) - [createVestingBatch()](/docs/api/stream/functions/createVestingBatch) - [decodeEndTime()](/docs/api/stream/functions/decodeEndTime) - [decodeStream()](/docs/api/stream/functions/decodeStream) - [deriveContractPDA()](/docs/api/stream/functions/deriveContractPDA) - [deriveEscrowPDA()](/docs/api/stream/functions/deriveEscrowPDA) - [deriveRepopulatedMetadataPDA()](/docs/api/stream/functions/deriveRepopulatedMetadataPDA) - [deriveStreamMetadataPDA()](/docs/api/stream/functions/deriveStreamMetadataPDA) - [deriveTestOraclePDA()](/docs/api/stream/functions/deriveTestOraclePDA) - [execute()](/docs/api/stream/functions/execute) - [executeBatch()](/docs/api/stream/functions/executeBatch) - [executeBatchSequential()](/docs/api/stream/functions/executeBatchSequential) - [extractSolanaErrorCode()](/docs/api/stream/functions/extractSolanaErrorCode) - [getMetadataKey()](/docs/api/stream/functions/getMetadataKey) - [handleContractError()](/docs/api/stream/functions/handleContractError) - [isAligned()](/docs/api/stream/functions/isAligned) - [isCliffCloseToDepositedAmount()](/docs/api/stream/functions/isCliffCloseToDepositedAmount) - [isCreateAlignedStreamData()](/docs/api/stream/functions/isCreateAlignedStreamData) - [isDynamicLock()](/docs/api/stream/functions/isDynamicLock) - [isTokenLock()](/docs/api/stream/functions/isTokenLock) - [isVesting()](/docs/api/stream/functions/isVesting) - [resolveConnection()](/docs/api/stream/functions/resolveConnection) - [resolveDuration()](/docs/api/stream/functions/resolveDuration) - [sendAndConfirmStreamRawTransaction()](/docs/api/stream/functions/sendAndConfirmStreamRawTransaction) - [sign()](/docs/api/stream/functions/sign) - [signAllTransactionWithRecipients()](/docs/api/stream/functions/signAllTransactionWithRecipients) - [topup()](/docs/api/stream/functions/topup) - [topupStreamInstruction()](/docs/api/stream/functions/topupStreamInstruction) - [transfer()](/docs/api/stream/functions/transfer) - [transferStreamInstruction()](/docs/api/stream/functions/transferStreamInstruction) - [transformContract()](/docs/api/stream/functions/transformContract) - [update()](/docs/api/stream/functions/update) - [updateStreamInstruction()](/docs/api/stream/functions/updateStreamInstruction) - [withdraw()](/docs/api/stream/functions/withdraw) - [withdrawStreamInstruction()](/docs/api/stream/functions/withdrawStreamInstruction) - Interfaces - [Account](/docs/api/stream/interfaces/Account) - [ApiClient](/docs/api/stream/interfaces/ApiClient) - [ApiClientOptions](/docs/api/stream/interfaces/ApiClientOptions) - [BatchCreationItem](/docs/api/stream/interfaces/BatchCreationItem) - [BatchExecuteResult](/docs/api/stream/interfaces/BatchExecuteResult) - [BatchInstructionResult](/docs/api/stream/interfaces/BatchInstructionResult) - [BatchItem](/docs/api/stream/interfaces/BatchItem) - [BatchItemError](/docs/api/stream/interfaces/BatchItemError) - [BatchItemSuccess](/docs/api/stream/interfaces/BatchItemSuccess) - [BuildTransactionOptions](/docs/api/stream/interfaces/BuildTransactionOptions) - [BuiltTransaction](/docs/api/stream/interfaces/BuiltTransaction) - [ClientCreationOptions](/docs/api/stream/interfaces/ClientCreationOptions) - [ContractSchema](/docs/api/stream/interfaces/ContractSchema) - [CreateInstructionResult](/docs/api/stream/interfaces/CreateInstructionResult) - [DecodedStream](/docs/api/stream/interfaces/DecodedStream) - [DynamicContractSchema](/docs/api/stream/interfaces/DynamicContractSchema) - [GetContractsOptions](/docs/api/stream/interfaces/GetContractsOptions) - [IBaseStreamConfig](/docs/api/stream/interfaces/IBaseStreamConfig) - [ICreateExt](/docs/api/stream/interfaces/ICreateExt) - [ICreateLockBatchParams](/docs/api/stream/interfaces/ICreateLockBatchParams) - [ICreateLockParams](/docs/api/stream/interfaces/ICreateLockParams) - [ICreateMultiError](/docs/api/stream/interfaces/ICreateMultiError) - [ICreateResult](/docs/api/stream/interfaces/ICreateResult) - [ICreateStreamExt](/docs/api/stream/interfaces/ICreateStreamExt) - [ICreateStreamInstructions](/docs/api/stream/interfaces/ICreateStreamInstructions) - [ICreateVestingBatchParams](/docs/api/stream/interfaces/ICreateVestingBatchParams) - [ICreateVestingParams](/docs/api/stream/interfaces/ICreateVestingParams) - [IFees](/docs/api/stream/interfaces/IFees) - [IGetAllData](/docs/api/stream/interfaces/IGetAllData) - [IGetFeesData](/docs/api/stream/interfaces/IGetFeesData) - [IInteractData](/docs/api/stream/interfaces/IInteractData) - [IInteractStreamExt](/docs/api/stream/interfaces/IInteractStreamExt) - [ILockBatchRecipient](/docs/api/stream/interfaces/ILockBatchRecipient) - [IMultiTransactionResult](/docs/api/stream/interfaces/IMultiTransactionResult) - [IPrepareCreateStreamExt](/docs/api/stream/interfaces/IPrepareCreateStreamExt) - [IPrepareStreamExt](/docs/api/stream/interfaces/IPrepareStreamExt) - [IRecipient](/docs/api/stream/interfaces/IRecipient) - [ISearchStreams](/docs/api/stream/interfaces/ISearchStreams) - [ITopUpData](/docs/api/stream/interfaces/ITopUpData) - [ITopUpStreamExt](/docs/api/stream/interfaces/ITopUpStreamExt) - [ITransactionExtWithInstructions](/docs/api/stream/interfaces/ITransactionExtWithInstructions) - [ITransactionResult](/docs/api/stream/interfaces/ITransactionResult) - [ITransferData](/docs/api/stream/interfaces/ITransferData) - [IUpdateData](/docs/api/stream/interfaces/IUpdateData) - [IVestingBatchRecipient](/docs/api/stream/interfaces/IVestingBatchRecipient) - [IWithdrawData](/docs/api/stream/interfaces/IWithdrawData) - [InstructionResult](/docs/api/stream/interfaces/InstructionResult) - [LinearStream](/docs/api/stream/interfaces/LinearStream) - [MetadataRecipientHashMap](/docs/api/stream/interfaces/MetadataRecipientHashMap) - [NativeOptions](/docs/api/stream/interfaces/NativeOptions) - [StreamClientOptions](/docs/api/stream/interfaces/StreamClientOptions) - [StreamClientOptionsWithConnection](/docs/api/stream/interfaces/StreamClientOptionsWithConnection) - [TabulariumContract](/docs/api/stream/interfaces/TabulariumContract) - [TransactionSchedulingOptions](/docs/api/stream/interfaces/TransactionSchedulingOptions) - Type Aliases - [AlignedStream](/docs/api/stream/type-aliases/AlignedStream) - [AlignedStreamData](/docs/api/stream/type-aliases/AlignedStreamData) - [AlignedUnlocksContract](/docs/api/stream/type-aliases/AlignedUnlocksContract) - [BatchItemResult](/docs/api/stream/type-aliases/BatchItemResult) - [BuildTransactionFn](/docs/api/stream/type-aliases/BuildTransactionFn) - [CancelFn](/docs/api/stream/type-aliases/CancelFn) - [Chain](/docs/api/stream/type-aliases/Chain) - [ChangeOracleParams](/docs/api/stream/type-aliases/ChangeOracleParams) - [ContractType](/docs/api/stream/type-aliases/ContractType) - [CreateBatchFn](/docs/api/stream/type-aliases/CreateBatchFn) - [CreateFn](/docs/api/stream/type-aliases/CreateFn) - [CreateParams](/docs/api/stream/type-aliases/CreateParams) - [CreateTestOracleParams](/docs/api/stream/type-aliases/CreateTestOracleParams) - [Env](/docs/api/stream/type-aliases/Env) - [ExecuteBatchFn](/docs/api/stream/type-aliases/ExecuteBatchFn) - [ExecuteBatchSequentialFn](/docs/api/stream/type-aliases/ExecuteBatchSequentialFn) - [ExecuteFn](/docs/api/stream/type-aliases/ExecuteFn) - [ExecutionEnv](/docs/api/stream/type-aliases/ExecutionEnv) - [IAlignedStreamConfig](/docs/api/stream/type-aliases/IAlignedStreamConfig) - [ICancelData](/docs/api/stream/type-aliases/ICancelData) - [ICreateAlignedStreamData](/docs/api/stream/type-aliases/ICreateAlignedStreamData) - [ICreateLinearStreamData](/docs/api/stream/type-aliases/ICreateLinearStreamData) - [ICreateMultipleAlignedStreamData](/docs/api/stream/type-aliases/ICreateMultipleAlignedStreamData) - [ICreateMultipleLinearStreamData](/docs/api/stream/type-aliases/ICreateMultipleLinearStreamData) - [ICreateMultipleStreamData](/docs/api/stream/type-aliases/ICreateMultipleStreamData) - [ICreateStreamData](/docs/api/stream/type-aliases/ICreateStreamData) - [IGetOneData](/docs/api/stream/type-aliases/IGetOneData) - [InstructionGenerator](/docs/api/stream/type-aliases/InstructionGenerator) - [Invoker](/docs/api/stream/type-aliases/Invoker) - [OracleType](/docs/api/stream/type-aliases/OracleType) - [OracleTypeName](/docs/api/stream/type-aliases/OracleTypeName) - [PriceOracleType](/docs/api/stream/type-aliases/PriceOracleType) - [SignFn](/docs/api/stream/type-aliases/SignFn) - [Stream](/docs/api/stream/type-aliases/Stream) - [TestOracle](/docs/api/stream/type-aliases/TestOracle) - [TopupFn](/docs/api/stream/type-aliases/TopupFn) - [TransferFn](/docs/api/stream/type-aliases/TransferFn) - [UpdateFn](/docs/api/stream/type-aliases/UpdateFn) - [UpdateTestOracleParams](/docs/api/stream/type-aliases/UpdateTestOracleParams) - [WithdrawFn](/docs/api/stream/type-aliases/WithdrawFn) - Variables - [AIRDROP_AMOUNT](/docs/api/stream/variables/AIRDROP_AMOUNT): const AIRDROP_AMOUNT: 1 = 1; - [AIRDROP_TEST_TOKEN](/docs/api/stream/variables/AIRDROP_TEST_TOKEN): const AIRDROP_TEST_TOKEN: "Gssm3vfi8s65R31SBdmQRq6cKeYojGgup7whkw4VCiQj" = "Gssm3vfi8s65R31SBdmQRq6cKeYojGgup7whkw4VCiQj"; - [ALIGNED_COMPUTE_LIMIT](/docs/api/stream/variables/ALIGNED_COMPUTE_LIMIT): const ALIGNED_COMPUTE_LIMIT: 300000 = 300000; - [ALIGNED_PRECISION_FACTOR_POW](/docs/api/stream/variables/ALIGNED_PRECISION_FACTOR_POW): const ALIGNED_PRECISION_FACTOR_POW: 9 = 9; - [ALIGNED_UNLOCKS_PROGRAM_ID](/docs/api/stream/variables/ALIGNED_UNLOCKS_PROGRAM_ID): const ALIGNED_UNLOCKS_PROGRAM_ID: object; - [CONTRACT_DISCRIMINATOR](/docs/api/stream/variables/CONTRACT_DISCRIMINATOR): const CONTRACT_DISCRIMINATOR: number[]; - [CONTRACT_SEED](/docs/api/stream/variables/CONTRACT_SEED): const CONTRACT_SEED: Buffer; - [CREATE_PARAMS_PADDING](/docs/api/stream/variables/CREATE_PARAMS_PADDING): const CREATE_PARAMS_PADDING: 121 = 121; - [DEFAULT_AUTO_CLAIM_FEE_SOL](/docs/api/stream/variables/DEFAULT_AUTO_CLAIM_FEE_SOL): const DEFAULT_AUTO_CLAIM_FEE_SOL: 190000000 = 190_000_000; - [DEFAULT_CREATION_FEE_SOL](/docs/api/stream/variables/DEFAULT_CREATION_FEE_SOL): const DEFAULT_CREATION_FEE_SOL: 90000000 = 90_000_000; - [DEFAULT_STREAMFLOW_FEE](/docs/api/stream/variables/DEFAULT_STREAMFLOW_FEE): const DEFAULT_STREAMFLOW_FEE: 0.19 = 0.19; - [ESCROW_SEED](/docs/api/stream/variables/ESCROW_SEED): const ESCROW_SEED: Buffer; - [FEES_METADATA_SEED](/docs/api/stream/variables/FEES_METADATA_SEED): const FEES_METADATA_SEED: Buffer; - [FEE_ORACLE_PUBLIC_KEY](/docs/api/stream/variables/FEE_ORACLE_PUBLIC_KEY): const FEE_ORACLE_PUBLIC_KEY: object; - [MAX_SAFE_UNIX_TIME_VALUE](/docs/api/stream/variables/MAX_SAFE_UNIX_TIME_VALUE): const MAX_SAFE_UNIX_TIME_VALUE: 8640000000000 = 8640000000000; - [METADATA_SEED](/docs/api/stream/variables/METADATA_SEED): const METADATA_SEED: Buffer; - [ORIGINAL_CONTRACT_SENDER_OFFSET](/docs/api/stream/variables/ORIGINAL_CONTRACT_SENDER_OFFSET): const ORIGINAL_CONTRACT_SENDER_OFFSET: 9 = 9; - [PARTNERS_SCHEMA](/docs/api/stream/variables/PARTNERS_SCHEMA): const PARTNERS_SCHEMA: object; - [PARTNER_ORACLE_PROGRAM_ID](/docs/api/stream/variables/PARTNER_ORACLE_PROGRAM_ID): const PARTNER_ORACLE_PROGRAM_ID: object; - [PARTNER_SCHEMA](/docs/api/stream/variables/PARTNER_SCHEMA): const PARTNER_SCHEMA: object; - [PROGRAM_ID](/docs/api/stream/variables/PROGRAM_ID): const PROGRAM_ID: object; - [REPOPULATED_METADATA_SEED](/docs/api/stream/variables/REPOPULATED_METADATA_SEED): const REPOPULATED_METADATA_SEED: Buffer; - [SOLANA_ERROR_MAP](/docs/api/stream/variables/SOLANA_ERROR_MAP): const SOLANA_ERROR_MAP: object; - [SOLANA_ERROR_MATCH_REGEX](/docs/api/stream/variables/SOLANA_ERROR_MATCH_REGEX): const SOLANA_ERROR_MATCH_REGEX: RegExp; - [STREAMFLOW_TREASURY_PUBLIC_KEY](/docs/api/stream/variables/STREAMFLOW_TREASURY_PUBLIC_KEY): const STREAMFLOW_TREASURY_PUBLIC_KEY: PublicKey; - [STREAM_STRUCT_OFFSETS](/docs/api/stream/variables/STREAM_STRUCT_OFFSETS): const STREAM_STRUCT_OFFSETS: Record; - [STREAM_STRUCT_OFFSET_CLOSED](/docs/api/stream/variables/STREAM_STRUCT_OFFSET_CLOSED): const STREAM_STRUCT_OFFSET_CLOSED: 671 = 671; - [STREAM_STRUCT_OFFSET_MINT](/docs/api/stream/variables/STREAM_STRUCT_OFFSET_MINT): const STREAM_STRUCT_OFFSET_MINT: 177 = 177; - [STREAM_STRUCT_OFFSET_OLD_METADATA_KEY](/docs/api/stream/variables/STREAM_STRUCT_OFFSET_OLD_METADATA_KEY): const STREAM_STRUCT_OFFSET_OLD_METADATA_KEY: 714 = 714; - [STREAM_STRUCT_OFFSET_RECIPIENT](/docs/api/stream/variables/STREAM_STRUCT_OFFSET_RECIPIENT): const STREAM_STRUCT_OFFSET_RECIPIENT: 113 = 113; - [STREAM_STRUCT_OFFSET_SENDER](/docs/api/stream/variables/STREAM_STRUCT_OFFSET_SENDER): const STREAM_STRUCT_OFFSET_SENDER: 49 = 49; - [TEST_ORACLE_DISCRIMINATOR](/docs/api/stream/variables/TEST_ORACLE_DISCRIMINATOR): const TEST_ORACLE_DISCRIMINATOR: number[]; - [TEST_ORACLE_SEED](/docs/api/stream/variables/TEST_ORACLE_SEED): const TEST_ORACLE_SEED: Buffer; - [TX_FINALITY_CONFIRMED](/docs/api/stream/variables/TX_FINALITY_CONFIRMED): const TX_FINALITY_CONFIRMED: "confirmed" = "confirmed"; - [WITHDRAWOR](/docs/api/stream/variables/WITHDRAWOR): const WITHDRAWOR: "wdrwhnCv4pzW8beKsbPa4S2UDZrXenjg16KJdKSpb5u" = "wdrwhnCv4pzW8beKsbPa4S2UDZrXenjg16KJdKSpb5u"; - [WITHDRAWOR_PUBLIC_KEY](/docs/api/stream/variables/WITHDRAWOR_PUBLIC_KEY): const WITHDRAWOR_PUBLIC_KEY: PublicKey; - [WITHDRAW_AVAILABLE_AMOUNT](/docs/api/stream/variables/WITHDRAW_AVAILABLE_AMOUNT): const WITHDRAW_AVAILABLE_AMOUNT: BN; - [getBN](/docs/api/stream/variables/getBN): const getBN: (value, decimals) => BN; - [getNumberFromBN](/docs/api/stream/variables/getNumberFromBN): const getNumberFromBN: (value, decimals) => number; - [timelockIDL](/docs/api/stream/variables/timelockIDL): timelockIDL: object; - @streamflow/common - [index](/docs/api/common): Shared types, Solana transaction helpers, BN utilities, and PublicKey normalization used across all @streamflow packages. - Classes - [ContractError](/docs/api/common/classes/ContractError) - [TransactionFailedError](/docs/api/common/classes/TransactionFailedError) - Enumerations - [ICluster](/docs/api/common/enumerations/ICluster) - Functions - [assertHasPublicKey()](/docs/api/common/functions/assertHasPublicKey) - [ata()](/docs/api/common/functions/ata) - [ataBatchExist()](/docs/api/common/functions/ataBatchExist) - [buildPartnerOracle()](/docs/api/common/functions/buildPartnerOracle) - [buildSendThrottler()](/docs/api/common/functions/buildSendThrottler) - [checkOrCreateAtaBatch()](/docs/api/common/functions/checkOrCreateAtaBatch) - [confirmAndEnsureTransaction()](/docs/api/common/functions/confirmAndEnsureTransaction) - [createAndEstimateTransaction()](/docs/api/common/functions/createAndEstimateTransaction) - [createAtaBatch()](/docs/api/common/functions/createAtaBatch) - [createVersionedTransaction()](/docs/api/common/functions/createVersionedTransaction) - [deserializeRawTransaction()](/docs/api/common/functions/deserializeRawTransaction) - [divCeilN()](/docs/api/common/functions/divCeilN) - [enrichAtaParams()](/docs/api/common/functions/enrichAtaParams) - [estimateComputeUnitPrice()](/docs/api/common/functions/estimateComputeUnitPrice) - [executeMultipleTransactions()](/docs/api/common/functions/executeMultipleTransactions) - [executeTransaction()](/docs/api/common/functions/executeTransaction) - [fetchTokenPrice()](/docs/api/common/functions/fetchTokenPrice) - [generateCreateAtaBatchTx()](/docs/api/common/functions/generateCreateAtaBatchTx) - [getBN()](/docs/api/common/functions/getBN) - [getFilters()](/docs/api/common/functions/getFilters) - [getMintAndProgram()](/docs/api/common/functions/getMintAndProgram) - [getMultipleAccountsInfoBatched()](/docs/api/common/functions/getMultipleAccountsInfoBatched) - [getNumberFromBN()](/docs/api/common/functions/getNumberFromBN) - [getProgramAccounts()](/docs/api/common/functions/getProgramAccounts) - [handleContractError()](/docs/api/common/functions/handleContractError) - [isSignerKeypair()](/docs/api/common/functions/isSignerKeypair) - [isSignerWallet()](/docs/api/common/functions/isSignerWallet) - [isTransactionVersioned()](/docs/api/common/functions/isTransactionVersioned) - [multiplyBigIntByNumber()](/docs/api/common/functions/multiplyBigIntByNumber) - [pk()](/docs/api/common/functions/pk) - [prepareBaseInstructions()](/docs/api/common/functions/prepareBaseInstructions) - [prepareTransaction()](/docs/api/common/functions/prepareTransaction) - [prepareWrappedAccount()](/docs/api/common/functions/prepareWrappedAccount) - [resolveTransactionAccounts()](/docs/api/common/functions/resolveTransactionAccounts) - [sendAndConfirmTransaction()](/docs/api/common/functions/sendAndConfirmTransaction) - [signAndExecuteTransaction()](/docs/api/common/functions/signAndExecuteTransaction) - [signTransaction()](/docs/api/common/functions/signTransaction) - [simulateTransaction()](/docs/api/common/functions/simulateTransaction) - [sleep()](/docs/api/common/functions/sleep) - [unwrapExecutionParams()](/docs/api/common/functions/unwrapExecutionParams) - Interfaces - [Account](/docs/api/common/interfaces/Account) - [AtaParams](/docs/api/common/interfaces/AtaParams) - [CheckAssociatedTokenAccountsData](/docs/api/common/interfaces/CheckAssociatedTokenAccountsData) - [ConfirmationParams](/docs/api/common/interfaces/ConfirmationParams) - [FetchTokenPriceOptions](/docs/api/common/interfaces/FetchTokenPriceOptions) - [IInteractExt](/docs/api/common/interfaces/IInteractExt) - [IPrepareResult](/docs/api/common/interfaces/IPrepareResult) - [IProgramAccount](/docs/api/common/interfaces/IProgramAccount) - [ITransactionExt](/docs/api/common/interfaces/ITransactionExt) - [ITransactionResult](/docs/api/common/interfaces/ITransactionResult) - [ThrottleParams](/docs/api/common/interfaces/ThrottleParams) - [TransactionExecutionParams](/docs/api/common/interfaces/TransactionExecutionParams) - Type Aliases - [ComputeLimitEstimate](/docs/api/common/type-aliases/ComputeLimitEstimate) - [ComputePriceEstimate](/docs/api/common/type-aliases/ComputePriceEstimate) - [ITransactionExtResolved](/docs/api/common/type-aliases/ITransactionExtResolved) - [IdlAccountsOfMethod](/docs/api/common/type-aliases/IdlAccountsOfMethod) - [IdlArgsOfMethod](/docs/api/common/type-aliases/IdlArgsOfMethod) - [IdlInstruction](/docs/api/common/type-aliases/IdlInstruction) - [PartnerOracle](/docs/api/common/type-aliases/PartnerOracle) - [PartnerOracleAccounts](/docs/api/common/type-aliases/PartnerOracleAccounts) - [PartnerOracleTypes](/docs/api/common/type-aliases/PartnerOracleTypes) - [TokenPriceResult](/docs/api/common/type-aliases/TokenPriceResult) - [TokensPricesResponse](/docs/api/common/type-aliases/TokensPricesResponse) - Variables - [invariant](/docs/api/common/variables/invariant): const invariant: (condition, message?) => asserts condition; - [isDev](/docs/api/common/variables/isDev): const isDev: boolean; - Solana - RPC - [solana/rpc](/docs/api/common/solana/rpc) - Functions - [estimateConsumeLimit()](/docs/api/common/solana/rpc/functions/estimateConsumeLimit) - Interfaces - [GetConsumeLimitEstimateOptions](/docs/api/common/solana/rpc/interfaces/GetConsumeLimitEstimateOptions) - [GetPriorityFeeEstimateOptions](/docs/api/common/solana/rpc/interfaces/GetPriorityFeeEstimateOptions) - Namespaces - PriorityFeeEstimation - [priorityFeeEstimation](/docs/api/common/solana/rpc/namespaces/priorityFeeEstimation) - Functions - [~~Function: getPriorityFeeEstimate()~~](/docs/api/common/solana/rpc/namespaces/priorityFeeEstimation/functions/getPriorityFeeEstimate) - [~~Function: getRecentPrioritizationFee()~~](/docs/api/common/solana/rpc/namespaces/priorityFeeEstimation/functions/getRecentPrioritizationFee) - PriorityFeeEstimationPercentile - [priorityFeeEstimationPercentile](/docs/api/common/solana/rpc/namespaces/priorityFeeEstimationPercentile) - Functions - [getPriorityFeeEstimate()](/docs/api/common/solana/rpc/namespaces/priorityFeeEstimationPercentile/functions/getPriorityFeeEstimate) - [getRecentPrioritizationFee()](/docs/api/common/solana/rpc/namespaces/priorityFeeEstimationPercentile/functions/getRecentPrioritizationFee) - @streamflow/staking - [index](/docs/api/staking): Staking pools and reward pools — SolanaStakingClient, pool derivation utilities, and reward calculations. - Classes - [RewardEntryAccumulator](/docs/api/staking/classes/RewardEntryAccumulator) - [SolanaStakingClient](/docs/api/staking/classes/SolanaStakingClient) - Functions - [calcRewards()](/docs/api/staking/functions/calcRewards) - [calculateAmountWithTransferFees()](/docs/api/staking/functions/calculateAmountWithTransferFees) - [calculateDecimalsShift()](/docs/api/staking/functions/calculateDecimalsShift) - [calculateFeeAmount()](/docs/api/staking/functions/calculateFeeAmount) - [calculateRewardAmountFromRate()](/docs/api/staking/functions/calculateRewardAmountFromRate) - [calculateRewardAmountFromValue()](/docs/api/staking/functions/calculateRewardAmountFromValue) - [calculateRewardRateFromAmount()](/docs/api/staking/functions/calculateRewardRateFromAmount) - [calculateStakeWeight()](/docs/api/staking/functions/calculateStakeWeight) - [deriveConfigPDA()](/docs/api/staking/functions/deriveConfigPDA) - [deriveFeeValuePDA()](/docs/api/staking/functions/deriveFeeValuePDA) - [deriveFundDelegatePDA()](/docs/api/staking/functions/deriveFundDelegatePDA) - [deriveRewardEntryPDA()](/docs/api/staking/functions/deriveRewardEntryPDA) - [deriveRewardPoolPDA()](/docs/api/staking/functions/deriveRewardPoolPDA) - [deriveRewardVaultPDA()](/docs/api/staking/functions/deriveRewardVaultPDA) - [deriveStakeEntryPDA()](/docs/api/staking/functions/deriveStakeEntryPDA) - [deriveStakeMintPDA()](/docs/api/staking/functions/deriveStakeMintPDA) - [deriveStakePoolPDA()](/docs/api/staking/functions/deriveStakePoolPDA) - [deriveStakeVaultPDA()](/docs/api/staking/functions/deriveStakeVaultPDA) - Interfaces - [BaseStakePoolArgs](/docs/api/staking/interfaces/BaseStakePoolArgs) - [ClawbackRewardPoolArgs](/docs/api/staking/interfaces/ClawbackRewardPoolArgs) - [CreateFundDelegateArgs](/docs/api/staking/interfaces/CreateFundDelegateArgs) - [CreateFundDelegatePrepareResult](/docs/api/staking/interfaces/CreateFundDelegatePrepareResult) - [CreateFundDelegateResult](/docs/api/staking/interfaces/CreateFundDelegateResult) - [CreateRewardEntryArgs](/docs/api/staking/interfaces/CreateRewardEntryArgs) - [CreateRewardPoolArgs](/docs/api/staking/interfaces/CreateRewardPoolArgs) - [CreateStakePoolArgs](/docs/api/staking/interfaces/CreateStakePoolArgs) - [FundPoolArgs](/docs/api/staking/interfaces/FundPoolArgs) - [IInteractExt](/docs/api/staking/interfaces/IInteractExt) - [StakeAndCreateEntriesArgs](/docs/api/staking/interfaces/StakeAndCreateEntriesArgs) - [StakeArgs](/docs/api/staking/interfaces/StakeArgs) - [UnstakeAndCloseArgs](/docs/api/staking/interfaces/UnstakeAndCloseArgs) - [UnstakeArgs](/docs/api/staking/interfaces/UnstakeArgs) - [UpdateRewardPoolArgs](/docs/api/staking/interfaces/UpdateRewardPoolArgs) - Staking - Namespaces - Constants - [constants](/docs/api/staking/staking/namespaces/constants) - Variables - [ANCHOR_DISCRIMINATOR_OFFSET](/docs/api/staking/staking/namespaces/constants/variables/ANCHOR_DISCRIMINATOR_OFFSET): const ANCHOR_DISCRIMINATOR_OFFSET: 8 = 8; - [CONFIG_PREFIX](/docs/api/staking/staking/namespaces/constants/variables/CONFIG_PREFIX): const CONFIG_PREFIX: Buffer; - [DEFAULT_FEE](/docs/api/staking/staking/namespaces/constants/variables/DEFAULT_FEE): const DEFAULT_FEE: 0 = 0; - [DEFAULT_FEE_BN](/docs/api/staking/staking/namespaces/constants/variables/DEFAULT_FEE_BN): const DEFAULT_FEE_BN: BN; - [FEE_PRECISION_FACTOR](/docs/api/staking/staking/namespaces/constants/variables/FEE_PRECISION_FACTOR): const FEE_PRECISION_FACTOR: 10000 = 10_000; - [FEE_PRECISION_FACTOR_BN](/docs/api/staking/staking/namespaces/constants/variables/FEE_PRECISION_FACTOR_BN): const FEE_PRECISION_FACTOR_BN: BN; - [FEE_PROGRAM_ID](/docs/api/staking/staking/namespaces/constants/variables/FEE_PROGRAM_ID): const FEE_PROGRAM_ID: Record; - [FEE_VALUE_PREFIX](/docs/api/staking/staking/namespaces/constants/variables/FEE_VALUE_PREFIX): const FEE_VALUE_PREFIX: Buffer; - [FUND_DELEGATE_PREFIX](/docs/api/staking/staking/namespaces/constants/variables/FUND_DELEGATE_PREFIX): const FUND_DELEGATE_PREFIX: Buffer; - [REWARD_AMOUNT_DECIMALS](/docs/api/staking/staking/namespaces/constants/variables/REWARD_AMOUNT_DECIMALS): const REWARD_AMOUNT_DECIMALS: 9 = 9; - [REWARD_AMOUNT_PRECISION_FACTOR](/docs/api/staking/staking/namespaces/constants/variables/REWARD_AMOUNT_PRECISION_FACTOR): const REWARD_AMOUNT_PRECISION_FACTOR: 1000000000 = 1_000_000_000; - [REWARD_AMOUNT_PRECISION_FACTOR_BN](/docs/api/staking/staking/namespaces/constants/variables/REWARD_AMOUNT_PRECISION_FACTOR_BN): const REWARD_AMOUNT_PRECISION_FACTOR_BN: BN; - [REWARD_ENTRY_BYTE_OFFSETS](/docs/api/staking/staking/namespaces/constants/variables/REWARD_ENTRY_BYTE_OFFSETS): const REWARD_ENTRY_BYTE_OFFSETS: object; - [REWARD_ENTRY_PREFIX](/docs/api/staking/staking/namespaces/constants/variables/REWARD_ENTRY_PREFIX): const REWARD_ENTRY_PREFIX: Buffer; - [REWARD_ENTRY_REWARD_POOL_OFFSET](/docs/api/staking/staking/namespaces/constants/variables/REWARD_ENTRY_REWARD_POOL_OFFSET): const REWARD_ENTRY_REWARD_POOL_OFFSET: 8 = ANCHOR_DISCRIMINATOR_OFFSET; - [REWARD_ENTRY_STAKE_ENTRY_OFFSET](/docs/api/staking/staking/namespaces/constants/variables/REWARD_ENTRY_STAKE_ENTRY_OFFSET): const REWARD_ENTRY_STAKE_ENTRY_OFFSET: number; - [REWARD_POOL_BYTE_OFFSETS](/docs/api/staking/staking/namespaces/constants/variables/REWARD_POOL_BYTE_OFFSETS): const REWARD_POOL_BYTE_OFFSETS: object; - [REWARD_POOL_DYNAMIC_PROGRAM_ID](/docs/api/staking/staking/namespaces/constants/variables/REWARD_POOL_DYNAMIC_PROGRAM_ID): const REWARD_POOL_DYNAMIC_PROGRAM_ID: Record; - [REWARD_POOL_MINT_OFFSET](/docs/api/staking/staking/namespaces/constants/variables/REWARD_POOL_MINT_OFFSET): const REWARD_POOL_MINT_OFFSET: number; - [REWARD_POOL_PREFIX](/docs/api/staking/staking/namespaces/constants/variables/REWARD_POOL_PREFIX): const REWARD_POOL_PREFIX: Buffer; - [REWARD_POOL_PROGRAM_ID](/docs/api/staking/staking/namespaces/constants/variables/REWARD_POOL_PROGRAM_ID): const REWARD_POOL_PROGRAM_ID: Record; - [REWARD_POOL_STAKE_POOL_OFFSET](/docs/api/staking/staking/namespaces/constants/variables/REWARD_POOL_STAKE_POOL_OFFSET): const REWARD_POOL_STAKE_POOL_OFFSET: number; - [REWARD_VAULT_PREFIX](/docs/api/staking/staking/namespaces/constants/variables/REWARD_VAULT_PREFIX): const REWARD_VAULT_PREFIX: Buffer; - [SCALE_PRECISION_FACTOR](/docs/api/staking/staking/namespaces/constants/variables/SCALE_PRECISION_FACTOR): const SCALE_PRECISION_FACTOR: 1000000000 = 1_000_000_000; - [SCALE_PRECISION_FACTOR_BN](/docs/api/staking/staking/namespaces/constants/variables/SCALE_PRECISION_FACTOR_BN): const SCALE_PRECISION_FACTOR_BN: BN; - [STAKE_ENTRY_BYTE_OFFSETS](/docs/api/staking/staking/namespaces/constants/variables/STAKE_ENTRY_BYTE_OFFSETS): const STAKE_ENTRY_BYTE_OFFSETS: object; - [STAKE_ENTRY_DISCRIMINATOR](/docs/api/staking/staking/namespaces/constants/variables/STAKE_ENTRY_DISCRIMINATOR): const STAKE_ENTRY_DISCRIMINATOR: number[]; - [STAKE_ENTRY_OWNER_OFFSET](/docs/api/staking/staking/namespaces/constants/variables/STAKE_ENTRY_OWNER_OFFSET): const STAKE_ENTRY_OWNER_OFFSET: number; - [STAKE_ENTRY_PAYER_OFFSET](/docs/api/staking/staking/namespaces/constants/variables/STAKE_ENTRY_PAYER_OFFSET): const STAKE_ENTRY_PAYER_OFFSET: number; - [STAKE_ENTRY_PREFIX](/docs/api/staking/staking/namespaces/constants/variables/STAKE_ENTRY_PREFIX): const STAKE_ENTRY_PREFIX: Buffer; - [STAKE_ENTRY_STAKE_POOL_OFFSET](/docs/api/staking/staking/namespaces/constants/variables/STAKE_ENTRY_STAKE_POOL_OFFSET): const STAKE_ENTRY_STAKE_POOL_OFFSET: number; - [STAKE_MINT_PREFIX](/docs/api/staking/staking/namespaces/constants/variables/STAKE_MINT_PREFIX): const STAKE_MINT_PREFIX: Buffer; - [STAKE_POOL_BYTE_OFFSETS](/docs/api/staking/staking/namespaces/constants/variables/STAKE_POOL_BYTE_OFFSETS): const STAKE_POOL_BYTE_OFFSETS: object; - [STAKE_POOL_CREATOR_OFFSET](/docs/api/staking/staking/namespaces/constants/variables/STAKE_POOL_CREATOR_OFFSET): const STAKE_POOL_CREATOR_OFFSET: number; - [STAKE_POOL_MINT_OFFSET](/docs/api/staking/staking/namespaces/constants/variables/STAKE_POOL_MINT_OFFSET): const STAKE_POOL_MINT_OFFSET: number; - [STAKE_POOL_PREFIX](/docs/api/staking/staking/namespaces/constants/variables/STAKE_POOL_PREFIX): const STAKE_POOL_PREFIX: Buffer; - [STAKE_POOL_PROGRAM_ID](/docs/api/staking/staking/namespaces/constants/variables/STAKE_POOL_PROGRAM_ID): const STAKE_POOL_PROGRAM_ID: Record; - [STAKE_VAULT_PREFIX](/docs/api/staking/staking/namespaces/constants/variables/STAKE_VAULT_PREFIX): const STAKE_VAULT_PREFIX: Buffer; - [STREAMFLOW_TREASURY_PUBLIC_KEY](/docs/api/staking/staking/namespaces/constants/variables/STREAMFLOW_TREASURY_PUBLIC_KEY): const STREAMFLOW_TREASURY_PUBLIC_KEY: PublicKey; - [U64_MAX](/docs/api/staking/staking/namespaces/constants/variables/U64_MAX): const U64_MAX: 18446744073709551615n = 18446744073709551615n; - [WORKER_PUBLIC_KEY](/docs/api/staking/staking/namespaces/constants/variables/WORKER_PUBLIC_KEY): const WORKER_PUBLIC_KEY: PublicKey; - Type Aliases - [ClaimRewardPoolArgs](/docs/api/staking/type-aliases/ClaimRewardPoolArgs) - [CloseRewardEntryArgs](/docs/api/staking/type-aliases/CloseRewardEntryArgs) - [CloseStakeEntryArgs](/docs/api/staking/type-aliases/CloseStakeEntryArgs) - [DefaultFeeValueConfig](/docs/api/staking/type-aliases/DefaultFeeValueConfig) - [FeeValue](/docs/api/staking/type-aliases/FeeValue) - [RewardEntry](/docs/api/staking/type-aliases/RewardEntry) - [RewardPool](/docs/api/staking/type-aliases/RewardPool) - [StakeEntry](/docs/api/staking/type-aliases/StakeEntry) - [StakePool](/docs/api/staking/type-aliases/StakePool) - [UnstakeAndClaimArgs](/docs/api/staking/type-aliases/UnstakeAndClaimArgs) - @streamflow/distributor - [index](/docs/api/distributor): Merkle airdrop protocol — SolanaDistributorClient, claim/clawback operations, and airdrop fee utilities. - Solana API - [solana](/docs/api/distributor/solana) - Classes - [SolanaAlignedDistributorClient](/docs/api/distributor/solana/classes/SolanaAlignedDistributorClient) - [SolanaDistributorClient](/docs/api/distributor/solana/classes/SolanaDistributorClient) - Descriptor - Aligned Distributor - [solana/descriptor/aligned_distributor](/docs/api/distributor/solana/descriptor/aligned_distributor) - Type Aliases - [AlignedDistributor](/docs/api/distributor/solana/descriptor/aligned_distributor/type-aliases/AlignedDistributor) - Merkle Distributor - [solana/descriptor/merkle_distributor](/docs/api/distributor/solana/descriptor/merkle_distributor) - Type Aliases - [MerkleDistributor](/docs/api/distributor/solana/descriptor/merkle_distributor/type-aliases/MerkleDistributor) - Enumerations - [AnchorErrorCode](/docs/api/distributor/solana/enumerations/AnchorErrorCode) - [ContractErrorCode](/docs/api/distributor/solana/enumerations/ContractErrorCode) - Functions - [applyFeeLogic()](/docs/api/distributor/solana/functions/applyFeeLogic) - [calculateAirdropFeeLamports()](/docs/api/distributor/solana/functions/calculateAirdropFeeLamports) - [calculateAmountWithTransferFees()](/docs/api/distributor/solana/functions/calculateAmountWithTransferFees) - [calculateClaimableLamportsFromPrices()](/docs/api/distributor/solana/functions/calculateClaimableLamportsFromPrices) - [calculateDynamicFeeFromSolParams()](/docs/api/distributor/solana/functions/calculateDynamicFeeFromSolParams) - [fetchAirdropFee()](/docs/api/distributor/solana/functions/fetchAirdropFee) - [getAlignedDistributorPda()](/docs/api/distributor/solana/functions/getAlignedDistributorPda) - [getClaimantStatusPda()](/docs/api/distributor/solana/functions/getClaimantStatusPda) - [getDistributorPda()](/docs/api/distributor/solana/functions/getDistributorPda) - [getEventAuthorityPda()](/docs/api/distributor/solana/functions/getEventAuthorityPda) - [getTestOraclePda()](/docs/api/distributor/solana/functions/getTestOraclePda) - [isCompressedClaimStatus()](/docs/api/distributor/solana/functions/isCompressedClaimStatus) - [resolveAirdropFeeLamportsUsingApi()](/docs/api/distributor/solana/functions/resolveAirdropFeeLamportsUsingApi) - [toLamportsSOL()](/docs/api/distributor/solana/functions/toLamportsSOL) - [wrappedSignAndExecuteTransaction()](/docs/api/distributor/solana/functions/wrappedSignAndExecuteTransaction) - Interfaces - [AirdropFeeQueryOptionsOverrides](/docs/api/distributor/solana/interfaces/AirdropFeeQueryOptionsOverrides) - [AlignedDistributorData](/docs/api/distributor/solana/interfaces/AlignedDistributorData) - [IClaimData](/docs/api/distributor/solana/interfaces/IClaimData) - [IClawbackData](/docs/api/distributor/solana/interfaces/IClawbackData) - [ICloseClaimData](/docs/api/distributor/solana/interfaces/ICloseClaimData) - [ICreateAlignedDistributorData](/docs/api/distributor/solana/interfaces/ICreateAlignedDistributorData) - [ICreateDistributorData](/docs/api/distributor/solana/interfaces/ICreateDistributorData) - [ICreateDistributorResult](/docs/api/distributor/solana/interfaces/ICreateDistributorResult) - [ICreateExt](/docs/api/distributor/solana/interfaces/ICreateExt) - [IGetClaimData](/docs/api/distributor/solana/interfaces/IGetClaimData) - [IGetDistributors](/docs/api/distributor/solana/interfaces/IGetDistributors) - [IInteractExt](/docs/api/distributor/solana/interfaces/IInteractExt) - [ISearchDistributors](/docs/api/distributor/solana/interfaces/ISearchDistributors) - [ISetClawbackReceiverData](/docs/api/distributor/solana/interfaces/ISetClawbackReceiverData) - [ISetDataAdmin](/docs/api/distributor/solana/interfaces/ISetDataAdmin) - [NewAlignedDistributorArgs](/docs/api/distributor/solana/interfaces/NewAlignedDistributorArgs) - Namespaces - Constants - [constants](/docs/api/distributor/solana/namespaces/constants) - Variables - [AIRDROP_CLAIM_FEE](/docs/api/distributor/solana/namespaces/constants/variables/AIRDROP_CLAIM_FEE): const AIRDROP_CLAIM_FEE: bigint; - [ALIGNED_DISTRIBUTOR_ERRORS](/docs/api/distributor/solana/namespaces/constants/variables/ALIGNED_DISTRIBUTOR_ERRORS): const ALIGNED_DISTRIBUTOR_ERRORS: Map; - [ALIGNED_DISTRIBUTOR_PREFIX](/docs/api/distributor/solana/namespaces/constants/variables/ALIGNED_DISTRIBUTOR_PREFIX): const ALIGNED_DISTRIBUTOR_PREFIX: Buffer; - [ALIGNED_DISTRIBUTOR_PROGRAM_ID](/docs/api/distributor/solana/namespaces/constants/variables/ALIGNED_DISTRIBUTOR_PROGRAM_ID): const ALIGNED_DISTRIBUTOR_PROGRAM_ID: object; - [ALIGNED_PRECISION_FACTOR_POW](/docs/api/distributor/solana/namespaces/constants/variables/ALIGNED_PRECISION_FACTOR_POW): const ALIGNED_PRECISION_FACTOR_POW: 9 = 9; - [ANCHOR_DISCRIMINATOR_OFFSET](/docs/api/distributor/solana/namespaces/constants/variables/ANCHOR_DISCRIMINATOR_OFFSET): const ANCHOR_DISCRIMINATOR_OFFSET: 8 = 8; - [CLAIM_STATUS_PREFIX](/docs/api/distributor/solana/namespaces/constants/variables/CLAIM_STATUS_PREFIX): const CLAIM_STATUS_PREFIX: Buffer; - [DISTRIBUTOR_ADMIN_OFFSET](/docs/api/distributor/solana/namespaces/constants/variables/DISTRIBUTOR_ADMIN_OFFSET): const DISTRIBUTOR_ADMIN_OFFSET: number; - [DISTRIBUTOR_MINT_OFFSET](/docs/api/distributor/solana/namespaces/constants/variables/DISTRIBUTOR_MINT_OFFSET): const DISTRIBUTOR_MINT_OFFSET: number; - [DISTRIBUTOR_PREFIX](/docs/api/distributor/solana/namespaces/constants/variables/DISTRIBUTOR_PREFIX): const DISTRIBUTOR_PREFIX: Buffer; - [DISTRIBUTOR_PROGRAM_ID](/docs/api/distributor/solana/namespaces/constants/variables/DISTRIBUTOR_PROGRAM_ID): const DISTRIBUTOR_PROGRAM_ID: object; - [FEE_CONFIG_PUBLIC_KEY](/docs/api/distributor/solana/namespaces/constants/variables/FEE_CONFIG_PUBLIC_KEY): const FEE_CONFIG_PUBLIC_KEY: object; - [MERKLE_DISTRIBUTOR_ERRORS](/docs/api/distributor/solana/namespaces/constants/variables/MERKLE_DISTRIBUTOR_ERRORS): const MERKLE_DISTRIBUTOR_ERRORS: Map; - [ONE_IN_BASIS_POINTS](/docs/api/distributor/solana/namespaces/constants/variables/ONE_IN_BASIS_POINTS): const ONE_IN_BASIS_POINTS: bigint; - [PARTNER_ORACLE_PROGRAM_ID](/docs/api/distributor/solana/namespaces/constants/variables/PARTNER_ORACLE_PROGRAM_ID): const PARTNER_ORACLE_PROGRAM_ID: object; - [SOL_FEE_PROGRAM_VERSION](/docs/api/distributor/solana/namespaces/constants/variables/SOL_FEE_PROGRAM_VERSION): const SOL_FEE_PROGRAM_VERSION: 1 = 1; - [STREAMFLOW_TREASURY_PUBLIC_KEY](/docs/api/distributor/solana/namespaces/constants/variables/STREAMFLOW_TREASURY_PUBLIC_KEY): const STREAMFLOW_TREASURY_PUBLIC_KEY: PublicKey; - [TEST_ORACLE_PREFIX](/docs/api/distributor/solana/namespaces/constants/variables/TEST_ORACLE_PREFIX): const TEST_ORACLE_PREFIX: Buffer; - Type Aliases - [AirdropFeeClient](/docs/api/distributor/solana/type-aliases/AirdropFeeClient) - [AirdropFeeDynamic](/docs/api/distributor/solana/type-aliases/AirdropFeeDynamic) - [AirdropFeeResponse](/docs/api/distributor/solana/type-aliases/AirdropFeeResponse) - [AirdropFeeServiceResponse](/docs/api/distributor/solana/type-aliases/AirdropFeeServiceResponse) - [AnyClaimStatus](/docs/api/distributor/solana/type-aliases/AnyClaimStatus) - [ClaimLockedAccounts](/docs/api/distributor/solana/type-aliases/ClaimLockedAccounts) - [ClaimLockedV2Accounts](/docs/api/distributor/solana/type-aliases/ClaimLockedV2Accounts) - [ClaimStatus](/docs/api/distributor/solana/type-aliases/ClaimStatus) - [ClawbackAccounts](/docs/api/distributor/solana/type-aliases/ClawbackAccounts) - [CloseClaimAccounts](/docs/api/distributor/solana/type-aliases/CloseClaimAccounts) - [CloseClaimArgs](/docs/api/distributor/solana/type-aliases/CloseClaimArgs) - [CompressedClaimStatus](/docs/api/distributor/solana/type-aliases/CompressedClaimStatus) - [FeeConfig](/docs/api/distributor/solana/type-aliases/FeeConfig) - [Fees](/docs/api/distributor/solana/type-aliases/Fees) - [MerkleDistributor](/docs/api/distributor/solana/type-aliases/MerkleDistributor) - [MerkleDistributorAccountTypes](/docs/api/distributor/solana/type-aliases/MerkleDistributorAccountTypes) - [MerkleDistributorAccounts](/docs/api/distributor/solana/type-aliases/MerkleDistributorAccounts) - [MerkleDistributorProgram](/docs/api/distributor/solana/type-aliases/MerkleDistributorProgram) - [NewClaimAccounts](/docs/api/distributor/solana/type-aliases/NewClaimAccounts) - [NewClaimArgs](/docs/api/distributor/solana/type-aliases/NewClaimArgs) - [NewDistributorAccounts](/docs/api/distributor/solana/type-aliases/NewDistributorAccounts) - [NewDistributorArgs](/docs/api/distributor/solana/type-aliases/NewDistributorArgs) - [OracleType](/docs/api/distributor/solana/type-aliases/OracleType) - [OracleTypeName](/docs/api/distributor/solana/type-aliases/OracleTypeName) - Variables - [FEE_ALLOCATION_FACTOR_FALLBACK_DENOMINATOR](/docs/api/distributor/solana/variables/FEE_ALLOCATION_FACTOR_FALLBACK_DENOMINATOR): const FEE_ALLOCATION_FACTOR_FALLBACK_DENOMINATOR: 100n = 100n; - [FEE_ALLOCATION_FACTOR_FALLBACK_NUMERATOR](/docs/api/distributor/solana/variables/FEE_ALLOCATION_FACTOR_FALLBACK_NUMERATOR): const FEE_ALLOCATION_FACTOR_FALLBACK_NUMERATOR: 90n = 90n; - [MAXIMUM_FEE_FALLBACK](/docs/api/distributor/solana/variables/MAXIMUM_FEE_FALLBACK): const MAXIMUM_FEE_FALLBACK: 9900000n = 9_900_000n; - [MINIMUM_FEE_FALLBACK](/docs/api/distributor/solana/variables/MINIMUM_FEE_FALLBACK): const MINIMUM_FEE_FALLBACK: 5000000n = 5_000_000n; - @streamflow/launchpad - [index](/docs/api/launchpad): Token launchpad protocol — SolanaLaunchpadClient, deposit/vault PDA derivation, and allocation claim operations. - Classes - [SolanaLaunchpadClient](/docs/api/launchpad/classes/SolanaLaunchpadClient) - Functions - [deriveDepositPDA()](/docs/api/launchpad/functions/deriveDepositPDA) - [deriveLaunchpadPDA()](/docs/api/launchpad/functions/deriveLaunchpadPDA) - [deriveVaultPDA()](/docs/api/launchpad/functions/deriveVaultPDA) - Interfaces - [IClaimAllocatedInstant](/docs/api/launchpad/interfaces/IClaimAllocatedInstant) - [IClaimAllocatedVested](/docs/api/launchpad/interfaces/IClaimAllocatedVested) - [IClaimDeposits](/docs/api/launchpad/interfaces/IClaimDeposits) - [ICreateLaunchpad](/docs/api/launchpad/interfaces/ICreateLaunchpad) - [IDeposit](/docs/api/launchpad/interfaces/IDeposit) - [IFundLaunchpad](/docs/api/launchpad/interfaces/IFundLaunchpad) - [IInteractExt](/docs/api/launchpad/interfaces/IInteractExt) - Launchpad - Namespaces - Constants - [constants](/docs/api/launchpad/launchpad/namespaces/constants) - Variables - [ANCHOR_DISCRIMINATOR_OFFSET](/docs/api/launchpad/launchpad/namespaces/constants/variables/ANCHOR_DISCRIMINATOR_OFFSET): const ANCHOR_DISCRIMINATOR_OFFSET: 8 = 8; - [DEPOSIT_PREFIX](/docs/api/launchpad/launchpad/namespaces/constants/variables/DEPOSIT_PREFIX): const DEPOSIT_PREFIX: Buffer; - [LAUNCHPAD_BASE_MINT_OFFSET](/docs/api/launchpad/launchpad/namespaces/constants/variables/LAUNCHPAD_BASE_MINT_OFFSET): const LAUNCHPAD_BASE_MINT_OFFSET: number; - [LAUNCHPAD_BYTE_OFFSETS](/docs/api/launchpad/launchpad/namespaces/constants/variables/LAUNCHPAD_BYTE_OFFSETS): const LAUNCHPAD_BYTE_OFFSETS: object; - [LAUNCHPAD_PREFIX](/docs/api/launchpad/launchpad/namespaces/constants/variables/LAUNCHPAD_PREFIX): const LAUNCHPAD_PREFIX: Buffer; - [LAUNCHPAD_QUOTE_MINT_OFFSET](/docs/api/launchpad/launchpad/namespaces/constants/variables/LAUNCHPAD_QUOTE_MINT_OFFSET): const LAUNCHPAD_QUOTE_MINT_OFFSET: number; - [PROGRAM_ID](/docs/api/launchpad/launchpad/namespaces/constants/variables/PROGRAM_ID): const PROGRAM_ID: Record; - [VAULT_PREFIX](/docs/api/launchpad/launchpad/namespaces/constants/variables/VAULT_PREFIX): const VAULT_PREFIX: Buffer; - Type Aliases - [DepositAccount](/docs/api/launchpad/type-aliases/DepositAccount) - [Launchpad](/docs/api/launchpad/type-aliases/Launchpad) - Resources - [Program IDs](/docs/resources/program-ids): On-chain program addresses for all Streamflow protocols on mainnet and devnet. - [Best Practices](/docs/resources/best-practices): Recommended patterns for PublicKey normalization, token amounts, error handling, and avoiding common pitfalls. - [Error Codes](/docs/resources/error-codes): SDK error codes for the Streamflow Vesting & Locks and Aligned Proxy programs. - [Security & Audits](/docs/resources/security-audits): Streamflow protocol security audits and on-chain program guarantees. - [FAQ](/docs/resources/faq): Common questions about locks, vesting, and the Streamflow JS SDK. - [Changelog](/docs/resources/changelog): Version history and release notes for the Streamflow JS SDK. - [Legal & Branding](/docs/resources/legal): Privacy policy, terms and conditions, and brand assets for Streamflow. - AI & Developer Tools - [llms.txt](/docs/ai-tools/llms-txt): Machine-readable URLs for AI tools and LLM context. - [AI Skills](/docs/ai-tools/ai-skills): Context files for AI-assisted Streamflow development. - [Get Help](/docs/ai-tools/get-dev-help): Resources for Streamflow developer support.