eosjs-cluster

eosjs-cluster can be used same way as using eosjs library. When there happens a problem with an endpoint, eosjs-cluster automatically calls the same request to the next endpoint.

it catches ENOTFOUND and ECONNREFUSED, "Too many request" for it.

It also supports browsers 🙂

Install

npm install --save eosjs@latest eosjs-cluster

Migrate from eosjs to eosjs-cluster

You can use a instance of EosCluster same way with eosjs object.

// they are same.
const eos = Eos({httpEndpoint, chainId, keyProvider});
const { EosCluster, EosClusterV2 } = require('eosjs-cluster');
const eos = EosCluster([httpEndpoint], {chainId, keyProvider});
const eos = EosClusterV2({httpEndpoint, chainId, keyProvider});
const eos = EosClusterV2({[httpEndpoint], chainId, keyProvider});

// For Scatter
/////////////////////////////////
// This is not supported yet!! //
/////////////////////////////////
const httpEndpoints = [
	'https://eos.greymass.com', // First endpoint shoule be same with eosChainInfo.host
	'https://api.main-net.eosnodeone.io',
	'https://api.eosnewyork.io'
];
const eosChainInfo = {
	blockchain: 'eos',
	host: 'eos.greymass.com', // This host value shoule be same with httpEndpoints[0]
	port: 443,
	chainId: 'aca376f206b8fc25a6ed44dbdc66547c36c6c33e3a119ffbeaef943642f0e906'
};
const { EosClusterScatter } = require('eosjs-cluster');
scatterObj.eos(eosChainInfo, EosClusterScatter(httpEndpoints), { chainId: 'aca376f206b8fc25a6ed44dbdc66547c36c6c33e3a119ffbeaef943642f0e906', binaryen: Binaryen }, 'https');

Example

const httpEndpoints = [
	'https://some-wrong-end-point-1.com', // Wrong Endpoint for test
	'https://some-wrong-end-point-2.com', // Wrong Endpoint for test
	'https://eos.greymass.com',
	'https://api.main-net.eosnodeone.io',
	'https://api.eosnewyork.io'
];
const chainId = 'aca376f206b8fc25a6ed44dbdc66547c36c6c33e3a119ffbeaef943642f0e906';
const keyProvider = ['PrivateKey1', 'PrivateKey2'];
const account = 'accountname1';

const { EosCluster } = require('eosjs-cluster');

// Do not use httpEndpoint in second parameter.
// EosCluster(httpEndpoints, {httpEndpoint: 'This is wrong usage!!', chainId, keyProvider});

// EosCluster([] or null or undefined, {chainId, keyProvider});
// == Eos({chainId, keyProvider});

const eos = EosCluster(httpEndpoints, {chainId, keyProvider});

eos.getCurrencyBalance('eosio.token', 'leckoaccount', 'EOS')
.then((res) => {
	console.log(res);
})
.catch((err) => {
	console.log(err);
});

Related projects(Projects using eosjs-cluster)

DEXEOS, EOS based Decentralized Exchange

Bloks.io - EOS Block Explorer