Skip to content
This repository has been archived by the owner on Jul 9, 2021. It is now read-only.

Use TypeDoc Markdown docs for @0x/web3-wrapper #2005

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,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 contract-wrappers order-utils order-watcher sol-compiler sol-coverage sol-profiler sol-trace ethereum-types asset-buyer migrations",
"packagesWithDocPages": "0x.js connect json-schemas subproviders contract-wrappers order-utils order-watcher 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"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/asset-buyer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,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"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/asset-swapper/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,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"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/connect/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,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": {
Expand Down
2 changes: 1 addition & 1 deletion packages/contract-wrappers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
"web3-provider-engine": "14.0.6"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/instant/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@
"svg-react-loader": "^0.4.6",
"ts-jest": "^23.10.3",
"tslint": "5.11.0",
"typedoc": "0.13.0",
"typedoc": "0.15.0",
"typescript": "3.0.1",
"webpack": "^4.20.2",
"webpack-cli": "3.1.2",
Expand Down
2 changes: 1 addition & 1 deletion packages/json-schemas/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,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": {
Expand Down
2 changes: 1 addition & 1 deletion packages/migrations/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,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"
Expand Down
2 changes: 1 addition & 1 deletion packages/monorepo-scripts/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion packages/order-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,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",
"web3-provider-engine": "14.0.6"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/sol-compiler/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,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",
Expand Down
2 changes: 1 addition & 1 deletion packages/sol-coverage/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,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": {
Expand Down
2 changes: 1 addition & 1 deletion packages/sol-profiler/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,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"
},
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion packages/sol-tracing-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,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": {
Expand Down
2 changes: 1 addition & 1 deletion packages/subproviders/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,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"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/web3-wrapper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Web3-wrapper is a JSON-RPC client for Ethereum nodes. It is a type-safe alternative to [Web3.js](https://github.com/ethereum/web3.js/) written in TypeScript.

### Read the [Documentation](https://0xproject.com/docs/web3-wrapper).
### Read the [Documentation](./docs/classes/_src_web3_wrapper_.web3wrapper.md).

## Installation

Expand Down
75 changes: 75 additions & 0 deletions packages/web3-wrapper/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
> **[Web3Wrapper](README.md)**

[Globals](globals.md) /

## @0x/web3-wrapper

Web3-wrapper is a JSON-RPC client for Ethereum nodes. It is a type-safe alternative to [Web3.js](https://github.com/ethereum/web3.js/) written in TypeScript.

### Read the [Documentation](https://0xproject.com/docs/web3-wrapper).

## Installation

```bash
yarn add @0x/web3-wrapper
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

```bash
PKG=@0x/web3-wrapper yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0x/web3-wrapper yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
Loading