Home

Filecoin Community Resources

This page lists resources, tooling, and other community projects to aid in installing, using & building on Filecoin.

• 1. Join a Network
• 2. Network Status
• 3. APIs & Developer Tools
• 4. Mining
• 5. Wallets

About the Protocol

• Filecoin Specification
• Filecoin Docs
• Engineering Filecoin's Economy - see page 12 for Fil+ & sector info
• Filecoin Plus / Fil+ - verified data earns 10x in rewards

1. Join a Network

Resources for setting up Filecoin and connecting to a network.

• network.filecoin.io - network overview
• mainnet status

Node Implementations

• Lotus - Recommended - most advanced implementation and security audited
• Other implementations in progress:
  • Fuhon
  • Forest
  • Venus (formerly go-filecoin)

Testnet

• See Join the Network in Filecoin Docs for more info

Shared Devnets

• network.filecoin.io
  • list of all current Filecoin networks including devnets optimized for testing
  • Calibration is the largest testnet
  • Nerpa is a devnet for developers with smaller 512MB sectors that can seal in ~25 min - #fil-net-nerpa-announce in Filecoin Slack
  • Butterfly is a devnet for protocol engineers testing latest code and may be reset at any time - #fil-net-butterfly-announce in Filecoin Slack

Local Devnets (on your local machine)

• See Run a Local Devnet in Filecoin Docs
• Or Textile's Local Devnet with mocked sectorbuilder
  • has a mocked sectorbuilder for faster API usage and deal confirmation

Containers & Virtualization

• Docker Hub images:
  • https://hub.docker.com/r/openworklabs/lotus
  • https://hub.docker.com/r/ognots/lotus
  • https://hub.docker.com/r/textile/lotus

Multi-Node endpoint hosting scripts

• For running a node cluster of Lotus JSON RPC API endpoints
• https://github.com/openworklabs/filecoin-chart (k8 cluster)
• https://github.com/openworklabs/filecoin-docker

Filecoin RPC Proxy Cache

• filecoin-rpc-proxy - cache any JSON RPC API request to reduce request load

2. Network Status

Tools and resources to check status & details for the network & chain.

Network Stats

• Network Stats Dashboard - uses Grafana + InfluxDB

Block Explorers

• Filfox
• Filscan.io
• Filscout.io
• Filplorer
• 1475 Explorer

--

• Calibration Testnet Filscan

Chain Data & Monitoring

• SpaceGap
  • shows storage proof deadlines and sector details for the top 50 miners
• Filstats.com - general statistics about deals
• Filstats.io - node telemetry monitoring - add your node!
• Sentinel & Sentinel-Visor - large network historical data monitoring infrastructure
• Slate-Sentinel API
• GraphQL Explorer for Filecoin Chain - see Docs tab for query info
• Statediff
  • Uses filecoin-project/statediff to explore and compare changes to Filecoin chain state
  • Also see keyko-io/filecoin-verifier-tools for a JS tool for the state HAMT
• Gasoline
  • Shows the distribution of gas and Tx types in average from the last epochs

Chain Ingest Tools

• Sentinel-Visor - has custom hooks into the VM of Lotus for parsing chain data
• https://www.npmjs.com/package/filecoin-chaininfo - deals only with data extraction and it can be used by any application
• More links coming soon

Storage Status

• Filecoin Storage Stats
• Filstats.com - general statistics about deals
• CID Checker at filecoin.tools
  • Shows information about stored CIDs
• Deals list at filfox.io

3. APIs & Developer Tools

API Clients

• filecoin.js - actively developed higher-level JS library for Lotus JSON RPC API with many convenience features
• js-lotus-client - lower-level JS library fo Lotus JSON RPC API
• lotus JSON RPC Postman sample - shows wallet calls only
• filecoin-ruby - interface to lotus Filecoin in Ruby

Additional Tools

• Powergate - leverages IPFS alongside Filecoin for hot storage and retrieval + storage deal helpers deals and more - Recommended

Developer Tools

• js-rle - RLE+ Spec. Learn about rle-bitset-encoding in the Filecoin Spec

REST Clients

• Starling Storage REST API + CLI - RESTful API + Node.js CLI that simplifies storing data for preservation use cases - visit Starlingstorage.io

Storage Client Applications

• Slate
  • a file-sharing client and network to collect, organize, and link files together
  • listed on Product Hunt here

Ecosystem Projects

Awesome Filecoin - awesome projects on Filecoin

4. Mining

Dashboards and Reputation Systems

• SpaceGap
  • shows storage proof deadlines and sector details for the top 50 miners
• Codefi Miner Reputation System - best miners, their asking price, deals they’ve completed

Miner Tools

• Filgas.io - real-time Filecoin mining gas queries
• Mining Benchmarks
• Lotus Farcaster - Prometheus, Grafana and Python monitoring dashboard
• Hactar - analytics for your Filecoin miner node

Storage Client / Miner Programs

• Slingshot Competition - currently in Phase 2 to store these curated datasets

• Filecoin Plus Verified Data Program - to incentivize useful storage on Filecoin with a social trust network for verified data. Clients can apply to Notaries to receive DataCap, which can be used to incentivize Miners at 10x to their quality adjusted power - increasing their probability of winning block rewards.

• Filecoin Discover Store

  • where Storage miners can buy hard drives with offline data filled with important datasets - (blog post)

• Miner X Fellowship - to support and learn from small-to-medium miner experience

5. Wallets

Tools for sending and receiving FIL tokens.

Wallets

• Ledger HW wallet in Filecoin Docs - the Ledger Live UI does not have Filecoin support yet but Ledger HW can be used with these Docs + either the Glif web wallet at Glif.io or a Lotus node.

• Glif web wallet - security-audited web wallet that supports sending & receiving FIL, also integrated with a Ledger HW device (uses filecoin-signing-tools lib below)

• Filecoin has been added to Trust Wallet

• FilSnap MetaMask Plugin - MetaMask has a new plugin system called Snaps currently still in beta that developers can try out

• A Filecoin lightwallet example is in the Filecoin.js library

Remote Signing Tools

• Filecoin Signing Tools - a pure JS or Rust/WASM/JSONRPC library for creating signed messages apart from a node
  • (Also available on npm at @zondax/filecoin-signing-tools)
  • Supports Ledger hardware device integration and payment channels (paych demo example)