API reference

`deployoor` (main)

Runtime exports for deploy scripts and tooling.

Export	Description
`defineConfig`	Type-safe config helper
`defineDeployer`	Low-level deployer factory (codegen uses this)
`defineRegister`	Register external contract factory
`defineReset`	Reset deployment records factory
`memoryStore`	In-memory `StoreAdapter` for tests
`fsStore`	Filesystem store (default in generated deployers)

Generated getOrDeploy<Name> functions are the primary API — import from ./deployers.

Export	Description
`generateDeployers({ root })`	Programmatic `deployoor generate`

Plugin SDK — the only import path for lifecycle plugins.

Export	Description
`definePlugin`	Create a named plugin with lifecycle hooks

Hooks include onContractDeployed and others in the deploy pipeline. See Plugins.

type DeployResult<TContract> = {
  contract: TContract;
  freshDeploy: boolean;
  receipt?: TransactionReceipt;
  deployment: DeploymentRecord;
};

Validated at runtime with Zod; exported as a stable TypeScript interface. See Deployment records.

Tagged errors (e.g. DeploymentExists, ChainIdMismatch, DeploymentFailed) reject from getOrDeploy / register with actionable messages.