/*
This file is part of web3.js.
web3.js is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
web3.js is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file httpprovider.js
* @authors:
* Marek Kotewicz <marek@parity.io>
* Marian Oancea
* Fabian Vogelsteller <fabian@ethereum.org>
* AyanamiTech <ayanami0330@protonmail.com>
* @date 2015
*/
var errors = require('web3-core-helpers').errors;
var fetch = require('cross-fetch');
var http = require('http');
var https = require('https');
// Apply missing polyfill for IE
require('es6-promise').polyfill();
// import abortController if abortController is not included in node
if (typeof global !== "undefined" && !global.AbortController) {
require('abortcontroller-polyfill/dist/polyfill-patch-fetch');
}
/**
* HttpProvider should be used to send rpc calls over http
*/
var HttpProvider = function HttpProvider(host, options) {
options = options || {};
this.withCredentials = options.withCredentials;
this.timeout = options.timeout || 0;
this.headers = options.headers;
this.agent = options.agent;
this.forceGlobalFetch = options.forceGlobalFetch || false;
this.connected = false;
// keepAlive is true unless explicitly set to false
const keepAlive = options.keepAlive !== false;
this.host = host || 'http://localhost:8545';
if (!this.agent) {
if (this.host.substring(0, 5) === "https") {
this.httpsAgent = new https.Agent({ keepAlive });
}
else {
this.httpAgent = new http.Agent({ keepAlive });
}
}
};
/**
* Should be used to make async request
*
* @method send
* @param {Object} payload
* @param {Function} callback triggered on end with (err, result)
*/
HttpProvider.prototype.send = function (payload, callback) {
var options = {
method: 'POST',
body: JSON.stringify(payload)
};
var headers = {};
var controller;
var fetchFunc = this.forceGlobalFetch ? globalThis.fetch : fetch;
if (typeof AbortController !== 'undefined') {
controller = new AbortController();
}
else if (typeof window !== 'undefined' && typeof window.AbortController !== 'undefined') {
// Some chrome version doesn't recognize new AbortController(); so we are using it from window instead
// https://stackoverflow.com/questions/55718778/why-abortcontroller-is-not-defined
controller = new window.AbortController();
}
if (typeof controller !== 'undefined') {
options.signal = controller.signal;
}
// the current runtime is node
if (typeof XMLHttpRequest === 'undefined') {
// https://github.com/node-fetch/node-fetch#custom-agent
var agents = { httpsAgent: this.httpsAgent, httpAgent: this.httpAgent };
if (this.agent) {
agents.httpsAgent = this.agent.https;
agents.httpAgent = this.agent.http;
}
if (this.host.substring(0, 5) === "https") {
options.agent = agents.httpsAgent;
}
else {
options.agent = agents.httpAgent;
}
}
if (this.headers) {
this.headers.forEach(function (header) {
headers[header.name] = header.value;
});
}
// Default headers
if (!headers['Content-Type']) {
headers['Content-Type'] = 'application/json';
}
// As the Fetch API supports the credentials as following options 'include', 'omit', 'same-origin'
// https://developer.mozilla.org/en-US/docs/Web/API/fetch#credentials
// To avoid breaking change in 1.x we override this value based on boolean option.
if (this.withCredentials) {
options.credentials = 'include';
}
else {
options.credentials = 'omit';
}
options.headers = headers;
if (this.timeout > 0 && typeof controller !== 'undefined') {
this.timeoutId = setTimeout(function () {
controller.abort();
}, this.timeout);
}
var success = function (response) {
if (this.timeoutId !== undefined) {
clearTimeout(this.timeoutId);
}
// Response is a stream data so should be awaited for json response
response
.json()
.then(function (data) {
callback(null, data);
}, function () {
response
.text()
.then(function (text) {
callback(errors.InvalidResponse(text));
}, function () {
callback(errors.InvalidResponse(""));
});
});
};
var failed = function (error) {
if (this.timeoutId !== undefined) {
clearTimeout(this.timeoutId);
}
if (error.name === 'AbortError') {
callback(errors.ConnectionTimeout(this.timeout));
return;
}
callback(errors.InvalidConnection(this.host, error));
};
fetchFunc(this.host, options)
.then(success.bind(this), failed.bind(this));
};
HttpProvider.prototype.disconnect = function () {
//NO OP
};
/**
* Returns the desired boolean.
*
* @method supportsSubscriptions
* @returns {boolean}
*/
HttpProvider.prototype.supportsSubscriptions = function () {
return false;
};
module.exports = HttpProvider;