diff --git a/README.md b/README.md index 921364d13..bd26e3a3c 100644 --- a/README.md +++ b/README.md @@ -33,8 +33,8 @@ Want to help out? Pull requests (PRs) are always welcome! If you want to help ou ### Link checking -Links are checked using [lychee-action](https://github.com/lycheeverse/lychee-action) as confirugred by [check-external-links.yml](.github/workflows/check-external-links.yml). Working links are required before merging. If you have a link that should be excluded from checking: -1. wrap it in `` `backquoetes` `` OR +Links are checked using [lychee-action](https://github.com/lycheeverse/lychee-action) as configured by [check-external-links.yml](.github/workflows/check-external-links.yml). Working links are required before merging. If you have a link that should be excluded from checking: +1. wrap it in `` `backticks` `` OR 2. wrap it in `` blocks OR 3. use [`.lycheeignore`](https://github.com/lycheeverse/lychee-action?tab=readme-ov-file#excluding-links-from-getting-checked) diff --git a/WELCOME.md b/WELCOME.md index cb26edfb6..84d5cb12f 100644 --- a/WELCOME.md +++ b/WELCOME.md @@ -27,4 +27,4 @@ Choose your own adventure
đź’ˇ Learn the basicsWant to understand the fundamental concepts of Filecoin, but aren't sure where to start? The Basics section is the perfect place to begin your journey!what-is-filecoin
🔧 Build with FilecoinEager to build on top of the Filecoin network but aren't sure how to begin? Head over to the Developers section to find examples and guides to help build your project!the-fvm.md
🏗️ Become a providerStarting up a provider node on the Filecoin network can be a daunting task. Head over to the Provider section to find out everything you need to know.basics
đź“Š Store dataWant to store large amount of data on the Filecoin network? There are plenty of storage options that you can choose from! Check out the Store section for more information!storage-model.md
- [Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page%20URL=https%3A%2F%2Fapp.gitbook.com%2Fo%2FNNmD4UvLc26b1TmEYgzE%2Fs%2FxNWFG7bQkjLkl5BBGjbD%2F) +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/) diff --git a/basics/assets/README.md b/basics/assets/README.md index b2d84dab0..bd082c282 100644 --- a/basics/assets/README.md +++ b/basics/assets/README.md @@ -6,3 +6,4 @@ description: >- # Assets +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/assets) diff --git a/basics/assets/get-fil.md b/basics/assets/get-fil.md index 3a52f520c..5f0546e65 100644 --- a/basics/assets/get-fil.md +++ b/basics/assets/get-fil.md @@ -62,3 +62,6 @@ Using a Bitcoin ATM often comes with higher fees than online exchanges. Fees can If you’re looking to get FIL to test your applications on a testnet like [Calibration](../../networks/calibration/), then check how to get test tokens! Test FIL is often referred to as `tFIL`. + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/assets/get-fil) diff --git a/basics/assets/metamask-setup.md b/basics/assets/metamask-setup.md index 7c93559be..1a7d04f67 100644 --- a/basics/assets/metamask-setup.md +++ b/basics/assets/metamask-setup.md @@ -145,3 +145,4 @@ You may see a _blind signing_ warning on your MetaMask device. This is expected, +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/assets/metamask-setup) diff --git a/basics/assets/the-fil-token.md b/basics/assets/the-fil-token.md index 0c9781444..975d0bc46 100644 --- a/basics/assets/the-fil-token.md +++ b/basics/assets/the-fil-token.md @@ -40,3 +40,6 @@ Much like how a US penny represents a fraction of a US dollar, there are many wa | femtoFIL | 1,000,000,000,000,000 | | attoFIL | 1,000,000,000,000,000,000 | + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/assets/the-fil-token) diff --git a/basics/assets/transfer-fil.md b/basics/assets/transfer-fil.md index 0a02b11fa..d2050cba5 100644 --- a/basics/assets/transfer-fil.md +++ b/basics/assets/transfer-fil.md @@ -89,3 +89,6 @@ If you are transferring FIL from any exchange to your `0x` address on MetaMask, There are no special steps or requirements for sending Filecoin from one Filecoin-style address to another on the Filecoin network. + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/assets/transfer-fil) diff --git a/basics/assets/wallets.md b/basics/assets/wallets.md index fcb934999..048f200ca 100644 --- a/basics/assets/wallets.md +++ b/basics/assets/wallets.md @@ -48,3 +48,6 @@ If you know of a wallet that supports Filecoin, you can submit a pull request to * If the wallet is a mobile wallet, it must be available on both Android and iOS. * The wallet must have been audited. The results of this audit must be public. + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/assets/wallets) diff --git a/basics/how-retrieval-works/README.md b/basics/how-retrieval-works/README.md index 2894312b2..b0a26ceb7 100644 --- a/basics/how-retrieval-works/README.md +++ b/basics/how-retrieval-works/README.md @@ -6,3 +6,4 @@ description: >- # How retrieval works +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/how-retrieval-works) diff --git a/basics/how-retrieval-works/basic-retrieval.md b/basics/how-retrieval-works/basic-retrieval.md index c0356de33..a2a8411d4 100644 --- a/basics/how-retrieval-works/basic-retrieval.md +++ b/basics/how-retrieval-works/basic-retrieval.md @@ -148,3 +148,7 @@ A `GET` query against a Lassie HTTP daemon allows retrieval from peers that have #### Lassie’s CAR format Lassie only returns data in CAR format, specifically, [CARv1](https://ipld.io/specs/transport/car/carv1/) format. [Lassie’s car spec](https://github.com/filecoin-project/lassie/blob/main/docs/CAR.md) describes the nature of the CAR data returned by Lassie and the various options available to the client for manipulating the output. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/how-retrieval-works/basic-retrieval) diff --git a/basics/how-retrieval-works/saturn.md b/basics/how-retrieval-works/saturn.md index 6cc06111c..175bda7d8 100644 --- a/basics/how-retrieval-works/saturn.md +++ b/basics/how-retrieval-works/saturn.md @@ -18,3 +18,6 @@ Incentives unite, align, and grow the network. Node operators earn Filecoin for Find out more over at [saturn.tech](https://saturn.tech). + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/how-retrieval-works/saturn) diff --git a/basics/how-retrieval-works/serving-retrievals.md b/basics/how-retrieval-works/serving-retrievals.md index e5d444042..4a66aa946 100644 --- a/basics/how-retrieval-works/serving-retrievals.md +++ b/basics/how-retrieval-works/serving-retrievals.md @@ -35,3 +35,6 @@ When attempting this retrieval deal using Graphsync, payment channels are used t Once the client has received the last chunk of data, the connection is closed. + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/how-retrieval-works/serving-retrievals) diff --git a/basics/how-storage-works/README.md b/basics/how-storage-works/README.md index fad8709d3..90a4b8870 100644 --- a/basics/how-storage-works/README.md +++ b/basics/how-storage-works/README.md @@ -6,3 +6,4 @@ description: >- # How storage works +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/how-storage-works) diff --git a/basics/how-storage-works/filecoin-and-ipfs.md b/basics/how-storage-works/filecoin-and-ipfs.md index ed4355ee8..3c3ba0fe6 100644 --- a/basics/how-storage-works/filecoin-and-ipfs.md +++ b/basics/how-storage-works/filecoin-and-ipfs.md @@ -73,3 +73,6 @@ The code that runs both clients and storage providers is open-source. Storage pr Filecoin has an active community of contributors to answer questions and help newcomers get started. There is an open dialog between users, developers, and storage providers. If you need help, you can reach the person who designed or built the system in question. Reach out on [Filecoin’s chat and forums](https://docs.filecoin.io/basics/project-and-community/chat-and-discussion-forums/). + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/how-storage-works/filecoin-and-ipfs) diff --git a/basics/how-storage-works/filecoin-plus.md b/basics/how-storage-works/filecoin-plus.md index d2284ab0e..ece1a7ed5 100644 --- a/basics/how-storage-works/filecoin-plus.md +++ b/basics/how-storage-works/filecoin-plus.md @@ -33,7 +33,7 @@ Consider first a network with ten storage providers. Initially, each storage pro ![filecoinplus1](https://github.com/filecoin-project/filecoin-docs/assets/46801006/d577d1d7-5e4f-4b3d-9b60-f102b5ca27bb) -In the above visualization, "VD" means "verfied deals", that is, deals that have been reviewed by allocators and have associated spending of datacap. +In the above visualization, "VD" means "verified deals", that is, deals that have been reviewed by allocators and have associated spending of datacap. If two of these storage providers begin filling their sectors with verified deals, their chances of winning a block reward increases by a factor of ten relative to their peers. Each one of these storage providers with verified deals in their sectors has a 36% chance of winning the block reward, while storage providers with only [regular deals](https://spec.filecoin.io/systems/filecoin\_blockchain/storage\_power\_consensus/#section-systems.filecoin\_mining.sector.sector\_quality) in their sectors have a 4% probability of winning the block rewards. @@ -141,3 +141,6 @@ There are three resources you can use to check the current status of the Filecoi * The [Datacap Stats dashboard](https://datacapstats.io) shows DataCap allocations, including the number of allocators, clients, and storage providers. You can also see number and size of deals. * The [Starboard Dashboard](https://dashboard.starboard.ventures/market-deals) includes network health data related to Filecoin+ verified deals. + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/how-storage-works/filecoin-plus) diff --git a/basics/how-storage-works/storage-onramps.md b/basics/how-storage-works/storage-onramps.md index 39462826f..3fa589464 100644 --- a/basics/how-storage-works/storage-onramps.md +++ b/basics/how-storage-works/storage-onramps.md @@ -19,3 +19,7 @@ Storage helpers are available for NFTs (non-fungible tokens) or general data. If * [Chainsafe Storage API](https://docs.storage.chainsafe.io) is an underlayer to Chainsafe’s encrypted IPFS & Filecoin file storage system. It offers S3-compatible bucket-style APIs for easy migration of data. As of September 2022, it’s the only storage helper with built-in encryption. * [Web3.Storage](https://web3.storage/docs) is a fast and open developer platform for [storing and interacting with data](https://blog.web3.storage/). Upload any data and Web3.Storage will ensure it ends up on a decentralized set of IPFS and Filecoin storage providers. There are JavaScript and Go libraries for the API, as well as a no-code web uploader. Free and paid plans are available. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/how-storage-works/storage-onramps) diff --git a/basics/interplanetary-consensus.md b/basics/interplanetary-consensus.md index 094af82da..922311ca5 100644 --- a/basics/interplanetary-consensus.md +++ b/basics/interplanetary-consensus.md @@ -60,3 +60,7 @@ With better performance, lower fees and faster transactions, IPC can rapidly imp * Read the [docs](https://docs.ipc.space/) * Check out the [repository](https://github.com/consensus-shipyard/ipc) * Connect with the community on [Discord](https://discord.gg/QtNbXf75) + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/interplanetary-consensus) diff --git a/basics/project-and-community/README.md b/basics/project-and-community/README.md index 4c9f10c69..1bf549d86 100644 --- a/basics/project-and-community/README.md +++ b/basics/project-and-community/README.md @@ -6,3 +6,4 @@ description: >- # Project and community +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/project-and-community) diff --git a/basics/project-and-community/chat-and-discussion-forums.md b/basics/project-and-community/chat-and-discussion-forums.md index a96f38961..70a53d375 100644 --- a/basics/project-and-community/chat-and-discussion-forums.md +++ b/basics/project-and-community/chat-and-discussion-forums.md @@ -18,3 +18,6 @@ For shorter-lived discussions, our community chat open to all on both Slack and For long-lived discussions and for support, please use the [discussion tab on GitHub](https://github.com/filecoin-project/community#forums) instead of Slack or Matrix. It’s easy for complex discussions to get lost in a sea of new messages on those chat platforms, and posting longer discussions and support requests on the forums helps future visitors, too. + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/project-and-community/chat-and-discussion-forums) diff --git a/basics/project-and-community/filecoin-compared-to.md b/basics/project-and-community/filecoin-compared-to.md index cde6a5461..7f5aac9cf 100644 --- a/basics/project-and-community/filecoin-compared-to.md +++ b/basics/project-and-community/filecoin-compared-to.md @@ -42,3 +42,4 @@ Filecoin combines many elements of other file storage and distribution systems. +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/project-and-community/filecoin-compared-to) diff --git a/basics/project-and-community/filecoin-faqs.md b/basics/project-and-community/filecoin-faqs.md index f7d89e086..ec6af7657 100644 --- a/basics/project-and-community/filecoin-faqs.md +++ b/basics/project-and-community/filecoin-faqs.md @@ -155,3 +155,6 @@ Also, note that world location matters for mining: many clients will prefer stor If you are retrieving your data from IPFS or a remote pinning layer, retrieval should take on the order of milliseconds to seconds in the worst case. Our latest tests for retrieval from the Filecoin network directly show that a sealed sector holding data takes \~1 hour to unseal. 1-5 hours is our best real-world estimate to go from sector unsealing to delivery of the data. If you need faster data retrieval for your application, we recommend building on IFPS. + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/project-and-community/filecoin-faqs) diff --git a/basics/project-and-community/related-projects.md b/basics/project-and-community/related-projects.md index f48b0e50a..0e2dee0f0 100644 --- a/basics/project-and-community/related-projects.md +++ b/basics/project-and-community/related-projects.md @@ -27,3 +27,6 @@ The Multiformats Project is a collection of protocols which aim to future-proof Interactive tutorials on decentralized web protocols, designed to introduce you to decentralized web concepts, protocols, and tools. Complete code challenges right in your web browser and track your progress as you go. Explore ProtoSchool’s tutorials on Filecoin at [proto.school/](https://proto.school/#/tutorials?course=filecoin). + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/project-and-community/related-projects) diff --git a/basics/project-and-community/social-media.md b/basics/project-and-community/social-media.md index 7f788ee71..d9d8686a8 100644 --- a/basics/project-and-community/social-media.md +++ b/basics/project-and-community/social-media.md @@ -33,3 +33,6 @@ Follow FilecoinOfficial on [WeChat](https://www.wechat.com/mobile) for project u + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/project-and-community/social-media) diff --git a/basics/project-and-community/the-filecoin-project.md b/basics/project-and-community/the-filecoin-project.md index a76282187..d57434d07 100644 --- a/basics/project-and-community/the-filecoin-project.md +++ b/basics/project-and-community/the-filecoin-project.md @@ -18,3 +18,6 @@ Learn about the ongoing cryptography research and design efforts that underpin t The Filecoin community believes that our mission is best served in an environment that is friendly, safe, and accepting, and free from intimidation or harassment. To that end, we ask that everyone involved in Filecoin read and respect our [code of conduct](https://github.com/filecoin-project/community/blob/master/CODE\_OF\_CONDUCT.md). + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/project-and-community/the-filecoin-project) diff --git a/basics/project-and-community/ways-to-contribute.md b/basics/project-and-community/ways-to-contribute.md index df56f2cf1..2cf91588e 100644 --- a/basics/project-and-community/ways-to-contribute.md +++ b/basics/project-and-community/ways-to-contribute.md @@ -393,3 +393,6 @@ All images contain alt text so that screen-reading programs can describe the ima ![Screenshot of an image being uploaded through the Filecoin command line.](filecoin-image-upload-screen.png) ``` + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/project-and-community/ways-to-contribute) diff --git a/basics/the-blockchain/README.md b/basics/the-blockchain/README.md index fe8272fd4..412bd1633 100644 --- a/basics/the-blockchain/README.md +++ b/basics/the-blockchain/README.md @@ -4,3 +4,4 @@ description: This section covers the basic concepts surrounding the Filecoin blo # The blockchain +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/the-blockchain) diff --git a/basics/the-blockchain/actors.md b/basics/the-blockchain/actors.md index e4e8ead2b..760e1f889 100644 --- a/basics/the-blockchain/actors.md +++ b/basics/the-blockchain/actors.md @@ -128,3 +128,6 @@ A _smart contract_ is a small, self-executing block of custom code that runs on With the FVM, actors can be written in Solidity. In future updates, any language that compiles to WASM will be supported. With user actors, users can create and enforce custom rules for storing and accessing data on the network. The FVM is responsible for actors and ensuring that they are executed correctly and securely. + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/the-blockchain/actors) diff --git a/basics/the-blockchain/addresses.md b/basics/the-blockchain/addresses.md index b5d9609ab..d21a34151 100644 --- a/basics/the-blockchain/addresses.md +++ b/basics/the-blockchain/addresses.md @@ -69,3 +69,7 @@ An `f4` address is structured as `f4f`, Currently, per [FIP 0048](https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0048.md), `f4` addresses may only be assigned by and in association with specific, built-in actors called _address managers_. Once users are able to deploy custom WebAssembly actors, this restriction will likely be relaxed in a future FIP. As an example, suppose an address manager has an actor ID (an `f0` address) `123`, and that address manager creates a new actor. Then, the `f4` address of the actor created by the address manager is `f4123fa3491xyz`, where `f4` is the address class, `123` is the actor ID of the address manager, `f` is a separator, and `a3491xyz` is the arbitrary `` chosen by that actor. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/the-blockchain/addresses) diff --git a/basics/the-blockchain/blocks-and-tipsets.md b/basics/the-blockchain/blocks-and-tipsets.md index ce72ce2fa..5e114e5e3 100644 --- a/basics/the-blockchain/blocks-and-tipsets.md +++ b/basics/the-blockchain/blocks-and-tipsets.md @@ -62,3 +62,7 @@ With the Ethereum JSON-RPC, we introduced the concept of the _tipset CID_ for th * _block hash_, think _tipset hash_. * _block height_, think _tipset epoch_. * _block messages_, think _messages in all blocks in a tipset, in their order of appearance, deduplicated and returned in canonical order of execution_. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/the-blockchain/blocks-and-tipsets) diff --git a/basics/the-blockchain/consensus.md b/basics/the-blockchain/consensus.md index c527831e4..d189d08cb 100644 --- a/basics/the-blockchain/consensus.md +++ b/basics/the-blockchain/consensus.md @@ -36,3 +36,7 @@ In summary, EC involves the following steps at each _epoch_: 5. The tipset that reflects the biggest amount of committed storage on the network is selected. 6. Using the selected tipset, the chain state is propagated. 7. EC returns to step 1 in the next epoch. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/the-blockchain/consensus) diff --git a/basics/the-blockchain/drand.md b/basics/the-blockchain/drand.md index 7bf1dc279..4183701b8 100644 --- a/basics/the-blockchain/drand.md +++ b/basics/the-blockchain/drand.md @@ -63,3 +63,7 @@ During the catch-up period, Filecoin nodes will backdate their blocks in order t Based on the level of decentralization of the Filecoin network, we expect to see varying levels of miner collaboration during this period. This is because there are two incentives at play: trying to mine valid blocks during the outage to collect block rewards and not falling behind a heavier chain being mined by a majority of miners who may or may not have ignored a portion of these blocks. In any event, a heavier chain will emerge after the catch-up period and mining can resume as normal. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/the-blockchain/drand) diff --git a/basics/the-blockchain/proofs.md b/basics/the-blockchain/proofs.md index f8d53c056..071d2963c 100644 --- a/basics/the-blockchain/proofs.md +++ b/basics/the-blockchain/proofs.md @@ -78,3 +78,7 @@ If an SP misses the submission deadline, no penalty is incurred, but the SP miss _WindowPoSt_ is used to prove that, for any and all SPs in the network, a copy of the data that was agreed to be stored is being continuously maintained over time and is used to audit SPs continuously. In WindowPoSt, all SPs must demonstrate the availability of all sectors claimed every [proving period](https://docs.filecoin.io/basics/the-blockchain/proofs/). Sector availability is not proved individually; rather, SPs must prove a whole [partition](https://docs.filecoin.io/basics/the-blockchain/proofs/) at once, and that sector must be proved by the deadline assigned (a 30-minute interval in the proving period). The more sectors an SP has pledged to store, the more the partitions of sectors that the SP will need to prove per deadline. As this requires that the SP has access to sealed copies of each of the requested sectors, it makes it irrational for the SP to seal data every time they need to provide a WindowPoSt proof, thus ensuring that SPs on the network are continuously maintaining the data agreed to. Additionally, failure to submit WindowPoSt for a sector will result in the SPs’ pledge collateral being forfeited and their storage power being reduced. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/the-blockchain/proofs) diff --git a/basics/what-is-filecoin/README.md b/basics/what-is-filecoin/README.md index a2454ec07..6a334df7f 100644 --- a/basics/what-is-filecoin/README.md +++ b/basics/what-is-filecoin/README.md @@ -15,4 +15,4 @@ For example, [NFT.Storage](https://nft.storage/) uses Filecoin to offer decentra Beyond these, Filecoin supports a wide range of data formats, including audio and video files. This functionality allows Web3 platforms like [Audius](https://audius.co/) and [Huddle01](https://huddle01.com/) to use Filecoin as a decentralized storage backend for music streaming and video conferencing. - [Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page%20URL=https%3A%2F%2Fapp.gitbook.com%2Fo%2FNNmD4UvLc26b1TmEYgzE%2Fs%2FxNWFG7bQkjLkl5BBGjbD%2F) +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/what-is-filecoin) diff --git a/basics/what-is-filecoin/blockchain.md b/basics/what-is-filecoin/blockchain.md index faba1975b..596016e91 100644 --- a/basics/what-is-filecoin/blockchain.md +++ b/basics/what-is-filecoin/blockchain.md @@ -113,3 +113,7 @@ If storage providers fail to provide reliable uptime or act maliciously against * Storage fault slashing to penalize storage providers for not being able to maintain healthy and reliable storage sectors for the network. * Consensus fault slashing to penalize storage providers to sabotage the liveness and security of the consensus process. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/what-is-filecoin/blockchain) diff --git a/basics/what-is-filecoin/crypto-economics.md b/basics/what-is-filecoin/crypto-economics.md index 75ee5f4b7..620c6a1d0 100644 --- a/basics/what-is-filecoin/crypto-economics.md +++ b/basics/what-is-filecoin/crypto-economics.md @@ -37,3 +37,6 @@ To encourage good behavior from network participants, during block reward mining FIL has a maximum circulating supply of 2,000,000,000 FIL, meaning that at most 2B Filecoin will ever be created. In practice, this max supply would never be reached since a considerable amount of FIL are burnt as gas fees, penalties etc., and are permanently removed from circulating supply. + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/what-is-filecoin/crypto-economics) diff --git a/basics/what-is-filecoin/networks.md b/basics/what-is-filecoin/networks.md index bd5c9176e..22ec5a2cf 100644 --- a/basics/what-is-filecoin/networks.md +++ b/basics/what-is-filecoin/networks.md @@ -23,3 +23,6 @@ Test networks, or testnets, are version of the Filecoin network that attempt to * [Calibration Faucet - Chainsafe](https://faucet.calibnet.chainsafe-fil.io) * [Calibration Faucet - Zondax](https://beryx.zondax.ch/faucet/) + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/what-is-filecoin/networks) diff --git a/basics/what-is-filecoin/programming-on-filecoin.md b/basics/what-is-filecoin/programming-on-filecoin.md index 1585ff5bd..6eb7bc53b 100644 --- a/basics/what-is-filecoin/programming-on-filecoin.md +++ b/basics/what-is-filecoin/programming-on-filecoin.md @@ -85,3 +85,6 @@ To allow Solidity smart contracts on FEVM to seamlessly call methods on Filecoin If you build on FEVM, you might find some of the [example contracts here](https://github.com/lotus-web3/client-contract) helpful. + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/what-is-filecoin/programming-on-filecoin) diff --git a/basics/what-is-filecoin/retrieval-market.md b/basics/what-is-filecoin/retrieval-market.md index c93414fd2..75625994a 100644 --- a/basics/what-is-filecoin/retrieval-market.md +++ b/basics/what-is-filecoin/retrieval-market.md @@ -21,3 +21,6 @@ Clients need to provide enough information to the storage provider for the data [Saturn](https://saturn.tech/) is a Web3 CDN in Filecoin’s retrieval market which serves the data stored on Filecoin with low latency and at low cost. It consists of independent retrieval providers specifically dedicated to that business, making retrieval an efficient, fast, and reliable operation. + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/what-is-filecoin/retrieval-market) diff --git a/basics/what-is-filecoin/storage-market.md b/basics/what-is-filecoin/storage-market.md index 807cf56ae..1355fd518 100644 --- a/basics/what-is-filecoin/storage-market.md +++ b/basics/what-is-filecoin/storage-market.md @@ -39,3 +39,7 @@ Here are some available storage helpers: * [Storacha](https://storacha.network/) - a decentralized hot storage network for data at scale, offering user-owned data with decentralized permissioning, leveraging Filecoin. * [Curio](https://curiostorage.org/) - a next-gen platform in the Filecoin ecosystem, streamlining storage provider operations. * [boost.filecoin.io](https://boost.filecoin.io/) - a tool for Storage Providers to manage data onboarding and retrieval on the Filecoin network. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/what-is-filecoin/storage-market) diff --git a/basics/what-is-filecoin/storage-model.md b/basics/what-is-filecoin/storage-model.md index e9223afda..d4584f715 100644 --- a/basics/what-is-filecoin/storage-model.md +++ b/basics/what-is-filecoin/storage-model.md @@ -37,3 +37,6 @@ The deal-making process happens _off-chain_. Once both parties agree to the term Sectors are the basic units of provable storage where storage providers store clients’ data and generate PoSt on behalf of the Filecoin network. Sectors have standard sizes and a lifetime that storage providers can extend before reaching the end of the lifetime. `32 GiB` and `64 GiB` sector sizes are supported. + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/what-is-filecoin/storage-model) diff --git a/networks/mainnet/rpcs.md b/networks/mainnet/rpcs.md index b730fde01..758ad5ee7 100644 --- a/networks/mainnet/rpcs.md +++ b/networks/mainnet/rpcs.md @@ -10,6 +10,8 @@ These endpoints are limited to the read-only [Filecoin JSON RPC API](../../refer {% hint style="info" %} Please note that most publicly hosted endpoints only guarantee recent state, i.e. 2000 of the latest blocks (last 16.67 hours). To request an archival node you can contact a provider below. {% endhint %} +In order to check the current benchmarked performance of each of the below endpoints, please see the [Filecoin ETH RPC Benchmark app](https://benchmark-rpc.vercel.app/). + Provider | HTTPS endpoint | WSS endpoint | Docs | API Support -- | -- | -- | -- | -- [Glif Nodes](https://api.node.glif.io/) | `https://api.node.glif.io/rpc/v1` | `wss://wss.node.glif.io/apigw/lotus/rpc/v1` | [Glif Nodes - Docs](https://api.node.glif.io/) | All Filecoin and Eth JSON RPC methods including MPoolPush diff --git a/smart-contracts/advanced/contract-automation.md b/smart-contracts/advanced/contract-automation.md new file mode 100644 index 000000000..d068253df --- /dev/null +++ b/smart-contracts/advanced/contract-automation.md @@ -0,0 +1,131 @@ +--- +description: >- + Smart contract automation enables decentralized applications (dapps) to interact with both on-chain and off-chain data in an automated and trustless manner. Automation tools allow developers to build smart contracts that execute predefined actions based on external triggers, eliminating the need for manual intervention while ensuring secure and reliable execution. +--- + +# Contract Automation + +In the Filecoin network, smart contracts benefit from a secure, deterministic environment. While this ensures reliability, it also limits direct access to external data sources. However, developers can leverage automation services to seamlessly connect off-chain data with on-chain smart contracts. This unlocks advanced capabilities such as price feeds, data verification, and much more, empowering Filecoin dapps with dynamic, real-world functionality by integrating external data into on-chain logic. + +## Available automation services + +### [Gelato](https://gelato.network/) + +Gelato's Web3 Functions is a powerful automation system designed to streamline and enhance Web3 operations. Web3 Functions serve as a comprehensive tool, enabling developers to effortlessly set up, manage, and automate their smart contract tasks. + +#### **How Gelato Web3 functions work?** + +Web3 Functions can be triggered by various events and allow developers to write both off-chain logic (TypeScript) and on-chain logic (Solidity). Once deployed, they handle automated smart contract interactions, providing real-time monitoring and flexibility. + +**Off-chain Data or Computation?** +Sometimes, automation tasks require data that isn't readily available on the blockchain, or they might need computations that are better performed off-chain. In such cases, Typescript Functions should be the choice. + +**All Checks On-chain?** +If all the conditions necessary for your automation task can be directly verified on the blockchain, you have the option to select between Typescript Functions, Solidity Functions & Automated Transactions + +## Triggers + +1. Time Interval + Use this trigger to execute tasks at regular intervals, e.g., every 10 minutes or once every 24 hours. It's like setting a straightforward, recurring alarm. +2. Cron Expressions + This offers a more refined control compared to the Time Interval. With cron expressions, you can set tasks to run at specific moments, such as "every Tuesday at 3 PM" or "on the 1st of every month". It gives you precision in task scheduling. +3. On-Chain Event + Ideal for those wanting their tasks to respond dynamically to blockchain activities. Whenever a specified event occurs on the blockchain, this trigger springs your task into action. It's like a vigilant watcher, always ready to act. +4. Every Block + This function operates with the rhythm of the blockchain itself, executing your chosen function each time a new block is created. + +## What to Execute? + + + +### Typescript Functions + +Typescript Functions are decentralized cloud functions that work similarly to AWS Lambda or Google Cloud, just for web3. They enable developers to execute on-chain transactions based on arbitrary off-chain data (APIs / subgraphs, etc) & computation. These functions are written in Typescript, stored on IPFS and run by Gelato. + +### Solidity Functions + +Solidity Functions are crucial for making on-chain tasks automatic and more efficient. They connect set conditions with specific actions in a smart contract, providing a straightforward method to turn user needs into automated processes. +Consider them as a set of "if-then" rules: If certain conditions are met on the blockchain, then a specific function gets executed. This level of automation ensures that the decentralized application can operate with minimal manual intervention, providing a seamless user experience. + +### Automated Transaction + +Automated Transaction ensures that a specific function on the target smart contract gets reliably triggered. When you pre-define the inputs, it means that every time Gelato initiates the function call, it uses consistent, predetermined arguments. + +#### **What is dedicatedMsgSender?** + +For security reasons, during task creation, you will see an address that acts as the msg.sender for your task executions. This address is a proxy contract deployed by Gelato. It ensures that every task execution on behalf of your contract uses this dedicated msg.sender address, which is essential for validating the origin of the task. + +## Quick Start + +### Writing & Deploying Typescript Functions + +1. Clone the hardhat-template repo + +```shell +git clone web3-functions-hardhat-template +``` + +2. CD into the folder and install + +```shell +cd web3-functions-hardhat-template && yarn install +``` + +3. Update the `index.ts` in one of the examples + +```typescript +Web3Function.onRun(async (context: Web3FunctionContext) => { + const { userArgs, multiChainProvider } = context; + + const provider = multiChainProvider.default(); + // Retrieve Last oracle update time + const oracleAddress = + (userArgs.oracle as string) ?? "0x71B9B0F6C999CBbB0FeF9c92B80D54e4973214da"; + + // YOUR CUSTOM LOGIC + ..... + + // Return if nothing has to be pushed on-chain + return { canExec: false, message: `Coingecko call failed` }; + + // Return if tx has to be pushed on-chain + return { + canExec: true, + callData: [ + { + to: oracleAddress, + data: oracle.interface.encodeFunctionData("updatePrice", [price]), + }, + ], + }; +}); +``` + +4. Deploy the Web3 Function to IPFS and create the Task + +```shell +npx w3f deploy web3-functions/YOUR-FUNCTION/index.ts +``` + +Result: + +```shell +$ npx w3f deploy web3-functions/YOUR-FUNCTION/index.ts + ✓ Web3Function deployed to ipfs. + ✓ CID: QmYMysfAhYYYrdhVytSTiE9phuoT49kMByktXSbVp1aRPx + +To create a task that runs your Web3 Function every minute, visit: +> https://beta.app.gelato.network/new-task?cid=QmYMysfAhYYYrdhVytSTiE9phuoT49kMByktXSbVp1aRPx +✨ Done in 3.56s. +``` + +Finally, go to the [Gelato App](https://app.gelato.network), create a new task, decide on the trigger, and input the CID. + +For a detailed guide on creating and deploying Web3 Functions, including setting up your development environment, triggers, and security configurations, refer to the full developer guide [here](https://docs.gelato.network/web3-services/web3-functions/quick-start/writing-typescript-functions). + +#### **Further Resources** + +- [Gelato Web3 Functions Docs](https://docs.gelato.network/web3-services/web3-functions) +- [What is 1Balance?](https://docs.gelato.network/web3-services/1balance) +- [Github Repository](https://github.com/gelatodigital/how-tos-3-w3f-triggers) +- [YouTube - How to write Event driven Web3 Functions](https://www.youtube.com/watch?v=7UpqGsANsBQ&ab_channel=JavierDonoso) diff --git a/smart-contracts/advanced/multicall.md b/smart-contracts/advanced/multicall.md index fe51ea1bb..6d02cea3e 100644 --- a/smart-contracts/advanced/multicall.md +++ b/smart-contracts/advanced/multicall.md @@ -123,3 +123,8 @@ In FVM, there are two types of accounts: Externally Owned Accounts (EOAs) contro For EOAs, which can only use CALL, Multicall3's address becomes the `msg.sender` for subsequent calls. This limits its usefulness from EOAs to scenarios where **`msg.sender` is irrelevant**. However, contract wallets or other contracts can use either CALL or DELEGATECALL, with the latter preserving the original `msg.sender`. The handling of `msg.value` in multicalls requires caution. Since `msg.value` doesn't change with delegatecalls, relying on it within a multicall can lead to security vulnerabilities. To learn more about this, see [here](https://github.com/runtimeverification/verified-smart-contracts/wiki/List-of-Security-Vulnerabilities#payable-multicall) and [here](https://samczsun.com/two-rights-might-make-a-wrong/). + +# Hints + +Lotus FEVM RPC supports Ethereum batch transactions. The key difference between `multicall` and batch transactions is that `multicall` aggregates multiple RPC requests into a single call, while batch transactions are simply an array of transactions executed sequentially but sent in one request. For more details, please refer to the [Ethereum documentation](https://geth.ethereum.org/docs/interacting-with-geth/rpc/batch). + diff --git a/smart-contracts/advanced/relay.md b/smart-contracts/advanced/relay.md new file mode 100644 index 000000000..266361f21 --- /dev/null +++ b/smart-contracts/advanced/relay.md @@ -0,0 +1,118 @@ +--- +description: >- + Relay is a service that allows users to interact with the Filecoin network using meta transactions. Users can submit transactions to the network without having to pay gas fees. Instead, a relayer pays the gas fees on behalf of the user. This enables users to interact with the network without having to hold FIL tokens or manage their own wallets. +--- + +# Relay + +## Meta Transactions + +Meta transactions are a type of transaction that allows users to interact with the Filecoin network without having to pay for gas fees. Instead, a third party, known as a relayer, pays the gas fees on behalf of the user. This enables users to interact with the network without having to hold FIL tokens or manage their own wallets. + +## Available relayers + +There are several relayers available that support meta transactions on the Filecoin network. Builders can integrate these relayers into their applications today. + +### [Gelato](https://gelato.network/) + +Relay services, like Gelato Relay, act as intermediaries that handle the submission of meta-transactions to the blockchain. By integrating relay contracts (such as GelatoRelayContext or ERC2771Context) into a smart contract, developers can enable gasless transactions. This allows users to interact with decentralized applications without holding native tokens, while maintaining security through features like EIP-712 signature validation. + +The relayer ensures the transaction is executed securely and promptly, handling the gas fee payment either off-chain (via a sponsor) or on-chain (with the user’s funds). This system simplifies blockchain interactions, broadening accessibility and reducing friction for dapp users. + +### Use cases + +- Highlight.xyz: Allows users to mint NFTs without incurring gas fees. +- ZED RUN: Automates breeding processes for digital racehorses. +- Reya: Enable gasless trading on the platform + +#### Off-chain and on-chain payments + +Transactions can be paid for in two primary ways: off-chain payments and on-chain payments. Each method offers flexibility depending on how developers wish to handle transaction fees for their users. + +##### Off-chain payments + +- **SponsoredCallERC2771**: In this method, Gelato uses the ERC-2771 meta-transaction standard to allow gasless transactions. The user signs a message, and the relay service covers the gas fees. ERC-2771Context ensures that the user’s identity is verified off-chain, by encoding the user’s address in the last 20 bytes of the transaction. This provides a secure, gasless experience where Gelato, using its 1Balance, sponsors the transaction fee. + +- **SponsoredCall**: When there is no need for ERC-2771's off-chain signature verification, this more flexible method can be used. The transaction fees are still covered by the sponsor using 1balance, but the responsibility for managing security measures such as signature validation and replay protection lies with the project. This option is ideal for use cases that already have built-in security mechanisms. + +##### On-chain payments + +- **callWithSyncFeeERC2771**: This method combines ERC-2771 meta-transaction functionality with Gelato’s SyncFee model. The user’s gas fee is calculated and paid directly from the smart contract during the transaction execution. Gelato’s Fee Oracle estimates the fee in real-time, and the GelatoRelayContext contract automatically handles the fee transfer. This is ideal for developers who want to maintain user signature verification while ensuring users cover their transaction costs. + +- **callWithSyncFee**: This method is similar to callWithSyncFeeERC2771 but without the need for ERC-2771’s off-chain signature verification. The user’s gas fee is calculated and paid directly from the target smart contract during the transaction execution. This approach is useful for applications where users are expected to pay for their own gas without requiring meta-transaction features. + +### Implementation + +We will require three simple steps to implement Gelato Relay. Here, we are going to showcase the three steps required to implement the method `sponsoredCallERC2771`, which is the most used one. + +#### Step 1: Inherit Context Contract + +Depending on the method, you must inherit different contracts as they will provide other methods. In this case, we will have to inherit the `ERC2771Context`. The `ERC2771Context` provide us with the methods `_msgSender()` and `_msgData()` that will allow us to recover the original user sending the transaction. + +```solidity +import { + ERC2771Context +} from "@gelatonetwork/relay-context/contracts/vendor/ERC2771Context.sol"; + +contract CounterERC2771 is ERC2771Context { + + // ERC2771Context: setting the immutable trustedForwarder variable + constructor(address trustedForwarder) ERC2771Context(trustedForwarder) {} + + function incrementContext() external { + + // Incrementing the counter mapped to the _msgSender! + contextCounter[_msgSender()]++; + + // Emitting an event for testing purposes + emit IncrementContextCounter(_msgSender()); + } +} +``` + +#### Step 2: Import the relay SDK + +In your frontend/backend, you would need to import and instantiate the relay class. + +``` +import { GelatoRelay, SponsoredCallERC2771Request } from "@gelatonetwork/relay-sdk"; +const relay = new GelatoRelay(API_KEY); +``` + +#### Step 3: Send the payload to Gelato + +This is an example using Gelato's CounterERC2771.sol, which is deployed on these networks. + +``` +// Set up on-chain variables, such as target address +const counter = "0x00172f67db60E5fA346e599cdE675f0ca213b47b"; +const abi = ["function incrementContext()"]; +const provider = new ethers.BrowserProvider(window.ethereum); +const signer = provider.getSigner(); +const user = signer.getAddress(); + +// Generate the target payload +const contract = new ethers.Contract(counter, abi, signer); +const { data } = await contract.incrementContext.populateTransaction(); + +// Populate a relay request +const request: CallWithERC2771Request = { + chainId: (await provider.getNetwork()).chainId, + target: counter; + data: data; + user: user; +}; + +// Without a specific API key, the relay request will fail! +// Go to https://relay.gelato.network to get a testnet API key with 1Balance. +// Send a relay request using Gelato Relay! +const relayResponse = await relay.sponsoredCallERC2771(request, provider, apiKey); +``` + +#### Further Gelato resources + +- [Gelato Relay Docs](https://docs.gelato.network/web3-services/relay) +- [What is 1Balance?](https://docs.gelato.network/web3-services/1balance) +- [YouTube - ERC2771](https://www.youtube.com/watch?v=P6LlzSzta1Q) +- [YouTube - non-ERC2771](https://youtu.be/shqLPDerunY) +- [GitHub Repository](https://github.com/gelatodigital/how-tos-5-6-7-8-relay-intro-methods) diff --git a/storage-providers/architecture/README.md b/storage-providers/architecture/README.md index a89b73351..8f15af2a4 100644 --- a/storage-providers/architecture/README.md +++ b/storage-providers/architecture/README.md @@ -6,3 +6,4 @@ description: >- # Architecture +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/architecture) diff --git a/storage-providers/architecture/lotus-automation.md b/storage-providers/architecture/lotus-automation.md index a2a1d9788..109dd1a43 100644 --- a/storage-providers/architecture/lotus-automation.md +++ b/storage-providers/architecture/lotus-automation.md @@ -34,3 +34,7 @@ One of the next features coming to this automation is a composable deployment me ## Prerequisites Read the `README` carefully on the [GitHub repo](https://github.com/filecoin-project/sp-automation) to make sure you have all the required prerequisites in place. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/architecture/lotus-automation) diff --git a/storage-providers/architecture/lotus-components.md b/storage-providers/architecture/lotus-components.md index e4be746f8..28062e241 100644 --- a/storage-providers/architecture/lotus-components.md +++ b/storage-providers/architecture/lotus-components.md @@ -33,7 +33,7 @@ The machine running the Lotus daemon must be connected to the public internet fo Syncing the chain is a key role of the daemon. It communicates with the other nodes on the network by sending messages, which are, in turn, collected into [blocks](https://docs.filecoin.io/reference/general/glossary/#block). These blocks are then collected into [tipsets](https://docs.filecoin.io/reference/general/glossary/#tipset). Your Lotus daemon receives the messages on-chain, enabling you to maintain consensus about the state of the Filecoin network with all the other participants. -Due to the growth in the size of the chain since its genesis, it is not advised for storage providers to sync the entire history of the network. Instead, providers should use the available [lightweight snapshots]( https://forest-archive.chainsafe.dev/list) to import the most recent messages. One exception in which a provider would need to sync the entire chain would be to run a blockchain explorer. +Due to the growth in the size of the chain since its genesis, it is not advised for storage providers to sync the entire history of the network. Instead, providers should use the available [lightweight snapshots](https://forest-archive.chainsafe.dev/list) to import the most recent messages. One exception in which a provider would need to sync the entire chain would be to run a blockchain explorer. Synced chain data should be stored on an SSD; however, faster NVMe drives are strongly recommended. A slow chain sync can lead to delays in critical messages being sent on-chain from your Lotus miner, resulting in the faulting of sectors and the slashing of collateral. @@ -171,3 +171,7 @@ To check if there are upcoming proving deadlines, run the following: ``` lotus-miner proving deadlines ``` + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/architecture/lotus-components) diff --git a/storage-providers/architecture/network-indexer.md b/storage-providers/architecture/network-indexer.md index 26b7730c5..ff02f786e 100644 --- a/storage-providers/architecture/network-indexer.md +++ b/storage-providers/architecture/network-indexer.md @@ -25,3 +25,7 @@ This diagram summarizes the different _actors_ in the indexer ecosystem and how Storage providers publish data to indexers so that clients can find that data using the CID or multihash of the content. When a client queries the indexer using a CID or multihash, the indexer then responds to the client with the provider data record, which tells the client where and how the content can be retrieved. As a storage provider, you will need to run an indexer in your setup so that your clients know where and how to retrieve data. For more information on how to create an index provider, see the [IPNI documentation](https://github.com/ipni/storetheindex/blob/main/doc/creating-an-index-provider.md). + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/architecture/network-indexer) diff --git a/storage-providers/architecture/sealing-as-a-service.md b/storage-providers/architecture/sealing-as-a-service.md index 5022c8d2f..1af4c2a42 100644 --- a/storage-providers/architecture/sealing-as-a-service.md +++ b/storage-providers/architecture/sealing-as-a-service.md @@ -29,3 +29,7 @@ Other solutions are possible where the sealing partner seals committed capacity See the following video from [Aligned](https://aligned.co/sealing-as-a-service) about their offering of Sealing-as-a-Service: {% embed url="https://www.youtube.com/watch?v=v4l1lGsUXvs" %} + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/architecture/sealing-as-a-service) diff --git a/storage-providers/architecture/sealing-pipeline.md b/storage-providers/architecture/sealing-pipeline.md index 7ff0c0779..1756a48d5 100644 --- a/storage-providers/architecture/sealing-pipeline.md +++ b/storage-providers/architecture/sealing-pipeline.md @@ -81,3 +81,7 @@ lotus-miner sectors batching commit --publish-now ``` Finally, the sealed sector is stored in the miner’s long-term storage space, along with unsealed sectors, which are required for retrievals if configured to do so. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/architecture/sealing-pipeline) diff --git a/storage-providers/architecture/sealing-rate.md b/storage-providers/architecture/sealing-rate.md index 3c0c22e1b..5ef6903b5 100644 --- a/storage-providers/architecture/sealing-rate.md +++ b/storage-providers/architecture/sealing-rate.md @@ -46,3 +46,7 @@ You can run multiple lotus-workers on the same GPU by splitting out their`tmp`fo ### Scaling out A storage provider’s sealing capacity scales linearly with the hardware you add to it. For example, if your current setup allows for a sealing rate of 3 TiB per day, doubling the number of workers could bring you to 6 TiB per day. This requires that all components of your infrastructure are able to handle this additional throughput. Using [Sealing-as-a-Service providers](sealing-as-a-service.md) allows you to scale your sealing capacity without adding more hardware. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/architecture/sealing-rate) diff --git a/storage-providers/basics/README.md b/storage-providers/basics/README.md index 6fdfd9b0d..a38226d71 100644 --- a/storage-providers/basics/README.md +++ b/storage-providers/basics/README.md @@ -51,3 +51,7 @@ Take availability and suitable redundancy into consideration when choosing your [Software architecture ->](../architecture/lotus-components.md) [Infrastructure ->](../skills/storage.md) + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/basics) diff --git a/storage-providers/basics/quickstart-guide.md b/storage-providers/basics/quickstart-guide.md index 4a8eceb14..7b07a31ca 100644 --- a/storage-providers/basics/quickstart-guide.md +++ b/storage-providers/basics/quickstart-guide.md @@ -8,7 +8,7 @@ description: >- ## Explore the storage provider documentation -Get ready to dive into the valuable resources of the [storage provider documentation](../../storage-providers/basics/README.md). This comprehensive guide offers a wealth of information about the role of storage providers in the Filecoin ecosystem, including insights into the economic aspects. You’ll also gain knowledge about the software architecture, hardware infrastructure, and the necessary skills for success. +Get ready to dive into the valuable resources of the [storage provider documentation](./). This comprehensive guide offers a wealth of information about the role of storage providers in the Filecoin ecosystem, including insights into the economic aspects. You’ll also gain knowledge about the software architecture, hardware infrastructure, and the necessary skills for success. ## Gain insights into ROI and collateral’s role @@ -37,3 +37,7 @@ As you step into the vibrant realm of the mainnet, it’s time to supercharge yo ## Discover the world of verified deals and tools Within the Filecoin network there are many [programs and tools](../filecoin-deals/filecoin-programs.md) designed to enhance your storage provider setup. Uncover the power of these tools as you dive into the documentation, gaining valuable insights and expanding your knowledge. Make the best use of data programs on your path to success. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/basics/quickstart-guide) diff --git a/storage-providers/filecoin-deals/README.md b/storage-providers/filecoin-deals/README.md index 58fd4c6e6..e191f6700 100644 --- a/storage-providers/filecoin-deals/README.md +++ b/storage-providers/filecoin-deals/README.md @@ -6,3 +6,4 @@ description: >- # Filecoin deals +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-deals) diff --git a/storage-providers/filecoin-deals/auxiliary-services.md b/storage-providers/filecoin-deals/auxiliary-services.md index 98d6938be..b4c86aec7 100644 --- a/storage-providers/filecoin-deals/auxiliary-services.md +++ b/storage-providers/filecoin-deals/auxiliary-services.md @@ -22,3 +22,7 @@ A next step after the introduction of FVM is [Bacalhau](https://docs.bacalhau.or ## Storage tiering Another potential service to offer is storage tiers with various performance profiles. For example, storage providers can offer hot/online storage by keeping an additional copy of the unsealed data available for immediate retrieval, as well as the sealed that has been stored on the Filecoin Network. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-deals/auxiliary-services) diff --git a/storage-providers/filecoin-deals/charging-for-data.md b/storage-providers/filecoin-deals/charging-for-data.md index 36864cfb9..12c69e6a1 100644 --- a/storage-providers/filecoin-deals/charging-for-data.md +++ b/storage-providers/filecoin-deals/charging-for-data.md @@ -17,3 +17,7 @@ In addition to sales costs, other factors contribute to your business’ total c By charging for data stored on your network, you can create a sustainable business model that allows you to invest in hardware and FIL as collateral, as well as grow your business over time. This requires skilled people capable of running a business at scale and interacting with investors, venture capitalists, and banks to secure the necessary funding for growth. Next to the sales cost, there are other things that contribute to the total cost of ownership of your storage provider business. Think of backups of your setup and the data, providing an access layer to ingest data and for retrievals, preparing the data (if not done already), and more. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-deals/charging-for-data) diff --git a/storage-providers/filecoin-deals/filecoin-programs.md b/storage-providers/filecoin-deals/filecoin-programs.md index 45bb1bbdb..9a6259c0b 100644 --- a/storage-providers/filecoin-deals/filecoin-programs.md +++ b/storage-providers/filecoin-deals/filecoin-programs.md @@ -10,34 +10,25 @@ Although it is possible to find your own data storage customers with valuable da ## [Web3.storage](https://web3.storage/) -[![GitHub Repo stars](https://img.shields.io/github/stars/web3-storage/web3.storage?style=for-the-badge)](https://github.com/web3-storage/web3.storage) -[![GitHub last commit](https://img.shields.io/github/last-commit/web3-storage/web3.storage?style=for-the-badge)](https://github.com/web3-storage/web3.storage/graphs/commit-activity) -[![Docs site](https://img.shields.io/badge/docs-web3.storage-blue?style=for-the-badge)](https://web3.storage/docs/) +[![GitHub Repo stars](https://img.shields.io/github/stars/web3-storage/web3.storage?style=for-the-badge)](https://github.com/web3-storage/web3.storage) [![GitHub last commit](https://img.shields.io/github/last-commit/web3-storage/web3.storage?style=for-the-badge)](https://github.com/web3-storage/web3.storage/graphs/commit-activity) [![Docs site](https://img.shields.io/badge/docs-web3.storage-blue?style=for-the-badge)](https://web3.storage/docs/) Web3.storage runs on “Elastic IPFS” as the inbound storage protocol offering scalability, performance and reliability as the platform grows. It guarantees the user (typically developers) that the platform will always serve your data when you need it. In the backend the data is uploaded onto the Filecoin Network for long-term storage. ## [Filecoin Green](https://green.filecoin.io) -[![Read the doc](https://img.shields.io/badge/docs-gitbook.io-blue?style=for-the-badge)](https://filecoin-green.gitbook.io/filecoin-green-documentation) -[![Join Slack](https://img.shields.io/badge/join-slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C02HZ215B7Y) +[![Read the doc](https://img.shields.io/badge/docs-gitbook.io-blue?style=for-the-badge)](https://filecoin-green.gitbook.io/filecoin-green-documentation) [![Join Slack](https://img.shields.io/badge/join-slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C02HZ215B7Y) Filecoin Green aims to measure the environmental impacts of Filecoin and verifiably drive them below zero, building infrastructure along the way that allows anyone to make transparent and substantive environmental claims. The team maintains the [Filecoin Energy Dashboard](https://filecoin.energy/) and works with storage providers to decarbonize their operations through the [Energy Validation Process](https://filecoin-green.gitbook.io/filecoin-green-documentation/storage-providers-green-guidance-documentation/storage-providers-tiered-sustainability-claims). Connect with the team on Slack at [#fil-green](https://filecoinproject.slack.com/archives/C02HZ215B7Y), or via email at [green@filecoin.org](mailto:green@filecoin.org). ## [Spade](https://github.com/data-preservation-programs/spade) -[![GitHub Repo stars](https://img.shields.io/github/stars/data-preservation-programs/spade?style=for-the-badge)](https://github.com/data-preservation-programs/spade) -[![GitHub last commit](https://img.shields.io/github/last-commit/data-preservation-programs/spade?style=for-the-badge)](https://github.com/data-preservation-programs/spade/graphs/commit-activity) -[![Read the doc](https://img.shields.io/badge/docs-README-blue?style=for-the-badge)](https://github.com/data-preservation-programs/spade/blob/master/README.md) -[![Join Slack](https://img.shields.io/badge/join-Slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C0377FJCG1L) +[![GitHub Repo stars](https://img.shields.io/github/stars/data-preservation-programs/spade?style=for-the-badge)](https://github.com/data-preservation-programs/spade) [![GitHub last commit](https://img.shields.io/github/last-commit/data-preservation-programs/spade?style=for-the-badge)](https://github.com/data-preservation-programs/spade/graphs/commit-activity) [![Read the doc](https://img.shields.io/badge/docs-README-blue?style=for-the-badge)](https://github.com/data-preservation-programs/spade/blob/master/README.md) [![Join Slack](https://img.shields.io/badge/join-Slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C0377FJCG1L) Spade automates the process of renewing storage deals on the Filecoin network, ensuring the longevity of data stored on the blockchain. This is particularly useful for datasets that need to be preserved for extended periods, far beyond the standard deal duration. By using Spade, organizations and individuals can manage and maintain their data storage deals more efficiently, guaranteeing that valuable data remains accessible and secure over time. ## [Singularity](https://github.com/data-preservation-programs/singularity) -[![Github Repo stars](https://img.shields.io/github/stars/data-preservation-programs/singularity?style=for-the-badge)](https://github.com/data-preservation-programs/singularity) -[![GitHub last commit](https://img.shields.io/github/last-commit/data-preservation-programs/singularity?style=for-the-badge)](https://github.com/data-preservation-programs/spade/graphs/commit-activity) -[![Read the doc](https://img.shields.io/badge/docs-gitbook.io-blue?style=for-the-badge)](https://data-programs.gitbook.io/singularity) -[![Join Slack](https://img.shields.io/badge/join-Slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C05JABREATH) +[![Github Repo stars](https://img.shields.io/github/stars/data-preservation-programs/singularity?style=for-the-badge)](https://github.com/data-preservation-programs/singularity) [![GitHub last commit](https://img.shields.io/github/last-commit/data-preservation-programs/singularity?style=for-the-badge)](https://github.com/data-preservation-programs/spade/graphs/commit-activity) [![Read the doc](https://img.shields.io/badge/docs-gitbook.io-blue?style=for-the-badge)](https://data-programs.gitbook.io/singularity) [![Join Slack](https://img.shields.io/badge/join-Slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C05JABREATH) Singularity is an end-to-end solution for onboarding datasets to Filecoin storage providers, supporting [PiB-scale data](https://stats.singularity.storage/). It offers modular compatibility with various data preparation and deal-making tools, allowing efficient processing from local or remote storage. Singularity integrates with over 40 storage solutions and introduces inline preparation, which links CAR files to their original data sources, preserving dataset hierarchies. It also supports content distribution and retrieval through multiple protocols and provides push and pull modes for deal making along with robust wallet management features. @@ -47,23 +38,19 @@ Many other programs and tools exist in the Filecoin community, developed by part ### [Decentrally](https://www.decentrally.cloud/) -[![Read the doc](https://img.shields.io/badge/docs-decentrally.cloud-blue?style=for-the-badge)](https://docs.decentrally.cloud) -[![Join Slack](https://img.shields.io/badge/join-Slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C07FN47FCFJ) +[![Read the doc](https://img.shields.io/badge/docs-decentrally.cloud-blue?style=for-the-badge)](https://docs.decentrally.cloud) [![Join Slack](https://img.shields.io/badge/join-Slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C07FN47FCFJ) Our Sync & Share platform a.k.a. DataDrop, empowered by Filecoin’s decentralized storage, transforms data management into an art. Creating paid deals for Storage Poviders and bringing more utility to the Filecoin ecosystem. It integrates with deal engines in the back-end such as [Boost](https://boost.filecoin.io). ### [CIDGravity](https://www.cidgravity.com/) -[![Read the doc](https://img.shields.io/badge/docs-cidgravity.com-blue?style=for-the-badge)](https://docs.cidgravity.com) -[![Join Slack](https://img.shields.io/badge/join-Slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C04SCAG37FH) +[![Read the doc](https://img.shields.io/badge/docs-cidgravity.com-blue?style=for-the-badge)](https://docs.cidgravity.com) [![Join Slack](https://img.shields.io/badge/join-Slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C04SCAG37FH) CIDGravity is a software-as-a-service that allows storage providers to handle dynamic pricing and client management towards your solution. It integrates with deal engines such as [Boost](https://boost.filecoin.io). ### [Swan (Filswan)](https://github.com/filswan) -[![GitHub Org's stars](https://img.shields.io/github/stars/filswan?style=for-the-badge)](https://github.com/filswan) -[![Read the doc](https://img.shields.io/badge/docs-filswan.com-blue?style=for-the-badge)](https://docs.filswan.com/) -[![Join Slack](https://img.shields.io/badge/join-Slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C04LBAMBDPD) +[![GitHub Org's stars](https://img.shields.io/github/stars/filswan?style=for-the-badge)](https://github.com/filswan) [![Read the doc](https://img.shields.io/badge/docs-filswan.com-blue?style=for-the-badge)](https://docs.filswan.com/) [![Join Slack](https://img.shields.io/badge/join-Slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C04LBAMBDPD) Swan is a provider of cross-chain cloud computing solutions. Developers can use its suite of tools to access resources across multiple chains. @@ -79,52 +66,49 @@ Here is a comprehensive list of deprecated tools and projects. ### Evergreen -![](https://img.shields.io/badge/maintenance-deprecated_04/2024-red.svg?style=for-the-badge) +![](https://img.shields.io/badge/maintenance-deprecated\_04/2024-red.svg?style=for-the-badge) -Evergreen extended the [Slingshot](#slingshot) program by aiming to store open datasets forever. Standard deals had a maximum duration of 540 days, which was not long enough for valuable, open datasets that might need to be stored forever. Evergreen used the [Spade](#spade) deal engine, which automatically renewed deals to extend the lifetime of the dataset on-chain. +Evergreen extended the [Slingshot](filecoin-programs.md#slingshot) program by aiming to store open datasets forever. Standard deals had a maximum duration of 540 days, which was not long enough for valuable, open datasets that might need to be stored forever. Evergreen used the [Spade](filecoin-programs.md#spade) deal engine, which automatically renewed deals to extend the lifetime of the dataset on-chain. ### CO2.Storage -![](https://img.shields.io/badge/maintenance-deprecated_04/2024-red.svg?style=for-the-badge) +![](https://img.shields.io/badge/maintenance-deprecated\_04/2024-red.svg?style=for-the-badge) CO2.Storage was a decentralized storage solution for structured data based on content-addressed data schemas. CO2.Storage primarily focused on structured data for environmental assets, such as Renewable Energy Credits, Carbon Offsets, and geospatial datasets, and mapped inputs to base data schemas (IPLD DAGs) for off-chain data (like metadata, images, attestation documents, and other assets) to promote the development of standard data schemas for environmental assets. This project was in alpha, and while many features could be considered stable, it was waiting until being feature complete to fully launch. The Filecoin Green team was actively working on this project and welcomed contributions from the community. ### Filecoin Tracker -![](https://img.shields.io/badge/maintenance-deprecated_04/2024-red.svg?style=for-the-badge) +![](https://img.shields.io/badge/maintenance-deprecated\_04/2024-red.svg?style=for-the-badge) Filecoin Tracker was deprecated on April 20, 2024. Here are great existing and working Filecoin dashboards that cover similar topics: -- [Starboard](https://dashboard.starboard.ventures/dashboard) -- [Filecoin Dune Daily Metrics](https://dune.com/kalen/filecoin-daily-metrics) -- [Filecoin Pulse (PoC)](https://filecoinpulse.pages.dev/) +* [Starboard](https://dashboard.starboard.ventures/dashboard) +* [Filecoin Dune Daily Metrics](https://dune.com/kalen/filecoin-daily-metrics) +* [Filecoin Pulse (PoC)](https://filecoinpulse.pages.dev/) ### Slingshot -[![GitHub Repo stars](https://img.shields.io/github/stars/filecoin-project/slingshot?style=for-the-badge)](https://github.com/filecoin-project/slingshot) -![GitHub last commit](https://img.shields.io/github/last-commit/filecoin-project/slingshot?style=for-the-badge) -![](https://img.shields.io/badge/maintenance-deprecated-red.svg?style=for-the-badge) -[![Join Slack](https://img.shields.io/badge/join-Slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C01AZP8BKRQ) +[![GitHub Repo stars](https://img.shields.io/github/stars/filecoin-project/slingshot?style=for-the-badge)](https://github.com/filecoin-project/slingshot) ![GitHub last commit](https://img.shields.io/github/last-commit/filecoin-project/slingshot?style=for-the-badge) ![](https://img.shields.io/badge/maintenance-deprecated-red.svg?style=for-the-badge) [![Join Slack](https://img.shields.io/badge/join-Slack-purple?style=for-the-badge)](https://filecoinproject.slack.com/archives/C01AZP8BKRQ) -Slingshot was a program that united Data clients, Data preparers and storage providers in a community to onboard data and share replicas of publicly valuable [_Open Datasets_](https://datasets.filecoin.io). Rather than providing a web interface like Estuary, Slingshot was a program that provides a workflow and tools for onboarding of large open datasets. The Slingshot Deal Engine provided deals to registered and certified storage providers. The data was prepared and uploaded using a tool called [Singularity](#singularity). +Slingshot was a program that united Data clients, Data preparers and storage providers in a community to onboard data and share replicas of publicly valuable [_Open Datasets_](https://datasets.filecoin.io). Rather than providing a web interface like Estuary, Slingshot was a program that provides a workflow and tools for onboarding of large open datasets. The Slingshot Deal Engine provided deals to registered and certified storage providers. The data was prepared and uploaded using a tool called [Singularity](filecoin-programs.md#singularity). ### Dataprograms.org -![](https://img.shields.io/badge/maintenance-deprecated_04%2F2024-red.svg?style=for-the-badge) +![](https://img.shields.io/badge/maintenance-deprecated\_04%2F2024-red.svg?style=for-the-badge) dataprograms.org listed tools, products, and incentive programs designed to drive growth and make data storage on Filecoin more accessible. It was discontinued in April 2024. ### Moonlanding -![](https://img.shields.io/badge/maintenance-deprecated_04%2F2024-red.svg?style=for-the-badge) +![](https://img.shields.io/badge/maintenance-deprecated\_04%2F2024-red.svg?style=for-the-badge) Moon Landing was designed to ramp up storage providers in the Filecoin network by enabling them to serve verified deals at scale. ### Filecoin Dataset Explorer -![](https://img.shields.io/badge/maintenance-deprecated_04%2F2024-red.svg?style=for-the-badge) +![](https://img.shields.io/badge/maintenance-deprecated\_04%2F2024-red.svg?style=for-the-badge) Filecoin Dataset Explorer showcased data stored on the Filecoin network between 2020 and 2022, including telemetry, historical archives, Creative Commons media, entertainment archives, scientific research, and machine learning datasets. It highlighted Filecoin's capability to store large datasets redundantly, ensuring availability from multiple Storage Providers worldwide. Each dataset is identified by a unique content identifier (CID). The platform aimed to make diverse datasets accessible to users globally. @@ -132,7 +116,7 @@ See also: Legacy Explorer (legacy.datasets.filecoin.io) ## Estuary -![](https://img.shields.io/badge/maintenance-deprecated_07%2F2023-red.svg?style=for-the-badge) +![](https://img.shields.io/badge/maintenance-deprecated\_07%2F2023-red.svg?style=for-the-badge) Estuary was an experimental software platform designed for sending public data to the Filecoin network, facilitating data retrieval from anywhere. It integrated IPFS and Filecoin technologies to provide a seamless end-to-end example for data storage and retrieval. When a file was uploaded, Estuary immediately made multiple storage deals with different providers to ensure redundancy and security. The software automated many aspects of deal making and retrieval, offering tools for managing connections, block storage, and deal tracking. Estuary aimed to simplify the use of decentralized storage networks for developers and users. @@ -140,8 +124,10 @@ Estuary was discontinued in July 2023, and the website shut down in April 2024. ### Big Data Exchange -![](https://img.shields.io/badge/maintenance-deprecated_04%2F2024-red.svg?style=for-the-badge) +![](https://img.shields.io/badge/maintenance-deprecated\_04%2F2024-red.svg?style=for-the-badge) Big Data Exchange was a program that allowed storage providers easy access to Filecoin+ deals through an auction where Storage Providers could bid on datasets by offering to pay clients FIL to choose the bidder as their Storage Provider. + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-deals/filecoin-programs) diff --git a/storage-providers/filecoin-deals/return-on-investment.md b/storage-providers/filecoin-deals/return-on-investment.md index c60bfaaa8..f0bd97667 100644 --- a/storage-providers/filecoin-deals/return-on-investment.md +++ b/storage-providers/filecoin-deals/return-on-investment.md @@ -49,3 +49,7 @@ It takes more variables than the cost vs. the income. In summary, the factors th * **Operational Costs:** Last but not least there’s the ongoing monthly cost of operating the storage provider business. Both the costs for technical operations as well as business operations need to be taken into consideration. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-deals/return-on-investment) diff --git a/storage-providers/filecoin-deals/snap-deals.md b/storage-providers/filecoin-deals/snap-deals.md index d21920131..4413dce22 100644 --- a/storage-providers/filecoin-deals/snap-deals.md +++ b/storage-providers/filecoin-deals/snap-deals.md @@ -19,3 +19,7 @@ There are two main reasons why a storage provider could be doing Snap Deals, als Snapping up sectors with snap deals puts a lot less stress on the storage provider’s infrastructure. The only task that is executed from the [sealing pipeline](../architecture/sealing-pipeline.md) is the replica-update and prove-replica-update phase, which is similar to the PC2 process. The CPU-intensive PreCommit 1 phase is not required in this process. Do not forget to provide the collateral funds when snapping up a verified deal. The same volume requires more collateral when it counts as Filecoin Plus data, namely 10x the collateral compared to raw storage power. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-deals/snap-deals) diff --git a/storage-providers/filecoin-deals/storage-deals.md b/storage-providers/filecoin-deals/storage-deals.md index bf45c2afa..3800955f8 100644 --- a/storage-providers/filecoin-deals/storage-deals.md +++ b/storage-providers/filecoin-deals/storage-deals.md @@ -30,3 +30,7 @@ In order for storage providers to accept deals and set their deal terms, they ne The storage provider can (and should) keep unsealed data copies available for retrieval requests from the client. It is the same software component, Boost, that is responsible for HTTP retrievals from the client and for setting the price for retrievals. Many tools and platforms act as a deal making engine in front of Boost. This is the case for [Spade](https://github.com/ribasushi/spade) for instance. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-deals/storage-deals) diff --git a/storage-providers/filecoin-deals/verified-deals.md b/storage-providers/filecoin-deals/verified-deals.md index f1f71f561..94deef36e 100644 --- a/storage-providers/filecoin-deals/verified-deals.md +++ b/storage-providers/filecoin-deals/verified-deals.md @@ -43,3 +43,7 @@ Tools and programs exist to support Filecoin Plus, but storage providers need to With great power, comes great responsibility, which also counts for storage power: rewards on Fil+ deals are 10x, but so are the penalties. Because a sector of 32 GiB counts for 320 GiB of storage power (10x), the rewards and the penalties are calculated on the QAP of 320 GiB. Filecoin Plus allows a storage provider to earn more block rewards on a verified deal, compared to a regular data deal. The 10x multiplier on storage power that comes with a verified deal, however, also requires 10x collateral from the storage provider. If the storage provider is then not capable of keeping the data and systems online and fails to submit the daily required proofs (WindowPoSt) for that data, the penalties (_slashing_) are also 10x higher than over regular data deals or CC sectors. Larger storage power means larger block rewards, larger collateral and larger slashing. The stakes are high - after all, we’re storing humanity’s most important information with Filecoin. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-deals/verified-deals) diff --git a/storage-providers/filecoin-economics/README.md b/storage-providers/filecoin-economics/README.md index 467d41380..e8b8e9acb 100644 --- a/storage-providers/filecoin-economics/README.md +++ b/storage-providers/filecoin-economics/README.md @@ -6,3 +6,4 @@ description: >- # Filecoin economics +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-economics) diff --git a/storage-providers/filecoin-economics/block-rewards.md b/storage-providers/filecoin-economics/block-rewards.md index de8523efa..a8ca9657c 100644 --- a/storage-providers/filecoin-economics/block-rewards.md +++ b/storage-providers/filecoin-economics/block-rewards.md @@ -35,3 +35,7 @@ The below graph shows the evolution of FIL per block reward over time: There is a positive side to releasing less FIL per block reward too. As Filecoin has a capped maximum token supply of 2 billion FIL, the slower minting rate allows for minting over a longer period. A lower circulating supply also has a positive effect on the price of FIL. See the [Crypto Economics](../../basics/what-is-filecoin/crypto-economics.md) page of this documentation and the [Filecoin spec](https://spec.filecoin.io/#section-systems.filecoin\_token.minting\_model) for more information. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-economics/block-rewards) diff --git a/storage-providers/filecoin-economics/committed-capacity.md b/storage-providers/filecoin-economics/committed-capacity.md index 0fcfae384..abae91d49 100644 --- a/storage-providers/filecoin-economics/committed-capacity.md +++ b/storage-providers/filecoin-economics/committed-capacity.md @@ -16,3 +16,7 @@ Because the Filecoin network needs consistency, meaning all data stored is still ## What’s next? Providing committed capacity is the easiest way to get started as a storage provider, but the economics are very dependent on the price of FIL. If the price of FIL is low, it can be unprofitable to provide only committed capacity. The optimal FIL-price your business needs to be profitable will depend on your setup. Profitability can be increased by utilizing [Filecoin Plus](../../basics/how-storage-works/filecoin-plus.md), along with [extra services you can charge for](../filecoin-deals/auxiliary-services.md). + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-economics/committed-capacity) diff --git a/storage-providers/filecoin-economics/fil-collateral.md b/storage-providers/filecoin-economics/fil-collateral.md index b2a6daa59..ed3958eb1 100644 --- a/storage-providers/filecoin-economics/fil-collateral.md +++ b/storage-providers/filecoin-economics/fil-collateral.md @@ -38,8 +38,12 @@ The “Current Sector Initial Pledge" can be found on blockchain explorers like Another cost factor in the network is gas. Storage providers not only pledge collateral for the capacity they announce on-chain. The network also burns FIL in the form of gas fees. Most activity on-chain has some level of gas involved. For storage providers, this is the case for committing sectors. -The gas fees fluctuate over time and can be followed on various websites like [Filfox - Gas Statistics](https://filfox.info/en/stats/gas) and [Beryx - Gas Estimator](https://beryx.io/estimate_gas). +The gas fees fluctuate over time and can be followed on various websites like [Filfox - Gas Statistics](https://filfox.info/en/stats/gas) and [Beryx - Gas Estimator](https://beryx.io/estimate\_gas). ## FIL lending programs The ecosystem does have [FIL Lenders](https://filecoin-lending.com/read-more) who can provide you FIL (with interest) to get you started, which you can pay back over time and with the help of earned block rewards. Every lender, though, will still require you to supply up to 20% of the required collateral. The [Filecoin Virtual Machine](../../smart-contracts/fundamentals/the-fvm.md), introduced in March 2023, enables the creation of new lending mechanisms via smart contracts. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-economics/fil-collateral) diff --git a/storage-providers/filecoin-economics/slashing.md b/storage-providers/filecoin-economics/slashing.md index fb03fa01e..52c6733bd 100644 --- a/storage-providers/filecoin-economics/slashing.md +++ b/storage-providers/filecoin-economics/slashing.md @@ -18,3 +18,7 @@ This term encompasses a broad set of penalties which are to be paid by storage p ## Consensus fault slashing This penalty is incurred when committing consensus faults. This penalty is applied to storage providers that have acted maliciously against the network’s consensus functionality. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-economics/slashing) diff --git a/storage-providers/filecoin-economics/storage-proving.md b/storage-providers/filecoin-economics/storage-proving.md index e3a62a59b..4cce7177b 100644 --- a/storage-providers/filecoin-economics/storage-proving.md +++ b/storage-providers/filecoin-economics/storage-proving.md @@ -9,3 +9,7 @@ As a storage provider, you must preserve the data for the duration of the [deal] ## WindowPoSt The cryptographic challenge for storage proving is called _Window Proof-of-Spacetime_ (WindowPoSt). Storage providers have a deadline of 30 minutes to respond to this WindowPoSt challenge via a message on the blockchain containing a [zk-SNARK](https://en.wikipedia.org/wiki/Zero-knowledge\_proof) proof of the verified sector. Failure to submit this proof within the 30 minute deadline, or failure to submit it at all, results in _slashing_. Slashing means a portion of the [collateral](fil-collateral.md) will be forfeited to the f099 burn address and the _storage power_ of the storage provider gets reduced. Slashing is a way to penalize storage providers who fail to meet the agreed upon standards of storage. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-economics/storage-proving) diff --git a/storage-providers/infrastructure/README.md b/storage-providers/infrastructure/README.md index 7f0056a71..34639702c 100644 --- a/storage-providers/infrastructure/README.md +++ b/storage-providers/infrastructure/README.md @@ -6,3 +6,4 @@ description: >- # Infrastructure +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/infrastructure) diff --git a/storage-providers/infrastructure/backup-and-disaster-recovery.md b/storage-providers/infrastructure/backup-and-disaster-recovery.md index d39457049..f0f04f5a4 100644 --- a/storage-providers/infrastructure/backup-and-disaster-recovery.md +++ b/storage-providers/infrastructure/backup-and-disaster-recovery.md @@ -64,3 +64,7 @@ One way to prepare for an easy failover of the software components in the event This helps to reduce the amount of manual tasks for a failover drastically. If the recovered daemon or miner instance changes IP address it requires quite a lot of reconfiguration in various places. Having the services on a floating IP allows to assign this IP to another machine and start the service on it. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/infrastructure/backup-and-disaster-recovery) diff --git a/storage-providers/infrastructure/network.md b/storage-providers/infrastructure/network.md index 9d005926d..610600a93 100644 --- a/storage-providers/infrastructure/network.md +++ b/storage-providers/infrastructure/network.md @@ -30,3 +30,7 @@ Depending on the size of the network, different network topologies may be used t Spine-leaf architectures provide predictable latency and linear scalability by having multiple L2 leaf switches that connect to the spine switches. On the other hand, smaller networks can be set up with redundant L3 switches or a collapsed spine/leaf design that connect to redundant routers/firewalls. It is important to determine the appropriate topology based on the specific needs of the organization. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/infrastructure/network) diff --git a/storage-providers/infrastructure/reference-architectures.md b/storage-providers/infrastructure/reference-architectures.md index 45fa62a07..84c3325c1 100644 --- a/storage-providers/infrastructure/reference-architectures.md +++ b/storage-providers/infrastructure/reference-architectures.md @@ -107,3 +107,7 @@ Please take a look at the presentation Benjamin Hoejsbo from [PIKNIK](https://ww {% hint style="info" %} We are working to improve this section. If you would like to share your mining setup, please create an issue in the [Filecoin documentation GitHub repository](https://github.com/filecoin-project/filecoin-docs/issues)! {% endhint %} + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/infrastructure/reference-architectures) diff --git a/storage-providers/infrastructure/storage.md b/storage-providers/infrastructure/storage.md index 14cbb5ed8..d4838c6aa 100644 --- a/storage-providers/infrastructure/storage.md +++ b/storage-providers/infrastructure/storage.md @@ -53,3 +53,7 @@ There are 2 types of read operations that are important in the context of Fileco * sequential read I/O: When retrievals happens, entire sectors are read from disk and streamed towards the customer via Boost. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/infrastructure/storage) diff --git a/storage-providers/skills/README.md b/storage-providers/skills/README.md index c914f8a89..c8fa5beb5 100644 --- a/storage-providers/skills/README.md +++ b/storage-providers/skills/README.md @@ -6,3 +6,4 @@ description: >- # Skills +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/skills) diff --git a/storage-providers/skills/industry.md b/storage-providers/skills/industry.md index cedb7d97e..cdc258e68 100644 --- a/storage-providers/skills/industry.md +++ b/storage-providers/skills/industry.md @@ -24,3 +24,7 @@ When working with customers from certain industries, it is important to understa **ISO 27001**: This is a security standard that provides a framework for establishing, implementing, maintaining, and continually improving an information security management system. Having one or more of these certifications can demonstrate to customers that you have the necessary skills and expertise to handle their data and meet their regulatory requirements. This can be a valuable asset for businesses looking to work with customers in specific industries, as it can provide a competitive edge and help attract new customers. Therefore, it is important for storage providers to stay informed about industry-specific requirements and obtain relevant certifications as necessary. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/skills/industry) diff --git a/storage-providers/skills/linux.md b/storage-providers/skills/linux.md index 7be64c697..4cf4f6993 100644 --- a/storage-providers/skills/linux.md +++ b/storage-providers/skills/linux.md @@ -75,3 +75,7 @@ sar -n DEV 1 sar -n TCP,ETCP 1 top ``` + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/skills/linux) diff --git a/storage-providers/skills/network.md b/storage-providers/skills/network.md index ce3b2af02..8c0a87fe5 100644 --- a/storage-providers/skills/network.md +++ b/storage-providers/skills/network.md @@ -52,3 +52,7 @@ As a storage provider, you also need to make trade-offs between performance and **For example**, if your storage provider setup requires high network throughput, but your budget is limited, you may need to prioritize certain network components, such as switches and network cards, over others. By analyzing the performance impact of each component and comparing it to the cost, you can make informed decisions about which components to invest in. **In summary**, performance is a critical aspect of a storage provider setup, particularly when dealing with high network throughput requirements. Network benchmarking tools such as iperf and iperf3 can help identify potential performance issues and optimize the network setup. To make informed decisions about the network setup, you also need to make trade-offs between performance and cost by analyzing the impact of each component and comparing it to the cost. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/skills/network) diff --git a/storage-providers/skills/sales.md b/storage-providers/skills/sales.md index 9652689f6..51fba77f1 100644 --- a/storage-providers/skills/sales.md +++ b/storage-providers/skills/sales.md @@ -30,7 +30,7 @@ A storage provider needs to get storage deals to grow his network power and to e * Obtaining data replicas from other storage providers and programs: - Certain Filecoin data programs will specify the minimum amount of replicas needed to perform a deal. This means deals need to be stored across multiple storage providers in the ecosystem, so you can work with peers in the network to share clients’ data replicas. + Certain Filecoin data programs will specify the minimum amount of replicas needed to perform a deal. This means deals need to be stored across multiple storage providers in the ecosystem, so you can work with peers in the network to share clients’ data replicas. Working in the ecosystem and building connections with other storage providers takes time and effort, and is essentially a sales activity. * Onboarding your own customers: @@ -38,3 +38,7 @@ A storage provider needs to get storage deals to grow his network power and to e Acquiring your own customers, and bringing their data onto the Filecoin network, requires business development skills and people on your team who actively work with data owners (customers) to educate them about the advantages of decentralized storage. It takes additional effort to work with customers and their data, but it has the additional advantage of being able to charge your customer for the data being stored. This means an additional revenue stream compared to only storing copies of deals, and earning block rewards. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/skills/sales) diff --git a/storage-providers/skills/security.md b/storage-providers/skills/security.md index f543a801e..157fd6eea 100644 --- a/storage-providers/skills/security.md +++ b/storage-providers/skills/security.md @@ -41,3 +41,7 @@ A second layer of defense is system security. There are multiple concepts that c * Privilege escalation Since it is not required that Lotus runs as root, it is also not required for the service account to have privilege escalation. This means you should not allow the `lotus` account to use `sudo`. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/skills/security) diff --git a/storage-providers/skills/storage.md b/storage-providers/skills/storage.md index c5ab00b53..e0997bbd3 100644 --- a/storage-providers/skills/storage.md +++ b/storage-providers/skills/storage.md @@ -53,3 +53,7 @@ As a storage provider, it is crucial to be able to troubleshoot and resolve any In addition to troubleshooting, you must also be able to optimize the performance of your storage system. One way to improve performance is by implementing an NVMe write-cache. NVMe is a protocol designed specifically for solid-state drives, which can greatly improve the speed of write operations. By adding an NVMe write-cache to the storage system, you can reduce the latency of write operations and improve overall system performance. Read-cache on the other hand is typically not useful in the context of Filecoin. This is because sealed sectors are read very randomly, and unsealed sectors will typically not be read twice. Therefore, storing data in a read-cache would be redundant and add unnecessary overhead to the system. + + + +[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/skills/storage)