0xMiden / 0xMiden/note-transport-service

Proto package lacks a version suffix; no buf breaking check in CI

Open
#135 0 comments 0 reactions 0 assignees View on GitHub
enhancement production-readiness
Dominant language
Rust
Stars
3
Forks
10
Avg merge
2h 23m
Merged PRs (30d)
4

Description

Severity: medium.

### Summary

The proto package is `miden_note_transport` with no `.v1` suffix (`proto/proto/miden_note_transport.proto:3`) and there is no `buf breaking` check in CI. Reflection (v1) is registered.

### Impact

For a production internet-facing API there is no path to introduce v2 side-by-side, and nothing guards against accidental wire-breaking edits (field renumbering, etc.).

### Recommendation

Rename to `miden.note_transport.v1` before GA (breaking now is cheap, later impossible) and add `buf breaking` to CI.

---
Part of #114.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.