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(gateway): add specification for running the gateway over libp2p #434

Merged
merged 4 commits into from
Oct 6, 2023

Conversation

aschmahmann
Copy link
Contributor

closes #433

Recommendations on wording and if more examples/specifics from the current draft of libp2p+http spec PR (libp2p/specs#508) are desired are welcome.

Overall, this PR is just specifying that the protocol ID to use for the Gateway API is /ipfs/gateway

src/http-gateways/libp2p-gateway.md Outdated Show resolved Hide resolved
src/http-gateways/libp2p-gateway.md Outdated Show resolved Hide resolved
src/http-gateways/libp2p-gateway.md Outdated Show resolved Hide resolved
@lidel lidel force-pushed the feat/gateway-libp2p-protocol branch from a88417d to d65550c Compare October 3, 2023 19:28
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.

Pushed cosmetic cleanup and added example of the mapping file which is expected for this to work.

@aschmahmann do you think we should merge it, or should this wait until we have a reference client in Kubo that leverages this, when available? (my vote is to merge so we have a spec that we can reference – hard to tell when we have time to work on client, probably after Istanbul, right?)

@lidel lidel mentioned this pull request Oct 3, 2023
@aschmahmann
Copy link
Contributor Author

aschmahmann commented Oct 4, 2023

Yeah, I suspect an implementation in kubo will have to wait although we could probably make others (in either Go or JS) fairly easily given that we already have the tooling (we've had for blocks for a long time and for DAGs with the bifrost-gateway and saturn js-client work).

WDYT about merging this one but decreasing the spec maturity from "reliable" until it becomes more load bearing (i.e. there is at least one deployed and used pair of clients and servers that's relying on it)?

I'm also ok with a merge here though given I doubt there's much to change.

we want a spec that people can implement, and we don't have a client in
Kubo yet (only server), so switching to draft sets proper expectations
about the stability of the document
@lidel
Copy link
Member

lidel commented Oct 6, 2023

I've switched to draft to set proper expectation while the ecosystem can start implementing and refining the spec in follow-up PRs, merging.

@lidel lidel merged commit b7d4ff0 into main Oct 6, 2023
2 checks passed
@lidel lidel deleted the feat/gateway-libp2p-protocol branch October 6, 2023 13:41
@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.

Gateway: define a protocol.ID for the gateway protocol.
3 participants