Skip to content

Commit 34ab3bb

Browse files
authored
Merge branch 'main' into xiangan/eoracle
2 parents 54f0f17 + 35c53c9 commit 34ab3bb

File tree

13 files changed

+73
-24
lines changed

13 files changed

+73
-24
lines changed

.gitbook.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,7 @@ redirects:
325325
reference: reference/general/README.md
326326
smart-contracts/advanced/wfil: smart-contracts/advanced/wrapped-fil.md
327327
smart-contracts/advanced/multicall: smart-contracts/advanced/multicall.md
328+
smart-contracts/advanced/multisig: smart-contracts/advanced/multisig.md
328329
smart-contracts/developing-contracts: smart-contracts/developing-contracts/best-practices.md
329330
smart-contracts/filecoin-evm-runtime/differences-with-ethereum: smart-contracts/fundamentals/README.md
330331
smart-contracts/filecoin-evm-runtime/filforwader: smart-contracts/filecoin-evm-runtime/filforwarder.md

SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@
130130
* [Wrapped FIL](smart-contracts/advanced/wrapped-fil.md)
131131
* [Oracles](smart-contracts/advanced/oracles.md)
132132
* [Multicall](smart-contracts/advanced/multicall.md)
133+
* [Multisig](smart-contracts/advanced/multisig.md)
133134
* [Cross-chain bridges](smart-contracts/advanced/cross-chain-bridges.md)
134135
* [Aggregated deal-making](smart-contracts/advanced/aggregated-deal-making.md)
135136

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
---
22
description: >-
3-
Learn how the Filecoin+ program works, how DataCap is obtained and used by clients, and how allocators verify that the data clients want to store with a Filecoin storage provider is useful.
3+
Learn how the Filecoin Plus program works, how DataCap is obtained and used by clients, and how allocators verify that the data clients want to store with a Filecoin storage provider is useful.
44
---
55

6-
# Filecoin+
6+
# Filecoin Plus
77

8-
## What is Filecoin+?
8+
## What is Filecoin Plus?
99

10-
The goal of the Filecoin+ program is to increase the amount of useful data stored with storage providers by clients on the Filecoin network.
10+
The goal of the Filecoin Plus program is to increase the amount of useful data stored with storage providers by clients on the Filecoin network.
1111

1212
In short, this is achieved by appointing allocators responsible for assigning DataCap tokens to clients that are vetted by the allocator as trusted parties storing useful data. Clients then pay DataCap to storage providers as part of a storage deal, which increases a storage provider’s probability of earning block rewards. A full description of this mechanism is described below.
1313

14-
Filecoin+ creates demand on the Filecoin network, ensuring the datasets stored on the network are legitimate and useful to either the clients, or a third party.
14+
Filecoin Plus creates demand on the Filecoin network, ensuring the datasets stored on the network are legitimate and useful to either the clients, or a third party.
1515

1616
## Storage Providers & DataCap
1717

18-
Filecoin+ introduces two concepts important to interactions on the Filecoin network – DataCap and Quality Adjusted Power (QAP).
18+
Filecoin Plus introduces two concepts important to interactions on the Filecoin network – DataCap and Quality Adjusted Power (QAP).
1919

2020
### DataCap
2121

22-
DataCap is a token paid to storage providers as part of a deal in which the client and the data they are storing is verified by a Filecoin+ allocator. Batches of DataCap are granted to allocators by root-key holders, allocators give DataCap to verified clients, and clients pay DataCap to storage providers as part of a deal. The more DataCap a storage provider ends up with, the higher probability they have to earn block rewards. The role of each of these participants, and how DataCap is used in a Filecoin+ deal, is described below in the "Filecoin+ Processes & Participants" section.
22+
DataCap is a token paid to storage providers as part of a deal in which the client and the data they are storing is verified by a Filecoin Plus allocator. Batches of DataCap are granted to allocators by root-key holders, allocators give DataCap to verified clients, and clients pay DataCap to storage providers as part of a deal. The more DataCap a storage provider ends up with, the higher probability they have to earn block rewards. The role of each of these participants, and how DataCap is used in a Filecoin Plus deal, is described below in the "Filecoin Plus Processes & Participants" section.
2323

2424
### Quality Adjusted Power
2525

26-
Quality Adjusted Power is an assigned rating to a given [sector](https://spec.filecoin.io/systems/filecoin_mining/sector/), the basic unit of storage on the Filecoin network. Quality Adjusted Power is a function of a number of features of the sector, including, but not limited to, the sector’s size and promised duration, and whether the sector includes a Filecoin+ deal. It's clear to the network that a sector includes a Filecoin+ deal if a deal in that sector involves DataCap paid to the storage provider. The more Filecoin+ verified data the storage provider has in a sector, the higher the Quality-Adjusted Power a storage provider has, which linearly increases the number of votes a miner has in the [Secret Leader Election](https://spec.filecoin.io/algorithms/expected_consensus/), determining which storage provider gets to serve as the verifier for the next block in the blockchain, and thus increasing the probability the storage provider is afforded the opportunity to earn block rewards. For more details on Quality Adjusted Power, see the [Filecoin specification](https://spec.filecoin.io/systems/filecoin_blockchain/storage_power_consensus/).
26+
Quality Adjusted Power is an assigned rating to a given [sector](https://spec.filecoin.io/systems/filecoin_mining/sector/), the basic unit of storage on the Filecoin network. Quality Adjusted Power is a function of a number of features of the sector, including, but not limited to, the sector’s size and promised duration, and whether the sector includes a Filecoin+ deal. It's clear to the network that a sector includes a Filecoin Plus deal if a deal in that sector involves DataCap paid to the storage provider. The more Filecoin Plus verified data the storage provider has in a sector, the higher the Quality-Adjusted Power a storage provider has, which linearly increases the number of votes a miner has in the [Secret Leader Election](https://spec.filecoin.io/algorithms/expected_consensus/), determining which storage provider gets to serve as the verifier for the next block in the blockchain, and thus increasing the probability the storage provider is afforded the opportunity to earn block rewards. For more details on Quality Adjusted Power, see the [Filecoin specification](https://spec.filecoin.io/systems/filecoin_blockchain/storage_power_consensus/).
2727

2828
[!IMPORTANT]
29-
There is a common misconception that a Filecoin+ deal increases the miner’s reward paid to a Filecoin storage provider by a factor of ten. This is not true, Filecoin+ does not increase the amount of block rewards available to storage providers. Including Filecoin+ deals in a sector increases the Quality Adjusted Power of a storage provider, which increases the probability a storage provider is selected as the block verifier for the next block on the Filecoin blockchain, and thus increases the probability they earn block rewards.
29+
There is a common misconception that a Filecoin Plus deal increases the miner’s reward paid to a Filecoin storage provider by a factor of ten. This is not true, Filecoin+ does not increase the amount of block rewards available to storage providers. Including Filecoin Plus deals in a sector increases the Quality Adjusted Power of a storage provider, which increases the probability a storage provider is selected as the block verifier for the next block on the Filecoin blockchain, and thus increases the probability they earn block rewards.
3030

3131
Consider first a network with ten storage providers. Initially, each storage provider has an equal 10% probability of winning available block rewards in a given period:
3232

@@ -42,7 +42,7 @@ Incentives for storage providers to accept verified deals is strongest initially
4242

4343
![filecoinplus3](https://github.com/filecoin-project/filecoin-docs/assets/46801006/a7ec2921-ea7c-4c0b-94d8-94f8eb5a2824)
4444

45-
As seen in the diagrams above, Filecoin+ increases the collateral requirements needed by a storage provider. As a higher percentage of storage providers include verified deals in their sectors, the collateral needed by each storage provider will increase. To learn more about storage provider collateral, see [this link](https://docs.filecoin.io/storage-providers/filecoin-economics/fil-collateral).
45+
As seen in the diagrams above, Filecoin Plus increases the collateral requirements needed by a storage provider. As a higher percentage of storage providers include verified deals in their sectors, the collateral needed by each storage provider will increase. To learn more about storage provider collateral, see [this link](https://docs.filecoin.io/storage-providers/filecoin-economics/fil-collateral).
4646

4747
## Filecoin+ Processes & Participants
4848

basics/project-and-community/filecoin-faqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ There’s a pretty large design space here, and we can do a bunch of different t
141141

142142
#### Who will be selected to be verifiers to verify clients on the network?
143143

144-
Notaries, selected through an application process, serve as fiduciaries for the Filecoin Network and are responsible for allocating DataCap to clients with valuable storage use cases.
144+
Allocators, selected through an application process, serve as fiduciaries for the Filecoin network and are responsible for allocating DataCap to clients with valuable storage use cases.
145145

146146
See [Filecoin Plus](../how-storage-works/filecoin-plus.md).
147147

basics/the-blockchain/actors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ The `StoragePowerActor` is responsible for keeping track of the storage power al
114114

115115
#### VerifiedRegistryActor
116116

117-
The `VerifiedRegistryActor` is responsible for managing Filecoin Plus (Fil+) clients. This actor can add a verified client to the Fil+ program, remove and reclaim expired DataCap allocations, and manage claims. This actor does not interact directly with the FVM.
117+
The `VerifiedRegistryActor` is responsible for managing Filecoin Plus clients. This actor can add a verified client to the Filecoin Plus program, remove and reclaim expired DataCap allocations, and manage claims. This actor does not interact directly with the FVM.
118118

119119
#### SystemActor
120120

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ The lifecycle for a deal within the storage market contains four distinct phases
1717

1818
## Filecoin plus
1919

20-
The mission of Filecoin Plus (Fil+) is to maximize the amount of useful storage on the Filecoin network. The aim is to bring more meaningful and valuable data into the Filecoin network by offering verified clients cheap, or even free, storage. This mechanism is designed and operates around datacap, the storage quota allocated to verified clients to store data and boost incentives for storage providers.
20+
The mission of Filecoin Plus is to maximize the amount of useful storage on the Filecoin network. The aim is to bring more meaningful and valuable data into the Filecoin network by offering verified clients cheap, or even free, storage. This mechanism is designed and operates around datacap, the storage quota allocated to verified clients to store data and boost incentives for storage providers.
2121

22-
Verified clients can onboard data into Filecoin using datacap, which they apply from community-selected notaries. In return for storing verified storage deals, storage providers receive datacap with a 10x boost to their storage power which eventually increases their block rewards as an incentive.
22+
Verified clients can onboard data into Filecoin using datacap, which they apply from community-selected allocators. In return for storing verified storage deals, storage providers receive datacap with a 10x boost to their storage power which eventually increases their block rewards as an incentive.
2323

2424
* Datacap: a Datacap token will be allocated to a verified client to spend in the storage deals carrying a 10x deal quality multiplier.
2525
* Notaries: community-selected notaries govern the program by verifying storage clients and allocating datacap tokens to verified clients.

reference/built-in-actors/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ The `StoragePowerActor` is responsible for keeping track of the storage power al
107107

108108
### VerifiedRegistryActor
109109

110-
The `VerifiedRegistryActor` is responsible for managing Filecoin Plus (Fil+) clients. This actor can add a verified client to the Fil+ program, remove and reclaim expired DataCap allocations and manage claims. This actor does not interact directly with the FVM.
110+
The `VerifiedRegistryActor` is responsible for managing Filecoin Plus clients. This actor can add a verified client to the Fil+ program, remove and reclaim expired DataCap allocations and manage claims. This actor does not interact directly with the FVM.
111111

112112
### SystemActor
113113

reference/general/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,8 +163,8 @@ For running a node cluster of load balanced Lotus JSON RPC API endpoints.
163163

164164
* [Filecoin storage providers (SPs)](https://sp.filecoin.io/) - Interested in becoming an SP? A boot camp, grants and expert advice is available here!
165165
* [Filecoin Plus Verified Data Program](https://github.com/filecoin-project/filecoin-plus-client-onboarding)
166-
* incentivizes valuable data stored on Filecoin with a social trust network for verified data
167-
* Clients can apply to Notaries to receive DataCap and incentivize storage providers at 10x to their quality-adjusted power, increasing probability of block rewards
166+
* Incentivizes valuable data stored on Filecoin with a social trust network for verified data.
167+
* Clients can apply to allocators to receive DataCap and incentivize storage providers at 10x to their quality-adjusted power, increasing probability of block rewards.
168168
* [Slingshot Competition](https://slingshot.filecoin.io/) - ended in 2021 and has now become [Filecoin Evergreen](https://evergreen.filecoin.io/)
169169

170170
### Retrieval Market resources (WIP experiments)
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
description: >-
3+
Multisig wallets enhance security and decentralization by requiring multiple signatures for transactions, distributing control among multiple participants.
4+
---
5+
6+
# Multisig Wallets
7+
8+
In the Filecoin network, multisig wallets allow multiple parties to jointly manage a wallet by requiring a predefined number of signatures (approvals) for a transaction to be executed. This enhances security and decentralization by distributing control among multiple participants.
9+
10+
Multisig wallets are an essential component of many blockchain applications, as they enable collaborative management of funds and application state. Users initiate a transaction to be signed by fellow collaborators. Once the required number of approvals is met, the transaction is executed.
11+
12+
Multisig wallets enable builders to integrate the following features into their projects:
13+
14+
* **Decentralized Governance**: Parties asynchronously approve transactions initiated by its members.
15+
* **Security**: Distributing control among multiple participants ensures that no single party has full control over the wallet.
16+
* **Collaborative fund management**: Multiple parties can jointly manage a wallet by requiring a predefined number of signatures (approvals) for a transaction to be executed.
17+
18+
## Available multisig wallet implementations
19+
20+
There are several multisig wallet implementations built upon the FVM. Builders can integrate these multisig wallets into their applications today.
21+
22+
### [Safe](https://safe.global/)
23+
24+
Safe is a popular smart account infrastructure provider that allows users to manage their digital assets securely. It is formally verified, secures over $100B in assets, and is used by more than 200 projects.
25+
26+
**Safe Smart Contracts**
27+
28+
Gnosis Safe’s smart contracts are live on the Filecoin Mainnet and Calibration testnet.
29+
30+
| Name | Address | Mainnet | Calibration |
31+
| -------------------------------- | -------------------------------------------- | ------- | ----------- |
32+
| [SimulateTxAccessor](https://filecoin.blockscout.com/address/0x3d4BA2E0884aa488718476ca2FB8Efc291A46199) | `0x3d4BA2E0884aa488718476ca2FB8Efc291A46199` | ✔️ | ✔️ |
33+
| [SafeProxyFactory](https://filecoin.blockscout.com/address/0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67) | `0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67` | ✔️ | ✔️ |
34+
| [TokenCallbackHandler](https://filecoin.blockscout.com/address/0xeDCF620325E82e3B9836eaaeFdc4283E99Dd7562) | `0xeDCF620325E82e3B9836eaaeFdc4283E99Dd7562` | ✔️ | ✔️ |
35+
| [CompatibilityFallbackHandler](https://filecoin.blockscout.com/address/0xfd0732Dc9E303f09fCEf3a7388Ad10A83459Ec99) | `0xfd0732Dc9E303f09fCEf3a7388Ad10A83459Ec99` | ✔️ | ✔️ |
36+
| [CreateCall](https://filecoin.blockscout.com/address/0x9b35Af71d77eaf8d7e40252370304687390A1A52) | `0x9b35Af71d77eaf8d7e40252370304687390A1A52` | ✔️ | ✔️ |
37+
| [MultiSend](https://filecoin.blockscout.com/address/0x38869bf66a61cF6bDB996A6aE40D5853Fd43B526) | `0x38869bf66a61cF6bDB996A6aE40D5853Fd43B526` | ✔️ | ✔️ |
38+
| [MultiSendCallOnly](https://filecoin.blockscout.com/address/0x9641d764fc13c8B624c04430C7356C1C7C8102e2) | `0x9641d764fc13c8B624c04430C7356C1C7C8102e2` | ✔️ | ✔️ |
39+
| [SignMessageLib](https://filecoin.blockscout.com/address/0xd53cd0aB83D845Ac265BE939c57F53AD838012c9) | `0xd53cd0aB83D845Ac265BE939c57F53AD838012c9` | ✔️ | ✔️ |
40+
| [SafeL2](https://filecoin.blockscout.com/address/0x29fcB43b46531BcA003ddC8FCB67FFE91900C762) | `0x29fcB43b46531BcA003ddC8FCB67FFE91900C762` | ✔️ | ✔️ |
41+
| [Safe](https://filecoin.blockscout.com/address/0x41675C099F32341bf84BFc5382aF534df5C7461a) | `0x41675C099F32341bf84BFc5382aF534df5C7461a` | ✔️ | ✔️ |
42+
43+
#### **Further Gnosis Safe resources**
44+
45+
* [Safe Smart Account Docs](https://docs.safe.global/advanced/smart-account-overview)
46+
* [Create Your Own Multisig via. the Safe CLI](https://docs.safe.global/advanced/cli-overview)
47+
* [Safe - Deploy a Recovery Safe Example](https://docs.safe.global/advanced/cli-guides/recovery-safe-deployment)

smart-contracts/developing-contracts/filecoin.sol.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: >-
99
The Filecoin Solidity library allows developers to:
1010

1111
* Interact with Filecoin built-in actors.
12-
* Simplify the interaction with the Filecoin storage market, miner actors, the verified registry for FIL+ automation, and more.
12+
* Simplify the interaction with the Filecoin storage market, miner actors, the verified registry for Filecoin Plus automation, and more.
1313
* Filecoin-specific data types such as `FilAddress`, `FilActorID`, `CIDs`, storage deals, and more.
1414
* OpenZeppelin-like utilities specific to Filecoin.
1515
* CBOR serialization and deserialization for parameters and return data.

0 commit comments

Comments
 (0)