Official Go implementation of the Ethereum protocol
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
go-ethereum/lib/web3.js

416 lines
13 KiB

/*
This file is part of ethereum.js.
ethereum.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.
ethereum.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 ethereum.js. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file web3.js
* @authors:
* Jeffrey Wilcke <jeff@ethdev.com>
* Marek Kotewicz <marek@ethdev.com>
* Marian Oancea <marian@ethdev.com>
10 years ago
* Gav Wood <g@ethdev.com>
* @date 2014
*/
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..
/// @returns (resolves) object with replaced promises with their result
10 years ago
function flattenPromise (obj) {
if (obj instanceof Promise) {
return Promise.resolve(obj);
}
10 years ago
if (obj instanceof Array) {
return new Promise(function (resolve) {
var promises = obj.map(function (o) {
return flattenPromise(o);
});
10 years ago
return Promise.all(promises).then(function (res) {
for (var i = 0; i < obj.length; i++) {
obj[i] = res[i];
}
resolve(obj);
});
10 years ago
});
}
10 years ago
if (obj instanceof Object) {
return new Promise(function (resolve) {
var keys = Object.keys(obj);
var promises = keys.map(function (key) {
return flattenPromise(obj[key]);
});
10 years ago
return Promise.all(promises).then(function (res) {
for (var i = 0; i < keys.length; i++) {
obj[keys[i]] = res[i];
}
resolve(obj);
});
});
}
10 years ago
return Promise.resolve(obj);
}
/// @returns an array of objects describing web3 api methods
10 years ago
var web3Methods = function () {
return [
{ name: 'sha3', call: 'web3_sha3' }
];
};
/// @returns an array of objects describing web3.eth api methods
10 years ago
var ethMethods = function () {
var blockCall = function (args) {
return typeof args[0] === "string" ? "eth_blockByHash" : "eth_blockByNumber";
};
10 years ago
var transactionCall = function (args) {
10 years ago
return typeof args[0] === "string" ? 'eth_transactionByHash' : 'eth_transactionByNumber';
};
10 years ago
var uncleCall = function (args) {
10 years ago
return typeof args[0] === "string" ? 'eth_uncleByHash' : 'eth_uncleByNumber';
};
10 years ago
var methods = [
{ name: 'balanceAt', call: 'eth_balanceAt' },
{ name: 'stateAt', call: 'eth_stateAt' },
10 years ago
{ name: 'storageAt', call: 'eth_storageAt' },
10 years ago
{ name: 'countAt', call: 'eth_countAt'},
{ name: 'codeAt', call: 'eth_codeAt' },
{ name: 'transact', call: 'eth_transact' },
{ name: 'call', call: 'eth_call' },
{ name: 'block', call: blockCall },
{ name: 'transaction', call: transactionCall },
{ name: 'uncle', call: uncleCall },
{ name: 'compilers', call: 'eth_compilers' },
{ name: 'lll', call: 'eth_lll' },
{ name: 'solidity', call: 'eth_solidity' },
10 years ago
{ name: 'serpent', call: 'eth_serpent' },
{ name: 'logs', call: 'eth_logs' }
10 years ago
];
return methods;
};
/// @returns an array of objects describing web3.eth api properties
10 years ago
var ethProperties = function () {
return [
{ name: 'coinbase', getter: 'eth_coinbase', setter: 'eth_setCoinbase' },
{ name: 'listening', getter: 'eth_listening', setter: 'eth_setListening' },
{ name: 'mining', getter: 'eth_mining', setter: 'eth_setMining' },
{ name: 'gasPrice', getter: 'eth_gasPrice' },
{ name: 'account', getter: 'eth_account' },
{ name: 'accounts', getter: 'eth_accounts' },
{ name: 'peerCount', getter: 'eth_peerCount' },
{ name: 'defaultBlock', getter: 'eth_defaultBlock', setter: 'eth_setDefaultBlock' },
{ name: 'number', getter: 'eth_number'}
];
};
/// @returns an array of objects describing web3.db api methods
10 years ago
var dbMethods = function () {
return [
{ name: 'put', call: 'db_put' },
{ name: 'get', call: 'db_get' },
{ name: 'putString', call: 'db_putString' },
{ name: 'getString', call: 'db_getString' }
];
};
/// @returns an array of objects describing web3.shh api methods
10 years ago
var shhMethods = function () {
return [
{ name: 'post', call: 'shh_post' },
{ name: 'newIdentity', call: 'shh_newIdentity' },
{ name: 'haveIdentity', call: 'shh_haveIdentity' },
{ name: 'newGroup', call: 'shh_newGroup' },
{ name: 'addToGroup', call: 'shh_addToGroup' }
];
};
/// @returns an array of objects describing web3.eth.watch api methods
10 years ago
var ethWatchMethods = function () {
var newFilter = function (args) {
return typeof args[0] === 'string' ? 'eth_newFilterString' : 'eth_newFilter';
};
10 years ago
return [
{ name: 'newFilter', call: newFilter },
{ name: 'uninstallFilter', call: 'eth_uninstallFilter' },
10 years ago
{ name: 'getMessages', call: 'eth_filterLogs' }
10 years ago
];
};
/// @returns an array of objects describing web3.shh.watch api methods
10 years ago
var shhWatchMethods = function () {
return [
{ name: 'newFilter', call: 'shh_newFilter' },
{ name: 'uninstallFilter', call: 'shh_uninstallFilter' },
{ name: 'getMessage', call: 'shh_getMessages' }
];
};
/// creates methods in a given object based on method description on input
/// setups api calls for these methods
10 years ago
var setupMethods = function (obj, methods) {
methods.forEach(function (method) {
obj[method.name] = function () {
return flattenPromise(Array.prototype.slice.call(arguments)).then(function (args) {
var call = typeof method.call === "function" ? method.call(args) : method.call;
return {call: call, args: args};
}).then(function (request) {
return new Promise(function (resolve, reject) {
web3.provider.send(request, function (err, result) {
if (!err) {
resolve(result);
return;
}
reject(err);
});
});
}).catch(function(err) {
console.error(err);
});
};
10 years ago
});
};
/// creates properties in a given object based on properties description on input
/// setups api calls for these properties
10 years ago
var setupProperties = function (obj, properties) {
properties.forEach(function (property) {
var proto = {};
proto.get = function () {
return new Promise(function(resolve, reject) {
web3.provider.send({call: property.getter}, function(err, result) {
if (!err) {
resolve(result);
return;
}
reject(err);
});
});
};
if (property.setter) {
proto.set = function (val) {
return flattenPromise([val]).then(function (args) {
return new Promise(function (resolve) {
web3.provider.send({call: property.setter, args: args}, function (err, result) {
if (!err) {
resolve(result);
return;
}
reject(err);
});
});
10 years ago
}).catch(function (err) {
console.error(err);
});
};
10 years ago
}
Object.defineProperty(obj, property.name, proto);
});
};
10 years ago
// TODO: import from a dependency, don't duplicate.
var hexToDec = function (hex) {
return parseInt(hex, 16).toString();
};
var decToHex = function (dec) {
return parseInt(dec).toString(16);
};
/// setups web3 object, and it's in-browser executed methods
10 years ago
var web3 = {
_callbacks: {},
_events: {},
providers: {},
10 years ago
toHex: function(str) {
var hex = "";
for(var i = 0; i < str.length; i++) {
var n = str.charCodeAt(i).toString(16);
hex += n.length < 2 ? '0' + n : n;
}
return hex;
},
10 years ago
/// @returns ascii string representation of hex value prefixed with 0x
10 years ago
toAscii: function(hex) {
// Find termination
var str = "";
var i = 0, l = hex.length;
if (hex.substring(0, 2) === '0x')
i = 2;
for(; i < l; i+=2) {
var code = parseInt(hex.substr(i, 2), 16);
10 years ago
if(code === 0) {
break;
}
str += String.fromCharCode(code);
}
10 years ago
return str;
},
10 years ago
/// @returns hex representation (prefixed by 0x) of ascii string
10 years ago
fromAscii: function(str, pad) {
pad = pad === undefined ? 0 : pad;
10 years ago
var hex = this.toHex(str);
while(hex.length < pad*2)
hex += "00";
return "0x" + hex;
},
10 years ago
/// @returns decimal representaton of hex value prefixed by 0x
10 years ago
toDecimal: function (val) {
return hexToDec(val.substring(2));
},
10 years ago
/// @returns hex representation (prefixed by 0x) of decimal value
10 years ago
fromDecimal: function (val) {
return "0x" + decToHex(val);
},
10 years ago
/// used to transform value/string to eth string
10 years ago
toEth: function(str) {
10 years ago
var val = typeof str === "string" ? str.indexOf('0x') === 0 ? parseInt(str.substr(2), 16) : parseInt(str) : str;
10 years ago
var unit = 0;
var units = [ 'wei', 'Kwei', 'Mwei', 'Gwei', 'szabo', 'finney', 'ether', 'grand', 'Mether', 'Gether', 'Tether', 'Pether', 'Eether', 'Zether', 'Yether', 'Nether', 'Dether', 'Vether', 'Uether' ];
while (val > 3000 && unit < units.length - 1)
{
val /= 1000;
unit++;
}
var s = val.toString().length < val.toFixed(2).length ? val.toString() : val.toFixed(2);
10 years ago
var replaceFunction = function($0, $1, $2) {
return $1 + ',' + $2;
};
10 years ago
10 years ago
while (true) {
var o = s;
10 years ago
s = s.replace(/(\d)(\d\d\d[\.\,])/, replaceFunction);
if (o === s)
10 years ago
break;
}
return s + ' ' + units[unit];
},
10 years ago
/// eth object prototype
10 years ago
eth: {
watch: function (params) {
return new Filter(params, ethWatch);
}
10 years ago
},
10 years ago
/// db object prototype
db: {},
10 years ago
/// shh object prototype
10 years ago
shh: {
watch: function (params) {
return new Filter(params, shhWatch);
}
10 years ago
},
10 years ago
/// used by filter to register callback with given id
10 years ago
on: function(event, id, cb) {
if(web3._events[event] === undefined) {
web3._events[event] = {};
}
10 years ago
web3._events[event][id] = cb;
return this;
},
10 years ago
/// used by filter to unregister callback with given id
10 years ago
off: function(event, id) {
if(web3._events[event] !== undefined) {
delete web3._events[event][id];
}
10 years ago
return this;
},
10 years ago
/// used to trigger callback registered by filter
10 years ago
trigger: function(event, id, data) {
var callbacks = web3._events[event];
if (!callbacks || !callbacks[id]) {
return;
}
10 years ago
var cb = callbacks[id];
cb(data);
10 years ago
},
/// @returns true if provider is installed
haveProvider: function() {
return !!web3.provider.provider;
10 years ago
}
};
/// setups all api methods
10 years ago
setupMethods(web3, web3Methods());
setupMethods(web3.eth, ethMethods());
setupProperties(web3.eth, ethProperties());
10 years ago
setupMethods(web3.db, dbMethods());
setupMethods(web3.shh, shhMethods());
var ethWatch = {
changed: 'eth_changed'
};
10 years ago
setupMethods(ethWatch, ethWatchMethods());
10 years ago
var shhWatch = {
changed: 'shh_changed'
};
10 years ago
setupMethods(shhWatch, shhWatchMethods());
web3.provider = new ProviderManager();
web3.setProvider = function(provider) {
provider.onmessage = messageHandler;
web3.provider.set(provider);
web3.provider.sendQueued();
};
/// callled when there is new incoming message
10 years ago
function messageHandler(data) {
if(data._event !== undefined) {
web3.trigger(data._event, data._id, data.data);
return;
}
10 years ago
if(data._id) {
var cb = web3._callbacks[data._id];
if (cb) {
cb.call(this, data.error, data.data);
delete web3._callbacks[data._id];
}
}
10 years ago
}
10 years ago
if (typeof(module) !== "undefined")
module.exports = web3;