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/abi-gen-wrappers/package.json | 2 +- packages/asset-buyer/package.json | 1 - packages/asset-buyer/src/asset_buyer.ts | 2 -- packages/contract-addresses/package.json | 2 +- packages/contract-addresses/src/index.ts | 1 + packages/contract-artifacts/package.json | 4 +--- packages/contract-artifacts/tsconfig.json | 2 +- packages/contract-wrappers/package.json | 1 - 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 ++--- packages/testnet-faucets/package.json | 1 - packages/testnet-faucets/src/ts/handler.ts | 2 -- packages/website/package.json | 1 - packages/website/ts/blockchain.ts | 2 -- 19 files changed, 24 insertions(+), 39 deletions(-) (limited to 'packages') diff --git a/packages/abi-gen-wrappers/package.json b/packages/abi-gen-wrappers/package.json index eabb27765..333db55f8 100644 --- a/packages/abi-gen-wrappers/package.json +++ b/packages/abi-gen-wrappers/package.json @@ -4,7 +4,7 @@ "engines": { "node": ">=6.12" }, - "description": "Smart contract components of 0x protocol", + "description": "Low-level 0x smart contract wrappers generated using @0xproject/abi-gen", "main": "lib/src/index.js", "directories": { "test": "test" diff --git a/packages/asset-buyer/package.json b/packages/asset-buyer/package.json index c2797c6ce..8c8f3c92c 100644 --- a/packages/asset-buyer/package.json +++ b/packages/asset-buyer/package.json @@ -37,7 +37,6 @@ "dependencies": { "@0xproject/assert": "^1.0.13", "@0xproject/connect": "^3.0.1", - "@0xproject/contract-addresses": "^1.0.0", "@0xproject/contract-wrappers": "^2.0.2", "@0xproject/json-schemas": "^1.0.7", "@0xproject/order-utils": "^1.0.7", diff --git a/packages/asset-buyer/src/asset_buyer.ts b/packages/asset-buyer/src/asset_buyer.ts index f7b59c1a1..4739e5a29 100644 --- a/packages/asset-buyer/src/asset_buyer.ts +++ b/packages/asset-buyer/src/asset_buyer.ts @@ -1,4 +1,3 @@ -import { getContractAddressesForNetwork } from '@0xproject/contract-addresses'; import { ContractWrappers } from '@0xproject/contract-wrappers'; import { schemas } from '@0xproject/json-schemas'; import { SignedOrder } from '@0xproject/order-utils'; @@ -110,7 +109,6 @@ export class AssetBuyer { this.expiryBufferSeconds = expiryBufferSeconds; this._contractWrappers = new ContractWrappers(this.provider, { networkId, - contractAddresses: getContractAddressesForNetwork(networkId), }); } /** diff --git a/packages/contract-addresses/package.json b/packages/contract-addresses/package.json index 8875430c7..47081584b 100644 --- a/packages/contract-addresses/package.json +++ b/packages/contract-addresses/package.json @@ -24,11 +24,11 @@ }, "homepage": "https://github.com/0xProject/0x-monorepo/packages/contract-addresses/README.md", "devDependencies": { + "@types/lodash": "4.14.104", "typescript": "3.0.1", "shx": "^0.2.2" }, "dependencies": { - "@0xproject/types": "1.1.4", "lodash": "^4.17.5" }, "publishConfig": { diff --git a/packages/contract-addresses/src/index.ts b/packages/contract-addresses/src/index.ts index a39130c11..80e88c8f9 100644 --- a/packages/contract-addresses/src/index.ts +++ b/packages/contract-addresses/src/index.ts @@ -53,6 +53,7 @@ const networkToAddresses: { [networkId: number]: ContractAddresses } = { /** * Used to get addresses of contracts that have been deployed to either the * Ethereum mainnet or a supported testnet. + * @param networkId The desired networkId. * @returns The set of addresses for contracts which have been deployed on the * given networkId. */ diff --git a/packages/contract-artifacts/package.json b/packages/contract-artifacts/package.json index 39fe68410..3e1696695 100644 --- a/packages/contract-artifacts/package.json +++ b/packages/contract-artifacts/package.json @@ -4,7 +4,7 @@ "engines": { "node": ">=6.12" }, - "description": "Smart contract components of 0x protocol", + "description": "0x smart contract compilation artifacts", "main": "lib/src/index.js", "directories": { "test": "test" @@ -27,8 +27,6 @@ "typescript": "3.0.1", "shx": "^0.2.2" }, - "dependencies": { - }, "publishConfig": { "access": "public" } diff --git a/packages/contract-artifacts/tsconfig.json b/packages/contract-artifacts/tsconfig.json index 6d6f85d93..cce086209 100644 --- a/packages/contract-artifacts/tsconfig.json +++ b/packages/contract-artifacts/tsconfig.json @@ -5,7 +5,7 @@ "rootDir": ".", "resolveJsonModule": true }, - "include": ["./globals.d.ts", "./src/**/*"], + "include": ["./src/**/*"], "files": [ "./artifacts/AssetProxyOwner.json", "./artifacts/DummyERC20Token.json", diff --git a/packages/contract-wrappers/package.json b/packages/contract-wrappers/package.json index 46ae15647..3924378d3 100644 --- a/packages/contract-wrappers/package.json +++ b/packages/contract-wrappers/package.json @@ -67,7 +67,6 @@ "dependencies": { "@0xproject/abi-gen-wrappers": "^1.0.0", "@0xproject/assert": "^1.0.13", - "@0xproject/base-contract": "^3.0.1", "@0xproject/contract-addresses": "^1.0.0", "@0xproject/contract-artifacts": "^1.0.0", "@0xproject/fill-scenarios": "^1.0.7", 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); diff --git a/packages/testnet-faucets/package.json b/packages/testnet-faucets/package.json index cd56c1395..a113889cc 100644 --- a/packages/testnet-faucets/package.json +++ b/packages/testnet-faucets/package.json @@ -19,7 +19,6 @@ "license": "Apache-2.0", "dependencies": { "0x.js": "^1.0.8", - "@0xproject/contract-addresses": "^1.0.0", "@0xproject/subproviders": "^2.0.7", "@0xproject/typescript-typings": "^3.0.2", "@0xproject/utils": "^2.0.2", diff --git a/packages/testnet-faucets/src/ts/handler.ts b/packages/testnet-faucets/src/ts/handler.ts index 262f6d889..5cc52e489 100644 --- a/packages/testnet-faucets/src/ts/handler.ts +++ b/packages/testnet-faucets/src/ts/handler.ts @@ -11,7 +11,6 @@ import { SignedOrder, Web3ProviderEngine, } from '0x.js'; -import { getContractAddressesForNetwork } from '@0xproject/contract-addresses'; import { NonceTrackerSubprovider, PrivateKeyWalletSubprovider } from '@0xproject/subproviders'; import { logUtils } from '@0xproject/utils'; import { Web3Wrapper } from '@0xproject/web3-wrapper'; @@ -68,7 +67,6 @@ export class Handler { const networkId = parseInt(networkIdString, 10); const contractWrappersConfig = { networkId, - contractAddresses: getContractAddressesForNetwork(networkId), }; const contractWrappers = new ContractWrappers(providerObj, contractWrappersConfig); const dispatchQueue = new DispatchQueue(); diff --git a/packages/website/package.json b/packages/website/package.json index f6da39666..efab95c80 100644 --- a/packages/website/package.json +++ b/packages/website/package.json @@ -20,7 +20,6 @@ "license": "Apache-2.0", "dependencies": { "0x.js": "^0.38.6", - "@0xproject/contract-addresses": "^1.0.0", "@0xproject/contract-wrappers": "^2.0.2", "@0xproject/json-schemas": "^1.0.7", "@0xproject/order-utils": "^1.0.7", diff --git a/packages/website/ts/blockchain.ts b/packages/website/ts/blockchain.ts index 8a2489e07..de1622686 100644 --- a/packages/website/ts/blockchain.ts +++ b/packages/website/ts/blockchain.ts @@ -1,5 +1,4 @@ import { ZeroEx } from '0x.js'; -import { getContractAddressesForNetwork } from '@0xproject/contract-addresses'; import { BlockRange, ContractWrappers, @@ -864,7 +863,6 @@ export class Blockchain { } else { const contractWrappersConfig = { networkId, - contractAddresses: getContractAddressesForNetwork(networkId), }; this._contractWrappers = new ContractWrappers(provider, contractWrappersConfig); } -- cgit v1.2.3