mykeels / crypto-dip-alert

Software that tells you when the price of a crypto has gone down.

Crypto Dip Alert

Contains software for notifying the user, when the price of monitored cryptocurrency, drops past a set threshold.

Included Software

• NodeJS Script
• React Native App

Third Party API

• coincap.io

Custom Notifications

To add a Custom Notification Provider:

• Create a file entry in the scripts/nodejs-crypto-dip-alert/notifications folder ending with .notification.js
• Expose a notify function from module.exports
• The function is an async function so return a Promise
• Function has the following as parameters
  • coin
  • maxPrice
  • currentPrice
  • dipThreshold
• You can add configs to the .env file to determine if custom notif will be used.
• e.g. NOTIFY_YORUBA= NOTIFY_MAILGUN=

Example with Yoruba Notification

/**
 * posts a notification in the terminal console
 * @param {{symbol: string, priceUsd: number}} coin
 * @param {number} maxPrice
 * @param {number} currentPrice
 * @param {number} dipThreshold
 */
const notify = async (coin, maxPrice, currentPrice, dipThreshold) => {
  // early return if not set in env flags
  if (!process.env.NOTIFY_YORUBA || process.env.NOTIFY_YORUBA !== 'true') return;
  console.log(`[🚨🚨🚨💰🚨🚨🚨] Egbami, ye, 😢 ${coin.symbol} ti jona`);
  console.log(`[👀] Iwọn ti o pọju: ${maxPrice} `);
  console.log(`[👀] Ni in si: ${currentPrice} `);
  console.log(`[👀] Àbáwọlé: ${dipThreshold} `);
  // await here if you need to
  return Promise.resolve();
}

module.exports = notify;

crypto-dip-alert's Issues

A price dip alert should end the program

Bug Description

When a price dip alert is detected, chances are there will be more, leading to multiple alerts which are annoying.

Expected Behaviour

When a price dip is detected, the program should end.

Add Docs for adding Custom Notification

Contributors will want to add a custom notification scheme, and it should be straightforward from the docs on how to.

Investigate using Bollinger bands to automate the dip threshold

Description

Following discussions with @dumebi, it should be possible to automate the dip threshold price, using Bollinger bands.

This task is to find out how, and investigate the possibility of adding an option to the script to do this.

Alternatives Considered

Not doing it.

Additional context

• https://www.investopedia.com/articles/technical/102201.asp
• https://www.haasonline.com/bollinger-bands-and-cryptocurrency/

There should be a reference to Coincap.io for their API

Bug Description

The software in this repo depends on Coincap.io's free and open API. There is no mention of this, except in the code.

Expected Behaviour

It should be mentioned in the root README.

Add Termux Push Notification

Using this module, and a notifications/termux.notification.js file, we can get the script to display a Push Notification on the User's Android Device.

Make the Console Notifier enabled by default

Bug Description

The default configuration of the .env.sample has the console notifier disabled. It should be enabled by default for usability.

Network errors should not lead to failures

Bug Description

Currently, when an error is thrown due to network error, the program crashes.

Expected Behaviour

The program should be able to survive network errors.