twitterfork of unek node-tip-bot - Biersteker/Strikerbee/Gielbier
node-tip-bot-twitter is an open-source node.js twitter bot for tipping with altcoins.
It is forked off uneks IRC node-tip-bot (https://github.com/unek/node-tip-bot) It uses node-dogecoin for integration with your coin's JSON RPC API.
To install node-tip-bot simply clone this repo and install dependencies:
git clone https://github.com/Biersteker/node-tip-bot-twitter
cd node-tip-bot-twitter
npm install
After installation proceed to the configuration.
To configure, copy the config/config.sample.yml
file to config/config.yml
.
Create an application at dev.twitter.com and fill in your keys.
- **consumer_key: ''
- **consumer_secret: ''
- **access_token_key: ''
- **access_token_secret: ''
Logging settings.
- file - file to log to. Set to
false
to disable logging to file.
JSON RPC API connection info.
- host - JSON RPC API hostname
- port - API port (by default 22555 for dogecoin)
- user - API username
- pass - API password (keep that secure)
Basic coin settings.
- withdrawal_fee - fee charged on withdraw to cover up txfee, the rest goes to bot's wallet.
- min_withdraw - minimum amount of coins to withdraw
- min_confirmations - minimum amount of confirmations needed to tip/withdraw coins
- min_tip - minimum amount of coins to tip
- short_name - short coin's name (eg.
Đ
orDOGE
) - full_name - full coin's name (eg.
dogecoin
)
Before running the bot, you have to be running your coin daemon with JSON-RPC API enabled. To enable, add this to your coin daemon configuration file (eg. ~/.dogecoin/dogecoin.conf
):
server=1
daemon=1
rpcuser=<your username>
rpcpassword=<your super secret password>
rpcallowip=<your bot's ip address or just 127.0.0.1 if hosted on the same machine>
To run the bot simply use node bin/tipbot
or npm start
.
Commands are executed by placing skeinbot in a tweet.
Command | Arguments | Description |
---|---|---|
balance |
displays your current wallet balance | |
address |
displays address where you can send your funds to the tip bot | |
withdraw |
<address> |
withdraws your whole wallet balance to specified address |
tip |
<nick> <amount> |
sends the specified amount of coins to the specified nickname |
help |
displays configured help message (by default similiar to this one) | |
terms |
displays terms and conditions for using the tip bot |