Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 55 additions & 55 deletions .gitbook.yaml

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,6 @@ https://eoracle.gitbook.io/eoracle/price-feeds/integration-guide

# WeChat mobile page intermittently times out from CI runners.
https://www.wechat.com/mobile

# New IA paths return 404 on docs.filecoin.io until migration is deployed.
https://docs.filecoin.io/overview
16 changes: 8 additions & 8 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@
## Overview

* [Overview](overview/README.md)
* [What is Filecoin](overview/what-is-filecoin/README.md)
* [Crypto-economics](overview/what-is-filecoin/crypto-economics.md)
* [Blockchain](overview/what-is-filecoin/blockchain.md)
* [Storage model](overview/what-is-filecoin/storage-model.md)
* [Storage market](overview/what-is-filecoin/storage-market.md)
* [Retrieval market](overview/what-is-filecoin/retrieval-market.md)
* [Programming on Filecoin](overview/what-is-filecoin/programming-on-filecoin.md)
* [Networks](overview/what-is-filecoin/networks.md)

## Architecture

Expand All @@ -28,14 +36,6 @@

## Basics

* [What is Filecoin](basics/what-is-filecoin/README.md)
* [Crypto-economics](basics/what-is-filecoin/crypto-economics.md)
* [Blockchain](basics/what-is-filecoin/blockchain.md)
* [Storage model](basics/what-is-filecoin/storage-model.md)
* [Storage market](basics/what-is-filecoin/storage-market.md)
* [Retrieval market](basics/what-is-filecoin/retrieval-market.md)
* [Programming on Filecoin](basics/what-is-filecoin/programming-on-filecoin.md)
* [Networks](basics/what-is-filecoin/networks.md)
* [The blockchain](basics/the-blockchain/README.md)
* [Actors](basics/the-blockchain/actors.md)
* [Addresses](basics/the-blockchain/addresses.md)
Expand Down
2 changes: 1 addition & 1 deletion WELCOME.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ layout:

Choose your own path to start exploring Filecoin:

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>💡 <strong>Learn the basics</strong></td><td>New to Filecoin and looking for foundational concepts? Start with the Basics section to understand the essentials and kick off your journey!</td><td></td><td><a href="basics/what-is-filecoin/">what-is-filecoin</a></td></tr><tr><td>🔧 <strong>Build with Filecoin</strong></td><td>Ready to develop on the Filecoin network? Head to the Developers section for guides and examples to help bring your project to life.</td><td></td><td><a href="smart-contracts/fundamentals/the-fvm.md">the-fvm.md</a></td></tr><tr><td>🏗️ <strong>Become a Storage Provider</strong></td><td>Thinking about running a provider node on Filecoin? Visit the Provider section for comprehensive guidance on getting started.</td><td></td><td><a href="storage-providers/basics/">basics</a></td></tr><tr><td>📊 <strong>Store data</strong></td><td>Looking to store large volumes of data? Explore the Store section to review the various storage options Filecoin offers.</td><td></td><td><a href="basics/what-is-filecoin/storage-model.md">storage-model.md</a></td></tr></tbody></table>
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>💡 <strong>Learn the basics</strong></td><td>New to Filecoin and looking for foundational concepts? Start with the Basics section to understand the essentials and kick off your journey!</td><td></td><td><a href="overview/what-is-filecoin/">what-is-filecoin</a></td></tr><tr><td>🔧 <strong>Build with Filecoin</strong></td><td>Ready to develop on the Filecoin network? Head to the Developers section for guides and examples to help bring your project to life.</td><td></td><td><a href="smart-contracts/fundamentals/the-fvm.md">the-fvm.md</a></td></tr><tr><td>🏗️ <strong>Become a Storage Provider</strong></td><td>Thinking about running a provider node on Filecoin? Visit the Provider section for comprehensive guidance on getting started.</td><td></td><td><a href="storage-providers/basics/">basics</a></td></tr><tr><td>📊 <strong>Store data</strong></td><td>Looking to store large volumes of data? Explore the Store section to review the various storage options Filecoin offers.</td><td></td><td><a href="overview/what-is-filecoin/storage-model.md">storage-model.md</a></td></tr></tbody></table>

[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/)
4 changes: 2 additions & 2 deletions basics/interplanetary-consensus.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Earlier, we talked about the challenge of scaling solutions to balance performan

* **Highly customizable without compromising security.** Most L2 scaling solutions today either inherit the L1's security features but don't have their own consensus algorithms (e.g. rollups), or do the reverse (e.g. sidechains). They are also deployed in isolation and require custom bridges or protocols to transfer assets and state between L2s that share a common L1, which are vulnerable to attacks. In contrast, IPC subnets have their own consensus algorithms, inherit security features from the parent subnet and have native cross-net communication, eliminating the need for bridges.
* **Multi-chain interoperability.** IPC uses the [Filecoin Virtual Machine (FVM)](https://docs.filecoin.io/smart-contracts/fundamentals/the-fvm) as its transaction execution layer. The FVM is a WASM-based polyglot execution environment for IPLD data and is designed to support smart contracts written in any programming language, compiled to WASM. It currently supports Filecoin and Ethereum. Today, IPC is fully compatible with Filecoin and Ethereum and can use either as a rootnet. IPC will eventually allow any chain to be taken as rootnet.
* **Tight storage integration with Filecoin.** IPC was designed from the data-centric L1, [Filecoin](https://docs.filecoin.io/basics/what-is-filecoin), which is the largest decentralized storage network. IPC can leverage its storage primitives, like IPLD data integration, to deliver enhanced solutions for data availability and more.
* **Tight storage integration with Filecoin.** IPC was designed from the data-centric L1, [Filecoin](https://docs.filecoin.io/overview/what-is-filecoin), which is the largest decentralized storage network. IPC can leverage its storage primitives, like IPLD data integration, to deliver enhanced solutions for data availability and more.

## Applications of IPC

Expand All @@ -48,7 +48,7 @@ Here are some practical examples of how IPC improves the performance of dApps:

With better performance, lower fees and faster transactions, IPC can rapidly improve horizontal and vertical markets with decentralized technology:

* **Artificial Intelligence:** IPC is fully compatible with [Filecoin](https://docs.filecoin.io/basics/what-is-filecoin), the world’s largest decentralized data storage. Leveraging Filecoin, IPC can enable distributed computation to power hundreds of innovative AI models.
* **Artificial Intelligence:** IPC is fully compatible with [Filecoin](https://docs.filecoin.io/overview/what-is-filecoin), the world’s largest decentralized data storage. Leveraging Filecoin, IPC can enable distributed computation to power hundreds of innovative AI models.
* **Decentralized Finance (DeFi):** Enabling truly high-frequency trading and traditional backends with verifiability and privacy.
* **Big Data and Data Science:** Multiple teams are creating global-scale distributed compute networks to enable Data Science analysis on Exabytes of decentralized stored data.
* **Metaverse/Gaming:** Enabling real-time tracking of player interactions in virtual worlds.
Expand Down
4 changes: 2 additions & 2 deletions overview/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ This section is the top-level landing area for foundational Filecoin concepts.

During IA migration, overview content is being consolidated from existing sections.

Current source section:
Core overview content:

* [Basics](../basics/what-is-filecoin/README.md)
* [What is Filecoin](./what-is-filecoin/README.md)

[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/overview)
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Filecoin is used as a storage solution for a range of products, including from W

Filecoin is compatible with various data types, including audio and video files. This versatility 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+URL=https://docs.filecoin.io/basics/what-is-filecoin)
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/overview/what-is-filecoin)
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ If storage providers fail to maintain reliable uptime or act maliciously, they f
- **Storage Fault Slashing**: Penalizes providers who fail to maintain healthy and reliable storage sectors.
- **Consensus Fault Slashing**: Penalizes providers attempting to disrupt the security or availability 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)
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/overview/what-is-filecoin/blockchain)
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ To ensure network security and reliable storage, storage providers must lock FIL

FIL’s maximum circulating supply is capped at 2 billion FIL. However, this maximum will never be reached, as a portion of FIL is permanently removed from circulation through gas fees, penalties, and other mechanisms.

[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/basics/what-is-filecoin/crypto-economics)
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/overview/what-is-filecoin/crypto-economics)
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ The [Calibration](../../networks/calibration/) testnet offers the closest simula
- [Calibration Faucet - Forest Explorer](https://forest-explorer.chainsafe.dev/faucet/calibnet)
- [Calibration USDFC Faucet - Chainsafe](https://forest-explorer.chainsafe.dev/faucet/calibnet_usdfc)

[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/basics/what-is-filecoin/networks)
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/overview/what-is-filecoin/networks)
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,4 @@ The primary difference between FEVM and EVM contracts is that FEVM contracts can

For example FEVM contracts, see the available [example contracts here](https://github.com/lotus-web3/client-contract).

[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/basics/what-is-filecoin/programming-on-filecoin)
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/overview/what-is-filecoin/programming-on-filecoin)
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ To request data retrieval, clients need to provide the following information to

Since most Filecoin nodes are also IPFS nodes, standard practice has been for Filecoin storage providers to also make available a hot copy of any given stored file through IPFS. Since the algorithm that generates a content address (CID) is the same for both Filecoin and IPFS, the client can request the CID of a file they stored on Filecoin and retrieve it from IPFS, if there is an IPFS node that is able and willing to serve the file.

[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/basics/what-is-filecoin/retrieval-market)
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/overview/what-is-filecoin/retrieval-market)
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ Available storage helpers include:
- [Curio](https://curiostorage.org/): A next-gen platform within 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)
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/overview/what-is-filecoin/storage-market)
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ The deal-making process initially occurs _off-chain_. Once both parties agree to

Sectors are the fundamental units of provable storage where storage providers securely store client data and generate PoSt (Proof of Spacetime) for the Filecoin network. Sectors come in standard sizes, typically `32 GiB` or `64 GiB`, and have a set lifespan that providers can extend before it expires.

[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/basics/what-is-filecoin/storage-model)
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/overview/what-is-filecoin/storage-model)
2 changes: 1 addition & 1 deletion storage-providers/filecoin-economics/block-rewards.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,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.
See the [Crypto Economics](../../overview/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.



Expand Down