-
Notifications
You must be signed in to change notification settings - Fork 302
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
918bac4
commit c6aaa4c
Showing
166 changed files
with
20,451 additions
and
136 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
description: >- | ||
This section aims to provide a comprehensive overview of Filecoin to | ||
developers and serves as a reference that developers can check back on. | ||
--- | ||
|
||
# What is Filecoin | ||
|
||
Filecoin is a peer-to-peer network that stores files, with built-in economic incentives and cryptography to ensure files are stored reliably over time. In Filecoin, users pay to store their files on storage providers. Storage providers are computers responsible for storing files and proving they have stored them correctly over time. Anyone who wants to store their files or get paid for storing other users’ files can join Filecoin. Available storage, and the price of that storage, are not controlled by any single company. Instead, Filecoin facilitates open markets for storing and retrieving files that anyone can participate in. | ||
|
||
Filecoin is built on top of the same software powering [IPFS protocol](https://docs.ipfs.tech/), which is a peer-to-peer distributed storage network that leverages [content addressing](https://docs.ipfs.tech/concepts/content-addressing/) to allow permanent references to the data, and avoids relying on specific devices or cloud servers for addressing the content. Filecoin is different from IPFS because it has an incentive layer on top to incentivize contents to be reliably stored and accessed. | ||
|
||
Filecoin enables several use cases, from Web3 native NFT and metaverse/game assets storage, incentivized permanent storage, to archiving Web2 datasets as a cheaper alternative to cloud storage. For example, [NFT.Storage](https://nft.storage/) utilizes Filecoin to provide a simple decentralized storage solution for NFT contents and metadata, while [Shoah Foundation](https://sfi.usc.edu/) and [Internet Archive](https://archive.org/) leverages Filecoin to backup their contents. Filecoin also supports a wide range of formats of data, including audio and video files, allowing Web3 platforms such as [Audius](https://audius.co/) and [Huddle01](https://huddle01.com/) to leverage Filecoin as the decentralized storage backend for music streaming and video conferencing. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,173 @@ | ||
# Table of contents | ||
|
||
## Basics | ||
|
||
* [What is Filecoin](README.md) | ||
* [Crypto-economics](basics/what-is-filecoin/crypto-economics.md) | ||
* [Blockchain](basics/what-is-filecoin/blockchain.md) | ||
* [Storage model](basics/what-is-filecoin/storage-model.md) | ||
* [Storage market](basics/what-is-filecoin/storage-market.md) | ||
* [Retrieval market](basics/what-is-filecoin/retrieval-market.md) | ||
* [Programming on Filecoin](basics/what-is-filecoin/programming-on-filecoin.md) | ||
* [Networks](basics/what-is-filecoin/networks.md) | ||
* [The blockchain](basics/the-blockchain/README.md) | ||
* [Actors](basics/the-blockchain/actors.md) | ||
* [Addresses](basics/the-blockchain/addresses.md) | ||
* [Blocks and tipsets](basics/the-blockchain/blocks-and-tipsets.md) | ||
* [Consensus](basics/the-blockchain/consensus.md) | ||
* [Drand](basics/the-blockchain/drand.md) | ||
* [Proofs](basics/the-blockchain/proofs.md) | ||
* [Assets](basics/assets/README.md) | ||
* [The FIL token](basics/assets/the-fil-token.md) | ||
* [Wallets](basics/assets/wallets.md) | ||
* [Metamask setup](basics/assets/metamask-setup.md) | ||
* [Get FIL](basics/assets/get-fil.md) | ||
* [Transfer FIL](basics/assets/transfer-fil.md) | ||
* [Interplanetary consensus](basics/interplanetary-consensus/README.md) | ||
* [Hierarchical consensus](basics/interplanetary-consensus/hierarchical-consensus.md) | ||
* [IPC agent](basics/interplanetary-consensus/ipc-agent.md) | ||
* [Mir and Trantor](basics/interplanetary-consensus/mir-and-trantor.md) | ||
* [How storage works](basics/how-storage-works/README.md) | ||
* [Filecoin plus](basics/how-storage-works/filecoin-plus.md) | ||
* [Storage onramps](basics/how-storage-works/storage-onramps.md) | ||
* [Filecoin and IPFS](basics/how-storage-works/filecoin-and-ipfs.md) | ||
* [How retrieval works](basics/how-retrieval-works/README.md) | ||
* [Basic retrieval](basics/how-retrieval-works/basic-retrieval.md) | ||
* [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) | ||
* [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) | ||
* [Social media](basics/project-and-community/social-media.md) | ||
* [The Filecoin project](basics/project-and-community/the-filecoin-project.md) | ||
* [Ways to contribute](basics/project-and-community/ways-to-contribute.md) | ||
|
||
## Storage providers | ||
|
||
* [Basics](storage-providers/basics/README.md) | ||
* [Quickstart guide](storage-providers/basics/quickstart-guide.md) | ||
* [Filecoin economics](storage-providers/filecoin-economics/README.md) | ||
* [Storage proving](storage-providers/filecoin-economics/storage-proving.md) | ||
* [FIL collateral](storage-providers/filecoin-economics/fil-collateral.md) | ||
* [Block rewards](storage-providers/filecoin-economics/block-rewards.md) | ||
* [Slashing](storage-providers/filecoin-economics/slashing.md) | ||
* [Committed capacity](storage-providers/filecoin-economics/committed-capacity.md) | ||
* [Filecoin deals](storage-providers/filecoin-deals/README.md) | ||
* [Storage deals](storage-providers/filecoin-deals/storage-deals.md) | ||
* [Verified deals](storage-providers/filecoin-deals/verified-deals.md) | ||
* [Filecoin programs](storage-providers/filecoin-deals/filecoin-programs.md) | ||
* [Snap deals](storage-providers/filecoin-deals/snap-deals.md) | ||
* [Charging for data](storage-providers/filecoin-deals/charging-for-data.md) | ||
* [Auxiliary services](storage-providers/filecoin-deals/auxiliary-services.md) | ||
* [Return-on-investment](storage-providers/filecoin-deals/return-on-investment.md) | ||
* [Architecture](storage-providers/architecture/README.md) | ||
* [Lotus components](storage-providers/architecture/lotus-components.md) | ||
* [Storage provider automation](storage-providers/architecture/lotus-automation.md) | ||
* [Sealing pipeline](storage-providers/architecture/sealing-pipeline.md) | ||
* [Sealing rate](storage-providers/architecture/sealing-rate.md) | ||
* [Sealing-as-a-service](storage-providers/architecture/sealing-as-a-service.md) | ||
* [Network indexer](storage-providers/architecture/network-indexer.md) | ||
* [Infrastructure](storage-providers/infrastructure/README.md) | ||
* [Storage](storage-providers/infrastructure/storage.md) | ||
* [Network](storage-providers/infrastructure/network.md) | ||
* [Backup and disaster recovery](storage-providers/infrastructure/backup-and-disaster-recovery.md) | ||
* [Reference architectures](storage-providers/infrastructure/reference-architectures.md) | ||
* [Skills](storage-providers/skills/README.md) | ||
* [Linux](storage-providers/skills/linux.md) | ||
* [Network](storage-providers/skills/network.md) | ||
* [Security](storage-providers/skills/security.md) | ||
* [Storage](storage-providers/skills/storage.md) | ||
* [Sales](storage-providers/skills/sales.md) | ||
* [Industry](storage-providers/skills/industry.md) | ||
|
||
## Nodes | ||
|
||
* [Implementations](nodes/implementations/README.md) | ||
* [Lotus](nodes/implementations/lotus.md) | ||
* [Venus](nodes/implementations/venus.md) | ||
* [Full-nodes](nodes/full-nodes/README.md) | ||
* [Pre-requisites](nodes/full-nodes/pre-requisites.md) | ||
* [Basic setup](nodes/full-nodes/basic-setup.md) | ||
* [Node providers](nodes/full-nodes/node-providers.md) | ||
* [Lite-nodes](nodes/lite-nodes/README.md) | ||
* [Spin up a lite-node](nodes/lite-nodes/spin-up-a-lite-node.md) | ||
|
||
## Smart contracts | ||
|
||
* [Fundamentals](smart-contracts/fundamentals/README.md) | ||
* [The FVM](smart-contracts/fundamentals/the-fvm.md) | ||
* [Filecoin EVM runtime](smart-contracts/fundamentals/filecoin-evm-runtime.md) | ||
* [ERC-20 quickstart](smart-contracts/fundamentals/erc-20-quickstart.md) | ||
* [Roadmap](smart-contracts/fundamentals/roadmap.md) | ||
* [Support](smart-contracts/fundamentals/support.md) | ||
* [FAQs](smart-contracts/fundamentals/faqs.md) | ||
* [Filecoin EVM-runtime](smart-contracts/filecoin-evm-runtime/README.md) | ||
* [Actor types](smart-contracts/filecoin-evm-runtime/actor-types.md) | ||
* [Address types](smart-contracts/filecoin-evm-runtime/address-types.md) | ||
* [FILForwarder](smart-contracts/filecoin-evm-runtime/filforwarder.md) | ||
* [Difference with Ethereum](smart-contracts/filecoin-evm-runtime/difference-with-ethereum.md) | ||
* [How gas works](smart-contracts/filecoin-evm-runtime/how-gas-works.md) | ||
* [Precompiles](smart-contracts/filecoin-evm-runtime/precompiles.md) | ||
* [Developing contracts](smart-contracts/developing-contracts/README.md) | ||
* [Get test tokens](smart-contracts/developing-contracts/get-test-tokens.md) | ||
* [Remix](smart-contracts/developing-contracts/remix.md) | ||
* [Hardhat](smart-contracts/developing-contracts/hardhat.md) | ||
* [Foundry](smart-contracts/developing-contracts/foundry.md) | ||
* [Solidity libraries](smart-contracts/developing-contracts/solidity-libraries.md) | ||
* [Call built-in actors](smart-contracts/developing-contracts/call-built-in-actors.md) | ||
* [Filecoin.sol](smart-contracts/developing-contracts/filecoin.sol.md) | ||
* [Client contract tutorial](smart-contracts/developing-contracts/client-contract-tutorial.md) | ||
* [Verify a contract](smart-contracts/developing-contracts/verify-a-contract.md) | ||
* [Best practices](smart-contracts/developing-contracts/best-practices.md) | ||
* [Advanced](smart-contracts/advanced/README.md) | ||
* [Wrapped FIL](smart-contracts/advanced/wrapped-fil.md) | ||
* [Oracles](smart-contracts/advanced/oracles.md) | ||
* [Cross-chain bridges](smart-contracts/advanced/cross-chain-bridges.md) | ||
|
||
## Networks | ||
|
||
* [Mainnet](networks/mainnet/README.md) | ||
* [Explorers](networks/mainnet/explorers.md) | ||
* [RPCs](networks/mainnet/rpcs.md) | ||
* [Network performance](networks/mainnet/network-performance.md) | ||
* [Calibration](networks/calibration/README.md) | ||
* [Explorers](networks/calibration/explorers.md) | ||
* [RPCs](networks/calibration/rpcs.md) | ||
* [Spacenet](networks/spacenet/README.md) | ||
* [RPCs](networks/spacenet/rpcs.md) | ||
* [Get test tokens](networks/spacenet/get-test-tokens.md) | ||
* [Local testnet](networks/local-testnet/README.md) | ||
* [Get test tokens](networks/local-testnet/get-test-tokens.md) | ||
|
||
## Reference | ||
|
||
* [General](reference/general/README.md) | ||
* [Glossary](reference/general/glossary.md) | ||
* [Specifications](reference/general/specifications.md) | ||
* [Tools](reference/general/tools.md) | ||
* [Exchanges](reference/exchanges/README.md) | ||
* [Exchange integration](reference/exchanges/exchange-integration.md) | ||
* [Built-in actors](reference/built-in-actors/README.md) | ||
* [Protocol API](reference/built-in-actors/protocol-api.md) | ||
* [Filecoin.sol](reference/built-in-actors/filecoin.sol.md) | ||
* [JSON-RPC](reference/json-rpc/README.md) | ||
* [Auth](reference/json-rpc/auth.md) | ||
* [Beacon](reference/json-rpc/beacon.md) | ||
* [Chain](reference/json-rpc/chain.md) | ||
* [Client](reference/json-rpc/client.md) | ||
* [Create](reference/json-rpc/create.md) | ||
* [Eth](reference/json-rpc/eth.md) | ||
* [Gas](reference/json-rpc/gas.md) | ||
* [I](reference/json-rpc/i.md) | ||
* [Log](reference/json-rpc/log.md) | ||
* [Market](reference/json-rpc/market.md) | ||
* [Miner](reference/json-rpc/miner.md) | ||
* [Mpool](reference/json-rpc/mpool.md) | ||
* [Msig](reference/json-rpc/msig.md) | ||
* [Net](reference/json-rpc/net.md) | ||
* [Paych](reference/json-rpc/paych.md) | ||
* [State](reference/json-rpc/state.md) | ||
* [Sync](reference/json-rpc/sync.md) | ||
* [Wallet](reference/json-rpc/wallet.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
description: >- | ||
The section covers the assets you can find on the Filecoin network, along with | ||
how to securely manage and use them. | ||
--- | ||
|
||
# Assets | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
description: >- | ||
The most common way to get FIL is to use an exchange. You should be aware of | ||
some specific steps when trying to transfer FIL from an exchange to your | ||
wallet. | ||
--- | ||
|
||
# Get FIL | ||
|
||
## Exchanges | ||
|
||
A cryptocurrency exchange is a digital platform where users can buy, sell, and trade cryptocurrencies for other cryptocurrencies or traditional fiat currencies like USD, EUR, or JPY. | ||
|
||
Cryptocurrency exchanges provide a marketplace for users to trade their digital assets and are typically run by private companies that facilitate these transactions. These exchanges can differ in terms of fees, security protocols, and the variety of cryptocurrencies they support. | ||
|
||
Users can typically sign up for an account with a cryptocurrency exchange, deposit funds into their account, and then use those funds to purchase or sell cryptocurrencies at the current market price. Some exchanges offer advanced trading features like margin trading, stop-loss orders, and trading bots. | ||
|
||
It’s important to note that while cryptocurrency exchanges can offer convenience and liquidity for traders, they also come with risks like hacking and regulatory uncertainty. Therefore, users should take precautions to protect their funds and do their own research before using any particular exchange. | ||
|
||
### Supported exchanges | ||
|
||
There are many exchanges that allow users to buy, sell, and trade FIL. Websites like [coingecko.com](https://www.coingecko.com/) and [coinmarketcap.com](https://coinmarketcap.com/currencies/filecoin/markets/) keep track of which exchanges support which cryptocurrencies. You can use these lists to help decide which exchange to use. | ||
|
||
Once you have found an exchange you want to use, you will have to create an account with that exchange. Many exchanges have strict verification and Know-Your-Customer (KYC) processes in place, so it may take a few days to create your account. However, most large exchanges can verify your information in a few minutes. | ||
|
||
Purchasing cryptocurrency varies from exchange to exchange, but the process is usually something like this: | ||
|
||
1. Add funds to your exchange account in your local currency (USD, EUR, YEN, etc.). | ||
2. Exchange your local currency for FIL at a set price. | ||
|
||
### Address compatibility | ||
|
||
Some exchanges allow users to fund and withdraw FIL using any of the [Filecoin address type](../../smart-contracts/filecoin-evm-runtime/address-types.md). However, some exchanges only support one, or a handful, of the available address types. Most exchanges do not currently support [f410 addresses](../the-blockchain/addresses.md) . | ||
|
||
If your exchange does not yet support Filecoin Eth-style 0x addresses, you must create a wallet to _relay_ the funds through. Take a look at the [Transfer FIL page](transfer-fil.md) for details on how to transfer your funds safely. | ||
|
||
## Test FIL | ||
|
||
If you’re looking to get FIL to test your applications on a testnet like [Calibration](../../networks/calibration/) then check how to get test tokens! Test FIL is often referred to as `tFIL`. |
Oops, something went wrong.