/specs

The Filecoin protocol specification

Primary LanguageTeXOtherNOASSERTION

The Filecoin Spec

This repo contains the documents that comprise the Filecoin spec.

Every document in the top level of the repo is part of the official spec, and is canon. Documents in the 'drafts' folder are work-in-progress draft documents that aren't yet accepted as part of the spec, but exist here for discussion. Documents in the notes repo are various notes from different meetings and discussions.

Viewing the spec

Recommended: You can view the spec here.

You can also view it locally by using hugo.

> git submodule update --init --recursive
> hugo serve

If you're just browsing on GitHub, start with INTRO.md. But really, we recommend using the rendered output. It is much easier to read and use.

Updates process for specs

For info on how this spec changes, please see the process doc.

Questions on the spec?

Issues are a great way to ask these questions. In general, your issue is much more likely to get a response if you tag an interested party in your question. Some folks you may consider tagging (based on subject):

  • @whyrusleeping - node behavior, storage market, networking behavior, protocol stewardship (upgrading, versioning, governance, etc)
  • @dignifiedquire - PoSTs, proofs, data structures
  • @nicola - PoSTs, proofs
  • @pooja - protocol stewardship, project status
  • @henri - chain sync, consensus

Owners/ Points of Contact