This is the Filecoin Specification, a repository that contains documents, code, models, and diagrams that constitute the specification of the Filecoin Protocol. This repository is the singular source of truth for the Filecoin Protocol. All implementations of the Filecoin Protocol should match and comply with the descriptions, interfaces, code, and models defined in this specification.
https://spec.filecoin.io is the user-friendly website rendering, which we recommend for reading this repository. The website is updated automatically with every merge to master.
git clone https://github.com/filecoin-project/specs.git
yarn installYou need to have Go and bzr installed (required to build lotus)
brew install go bzryarn start
# open http://localhost:1313/ in the browserWe have a markdown linter set up to check for common errors like incorrectly nested headers. It runs in CI and you can run it locally with:
npm test
content/algorithms/crypto/randomness.md
15:39-15:46 warning Found reference to undefined definition no-undefined-references remark-lint
54:24-54:31 warning Found reference to undefined definition no-undefined-references remark-lint
âš 2 warningsProblem - Site fails to build with an error that states it faled to download modules on macos
Error: failed to download modules: go command failed ...
Solution - run npm run clean - the cache dir hugo uses can get corrupted, and this resets it. See #1048
External modules should be added as Hugo Modules
You can find examples in the config.toml
[module]
[[module.imports]]
path = "github.com/filecoin-project/specs-actors"
[[module.imports.mounts]]
source = "."
target = "content/externals/specs-actors"
targetshould ALWAYS use the foldercontent/externals
This makes files from external repos available for Hugo rendering and allows for linking to up-to-date files that are directly pulled from other repositories.
The configuration above gives the following information:
path: Repository's URL without protocol.source: Folder from the repository referenced in thepathto be mounted into the local Hugo filesystem.target: Folder wheresourcewill be mounted locally, this should follow this structurecontent/modules/<target value>.
Example: if you want to link/embed to the file xyz.go that lives in https://github.com/filecoin-project/specs-actors/actors/xyz-folder/xyz.go, from within a markdown file then with the above configuration the src for shortcodes or markdown image syntax would be:
{{<embed src="/externals/specs-actors/actors/xyz-folder/xyz.go" lang="go">}}
The first foward slash is important it means the path is relative to the content folder.
These modules can be updated with
hugo mod get -uor to a specific version with
hugo mod get github.com/filecoin-project/[email protected]The first heading should be an atx style heading # Head and should refer to the overall title of the document.
---
title: Storage Power Actor
---
# Storage Power Actor
## Header for a section in this document
Some text
### Sub header for the a nested section
## Another top level headerDescription for all the available frontmatter properties
<!-- Page Title to be used in the navigation -->
title: Libraries
<!-- Small description for html metadata, if not present the first couple of paragraphs will be used instead -->
description: Libraries used from Filecoin
<!-- This will be used to order the ToC, navigation and any other listings of pages -->
weight: 3
<!-- This will make a page section collapse in the navigation -->
bookCollapseSection: true
<!-- This will hidden the page from the navigation -->
bookhidden: true
<!-- This is used in the dashboard to describe the importance of the page content -->
dashboardWeight: 2
<!-- This is used in the dashboard to describe the state of the page content options are "missing", "incorrect", "wip", "reliable", "stable" or "n/a" -->
dashboardState: stable
<!-- This is used in the dashboard to describe if the theory of the page has been audited, options are "missing", "wip", "done" or "n/a" -->
dashboardAudit: wip
<!-- When dashboardAudit is stable we should have a report url -->
dashboardAuditURL: https://url.to.the.report
<!-- The date that the report at dashboardAuditURL was completed -->
dashboardAuditDate: "2020-08-01"
<!-- This is used in the dashboard to describe if the page content has compliance tests, options are 0 or numbers of tests -->
dashboardTests: 0Code fences should always have a lang, if you don't know or don't care just use text
```text
Random plain text context ...
``
To add an image or diagram you just need to use normal markdown syntax.
For diagrams you can use the source files and the pipelines will handle converting that to svg, we support mermaid and dot source files.
# relative to the markdown file
# relative to the content folder
When there's no title we use the alt text as title
These links use "portable links" just like relref so you can just give it the name of the file and it will fetch the correct relative link and title for the <a href="/relative/path" title="page title"> automatically.
You can override the <a> title by passing a second string in the link definition.
Note: When using anchors the title can't be fetched automatically.
[](storage_power_consensus)
# <a href="/systems/filecoin_blockchain/storage_power_consensus" title="Storage Power Consensus">Storage Power Consensus</a>
[Storage Power](storage_power_consensus "Title to override the page original title")
# <a href="/systems/filecoin_blockchain/storage_power_consensus" title="Title to override the page original title">Storage Power</a>
[Tickets](storage_power_consensus#the-ticket-chain-and-drawing-randomness "The Ticket chain and drawing randomness")
# <a href="/systems/filecoin_blockchain/storage_power_consensus#the-ticket-chain-and-drawing-randomness" title="The Ticket chain and drawing randomness">Tickets</a>
# src relative to the page
{{<embed src="piece_store.id" lang="go">}}
# src relative to content folder
{{<embed src="/systems/piece_store.id" lang="go">}}
# can just embed a markdown file
{{<embed src="section.md" markdown="true">}}
# can embed symbols from Go files
# extracts comments and symbol body
{{<embed src="/externals/go-data-transfer/types.go" lang="go" symbol="Channel">}}The listing shortcode creates tables from externals sources, supports Go struct.
# src relative to the page
{{<listing src="piece_store.go" symbol="Channel">}}
# src relative to content folder
{{<listing src="/systems/piece_store.go" symbol="Channel">}}
# src can also be from the externals repos
{{<listing src="/externals/go-data-transfer/types.go" symbol="Channel">}}Inline mermaid syntax rendering
{{< mermaid >}}
graph TD
A[Christmas] -->|Get money| B(Go shopping)
B --> C{Let me think}
C -->|One| D[Laptop]
C -->|Two| E[iPhone]
C -->|Three| F[fa:fa-car Car]
{{</ mermaid >}}<!-- info|warning|danger -->
{{< hint info >}}
**Markdown content**
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
{{< /hint >}}For short snippets of math text you can just use the {{<katex>}} shortcode, but if you need to write lots of math in a page you can just use math-mode and avoid writting the katex shortcode everywhere.
Parses math typesetting with KaTeX
Check this example example
Some syntax like
\_can't go through HUGO markdown parser and for that reason we need to wrap math text with code blocks, code fendes or the shortcode{{<plain>}}. See examples below.
---
title: Math Mode
math-mode: true
---Math text needs to be wrapped to avoid Hugo's Markdown parser. When wrapping defs or any math block that doesn't need to be rendered the recommended option is to use the shortcode {{<plain hidden}} with the hidden argument.
{{<plain hidden>}}
$$
\gdef\createporepbatch{\textsf{create_porep_batch}}
\gdef\GrothProof{\textsf{Groth16Proof}}
\gdef\Groth{\textsf{Groth16}}
\gdef\GrothEvaluationKey{\textsf{Groth16EvaluationKey}}
\gdef\GrothVerificationKey{\textsf{Groth16VerificationKey}}
{{</plain>}}The index of a node in a `$\BinTree$` layer `$l$`. The leftmost node in a tree has `$\index_l = 0$`.```text
$\overline{\underline{\Function \BinTree\dot\createproof(c: \NodeIndex) \rightarrow \BinTreeProof_c}}$
$\line{1}{\bi}{\leaf: \Safe = \BinTree\dot\leaves[c]}$
$\line{2}{\bi}{\root: \Safe = \BinTree\dot\root}$
$\line{3}{\bi}{\path: \BinPathElement^{[\BinTreeDepth]}= [\ ]}$
$\line{4}{\bi}{\for l \in [\BinTreeDepth]:}$
$\line{5}{\bi}{\quad \index_l: [\len(\BinTree\dot\layer_l)] = c \gg l}$
$\line{6}{\bi}{\quad \missing: \Bit = \index_l \AND 1}$
$\line{7}{\bi}{\quad \sibling: \Safe = \if \missing = 0:}$
$\quad\quad\quad \BinTree\dot\layer_l[\index_l + 1]$
$\quad\quad\thin \else:$
$\quad\quad\quad \BinTree\dot\layer_l[\index_l - 1]$
$\line{8}{\bi}{\quad \path\dot\push(\BinPathElement \thin \{\ \sibling, \thin \missing\ \} \thin )}$
$\line{9}{\bi}{\return \BinTreeProof_c \thin \{\ \leaf, \thin \root, \thin \path\ \}}$
```