From 974ec23ecd2a445523e0550c0a7f69329d6959f1 Mon Sep 17 00:00:00 2001 From: Alex Browne Date: Wed, 10 Oct 2018 16:04:37 -0700 Subject: Apply various PR feedback --- packages/contract-wrappers/src/contract_wrappers.ts | 8 ++++---- .../src/contract_wrappers/contract_wrapper.ts | 1 + .../src/contract_wrappers/erc20_proxy_wrapper.ts | 5 ++--- .../src/contract_wrappers/erc721_proxy_wrapper.ts | 5 ++--- .../src/contract_wrappers/exchange_wrapper.ts | 7 +++---- .../src/contract_wrappers/forwarder_wrapper.ts | 11 +++++------ .../src/contract_wrappers/order_validator_wrapper.ts | 5 ++--- 7 files changed, 19 insertions(+), 23 deletions(-) (limited to 'packages/contract-wrappers/src') diff --git a/packages/contract-wrappers/src/contract_wrappers.ts b/packages/contract-wrappers/src/contract_wrappers.ts index 25acf823d..34eb1f303 100644 --- a/packages/contract-wrappers/src/contract_wrappers.ts +++ b/packages/contract-wrappers/src/contract_wrappers.ts @@ -70,7 +70,7 @@ export class ContractWrappers { private readonly _web3Wrapper: Web3Wrapper; /** * Instantiates a new ContractWrappers instance. - * @param provider The Provider instance you would like the 0x.js library to use for interacting with + * @param provider The Provider instance you would like the contract-wrappers library to use for interacting with * the Ethereum network. * @param config The configuration object. Look up the type for the description. * @return An instance of the ContractWrappers class. @@ -147,9 +147,9 @@ export class ContractWrappers { ); } /** - * Sets a new web3 provider for 0x.js. Updating the provider will stop all + * Sets a new web3 provider for contract-wrappers. Updating the provider will stop all * subscriptions so you will need to re-subscribe to all events relevant to your app after this call. - * @param provider The Web3Provider you would like the 0x.js library to use from now on. + * @param provider The Web3Provider you would like the contract-wrappers library to use from now on. * @param networkId The id of the network your provider is connected to */ public setProvider(provider: Provider): void { @@ -164,7 +164,7 @@ export class ContractWrappers { (this.orderValidator as any)._invalidateContractInstance(); } /** - * Get the provider instance currently used by 0x.js + * Get the provider instance currently used by contract-wrappers * @return Web3 provider instance */ public getProvider(): Provider { diff --git a/packages/contract-wrappers/src/contract_wrappers/contract_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/contract_wrapper.ts index 30095e002..3d37e446c 100644 --- a/packages/contract-wrappers/src/contract_wrappers/contract_wrapper.ts +++ b/packages/contract-wrappers/src/contract_wrappers/contract_wrapper.ts @@ -113,6 +113,7 @@ export abstract class ContractWrapper { return logWithDecodedArgs; } protected _getDefaultContractAddresses(): ContractAddresses { + // TODO(albrow): Figure out better error handling here. return getContractAddressesForNetwork(this._networkId); } private _onLogStateChanged(isRemoved: boolean, rawLog: RawLogEntry): void { diff --git a/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts index 605646256..459019877 100644 --- a/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts +++ b/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts @@ -20,9 +20,8 @@ export class ERC20ProxyWrapper extends ContractWrapper { * Instantiate ERC20ProxyWrapper * @param web3Wrapper Web3Wrapper instance to use * @param networkId Desired networkId - * @param address (Optional) The address of the ERC20Proxy contract. If - * undefined, will default to the known address corresponding to the - * networkId. + * @param address The address of the ERC20Proxy contract. If undefined, will + * default to the known address corresponding to the networkId. */ constructor(web3Wrapper: Web3Wrapper, networkId: number, address?: string) { super(web3Wrapper, networkId); diff --git a/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts index b1b026a3a..9cf56dec1 100644 --- a/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts +++ b/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts @@ -20,9 +20,8 @@ export class ERC721ProxyWrapper extends ContractWrapper { * Instantiate ERC721ProxyWrapper * @param web3Wrapper Web3Wrapper instance to use * @param networkId Desired networkId - * @param address (Optional) The address of the ERC721Proxy contract. If - * undefined, will default to the known address corresponding to the - * networkId. + * @param address The address of the ERC721Proxy contract. If undefined, + * will default to the known address corresponding to the networkId. */ constructor(web3Wrapper: Web3Wrapper, networkId: number, address?: string) { super(web3Wrapper, networkId); diff --git a/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts index b185b7e0c..67c0351e2 100644 --- a/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts +++ b/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts @@ -53,12 +53,11 @@ export class ExchangeWrapper extends ContractWrapper { * @param networkId Desired networkId. * @param erc20TokenWrapper ERC20TokenWrapper instance to use. * @param erc721TokenWrapper ERC721TokenWrapper instance to use. - * @param address (Optional) The address of the Exchange contract. If + * @param address The address of the Exchange contract. If undefined, will + * default to the known address corresponding to the networkId. + * @param zrxTokenAddress The address of the ZRXToken contract. If * undefined, will default to the known address corresponding to the * networkId. - * @param zrxTokenAddress (Optional) The address of the ZRXToken contract. - * If undefined, will default to the known address corresponding to the - * networkId. * @param blockPollingIntervalMs The block polling interval to use for active subscriptions. */ constructor( diff --git a/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts index b72a77e8b..fe4d0cbda 100644 --- a/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts +++ b/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts @@ -32,15 +32,14 @@ export class ForwarderWrapper extends ContractWrapper { * Instantiate ForwarderWrapper * @param web3Wrapper Web3Wrapper instance to use. * @param networkId Desired networkId. - * @param address (Optional) The address of the Exchange contract. If + * @param address The address of the Exchange contract. If undefined, will + * default to the known address corresponding to the networkId. + * @param zrxTokenAddress The address of the ZRXToken contract. If * undefined, will default to the known address corresponding to the * networkId. - * @param zrxTokenAddress (Optional) The address of the ZRXToken contract. - * If undefined, will default to the known address corresponding to the + * @param etherTokenAddress The address of a WETH (Ether token) contract. If + * undefined, will default to the known address corresponding to the * networkId. - * @param etherTokenAddress (Optional) The address of a WETH (Ether token) - * contract. If undefined, will default to the known address corresponding - * to the networkId. */ constructor( web3Wrapper: Web3Wrapper, diff --git a/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts index b7bdfb149..16179447b 100644 --- a/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts +++ b/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts @@ -23,9 +23,8 @@ export class OrderValidatorWrapper extends ContractWrapper { * Instantiate OrderValidatorWrapper * @param web3Wrapper Web3Wrapper instance to use. * @param networkId Desired networkId. - * @param address (Optional) The address of the OrderValidator contract. If - * undefined, will default to the known address corresponding to the - * networkId. + * @param address The address of the OrderValidator contract. If undefined, + * will default to the known address corresponding to the networkId. */ constructor(web3Wrapper: Web3Wrapper, networkId: number, address?: string) { super(web3Wrapper, networkId); -- cgit v1.2.3