From 3ad4094040155dbc9782a57549efab4299a00288 Mon Sep 17 00:00:00 2001 From: Ricardo Guilherme Schmidt <3esmit@gmail.com> Date: Sun, 13 May 2018 22:37:14 -0300 Subject: [PATCH 1/4] add some test utils --- utils/testUtils.js | 104 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 102 insertions(+), 2 deletions(-) diff --git a/utils/testUtils.js b/utils/testUtils.js index 13f7312..b182728 100644 --- a/utils/testUtils.js +++ b/utils/testUtils.js @@ -85,8 +85,6 @@ var callbackToResolve = function (resolve, reject) { }; }; - - exports.promisify = (func) => (...args) => { return new Promise((resolve, reject) => { @@ -95,3 +93,105 @@ exports.promisify = (func) => }); } + +// This has been tested with the real Ethereum network and Testrpc. +// Copied and edited from: https://gist.github.com/xavierlepretre/d5583222fde52ddfbc58b7cfa0d2d0a9 +exports.assertReverts = (contractMethodCall, maxGasAvailable) => { + return new Promise((resolve, reject) => { + try { + resolve(contractMethodCall()) + } catch (error) { + reject(error) + } + }) + .then(tx => { + assert.equal(tx.receipt.gasUsed, maxGasAvailable, "tx successful, the max gas available was not consumed") + }) + .catch(error => { + if ((error + "").indexOf("invalid opcode") < 0 && (error + "").indexOf("out of gas") < 0) { + // Checks if the error is from TestRpc. If it is then ignore it. + // Otherwise relay/throw the error produced by the above assertion. + // Note that no error is thrown when using a real Ethereum network AND the assertion above is true. + throw error + } + }) +} + +exports.listenForEvent = event => new Promise((resolve, reject) => { + event({}, (error, response) => { + if (!error) { + resolve(response.args) + } else { + reject(error) + } + event.stopWatching() + }) +}); + +exports.eventValues = (receipt, eventName) => { + if(receipt.events[eventName]) + return receipt.events[eventName].returnValues; +} + +exports.addressToBytes32 = (address) => { + const stringed = "0000000000000000000000000000000000000000000000000000000000000000" + address.slice(2); + return "0x" + stringed.substring(stringed.length - 64, stringed.length); +} + + +// OpenZeppelin's expectThrow helper - +// Source: https://github.com/OpenZeppelin/zeppelin-solidity/blob/master/test/helpers/expectThrow.js +exports.expectThrow = async promise => { + try { + await promise; + } catch (error) { + // TODO: Check jump destination to destinguish between a throw + // and an actual invalid jump. + const invalidOpcode = error.message.search('invalid opcode') >= 0; + // TODO: When we contract A calls contract B, and B throws, instead + // of an 'invalid jump', we get an 'out of gas' error. How do + // we distinguish this from an actual out of gas event? (The + // testrpc log actually show an 'invalid jump' event.) + const outOfGas = error.message.search('out of gas') >= 0; + const revert = error.message.search('revert') >= 0; + assert( + invalidOpcode || outOfGas || revert, + 'Expected throw, got \'' + error + '\' instead', + ); + return; + } + assert.fail('Expected throw not received'); + }; + +exports.assertJump = (error) => { + assert(error.message.search('revert') > -1, 'Revert should happen'); +} + +var callbackToResolve = function (resolve, reject) { + return function (error, value) { + if (error) { + reject(error); + } else { + resolve(value); + } + }; +}; + +exports.promisify = (func) => + (...args) => { + return new Promise((resolve, reject) => { + const callback = (err, data) => err ? reject(err) : resolve(data); + func.apply(this, [...args, callback]); + }); + } + +exports.zeroAddress = '0x0000000000000000000000000000000000000000'; + +exports.ensureException = function(error) { + assert(isException(error), error.toString()); +}; + +exports.isException = function(error) { + let strError = error.toString(); + return strError.includes('invalid opcode') || strError.includes('invalid JUMP') || strError.includes('revert'); +} From 750661069a9f77f89b21f3f9318c697ff7d7a45b Mon Sep 17 00:00:00 2001 From: Ricardo Guilherme Schmidt <3esmit@gmail.com> Date: Sun, 13 May 2018 23:34:50 -0300 Subject: [PATCH 2/4] fix test utils --- utils/testUtils.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utils/testUtils.js b/utils/testUtils.js index b182728..75ddb06 100644 --- a/utils/testUtils.js +++ b/utils/testUtils.js @@ -191,7 +191,7 @@ exports.ensureException = function(error) { assert(isException(error), error.toString()); }; -exports.isException = function(error) { +function isException(error) { let strError = error.toString(); return strError.includes('invalid opcode') || strError.includes('invalid JUMP') || strError.includes('revert'); } From 90b45ff4624433db1c801916944584e092a2df81 Mon Sep 17 00:00:00 2001 From: Ricardo Guilherme Schmidt <3esmit@gmail.com> Date: Mon, 14 May 2018 18:00:21 -0300 Subject: [PATCH 3/4] update testutils --- utils/testUtils.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utils/testUtils.js b/utils/testUtils.js index 75ddb06..00a9af8 100644 --- a/utils/testUtils.js +++ b/utils/testUtils.js @@ -186,7 +186,7 @@ exports.promisify = (func) => } exports.zeroAddress = '0x0000000000000000000000000000000000000000'; - +exports.zeroBytes32 = "0x0000000000000000000000000000000000000000000000000000000000000000"; exports.ensureException = function(error) { assert(isException(error), error.toString()); }; From 0923267e66a8ad11179ef3e0592c3a1000c0d592 Mon Sep 17 00:00:00 2001 From: Ricardo Guilherme Schmidt <3esmit@gmail.com> Date: Mon, 14 May 2018 20:58:30 -0300 Subject: [PATCH 4/4] add readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fc827f3 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# status.im contracts + +Usage: + ``` + npm install -g embark + git clone https://github.com/status-im/contracts.git + cd contracts + npm install + embark simulator + embark test + embark run + ``` + +| Contract | Deploy | Test | UI | +| -------------------------------------- | ------ | ---- | --- | +| token/TestToken | Yes | Yes | Yes | +| token/ERC20Token | No | Yes | Yes | \ No newline at end of file