aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-05-30 20:48:10 +0800
committerFabio Berger <me@fabioberger.com>2017-05-30 20:48:10 +0800
commit1f09470838342e4b9d493b9ddc2eecf65409483e (patch)
tree4ef197dc2e45fa79f6b5c7686fd88037d519c290
parentf4bc7ecf5f72ee32931cf4fa44fffb50505d696d (diff)
parent6b321ca1c70b9dcf188b2a112015386cba0ad5f2 (diff)
downloaddexon-sol-tools-1f09470838342e4b9d493b9ddc2eecf65409483e.tar
dexon-sol-tools-1f09470838342e4b9d493b9ddc2eecf65409483e.tar.gz
dexon-sol-tools-1f09470838342e4b9d493b9ddc2eecf65409483e.tar.bz2
dexon-sol-tools-1f09470838342e4b9d493b9ddc2eecf65409483e.tar.lz
dexon-sol-tools-1f09470838342e4b9d493b9ddc2eecf65409483e.tar.xz
dexon-sol-tools-1f09470838342e4b9d493b9ddc2eecf65409483e.tar.zst
dexon-sol-tools-1f09470838342e4b9d493b9ddc2eecf65409483e.zip
Merge branch 'master' into erc20Wrapper
# Conflicts: # src/0x.js.ts
-rw-r--r--src/contract_wrappers/exchange_wrapper.ts17
-rw-r--r--src/contract_wrappers/token_registry_wrapper.ts19
-rw-r--r--src/types.ts11
-rw-r--r--src/web3_wrapper.ts10
-rw-r--r--test/0x.js_test.ts36
-rw-r--r--test/exchange_wrapper.ts1
-rw-r--r--test/token_registry_wrapper_test.ts4
-rw-r--r--test/utils/web3_factory.ts10
8 files changed, 85 insertions, 23 deletions
diff --git a/src/contract_wrappers/exchange_wrapper.ts b/src/contract_wrappers/exchange_wrapper.ts
index f0f153c2b..3f6eb0dab 100644
--- a/src/contract_wrappers/exchange_wrapper.ts
+++ b/src/contract_wrappers/exchange_wrapper.ts
@@ -7,9 +7,13 @@ import * as ExchangeArtifacts from '../artifacts/Exchange.json';
import {ecSignatureSchema} from '../schemas/ec_signature_schema';
export class ExchangeWrapper extends ContractWrapper {
+ private exchangeContractIfExists?: ExchangeContract;
constructor(web3Wrapper: Web3Wrapper) {
super(web3Wrapper);
}
+ public invalidateContractInstance(): void {
+ delete this.exchangeContractIfExists;
+ }
public async isValidSignatureAsync(dataHex: string, ecSignature: ECSignature,
signerAddressHex: string): Promise<boolean> {
assert.isHexString('dataHex', dataHex);
@@ -19,10 +23,9 @@ export class ExchangeWrapper extends ContractWrapper {
const senderAddressIfExists = await this.web3Wrapper.getSenderAddressIfExistsAsync();
assert.assert(!_.isUndefined(senderAddressIfExists), ZeroExError.USER_HAS_NO_ASSOCIATED_ADDRESSES);
- const contractInstance = await this.instantiateContractIfExistsAsync((ExchangeArtifacts as any));
- const exchangeInstance = contractInstance as ExchangeContract;
+ const exchangeContract = await this.getExchangeContractAsync();
- const isValidSignature = await exchangeInstance.isValidSignature.call(
+ const isValidSignature = await exchangeContract.isValidSignature.call(
signerAddressHex,
dataHex,
ecSignature.v,
@@ -34,4 +37,12 @@ export class ExchangeWrapper extends ContractWrapper {
);
return isValidSignature;
}
+ private async getExchangeContractAsync(): Promise<ExchangeContract> {
+ if (!_.isUndefined(this.exchangeContractIfExists)) {
+ return this.exchangeContractIfExists;
+ }
+ const contractInstance = await this.instantiateContractIfExistsAsync((ExchangeArtifacts as any));
+ this.exchangeContractIfExists = contractInstance as ExchangeContract;
+ return this.exchangeContractIfExists;
+ }
}
diff --git a/src/contract_wrappers/token_registry_wrapper.ts b/src/contract_wrappers/token_registry_wrapper.ts
index 4d6eacb51..86bea1c5d 100644
--- a/src/contract_wrappers/token_registry_wrapper.ts
+++ b/src/contract_wrappers/token_registry_wrapper.ts
@@ -1,20 +1,23 @@
import * as _ from 'lodash';
import {Web3Wrapper} from '../web3_wrapper';
-import {ZeroExError, Token, TokenRegistryContract} from '../types';
+import {Token, TokenRegistryContract, TokenMetadata} from '../types';
import {assert} from '../utils/assert';
import {ContractWrapper} from './contract_wrapper';
import * as TokenRegistryArtifacts from '../artifacts/TokenRegistry.json';
export class TokenRegistryWrapper extends ContractWrapper {
+ private tokenRegistryContractIfExists?: TokenRegistryContract;
constructor(web3Wrapper: Web3Wrapper) {
super(web3Wrapper);
}
+ public invalidateContractInstance(): void {
+ delete this.tokenRegistryContractIfExists;
+ }
public async getTokensAsync(): Promise<Token[]> {
- const contractInstance = await this.instantiateContractIfExistsAsync((TokenRegistryArtifacts as any));
- const tokenRegistryContract = contractInstance as TokenRegistryContract;
+ const tokenRegistryContract = await this.getTokenRegistryContractAsync();
const addresses = await tokenRegistryContract.getTokenAddresses.call();
- const tokenMetadataPromises: Array<Promise<any[]>> = _.map(
+ const tokenMetadataPromises: Array<Promise<TokenMetadata>> = _.map(
addresses,
(address: string) => (tokenRegistryContract.getTokenMetaData.call(address)),
);
@@ -30,4 +33,12 @@ export class TokenRegistryWrapper extends ContractWrapper {
});
return tokens;
}
+ private async getTokenRegistryContractAsync(): Promise<TokenRegistryContract> {
+ if (!_.isUndefined(this.tokenRegistryContractIfExists)) {
+ return this.tokenRegistryContractIfExists;
+ }
+ const contractInstance = await this.instantiateContractIfExistsAsync((TokenRegistryArtifacts as any));
+ this.tokenRegistryContractIfExists = contractInstance as TokenRegistryContract;
+ return this.tokenRegistryContractIfExists;
+ }
}
diff --git a/src/types.ts b/src/types.ts
index f5b0f3e7c..9c82c1fa6 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -37,8 +37,12 @@ export interface ERC20Contract {
}
export interface TokenRegistryContract {
- getTokenMetaData: any;
- getTokenAddresses: any;
+ getTokenMetaData: {
+ call: (address: string) => Promise<TokenMetadata>;
+ };
+ getTokenAddresses: {
+ call: () => Promise<string[]>;
+ };
}
export const SolidityTypes = strEnum([
@@ -47,6 +51,9 @@ export const SolidityTypes = strEnum([
]);
export type SolidityTypes = keyof typeof SolidityTypes;
+// [address, name, symbol, projectUrl, decimals, ipfsHash, swarmHash]
+export type TokenMetadata = [string, string, string, string, BigNumber.BigNumber, string, string];
+
export interface Token {
name: string;
address: string;
diff --git a/src/web3_wrapper.ts b/src/web3_wrapper.ts
index 97d04db8c..e65f29b56 100644
--- a/src/web3_wrapper.ts
+++ b/src/web3_wrapper.ts
@@ -9,6 +9,9 @@ export class Web3Wrapper {
this.web3 = new Web3();
this.web3.setProvider(web3.currentProvider);
}
+ public setProvider(provider: Web3.Provider) {
+ this.web3.setProvider(provider);
+ }
public isAddress(address: string): boolean {
return this.web3.isAddress(address);
}
@@ -49,10 +52,9 @@ export class Web3Wrapper {
}
public async doesContractExistAtAddressAsync(address: string): Promise<boolean> {
const code = await promisify(this.web3.eth.getCode)(address);
- // Regex matches 0x0, 0x00, 0x in order to accomodate poorly implemented clients
- const zeroHexAddressRegex = /^0x0*$/i;
- const didFindCode = _.isNull(code.match(zeroHexAddressRegex));
- return didFindCode;
+ // Regex matches 0x0, 0x00, 0x in order to accommodate poorly implemented clients
+ const codeIsEmpty = /^0x0{0,40}$/i.test(code);
+ return !codeIsEmpty;
}
public async signTransactionAsync(address: string, message: string): Promise<string> {
const signData = await promisify(this.web3.eth.sign)(address, message);
diff --git a/test/0x.js_test.ts b/test/0x.js_test.ts
index bb312a00f..5d23d7094 100644
--- a/test/0x.js_test.ts
+++ b/test/0x.js_test.ts
@@ -13,6 +13,34 @@ chai.use(ChaiBigNumber());
const expect = chai.expect;
describe('ZeroEx library', () => {
+ describe('#setProvider', () => {
+ it('overrides the provider in the nested web3 instance and invalidates contractInstances', async () => {
+ const web3 = web3Factory.create();
+ const zeroEx = new ZeroEx(web3);
+ // Instantiate the contract instances with the current provider
+ await (zeroEx.exchange as any).getExchangeContractAsync();
+ await (zeroEx.tokenRegistry as any).getTokenRegistryContractAsync();
+ expect((zeroEx.exchange as any).exchangeContractIfExists).to.not.be.undefined;
+ expect((zeroEx.tokenRegistry as any).tokenRegistryContractIfExists).to.not.be.undefined;
+
+ const newProvider = web3Factory.getRpcProvider();
+ // Add property to newProvider so that we can differentiate it from old provider
+ (newProvider as any).zeroExTestId = 1;
+ zeroEx.setProvider(newProvider);
+
+ // Check that contractInstances with old provider are removed after provider update
+ expect((zeroEx.exchange as any).exchangeContractIfExists).to.be.undefined;
+ expect((zeroEx.tokenRegistry as any).tokenRegistryContractIfExists).to.be.undefined;
+
+ // Check that all nested web3 instances return the updated provider
+ const nestedWeb3WrapperProvider = (zeroEx as any).web3Wrapper.getCurrentProvider();
+ expect((nestedWeb3WrapperProvider as any).zeroExTestId).to.be.a('number');
+ const exchangeWeb3WrapperProvider = zeroEx.exchange.web3Wrapper.getCurrentProvider();
+ expect((exchangeWeb3WrapperProvider as any).zeroExTestId).to.be.a('number');
+ const tokenRegistryWeb3WrapperProvider = zeroEx.tokenRegistry.web3Wrapper.getCurrentProvider();
+ expect((tokenRegistryWeb3WrapperProvider as any).zeroExTestId).to.be.a('number');
+ });
+ });
describe('#getOrderHash', () => {
const expectedOrderHash = '0x103a5e97dab5dbeb8f385636f86a7d1e458a7ccbe1bd194727f0b2f85ab116c7';
it('defaults takerAddress to NULL address', () => {
@@ -194,9 +222,9 @@ describe('ZeroEx library', () => {
const web3 = web3Factory.create();
const zeroEx = new ZeroEx(web3);
stubs = [
- Sinon.stub(zeroEx.web3Wrapper, 'getNodeVersionAsync')
+ Sinon.stub((zeroEx as any).web3Wrapper, 'getNodeVersionAsync')
.returns(Promise.resolve(newParityNodeVersion)),
- Sinon.stub(zeroEx.web3Wrapper, 'signTransactionAsync')
+ Sinon.stub((zeroEx as any).web3Wrapper, 'signTransactionAsync')
.returns(Promise.resolve(signature)),
Sinon.stub(ZeroEx, 'isValidSignature').returns(true),
];
@@ -218,9 +246,9 @@ describe('ZeroEx library', () => {
const web3 = web3Factory.create();
const zeroEx = new ZeroEx(web3);
stubs = [
- Sinon.stub(zeroEx.web3Wrapper, 'getNodeVersionAsync')
+ Sinon.stub((zeroEx as any).web3Wrapper, 'getNodeVersionAsync')
.returns(Promise.resolve(newParityNodeVersion)),
- Sinon.stub(zeroEx.web3Wrapper, 'signTransactionAsync')
+ Sinon.stub((zeroEx as any).web3Wrapper, 'signTransactionAsync')
.returns(Promise.resolve(signature)),
Sinon.stub(ZeroEx, 'isValidSignature').returns(true),
];
diff --git a/test/exchange_wrapper.ts b/test/exchange_wrapper.ts
index 4bfc49374..55b84ce36 100644
--- a/test/exchange_wrapper.ts
+++ b/test/exchange_wrapper.ts
@@ -1,7 +1,6 @@
import 'mocha';
import * as chai from 'chai';
import chaiAsPromised = require('chai-as-promised');
-import * as Web3 from 'web3';
import {web3Factory} from './utils/web3_factory';
import {ZeroEx} from '../src/0x.js';
import {BlockchainLifecycle} from './utils/blockchain_lifecycle';
diff --git a/test/token_registry_wrapper_test.ts b/test/token_registry_wrapper_test.ts
index cd435c48c..c91555d8b 100644
--- a/test/token_registry_wrapper_test.ts
+++ b/test/token_registry_wrapper_test.ts
@@ -31,12 +31,12 @@ describe('TokenRegistryWrapper', () => {
describe('#getTokensAsync', () => {
it('should return all the tokens added to the tokenRegistry during the migration', async () => {
const tokens = await zeroEx.tokenRegistry.getTokensAsync();
- expect(tokens.length).to.be.equal(TOKEN_REGISTRY_SIZE_AFTER_MIGRATION);
+ expect(tokens).to.have.lengthOf(TOKEN_REGISTRY_SIZE_AFTER_MIGRATION);
const schemaValidator = new SchemaValidator();
_.each(tokens, token => {
const validationResult = schemaValidator.validate(token, tokenSchema);
- expect(validationResult.errors.length).to.be.equal(0);
+ expect(validationResult.errors).to.have.lengthOf(0);
});
});
});
diff --git a/test/utils/web3_factory.ts b/test/utils/web3_factory.ts
index 493fbc2df..ffdc0e4cf 100644
--- a/test/utils/web3_factory.ts
+++ b/test/utils/web3_factory.ts
@@ -10,14 +10,18 @@ import {constants} from './constants';
export const web3Factory = {
create(): Web3 {
+ const provider = this.getRpcProvider();
+ const web3 = new Web3();
+ web3.setProvider(provider);
+ return web3;
+ },
+ getRpcProvider(): Web3.Provider {
const provider = new ProviderEngine();
const rpcUrl = `http://${constants.RPC_HOST}:${constants.RPC_PORT}`;
provider.addProvider(new RpcSubprovider({
rpcUrl,
}));
provider.start();
- const web3 = new Web3();
- web3.setProvider(provider);
- return web3;
+ return provider;
},
};