matrix-org / matrix-org/matrix-spec

PDUs should be sent on the wire in canonical JSON form

Open
#255 21 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-S2S wart
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Doing so means that the receiver doesn't need to re-canonicalise the JSON before checking its signature. However, it then means that receivers would need to handle the PDU as both string-representation and JSON. @richvdh: what were your other reasons for not mandating that some APIs use canonical JSON form?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. First determine whether canonical JSON should be mandated for PDUs and how receivers would handle both string and JSON representations; done means reaching a decision that can be reflected in the Matrix protocol specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
backend-api-design, cryptography
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.