Add doc generation to several more packages and fix up their index.ts files so all public interface types are exported

contracts/asset-proxy/package.json

@@ -33,7 +33,9 @@
         "contracts:gen": "contracts-gen generate",
         "contracts:copy": "contracts-gen copy",
         "lint-contracts": "solhint -c ../.solhint.json contracts/**/**/**/**/*.sol",
-        "compile:truffle": "truffle compile"
+        "compile:truffle": "truffle compile",
+        "docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
+        "docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "config": {
         "publicInterfaceContracts": "ERC1155Proxy,ERC20Proxy,ERC721Proxy,MultiAssetProxy,StaticCallProxy,ERC20BridgeProxy,Eth2DaiBridge,IAssetData,IAssetProxy,UniswapBridge,TestStaticCallTarget",
@@ -58,6 +60,8 @@
         "@0x/sol-compiler": "^3.2.0-beta.2",
         "@0x/tslint-config": "^3.1.0-beta.2",
         "@0x/types": "^2.5.0-beta.2",
+        "@0x/ts-doc-gen": "^0.0.22",
+        "typedoc": "^0.15.0",
         "@types/lodash": "4.14.104",
         "@types/mocha": "^5.2.7",
         "@types/node": "*",

contracts/asset-proxy/src/index.ts

@@ -1,6 +1,64 @@
-export * from './artifacts';
+export { artifacts } from './artifacts';
-export * from './wrappers';
+export {
+    ERC1155ProxyContract,
+    ERC20BridgeProxyContract,
+    ERC20ProxyContract,
+    ERC721ProxyContract,
+    Eth2DaiBridgeContract,
+    IAssetDataContract,
+    IAssetProxyContract,
+    MultiAssetProxyContract,
+    StaticCallProxyContract,
+    TestStaticCallTargetContract,
+    UniswapBridgeContract,
+} from './wrappers';
 
 export { ERC20Wrapper } from './erc20_wrapper';
 export { ERC721Wrapper } from './erc721_wrapper';
 export { ERC1155ProxyWrapper } from './erc1155_proxy_wrapper';
+export { Erc1155Wrapper, ERC1155MintableContract } from '@0x/contracts-erc1155';
+export { DummyERC20TokenContract } from '@0x/contracts-erc20';
+export { DummyERC721TokenContract } from '@0x/contracts-erc721';
+export {
+    ERC1155HoldingsByOwner,
+    ERC20BalancesByOwner,
+    ERC721TokenIdsByOwner,
+    ERC1155FungibleHoldingsByOwner,
+    ERC1155NonFungibleHoldingsByOwner,
+} from '@0x/contracts-test-utils';
+export {
+    TransactionReceiptWithDecodedLogs,
+    Provider,
+    ZeroExProvider,
+    JSONRPCRequestPayload,
+    JSONRPCErrorCallback,
+    TransactionReceiptStatus,
+    JSONRPCResponsePayload,
+    JSONRPCResponseError,
+    ContractArtifact,
+    ContractChains,
+    CompilerOpts,
+    StandardContractOutput,
+    CompilerSettings,
+    ContractChainData,
+    ContractAbi,
+    DevdocOutput,
+    EvmOutput,
+    CompilerSettingsMetadata,
+    OptimizerSettings,
+    OutputField,
+    ParamDescription,
+    EvmBytecodeOutput,
+    AbiDefinition,
+    FunctionAbi,
+    EventAbi,
+    RevertErrorAbi,
+    EventParameter,
+    DataItem,
+    MethodAbi,
+    ConstructorAbi,
+    FallbackAbi,
+    ConstructorStateMutability,
+    TupleDataItem,
+    StateMutability,
+} from 'ethereum-types';

contracts/asset-proxy/typedoc-tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "../../typedoc-tsconfig",
+    "compilerOptions": {
+        "outDir": "lib"
+    },
+    "include": ["./src/**/*", "./test/**/*"]
+}

contracts/coordinator/package.json

@@ -33,7 +33,9 @@
         "contracts:gen": "contracts-gen generate",
         "contracts:copy": "contracts-gen copy",
         "lint-contracts": "solhint -c ../.solhint.json contracts/**/**/**/**/*.sol",
-        "compile:truffle": "truffle compile"
+        "compile:truffle": "truffle compile",
+        "docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
+        "docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "config": {
         "publicInterfaceContracts": "Coordinator,CoordinatorRegistry,LibCoordinatorApproval,LibCoordinatorRichErrors,LibEIP712CoordinatorDomain,LibConstants",
@@ -62,6 +64,8 @@
         "@0x/sol-compiler": "^3.2.0-beta.2",
         "@0x/tslint-config": "^3.1.0-beta.2",
         "@0x/web3-wrapper": "^6.1.0-beta.2",
+        "@0x/ts-doc-gen": "^0.0.22",
+        "typedoc": "^0.15.0",
         "@types/lodash": "4.14.104",
         "@types/mocha": "^5.2.7",
         "@types/node": "*",

contracts/coordinator/src/index.ts

@@ -1,5 +1,41 @@
-export * from './artifacts';
+export { artifacts } from './artifacts';
-export * from './wrappers';
+export {
+    CoordinatorContract,
+    CoordinatorRegistryContract,
+    LibConstantsContract,
+    LibCoordinatorApprovalContract,
+    LibCoordinatorRichErrorsContract,
+    LibEIP712CoordinatorDomainContract,
+} from './wrappers';
 export import CoordinatorRevertErrors = require('./revert_errors');
 export { ApprovalFactory } from './approval_factory';
 export { SignedCoordinatorApproval } from './types';
+export { SignatureType, SignedZeroExTransaction, EIP712DomainWithDefaultSchema } from '@0x/types';
+export {
+    ContractArtifact,
+    ContractChains,
+    CompilerOpts,
+    StandardContractOutput,
+    CompilerSettings,
+    ContractChainData,
+    ContractAbi,
+    DevdocOutput,
+    EvmOutput,
+    CompilerSettingsMetadata,
+    OptimizerSettings,
+    OutputField,
+    ParamDescription,
+    EvmBytecodeOutput,
+    AbiDefinition,
+    FunctionAbi,
+    EventAbi,
+    RevertErrorAbi,
+    EventParameter,
+    DataItem,
+    MethodAbi,
+    ConstructorAbi,
+    FallbackAbi,
+    ConstructorStateMutability,
+    TupleDataItem,
+    StateMutability,
+} from 'ethereum-types';

contracts/coordinator/typedoc-tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "../../typedoc-tsconfig",
+    "compilerOptions": {
+        "outDir": "lib"
+    },
+    "include": ["./src/**/*", "./test/**/*"]
+}

contracts/dev-utils/package.json

@@ -22,7 +22,9 @@
         "contracts:copy": "contracts-gen copy",
         "lint-contracts": "solhint -c ../.solhint.json contracts/**/**/**/**/*.sol",
         "quantify_bytecode": "echo EVM bytecode object lengths:;for i in ./test/generated-artifacts/*.json; do node -e \"console.log('$i\t' + (require('$i').compilerOutput.evm.bytecode.object.length - 2) / 2)\"; done",
-        "compile:truffle": "truffle compile"
+        "compile:truffle": "truffle compile",
+        "docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
+        "docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "config": {
         "publicInterfaceContracts": "DevUtils,LibAssetData,LibTransactionDecoder",
@@ -44,6 +46,8 @@
         "@0x/contracts-gen": "^1.1.0-beta.2",
         "@0x/sol-compiler": "^3.2.0-beta.2",
         "@0x/tslint-config": "^3.1.0-beta.2",
+        "@0x/ts-doc-gen": "^0.0.22",
+        "typedoc": "^0.15.0",
         "@types/node": "*",
         "ethers": "~4.0.4",
         "npm-run-all": "^4.1.2",

contracts/dev-utils/src/index.ts

@@ -1,2 +1,30 @@
-export * from './artifacts';
+export { artifacts } from './artifacts';
-export * from './wrappers';
+export { DevUtilsContract, LibAssetDataContract, LibTransactionDecoderContract } from './wrappers';
+export {
+    ContractArtifact,
+    ContractChains,
+    CompilerOpts,
+    StandardContractOutput,
+    CompilerSettings,
+    ContractChainData,
+    ContractAbi,
+    DevdocOutput,
+    EvmOutput,
+    CompilerSettingsMetadata,
+    OptimizerSettings,
+    OutputField,
+    ParamDescription,
+    EvmBytecodeOutput,
+    AbiDefinition,
+    FunctionAbi,
+    EventAbi,
+    RevertErrorAbi,
+    EventParameter,
+    DataItem,
+    MethodAbi,
+    ConstructorAbi,
+    FallbackAbi,
+    ConstructorStateMutability,
+    TupleDataItem,
+    StateMutability,
+} from 'ethereum-types';

contracts/dev-utils/typedoc-tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "../../typedoc-tsconfig",
+    "compilerOptions": {
+        "outDir": "lib"
+    },
+    "include": ["./src/**/*", "./test/**/*"]
+}

contracts/erc1155/package.json

@@ -33,7 +33,9 @@
         "contracts:gen": "contracts-gen generate",
         "contracts:copy": "contracts-gen copy",
         "lint-contracts": "solhint -c ../.solhint.json contracts/**/**/**/**/*.sol",
-        "compile:truffle": "truffle compile"
+        "compile:truffle": "truffle compile",
+        "docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
+        "docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "config": {
         "publicInterfaceContracts": "ERC1155,ERC1155Mintable,IERC1155Receiver,DummyERC1155Receiver",
@@ -57,6 +59,8 @@
         "@0x/sol-compiler": "^3.2.0-beta.2",
         "@0x/tslint-config": "^3.1.0-beta.2",
         "@0x/types": "^2.5.0-beta.2",
+        "@0x/ts-doc-gen": "^0.0.22",
+        "typedoc": "^0.15.0",
         "@types/lodash": "4.14.104",
         "@types/mocha": "^5.2.7",
         "@types/node": "*",

contracts/erc1155/src/index.ts

@@ -1,3 +1,45 @@
-export * from './wrappers';
+export {
-export * from './artifacts';
+    DummyERC1155ReceiverContract,
+    ERC1155Contract,
+    ERC1155MintableContract,
+    IERC1155ReceiverContract,
+    DummyERC1155ReceiverBatchTokenReceivedEventArgs,
+    ERC1155TransferSingleEventArgs,
+} from './wrappers';
+export { artifacts } from './artifacts';
 export { Erc1155Wrapper } from './erc1155_wrapper';
+export {
+    Provider,
+    TransactionReceiptWithDecodedLogs,
+    JSONRPCRequestPayload,
+    JSONRPCResponsePayload,
+    JSONRPCResponseError,
+    JSONRPCErrorCallback,
+    TransactionReceiptStatus,
+    ContractArtifact,
+    ContractChains,
+    CompilerOpts,
+    StandardContractOutput,
+    CompilerSettings,
+    ContractChainData,
+    ContractAbi,
+    DevdocOutput,
+    EvmOutput,
+    CompilerSettingsMetadata,
+    OptimizerSettings,
+    OutputField,
+    ParamDescription,
+    EvmBytecodeOutput,
+    AbiDefinition,
+    FunctionAbi,
+    EventAbi,
+    RevertErrorAbi,
+    EventParameter,
+    DataItem,
+    MethodAbi,
+    ConstructorAbi,
+    FallbackAbi,
+    ConstructorStateMutability,
+    TupleDataItem,
+    StateMutability,
+} from 'ethereum-types';

contracts/erc1155/typedoc-tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "../../typedoc-tsconfig",
+    "compilerOptions": {
+        "outDir": "lib"
+    },
+    "include": ["./src/**/*", "./test/**/*"]
+}

contracts/erc20/package.json

@@ -32,7 +32,9 @@
         "test:circleci": "yarn test",
         "contracts:gen": "contracts-gen generate",
         "contracts:copy": "contracts-gen copy",
-        "lint-contracts": "solhint -c ../.solhint.json contracts/**/**/**/**/*.sol"
+        "lint-contracts": "solhint -c ../.solhint.json contracts/**/**/**/**/*.sol",
+        "docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
+        "docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "config": {
         "publicInterfaceContracts": "DummyERC20Token,ERC20Token,WETH9,ZRXToken,DummyNoReturnERC20Token,DummyMultipleReturnERC20Token",
@@ -58,6 +60,8 @@
         "@0x/tslint-config": "^3.1.0-beta.2",
         "@0x/utils": "^4.6.0-beta.2",
         "@0x/web3-wrapper": "^6.1.0-beta.2",
+        "@0x/ts-doc-gen": "^0.0.22",
+        "typedoc": "^0.15.0",
         "@types/lodash": "4.14.104",
         "@types/mocha": "^5.2.7",
         "@types/node": "*",

contracts/erc20/src/index.ts

@@ -1,2 +1,42 @@
-export * from './wrappers';
+export {
-export * from './artifacts';
+    DummyERC20TokenContract,
+    DummyMultipleReturnERC20TokenContract,
+    DummyNoReturnERC20TokenContract,
+    WETH9Contract,
+    ZRXTokenContract,
+    DummyERC20TokenTransferEventArgs,
+    ERC20TokenEventArgs,
+    ERC20TokenEvents,
+    ERC20TokenTransferEventArgs,
+    ERC20TokenApprovalEventArgs,
+    ERC20TokenContract,
+} from './wrappers';
+export { artifacts } from './artifacts';
+export {
+    ContractArtifact,
+    ContractChains,
+    CompilerOpts,
+    StandardContractOutput,
+    CompilerSettings,
+    ContractChainData,
+    ContractAbi,
+    DevdocOutput,
+    EvmOutput,
+    CompilerSettingsMetadata,
+    OptimizerSettings,
+    OutputField,
+    ParamDescription,
+    EvmBytecodeOutput,
+    AbiDefinition,
+    FunctionAbi,
+    EventAbi,
+    RevertErrorAbi,
+    EventParameter,
+    DataItem,
+    MethodAbi,
+    ConstructorAbi,
+    FallbackAbi,
+    ConstructorStateMutability,
+    TupleDataItem,
+    StateMutability,
+} from 'ethereum-types';

contracts/erc20/typedoc-tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "../../typedoc-tsconfig",
+    "compilerOptions": {
+        "outDir": "lib"
+    },
+    "include": ["./src/**/*", "./test/**/*"]
+}

contracts/erc721/package.json

@@ -33,7 +33,9 @@
         "contracts:gen": "contracts-gen generate",
         "contracts:copy": "contracts-gen copy",
         "lint-contracts": "solhint -c ../.solhint.json contracts/**/**/**/**/*.sol",
-        "compile:truffle": "truffle compile"
+        "compile:truffle": "truffle compile",
+        "docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
+        "docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "config": {
         "publicInterfaceContracts": "DummyERC721Token,ERC721Token,IERC721Receiver,DummyERC721Receiver",
@@ -60,6 +62,8 @@
         "@0x/types": "^2.5.0-beta.2",
         "@0x/utils": "^4.6.0-beta.2",
         "@0x/web3-wrapper": "^6.1.0-beta.2",
+        "@0x/ts-doc-gen": "^0.0.22",
+        "typedoc": "^0.15.0",
         "@types/lodash": "4.14.104",
         "@types/mocha": "^5.2.7",
         "@types/node": "*",

contracts/erc721/src/index.ts

@@ -1,2 +1,35 @@
-export * from './wrappers';
+export {
-export * from './artifacts';
+    DummyERC721ReceiverContract,
+    DummyERC721TokenContract,
+    ERC721TokenContract,
+    IERC721ReceiverContract,
+} from './wrappers';
+export { artifacts } from './artifacts';
+export {
+    ContractArtifact,
+    ContractChains,
+    CompilerOpts,
+    StandardContractOutput,
+    CompilerSettings,
+    ContractChainData,
+    ContractAbi,
+    DevdocOutput,
+    EvmOutput,
+    CompilerSettingsMetadata,
+    OptimizerSettings,
+    OutputField,
+    ParamDescription,
+    EvmBytecodeOutput,
+    AbiDefinition,
+    FunctionAbi,
+    EventAbi,
+    RevertErrorAbi,
+    EventParameter,
+    DataItem,
+    MethodAbi,
+    ConstructorAbi,
+    FallbackAbi,
+    ConstructorStateMutability,
+    TupleDataItem,
+    StateMutability,
+} from 'ethereum-types';

contracts/erc721/typedoc-tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "../../typedoc-tsconfig",
+    "compilerOptions": {
+        "outDir": "lib"
+    },
+    "include": ["./src/**/*", "./test/**/*"]
+}

contracts/exchange-forwarder/package.json

@@ -32,7 +32,9 @@
         "contracts:gen": "contracts-gen generate",
         "contracts:copy": "contracts-gen copy",
         "lint-contracts": "solhint -c ../.solhint.json contracts/**/**/**/**/*.sol",
-        "compile:truffle": "truffle compile"
+        "compile:truffle": "truffle compile",
+        "docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
+        "docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "config": {
         "publicInterfaceContracts": "Forwarder",
@@ -66,6 +68,8 @@
         "@0x/types": "^2.5.0-beta.2",
         "@0x/utils": "^4.6.0-beta.2",
         "@0x/web3-wrapper": "^6.1.0-beta.2",
+        "@0x/ts-doc-gen": "^0.0.22",
+        "typedoc": "^0.15.0",
         "@types/lodash": "4.14.104",
         "@types/mocha": "^5.2.7",
         "@types/node": "*",

contracts/exchange-forwarder/src/index.ts

@@ -1,3 +1,31 @@
-export * from './artifacts';
+export { artifacts } from './artifacts';
-export * from './wrappers';
+export { ForwarderContract } from './wrappers';
 export import ForwarderRevertErrors = require('./revert_errors');
+export {
+    ContractArtifact,
+    ContractChains,
+    CompilerOpts,
+    StandardContractOutput,
+    CompilerSettings,
+    ContractChainData,
+    ContractAbi,
+    DevdocOutput,
+    EvmOutput,
+    CompilerSettingsMetadata,
+    OptimizerSettings,
+    OutputField,
+    ParamDescription,
+    EvmBytecodeOutput,
+    AbiDefinition,
+    FunctionAbi,
+    EventAbi,
+    RevertErrorAbi,
+    EventParameter,
+    DataItem,
+    MethodAbi,
+    ConstructorAbi,
+    FallbackAbi,
+    ConstructorStateMutability,
+    TupleDataItem,
+    StateMutability,
+} from 'ethereum-types';

contracts/exchange-forwarder/typedoc-tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "../../typedoc-tsconfig",
+    "compilerOptions": {
+        "outDir": "lib"
+    },
+    "include": ["./src/**/*", "./test/**/*"]
+}

contracts/exchange-libs/package.json

@@ -33,7 +33,9 @@
         "contracts:gen": "contracts-gen generate",
         "contracts:copy": "contracts-gen copy",
         "lint-contracts": "solhint -c ../.solhint.json contracts/**/**/**/**/*.sol",
-        "compile:truffle": "truffle compile"
+        "compile:truffle": "truffle compile",
+        "docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
+        "docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "config": {
         "publicInterfaceContracts": "IWallet,LibEIP712ExchangeDomain,LibExchangeRichErrors,LibMath,LibMathRichErrors,LibOrder,LibZeroExTransaction",
@@ -58,6 +60,8 @@
         "@0x/subproviders": "^5.1.0-beta.2",
         "@0x/tslint-config": "^3.1.0-beta.2",
         "@0x/web3-wrapper": "^6.1.0-beta.2",
+        "@0x/ts-doc-gen": "^0.0.22",
+        "typedoc": "^0.15.0",
         "@types/lodash": "4.14.104",
         "@types/mocha": "^5.2.7",
         "@types/node": "*",

contracts/exchange-libs/src/index.ts

@@ -1,6 +1,42 @@
-export * from './artifacts';
+export { artifacts } from './artifacts';
-export * from './wrappers';
+export {
+    IWalletContract,
+    LibEIP712ExchangeDomainContract,
+    LibExchangeRichErrorsContract,
+    LibMathContract,
+    LibMathRichErrorsContract,
+    LibOrderContract,
+    LibZeroExTransactionContract,
+} from './wrappers';
 export import LibMathRevertErrors = require('./lib_math_revert_errors');
 
 import * as ReferenceFunctionsToExport from './reference_functions';
 export import ReferenceFunctions = ReferenceFunctionsToExport;
+export {
+    ContractArtifact,
+    ContractChains,
+    CompilerOpts,
+    StandardContractOutput,
+    CompilerSettings,
+    ContractChainData,
+    ContractAbi,
+    DevdocOutput,
+    EvmOutput,
+    CompilerSettingsMetadata,
+    OptimizerSettings,
+    OutputField,
+    ParamDescription,
+    EvmBytecodeOutput,
+    AbiDefinition,
+    FunctionAbi,
+    EventAbi,
+    RevertErrorAbi,
+    EventParameter,
+    DataItem,
+    MethodAbi,
+    ConstructorAbi,
+    FallbackAbi,
+    ConstructorStateMutability,
+    TupleDataItem,
+    StateMutability,
+} from 'ethereum-types';

contracts/exchange/package.json

@@ -33,7 +33,9 @@
         "contracts:gen": "contracts-gen generate",
         "contracts:copy": "contracts-gen copy",
         "lint-contracts": "solhint -c ../.solhint.json contracts/**/**/**/**/*.sol",
-        "compile:truffle": "truffle compile"
+        "compile:truffle": "truffle compile",
+        "docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
+        "docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "config": {
         "publicInterfaceContracts": "Exchange,IExchange",
@@ -62,6 +64,8 @@
         "@0x/sol-compiler": "^3.2.0-beta.2",
         "@0x/tslint-config": "^3.1.0-beta.2",
         "@0x/web3-wrapper": "^6.1.0-beta.2",
+        "@0x/ts-doc-gen": "^0.0.22",
+        "typedoc": "^0.15.0",
         "@types/lodash": "4.14.104",
         "@types/mocha": "^5.2.7",
         "@types/node": "*",

contracts/exchange/src/index.ts

@@ -1,4 +1,67 @@
-export * from './artifacts';
+export { artifacts } from './artifacts';
-export * from './wrappers';
+export {
+    IExchangeContract,
+    IExchangeEvents,
+    IExchangeFillEventArgs,
+    ExchangeEventArgs,
+    ExchangeEvents,
+    ExchangeSignatureValidatorApprovalEventArgs,
+    ExchangeFillEventArgs,
+    ExchangeCancelEventArgs,
+    ExchangeCancelUpToEventArgs,
+    ExchangeAssetProxyRegisteredEventArgs,
+    ExchangeContract,
+    ExchangeProtocolFeeCollectorAddressEventArgs,
+    ExchangeProtocolFeeMultiplierEventArgs,
+    ExchangeTransactionExecutionEventArgs,
+} from './wrappers';
 export import ExchangeRevertErrors = require('./revert_errors');
 export { exchangeDataEncoder } from './exchange_data_encoder';
+export {
+    TokenOwnersByName,
+    TokenContractsByName,
+    TokenIds,
+    ERC1155TokenIds,
+    ERC721TokenIds,
+    TokenData,
+    Named,
+} from './balance_stores/types';
+export { SignedOrder } from '@0x/types';
+export {
+    Numberish,
+    TokenBalances,
+    ExchangeFunctionName,
+    ERC1155Holdings,
+    ERC20BalancesByOwner,
+    ERC721TokenIdsByOwner,
+    EthBalancesByOwner,
+} from '@0x/contracts-test-utils';
+export { DevUtilsContract } from '@0x/contracts-dev-utils';
+export {
+    ContractArtifact,
+    ContractChains,
+    CompilerOpts,
+    StandardContractOutput,
+    CompilerSettings,
+    ContractChainData,
+    ContractAbi,
+    DevdocOutput,
+    EvmOutput,
+    CompilerSettingsMetadata,
+    OptimizerSettings,
+    OutputField,
+    ParamDescription,
+    EvmBytecodeOutput,
+    AbiDefinition,
+    FunctionAbi,
+    EventAbi,
+    RevertErrorAbi,
+    EventParameter,
+    DataItem,
+    MethodAbi,
+    ConstructorAbi,
+    FallbackAbi,
+    ConstructorStateMutability,
+    TupleDataItem,
+    StateMutability,
+} from 'ethereum-types';

contracts/exchange/typedoc-tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "../../typedoc-tsconfig",
+    "compilerOptions": {
+        "outDir": "lib"
+    },
+    "include": ["./src/**/*", "./test/**/*"]
+}

contracts/extensions/package.json

@@ -33,7 +33,9 @@
         "contracts:gen": "contracts-gen generate",
         "contracts:copy": "contracts-gen copy",
         "lint-contracts": "solhint -c ../.solhint.json contracts/**/**/**/**/*.sol",
-        "compile:truffle": "truffle compile"
+        "compile:truffle": "truffle compile",
+        "docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
+        "docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "config": {
         "publicInterfaceContracts": "DutchAuction,OrderMatcher,BalanceThresholdFilter",
@@ -67,6 +69,8 @@
         "@0x/types": "^2.5.0-beta.2",
         "@0x/utils": "^4.6.0-beta.2",
         "@0x/web3-wrapper": "^6.1.0-beta.2",
+        "@0x/ts-doc-gen": "^0.0.22",
+        "typedoc": "^0.15.0",
         "@types/lodash": "4.14.104",
         "@types/mocha": "^5.2.7",
         "@types/node": "*",

contracts/extensions/src/index.ts

@@ -1,2 +1,30 @@
-export * from './artifacts';
+export { artifacts } from './artifacts';
-export * from './wrappers';
+export { BalanceThresholdFilterContract, DutchAuctionContract, OrderMatcherContract } from './wrappers';
+export {
+    ContractArtifact,
+    ContractChains,
+    CompilerOpts,
+    StandardContractOutput,
+    CompilerSettings,
+    ContractChainData,
+    ContractAbi,
+    DevdocOutput,
+    EvmOutput,
+    CompilerSettingsMetadata,
+    OptimizerSettings,
+    OutputField,
+    ParamDescription,
+    EvmBytecodeOutput,
+    AbiDefinition,
+    FunctionAbi,
+    EventAbi,
+    RevertErrorAbi,
+    EventParameter,
+    DataItem,
+    MethodAbi,
+    ConstructorAbi,
+    FallbackAbi,
+    ConstructorStateMutability,
+    TupleDataItem,
+    StateMutability,
+} from 'ethereum-types';

contracts/extensions/src/wrappers.ts

@@ -5,7 +5,4 @@
  */
 export * from '../generated-wrappers/balance_threshold_filter';
 export * from '../generated-wrappers/dutch_auction';
-export * from '../generated-wrappers/exchange';
-export * from '../generated-wrappers/exchange_wrapper';
 export * from '../generated-wrappers/order_matcher';
-export * from '../generated-wrappers/weth9';

contracts/extensions/typedoc-tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "../../typedoc-tsconfig",
+    "compilerOptions": {
+        "outDir": "lib"
+    },
+    "include": ["./src/**/*", "./test/**/*"]
+}

contracts/integrations/src/index.ts

@@ -1,2 +1,2 @@
-export * from './artifacts';
+export { artifacts } from './artifacts';
 export * from './wrappers';

contracts/integrations/test/framework/balances/types.ts

@@ -6,7 +6,7 @@ import { BigNumber } from '@0x/utils';
 // alias for clarity
 type address = string;
 
-interface TokenData<TERC20, TERC721, TERC1155> {
+export interface TokenData<TERC20, TERC721, TERC1155> {
     erc20: TERC20;
     erc721: TERC721;
     erc1155: TERC1155;
@@ -20,7 +20,7 @@ export type TokenContracts = TokenData<
     ERC1155MintableContract[]
 >;
 
-interface Named<T> {
+export interface Named<T> {
     [readableName: string]: T;
 }
 
@@ -34,11 +34,11 @@ export type TokenContractsByName = TokenData<
     Named<ERC1155MintableContract>
 >;
 
-interface ERC721TokenIds {
+export interface ERC721TokenIds {
     [tokenAddress: string]: BigNumber[];
 }
 
-interface ERC1155TokenIds {
+export interface ERC1155TokenIds {
     [tokenAddress: string]: {
         fungible: BigNumber[];
         nonFungible: BigNumber[];

contracts/multisig/src/index.ts

@@ -1,2 +1,2 @@
-export * from './artifacts';
+export { artifacts } from './artifacts';
 export * from './wrappers';

contracts/staking/package.json

@@ -34,7 +34,9 @@
         "contracts:gen": "contracts-gen generate",
         "contracts:copy": "contracts-gen copy",
         "lint-contracts": "solhint -c ../.solhint.json contracts/**/**/**/**/*.sol",
-        "compile:truffle": "truffle compile"
+        "compile:truffle": "truffle compile",
+        "docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
+        "docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "config": {
         "publicInterfaceContracts": "IStaking,IStakingEvents,IStakingProxy,IZrxVault,LibStakingRichErrors,Staking,StakingProxy,ZrxVault,TestStaking",
@@ -64,6 +66,8 @@
         "@0x/tslint-config": "^3.1.0-beta.2",
         "@0x/types": "^2.5.0-beta.2",
         "@0x/web3-wrapper": "^6.1.0-beta.2",
+        "@0x/ts-doc-gen": "^0.0.22",
+        "typedoc": "^0.15.0",
         "@types/lodash": "4.14.104",
         "@types/node": "*",
         "chai": "^4.0.1",

contracts/staking/src/index.ts

@@ -1,13 +1,75 @@
-export * from './wrappers';
+export {
-export * from './artifacts';
+    IStakingContract,
+    IStakingEventsContract,
+    IStakingProxyContract,
+    IZrxVaultContract,
+    LibStakingRichErrorsContract,
+    TestStakingContract,
+    ZrxVaultContract,
+    StakingAuthorizedAddressAddedEventArgs,
+    StakingAuthorizedAddressRemovedEventArgs,
+    StakingContract,
+    StakingEpochEndedEventArgs,
+    StakingEpochFinalizedEventArgs,
+    StakingEventArgs,
+    StakingEvents,
+    StakingExchangeAddedEventArgs,
+    StakingExchangeRemovedEventArgs,
+    StakingMakerStakingPoolSetEventArgs,
+    StakingMoveStakeEventArgs,
+    StakingOperatorShareDecreasedEventArgs,
+    StakingOwnershipTransferredEventArgs,
+    StakingParamsSetEventArgs,
+    StakingRewardsPaidEventArgs,
+    StakingStakeEventArgs,
+    StakingStakingPoolCreatedEventArgs,
+    StakingStakingPoolEarnedRewardsInEpochEventArgs,
+    StakingUnstakeEventArgs,
+    StakingProxyAuthorizedAddressAddedEventArgs,
+    StakingProxyAuthorizedAddressRemovedEventArgs,
+    StakingProxyContract,
+    StakingProxyEventArgs,
+    StakingProxyEvents,
+    StakingProxyOwnershipTransferredEventArgs,
+    StakingProxyStakingContractAttachedToProxyEventArgs,
+    StakingProxyStakingContractDetachedFromProxyEventArgs,
+    IStakingEventsStakingPoolEarnedRewardsInEpochEventArgs,
+    TestStakingEvents,
+    IStakingEventsEpochEndedEventArgs,
+    IStakingEventsEpochFinalizedEventArgs,
+    IStakingEventsEvents,
+    IStakingEventsRewardsPaidEventArgs,
+} from './wrappers';
+export { artifacts } from './artifacts';
 export import FixedMathRevertErrors = require('./fixed_math_revert_errors');
 export import StakingRevertErrors = require('./staking_revert_errors');
 export { constants } from './constants';
+export { StakeInfo, StakeStatus, StoredBalance } from './types';
 export {
-    GlobalStakeByStatus,
+    ContractArtifact,
-    OwnerStakeByStatus,
+    ContractChains,
-    StakeInfo,
+    CompilerOpts,
-    StakingPoolById,
+    StandardContractOutput,
-    StakeStatus,
+    CompilerSettings,
-    StoredBalance,
+    ContractChainData,
-} from './types';
+    ContractAbi,
+    DevdocOutput,
+    EvmOutput,
+    CompilerSettingsMetadata,
+    OptimizerSettings,
+    OutputField,
+    ParamDescription,
+    EvmBytecodeOutput,
+    AbiDefinition,
+    FunctionAbi,
+    EventAbi,
+    RevertErrorAbi,
+    EventParameter,
+    DataItem,
+    MethodAbi,
+    ConstructorAbi,
+    FallbackAbi,
+    ConstructorStateMutability,
+    TupleDataItem,
+    StateMutability,
+} from 'ethereum-types';

contracts/staking/typedoc-tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "../../typedoc-tsconfig",
+    "compilerOptions": {
+        "outDir": "lib"
+    },
+    "include": ["./src/**/*", "./test/**/*"]
+}

contracts/tests/src/index.ts

@@ -1 +1 @@
-export * from './artifacts';
+export { artifacts } from './artifacts';

contracts/utils/src/index.ts

@@ -1,4 +1,4 @@
-export * from './artifacts';
+export { artifacts } from './artifacts';
 export * from './wrappers';
 
 import * as ReferenceFunctionsToExport from './reference_functions';

package.json

@@ -53,7 +53,7 @@
     "config": {
         "contractsPackages": "@0x/contracts-asset-proxy @0x/contracts-dev-utils @0x/contracts-erc20 @0x/contracts-erc721 @0x/contracts-erc1155 @0x/contracts-exchange @0x/contracts-exchange-forwarder @0x/contracts-exchange-libs @0x/contracts-integrations @0x/contracts-multisig @0x/contracts-staking @0x/contracts-test-utils @0x/contracts-utils @0x/contracts-coordinator @0x/contracts-tests",
         "mnemonic": "concert load couple harbor equip island argue ramp clarify fence smart topic",
-        "packagesWithDocPages": "contract-wrappers 0x.js connect json-schemas subproviders web3-wrapper order-utils sol-compiler sol-coverage sol-profiler sol-trace ethereum-types asset-swapper migrations",
+        "packagesWithDocPages": "0x.js @0x/contract-wrappers @0x/connect @0x/json-schemas @0x/subproviders @0x/web3-wrapper @0x/order-utils @0x/sol-compiler @0x/sol-coverage @0x/sol-profiler @0x/sol-trace @0x/dev-utils @0x/asset-swapper @0x/migrations @0x/orderbook @0x/contracts-asset-proxy @0x/contracts-coordinator @0x/contracts-dev-utils @0x/contracts-erc20 @0x/contracts-erc721 @0x/contracts-erc1155 @0x/contracts-exchange @0x/contracts-exchange-forwarder @0x/contracts-exchange-libs @0x/contracts-extensions @0x/contracts-staking",
         "ignoreDependencyVersions": "@types/styled-components @types/node",
         "ignoreDependencyVersionsForPackage": "instant contract-wrappers"
     },

packages/abi-gen/test-cli/test_typescript/src/index.ts

@@ -1,2 +1,2 @@
-export * from './artifacts';
+export { artifacts } from './artifacts';
 export * from './wrappers';

packages/dev-utils/package.json

@@ -18,7 +18,9 @@
         "coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info",
         "clean": "shx rm -rf lib",
         "lint": "tslint --format stylish --project .",
-        "fix": "tslint --format stylish --fix --project ."
+        "fix": "tslint --format stylish --fix --project .",
+        "docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
+        "docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "license": "Apache-2.0",
     "repository": {
@@ -31,6 +33,7 @@
     "homepage": "https://github.com/0xProject/0x-monorepo/packages/dev-utils/README.md",
     "devDependencies": {
         "@0x/tslint-config": "^3.1.0-beta.2",
+        "@0x/ts-doc-gen": "^0.0.22",
         "@types/lodash": "4.14.104",
         "@types/mocha": "^5.2.7",
         "make-promises-safe": "^1.1.0",
@@ -39,7 +42,8 @@
         "nyc": "^11.0.1",
         "shx": "^0.2.2",
         "tslint": "5.11.0",
-        "typescript": "3.0.1"
+        "typescript": "3.0.1",
+        "typedoc": "^0.15.0"
     },
     "dependencies": {
         "@0x/subproviders": "^5.1.0-beta.2",
@@ -47,6 +51,7 @@
         "@0x/typescript-typings": "^4.4.0-beta.2",
         "@0x/utils": "^4.6.0-beta.2",
         "@0x/web3-wrapper": "^6.1.0-beta.2",
+        "web3-provider-engine": "14.0.6",
         "@types/web3-provider-engine": "^14.0.0",
         "chai": "^4.0.1",
         "chai-as-promised": "^7.1.0",

packages/dev-utils/src/index.ts

@@ -1,7 +1,63 @@
 export { BlockchainLifecycle } from './blockchain_lifecycle';
-export { web3Factory } from './web3_factory';
+export { web3Factory, Web3Config } from './web3_factory';
 export { constants as devConstants } from './constants';
-export { env, EnvVars } from './env';
+export { env } from './env';
 export { callbackErrorReporter } from './callback_error_reporter';
 export { chaiSetup } from './chai_setup';
 export { tokenUtils } from './token_utils';
+export { Web3Wrapper, NodeType } from '@0x/web3-wrapper';
+export import Web3ProviderEngine = require('web3-provider-engine');
+export { DoneCallback } from '@0x/types';
+export { AbiDecoder, DecodedCalldata } from '@0x/utils';
+export {
+    SupportedProvider,
+    CallData,
+    TransactionReceiptWithDecodedLogs,
+    BlockParam,
+    TxData,
+    BlockWithoutTransactionData,
+    BlockWithTransactionData,
+    FilterObject,
+    LogEntry,
+    Transaction,
+    TransactionReceipt,
+    TraceParams,
+    TransactionTrace,
+    JSONRPCRequestPayload,
+    LogTopic,
+    DecodedLogEntry,
+    LogEntryEvent,
+    TransactionReceiptStatus,
+    StructLog,
+    TxDataPayable,
+    BlockParamLiteral,
+    Web3JsProvider,
+    GanacheProvider,
+    EIP1193Provider,
+    ZeroExProvider,
+    AbiDefinition,
+    DecodedLogArgs,
+    LogWithDecodedArgs,
+    RawLog,
+    ContractEventArg,
+    DecodedLogEntryEvent,
+    EIP1193Event,
+    JSONRPCErrorCallback,
+    OpCode,
+    FunctionAbi,
+    EventAbi,
+    RevertErrorAbi,
+    Web3JsV1Provider,
+    Web3JsV2Provider,
+    Web3JsV3Provider,
+    EventParameter,
+    DataItem,
+    JSONRPCResponsePayload,
+    MethodAbi,
+    ConstructorAbi,
+    FallbackAbi,
+    ConstructorStateMutability,
+    TupleDataItem,
+    JSONRPCResponseError,
+    StateMutability,
+} from 'ethereum-types';

packages/orderbook/package.json

@@ -24,13 +24,17 @@
         "watch": "tsc -w -p tsconfig.json",
         "prettier": "prettier --write 'src/**/*.ts' --config .prettierrc",
         "test:circleci": "yarn test:coverage",
-        "lint": "tslint --project . --format stylish"
+        "lint": "tslint --project . --format stylish",
+        "docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
+        "docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
     },
     "author": "Jacob Evans",
     "license": "Apache-2.0",
     "devDependencies": {
         "@0x/tslint-config": "^3.1.0-beta.2",
         "@0x/types": "^2.5.0-beta.2",
+        "@0x/ts-doc-gen": "^0.0.22",
+        "typedoc": "^0.15.0",
         "@types/jest": "^24.0.17",
         "@types/sinon": "^2.2.2",
         "@types/websocket": "^0.0.39",

packages/orderbook/src/index.ts

@@ -13,5 +13,11 @@ export {
     AddedRemovedOrders,
     RejectedOrder,
 } from './types';
+export {
+    SignedOrder,
+    AssetPairsItem,
+    APIOrder,
+    Asset,
+} from '@0x/types';
 
 export { WSOpts } from '@0x/mesh-rpc-client';

packages/orderbook/typedoc-tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "../../typedoc-tsconfig",
+    "compilerOptions": {
+        "outDir": "lib"
+    },
+    "include": ["./src/**/*", "./test/**/*"]
+}