diff options
Diffstat (limited to 'lib/contract.js')
-rw-r--r-- | lib/contract.js | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/lib/contract.js b/lib/contract.js index eb7fbf018..52ce08705 100644 --- a/lib/contract.js +++ b/lib/contract.js @@ -27,9 +27,29 @@ if (process.env.NODE_ENV !== 'build') { var abi = require('./abi'); -// method signature length in bytes +/// method signature length in bytes var ETH_METHOD_SIGNATURE_LENGTH = 4; +/** + * 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').call(); // myMethod call + * 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); @@ -70,3 +90,4 @@ var contract = function (address, desc) { }; module.exports = contract; + |