2019-08-02 04:26:11 +00:00
|
|
|
# project lotus - 莲
|
|
|
|
|
|
2019-08-02 05:30:05 +00:00
|
|
|
Lotus is an experimental implementation of the Filecoin Distributed Storage
|
|
|
|
|
Network. For more details, check out the
|
|
|
|
|
[spec](https://github.com/filecoin-project/spec).
|
|
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
All work is tracked via issues, and an attempt to keep an up to date view on
|
|
|
|
|
this exists in the [lotus testnet github project
|
|
|
|
|
board](https://github.com/filecoin-project/go-lotus/projects/1).
|
|
|
|
|
|
2019-08-02 04:26:11 +00:00
|
|
|
|
|
|
|
|
## Building
|
|
|
|
|
|
|
|
|
|
*Dependencies:*
|
|
|
|
|
- go1.12 or higher
|
|
|
|
|
- rust (version?)
|
|
|
|
|
- git
|
|
|
|
|
- bzr (some go dependency needs this)
|
|
|
|
|
|
|
|
|
|
*Building:*
|
|
|
|
|
```
|
|
|
|
|
$ make
|
|
|
|
|
```
|
|
|
|
|
|
2019-08-02 05:30:05 +00:00
|
|
|
## Architecture
|
|
|
|
|
Lotus is architected modularly, and aims to keep clean api boundaries between
|
|
|
|
|
everything, even if they are in the same process. Notably, the 'lotus full node'
|
|
|
|
|
software, and the 'lotus storage miner' software are two separate programs.
|
|
|
|
|
|
|
|
|
|
The lotus storage miner is intended to be run on the machine that manages a
|
|
|
|
|
single storage miner instance, and is meant to communicate with the full node
|
|
|
|
|
via the websockets api for all of its chain interaction needs. This way, a
|
|
|
|
|
mining operation may easily run one or many storage miners, connected to one or
|
|
|
|
|
many full node instances.
|
|
|
|
|
|
|
|
|
|
## Notable Modules
|
|
|
|
|
|
|
|
|
|
### Api
|
|
|
|
|
The systems api is defined in here. The rpc maps directly to the api defined
|
|
|
|
|
here using the jsonrpc package in `lib/jsonrpc`.
|
|
|
|
|
|
|
|
|
|
### Chain/Types
|
|
|
|
|
Implementation of data structures used by Filecoin and their serializations.
|
|
|
|
|
|
|
|
|
|
### Chain/Store
|
|
|
|
|
The chainstore manages all local chain state, including block headers,
|
|
|
|
|
messages, and state.
|
|
|
|
|
|
|
|
|
|
### Chain/State
|
|
|
|
|
A package for dealing with the filecoin state tree. Wraps the
|
|
|
|
|
[HAMT](https://github.com/ipfs/go-hamt-ipld).
|
|
|
|
|
|
|
|
|
|
### Chain/Actors
|
|
|
|
|
Implementations of the builtin Filecoin network actors.
|
|
|
|
|
|
|
|
|
|
### Chain/Vm
|
|
|
|
|
The filecoin state machine 'vm'. Implemented here are utilities to invoke
|
|
|
|
|
filecoin actor methods.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Miner
|
|
|
|
|
The block producer logic. This package interfaces with the full node through
|
|
|
|
|
the api, despite currently being implented in the same process (very likely to
|
|
|
|
|
be extracted as its own separate process in the near future).
|
|
|
|
|
|
|
|
|
|
### Storage
|
|
|
|
|
The storage miner logic. This package also interfaces with the full node
|
|
|
|
|
through a subset of the api. This code is used to implement the
|
|
|
|
|
lotus-storage-miner process.
|
|
|
|
|
|
2019-08-02 05:35:37 +00:00
|
|
|
## Pond
|
|
|
|
|
Pond is a graphical testbed for lotus. It can be used to spin up nodes, connect
|
|
|
|
|
them in a given topology, start them mining, and observe how they function over
|
|
|
|
|
time.
|
|
|
|
|
|
|
|
|
|
To try it out, run `make pond`, then run the `pond` binary that gets created.
|
|
|
|
|
Once it is running, visit localhost:2222 in your browser.
|
|
|
|
|
|
2019-08-02 06:26:24 +00:00
|
|
|
## Tracing
|
|
|
|
|
Lotus has tracing built into many of its internals. To view the traces, first
|
|
|
|
|
[download jaeger](https://www.jaegertracing.io/download/) (Choose the
|
|
|
|
|
'all-in-one' binary). Then run it somewhere, start up the lotus daemon, and
|
|
|
|
|
open up localhost:16686 in your browser.
|
|
|
|
|
|
|
|
|
|
For more details, see [this document](./docs/tracing.md).
|
|
|
|
|
|
2019-08-02 04:26:11 +00:00
|
|
|
## License
|
|
|
|
|
MIT + Apache
|
