codingpeasant / blocace

Blocace is a distributed document database powered by the blockchain technology.

---

Blocace is a distributed document database powered by the blockchain technology.

Note to Developers

• This is a prototype.
• The APIs are constantly evolving and designed to demonstrate types of functionality. Expect substantial changes before the release.

Install

Compile on Linux/macOS/Windows

Prerequisite: Go version: 1.12 or later; GCC 5.1 or later.

Windows may need to install GCC if missing before installing the dependencies. Linux may also need to install gcc using the corresponding package management tool, like yum install gcc on RedHat or alike. macOS may need to install Xcode Command Line Tools.

Build and run with Go Modules

git clone https://github.com/codingpeasant/blocace.git
cd blocace
export GO111MODULE=on # Go 1.12 and earlier
go get
go build -ldflags="-s -w -X main.version=0.0.6"
./blocace server

Download for Linux/macOS/Windows

If you'd like to try Blocace directly, please navigate to Releases and get the right binary for your OS/ARCH.

Docs

Checkout Blocace In 10 Minutes and Blocace APIs Reference

License

Blocace is licensed as Apache 2.0.

blocace's Issues

3rd-party authentication service support

Now Blocace has a proprietary authentication approach. We need to get rid of it (or extend it) and embrace widely used authentication protocols like LDAP/AD with an OAuth2 workflow. https://github.com/ory/hydra can be potentially used.

Use cache to temporarily store Account.ChallengeWord

The Account.ChallengeWord is persisted to DB right now and this doesn't support concurrent user authentication as the ChallengeWord can be overwritten by another client that tries to use the same account to authenticate.

A cache in memory should be introduced to store ChallengeWord for each account so that

• all the ChallengeWord can be kept for multiple clients
• /jwt requested ChallengeWord (whether success or failure) can be removed
• expired ChallengeWord can be automatically removed from the cache (TTL: 60 seconds)

Create a data access layer interface

Now Blocace primarily uses BoltDB for persisting blockchain information. We need to:

• Create an interface of the data access layer
• Create a data access layer implementation for BoltDB to get rid of the repetitive DB API calls

It's beneficial when we want to add middle-wares like compression and encryption.

Increase test coverage

As this repo is growing, more quality controls needs to kick in. Now the code coverage is almost 0. We need to add necessary unit test and integration test cases. Any tests cases contributions are welcome!

This issue will remain open before we can achieve a satisfying coverage.

Implement p2p cluster

Now Blocace only supports single node mode. We need to utilize libp2p and a consensus algorithm to support clustering.

Proposing blockchain forest structure to maximize transaction per second and minimizing network volumes instead of maintaining a single blockchain containing all the transactions.