This repository has been archived by the owner on Jul 9, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 465
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2347 from 0xProject/refactor/supportDocsForContra…
…ctPackages docs: Generate MD docs for contracts-* packages and a few others
- Loading branch information
Showing
48 changed files
with
717 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "extends": "../../typedoc-tsconfig", | ||
| "compilerOptions": { | ||
| "outDir": "lib" | ||
| }, | ||
| "include": ["./src/**/*", "./test/**/*"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "extends": "../../typedoc-tsconfig", | ||
| "compilerOptions": { | ||
| "outDir": "lib" | ||
| }, | ||
| "include": ["./src/**/*", "./test/**/*"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "extends": "../../typedoc-tsconfig", | ||
| "compilerOptions": { | ||
| "outDir": "lib" | ||
| }, | ||
| "include": ["./src/**/*", "./test/**/*"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "extends": "../../typedoc-tsconfig", | ||
| "compilerOptions": { | ||
| "outDir": "lib" | ||
| }, | ||
| "include": ["./src/**/*", "./test/**/*"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "extends": "../../typedoc-tsconfig", | ||
| "compilerOptions": { | ||
| "outDir": "lib" | ||
| }, | ||
| "include": ["./src/**/*", "./test/**/*"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.