Filecoin Documentation
repository·main·Indexed 42 days ago
https://github.com/filecoin-project/filecoin-docsOfficial technical guides and references for the Filecoin network. Includes documentation on the Filecoin Virtual Machine (FVM), the Filecoin EVM (FEVM) for Solidity smart contracts, storage and retrieval processes, the Calibration testnet, and the native FIL token.
What's inside Filecoin
- Filecoin nodes are participants that maintain network integrity and contribute to its operation. There are several major implementations available, each with different focuses, languages, and feature sets. Choosing an implementation depends on whether you need full storage/mining capabilities or specialized blockchain analytics.
Overview of Filecoin deals for storage providers
mainFilecoin deals represent the mechanism by which storage providers accept and manage client data. This section provides guidance on various deal types, pricing strategies, and tools available to providers to streamline data storage and revenue generation.
Key areas covered include:
- Storage deals: The process of accepting and storing client data within sectors.
- Verified deals: High-reward deals specifically from Filecoin Plus clients.
- Snap deals: A method to convert empty sectors into data sectors without the need for re-sealing.
- Pricing and Revenue: Strategies for charging for data and calculating Return on Investment (ROI).
- Service Expansion: Utilizing auxiliary services to provide value beyond basic storage.
Overview of Venus implementation
mainVenus is an open-source, full-featured implementation of the Filecoin protocol developed by IPFSForce. Built in Go, it provides storage, retrieval, and mining functionalities. It is designed for speed, efficiency, and scalability, and maintains compatibility with the Lotus implementation, allowing for interoperability with other Filecoin nodes on the network.
Key features include:
- Automatic fault tolerance
- Intelligent storage allocation
- Decentralized data distribution
- Support for the Chinese language and market
What is Filecoin?
mainFilecoin is a peer-to-peer network designed for reliable, decentralized file storage. It uses built-in economic incentives and cryptographic proofs to ensure data integrity and availability.
Core Mechanics
- Clients (Users): Pay storage providers to store data.
- Storage Providers (Data Centers): Provide daily cryptographic proofs to clients as evidence that data is still stored. To participate, providers must lock a certain amount of Filecoin as collateral. If they fail to provide proofs, their collateral is burned.
- Open Market: Pricing and availability are determined by an open market rather than a central entity. Clients can review a provider's history, credentials, and compliance record before choosing them.
Relationship with IPFS
Most Filecoin nodes are also IPFS protocol nodes. While IPFS provides content addressing (using CIDs) to manage data without central servers, it lacks native financial incentives for long-term storage. Filecoin adds an incentive layer to IPFS, allowing providers to offer reliable long-term 'cold storage' while potentially pinning 'hot copies' on IPFS for easy retrieval.
Common Use Cases
- Web3-native storage: NFT content and metadata (e.g., NFT.Storage).
- Content Preservation: Archival of traditional datasets (e.g., Internet Archive, Shoah Foundation).
- Media Streaming: Decentralized backends for audio and video (e.g., Audius, Huddle01).
Overview of Filecoin Full-nodes
mainThis section provides guidance on how to deploy and operate a full Filecoin node. It covers two primary approaches:
- Self-hosted nodes: Instructions on how to spin up a full Filecoin node using Lotus.
- Remote nodes: Options and configurations for interacting with existing remote nodes.
To successfully deploy a node, you should follow the progression from verifying hardware/software requirements to performing a basic setup, and finally choosing between different node provider configurations.
Overview of the Calibration Network
mainThe Calibration network is the most realistic testnet simulation of the Filecoin mainnet. It is designed for prospective storage providers to experience realistic sealing performance and hardware requirements using final proofs constructions and parameters.
Key features include:
- Support for 32 GiB and 64 GiB sector sizes (matching mainnet).
- Inclusion of Filecoin EVM-runtime features.
- Ability for storage clients to store/retrieve real data and participate in deal-making workflows.
- Minimum power requirement for consensus miners is 32 GiB.
Overview of Storage Provider Architecture
mainThe Storage Provider architecture encompasses the software stack, sealing pipelines, and operational tooling required to manage Filecoin storage operations. Key areas of focus include:
- Software Components: Understanding the major Lotus components within a provider setup.
- Automation: Using tools for one-click deployment of the Lotus and Boost stack.
- Sealing Pipeline: The lifecycle of preparing sectors for storage.
- Sealing Performance: Factors influencing sealing rates and methods for outsourcing sealing via 'Sealing as a Service'.
- Network Indexing: How the IPNI maps content identifiers to specific storage providers.
Overview of Filecoin node types
mainFilecoin nodes serve as the network backbone by storing and verifying the blockchain. There are three primary categories of nodes discussed in this documentation:
- Implementations: Specific software packages used to run nodes, such as Lotus and Venus.
- Lite nodes: Lightweight node implementations that do not store the full chain but rely on full nodes for access to chain data.
- Full nodes: Complete node implementations that store and validate the entire blockchain history.
Refer to the specific implementation, lite node, or full node guides for setup instructions and technical details.
Overview of Filecoin economics for storage providers
mainFilecoin economics defines the financial mechanics for storage providers. To participate in the network, providers must manage several key economic components:
- Storage proving: Using Proof-of-Spacetime to demonstrate data is being stored.
- FIL collateral: The required token commitment to initiate storage provision.
- Block rewards: Earning FIL by mining blocks, which is proportional to storage power.
- Slashing: Economic penalties applied for failing to prove storage or for malicious behavior.
- Committed capacity: Using sectors filled with placeholder data to generate consensus power.
Explore the Filecoin community and resources
mainThe Filecoin community consists of developers, storage providers, researchers, and users. You can navigate through various resources to understand the project's governance, technical differences, and ecosystem:
- Governance and Discussion: Access discussion channels, governance proposals (FIPs), and community calls via the Forums and FIPs guide.
- Technical Comparisons and FAQs: Learn how Filecoin compares to other storage solutions (filecoin-compared-to.md), find answers to common questions about storage costs and economics (filecoin-faqs.md), or learn about building on the Filecoin Virtual Machine (FVM) (faqs.md).
- Ecosystem and Roadmap: Discover related protocols and tools (related-projects.md), follow the project roadmap and research (the-filecoin-project.md), or find official social media channels (social-media.md).
- Contribution: Find specific instructions on how to participate in code, documentation, and community efforts in the Ways to contribute guide.
Identify superseded Filecoin tools and workflows
mainThe content in this reference section describes tools, workflows, and projects that are no longer actively maintained. These are preserved for historical reference only.
If you are looking for current guidance, use the following modern alternatives:
- Storage Uploads: Upload to Filecoin
- PDP (Proof of Data Possession): PDP
- General Development: Build on Filecoin
Manage FIL tokens and assets on Filecoin
mainThis section provides guidance on managing FIL tokens, which are the native cryptocurrency powering the Filecoin network. You can learn how to acquire, store, and transfer assets using the following resources:
- The FIL token: Understanding the native cryptocurrency of the network.
- Wallets: Exploring various options for securely holding and managing FIL.
- MetaMask setup: Configuring the MetaMask browser extension to interact with the Filecoin network.
- Get FIL: Instructions on purchasing FIL via cryptocurrency exchanges.
- Transfer FIL: How to send FIL between different address types.