web3-storage / freeway

🛣 Experimental IPFS HTTP gateway providing access to UnixFS data via CAR CIDs.

freeway

🧪 Experimental IPFS HTTP gateway providing access to UnixFS data via CAR CIDs.

The freeway currently works with the following R2 buckets:

• CARPARK - CAR file storage area. Key format <CAR_CID>/<CAR_CID>.car
• SATNAV - Indexes of block offsets within CARs. Key format <CAR_CID>/<CAR_CID>.car.idx, index format MultihashIndexSorted.
• DUDEWHERE - Mapping of root data CIDs to CAR CID(s). Key format <DATA_CID>/<CAR_CID>.

How it works:

1. Extract DATA_CID from URL.
2. Lookup CAR_CID(s) in DUDEWHERE.
3. Read indexes from SATNAV
4. UnixFS export directly from CARPARK using index data to locate block positions.

The querystring parameter origin can optionally provide the hint of which CAR file(s) the data DAG is contained within. e.g.

https://freeway.dag.haus/ipfs/bafybeiaaxqlnwlfeirgr5p63ftnfszmerttupnwrim52h4zv2tfpntbjdy/data.txt?origin=bagbaieralsmnkvhi3t3d7lek2ti2vhfglb4bhw7gite2qsz467zjuqvbvyva

Read MOAR

Contributing

Feel free to join in. All welcome. Please read our contributing guidelines and/or open an issue!

License

Dual-licensed under MIT + Apache 2.0