matrix-org / matrix-org/matrix-spec

S2S get_missing_events: does the walk terminate at `earliest_events`?

Open
#1,513 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

**Link to problem area**: https://spec.matrix.org/v1.6/server-server-api/#post_matrixfederationv1get_missing_eventsroomid

**Issue**
Says:

> This is done by doing a breadth-first walk of the prev_events for the latest_events, ignoring any events in earliest_events and stopping at the limit.

And for `earliest_events`:

> Required: The latest event IDs that the sender already has. These are skipped when retrieving the previous events of latest_events.

In both cases it's not clear what exactly is meant with "ignoring" and "skipping" - does this simply mean that those events are elided from the response, but the walk continues beyond them? Or does it mean that encountering an event from the `earliest_events` terminates the DAG walk for that specific branch, and so any known event's ancestors are not considered either (unless otherwise encountered)?

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

Start with the Matrix Server-Server API's POST /_matrix/federation/v1/get_missing_events section linked in the issue. Compare the descriptions of latest_events and earliest_events, then establish the intended walk behavior with the specification maintainers; done means the endpoint text unambiguously defines how those events affect traversal.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.