crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update more things to work with both Geth and Ganache

Browse Source
This commit is contained in:
Alex Browne
2018-06-05 16:20:38 -07:00
parent 63caddea62
commit d6d7f4e875
6 changed files with 64 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
packages/contracts/src/utils/assertions.ts
View File

@@ -5,38 +5,30 @@ import { constants } from './constants';
const expect = chai.expect; const expect = chai.expect;
// throws if the given promise does not reject with one of two expected error function _expectEitherError<T>(p: Promise<T>, error1: string, error2: string): PromiseLike<void> {
// messages.
export function expectRevertOrAlwaysFailingTransaction<T>(p: Promise<T>): PromiseLike<void> {
return expect(p) return expect(p)
.to.be.rejected() .to.be.rejected()
.then(e => { .then(e => {
expect(e).to.satisfy( expect(e).to.satisfy(
(err: Error) => (err: Error) => _.includes(err.message, error1) || _.includes(err.message, error2),
_.includes(err.message, constants.REVERT) || _.includes(err.message, 'always failing transaction'), `expected promise to reject with error message that includes "${error1}" or "${error2}", but got: ` +
`"${e.message}"\n`,
); );
}); });
} }
export function expectInsufficientFunds<T>(p: Promise<T>): PromiseLike<void> { export function expectInsufficientFunds<T>(p: Promise<T>): PromiseLike<void> {
return expect(p) return _expectEitherError(p, 'insufficient funds', "sender doesn't have enough funds");
.to.be.rejected() }
.then(e => {
expect(e).to.satisfy( export function expectRevertOrOtherError<T>(p: Promise<T>, otherError: string): PromiseLike<void> {
(err: Error) => return _expectEitherError(p, constants.REVERT, otherError);
_.includes(err.message, 'insufficient funds') || }
_.includes(err.message, "sender doesn't have enough funds"),
); export function expectRevertOrAlwaysFailingTransaction<T>(p: Promise<T>): PromiseLike<void> {
}); return expectRevertOrOtherError(p, 'always failing transaction');
} }
export function expectRevertOrContractCallFailed<T>(p: Promise<T>): PromiseLike<void> { export function expectRevertOrContractCallFailed<T>(p: Promise<T>): PromiseLike<void> {
return expect(p) return expectRevertOrOtherError<T>(p, 'Contract call failed');
.to.be.rejected()
.then(e => {
expect(e).to.satisfy(
(err: Error) =>
_.includes(err.message, constants.REVERT) || _.includes(err.message, 'Contract call failed'),
);
});
} }

29
packages/contracts/test/libraries/lib_bytes.ts
View File

@@ -10,7 +10,7 @@ import * as Web3 from 'web3';
import { TestLibBytesContract } from '../../src/contract_wrappers/generated/test_lib_bytes'; import { TestLibBytesContract } from '../../src/contract_wrappers/generated/test_lib_bytes';
import { artifacts } from '../../src/utils/artifacts'; import { artifacts } from '../../src/utils/artifacts';
import { expectRevertOrAlwaysFailingTransaction } from '../../src/utils/assertions'; import { expectRevertOrAlwaysFailingTransaction, expectRevertOrOtherError } from '../../src/utils/assertions';
import { chaiSetup } from '../../src/utils/chai_setup'; import { chaiSetup } from '../../src/utils/chai_setup';
import { constants } from '../../src/utils/constants'; import { constants } from '../../src/utils/constants';
import { provider, txDefaults, web3Wrapper } from '../../src/utils/web3_wrapper'; import { provider, txDefaults, web3Wrapper } from '../../src/utils/web3_wrapper';
@@ -64,7 +64,8 @@ describe('LibBytes', () => {
describe('popByte', () => { describe('popByte', () => {
it('should revert if length is 0', async () => { it('should revert if length is 0', async () => {
return expect(libBytes.publicPopByte.callAsync(constants.NULL_BYTES)).to.be.rejectedWith( return expectRevertOrOtherError(
libBytes.publicPopByte.callAsync(constants.NULL_BYTES),
constants.LIB_BYTES_GT_ZERO_LENGTH_REQUIRED, constants.LIB_BYTES_GT_ZERO_LENGTH_REQUIRED,
); );
}); });
@@ -80,7 +81,8 @@ describe('LibBytes', () => {
describe('popAddress', () => { describe('popAddress', () => {
it('should revert if length is less than 20', async () => { it('should revert if length is less than 20', async () => {
return expect(libBytes.publicPopAddress.callAsync(byteArrayShorterThan20Bytes)).to.be.rejectedWith( return expectRevertOrOtherError(
libBytes.publicPopAddress.callAsync(byteArrayShorterThan20Bytes),
constants.LIB_BYTES_GTE_20_LENGTH_REQUIRED, constants.LIB_BYTES_GTE_20_LENGTH_REQUIRED,
); );
}); });
@@ -165,7 +167,8 @@ describe('LibBytes', () => {
it('should fail if the byte array is too short to hold an address)', async () => { it('should fail if the byte array is too short to hold an address)', async () => {
const shortByteArray = '0xabcdef'; const shortByteArray = '0xabcdef';
const offset = new BigNumber(0); const offset = new BigNumber(0);
return expect(libBytes.publicReadAddress.callAsync(shortByteArray, offset)).to.be.rejectedWith( return expectRevertOrOtherError(
libBytes.publicReadAddress.callAsync(shortByteArray, offset),
constants.LIB_BYTES_GTE_20_LENGTH_REQUIRED, constants.LIB_BYTES_GTE_20_LENGTH_REQUIRED,
); );
}); });
@@ -173,7 +176,8 @@ describe('LibBytes', () => {
it('should fail if the length between the offset and end of the byte array is too short to hold an address)', async () => { it('should fail if the length between the offset and end of the byte array is too short to hold an address)', async () => {
const byteArray = ethUtil.addHexPrefix(testAddress); const byteArray = ethUtil.addHexPrefix(testAddress);
const badOffset = new BigNumber(ethUtil.toBuffer(byteArray).byteLength); const badOffset = new BigNumber(ethUtil.toBuffer(byteArray).byteLength);
return expect(libBytes.publicReadAddress.callAsync(byteArray, badOffset)).to.be.rejectedWith( return expectRevertOrOtherError(
libBytes.publicReadAddress.callAsync(byteArray, badOffset),
constants.LIB_BYTES_GTE_20_LENGTH_REQUIRED, constants.LIB_BYTES_GTE_20_LENGTH_REQUIRED,
); );
}); });
@@ -209,14 +213,16 @@ describe('LibBytes', () => {
it('should fail if the byte array is too short to hold a bytes32)', async () => { it('should fail if the byte array is too short to hold a bytes32)', async () => {
const offset = new BigNumber(0); const offset = new BigNumber(0);
return expect(libBytes.publicReadBytes32.callAsync(byteArrayShorterThan32Bytes, offset)).to.be.rejectedWith( return expectRevertOrOtherError(
libBytes.publicReadBytes32.callAsync(byteArrayShorterThan32Bytes, offset),
constants.LIB_BYTES_GTE_32_LENGTH_REQUIRED, constants.LIB_BYTES_GTE_32_LENGTH_REQUIRED,
); );
}); });
it('should fail if the length between the offset and end of the byte array is too short to hold a bytes32)', async () => { it('should fail if the length between the offset and end of the byte array is too short to hold a bytes32)', async () => {
const badOffset = new BigNumber(ethUtil.toBuffer(testBytes32).byteLength); const badOffset = new BigNumber(ethUtil.toBuffer(testBytes32).byteLength);
return expect(libBytes.publicReadBytes32.callAsync(testBytes32, badOffset)).to.be.rejectedWith( return expectRevertOrOtherError(
libBytes.publicReadBytes32.callAsync(testBytes32, badOffset),
constants.LIB_BYTES_GTE_32_LENGTH_REQUIRED, constants.LIB_BYTES_GTE_32_LENGTH_REQUIRED,
); );
}); });
@@ -256,7 +262,8 @@ describe('LibBytes', () => {
it('should fail if the byte array is too short to hold a uint256)', async () => { it('should fail if the byte array is too short to hold a uint256)', async () => {
const offset = new BigNumber(0); const offset = new BigNumber(0);
return expect(libBytes.publicReadUint256.callAsync(byteArrayShorterThan32Bytes, offset)).to.be.rejectedWith( return expectRevertOrOtherError(
libBytes.publicReadUint256.callAsync(byteArrayShorterThan32Bytes, offset),
constants.LIB_BYTES_GTE_32_LENGTH_REQUIRED, constants.LIB_BYTES_GTE_32_LENGTH_REQUIRED,
); );
}); });
@@ -266,7 +273,8 @@ describe('LibBytes', () => {
const testUint256AsBuffer = ethUtil.toBuffer(formattedTestUint256); const testUint256AsBuffer = ethUtil.toBuffer(formattedTestUint256);
const byteArray = ethUtil.bufferToHex(testUint256AsBuffer); const byteArray = ethUtil.bufferToHex(testUint256AsBuffer);
const badOffset = new BigNumber(testUint256AsBuffer.byteLength); const badOffset = new BigNumber(testUint256AsBuffer.byteLength);
return expect(libBytes.publicReadUint256.callAsync(byteArray, badOffset)).to.be.rejectedWith( return expectRevertOrOtherError(
libBytes.publicReadUint256.callAsync(byteArray, badOffset),
constants.LIB_BYTES_GTE_32_LENGTH_REQUIRED, constants.LIB_BYTES_GTE_32_LENGTH_REQUIRED,
); );
}); });
@@ -287,7 +295,8 @@ describe('LibBytes', () => {
// AssertionError: expected promise to be rejected with an error including 'revert' but it was fulfilled with '0x08c379a0' // AssertionError: expected promise to be rejected with an error including 'revert' but it was fulfilled with '0x08c379a0'
it('should revert if byte array has a length < 4', async () => { it('should revert if byte array has a length < 4', async () => {
const byteArrayLessThan4Bytes = '0x010101'; const byteArrayLessThan4Bytes = '0x010101';
return expect(libBytes.publicReadFirst4.callAsync(byteArrayLessThan4Bytes)).to.be.rejectedWith( return expectRevertOrOtherError(
libBytes.publicReadFirst4.callAsync(byteArrayLessThan4Bytes),
constants.LIB_BYTES_GTE_4_LENGTH_REQUIRED, constants.LIB_BYTES_GTE_4_LENGTH_REQUIRED,
); );
}); });

15
packages/contracts/test/unlimited_allowance_token.ts
View File

@@ -7,7 +7,7 @@ import * as Web3 from 'web3';
import { DummyERC20TokenContract } from '../src/contract_wrappers/generated/dummy_e_r_c20_token'; import { DummyERC20TokenContract } from '../src/contract_wrappers/generated/dummy_e_r_c20_token';
import { artifacts } from '../src/utils/artifacts'; import { artifacts } from '../src/utils/artifacts';
import { expectRevertOrAlwaysFailingTransaction } from '../src/utils/assertions'; import { expectRevertOrAlwaysFailingTransaction, expectRevertOrOtherError } from '../src/utils/assertions';
import { chaiSetup } from '../src/utils/chai_setup'; import { chaiSetup } from '../src/utils/chai_setup';
import { constants } from '../src/utils/constants'; import { constants } from '../src/utils/constants';
import { provider, txDefaults, web3Wrapper } from '../src/utils/web3_wrapper'; import { provider, txDefaults, web3Wrapper } from '../src/utils/web3_wrapper';
@@ -56,7 +56,8 @@ describe('UnlimitedAllowanceToken', () => {
it('should throw if owner has insufficient balance', async () => { it('should throw if owner has insufficient balance', async () => {
const ownerBalance = await token.balanceOf.callAsync(owner); const ownerBalance = await token.balanceOf.callAsync(owner);
const amountToTransfer = ownerBalance.plus(1); const amountToTransfer = ownerBalance.plus(1);
return expect(token.transfer.callAsync(spender, amountToTransfer, { from: owner })).to.be.rejectedWith( return expectRevertOrOtherError(
token.transfer.callAsync(spender, amountToTransfer, { from: owner }),
constants.ERC20_INSUFFICIENT_BALANCE, constants.ERC20_INSUFFICIENT_BALANCE,
); );
}); });
@@ -94,11 +95,12 @@ describe('UnlimitedAllowanceToken', () => {
await token.approve.sendTransactionAsync(spender, amountToTransfer, { from: owner }), await token.approve.sendTransactionAsync(spender, amountToTransfer, { from: owner }),
constants.AWAIT_TRANSACTION_MINED_MS, constants.AWAIT_TRANSACTION_MINED_MS,
); );
return expect( return expectRevertOrOtherError(
token.transferFrom.callAsync(owner, spender, amountToTransfer, { token.transferFrom.callAsync(owner, spender, amountToTransfer, {
from: spender, from: spender,
}), }),
).to.be.rejectedWith(constants.ERC20_INSUFFICIENT_BALANCE); constants.ERC20_INSUFFICIENT_BALANCE,
);
}); });
it('should throw if spender has insufficient allowance', async () => { it('should throw if spender has insufficient allowance', async () => {
@@ -109,11 +111,12 @@ describe('UnlimitedAllowanceToken', () => {
const isSpenderAllowanceInsufficient = spenderAllowance.cmp(amountToTransfer) < 0; const isSpenderAllowanceInsufficient = spenderAllowance.cmp(amountToTransfer) < 0;
expect(isSpenderAllowanceInsufficient).to.be.true(); expect(isSpenderAllowanceInsufficient).to.be.true();
return expect( return expectRevertOrOtherError(
token.transferFrom.callAsync(owner, spender, amountToTransfer, { token.transferFrom.callAsync(owner, spender, amountToTransfer, {
from: spender, from: spender,
}), }),
).to.be.rejectedWith(constants.ERC20_INSUFFICIENT_ALLOWANCE); constants.ERC20_INSUFFICIENT_ALLOWANCE,
);
}); });
it('should return true on a 0 value transfer', async () => { it('should return true on a 0 value transfer', async () => {

11
packages/dev-utils/src/blockchain_lifecycle.ts
View File

@@ -1,4 +1,4 @@
import { Web3Wrapper } from '@0xproject/web3-wrapper'; import { uniqueVersionIds, Web3Wrapper } from '@0xproject/web3-wrapper';
import * as _ from 'lodash'; import * as _ from 'lodash';
import * as Web3 from 'web3'; import * as Web3 from 'web3';
@@ -7,11 +7,6 @@ enum NodeType {
Ganache = 'GANACHE', Ganache = 'GANACHE',
} }
// These are unique identifiers contained in the response of the
// web3_clientVersion call.
const GETH_VERSION_ID = 'Geth';
const GANACHE_VERSION_ID = 'EthereumJS TestRPC';
export class BlockchainLifecycle { export class BlockchainLifecycle {
private _web3Wrapper: Web3Wrapper; private _web3Wrapper: Web3Wrapper;
private _snapshotIdsStack: number[]; private _snapshotIdsStack: number[];
@@ -54,9 +49,9 @@ export class BlockchainLifecycle {
} }
private async _getNodeTypeAsync(): Promise<NodeType> { private async _getNodeTypeAsync(): Promise<NodeType> {
const version = await this._web3Wrapper.getNodeVersionAsync(); const version = await this._web3Wrapper.getNodeVersionAsync();
if (_.includes(version, GETH_VERSION_ID)) { if (_.includes(version, uniqueVersionIds.geth)) {
return NodeType.Geth; return NodeType.Geth;
} else if (_.includes(version, GANACHE_VERSION_ID)) { } else if (_.includes(version, uniqueVersionIds.ganache)) {
return NodeType.Ganache; return NodeType.Ganache;
} else { } else {
throw new Error(`Unknown client version: ${version}`); throw new Error(`Unknown client version: ${version}`);

2
packages/web3-wrapper/src/index.ts
View File

@@ -1,2 +1,2 @@
export { Web3Wrapper } from './web3_wrapper'; export { Web3Wrapper, uniqueVersionIds } from './web3_wrapper';
export { Web3WrapperErrors } from './types'; export { Web3WrapperErrors } from './types';

21
packages/web3-wrapper/src/web3_wrapper.ts
View File

@@ -21,6 +21,13 @@ import { Web3WrapperErrors } from './types';
const BASE_TEN = 10; const BASE_TEN = 10;
// These are unique identifiers contained in the response of the
// web3_clientVersion call.
export const uniqueVersionIds = {
geth: 'Geth',
ganache: 'EthereumJS TestRPC',
};
/** /**
* A wrapper around the Web3.js 0.x library that provides a consistent, clean promise-based interface. * A wrapper around the Web3.js 0.x library that provides a consistent, clean promise-based interface.
*/ */
@@ -254,12 +261,20 @@ export class Web3Wrapper {
await this._sendRawPayloadAsync<string>({ method: 'evm_mine', params: [] }); await this._sendRawPayloadAsync<string>({ method: 'evm_mine', params: [] });
} }
/** /**
* Increase the next blocks timestamp on TestRPC/Ganache local node * Increase the next blocks timestamp on TestRPC/Ganache or Geth local node.
* Will throw if provider is neither TestRPC/Ganache or Geth.
* @param timeDelta Amount of time to add in seconds * @param timeDelta Amount of time to add in seconds
*/ */
public async increaseTimeAsync(timeDelta: number): Promise<number> { public async increaseTimeAsync(timeDelta: number): Promise<number> {
// TODO(albrow): Detect Geth vs. Ganache and use appropriate endpoint. // Detect Geth vs. Ganache and use appropriate endpoint.
return this._sendRawPayloadAsync<number>({ method: 'debug_increaseTime', params: [timeDelta] }); const version = await this.getNodeVersionAsync();
if (_.includes(version, uniqueVersionIds.geth)) {
return this._sendRawPayloadAsync<number>({ method: 'debug_increaseTime', params: [timeDelta] });
} else if (_.includes(version, uniqueVersionIds.ganache)) {
return this._sendRawPayloadAsync<number>({ method: 'evm_increaseTime', params: [timeDelta] });
} else {
throw new Error(`Unknown client version: ${version}`);
}
} }
/** /**
* Retrieve smart contract logs for a given filter * Retrieve smart contract logs for a given filter