Skip to main content

Protocol Registry Wizard

A Textual TUI for designing protocol registry entries with hard guardrails.

Features

  • Capture protocol identity, deployment identity, ABI sources, and subgraph wiring
  • Enforce one ABI per one address for live protocol drafts
  • Refuse to generate a live draft when address-local ABI coverage is incomplete
  • Emit explicit validation logs and a markdown onboarding draft
  • Keep metadata-only and live-protocol paths separate

Installation

pip install protocol-registry-wizard

Usage

protocol-wizard

Or run as a module:

python -m protocol_registry

Key Bindings

Binding Action
Ctrl+Q Quit
Ctrl+R Refresh preview
Ctrl+G Generate draft (JSON + markdown)
Ctrl+S Scaffold (stub + env snippet + test + promotion patch)

Output

  • Drafts: Written to docs/protocol_registry_drafts/
  • Scaffolded code: Written to docs/protocol_registry_drafts/generated/

Docker

docker build -t protocol-wizard .
docker run -it -v $(pwd)/output:/app/output protocol-wizard

Development

git clone https://github.com/stratagemresearch/protocol-registry-wizard.git
cd protocol-registry-wizard
uv venv && uv pip install -e .

License

MIT

Release files for hirschauers-protocol-registry-wizard 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hirschauers-protocol-registry-wizard 0.1.0
File Size Uploaded
hirschauers_protocol_registry_wizard-0.1.0.tar.gz 12.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hirschauers-protocol-registry-wizard 0.1.0
File Interpreter ABI Platform
hirschauers_protocol_registry_wizard-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 23.0 kB

Release files / hirschauers_protocol_registry_wizard-0.1.0.tar.gz

Download URL hirschauers_protocol_registry_wizard-0.1.0.tar.gz
Size 12.7 kB
Tags Source
SHA-256 checksum
How to use checksums
28b7cbb7a2a20d9540d26c3bbe1477fdfcf8bf061c60e4221b7bb7a9048317ce
BLAKE2b-256 checksum
How to use checksums
1528bd6a5bb347c4eec8fb78ebec84b7aa556ffb75b3d2452ceaa80aae69a6d2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.12

Release files / hirschauers_protocol_registry_wizard-0.1.0-py3-none-any.whl

Download URL hirschauers_protocol_registry_wizard-0.1.0-py3-none-any.whl
Size 10.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1dc18b190e84296728920e390baec5aeb5a6177eab951ccd0c16c9439783c45b
BLAKE2b-256 checksum
How to use checksums
85e8dc100d504582bab758c986ccf38e186d0e024a38d4f8b8bf5f93490cac4c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.12

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page