Skip to content
Oeiuwq Faith Blog OpenSource Porfolio

sini/gen-bind

gen-bind: module binding with external arguments for Nix

sini/gen-bind.json
{
"createdAt": "2026-05-25T22:30:42Z",
"defaultBranch": "main",
"description": "gen-bind: module binding with external arguments for Nix",
"fullName": "sini/gen-bind",
"homepage": null,
"language": "Nix",
"name": "gen-bind",
"pushedAt": "2026-07-16T01:51:54Z",
"stargazersCount": 1,
"topics": [],
"updatedAt": "2026-07-16T01:51:57Z",
"url": "https://github.com/sini/gen-bind"
}

gen-bind — module binding with external arguments for Nix

Section titled “gen-bind — module binding with external arguments for Nix”

CI License: MIT Sponsor

Module binding with external arguments for Nix — partial application of bindings into NixOS module functions with closure-based injection, collision detection with blame, lazy contracts, and thunk resolution for config-dependent values.

gen-bind gives you what manual specialArgs doesn’t: builtins.functionArgs introspection to inject only the args a module actually declares, merge strategy control when bindings collide with module-system args, contract assertions that fire on demand rather than at wrap time, and provenance tracking that names the source in every error message.

gen-bind is a nixpkgs-lib-free Class B library: its only dependency is gen-prelude (pure, zero-input). It remains module-system-aware — not -dependent — emitting modules in the nixpkgs __functionArgs/_file/key convention via two helpers vendored locally in lib/module-convention.nix, with no nixpkgs.lib import. A CI purity invariant and an evalModules equivalence test keep that boundary honest.

  • [Terminology]!(#terminology)
  • [Overview]!(#overview)
  • [Gen Ecosystem]!(#gen-ecosystem)
  • [Quick Start]!(#quick-start)
  • [Core Concepts]!(#core-concepts)
    • [Bindings and Wrapping]!(#bindings-and-wrapping)
    • [Module Shapes]!(#module-shapes)
    • [Merge Strategies]!(#merge-strategies)
    • [Config Thunks]!(#config-thunks)
    • [Lazy Contracts]!(#lazy-contracts)
    • [Provenance]!(#provenance)
    • [Signatures]!(#signatures)
    • [Layered Composition]!(#layered-composition)
    • [Identity Wrapping]!(#identity-wrapping)
    • [Arg Stripping]!(#arg-stripping)
    • [Batch Wrapping]!(#batch-wrapping)
  • [API Reference]!(#api-reference)
  • [Laziness Guarantees]!(#laziness-guarantees)
  • [Architecture]!(#architecture)
  • [Testing]!(#testing)
  • [Theoretical Foundations]!(#theoretical-foundations)
TermDefinition
BindingsNamed external values injected into module functions
WrappingPartial application of bindings into a module’s args
Merge StrategyResolution policy when a binding name collides with a module-system arg
ThunkConfig-dependent deferred value resolved inside evalModules
ContractLazy assertion on a binding value (checked on demand, not at wrap time)
ProvenanceSource-tracking metadata surfaced in blame messages on collision or violation
SignatureStatic record of what a module requires, what was bound, and what remains

A NixOS module is a function { arg1, arg2, ... }: { ...config... } whose formal parameters are resolved by evalModules from specialArgs and _module.args. gen-bind sits in front of that resolution: it takes a module plus a set of named bindings and partially applies the bindings the module actually declares — determined by builtins.functionArgs introspection, never by evaluating the values — leaving every other arg for evalModules to supply as normal.

The mental model is a single pipeline over four parallel keyed maps, all indexed by binding arg name:

  • bindings — the external values to inject ({ host = ...; }),
  • contracts — lazy per-binding assertions that fire only when the arg is demanded,
  • provenance — blame metadata that names the source in every error message,
  • mergeStrategies — collision policy when a binding name shadows a module-system arg.

wrap (single module) and wrapAll (batch) consume those maps and return a record { module; wrapped; validator; signature; advertisedArgs }. compose/composeWith merge binding sources upstream; mkThunk defers a binding that depends on the config fixpoint; wrapIdentity and stripBindingArgs post-process the wrapped module for NixOS key-dedup and advertised-arg hygiene. Nothing in the pipeline forces a binding value that the target module does not demand, so unbuilt hosts carry zero binding cost.

LibraryRole
gen-preludePure nixpkgs-lib-free utility base (builtins re-exports + vendored lib utils)
gen-algebraPure primitives (record, search monad, either, intensional identity)
gen-typesClean-room MIT structural type checker (leaf/poly checkers; verify: v → null|err)
gen-mergeByte-mode module merge engine (evalModuleTree, byte-identical to nixpkgs lib.evalModules over the priority subset)
gen-schemaTyped registries (kinds, instances, collections, refs); re-hosted on gen-merge
gen-aspectsAspect type system (traits, classification, dispatch); re-hosted on gen-merge
gen-scopeHOAG scope-graph evaluator (demand-driven, _eval memoization, circular attributes)
gen-graphAccessor-based graph query combinators (traversal, condensation, phaseOrder)
gen-selectSelector algebra (pattern matching over graph positions)
gen-bindThis lib — Module binding (inject external args into NixOS modules)
gen-dispatchRelational rule dispatch STEP (stratified phases, conflict resolution)
gen-resolveDemand-driven RAG evaluator over scope graphs (attribute schedule + convergence loop)
gen-rebuildPure-Nix incremental rebuilder (change propagation, AFFECTED set)
gen-varsPure-Nix vars/secrets (den-agnostic)
gen-flakeThe nixpkgs boundary — compose purely, inject resolved values, build NixOS systems (value-injection)
flake.nix
{
inputs.gen-bind.url = "github:sini/gen-bind";
# gen-bind's only dependency is gen-prelude (pulled in transitively, zero-input).
# nixpkgs below is the consumer's own dependency, not gen-bind's.
outputs = { gen-bind, ... }:
let
genBind = gen-bind.lib;
# or instantiate the lib directly (needs a gen-prelude input):
# genBind = import "${gen-bind}/lib" { prelude = inputs.gen-prelude.lib; };
in {
# Wrap a module with external bindings
wrappedModule = (genBind.wrap {
module = { host, config, lib, ... }: {
networking.hostName = host.name;
};
bindings = { host = { name = "igloo"; }; };
}).module;
};
}
let
# prelude = gen-prelude's lib, e.g. import "${gen-prelude}/lib"
genBind = import ./path/to/gen-bind/lib { inherit prelude; };
result = genBind.wrap {
module = { host, pkgs, config, ... }: {
environment.systemPackages = [ pkgs.git ];
networking.hostName = host.name;
};
bindings = { host = { name = "igloo"; }; };
# pkgs comes from evalModules specialArgs — wrap only injects `host`
};
in result.module # function: { pkgs, config, ... } -> { ... }
let
prelude = import ./path/to/gen-prelude/lib { };
genBind = import ./path/to/gen-bind/lib { inherit prelude; };
in
# use genBind.wrap, genBind.wrapAll, genBind.contract, etc.

wrap inspects a module’s formal parameters via builtins.functionArgs and injects only the bindings that match. Non-matching bindings are ignored. The result is a partially-applied module whose remaining args come from evalModules as normal.

result = genBind.wrap {
module = { host, config, lib, ... }: {
networking.hostName = host.name;
};
bindings = { host = { name = "igloo"; }; extraUnused = "ignored"; };
};
# result.module — partially applied: { config, lib, ... } -> { ... }
# result.wrapped — true
# result.signature — { requires = { config = false; lib = false; }; bound = { host = { ... }; }; ... }

When no binding names match the module’s args, the module passes through unchanged (result.wrapped = false).

wrap handles three module shapes:

  • Function — standard { arg1, arg2, ... }: { ... }. Bindings are injected via partial application.
  • Imports attrset{ imports = [ mod1 mod2 ]; }. Each import is wrapped recursively.
  • Plain attrset{ config = { ... }; }. Passes through unchanged.

When a binding name collides with a module-system arg (e.g., both gen-bind and evalModules provide lib), the merge strategy determines resolution:

result = genBind.wrap {
module = { lib, host, ... }: { networking.hostName = host.name; };
bindings = { host = { name = "igloo"; }; lib = myCustomLib; };
mergeStrategies = {
lib = genBind.mergeStrategy.systemWins; # module-system lib wins
# or: genBind.mergeStrategy.bindWins (default)
# or: genBind.mergeStrategy.error (throw at eval time)
};
};

The default strategy is bindWins — binding shadows the module-system arg. Set _mergeStrategy directly on a binding value as an inline annotation:

bindings = {
lib = myLib // { _mergeStrategy = "system-wins"; };
};

Collision detection runs when mkMergeValidator is called with the module args. Warnings (for bindWins/systemWins) and errors (for error) include provenance if set.

Some bindings depend on the evalModules fixpoint — they can’t be computed until config is available. Use mkThunk to defer resolution:

result = genBind.wrap {
module = { extraModules, config, ... }: {
imports = extraModules;
};
bindings = {
extraModules = [
# Static entry
myBaseModule
# Thunk — resolved when evalModules calls the wrapper
(genBind.mkThunk ({ config }: lib.optional config.services.nginx.enable nginxExtraModule))
];
};
};

Thunks travel as markers ({ __configThunk = true; __fn = fn; }) through the binding pipeline and resolve inside the module wrapper when evalModules provides config. Only list-valued bindings are auto-detected for thunks. Non-list bindings with thunks require explicit thunkBindings = [ "argName" ].

mkThunkFrom scopeId fn creates a thunk annotated with a source scope for tracing.

Contracts are assertions that fire only when the bound value is demanded — preserving Nix’s lazy evaluation semantics. Unbuilt modules have zero contract cost.

result = genBind.wrap {
module = { host, ... }: { networking.hostName = host.name; };
bindings = { host = { name = "igloo"; }; };
contracts = {
host = genBind.contract.hasFields [ "name" "system" ];
# or: genBind.contract.isType "set"
# or: genBind.contract.nonEmpty
# or: genBind.contract.mk { check = v: v.name != ""; message = "host must have non-empty name"; }
};
provenance = {
host = { source = "entity-context"; scope = "host=igloo"; };
};
};

Contract violations include the message and provenance:

gen-bind: contract violation: value must have fields: name, system (provided by 'entity-context' at scope 'host=igloo')

contract.apply contract value prov applies a contract directly without going through wrap.

Provenance metadata on the wrap call surfaces in all blame messages — collisions, contract violations, and error-strategy throws:

genBind.wrap {
module = myModule;
bindings = { host = hostVal; };
provenance = {
host = { source = "scope-policy"; scope = "host=igloo,user=tux"; };
};
};

provenance.format prov formats a provenance record to a string ("provided by 'scope-policy' at scope 'host=igloo,user=tux'") or returns "" for null.

Every wrap result includes a signature describing the module’s binding interface:

result.signature
# -> {
# requires = { config = false; lib = false; }; # still needed from evalModules
# bound = { host = { optional = false; provenance = { source = "..."; }; }; };
# unsatisfied = []; # vocabulary keys present but not injected
# mergeStrategies = { host = "bind-wins"; };
# }

buildSignature computes the signature from a module + binding config without performing wrapping.

Multiple binding sources (entity context, enrichment, pipes) compose with later layers shadowing earlier ones:

# compose: plain attrset merge
allBindings = genBind.compose [
entityBindings
enrichmentBindings
pipeBindings
];
# composeWith: structured merge across all binding fields
cfg = genBind.composeWith [
{ bindings = entityBindings; provenance = entityProv; }
{ bindings = enrichBindings; contracts = enrichContracts; }
{ bindings = pipeBindings; mergeStrategies = pipeStrats; }
];
# cfg.bindings, cfg.provenance, cfg.contracts, cfg.mergeStrategies — all merged
result = genBind.wrap (cfg // { module = myModule; });

NixOS deduplicates modules by key. wrapIdentity stamps a stable key onto a wrapped module so that re-emitting the same module at the same identity doesn’t duplicate it in evalModules:

keyed = genBind.wrapIdentity {
class = "nixos";
module = result.module;
identity = "host=igloo";
# isAnon = false; # default: sets key + _file + imports wrapper
};
# keyed -> { key = "nixos@host=igloo"; _file = "nixos@host=igloo"; imports = [ result.module ]; }

Set isAnon = true to stamp only _file (via the vendored setDefaultModuleLocation convention helper) instead — useful for anonymous modules that shouldn’t appear in key-based dedup.

After wrapping, binding arg names must be removed from the module’s advertised args. Otherwise evalModules probes _module.args.<name> for every advertised arg and crashes when the key doesn’t exist.

stripped = genBind.stripBindingArgs {
module = result.module;
bindingNames = [ "host" ];
};

Works on both function modules and attrset modules with __functionArgs. Args not present in the module’s advertised interface are silently skipped.

wrapAll wraps a list of modules with shared bindings, pre-computing contracts once across all modules:

batch = genBind.wrapAll {
modules = [ modA modB modC ];
bindings = sharedBindings;
contracts = sharedContracts;
provenance = sharedProv;
};
# batch.modules — list of wrapped modules
# batch.validators — list of non-null validators (one per wrapped function module)
# batch.signatures — list of signatures (one per module)
# batch.all — wrapped modules ++ non-null validators (flat list)
wrap {
module, # function | { imports = [...]; } | attrset
bindings ? {}, # { name = value; } — external values to inject
contracts ? {}, # { name = contract; } — lazy assertions per binding
provenance ? {}, # { name = { source; scope?; }; } — blame metadata
mergeStrategies ? {}, # { name = strategy; } — per-arg collision resolution
defaultMergeStrategy ? bindWins, # fallback strategy for unspecified args
thunkBindings ? [], # explicit list of list-valued args containing thunks
}

Returns { module; wrapped; validator; signature; advertisedArgs }.

  • module — wrapped or passthrough module
  • wrappedtrue if any binding was injected
  • validatormkMergeValidator result for collision checking, null if no bindings matched
  • signaturebuildSignature result
  • advertisedArgs — remaining formal args after binding injection
wrapAll {
modules, # list of modules
bindings ? {},
contracts ? {},
provenance ? {},
mergeStrategies ? {},
defaultMergeStrategy ? bindWins,
thunkBindings ? [],
}

Contracts are pre-computed once and shared across all modules. Returns { modules; validators; signatures; all }.

  • modules — list of wrapped modules
  • validators — list of non-null validators
  • signatures — list of signatures (one per module)
  • allmodules ++ validators (flat list of wrapped modules and non-null validators), ready to pass directly to evalModules; the validators emit lazy warnings and do no work at module-collection WHNF
mkThunk fn

Creates a config-dependent thunk. fn receives { config; <ctx-args>... }ctx-args are any of fn’s named parameters that exist in the binding context. The return value is spliced into the list binding (single value or list both work).

mkThunkFrom scopeId fn

Like mkThunk but annotates the thunk with a source scope string for tracing.

isThunk value # -> bool

Returns true if value is a thunk created by mkThunk or mkThunkFrom.

resolveThunks { config; ctx; thunkArgNames; bindings; }

Resolves thunks within list-valued bindings. For each arg name in thunkArgNames whose binding is a list, expands thunk entries by calling __fn with config and matching ctx args. Non-thunk entries and non-list args pass through unchanged.

contract.mk { check; message ? "contract violation"; blame ? null; }

Creates a contract. check is value -> bool. blame is an optional string added to the error message.

contract.hasFields fields # fields: [ "name" "system" ]

Contract asserting the value has all listed fields.

contract.isType type # type: "set" | "list" | "string" | "int" | "bool" | ...

Contract asserting builtins.typeOf value == type.

Contract asserting the value is non-empty (non-empty list, non-empty attrset, or non-null).

contract.apply contract value prov

Applies a contract directly. Returns value if the check passes, throws with message + provenance string on failure.

mergeStrategy.bindWins # "bind-wins" — binding shadows module-system arg (default)
mergeStrategy.systemWins # "system-wins" — module-system arg wins, binding dropped
mergeStrategy.error # "error" — throw at eval time with blame
mergeStrategy.fromBindings bindings
# -> { name = strategy | null; } — extracts _mergeStrategy annotations from binding values
mkMergeValidator { resolvePolicy; boundArgNames; provenance; }

Returns a validator function moduleArgs -> { warnings }. Call with the module args attrset (including config._module.args) to check for collisions. The returned warnings are lazy (config-implicit): the config._module.args probe runs only when .warnings is demanded — post-fixpoint, the NixOS-idiomatic point — so the validator does no work at module-collection WHNF and is safe to feed straight into evalModules (this is what wrapAll’s .all relies on). Bind-wins and system-wins collisions produce warning strings in .warnings; error-strategy collisions throw, lazily, when .warnings is forced.

provenance.format prov # prov: { source; scope?; } | null

Returns a formatted string ("provided by 'source' at scope 'scope'") or "" for null.

compose layers # layers: [ attrset ... ]

Plain left-fold // across binding attrsets. Later layers shadow earlier ones.

composeWith layers
# layers: [ { bindings?; provenance?; contracts?; mergeStrategies?; } ... ]

Structured composition across all four binding fields. Returns { bindings; provenance; contracts; mergeStrategies }.

wrapIdentity { class; module; identity; isAnon ? false; }

Stamps a stable NixOS module key onto a module. Non-anon: returns { key = "${class}@${identity}"; _file = ...; imports = [ module ]; }. Anon: applies the vendored setDefaultModuleLocation convention helper instead.

stripBindingArgs { module; bindingNames; }

Removes bindingNames from the module’s advertised formal args. Works on function modules and attrset modules with __functionArgs. Returns the module unchanged if no args match or the module shape doesn’t support stripping.

buildSignature { module; bindings; defaultMergeStrategy; mergeStrategies; provenance ? {}; }

Computes a signature record: { requires; bound; unsatisfied; mergeStrategies }.

  • requires — formal args not satisfied by bindings (pass to evalModules)
  • bound{ argName = { optional; provenance; }; } for each injected arg
  • unsatisfied — arg names in vocabulary but not injected and not optional (currently always [] with the standard API)
  • mergeStrategies — per-bound-arg strategy
  • Binding values are never forced at wrap time — builtins.functionArgs introspects without evaluating.
  • Per-arg injection uses // semantics — only args the module actually demands are forced.
  • Contracts fire on demand only — the contract thunk wraps the binding value in an assert; if the module never demands the arg, the contract never runs.
  • Unbuilt hosts have zero cost — thunks in list bindings resolve only when the wrapper function is called by evalModules.
External bindings (entity context, enrichment, pipes)
| composed via
compose / composeWith
| applied via
wrap / wrapAll
|-- builtins.functionArgs — inspect module signature
|-- applyContracts — lazy assertion wrapping (cf. Chitil 2012 §4.2)
|-- resolvePolicy — per-arg merge strategy dispatch (cf. Leijen 2005 §2)
|-- detectThunkArgs — identify config-dependent list bindings
'-- wrapFunctionModule / wrapImportsModule / passthrough
| result
{ module; wrapped; validator; signature; advertisedArgs }
| optional post-processing
wrapIdentity — NixOS key stamping (cf. Cardelli 1997 §5)
stripBindingArgs — formal arg cleanup
mkMergeValidator — collision detection with blame (cf. Findler 2002 §2)
lib/
default.nix — public API surface (takes { prelude })
wrap.nix — core wrapping logic (wrapCore, wrapAllCore)
merge-strategy.nix — collision detection and merge validator
contract.nix — lazy binding contracts (mk, hasFields, isType, nonEmpty, apply)
thunk.nix — config thunk primitives (mkThunk, mkThunkFrom, isThunk, resolveThunks)
provenance.nix — blame formatting
compose.nix — layered composition (compose, composeWith)
identity.nix — NixOS module identity wrapping
strip.nix — binding arg stripping for NixOS compatibility
signature.nix — module signature inference
module-convention.nix — vendored nixpkgs convention helpers (setFunctionArgs, setDefaultModuleLocation)

65 tests across 12 suitescompose, contract, evalmodules-equivalence, identity, integration, merge-strategy, provenance, purity, signature, strip, thunk, wrap. Tests use nix-unit in ci/ (which keeps a nixpkgs dependency for the test runner and the real lib.evalModules driven by the production-safety equivalence gate):

Terminal window
cd ci
nix run nixpkgs#nix-unit -- --flake .#tests # all 65, across 12 suites
nix run nixpkgs#nix-unit -- --flake .#tests.wrap # one suite
nix flake check # full check incl. treefmt

The purity suite enforces the nixpkgs-lib-free Class B boundary — the library source imports no nixpkgs.lib — and the evalmodules-equivalence suite drives gen-bind output through a real lib.evalModules to prove the vendored convention helpers stay byte-behavior-identical.

gen-bind’s design draws on five papers. Each is either implemented (the paper’s formalism directly shapes the code) or informed by (the paper’s concepts influenced the approach without direct implementation).

FeaturePaperRelationship
Blame trackingFindler & Felleisen — Contracts for Higher-Order Functions (ICFP 2002)Provenance metadata plays the role of Findler’s blame labels: when a contract fires or a collision is detected, the error message identifies the guilty party (binding source, scope rule) via the same covariant/contravariant blame assignment structure (cf. Findler 2002 S2.3).
Lazy contractsChitil — Practical Typed Lazy Contracts (ICFP 2012)Contracts are partial identities (assert c is less than or equal to id — Chitil 2012 S4.2) that fire on demand. gen-bind contracts wrap binding values in exactly this pattern: the assertion thunk is never forced unless the consuming module demands the arg (cf. Chitil 2012 S2).
Module signaturesCardelli — Program Fragments, Linking, and Modularization (POPL 1997)gen-bind’s signature.requires and signature.bound are a lightweight analog of Cardelli’s linkset interfaces: each compilation unit (wrapped module) declares what it provides (bound args) and what it still needs (requires from evalModules). Identity wrapping implements Cardelli’s fragment naming for dedup (cf. Cardelli 1997 S5).
FeaturePaperRelationship
Closure-based bindingReynolds — Definitional Interpreters for Higher-Order Programming Languages (1972)Reynolds’ closure environments inform the approach but gen-bind’s wrapping is partial application, not defunctionalization per se. builtins.functionArgs is the Nix analogue of formal parameter reflection in a definitional interpreter (cf. Reynolds 1972 S4).
Merge resolutionLeijen — Extensible Records with Scoped Labels (TFP 2005)Leijen’s free extension (retaining duplicate labels with scoped resolution) informs the merge strategy vocabulary: bindWins shadows like Leijen’s first-match selection; error mirrors strict extension where duplicates are rejected (cf. Leijen 2005 S2). gen-bind uses flat // rather than row-typed scoping.