Skip to content

DarthJahus/YuanTip-Telegram

Repository files navigation

YuanTip - Yuancoin tipbot for Telegram

Forked from PandaTip-Telegram, by @DarthJahus

Dependencies

  • apt-get install python-dev
  • apt-get install python-pip
  • pip install python-telegram-bot --upgrade
  • pip install requests
  • pip install emoji

In order to run the tip-bot, a Yuancoin-Core client is needed (yuancoind).

Configuration file

Create a config.json JSON file and set up the following parameters:

(sample)

{
	"telegram-token": "such:sicret-token",
	"telegram-botname": "YuanTip",
	"rpc-uri": "http://127.0.0.1:22444",
	"rpc-user": "suchuser",
	"rpc-psw": "suchpassword",
	"admins": [-0, 0],
	"spam_filter": [5, 60],
	"rain": {
	    "rain_queue_min_text_length": 10,
	    "rain_queue_min_words": 2,
	    "rain_queue_max_members": 30,
	    "rain_min_members": 5,
	    "rain_min_amount": 10
	}
}
  • telegram-token: Your bot's unique and secret token.

    Create a new bot by talking with @BotFather to get one.

  • rpc-uri: Address and port for the daemon.

    We do not advice to expose the port to external network. Please, be cautious. See next section to allow access for network addresses.

  • rpc-user, rpc-psw: Username and password for the daemon.

    You can set them in the iocoin.conf file (see next section).

  • admins: An array of administrators' Telegram UserID (as integers).

    You can send /user_id to @ContremaitreBot to know your UserID.

  • spam_filter: An array of two integers. The first value is the number of actions a user can perform in a period of time, the 2nd value defines that period of time in seconds.

    "spam_filter": [5, 60] means that users cannot perform more than 5 actions per minute.

Yuancoin daemon configuration

A yuancoin.conf file is needed in data directory.

(sample)

server=1
daemon=1
enableaccounts=1
staking=0
rpcuser=muchuser
rpcpassword=suchsicret
pid=yuancoind.pid
rpcallowip=127.0.0.1
rpcconnect=127.0.0.1

ToDo

  • Add service commands like /pause (pauses the bot for everyone), and maybe some commands to check the health of the daemon / wallet.
  • Populate strings.json
  • Add spam protection
  • Per-user language
  • Show fiat equivalent for balance
  • Add /price and /marketcap commands

Releases

No releases published

Packages

No packages published

Languages