1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | 1 1 1 1 1 1 1 6 6 6 6 24 1 6 6 6 6 6 6 6 5 6 1 6 6 6 1 6 1 1 1 1 1 1 1 1 6 8 6 6 6 6 6 6 6 6 6 1 | /* 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'); var abi = require('./abi'); var utils = require('./utils'); var eventImpl = require('./event'); var filter = require('./filter'); var exportNatspecGlobals = function (vars) { // it's used byt natspec.js // TODO: figure out better way to solve this web3._currentContractAbi = vars.abi; web3._currentContractAddress = vars.address; web3._currentContractMethodName = vars.method; web3._currentContractMethodParams = vars.params; }; var addFunctionRelatedPropertiesToContract = function (contract) { contract.call = function (options) { contract._isTransact = false; contract._options = options; return contract; }; contract.transact = function (options) { contract._isTransact = true; contract._options = options; return contract; }; contract._options = {}; ['gas', 'gasPrice', 'value', 'from'].forEach(function(p) { contract[p] = function (v) { contract._options[p] = v; return contract; }; }); }; var addFunctionsToContract = function (contract, desc, address) { var inputParser = abi.inputParser(desc); var outputParser = abi.outputParser(desc); // create contract functions utils.filterFunctions(desc).forEach(function (method) { var displayName = utils.extractDisplayName(method.name); var typeName = utils.extractTypeName(method.name); var impl = function () { var params = Array.prototype.slice.call(arguments); var signature = abi.signatureFromAscii(method.name); var parsed = inputParser[displayName][typeName].apply(null, params); var options = contract._options || {}; options.to = address; options.data = signature + parsed; var isTransact = contract._isTransact === true || (contract._isTransact !== false && !method.constant); var collapse = options.collapse !== false; // reset contract._options = {}; contract._isTransact = null; if (isTransact) { exportNatspecGlobals({ abi: desc, address: address, method: method.name, params: params }); // transactions do not have any output, cause we do not know, when they will be processed web3.eth.transact(options); return; } 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; }; if (contract[displayName] === undefined) { contract[displayName] = impl; } contract[displayName][typeName] = impl; }); }; var addEventRelatedPropertiesToContract = function (contract, desc, address) { contract.address = address; contract._onWatchEventResult = function (data) { var matchingEvent = event.getMatchingEvent(utils.filterEvents(desc)); var parser = eventImpl.outputParser(matchingEvent); return parser(data); }; Object.defineProperty(contract, 'topic', { get: function() { return utils.filterEvents(desc).map(function (e) { return abi.eventSignatureFromAscii(e.name); }); } }); }; var addEventsToContract = function (contract, desc, address) { // create contract events utils.filterEvents(desc).forEach(function (e) { var impl = function () { var params = Array.prototype.slice.call(arguments); var signature = abi.eventSignatureFromAscii(e.name); var event = eventImpl.inputParser(address, signature, e); var o = event.apply(null, params); var outputFormatter = function (data) { var parser = eventImpl.outputParser(e); return parser(data); }; return web3.eth.watch(o, undefined, undefined, outputFormatter); }; // this property should be used by eth.filter to check if object is an event impl._isEvent = true; var displayName = utils.extractDisplayName(e.name); var typeName = utils.extractTypeName(e.name); Eif (contract[displayName] === undefined) { contract[displayName] = impl; } contract[displayName][typeName] = impl; }); }; /** * 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) { // 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? 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); return result; }; module.exports = contract; |