Skip to content

Latest commit

 

History

History
185 lines (132 loc) · 7.44 KB

README.md

File metadata and controls

185 lines (132 loc) · 7.44 KB
Raw

xrptipbot.com

XRP Tip Bot (reddit, /u/xrptipbot) in PHP + NodeJS

Todo

This is ugly code, I know. It is, however, functioning very well, and running in a secure environment. There are some things on my personal wishlist for this repo, and I'll try to find/make the time to do this. Wish to help? Contact me @ reddit, /u/pepperew

Todo's:
  1. Dockerfile, to prepare an out of the box docker container + environment for the code to run, with nodejs, php, nginx, MySQL / MariaDB, etc.
  2. Get rid of the fixed paths (/data/ etc.)
  3. Make an installer (npm install, php composer, gen. template config file, generate reddit access token)
  4. Exception handling / logging

Note

This code needs refactoring, cleanup, etc. etc. - I know. However: I wrote this in two days ;) Will try to find some time.

Environment

This is just the backend, processing the reddit-messages, storing it in a MySQL DB and interacting with the XRP ledger (public Ripple server). The frontend of the XRP Tip Bot (https://www.xrptipbot.com) is written in Twig + HTML on the https://nodum.io platform. The frontend communcates over a VPN to the backend (this repo) using HTTP POST JSON messages.

Live messaging to the client (webbrowser) is provided by https://ably.io.

Security

Communcation with reddit: OAUTH API, secrets in config.php, communcates server to server (HTTPS).

Internal communication from the NodeJS scripts to the MySQL DB: internal (localhost) HTTP calls with JSON data.

Installation (dev)

This code runs in a Ubuntu 16.04 (CLI) environment with NodeJS 8 and PHP 7 installed. This repo should live in /data/ (the paths are currently hardcoded). The PHP folder is symlinked to the HTTP webroot, and a crontab is present to run all the scripts:

### REDDIT ###

# Fetch Reddit Messages and insert into table message
* *     * * *   cd /data/cli/reddit; php fetch_pbs.php > log/fetch_pbs.txt
* *     * * *   sleep 30; cd /data/cli/reddit; php fetch_pbs.php >> log/fetch_pbs.txt

# Fetch Reddit Comments at watched subreddits and insert into table message
* *     * * *   root    cd /data/cli/reddit; php fetch_comments.php > log/fetch_comments.txt
* *     * * *   root    sleep 10; cd /data/cli/reddit; php fetch_comments.php > log/fetch_comments.txt
* *     * * *   root    sleep 20; cd /data/cli/reddit; php fetch_comments.php > log/fetch_comments.txt
* *     * * *   root    sleep 30; cd /data/cli/reddit; php fetch_comments.php > log/fetch_comments.txt
* *     * * *   root    sleep 40; cd /data/cli/reddit; php fetch_comments.php > log/fetch_comments.txt
* *     * * *   root    sleep 50; cd /data/cli/reddit; php fetch_comments.php > log/fetch_comments.txt

# Process Reddit message and reply
* *     * * *   cd /data/cli/reddit; php process_messages.php > log/process_messages.txt
* *     * * *   sleep 30; cd /data/cli/reddit; php process_messages.php >> log/process_messages.txt

### TWITTER ###

# Fetch Twitter Messages and insert into table message
* *     * * *   cd /data/cli/twitter; php fetch_pbs.php > log/fetch_pbs.txt
* *     * * *   sleep 30; cd /data/cli/twitter; php fetch_pbs.php >> log/fetch_pbs.txt

# Process Twitter message and reply
* *     * * *   cd /data/cli/twitter; php process_messages.php > log/process_messages.txt
* *     * * *   sleep 30; cd /data/cli/twitter; php process_messages.php >> log/process_messages.txt

# Process withdrawals
* *     * * *   cd /data/cli/process_withdraw; php processOne.php > log_processOne.txt
* *     * * *   sleep 30; cd /data/cli/process_withdraw; php processOne.php >> log_processOne.txt
* *     * * *   sleep 30; cd /data/cli/process_withdraw; php processOneEscrow.php >> log_processOneEscrow.txt

There is one script that runs all the time in the background; nodejs/storetransactions/run.sh (in /data/). This bash script runs app.js from the storetransactions folder. This script monitors the XRP ledger for incoming transactions, and stores the transactions in the database for further processing.

The database (MySQL / MariaDB) (db: tipbot) schema is present in install/db.sql.

The config is in config.php and should look like this:

<?php

    // For push messaging on transaction sent/received
    $__ABLY_CREDENTIAL = 'xxxx:yyyyyyy';

    $__MAX_TIP_AMOUNT  = 5;

    // Monitor for transactions (to DB)
    $__WALLETS = [
        'rXXXXX',
        'rYYYYY',
        'rQQQQQ',
    ];

    // Allow sending funds
    $__SECRETS = [
        'rXXXXX' => 'sQQQQQQ',
        'rYYYYY' => 'sZZZZZZZ',
    ];

    // User & Pass of MySQL database, db 'tipbot', schema: install/db.sql
    $__DATABASE = [
        'user' => 'XXXXX',
        'pass' => 'YYYYYYYY',
    ];

    $__REDDIT_USER_AGENT = 'Cli:XrpTipBotScript:v0.0.1 (by /u/xrptipbot)';

    $__REDDIT_CLIENT_CONFIG = [
        'clientId'      => 'XXXX',
        'clientSecret'  => 'YYYYYY',
        'redirectUri'   => 'https://www.xrptipbot.com/script',
        'userAgent'     => $__REDDIT_USER_AGENT,
        'scopes'        => [ 'identity', 'edit', 'history', 'mysubreddits', 'privatemessages', 'read', 'report', 'save', 'submit' ]
    ];

    $__TWITTER_CLIENT_CONFIG = [
        'consumerKey'        => 'xxxxx',
        'consumerSecret'     => 'yyyyy',
        'accessToken'        => 'qqqqqq',
        'accessTokenSecret'  => 'xxxxxx'
    ];

    $__TWILIO_CLIENT_CONFIG = [
        'project' => 'xxx',
        'key'     => 'yyy',
        'to'      => '+31xx',
        'from'    => '+32xx'
    ];
    
    $__DISCORD_BOT = [
        'secret' => 'xxxx',
    ];

    if(isset($_SERVER["PWD"]) && isset($_SERVER["TERM"]) && $_SERVER["_"]){
        // CLI called
        $configJson = json_encode([
            'wallets' => $__WALLETS,
            'secrets' => array_flip($__SECRETS),
            'twilio'  => $__TWILIO_CLIENT_CONFIG,
            'discord' => $__DISCORD_BOT,
        ]);
        file_put_contents('/data/.config.js', $configJson);
    }

To generate the config file for NodeJS based on the PHP config, execute config.php on the commandline.

To retrieve the access token for the app, no fancy installation script is present at the moment. Edit cli/reddit/_bootstrap.php to (step by step) retrieve some info and exit. The last step (3) retrieves the token from the reddit API and stores it in a json-file.

Run composer to install the PHP deps. in cli/reddit.

Run npm install in the nodejs/* folders to install the NPM modules.

Application Flow

Deposits

  • nodejs/storetransactions/app.js watches wallets
  • All transactions (history + live stream) are posted to the php/_storetransaction.php script
  • A crontab scans the DB for all new transactions. If it's a deposit it processed the deposit with php/__processdeposit.php
  • If the deposit is processed, a PB to the user is sent using cli/reddit/send_pb.php

Tips

  • A crontab checks the unread messages to /u/xrptipbot (that includes mentions) using cli/reddit/fetch_pbs.php
  • Another crontab checks all messages in the DB that aren't processed, and decides what to do: cli/reddit/process_messages.php
  • A reaction will be sent to the reddit-user using cli/reddit/send_reaction.php
  • If it's a valid tip, the balance of the sending and receiving user are updated in the DB

Withdrawals

  • A request to withdraw funds is stored in the database. cli/process_withdraw/processOne.php runs every 30 seconds, and processes one withdrawal.
  • nodejs/sendwithdrawreq/app.js runs to process the withdrawal by sending a TX to the XRP Ledger using ripple-lib.

Contributing

Fork, change, commit, send pull request. More to come.