Skip to content

Reference

Welcome to the nXCC reference documentation. These pages provide detailed, technical information about the core concepts, APIs, and configuration of the nXCC platform.

Documentation for building workers and applications on nXCC:

  • Core Concepts: A deep dive into Identities, Policies, and Workers.
  • SDK Reference: Complete API reference for the @nxcc/sdk package.
  • CLI Reference: A complete guide to the @nxcc/cli commands for development.
  • Worker Manifest: The specification for the worker.manifest.json file.
  • Worker Runtime APIs: The execution environment and APIs available to your workers.
  • Event Triggers: How to trigger workers from on-chain events, HTTP requests, and more.
  • Identities & Policies: Advanced details on the on-chain identity and programmable policy system.

Documentation for running and managing nXCC nodes: