mpos-eggdrop-tcl

MPOS Addon - TCL Script for Eggdrop IRC Bot

This script is an addon for the popular eggdrop Bot

and gets API Data from MPOS, a fantastic Webinterface for people running Cryptocoin Pools

FEATURES

• Easy Setup
• Support for multiple Pools
• Easy add Pools on the fly
• Enable/Disable Pools on the fly
• Output can set to separate channels for each coin
• Command ACL per Channel, Coin and Command
• All Pool related Settings can be set on the fly and without rehashing the Bot
• Show registered Pools on channel
• Advertise Pools in Channel at a given timeframe
• Get Userbalance
• Get User Workers
• Show Pool Stats
• Show Round Stats
• Show Last Block Info
• Checking for new Blocks on multiple Pools
• Advertise new Blocks to Channel
• Advertise Stats and Infos directly into the channel or send via private Message
• Show actual Coin Price
  • Coins-E
  • Vircurex
  • MintPal
• Show Coin Infos from choinchoose
• Create own Channel Output with predefined variables
• Create custom output per Coin
• Add users to known users, not using eggdrops userfile
• Only allow known users access to commands
• Only allow commands in defined channels

Requirements

• TCL (with JSON, SQLITE and TLS Support) sudo apt-get install libsqlite3-tcl tcl tcl-tls tcl8.5 tcl8.5-dev tcllib
• eggdrop IRC Bot
• MPOS with activated api and following functions
  • getdashboarddata
  • getuserworkers
  • getpoolstatus
  • getblocksfound
  • getuserstatus

INSTALL

• copy or rename config.dist.tcl to config.tcl and configure the settings to suit your need
• copy or rename output.dist.tcl to output.tcl and set the output to what you like
• add the following lines at the end of your eggdrop.conf and rehash or reload the bot

#
### Mininginfo
#
# basic scripts for settings and functions
#
source scripts/mininginfo/config.tcl
source scripts/mininginfo/basics.tcl
source scripts/mininginfo/bothelp.tcl
source scripts/mininginfo/output.tcl
source scripts/mininginfo/sqlite.tcl
#
# statistic scripts
#
source scripts/mininginfo/balance.tcl
source scripts/mininginfo/blockstats.tcl
source scripts/mininginfo/findblocks.tcl
source scripts/mininginfo/poolstats.tcl
source scripts/mininginfo/roundstats.tcl
source scripts/mininginfo/userstats.tcl
source scripts/mininginfo/workers.tcl
source scripts/mininginfo/income.tcl
#
# additional scripts - non mpos related
#
source scripts/mininginfo/pools.tcl
source scripts/mininginfo/users.tcl
source scripts/mininginfo/announce.tcl
source scripts/mininginfo/marketdata.tcl
source scripts/mininginfo/coinchoose.tcl
source scripts/mininginfo/notify.tcl

Managing Pools

Setting up multiple Pools is very easy

NOTE: Only Botowners can manage Pools. You have to be recognized by the bot, else you can't fire any of the commands. Be sure you have +n rights and a valid hostmask on the bots userfile.

You can add as many Pools as you want. Apiurl and Apikey are the Values from your MPOS installation.

Add a Pool

!addpool POOLURL COIN PAYOUTSYS FEE

e.g. !addpool http://yourpoolurl.tld BTC PPLNS 1

Add Apikey to Pool

/msg Botnick !apikey POOLURL APIKEY

e.g. /msg Poolbot !apikey http://yourpoolurl.tld 23984710298674309812734098712309471092743

Delete a Pool

!delpool POOLURL

e.g. !delpool http://yourpoolurl.tld

Activating a Pool for Block advertising

!blockfinder POOLURL enable

e.g. !blockfinder http://youpoolurl.tld enable
or   !blockfinder http://youpoolurl.tld true
or   !blockfinder http://youpoolurl.tld 1

Deactivating a Pool for Block advertising

!blockfinder POOLURL disable

e.g. !blockfinder http://youpoolurl.tld disable
or   !blockfinder http://youpoolurl.tld false
or   !blockfinder http://youpoolurl.tld 0

Setting different Channel Announces for specified Coin

NOTE: If not set for Coin, default Channels from Config file will be used. If you set different Channels to advertise the Coins, config file entries will only be used to recognize Commands typed in channel, not for Advertising Blockfinder Statistics.

Activating Announce for specified Coin to a specific Channel

e.g. !announce COIN #channel enable
or !announce COIN #channel true
or !announce COIN #channel 1

Deactivating Announce for specified Coin to a specific Channel (defaults from config File will be used)

e.g. !announce COIN #channel disable
or !announce COIN #channel false
or !announce COIN #channel 0

Deleting Announces from Database

!announce COIN #channel delete

Showing Announcement entries, will show all entries in Announce Table

!announce

Using Commands to query the Infos

Let's say the Value "BTC" is the Coin Name, used to query the Pool. So, if your Pool Coin is set to "BTC" you can query the bot with following command

!pool BTC

Querying userinfos works like that

!user BTC USERNAME

Commands ACL

If set command_protect "0" is set to 1 in config, You can set access rights for every command and coin in defined Channels. Only set Commands that should be protected in use. Here is a basic example.

set protected_commands {
	"hashrate"
	"diff"
	"pool"
	"block"
	"last"
	"user"
	"round"
	"worker"
	"balance"
	"coinchoose"
	"request"
	"price"
	"calc"
}

This is a Standard List of Commands that are protected. If you want specific Commands not to be protected, remove them from the list and they will trigger in every Channel. If you want to allow commands for a specific channel or coin, only activate them via !command.

Use one of the Values set in protected_commands as COMMANDNAME. If you use ALL instead of COMMANDNAME, all commands are allowed in specified channel.

e.g. !command COMMANDNAME COIN #channel enable
or !command COMMANDNAME COIN #channel true
or !command COMMANDNAME COIN #channel 1

You can simply disable the Command like this

e.g. !command COMMANDNAME COIN #channel disable
or !command COMMANDNAME COIN #channel false
or !command COMMANDNAME COIN #channel 0

Or delete them from Command list

e.g. !command COMMANDNAME COIN #channel delete

NOTE: Commands in protected_commands and not enabled via !command, will not work

Creating self defined Output

In output.tcl, there are predefined output variables. If you want to create your own message that will be posted to channel or by private message, you have to create your own text in the putput variables of each section. Now there are predefined standard messages, which can be used to post the relevant information. You can also use different messages based on coins you set in config.tcl

Standard Output looks like this and is predefined

set output_balance "Coin: \0032%balance_coin%\003\
| User: %balance_user%\
| Confirmed: %balance_confirmed%\
| Unconfirmed: %balance_unconfirmed%\
| Orphan: %balance_orphan%"

Customized output can look like this and is disabled by default

set output_balance_percoin(btc) "Coin: \0032%balance_coin%\003 - test output btc"
set output_balance_percoin(ltc) "Coin: \0032%balance_coin%\003 - test output ltc"

Customized output can be set for every coin added to config

USAGE

If you are on IRC and the Bot sits in your channel, type one of the following commands to communicate with the bot and get the output right in the channel. All this commands can be used as a direct message to the Bot. You only have to do /msg BOTNICK COMMAND. So nothing is visible in the channel.

Commands for all Users

!block COINNAME                        - Blockstats
!pool COINNAME                         - Pool Information
!round COINNAME                        - Round Information
!last COINNAME                         - Last found Block
!user COINNAME USER                    - User Information
!worker COINNAME USER                  - Workerinfo for user
!worker COINNAME USER active           - Users active Workers
!worker COINNAME USER inactive         - User inactive Workers
!balance COINNAME USER                 - User Wallet Balance
!hashrate COINNAME                     - Get actual Hashrate from Pool"
!diff COINNAME                         - Get actual Difficulty from Pool"
!calc YOURHASHRATE COINNAME            - Profit Calculator based on Hashrate"
!coinchoose COINNAME                   - Get actual Coininfo from Coinchoose
!price ALTCOIN BASECOIN EXCHANGE       - Get actual Coinprice
!request                               - Request Access to Bot Commands
?help                                  - This help text

Commands only for Bot Owners

!adduser IRCNICK                           - Adding User to userfile
!deluser IRCNICK                           - Deleting User from userfile
!pools                                     - Shows all registered Miningpools
!pools COINNAME                            - Shows registered Miningpools for specified coin
!addpool URL COIN PAYOUTSYS FEE            - Add Pool to Database
!delpool URL                               - Delete Pool from Database
!blockfinder URL enable/disable            - Activate/Deactivate Blockfinder announce in channel for specified pool
!announce COIN CHANNEL enable/disable      - Set Announce for specified Coin an Channel, else post in Standard set in config
!command COMMANDNAME COIN #channel enable  - Set ACL for Commands
/msg Botnick !apikey URL APIKEY            - Adds Apikey for specified host

Market Data

Using the scripts for actual Coinprice, require API Settings in config.tcl

Commands to query the actual Coinprice from the Market API's

!price ALTCOIN BASECOIN EXCHANGE

e.g. !price LTC BTC mintpal
or !price LTC BTC coins-e
or !price LTC BTC vircurex
or !price LTC BTC mintpal

This will show you the actual Litecoin Price in Bitcoins

Contributing

You can contribute to this project in different ways:

• Report outstanding issues and bugs by creating an [Issue][1]
• Suggest feature enhancements also via [Issues][1]