Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish existing Bitswap specs at specs.ipfs.tech #437

Merged
merged 7 commits into from
Oct 18, 2023
Merged

Publish existing Bitswap specs at specs.ipfs.tech #437

merged 7 commits into from
Oct 18, 2023

Conversation

hacdias
Copy link
Member

@hacdias hacdias commented Sep 19, 2023

As per what I discussed with @lidel, this PR moves the current Bitswap specs to the website. Merge should be done using rebase or merge commit in order to preserve the history for the Bitswap specifications.

Note that I put this under architecture. We may want to either create a new section, or put it somewhere else.

@lidel
Copy link
Member

lidel commented Sep 19, 2023

I've created /exchange category and moved Bitswap spec to /exchange/bitswap (which will produce permalink https://specs.ipfs.tech/exchange/bitswap/).

Preview:

@aschmahmann any concerns or ok to merge?

@lidel lidel changed the title Move Bitswap specs to website Publish existing Bitswap specs at specs.ipfs.tech Sep 19, 2023
Copy link
Contributor

@aschmahmann aschmahmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly LGTM, one small change requested (removing the unnecessary text after switching the section from content routing -> routing). The rest are optional.

Thanks for doing this 🙏

src/routing/index.html Outdated Show resolved Hide resolved
src/routing/index.html Outdated Show resolved Hide resolved
}
```

## Implementations
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can be done in a follow up, but noticed we're missing a Rust implementation here. Anyone know what implementations of Bitswap are best supported in Rust? cc @mxinden @b5

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know several, but I am not familiar enough with either to be able to endorse one.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If there are multiple I think fine to include them.

Just would prefer to not add in abandoned, non functional, etc. implementations where people will likely be better off not relying on them. People can still find those with a search engine if they want to build an implementation and see where others left off.

Copy link
Member

@lidel lidel Oct 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@b5 @dignifiedquire do you feel we could include bitswap crate from Beetle here (in this PR or future one), or is it not something you plan to maintain going forward?

Copy link
Member

@lidel lidel Oct 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@achingbrain: any learnings from maintaining https://github.com/ipfs/js-ipfs-bitswap?
@hannahhoward @gammazero @masih: I know you've been using bitswap (1.2.0?) for retrieval in Lassie and for content routing in Cassette this year.

This is the revamped spec for basics of Bitswap Protocol (it does not include things like Bitswap Sessions, which are implementation-specific).

Is there anything you feel is missing from this document? Any "Notes for implementers" we could/should include as an Appendix to this document, while we are at it?

If not, perfectly ok, just thought I'll send a ping in your direction in case there was something you've noticed.

hacdias and others added 7 commits October 17, 2023 13:49
@BigLep
Copy link
Contributor

BigLep commented Oct 17, 2023

2023-10-17 maintainer conversation: @aschmahmann will approve and @lidel will merge

@lidel lidel merged commit e5bbe2a into main Oct 18, 2023
4 checks passed
@lidel lidel deleted the bitswap branch October 18, 2023 22:43
@BigLep BigLep mentioned this pull request Nov 9, 2023
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants