@silasdavis/legacy-db/lib/consensus.js

Javascript library that calls a Hyperledger Burrow server over rpc.

/**
 * @file consensus.js
 * @fileOverview Factory module for the Consensus class.
 * @author Andreas Olofsson
 * @module consensus
 */
'use strict'

var util = require('./util')
var nUtil = require('util')

/**
 * Create a new instance of the Consensus class.
 *
 * @param {module:rpc/client~Client} client - The client object.
 * @returns {Consensus} - A new instance of the Consensus class.
 */
exports.createInstance = function (server) {
  return new Consensus(server)
}

/**
 * The Consensus class has methods that relates to consensus mechanisms, such as
 * getting a list of all validators, and querying the consensus state.
 *
 * @param {module:rpc/client~Client} client - The client object.
 * @augments module:util~ComponentBase
 * @constructor
 */
function Consensus (server) {
  util.ComponentBase.call(this, server)
}

nUtil.inherits(Consensus, util.ComponentBase)

/**
 * Get a list of all validators.
 *
 * @param {module:rpc/rpc~methodCallback} callback - The callback function.
 */
Consensus.prototype.getValidators = function (callback) {
  this.server.getValidators(callback)
}

/**
 * Get the consensus state.
 *
 * @param {module:rpc/rpc~methodCallback} callback - The callback function.
 */
Consensus.prototype.getState = function (callback) {
  this.server.getConsensusState(callback)
}