Skip to content

Commit a0c398c

Browse files
committed
CR
1 parent 48a77d2 commit a0c398c

File tree

9 files changed

+70
-70
lines changed

9 files changed

+70
-70
lines changed

WELCOME.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ layout:
1919
visible: true
2020
---
2121

22-
# Welcome to the Filecoin Documentation
22+
# Welcome to the Filecoin documentation
2323

2424
Choose your own path to start exploring Filecoin:
2525

@@ -34,7 +34,7 @@ Choose your own path to start exploring Filecoin:
3434
</thead>
3535
<tbody>
3636
<tr>
37-
<td>💡 <strong>Learn the Basics</strong></td>
37+
<td>💡 <strong>Learn the basics</strong></td>
3838
<td>New to Filecoin and looking for foundational concepts? Start with the Basics section to understand the essentials and kick off your journey!</td>
3939
<td></td>
4040
<td><a href="basics/what-is-filecoin/">what-is-filecoin</a></td>
@@ -52,7 +52,7 @@ Choose your own path to start exploring Filecoin:
5252
<td><a href="storage-providers/basics/">basics</a></td>
5353
</tr>
5454
<tr>
55-
<td>📊 <strong>Store Data</strong></td>
55+
<td>📊 <strong>Store data</strong></td>
5656
<td>Looking to store large volumes of data? Explore the Store section to review the various storage options Filecoin offers.</td>
5757
<td></td>
5858
<td><a href="basics/what-is-filecoin/storage-model.md">storage-model.md</a></td>

basics/what-is-filecoin/blockchain.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,30 @@ Each tipset is assigned a weight, enabling the consensus protocol to guide nodes
1515

1616
An actor in the Filecoin blockchain is similar to a smart contract in the Ethereum Virtual Machine. It functions as an ‘object’ within the Filecoin network, with a state and a set of methods for interaction.
1717

18-
### Built-in Actors
18+
### Built-in actors
1919

2020
Several built-in system actors power the Filecoin network as a decentralized storage network:
2121

22-
- **System Actor**: General system actor.
23-
- **Init Actor**: Initializes new actors and records the network name.
24-
- **Cron Actor**: Scheduler that runs critical functions at every epoch.
25-
- **Account Actor**: Manages user accounts (non-singleton).
26-
- **Reward Actor**: Manages block rewards and token vesting (singleton).
27-
- **Storage Miner Actor**: Manages storage mining operations and validates storage proofs.
28-
- **Storage Power Actor**: Tracks storage power allocation for each provider.
29-
- **Storage Market Actor**: Manages storage deals.
30-
- **Multisig Actor**: Handles Filecoin multi-signature wallet operations.
31-
- **Payment Channel Actor**: Sets up and settles payment channel funds.
32-
- **Datacap Actor**: Manages datacap tokens.
33-
- **Verified Registry Actor**: Manages verified clients.
34-
- **Ethereum Address Manager (EAM) Actor**: Assigns Ethereum-compatible addresses on Filecoin, including EVM smart contract addresses.
35-
- **EVM Account Actor**: Represents an external Ethereum identity backed by a secp256k1 key.
36-
37-
### User-Programmable Actors
22+
- **System actor**: General system actor.
23+
- **Init actor**: Initializes new actors and records the network name.
24+
- **Cron actor**: Scheduler that runs critical functions at every epoch.
25+
- **Account actor**: Manages user accounts (non-singleton).
26+
- **Reward actor**: Manages block rewards and token vesting (singleton).
27+
- **Storage miner actor**: Manages storage mining operations and validates storage proofs.
28+
- **Storage power actor**: Tracks storage power allocation for each provider.
29+
- **Storage market actor**: Manages storage deals.
30+
- **Multisig actor**: Handles Filecoin multi-signature wallet operations.
31+
- **Payment channel actor**: Sets up and settles payment channel funds.
32+
- **Datacap actor**: Manages datacap tokens.
33+
- **Verified registry actor**: Manages verified clients.
34+
- **Ethereum Address Manager (EAM) actor**: Assigns Ethereum-compatible addresses on Filecoin, including EVM smart contract addresses.
35+
- **Ethereum Virtual Machine (EVM) account actor**: Represents an external Ethereum identity backed by a secp256k1 key.
36+
37+
### User-programmable actors
3838

3939
With the maturity of the FVM, developers can write actors and deploy them on the Filecoin network, similar to other blockchains' smart contracts. User-programmable actors can interact with built-in actors via the exported API from built-in actors.
4040

41-
## Distributed Randomness
41+
## Distributed randomness
4242

4343
Filecoin uses the [Drand](https://drand.love) protocol as a randomness beacon for leader election in the [expected consensus](blockchain.md#expected-consensus) process. This randomness ensures leader election is secret, fair, and verifiable.
4444

@@ -65,13 +65,13 @@ In the Filecoin network, addresses identify actors in the Filecoin state. Each a
6565

6666
## Consensus
6767

68-
### Expected Consensus
68+
### Expected consensus
6969

7070
Expected Consensus (EC) is the consensus algorithm underlying Filecoin. EC is a probabilistic, Byzantine fault-tolerant protocol that conducts a leader election among storage providers each epoch to determine which provider submits a block. Similar to proof-of-stake, Filecoin’s leader election relies on proof-of-storage, meaning the probability of being elected depends on how much provable storage power a miner contributes to the network. This storage power is recorded in the storage power table, managed by the Storage Power Actor.
7171

7272
At a high level, the consensus process uses [Drand](https://drand.love) to provide distributed, verifiable randomness, ensuring that leader election is secret, fair, and unbiased. Election participants and their storage power are drawn from the Power Table, which is continuously calculated and maintained by the Storage Power Consensus subsystem. Ultimately, EC gathers all valid blocks produced in an epoch and applies a weighting function to select the heaviest chain, adding blocks accordingly.
7373

74-
### Block Production Process
74+
### Block production process
7575

7676
The block production process for each epoch is as follows:
7777

@@ -90,11 +90,11 @@ EC enforces soft finality, where miners at round `N` reject blocks forking off b
9090

9191
Filecoin operates on proof-of-storage, where miners offer storage space and provide proofs to verify data storage.
9292

93-
### Proof of Replication
93+
### Proof of replication
9494

9595
With proof-of-replication (PoRep), storage providers prove they have created a unique copy of the client’s data for the network.
9696

97-
### Proof of Spacetime
97+
### Proof of spacetime
9898

9999
Storage providers must continuously prove that they are storing clients' data throughout the entire duration of the storage deal. The proof-of-spacetime (PoSt) process includes two types of challenges:
100100

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,21 @@ description: >-
33
Crypto-economics is the study of how cryptocurrency can incentivize usage of a blockchain network. This page covers how Filecoin manages incentivization within the network.
44
---
55

6-
# Crypto-Economics
6+
# Crypto-economics
77

8-
## Native Currency
8+
## Native currency
99

1010
Filecoin’s native currency, FIL, is a utility token that incentivizes persistent storage on the Filecoin network. Storage providers earn FIL by offering reliable storage services or committing storage capacity to the network. With a maximum circulating supply of 2 billion FIL, no more than 2 billion Filecoin will ever exist.
1111

1212
As a utility token aligned with the network’s long-term growth, Filecoin issuance depends on the network’s provable utility and growth. Most of the Filecoin supply is only minted as the network achieves specific growth and utility milestones.
1313

1414
Filecoin uses a dual minting model for block reward distribution:
1515

16-
## Baseline Minting
16+
## Baseline minting
1717

1818
Up to 770 million FIL tokens are minted based on network performance. Full release of these tokens would only occur if the Filecoin network reaches a yottabyte of storage capacity within 20 years, approximately 1,000 times the capacity of today’s cloud storage.
1919

20-
## Simple Minting
20+
## Simple minting
2121

2222
An additional 330 million FIL tokens are released on a 6-year half-life schedule, with 97% of these tokens projected to be released over about 30 years.
2323

@@ -27,11 +27,11 @@ Additionally, 300 million FIL tokens are held in a mining reserve to incentivize
2727

2828
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.
2929

30-
## Collateral and Slashing
30+
## Collateral and slashing
3131

3232
To ensure network security and reliable storage, storage providers must lock FIL as pledge collateral during block reward mining. Pledge collateral is based on projected block rewards a miner could earn. Collateral and all earned rewards are subject to slashing if the storage fails to meet reliability standards throughout a sector’s lifecycle.
3333

34-
## Total Supply
34+
## Total supply
3535

3636
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.
3737

basics/what-is-filecoin/programming-on-filecoin.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ description: >-
33
Once data is stored, computations can be performed directly on it without needing retrieval. This page covers the basics of programming on Filecoin.
44
---
55

6-
# Programming on Filecoin
6+
# Programming on filecoin
77

8-
## Compute-over-Data
8+
## Compute-over-data
99

1010
Beyond storage and retrieval, data often needs transformation. Compute-over-data protocols enable computations over IPLD, the data layer used by content-addressed systems like Filecoin. Working groups are developing compute solutions for Filecoin data, including large-scale parallel compute (e.g., [Bacalhau](https://www.bacalhau.org/)) and cryptographically verifiable compute (e.g., [Lurk](https://filecoin.io/blog/posts/introducing-lurk-a-programming-language-for-recursive-zk-snarks/)).
1111

@@ -27,35 +27,35 @@ By enabling compute-over-states on the Filecoin network, the FVM unlocks a wide
2727

2828
FVM enables a new kind of organization centered around data.
2929

30-
#### Data DAOs and Tokenized Datasets
30+
#### Data DAOs and tokenized datasets
3131

3232
The FVM makes it possible to create and manage decentralized and autonomous organizations (Data DAOs) focused on data curation and preservation. Data DAOs allow groups of individuals or organizations to govern and monetize data access, pooling returns into a shared treasury to fund preservation and growth. These data tokens can also be exchanged among peers or used to request computation services, such as validation, analysis, feature detection, and machine learning.
3333

34-
#### Perpetual Storage
34+
#### Perpetual storage
3535

3636
The FVM allows users to store data once and use repair and replication bots to manage ongoing storage deals, ensuring perpetual data storage. Through smart contracts, users can fund a wallet with FIL, allowing storage providers to maintain data storage indefinitely. Repair bots monitor these storage deals and replicate data across providers as needed, offering long-term data permanence.
3737

38-
### Financial Services for Miners
38+
### Financial services for miners
3939

4040
The FVM can facilitate unique financial services tailored for storage providers (SPs) in the Filecoin ecosystem.
4141

42-
#### Lending and Staking Protocols
42+
#### Lending and staking protocols
4343

4444
Users can lend Filecoin to storage providers to be used as storage collateral, earning interest in return. Loans may be undercollateralized based on SP performance history, with reputation scores generated from on-chain data. Loans can also be automatically repaid to investors using a multisig wallet, which includes lenders and a third-party arbitrator. New FVM-enabled smart contracts create yield opportunities for FIL holders while supporting the growth of storage services on the network.
4545

4646
#### Insurance
4747

4848
SPs may require financial products to protect against risks in providing storage solutions. Attributes such as payment history, operational length, and availability can be used to underwrite insurance policies, shielding SPs from financial impacts due to storage faults or token price fluctuations.
4949

50-
### Core Chain Infrastructure
50+
### Core chain infrastructure
5151

5252
The FVM is expected to achieve feature parity with other persistent EVM chains, supporting critical infrastructure for decentralized exchanges and token bridges.
5353

54-
#### Decentralized Exchanges
54+
#### Decentralized exchanges
5555

5656
To facilitate on-chain token exchange, the FVM may support decentralized exchanges like Uniswap or Sushi, or implement decentralized order books similar to Serum on Solana.
5757

58-
#### Token Bridges
58+
#### Token bridges
5959

6060
Although not an immediate focus, token bridges will eventually connect Filecoin to EVM, Move, and Cosmos chains, enabling cross-chain wrapped tokens. While Filecoin currently offers unique value without needing to bootstrap liquidity from other chains, long-term integration with other blockchains is anticipated.
6161

basics/what-is-filecoin/retrieval-market.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ description: >-
33
The retrieval market facilitates the negotiation of retrieval deals for serving stored data to clients in exchange for FIL.
44
---
55

6-
# Retrieval Market
6+
# Retrieval market
77

8-
## Basic Retrieval
8+
## Basic retrieval
99

1010
Currently, Filecoin nodes support direct retrieval from the storage miners who originally stored the data. Clients can send retrieval requests directly to a storage provider and pay a small amount of FIL to retrieve their data.
1111

basics/what-is-filecoin/storage-market.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ description: >-
33
The storage market is the entry point where storage providers and clients negotiate and publish storage deals on-chain.
44
---
55

6-
# Storage Market
6+
# Storage market
77

8-
## Deal Making
8+
## Deal making
99

1010
The lifecycle of a deal within the storage market includes four distinct phases:
1111

@@ -24,7 +24,7 @@ Verified clients use datacap allocated by community-selected allocators to store
2424
- **Allocators**: Community-selected entities responsible for verifying storage clients and allocating datacap tokens.
2525
- **Verified Clients**: Active participants with datacap allocations for their data storage needs.
2626

27-
## Storage On-Ramps
27+
## Storage on-ramps
2828

2929
To simplify data storage on the Filecoin network, several tools offer streamlined integration of Filecoin and IPFS storage for applications or smart contracts.
3030

basics/what-is-filecoin/storage-model.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ Providers offer storage and retrieval services to network users. There are two t
1818
- Storage Providers
1919
- Retrieval Providers
2020

21-
### Storage Providers
21+
### Storage providers
2222

2323
Storage providers, often called SPs, are responsible for storing files and data for clients on the network. They also provide cryptographic proofs to verify that data is stored securely. The majority of providers on the Filecoin network are SPs.
2424

25-
### Retrieval Providers
25+
### Retrieval providers
2626

2727
Retrieval providers, or RPs, specialize in delivering quick access to data rather than long-term storage. While many storage providers also offer retrieval services, stand-alone RPs are increasingly joining the network to enhance data accessibility.
2828

smart-contracts/advanced/oracles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Pyth’s smart contracts are live on the Filecoin Mainnet and Calibration testne
3434
| Name | Address | Mainnet | Calibration |
3535
| ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ------- | ----------- |
3636
| [Pyth - Mainnet](https://filecoin.blockscout.com/address/0xA2aa501b19aff244D90cc15a4Cf739D2725B5729?tab=contract) | `0x045CE60839d108B43dF9e703d4b25402a6a28a0d` | ✔️ | |
37-
| [Pyth - Calibration](https://calibration.filfox.info/en/address/0xA2aa501b19aff244D90cc15a4Cf739D2725B5729) | `0x15e6Cc0D69A162151Cadfba035aa10b82b12b970` | | ✔️ |
37+
| [Pyth - Calibration](http://47.109.105.51/en/address/0xA2aa501b19aff244D90cc15a4Cf739D2725B5729) | `0x15e6Cc0D69A162151Cadfba035aa10b82b12b970` | | ✔️ |
3838

3939
**Pyth x Filecoin Price Feed IDs**
4040

smart-contracts/developing-contracts/client-contract-tutorial.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
---
22
description: >-
3-
This page covers the client contract, and includes a tutorial on how developers can use the client contract to create storage deals programmatically.
3+
This page covers the client contract, and includes a tutorial on how developers can use the client contract to create storage deals programmatically.
44
---
55

66
# Client contract tutorial
77

8-
In this tutorial we will cover the background of creating storage deals using smart contracts, and how to create storage deals with smart contracts on the [Filecoin virtual machine](../../reference/general/glossary.md#filecoin-virtual-machine).
8+
In this tutorial we will cover the background of creating storage deals using smart contracts, and how to create storage deals with smart contracts on the [Filecoin virtual machine](../../reference/general/glossary.md#filecoin-virtual-machine).
99

1010
You can find a video form of this walkthrough on [ETHGlobal’s YouTube Channel](https://www.youtube.com/watch?v=27EV3gQGY9k).
1111

1212
## Prerequisites
1313

1414
Before continuing, make sure you have the following software installed and prerequisites ready:
1515

16-
* Git
17-
* NodeJS
18-
* Yarn or NPM (Yarn is used in this tutorial)
19-
* A code editor such as VS Code
20-
* A wallet with Calibration testnet FIL
16+
- Git
17+
- NodeJS
18+
- Yarn or NPM (Yarn is used in this tutorial)
19+
- A code editor such as VS Code
20+
- A wallet with Calibration testnet FIL
2121

2222
## Steps
2323

@@ -68,32 +68,32 @@ Before storing a file with a storage provider it needs to be prepared by turning
6868
6969
1. Go to the [FVM Data Depot website](https://data.lighthouse.storage/) and create an account.
7070
2. Click **Upload File** and select a file you wish to upload.
71-
3. Select the **File ID** of the file to read all the relevant metadata. Make a note of the:
71+
3. Select the **File ID** of the file to read all the relevant metadata. Make a note of the:
7272
73-
* Piece CID
74-
* Payload CID
75-
* Car size
76-
* Piece size
77-
* URL
73+
- Piece CID
74+
- Payload CID
75+
- Car size
76+
- Piece size
77+
- URL
7878
79-
We’ll use this information in the next step when invoking the `MakeDealProposal` method.
79+
We’ll use this information in the next step when invoking the `MakeDealProposal` method.
8080
8181
### Invoke the `MakeDealProposal` method
8282
8383
Now that we have the `.car` file prepared in the data depot, we can invoke the MakeDealProposal method on the smart contract we deployed earlier. To do this, we will run the `make-deal-proposal` task in Hardhat. There are quite a few parameters to include in this call:
8484
85-
* `contract`: the address of your deployed `ClientContract.sol`.
86-
* `piece-cid: gathered from the previous step.
87-
* `piece-size`: gathered from the previous step.
88-
* `car-size`: gathered from the previous step.
89-
* `start-epoch`: The block number you want the deal to begin on. It should be a block in the future. You can find the current block number on [Beryx](https://beryx.io/), making sure to select the correct network.
90-
* `end-epoch`: The block number you want the deal to end on. It should be a block in the future and after the `Start-Epoch`. You can find the current block number on [FILFOX](https://calibration.filfox.info/en).
91-
* `location-ref`: The location of where the storage provider can find the .car file. This is the `URL` from the previous step.
85+
- `contract`: the address of your deployed `ClientContract.sol`.
86+
- `piece-cid: gathered from the previous step.
87+
- `piece-size`: gathered from the previous step.
88+
- `car-size`: gathered from the previous step.
89+
- `start-epoch`: The block number you want the deal to begin on. It should be a block in the future. You can find the current block number on [Beryx](https://beryx.io/), making sure to select the correct network.
90+
- `end-epoch`: The block number you want the deal to end on. It should be a block in the future and after the `Start-Epoch`. You can find the current block number on [FILFOX](http://47.109.105.51/en).
91+
- `location-ref`: The location of where the storage provider can find the .car file. This is the `URL` from the previous step.
9292
9393
When calling the `make-deal-proposal` task in Hardhat, your command will look something like this:
9494
9595
```shell
96-
yarn hardhat make-deal-proposal \
96+
yarn hardhat make-deal-proposal \
9797
--contract 0x0219eB1740C315fe5e20612D7E13AE2A883dB3f4 \
9898
--piece-cid baga6ea4seaqn4eomxfk3ttog7lnvlvedu7nia377w4gotw2pm746k6kq7gwe6ga \
9999
--piece-size 2097152 \

0 commit comments

Comments
 (0)