base-sdk.md

Domain-neutral SDK

@operatorstack/boatstack declares complete Control Program IR. The main composition boundary is defineFlow; it validates and canonicalizes authoring data into raw IR but does not execute a Flow.

Program structure

• defineFlow lowers a complete FlowDefinition.
• facet, evidence, operator, and transition declare the relation.
• marked declares a target; entry selects a target and normalizes inputs.
• fact, all, and always build predicates.

Invocation and parameters

hostParameter, fromEntryInput, fromState, fromReceipt, fromStateOrReceipt, fromWorkOutput, and trustedParameterResolver describe exact producers. They do not resolve values while TypeScript runs. The compiler requires one compatible producer for each required reachable parameter.

Foreground work

foregroundWork declares bounded candidate work. instructionAsset and schemaAsset name repository assets that the compiler later resolves and fingerprints. entryInput binds an input to an entry value. workInput can instead bind an input to a required output from one prior Work transition. workArtifact declares an output. An output may attach guidance: instructionAsset(...); its exact UTF-8 bytes are embedded in the runtime request and participate in the work and program fingerprints. Package instructions coordinate all outputs, while guidance describes only its artifact. Neither grants authority or verifies content. Work completion does not independently advance Flow state. Cross-transition Work inputs resolve only from the applicable committed producer result. The downstream result retains the producer receipt, result, contract, output, and byte identities.

Authority

AuthorityRequirements appears on transitions and entries. On an entry it declares activation authority; on a transition it adds mandatory admission authority. Neither form creates a receipt or chooses an actor.

See Flow anatomy and the generated module page for exact types, categories, and signatures.