docs: add Retrieval page under Core Concepts#819
Open
nijoe1 wants to merge 1 commit into
Open
Conversation
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ❌ Deployment failed View logs |
synapse-dev | da0a9de | Jun 03 2026, 08:23 AM |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Core Concepts → Retrieval documentation page explaining how Filecoin Onchain Cloud (FOC) serves stored data back to applications, including direct storage-provider retrieval, CDN-accelerated retrieval via Filecoin Beam/FilBeam, and IPFS-style retrieval via Filecoin Pin.
Changes:
- Adds a new
Retrievalcore-concepts page describing retrieval fundamentals and “store and serve” behavior. - Documents the three retrieval paths with a Mermaid flow diagram and a FilBeam quota-check example.
- Links out to related guides (Storage Operations, FWSS, FilBeam docs).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| [**Filecoin Beam**](https://docs.filbeam.com/) is the retrieval and delivery layer of FOC. It is a content delivery network that caches pieces close to where they are requested, cutting retrieval latency from seconds to milliseconds. | ||
|
|
||
| FilBeam serves each piece from a per-account subdomain keyed by PieceCID. On mainnet: |
| import { Synapse } from "@filoz/synapse-sdk" | ||
| import { privateKeyToAccount } from "viem/accounts" | ||
|
|
||
| const synapse = await Synapse.create({ account: privateKeyToAccount("0x..."), source: "my-app" }) |
|
|
||
| ## IPFS Retrieval | ||
|
|
||
| For applications that speak IPFS natively, content stored through [**Filecoin Pin**](/core-concepts/filecoin-pin/) is also served over the IPFS network. Filecoin Pin packs your data into an IPFS CAR, stores it on FOC providers, and announces it to IPNI, so it resolves through standard IPFS gateways by its root CID: |
| https://dweb.link/ipfs/<your-root-cid> | ||
| ``` | ||
|
|
||
| This path lets IPFS-native apps treat FOC as a durable, verifiable backing store while keeping the addressing and access patterns their stack already uses. See the [Filecoin Pin quick start](/getting-started/filecoin-pin/) to pin and retrieve your first file. |
|
|
||
| - [Storage Operations](/developer-guides/storage/storage-operations/) - Upload and download with the SDK | ||
| - [Filecoin Warm Storage Service](/core-concepts/fwss-overview/) - The service layer behind storage and retrieval | ||
| - [Filecoin Pin](/core-concepts/filecoin-pin/) - Guaranteed IPFS pinning backed by FOC |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a Retrieval page covering how the Filecoin Onchain Cloud serves data back, across direct (non-CDN) retrieval, Filecoin Beam (CDN), and IPFS retrieval via Filecoin Pin.
Closes #816