Automagically buy BTC, ETH or LTC on Coinbase, based on user defined thresholds.
Tradingbots: Typically, bots perform tasks that are both simple and structurally repetitive, at a much higher rate than would be possible for a human alone.
For node module management Coinboss uses Yarn over NPM.
To install yarn globally on your machine please check Installing Yarn.
After that you can install all service dependencies with:
yarn
You need a Coinbase.com API key with the following permissions:
wallet:accounts:read
wallet:buys:create
wallet:payment-methods:read
wallet:sells:create
- Setup project
This is a convenience method to install a pre-made Serverless Service locally by downloading the Github repo and unzipping it. Services are listed below.
serverless install -u https://github.com/nicka/coinboss
- Install development dependencies
yarn
- Setup environment
cp .env.example .env.dev
-
Update configuration within
.env.dev
-
Deploy your Coinboss
STAGE="dev" yarn run deploy
Coinboss is triggered based on CloudWatch alarms. The thresholds can be found within the projects .env.example.
For testing Coinboss uses Jest, for more information please check their documentation.
NOTE: To update Jest snapshots supply
-- -u
to any of the test commands.
Running the tests
yarn run test
Code coverage
In order to inspect code coverage:
open coverage/lcov-report/index.html
Local API Gateway simulation.
STAGE="dev" yarn run serve
Create build artifacts.
STAGE="dev" yarn run build
Deploy build artifacts.
STAGE="dev" yarn run deploy
- Increase test coverage
- Add support for percentage thresholds
- Add more currency alarms