diff --git a/SUMMARY.md b/SUMMARY.md index fbb41867f..4f3b99651 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -35,7 +35,7 @@ * [Serving retrievals](basics/how-retrieval-works/serving-retrievals.md) * [Saturn](basics/how-retrieval-works/saturn.md) * [Project and community](basics/project-and-community/README.md) - * [Chat and discussion forums](basics/project-and-community/chat-and-discussion-forums.md) + * [Forums and FIPs](basics/project-and-community/forums-and-FIPs.md) * [Filecoin compared to](basics/project-and-community/filecoin-compared-to.md) * [Filecoin FAQs](basics/project-and-community/filecoin-faqs.md) * [Related projects](basics/project-and-community/related-projects.md) diff --git a/basics/how-storage-works/filecoin-plus.md b/basics/how-storage-works/filecoin-plus.md index 3c3cea59e..4336167e8 100644 --- a/basics/how-storage-works/filecoin-plus.md +++ b/basics/how-storage-works/filecoin-plus.md @@ -99,6 +99,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. - +To learn more about Filecoin Plus, review [FIP003: Filecoin Plus Principles](https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0003.md). [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/project-and-community/chat-and-discussion-forums.md b/basics/project-and-community/chat-and-discussion-forums.md deleted file mode 100644 index 70a53d375..000000000 --- a/basics/project-and-community/chat-and-discussion-forums.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: >- - Connect with the Filecoin community in discussion forums or on IRC. The - Filecoin community is active and here to answer your questions in your channel - of choice. ---- - -# Chat and discussion forums - -### Chat - -For shorter-lived discussions, our community chat open to all on both Slack and Matrix, with bridged channels allowing you to participate in the same conversations from either platform: - -* [Slack](https://filecoin.io/slack/) -* [Matrix](https://matrix.to/#/#ipfs-space:ipfs.io) - -### Discussion Forums - -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/forums-and-FIPs.md b/basics/project-and-community/forums-and-FIPs.md new file mode 100644 index 000000000..fc4230001 --- /dev/null +++ b/basics/project-and-community/forums-and-FIPs.md @@ -0,0 +1,40 @@ +--- +description: >- + Connect with the Filecoin community in discussion forums or on IRC. The + Filecoin community is active and here to answer your questions in your channel + of choice. +--- + +# Discussion Forums and Filecoin Improvement Proposals + +### Discussion Forums + +For shorter-lived discussions, our community chat open to all on both Slack and Discord: + +* [Slack](https://filecoin.io/slack/) +* [Discord](https://discord.com/invite/filecoin) + +For long-lived discussions and for support, please use the [discussion tab on GitHub](https://github.com/filecoin-project/community#forums) instead of Slack. 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. + +### Filecoin improvement proposals + +Filecoin improvement proposals (FIPs) are design documents that propose changes and improvements to the Filecoin network, giving detailed specifications and their rational, and allowing the community to document their consensus or dissent. All technical FIPs that are accepted are later reflected in the [Filecoin Spec](https://spec.filecoin.io/). + +There are three types of FIPs: +* Technical FIPs (FTP): protocol changes, standards, API changes. They can include core (consensus-related changes, networking (network protocol improvements, interface (API/RPC or language-level updates), or can be informational (updates to general guidelines or documentation). +* Organizational FIPs (FOP): changes to processes, tools, or governance. +* Recovery FIPs (FRP): emergency fixes requiring state changes (e.g., major bugs). + +Typically, the FIP lifecycle looks something like this: + +[ WIP ] -> [ DRAFT ] -> [ LAST CALL ] -> [ ACCEPTED ] -> [ FINAL ] + +1. WIP: A community member has an idea for a FIP, and begins discussing the idea publicly on the Filecoin Discord, in the [Filecoin Slack channel for discussing FIPs](https://filecoinproject.slack.com/archives/C01EU76LPCJ), or in Github issues for the relevant repo. +2. DRAFT: If there is a chance the FIP could be adopted, the author submits a draft for the FIP as a pull request in the [FIPs repo](https://github.com/filecoin-project/FIPs). +3. LAST CALL: This status allows the community to submit final changes to the draft. +4. ACCEPTED: Once the FIP is voted on and accepted, the core engineers will work to implement it. +5. FINAL: This status represents the current state-of-the-art, and it should only be updated to correct errors. + +It is the authors' responsibility to request status updates for the FIP. A more robust explainer of the FIP process can be found in [FIP001](https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0001.md#what-is-a-fip). + +[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/ways-to-contribute.md b/basics/project-and-community/ways-to-contribute.md index 2cf91588e..212244786 100644 --- a/basics/project-and-community/ways-to-contribute.md +++ b/basics/project-and-community/ways-to-contribute.md @@ -39,7 +39,7 @@ If you have never contributed to an open-source project before, or just need a r #### Community -If interacting with people is your favorite thing to do in this world, join the [Filecoin chat and discussion forums](chat-and-discussion-forums.md) to say hello, meet others who share your goals, and connect with other members of the community. You should also consider joining [Filecoin Slack](https://filecoin.io/slack). +If interacting with people is your favorite thing to do in this world, join the [Filecoin chat and discussion forums](forums-and-FIPs.md) to say hello, meet others who share your goals, and connect with other members of the community. You should also consider joining [Filecoin Slack](https://filecoin.io/slack). #### Build Applications diff --git a/basics/what-is-filecoin/crypto-economics.md b/basics/what-is-filecoin/crypto-economics.md index 72f59bbe8..d9affa6d9 100644 --- a/basics/what-is-filecoin/crypto-economics.md +++ b/basics/what-is-filecoin/crypto-economics.md @@ -25,7 +25,11 @@ Additionally, 300 million FIL tokens are held in a mining reserve to incentivize ## Vesting -Mining rewards are subject to a vesting schedule to support long-term network alignment. For instance, 75% of block rewards earned by miners vest linearly over 180 days, while 25% are immediately accessible, improving miner cash flow and profitability. Further, FIL tokens are vested to Protocol Labs teams and the Filecoin Foundation over six years and to SAFT investors over three years, as outlined in the vesting schedule. +Mining rewards are subject to a vesting schedule to support long-term network alignment. For instance, 75% of block rewards earned by miners vest linearly over 180 days, while 25% are immediately accessible, improving miner cash flow and profitability. Note that if the miner has incurred "[fee debt](https://docs.filecoin.io/storage-providers/filecoin-economics/slashing)," the immediately accessible block rewards will automatically go towards paying down those fees. + +A certain portion of initially printed FIL tokens are vested to Protocol Labs teams and the Filecoin Foundation over six years, and to SAFT investors over three years, as outlined in the [vesting schedule](https://observablehq.com/@starboard/a-primer-to-filecoin-circulating-supply/2). + +To learn more about Filecoin block rewards vesting, review [FIP004: Liquidity Improvement for Storage Miners](https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0004.md). ## Collateral and slashing diff --git a/networks/calibration/rpcs.md b/networks/calibration/rpcs.md index 5c0435602..2288d783b 100644 --- a/networks/calibration/rpcs.md +++ b/networks/calibration/rpcs.md @@ -42,10 +42,5 @@ FULLNODE_API_INFO=wss://wss.calibration.node.glif.io/apigw/lotus lotus daemon -- * When using a lite-node, omit `/rpc/v1` from Glif’s WebSocket address. * [Glif documentation](https://hosting.glif.io/) -## [Lava](https://docs.lavanet.xyz/filecoin) - -* HTTPS: `https://filecoin-testnet.lava.build` -* [Lava documentation](https://docs.lavanet.xyz/filecoin-dev) - [Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/networks/calibration/rpcs) diff --git a/networks/mainnet/rpcs.md b/networks/mainnet/rpcs.md index 4a65c4696..431e7a887 100644 --- a/networks/mainnet/rpcs.md +++ b/networks/mainnet/rpcs.md @@ -20,7 +20,7 @@ In order to check the current benchmarked performance of each of the below endpo | [Ankr](https://ankr.com/) | `https://rpc.ankr.com/filecoin` | By request at: https://www.ankr.com/rpc/filecoin | [Ankr Docs - Filecoin](https://www.ankr.com/docs/rpc-service/chains/chains-list/#filecoin) | All Filecoin and Eth JSON RPC methods including MPoolPush | | [Chainup Cloud](https://cloud.chainup.com/) | `https://filecoin.chainup.net/rpc/v1` | `wss://filecoin.chainup.net/rpc/v1` | [Chainup Cloud Docs - Filecoin](https://docs.chainupcloud.com/blockchain-api/filecoin/public-apis) | | | [NOWNodes](https://nownodes.io/) | `https://fil.nownodes.io` (Free for 1 month with signup) | | [NOWNodes - Docs](https://documenter.getpostman.com/view/13630829/TVmFkLwy) | | -| [Lava](https://docs.lavanet.xyz/filecoin-dev) | `https://filecoin.lava.build` | | [Lava - Docs](https://docs.lavanet.xyz/filecoin-dev) | JSON RPC | + ## Additional Notes: diff --git a/reference/general/tools.md b/reference/general/tools.md index 7887eface..6147c90df 100644 --- a/reference/general/tools.md +++ b/reference/general/tools.md @@ -35,17 +35,4 @@ These are some tools that developers will find useful when dealing with built-in * [FVM High-level Rust SDK](https://github.com/polyphene/fvm-rs-sdk) by Polyphene * [Tooling by Glif](https://glif.io/en) -### Filecoin improvement proposals - -Filecoin improvement proposals (FIPs) are a way for the Filecoin community to discuss potential changes and improvements to the Filecoin network. - -* [About](https://github.com/filecoin-project/FIPs) -* [Filecoin Slack channel for FIP discussion](https://filecoinproject.slack.com/archives/C01EU76LPCJ) -* [Program Overview & Application](https://airtable.com/shr48kiPOqjwxzX6u) -* [FVM Foundry Cohort Update Recordings](https://www.youtube.com/playlist?list=PL\_0VrY55uV18DBdFIkN0jdBMF8nadVxWQ) -* [FVM Foundry Early Builders F/0 Cohort Showcase - Oct 3 2022](https://drive.google.com/file/d/1JLR45vSNScZX7edz9DxwlpYGnVfGm30Q/view?usp=sharing) -* [FVM Foundry Early Builders F/1 Cohort Kick Off - Oct 5 2022](https://drive.google.com/file/d/1mV0PMunDUvIBqmuNw9VjUJIf4zE4z9LV/view?usp=sharing) - - - [Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/reference/general/tools) diff --git a/storage-providers/filecoin-deals/filecoin-programs.md b/storage-providers/filecoin-deals/filecoin-programs.md index cd70dce96..423db2d5d 100644 --- a/storage-providers/filecoin-deals/filecoin-programs.md +++ b/storage-providers/filecoin-deals/filecoin-programs.md @@ -36,7 +36,7 @@ Singularity is an end-to-end solution for onboarding datasets to Filecoin storag Many other programs and tools exist in the Filecoin community, developed by partners or storage providers. We list some examples below. -### [Decentrally](https://www.decentrally.cloud/) +### Decentrally [![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) diff --git a/storage-providers/filecoin-economics/block-rewards.md b/storage-providers/filecoin-economics/block-rewards.md index a8ca9657c..e435f7856 100644 --- a/storage-providers/filecoin-economics/block-rewards.md +++ b/storage-providers/filecoin-economics/block-rewards.md @@ -12,6 +12,8 @@ WinningPoSt (short for [Winning Proof of SpaceTime](https://spec.filecoin.io/alg The election mechanism of the Filecoin network is based on the “storage power” of the storage providers. A minimum of 10 TiB in storage power is required to be eligible for WinningPoSt, and hence to earn block rewards. The more storage power a storage provider has, the more likely they will be elected to mine a block. This concept becomes incredibly advantageous in the context of [Filecoin Plus verified deals](../../basics/how-storage-works/filecoin-plus.md). +Note that the deadline cron, a built-in actor that processes all miner actors every 60 epochs (every 30 minutes), is responsible for updating the rewards vesting table. A miner operator wishing to process vesting manually, ahead of the per-deadline cron call, could do so by calling WithdrawFunds with an amount of zero. Such a call would require use of the miner's Owner address. More details can be found in [FIP005: Remove ineffective reward vesting](https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0005.md). + ## Filecoin’s storage capacity The Filecoin network is composed of storage providers who offer storage capacity to the network. This capacity is used to secure the network, as it takes a significant amount of storage to take part in the consensus mechanism. This large capacity makes it impractical for a single party to reach 51% of the network power, since an attacker would need 10 EiB in storage to control the network. Therefore, it is important that the raw capacity also referred to as _raw byte power_, remains high. The Filecoin spec also included a _baseline power_ above which the network yields maximum returns for the storage providers. diff --git a/storage-providers/filecoin-economics/slashing.md b/storage-providers/filecoin-economics/slashing.md index 52c6733bd..ddebcbf92 100644 --- a/storage-providers/filecoin-economics/slashing.md +++ b/storage-providers/filecoin-economics/slashing.md @@ -11,14 +11,18 @@ description: >- This term encompasses a broad set of penalties which are to be paid by storage providers if they fail to provide sector reliability or decide to voluntarily exit the network. These include: -* **Fault fees** are incurred for each day a storage provider’s sector is offline (fails to submit Proofs-of-Spacetime to the chain). Fault fees continue until the associated wallet is empty and the storage provider is removed from the network. In the case of a faulted sector, there will be an additional sector penalty added immediately following the fault fee. +* **Fault fees** are incurred for each day a storage provider’s sector is offline (fails to submit Proofs-of-Spacetime to the chain). Fault fees continue until the associated wallet is empty and the storage provider is removed from the network. In the case of a faulted sector, there will be an additional sector penalty added immediately following the fault fee. Sector fault fees are equal to 3.51 days of expected block rewards. * **Sector penalties** are incurred for a faulted sector that was not declared faulted before a _WindowPoSt_ check occurs. The sector will pay a fault fee after a Sector Penalty once the fault is detected. * **Termination fees** are incurred when a sector is voluntarily or involuntarily terminated and is removed from the network. +* **Consensus fault slashing** is a penalty incurred when committing consensus faults. This penalty is applied to storage providers that have acted maliciously against the network’s consensus functionality. -## 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. +## Honest Storage Providers +Note that occasionally, storage providers may experience operational issues, such as downtime or bugs, that cause them to miss their delivery of a WindowPoSt. To ensure reliability and to encourage smaller miners to join the network, there are built-in exceptions to the fault fees: +* If the Storage Provider has a history of acting honestly, there is no penalty in the current proving period for a faulted sector in the case of a missed WindowPoSt. +* There are no fees if the sector is successfully recovered in a later proving period. +* The fault fee applies only to the sectors already faulty, meaning, they are from a previous proving period, or marked for recovery. Penalties are only applied to faulty sectors from previous proving periods, never the current proving period. +To learn more about fault fee exceptions, review [FIP002: Free Faults on Newly Faulted Sectors of a Missed WindowPoSt](https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0002.md). [Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/storage-providers/filecoin-economics/slashing)