Reference: Node Fields (what compile() reads)

Generated for @chainrender/client 0.21.0 — these are the fields its compile() reads, exactly. Using another version? Check yours with npm ls @chainrender/client.

Every field the compiler encodes, per node type. It is generated from chainc/node-schema.ts — the same table behind nodeJsonSchema(), checkNode(), vocabulary().nodeTypes and the MCP chainrender_check_node tool. That table is drift-locked to compile() in both directions: the TypeScript build fails if the compiler's node type gains a field the table doesn't list, and test/node-schema.ts changes every listed field and checks the compiled bytes change.

Why check a tree before compiling. compile() is lenient on purpose: it silently drops anything it doesn't read — an unknown field, a misspelled enum value (direction: "vertical", role: "note"), a11y fields on an image, args on a batch member. The tree still compiles, and the component ships without what was written. checkNode(tree) reports each of those with its path. See The Vocabulary.

Value kinds: address = 0x + 20 bytes · bytes32 = 0x + 32 bytes · hex = 0x + whole bytes · arg = hex bytes when resolver is set, otherwise free text for a client hook · integer = whole number ≥ 1 · number|string = a positive number or the same as a decimal string · record = a string-keyed map.

text

Also takes the accessibility fields and the behaviour fields (below).

box

Also takes the accessibility fields and the behaviour fields (below).

button

Also takes the accessibility fields and the behaviour fields (below).

input

Also takes the accessibility fields and the behaviour fields (below).

icon

Also takes the accessibility fields and the behaviour fields (below).

link

Also takes the accessibility fields and the behaviour fields (below).

slot

Also takes the accessibility fields and the behaviour fields (below).

image

Also takes the behaviour fields (below).

Images take no role/label/ARIA fields — alt is the image's accessible text. Those fields are dropped by compile() and reported by checkNode().

ref

A ref takes only type and hash.

Accessibility fields

On every element type except image and ref.

Presentation fields (VERSION_5, Enhanced mode)

docs/202. Read by compile(tree, { mode: "enhanced" }) only; the default (classic) drops them and checkNode() reports each as mode. Any of them opts the component into format VERSION_5, which renders only where the chain's RenderRouter has the V5 interpreter. What each style value means is on Style Tokens.

text

box

button

input

icon

link

slot

image

Behaviour fields

On every element type except ref (images included).

Fields compile() ignores

Allowed by the TypeScript type but never encoded; checkNode() reports them as ignored-field:

• image: role, label, state, id, controls, describedby, labelledby, activedescendant, haspopup
• button.batch[]: args

Builder authoring fields

Read by the visual builder and grade(), never by compile(). checkNode(tree) reports them as authoring-field; checkNode(tree, { authoring: true }) and nodeJsonSchema({ authoring: true }) accept them.

• argValues on slot and image (an object): the resolver args typed in the builder, by name; the builder encodes them into arg at export.
• image.scene (an object, on an image whose bind is p5 or three): the rich-media sketch that runs above the on-chain floor. Its fields are below.
• pinnedDep on the root node (an object): the pinned-dependency declaration grade() reads (Grade B).
• Any key starting with _ (for example _multiview, _view, _mvId): design-time metadata such as multi-view tabs.

image.scene (rich-media sketch)

An image becomes a rich-media app when its bind is p5 or three and it carries a scene. checkNode(tree, { authoring: true }) checks these exact fields (unknown keys are reported), the p5/three bind, and that libHash is not the zero hash. An empty string means "not set" for seed, libHash and entry. At deploy the builder uploads source to SourceStore (chunked when large) and registers a scene in SceneComponentRegistry: floor = SceneFloor's sigilFloor(seed), binding = encodeSceneBinding({ libHash, seed, entry: <SourceStore id>, meta }). The app is labelled ⚙ Above-floor; grade(tree) returns the floor's letter plus aboveFloor. See Rich Media: p5.js & three.js.

Limits

• At most 1024 nodes and depth 64 (the interpreter's bounds).
• At most 255 children and 255 attributes on one node.
• Each literal value at most 65535 UTF-8 bytes.