Plugin Reference

Plugins are standalone WebSocket applications that expose compute functions to a Timeleap worker. All communication is binary and follows a strict schema contract using @timeleap/sia.

Architecture

• Plugins are standalone processes running in containers
• Workers connect to each plugin over WebSocket (inside Docker network)
• Plugins receive binary RPC requests and return encoded binary responses
• Function metadata is declared in conf.yaml

conf.yaml Declaration

Plugins must be declared inside the broker config:

Sia Schemas

Plugins use @timeleap/sia to define schemas for input/output types.

Example:

Compile them with:

Worker → Plugin Payload

The worker sends this binary structure to the plugin:

Plugins must decode RPCRequest, then decode params using the expected method schema.

Plugin Response

Plugins respond with a binary payload matching the schema for that method:

There is no envelope. Just send the encoded Uint8Array response back to the worker.

Runtime Example

Client Example

This example shows how to call a plugin function from a Timeleap-compatible client using @timeleap/client and @timeleap/sia.

Requirements

• Plugins must be reachable inside the Docker network (use service names)
• No JSON is allowed — all data must be encoded using @timeleap/sia
• Worker will reject malformed or schema-mismatched responses
• Function names in conf.yaml must match the schemas used

Register Plugin

Register a plugin via CLI: