plugeth/lib/contract.js

208 lines
6.9 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
*/
2015-01-29 11:35:21 +00:00
var web3 = require('./web3');
var abi = require('./abi');
2015-01-29 14:05:43 +00:00
var eventImpl = require('./event');
2015-01-29 12:32:32 +00:00
var addFunctionRelatedPropertiesToContract = function (contract) {
contract.call = function (options) {
contract._isTransact = false;
contract._options = options;
return contract;
2015-01-22 14:18:21 +00:00
};
2015-01-29 12:32:32 +00:00
contract.transact = function (options) {
contract._isTransact = true;
contract._options = options;
return contract;
2015-01-22 14:18:21 +00:00
};
2015-01-29 12:32:32 +00:00
contract._options = {};
['gas', 'gasPrice', 'value', 'from'].forEach(function(p) {
2015-01-29 12:32:32 +00:00
contract[p] = function (v) {
contract._options[p] = v;
return contract;
};
});
2015-01-29 12:32:32 +00:00
};
var addFunctionsToContract = function (contract, desc, address) {
var inputParser = abi.inputParser(desc);
var outputParser = abi.outputParser(desc);
2015-01-28 13:55:39 +00:00
// create contract functions
2015-01-28 13:20:36 +00:00
abi.filterFunctions(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);
var signature = abi.methodSignature(method.name);
2015-01-22 13:37:34 +00:00
var parsed = inputParser[displayName][typeName].apply(null, params);
2015-01-29 12:32:32 +00:00
var options = contract._options || {};
2015-01-22 13:37:34 +00:00
options.to = address;
options.data = signature + parsed;
2015-01-22 14:32:52 +00:00
2015-01-29 12:32:32 +00:00
var isTransact = contract._isTransact === true || (contract._isTransact !== false && !method.constant);
var collapse = options.collapse !== false;
2015-01-22 14:32:52 +00:00
// reset
2015-01-29 12:32:32 +00:00
contract._options = {};
contract._isTransact = null;
2015-01-22 13:37:34 +00:00
2015-01-22 14:32:52 +00:00
if (isTransact) {
2015-01-22 13:37:34 +00:00
// it's used byt natspec.js
// TODO: figure out better way to solve this
web3._currentContractAbi = desc;
web3._currentContractAddress = address;
2015-01-27 13:14:02 +00:00
web3._currentContractMethodName = method.name;
web3._currentContractMethodParams = params;
2015-01-22 13:37:34 +00:00
2015-01-22 14:32:52 +00:00
// transactions do not have any output, cause we do not know, when they will be processed
web3.eth.transact(options);
return;
2015-01-22 13:37:34 +00:00
}
2015-01-22 14:32:52 +00:00
var output = web3.eth.call(options);
var ret = outputParser[displayName][typeName](output);
if (collapse)
{
if (ret.length === 1)
ret = ret[0];
else if (ret.length === 0)
ret = null;
}
return ret;
};
2015-01-20 14:06:05 +00:00
2015-01-29 12:32:32 +00:00
if (contract[displayName] === undefined) {
contract[displayName] = impl;
2015-01-20 14:06:05 +00:00
}
2015-01-29 12:32:32 +00:00
contract[displayName][typeName] = impl;
});
2015-01-29 12:32:32 +00:00
};
2015-01-22 13:37:34 +00:00
2015-01-29 12:32:32 +00:00
var addEventRelatedPropertiesToContract = function (contract, desc, address) {
contract.address = address;
2015-01-28 13:55:39 +00:00
2015-01-29 14:45:04 +00:00
Object.defineProperty(contract, 'topic', {
2015-01-29 12:32:32 +00:00
get: function() {
return abi.filterEvents(desc).map(function (e) {
return abi.methodSignature(e.name);
});
}
});
2015-01-28 13:55:39 +00:00
2015-01-29 12:32:32 +00:00
};
2015-01-29 11:35:21 +00:00
2015-01-29 12:32:32 +00:00
var addEventsToContract = function (contract, desc, address) {
// create contract events
abi.filterEvents(desc).forEach(function (e) {
2015-01-28 13:55:39 +00:00
2015-01-29 12:32:32 +00:00
var impl = function () {
var params = Array.prototype.slice.call(arguments);
var signature = abi.methodSignature(e.name);
var event = eventImpl(address, signature, e);
2015-01-29 14:05:43 +00:00
var o = event.apply(null, params);
2015-01-28 13:55:39 +00:00
return web3.eth.watch(o);
};
2015-01-31 00:30:19 +00:00
// this property should be used by eth.filter to check if object is an event
impl._isEvent = true;
2015-01-29 14:05:43 +00:00
2015-01-31 00:30:19 +00:00
// TODO: we can remove address && topic properties, they are not used anymore since we introduced _isEvent
2015-01-29 14:05:43 +00:00
impl.address = address;
2015-01-29 14:45:04 +00:00
Object.defineProperty(impl, 'topic', {
2015-01-29 14:05:43 +00:00
get: function() {
return [abi.methodSignature(e.name)];
}
});
2015-01-29 12:32:32 +00:00
// TODO: rename these methods, cause they are used not only for methods
var displayName = abi.methodDisplayName(e.name);
var typeName = abi.methodTypeName(e.name);
2015-01-28 13:55:39 +00:00
2015-01-29 12:32:32 +00:00
if (contract[displayName] === undefined) {
contract[displayName] = impl;
2015-01-28 13:55:39 +00:00
}
2015-01-29 12:32:32 +00:00
contract[displayName][typeName] = impl;
2015-01-28 13:55:39 +00:00
});
2015-01-29 12:32:32 +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' }],
* outputs: [{name: 'd', type: 'string' }]
* }]; // contract abi
*
* var myContract = web3.eth.contract('0x0123123121', abi); // creation of contract object
*
* myContract.myMethod('this is test string param for call'); // myMethod call (implicit, default)
* myContract.call().myMethod('this is test string param for call'); // myMethod call (explicit)
* myContract.transact().myMethod('this is test string param for 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) {
2015-01-29 14:17:32 +00:00
// workaround for invalid assumption that method.name is the full anonymous prototype of the method.
// it's not. it's just the name. the rest of the code assumes it's actually the anonymous
// prototype, so we make it so as a workaround.
// TODO: we may not want to modify input params, maybe use copy instead?
2015-01-29 12:32:32 +00:00
desc.forEach(function (method) {
if (method.name.indexOf('(') === -1) {
var displayName = method.name;
var typeName = method.inputs.map(function(i){return i.type; }).join();
method.name = displayName + '(' + typeName + ')';
}
});
var result = {};
addFunctionRelatedPropertiesToContract(result);
addFunctionsToContract(result, desc, address);
addEventRelatedPropertiesToContract(result, desc, address);
addEventsToContract(result, desc, address);
2015-01-28 13:55:39 +00:00
2015-01-22 14:18:21 +00:00
return result;
};
module.exports = contract;
2015-01-14 11:01:11 +00:00