mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-21 20:55:48 +00:00
make Remote.getLedgerSequence asynchronous
This commit is contained in:
@@ -71,7 +71,8 @@ function composeAsync(wrapper: Wrapper, callback: Callback): Callback {
|
||||
function convertErrors(callback: Callback): () => void {
|
||||
return function(error, data) {
|
||||
if (error && !(error instanceof errors.RippleError)) {
|
||||
const error_ = new errors.RippleError(error);
|
||||
const message = _.get(error, ['remote', 'error_message'], error.message);
|
||||
const error_ = new errors.RippleError(message);
|
||||
error_.data = data;
|
||||
callback(error_, data);
|
||||
} else if (error) {
|
||||
|
||||
@@ -7,6 +7,9 @@ const getTrustlines = require('./trustlines');
|
||||
const validate = utils.common.validate;
|
||||
const composeAsync = utils.common.composeAsync;
|
||||
const convertErrors = utils.common.convertErrors;
|
||||
import type {Remote} from '../../core/remote';
|
||||
import type {GetLedgerSequenceCallback} from '../../core/remote';
|
||||
|
||||
|
||||
function getTrustlineBalanceAmount(trustline) {
|
||||
return {
|
||||
@@ -31,14 +34,26 @@ function getTrustlinesAsync(account, options, callback) {
|
||||
.catch(callback);
|
||||
}
|
||||
|
||||
function getLedgerVersion(remote: Remote, optionValue?: number,
|
||||
callback: GetLedgerSequenceCallback
|
||||
) {
|
||||
if (typeof optionValue === 'number') {
|
||||
callback(null, optionValue);
|
||||
} else {
|
||||
remote.getLedgerSequence(callback);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
function getBalancesAsync(account, options, callback) {
|
||||
validate.address(account);
|
||||
validate.getBalancesOptions(options);
|
||||
|
||||
const ledgerVersion = options.ledgerVersion
|
||||
|| this.remote.getLedgerSequence();
|
||||
async.parallel({
|
||||
xrp: _.partial(utils.getXRPBalance, this.remote, account, ledgerVersion),
|
||||
xrp: async.compose(
|
||||
_.partial(utils.getXRPBalance, this.remote, account),
|
||||
_.partial(getLedgerVersion, this.remote, options.ledgerVersion)
|
||||
),
|
||||
trustlines: _.partial(getTrustlinesAsync.bind(this), account, options)
|
||||
}, composeAsync(formatBalances, convertErrors(callback)));
|
||||
}
|
||||
|
||||
@@ -26,10 +26,21 @@ function getOrdersAsync(account, options, callback) {
|
||||
validate.address(account);
|
||||
validate.getOrdersOptions(options);
|
||||
|
||||
const ledgerVersion = options.ledgerVersion
|
||||
|| this.remote.getLedgerSequence();
|
||||
if (!options.ledgerVersion) {
|
||||
const self = this;
|
||||
this.remote.getLedgerSequence((err, seq) => {
|
||||
if (err) {
|
||||
convertErrors(callback)(err);
|
||||
return;
|
||||
}
|
||||
const newOptions = _.extend(options, {ledgerVersion: seq});
|
||||
getOrdersAsync.call(self, account, newOptions, callback);
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
const getter = _.partial(requestAccountOffers, this.remote, account,
|
||||
ledgerVersion);
|
||||
options.ledgerVersion);
|
||||
utils.getRecursive(getter, options.limit,
|
||||
composeAsync((orders) => _.sortBy(orders,
|
||||
(order) => order.properties.sequence), callback));
|
||||
|
||||
@@ -52,10 +52,10 @@ function getTransactionAsync(identifier: string, options: TransactionOptions,
|
||||
validate.getTransactionOptions(options);
|
||||
|
||||
const remote = this.remote;
|
||||
const maxLedgerVersion =
|
||||
options.maxLedgerVersion || remote.getLedgerSequence();
|
||||
|
||||
function callbackWrapper(error_?: Error, tx?: Object) {
|
||||
function callbackWrapper(error_?: Error, tx?: Object,
|
||||
maxLedgerVersion?: number
|
||||
) {
|
||||
let error = error_;
|
||||
|
||||
if (!error && tx && tx.validated !== true) {
|
||||
@@ -89,11 +89,22 @@ function getTransactionAsync(identifier: string, options: TransactionOptions,
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/* eslint-disable no-unused-vars, handle-callback-err */
|
||||
function callbackWrapper2(error_?: Error, tx?: Object) {
|
||||
remote.getLedgerSequence(function(err?, seq: number) {
|
||||
const maxLedgerVersion = Math.min(options.maxLedgerVersion || Infinity,
|
||||
seq);
|
||||
callbackWrapper(error_, tx, maxLedgerVersion);
|
||||
});
|
||||
}
|
||||
/* eslint-enable no-unused-vars, handle-callback-err */
|
||||
|
||||
async.waterfall([
|
||||
_.partial(remote.requestTx.bind(remote),
|
||||
{hash: identifier, binary: false}),
|
||||
_.partial(attachTransactionDate, remote)
|
||||
], callbackWrapper);
|
||||
], callbackWrapper2);
|
||||
}
|
||||
|
||||
function getTransaction(identifier: string,
|
||||
|
||||
@@ -42,10 +42,21 @@ function getTrustlinesAsync(account: string, options: {currency: string,
|
||||
validate.address(account);
|
||||
validate.getTrustlinesOptions(options);
|
||||
|
||||
const ledgerVersion = options.ledgerVersion
|
||||
|| this.remote.getLedgerSequence();
|
||||
if (!options.ledgerVersion) {
|
||||
const self = this;
|
||||
this.remote.getLedgerSequence(convertErrors(function(err?, seq: number) {
|
||||
if (err) {
|
||||
callback(err);
|
||||
} else {
|
||||
const newOptions = _.extend(options, {ledgerVersion: seq});
|
||||
getTrustlinesAsync.call(self, account, newOptions, callback);
|
||||
}
|
||||
}));
|
||||
return;
|
||||
}
|
||||
|
||||
const getter = _.partial(getAccountLines, this.remote, account,
|
||||
ledgerVersion, options);
|
||||
options.ledgerVersion, options);
|
||||
utils.getRecursive(getter, options.limit, callback);
|
||||
}
|
||||
|
||||
|
||||
@@ -103,7 +103,7 @@ function hasCompleteLedgerRange(remote: Remote, minLedgerVersion?: number,
|
||||
const firstLedgerVersion = 32570; // earlier versions have been lost
|
||||
return remote.getServer().hasLedgerRange(
|
||||
minLedgerVersion || firstLedgerVersion,
|
||||
maxLedgerVersion || remote.getLedgerSequence());
|
||||
maxLedgerVersion || remote.getLedgerSequenceSync());
|
||||
}
|
||||
|
||||
function isPendingLedgerVersion(remote: Remote, maxLedgerVersion: ?number
|
||||
|
||||
@@ -53,8 +53,7 @@ function getServerInfoAsync(
|
||||
): void {
|
||||
this.remote.requestServerInfo((error, response) => {
|
||||
if (error) {
|
||||
const message =
|
||||
_.get(error, ['remote', 'error_message'], error.message);
|
||||
const message = _.get(error, ['remote', 'error_message'], error.message);
|
||||
callback(new common.errors.RippledNetworkError(message));
|
||||
} else {
|
||||
callback(null,
|
||||
@@ -63,28 +62,43 @@ function getServerInfoAsync(
|
||||
});
|
||||
}
|
||||
|
||||
function getFee(): number {
|
||||
return common.dropsToXrp(this.remote.createTransaction()._computeFee());
|
||||
function getFee(): ?number {
|
||||
if (!this.remote._servers.length) {
|
||||
throw new common.errors.RippledNetworkError('No servers available.');
|
||||
}
|
||||
const fee = this.remote.createTransaction()._computeFee();
|
||||
if (typeof fee !== 'string') {
|
||||
return undefined;
|
||||
}
|
||||
return common.dropsToXrp(fee);
|
||||
}
|
||||
|
||||
function getLedgerVersion(): number {
|
||||
return this.remote.getLedgerSequence();
|
||||
function getLedgerVersion(): Promise<number> {
|
||||
return common.promisify(this.remote.getLedgerSequence).call(this.remote);
|
||||
}
|
||||
|
||||
function connect(): Promise<void> {
|
||||
return common.promisify(callback => {
|
||||
try {
|
||||
this.remote.connect(() => callback(null));
|
||||
} catch(error) {
|
||||
callback(new common.errors.RippledNetworkError(error.message));
|
||||
}
|
||||
})();
|
||||
}
|
||||
|
||||
function disconnect(): Promise<void> {
|
||||
return common.promisify(callback => {
|
||||
try {
|
||||
this.remote.disconnect(() => callback(null));
|
||||
} catch(error) {
|
||||
callback(new common.errors.RippledNetworkError(error.message));
|
||||
}
|
||||
})();
|
||||
}
|
||||
|
||||
function getServerInfo(): Promise<GetServerInfoResponse> {
|
||||
return common.promisify(getServerInfoAsync.bind(this))();
|
||||
return common.promisify(getServerInfoAsync).call(this);
|
||||
}
|
||||
|
||||
function rippleTimeToISO8601(rippleTime: string): string {
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
/* @flow */
|
||||
'use strict';
|
||||
const _ = require('lodash');
|
||||
const async = require('async');
|
||||
const BigNumber = require('bignumber.js');
|
||||
const common = require('../common');
|
||||
const composeAsync = common.composeAsync;
|
||||
|
||||
function setTransactionBitFlags(transaction: any, values: any, flags: any
|
||||
): void {
|
||||
@@ -19,9 +21,11 @@ function setTransactionBitFlags(transaction: any, values: any, flags: any
|
||||
}
|
||||
}
|
||||
|
||||
function getFeeDrops(remote) {
|
||||
function getFeeDrops(remote, callback) {
|
||||
const feeUnits = 10; // all transactions currently have a fee of 10 fee units
|
||||
return remote.feeTx(feeUnits).to_text();
|
||||
remote.feeTxAsync(feeUnits, (err, data) => {
|
||||
callback(err, data ? data.to_text() : undefined);
|
||||
});
|
||||
}
|
||||
|
||||
function formatPrepareResponse(txJSON) {
|
||||
@@ -39,42 +43,64 @@ function formatPrepareResponse(txJSON) {
|
||||
type Callback = (err: ?(typeof Error),
|
||||
data: {txJSON: string, instructions: any}) => void;
|
||||
function prepareTransaction(transaction: any, remote: any, instructions: any,
|
||||
callback: Callback): void {
|
||||
callback: Callback
|
||||
): void {
|
||||
common.validate.instructions(instructions);
|
||||
|
||||
transaction.complete();
|
||||
const account = transaction.getAccount();
|
||||
const txJSON = transaction.tx_json;
|
||||
|
||||
|
||||
function prepare1(callback_) {
|
||||
if (instructions.maxLedgerVersion !== undefined) {
|
||||
txJSON.LastLedgerSequence = parseInt(instructions.maxLedgerVersion, 10);
|
||||
callback_();
|
||||
} else {
|
||||
const offset = instructions.maxLedgerVersionOffset !== undefined ?
|
||||
parseInt(instructions.maxLedgerVersionOffset, 10) : 3;
|
||||
txJSON.LastLedgerSequence = remote.getLedgerSequence() + offset;
|
||||
remote.getLedgerSequence((error, seq) => {
|
||||
txJSON.LastLedgerSequence = seq + offset;
|
||||
callback_(error);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
function prepare2(callback_) {
|
||||
if (instructions.fee !== undefined) {
|
||||
txJSON.Fee = common.xrpToDrops(instructions.fee);
|
||||
callback_();
|
||||
} else {
|
||||
const serverFeeDrops = getFeeDrops(remote);
|
||||
getFeeDrops(remote, composeAsync((serverFeeDrops) => {
|
||||
if (instructions.maxFee !== undefined) {
|
||||
const maxFeeDrops = common.xrpToDrops(instructions.maxFee);
|
||||
txJSON.Fee = BigNumber.min(serverFeeDrops, maxFeeDrops).toString();
|
||||
} else {
|
||||
txJSON.Fee = serverFeeDrops;
|
||||
}
|
||||
}, callback_));
|
||||
}
|
||||
}
|
||||
|
||||
function prepare3(callback_) {
|
||||
if (instructions.sequence !== undefined) {
|
||||
txJSON.Sequence = parseInt(instructions.sequence, 10);
|
||||
callback(null, formatPrepareResponse(txJSON));
|
||||
callback_(null, formatPrepareResponse(txJSON));
|
||||
} else {
|
||||
remote.findAccount(account).getNextSequence(function(error, sequence) {
|
||||
txJSON.Sequence = sequence;
|
||||
callback(error, formatPrepareResponse(txJSON));
|
||||
callback_(error, formatPrepareResponse(txJSON));
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
async.series([
|
||||
prepare1,
|
||||
prepare2,
|
||||
prepare3
|
||||
], common.convertErrors(function(error, results) {
|
||||
callback(error, results && results[2]);
|
||||
}));
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
|
||||
@@ -36,6 +36,8 @@ const utils = require('./utils');
|
||||
const hashprefixes = require('./hashprefixes');
|
||||
const log = require('./log').internal.sub('remote');
|
||||
|
||||
export type GetLedgerSequenceCallback = (err?: ?Error, index?: number) => void;
|
||||
|
||||
/**
|
||||
* Interface to manage connections to rippled servers
|
||||
*
|
||||
@@ -518,7 +520,35 @@ Remote.prototype._handleMessage = function(message, server) {
|
||||
}
|
||||
};
|
||||
|
||||
Remote.prototype.getLedgerSequence = function() {
|
||||
/**
|
||||
*
|
||||
* @param {Function} [callback]
|
||||
* @api public
|
||||
*/
|
||||
|
||||
Remote.prototype.getLedgerSequence = function(callback = function() {}) {
|
||||
if (!this._servers.length) {
|
||||
callback(new Error('No servers available.'));
|
||||
return;
|
||||
}
|
||||
|
||||
if (_.isFinite(this._ledger_current_index)) {
|
||||
// the "current" ledger is the one after the most recently closed ledger
|
||||
callback(null, this._ledger_current_index - 1);
|
||||
} else {
|
||||
const self = this;
|
||||
this.once('ledger_closed', function() {
|
||||
callback(null, self._ledger_current_index - 1);
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
*
|
||||
* @api private
|
||||
*/
|
||||
|
||||
Remote.prototype.getLedgerSequenceSync = function(): number {
|
||||
if (!this._ledger_current_index) {
|
||||
throw new Error('Ledger sequence has not yet been initialized');
|
||||
}
|
||||
@@ -2307,6 +2337,32 @@ Remote.prototype.feeTx = function(units) {
|
||||
return server._feeTx(units);
|
||||
};
|
||||
|
||||
/**
|
||||
* Same as feeTx, but will wait to connect to server if currently
|
||||
* disconnected.
|
||||
*
|
||||
* @param {Number} fee units
|
||||
* @param {Function} callback
|
||||
*/
|
||||
|
||||
Remote.prototype.feeTxAsync = function(units, callback) {
|
||||
if (!this._servers.length) {
|
||||
callback(new Error('No servers available.'));
|
||||
return;
|
||||
}
|
||||
|
||||
let server = this.getServer();
|
||||
|
||||
if (!server) {
|
||||
this.once('connected', () => {
|
||||
server = this.getServer();
|
||||
callback(null, server._feeTx(units));
|
||||
});
|
||||
} else {
|
||||
callback(null, server._feeTx(units));
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Get the current recommended transaction fee unit.
|
||||
*
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
'use strict';
|
||||
|
||||
const util = require('util');
|
||||
const _ = require('lodash');
|
||||
|
||||
@@ -18,18 +20,23 @@ function RippleError(code?: any, message?: string) {
|
||||
}
|
||||
}
|
||||
|
||||
this.engine_result = this.result = (this.result || this.engine_result || this.error || 'Error');
|
||||
this.engine_result_message = this.result_message = (this.result_message || this.engine_result_message || this.error_message || 'Error');
|
||||
this.engine_result = this.result = (this.result || this.engine_result ||
|
||||
this.error || 'Error');
|
||||
this.engine_result_message = this.result_message = (this.result_message ||
|
||||
this.engine_result_message || this.error_message || 'Error');
|
||||
this.message = this.result_message;
|
||||
|
||||
let stack;
|
||||
|
||||
if (!!Error.captureStackTrace) {
|
||||
if (Boolean(Error.captureStackTrace)) {
|
||||
Error.captureStackTrace(this, code || this);
|
||||
} else if ((stack = new Error().stack)) {
|
||||
} else {
|
||||
stack = new Error().stack;
|
||||
if (Boolean(stack)) {
|
||||
this.stack = stack;
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
util.inherits(RippleError, Error);
|
||||
|
||||
|
||||
@@ -52,14 +52,16 @@ describe('RippleAPI', function() {
|
||||
});
|
||||
|
||||
it('preparePayment with all options specified', function() {
|
||||
return this.api.getLedgerVersion().then((ver) => {
|
||||
const localInstructions = {
|
||||
maxLedgerVersion: this.api.getLedgerVersion() + 100,
|
||||
maxLedgerVersion: ver + 100,
|
||||
fee: '0.000012'
|
||||
};
|
||||
return this.api.preparePayment(
|
||||
address, requests.preparePaymentAllOptions, localInstructions).then(
|
||||
_.partial(checkResult, responses.preparePaymentAllOptions, 'prepare'));
|
||||
});
|
||||
});
|
||||
|
||||
it('preparePayment without counterparty set', function() {
|
||||
const localInstructions = _.defaults({sequence: 23}, instructions);
|
||||
@@ -637,8 +639,13 @@ describe('RippleAPI', function() {
|
||||
});
|
||||
});
|
||||
|
||||
it('getLedgerVersion', function() {
|
||||
assert.strictEqual(this.api.getLedgerVersion(), 8819951);
|
||||
it('getLedgerVersion', function(done) {
|
||||
this.api.getLedgerVersion().then((ver) => {
|
||||
assert.strictEqual(ver, 8819951);
|
||||
done();
|
||||
}, (err) => {
|
||||
done(err);
|
||||
});
|
||||
});
|
||||
|
||||
it('getLedger', function() {
|
||||
|
||||
Reference in New Issue
Block a user