845d6b8dcd
## Summary - Introduce a standalone Python roadmap validator with a CLI entry point, modular validation pipeline, and GitHub Actions wiring so roadmap content can be linted locally and in CI. - Provide reusable validation primitives for path resolution, front-matter parsing, identity checks, task parsing, catalog enforcement, and template adherence. - Document usage, configuration, and workflow behaviour to make the validator approachable for contributors. ## Validator Details - **Core tooling** - Added the `tools/roadmap_validator/` package with `validate.py` (CLI), `validator.py` (orchestration), and helper modules (`tasks.py`, `identity.py`, `paths.py`, `constants.py`, `issues.py`). - CLI supports directory/file targets, skips default filenames, emits GitHub annotations, and integrates optional substring filtering - README explains features, environment variables, and development guidance. - **Catalog and template enforcement** - `catalog.py` verifies each allowed content unit has `index.md` and `preview.md`, confirms roadmap entries appear under the proper quarter/area, and flags stale or missing links. - `templates.py` enforces template basics: front matter completeness, `## Description` ordering/content, template placeholder cleanup, and task section detection. - **Task validation** - `tasks.py` checks required metadata (`owner`, `status`, `start-date`, `end-date`), date formats, populated descriptions/deliverables, TODO markers, tangible deliverable heuristics, and `fully-qualified-name` prefixes. - **Workflow integration** - `.github/workflows/roadmap-validator.yml` runs the validator on pushes and manual dispatch, installs dependencies, scopes validation to changed Markdown, and surfaces findings via GitHub annotations. ## Existing Roadmap Updates - Normalised 2025q4 commitments across Web, DST, QA, SC, and other units by filling in missing descriptions, deliverables, schedule notes, recurring task statuses, and maintenance tasks. - Added tasks where absent, removed remaining template placeholders, aligned fully qualified names, and ensured roadmap files conform to the new validator checks. ## Testing ```bash python tools/roadmap_validator/validate.py *2025q4* ``` CI: `Roadmap Validator` workflow runs automatically on pushes/dispatch. --------- Co-authored-by: kaiserd <1684595+kaiserd@users.noreply.github.com>
4.9 KiB
title, tags, draft, description
| title | tags | draft | description | |||
|---|---|---|---|---|---|---|
| Kademlia DHT |
|
false | Implement Kademlia DHT |
vac:p2p:ift:2025q4-nimlibp2p-kad-dht
Description
Implement Kademlia Distributed Hash Table in nim-libp2p, based on the libp2p specification as an additional discovery mechanism. This commitment involves two main objectives: implementing nim-kademlia-dht, integrating this in nim-libp2p and making sure there is interoperability with other libp2p implementations. This deliverable continues the work started in 2025q2
Task List
Routing table and RPC Protocol
- fully qualified name:
vac:p2p:ift:2025q4-nimlibp2p-kad-dht:routing-and-rpc - owner: gabe/rramos
- status: in progress(75%)
- start-date: 2025/10/01
- end-date: 2025/12/31
Description
Implement Kademlia’s XOR-based routing table with bucket management. Define RPC messages (PING, SET_VALUE, GET_VALUE, ADD_PROVIDERS, GET_PROVIDERS, FIND_NODE) for node communication.
Schedule note: Dates reflect quarter bounds; update when actual timing is known.
Deliverables
- vacp2p/nim-libp2p#1454 feat(kad-dht): routing table
- vacp2p/nim-libp2p#1453 feat(kad-dht): protobuffers
- vacp2p/nim-libp2p#1455 feat(kad-dht): handler
- vacp2p/nim-libp2p#1744 feat(kad): add ping
Bootstrapping & Lookup Mechanism
- fully qualified name:
vac:p2p:ift:2025q4-nimlibp2p-kad-dht:bootstraping-and-lookup - owner: rramos
- status: done
- start-date: 2025/10/01
- end-date: 2025/12/31
Description
Enable nodes to join the network via bootstrap peers. Implement iterative lookup for efficient key discovery and retrieval
Schedule note: Dates reflect quarter bounds; update when actual timing is known.
Deliverables
- vacp2p/nim-libp2p#1624 feat(kad-dht): findPeer
Network Maintenance & Node Management
- fully qualified name:
vac:p2p:ift:2025q4-nimlibp2p-kad-dht:network-maintenance-node-management - owner: gabe
- status: in progress(50%)
- start-date: 2025/10/01
- end-date: 2025/12/31
Description
Handle bucket refresh, node eviction, and periodic pings to maintain an active routing table. Implement bucket splitting and adaptive refresh strategies.
Schedule note: Dates reflect quarter bounds; update when actual timing is known.
Deliverables
- vacp2p/nim-libp2p#1746 chore(kad): routing table eviction policy
Data Storage & Replication
- fully qualified name:
vac:p2p:ift:2025q4-nimlibp2p-kad-dht:data-storage - owner: gabe
- status: in progress(90%)
- start-date: 2025/10/01
- end-date: 2025/12/31
Description
Implement the logic for SET_VALUE and ADD_PROVIDERS. Store key-value pairs with expiration and replication mechanisms.
Ensure values persist despite churn, using periodic re-publication and redundancy strategies
Schedule note: Dates reflect quarter bounds; update when actual timing is known.
Deliverables
- vacp2p/nim-libp2p#1582 feat(kad): Initial unstable putval api
- vacp2p/nim-libp2p#1749 chore(kad): tidy up putVal
- vacp2p/nim-libp2p#1773 feat(kad): addProvider
- vacp2p/nim-libp2p#1789 feat(kad): add ProviderManager
Data Retrieval
- fully qualified name:
vac:p2p:ift:2025q4-nimlibp2p-kad-dht:data-retrieval - owner: gabe
- status: in progress(60%)
- start-date: 2025/10/01
- end-date: 2025/12/31
Description
Implement the logic for GET_VALUE and GET_PROVIDERS. Implement validation and quorum mechanisms for queries
Schedule note: Dates reflect quarter bounds; update when actual timing is known.
Deliverables
- vacp2p/nim-libp2p#1764 chore(kad): add alpha handling
- vacp2p/nim-libp2p#1750 feat(kad): add getValue
- vacp2p/nim-libp2p#1765 chore(kad): getVal loop improvements
Discovery
- fully qualified name:
vac:p2p:ift:2025q4-nimlibp2p-kad-dht:discovery - owner: gabe
- status: in progress(15%)
- start-date: 2025/10/01
- end-date: 2025/12/31
Description
Extend nim-libp2p discovery mechanism by providing a discovery interface that will use Kademlia DHT to advertise nodes and find peers
Deliverables
PRs
Interop
- fully qualified name:
vac:p2p:ift:2025q4-nimlibp2p-kad-dht:interop - owner: gabe
- status: not started
- start-date: 2025/10/01
- end-date: 2025/12/31
Description
Ensure interop is achieved between nim-libp2p's kad-dht implementation and other libp2p implementations
Deliverables
PRs