Composable APIs

The composable API is a set of TypeScript functions that wrap SolanaStreamClient with intent-specific defaults and a clean 3-phase transaction model.

import {
  createLock, createLockBatch,
  createVesting, createVestingBatch,
  withdraw, topup, transfer, cancel, update,
  buildTransaction, sign, execute, executeBatch, executeBatchSequential,
} from "@streamflow/stream/solana/api";

The 3-Phase Transaction Model

const result = await createLock(params, invoker, env);
// result: { instructions, signers?, metadataPubKey? }

const built = await buildTransaction(
  result.instructions,
  { feePayer: invoker.publicKey, computeLimit: 200_000 },
  env,
);
// built: { transaction, blockhashWithExpiryBlockHeight, context }

await sign(built.transaction, [invoker, ...(result.signers ?? [])]);
const signature = await execute(built, env);

Why composable?

• Custom fee payer - pass any wallet as feePayer in buildTransaction
• Custom compute budget - tune computeLimit and computePrice
• Multi-sig - collect signatures from multiple parties before executing
• Inspect first - examine instructions before committing to an on-chain action
• Batch execution - build multiple transactions, then send with executeBatch() or executeBatchSequential()

Quick reference

The Type column shows each function's return type. All functions are async and return a Promise of the listed type.