Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

internal/jsre/deps: fix typo in jsdoc #28511

Merged
merged 3 commits into from
Nov 15, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Revert "[jsdoc]: fix formatOutputUInt function return type"
This reverts commit 3dc1842.
  • Loading branch information
aliening committed Nov 12, 2023

Partially verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
We cannot verify signatures from co-authors, and some of the co-authors attributed to this commit require their commits to be signed.
commit 8795a151868c3a5e39e093175f56bd34e668c3d4
80 changes: 40 additions & 40 deletions internal/jsre/deps/web3.js
Original file line number Diff line number Diff line change
@@ -1033,7 +1033,7 @@ var formatOutputInt = function (param) {
*
* @method formatOutputUInt
* @param {SolidityParam}
* @returns {BigNumber} right-aligned output bytes formatted to uint
* @returns {BigNumeber} right-aligned output bytes formatted to uint
*/
var formatOutputUInt = function (param) {
var value = param.staticPart() || "0";
@@ -1192,7 +1192,7 @@ module.exports = SolidityTypeInt;
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 param.js
* @author Marek Kotewicz <[email protected]>
* @date 2015
@@ -1211,7 +1211,7 @@ var SolidityParam = function (value, offset) {

/**
* This method should be used to get length of params's dynamic part
*
*
* @method dynamicPartLength
* @returns {Number} length of dynamic part (in bytes)
*/
@@ -1239,7 +1239,7 @@ SolidityParam.prototype.withOffset = function (offset) {
* @param {SolidityParam} result of combination
*/
SolidityParam.prototype.combine = function (param) {
return new SolidityParam(this.value + param.value);
return new SolidityParam(this.value + param.value);
};

/**
@@ -1271,8 +1271,8 @@ SolidityParam.prototype.offsetAsBytes = function () {
*/
SolidityParam.prototype.staticPart = function () {
if (!this.isDynamic()) {
return this.value;
}
return this.value;
}
return this.offsetAsBytes();
};

@@ -1304,7 +1304,7 @@ SolidityParam.prototype.encode = function () {
* @returns {String}
*/
SolidityParam.encodeList = function (params) {

// updating offsets
var totalOffset = params.length * 32;
var offsetParams = params.map(function (param) {
@@ -1746,13 +1746,13 @@ if (typeof XMLHttpRequest === 'undefined') {

/**
* Utils
*
*
* @module utils
*/

/**
* Utility functions
*
*
* @class [utils] config
* @constructor
*/
@@ -1819,7 +1819,7 @@ module.exports = {
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 sha3.js
* @author Marek Kotewicz <[email protected]>
* @date 2015
@@ -2739,7 +2739,7 @@ module.exports = AllSolidityEvents;
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 batch.js
* @author Marek Kotewicz <[email protected]>
* @date 2015
@@ -2784,7 +2784,7 @@ Batch.prototype.execute = function () {
requests[index].callback(null, (requests[index].format ? requests[index].format(result.result) : result.result));
}
});
});
});
};

module.exports = Batch;
@@ -2971,7 +2971,7 @@ var ContractFactory = function (eth, abi) {
*/
this.new = function () {
/*jshint maxcomplexity: 7 */

var contract = new Contract(this.eth, this.abi);

// parse arguments
@@ -3119,7 +3119,7 @@ module.exports = ContractFactory;
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 errors.js
* @author Marek Kotewicz <[email protected]>
* @date 2015
@@ -3394,7 +3394,7 @@ var extend = function (web3) {
}
};

ex.formatters = formatters;
ex.formatters = formatters;
ex.utils = utils;
ex.Method = Method;
ex.Property = Property;
@@ -4443,7 +4443,7 @@ module.exports = HttpProvider;
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 iban.js
* @author Marek Kotewicz <[email protected]>
* @date 2015
@@ -4643,7 +4643,7 @@ Iban.prototype.address = function () {
var base36 = this._iban.substr(4);
var asBn = new BigNumber(base36, 36);
return padLeft(asBn.toString(16), 20);
}
}

return '';
};
@@ -4688,7 +4688,7 @@ var IpcProvider = function (path, net) {
var _this = this;
this.responseCallbacks = {};
this.path = path;

this.connection = net.connect({path: this.path});

this.connection.on('error', function(e){
@@ -4698,7 +4698,7 @@ var IpcProvider = function (path, net) {

this.connection.on('end', function(){
_this._timeout();
});
});


// LISTEN FOR CONNECTION RESPONSES
@@ -4737,7 +4737,7 @@ Will parse the response and make an array out of it.
IpcProvider.prototype._parseResponse = function(data) {
var _this = this,
returnValues = [];

// DE-CHUNKER
var dechunkedData = data
.replace(/\}[\n\r]?\{/g,'}|--|{') // }{
@@ -4841,7 +4841,7 @@ IpcProvider.prototype.send = function (payload) {
try {
result = JSON.parse(data);
} catch(e) {
throw errors.InvalidResponse(data);
throw errors.InvalidResponse(data);
}

return result;
@@ -5016,7 +5016,7 @@ Method.prototype.extractCallback = function (args) {

/**
* Should be called to check if the number of arguments is correct
*
*
* @method validateArgs
* @param {Array} arguments
* @throws {Error} if it is not
@@ -5029,7 +5029,7 @@ Method.prototype.validateArgs = function (args) {

/**
* Should be called to format input args of method
*
*
* @method formatInput
* @param {Array}
* @return {Array}
@@ -5083,7 +5083,7 @@ Method.prototype.attachToObject = function (obj) {
obj[name[0]] = obj[name[0]] || {};
obj[name[0]][name[1]] = func;
} else {
obj[name[0]] = func;
obj[name[0]] = func;
}
};

@@ -5146,8 +5146,8 @@ var DB = function (web3) {
this._requestManager = web3._requestManager;

var self = this;

methods().forEach(function(method) {
methods().forEach(function(method) {
method.attachToObject(self);
method.setRequestManager(web3._requestManager);
});
@@ -5572,7 +5572,7 @@ var Net = function (web3) {

var self = this;

properties().forEach(function(p) {
properties().forEach(function(p) {
p.attachToObject(self);
p.setRequestManager(web3._requestManager);
});
@@ -6131,7 +6131,7 @@ module.exports = {
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 namereg.js
* @author Marek Kotewicz <[email protected]>
* @date 2015
@@ -6318,7 +6318,7 @@ module.exports = Property;
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 requestmanager.js
* @author Jeffrey Wilcke <[email protected]>
* @author Marek Kotewicz <[email protected]>
@@ -6385,7 +6385,7 @@ RequestManager.prototype.sendAsync = function (data, callback) {
if (err) {
return callback(err);
}

if (!Jsonrpc.isValidResponse(result)) {
return callback(errors.InvalidResponse(result));
}
@@ -6418,7 +6418,7 @@ RequestManager.prototype.sendBatch = function (data, callback) {
}

callback(err, results);
});
});
};

/**
@@ -6522,7 +6522,7 @@ RequestManager.prototype.poll = function () {
}

var payload = Jsonrpc.toBatchPayload(pollsData);

// map the request id to they poll id
var pollsIdMap = {};
payload.forEach(function(load, index){
@@ -6552,7 +6552,7 @@ RequestManager.prototype.poll = function () {
} else
return false;
}).filter(function (result) {
return !!result;
return !!result;
}).filter(function (result) {
var valid = Jsonrpc.isValidResponse(result);
if (!valid) {
@@ -6627,16 +6627,16 @@ var pollSyncing = function(self) {

self.callbacks.forEach(function (callback) {
if (self.lastSyncState !== sync) {

// call the callback with true first so the app can stop anything, before receiving the sync data
if(!self.lastSyncState && utils.isObject(sync))
callback(null, true);

// call on the next CPU cycle, so the actions of the sync stop can be processes first
setTimeout(function() {
callback(null, sync);
}, 0);

self.lastSyncState = sync;
}
});
@@ -6691,7 +6691,7 @@ module.exports = IsSyncing;
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 transfer.js
* @author Marek Kotewicz <[email protected]>
* @date 2015
@@ -6710,15 +6710,15 @@ var exchangeAbi = require('../contracts/SmartExchange.json');
* @param {Function} callback, callback
*/
var transfer = function (eth, from, to, value, callback) {
var iban = new Iban(to);
var iban = new Iban(to);
if (!iban.isValid()) {
throw new Error('invalid iban address');
}

if (iban.isDirect()) {
return transferToAddress(eth, from, iban.address(), value, callback);
}

if (!callback) {
var address = eth.icapNamereg().addr(iban.institution());
return deposit(eth, from, address, value, iban.client());
@@ -6727,7 +6727,7 @@ var transfer = function (eth, from, to, value, callback) {
eth.icapNamereg().addr(iban.institution(), function (err, address) {
return deposit(eth, from, address, value, iban.client(), callback);
});

};

/**