@ubiqsmart/sparrow-shokku-provider v1.0.1
Note: Until further notice, this project is in heavy development mode (don't expect everything to work out of the box, also the documentation is lacking and many more)!
Description
Shokku provides you with a complete way of having your own infrastructure for Ubiq and Ethereum (soon) nodes (pretty much like Infura does), exposing them with a nice JSON API, allowing you to have full control on the whole process.
If you want, you can try the live service hosted in https://api.shokku.com (to be deployed soon).
Motivation
If you're asking why the existence of this project, I recommend you to read this Medium article (to be released soon) where I explain the reasoning in more detail.
Development Setup
Please see DEVELOPMENT for more information.
Deployment
Please see DEPLOYMENT for more details and options.
TODO
Towards releasing version 1.0.0, there are several tasks that need attention. We're using Waffle.io to track everything.
A couple of tasks that would be awesome to have help would be:
- Configure services like travis, waffle...
- Finish properly tests.
- Increase code coverage.
- Finish Docker DigitalOcean provisioner.
- Finish Docker Vultr provisioner.
- Add complete support to IPFS nodes.
- Provide a better way to backup blockchain data (in case of Gubiq instances) to spin up quickly more instances without downloading the whole blockchain.
- Create Terraform provisioner for setting up a Kubernetes cluster tailored for Shokku.
- Create a set of Helm recipes for spining Shokku inside a Kubernetes cluster.
- Add support to Ethereum nodes. Improve API to allow having Ubiq and Ethereum options (or to spin one or another depending on needs).
- Add rate limiting usage to the API.
- Add permissions to use the API with proper JWT sessions (have a better control access).
- Improve session API stickiness with Traefik (at least for Docker Swarm).
- Prepare the code to scale and support heavy load.
Contributing
Please see CONTRIBUTING for details.
Backers
These are super hero members that have contributed in a meaningful way to the project (with a donation, with code, with documentation, with coffee...):
- Don't be shy and help! You'r name will be here ;)
Donations
Donations are very important to us as it will help to keep this project moving! ❤❤❤
Ubiq Address: 0x83B07FC91522e64Dac623a49Da5967d433aD1a4B | View address on ubiqscan
Acknowledgements
- Thanks to Pablo (@ataliano) for creating this awesome logo!
Support
- Join the #shokku channel in our public Discord group. Sign up at https://discord.gg/HF6vEGF.
- File an issue on GitHub (double check that there's no duplicates).
- Tweet to or DM @aldoborrero.
License
Everything is licensed with the Apache License 2.0 (Apache).
Please see License File for more information.