Reference

This section contains links and reference materials for Filecoin.

• Reference
  • About Filecoin
  • Filecoin Network
    • Node implementations
    • Networks
  • Network status
    • Block explorers
    • Chain data and monitoring
    • Storage/Deals status
  • Storage Web Applications
  • APIs & Developer tools
    • Storage APIs for app builders
    • Message signing tools
    • Wallet-related tools
    • Node Infrastructure & APIs
      • Scalable endpoint hosting
      • Filecoin API clients
      • Storage provider index API
    • Data prep tools
    • Databases using IPFS and Filecoin
    • Other developer tools
  • Mining
    • Miner reputation systems
    • Miner tools
    • Storage client and miner programs
    • Retrieval Market resources (WIP experiments)
  • Wallets
    • Wallets (audited)
    • Other wallets
  • Ecosystem galleries
    • Hackathons
    • Grants and accelerators

About Filecoin

• Filecoin Specification (opens new window) - technical specification for Filecoin protocol and its associated subsystems.
• Engineering Filecoin's Economy (opens new window) - the design of Filecoin's economic incentives.
• Filecoin Slack (opens new window) - announcement, open discussion of Filecoin.
• Filecoin Community (opens new window) - Filecoin community and ecosystem channels, discussion forums, and more.
• Filecoin 中文社区 (opens new window) - resources and forum for the Chinese community, maintained and moderated by CoinSummer & PL.
• Filecoin Youtube channel (opens new window) - various Filecoin workshops, conference talks, and meetups.
• Filecoin Core Dev meeting (opens new window) - technical meeting to bring together various Filecoin teams for protocol development.

Filecoin Network

Node implementations

• Lotus (opens new window) - Recommended most advanced implementation and security audited (opens new window), in GoLang.
• Other implementations (In progress):
  • Fuhon (opens new window) - C++
  • Forest (opens new window) - Rust
  • Venus (opens new window) (formerly go-filecoin) - also in GoLang (Venus Docs (opens new window)).

• Lotus Docker Hub Images (unofficial):
  • glif/lotus (opens new window)
  • ognots/lotus (opens new window) - mainnet-v1.830-rc1
  • textile/lotus (opens new window) - latest

Networks

Network.filecoin.io (opens new window) - lists all current Filecoin networks and related informations.

• Mainnet
  • Mainnet network status (opens new window) - reports the status and incident of the Filecoin Mainnet.
• Calibration
  • Largest testnet which support 32GiB and 64GiB sectors.
  • See #fil-net-calibration-announce (opens new window) for announcements and #fil-net-calibration-discuss (opens new window) for questions and discussion in Filecoin Slack (opens new window).
• Local Devnet
  • Run a Local Devnet using Lotus (opens new window).
  • Textile's Local Devnet (opens new window) - uses a mocked sector builder for faster deal confirmation and it is for storage app prototyping.
  • Ganache for Filecoin (opens new window) - local network to support development with Filecoin by various ways.

Network status

Tools to check status and details of the network and chain.

Block explorers

• Filfox.info (opens new window) - Mainnet
• Filscan (opens new window) - Mainnet & Calibration
• Filscout (opens new window) - Mainnet & Calibration
• 1475 Filecoin Explorer (opens new window) - Mainnet
• Grafana (opens new window) - Network Statistics Dashboard
  • Mainnet (opens new window)
  • Calibration (opens new window)

Chain data and monitoring

• Filstats.io (opens new window) - node telemetry monitoring - add your node!
• Sentinel Project (opens new window) - Filecoin Network Monitoring and Analysis System behind Grafana.
• Statediff (opens new window) - exploration and comparing changes to Filecoin state.
• "Orphan blocks" (not an official protocol term in the Filecoin Spec) - Blocks without rewards that were either mined on the wrong tipset that the network fails to deliver in time, or a mix resulting in reorgs.
  • Orphan Block Statistics (opens new window)
  • Orphan Block List (opens new window)

Storage/Deals status

• Filecoin Storage Stats (opens new window) - general storage summary of Filecoin.
• filecoin.tools (opens new window) - check your CID's storage deal status.
• file.app (opens new window) - Filecoin miner analytics.
• Deals list at Filfox.io (opens new window)

Storage Web Applications

Web-based applications that store your data on Filecoin. No command-line or coding experience required.

• ChainSafe Files (opens new window) - Dropbox-style UI, login with Oauth or general Metamask
• Estuary (opens new window) allows uploading and storing content on the Filecoin network directly from your browser.
• File.video (opens new window) and Voodfy (opens new window) - video hosting with decentralized transcoding from LivePeer
• Slate.host (opens new window) - a storage application on Filecoin to collect, organize, and link files together and share them, listed on Product Hunt here (opens new window) on Github at filecoin-project/slate (opens new window)
• Starling Framework for Data Integrity (opens new window)
  • to securely capture, store and verify human history
  • learn more at starlinglab.org/78days (opens new window) or the Filecoin blog interview (opens new window)
• Starling Storage API + CLI (opens new window) - RESTful API + Node.js CLI that simplifies storing data for preservation use cases. Visit Starlingstorage.io (opens new window) to learn more.

APIs & Developer tools

Developer tools, API clients & storing service that developers can use to build on Filecoin.

Storage APIs for app builders

• Estuary (opens new window) - a simple IPFS node that integrates a minimal Filecoin Client Library. It allows anyone with public data to store and retrieve it using a few API calls. It is for infrastructure operators, developers and Filecoin users.
  • Estuary Docs (opens new window) - more documentations on how to use Estuary and its API.
  • Estuary WWW (opens new window) - A simple website application example that can commun any Estuary node.
• NFT.storage (opens new window) - beta service from Protocol Labs for storing off-chain NFT data on IPFS and Filecoin.
• Powergate (opens new window) - infrastructure tool that leverages running an IPFS node alongside a Filecoin node using IPFS for hot storage and retrieval, plus storage deal helpers and other convenience features for app developers.
  • POW CLI (opens new window) - The CLI runs on the Powergate API.
  • Powergate JS Client (opens new window) - JS client built on top of Powergate gRPC APIs.
  • Powergate Go Client (opens new window) - Build your Go app using Powergate APIs with Go client.
• Slate.host API (opens new window) - Slate.host (opens new window) has a Developer API that allows you upload files with an account.
• Space SDK from Fleek (opens new window) - JS library backed by Fleek's hosted services using IPFS, Textile, Filecoin, Ethereum, etc.
• Textile Buckets (opens new window) - simplified cloud bucket store on IPFS with archive to Filecoin option using Powergate under the hood, hosted by Textile.

Message signing tools

• Filecoin JS Signer (opens new window) - a pure Typescript / Javascript library for creating, signing and broadcasting messages to send FIL, and interact with Filecoin's built-in actors (like Payment Channel and Multisig), among other utility functions.
  • Also available on npm at @blitslabs/filecoin-js-signer (opens new window)
  • Currently used by the Filecoin Loans project for its mobile wallet (written in React Native) and creating Payment Channels.
• Filecoin Signing Tools (opens new window) - a pure JS or Rust / WASM / JSONRPC library for creating signed messages apart from a Filecoin node.
  • Also available on npm at @zondax/filecoin-signing-tools (opens new window)
  • Supports Ledger hardware device integration (opens new window) and payment channels (paych demo example (opens new window)). Multisig support will be added soon.
  • For an open source example of how to use it see the Glif web wallet (opens new window) on Github.

Wallet-related tools

• Filecoin Rosetta API Proxy (opens new window) - Rosetta (opens new window) is an API standard created by Coinbase for a consistent interface to many chains for wallets and exchanges.
• FilSnap MetaMask Plugin (opens new window) - MetaMask has a new plugin system called Snaps (opens new window) currently still in beta that developers can try out.

Node Infrastructure & APIs

NOTE: making deep calls into the chain’s history may take some time to return and it may be more efficient to use a chain database (e.g. used by block explorers) that stores the chain’s history and is optimized for queries.

• Glif nodes (opens new window) and Infura (opens new window) - Hosted endpoints to Filecoin mainnet and testnet.
  • These endpoints support read-only calls and MPoolPush() for sending signed transactions to the network (which can be signed using the Message signing tools).
• Lotus JSON-RPC API (opens new window) - Lotus offers the full feature set of its capabilities through API.
  • lotus API Postman sample (opens new window) - (shows sample wallet calls only)

Scalable endpoint hosting

For running a node cluster of load balanced Lotus JSON RPC API endpoints.

• Filecoin-chart (opens new window) (k8 cluster) - Helm chart for hosting Lotus Node clients.

Filecoin API clients

• Filecoin.js (opens new window) (outdated) - higher-level JS library for interacting with Lotus via JSON-RPC API.
• js-lotus-client (opens new window) - lower-level JS wrapper for basic parsing of the Lotus JSON RPC API.
• lotus-json-rpc-provider (opens new window) (outdated) - wraps the Lotus API in TypeScript.

Storage provider index API

• Figment - Miner Reputation System API (opens new window) - reputation score based on miner storage capacity, sector faults and deal slashes.
• Filrep.io API (opens new window) - A suite of RESTFul JSON endpoints to discover the best storage provider to make deals with.
• Textile Miner Index (opens new window) - API and CLI to find miners by price, observed deals, speed from North American nodes.

Data prep tools

• CAR files (opens new window) - automatically used on Lotus import for less than 32 and 64 GiB, Filecoin archive format serialized from DAGs, see also offline deals for large datasets (opens new window).
• go-graphsplit (opens new window) - by FileDrive chunks a larger single DAG for storage in default Filecoin 32 and 64 GiB sector sizes.
• IPFS (opens new window) - you can use ipfs add with an IPFS node then add the CID from a Filecoin node (opens new window).

Databases using IPFS and Filecoin

• OrbitDB (opens new window) - decentralized multi-party database on IPFS with multi-party syncing with topic pubsub and CRDTs. Filecoin integration using Powergate available at orbit-db-powergate-io (opens new window).
• ThreadsDB (opens new window) - decentralized multi-party database for user-siloed data on IPFS with Filecoin integration coming soon.

Other developer tools

• js-rle (opens new window) - RLE+ Spec. Learn about rle-bitset-encoding in the Filecoin Spec (opens new window).
• Truffle for Filecoin (opens new window) - building apps to preserve files to IPFS and Filecoin.

Mining

Miner reputation systems

• Codefi Storage (opens new window) - view the Filecoin Storage Market, miner info, asking price, completed deals.
• FIL Swan (opens new window) - for offline deals, miner info, prices, offline deal acceptance.
• Filrep.io (opens new window) - Index of online miners and their pricing, ranked by power and reputation score.
• Textile Miner Index (opens new window) - API and CLI to find miners by price, observed deals, speed from North American nodes.
• SpaceGap (opens new window) - shows storage proof deadlines and sector details for the top 50 miners.

Miner tools

• Bidbot (opens new window) - A Filecoin Network sidecar to bid in storage deal auctions.
• Filgas.io (opens new window) - real-time Filecoin mining gas queries.
• Hactar (opens new window) - analytics for your Filecoin miner node.
• Lotus Farcaster (opens new window) - Prometheus, Grafana and Python monitoring dashboard.
• Mining Benchmarks (opens new window): Hardware performance comparisons from the Filecoin community.

Storage client and miner programs

• Filecoin Plus Verified Data Program (opens new window)
  • incentivizes valuable data stored on Filecoin with a social trust network for verified data
  • Clients can apply to Notaries to receive DataCap and incentivize Miners at 10x to their quality-adjusted power, increasing probability of block rewards
• Filecoin Discover Store (opens new window)
  • where Storage miners can buy hard drives with offline data filled with valuable datasets - (blog post (opens new window))
• Miner X Fellowship (opens new window) - to support and learn from small-to-medium miner experience.
• Slingshot Competition (opens new window)

Retrieval Market resources (WIP experiments)

The Retrieval Market is in early development; research and development teams are actively exploring improvements.

• Browser Retrieval Client (opens new window)
• Browser Retrieval Client using WASM (opens new window)
• ChainSafe's Full Node Retrieval Client (opens new window)
• Decentralized Data Delivery Markets - Open Problems and RFCs (opens new window)
• July 2020 Retrieval Markets Workshop (opens new window) - list of Sessions (opens new window)

Wallets

Tools for sending and receiving FIL tokens.

Wallets (audited)

Wallets that have conducted third-party audits of their open-source code by a reputable security auditor are recommended below.

• Glif web wallet (opens new window) - recommended - security-audited web wallet that supports sending & receiving FIL, also integrated with Ledger hardware (uses the audited filecoin-signing-tools library (opens new window) below).
• Ledger HW wallet in Filecoin Docs (opens new window) - recommended - Ledger Live does not have Filecoin support yet, but Ledger hardware wallets can be used with the Glif.io or a Filecoin Lotus node.
• FoxWallet (opens new window) - recommended - by the team behind Filfox, a security-audited (opens new window) mobile wallet that supports sending & receiving FIL, also provides useful data and mining information.

Other wallets

The wallets below support FIL tokens. We recommend verifying that these have been security audited by reputable 3rd party auditors and that the codebase is open sourced. Please evaluate these wallets for security risks at your own discretion, as an insecure wallet may lead to loss of funds.

• BlitsWallet (opens new window) - by the team behind Filecoin.loans
• Cobo (opens new window)
• MathWallet (opens new window)
• ImToken (opens new window)
• TrustWallet (opens new window)
  • Open-source (opens new window) on Github, official mobile wallet of Binance

Ecosystem galleries

• Awesome Filecoin (opens new window) - awesome projects on Filecoin
• Community Projects Showcase (opens new window) - updated news about ecosystem projects
• Filecoin Ecosystem Grid (opens new window)

Hackathons

• Upcoming Hackathons (opens new window)
  • Keep a lookout for upcoming hackathons!
  • All winners are eligible for Next Steps Grants (opens new window) after the Hackathon!

Grants and accelerators

• Filecoin Dev Grants (opens new window) - ongoing monthly dev grant program to support open source projects + new RFPs (opens new window) on Filecoin
  • funded by the Filecoin Foundation (opens new window)
• Accelerators
  • Apollo - Gitcoin x Filecoin (opens new window) - from Summer 2020
  • Filecoin Frontier Accelerator with LongHash (opens new window) - applications closed Nov 15, 2020
  • Filecoin Launchpad Accelerator with ConsenSys Tachyon (opens new window) - from Fall 2020
  • Huobi-Filecoin Incubation Center (opens new window)