/hivemind

Community consensus layer for the Steem blockchain.

Primary LanguagePythonMIT LicenseMIT

Hivemind

hivemind is an off-chain consensus layer for Steem communities and API server for social features like feeds and follows.

Dev Environment

Make sure you have Python 3.5+, Docker and MySQL installed on your local machine.

Setting up MySQL

First, we need to start a MySQL server (in Docker).

make mysql

Then we need to set DATABASE_URL environment variable, for example:

set DATABASE_URL 'mysql://root:root_password@mysql:3306/testdb'

I defined mysql in /etc/hosts such that it links to mysql docker container IP.

Lastly we invoke the ensure-schema command to create MySQL tables.

hive db ensure-schema --yes

Indexing the blockchain

We can index the blockchain using cli as well.

hive indexer from-steemd

If we have a .json.lst file containing first X blocks, we can index from that (its much faster).

hive indexer from-file /path/to/blocks.json.lst

Starting API Server

hive server dev-server --port 1234

Production Env

BYO MySQL deployment (ie. Amazon RDS). Hive is deployed as Docker container (see Dockerfile).

Environment Variables

Variable Default
ENVIRONMENT DEV
LOG_LEVEL INFO
HTTP_SERVER_PORT 8080
HTTP_SERVER_STATS_PORT 9191
DATABASE_URL

Services

Please see /service.

Other

Documentation

Generate documentation.

cd docs
make html

Then open docs/_build in browser.

Spec

Community Spec Draft

License

MIT