xahaud/js/remote.js

// Remote access to a server.
// - We never send binary data.
// - We use the W3C interface for node and browser compatibility:
//   http://www.w3.org/TR/websockets/#the-websocket-interface
//
// This class is intended for both browser and node.js use.
//
// This class is designed to work via peer protocol via either the public or
// private websocket interfaces.  The JavaScript class for the peer protocol
// has not yet been implemented. However, this class has been designed for it
// to be a very simple drop option.
//
// YYY Will later provide js/network.js which will transparently use multiple
// instances of this class for network access.
//

// npm
var WebSocket = require('ws');

var EventEmitter = require('./events').EventEmitter;
var Amount    = require('./amount.js').Amount;
var UInt160   = require('./amount.js').UInt160;

// Don't include in browser context.
var config    = require('../test/config.js');

// Request events emmitted:
// 'success' : Request successful.
// 'error'   : Request failed.
//   'remoteError'
//   'remoteUnexpected'
//   'remoteDisconnected'
var Request = function (remote, command) {
  var self  = this;

  this.message	  = {
    'command' : command,
    'id'      : undefined,
  };
  this.remote	  = remote;
  this.requested  = false;

  this.on('request', function () {
      self.request_default();
    });
};

Request.prototype  = new EventEmitter;

// Send the request to a remote.
Request.prototype.request = function (remote) {
  this.emit('request', remote);
};

Request.prototype.request_default = function () {
  if (!this.requested) {
    this.requested  = true;
    this.remote.request(this);
  }
};

Request.prototype.ledger_choose = function (current) {
  if (current)
  {
    this.message.ledger_index = this.remote.ledger_current_index;
  }
  else {
    this.message.ledger_hash  = this.remote.ledger_hash;
  }

  return this;
};

// Set the ledger for a request.
// - ledger_entry
// - transaction_entry
Request.prototype.ledger_hash = function (h) {
  this.message.ledger_hash  = h;

  return this;
};

// Set the ledger_index for a request.
// - ledger_entry
Request.prototype.ledger_index = function (ledger_index) {
  this.message.ledger_index  = ledger_index;

  return this;
};

Request.prototype.account_root = function (account) {
  this.message.account_root  = UInt160.json_rewrite(account);

  return this;
};

Request.prototype.index = function (hash) {
  this.message.index  = hash;

  return this;
};

Request.prototype.secret = function (s) {
  if (s)
    this.message.secret  = s;

  return this;
};

Request.prototype.tx_hash = function (h) {
  this.message.tx_hash  = h;

  return this;
};

Request.prototype.tx_json = function (j) {
  this.message.tx_json  = j;

  return this;
};

Request.prototype.ripple_state = function (account, issuer, currency) {
  this.message.ripple_state  = {
      'accounts' : [
	UInt160.json_rewrite(account),
	UInt160.json_rewrite(issuer)
      ],
      'currency' : currency
    };

  return this;
};

//
// Remote - access to a remote Ripple server via websocket.
//
// Events:
// 'connectted'
// 'disconnected'
// 'state':
// - 'online' : connectted and subscribed
// - 'offline' : not subscribed or not connectted.
// 'ledger_closed': A good indicate of ready to serve.
// 'subscribed' : This indicates stand-alone is available.
//

// --> trusted: truthy, if remote is trusted
var Remote = function (trusted, websocket_ip, websocket_port, trace) {
  this.trusted              = trusted;
  this.websocket_ip         = websocket_ip;
  this.websocket_port       = websocket_port;
  this.id                   = 0;
  this.trace                = trace;
  this.ledger_hash	    = undefined;
  this.ledger_current_index = undefined;
  this.stand_alone          = undefined;
  this.online_target	    = false;
  this.online_state	    = 'closed';	  // 'open', 'closed', 'connecting', 'closing'
  this.state	  	    = 'offline';  // 'online', 'offline'
  this.retry_timer	    = undefined;
  this.retry		    = undefined;
  this.config		    = config || { 'accounts' : {}};
  
  // Cache information for accounts.
  this.accounts = {
    // Consider sequence numbers stable if you know you're not generating bad transactions.
    // Otherwise, clear it to have it automatically refreshed from the network.
    
    // account : { seq : __ }

    };
  
  // Cache for various ledgers.
  // XXX Clear when ledger advances.
  this.ledgers = {
    'current' : {
      'account_root' : {}
    }
  };
};

Remote.prototype      = new EventEmitter;

Remote.from_config = function (name, trace) {
  var serverConfig = config.servers[name];

  return new Remote(serverConfig.trusted, serverConfig.websocket_ip, serverConfig.websocket_port, trace);
};

var isTemMalformed  = function (engine_result_code) {
  return (engine_result_code >= -299 && engine_result_code <  199);
};

var isTefFailure = function (engine_result_code) {
  return (engine_result_code >= -299 && engine_result_code <  199);
};

Remote.flags = {
  'OfferCreate' : {
    'Passive'		      : 0x00010000,
  },

  'Payment' : {
    'CreateAccount'	      : 0x00010000,
    'PartialPayment'	      : 0x00020000,
    'LimitQuality'	      : 0x00040000,
    'NoRippleDirect'	      : 0x00080000,
  },
};

// XXX This needs to be determined from the network.
Remote.fees = {
  'default'	    : Amount.from_json("10"),
  'account_create'  : Amount.from_json("1000000000"),
  'nickname_create' : Amount.from_json("1000"),
  'offer'	    : Amount.from_json("10"),
};

// Set the emited state: 'online' or 'offline'
Remote.prototype._set_state = function (state) {
  if (this.trace) console.log("remote: set_state: %s", state);

  if (this.state !== state) {
    this.state = state;

    this.emit('state', state);
    switch (state) {
      case 'online':
	this.online_state	= 'open';
	this.emit('connected');
	break;

      case 'offline':
	this.online_state	= 'closed';
	this.emit('disconnected');
	break;
    }
  }
};

Remote.prototype.set_trace = function (trace) {
  this.trace  = undefined === trace || trace;

  return this;
};

// Set the target online state. Defaults to false.
Remote.prototype.connect = function (online) {
  var target  = undefined === online || online;

  if (this.online_target != target) {
    this.online_target  = target;

    // If we were in a stable state, go dynamic.
    switch (this.online_state) {
      case 'open':
	if (!target) this._connect_stop();
	break;

      case 'closed':
	if (target) this._connect_retry();
	break;
    }
  }

  return this;
};

// Stop from open state.
Remote.prototype._connect_stop = function () {
  delete this.ws.onerror;
  delete this.ws.onclose;

  this.ws.terminate();
  delete this.ws;

  this._set_state('offline');
};

// Implictly we are not connected.
Remote.prototype._connect_retry = function () {
  var self  = this;

  if (!self.online_target) {
    // Do not continue trying to connect.
    this._set_state('offline');
  }
  else if ('connecting' !== this.online_state) {
    // New to connecting state.
    this.online_state = 'connecting';
    this.retry	      = 0;
 
    this._connect_start();
  }
  else
  {
    // Delay and retry.
    this.retry	      += 1;
    this.retry_timer  =  setTimeout(function () {
	if (self.trace) console.log("remote: retry");

	if (self.online_target) {
	  self._connect_start();
	}
	else {
	  self._connect_retry();
	}
      }, this.retry < 40 ? 1000/20 : 1000); // 20 times per second for 2 seconds then once per second.
  }
};

Remote.prototype._connect_start = function () {
  // Note: as a browser client can't make encrypted connections to random ips
  // with self-signed certs as the user must have pre-approved the self-signed certs.

  var self = this;
  var url  = "ws://" + this.websocket_ip + ":" + this.websocket_port;
  
  if (this.trace) console.log("remote: connect: %s", url);
  
  var ws = this.ws = new WebSocket(url);
  
  ws.response = {};
  
  ws.onopen = function () {
    if (self.trace) console.log("remote: onopen: %s: online_target=%s", ws.readyState, self.online_target);
    
    ws.onerror = function () {
      if (self.trace) console.log("remote: onerror: %s", ws.readyState);

      delete ws.onclose;

      self._connect_retry();
    };

    ws.onclose = function () {
      if (self.trace) console.log("remote: onclose: %s", ws.readyState);

      delete ws.onerror;

      self._connect_retry();
    };
 
    if (self.online_target) {
      self._set_state('online');

      // Note, we could get disconnected before tis go through.
      self._server_subscribe();	    // Automatically subscribe.
    }
    else {
      self._connect_stop();
    }
  };
  
  ws.onerror = function () {
    if (self.trace) console.log("remote: onerror: %s", ws.readyState);
 
    delete ws.onclose;
    
    self._connect_retry();
  };

  // Failure to open.
  ws.onclose = function () {
    if (self.trace) console.log("remote: onclose: %s", ws.readyState);

    delete ws.onerror;

    self._connect_retry();
  };
  
  // Node's ws module doesn't pass arguments to onmessage.
  ws.on('message', function (json, flags) {
      self._connect_message(ws, json, flags);
    });
};

// It is possible for messages to be dispatched after the connection is closed.
Remote.prototype._connect_message = function (ws, json, flags) {
  var message	  = JSON.parse(json);
  var unexpected  = false;
  var request;

  if ('object' !== typeof message) {
    unexpected  = true;
  }
  else {
    switch (message.type) {
      case 'response':
	{
	  request	  = ws.response[message.id];

	  if (!request) {
	    unexpected  = true;
	  }
	  else if ('success' === message.result) {
	    if (this.trace) console.log("message: %s", json);

	    request.emit('success', message);
	  }
	  else if (message.error) {
	    if (this.trace) console.log("message: %s", json);

	    request.emit('error', {
		'error'		: 'remoteError',
		'error_message' : 'Remote reported an error.',
		'remote'        : message,
	      });
	  }
	}
	break;

      case 'ledgerClosed':
	// XXX If not trusted, need to verify we consider ledger closed.
	// XXX Also need to consider a slow server or out of order response.
	// XXX Be more defensive fields could be missing or of wrong type.
	// YYY Might want to do some cache management.

	this.ledger_time	  = message.ledger_time;
	this.ledger_hash	  = message.ledger_hash;
	this.ledger_current_index = message.ledger_index + 1;

	this.emit('ledger_closed', message.ledger_hash, message.ledger_index);
	break;
      
      default:
	unexpected  = true;
	break;
    }
  }

  if (!unexpected) {
  }
  // Unexpected response from remote.
  // XXX This isn't so robust. Hard fails should probably only happen in a debugging scenairo.
  else if (this.trusted) {
    // Remote is trusted, report an error.
    console.log("unexpected message from trusted remote: %s", json);

    (request || this).emit('error', {
	'error' : 'remoteUnexpected',
	'error_message' : 'Unexpected response from remote.'
      });
  }
  else {
    // Treat as a disconnect.
    if (this.trace) console.log("unexpected message from untrusted remote: %s", json);

    // XXX All pending request need this treatment and need to actionally disconnect.
    (request || this).emit('error', {
	'error' : 'remoteDisconnected',
	'error_message' : 'Remote disconnected.'
      });
  }
};

// Send a request.
// <-> request: what to send, consumed.
Remote.prototype.request = function (request) {
  if (this.ws) {
    // Only bother if we are still connected.

    this.ws.response[request.message.id = this.id] = request;
    
    this.id += 1;   // Advance id.
    
    if (this.trace) console.log("remote: request: %s", JSON.stringify(request.message));
    
    this.ws.send(JSON.stringify(request.message));
  }
  else {
    if (this.trace) console.log("remote: request: DROPPING: %s", JSON.stringify(request.message));
  }
};

// Only for unit testing.
Remote.prototype.request_ledger_hash = function () {
  assert(this.trusted);   // If not trusted, need to check proof.

  var request = new Request(this, 'rpc');
  
  request.message.rpc_command = 'ledger_closed';

  return request;
};

// Get the current proposed ledger entry.  May be closed (and revised) at any time (even before returning).
// Only for unit testing.
Remote.prototype.request_ledger_current = function () {
  var request = new Request(this, 'rpc');
  
  request.message.rpc_command = 'ledger_current';

  return request;
};

// --> ledger : optional
// --> ledger_index : optional
Remote.prototype.request_ledger_entry = function (type) {
  assert(this.trusted);   // If not trusted, need to check proof, maybe talk packet protocol.
  
  var self    = this;
  var request = new Request(this, 'rpc');

  request.message.rpc_command = 'ledger_entry';

  if (type)
    this.type = type;

  // Transparent caching:
  request.on('request', function (remote) {	      // Intercept default request.
    if (this.ledger_hash) {
      // XXX Add caching.
    }
    // else if (req.ledger_index)
    // else if ('ripple_state' === this.type)	      // YYY Could be cached per ledger.
    else if ('account_root' === this.type) {
      var cache = self.ledgers.current.account_root;
      
      if (!cache)
      {
	cache = self.ledgers.current.account_root = {};
      }
      
      var node = self.ledgers.current.account_root[request.message.account_root];

      if (node) {
	// Emulate fetch of ledger entry.
	this.request.emit('success', {
	    // YYY Missing lots of fields.
	    'node' :  node,
	  });
      }
      else {
	// Was not cached.

	// XXX Only allow with trusted mode.  Must sync response with advance.
	switch (response.type) {
	  case 'account_root':
	    request.on('success', function (message) {
		// Cache node.
		self.ledgers.current.account_root[message.node.Account] = message.node;
	      });
	    break;
	    
	  default:
	    // This type not cached.
	}

	this.request_default();
      }
    }
  });

  return request;
};

Remote.prototype.request_subscribe = function () {
  var request = new Request(this, 'subscribe');

  request.message.streams = [ 'ledger', 'server' ];

  return request;
};

Remote.prototype.request_transaction_entry = function (hash) {
  assert(this.trusted);   // If not trusted, need to check proof, maybe talk packet protocol.
  
  var request = new Request(this, 'rpc');

  request.message.rpc_command = 'transaction_entry';

  return request
    .tx_hash(hash);
};

// Submit a transaction.
Remote.prototype.submit = function (transaction) {
  var self  = this;

  if (this.trace) console.log("remote: submit: %s", JSON.stringify(transaction.tx_json));

  if (transaction.secret && !this.trusted)
  {
    transaction.emit('error', {
	'result'	  : 'serverUntrusted',
	'result_message'  : "Attempt to give a secret to an untrusted server."
      });
  }
  else {
    if (!transaction.tx_json.Sequence) {
      transaction.tx_json.Sequence	= this.account_seq(transaction.tx_json.Account, 'ADVANCE');
      // console.log("Sequence: %s", transaction.tx_json.Sequence);
    }

    if (!transaction.tx_json.Sequence) {
      // Look in the last closed ledger.
      this.account_seq_cache(transaction.tx_json.Account, false)
	.on('success_account_seq_cache', function () {
	    // Try again.
	    self.submit(transaction);
	  })
	.on('error_account_seq_cache', function (message) {
	    // XXX Maybe be smarter about this. Don't want to trust an untrusted server for this seq number.

	    // Look in the current ledger.
	    self.account_seq_cache(transaction.tx_json.Account, 'CURRENT')
	      .on('success_account_seq_cache', function () {
		  // Try again.
		  self.submit(transaction);
		})
	      .on('error_account_seq_cache', function (message) {
		  // Forward errors.
		  transaction.emit('error', message);
		})
	      .request();
	  })
	.request();
    }
    else {
      var submit_request = new Request(this, 'rpc');

      submit_request.message.rpc_command = 'submit_json';

      submit_request.tx_json(transaction.tx_json);
      submit_request.secret(transaction.secret);

      if (transaction.build_path)
	submit_request.build_path = true;

      // Forward successes and errors.
      submit_request.on('success', function (message) { transaction.emit('success', message); });
      submit_request.on('error', function (message) { transaction.emit('error', message); });
    
      submit_request.request();
    }
  }
};

//
// Higher level functions.
//

// Subscribe to a server to get 'ledger_closed' events.
// 'subscribed' : This command was successful.
// 'ledger_closed : ledger_closed and ledger_current_index are updated.
Remote.prototype._server_subscribe = function () {
  var self  = this;

  this.request_subscribe()
    .on('success', function (message) {
	self.stand_alone          = !!message.stand_alone;

	if (message.ledger_hash && message.ledger_index) {
	  self.ledger_time        = message.ledger_time;
	  self.ledger_hash        = message.ledger_hash;
	  self.ledger_current_index = message.ledger_index+1;

	  self.emit('ledger_closed', self.ledger_hash, self.ledger_current_index-1);
	}

	self.emit('subscribed');
      })
    .request();

  // XXX Could give error events, maybe even time out.

  return this;
};

// Ask the remote to accept the current ledger.
// - To be notified when the ledger is accepted, server_subscribe() then listen to 'ledger_hash' events.
// A good way to be notified of the result of this is:
//    remote.once('ledger_closed', function (ledger_closed, ledger_index) { ... } );
Remote.prototype.ledger_accept = function () {
  if (this.stand_alone || undefined === this.stand_alone)
  {
    var request = new Request(this, 'rpc');

    request.message.rpc_command = 'ledger_accept';

    request
      .request();
  }
  else {
    this.emit('error', {
	'error' : 'notStandAlone'
      });
  }

  return this;
};

// Return a request to refresh the account balance.
Remote.prototype.request_account_balance = function (account, current) {
  return (this.request_ledger_entry('account_root'))
    .account_root(account)
    .ledger_choose(current)
    .on('success', function (message) {
      // If the caller also waits for 'success', they might run before this.
      request.emit('account_balance', message.node.Balance);
    });
};

// Return the next account sequence if possible.
// <-- undefined or Sequence
Remote.prototype.account_seq = function (account, advance) {
  var account	    = UInt160.json_rewrite(account);
  var account_info  = this.accounts[account];
  var seq;

  if (account_info && account_info.seq)
  {
    seq = account_info.seq;

    if (advance) account_info.seq += 1;

    // console.log("cached: %s current=%d next=%d", account, seq, account_info.seq);
  }
  else {
    // console.log("uncached: %s", account);
  }

  return seq;
}

Remote.prototype.set_account_seq = function (account, seq) {
  var account	    = UInt160.json_rewrite(account);

  if (!this.accounts[account]) this.accounts[account] = {};
 
  this.accounts[account].seq = seq;
}

// Return a request to refresh accounts[account].seq.
Remote.prototype.account_seq_cache = function (account, current) {
  var self    = this;
  var request;

  if (!self.accounts[account]) self.accounts[account] = {};

  var account_info = self.accounts[account];

  request = account_info.caching_seq_request;
  if (!request) {
    // console.log("starting: %s", account);
    request = self.request_ledger_entry('account_root')
      .account_root(account)
      .ledger_choose(current)
      .on('success', function (message) {
	  delete account_info.caching_seq_request;

	  var seq = message.node.Sequence;
      
	  account_info.seq  = seq;

	  // console.log("caching: %s %d", account, seq);
	  // If the caller also waits for 'success', they might run before this.
	  request.emit('success_account_seq_cache', message);
	})
      .on('error', function (message) {
	  // console.log("error: %s", account);
	  delete account_info.caching_seq_request;

	  request.emit('error_account_seq_cache', message);
	});

    account_info.caching_seq_request	= request;
  }

  return request
};

// Mark an account's root node as dirty.
Remote.prototype.dirty_account_root = function (account) {
  var account	    = UInt160.json_rewrite(account);

  delete this.ledgers.current.account_root[account];
};

// Return a request to get a ripple balance.
//
// --> account: String
// --> issuer: String
// --> currency: String
// --> current: bool : true = current ledger
//
// If does not exist: emit('error', 'error' : 'remoteError', 'remote' : { 'error' : 'entryNotFound' })
Remote.prototype.request_ripple_balance = function (account, issuer, currency, current) {
  var request	    = this.request_ledger_entry('ripple_state');	  // YYY Could be cached per ledger.

  return request
    .ripple_state(account, issuer, currency)
    .ledger_choose(current)
    .on('success', function (message) {
	var node	    = message.node;

	var lowLimit	    = Amount.from_json(node.LowLimit);
	var highLimit	    = Amount.from_json(node.HighLimit);
	// The amount the low account holds of issuer.
	var balance	    = Amount.from_json(node.Balance);
	// accountHigh implies: for account: balance is negated, highLimit is the limit set by account.
	var accountHigh	    = UInt160.from_json(account).equals(highLimit.issuer);
	// The limit set by account.
	var accountLimit    = (accountHigh ? highLimit : lowLimit).parse_issuer(account);
	// The limit set by issuer.
	var issuerLimit	    = (accountHigh ? lowLimit : highLimit).parse_issuer(issuer);
	var accountBalance  = (accountHigh ? balance.negate() : balance).parse_issuer(account);
	var issuerBalance   = (accountHigh ? balance : balance.negate()).parse_issuer(issuer);

	request.emit('ripple_state', {
	  'issuer_balance'  : issuerBalance,  // Balance with dst as issuer.
	  'account_balance' : accountBalance, // Balance with account as issuer.
	  'issuer_limit'    : issuerLimit,    // Limit set by issuer with src as issuer.
	  'account_limit'   : accountLimit    // Limit set by account with dst as issuer.
	});
      });
}

Remote.prototype.transaction = function () {
  return new Transaction(this);
};

//
// Transactions
//
//  Construction:
//    remote.transaction()  // Build a transaction object.
//     .offer_create(...)   // Set major parameters.
//     .set_flags()	    // Set optional parameters.
//     .on()		    // Register for events.
//     .submit();	    // Send to network.
//
//  Events:
// 'success' : Transaction submitted without error.
// 'error' : Error submitting transaction.
// 'proposed' : Advisory proposed status transaction.
// - A client should expect 0 to multiple results.
// - Might not get back. The remote might just forward the transaction.
// - A success could be reverted in final.
// - local error: other remotes might like it.
// - malformed error: local server thought it was malformed.
// - The client should only trust this when talking to a trusted server.
// 'final' : Final status of transaction.
// - Only expect a final from dishonest servers after a tesSUCCESS or ter*.
// 'lost' : Gave up looking for on ledger_closed.
// 'pending' : Transaction was not found on ledger_closed.
// 'state' : Follow the state of a transaction.
//    'client_submitted'     - Sent to remote
//     |- 'remoteError'	     - Remote rejected transaction.
//      \- 'client_proposed' - Remote provisionally accepted transaction.
//       |- 'client_missing' - Transaction has not appeared in ledger as expected.
//       | |\- 'client_lost' - No longer monitoring missing transaction.
//       |/
//       |- 'tesSUCCESS'     - Transaction in ledger as expected.
//       |- 'ter...'	     - Transaction failed.
//       \- 'tep...'	     - Transaction partially succeeded.
//
// Notes:
// - All transactions including those with local and malformed errors may be
//   forwarded anyway.
// - A malicous server can:
//   - give any proposed result.
//     - it may declare something correct as incorrect or something correct as incorrect.
//     - it may not communicate with the rest of the network.
//   - may or may not forward.
//

var SUBMIT_MISSING  = 4;    // Report missing.
var SUBMIT_LOST	    = 8;    // Give up tracking.

// A class to implement transactions.
// - Collects parameters
// - Allow event listeners to be attached to determine the outcome.
var Transaction	= function (remote) {
  var self  = this;

  this.remote	    = remote;
  this.secret	    = undefined;
  this.build_path   = true;
  this.tx_json	    = {		      	// Transaction data.
    'Flags' : 0,		      	// XXX Would be nice if server did not require this.
  };
  this.hash	    = undefined;
  this.submit_index = undefined;      	// ledger_current_index was this when transaction was submited.
  this.state	    = undefined;	// Under construction.

  this.on('success', function (message) {
      if (message.engine_result) {
	self.hash	= message.tx_json.hash;

	self.set_state('client_proposed');

	self.emit('proposed', {
	    'tx_json'	      : message.tx_json,
	    'result'	      : message.engine_result,
	    'result_code'     : message.engine_result_code,
	    'result_message'  : message.engine_result_message,
	    'rejected'	      : self.isRejected(message.engine_result_code),	  // If server is honest, don't expect a final if rejected.
	  });
      }
    });

  this.on('error', function (message) {
	// Might want to give more detailed information.
	self.set_state('remoteError');
    });
};

Transaction.prototype  = new EventEmitter;

Transaction.prototype.consts = {
  'telLOCAL_ERROR'  : -399,
  'temMALFORMED'    : -299,
  'tefFAILURE'	    : -199,
  'terRETRY'	    : -99,
  'tesSUCCESS'	    : 0,
  'tepPARTIAL'	    : 100,
};

Transaction.prototype.isTelLocal = function (ter) {
  return ter >= this.consts.telLOCAL_ERROR && ter < this.consts.temMALFORMED;
};

Transaction.prototype.isTemMalformed = function (ter) {
  return ter >= this.consts.temMALFORMED && ter < this.consts.tefFAILURE;
};

Transaction.prototype.isTefFailure = function (ter) {
  return ter >= this.consts.tefFAILURE && ter < this.consts.terRETRY;
};

Transaction.prototype.isTerRetry = function (ter) {
  return ter >= this.consts.terRETRY && ter < this.consts.tesSUCCESS;
};

Transaction.prototype.isTepSuccess = function (ter) {
  return ter >= this.consts.tesSUCCESS;
};

Transaction.prototype.isTepPartial = function (ter) {
  return ter >= this.consts.tepPATH_PARTIAL;
};

Transaction.prototype.isRejected = function (ter) {
  return this.isTelLocal(ter) || this.isTemMalformed(ter) || this.isTefFailure(ter);
};

Transaction.prototype.set_state = function (state) {
  if (this.state !== state) {
    this.state  = state;
    this.emit('state', state);
  }
};

// Submit a transaction to the network.
// XXX Don't allow a submit without knowing ledger_index.
// XXX Have a network canSubmit(), post events for following.
// XXX Also give broader status for tracking through network disconnects.
Transaction.prototype.submit = function () {
  var self    = this;
  var tx_json = this.tx_json;

  if ('string' !== typeof tx_json.Account)
  {
    this.emit('error', {
	'error' : 'invalidAccount',
	'error_message' : 'Bad account.'
      });
    return;
  }

  // YYY Might check paths for invalid accounts.

  if (undefined === tx_json.Fee) {
    if ('Payment' === tx_json.TransactionType
      && tx_json.Flags & Remote.flags.Payment.CreateAccount) {

      tx_json.Fee    = Remote.fees.account_create.to_json();
    }
    else {
      tx_json.Fee    = Remote.fees['default'].to_json();
    }
  }

  if (this.listeners('final').length || this.listeners('lost').length || this.listeners('pending').length) {
    // There are listeners for 'final', 'lost', or 'pending' arrange to emit them.

    this.submit_index = this.remote.ledger_current_index;

    var	on_ledger_closed = function (ledger_hash, ledger_index) {
	var stop  = false;

// XXX make sure self.hash is available.
	self.remote.request_transaction_entry(self.hash)
	  .ledger_hash(ledger_hash)
	  .on('success', function (message) {
	      self.set_state(message.metadata.TransactionResult);
	      self.emit('final', message);
	    })
	  .on('error', function (message) {
	      if ('remoteError' === message.error
		&& 'transactionNotFound' === message.remote.error) {
		if (self.submit_index + SUBMIT_LOST < ledger_index) {
		  self.set_state('client_lost');	// Gave up.
		  self.emit('lost');
		  stop  = true;
		}
		else if (self.submit_index + SUBMIT_MISSING < ledger_index) {
		  self.set_state('client_missing');    // We don't know what happened to transaction, still might find.
		  self.emit('pending');
		}
		else {
		  self.emit('pending');
		}
	      }
	      // XXX Could log other unexpectedness.
	    })
	  .request();
	
	if (stop) {
	  self.removeListener('ledger_closed', on_ledger_closed);
	  self.emit('final', message);
	}
      };

    this.remote.on('ledger_closed', on_ledger_closed);
  }

  this.set_state('client_submitted');

  this.remote.submit(this);

  return this;
}

//
// Set options for Transactions
//

Transaction.prototype.build_path = function (build) {
  this.build_path = build;

  return this;
}

Transaction._path_rewrite = function (path) {
  var path_new	= [];
  
  for (var index in path) {
    var	node	  = path[index];
    var	node_new  = {};

    if ('account' in node)
      node_new.account	= UInt160.json_rewrite(node.account);

    if ('issuer' in node)
      node_new.issuer	= UInt160.json_rewrite(node.issuer);

    if ('currency' in node)
      node_new.currency	= Currency.json_rewrite(node.currency);

    path_new.push(node_new);
  }

  return path_new;
}

Transaction.prototype.path_add = function (path) {
  this.tx_json.Paths  = this.tx_json.Paths || []
  this.tx_json.Paths.push(Transaction._path_rewrite(path));

  return this;
}

// --> paths: undefined or array of path
// A path is an array of objects containing some combination of: account, currency, issuer
Transaction.prototype.paths = function (paths) {
  for (var index in paths) {
    this.path_add(paths[index]);
  }

  return this;
}

// If the secret is in the config object, it does not need to be provided.
Transaction.prototype.secret = function (secret) {
  this.secret = secret;
}

Transaction.prototype.send_max = function (send_max) {
  if (send_max)
      this.tx_json.SendMax = Amount.json_rewrite(send_max);

  return this;
}

// --> rate: In billionths.
Transaction.prototype.transfer_rate = function (rate) {
  this.tx_json.TransferRate = Number(rate);

  if (this.tx_json.TransferRate < 1e9)
    throw 'invalidTransferRate';

  return this;
}

// Add flags to a transaction.
// --> flags: undefined, _flag_, or [ _flags_ ]
Transaction.prototype.set_flags = function (flags) {
  if (flags) {
      var   transaction_flags = Remote.flags[this.tx_json.TransactionType];

      if (undefined == this.tx_json.Flags)	// We plan to not define this field on new Transaction.
	this.tx_json.Flags	  = 0;
      
      var flag_set  = 'object' === typeof flags ? flags : [ flags ];

      for (index in flag_set) {
	var flag  = flag_set[index];

	if (flag in transaction_flags)
	{
	  this.tx_json.Flags      += transaction_flags[flag];
	}
	else {
	  // XXX Immediately report an error or mark it.
	}
      }

      if (this.tx_json.Flags & Remote.flags.Payment.CreateAccount)
	this.tx_json.Fee	= Remote.fees.account_create.to_json();
  }

  return this;
}

//
// Transactions
//

Transaction.prototype._account_secret = function (account) {
  // Fill in secret from config, if needed.
  return this.remote.config.accounts[account] ? this.remote.config.accounts[account].secret : undefined;
};

// Options:
//  .domain()		NYI
//  .message_key()	NYI
//  .transfer_rate()
//  .wallet_locator()	NYI
Transaction.prototype.account_set = function (src) {
  this.secret			= this._account_secret(src);
  this.tx_json.TransactionType  = 'AccountSet';
  this.tx_json.Account		= UInt160.json_rewrite(src);

  return this;
};

Transaction.prototype.claim = function (src, generator, public_key, signature) {
  this.secret			= this._account_secret(src);
  this.tx_json.TransactionType  = 'Claim';
  this.tx_json.Generator	= generator;
  this.tx_json.PublicKey	= public_key;
  this.tx_json.Signature	= signature;

  return this;
};

Transaction.prototype.offer_cancel = function (src, sequence) {
  this.secret			= this._account_secret(src);
  this.tx_json.TransactionType  = 'OfferCancel';
  this.tx_json.Account		= UInt160.json_rewrite(src);
  this.tx_json.OfferSequence    = Number(sequence);

  return this;
};

// --> expiration : Date or Number
Transaction.prototype.offer_create = function (src, taker_pays, taker_gets, expiration) {
  this.secret			= this._account_secret(src);
  this.tx_json.TransactionType  = 'OfferCreate';
  this.tx_json.Account		= UInt160.json_rewrite(src);
  this.tx_json.Fee		= Remote.fees.offer.to_json();
  this.tx_json.TakerPays	= Amount.json_rewrite(taker_pays);
  this.tx_json.TakerGets	= Amount.json_rewrite(taker_gets);

  if (expiration)
    this.tx_json.Expiration  = Date === expiration.constructor
				    ? expiration.getTime()
				    : Number(expiration);

  return this;
};

Transaction.prototype.password_fund = function (src, dst) {
  this.secret			= this._account_secret(src);
  this.tx_json.TransactionType  = 'PasswordFund';
  this.tx_json.Destination	= UInt160.json_rewrite(dst);

  return this;
}

Transaction.prototype.password_set = function (src, authorized_key, generator, public_key, signature) {
  this.secret			= this._account_secret(src);
  this.tx_json.TransactionType  = 'PasswordSet';
  this.tx_json.AuthorizedKey    = authorized_key;
  this.tx_json.Generator	= generator;
  this.tx_json.PublicKey	= public_key;
  this.tx_json.Signature	= signature;

  return this;
}

// Construct a 'payment' transaction.
//
// When a transaction is submitted:
// - If the connection is reliable and the server is not merely forwarding and is not malicious, 
// --> src : UInt160 or String
// --> dst : UInt160 or String
// --> deliver_amount : Amount or String.
//
// Options:
//  .paths()
//  .build_path()
//  .path_add()
//  .secret()
//  .send_max()
//  .set_flags()
Transaction.prototype.payment = function (src, dst, deliver_amount) {
  this.secret			= this._account_secret(src);
  this.tx_json.TransactionType  = 'Payment';
  this.tx_json.Account		= UInt160.json_rewrite(src);
  this.tx_json.Amount		= Amount.json_rewrite(deliver_amount);
  this.tx_json.Destination	= UInt160.json_rewrite(dst);

  return this;
}

Transaction.prototype.ripple_line_set = function (src, limit, quality_in, quality_out) {
  this.secret			= this._account_secret(src);
  this.tx_json.TransactionType  = 'CreditSet';
  this.tx_json.Account		= UInt160.json_rewrite(src);

  // Allow limit of 0 through.
  if (undefined !== limit)
    this.tx_json.LimitAmount  = Amount.json_rewrite(limit);

  if (quality_in)
    this.tx_json.QualityIn    = quality_in;

  if (quality_out)
    this.tx_json.QualityOut   = quality_out;

  // XXX Throw an error if nothing is set.

  return this;
};

Transaction.prototype.wallet_add = function (src, amount, authorized_key, public_key, signature) {
  this.secret			= this._account_secret(src);
  this.tx_json.TransactionType  = 'WalletAdd';
  this.tx_json.Amount		= Amount.json_rewrite(amount);
  this.tx_json.AuthorizedKey    = authorized_key;
  this.tx_json.PublicKey	= public_key;
  this.tx_json.Signature	= signature;

  return this;
};

exports.Remote          = Remote;

// vim:sw=2:sts=2:ts=8