Skip to content

MarcooRo/birdWatchingBot

Repository files navigation

Kanaria & Singular BOT

Multi bot tools to observe the Kanaria and Singular markets in real-time

What does it do

The BOTs takes live events from the Kasuma blockchain, filtering remark::2.0.0 for Kanaria and, for the moment, remerk::1.0.0 for Singular. Each BOT has its own menu to create a filter and customize your feeds.

We have improved the experience by dividing the output into separate channels. In this way, it's possible to personalize your feed and keep it more organized. We developed this BOTs for Telegram and Discord. Here you can find the live BOTs

Installation & Usage

Note: NodeJS 16+ is required and also NPM

git clone https://github.com/MarcooRo/birdWatchingBot.git

Both the root and the folder must be initialized npm i

The project uses docker to separate all the components that make up the project, the infrastructure is composed of containers: bot1-0-0, bot2-0-0 for the user interface on telegram. mysql1, mysql2 for user management and set filters. Two database monitoring services: phphmyadmin1, phpmyadmin2. Each container is running with forever.js to make sure to perform an auto rebuild of the script in case of malfunction

List of commands

1. docker-compose build Create images from docker-compose.yml
2. docker-compose up -d mysql1-0-0 mysql2-0-0 phpmyadmin1 phpmyadmin2
3. Import SQL databases via control panel phpmyadmin
4. docker-compose up -d bot1-0-0 bot 2-0-0 Activate telegram bots and interfaces
5. docker-compose up nodejs RUN del watcher events

You will need to add your own tokens for Telegrame and Discord chats

The tools is divided into several part:

  • catchEvents.js
    Observe the blocks on the Kusama network and intercept the Remerks, and filter the versions.
  • scriptUtils folder
    In this folder the Remark is analyzed and the message is generated.
  • discordBot.js, discordUtils & manageDiscord.js
    They manage the creation and sending of the message to the discord bots. Discord message are. Discord messages are sent in embed. They are always divided into remerk 1.0.0 and 2.0.0. a channel for the list and one for the buy.
  • dumpbuild folder
    We have built a script that destructures the dump provided by the official remerk documentation, here, this creates subfolders categorized, at the moment by type of object and all bird, in the folder thare is JSON file with the fields that you want to keep from the original metadata. In the script you can select which fields to keep. At the moment we hold: thumb, slot and metadata. This is just an example, we use the SOLT to determine what type of object is in the remark. We did this to create a much lighter file that is easy to pars.

Possibility

We have split the scripts so that the bots are highly customizable, we invite you to visit the page of Remerk Spec where to find all the events that can be intercepted in the block, such as MINT and the others. Have fun!

Note

At the moment only Kanaria use the 2.0.0 protocol, when there is integration in Singular this bot will be updated to allow the correct sending of the message.

About

Kanaria and Singular Bird Watching Bot

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages