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

feat: add information on the features supported by the public IPFS gateways #1877

Merged
merged 5 commits into from
Jul 2, 2024

Conversation

aschmahmann
Copy link
Contributor

Describe your changes

Given how much use and attention the public gateways provided by the IPFS Foundation get and how diverse IPFS implementations could be (https://specs.ipfs.tech/architecture/principles/#ipfs-implementation-requirements), it would be good to say explicitly what these public gateways support.

Information here is pretty rough but wanted to get something out. cc @darobin @lidel

Files changed

  • docs/concepts/public-utilities.md

What issue(s) does this address?

Does this update depend on any other PRs?

No

Checklist before requesting a review

  • Passing the beta version of the Check Markdown links for modified files check. Action results can be viewed here.

Checklist before merging

  • Passing all required checks (The beta Check Markdown links for modified files check is not required)

docs/concepts/public-utilities.md Outdated Show resolved Hide resolved
docs/concepts/public-utilities.md Outdated Show resolved Hide resolved
docs/concepts/public-utilities.md Outdated Show resolved Hide resolved
docs/concepts/public-utilities.md Outdated Show resolved Hide resolved
docs/concepts/public-utilities.md Outdated Show resolved Hide resolved
- Support one of the following libp2p transport configurations:
- QUIC-v1
- TCP or WS or WSS, Yamux, TLS or Noise
- WebTransport
Copy link
Member

Choose a reason for hiding this comment

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

WebTransport is only for browsers as far as I'm aware.

Suggested change
- WebTransport

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Pretty cool, but would be misleading. As far as I'm aware there's no reason a go peer would use WebTransport over QUIC. It would be misleading as it might wrongly suggest that browsers with WebTransport can be dialled over WebTransport.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As far as I'm aware there's no reason a go peer would use WebTransport over QUIC

IIRC WebTransport would better help you hide you were using libp2p since it just looks like a regular HTTP/3 connection. However, independent of that some environments other than browsers might make WebTransport available before QUIC due to needing lower level access to QUIC (as opposed to WebTransport which for libp2p's case runs a Noise handshake on top to establish which PeerID is associated with the connection).

@aschmahmann aschmahmann marked this pull request as ready for review June 20, 2024 16:49
@aschmahmann
Copy link
Contributor Author

@2color any idea why this is failing with
Status: 400 [Error: ENOENT: no such file or directory, access '/github/workspace/docs/concepts/nodes']? Seems like the check is in the wrong place but clicking through on the website seems ok and the link wasn't modified in this PR.

@2color
Copy link
Member

2color commented Jun 21, 2024

@aschmahmann Yeah it seems that this action is triggering some false positives, e.g. https://github.com/ipfs/ipfs-docs/actions/runs/8673131916/job/23935698662

I would just ignore it for this PR.

@bumblefudge bumblefudge self-assigned this Jun 27, 2024
@lidel
Copy link
Member

lidel commented Jun 27, 2024

@bumblefudge Try reviewing/merging #1886 first, I've fixed a bunch of broken links there, should make this one easier.

@aschmahmann aschmahmann force-pushed the feat/public-utilities-details branch from 41bd2c7 to 9855867 Compare July 2, 2024 19:12
Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

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

lgtm, should be enough until we finish ipfs/specs#453 and refer to it here

Merged small suggestions, we can refine in follow-up PR.

@lidel lidel merged commit 640fb45 into main Jul 2, 2024
5 checks passed
@lidel lidel deleted the feat/public-utilities-details branch July 2, 2024 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants