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

Merge branch 'development' into optimize/refactor-templates

Browse Source
This commit is contained in:
Jacob Evans 2019-11-19 10:07:46 +10:00 committed by GitHub
commit 81e146650b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
46 changed files with 707 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
contracts/asset-proxy/package.json
View File

@ -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": "*",

62
contracts/asset-proxy/src/index.ts
View File

@ -1,6 +1,64 @@
export * from './artifacts';
export * from './wrappers';
export { artifacts } from './artifacts';
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';

7
contracts/asset-proxy/typedoc-tsconfig.json Normal file
View File

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

6
contracts/coordinator/package.json
View File

@ -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": "*",

40
contracts/coordinator/src/index.ts
View File

@ -1,5 +1,41 @@
export * from './artifacts';
export * from './wrappers';
export { artifacts } from './artifacts';
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';

7
contracts/coordinator/typedoc-tsconfig.json Normal file
View File

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

6
contracts/dev-utils/package.json
View File

@ -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",

32
contracts/dev-utils/src/index.ts
View File

@ -1,2 +1,30 @@
export * from './artifacts';
export * from './wrappers';
export { artifacts } from './artifacts';
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';

7
contracts/dev-utils/typedoc-tsconfig.json Normal file
View File

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

6
contracts/erc1155/package.json
View File

@ -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": "*",

46
contracts/erc1155/src/index.ts
View File

@ -1,3 +1,45 @@
export * from './wrappers';
export * from './artifacts';
export {
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';

7
contracts/erc1155/typedoc-tsconfig.json Normal file
View File

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

6
contracts/erc20/package.json
View File

@ -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": "*",

44
contracts/erc20/src/index.ts
View File

@ -1,2 +1,42 @@
export * from './wrappers';
export * from './artifacts';
export {
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';

7
contracts/erc20/typedoc-tsconfig.json Normal file
View File

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

6
contracts/erc721/package.json
View File

@ -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": "*",

37
contracts/erc721/src/index.ts
View File

@ -1,2 +1,35 @@
export * from './wrappers';
export * from './artifacts';
export {
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';

7
contracts/erc721/typedoc-tsconfig.json Normal file
View File

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

6
contracts/exchange-forwarder/package.json
View File

@ -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": "*",

32
contracts/exchange-forwarder/src/index.ts
View File

@ -1,3 +1,31 @@
export * from './artifacts';
export * from './wrappers';
export { artifacts } from './artifacts';
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';

7
contracts/exchange-forwarder/typedoc-tsconfig.json Normal file
View File

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

6
contracts/exchange-libs/package.json
View File

@ -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": "*",

40
contracts/exchange-libs/src/index.ts
View File

@ -1,6 +1,42 @@
export * from './artifacts';
export * from './wrappers';
export { artifacts } from './artifacts';
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';

6
contracts/exchange/package.json
View File

@ -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": "*",

50
contracts/exchange/src/index.ts
View File

@ -1,4 +1,50 @@
export * from './artifacts';
export * from './wrappers';
export { artifacts } from './artifacts';
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 { SignedOrder } from '@0x/types';
export { ExchangeFunctionName } 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';

7
contracts/exchange/typedoc-tsconfig.json Normal file
View File

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

6
contracts/extensions/package.json
View File

@ -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": "*",

32
contracts/extensions/src/index.ts
View File

@ -1,2 +1,30 @@
export * from './artifacts';
export * from './wrappers';
export { artifacts } from './artifacts';
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';

3
contracts/extensions/src/wrappers.ts
View File

@ -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';

7
contracts/extensions/typedoc-tsconfig.json Normal file
View File

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

2
contracts/integrations/src/index.ts
View File

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

2
contracts/multisig/src/index.ts
View File

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

6
contracts/staking/package.json
View File

@ -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",

80
contracts/staking/src/index.ts
View File

@ -1,13 +1,83 @@
export * from './wrappers';
export * from './artifacts';
export {
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 {
GlobalStakeByStatus,
OwnerStakeByStatus,
StakeInfo,
StakingPoolById,
StakeStatus,
StoredBalance,
StakingPoolById,
OwnerStakeByStatus,
GlobalStakeByStatus,
StakingPool,
} from './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';

7
contracts/staking/typedoc-tsconfig.json Normal file
View File

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

2
contracts/tests/src/index.ts
View File

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

2
contracts/utils/src/index.ts
View File

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

2
package.json
View File

@ -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"
},

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

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

9
packages/dev-utils/package.json
View File

@ -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",

58
packages/dev-utils/src/index.ts
View File

@ -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 { 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';

6
packages/monorepo-scripts/src/doc_gen_configs.ts
View File

@ -52,8 +52,12 @@ export const docGenConfigs: DocGenConfigs = {
'ContractFunctionObj',
'ContractTxFunctionObj',
'EventCallback ',
'EnvVars',
'GlobalStakeByStatus',
'OwnerStakeByStatus',
'StakingPoolById',
],
// Some libraries only export types. In those cases, we cannot check if the exported types are part of the
// "exported public interface". Thus we add them here and skip those checks.
TYPES_ONLY_LIBRARIES: ['ethereum-types', 'types'],
TYPES_ONLY_LIBRARIES: ['ethereum-types', '@0x/types'],
};

31
packages/monorepo-scripts/src/utils/doc_generate_utils.ts
View File

@ -13,6 +13,7 @@ import { utils } from './utils';
export class DocGenerateUtils {
private readonly _packageName: string;
private readonly _packageDir: string;
private readonly _omitExports: string[];
private readonly _packagePath: string;
private readonly _exportPathToExportedItems: ExportPathToExportedItems;
@ -160,7 +161,6 @@ export class DocGenerateUtils {
}
constructor(packageName: string) {
this._packageName = packageName;
this._packagePath = `${constants.monorepoRootPath}/packages/${packageName}`;
this._monoRepoPkgNameToPath = {};
const monorepoPackages = utils.getPackages(constants.monorepoRootPath);
@ -169,6 +169,11 @@ export class DocGenerateUtils {
const pkg = _.find(monorepoPackages, monorepoPackage => {
return _.includes(monorepoPackage.packageJson.name, packageName);
});
if (pkg === undefined) {
throw new Error(`No package found with name ${packageName}`);
}
this._packagePath = pkg.location;
this._packageDir = pkg.location.substring(pkg.location.lastIndexOf('/') + 1);
if (pkg === undefined) {
throw new Error(`Couldn't find a package.json for ${packageName}`);
}
@ -197,7 +202,7 @@ export class DocGenerateUtils {
const mdFileDir = path.join(this._packagePath, 'docs');
const mdReferencePath = `${mdFileDir}/reference.mdx`;
const projectFiles = typeDocExtraFileIncludes.join(' ');
const cwd = path.join(constants.monorepoRootPath, 'packages', this._packageName);
const cwd = this._packagePath;
// HACK: For some reason calling `typedoc` command directly from here, even with `cwd` set to the
// packages root dir, does not work. It only works when called via a `package.json` script located
// in the package's root.
@ -356,7 +361,7 @@ export class DocGenerateUtils {
_.each(typedocOutput.children, (child, i) => {
if (!_.includes(child.name, '/src/')) {
const nameWithoutQuotes = child.name.replace(/"/g, '');
const standardizedName = `"${this._packageName}/src/${nameWithoutQuotes}"`;
const standardizedName = `"${this._packageDir}/src/${nameWithoutQuotes}"`;
modifiedTypedocOutput.children[i].name = standardizedName;
}
});
@ -366,18 +371,28 @@ export class DocGenerateUtils {
* Maps back each top-level TypeDoc JSON object name to the exportPath from which it was generated.
*/
private _findExportPathGivenTypedocName(typedocName: string): string {
const typeDocNameWithoutQuotes = _.replace(typedocName, /"/g, '');
let typeDocNameWithoutQuotes = _.replace(typedocName, /"/g, '');
if (typeDocNameWithoutQuotes.startsWith('contracts/')) {
// tslint:disable-next-line:custom-no-magic-numbers
typeDocNameWithoutQuotes = typeDocNameWithoutQuotes.substring(10);
} else if (typeDocNameWithoutQuotes.startsWith('packages/')) {
// tslint:disable-next-line:custom-no-magic-numbers
typeDocNameWithoutQuotes = typeDocNameWithoutQuotes.substring(9);
}
const sanitizedExportPathToExportPath: { [sanitizedName: string]: string } = {};
const exportPaths = _.keys(this._exportPathToExportedItems);
const sanitizedExportPaths = _.map(exportPaths, exportPath => {
if (_.startsWith(exportPath, './')) {
const sanitizedExportPath = path.join(this._packageName, 'src', exportPath);
const sanitizedExportPath = path.join(this._packageDir, 'src', exportPath);
sanitizedExportPathToExportPath[sanitizedExportPath] = exportPath;
return sanitizedExportPath;
}
const monorepoPrefix = '@0x/';
if (_.startsWith(exportPath, monorepoPrefix)) {
const sanitizedExportPath = exportPath.split(monorepoPrefix)[1];
let sanitizedExportPath = exportPath.split(monorepoPrefix)[1];
if (sanitizedExportPath.startsWith('contracts-')) {
sanitizedExportPath = sanitizedExportPath.replace('contracts-', '');
}
sanitizedExportPathToExportPath[sanitizedExportPath] = exportPath;
return sanitizedExportPath;
}
@ -394,7 +409,9 @@ export class DocGenerateUtils {
return _.startsWith(typeDocNameWithoutQuotes, p);
});
if (matchingSanitizedExportPathIfExists === undefined) {
throw new Error(`Didn't find an exportPath for ${typeDocNameWithoutQuotes}`);
throw new Error(
`Didn't find an exportPath for ${typeDocNameWithoutQuotes} ${sanitizedExportPathsSortedByLength}`,
);
}
const matchingExportPath = sanitizedExportPathToExportPath[matchingSanitizedExportPathIfExists];
return matchingExportPath;

6
packages/orderbook/package.json
View File

@ -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",

1
packages/orderbook/src/index.ts
View File

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

7
packages/orderbook/typedoc-tsconfig.json Normal file
View File

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