Skip to content

docs(ttx): versioning exploration for interactive protocols #1658

Closed
SuyashAlphaC wants to merge 2 commits into
hyperledger-labs:mainfrom
SuyashAlphaC:feat/ttx-versioning-exploration
Closed

docs(ttx): versioning exploration for interactive protocols #1658
SuyashAlphaC wants to merge 2 commits into
hyperledger-labs:mainfrom
SuyashAlphaC:feat/ttx-versioning-exploration

Conversation

@SuyashAlphaC
Copy link
Copy Markdown
Contributor

This PR adds the design exploration document requested by @adecaro on #1620 and tracked under #1654. It is documentation only — no code or behavior changes.

The doc lives at docs/services/ttx-versioning.md and covers:

  • A surface map of every interactive view in token/services/ttx/ that exchanges typed messages over FSC sessions
  • Evaluation of four versioning approaches (embedded version field, envelope wrapper, negotiation handshake, alignment with Aggregated Protobuf Best Practices Analysis & Improvement Plan #1622)
  • A recommended minimal v1: a JSON envelope at the session helper layer, scoped to the four JSON-typed flows
  • Mixed-version policy options (strict / tolerant fallback / capability handshake) with a recommended starting point
  • Coordination strategy with the proto-direction in Aggregated Protobuf Best Practices Analysis & Improvement Plan #1622 — placed at the same architectural layer so it can be replaced cleanly later
  • A migration sketch and explicit open questions for maintainer review

The proposal is non-implementation by design — it asks for maintainer alignment before any code is written.

Test plan

Refs: #1654

Add a design exploration document for introducing versioning to the
interactive protocols in token/services/ttx. The document maps every
interactive view that exchanges typed messages over FSC sessions,
evaluates four versioning approaches, and recommends a minimal v1
envelope at the session helper layer.

The exploration is the deliverable of issue hyperledger-labs#1654 and is intentionally
non-implementation: it produces a proposal for maintainer review before
any code is touched. It coordinates with the proto-direction work in
hyperledger-labs#1622 by placing the envelope at the same architectural layer that a
proto envelope would later replace.

Refs: hyperledger-labs#1654
Signed-off-by: SuyashAlphaC <suyashagrawal862@gmail.com>
@SuyashAlphaC SuyashAlphaC marked this pull request as ready for review May 7, 2026 06:08
@adecaro
Copy link
Copy Markdown
Contributor

adecaro commented May 12, 2026

Hi @SuyashAlphaC , great effort, thanks 🙏

In the meantime, please, create an Issue with your first analysis in the description. I'll prepare an answer to it so that we can proceed with the implementation plan. What do you think?

@SuyashAlphaC
Copy link
Copy Markdown
Contributor Author

Hey @adecaro . As per your note — moving the first analysis into the issue body at #1654 for discussion before any code lands. Closing this PR; will open a fresh implementation PR once the design questions there are answered.

Thanks 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants