Twitter-Tip is an open-source node.js Twitter bot for tipping with altcoins.
To install Twitter-Tip simply clone this repo and install dependencies:
git clone https://github.com/Crowndev/Twitter-Tip
cd Twitter-Tip
npm install
After installation proceed to the configuration.
Logging settings.
- file - file to log to. Set to
false
to disable logging to file.
JSON RPC API connection info.
- host - Daemon hostname(127.0.0.1 if hosted on the same machine)
- port - Daemon RPC port (by default 9341 for Crown)
- user - Daemon RPC username
- pass - Daemon RPC 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.
CRW
) - full_name - full coin's name (eg.
Crown
)
- username - Your twitter username that the bot is running on.
- consumer_key - Create an app on twitter to get your keys https://apps.twitter.com/
- consumer_secret - Create an app on twitter to get your keys https://apps.twitter.com/
- access_token - Create an app on twitter to get your keys https://apps.twitter.com/
- access_token_secret - Create an app on twitter to get your keys https://apps.twitter.com/
Every Twitter username has it's own account in your wallet. When tipping sending or withdrawing, bot checks if user is registered and identified with Twitter. If so, he moves the money from one account to another, or when withdrawing, transfers coins to other wallet.
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. ~/.crown/crown.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 twitter
or npm start
.
Commands are executed by messaging the bot on twitter.
Command | Arguments | Description |
---|---|---|
address |
displays address where you can send your funds to the tip bot | |
balance |
displays your current wallet balance | |
help |
displays configured help message (by default similiar to this one) | |
send |
<address> <amount> |
sends the specified amount of coins to the specified address |
tip |
<nick> <amount> |
sends the specified amount of coins to the specified nickname |
withdraw |
<address> |
withdraws your whole wallet balance to specified address |