diff options
Diffstat (limited to 'packages')
-rw-r--r-- | packages/react-docs/example/ts/docs.tsx | 93 | ||||
-rw-r--r-- | packages/react-docs/example/ts/index.tsx | 61 | ||||
-rw-r--r-- | packages/react-docs/example/ts/json/0.1.12.json | 1334 | ||||
-rw-r--r-- | packages/web3-wrapper/test.json | 1350 |
4 files changed, 2780 insertions, 58 deletions
diff --git a/packages/react-docs/example/ts/docs.tsx b/packages/react-docs/example/ts/docs.tsx new file mode 100644 index 000000000..98cd5b355 --- /dev/null +++ b/packages/react-docs/example/ts/docs.tsx @@ -0,0 +1,93 @@ +import * as _ from 'lodash'; +import * as React from 'react'; + +import { Documentation } from '../../src/ts/components/documentation'; +import { DocsInfo } from '../../src/ts/docs_info'; +import { DocAgnosticFormat, DocsInfoConfig, SupportedDocJson, TypeDocNode } from '../../src/ts/types'; + +import * as v1TypeDocJson from './json/0.1.12.json'; +import * as v2TypeDocJson from './json/0.2.0.json'; + +/* tslint:disable:no-var-requires */ +const IntroMarkdown = require('md/introduction'); +/* tslint:enable:no-var-requires */ + +const docSections = { + introduction: 'introduction', + web3Wrapper: 'web3Wrapper', +}; + +const docsInfoConfig: DocsInfoConfig = { + id: 'web3Wrapper', + type: SupportedDocJson.TypeDoc, + displayName: 'Web3 Wrapper', + packageUrl: 'https://github.com/0xProject/0x-monorepo', + menu: { + introduction: [docSections.introduction], + web3Wrapper: [docSections.web3Wrapper], + }, + sectionNameToMarkdown: { + [docSections.introduction]: IntroMarkdown, + }, + // Note: This needs to be kept in sync with the types exported in index.ts. Unfortunately there is + // currently no way to extract the re-exported types from index.ts via TypeDoc :( + publicTypes: ['TxData', 'TransactionReceipt', 'RawLogEntry'], + sectionNameToModulePath: { + [docSections.web3Wrapper]: ['"index"'], + }, + menuSubsectionToVersionWhenIntroduced: {}, + sections: docSections, + visibleConstructors: [docSections.web3Wrapper], +}; +const docsInfo = new DocsInfo(docsInfoConfig); + +const availableVersions = ['0.1.12', '0.2.0']; +const versionToDocJSON: { [semver: string]: object } = { + '0.1.12': v1TypeDocJson, + '0.2.0': v2TypeDocJson, +}; + +export interface DocsProps {} + +interface DocsState { + selectedVersion: string; + docAgnosticFormat?: DocAgnosticFormat; +} + +export class Docs extends React.Component<DocsProps, DocsState> { + constructor(props: DocsProps) { + super(props); + this.state = { + selectedVersion: '0.2.0', + docAgnosticFormat: docsInfo.convertToDocAgnosticFormat(v1TypeDocJson), + }; + } + public render() { + const menuSubsectionsBySection = _.isUndefined(this.state.docAgnosticFormat) + ? {} + : docsInfo.getMenuSubsectionsBySection(this.state.docAgnosticFormat); + return ( + <Documentation + selectedVersion={this.state.selectedVersion} + availableVersions={availableVersions} + docsInfo={docsInfo} + docAgnosticFormat={this.state.docAgnosticFormat} + sourceUrl={this._getSourceUrl()} + onVersionSelected={this._onVersionSelected.bind(this)} + /> + ); + } + private _onVersionSelected(semver: string) { + const selectedDocJSON = versionToDocJSON[semver]; + this.setState({ + selectedVersion: semver, + docAgnosticFormat: docsInfo.convertToDocAgnosticFormat(selectedDocJSON as TypeDocNode), + }); + } + private _getSourceUrl() { + const sourceUrl = `${docsInfoConfig.packageUrl}/blob/@0xproject/web3-wrapper%40${ + this.state.selectedVersion + }/packages/web3-wrapper`; + return sourceUrl; + } +} diff --git a/packages/react-docs/example/ts/index.tsx b/packages/react-docs/example/ts/index.tsx index bf7574e7b..84a544766 100644 --- a/packages/react-docs/example/ts/index.tsx +++ b/packages/react-docs/example/ts/index.tsx @@ -5,68 +5,13 @@ import * as React from 'react'; import { render } from 'react-dom'; import * as injectTapEventPlugin from 'react-tap-event-plugin'; -import { Documentation } from '../../src/ts/components/documentation'; -import { DocsInfo } from '../../src/ts/docs_info'; -import { DocsInfoConfig, SupportedDocJson } from '../../src/ts/types'; -injectTapEventPlugin(); - -/* tslint:disable:no-var-requires */ -const IntroMarkdown = require('md/introduction'); -/* tslint:enable:no-var-requires */ - -const docSections = { - introduction: 'introduction', - web3Wrapper: 'web3Wrapper', -}; - -const docsInfoConfig: DocsInfoConfig = { - id: 'web3Wrapper', - type: SupportedDocJson.TypeDoc, - displayName: 'Web3 Wrapper', - packageUrl: 'https://github.com/0xProject/0x-monorepo', - menu: { - introduction: [docSections.introduction], - web3Wrapper: [docSections.web3Wrapper], - }, - sectionNameToMarkdown: { - [docSections.introduction]: IntroMarkdown, - }, - // Note: This needs to be kept in sync with the types exported in index.ts. Unfortunately there is - // currently no way to extract the re-exported types from index.ts via TypeDoc :( - publicTypes: ['TxData', 'TransactionReceipt', 'RawLogEntry'], - sectionNameToModulePath: { - [docSections.web3Wrapper]: ['"index"'], - }, - menuSubsectionToVersionWhenIntroduced: {}, - sections: docSections, - visibleConstructors: [docSections.web3Wrapper], -}; -const docsInfo = new DocsInfo(docsInfoConfig); +import { Docs } from './docs'; -const selectedVersion = '0.2.0'; -const availableVersions = ['0.1.12', '0.1.13', '0.1.14', '0.2.0']; - -const sourceUrl = `${ - docsInfoConfig.packageUrl -}/blob/@0xproject/web3-wrapper%40${selectedVersion}/packages/web3-wrapper`; - -import * as typeDocJson from './json/0.2.0.json'; -const docAgnosticFormat = docsInfo.convertToDocAgnosticFormat(typeDocJson); +injectTapEventPlugin(); render( <MuiThemeProvider> - <Documentation - selectedVersion={selectedVersion} - availableVersions={availableVersions} - docsInfo={docsInfo} - docAgnosticFormat={docAgnosticFormat} - sourceUrl={sourceUrl} - onVersionSelected={onVersionSelected} - /> + <Docs /> </MuiThemeProvider>, document.getElementById('app'), ); - -function onVersionSelected(semver: string) { - // TODO -} diff --git a/packages/react-docs/example/ts/json/0.1.12.json b/packages/react-docs/example/ts/json/0.1.12.json new file mode 100644 index 000000000..b07a8f237 --- /dev/null +++ b/packages/react-docs/example/ts/json/0.1.12.json @@ -0,0 +1,1334 @@ +{ + "id": 0, + "name": "@0xproject/web3-wrapper", + "kind": 0, + "flags": {}, + "children": [ + { + "id": 1, + "name": "\"index\"", + "kind": 1, + "kindString": "External module", + "flags": { + "isExported": true + }, + "originalName": + "/Users/fabioberger/Documents/projects/0x_project/0x-monorepo/packages/web3-wrapper/src/index.ts", + "children": [ + { + "id": 11, + "name": "Web3Wrapper", + "kind": 128, + "kindString": "Class", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 12, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 13, + "name": "new Web3Wrapper", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 14, + "name": "provider", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Provider" + } + }, + { + "id": 15, + "name": "defaults", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "Partial", + "typeArguments": [ + { + "type": "reference", + "name": "TxData" + } + ] + } + } + ], + "type": { + "type": "reference", + "name": "Web3Wrapper", + "id": 11 + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 20, + "character": 38 + } + ] + }, + { + "id": 42, + "name": "doesContractExistAtAddressAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 43, + "name": "doesContractExistAtAddressAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 44, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 75, + "character": 48 + } + ] + }, + { + "id": 69, + "name": "estimateGasAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 70, + "name": "estimateGasAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 71, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 133, + "character": 33 + } + ] + }, + { + "id": 57, + "name": "getAvailableAddressesAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 58, + "name": "getAvailableAddressesAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 97, + "character": 43 + } + ] + }, + { + "id": 39, + "name": "getBalanceInWeiAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 40, + "name": "getBalanceInWeiAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 41, + "name": "owner", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "reference", + "name": "BigNumber" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 69, + "character": 37 + } + ] + }, + { + "id": 51, + "name": "getBlockAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 52, + "name": "getBlockAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 53, + "name": "blockParam", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "name": "Web3.BlockParam" + } + ] + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "reference", + "name": "BlockWithoutTransactionData" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 89, + "character": 30 + } + ] + }, + { + "id": 49, + "name": "getBlockNumberAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 50, + "name": "getBlockNumberAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 85, + "character": 36 + } + ] + }, + { + "id": 54, + "name": "getBlockTimestampAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 55, + "name": "getBlockTimestampAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 56, + "name": "blockParam", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "name": "Web3.BlockParam" + } + ] + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 93, + "character": 39 + } + ] + }, + { + "id": 16, + "name": "getContractDefaults", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 17, + "name": "getContractDefaults", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Partial", + "typeArguments": [ + { + "type": "reference", + "name": "TxData" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 33, + "character": 30 + } + ] + }, + { + "id": 62, + "name": "getContractFromAbi", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 63, + "name": "getContractFromAbi", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 64, + "name": "abi", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Web3.ContractAbi" + } + } + ], + "type": { + "type": "reference", + "name": "Contract", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 125, + "character": 29 + } + ] + }, + { + "id": 65, + "name": "getContractInstance", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 66, + "name": "getContractInstance", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 67, + "name": "abi", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Web3.ContractAbi" + } + }, + { + "id": 68, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "ContractInstance" + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 129, + "character": 30 + } + ] + }, + { + "id": 34, + "name": "getCurrentProvider", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 35, + "name": "getCurrentProvider", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Provider" + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 62, + "character": 29 + } + ] + }, + { + "id": 59, + "name": "getLogsAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 60, + "name": "getLogsAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 61, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "FilterObject" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "name": "LogEntry" + } + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 101, + "character": 29 + } + ] + }, + { + "id": 29, + "name": "getNetworkIdAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 30, + "name": "getNetworkIdAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 50, + "character": 34 + } + ] + }, + { + "id": 27, + "name": "getNodeVersionAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 28, + "name": "getNodeVersionAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 46, + "character": 36 + } + ] + }, + { + "id": 31, + "name": "getTransactionReceiptAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 32, + "name": "getTransactionReceiptAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 33, + "name": "txHash", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "reference", + "name": "TransactionReceipt" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 55, + "character": 43 + } + ] + }, + { + "id": 21, + "name": "isAddress", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 22, + "name": "isAddress", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 23, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 39, + "character": 20 + } + ] + }, + { + "id": 24, + "name": "isSenderAddressAvailableAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 25, + "name": "isSenderAddressAvailableAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 26, + "name": "senderAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 42, + "character": 46 + } + ] + }, + { + "id": 72, + "name": "sendTransactionAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 73, + "name": "sendTransactionAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 74, + "name": "txData", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "TxData" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 137, + "character": 37 + } + ] + }, + { + "id": 18, + "name": "setProvider", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 19, + "name": "setProvider", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 20, + "name": "provider", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Provider" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 36, + "character": 22 + } + ] + }, + { + "id": 45, + "name": "signTransactionAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 46, + "name": "signTransactionAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 47, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 48, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 81, + "character": 37 + } + ] + }, + { + "id": 36, + "name": "toWei", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 37, + "name": "toWei", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 38, + "name": "ethAmount", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "BigNumber" + } + } + ], + "type": { + "type": "reference", + "name": "BigNumber" + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 65, + "character": 16 + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [12] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 42, + 69, + 57, + 39, + 51, + 49, + 54, + 16, + 62, + 65, + 34, + 59, + 29, + 27, + 31, + 21, + 24, + 72, + 18, + 45, + 36 + ] + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 17, + "character": 24 + } + ] + }, + { + "id": 2, + "name": "RawLogEntry", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 8, + "name": "address", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 12, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 6, + "name": "blockHash", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 10, + "character": 13 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 7, + "name": "blockNumber", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 11, + "character": 15 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 9, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 13, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3, + "name": "logIndex", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 7, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 10, + "name": "topics", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 14, + "character": 10 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 5, + "name": "transactionHash", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 9, + "character": 19 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4, + "name": "transactionIndex", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 8, + "character": 20 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [8, 6, 7, 9, 3, 10, 5, 4] + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 6, + "character": 21 + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [11] + }, + { + "title": "Interfaces", + "kind": 256, + "children": [2] + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 1, + "character": 0 + } + ] + } + ], + "groups": [ + { + "title": "External modules", + "kind": 1, + "children": [1] + } + ] +} diff --git a/packages/web3-wrapper/test.json b/packages/web3-wrapper/test.json new file mode 100644 index 000000000..a27a35ffe --- /dev/null +++ b/packages/web3-wrapper/test.json @@ -0,0 +1,1350 @@ +{ + "id": 0, + "name": "@0xproject/web3-wrapper", + "kind": 0, + "flags": {}, + "children": [ + { + "id": 1, + "name": "\"index\"", + "kind": 1, + "kindString": "External module", + "flags": { + "isExported": true + }, + "originalName": "/Users/fabioberger/Documents/projects/0x_project/0x-monorepo/packages/web3-wrapper/src/index.ts", + "children": [ + { + "id": 11, + "name": "Web3Wrapper", + "kind": 128, + "kindString": "Class", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 12, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 13, + "name": "new Web3Wrapper", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 14, + "name": "provider", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Provider" + } + }, + { + "id": 15, + "name": "defaults", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "Partial", + "typeArguments": [ + { + "type": "reference", + "name": "TxData" + } + ] + } + } + ], + "type": { + "type": "reference", + "name": "Web3Wrapper", + "id": 11 + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 20, + "character": 38 + } + ] + }, + { + "id": 42, + "name": "doesContractExistAtAddressAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 43, + "name": "doesContractExistAtAddressAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 44, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 75, + "character": 48 + } + ] + }, + { + "id": 69, + "name": "estimateGasAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 70, + "name": "estimateGasAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 71, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 133, + "character": 33 + } + ] + }, + { + "id": 57, + "name": "getAvailableAddressesAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 58, + "name": "getAvailableAddressesAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 97, + "character": 43 + } + ] + }, + { + "id": 39, + "name": "getBalanceInWeiAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 40, + "name": "getBalanceInWeiAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 41, + "name": "owner", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "reference", + "name": "BigNumber" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 69, + "character": 37 + } + ] + }, + { + "id": 51, + "name": "getBlockAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 52, + "name": "getBlockAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 53, + "name": "blockParam", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "name": "Web3.BlockParam" + } + ] + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "reference", + "name": "BlockWithoutTransactionData" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 89, + "character": 30 + } + ] + }, + { + "id": 49, + "name": "getBlockNumberAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 50, + "name": "getBlockNumberAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 85, + "character": 36 + } + ] + }, + { + "id": 54, + "name": "getBlockTimestampAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 55, + "name": "getBlockTimestampAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 56, + "name": "blockParam", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "name": "Web3.BlockParam" + } + ] + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 93, + "character": 39 + } + ] + }, + { + "id": 16, + "name": "getContractDefaults", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 17, + "name": "getContractDefaults", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Partial", + "typeArguments": [ + { + "type": "reference", + "name": "TxData" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 33, + "character": 30 + } + ] + }, + { + "id": 62, + "name": "getContractFromAbi", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 63, + "name": "getContractFromAbi", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 64, + "name": "abi", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Web3.ContractAbi" + } + } + ], + "type": { + "type": "reference", + "name": "Contract", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 125, + "character": 29 + } + ] + }, + { + "id": 65, + "name": "getContractInstance", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 66, + "name": "getContractInstance", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 67, + "name": "abi", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Web3.ContractAbi" + } + }, + { + "id": 68, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "ContractInstance" + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 129, + "character": 30 + } + ] + }, + { + "id": 34, + "name": "getCurrentProvider", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 35, + "name": "getCurrentProvider", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Provider" + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 62, + "character": 29 + } + ] + }, + { + "id": 59, + "name": "getLogsAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 60, + "name": "getLogsAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 61, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "FilterObject" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "name": "LogEntry" + } + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 101, + "character": 29 + } + ] + }, + { + "id": 29, + "name": "getNetworkIdAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 30, + "name": "getNetworkIdAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 50, + "character": 34 + } + ] + }, + { + "id": 27, + "name": "getNodeVersionAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 28, + "name": "getNodeVersionAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 46, + "character": 36 + } + ] + }, + { + "id": 31, + "name": "getTransactionReceiptAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 32, + "name": "getTransactionReceiptAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 33, + "name": "txHash", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "reference", + "name": "TransactionReceipt" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 55, + "character": 43 + } + ] + }, + { + "id": 21, + "name": "isAddress", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 22, + "name": "isAddress", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 23, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 39, + "character": 20 + } + ] + }, + { + "id": 24, + "name": "isSenderAddressAvailableAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 25, + "name": "isSenderAddressAvailableAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 26, + "name": "senderAddress", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 42, + "character": 46 + } + ] + }, + { + "id": 72, + "name": "sendTransactionAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 73, + "name": "sendTransactionAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 74, + "name": "txData", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "TxData" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 137, + "character": 37 + } + ] + }, + { + "id": 18, + "name": "setProvider", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 19, + "name": "setProvider", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 20, + "name": "provider", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Provider" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 36, + "character": 22 + } + ] + }, + { + "id": 45, + "name": "signTransactionAsync", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 46, + "name": "signTransactionAsync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 47, + "name": "address", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 48, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "Promise", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 81, + "character": 37 + } + ] + }, + { + "id": 36, + "name": "toWei", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true, + "isPublic": true + }, + "signatures": [ + { + "id": 37, + "name": "toWei", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 38, + "name": "ethAmount", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "BigNumber" + } + } + ], + "type": { + "type": "reference", + "name": "BigNumber" + } + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 65, + "character": 16 + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 12 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 42, + 69, + 57, + 39, + 51, + 49, + 54, + 16, + 62, + 65, + 34, + 59, + 29, + 27, + 31, + 21, + 24, + 72, + 18, + 45, + 36 + ] + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 17, + "character": 24 + } + ] + }, + { + "id": 2, + "name": "RawLogEntry", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 8, + "name": "address", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 12, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 6, + "name": "blockHash", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 10, + "character": 13 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 7, + "name": "blockNumber", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 11, + "character": 15 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 9, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 13, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3, + "name": "logIndex", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 7, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 10, + "name": "topics", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 14, + "character": 10 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 5, + "name": "transactionHash", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 9, + "character": 19 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4, + "name": "transactionIndex", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "index.ts", + "line": 8, + "character": 20 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 8, + 6, + 7, + 9, + 3, + 10, + 5, + 4 + ] + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 6, + "character": 21 + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [ + 11 + ] + }, + { + "title": "Interfaces", + "kind": 256, + "children": [ + 2 + ] + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 1, + "character": 0 + } + ] + } + ], + "groups": [ + { + "title": "External modules", + "kind": 1, + "children": [ + 1 + ] + } + ] +}
\ No newline at end of file |