{"id":24017571,"url":"https://github.com/piraces/whale-irc-bot","last_synced_at":"2026-05-15T11:02:04.208Z","repository":{"id":93937792,"uuid":"378404849","full_name":"piraces/whale-irc-bot","owner":"piraces","description":"IRC Bot that sends alerts to the channel ##crypto-whale-alerts in irc.libera.chat from whale-alert.io about large and unusual transactions in crypto exchanges","archived":false,"fork":false,"pushed_at":"2021-06-25T17:13:17.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-08T09:45:09.718Z","etag":null,"topics":["bot","cryptocurrencies","cryptocurrency-exchanges","deno","irc","irc-bot"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/piraces.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-19T12:17:15.000Z","updated_at":"2021-09-10T10:52:16.000Z","dependencies_parsed_at":"2023-04-01T06:18:52.369Z","dependency_job_id":null,"html_url":"https://github.com/piraces/whale-irc-bot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piraces%2Fwhale-irc-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piraces%2Fwhale-irc-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piraces%2Fwhale-irc-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piraces%2Fwhale-irc-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/piraces","download_url":"https://codeload.github.com/piraces/whale-irc-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240746841,"owners_count":19850993,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","cryptocurrencies","cryptocurrency-exchanges","deno","irc","irc-bot"],"created_at":"2025-01-08T09:41:32.989Z","updated_at":"2026-05-15T11:02:04.128Z","avatar_url":"https://github.com/piraces.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🐋 Whale IRC Bot\nIRC Bot that sends alerts to the channel #crypto-whale-alerts in irc.libera.chat from whale-alert.io about large and unusual transactions in crypto exchanges.\n\n# Features\n\n- 💬 Most IRC servers support.\n- 👥 NickServ identification.\n- 👷‍♂️ Completly configurable.\n- 🔄 Auto reconnect.\n- 🐳 Ready to deploy to Docker.\n\n\n# How does it work\n\nThis bot makes requests to the [Whale Alert](https://whale-alert.io) API ([docs here](https://docs.whale-alert.io/#introduction)), in order to retrieve the latest transactions in a predefined interval which reaches or surpass the limit defined in the bot configuration. When a transaction meets this requirements, an alert is sent to the configured IRC channel in the following format:\n\n```text\n\u003cNumberOfTokens\u003e #\u003cCryptoTicket\u003e (\u003cPrice in USD\u003e) transferred from #\u003cSource\u003e to #\u003cDestination\u003e.\n```\n\nFor example:\n```text\n10,000 #ETH (22,366,904 USD) transferred from #Coinbase to #Binance\n```\n\nIn order to achieve this, **the bot needs the following**:\n\n- A [Whale Alert API token](https://whale-alert.io/signup).\n- An IRC Server and port to connect to.\n- A nick for the bot.\n- A channel to connect to.\n- (Optional) A NickServ password in order to identify the bot in the server.\n\n\n# Configuring the bot\n\nThe repository contains an example configuration file named `bot.config.sample.json` which contains basic sample configuration for the bot.\n\nIn order to bootstrap our bot, we need to copy that file to a one named `bot.config.json`.\n\nThen we can proceed to configure it. Take a look to the table below to see all the configuration values explained:\n\n| Key              | Type    | Default value         | Details                                                                                                                          |\n|------------------|---------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------|\n| ircServer        | string  | irc.libera.chat       | IRC server hostname to connect to                                                                                                |\n| ircPort          | number  | 6667                  | IRC server port (usually 6667)                                                                                                   |\n| botNick          | string  | whaleCryptoBot        | The nick for your bot to take                                                                                                    |\n| channel          | string  | ##crypto-whale-alerts | The channel where the bot will post messages to                                                                                  |\n| enableNickServ   | boolean | false                 | Enable NickServ identification or not                                                                                            |\n| nickServPassword | string  | nickservpass          | If `enableNickServ` is true, the pass to use when identificating                                                                 |\n| whaleAlertApiKey | string  | apiKey                | The API Key obtained from Whale-alert.io                                                                                         |\n| minValue         | number  | 5000000               | Minimum value in USD to consider as an alert. All transactions equal or greater than this value will be reported to the channel. |\n| pollInterval     | number  | 60000                 | Number of milliseconds to wait between API calls (default value is the recommended for free accounts)                            |\n| rateLimit     | number  | 2500                 | Number of milliseconds to wait between sent messages (default value is the recommended for rate-limit)                            |\n\n\n# Running the bot\n\nMake sure to have [Deno]() installed or use the Docker image instead.\n\n**Using your shell and Deno:**\n\n```shell\ndeno run --allow-net --allow-read --allow-write main.ts\n```\n\n**Using docker:**\n\n```shell\ndocker build -t whale-irc-bot .\ndocker run -d whale-irc-bot\n```\n\n# Dependencies\n\n- [deno.land/x/irc@v0.4.1](https://deno.land/x/irc@v0.4.1)\n- [deno.land/std@0.99.0/log](https://deno.land/std@0.99.0/log)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiraces%2Fwhale-irc-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpiraces%2Fwhale-irc-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiraces%2Fwhale-irc-bot/lists"}