Avian FlightPlan Registry

This repository tracks curated Lua FlightPlans that are registered on-chain but distributed off-chain. Nodes can point syncflightplan and analyzeflightplan at manifest.json in this repo to install or audit scripts.

Layout

approved/       # reviewed scripts whose hashes already exist on-chain
experimental/   # work-in-progress scripts; not guaranteed registered yet
docs/           # schema notes, contributor guides
tools/          # automation for hashing and manifest regeneration
manifest.json   # canonical manifest consumed by nodes and tooling

Workflow

1. Authoring – contributors PR Lua files under experimental/ or approved/.
2. Hashing – maintainers run python tools/hash_manifest.py (or manual commands) to recompute SHA256 values and rewrite manifest.json.
3. Verification – analyzeflightplan is run against each script before merging to ensure risk classification and index registrations look correct.
4. Publishing – once merged, tag a release or push main; nodes can pull the manifest.json URL or mirror the repo locally.

Using with Avian nodes

# copy manifest locally
curl -o ~/.avian/flightplans/manifest.json https://raw.githubusercontent.com/<org>/flightplans/main/manifest.json

# install vetted script
avian-cli syncflightplan hello_world

# audit before enabling
avian-cli analyzeflightplan hello_world flightplans/approved/hello_world.lua

Regeneration Checklist

1. Update/verify Lua sources.
2. Run the hashing tool to refresh manifest.json.
3. Confirm every entry’s txid/vout matches a confirmed registration.
4. Commit the new manifest and scripts together.
5. (Optional) sign releases or attach manifests to GitHub Releases for easier mirroring.

Refer to docs/manifest-schema.md for the full JSON schema and field descriptions.