plugeth/lib/contract.js

101 lines
3.3 KiB
JavaScript
Raw Normal View History

/*
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 contract.js
* @authors:
* Marek Kotewicz <marek@ethdev.com>
* @date 2014
*/
var web3 = require('./web3'); // jshint ignore:line
var abi = require('./abi');
2015-01-09 12:30:14 +00:00
2015-01-14 11:01:11 +00:00
/**
* This method should be called when we want to call / transact some solidity method from javascript
* it returns an object which has same methods available as solidity contract description
* usage example:
*
* var abi = [{
* name: 'myMethod',
* inputs: [{ name: 'a', type: 'string' }],
2015-01-15 10:39:02 +00:00
* outputs: [{name: 'd', type: 'string' }]
2015-01-14 11:01:11 +00:00
* }]; // contract abi
*
* var myContract = web3.eth.contract('0x0123123121', abi); // creation of contract object
*
2015-01-15 10:39:02 +00:00
* myContract.myMethod('this is test string param for call').call(); // myMethod call
2015-01-14 11:01:11 +00:00
* myContract.myMethod('this is test string param for transact').transact() // myMethod transact
*
* @param address - address of the contract, which should be called
* @param desc - abi json description of the contract, which is being created
* @returns contract object
*/
var contract = function (address, desc) {
var inputParser = abi.inputParser(desc);
var outputParser = abi.outputParser(desc);
var contract = {};
desc.forEach(function (method) {
2015-01-20 14:06:05 +00:00
var displayName = abi.methodDisplayName(method.name);
var typeName = abi.methodTypeName(method.name);
var impl = function () {
var params = Array.prototype.slice.call(arguments);
2015-01-20 14:06:05 +00:00
var parsed = inputParser[displayName][typeName].apply(null, params);
var signature = abi.methodSignature(method.name);
return {
call: function (extra) {
extra = extra || {};
extra.to = address;
extra.data = signature + parsed;
var result = web3.eth.call(extra);
return outputParser[displayName][typeName](result);
},
transact: function (extra) {
extra = extra || {};
extra.to = address;
extra.data = signature + parsed;
/// it's used by natspec.js
/// TODO: figure a better way to solve this
web3._currentContractAbi = desc;
web3._currentContractAddress = address;
var result = web3.eth.transact(extra);
return outputParser[displayName][typeName](result);
}
};
};
2015-01-20 14:06:05 +00:00
if (contract[displayName] === undefined) {
contract[displayName] = impl;
}
contract[displayName][typeName] = impl;
});
2014-12-22 00:13:49 +00:00
return contract;
};
module.exports = contract;
2015-01-14 11:01:11 +00:00