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

Merge pull request #2033 from 0xProject/feature/genMDDocs

Browse Source 
Generate MD docs for all packages
This commit is contained in:
Fabio B
2019-08-26 08:08:17 +02:00
committed by GitHub
parent cbb40c1c2b e452cfcd59
commit ad83b17fdf
41 changed files with 19409 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.circleci/config.yml
View File

@@ -23,7 +23,7 @@ jobs:
# command: npm set prefix=/home/circleci/npm && echo 'export PATH=$HOME/circleci/npm/bin:$PATH' >> /home/circleci/.bashrc
- run:
name: install-yarn
command: npm install --global yarn@1.9.4
command: npm install --global yarn@1.17.0
- run:
name: yarn
command: yarn --frozen-lockfile --ignore-engines install || yarn --frozen-lockfile --ignore-engines install
@@ -302,6 +302,7 @@ jobs:
- run: yarn lerna run lint
- run: yarn prettier:ci
- run: yarn deps_versions:ci
- run: yarn diff_md_docs:ci
- run: cd packages/0x.js && yarn build:umd:prod
- run: yarn bundlewatch
submit-coverage:

3
.gitignore vendored
View File

@@ -150,3 +150,6 @@ python-packages/*/.coverage
# python keeps package-local copies of json schemas
python-packages/json_schemas/src/zero_ex/json_schemas/schemas
# Doc README copy
packages/*/docs/README.md

1
.prettierignore
View File

@@ -38,3 +38,4 @@ packages/sol-coverage/test/fixtures/artifacts
packages/abi-gen/test-cli/fixtures/artifacts/AbiGenDummy.json
packages/abi-gen/test-cli/fixtures/artifacts/LibDummy.json
packages/abi-gen/test-cli/fixtures/artifacts/TestLibDummy.json
packages/*/docs

8
package.json
View File

@@ -43,6 +43,9 @@
"test": "wsrun test $PKG --fast-exit --serial --exclude-missing",
"test:contracts": "wsrun test -p ${npm_package_config_contractsPackages} -c --fast-exit --serial --exclude-missing",
"generate_doc": "node ./packages/monorepo-scripts/lib/doc_generate_and_upload.js",
"generate_md_docs": "wsrun docs:md --exclude-missing",
"upload_md_docs": "wsrun s3:sync_md_docs --exclude-missing",
"diff_md_docs:ci": "wsrun diff_docs --exclude-missing",
"test:generate_docs:circleci": "for i in ${npm_package_config_packagesWithDocPages}; do yarn generate_doc --package $i --shouldUpload false --isStaging true || break -1; done;",
"bundlewatch": "bundlewatch",
"lint": "wsrun lint $PKG --fast-exit --parallel --exclude-missing"
@@ -50,7 +53,7 @@
"config": {
"contractsPackages": "@0x/contracts-asset-proxy @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-multisig @0x/contracts-test-utils @0x/contracts-utils @0x/contracts-coordinator @0x/contracts-dev-utils",
"mnemonic": "concert load couple harbor equip island argue ramp clarify fence smart topic",
"packagesWithDocPages": "0x.js connect json-schemas subproviders web3-wrapper order-utils sol-compiler sol-coverage sol-profiler sol-trace ethereum-types asset-buyer migrations",
"packagesWithDocPages": "connect json-schemas subproviders web3-wrapper order-utils sol-compiler sol-coverage sol-profiler sol-trace ethereum-types asset-buyer migrations",
"ignoreDependencyVersions": "@types/styled-components @types/node",
"ignoreDependencyVersionsForPackage": "website instant dev-tools-pages contract-wrappers"
},
@@ -73,9 +76,6 @@
"repoBranchBase": "development"
}
},
"resolutions": {
"graceful-fs": "4.1.15"
},
"devDependencies": {
"@0x-lerna-fork/lerna": "3.16.10",
"@0xproject/npm-cli-login": "^0.0.11",

4
packages/0x.js/package.json
View File

@@ -27,7 +27,7 @@
"clean": "shx rm -rf _bundles lib test_temp src/generated_contract_wrappers generated_docs",
"build:umd:prod": "NODE_ENV=production node --max_old_space_size=8192 ../../node_modules/.bin/webpack --mode production",
"build:commonjs": "tsc -b",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"postpublish": {
@@ -66,7 +66,7 @@
"sinon": "^4.0.0",
"source-map-support": "^0.5.0",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typedoc": "^0.15.0",
"typescript": "3.0.1",
"uglifyjs-webpack-plugin": "^2.0.1",
"webpack": "^4.20.2"

2
packages/abi-gen-wrappers/package.json
View File

@@ -19,7 +19,7 @@
"prettier_contract_wrappers": "prettier --write src/generated-wrappers/* --config ../../.prettierrc",
"clean": "shx rm -rf lib src/generated-wrappers",
"generate_contract_wrappers": "abi-gen --abis ${npm_package_config_abis} --output src/generated-wrappers --backend ethers",
"docs": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --out generated_docs ./src/generated-wrappers/*"
"docs": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --out generated_docs ./src/generated-wrappers/*"
},
"config": {
"abis": "../contract-artifacts/artifacts/@(AssetProxyOwner|DevUtils|DutchAuction|DummyERC20Token|DummyERC721Token|ERC20Proxy|ERC20Token|ERC721Proxy|ERC721Token|Exchange|Forwarder|IAssetProxy|IValidator|IWallet|MultiAssetProxy|OrderValidator|WETH9|ZRXToken|Coordinator|CoordinatorRegistry|EthBalanceChecker|ERC1155Proxy|StaticCallProxy).json"

1131
packages/asset-buyer/docs/reference.mdx Normal file
View File

File diff suppressed because it is too large Load Diff

8
packages/asset-buyer/package.json
View File

@@ -19,7 +19,10 @@
"test:circleci": "yarn test:coverage",
"run_mocha": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js --exit",
"clean": "shx rm -rf lib test_temp",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"postpublish": {
@@ -51,6 +54,7 @@
"lodash": "^4.17.11"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.17",
"@0x/tslint-config": "^3.0.1",
"@types/lodash": "4.14.104",
"@types/mocha": "^5.2.7",
@@ -65,7 +69,7 @@
"nyc": "^11.0.1",
"shx": "^0.2.2",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typedoc": "^0.15.0",
"typemoq": "^2.1.0",
"typescript": "3.0.1"
},

2872
packages/asset-swapper/docs/reference.mdx Normal file
View File

File diff suppressed because it is too large Load Diff

8
packages/asset-swapper/package.json
View File

@@ -19,7 +19,10 @@
"test:circleci": "yarn test:coverage",
"run_mocha": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js lib/test/global_hooks.js --timeout 10000 --bail --exit",
"clean": "shx rm -rf lib test_temp",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"postpublish": {
@@ -55,6 +58,7 @@
"lodash": "^4.17.11"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.17",
"@0x/tslint-config": "^3.0.1",
"@types/lodash": "4.14.104",
"@types/mocha": "^5.2.7",
@@ -69,7 +73,7 @@
"nyc": "^11.0.1",
"shx": "^0.2.2",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typedoc": "^0.15.0",
"typemoq": "^2.1.0",
"typescript": "3.0.1"
},

553
packages/connect/docs/reference.mdx Normal file
View File

@@ -0,0 +1,553 @@
# Class: HttpClient
This class includes all the functionality related to interacting with a set of HTTP endpoints
that implement the standard relayer API v2
### Hierarchy
* **HttpClient**
### Implements
* [Client](#interface-client)
### Constructors
## constructer
\+ **new HttpClient**(`url`: string): *[HttpClient](#class-httpclient)*
*Defined in [http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L44)*
Instantiates a new HttpClient instance
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`url` | string | The relayer API base HTTP url you would like to interact with |
**Returns:** *[HttpClient](#class-httpclient)*
An instance of HttpClient
### Methods
## getAssetPairsAsync
▸ **getAssetPairsAsync**(`requestOpts?`: `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise<AssetPairsResponse>`*
*Defined in [http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L59)*
Retrieve assetData pair info from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts` | Options specifying assetData information to retrieve, page information, and network id. |
**Returns:** *`Promise<AssetPairsResponse>`*
The resulting AssetPairsResponse that match the request
___
## getFeeRecipientsAsync
▸ **getFeeRecipientsAsync**(`requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<FeeRecipientsResponse>`*
*Defined in [http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L160)*
Retrieve the list of fee recipient addresses used by the relayer.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `RequestOpts` & `PagedRequestOpts` | Options specifying page information, and network id. |
**Returns:** *`Promise<FeeRecipientsResponse>`*
The resulting FeeRecipientsResponse
___
## getOrderAsync
▸ **getOrderAsync**(`orderHash`: string, `requestOpts?`: `RequestOpts`): *`Promise<APIOrder>`*
*Defined in [http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L99)*
Retrieve a specific order from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderHash` | string | An orderHash generated from the desired order |
`requestOpts?` | `RequestOpts` | - |
**Returns:** *`Promise<APIOrder>`*
The APIOrder that matches the supplied orderHash
___
## getOrderConfigAsync
▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`, `requestOpts?`: `RequestOpts`): *`Promise<OrderConfigResponse>`*
*Defined in [http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L139)*
Retrieve fee information from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`request` | `OrderConfigRequest` | A OrderConfigRequest instance describing the specific fees to retrieve |
`requestOpts?` | `RequestOpts` | Options specifying network id. |
**Returns:** *`Promise<OrderConfigResponse>`*
The resulting OrderConfigResponse that matches the request
___
## getOrderbookAsync
▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<OrderbookResponse>`*
*Defined in [http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L117)*
Retrieve an orderbook from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`request` | `OrderbookRequest` | An OrderbookRequest instance describing the specific orderbook to retrieve |
`requestOpts?` | `RequestOpts` & `PagedRequestOpts` | Options specifying page information, and network id. |
**Returns:** *`Promise<OrderbookResponse>`*
The resulting OrderbookResponse that matches the request
___
## getOrdersAsync
▸ **getOrdersAsync**(`requestOpts?`: `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise<OrdersResponse>`*
*Defined in [http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L79)*
Retrieve orders from the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`requestOpts?` | `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts` | Options specifying orders to retrieve and page information, page information, and network id. |
**Returns:** *`Promise<OrdersResponse>`*
The resulting OrdersResponse that match the request
___
## submitOrderAsync
▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`, `requestOpts?`: `RequestOpts`): *`Promise<void>`*
*Defined in [http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L177)*
Submit a signed order to the API
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`signedOrder` | `SignedOrder` | A SignedOrder instance to submit |
`requestOpts?` | `RequestOpts` | Options specifying network id. |
**Returns:** *`Promise<void>`*
<hr />
# Class: WebSocketOrdersChannel
This class includes all the functionality related to interacting with a websocket endpoint
that implements the standard relayer API v0
### Hierarchy
* **WebSocketOrdersChannel**
### Implements
* [OrdersChannel](#interface-orderschannel)
### Constructors
## constructer
\+ **new WebSocketOrdersChannel**(`client`: `w3cwebsocket`, `handler`: [OrdersChannelHandler](#interface-orderschannelhandler)): *[WebSocketOrdersChannel](#class-websocketorderschannel)*
*Defined in [ws_orders_channel.ts:21](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/ws_orders_channel.ts#L21)*
Instantiates a new WebSocketOrdersChannel instance
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`client` | `w3cwebsocket` | A WebSocket client |
`handler` | [OrdersChannelHandler](#interface-orderschannelhandler) | An OrdersChannelHandler instance that responds to various channel updates |
**Returns:** *[WebSocketOrdersChannel](#class-websocketorderschannel)*
An instance of WebSocketOrdersChannel
### Methods
## close
▸ **close**(): *void*
*Defined in [ws_orders_channel.ts:66](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/ws_orders_channel.ts#L66)*
Close the websocket and stop receiving updates
**Returns:** *void*
___
## subscribe
▸ **subscribe**(`subscriptionOpts`: `OrdersChannelSubscriptionOpts`): *void*
*Defined in [ws_orders_channel.ts:50](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/ws_orders_channel.ts#L50)*
Subscribe to orderbook snapshots and updates from the websocket
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`subscriptionOpts` | `OrdersChannelSubscriptionOpts` | An OrdersChannelSubscriptionOpts instance describing which assetData pair to subscribe to |
**Returns:** *void*
<hr />
# Enumeration: HttpRequestType
### Enumeration members
## Get
• **Get**: = "GET"
*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L46)*
___
## Post
• **Post**: = "POST"
*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L47)*
<hr />
# Interface: Client
### Hierarchy
* **Client**
### Implemented by
* [HttpClient](#class-httpclient)
### Properties
## getAssetPairsAsync
• **getAssetPairsAsync**: *function*
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L18)*
#### Type declaration:
▸ (`requestOpts?`: `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise<PaginatedCollection<AssetPairsItem>>`*
**Parameters:**
Name | Type |
------ | ------ |
`requestOpts?` | `AssetPairsRequestOpts` & `PagedRequestOpts` |
___
## getFeeRecipientsAsync
• **getFeeRecipientsAsync**: *function*
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L25)*
#### Type declaration:
▸ (`requestOpts?`: `PagedRequestOpts`): *`Promise<FeeRecipientsResponse>`*
**Parameters:**
Name | Type |
------ | ------ |
`requestOpts?` | `PagedRequestOpts` |
___
## getOrderAsync
• **getOrderAsync**: *function*
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L22)*
#### Type declaration:
▸ (`orderHash`: string): *`Promise<APIOrder>`*
**Parameters:**
Name | Type |
------ | ------ |
`orderHash` | string |
___
## getOrderConfigAsync
• **getOrderConfigAsync**: *function*
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L24)*
#### Type declaration:
▸ (`request`: `OrderConfigRequest`): *`Promise<OrderConfigResponse>`*
**Parameters:**
Name | Type |
------ | ------ |
`request` | `OrderConfigRequest` |
___
## getOrderbookAsync
• **getOrderbookAsync**: *function*
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L23)*
#### Type declaration:
▸ (`request`: `OrderbookRequest`, `requestOpts?`: `PagedRequestOpts`): *`Promise<OrderbookResponse>`*
**Parameters:**
Name | Type |
------ | ------ |
`request` | `OrderbookRequest` |
`requestOpts?` | `PagedRequestOpts` |
___
## getOrdersAsync
• **getOrdersAsync**: *function*
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L21)*
#### Type declaration:
▸ (`requestOpts?`: `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise<PaginatedCollection<APIOrder>>`*
**Parameters:**
Name | Type |
------ | ------ |
`requestOpts?` | `OrdersRequestOpts` & `PagedRequestOpts` |
___
## submitOrderAsync
• **submitOrderAsync**: *function*
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L26)*
#### Type declaration:
▸ (`signedOrder`: `SignedOrder`): *`Promise<void>`*
**Parameters:**
Name | Type |
------ | ------ |
`signedOrder` | `SignedOrder` |
<hr />
# Interface: HttpRequestOptions
### Hierarchy
* **HttpRequestOptions**
### Properties
## `Optional` params
• **params**? : *undefined | object*
*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L41)*
___
## `Optional` payload
• **payload**? : *undefined | object*
*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L42)*
<hr />
# Interface: OrdersChannel
### Hierarchy
* **OrdersChannel**
### Implemented by
* [WebSocketOrdersChannel](#class-websocketorderschannel)
### Properties
## close
• **close**: *function*
*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L31)*
#### Type declaration:
▸ (): *void*
___
## subscribe
• **subscribe**: *function*
*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L30)*
#### Type declaration:
▸ (`subscriptionOpts`: `OrdersChannelSubscriptionOpts`): *void*
**Parameters:**
Name | Type |
------ | ------ |
`subscriptionOpts` | `OrdersChannelSubscriptionOpts` |
<hr />
# Interface: OrdersChannelHandler
### Hierarchy
* **OrdersChannelHandler**
### Properties
## onClose
• **onClose**: *function*
*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L37)*
#### Type declaration:
▸ (`channel`: [OrdersChannel](#interface-orderschannel)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`channel` | [OrdersChannel](#interface-orderschannel) |
___
## onError
• **onError**: *function*
*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L36)*
#### Type declaration:
▸ (`channel`: [OrdersChannel](#interface-orderschannel), `err`: `Error`, `subscriptionOpts?`: `OrdersChannelSubscriptionOpts`): *void*
**Parameters:**
Name | Type |
------ | ------ |
`channel` | [OrdersChannel](#interface-orderschannel) |
`err` | `Error` |
`subscriptionOpts?` | `OrdersChannelSubscriptionOpts` |
___
## onUpdate
• **onUpdate**: *function*
*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L35)*
#### Type declaration:
▸ (`channel`: [OrdersChannel](#interface-orderschannel), `subscriptionOpts`: `OrdersChannelSubscriptionOpts`, `orders`: `APIOrder`[]): *void*
**Parameters:**
Name | Type |
------ | ------ |
`channel` | [OrdersChannel](#interface-orderschannel) |
`subscriptionOpts` | `OrdersChannelSubscriptionOpts` |
`orders` | `APIOrder`[] |
<hr />
# Interface: OrdersChannelSubscriptionOptsMap
### Hierarchy
* **OrdersChannelSubscriptionOptsMap**
### Indexable
● \[▪ **key**: *string*\]: `OrdersChannelSubscriptionOpts`
<hr />

8
packages/connect/package.json
View File

@@ -27,7 +27,10 @@
"test:coverage": "nyc npm run test --all && yarn coverage:report:lcov",
"coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info",
"test:circleci": "yarn test:coverage",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"postpublish": {
@@ -58,6 +61,7 @@
"websocket": "^1.0.26"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.17",
"@0x/tslint-config": "^3.0.1",
"@types/fetch-mock": "^6.0.3",
"@types/lodash": "4.14.104",
@@ -78,7 +82,7 @@
"nyc": "^11.0.1",
"shx": "^0.2.2",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typedoc": "^0.15.0",
"typescript": "3.0.1"
},
"publishConfig": {

1837
packages/contract-wrappers/docs/reference.mdx Normal file
View File

File diff suppressed because it is too large Load Diff

11
packages/contract-wrappers/package.json
View File

@@ -28,7 +28,10 @@
"coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info",
"prettier": "prettier --write **/* --config ../../.prettierrc",
"clean": "shx rm -rf lib",
"docs_test": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --out generated_docs ./src/generated-wrappers/*"
"docs_test": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --out generated_docs ./src/generated-wrappers/*",
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json"
},
"config": {
"abis": "../contract-artifacts/artifacts/@(AssetProxyOwner|DevUtils|DutchAuction|DummyERC20Token|DummyERC721Token|ERC20Proxy|ERC20Token|ERC721Proxy|ERC721Token|Exchange|Forwarder|IAssetProxy|IValidator|IWallet|MultiAssetProxy|OrderValidator|WETH9|ZRXToken|Coordinator|CoordinatorRegistry|EthBalanceChecker).json"
@@ -44,6 +47,7 @@
"homepage": "https://github.com/0xProject/0x-monorepo/packages/contract-wrappers/README.md",
"devDependencies": {
"@0x/assert": "^2.1.4",
"@0x/ts-doc-gen": "^0.0.17",
"@0x/contracts-test-utils": "^3.1.14",
"@0x/coordinator-server": "^0.1.3",
"@0x/json-schemas": "^4.0.0",
@@ -61,7 +65,10 @@
"lodash": "^4.17.11",
"mocha": "^6.2.0",
"nock": "^10.0.6",
"shx": "^0.2.2"
"shx": "^0.2.2",
"tslint": "5.11.0",
"typedoc": "^0.15.0",
"typescript": "3.0.1"
},
"dependencies": {
"@0x/abi-gen-wrappers": "^5.2.0",

4613
packages/ethereum-types/docs/reference.mdx Normal file
View File

File diff suppressed because it is too large Load Diff

7
packages/ethereum-types/package.json
View File

@@ -13,7 +13,10 @@
"clean": "shx rm -rf lib generated_docs",
"lint": "tslint --format stylish --project .",
"fix": "tslint --fix --format stylish --project .",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"postpublish": {
@@ -30,10 +33,12 @@
},
"homepage": "https://github.com/0xProject/0x-monorepo/packages/ethereum-types/README.md",
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.17",
"@0x/tslint-config": "^3.0.1",
"make-promises-safe": "^1.1.0",
"shx": "^0.2.2",
"tslint": "5.11.0",
"typedoc": "^0.15.0",
"typescript": "3.0.1"
},
"dependencies": {

1
packages/instant/package.json
View File

@@ -101,7 +101,6 @@
"svg-react-loader": "^0.4.6",
"ts-jest": "^23.10.3",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typescript": "3.0.1",
"webpack": "^4.20.2",
"webpack-cli": "3.1.2",

7
packages/instant/typedoc-tsconfig.json
View File

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

85
packages/json-schemas/docs/reference.mdx Normal file
View File

@@ -0,0 +1,85 @@
# Class: SchemaValidator
A validator for [JSON-schemas](http://json-schema.org/)
### Hierarchy
* **SchemaValidator**
### Constructors
## constructer
\+ **new SchemaValidator**(): *[SchemaValidator](#class-schemavalidator)*
*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/json-schemas/src/schema_validator.ts#L15)*
Instantiates a SchemaValidator instance
**Returns:** *[SchemaValidator](#class-schemavalidator)*
### Methods
## addSchema
▸ **addSchema**(`schema`: `Schema`): *void*
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/json-schemas/src/schema_validator.ts#L32)*
Add a schema to the validator. All schemas and sub-schemas must be added to
the validator before the `validate` and `isValid` methods can be called with
instances of that schema.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`schema` | `Schema` | The schema to add |
**Returns:** *void*
___
## isValid
▸ **isValid**(`instance`: any, `schema`: `Schema`): *boolean*
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/json-schemas/src/schema_validator.ts#L57)*
Check whether an instance properly adheres to a JSON schema
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`instance` | any | JS object in question |
`schema` | `Schema` | Schema to check against |
**Returns:** *boolean*
Whether or not the instance adheres to the schema
___
## validate
▸ **validate**(`instance`: any, `schema`: `Schema`): *`ValidatorResult`*
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/json-schemas/src/schema_validator.ts#L46)*
Validate the JS object conforms to a specific JSON schema
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`instance` | any | JS object in question |
`schema` | `Schema` | Schema to check against |
**Returns:** *`ValidatorResult`*
The results of the validation
<hr />

8
packages/json-schemas/package.json
View File

@@ -19,7 +19,10 @@
"test:circleci": "yarn test:coverage",
"run_mocha": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js --exit",
"clean": "shx rm -rf lib test_temp generated_docs",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"postpublish": {
@@ -46,6 +49,7 @@
"lodash.values": "^4.3.0"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.17",
"@0x/tslint-config": "^3.0.1",
"@0x/utils": "^4.5.0",
"@types/lodash.foreach": "^4.5.3",
@@ -60,7 +64,7 @@
"nyc": "^11.0.1",
"shx": "^0.2.2",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typedoc": "^0.15.0",
"typescript": "3.0.1"
},
"publishConfig": {

175
packages/migrations/docs/reference.mdx Normal file
View File

@@ -0,0 +1,175 @@
# Enumeration: ContractName
### Enumeration members
## AccountLevels
• **AccountLevels**: = "AccountLevels"
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L26)*
___
## Arbitrage
• **Arbitrage**: = "Arbitrage"
*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L28)*
___
## DummyToken
• **DummyToken**: = "DummyToken"
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L23)*
___
## EtherDelta
• **EtherDelta**: = "EtherDelta"
*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L27)*
___
## Exchange
• **Exchange**: = "Exchange"
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L21)*
___
## MultiSigWalletWithTimeLock
• **MultiSigWalletWithTimeLock**: = "MultiSigWalletWithTimeLock"
*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L20)*
___
## MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress
• **MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress**: = "MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress"
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L25)*
___
## TokenRegistry
• **TokenRegistry**: = "TokenRegistry"
*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L19)*
___
## TokenTransferProxy
• **TokenTransferProxy**: = "TokenTransferProxy"
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L18)*
___
## WETH9
• **WETH9**: = "WETH9"
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L24)*
___
## ZRXToken
• **ZRXToken**: = "ZRXToken"
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L22)*
<hr />
# Interface: ERC20Token
### Hierarchy
* **ERC20Token**
### Properties
## `Optional` address
• **address**? : *undefined | string*
*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L4)*
___
## decimals
• **decimals**: *`BigNumber`*
*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L7)*
___
## ipfsHash
• **ipfsHash**: *string*
*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L8)*
___
## name
• **name**: *string*
*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L5)*
___
## swarmHash
• **swarmHash**: *string*
*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L9)*
___
## symbol
• **symbol**: *string*
*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L6)*
<hr />
# Interface: ERC721Token
### Hierarchy
* **ERC721Token**
### Properties
## name
• **name**: *string*
*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L13)*
___
## symbol
• **symbol**: *string*
*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L14)*
<hr />

8
packages/migrations/package.json
View File

@@ -17,7 +17,10 @@
"migrate:v2:snapshot": "run-s build script:migrate:v2:snapshot",
"script:migrate:v2": "node ./lib/migrate.js",
"script:migrate:v2:snapshot": "node ./lib/migrate_snapshot.js",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES",
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES",
"build:snapshot": "rm -rf ${npm_package_config_snapshot_name} && yarn migrate:v2:snapshot && zip -r \"${npm_package_config_snapshot_name}-${npm_package_version}.zip\" ${npm_package_config_snapshot_name}",
"build:snapshot:docker": "docker build --tag ${npm_package_config_docker_snapshot_name}:${npm_package_version} --tag ${npm_package_config_docker_snapshot_name}:latest .",
"publish:snapshot": "aws s3 cp ${npm_package_config_snapshot_name}-${npm_package_version}.zip ${npm_package_config_s3_snapshot_bucket} && aws s3 cp ${npm_package_config_s3_snapshot_bucket}/${npm_package_config_snapshot_name}-${npm_package_version}.zip ${npm_package_config_s3_snapshot_bucket}/${npm_package_config_snapshot_name}-latest.zip",
@@ -38,6 +41,7 @@
"license": "Apache-2.0",
"devDependencies": {
"@0x/dev-utils": "^2.3.1",
"@0x/ts-doc-gen": "^0.0.17",
"@0x/tslint-config": "^3.0.1",
"@0x/types": "^2.4.1",
"@types/yargs": "^11.0.0",
@@ -45,7 +49,7 @@
"npm-run-all": "^4.1.2",
"shx": "^0.2.2",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typedoc": "^0.15.0",
"typescript": "3.0.1",
"web3-provider-engine": "14.0.6",
"yargs": "^10.0.3"

2
packages/monorepo-scripts/package.json
View File

@@ -68,7 +68,7 @@
"semver": "5.5.0",
"semver-diff": "^2.1.0",
"semver-sort": "0.0.4",
"typedoc": "0.13.0",
"typedoc": "^0.15.0",
"yargs": "^10.0.3"
},
"publishConfig": {

17
packages/monorepo-scripts/src/publish.ts
View File

@@ -71,9 +71,12 @@ async function confirmAsync(message: string): Promise<void> {
}
});
// Push changelog changes to Github
// Generate markdown docs for packages
await execAsync(`yarn generate_md_docs`, { cwd: constants.monorepoRootPath });
// Push changelogs changes and markdown docs to Github
if (!configs.IS_LOCAL_PUBLISH) {
await pushChangelogsToGithubAsync();
await pushChangelogsAndMDDocsToGithubAsync();
}
// Call LernaPublish
@@ -92,7 +95,11 @@ async function confirmAsync(message: string): Promise<void> {
const isStaging = false;
const shouldUploadDocs = true;
await generateAndUploadDocJsonsAsync(packagesWithDocs, isStaging, shouldUploadDocs);
// Upload markdown docs to S3 bucket
await execAsync(`yarn upload_md_docs`, { cwd: constants.monorepoRootPath });
}
const releaseNotes = await publishReleaseNotesAsync(updatedPublicPackages, isDryRun);
utils.log('Published release notes');
@@ -195,11 +202,11 @@ async function confirmDocPagesRenderAsync(packagesWithDocs: Package[]): Promise<
await confirmAsync('Do all the doc pages render? (y/n)');
}
async function pushChangelogsToGithubAsync(): Promise<void> {
async function pushChangelogsAndMDDocsToGithubAsync(): Promise<void> {
await execAsync(`git add . --all`, { cwd: constants.monorepoRootPath });
await execAsync(`git commit -m "Updated CHANGELOGS"`, { cwd: constants.monorepoRootPath });
await execAsync(`git commit -m "Updated CHANGELOGS & MD docs"`, { cwd: constants.monorepoRootPath });
await execAsync(`git push`, { cwd: constants.monorepoRootPath });
utils.log(`Pushed CHANGELOG updates to Github`);
utils.log(`Pushed CHANGELOG updates & updated MD docs to Github`);
}
async function updateChangeLogsAsync(updatedPublicPackages: Package[]): Promise<PackageToNextVersion> {

1431
packages/order-utils/docs/reference.mdx Normal file
View File

File diff suppressed because it is too large Load Diff

8
packages/order-utils/package.json
View File

@@ -19,7 +19,10 @@
"clean": "shx rm -rf lib generated_docs",
"lint": "tslint --format stylish --project .",
"fix": "tslint --fix --format stylish --project .",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"postpublish": {
@@ -37,6 +40,7 @@
"homepage": "https://github.com/0xProject/0x-monorepo/packages/order-utils/README.md",
"devDependencies": {
"@0x/dev-utils": "^2.3.1",
"@0x/ts-doc-gen": "^0.0.17",
"@0x/tslint-config": "^3.0.1",
"@types/bn.js": "^4.11.0",
"@types/lodash": "4.14.104",
@@ -52,7 +56,7 @@
"shx": "^0.2.2",
"sinon": "^4.0.0",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typedoc": "^0.15.0",
"typescript": "3.0.1",
"web3-provider-engine": "14.0.6"
},

1109
packages/order-watcher/docs/reference.mdx Normal file
View File

File diff suppressed because it is too large Load Diff

296
packages/sol-compiler/docs/reference.mdx Normal file
View File

@@ -0,0 +1,296 @@
# Class: Compiler
The Compiler facilitates compiling Solidity smart contracts and saves the results
to artifact files.
### Hierarchy
* **Compiler**
### Constructors
## constructer
\+ **new Compiler**(`opts?`: `CompilerOptions`): *[Compiler](#class-compiler)*
*Defined in [compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/compiler.ts#L94)*
Instantiates a new instance of the Compiler class.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`opts?` | `CompilerOptions` | Optional compiler options |
**Returns:** *[Compiler](#class-compiler)*
An instance of the Compiler class.
### Methods
## compileAsync
▸ **compileAsync**(): *`Promise<void>`*
*Defined in [compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/compiler.ts#L132)*
Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`.
**Returns:** *`Promise<void>`*
___
## getCompilerOutputsAsync
▸ **getCompilerOutputsAsync**(): *`Promise<StandardOutput[]>`*
*Defined in [compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/compiler.ts#L145)*
Compiles Solidity files specified during instantiation, and returns the
compiler output given by solc. Return value is an array of outputs:
Solidity modules are batched together by version required, and each
element of the returned array corresponds to a compiler version, and
each element contains the output for all of the modules compiled with
that version.
**Returns:** *`Promise<StandardOutput[]>`*
___
## watchAsync
▸ **watchAsync**(): *`Promise<void>`*
*Defined in [compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/compiler.ts#L149)*
**Returns:** *`Promise<void>`*
<hr />
# Class: CompilationError
### Hierarchy
* `Error`
* **CompilationError**
### Constructors
## constructer
\+ **new CompilationError**(`errorsCount`: number): *[CompilationError](#class-compilationerror)*
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L39)*
**Parameters:**
Name | Type |
------ | ------ |
`errorsCount` | number |
**Returns:** *[CompilationError](#class-compilationerror)*
### Properties
## errorsCount
• **errorsCount**: *number*
*Defined in [utils/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L38)*
___
## message
• **message**: *string*
___
## name
• **name**: *string*
___
## `Optional` stack
• **stack**? : *undefined | string*
*Overrides void*
___
## typeName
• **typeName**: *string* = "CompilationError"
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L39)*
___
## `Static` Error
▪ **Error**: *`ErrorConstructor`*
<hr />
# Enumeration: AbiType
### Enumeration members
## Constructor
• **Constructor**: = "constructor"
*Defined in [utils/types.ts:3](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L3)*
___
## Event
• **Event**: = "event"
*Defined in [utils/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L4)*
___
## Fallback
• **Fallback**: = "fallback"
*Defined in [utils/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L5)*
___
## Function
• **Function**: = "function"
*Defined in [utils/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L2)*
<hr />
# Interface: BinaryPaths
### Hierarchy
* **BinaryPaths**
### Hierarchy
* **ContractSourceData**
### Hierarchy
* **ContractSpecificSourceData**
### Properties
## solcVersionRange
• **solcVersionRange**: *string*
*Defined in [utils/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L21)*
___
## sourceHash
• **sourceHash**: *`Buffer`*
*Defined in [utils/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L22)*
___
## sourceTreeHash
• **sourceTreeHash**: *`Buffer`*
*Defined in [utils/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L23)*
<hr />
# Interface: SolcErrors
### Hierarchy
* **SolcErrors**
### Hierarchy
* **Token**
### Properties
## `Optional` address
• **address**? : *undefined | string*
*Defined in [utils/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L27)*
___
## decimals
• **decimals**: *number*
*Defined in [utils/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L30)*
___
## ipfsHash
• **ipfsHash**: *string*
*Defined in [utils/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L31)*
___
## name
• **name**: *string*
*Defined in [utils/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L28)*
___
## swarmHash
• **swarmHash**: *string*
*Defined in [utils/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L32)*
___
## symbol
• **symbol**: *string*
*Defined in [utils/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L29)*
<hr />

8
packages/sol-compiler/package.json
View File

@@ -22,7 +22,10 @@
"lint": "tslint --format stylish --project .",
"fix": "tslint --fix --format stylish --project .",
"test:circleci": "yarn test:coverage",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"postpublish": {
@@ -44,6 +47,7 @@
"homepage": "https://github.com/0xProject/0x-monorepo/packages/sol-compiler/README.md",
"devDependencies": {
"@0x/dev-utils": "^2.3.1",
"@0x/ts-doc-gen": "^0.0.17",
"@0x/tslint-config": "^3.0.1",
"@types/mkdirp": "^0.5.2",
"@types/mocha": "^5.2.7",
@@ -62,7 +66,7 @@
"nyc": "^11.0.1",
"shx": "^0.2.2",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typedoc": "^0.15.0",
"types-bn": "^0.0.1",
"typescript": "3.0.1",
"web3-provider-engine": "14.0.6",

179
packages/sol-coverage/docs/reference.mdx Normal file
View File

@@ -0,0 +1,179 @@
# Class: CoverageSubprovider
This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface.
It's used to compute your code coverage while running solidity tests.
### Hierarchy
* `TraceInfoSubprovider`
* **CoverageSubprovider**
### Constructors
## constructer
\+ **new CoverageSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `partialConfig`: [CoverageSubproviderPartialConfig](../modules/_coverage_subprovider_.md#coveragesubproviderpartialconfig)): *[CoverageSubprovider](#class-coveragesubprovider)*
*Overrides void*
*Defined in [coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-coverage/src/coverage_subprovider.ts#L44)*
Instantiates a CoverageSubprovider instance
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`artifactAdapter` | `AbstractArtifactAdapter` | - | Adapter for used artifacts format (0x, truffle, giveth, etc.) |
`defaultFromAddress` | string | - | default from address to use when sending transactions |
`partialConfig` | [CoverageSubproviderPartialConfig](#coveragesubproviderpartialconfig) | {} | Partial configuration object |
**Returns:** *[CoverageSubprovider](#class-coveragesubprovider)*
### Methods
## emitPayloadAsync
▸ **emitPayloadAsync**(`payload`: `Partial<JSONRPCRequestPayloadWithMethod>`): *`Promise<JSONRPCResponsePayload>`*
Emits a JSON RPC payload that will then be handled by the ProviderEngine instance
this subprovider is a part of. The payload will cascade down the subprovider middleware
stack until finding the responsible entity for handling the request.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`payload` | `Partial<JSONRPCRequestPayloadWithMethod>` | JSON RPC payload |
**Returns:** *`Promise<JSONRPCResponsePayload>`*
JSON RPC response payload
___
## handleRequest
▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise<void>`*
*Overrides void*
This method conforms to the web3-provider-engine interface.
It is called internally by the ProviderEngine when it is this subproviders
turn to handle a JSON RPC request.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`payload` | `JSONRPCRequestPayload` | JSON RPC payload |
`next` | `NextCallback` | Callback to call if this subprovider decides not to handle the request |
`_end` | `ErrorCallback` | Callback to call if subprovider handled the request and wants to pass back the request. |
**Returns:** *`Promise<void>`*
___
## setEngine
▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void*
*Overrides void*
Set's the subprovider's engine to the ProviderEngine it is added to.
This is only called within the ProviderEngine source code, do not call
directly.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to |
**Returns:** *void*
___
## start
▸ **start**(): *void*
Starts trace collection
**Returns:** *void*
___
## stop
▸ **stop**(): *void*
Stops trace collection
**Returns:** *void*
___
## writeCoverageAsync
▸ **writeCoverageAsync**(): *`Promise<void>`*
*Defined in [coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-coverage/src/coverage_subprovider.ts#L78)*
Write the test coverage results to a file in Istanbul format.
**Returns:** *`Promise<void>`*
<hr />
# Interface: CoverageSubproviderConfig
This type defines the schema of the config object that could be passed to CoverageSubprovider
isVerbose: If true - will log any unknown transactions. Defaults to true.
ignoreFilesGlobs: The list of globs matching the file names of the files we want to ignore coverage for. Defaults to [].
### Hierarchy
* **CoverageSubproviderConfig**
### Properties
## ignoreFilesGlobs
• **ignoreFilesGlobs**: *string[]*
*Defined in [coverage_subprovider.ts:28](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-coverage/src/coverage_subprovider.ts#L28)*
___
## isVerbose
• **isVerbose**: *boolean*
*Defined in [coverage_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-coverage/src/coverage_subprovider.ts#L27)*
<hr />

8
packages/sol-coverage/package.json
View File

@@ -13,7 +13,10 @@
"lint": "tslint --format stylish --project .",
"fix": "tslint --fix --format stylish --project .",
"clean": "shx rm -rf lib src/artifacts generated_docs",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"postpublish": {
@@ -40,6 +43,7 @@
"web3-provider-engine": "14.0.6"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.17",
"@0x/tslint-config": "^3.0.1",
"@types/node": "*",
"@types/web3-provider-engine": "^14.0.0",
@@ -48,7 +52,7 @@
"shx": "^0.2.2",
"sinon": "^4.0.0",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typedoc": "^0.15.0",
"typescript": "3.0.1"
},
"publishConfig": {

150
packages/sol-profiler/docs/reference.mdx Normal file
View File

@@ -0,0 +1,150 @@
# Class: ProfilerSubprovider
This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface.
ProfilerSubprovider is used to profile Solidity code while running tests.
### Hierarchy
* `TraceInfoSubprovider`
* **ProfilerSubprovider**
### Constructors
## constructer
\+ **new ProfilerSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `isVerbose`: boolean): *[ProfilerSubprovider](#class-profilersubprovider)*
*Overrides void*
*Defined in [profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-profiler/src/profiler_subprovider.ts#L30)*
Instantiates a ProfilerSubprovider instance
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`artifactAdapter` | `AbstractArtifactAdapter` | - | Adapter for used artifacts format (0x, truffle, giveth, etc.) |
`defaultFromAddress` | string | - | default from address to use when sending transactions |
`isVerbose` | boolean | true | If true, we will log any unknown transactions. Otherwise we will ignore them |
**Returns:** *[ProfilerSubprovider](#class-profilersubprovider)*
### Methods
## emitPayloadAsync
▸ **emitPayloadAsync**(`payload`: `Partial<JSONRPCRequestPayloadWithMethod>`): *`Promise<JSONRPCResponsePayload>`*
Emits a JSON RPC payload that will then be handled by the ProviderEngine instance
this subprovider is a part of. The payload will cascade down the subprovider middleware
stack until finding the responsible entity for handling the request.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`payload` | `Partial<JSONRPCRequestPayloadWithMethod>` | JSON RPC payload |
**Returns:** *`Promise<JSONRPCResponsePayload>`*
JSON RPC response payload
___
## handleRequest
▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise<void>`*
*Overrides void*
This method conforms to the web3-provider-engine interface.
It is called internally by the ProviderEngine when it is this subproviders
turn to handle a JSON RPC request.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`payload` | `JSONRPCRequestPayload` | JSON RPC payload |
`next` | `NextCallback` | Callback to call if this subprovider decides not to handle the request |
`_end` | `ErrorCallback` | Callback to call if subprovider handled the request and wants to pass back the request. |
**Returns:** *`Promise<void>`*
___
## setEngine
▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void*
*Overrides void*
Set's the subprovider's engine to the ProviderEngine it is added to.
This is only called within the ProviderEngine source code, do not call
directly.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to |
**Returns:** *void*
___
## start
▸ **start**(): *void*
Starts trace collection
**Returns:** *void*
___
## stop
▸ **stop**(): *void*
Stops trace collection
**Returns:** *void*
___
## writeProfilerOutputAsync
▸ **writeProfilerOutputAsync**(): *`Promise<void>`*
*Defined in [profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-profiler/src/profiler_subprovider.ts#L104)*
Write the test profiler results to a file in Istanbul format.
**Returns:** *`Promise<void>`*
<hr />

8
packages/sol-profiler/package.json
View File

@@ -13,7 +13,10 @@
"lint": "tslint --format stylish --project .",
"fix": "tslint --fix --format stylish --project .",
"clean": "shx rm -rf lib src/artifacts generated_docs",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"postpublish": {
@@ -40,13 +43,14 @@
"web3-provider-engine": "14.0.6"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.17",
"@0x/tslint-config": "^3.0.1",
"@types/node": "*",
"@types/web3-provider-engine": "^14.0.0",
"npm-run-all": "^4.1.2",
"shx": "^0.2.2",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typedoc": "^0.15.0",
"typescript": "3.0.1"
},
"publishConfig": {

138
packages/sol-trace/docs/reference.mdx Normal file
View File

@@ -0,0 +1,138 @@
# Class: RevertTraceSubprovider
This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface.
It is used to report call stack traces whenever a revert occurs.
### Hierarchy
* `TraceCollectionSubprovider`
* **RevertTraceSubprovider**
### Constructors
## constructer
\+ **new RevertTraceSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `isVerbose`: boolean): *[RevertTraceSubprovider](#class-reverttracesubprovider)*
*Overrides void*
*Defined in [revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-trace/src/revert_trace_subprovider.ts#L27)*
Instantiates a RevertTraceSubprovider instance
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`artifactAdapter` | `AbstractArtifactAdapter` | - | Adapter for used artifacts format (0x, truffle, giveth, etc.) |
`defaultFromAddress` | string | - | default from address to use when sending transactions |
`isVerbose` | boolean | true | If true, we will log any unknown transactions. Otherwise we will ignore them |
**Returns:** *[RevertTraceSubprovider](#class-reverttracesubprovider)*
### Methods
## emitPayloadAsync
▸ **emitPayloadAsync**(`payload`: `Partial<JSONRPCRequestPayloadWithMethod>`): *`Promise<JSONRPCResponsePayload>`*
Emits a JSON RPC payload that will then be handled by the ProviderEngine instance
this subprovider is a part of. The payload will cascade down the subprovider middleware
stack until finding the responsible entity for handling the request.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`payload` | `Partial<JSONRPCRequestPayloadWithMethod>` | JSON RPC payload |
**Returns:** *`Promise<JSONRPCResponsePayload>`*
JSON RPC response payload
___
## handleRequest
▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise<void>`*
*Overrides void*
This method conforms to the web3-provider-engine interface.
It is called internally by the ProviderEngine when it is this subproviders
turn to handle a JSON RPC request.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`payload` | `JSONRPCRequestPayload` | JSON RPC payload |
`next` | `NextCallback` | Callback to call if this subprovider decides not to handle the request |
`_end` | `ErrorCallback` | Callback to call if subprovider handled the request and wants to pass back the request. |
**Returns:** *`Promise<void>`*
___
## setEngine
▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void*
*Overrides void*
Set's the subprovider's engine to the ProviderEngine it is added to.
This is only called within the ProviderEngine source code, do not call
directly.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to |
**Returns:** *void*
___
## start
▸ **start**(): *void*
Starts trace collection
**Returns:** *void*
___
## stop
▸ **stop**(): *void*
Stops trace collection
**Returns:** *void*
<hr />

7
packages/sol-trace/package.json
View File

@@ -13,7 +13,10 @@
"lint": "tslint --format stylish --project .",
"fix": "tslint --fix --format stylish --project .",
"clean": "shx rm -rf lib src/artifacts generated_docs",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"postpublish": {
@@ -41,6 +44,7 @@
"web3-provider-engine": "14.0.6"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.17",
"@0x/tslint-config": "^3.0.1",
"@types/loglevel": "^1.5.3",
"@types/node": "*",
@@ -48,6 +52,7 @@
"npm-run-all": "^4.1.2",
"shx": "^0.2.2",
"tslint": "5.11.0",
"typedoc": "^0.15.0",
"typescript": "3.0.1"
},
"publishConfig": {

10
packages/sol-tracing-utils/package.json
View File

@@ -21,16 +21,11 @@
"run_mocha": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js --exit",
"clean": "shx rm -rf lib test/fixtures/artifacts src/artifacts generated_docs",
"copy_test_fixtures": "copyfiles 'test/fixtures/**/*' ./lib",
"compile_test": "sol-compiler compile",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"compile_test": "sol-compiler compile"
},
"config": {
"postpublish": {
"assets": [],
"docOmitExports": [
"ProfilerSubprovider",
"RevertTraceSubprovider"
]
"assets": []
}
},
"repository": {
@@ -83,7 +78,6 @@
"shx": "^0.2.2",
"sinon": "^4.0.0",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typescript": "3.0.1"
},
"publishConfig": {

2809
packages/subproviders/docs/reference.mdx Normal file
View File

File diff suppressed because it is too large Load Diff

8
packages/subproviders/package.json
View File

@@ -22,7 +22,10 @@
"test:all": "run-s test:unit test:integration",
"test:unit": "run-s clean build run_mocha_unit",
"test:integration": "run-s clean build run_mocha_integration",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"postpublish": {
@@ -52,6 +55,7 @@
"web3-provider-engine": "14.0.6"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.17",
"@0x/tslint-config": "^3.0.1",
"@types/bip39": "^2.4.0",
"@types/bn.js": "^4.11.0",
@@ -71,7 +75,7 @@
"shx": "^0.2.2",
"sinon": "^4.0.0",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typedoc": "^0.15.0",
"typescript": "3.0.1",
"webpack": "^4.20.2"
},

1790
packages/web3-wrapper/docs/reference.mdx Normal file
View File

File diff suppressed because it is too large Load Diff

8
packages/web3-wrapper/package.json
View File

@@ -20,7 +20,10 @@
"run_mocha": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js --bail --exit",
"test:coverage": "nyc npm run test --all && yarn coverage:report:lcov",
"coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
"diff_docs": "git diff --exit-code ./docs",
"s3:sync_md_docs": "aws s3 sync ./docs s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers",
"docs:md": "ts-doc-gen --sourceDir=./src --output=./docs --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"postpublish": {
@@ -37,6 +40,7 @@
},
"homepage": "https://github.com/0xProject/0x-monorepo/packages/web3-wrapper/README.md",
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.17",
"@0x/tslint-config": "^3.0.1",
"@types/lodash": "4.14.104",
"@types/mocha": "^5.2.7",
@@ -51,7 +55,7 @@
"nyc": "^11.0.1",
"shx": "^0.2.2",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typedoc": "^0.15.0",
"typescript": "3.0.1"
},
"dependencies": {

196
yarn.lock
View File

@@ -649,13 +649,6 @@
dependencies:
"@0x/base-contract" "^4.0.3"
"@0x/abi-gen-wrappers@^5.3.0":
version "5.2.0"
dependencies:
"@0x/base-contract" "^5.3.1"
"@0x/contract-addresses" "^3.0.3"
"@0x/contract-artifacts" "^2.0.4"
"@0x/asset-buyer@6.1.8":
version "6.1.8"
resolved "https://registry.yarnpkg.com/@0x/asset-buyer/-/asset-buyer-6.1.8.tgz#71f6abb366e89e62457c256644edb37e12113e94"
@@ -762,6 +755,16 @@
typeorm "0.2.7"
websocket "^1.0.25"
"@0x/json-schemas@^3.0.1", "@0x/json-schemas@^3.0.11", "@0x/json-schemas@^3.0.2", "@0x/json-schemas@^3.0.3", "@0x/json-schemas@^3.1.11":
version "3.1.13"
resolved "https://registry.yarnpkg.com/@0x/json-schemas/-/json-schemas-3.1.13.tgz#4b9010f1bdeaf2aef1daba1753aa2e5ecf57f654"
integrity sha512-V93sF6seHDHFCSLZOOEhgY5k+w+78tLmxJRhj8XvsW4+EnXcgpshxK38P6SQAmBoNLDutmM8Wk1inf6ghiW0qA==
dependencies:
"@0x/typescript-typings" "^4.2.4"
"@types/node" "*"
jsonschema "^1.2.0"
lodash.values "^4.3.0"
"@0x/order-utils@^5.0.0":
version "5.0.0"
resolved "https://registry.yarnpkg.com/@0x/order-utils/-/order-utils-5.0.0.tgz#7f43e0310ace31738895881501c8dda9c3a3aefa"
@@ -813,6 +816,20 @@
optionalDependencies:
"@ledgerhq/hw-transport-node-hid" "^4.3.0"
"@0x/ts-doc-gen@^0.0.17":
version "0.0.17"
resolved "https://registry.yarnpkg.com/@0x/ts-doc-gen/-/ts-doc-gen-0.0.17.tgz#2c3c8e96aad4476e3a13608d3f1b516b87e17665"
integrity sha512-0+ErnVixm804BkYHt7sYe10rc8w9Nf4qO2Ecp9ljzNliEVgwMV7zBSOFFk1CUSbTPYXqDSLuP79y7CxlWXmxdA==
dependencies:
"@0x/typescript-typings" "^4.2.2"
"@0x/utils" "^4.3.3"
glob "^7.1.4"
promisify-child-process "^3.1.1"
rimraf "^2.6.3"
typedoc "^0.15.0"
typedoc-plugin-markdown "^2.1.0"
yargs "^10.0.3"
"@0x/web3-wrapper@^4.0.1":
version "4.0.2"
resolved "https://registry.npmjs.org/@0x/web3-wrapper/-/web3-wrapper-4.0.2.tgz#d4e0a4fa1217155e1aed4cd91086654fd99f2959"
@@ -884,7 +901,7 @@
dependencies:
regenerator-runtime "^0.12.0"
"@babel/runtime@^7.4.5":
"@babel/runtime@^7.1.5", "@babel/runtime@^7.4.5":
version "7.5.5"
resolved "https://registry.npmjs.org/@babel/runtime/-/runtime-7.5.5.tgz#74fba56d35efbeca444091c7850ccd494fd2f132"
dependencies:
@@ -1769,12 +1786,6 @@
version "2.0.0"
resolved "https://registry.yarnpkg.com/@types/find-versions/-/find-versions-2.0.0.tgz#a976ca032ab8dd1161116604eded0620d2b85df2"
"@types/fs-extra@^5.0.3":
version "5.0.4"
resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-5.0.4.tgz#b971134d162cc0497d221adde3dbb67502225599"
dependencies:
"@types/node" "*"
"@types/glob@*", "@types/glob@5.0.35":
version "5.0.35"
resolved "https://registry.yarnpkg.com/@types/glob/-/glob-5.0.35.tgz#1ae151c802cece940443b5ac246925c85189f32a"
@@ -1791,10 +1802,6 @@
"@types/minimatch" "*"
"@types/node" "*"
"@types/handlebars@^4.0.38":
version "4.0.39"
resolved "https://registry.yarnpkg.com/@types/handlebars/-/handlebars-4.0.39.tgz#961fb54db68030890942e6aeffe9f93a957807bd"
"@types/hdkey@^0.7.0":
version "0.7.0"
resolved "https://registry.yarnpkg.com/@types/hdkey/-/hdkey-0.7.0.tgz#6734d138e3c597f241be8fae2e60c2949bc3af87"
@@ -1851,18 +1858,10 @@
version "4.14.104"
resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.104.tgz#53ee2357fa2e6e68379341d92eb2ecea4b11bb80"
"@types/lodash@^4.14.110":
version "4.14.116"
resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.116.tgz#5ccf215653e3e8c786a58390751033a9adca0eb9"
"@types/loglevel@^1.5.3":
version "1.5.3"
resolved "https://registry.yarnpkg.com/@types/loglevel/-/loglevel-1.5.3.tgz#adfce55383edc5998a2170ad581b3e23d6adb5b8"
"@types/marked@^0.4.0":
version "0.4.0"
resolved "https://registry.yarnpkg.com/@types/marked/-/marked-0.4.0.tgz#057a6165703e7419217f8ffc6887747f980b6315"
"@types/material-ui@^0.20.0":
version "0.20.8"
resolved "https://registry.npmjs.org/@types/material-ui/-/material-ui-0.20.8.tgz#76e46f9accc48944f532c3b1038a2b46214454fa"
@@ -2102,13 +2101,6 @@
"@types/express-serve-static-core" "*"
"@types/mime" "*"
"@types/shelljs@^0.8.0":
version "0.8.0"
resolved "https://registry.yarnpkg.com/@types/shelljs/-/shelljs-0.8.0.tgz#0caa56b68baae4f68f44e0dd666ab30b098e3632"
dependencies:
"@types/glob" "*"
"@types/node" "*"
"@types/sinon@^2.2.2":
version "2.3.7"
resolved "https://registry.yarnpkg.com/@types/sinon/-/sinon-2.3.7.tgz#e92c2fed3297eae078d78d1da032b26788b4af86"
@@ -3681,6 +3673,13 @@ bach@^1.0.0:
async-settle "^1.0.0"
now-and-later "^2.0.0"
backbone@^1.4.0:
version "1.4.0"
resolved "https://registry.yarnpkg.com/backbone/-/backbone-1.4.0.tgz#54db4de9df7c3811c3f032f34749a4cd27f3bd12"
integrity sha512-RLmDrRXkVdouTg38jcgHhyQ/2zjg7a8E6sz2zxfz21Hh17xDJYUHBZimVIt5fUyS8vbfpeSmTL3gUjTEvUV3qQ==
dependencies:
underscore ">=1.8.3"
backoff@^2.5.0:
version "2.5.0"
resolved "https://registry.yarnpkg.com/backoff/-/backoff-2.5.0.tgz#f616eda9d3e4b66b8ca7fca79f695722c5f8e26f"
@@ -8837,10 +8836,27 @@ got@^6.7.1:
unzip-response "^2.0.1"
url-parse-lax "^1.0.0"
graceful-fs@4.1.15, graceful-fs@^3.0.0, graceful-fs@^4.0.0, graceful-fs@^4.1.10, graceful-fs@^4.1.11, graceful-fs@^4.1.15, graceful-fs@^4.1.2, graceful-fs@^4.1.6, graceful-fs@^4.1.9, graceful-fs@^4.2.0, graceful-fs@~1.2.0:
graceful-fs@^3.0.0:
version "3.0.11"
resolved "http://registry.yarnpkg.com/graceful-fs/-/graceful-fs-3.0.11.tgz#7613c778a1afea62f25c630a086d7f3acbbdd818"
integrity sha1-dhPHeKGv6mLyXGMKCG1/Osu92Bg=
dependencies:
natives "^1.1.0"
graceful-fs@^4.0.0, graceful-fs@^4.1.10, graceful-fs@^4.1.11, graceful-fs@^4.1.15, graceful-fs@^4.1.2, graceful-fs@^4.1.6, graceful-fs@^4.1.9:
version "4.1.15"
resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.1.15.tgz#ffb703e1066e8a0eeaa4c8b80ba9253eeefbfb00"
graceful-fs@^4.2.0:
version "4.2.1"
resolved "http://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.1.tgz#1c1f0c364882c868f5bff6512146328336a11b1d"
integrity sha512-b9usnbDGnD928gJB3LrCmxoibr3VE4U2SMo5PBuBnokWyDADTqDPXg4YpwKF1trpH+UbGp7QLicO3+aWEy0+mw==
graceful-fs@~1.2.0:
version "1.2.3"
resolved "http://registry.yarnpkg.com/graceful-fs/-/graceful-fs-1.2.3.tgz#15a4806a57547cb2d2dbf27f42e89a8c3451b364"
integrity sha1-FaSAaldUfLLS2/J/QuiajDRRs2Q=
"graceful-readlink@>= 1.0.0":
version "1.0.1"
resolved "https://registry.yarnpkg.com/graceful-readlink/-/graceful-readlink-1.0.1.tgz#4cafad76bc62f02fa039b2f94e9a3dd3a391a725"
@@ -8954,7 +8970,7 @@ handle-thing@^1.2.5:
version "1.2.5"
resolved "https://registry.yarnpkg.com/handle-thing/-/handle-thing-1.2.5.tgz#fd7aad726bf1a5fd16dfc29b2f7a6601d27139c4"
handlebars@^4.0.1, handlebars@^4.0.11, handlebars@^4.0.2, handlebars@^4.0.3, handlebars@^4.0.6, handlebars@^4.1.0, handlebars@^4.1.2:
handlebars@^4.0.1, handlebars@^4.0.11, handlebars@^4.0.2, handlebars@^4.0.3, handlebars@^4.1.0, handlebars@^4.1.2:
version "4.1.2"
resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.1.2.tgz#b6b37c1ced0306b221e094fc7aca3ec23b131b67"
dependencies:
@@ -9155,7 +9171,7 @@ heap@0.2.6:
version "0.2.6"
resolved "https://registry.yarnpkg.com/heap/-/heap-0.2.6.tgz#087e1f10b046932fc8594dd9e6d378afc9d1e5ac"
highlight.js@^9.0.0, highlight.js@^9.11.0, highlight.js@~9.12.0:
highlight.js@^9.11.0, highlight.js@~9.12.0:
version "9.12.0"
resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-9.12.0.tgz#e6d9dbe57cbefe60751f02af336195870c90c01e"
@@ -9163,9 +9179,10 @@ highlight.js@^9.13.1:
version "9.13.1"
resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-9.13.1.tgz#054586d53a6863311168488a0f58d6c505ce641e"
highlight.js@^9.6.0:
highlight.js@^9.15.8, highlight.js@^9.6.0:
version "9.15.9"
resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-9.15.9.tgz#865257da1dbb4a58c4552d46c4b3854f77f0e6d5"
integrity sha512-M0zZvfLr5p0keDMCAhNBp03XJbKBxUx5AfyfufMdFMEP4N/Xj6dh0IqC75ys7BAzceR34NgcvXjupRVaHBPPVQ==
highlightjs-solidity@^1.0.5:
version "1.0.6"
@@ -10634,6 +10651,11 @@ jmespath@0.15.0:
version "0.15.0"
resolved "https://registry.npmjs.org/jmespath/-/jmespath-0.15.0.tgz#a3f222a9aae9f966f5d27c796510e28091764217"
jquery@^3.4.1:
version "3.4.1"
resolved "https://registry.yarnpkg.com/jquery/-/jquery-3.4.1.tgz#714f1f8d9dde4bdfa55764ba37ef214630d80ef2"
integrity sha512-36+AdBzCL+y6qjw5Tx7HgzeGCzC81MDDgaUP8ld2zhx58HdqXGoBd+tHdrBMiyjGQs0Hxs/MLZTu/eHNJJuWPw==
js-base64@^2.1.8:
version "2.5.1"
resolved "https://registry.npmjs.org/js-base64/-/js-base64-2.5.1.tgz#1efa39ef2c5f7980bb1784ade4a8af2de3291121"
@@ -11744,6 +11766,11 @@ lunr@^2.3.0:
version "2.3.1"
resolved "https://registry.npmjs.org/lunr/-/lunr-2.3.1.tgz#113616a2b602ddc10932a7bf8a4e6e57ebfecdf2"
lunr@^2.3.6:
version "2.3.6"
resolved "https://registry.yarnpkg.com/lunr/-/lunr-2.3.6.tgz#f278beee7ffd56ad86e6e478ce02ab2b98c78dd5"
integrity sha512-swStvEyDqQ85MGpABCMBclZcLI/pBIlu8FFDtmX197+oEgKloJ67QnB+Tidh0340HmLMs39c4GrkPY3cmkXp6Q==
macaddress@^0.2.8:
version "0.2.8"
resolved "https://registry.yarnpkg.com/macaddress/-/macaddress-0.2.8.tgz#5904dc537c39ec6dbefeae902327135fa8511f12"
@@ -11861,9 +11888,10 @@ marked@0.3.18:
version "0.3.18"
resolved "https://registry.npmjs.org/marked/-/marked-0.3.18.tgz#3ef058cd926101849b92a7a7c15db18c7fc76b2f"
marked@^0.4.0:
version "0.4.0"
resolved "https://registry.yarnpkg.com/marked/-/marked-0.4.0.tgz#9ad2c2a7a1791f10a852e0112f77b571dce10c66"
marked@^0.7.0:
version "0.7.0"
resolved "https://registry.yarnpkg.com/marked/-/marked-0.7.0.tgz#b64201f051d271b1edc10a04d1ae9b74bb8e5c0e"
integrity sha512-c+yYdCZJQrsRjTPhUx7VKkApw9bwDkNbHUKo1ovgcfDjb2kc8rLuRbIFyXL5WOEUwzSSKo3IXpph2K6DqB/KZg==
matchdep@^2.0.0:
version "2.0.0"
@@ -12472,6 +12500,11 @@ nanomatch@^1.2.9:
snapdragon "^0.8.1"
to-regex "^3.0.1"
natives@^1.1.0:
version "1.1.6"
resolved "http://registry.yarnpkg.com/natives/-/natives-1.1.6.tgz#a603b4a498ab77173612b9ea1acdec4d980f00bb"
integrity sha512-6+TDFewD4yxY14ptjKaS63GVdtKiES1pTPyxn9Jb0rBqPMZ7VcCiooEhPNsr+mqHtMGxa/5c/HhcC4uPEUw/nA==
natural-compare@^1.4.0:
version "1.4.0"
resolved "https://registry.yarnpkg.com/natural-compare/-/natural-compare-1.4.0.tgz#4abebfeed7541f2c27acfb29bdbbd15c8d5ba4f7"
@@ -14292,6 +14325,11 @@ progress@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.0.tgz#8a1be366bf8fc23db2bd23f10c6fe920b4389d1f"
progress@^2.0.3:
version "2.0.3"
resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.3.tgz#7e8cf8d8f5b8f239c1bc68beb4eb78567d572ef8"
integrity sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==
promise-inflight@^1.0.1:
version "1.0.1"
resolved "https://registry.yarnpkg.com/promise-inflight/-/promise-inflight-1.0.1.tgz#98472870bf228132fcbdd868129bad12c3c029e3"
@@ -14320,6 +14358,13 @@ promisify-child-process@^1.0.5:
version "1.0.5"
resolved "https://registry.yarnpkg.com/promisify-child-process/-/promisify-child-process-1.0.5.tgz#817ad1aec92c013d83bb37e1f143e9b4033d9669"
promisify-child-process@^3.1.1:
version "3.1.1"
resolved "https://registry.yarnpkg.com/promisify-child-process/-/promisify-child-process-3.1.1.tgz#3a029c1d97bdb8bbcc8862c765b91f1cee0f2691"
integrity sha512-683UHZEP4Bm75BvBujEe87AdE9lxnoWpcU5pEw4FG9HCSwwZC9pF7HUj3QmlDAvhyvulkWHLZs1lVRBNTvkbXQ==
dependencies:
"@babel/runtime" "^7.1.5"
prompt@0.2.14:
version "0.2.14"
resolved "https://registry.yarnpkg.com/prompt/-/prompt-0.2.14.tgz#57754f64f543fd7b0845707c818ece618f05ffdc"
@@ -14874,8 +14919,6 @@ react-highlight@0xproject/react-highlight#react-peer-deps:
dependencies:
highlight.js "^9.11.0"
highlightjs-solidity "^1.0.5"
react "^16.5.2"
react-dom "^16.5.2"
react-hot-loader@^4.3.3:
version "4.3.4"
@@ -16363,9 +16406,10 @@ shelljs@^0.7.3:
interpret "^1.0.0"
rechoir "^0.6.2"
shelljs@^0.8.2:
version "0.8.2"
resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.8.2.tgz#345b7df7763f4c2340d584abb532c5f752ca9e35"
shelljs@^0.8.3:
version "0.8.3"
resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.8.3.tgz#a7f3319520ebf09ee81275b2368adb286659b097"
integrity sha512-fc0BKlAWiLpwZljmOvAOTE/gXawtCoNrP5oaY7KIaQbbyHeQVg01pSEuEGvGh3HEdBU4baCD7wQBwADmM/7f7A==
dependencies:
glob "^7.0.0"
interpret "^1.0.0"
@@ -17914,31 +17958,37 @@ typedarray@^0.0.6:
version "0.0.6"
resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"
typedoc-default-themes@^0.5.0:
version "0.5.0"
resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.5.0.tgz#6dc2433e78ed8bea8e887a3acde2f31785bd6227"
typedoc@0.13.0:
version "0.13.0"
resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.13.0.tgz#9efdf352bd54873955cd161bd4b75f24a8c59dde"
typedoc-default-themes@^0.6.0:
version "0.6.0"
resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.6.0.tgz#7e73bf54dd9e11550dd0fb576d5176b758f8f8b5"
integrity sha512-MdTROOojxod78CEv22rIA69o7crMPLnVZPefuDLt/WepXqJwgiSu8Xxq+H36x0Jj3YGc7lOglI2vPJ2GhoOybw==
dependencies:
backbone "^1.4.0"
jquery "^3.4.1"
lunr "^2.3.6"
underscore "^1.9.1"
typedoc-plugin-markdown@^2.1.0:
version "2.1.0"
resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-2.1.0.tgz#17b7b97415b97214985d1a61ef7b9a4dce3e8305"
integrity sha512-f7CgreapeUIpm85BnC4ec9PZp10INOpLpItSCV4YFlZS4VaBA/a1D2nYv9+7TVJugc084XlSFUY+OX9fwGAUpA==
typedoc@^0.15.0:
version "0.15.0"
resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.15.0.tgz#21eaf4db41cf2797bad027a74f2a75cd08ae0c2d"
integrity sha512-NOtfq5Tis4EFt+J2ozhVq9RCeUnfEYMFKoU6nCXCXUULJz1UQynOM+yH3TkfZCPLzigbqB0tQYGVlktUWweKlw==
dependencies:
"@types/fs-extra" "^5.0.3"
"@types/handlebars" "^4.0.38"
"@types/highlight.js" "^9.12.3"
"@types/lodash" "^4.14.110"
"@types/marked" "^0.4.0"
"@types/minimatch" "3.0.3"
"@types/shelljs" "^0.8.0"
fs-extra "^7.0.0"
handlebars "^4.0.6"
highlight.js "^9.0.0"
lodash "^4.17.10"
marked "^0.4.0"
fs-extra "^8.1.0"
handlebars "^4.1.2"
highlight.js "^9.15.8"
lodash "^4.17.15"
marked "^0.7.0"
minimatch "^3.0.0"
progress "^2.0.0"
shelljs "^0.8.2"
typedoc-default-themes "^0.5.0"
typescript "3.1.x"
progress "^2.0.3"
shelljs "^0.8.3"
typedoc-default-themes "^0.6.0"
typescript "3.5.x"
typemoq@^2.1.0:
version "2.1.0"
@@ -17976,9 +18026,10 @@ typescript@3.0.1:
version "3.0.1"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.0.1.tgz#43738f29585d3a87575520a4b93ab6026ef11fdb"
typescript@3.1.x:
version "3.1.3"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.1.3.tgz#01b70247a6d3c2467f70c45795ef5ea18ce191d5"
typescript@3.5.x:
version "3.5.3"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.5.3.tgz#c830f657f93f1ea846819e929092f5fe5983e977"
integrity sha512-ACzBtm/PhXBDId6a6sDJfroT2pOWt/oOnk4/dElG5G33ZL776N3Y6/6bKZJBFpd+b05F3Ct9qDjMeJmRWtE2/g==
typewise-core@^1.2, typewise-core@^1.2.0:
version "1.2.0"
@@ -18086,6 +18137,11 @@ underscore@1.8.3:
version "1.8.3"
resolved "https://registry.yarnpkg.com/underscore/-/underscore-1.8.3.tgz#4f3fb53b106e6097fcf9cb4109f2a5e9bdfa5022"
underscore@>=1.8.3, underscore@^1.9.1:
version "1.9.1"
resolved "https://registry.yarnpkg.com/underscore/-/underscore-1.9.1.tgz#06dce34a0e68a7babc29b365b8e74b8925203961"
integrity sha512-5/4etnCkd9c8gwgowi5/om/mYO5ajCaOgdzj/oW+0eQV9WxKBDZw5+ycmKmeaTXjInS/W0BzpGLo2xR2aBwZdg==
underscore@~1.4.4:
version "1.4.4"
resolved "https://registry.npmjs.org/underscore/-/underscore-1.4.4.tgz#61a6a32010622afa07963bf325203cf12239d604"