From 380d9862c399602045886fb05ee628539675383c Mon Sep 17 00:00:00 2001 From: Marek Kotewicz Date: Tue, 13 Jan 2015 12:49:10 +0100 Subject: tests in progress, fixed utf characters conversion in toAscii --- lib/web3.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'lib/web3.js') diff --git a/lib/web3.js b/lib/web3.js index 4220114f9..85f2f9065 100644 --- a/lib/web3.js +++ b/lib/web3.js @@ -244,12 +244,12 @@ var web3 = { if (hex.substring(0, 2) === '0x') i = 2; for(; i < l; i+=2) { - var code = hex.charCodeAt(i); + var code = parseInt(hex.substr(i, 2), 16); if(code === 0) { break; } - str += String.fromCharCode(parseInt(hex.substr(i, 2), 16)); + str += String.fromCharCode(code); } return str; -- cgit v1.2.3 From 8b7d4b0c9ed7113b685ecbae646b9d7df5a89aca Mon Sep 17 00:00:00 2001 From: Marek Kotewicz Date: Tue, 13 Jan 2015 17:05:05 +0100 Subject: beginning of comments in web3 --- lib/web3.js | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) (limited to 'lib/web3.js') diff --git a/lib/web3.js b/lib/web3.js index 85f2f9065..a27940f84 100644 --- a/lib/web3.js +++ b/lib/web3.js @@ -23,6 +23,9 @@ * @date 2014 */ +/// Recursively resolves all promises in given object and replaces the resolved values with promises +/// @param any object/array/promise/anything else.. +/// @returns (resolves) object with replaced promises with their result function flattenPromise (obj) { if (obj instanceof Promise) { return Promise.resolve(obj); @@ -62,12 +65,14 @@ function flattenPromise (obj) { return Promise.resolve(obj); } +/// @returns an array of objects describing web3 api methods var web3Methods = function () { return [ { name: 'sha3', call: 'web3_sha3' } ]; }; +/// @returns an array of objects describing web3.eth api methods var ethMethods = function () { var blockCall = function (args) { return typeof args[0] === "string" ? "eth_blockByHash" : "eth_blockByNumber"; @@ -101,6 +106,7 @@ var ethMethods = function () { return methods; }; +/// @returns an array of objects describing web3.eth api properties var ethProperties = function () { return [ { name: 'coinbase', getter: 'eth_coinbase', setter: 'eth_setCoinbase' }, @@ -115,6 +121,7 @@ var ethProperties = function () { ]; }; +/// @returns an array of objects describing web3.db api methods var dbMethods = function () { return [ { name: 'put', call: 'db_put' }, @@ -124,6 +131,7 @@ var dbMethods = function () { ]; }; +/// @returns an array of objects describing web3.shh api methods var shhMethods = function () { return [ { name: 'post', call: 'shh_post' }, @@ -134,6 +142,7 @@ var shhMethods = function () { ]; }; +/// @returns an array of objects describing web3.eth.watch api methods var ethWatchMethods = function () { var newFilter = function (args) { return typeof args[0] === 'string' ? 'eth_newFilterString' : 'eth_newFilter'; @@ -146,6 +155,7 @@ var ethWatchMethods = function () { ]; }; +/// @returns an array of objects describing web3.shh.watch api methods var shhWatchMethods = function () { return [ { name: 'newFilter', call: 'shh_newFilter' }, @@ -154,6 +164,8 @@ var shhWatchMethods = function () { ]; }; +/// creates methods in a given object based on method description on input +/// setups api calls for these methods var setupMethods = function (obj, methods) { methods.forEach(function (method) { obj[method.name] = function () { @@ -177,6 +189,8 @@ var setupMethods = function (obj, methods) { }); }; +/// creates properties in a given object based on properties description on input +/// setups api calls for these properties var setupProperties = function (obj, properties) { properties.forEach(function (property) { var proto = {}; @@ -221,7 +235,7 @@ var decToHex = function (dec) { return parseInt(dec).toString(16); }; - +/// setups web3 object, and it's in-browser executed methods var web3 = { _callbacks: {}, _events: {}, @@ -339,6 +353,7 @@ var web3 = { } }; +/// setups all api methods setupMethods(web3, web3Methods()); setupMethods(web3.eth, ethMethods()); setupProperties(web3.eth, ethProperties()); @@ -348,12 +363,16 @@ setupMethods(web3.shh, shhMethods()); var ethWatch = { changed: 'eth_changed' }; + setupMethods(ethWatch, ethWatchMethods()); + var shhWatch = { changed: 'shh_changed' }; + setupMethods(shhWatch, shhWatchMethods()); +/// Provider manager object prototype var ProviderManager = function() { this.queued = []; this.polls = []; @@ -375,6 +394,7 @@ var ProviderManager = function() { poll(); }; +/// sends outgoing requests, if provider is not available, enqueue the request ProviderManager.prototype.send = function(data, cb) { data._id = this.id; if (cb) { @@ -392,6 +412,7 @@ ProviderManager.prototype.send = function(data, cb) { } }; +/// setups provider, which will be used for sending messages ProviderManager.prototype.set = function(provider) { if(this.provider !== undefined && this.provider.unload !== undefined) { this.provider.unload(); @@ -401,6 +422,7 @@ ProviderManager.prototype.set = function(provider) { this.ready = true; }; +/// resends queued messages ProviderManager.prototype.sendQueued = function() { for(var i = 0; this.queued.length; i++) { // Resend @@ -408,10 +430,13 @@ ProviderManager.prototype.sendQueued = function() { } }; +/// @returns true if the provider i properly set ProviderManager.prototype.installed = function() { return this.provider !== undefined; }; +/// this method is only used, when we do not have native qt bindings and have to do polling on our own +/// should be callled, on start watching for eth/shh changes ProviderManager.prototype.startPolling = function (data, pollId) { if (!this.provider || !this.provider.poll) { return; @@ -419,6 +444,7 @@ ProviderManager.prototype.startPolling = function (data, pollId) { this.polls.push({data: data, id: pollId}); }; +/// should be called to stop polling for certain watch changes ProviderManager.prototype.stopPolling = function (pollId) { for (var i = this.polls.length; i--;) { var poll = this.polls[i]; @@ -436,10 +462,13 @@ web3.setProvider = function(provider) { web3.provider.sendQueued(); }; +/// returns true if provider is installed web3.haveProvider = function() { return !!web3.provider.provider; }; +/// should be used when we want to watch something +/// it's using inner polling mechanism and is notified about changes var Filter = function(options, impl) { this.impl = impl; this.callbacks = []; @@ -453,10 +482,12 @@ var Filter = function(options, impl) { }); }; +/// alias for changed* Filter.prototype.arrived = function(callback) { this.changed(callback); }; +/// gets called when there is new eth/shh message Filter.prototype.changed = function(callback) { var self = this; this.promise.then(function(id) { @@ -464,12 +495,14 @@ Filter.prototype.changed = function(callback) { }); }; +/// trigger calling new message from people Filter.prototype.trigger = function(messages) { for(var i = 0; i < this.callbacks.length; i++) { this.callbacks[i].call(this, messages); } }; +/// should be called to uninstall current filter Filter.prototype.uninstall = function() { var self = this; this.promise.then(function (id) { @@ -479,6 +512,7 @@ Filter.prototype.uninstall = function() { }); }; +/// should be called to manually trigger getting latest messages from the client Filter.prototype.messages = function() { var self = this; return this.promise.then(function (id) { @@ -486,10 +520,12 @@ Filter.prototype.messages = function() { }); }; +/// alias for messages Filter.prototype.logs = function () { return this.messages(); }; +/// callled when there is new incoming message function messageHandler(data) { if(data._event !== undefined) { web3.trigger(data._event, data._id, data.data); -- cgit v1.2.3 From 9a8f45ee30aafad9f40beb646cd0be846277e0ea Mon Sep 17 00:00:00 2001 From: Marek Kotewicz Date: Tue, 13 Jan 2015 18:28:49 +0100 Subject: Filter separated to filter.js file --- lib/web3.js | 60 +++--------------------------------------------------------- 1 file changed, 3 insertions(+), 57 deletions(-) (limited to 'lib/web3.js') diff --git a/lib/web3.js b/lib/web3.js index a27940f84..527022c62 100644 --- a/lib/web3.js +++ b/lib/web3.js @@ -14,7 +14,7 @@ You should have received a copy of the GNU Lesser General Public License along with ethereum.js. If not, see . */ -/** @file main.js +/** @file web3.js * @authors: * Jeffrey Wilcke * Marek Kotewicz @@ -23,6 +23,8 @@ * @date 2014 */ +var Filter = require('./filter'); + /// Recursively resolves all promises in given object and replaces the resolved values with promises /// @param any object/array/promise/anything else.. /// @returns (resolves) object with replaced promises with their result @@ -467,63 +469,7 @@ web3.haveProvider = function() { return !!web3.provider.provider; }; -/// should be used when we want to watch something -/// it's using inner polling mechanism and is notified about changes -var Filter = function(options, impl) { - this.impl = impl; - this.callbacks = []; - - var self = this; - this.promise = impl.newFilter(options); - this.promise.then(function (id) { - self.id = id; - web3.on(impl.changed, id, self.trigger.bind(self)); - web3.provider.startPolling({call: impl.changed, args: [id]}, id); - }); -}; - -/// alias for changed* -Filter.prototype.arrived = function(callback) { - this.changed(callback); -}; - -/// gets called when there is new eth/shh message -Filter.prototype.changed = function(callback) { - var self = this; - this.promise.then(function(id) { - self.callbacks.push(callback); - }); -}; -/// trigger calling new message from people -Filter.prototype.trigger = function(messages) { - for(var i = 0; i < this.callbacks.length; i++) { - this.callbacks[i].call(this, messages); - } -}; - -/// should be called to uninstall current filter -Filter.prototype.uninstall = function() { - var self = this; - this.promise.then(function (id) { - self.impl.uninstallFilter(id); - web3.provider.stopPolling(id); - web3.off(impl.changed, id); - }); -}; - -/// should be called to manually trigger getting latest messages from the client -Filter.prototype.messages = function() { - var self = this; - return this.promise.then(function (id) { - return self.impl.getMessages(id); - }); -}; - -/// alias for messages -Filter.prototype.logs = function () { - return this.messages(); -}; /// callled when there is new incoming message function messageHandler(data) { -- cgit v1.2.3 From 422dc05bb054b86d72b313edc2e7cb79dfb70ba3 Mon Sep 17 00:00:00 2001 From: Marek Kotewicz Date: Tue, 13 Jan 2015 18:40:01 +0100 Subject: ProviderManager separated to providermanager.js file --- lib/web3.js | 82 +------------------------------------------------------------ 1 file changed, 1 insertion(+), 81 deletions(-) (limited to 'lib/web3.js') diff --git a/lib/web3.js b/lib/web3.js index 527022c62..47decb8bd 100644 --- a/lib/web3.js +++ b/lib/web3.js @@ -24,6 +24,7 @@ */ var Filter = require('./filter'); +var ProviderManager = require('./providermanager'); /// Recursively resolves all promises in given object and replaces the resolved values with promises /// @param any object/array/promise/anything else.. @@ -374,87 +375,6 @@ var shhWatch = { setupMethods(shhWatch, shhWatchMethods()); -/// Provider manager object prototype -var ProviderManager = function() { - this.queued = []; - this.polls = []; - this.ready = false; - this.provider = undefined; - this.id = 1; - - var self = this; - var poll = function () { - if (self.provider && self.provider.poll) { - self.polls.forEach(function (data) { - data.data._id = self.id; - self.id++; - self.provider.poll(data.data, data.id); - }); - } - setTimeout(poll, 12000); - }; - poll(); -}; - -/// sends outgoing requests, if provider is not available, enqueue the request -ProviderManager.prototype.send = function(data, cb) { - data._id = this.id; - if (cb) { - web3._callbacks[data._id] = cb; - } - - data.args = data.args || []; - this.id++; - - if(this.provider !== undefined) { - this.provider.send(data); - } else { - console.warn("provider is not set"); - this.queued.push(data); - } -}; - -/// setups provider, which will be used for sending messages -ProviderManager.prototype.set = function(provider) { - if(this.provider !== undefined && this.provider.unload !== undefined) { - this.provider.unload(); - } - - this.provider = provider; - this.ready = true; -}; - -/// resends queued messages -ProviderManager.prototype.sendQueued = function() { - for(var i = 0; this.queued.length; i++) { - // Resend - this.send(this.queued[i]); - } -}; - -/// @returns true if the provider i properly set -ProviderManager.prototype.installed = function() { - return this.provider !== undefined; -}; - -/// this method is only used, when we do not have native qt bindings and have to do polling on our own -/// should be callled, on start watching for eth/shh changes -ProviderManager.prototype.startPolling = function (data, pollId) { - if (!this.provider || !this.provider.poll) { - return; - } - this.polls.push({data: data, id: pollId}); -}; - -/// should be called to stop polling for certain watch changes -ProviderManager.prototype.stopPolling = function (pollId) { - for (var i = this.polls.length; i--;) { - var poll = this.polls[i]; - if (poll.id === pollId) { - this.polls.splice(i, 1); - } - } -}; web3.provider = new ProviderManager(); -- cgit v1.2.3 From 8d1f96cc0aa608c319a48af5a3c2397b694d5930 Mon Sep 17 00:00:00 2001 From: Marek Kotewicz Date: Wed, 14 Jan 2015 10:50:34 +0100 Subject: few comments --- lib/web3.js | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) (limited to 'lib/web3.js') diff --git a/lib/web3.js b/lib/web3.js index 47decb8bd..25c2901a8 100644 --- a/lib/web3.js +++ b/lib/web3.js @@ -254,6 +254,7 @@ var web3 = { return hex; }, + /// @returns ascii string representation of hex value prefixed with 0x toAscii: function(hex) { // Find termination var str = ""; @@ -272,6 +273,7 @@ var web3 = { return str; }, + /// @returns hex representation (prefixed by 0x) of ascii string fromAscii: function(str, pad) { pad = pad === undefined ? 0 : pad; var hex = this.toHex(str); @@ -280,14 +282,17 @@ var web3 = { return "0x" + hex; }, + /// @returns decimal representaton of hex value prefixed by 0x toDecimal: function (val) { return hexToDec(val.substring(2)); }, + /// @returns hex representation (prefixed by 0x) of decimal value fromDecimal: function (val) { return "0x" + decToHex(val); }, + /// used to transform value/string to eth string toEth: function(str) { var val = typeof str === "string" ? str.indexOf('0x') === 0 ? parseInt(str.substr(2), 16) : parseInt(str) : str; var unit = 0; @@ -311,24 +316,24 @@ var web3 = { return s + ' ' + units[unit]; }, + /// eth object prototype eth: { - prototype: Object(), // jshint ignore:line watch: function (params) { return new Filter(params, ethWatch); } }, - db: { - prototype: Object() // jshint ignore:line - }, + /// db object prototype + db: {}, + /// shh object prototype shh: { - prototype: Object(), // jshint ignore:line watch: function (params) { return new Filter(params, shhWatch); } }, + /// used by filter to register callback with given id on: function(event, id, cb) { if(web3._events[event] === undefined) { web3._events[event] = {}; @@ -338,6 +343,7 @@ var web3 = { return this; }, + /// used by filter to unregister callback with given id off: function(event, id) { if(web3._events[event] !== undefined) { delete web3._events[event][id]; @@ -346,6 +352,7 @@ var web3 = { return this; }, + /// used to trigger callback registered by filter trigger: function(event, id, data) { var callbacks = web3._events[event]; if (!callbacks || !callbacks[id]) { @@ -353,6 +360,11 @@ var web3 = { } var cb = callbacks[id]; cb(data); + }, + + /// @returns true if provider is installed + haveProvider: function() { + return !!web3.provider.provider; } }; @@ -375,7 +387,6 @@ var shhWatch = { setupMethods(shhWatch, shhWatchMethods()); - web3.provider = new ProviderManager(); web3.setProvider = function(provider) { @@ -384,13 +395,6 @@ web3.setProvider = function(provider) { web3.provider.sendQueued(); }; -/// returns true if provider is installed -web3.haveProvider = function() { - return !!web3.provider.provider; -}; - - - /// callled when there is new incoming message function messageHandler(data) { if(data._event !== undefined) { -- cgit v1.2.3