libp2p / libp2p/specs

Specification upgrades: Determining the way forward?

Open
#649 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
1.8k
Forks
320
Avg merge
11d 15h
Merged PRs (30d)
1

Description

We currently have GossipSub v1.2 specifications that focus on optimally handling large messages. Additionally, there is already a PR for PeerDAS support as GossipSub v1.3.

We need to determine the best approach for proposing further optimizations related to large message handling (v1.2). Here are a few possible options:

  1. Update v1.2: Since v1.2 is still an active working draft, we can revise it to create a consolidated document that includes all optimizations for large message handling.
  • Pros: This would unify all large message optimizations in one document.
  • Cons: Some implementations are already advertising v1.2, and updating the specifications may impact those implementations.
  1. Utilize v1.2.x Format for Future (Large Message) Recommendations: We can use v1.2.1 for subsequent recommendations.
  • Pros: Simple upgrades within v1.2.
  • Cons: Should v1.2.2 conform to all specifications outlined in v1.2.1 as well (or what version number to advertise)?
  1. Introduce as v1.4:
  • Pros: simple straightforward version upgrades
  • Cons: A router may choose not to support 1.3 and still support 1.2 and 1.4. It may require advertising all the supported versions.

Contributor guide

No contributing guide indexed for this repository

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

Read pubsub/gossipsub/gossipsub-v1.2.md and review the linked PeerDAS PR #617 first. Compare the proposed v1.2 update, v1.2.x, and v1.4 approaches, with the work complete when the project has decided how future large-message optimizations should be versioned.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, networking
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.