Overview

This section is for developers building applications on top of ADAPT. It assumes you have read What is ADAPT and Architecture — if not, those two pages take ten minutes and will save you an hour.

The section is organised the way most projects unfold:

  1. Set up your toolchain — install the MUFL compiler, REPL, and optionally the VS Code language server.
  2. The MUFL language — learn the language your packet logic is written in.
  3. Compile your MUFL code — turn .mufl sources into the .muflo artifacts that the evaluator runs.
  4. Ship a product — embed the .muflo into a host application (Embed .muflo in your app) and stand up the runtime components your network needs (Deploy your network).
  5. Tutorials — end-to-end walk-throughs from a one-line script to a fully-encrypted messenger. (Currently being rewritten against the new toolchain; the runnable messenger-demo is the up-to-date reference in the meantime.)
  6. Debugging & logs — the workflow for diagnosing failed transactions and inspecting wrapper-level traces.

What lives where

The pieces you will be touching during development:

  • mufl-compile — the MUFL compiler. Reads .mufl / .mu / .mm sources, writes .muflo.
  • mufl — the REPL. Quick experiments and one-off .muflo evaluation.
  • meta — the type-checking library used by the compiler. Ships with the toolchain.
  • mufl_stdlib — the standard library. Ships with the toolchain.
  • transactions — internal library that implements the transaction-return convention used by MUFL.
  • @adapt-toolkit/sdk — the npm package you depend on from your TypeScript / JavaScript application to talk to compiled packets. See the SDK API reference.
  • MUFL language server — VS Code extension that gives you diagnostics, autocomplete, and rename for MUFL files. See Install the language server.

A worked example

For a guided walk-through of building a real ADAPT application end to end, see the tutorials section (rewrite in progress) or the live messenger-demo repository.