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

Add OrderWatcher docs page

Browse Source
This commit is contained in:
Fabio Berger
2018-08-03 11:14:01 +02:00
parent b5d98a2803
commit 6dd656bdfc
14 changed files with 139 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
packages/order-watcher/package.json
View File

@@ -25,10 +25,15 @@
"copy_artifacts": "copyfiles -u 2 './src/artifacts/**/*.json' ./lib/src/artifacts",
"update_artifacts": "for i in ${npm_package_config_contracts_v2_beta}; do copyfiles -u 4 ../migrations/artifacts/2.0.0-beta-testnet/$i.json src/artifacts; done;",
"clean": "shx rm -rf _bundles lib test_temp test/artifacts src/generated_contract_wrappers",
"run_mocha": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js lib/test/global_hooks.js --timeout 10000 --bail --exit"
"run_mocha": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js lib/test/global_hooks.js --timeout 10000 --bail --exit",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"contracts_v2_beta": "Exchange WETH9 ERC20Token ERC721Token"
"contracts_v2_beta": "Exchange WETH9 ERC20Token ERC721Token",
"postpublish": {
"assets": [],
"shouldPublishDocs": true
}
},
"repository": {
"type": "git",

17
packages/website/md/docs/order_watcher/installation.md Normal file
View File

@@ -0,0 +1,17 @@
**Install**
```bash
yarn add @0xproject/order-watcher
```
**Import**
```javascript
import { OrderWatcher } from '@0xproject/order-watcher';
```
or
```javascript
var OrderWatcher = require('@0xproject/order-utils').OrderWatcher;
```

1
packages/website/md/docs/order_watcher/introduction.md Normal file
View File

@@ -0,0 +1 @@
Welcome to the [@0xproject/order-watcher](https://github.com/0xProject/0x-monorepo/tree/development/packages/order-watcher) documentation! OrderWatcher is a daemon that efficiently watches a set of orders, emitting events whenever the validity of an order changes. It can be used by relayers to prune an orderbook, or by traders to keep orders fetched from a Relayer up-to-date.

1
packages/website/translations/chinese.json
View File

@@ -62,6 +62,7 @@
"ETHEREUM_TYPES": "Ethereum Types",
"SUBPROVIDERS": "Subproviders",
"CONTRACT_WRAPPERS": "Contract Wrappers",
"ORDER_WATCHER": "OrderWatcher",
"0x.js": "0x.js",
"BLOG": "博客",
"FORUM": "论坛",

1
packages/website/translations/english.json
View File

@@ -63,6 +63,7 @@
"ETHEREUM_TYPES": "Ethereum Types",
"SUBPROVIDERS": "Subproviders",
"CONTRACT_WRAPPERS": "Contract Wrappers",
"ORDER_WATCHER": "OrderWatcher",
"0X_JS": "0x.js",
"BLOG": "blog",
"FORUM": "forum",

1
packages/website/translations/korean.json
View File

@@ -62,6 +62,7 @@
"ETHEREUM_TYPES": "Ethereum Types",
"SUBPROVIDERS": "Subproviders",
"CONTRACT_WRAPPERS": "Contract Wrappers",
"ORDER_WATCHER": "OrderWatcher",
"0X_JS": "0x.js",
"BLOG": "블로그",
"FORUM": "포럼",

1
packages/website/translations/russian.json
View File

@@ -62,6 +62,7 @@
"ETHEREUM_TYPES": "Ethereum Types",
"SUBPROVIDERS": "Subproviders",
"CONTRACT_WRAPPERS": "Contract Wrappers",
"ORDER_WATCHER": "OrderWatcher",
"0X_JS": "0x.js",
"BLOG": "Блог",
"FORUM": "Форум",

1
packages/website/translations/spanish.json
View File

@@ -63,6 +63,7 @@
"ETHEREUM_TYPES": "Ethereum Types",
"SUBPROVIDERS": "Subproviders",
"CONTRACT_WRAPPERS": "Contract Wrappers",
"ORDER_WATCHER": "OrderWatcher",
"0X_JS": "0x.js",
"BLOG": "blog",
"FORUM": "foro",

29
packages/website/ts/components/top_bar/top_bar.tsx
View File

@@ -84,7 +84,9 @@ const DOC_WEBSITE_PATHS_TO_KEY = {
[WebsitePaths.ContractWrappers]: Key.ContractWrappers,
[WebsitePaths.Connect]: Key.Connect,
[WebsitePaths.ZeroExJs]: Key.ZeroExJs,
}
[WebsitePaths.OrderUtils]: Key.OrderUtils,
[WebsitePaths.OrderWatcher]: Key.OrderWatcher,
};
const DEFAULT_HEIGHT = 68;
const EXPANDED_HEIGHT = 75;
@@ -166,12 +168,28 @@ export class TopBar extends React.Component<TopBarProps, TopBarState> {
primaryText={this.props.translate.get(Key.Web3Wrapper, Deco.CapWords)}
/>
</Link>,
<Link key="subMenuItem-contractWrappers" to={WebsitePaths.ContractWrappers} className="text-decoration-none">
<Link
key="subMenuItem-contractWrappers"
to={WebsitePaths.ContractWrappers}
className="text-decoration-none"
>
<MenuItem
style={{ fontSize: styles.menuItem.fontSize }}
primaryText={this.props.translate.get(Key.ContractWrappers, Deco.CapWords)}
/>
</Link>,
<Link key="subMenuItem-orderUtils" to={WebsitePaths.OrderUtils} className="text-decoration-none">
<MenuItem
style={{ fontSize: styles.menuItem.fontSize }}
primaryText={this.props.translate.get(Key.OrderUtils, Deco.CapWords)}
/>
</Link>,
<Link key="subMenuItem-orderWatcher" to={WebsitePaths.OrderWatcher} className="text-decoration-none">
<MenuItem
style={{ fontSize: styles.menuItem.fontSize }}
primaryText={this.props.translate.get(Key.OrderWatcher, Deco.CapWords)}
/>
</Link>,
<Link key="subMenuItem-sol-compiler" to={WebsitePaths.SolCompiler} className="text-decoration-none">
<MenuItem
style={{ fontSize: styles.menuItem.fontSize }}
@@ -359,7 +377,7 @@ export class TopBar extends React.Component<TopBarProps, TopBarState> {
{this.props.translate.get(key, Deco.Cap)}{' '}
{this.props.translate.get(Key.Docs, Deco.Cap)}
</MenuItem>
</Link>
</Link>;
}
})}
{!this._isViewingPortal() && (
@@ -391,10 +409,7 @@ export class TopBar extends React.Component<TopBarProps, TopBarState> {
const isViewingDocsPage = _.some(DOC_WEBSITE_PATHS_TO_KEY, (_key, websitePath) => {
return this._doesUrlInclude(websitePath);
});
if (
!isViewingDocsPage ||
_.isUndefined(this.props.menu)
) {
if (!isViewingDocsPage || _.isUndefined(this.props.menu)) {
return undefined;
}
return (

70
packages/website/ts/containers/order_watcher_documentation.ts Normal file
View File

@@ -0,0 +1,70 @@
import { DocsInfo, DocsInfoConfig, SupportedDocJson } from '@0xproject/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { Dispatch } from 'redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { Dispatcher } from 'ts/redux/dispatcher';
import { State } from 'ts/redux/reducer';
import { DocPackages } from 'ts/types';
import { constants } from 'ts/utils/constants';
import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
const IntroMarkdown = require('md/docs/order_watcher/introduction');
const InstallationMarkdown = require('md/docs/order_watcher/installation');
/* tslint:enable:no-var-requires */
const markdownSections = {
introduction: 'introduction',
installation: 'installation',
};
const docsInfoConfig: DocsInfoConfig = {
id: DocPackages.OrderWatcher,
type: SupportedDocJson.TypeDoc,
displayName: 'OrderWatcher',
packageUrl: 'https://github.com/0xProject/0x-monorepo',
markdownMenu: {
introduction: [markdownSections.introduction],
install: [markdownSections.installation],
},
sectionNameToMarkdownByVersion: {
'0.0.1': {
[markdownSections.introduction]: IntroMarkdown,
[markdownSections.installation]: InstallationMarkdown,
},
},
markdownSections,
typeConfigs: {
typeNameToExternalLink: {
BigNumber: constants.URL_BIGNUMBERJS_GITHUB,
},
},
};
const docsInfo = new DocsInfo(docsInfoConfig);
interface ConnectedState {
docsVersion: string;
availableDocVersions: string[];
docsInfo: DocsInfo;
translate: Translate;
}
interface ConnectedDispatch {
dispatcher: Dispatcher;
}
const mapStateToProps = (state: State, _ownProps: DocPageProps): ConnectedState => ({
docsVersion: state.docsVersion,
availableDocVersions: state.availableDocVersions,
translate: state.translate,
docsInfo,
});
const mapDispatchToProps = (dispatch: Dispatch<State>): ConnectedDispatch => ({
dispatcher: new Dispatcher(dispatch),
});
export const Documentation: React.ComponentClass<DocPageProps> = connect(mapStateToProps, mapDispatchToProps)(
DocPageComponent,
);

12
packages/website/ts/index.tsx
View File

@@ -40,6 +40,9 @@ const LazyZeroExJSDocumentation = createLazyComponent('Documentation', async ()
const LazyContractWrappersDocumentation = createLazyComponent('Documentation', async () =>
System.import<any>(/* webpackChunkName: "contractWrapperDocs" */ 'ts/containers/contract_wrappers_documentation'),
);
const LazyOrderWatcherDocumentation = createLazyComponent('Documentation', async () =>
System.import<any>(/* webpackChunkName: "orderWatcherDocs" */ 'ts/containers/order_watcher_documentation'),
);
const LazySmartContractsDocumentation = createLazyComponent('Documentation', async () =>
System.import<any>(/* webpackChunkName: "smartContractDocs" */ 'ts/containers/smart_contracts_documentation'),
);
@@ -83,7 +86,14 @@ render(
<Route path={WebsitePaths.About} component={About as any} />
<Route path={WebsitePaths.Wiki} component={Wiki as any} />
<Route path={`${WebsitePaths.ZeroExJs}/:version?`} component={LazyZeroExJSDocumentation} />
<Route path={`${WebsitePaths.ContractWrappers}/:version?`} component={LazyContractWrappersDocumentation} />
<Route
path={`${WebsitePaths.ContractWrappers}/:version?`}
component={LazyContractWrappersDocumentation}
/>
<Route
path={`${WebsitePaths.OrderWatcher}/:version?`}
component={LazyOrderWatcherDocumentation}
/>
<Route path={`${WebsitePaths.Connect}/:version?`} component={LazyConnectDocumentation} />
<Route
path={`${WebsitePaths.SolCompiler}/:version?`}

1
packages/website/ts/pages/documentation/doc_page.tsx
View File

@@ -34,6 +34,7 @@ const docIdToSubpackageName: { [id: string]: string } = {
[DocPackages.SolCov]: 'sol-cov',
[DocPackages.Subproviders]: 'subproviders',
[DocPackages.OrderUtils]: 'order-utils',
[DocPackages.OrderWatcher]: 'order-watcher',
[DocPackages.EthereumTypes]: 'ethereum-types',
};

2
packages/website/ts/pages/landing/landing.tsx
View File

@@ -436,7 +436,7 @@ export class Landing extends React.Component<LandingProps, LandingState> {
style={{ fontFamily: 'Roboto Mono' }}
>
<div>{this.props.translate.get(Key.OffChainOrderRelay, Deco.Cap)}</div>
<div> {this.props.translate.get(Key.OonChainSettlement, Deco.Cap)}</div>
<div> {this.props.translate.get(Key.OnChainSettlement, Deco.Cap)}</div>
</div>
<div
className="pb2 pt2 h5 sm-center sm-px3 sm-mx-auto"

5
packages/website/ts/types.ts
View File

@@ -372,6 +372,7 @@ export enum WebsitePaths {
Connect = '/docs/connect',
Web3Wrapper = '/docs/web3-wrapper',
ContractWrappers = '/docs/contract-wrappers',
OrderWatcher = '/docs/order-watcher',
SolCompiler = '/docs/sol-compiler',
JSONSchemas = '/docs/json-schemas',
SolCov = '/docs/sol-cov',
@@ -393,6 +394,7 @@ export enum DocPackages {
OrderUtils = 'ORDER_UTILS',
EthereumTypes = 'ETHEREUM_TYPES',
ContractWrappers = 'CONTRACT_WRAPPERS',
OrderWatcher = 'ORDER_WATCHER',
}
export enum Key {
@@ -409,7 +411,7 @@ export enum Key {
TraditionalAssets = 'TRADITIONAL_ASSETS',
DigitalGoods = 'DIGITAL_GOODS',
OffChainOrderRelay = 'OFFCHAIN_ORDER_RELAY',
OonChainSettlement = 'OONCHAIN_SETTLEMENT',
OnChainSettlement = 'ONCHAIN_SETTLEMENT',
OffChainOnChainDescription = 'OFFCHAIN_ONCHAIN_DESCRIPTION',
RelayersHeader = 'RELAYERS_HEADER',
BenefitsHeader = 'BENEFITS_HEADER',
@@ -448,6 +450,7 @@ export enum Key {
Subproviders = 'SUBPROVIDERS',
ZeroExJs = '0X_JS',
ContractWrappers = 'CONTRACT_WRAPPERS',
OrderWatcher = 'ORDER_WATCHER',
Blog = 'BLOG',
Forum = 'FORUM',
Connect = 'CONNECT',