Skip to content

Commit 83245eb

Browse files
authored
Merge pull request #2379 from filecoin-project/fip001-fips-tools-doc-update
Fip001 fips tools doc update
2 parents 9bdb5d1 + f96830b commit 83245eb

File tree

12 files changed

+60
-51
lines changed

12 files changed

+60
-51
lines changed

SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* [Serving retrievals](basics/how-retrieval-works/serving-retrievals.md)
3636
* [Saturn](basics/how-retrieval-works/saturn.md)
3737
* [Project and community](basics/project-and-community/README.md)
38-
* [Chat and discussion forums](basics/project-and-community/chat-and-discussion-forums.md)
38+
* [Forums and FIPs](basics/project-and-community/forums-and-FIPs.md)
3939
* [Filecoin compared to](basics/project-and-community/filecoin-compared-to.md)
4040
* [Filecoin FAQs](basics/project-and-community/filecoin-faqs.md)
4141
* [Related projects](basics/project-and-community/related-projects.md)

basics/how-storage-works/filecoin-plus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,6 @@ There are three resources you can use to check the current status of the Filecoi
9999
* 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.
100100
* The [Starboard Dashboard](https://dashboard.starboard.ventures/market-deals) includes network health data related to Filecoin+ verified deals.
101101

102-
102+
To learn more about Filecoin Plus, review [FIP003: Filecoin Plus Principles](https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0003.md).
103103

104104
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/how-storage-works/filecoin-plus)

basics/project-and-community/chat-and-discussion-forums.md

Lines changed: 0 additions & 23 deletions
This file was deleted.
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
description: >-
3+
Connect with the Filecoin community in discussion forums or on IRC. The
4+
Filecoin community is active and here to answer your questions in your channel
5+
of choice.
6+
---
7+
8+
# Discussion Forums and Filecoin Improvement Proposals
9+
10+
### Discussion Forums
11+
12+
For shorter-lived discussions, our community chat open to all on both Slack and Discord:
13+
14+
* [Slack](https://filecoin.io/slack/)
15+
* [Discord](https://discord.com/invite/filecoin)
16+
17+
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.
18+
19+
### Filecoin improvement proposals
20+
21+
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/).
22+
23+
There are three types of FIPs:
24+
* 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).
25+
* Organizational FIPs (FOP): changes to processes, tools, or governance.
26+
* Recovery FIPs (FRP): emergency fixes requiring state changes (e.g., major bugs).
27+
28+
Typically, the FIP lifecycle looks something like this:
29+
30+
[ WIP ] -> [ DRAFT ] -> [ LAST CALL ] -> [ ACCEPTED ] -> [ FINAL ]
31+
32+
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.
33+
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).
34+
3. LAST CALL: This status allows the community to submit final changes to the draft.
35+
4. ACCEPTED: Once the FIP is voted on and accepted, the core engineers will work to implement it.
36+
5. FINAL: This status represents the current state-of-the-art, and it should only be updated to correct errors.
37+
38+
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).
39+
40+
[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)

basics/project-and-community/ways-to-contribute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ If you have never contributed to an open-source project before, or just need a r
3939

4040
#### Community
4141

42-
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).
42+
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).
4343

4444
#### Build Applications
4545

basics/what-is-filecoin/crypto-economics.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,11 @@ Additionally, 300 million FIL tokens are held in a mining reserve to incentivize
2525

2626
## Vesting
2727

28-
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.
28+
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.
29+
30+
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).
31+
32+
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).
2933

3034
## Collateral and slashing
3135

networks/calibration/rpcs.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,5 @@ FULLNODE_API_INFO=wss://wss.calibration.node.glif.io/apigw/lotus lotus daemon --
4242
* When using a lite-node, omit `/rpc/v1` from Glif’s WebSocket address.
4343
* [Glif documentation](https://hosting.glif.io/)
4444

45-
## [Lava](https://docs.lavanet.xyz/filecoin)
46-
47-
* HTTPS: `https://filecoin-testnet.lava.build`
48-
* [Lava documentation](https://docs.lavanet.xyz/filecoin-dev)
49-
5045

5146
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/networks/calibration/rpcs)

networks/mainnet/rpcs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ In order to check the current benchmarked performance of each of the below endpo
2020
| [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 |
2121
| [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) | |
2222
| [NOWNodes](https://nownodes.io/) | `https://fil.nownodes.io` (Free for 1 month with signup) | | [NOWNodes - Docs](https://documenter.getpostman.com/view/13630829/TVmFkLwy) | |
23-
| [Lava](https://docs.lavanet.xyz/filecoin-dev) | `https://filecoin.lava.build` | | [Lava - Docs](https://docs.lavanet.xyz/filecoin-dev) | JSON RPC |
23+
2424

2525
## Additional Notes:
2626

reference/general/tools.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,4 @@ These are some tools that developers will find useful when dealing with built-in
3535
* [FVM High-level Rust SDK](https://github.com/polyphene/fvm-rs-sdk) by Polyphene
3636
* [Tooling by Glif](https://glif.io/en)
3737

38-
### Filecoin improvement proposals
39-
40-
Filecoin improvement proposals (FIPs) are a way for the Filecoin community to discuss potential changes and improvements to the Filecoin network.
41-
42-
* [About](https://github.com/filecoin-project/FIPs)
43-
* [Filecoin Slack channel for FIP discussion](https://filecoinproject.slack.com/archives/C01EU76LPCJ)
44-
* [Program Overview & Application](https://airtable.com/shr48kiPOqjwxzX6u)
45-
* [FVM Foundry Cohort Update Recordings](https://www.youtube.com/playlist?list=PL\_0VrY55uV18DBdFIkN0jdBMF8nadVxWQ)
46-
* [FVM Foundry Early Builders F/0 Cohort Showcase - Oct 3 2022](https://drive.google.com/file/d/1JLR45vSNScZX7edz9DxwlpYGnVfGm30Q/view?usp=sharing)
47-
* [FVM Foundry Early Builders F/1 Cohort Kick Off - Oct 5 2022](https://drive.google.com/file/d/1mV0PMunDUvIBqmuNw9VjUJIf4zE4z9LV/view?usp=sharing)
48-
49-
50-
5138
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/reference/general/tools)

storage-providers/filecoin-deals/filecoin-programs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Singularity is an end-to-end solution for onboarding datasets to Filecoin storag
3636

3737
Many other programs and tools exist in the Filecoin community, developed by partners or storage providers. We list some examples below.
3838

39-
### [Decentrally](https://www.decentrally.cloud/)
39+
### Decentrally
4040

4141
[![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)
4242

0 commit comments

Comments
 (0)