JS: Rework remote framework.

This commit is contained in:
Arthur Britto
2012-10-04 17:50:46 -07:00
committed by Stefan Thomas
parent ee7583d0ae
commit a240efc38d

View File

@@ -12,21 +12,50 @@ var util = require('util');
var WebSocket = require('ws'); var WebSocket = require('ws');
// --> trusted: truthy, if remote is trusted // --> trusted: truthy, if remote is trusted
var Remote = function(trusted, websocket_ip, websocket_port, trace) { var Remote = function (trusted, websocket_ip, websocket_port, trace) {
this.trusted = trusted; this.trusted = trusted;
this.websocket_ip = websocket_ip; this.websocket_ip = websocket_ip;
this.websocket_port = websocket_port; this.websocket_port = websocket_port;
this.id = 0; this.id = 0;
this.trace = trace; this.trace = trace;
this.ledger_closed = undefined;
this.ledger_current_index = undefined;
this.stand_alone = undefined;
// Cache information for accounts.
this.accounts = {
};
// Cache for various ledgers.
// XXX Clear when ledger advances.
this.ledgers = {
'current' : {}
};
}; };
var remoteConfig = function(config, server, trace) { var remoteConfig = function (config, server, trace) {
var serverConfig = config.servers[server]; var serverConfig = config.servers[server];
return new Remote(serverConfig.trusted, serverConfig.websocket_ip, serverConfig.websocket_port, trace); return new Remote(serverConfig.trusted, serverConfig.websocket_ip, serverConfig.websocket_port, trace);
}; };
Remote.method('connect_helper', function() { // XXX This needs to be determined from the network.
var fees = {
'default' : 100,
'account_create' : 1000,
'nickname_create' : 1000,
'offer' : 100,
};
// For accounts we cache things like sequence numbers.
var 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.
// acount : { seq : __ }
};
Remote.method('connect_helper', function () {
var self = this; var self = this;
if (this.trace) if (this.trace)
@@ -38,7 +67,7 @@ Remote.method('connect_helper', function() {
ws.response = {}; ws.response = {};
ws.onopen = function() { ws.onopen = function () {
if (this.trace) if (this.trace)
console.log("remote: onopen: %s", ws.readyState); console.log("remote: onopen: %s", ws.readyState);
@@ -48,7 +77,7 @@ Remote.method('connect_helper', function() {
self.done(ws.readyState); self.done(ws.readyState);
}; };
ws.onerror = function() { ws.onerror = function () {
if (this.trace) if (this.trace)
console.log("remote: onerror: %s", ws.readyState); console.log("remote: onerror: %s", ws.readyState);
@@ -63,7 +92,7 @@ Remote.method('connect_helper', function() {
else else
{ {
// Delay and retry. // Delay and retry.
setTimeout(function() { setTimeout(function () {
if (this.trace) if (this.trace)
console.log("remote: retry"); console.log("remote: retry");
@@ -73,7 +102,7 @@ Remote.method('connect_helper', function() {
}; };
// Covers failure to open. // Covers failure to open.
ws.onclose = function() { ws.onclose = function () {
if (this.trace) if (this.trace)
console.log("remote: onclose: %s", ws.readyState); console.log("remote: onclose: %s", ws.readyState);
@@ -83,7 +112,7 @@ Remote.method('connect_helper', function() {
}; };
// Node's ws module doesn't pass arguments to onmessage. // Node's ws module doesn't pass arguments to onmessage.
ws.on('message', function(json, flags) { ws.on('message', function (json, flags) {
var message = JSON.parse(json); var message = JSON.parse(json);
// console.log("message: %s", json); // console.log("message: %s", json);
@@ -106,7 +135,7 @@ Remote.method('connect_helper', function() {
// Target state is connectted. // Target state is connectted.
// done(readyState): // done(readyState):
// --> readyState: OPEN, CLOSED // --> readyState: OPEN, CLOSED
Remote.method('connect', function(done, timeout) { Remote.method('connect', function (done, timeout) {
var self = this; var self = this;
this.url = util.format("ws://%s:%s", this.websocket_ip, this.websocket_port); this.url = util.format("ws://%s:%s", this.websocket_ip, this.websocket_port);
@@ -137,10 +166,10 @@ Remote.method('connect', function(done, timeout) {
}); });
// Target stated is disconnected. // Target stated is disconnected.
Remote.method('disconnect', function(done) { Remote.method('disconnect', function (done) {
var ws = this.ws; var ws = this.ws;
ws.onclose = function() { ws.onclose = function () {
if (this.trace) if (this.trace)
console.log("remote: onclose: %s", ws.readyState); console.log("remote: onclose: %s", ws.readyState);
@@ -152,54 +181,178 @@ Remote.method('disconnect', function(done) {
// Send a command. The comman should lack the id. // Send a command. The comman should lack the id.
// <-> command: what to send, consumed. // <-> command: what to send, consumed.
Remote.method('request', function(command, done) { Remote.method('request', function (request, onDone, onFailure) {
this.id += 1; // Advance id. this.id += 1; // Advance id.
var ws = this.ws; var ws = this.ws;
command.id = this.id; request.id = this.id;
ws.response[command.id] = done; ws.response[request.id] = function (response) {
if (this.trace)
console.log("remote: response: %s", JSON.stringify(response));
if (onFailure && response.error)
{
onFailure(response);
}
else
{
onDone(response);
}
};
if (this.trace) if (this.trace)
console.log("remote: send: %s", JSON.stringify(command)); console.log("remote: request: %s", JSON.stringify(request));
ws.send(JSON.stringify(command)); ws.send(JSON.stringify(request));
}); });
Remote.method('ledger_closed', function(done) { Remote.method('request_ledger_closed', function (onDone, onFailure) {
assert(this.trusted); // If not trusted, need to check proof. assert(this.trusted); // If not trusted, need to check proof.
this.request({ 'command' : 'ledger_closed' }, done); this.request({ 'command' : 'ledger_closed' }, onDone, onFailure);
}); });
// Get the current proposed ledger entry. May be closed (and revised) at any time (even before returning). // Get the current proposed ledger entry. May be closed (and revised) at any time (even before returning).
// Only for use by unit tests. // Only for use by unit tests.
Remote.method('ledger_current', function(done) { Remote.method('request_ledger_current', function (onDone, onFailure) {
this.request({ 'command' : 'ledger_current' }, done); this.request({ 'command' : 'ledger_current' }, onDone, onFailure);
}); });
// <-> params: // <-> request:
// --> ledger : optional // --> ledger : optional
// --> ledger_index : optional // --> ledger_index : optional
Remote.method('ledger_entry', function(params, done) { // --> type
Remote.method('request_ledger_entry', function (req, onDone, onFailure) {
assert(this.trusted); // If not trusted, need to check proof, maybe talk packet protocol. assert(this.trusted); // If not trusted, need to check proof, maybe talk packet protocol.
params.command = 'ledger_entry'; req.command = 'ledger_entry';
this.request(params, done); if (req.ledger_closed)
{
// XXX Initial implementation no caching.
this.request(req, onDone, onFailure);
}
else if (req.ledger_index)
{
// Current
// XXX Only allow with standalone mode. Must sync response with advance.
var entry;
switch (req.type) {
case 'account_root':
var cache = this.ledgers.current.account_root;
if (!cache)
{
cache = this.ledgers.current.account_root = {};
}
var entry = this.ledgers.current.account_root[req.account];
break;
default:
// This type not cached.
}
if (entry)
{
onDone(entry);
}
else
{
// Not cached.
// Submit request
this.request(req, function (r) {
// Got result.
switch (req.type) {
case 'account_root':
this.ledgers.current.account_root.account = r;
break;
default:
// This type not cached.
}
onDone(r);
}, onFailure);
}
}
}); });
// Submit a json transaction. // Submit a json transaction.
// done(value) // done(value)
// <-> value: { 'status', status, 'result' : result, ... } // <-> value: { 'status', status, 'result' : result, ... }
// done may be called up to 3 times. // done may be called up to 3 times.
Remote.method('submit', function(json, done) { Remote.method('submit', function (json, private_key, onDone, onFailure) {
// this.request(..., function() { var req = {};
// });
req.command = 'submit';
req.json = json;
if (private_key && !this.trusted)
{
onFailure({ 'error' : 'untrustedSever', 'request' : req });
}
else
{
this.request(req, onDone, onFailure);
}
});
//
// Higher level functions.
//
// Subscribe to a server to get the current and closed ledger.
// XXX Set up routine to update on notification.
Remote.method('server_subscribe', function (onDone, onFailure) {
this.request({
'command' : 'server_subscribe'
}, function (r) {
this.ledger_current_index = r.ledger_current_index;
this.ledger_closed = r.ledger_closed;
this.stand_alone = r.stand_alone;
onDone();
}, onFailure);
});
// Refresh accounts[account].seq
// done(result);
Remote.method('account_seq', function (account, onDone, onFailure) {
var account_root_entry = this.accounts[account];
if (account_root_entry && account_root_entry.seq)
{
onDone(account_root_entry.seq);
}
else
{
// Need to get the ledger entry.
this.request_ledger_entry({
'ledger' : this.ledger_closed,
'account_root' : account
}, function (r) {
// Extract the seqence number from the account root entry.
this.accounts[account].seq = r.seq;
onDone(r.seq);
}, onFailure);
}
});
// A submit that fills in the sequence number.
Remote.method('submit_seq', function (onDone, onFailure) {
}); });
exports.Remote = Remote; exports.Remote = Remote;
exports.remoteConfig = remoteConfig; exports.remoteConfig = remoteConfig;
exports.fees = fees;
exports.accounts = accounts;
// vim:ts=4 // vim:sw=2:sts=2:ts=8