accountTransactions.js

var winston = require('winston'),
  moment    = require('moment'),
  _         = require('lodash'),
  tools     = require('../utils');
  
  
/**
 *  accountTransactions returns transactions in which an account sent or received an amount.
 * 
 *  max returned results : 500;
 * 
 *  expects params to have:
 *  {
 *    account: //ripple address of the account to query
 *    startTime: (any momentjs-readable date), // optional, defaults to 30 days before endTime
 *    endTime: (any momentjs-readable date), // optional, defaults to now
 *    descending: true/false, // optional, defaults to true
 *    limit  : limit the number of responses, ignored if time increment is set or reduce is true
 *    offset : offset by n transactions for pagination 
 *    format : 'json', 'csv'   // optional
 *    
 *  }
 * 

 curl -H "Content-Type: application/json" -X POST -d '{
      "startTime" : "jan 1, 2014 10:00 am",
      "endTime"   : "jan 10, 2015 10:00 am",
      "account"   : "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
      "format"    : "json"
      
    }' http://localhost:5993/api/accountTransactions
    
 curl -H "Content-Type: application/json" -X POST -d '{
      "startTime" : "jan 1, 2014 10:00 am",
      "endTime"   : "jan 10, 2015 10:00 am",
      "account"   : "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
      "format"    : "csv"
      
    }' http://localhost:5993/api/accountTransactions
    
 curl -H "Content-Type: application/json" -X POST -d '{
      "startTime"  : "jan 1, 2014 10:00 am",
      "endTime"    : "jan 10, 2015 10:00 am",
      "account"    : "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
      "limit"      :  10,
      "descending" : true,
      "format"     : "csv"
      
    }' http://localhost:5993/api/accountTransactions
    
    
 * 
 */

function accountTransactions(params, callback, unlimit) {

  var account = params.account,
    limit     = params.limit  ? parseInt(params.limit, 10)  : 0,
    offset    = params.offset ? parseInt(params.offset, 10) : 0,
    maxLimit  = unlimit ? Infinity : 500,
    viewOpts  = {};

  if (!account) return callback("please provide a valid ripple account");
  if (!limit || limit>maxLimit) limit = maxLimit === Infinity ? null : maxLimit;
  
  //Parse start and end times
  var range = tools.parseTimeRange(params.startTime, params.endTime, params.descending);
  
  if (range.error)  return callback(range.error);  
  if (!range.end)   range.end   = moment.utc();
  if (!range.start) range.start = moment.utc(range.end).subtract(30, "days");
  
  // set startkey and endkey for couchdb query
  viewOpts.startkey = [account].concat(range.start.toArray().slice(0,6));
  viewOpts.endkey   = [account].concat(range.end.toArray().slice(0,6));
  
  if (params.descending) viewOpts.descending = true;
  
  viewOpts.reduce = false; //view has no reduce function
  
  if (viewOpts.reduce===false) {
    if (limit  && !isNaN(limit))  viewOpts.limit = limit;
    if (offset && !isNaN(offset)) viewOpts.skip  = offset;
  }
  
  viewOpts.stale = "ok"; //dont wait for updates
  
  db.view('accountTransactions', 'v1', viewOpts, function(error, couchRes){

    if (error) return callback ('CouchDB - ' + error);
  
    handleResponse(couchRes.rows);
  });
/*
 * handleResponse - format the data according to the requirements
 * of the request and return it to the caller.
 * 
 */  
  function handleResponse (rows) {
        
    var response, stats = {}, transactions = [];

    if (params.format === 'json') {
      
      rows.forEach( function( row, index ) {
        var value = row.value;
        
        //value[0] = currency
        //value[1] = issuer
        //value[2] = sent or recieved
        //value[3] = amount
        //value[4] = counterparty
        
        if (value[0]=='XRP') {
          if (!stats[value[0]])           stats[value[0]] = {};
          if (!stats[value[0]][value[2]]) stats[value[0]][value[2]] = {amount:0, count:0};
          stats[value[0]][value[2]]['amount'] += value[3];
          stats[value[0]][value[2]]['count']++;
          
          
        } else {
          if (!stats[value[0]])                     stats[value[0]] = {};
          if (!stats[value[0]][value[1]])           stats[value[0]][value[1]] = {};
          if (!stats[value[0]][value[1]][value[2]]) stats[value[0]][value[1]][value[2]] = {amount:0, count:0};
          stats[value[0]][value[1]][value[2]]['amount'] += value[3];
          stats[value[0]][value[1]][value[2]]['count']++;
        }
        
        transactions.push({
          currency     : value[0],
          issuer       : value[1],
          type         : value[2],
          amount       : value[3],
          counterparty : value[4],
          time         : moment.utc(value[5]).format(),
          txHash       : value[6],
          ledgerIndex  : parseInt(row.id, 10),
        });
      });
      
      response = {
        account        : account,
        startTime      : range.start.format(),
        endTime        : range.end.format(),
        summary        : stats,
        transactions   : transactions
      }
      
      return callback(null, response);
      
    } else {
      
      //TODO: document this param and apply other formats to it
      if (params.counterparties) {
        var counterparties = {}, data = [];
        
        for (var i=0; i<rows.length; i++) {
          counterparties[rows[i].value[4]] = 1;
        }
        
        for(var key in counterparties) {
          data.push(key);
        }
        
        if (params.format == 'csv') {
          var csv = "account\n";
          data.forEach(function(account) {csv += account+"\n"});
          return callback (null, csv);
        }  
        
        return callback(null, data);
      }
      
        response = [["currency","issuer","type","amount","counterparty","time","txHash","ledgerIndex"]];
        rows.forEach( function( row, index ) {
          response.push([
            row.value[0],
            row.value[1],
            row.value[2],
            row.value[3],
            row.value[4],
            moment.utc(row.value[5]).format(),
            row.value[6],
            parseInt(row.id, 10),
          ]);
        });
              
      if (params.format == 'csv') {
        var csvStr = _.map(response, function(row){
          return row.join(', ');
        }).join('\n');

        // provide output as CSV
        return callback(null, csvStr);   
           
      } else {
        
        //default response
        return callback(null, response);
      }
    }
  }
}


module.exports = accountTransactions;