Error Codes

When a Streamflow transaction fails on-chain, the SDK wraps the error in a ContractError. The .contractErrorCode property contains the SDK-defined string name mapped from the raw hex program error in the transaction log.

These codes are defined in @streamflow/stream - ContractErrorCode for the core Vesting & Locks program and AlignedProxyErrorCode for price-based (Aligned) streams.

Catching errors

import { ContractError, ContractErrorCode } from "@streamflow/stream";

try {
  const result = await withdraw({ id: streamId }, invoker, env);
} catch (err) {
  if (err instanceof ContractError) {
    console.error("Code:", err.contractErrorCode);   // e.g. "Unauthorized"
    console.error("Description:", err.description);  // human-readable description if available
    console.error("Message:", err.message);
    console.error("Cause:", err.cause);              // original on-chain error
  }
}

Error code reference

Source

These codes are defined in packages/stream/solana/types.ts (ContractErrorCode, AlignedProxyErrorCode) and mapped in packages/stream/solana/constants.ts (SOLANA_ERROR_MAP). See the SDK Reference for the full type documentation.