Skip to content

Commit d0d8201

Browse files
authored
docs: clarify provider and retrieval implementation paths (filecoin-project#2466)
* docs: clarify provider and retrieval implementation paths * docs: address provider retrieval review feedback * docs: point FOC retrieval row to retrieval docs
1 parent 59982bf commit d0d8201

2 files changed

Lines changed: 29 additions & 6 deletions

File tree

getting-started/how-retrieval-works/serving-retrievals.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,17 @@ The client then attempts to retrieve the data from the SP over Bitswap, Graphsyn
3333

3434
Once the client has received the last chunk of data, the connection is closed.
3535

36+
### Implementation paths
37+
38+
Different retrieval workflows use different tools:
39+
40+
| Workflow | Maintained path |
41+
| --- | --- |
42+
| Serving PDP retrievals as a storage provider | Use [Curio](https://curiostorage.org/) for PDP retrievals. |
43+
| Serving PoRep retrievals as a storage provider | Use [Boost](https://boost.filecoin.io/) to serve retrievals. Boost supports Graphsync retrievals by default, and storage providers can run [`booster-http`](https://boost.filecoin.io/http-retrieval) for HTTP retrievals when configured. |
44+
| Retrieving data as a client | Use [Lassie](https://github.com/filecoin-project/lassie) to fetch content from Filecoin and IPFS using the best available retrieval path. |
45+
| Retrieving application data with Filecoin Onchain Cloud | See the [Filecoin Onchain Cloud retrieval docs](https://docs.filecoin.cloud/core-concepts/retrieval/) for maintained Synapse SDK retrieval flows. |
46+
3647

3748

3849
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/getting-started/how-retrieval-works/serving-retrievals)

storage-providers/getting-started.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Follow these steps to begin your storage provider journey:
2020
4. Build the right infrastructure
2121
5. Get to know the ecosystem
2222
6. Understand ROI and collateral
23-
7. Get started with Lotus
23+
7. Choose your provider software stack
2424
8. Set up a local development environment
2525
9. Become a storage provider
26-
10. Supercharge your mainnet experience with Boost
26+
10. Configure PoRep deal-making and retrieval services
2727
11. Explore verified deals and ecosystem tools
2828

2929
## Understand Filecoin economics
@@ -109,9 +109,19 @@ One of the enriching elements of the Filecoin ecosystem lies in its vibrant comm
109109

110110
To run a successful storage provider business, it is crucial to understand the concept of Return on Investment (ROI) and the significance of collateral. By planning ahead and considering various factors, such as CAPEX, OPEX, network variables, and collateral requirements, you can make informed decisions that impact your business's profitability and desired capacity.
111111

112-
## Get started with Lotus <a href="#get-started-with-lotus" id="get-started-with-lotus"></a>
112+
## Choose your provider software stack
113113

114-
Lotus is the leading reference implementation of the Filecoin protocol and the most widely used software stack for interacting with the blockchain and operating a storage provider setup. Understanding Lotus is fundamental to navigating the Filecoin network and building a reliable storage operation.
114+
Storage providers usually run several pieces of software together. Start by understanding which component handles each part of the operation:
115+
116+
| Component | Role |
117+
| --- | --- |
118+
| [Curio](https://curiostorage.org/) | Modern storage-provider stack for running provider operations, including PDP storage, proving, and retrieval, and PoRep sealing and proving workflows. |
119+
| [Lotus](https://lotus.filecoin.io) | Reference Filecoin implementation for chain sync, node operations, miner actor interactions, and client tooling. |
120+
| [Boost](https://boost.filecoin.io) | Deal-making and retrieval software for accepting PoRep storage deals and serving retrievals, including HTTP retrievals when configured. |
121+
122+
For new storage-provider planning, treat Curio as the provider operations stack, Lotus as the underlying Filecoin node and chain tooling, and optionally Boost as the PoRep storage-deal and retrieval layer. Use each project's maintained documentation for installation and production configuration.
123+
124+
[Curio documentation ->](https://docs.curiostorage.org/)
115125

116126
[Lotus documentation ->](https://lotus.filecoin.io)
117127

@@ -127,9 +137,11 @@ Once ready, determine your starting capacity and architect a solution to accommo
127137

128138
[Reference architectures ->](./infrastructure/reference-architectures.md)
129139

130-
## Supercharge your mainnet experience with Boost <a href="#supercharge-your-mainnet-experience-with-boost" id="supercharge-your-mainnet-experience-with-boost"></a>
140+
## Configure PoRep deal-making and retrieval services
141+
142+
As you step into the mainnet, Boost helps you accept PoRep storage deals and offer data retrieval services to data owners. Deploying Boost unlocks your ability to participate in PoRep deal-making and serve clients across the Filecoin network.
131143

132-
As you step into the mainnet, Boost is the software designed to help you secure storage deals and offer efficient data retrieval services to data owners. Deploying Boost unlocks your ability to participate in deal-making and serve clients across the Filecoin network.
144+
Boost is not used for PDP deals and retrieval.
133145

134146
[Boost documentation ->](https://boost.filecoin.io)
135147

0 commit comments

Comments
 (0)