diff --git a/package.json b/package.json index 7398c8536f..f3121c559f 100644 --- a/package.json +++ b/package.json @@ -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" }, diff --git a/packages/asset-buyer/package.json b/packages/asset-buyer/package.json index 0749714e70..5843280024 100644 --- a/packages/asset-buyer/package.json +++ b/packages/asset-buyer/package.json @@ -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" }, diff --git a/packages/asset-swapper/package.json b/packages/asset-swapper/package.json index 3de01c2bde..17bfa48ece 100644 --- a/packages/asset-swapper/package.json +++ b/packages/asset-swapper/package.json @@ -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" }, diff --git a/packages/connect/package.json b/packages/connect/package.json index 0729de4b4e..76057cce43 100644 --- a/packages/connect/package.json +++ b/packages/connect/package.json @@ -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": { diff --git a/packages/contract-wrappers/package.json b/packages/contract-wrappers/package.json index 46bf4f27d9..24a7c27d73 100644 --- a/packages/contract-wrappers/package.json +++ b/packages/contract-wrappers/package.json @@ -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" }, diff --git a/packages/instant/package.json b/packages/instant/package.json index ea16a2ef1a..04ff669e18 100644 --- a/packages/instant/package.json +++ b/packages/instant/package.json @@ -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", diff --git a/packages/json-schemas/package.json b/packages/json-schemas/package.json index 69958707a4..6b12d4fd4e 100644 --- a/packages/json-schemas/package.json +++ b/packages/json-schemas/package.json @@ -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": { diff --git a/packages/migrations/package.json b/packages/migrations/package.json index b795b7f474..9dc914e81d 100644 --- a/packages/migrations/package.json +++ b/packages/migrations/package.json @@ -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" diff --git a/packages/monorepo-scripts/package.json b/packages/monorepo-scripts/package.json index 69fe1babe8..dd4debc3ae 100644 --- a/packages/monorepo-scripts/package.json +++ b/packages/monorepo-scripts/package.json @@ -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": { diff --git a/packages/order-utils/package.json b/packages/order-utils/package.json index 145a1366ad..6e4ab1aced 100644 --- a/packages/order-utils/package.json +++ b/packages/order-utils/package.json @@ -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" }, diff --git a/packages/sol-compiler/package.json b/packages/sol-compiler/package.json index 79037f9451..0c82c82aa8 100644 --- a/packages/sol-compiler/package.json +++ b/packages/sol-compiler/package.json @@ -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", diff --git a/packages/sol-coverage/package.json b/packages/sol-coverage/package.json index c3bf65275c..43fb0e7469 100644 --- a/packages/sol-coverage/package.json +++ b/packages/sol-coverage/package.json @@ -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": { diff --git a/packages/sol-profiler/package.json b/packages/sol-profiler/package.json index 45fa5421a7..873d8acc38 100644 --- a/packages/sol-profiler/package.json +++ b/packages/sol-profiler/package.json @@ -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": { diff --git a/packages/sol-tracing-utils/package.json b/packages/sol-tracing-utils/package.json index df8e98d8b8..6a4eb78bb2 100644 --- a/packages/sol-tracing-utils/package.json +++ b/packages/sol-tracing-utils/package.json @@ -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": { diff --git a/packages/subproviders/package.json b/packages/subproviders/package.json index 5d53521706..5c8f17bcf3 100644 --- a/packages/subproviders/package.json +++ b/packages/subproviders/package.json @@ -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" }, diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index 4402de19c9..a81d47ee47 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -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 diff --git a/packages/web3-wrapper/docs/README.md b/packages/web3-wrapper/docs/README.md new file mode 100644 index 0000000000..dc80c519e1 --- /dev/null +++ b/packages/web3-wrapper/docs/README.md @@ -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 +``` \ No newline at end of file diff --git a/packages/web3-wrapper/docs/classes/_src_web3_wrapper_.web3wrapper.md b/packages/web3-wrapper/docs/classes/_src_web3_wrapper_.web3wrapper.md new file mode 100644 index 0000000000..13ba18f995 --- /dev/null +++ b/packages/web3-wrapper/docs/classes/_src_web3_wrapper_.web3wrapper.md @@ -0,0 +1,793 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/web3_wrapper"](../modules/_src_web3_wrapper_.md) / [Web3Wrapper](_src_web3_wrapper_.web3wrapper.md) / + +# Class: Web3Wrapper + +An alternative to the Web3.js library that provides a consistent, clean, promise-based interface. + +## Hierarchy + +* **Web3Wrapper** + +## Index + +### Constructors + +* [constructor](_src_web3_wrapper_.web3wrapper.md#constructor) + +### Properties + +* [abiDecoder](_src_web3_wrapper_.web3wrapper.md#abidecoder) +* [isZeroExWeb3Wrapper](_src_web3_wrapper_.web3wrapper.md#iszeroexweb3wrapper) + +### Methods + +* [awaitTransactionMinedAsync](_src_web3_wrapper_.web3wrapper.md#awaittransactionminedasync) +* [awaitTransactionSuccessAsync](_src_web3_wrapper_.web3wrapper.md#awaittransactionsuccessasync) +* [callAsync](_src_web3_wrapper_.web3wrapper.md#callasync) +* [doesContractExistAtAddressAsync](_src_web3_wrapper_.web3wrapper.md#doescontractexistataddressasync) +* [estimateGasAsync](_src_web3_wrapper_.web3wrapper.md#estimategasasync) +* [getAvailableAddressesAsync](_src_web3_wrapper_.web3wrapper.md#getavailableaddressesasync) +* [getBalanceInWeiAsync](_src_web3_wrapper_.web3wrapper.md#getbalanceinweiasync) +* [getBlockIfExistsAsync](_src_web3_wrapper_.web3wrapper.md#getblockifexistsasync) +* [getBlockNumberAsync](_src_web3_wrapper_.web3wrapper.md#getblocknumberasync) +* [getBlockTimestampAsync](_src_web3_wrapper_.web3wrapper.md#getblocktimestampasync) +* [getBlockWithTransactionDataAsync](_src_web3_wrapper_.web3wrapper.md#getblockwithtransactiondataasync) +* [getContractCodeAsync](_src_web3_wrapper_.web3wrapper.md#getcontractcodeasync) +* [getContractDefaults](_src_web3_wrapper_.web3wrapper.md#getcontractdefaults) +* [getLogsAsync](_src_web3_wrapper_.web3wrapper.md#getlogsasync) +* [getNetworkIdAsync](_src_web3_wrapper_.web3wrapper.md#getnetworkidasync) +* [getNodeTypeAsync](_src_web3_wrapper_.web3wrapper.md#getnodetypeasync) +* [getNodeVersionAsync](_src_web3_wrapper_.web3wrapper.md#getnodeversionasync) +* [getProvider](_src_web3_wrapper_.web3wrapper.md#getprovider) +* [getTransactionByHashAsync](_src_web3_wrapper_.web3wrapper.md#gettransactionbyhashasync) +* [getTransactionReceiptIfExistsAsync](_src_web3_wrapper_.web3wrapper.md#gettransactionreceiptifexistsasync) +* [getTransactionTraceAsync](_src_web3_wrapper_.web3wrapper.md#gettransactiontraceasync) +* [increaseTimeAsync](_src_web3_wrapper_.web3wrapper.md#increasetimeasync) +* [isSenderAddressAvailableAsync](_src_web3_wrapper_.web3wrapper.md#issenderaddressavailableasync) +* [mineBlockAsync](_src_web3_wrapper_.web3wrapper.md#mineblockasync) +* [revertSnapshotAsync](_src_web3_wrapper_.web3wrapper.md#revertsnapshotasync) +* [sendRawPayloadAsync](_src_web3_wrapper_.web3wrapper.md#sendrawpayloadasync) +* [sendTransactionAsync](_src_web3_wrapper_.web3wrapper.md#sendtransactionasync) +* [setHeadAsync](_src_web3_wrapper_.web3wrapper.md#setheadasync) +* [setProvider](_src_web3_wrapper_.web3wrapper.md#setprovider) +* [signMessageAsync](_src_web3_wrapper_.web3wrapper.md#signmessageasync) +* [signTypedDataAsync](_src_web3_wrapper_.web3wrapper.md#signtypeddataasync) +* [takeSnapshotAsync](_src_web3_wrapper_.web3wrapper.md#takesnapshotasync) +* [isAddress](_src_web3_wrapper_.web3wrapper.md#static-isaddress) +* [toBaseUnitAmount](_src_web3_wrapper_.web3wrapper.md#static-tobaseunitamount) +* [toUnitAmount](_src_web3_wrapper_.web3wrapper.md#static-tounitamount) +* [toWei](_src_web3_wrapper_.web3wrapper.md#static-towei) + +## Constructors + +### constructor + +\+ **new Web3Wrapper**(`supportedProvider`: `SupportedProvider`, `callAndTxnDefaults`: `Partial`): *[Web3Wrapper](_src_web3_wrapper_.web3wrapper.md)* + +*Defined in [src/web3_wrapper.ts:145](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L145)* + +Instantiates a new Web3Wrapper. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`supportedProvider` | `SupportedProvider` | - | - | +`callAndTxnDefaults` | `Partial` | {} | Override Call and Txn Data defaults sent with RPC requests to the backing Ethereum node. | + +**Returns:** *[Web3Wrapper](_src_web3_wrapper_.web3wrapper.md)* + +An instance of the Web3Wrapper class. + +## Properties + +### abiDecoder + +• **abiDecoder**: *`AbiDecoder`* + +*Defined in [src/web3_wrapper.ts:54](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L54)* + +___ + +### isZeroExWeb3Wrapper + +• **isZeroExWeb3Wrapper**: *boolean* = true + +*Defined in [src/web3_wrapper.ts:53](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L53)* + +Flag to check if this instance is of type Web3Wrapper + +## Methods + +### awaitTransactionMinedAsync + +▸ **awaitTransactionMinedAsync**(`txHash`: string, `pollingIntervalMs`: number, `timeoutMs?`: undefined | number): *`Promise`* + +*Defined in [src/web3_wrapper.ts:568](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L568)* + +Waits for a transaction to be mined and returns the transaction receipt. +Note that just because a transaction was mined does not mean it was +successful. You need to check the status code of the transaction receipt +to find out if it was successful, or use the helper method +awaitTransactionSuccessAsync. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`txHash` | string | - | Transaction hash | +`pollingIntervalMs` | number | 1000 | How often (in ms) should we check if the transaction is mined. | +`timeoutMs?` | undefined \| number | - | How long (in ms) to poll for transaction mined until aborting. | + +**Returns:** *`Promise`* + +Transaction receipt with decoded log args. + +___ + +### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`txHash`: string, `pollingIntervalMs`: number, `timeoutMs?`: undefined | number): *`Promise`* + +*Defined in [src/web3_wrapper.ts:643](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L643)* + +Waits for a transaction to be mined and returns the transaction receipt. +Unlike awaitTransactionMinedAsync, it will throw if the receipt has a +status that is not equal to 1. A status of 0 or null indicates that the +transaction was mined, but failed. See: +https://github.com/ethereum/wiki/wiki/JavaScript-API#web3ethgettransactionreceipt + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`txHash` | string | - | Transaction hash | +`pollingIntervalMs` | number | 1000 | How often (in ms) should we check if the transaction is mined. | +`timeoutMs?` | undefined \| number | - | How long (in ms) to poll for transaction mined until aborting. | + +**Returns:** *`Promise`* + +Transaction receipt with decoded log args. + +___ + +### callAsync + +▸ **callAsync**(`callData`: `CallData`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [src/web3_wrapper.ts:525](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L525)* + +Call a smart contract method at a given block height + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | `CallData` | Call data | +`defaultBlock?` | `BlockParam` | Block height at which to make the call. Defaults to `latest` | + +**Returns:** *`Promise`* + +The raw call result + +___ + +### doesContractExistAtAddressAsync + +▸ **doesContractExistAtAddressAsync**(`address`: string): *`Promise`* + +*Defined in [src/web3_wrapper.ts:273](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L273)* + +Check if a contract exists at a given address + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`address` | string | Address to which to check | + +**Returns:** *`Promise`* + +Whether or not contract code was found at the supplied address + +___ + +### estimateGasAsync + +▸ **estimateGasAsync**(`txData`: `Partial`): *`Promise`* + +*Defined in [src/web3_wrapper.ts:508](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L508)* + +Calculate the estimated gas cost for a given transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txData` | `Partial` | Transaction data | + +**Returns:** *`Promise`* + +Estimated gas cost + +___ + +### getAvailableAddressesAsync + +▸ **getAvailableAddressesAsync**(): *`Promise`* + +*Defined in [src/web3_wrapper.ts:421](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L421)* + +Retrieve the user addresses available through the backing provider + +**Returns:** *`Promise`* + +Available user addresses + +___ + +### getBalanceInWeiAsync + +▸ **getBalanceInWeiAsync**(`owner`: string, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [src/web3_wrapper.ts:254](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L254)* + +Retrieves an accounts Ether balance in wei + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`owner` | string | Account whose balance you wish to check | +`defaultBlock?` | `BlockParam` | The block depth at which to fetch the balance (default=latest) | + +**Returns:** *`Promise`* + +Balance in wei + +___ + +### getBlockIfExistsAsync + +▸ **getBlockIfExistsAsync**(`blockParam`: string | `BlockParam`): *`Promise`* + +*Defined in [src/web3_wrapper.ts:361](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L361)* + +Fetch a specific Ethereum block without transaction data + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`blockParam` | string \| `BlockParam` | The block you wish to fetch (blockHash, blockNumber or blockLiteral) | + +**Returns:** *`Promise`* + +The requested block without transaction data, or undefined if block was not found +(e.g the node isn't fully synced, there was a block re-org and the requested block was uncles, etc...) + +___ + +### getBlockNumberAsync + +▸ **getBlockNumberAsync**(): *`Promise`* + +*Defined in [src/web3_wrapper.ts:347](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L347)* + +Fetches the latest block number + +**Returns:** *`Promise`* + +Block number + +___ + +### getBlockTimestampAsync + +▸ **getBlockTimestampAsync**(`blockParam`: string | `BlockParam`): *`Promise`* + +*Defined in [src/web3_wrapper.ts:409](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L409)* + +Fetch a block's timestamp + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`blockParam` | string \| `BlockParam` | The block you wish to fetch (blockHash, blockNumber or blockLiteral) | + +**Returns:** *`Promise`* + +The block's timestamp + +___ + +### getBlockWithTransactionDataAsync + +▸ **getBlockWithTransactionDataAsync**(`blockParam`: string | `BlockParam`): *`Promise`* + +*Defined in [src/web3_wrapper.ts:387](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L387)* + +Fetch a specific Ethereum block with transaction data + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`blockParam` | string \| `BlockParam` | The block you wish to fetch (blockHash, blockNumber or blockLiteral) | + +**Returns:** *`Promise`* + +The requested block with transaction data + +___ + +### getContractCodeAsync + +▸ **getContractCodeAsync**(`address`: string, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [src/web3_wrapper.ts:286](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L286)* + +Gets the contract code by address + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`address` | string | Address of the contract | +`defaultBlock?` | `BlockParam` | Block height at which to make the call. Defaults to `latest` | + +**Returns:** *`Promise`* + +Code of the contract + +___ + +### getContractDefaults + +▸ **getContractDefaults**(): *`Partial` | undefined* + +*Defined in [src/web3_wrapper.ts:164](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L164)* + +Get the contract defaults set to the Web3Wrapper instance + +**Returns:** *`Partial` | undefined* + +CallAndTxnData defaults (e.g gas, gasPrice, nonce, etc...) + +___ + +### getLogsAsync + +▸ **getLogsAsync**(`filter`: `FilterObject`): *`Promise`* + +*Defined in [src/web3_wrapper.ts:475](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L475)* + +Retrieve smart contract logs for a given filter + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`filter` | `FilterObject` | Parameters by which to filter which logs to retrieve | + +**Returns:** *`Promise`* + +The corresponding log entries + +___ + +### getNetworkIdAsync + +▸ **getNetworkIdAsync**(): *`Promise`* + +*Defined in [src/web3_wrapper.ts:207](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L207)* + +Fetches the networkId of the backing Ethereum node + +**Returns:** *`Promise`* + +The network id + +___ + +### getNodeTypeAsync + +▸ **getNodeTypeAsync**(): *`Promise`* + +*Defined in [src/web3_wrapper.ts:690](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L690)* + +Returns either NodeType.Geth or NodeType.Ganache depending on the type of +the backing Ethereum node. Throws for any other type of node. + +**Returns:** *`Promise`* + +___ + +### getNodeVersionAsync + +▸ **getNodeVersionAsync**(): *`Promise`* + +*Defined in [src/web3_wrapper.ts:199](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L199)* + +Fetch the backing Ethereum node's version string (e.g `MetaMask/v4.2.0`) + +**Returns:** *`Promise`* + +Ethereum node's version string + +___ + +### getProvider + +▸ **getProvider**(): *`SupportedProvider`* + +*Defined in [src/web3_wrapper.ts:171](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L171)* + +Retrieve the Web3 provider + +**Returns:** *`SupportedProvider`* + +Web3 provider instance + +___ + +### getTransactionByHashAsync + +▸ **getTransactionByHashAsync**(`txHash`: string): *`Promise`* + +*Defined in [src/web3_wrapper.ts:239](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L239)* + +Retrieves the transaction data for a given transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txHash` | string | Transaction hash | + +**Returns:** *`Promise`* + +The raw transaction data + +___ + +### getTransactionReceiptIfExistsAsync + +▸ **getTransactionReceiptIfExistsAsync**(`txHash`: string): *`Promise`* + +*Defined in [src/web3_wrapper.ts:217](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L217)* + +Retrieves the transaction receipt for a given transaction hash if found + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txHash` | string | Transaction hash | + +**Returns:** *`Promise`* + +The transaction receipt, including it's status (0: failed, 1: succeeded). Returns undefined if transaction not found. + +___ + +### getTransactionTraceAsync + +▸ **getTransactionTraceAsync**(`txHash`: string, `traceParams`: `TraceParams`): *`Promise`* + +*Defined in [src/web3_wrapper.ts:305](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L305)* + +Gets the debug trace of a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txHash` | string | Hash of the transactuon to get a trace for | +`traceParams` | `TraceParams` | Config object allowing you to specify if you need memory/storage/stack traces. | + +**Returns:** *`Promise`* + +Transaction trace + +___ + +### increaseTimeAsync + +▸ **increaseTimeAsync**(`timeDelta`: number): *`Promise`* + +*Defined in [src/web3_wrapper.ts:458](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L458)* + +Increase the next blocks timestamp on TestRPC/Ganache or Geth local node. +Will throw if provider is neither TestRPC/Ganache or Geth. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`timeDelta` | number | Amount of time to add in seconds | + +**Returns:** *`Promise`* + +___ + +### isSenderAddressAvailableAsync + +▸ **isSenderAddressAvailableAsync**(`senderAddress`: string): *`Promise`* + +*Defined in [src/web3_wrapper.ts:189](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L189)* + +Check whether an address is available through the backing provider. This can be +useful if you want to know whether a user can sign messages or transactions from +a given Ethereum address. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`senderAddress` | string | Address to check availability for | + +**Returns:** *`Promise`* + +Whether the address is available through the provider. + +___ + +### mineBlockAsync + +▸ **mineBlockAsync**(): *`Promise`* + +*Defined in [src/web3_wrapper.ts:450](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L450)* + +Mine a block on a TestRPC/Ganache local node + +**Returns:** *`Promise`* + +___ + +### revertSnapshotAsync + +▸ **revertSnapshotAsync**(`snapshotId`: number): *`Promise`* + +*Defined in [src/web3_wrapper.ts:442](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L442)* + +Revert the blockchain state to a previous snapshot state on TestRPC/Ganache local node + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`snapshotId` | number | snapshot id to revert to | + +**Returns:** *`Promise`* + +Whether the revert was successful + +___ + +### sendRawPayloadAsync + +▸ **sendRawPayloadAsync**<**A**>(`payload`: `Partial`): *`Promise`* + +*Defined in [src/web3_wrapper.ts:671](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L671)* + +Sends a raw Ethereum JSON RPC payload and returns the response's `result` key + +**Type parameters:** + +▪ **A** + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`payload` | `Partial` | A partial JSON RPC payload. No need to include version, id, params (if none needed) | + +**Returns:** *`Promise`* + +The contents nested under the result key of the response body + +___ + +### sendTransactionAsync + +▸ **sendTransactionAsync**(`txData`: `TxData`): *`Promise`* + +*Defined in [src/web3_wrapper.ts:547](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L547)* + +Send a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txData` | `TxData` | Transaction data | + +**Returns:** *`Promise`* + +Transaction hash + +___ + +### setHeadAsync + +▸ **setHeadAsync**(`blockNumber`: number): *`Promise`* + +*Defined in [src/web3_wrapper.ts:662](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L662)* + +Calls the 'debug_setHead' JSON RPC method, which sets the current head of +the local chain by block number. Note, this is a destructive action and +may severely damage your chain. Use with extreme caution. As of now, this +is only supported by Geth. It sill throw if the 'debug_setHead' method is +not supported. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`blockNumber` | number | The block number to reset to. | + +**Returns:** *`Promise`* + +___ + +### setProvider + +▸ **setProvider**(`supportedProvider`: `SupportedProvider`): *void* + +*Defined in [src/web3_wrapper.ts:178](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L178)* + +Update the used Web3 provider + +**Parameters:** + +Name | Type | +------ | ------ | +`supportedProvider` | `SupportedProvider` | + +**Returns:** *void* + +___ + +### signMessageAsync + +▸ **signMessageAsync**(`address`: string, `message`: string): *`Promise`* + +*Defined in [src/web3_wrapper.ts:319](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L319)* + +Sign a message with a specific address's private key (`eth_sign`) + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`address` | string | Address of signer | +`message` | string | Message to sign | + +**Returns:** *`Promise`* + +Signature string (might be VRS or RSV depending on the Signer) + +___ + +### signTypedDataAsync + +▸ **signTypedDataAsync**(`address`: string, `typedData`: any): *`Promise`* + +*Defined in [src/web3_wrapper.ts:334](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L334)* + +Sign an EIP712 typed data message with a specific address's private key (`eth_signTypedData`) + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`address` | string | Address of signer | +`typedData` | any | Typed data message to sign | + +**Returns:** *`Promise`* + +Signature string (as RSV) + +___ + +### takeSnapshotAsync + +▸ **takeSnapshotAsync**(): *`Promise`* + +*Defined in [src/web3_wrapper.ts:433](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L433)* + +Take a snapshot of the blockchain state on a TestRPC/Ganache local node + +**Returns:** *`Promise`* + +The snapshot id. This can be used to revert to this snapshot + +___ + +### `Static` isAddress + +▸ **isAddress**(`address`: string): *boolean* + +*Defined in [src/web3_wrapper.ts:65](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L65)* + +Check if an address is a valid Ethereum address + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`address` | string | Address to check | + +**Returns:** *boolean* + +Whether the address is a valid Ethereum address + +___ + +### `Static` toBaseUnitAmount + +▸ **toBaseUnitAmount**(`amount`: `BigNumber`, `decimals`: number): *`BigNumber`* + +*Defined in [src/web3_wrapper.ts:91](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L91)* + +A baseUnit is defined as the smallest denomination of a token. An amount expressed in baseUnits +is the amount expressed in the smallest denomination. +E.g: 1 unit of a token with 18 decimal places is expressed in baseUnits as 1000000000000000000 + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`amount` | `BigNumber` | The amount of units that you would like converted to baseUnits. | +`decimals` | number | The number of decimal places the unit amount has. | + +**Returns:** *`BigNumber`* + +The amount in baseUnits. + +___ + +### `Static` toUnitAmount + +▸ **toUnitAmount**(`amount`: `BigNumber`, `decimals`: number): *`BigNumber`* + +*Defined in [src/web3_wrapper.ts:76](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L76)* + +A unit amount is defined as the amount of a token above the specified decimal places (integer part). +E.g: If a currency has 18 decimal places, 1e18 or one quintillion of the currency is equivalent +to 1 unit. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`amount` | `BigNumber` | The amount in baseUnits that you would like converted to units. | +`decimals` | number | The number of decimal places the unit amount has. | + +**Returns:** *`BigNumber`* + +The amount in units. + +___ + +### `Static` toWei + +▸ **toWei**(`ethAmount`: `BigNumber`): *`BigNumber`* + +*Defined in [src/web3_wrapper.ts:107](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/web3_wrapper.ts#L107)* + +Convert an Ether amount from ETH to Wei + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ethAmount` | `BigNumber` | Amount of Ether to convert to wei | + +**Returns:** *`BigNumber`* + +Amount in wei \ No newline at end of file diff --git a/packages/web3-wrapper/docs/enums/_src_types_.nodetype.md b/packages/web3-wrapper/docs/enums/_src_types_.nodetype.md new file mode 100644 index 0000000000..948d37876f --- /dev/null +++ b/packages/web3-wrapper/docs/enums/_src_types_.nodetype.md @@ -0,0 +1,28 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/types"](../modules/_src_types_.md) / [NodeType](_src_types_.nodetype.md) / + +# Enumeration: NodeType + +## Index + +### Enumeration members + +* [Ganache](_src_types_.nodetype.md#ganache) +* [Geth](_src_types_.nodetype.md#geth) + +## Enumeration members + +### Ganache + +• **Ganache**: = "GANACHE" + +*Defined in [src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L91)* + +___ + +### Geth + +• **Geth**: = "GETH" + +*Defined in [src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L90)* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/enums/_src_types_.web3wrappererrors.md b/packages/web3-wrapper/docs/enums/_src_types_.web3wrappererrors.md new file mode 100644 index 0000000000..5437f9c7f6 --- /dev/null +++ b/packages/web3-wrapper/docs/enums/_src_types_.web3wrappererrors.md @@ -0,0 +1,19 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/types"](../modules/_src_types_.md) / [Web3WrapperErrors](_src_types_.web3wrappererrors.md) / + +# Enumeration: Web3WrapperErrors + +## Index + +### Enumeration members + +* [TransactionMiningTimeout](_src_types_.web3wrappererrors.md#transactionminingtimeout) + +## Enumeration members + +### TransactionMiningTimeout + +• **TransactionMiningTimeout**: = "TRANSACTION_MINING_TIMEOUT" + +*Defined in [src/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L2)* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/globals.md b/packages/web3-wrapper/docs/globals.md new file mode 100644 index 0000000000..68103d1c16 --- /dev/null +++ b/packages/web3-wrapper/docs/globals.md @@ -0,0 +1,17 @@ +> **[Web3Wrapper](README.md)** + +[Globals](globals.md) / + +# Web3Wrapper + +## Index + +### External modules + +* ["src/index"](modules/_src_index_.md) +* ["src/marshaller"](modules/_src_marshaller_.md) +* ["src/types"](modules/_src_types_.md) +* ["src/utils"](modules/_src_utils_.md) +* ["src/web3_wrapper"](modules/_src_web3_wrapper_.md) +* ["test/utils/chai_setup"](modules/_test_utils_chai_setup_.md) +* ["test/web3_wrapper_test"](modules/_test_web3_wrapper_test_.md) \ No newline at end of file diff --git a/packages/web3-wrapper/docs/interfaces/_src_types_.abstractblockrpc.md b/packages/web3-wrapper/docs/interfaces/_src_types_.abstractblockrpc.md new file mode 100644 index 0000000000..b63c59b77a --- /dev/null +++ b/packages/web3-wrapper/docs/interfaces/_src_types_.abstractblockrpc.md @@ -0,0 +1,171 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/types"](../modules/_src_types_.md) / [AbstractBlockRPC](_src_types_.abstractblockrpc.md) / + +# Interface: AbstractBlockRPC + +## Hierarchy + +* **AbstractBlockRPC** + + * [BlockWithoutTransactionDataRPC](_src_types_.blockwithouttransactiondatarpc.md) + + * [BlockWithTransactionDataRPC](_src_types_.blockwithtransactiondatarpc.md) + +## Index + +### Properties + +* [difficulty](_src_types_.abstractblockrpc.md#difficulty) +* [extraData](_src_types_.abstractblockrpc.md#extradata) +* [gasLimit](_src_types_.abstractblockrpc.md#gaslimit) +* [gasUsed](_src_types_.abstractblockrpc.md#gasused) +* [hash](_src_types_.abstractblockrpc.md#hash) +* [logsBloom](_src_types_.abstractblockrpc.md#logsbloom) +* [miner](_src_types_.abstractblockrpc.md#miner) +* [nonce](_src_types_.abstractblockrpc.md#nonce) +* [number](_src_types_.abstractblockrpc.md#number) +* [parentHash](_src_types_.abstractblockrpc.md#parenthash) +* [sha3Uncles](_src_types_.abstractblockrpc.md#sha3uncles) +* [size](_src_types_.abstractblockrpc.md#size) +* [stateRoot](_src_types_.abstractblockrpc.md#stateroot) +* [timestamp](_src_types_.abstractblockrpc.md#timestamp) +* [totalDifficulty](_src_types_.abstractblockrpc.md#totaldifficulty) +* [transactionsRoot](_src_types_.abstractblockrpc.md#transactionsroot) +* [uncles](_src_types_.abstractblockrpc.md#uncles) + +## Properties + +### difficulty + +• **difficulty**: *string* + +*Defined in [src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L15)* + +___ + +### extraData + +• **extraData**: *string* + +*Defined in [src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L17)* + +___ + +### gasLimit + +• **gasLimit**: *string* + +*Defined in [src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L19)* + +___ + +### gasUsed + +• **gasUsed**: *string* + +*Defined in [src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L20)* + +___ + +### hash + +• **hash**: *string | null* + +*Defined in [src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L7)* + +___ + +### logsBloom + +• **logsBloom**: *string | null* + +*Defined in [src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L11)* + +___ + +### miner + +• **miner**: *string* + +*Defined in [src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L14)* + +___ + +### nonce + +• **nonce**: *string | null* + +*Defined in [src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L9)* + +___ + +### number + +• **number**: *string | null* + +*Defined in [src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L6)* + +___ + +### parentHash + +• **parentHash**: *string* + +*Defined in [src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L8)* + +___ + +### sha3Uncles + +• **sha3Uncles**: *string* + +*Defined in [src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L10)* + +___ + +### size + +• **size**: *string* + +*Defined in [src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L18)* + +___ + +### stateRoot + +• **stateRoot**: *string* + +*Defined in [src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L13)* + +___ + +### timestamp + +• **timestamp**: *string* + +*Defined in [src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L21)* + +___ + +### totalDifficulty + +• **totalDifficulty**: *string* + +*Defined in [src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L16)* + +___ + +### transactionsRoot + +• **transactionsRoot**: *string* + +*Defined in [src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L12)* + +___ + +### uncles + +• **uncles**: *string[]* + +*Defined in [src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L22)* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/interfaces/_src_types_.blockwithouttransactiondatarpc.md b/packages/web3-wrapper/docs/interfaces/_src_types_.blockwithouttransactiondatarpc.md new file mode 100644 index 0000000000..0438301a26 --- /dev/null +++ b/packages/web3-wrapper/docs/interfaces/_src_types_.blockwithouttransactiondatarpc.md @@ -0,0 +1,212 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/types"](../modules/_src_types_.md) / [BlockWithoutTransactionDataRPC](_src_types_.blockwithouttransactiondatarpc.md) / + +# Interface: BlockWithoutTransactionDataRPC + +## Hierarchy + +* [AbstractBlockRPC](_src_types_.abstractblockrpc.md) + + * **BlockWithoutTransactionDataRPC** + +## Index + +### Properties + +* [difficulty](_src_types_.blockwithouttransactiondatarpc.md#difficulty) +* [extraData](_src_types_.blockwithouttransactiondatarpc.md#extradata) +* [gasLimit](_src_types_.blockwithouttransactiondatarpc.md#gaslimit) +* [gasUsed](_src_types_.blockwithouttransactiondatarpc.md#gasused) +* [hash](_src_types_.blockwithouttransactiondatarpc.md#hash) +* [logsBloom](_src_types_.blockwithouttransactiondatarpc.md#logsbloom) +* [miner](_src_types_.blockwithouttransactiondatarpc.md#miner) +* [nonce](_src_types_.blockwithouttransactiondatarpc.md#nonce) +* [number](_src_types_.blockwithouttransactiondatarpc.md#number) +* [parentHash](_src_types_.blockwithouttransactiondatarpc.md#parenthash) +* [sha3Uncles](_src_types_.blockwithouttransactiondatarpc.md#sha3uncles) +* [size](_src_types_.blockwithouttransactiondatarpc.md#size) +* [stateRoot](_src_types_.blockwithouttransactiondatarpc.md#stateroot) +* [timestamp](_src_types_.blockwithouttransactiondatarpc.md#timestamp) +* [totalDifficulty](_src_types_.blockwithouttransactiondatarpc.md#totaldifficulty) +* [transactions](_src_types_.blockwithouttransactiondatarpc.md#transactions) +* [transactionsRoot](_src_types_.blockwithouttransactiondatarpc.md#transactionsroot) +* [uncles](_src_types_.blockwithouttransactiondatarpc.md#uncles) + +## Properties + +### difficulty + +• **difficulty**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[difficulty](_src_types_.abstractblockrpc.md#difficulty)* + +*Defined in [src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L15)* + +___ + +### extraData + +• **extraData**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[extraData](_src_types_.abstractblockrpc.md#extradata)* + +*Defined in [src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L17)* + +___ + +### gasLimit + +• **gasLimit**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[gasLimit](_src_types_.abstractblockrpc.md#gaslimit)* + +*Defined in [src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L19)* + +___ + +### gasUsed + +• **gasUsed**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[gasUsed](_src_types_.abstractblockrpc.md#gasused)* + +*Defined in [src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L20)* + +___ + +### hash + +• **hash**: *string | null* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[hash](_src_types_.abstractblockrpc.md#hash)* + +*Defined in [src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L7)* + +___ + +### logsBloom + +• **logsBloom**: *string | null* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[logsBloom](_src_types_.abstractblockrpc.md#logsbloom)* + +*Defined in [src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L11)* + +___ + +### miner + +• **miner**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[miner](_src_types_.abstractblockrpc.md#miner)* + +*Defined in [src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L14)* + +___ + +### nonce + +• **nonce**: *string | null* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[nonce](_src_types_.abstractblockrpc.md#nonce)* + +*Defined in [src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L9)* + +___ + +### number + +• **number**: *string | null* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[number](_src_types_.abstractblockrpc.md#number)* + +*Defined in [src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L6)* + +___ + +### parentHash + +• **parentHash**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[parentHash](_src_types_.abstractblockrpc.md#parenthash)* + +*Defined in [src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L8)* + +___ + +### sha3Uncles + +• **sha3Uncles**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[sha3Uncles](_src_types_.abstractblockrpc.md#sha3uncles)* + +*Defined in [src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L10)* + +___ + +### size + +• **size**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[size](_src_types_.abstractblockrpc.md#size)* + +*Defined in [src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L18)* + +___ + +### stateRoot + +• **stateRoot**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[stateRoot](_src_types_.abstractblockrpc.md#stateroot)* + +*Defined in [src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L13)* + +___ + +### timestamp + +• **timestamp**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[timestamp](_src_types_.abstractblockrpc.md#timestamp)* + +*Defined in [src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L21)* + +___ + +### totalDifficulty + +• **totalDifficulty**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[totalDifficulty](_src_types_.abstractblockrpc.md#totaldifficulty)* + +*Defined in [src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L16)* + +___ + +### transactions + +• **transactions**: *string[]* + +*Defined in [src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L25)* + +___ + +### transactionsRoot + +• **transactionsRoot**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[transactionsRoot](_src_types_.abstractblockrpc.md#transactionsroot)* + +*Defined in [src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L12)* + +___ + +### uncles + +• **uncles**: *string[]* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[uncles](_src_types_.abstractblockrpc.md#uncles)* + +*Defined in [src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L22)* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/interfaces/_src_types_.blockwithtransactiondatarpc.md b/packages/web3-wrapper/docs/interfaces/_src_types_.blockwithtransactiondatarpc.md new file mode 100644 index 0000000000..477e55d65b --- /dev/null +++ b/packages/web3-wrapper/docs/interfaces/_src_types_.blockwithtransactiondatarpc.md @@ -0,0 +1,212 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/types"](../modules/_src_types_.md) / [BlockWithTransactionDataRPC](_src_types_.blockwithtransactiondatarpc.md) / + +# Interface: BlockWithTransactionDataRPC + +## Hierarchy + +* [AbstractBlockRPC](_src_types_.abstractblockrpc.md) + + * **BlockWithTransactionDataRPC** + +## Index + +### Properties + +* [difficulty](_src_types_.blockwithtransactiondatarpc.md#difficulty) +* [extraData](_src_types_.blockwithtransactiondatarpc.md#extradata) +* [gasLimit](_src_types_.blockwithtransactiondatarpc.md#gaslimit) +* [gasUsed](_src_types_.blockwithtransactiondatarpc.md#gasused) +* [hash](_src_types_.blockwithtransactiondatarpc.md#hash) +* [logsBloom](_src_types_.blockwithtransactiondatarpc.md#logsbloom) +* [miner](_src_types_.blockwithtransactiondatarpc.md#miner) +* [nonce](_src_types_.blockwithtransactiondatarpc.md#nonce) +* [number](_src_types_.blockwithtransactiondatarpc.md#number) +* [parentHash](_src_types_.blockwithtransactiondatarpc.md#parenthash) +* [sha3Uncles](_src_types_.blockwithtransactiondatarpc.md#sha3uncles) +* [size](_src_types_.blockwithtransactiondatarpc.md#size) +* [stateRoot](_src_types_.blockwithtransactiondatarpc.md#stateroot) +* [timestamp](_src_types_.blockwithtransactiondatarpc.md#timestamp) +* [totalDifficulty](_src_types_.blockwithtransactiondatarpc.md#totaldifficulty) +* [transactions](_src_types_.blockwithtransactiondatarpc.md#transactions) +* [transactionsRoot](_src_types_.blockwithtransactiondatarpc.md#transactionsroot) +* [uncles](_src_types_.blockwithtransactiondatarpc.md#uncles) + +## Properties + +### difficulty + +• **difficulty**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[difficulty](_src_types_.abstractblockrpc.md#difficulty)* + +*Defined in [src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L15)* + +___ + +### extraData + +• **extraData**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[extraData](_src_types_.abstractblockrpc.md#extradata)* + +*Defined in [src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L17)* + +___ + +### gasLimit + +• **gasLimit**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[gasLimit](_src_types_.abstractblockrpc.md#gaslimit)* + +*Defined in [src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L19)* + +___ + +### gasUsed + +• **gasUsed**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[gasUsed](_src_types_.abstractblockrpc.md#gasused)* + +*Defined in [src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L20)* + +___ + +### hash + +• **hash**: *string | null* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[hash](_src_types_.abstractblockrpc.md#hash)* + +*Defined in [src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L7)* + +___ + +### logsBloom + +• **logsBloom**: *string | null* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[logsBloom](_src_types_.abstractblockrpc.md#logsbloom)* + +*Defined in [src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L11)* + +___ + +### miner + +• **miner**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[miner](_src_types_.abstractblockrpc.md#miner)* + +*Defined in [src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L14)* + +___ + +### nonce + +• **nonce**: *string | null* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[nonce](_src_types_.abstractblockrpc.md#nonce)* + +*Defined in [src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L9)* + +___ + +### number + +• **number**: *string | null* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[number](_src_types_.abstractblockrpc.md#number)* + +*Defined in [src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L6)* + +___ + +### parentHash + +• **parentHash**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[parentHash](_src_types_.abstractblockrpc.md#parenthash)* + +*Defined in [src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L8)* + +___ + +### sha3Uncles + +• **sha3Uncles**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[sha3Uncles](_src_types_.abstractblockrpc.md#sha3uncles)* + +*Defined in [src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L10)* + +___ + +### size + +• **size**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[size](_src_types_.abstractblockrpc.md#size)* + +*Defined in [src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L18)* + +___ + +### stateRoot + +• **stateRoot**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[stateRoot](_src_types_.abstractblockrpc.md#stateroot)* + +*Defined in [src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L13)* + +___ + +### timestamp + +• **timestamp**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[timestamp](_src_types_.abstractblockrpc.md#timestamp)* + +*Defined in [src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L21)* + +___ + +### totalDifficulty + +• **totalDifficulty**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[totalDifficulty](_src_types_.abstractblockrpc.md#totaldifficulty)* + +*Defined in [src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L16)* + +___ + +### transactions + +• **transactions**: *[TransactionRPC](_src_types_.transactionrpc.md)[]* + +*Defined in [src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L28)* + +___ + +### transactionsRoot + +• **transactionsRoot**: *string* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[transactionsRoot](_src_types_.abstractblockrpc.md#transactionsroot)* + +*Defined in [src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L12)* + +___ + +### uncles + +• **uncles**: *string[]* + +*Inherited from [AbstractBlockRPC](_src_types_.abstractblockrpc.md).[uncles](_src_types_.abstractblockrpc.md#uncles)* + +*Defined in [src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L22)* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/interfaces/_src_types_.calldatarpc.md b/packages/web3-wrapper/docs/interfaces/_src_types_.calldatarpc.md new file mode 100644 index 0000000000..8798912b73 --- /dev/null +++ b/packages/web3-wrapper/docs/interfaces/_src_types_.calldatarpc.md @@ -0,0 +1,91 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/types"](../modules/_src_types_.md) / [CallDataRPC](_src_types_.calldatarpc.md) / + +# Interface: CallDataRPC + +## Hierarchy + +* [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md) + + * **CallDataRPC** + +## Index + +### Properties + +* [data](_src_types_.calldatarpc.md#optional-data) +* [from](_src_types_.calldatarpc.md#optional-from) +* [gas](_src_types_.calldatarpc.md#optional-gas) +* [gasPrice](_src_types_.calldatarpc.md#optional-gasprice) +* [nonce](_src_types_.calldatarpc.md#optional-nonce) +* [to](_src_types_.calldatarpc.md#optional-to) +* [value](_src_types_.calldatarpc.md#optional-value) + +## Properties + +### `Optional` data + +• **data**? : *undefined | string* + +*Inherited from [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md).[data](_src_types_.calltxdatabaserpc.md#optional-data)* + +*Defined in [src/types.ts:76](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L76)* + +___ + +### `Optional` from + +• **from**? : *undefined | string* + +*Defined in [src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L85)* + +___ + +### `Optional` gas + +• **gas**? : *undefined | string* + +*Inherited from [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md).[gas](_src_types_.calltxdatabaserpc.md#optional-gas)* + +*Defined in [src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L74)* + +___ + +### `Optional` gasPrice + +• **gasPrice**? : *undefined | string* + +*Inherited from [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md).[gasPrice](_src_types_.calltxdatabaserpc.md#optional-gasprice)* + +*Defined in [src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L75)* + +___ + +### `Optional` nonce + +• **nonce**? : *undefined | string* + +*Inherited from [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md).[nonce](_src_types_.calltxdatabaserpc.md#optional-nonce)* + +*Defined in [src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L77)* + +___ + +### `Optional` to + +• **to**? : *undefined | string* + +*Inherited from [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md).[to](_src_types_.calltxdatabaserpc.md#optional-to)* + +*Defined in [src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L72)* + +___ + +### `Optional` value + +• **value**? : *undefined | string* + +*Inherited from [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md).[value](_src_types_.calltxdatabaserpc.md#optional-value)* + +*Defined in [src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L73)* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/interfaces/_src_types_.calltxdatabaserpc.md b/packages/web3-wrapper/docs/interfaces/_src_types_.calltxdatabaserpc.md new file mode 100644 index 0000000000..d2584d5301 --- /dev/null +++ b/packages/web3-wrapper/docs/interfaces/_src_types_.calltxdatabaserpc.md @@ -0,0 +1,72 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/types"](../modules/_src_types_.md) / [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md) / + +# Interface: CallTxDataBaseRPC + +## Hierarchy + +* **CallTxDataBaseRPC** + + * [TxDataRPC](_src_types_.txdatarpc.md) + + * [CallDataRPC](_src_types_.calldatarpc.md) + +## Index + +### Properties + +* [data](_src_types_.calltxdatabaserpc.md#optional-data) +* [gas](_src_types_.calltxdatabaserpc.md#optional-gas) +* [gasPrice](_src_types_.calltxdatabaserpc.md#optional-gasprice) +* [nonce](_src_types_.calltxdatabaserpc.md#optional-nonce) +* [to](_src_types_.calltxdatabaserpc.md#optional-to) +* [value](_src_types_.calltxdatabaserpc.md#optional-value) + +## Properties + +### `Optional` data + +• **data**? : *undefined | string* + +*Defined in [src/types.ts:76](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L76)* + +___ + +### `Optional` gas + +• **gas**? : *undefined | string* + +*Defined in [src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L74)* + +___ + +### `Optional` gasPrice + +• **gasPrice**? : *undefined | string* + +*Defined in [src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L75)* + +___ + +### `Optional` nonce + +• **nonce**? : *undefined | string* + +*Defined in [src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L77)* + +___ + +### `Optional` to + +• **to**? : *undefined | string* + +*Defined in [src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L72)* + +___ + +### `Optional` value + +• **value**? : *undefined | string* + +*Defined in [src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L73)* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/interfaces/_src_types_.logentryrpc.md b/packages/web3-wrapper/docs/interfaces/_src_types_.logentryrpc.md new file mode 100644 index 0000000000..dfed32d8ab --- /dev/null +++ b/packages/web3-wrapper/docs/interfaces/_src_types_.logentryrpc.md @@ -0,0 +1,86 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/types"](../modules/_src_types_.md) / [LogEntryRPC](_src_types_.logentryrpc.md) / + +# Interface: LogEntryRPC + +## Hierarchy + +* **LogEntryRPC** + +## Index + +### Properties + +* [address](_src_types_.logentryrpc.md#address) +* [blockHash](_src_types_.logentryrpc.md#blockhash) +* [blockNumber](_src_types_.logentryrpc.md#blocknumber) +* [data](_src_types_.logentryrpc.md#data) +* [logIndex](_src_types_.logentryrpc.md#logindex) +* [topics](_src_types_.logentryrpc.md#topics) +* [transactionHash](_src_types_.logentryrpc.md#transactionhash) +* [transactionIndex](_src_types_.logentryrpc.md#transactionindex) + +## Properties + +### address + +• **address**: *string* + +*Defined in [src/types.ts:64](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L64)* + +___ + +### blockHash + +• **blockHash**: *string | null* + +*Defined in [src/types.ts:62](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L62)* + +___ + +### blockNumber + +• **blockNumber**: *string | null* + +*Defined in [src/types.ts:63](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L63)* + +___ + +### data + +• **data**: *string* + +*Defined in [src/types.ts:65](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L65)* + +___ + +### logIndex + +• **logIndex**: *string | null* + +*Defined in [src/types.ts:59](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L59)* + +___ + +### topics + +• **topics**: *string[]* + +*Defined in [src/types.ts:66](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L66)* + +___ + +### transactionHash + +• **transactionHash**: *string* + +*Defined in [src/types.ts:61](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L61)* + +___ + +### transactionIndex + +• **transactionIndex**: *string | null* + +*Defined in [src/types.ts:60](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L60)* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/interfaces/_src_types_.transactionreceiptrpc.md b/packages/web3-wrapper/docs/interfaces/_src_types_.transactionreceiptrpc.md new file mode 100644 index 0000000000..98a142102b --- /dev/null +++ b/packages/web3-wrapper/docs/interfaces/_src_types_.transactionreceiptrpc.md @@ -0,0 +1,113 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/types"](../modules/_src_types_.md) / [TransactionReceiptRPC](_src_types_.transactionreceiptrpc.md) / + +# Interface: TransactionReceiptRPC + +## Hierarchy + +* **TransactionReceiptRPC** + +## Index + +### Properties + +* [blockHash](_src_types_.transactionreceiptrpc.md#blockhash) +* [blockNumber](_src_types_.transactionreceiptrpc.md#blocknumber) +* [contractAddress](_src_types_.transactionreceiptrpc.md#contractaddress) +* [cumulativeGasUsed](_src_types_.transactionreceiptrpc.md#cumulativegasused) +* [from](_src_types_.transactionreceiptrpc.md#from) +* [gasUsed](_src_types_.transactionreceiptrpc.md#gasused) +* [logs](_src_types_.transactionreceiptrpc.md#logs) +* [status](_src_types_.transactionreceiptrpc.md#status) +* [to](_src_types_.transactionreceiptrpc.md#to) +* [transactionHash](_src_types_.transactionreceiptrpc.md#transactionhash) +* [transactionIndex](_src_types_.transactionreceiptrpc.md#transactionindex) + +## Properties + +### blockHash + +• **blockHash**: *string* + +*Defined in [src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L45)* + +___ + +### blockNumber + +• **blockNumber**: *string* + +*Defined in [src/types.ts:46](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L46)* + +___ + +### contractAddress + +• **contractAddress**: *string | null* + +*Defined in [src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L54)* + +___ + +### cumulativeGasUsed + +• **cumulativeGasUsed**: *string* + +*Defined in [src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L52)* + +___ + +### from + +• **from**: *string* + +*Defined in [src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L49)* + +___ + +### gasUsed + +• **gasUsed**: *string* + +*Defined in [src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L53)* + +___ + +### logs + +• **logs**: *[LogEntryRPC](_src_types_.logentryrpc.md)[]* + +*Defined in [src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L55)* + +___ + +### status + +• **status**: *[TransactionReceiptStatusRPC](../modules/_src_types_.md#transactionreceiptstatusrpc)* + +*Defined in [src/types.ts:51](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L51)* + +___ + +### to + +• **to**: *string* + +*Defined in [src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L50)* + +___ + +### transactionHash + +• **transactionHash**: *string* + +*Defined in [src/types.ts:47](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L47)* + +___ + +### transactionIndex + +• **transactionIndex**: *string* + +*Defined in [src/types.ts:48](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L48)* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/interfaces/_src_types_.transactionrpc.md b/packages/web3-wrapper/docs/interfaces/_src_types_.transactionrpc.md new file mode 100644 index 0000000000..53040b86c2 --- /dev/null +++ b/packages/web3-wrapper/docs/interfaces/_src_types_.transactionrpc.md @@ -0,0 +1,113 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/types"](../modules/_src_types_.md) / [TransactionRPC](_src_types_.transactionrpc.md) / + +# Interface: TransactionRPC + +## Hierarchy + +* **TransactionRPC** + +## Index + +### Properties + +* [blockHash](_src_types_.transactionrpc.md#blockhash) +* [blockNumber](_src_types_.transactionrpc.md#blocknumber) +* [from](_src_types_.transactionrpc.md#from) +* [gas](_src_types_.transactionrpc.md#gas) +* [gasPrice](_src_types_.transactionrpc.md#gasprice) +* [hash](_src_types_.transactionrpc.md#hash) +* [input](_src_types_.transactionrpc.md#input) +* [nonce](_src_types_.transactionrpc.md#nonce) +* [to](_src_types_.transactionrpc.md#to) +* [transactionIndex](_src_types_.transactionrpc.md#transactionindex) +* [value](_src_types_.transactionrpc.md#value) + +## Properties + +### blockHash + +• **blockHash**: *string | null* + +*Defined in [src/types.ts:33](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L33)* + +___ + +### blockNumber + +• **blockNumber**: *string | null* + +*Defined in [src/types.ts:34](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L34)* + +___ + +### from + +• **from**: *string* + +*Defined in [src/types.ts:36](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L36)* + +___ + +### gas + +• **gas**: *string* + +*Defined in [src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L40)* + +___ + +### gasPrice + +• **gasPrice**: *string* + +*Defined in [src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L39)* + +___ + +### hash + +• **hash**: *string* + +*Defined in [src/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L31)* + +___ + +### input + +• **input**: *string* + +*Defined in [src/types.ts:41](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L41)* + +___ + +### nonce + +• **nonce**: *string* + +*Defined in [src/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L32)* + +___ + +### to + +• **to**: *string | null* + +*Defined in [src/types.ts:37](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L37)* + +___ + +### transactionIndex + +• **transactionIndex**: *string | null* + +*Defined in [src/types.ts:35](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L35)* + +___ + +### value + +• **value**: *string* + +*Defined in [src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L38)* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/interfaces/_src_types_.txdatarpc.md b/packages/web3-wrapper/docs/interfaces/_src_types_.txdatarpc.md new file mode 100644 index 0000000000..84d9c17422 --- /dev/null +++ b/packages/web3-wrapper/docs/interfaces/_src_types_.txdatarpc.md @@ -0,0 +1,91 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/types"](../modules/_src_types_.md) / [TxDataRPC](_src_types_.txdatarpc.md) / + +# Interface: TxDataRPC + +## Hierarchy + +* [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md) + + * **TxDataRPC** + +## Index + +### Properties + +* [data](_src_types_.txdatarpc.md#optional-data) +* [from](_src_types_.txdatarpc.md#from) +* [gas](_src_types_.txdatarpc.md#optional-gas) +* [gasPrice](_src_types_.txdatarpc.md#optional-gasprice) +* [nonce](_src_types_.txdatarpc.md#optional-nonce) +* [to](_src_types_.txdatarpc.md#optional-to) +* [value](_src_types_.txdatarpc.md#optional-value) + +## Properties + +### `Optional` data + +• **data**? : *undefined | string* + +*Inherited from [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md).[data](_src_types_.calltxdatabaserpc.md#optional-data)* + +*Defined in [src/types.ts:76](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L76)* + +___ + +### from + +• **from**: *string* + +*Defined in [src/types.ts:81](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L81)* + +___ + +### `Optional` gas + +• **gas**? : *undefined | string* + +*Inherited from [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md).[gas](_src_types_.calltxdatabaserpc.md#optional-gas)* + +*Defined in [src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L74)* + +___ + +### `Optional` gasPrice + +• **gasPrice**? : *undefined | string* + +*Inherited from [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md).[gasPrice](_src_types_.calltxdatabaserpc.md#optional-gasprice)* + +*Defined in [src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L75)* + +___ + +### `Optional` nonce + +• **nonce**? : *undefined | string* + +*Inherited from [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md).[nonce](_src_types_.calltxdatabaserpc.md#optional-nonce)* + +*Defined in [src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L77)* + +___ + +### `Optional` to + +• **to**? : *undefined | string* + +*Inherited from [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md).[to](_src_types_.calltxdatabaserpc.md#optional-to)* + +*Defined in [src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L72)* + +___ + +### `Optional` value + +• **value**? : *undefined | string* + +*Inherited from [CallTxDataBaseRPC](_src_types_.calltxdatabaserpc.md).[value](_src_types_.calltxdatabaserpc.md#optional-value)* + +*Defined in [src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L73)* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/modules/_src_index_.md b/packages/web3-wrapper/docs/modules/_src_index_.md new file mode 100644 index 0000000000..9b2d5c52f9 --- /dev/null +++ b/packages/web3-wrapper/docs/modules/_src_index_.md @@ -0,0 +1,5 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/index"](_src_index_.md) / + +# External module: "src/index" \ No newline at end of file diff --git a/packages/web3-wrapper/docs/modules/_src_marshaller_.md b/packages/web3-wrapper/docs/modules/_src_marshaller_.md new file mode 100644 index 0000000000..281d1244a5 --- /dev/null +++ b/packages/web3-wrapper/docs/modules/_src_marshaller_.md @@ -0,0 +1,215 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/marshaller"](_src_marshaller_.md) / + +# External module: "src/marshaller" + +## Index + +### Object literals + +* [marshaller](_src_marshaller_.md#const-marshaller) + +## Object literals + +### `Const` marshaller + +### ▪ **marshaller**: *object* + +*Defined in [src/marshaller.ts:33](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/marshaller.ts#L33)* + +Utils to convert ethereum structures from user-space format to RPC format. (marshall/unmarshall) + +### _marshalCallTxDataBase + +▸ **_marshalCallTxDataBase**(`callTxDataBase`: `Partial`): *`Partial`* + +*Defined in [src/marshaller.ts:208](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/marshaller.ts#L208)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callTxDataBase` | `Partial` | + +**Returns:** *`Partial`* + +### marshalAddress + +▸ **marshalAddress**(`address`: string): *string* + +*Defined in [src/marshaller.ts:176](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/marshaller.ts#L176)* + +Marshall address + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`address` | string | address to marshall | + +**Returns:** *string* + +marshalled address + +### marshalBlockParam + +▸ **marshalBlockParam**(`blockParam`: `BlockParam` | string | number | undefined): *string | undefined* + +*Defined in [src/marshaller.ts:187](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/marshaller.ts#L187)* + +Marshall block param + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`blockParam` | `BlockParam` \| string \| number \| undefined | block param to marshall | + +**Returns:** *string | undefined* + +marshalled block param + +### marshalCallData + +▸ **marshalCallData**(`callData`: `Partial`): *`Partial`* + +*Defined in [src/marshaller.ts:159](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/marshaller.ts#L159)* + +Marshall call data + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | `Partial` | call data to marshall | + +**Returns:** *`Partial`* + +marshalled call data + +### marshalTxData + +▸ **marshalTxData**(`txData`: `Partial`): *`Partial`* + +*Defined in [src/marshaller.ts:133](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/marshaller.ts#L133)* + +Marshall transaction data + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txData` | `Partial` | transaction data to marshall | + +**Returns:** *`Partial`* + +marshalled transaction data + +### unmarshalIntoBlockWithTransactionData + +▸ **unmarshalIntoBlockWithTransactionData**(`blockWithHexValues`: [BlockWithTransactionDataRPC](../interfaces/_src_types_.blockwithtransactiondatarpc.md)): *`BlockWithTransactionData`* + +*Defined in [src/marshaller.ts:59](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/marshaller.ts#L59)* + +Unmarshall block with transaction data + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`blockWithHexValues` | [BlockWithTransactionDataRPC](../interfaces/_src_types_.blockwithtransactiondatarpc.md) | block to unmarshall | + +**Returns:** *`BlockWithTransactionData`* + +unmarshalled block with transaction data + +### unmarshalIntoBlockWithoutTransactionData + +▸ **unmarshalIntoBlockWithoutTransactionData**(`blockWithHexValues`: [BlockWithoutTransactionDataRPC](../interfaces/_src_types_.blockwithouttransactiondatarpc.md)): *`BlockWithoutTransactionData`* + +*Defined in [src/marshaller.ts:39](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/marshaller.ts#L39)* + +Unmarshall block without transaction data + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`blockWithHexValues` | [BlockWithoutTransactionDataRPC](../interfaces/_src_types_.blockwithouttransactiondatarpc.md) | block to unmarshall | + +**Returns:** *`BlockWithoutTransactionData`* + +unmarshalled block without transaction data + +### unmarshalLog + +▸ **unmarshalLog**(`rawLog`: `RawLogEntry`): *`LogEntry`* + +*Defined in [src/marshaller.ts:199](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/marshaller.ts#L199)* + +Unmarshall log + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`rawLog` | `RawLogEntry` | log to unmarshall | + +**Returns:** *`LogEntry`* + +unmarshalled log + +### unmarshalTransaction + +▸ **unmarshalTransaction**(`txRpc`: [TransactionRPC](../interfaces/_src_types_.transactionrpc.md)): *`Transaction`* + +*Defined in [src/marshaller.ts:82](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/marshaller.ts#L82)* + +Unmarshall transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txRpc` | [TransactionRPC](../interfaces/_src_types_.transactionrpc.md) | transaction to unmarshall | + +**Returns:** *`Transaction`* + +unmarshalled transaction + +### unmarshalTransactionReceipt + +▸ **unmarshalTransactionReceipt**(`txReceiptRpc`: [TransactionReceiptRPC](../interfaces/_src_types_.transactionreceiptrpc.md)): *`TransactionReceipt`* + +*Defined in [src/marshaller.ts:99](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/marshaller.ts#L99)* + +Unmarshall transaction receipt + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txReceiptRpc` | [TransactionReceiptRPC](../interfaces/_src_types_.transactionreceiptrpc.md) | transaction receipt to unmarshall | + +**Returns:** *`TransactionReceipt`* + +unmarshalled transaction receipt + +### unmarshalTxData + +▸ **unmarshalTxData**(`txDataRpc`: [TxDataRPC](../interfaces/_src_types_.txdatarpc.md)): *`TxData`* + +*Defined in [src/marshaller.ts:115](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/marshaller.ts#L115)* + +Unmarshall transaction data + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txDataRpc` | [TxDataRPC](../interfaces/_src_types_.txdatarpc.md) | transaction data to unmarshall | + +**Returns:** *`TxData`* + +unmarshalled transaction data \ No newline at end of file diff --git a/packages/web3-wrapper/docs/modules/_src_types_.md b/packages/web3-wrapper/docs/modules/_src_types_.md new file mode 100644 index 0000000000..6ab412f700 --- /dev/null +++ b/packages/web3-wrapper/docs/modules/_src_types_.md @@ -0,0 +1,36 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/types"](_src_types_.md) / + +# External module: "src/types" + +## Index + +### Enumerations + +* [NodeType](../enums/_src_types_.nodetype.md) +* [Web3WrapperErrors](../enums/_src_types_.web3wrappererrors.md) + +### Interfaces + +* [AbstractBlockRPC](../interfaces/_src_types_.abstractblockrpc.md) +* [BlockWithTransactionDataRPC](../interfaces/_src_types_.blockwithtransactiondatarpc.md) +* [BlockWithoutTransactionDataRPC](../interfaces/_src_types_.blockwithouttransactiondatarpc.md) +* [CallDataRPC](../interfaces/_src_types_.calldatarpc.md) +* [CallTxDataBaseRPC](../interfaces/_src_types_.calltxdatabaserpc.md) +* [LogEntryRPC](../interfaces/_src_types_.logentryrpc.md) +* [TransactionRPC](../interfaces/_src_types_.transactionrpc.md) +* [TransactionReceiptRPC](../interfaces/_src_types_.transactionreceiptrpc.md) +* [TxDataRPC](../interfaces/_src_types_.txdatarpc.md) + +### Type aliases + +* [TransactionReceiptStatusRPC](_src_types_.md#transactionreceiptstatusrpc) + +## Type aliases + +### TransactionReceiptStatusRPC + +Ƭ **TransactionReceiptStatusRPC**: *null | string | `0` | `1`* + +*Defined in [src/types.ts:69](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/types.ts#L69)* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/modules/_src_utils_.md b/packages/web3-wrapper/docs/modules/_src_utils_.md new file mode 100644 index 0000000000..d1180eb0c7 --- /dev/null +++ b/packages/web3-wrapper/docs/modules/_src_utils_.md @@ -0,0 +1,103 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/utils"](_src_utils_.md) / + +# External module: "src/utils" + +## Index + +### Object literals + +* [utils](_src_utils_.md#const-utils) + +## Object literals + +### `Const` utils + +### ▪ **utils**: *object* + +*Defined in [src/utils.ts:4](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/utils.ts#L4)* + +### convertAmountToBigNumber + +▸ **convertAmountToBigNumber**(`value`: string | number | `BigNumber`): *`BigNumber`* + +*Defined in [src/utils.ts:17](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/utils.ts#L17)* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | string \| number \| `BigNumber` | + +**Returns:** *`BigNumber`* + +### convertHexToNumber + +▸ **convertHexToNumber**(`value`: string): *number* + +*Defined in [src/utils.ts:5](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/utils.ts#L5)* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | string | + +**Returns:** *number* + +### convertHexToNumberOrNull + +▸ **convertHexToNumberOrNull**(`hex`: string | null): *number | null* + +*Defined in [src/utils.ts:10](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/utils.ts#L10)* + +**Parameters:** + +Name | Type | +------ | ------ | +`hex` | string \| null | + +**Returns:** *number | null* + +### encodeAmountAsHexString + +▸ **encodeAmountAsHexString**(`value`: string | number | `BigNumber`): *string* + +*Defined in [src/utils.ts:31](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/utils.ts#L31)* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | string \| number \| `BigNumber` | + +**Returns:** *string* + +### isHexStrict + +▸ **isHexStrict**(`hex`: string | number): *boolean* + +*Defined in [src/utils.ts:49](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/utils.ts#L49)* + +**Parameters:** + +Name | Type | +------ | ------ | +`hex` | string \| number | + +**Returns:** *boolean* + +### numberToHex + +▸ **numberToHex**(`value`: number): *string* + +*Defined in [src/utils.ts:38](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/src/utils.ts#L38)* + +**Parameters:** + +Name | Type | +------ | ------ | +`value` | number | + +**Returns:** *string* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/modules/_src_web3_wrapper_.md b/packages/web3-wrapper/docs/modules/_src_web3_wrapper_.md new file mode 100644 index 0000000000..b6a2c356f1 --- /dev/null +++ b/packages/web3-wrapper/docs/modules/_src_web3_wrapper_.md @@ -0,0 +1,11 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["src/web3_wrapper"](_src_web3_wrapper_.md) / + +# External module: "src/web3_wrapper" + +## Index + +### Classes + +* [Web3Wrapper](../classes/_src_web3_wrapper_.web3wrapper.md) \ No newline at end of file diff --git a/packages/web3-wrapper/docs/modules/_test_utils_chai_setup_.md b/packages/web3-wrapper/docs/modules/_test_utils_chai_setup_.md new file mode 100644 index 0000000000..e54f03d11c --- /dev/null +++ b/packages/web3-wrapper/docs/modules/_test_utils_chai_setup_.md @@ -0,0 +1,27 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["test/utils/chai_setup"](_test_utils_chai_setup_.md) / + +# External module: "test/utils/chai_setup" + +## Index + +### Object literals + +* [chaiSetup](_test_utils_chai_setup_.md#const-chaisetup) + +## Object literals + +### `Const` chaiSetup + +### ▪ **chaiSetup**: *object* + +*Defined in [test/utils/chai_setup.ts:6](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/test/utils/chai_setup.ts#L6)* + +### configure + +▸ **configure**(): *void* + +*Defined in [test/utils/chai_setup.ts:7](https://github.com/0xProject/0x-monorepo/blob/a9ccc3fad/packages/web3-wrapper/test/utils/chai_setup.ts#L7)* + +**Returns:** *void* \ No newline at end of file diff --git a/packages/web3-wrapper/docs/modules/_test_web3_wrapper_test_.md b/packages/web3-wrapper/docs/modules/_test_web3_wrapper_test_.md new file mode 100644 index 0000000000..5c9a83d3d2 --- /dev/null +++ b/packages/web3-wrapper/docs/modules/_test_web3_wrapper_test_.md @@ -0,0 +1,5 @@ +> **[Web3Wrapper](../README.md)** + +[Globals](../globals.md) / ["test/web3_wrapper_test"](_test_web3_wrapper_test_.md) / + +# External module: "test/web3_wrapper_test" \ No newline at end of file diff --git a/packages/web3-wrapper/package.json b/packages/web3-wrapper/package.json index 0c35aa1201..9d969a7a7d 100644 --- a/packages/web3-wrapper/package.json +++ b/packages/web3-wrapper/package.json @@ -20,7 +20,7 @@ "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" + "docs:md": "typedoc --excludePrivate --excludeProtected --excludeExternals --excludeNotExported --target ES5 --module commonjs --name Web3Wrapper --theme markdown --tsconfig typedoc-tsconfig.json $PROJECT_FILES" }, "config": { "postpublish": { @@ -51,7 +51,8 @@ "nyc": "^11.0.1", "shx": "^0.2.2", "tslint": "5.11.0", - "typedoc": "0.13.0", + "typedoc": "0.15.0", + "typedoc-plugin-markdown": "^2.1.0", "typescript": "3.0.1" }, "dependencies": { diff --git a/packages/website/md/docs/web3_wrapper/1/installation.md b/packages/website/md/docs/web3_wrapper/1/installation.md deleted file mode 100644 index 92794d9b03..0000000000 --- a/packages/website/md/docs/web3_wrapper/1/installation.md +++ /dev/null @@ -1,25 +0,0 @@ -**Install** - -```bash -npm install @0xproject/web3-wrapper --save -``` - -**Import** - -```javascript -import { Web3Wrapper } from '@0xproject/web3-wrapper'; -``` - -or - -```javascript -var Web3Wrapper = require('@0xproject/web3-wrapper').Web3Wrapper; -``` - -If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: - -``` -"include": [ - "./node_modules/web3-typescript-typings/index.d.ts", -] -``` diff --git a/packages/website/md/docs/web3_wrapper/1/introduction.md b/packages/website/md/docs/web3_wrapper/1/introduction.md deleted file mode 100644 index 17bd316f1a..0000000000 --- a/packages/website/md/docs/web3_wrapper/1/introduction.md +++ /dev/null @@ -1 +0,0 @@ -Welcome to the [Web3Wrapper](https://github.com/0xProject/0x-monorepo/tree/development/packages/web3-wrapper) documentation! 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. diff --git a/packages/website/md/docs/web3_wrapper/2/installation.md b/packages/website/md/docs/web3_wrapper/2/installation.md deleted file mode 100644 index 14c4f066c8..0000000000 --- a/packages/website/md/docs/web3_wrapper/2/installation.md +++ /dev/null @@ -1,25 +0,0 @@ -**Install** - -```bash -npm install @0x/web3-wrapper --save -``` - -**Import** - -```javascript -import { Web3Wrapper } from '@0x/web3-wrapper'; -``` - -or - -```javascript -var Web3Wrapper = require('@0x/web3-wrapper').Web3Wrapper; -``` - -If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: - -``` -"include": [ - "./node_modules/web3-typescript-typings/index.d.ts", -] -``` diff --git a/packages/website/public/sitemap.txt b/packages/website/public/sitemap.txt index 5ee7cb843f..d4abd61bf5 100644 --- a/packages/website/public/sitemap.txt +++ b/packages/website/public/sitemap.txt @@ -21,7 +21,6 @@ https://0x.org/why https://0x.org/pdfs/0x_white_paper.pdf https://0x.org/docs/contracts https://0x.org/docs/connect -https://0x.org/docs/web3-wrapper https://0x.org/docs/contract-wrappers https://0x.org/docs/order-watcher https://0x.org/docs/sol-compiler diff --git a/packages/website/ts/containers/web3_wrapper_documentation.ts b/packages/website/ts/containers/web3_wrapper_documentation.ts deleted file mode 100644 index 76539e73a7..0000000000 --- a/packages/website/ts/containers/web3_wrapper_documentation.ts +++ /dev/null @@ -1,46 +0,0 @@ -import * as React from 'react'; -import { connect } from 'react-redux'; -import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page'; -import { DocPackages } from 'ts/types'; - -import { DocsInfoConfig, SupportedDocJson } from '../types'; -import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container'; - -/* tslint:disable:no-var-requires */ -const IntroMarkdown1 = require('md/docs/web3_wrapper/1/introduction'); -const InstallationMarkdown1 = require('md/docs/web3_wrapper/1/installation'); -const InstallationMarkdown2 = require('md/docs/web3_wrapper/2/installation'); -/* tslint:enable:no-var-requires */ - -const markdownSections = { - introduction: 'introduction', - installation: 'installation', -}; - -const docsInfoConfig: DocsInfoConfig = { - id: DocPackages.Web3Wrapper, - packageName: '@0x/web3-wrapper', - type: SupportedDocJson.TypeDoc, - displayName: 'Web3Wrapper', - packageUrl: 'https://github.com/0xProject/0x-monorepo/packages/web3-wrapper', - markdownMenu: { - 'getting-started': [markdownSections.introduction, markdownSections.installation], - }, - sectionNameToMarkdownByVersion: { - '0.0.1': { - [markdownSections.introduction]: IntroMarkdown1, - [markdownSections.installation]: InstallationMarkdown1, - }, - '3.1.0': { - [markdownSections.introduction]: IntroMarkdown1, - [markdownSections.installation]: InstallationMarkdown2, - }, - }, - markdownSections, -}; -const mapStateToProps = getMapStateToProps(docsInfoConfig); - -export const Documentation: React.ComponentClass = connect( - mapStateToProps, - mapDispatchToProps, -)(DocPageComponent); diff --git a/packages/website/ts/index.tsx b/packages/website/ts/index.tsx index d34c92d1bc..6c8a83f8ca 100644 --- a/packages/website/ts/index.tsx +++ b/packages/website/ts/index.tsx @@ -39,6 +39,7 @@ trackedTokenStorage.clearIfRequired(); import 'less/all.less'; import 'sass/modal_video.scss'; +import { constants } from 'ts/utils/constants'; // We pass modulePromise returning lambda instead of module promise, // cause we only want to import the module when the user navigates to the page. @@ -66,9 +67,6 @@ const LazySmartContractsDocumentation = createLazyComponent('Documentation', asy const LazyConnectDocumentation = createLazyComponent('Documentation', async () => import(/* webpackChunkName: "connectDocs" */ 'ts/containers/connect_documentation'), ); -const LazyWeb3WrapperDocumentation = createLazyComponent('Documentation', async () => - import(/* webpackChunkName: "web3WrapperDocs" */ 'ts/containers/web3_wrapper_documentation'), -); const LazySolCompilerDocumentation = createLazyComponent('Documentation', async () => import(/* webpackChunkName: "solCompilerDocs" */ 'ts/containers/sol_compiler_documentation'), ); @@ -228,6 +226,7 @@ render( /> + diff --git a/packages/website/ts/types.ts b/packages/website/ts/types.ts index 2e7d642169..a496f769e0 100644 --- a/packages/website/ts/types.ts +++ b/packages/website/ts/types.ts @@ -433,7 +433,6 @@ export enum Docs { export enum WebsiteLegacyPaths { ZeroExJs = '/docs/0xjs', - Web3Wrapper = '/docs/web3_wrapper', Deployer = '/docs/deployer', Jobs = '/jobs', } diff --git a/packages/website/ts/utils/constants.ts b/packages/website/ts/utils/constants.ts index 61cad96db7..6397f86ef9 100644 --- a/packages/website/ts/utils/constants.ts +++ b/packages/website/ts/utils/constants.ts @@ -109,6 +109,8 @@ export const constants = { URL_LAUNCH_KIT_ERC20_DEMO: 'https://demo.0x.org/erc20/', URL_LAUNCH_KIT_ERC721_DEMO: 'https://demo.0x.org/marketplace/', URL_WEB3_DOCS: 'https://github.com/ethereum/wiki/wiki/JavaScript-API', + URL_WEB3_WRAPPER_DOCS: + 'https://github.com/0xProject/0x-monorepo/tree/development/packages/web3-wrapper/docs/classes/_src_web3_wrapper_.web3wrapper.md', URL_WEB3_DECODED_LOG_ENTRY_EVENT: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L123', URL_WEB3_LOG_ENTRY_EVENT: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L127', diff --git a/yarn.lock b/yarn.lock index 92c9d733f9..007a0fa91a 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3734,20 +3734,12 @@ babylon@^6.1.21, babylon@^6.18.0: version "6.18.0" resolved "https://registry.yarnpkg.com/babylon/-/babylon-6.18.0.tgz#af2f3b88fa6f5c1e4c634d1a0f8eac4f55b395e3" -bach@^1.0.0: - version "1.2.0" - resolved "https://registry.yarnpkg.com/bach/-/bach-1.2.0.tgz#4b3ce96bf27134f79a1b414a51c14e34c3bd9880" - integrity sha1-Szzpa/JxNPeaG0FKUcFONMO9mIA= +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: - arr-filter "^1.1.1" - arr-flatten "^1.0.1" - arr-map "^2.0.0" - array-each "^1.0.0" - array-initial "^1.0.0" - array-last "^1.1.1" - async-done "^1.2.2" - async-settle "^1.0.0" - now-and-later "^2.0.0" + underscore ">=1.8.3" backoff@^2.5.0: version "2.5.0" @@ -9252,6 +9244,11 @@ highlight.js@^9.13.1, highlight.js@^9.6.0: version "9.13.1" resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-9.13.1.tgz#054586d53a6863311168488a0f58d6c505ce641e" +highlight.js@^9.15.8: + version "9.15.8" + resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-9.15.8.tgz#f344fda123f36f1a65490e932cf90569e4999971" + integrity sha512-RrapkKQWwE+wKdF73VsOa2RQdIoO3mxwJ4P8mhbI6KYJUraUHRKM5w5zQQKXNk0xNL4UVRdulV9SBJcmzJNzVA== + highlightjs-solidity@^1.0.5: version "1.0.6" resolved "https://registry.yarnpkg.com/highlightjs-solidity/-/highlightjs-solidity-1.0.6.tgz#59394d8a2c57013580d5bfbb62f7df98386ae7ac" @@ -10711,10 +10708,10 @@ jmespath@0.15.0: version "0.15.0" resolved "https://registry.npmjs.org/jmespath/-/jmespath-0.15.0.tgz#a3f222a9aae9f966f5d27c796510e28091764217" -js-base64@^2.1.8: - version "2.5.1" - resolved "https://registry.npmjs.org/js-base64/-/js-base64-2.5.1.tgz#1efa39ef2c5f7980bb1784ade4a8af2de3291121" - integrity sha512-M7kLczedRMYX4L8Mdh4MzyAMM9O5osx+4FcOQuTvr3A9F2D9S5JXheN0ewNbrvK2UatkTRhL5ejGmGSjNMiZuw== +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.9: version "2.4.3" @@ -11842,6 +11839,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" @@ -11963,15 +11965,10 @@ marked@^0.4.0: version "0.4.0" resolved "https://registry.yarnpkg.com/marked/-/marked-0.4.0.tgz#9ad2c2a7a1791f10a852e0112f77b571dce10c66" -matchdep@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/matchdep/-/matchdep-2.0.0.tgz#c6f34834a0d8dbc3b37c27ee8bbcb27c7775582e" - integrity sha1-xvNINKDY28OzfCfui7yyfHd1WC4= - dependencies: - findup-sync "^2.0.0" - micromatch "^3.0.4" - resolve "^1.4.0" - stack-trace "0.0.10" +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== matchmediaquery@^0.3.0: version "0.3.0" @@ -14373,6 +14370,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" @@ -16467,6 +16469,15 @@ shelljs@^0.8.2: interpret "^1.0.0" rechoir "^0.6.2" +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" + rechoir "^0.6.2" + shellwords@^0.1.1: version "0.1.1" resolved "https://registry.npmjs.org/shellwords/-/shellwords-0.1.1.tgz#d6b9181c1a48d397324c84871efbcfc73fc0654b" @@ -18010,6 +18021,21 @@ 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-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.13.0: version "0.13.0" resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.13.0.tgz#9efdf352bd54873955cd161bd4b75f24a8c59dde" @@ -18032,6 +18058,23 @@ typedoc@0.13.0: typedoc-default-themes "^0.5.0" typescript "3.1.x" +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/minimatch" "3.0.3" + 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.3" + shelljs "^0.8.3" + typedoc-default-themes "^0.6.0" + typescript "3.5.x" + typemoq@^2.1.0: version "2.1.0" resolved "https://registry.yarnpkg.com/typemoq/-/typemoq-2.1.0.tgz#4452ce360d92cf2a1a180f0c29de2803f87af1e8" @@ -18072,6 +18115,11 @@ 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" resolved "https://registry.yarnpkg.com/typewise-core/-/typewise-core-1.2.0.tgz#97eb91805c7f55d2f941748fa50d315d991ef195" @@ -18178,6 +18226,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"