libp2p / libp2p/specs

Specifications for switch/swarm

Open
#149 6 comments 0 reactions 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

I am currently going through the js-libp2p-switch library in order to make a change needed in my gossipsub implementation. The library has a lot of moving parts and it isn't exactly straightforward on how each component works together.

Are there any specifications about the dialer machine that I can read about upon which this codebase is based on?

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

Begin by reviewing this repository's existing specifications and the linked js-libp2p-switch library, focusing on the dialer machine and switch/swarm interactions. Done means locating an applicable specification or clearly recording the missing behavior and scope needed to document it.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, networking
Issue type
Documentation
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.