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

Boxo gateway should support IPIP-402 parameters #283

Closed
3 tasks
hannahhoward opened this issue Apr 20, 2023 · 1 comment · Fixed by #303
Closed
3 tasks

Boxo gateway should support IPIP-402 parameters #283

hannahhoward opened this issue Apr 20, 2023 · 1 comment · Fixed by #303
Assignees
Labels
dif/expert Extensive knowledge (implications, ramifications) required effort/days Estimated to take multiple days, but less than a week P1 High: Likely tackled by core team if no one steps up topic/gateway Issues related to HTTP Gateway

Comments

@hannahhoward
Copy link
Contributor

hannahhoward commented Apr 20, 2023

What

Feature request. Boxo's gateway module should be updated to support the parameters and behavior described in ipfs/specs#402.

Specifically, for CAR requests, the gateway should:

  • return intermediate blocks for the path when the request is for a cid+path
  • support the car-scope parameter (including block, file, all)
  • support the bytes parameter (lower priority -- not needed for the use case below)

Why

  1. Lassie would like to retrieve from Boost over HTTP. Boost supplies an HTTP gateway by incorporating Boxo's gateway module. For Lassie to retrieve from Boost trustlessly, and serve all of the neccesary requests, the gateway must support the changes in IPIP-402, or at least everything except the bytes parameter. While we can certainly redirect to a shim for CAR requests, it seems like that would be very temporary solution and it would be better to just do it in Boxo.
  2. CAR-based improvements to bifrost-gateway will be helped having a stable implementation to make calls against so can iterate against. Testing directly against not-yet-verified-if-spec-compliant Saturn adds in variables.
  3. Implementations of IPIP-402 (e.g., Boxo, Kubo, bifrost-gateway, Lassie, Boost) want/need conformance tests. Given EngRes IP Stewards are driving the conformance tests, it's good to have a place they can quickly iterate on for validating the conformance tests.
  4. Merging IPIP-402: Partial CAR Support on Trustless Gateways specs#402 requires having an accompanying client/server implementation to validate the work. Boxo is a natural place to do this work.
@hannahhoward hannahhoward added the need/triage Needs initial labeling and prioritization label Apr 20, 2023
@lidel lidel added P1 High: Likely tackled by core team if no one steps up dif/expert Extensive knowledge (implications, ramifications) required effort/days Estimated to take multiple days, but less than a week topic/gateway Issues related to HTTP Gateway and removed need/triage Needs initial labeling and prioritization labels Apr 21, 2023
@lidel lidel moved this to 📋 Backlog in bifrost-gateway Apr 21, 2023
@BigLep
Copy link
Contributor

BigLep commented May 9, 2023

I added more justification in the issue description for why this work should be done.

@BigLep BigLep moved this to 🥞 Todo in IPFS Shipyard Team May 11, 2023
@BigLep BigLep moved this from 🥞 Todo to 🏃‍♀️ In Progress in IPFS Shipyard Team May 16, 2023
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in bifrost-gateway Jun 8, 2023
@github-project-automation github-project-automation bot moved this from 🏃‍♀️ In Progress to 🎉 Done in IPFS Shipyard Team Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dif/expert Extensive knowledge (implications, ramifications) required effort/days Estimated to take multiple days, but less than a week P1 High: Likely tackled by core team if no one steps up topic/gateway Issues related to HTTP Gateway
Projects
No open projects
Archived in project
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants