schmrdty/toker
SHA256
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
erc20 +/-
4 commits 1 branch 0 tags 29 KiB
JavaScript 100%
Find a file
schmrdty 504cb2013d Update README.md
2024-06-24 01:25:42 +00:00
blanktokenTracker.js TokenTracker 2024-06-23 23:30:14 +00:00
LICENSE Initial commit 2024-06-18 22:25:49 +00:00
README.md Update README.md 2024-06-24 01:25:42 +00:00

README.md

tokeR

erc20 +/-

Farcaster Token Notification Bot

Overview

The tokeRbot designed to monitor cryptocurrency tokens and notify users when the price of a specified token moves above or below a customizable % threshold from its current value. This bot integrates with the Airstack API for real-time token prices and the Warpcast API for sending notifications.

Features

  • Feature pending further development * Monitors multiple tokens simultaneously *
  • Sends notifications when a token's price changes by x%.
  • Allows users to set a maximum threshold for notifications.
  • Rate limits to prevent spamming (no more than 1 notification per token per 61 seconds).

Setup

  1. Clone the repository to your local machine.
  2. Install the required dependencies with npm install.
  3. Set up your Airstack and Warpcast API keys in the .env file.
  4. Run the bot using node bot.js.

Measuring Capabilities

  • Accuracy: The bot's ability to detect a 15% price change is measured by comparing the detected changes against historical price data.
  • Timeliness: Notifications should be sent within 1 minute of the price change detection. This can be measured by timestamping the price change event and the notification sent event.
  • Rate Limiting: Ensure that the bot adheres to the rate limit by reviewing logs to confirm that no more than one notification per token per minute is sent.

Troubleshooting

  • API Connectivity Issues: If the bot fails to retrieve token prices, check the 0x API status and ensure API key/s are valid.
  • Notification Delivery Failures: Should notifications fail to send, verify your Warpcast API integration/Neynar and check for any service outages. *Should notifications fail to send, create a log.
  • Incorrect Price Alerts: If the bot sends incorrect alerts, review the price change detection logic for any calculation errors.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your proposed changes.

Support

If you encounter any issues or have questions, please file an issue on the Forgejo repository issue tracker.

License

This project is licensed under the MIT License - see the LICENSE file for details.