Reference implementation of the Filecoin protocol, written in Go
Go to file
Łukasz Magiera a6d0938385
Merge pull request #9 from filecoin-project/docs/architecture
readme: Add a section about architecture
2020-04-06 21:50:14 +02:00
.circleci one line gofmt 2020-04-01 16:22:32 -07:00
docs readme: Add a section about architecture 2020-04-06 21:44:45 +02:00
extern Update imports; Add build scripts 2020-03-28 00:21:36 +01:00
ffiwrapper Update imports; Add build scripts 2020-03-28 00:21:36 +01:00
mock nolint the existing linting errors 2020-04-01 16:18:20 -07:00
sealtasks Rename agvmgr+sealmgr to sectorstorage 2020-03-23 12:47:10 +01:00
stores Update imports; Add build scripts 2020-03-28 00:21:36 +01:00
tarutil nolint the existing linting errors 2020-04-01 16:18:20 -07:00
zerocomm Update imports; Add build scripts 2020-03-28 00:21:36 +01:00
.gitmodules Update imports; Add build scripts 2020-03-28 00:21:36 +01:00
go.mod Revert specs-actors version 2020-03-28 00:33:38 +01:00
go.sum Revert specs-actors version 2020-03-28 00:33:38 +01:00
LICENSE-APACHE Repo setup 2020-03-28 00:02:52 +01:00
LICENSE-MIT Repo setup 2020-03-28 00:02:52 +01:00
localworker.go Update imports; Add build scripts 2020-03-28 00:21:36 +01:00
manager.go Update imports; Add build scripts 2020-03-28 00:21:36 +01:00
parameters.json circleci: add shell config 2020-04-01 15:51:50 -07:00
README.md readme: Add a section about architecture 2020-04-06 21:44:45 +02:00
resources.go Merge pull request #7 from filecoin-project/chores/address-pr-nit 2020-04-02 01:56:33 +02:00
roprov.go Update imports; Add build scripts 2020-03-28 00:21:36 +01:00
sched.go Update imports; Add build scripts 2020-03-28 00:21:36 +01:00
stats.go sectorstorage: Untangle from lotus deps 2020-03-27 22:35:33 +01:00

sector-storage

CircleCI standard-readme compliant

a concrete implementation of the specs-storage interface

The sector-storage project provides a implementation-nonspecific reference implementation of the specs-storage interface.

Architecture

high-level architecture

Manager

Manages is the top-level piece of the storage system gluing all the other pieces together. It also implements scheduling logic.

package stores

This package implements the sector storage subsystem. Fundamentally the storage is divided into paths, each path has it's UUID, and stores a set of sector 'files'. There are currently 3 types of sector files - unsealed, sealed, and cache.

Paths can be shared between nodes by sharing the underlying filesystem.

stores.Local

The Local store implements SectorProvider for paths mounted in the local filesystem. Paths can be shared between nodes, and support shared filesystems such as NFS.

stores.Local implements all native filesystem-related operations

stores.Remote

The Remote store extends Local store, handles fetching sector files into a local store if needed, and handles removing sectors from non-local stores.

stores.Index

The Index is a singleton holding metadata about storage paths, and a mapping of sector files to paths

LocalWorker

LocalWorker implements the Worker interface with ffiwrapper.Sealer and a store.Store instance

License

The Filecoin Project is dual-licensed under Apache 2.0 and MIT terms: