README
¶
filecoin
Textile's Filecoin swiss army knife for developers
Join us on our public Slack channel for news, discussions, and status updates. Check out our blog for the latest posts and announcements.
Table of Contents
Usage
Warning This project is still pre-release and is only meant for testing.
Lotus (lotus)
See https://lotu.sh/. Required for client. Lotus is an implementation of the Filecoin Distributed Storage Network—we run the Lotus client to join the Filecoin Testnet.
Client (filcoin)
Note to developers—as of 1/25/2020, the main line of development for the filecoin client is happening in the asutula/cli branch.
# from the asutula/cli branch
go build -i -o filecoin exe/cli/main.go
chmod +x filecoin
Try filecoin --help.
Server
The server connects to Lotus and enables multiple modules, such as:
- Reputations module:
- Miners index: with on-chain and metadata information.
- Ask index: with an up-to-date information about available Storage Ask in the network.
- Slashing index: contains a history of all miner-slashes.
- Deals Module:
- Contain helper features for making and watching deals.
Prerequisites
Currently, the server needs the same dependencies as Lotus, so most probably they will be already installed if you run the server in dev mode (go run syntax). If that's not the case, see here.
Run in dev mode
The server can be run in dev mode with go run exe/server/main.go.
Run in docker mode
You can run the server in a Docker Compose enviroment with Prometheus and Grafana to have a health-monitoring for the server. To do so:
cd docker
make fresh
This will do whatever it takes to get all systems running:
localhost:3000: Grafana dashboard with anonymous setup. admin:foobar are admin credentials.localhost:9090: Prometheus enpoint.localhost:8888: Server Prometheus endpoint for metric scraping.localhost:8889: HTTP endpoint for current index values (index/miners,index/slashing,index/ask).
It's important to mention that the Docker Compose is run in host network mode, which is only supported in Linux. Eventually we'll include Lotus inside the compose file allowing for default network modes.
Test
For running tests: make test
Contributing
This project is a work in progress. As such, there's a few things you can do right now to help out:
- Ask questions! We'll try to help. Be sure to drop a note (on the above issue) if there is anything you'd like to work on and we'll update the issue to let others know. Also get in touch on Slack.
- Open issues, file issues, submit pull requests!
- Perform code reviews. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
- Take a look at the code. Contributions here that would be most helpful are top-level comments about how it should look based on your understanding. Again, the more eyes the better.
- Add tests. There can never be enough tests.
Before you get started, be sure to read our contributors guide and our contributor covenant code of conduct.
Changelog
Changelog is published to Releases.
Directories