Giter Site home page Giter Site logo

idena-companion's Introduction

Idena Companion

This Telegram bot provides a simple interface to manage and monitor an Idena mining node. With this bot, you can check the status of your node, view your balance, mining rewards, and start/stop the mining process directly via Telegram commands.

Prerequisites

  • Node.js (version 16.x or higher)
  • npm (Node Package Manager)
  • A Telegram bot created via BotFather on Telegram
  • A CoinMarketCap API key
  • A server or local environment with an Idena node installed and configured

Installation

  1. Clone this repository on your server or local machine hosting the Idena node
  2. Install project dependencies: npm install
  3. Adapt variables in bot.js file:
  • const token = 'TOKEN_TELEGRAM_BOT_HERE'; with the Telegram bot token created by Botfather
  • const whitelistedUserIds = [TELEGRAM_USER_ID_HERE]; with your Telegram user ID
  • const walletAddress = 'WALLET_ADDRESS_HERE'; with your Idena wallet address
  • 'X-CMC_PRO_API_KEY': 'COINMARKETCAP_APIKEY_HERE', with your CoinMarketCap API key
  1. Launch the NodeJS project: node bot.js

Commandes

  • /help - Displays the list of available commands
  • /status - Checking bot operation
  • /balance - Displays the current wallet balance
  • /rewards - Shows mining rewards
  • /node top - Displays current node status
  • /node start - Starts the mining node
  • /node stop - Stops the mining node

bot.js

The opperation linked to bot.js is a set of API calls linked to the wallet and Idena rewards. If you're not interested in the part linked to the management of the mining node, you can install this bot on any machine with an Internet connection.

nodeCommands.js

This file contains the monitoring and control operations for the Idena mining node. It works OOB with nodes installed with the default configuration via the idena.site procedure. You're free to adapt the code if you've installed the node in another way.

idena-companion's People

Contributors

mrvrops avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.