bumped version and added to docs

packages/asset-swapper/src/index.ts

@@ -16,6 +16,7 @@ export {
     DataItem,
     StateMutability,
     EventParameter,
+    TupleDataItem,
     ConstructorStateMutability,
 } from 'ethereum-types';
 

packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts

@@ -77,7 +77,7 @@ export class ForwarderSwapQuoteConsumer implements SwapQuoteConsumerBase<Forward
     /**
      * Given a SwapQuote, returns 'SmartContractParamsInfo' for a forwarder extension call. See type definition of CalldataInfo for more information.
      * @param quote An object that conforms to SwapQuote. See type definition for more information.
-     * @param opts  Options for getting CalldataInfo. See type definition for more information.
+     * @param opts  Options for getting SmartContractParams. See type definition for more information.
      */
     public async getSmartContractParamsOrThrowAsync(
         quote: SwapQuote,

packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts

@@ -44,6 +44,11 @@ export class SwapQuoteConsumer implements SwapQuoteConsumerBase<SmartContractPar
         this._forwarderConsumer = new ForwarderSwapQuoteConsumer(supportedProvider, options);
     }
 
+    /**
+     * Given a SwapQuote, returns 'CalldataInfo' for a 0x exchange call. See type definition of CalldataInfo for more information.
+     * @param quote An object that conforms to SwapQuote. See type definition for more information.
+     * @param opts  Options for getting SmartContractParams. See type definition for more information.
+     */
     public async getCalldataOrThrowAsync(
         quote: SwapQuote,
         opts: Partial<SwapQuoteGetOutputOpts>,
@@ -53,6 +58,11 @@ export class SwapQuoteConsumer implements SwapQuoteConsumerBase<SmartContractPar
         return consumer.getCalldataOrThrowAsync(quote, opts);
     }
 
+    /**
+     * Given a SwapQuote, returns 'SmartContractParamsInfo' for a 0x exchange call. See type definition of SmartContractParamsInfo for more information.
+     * @param quote An object that conforms to SwapQuote. See type definition for more information.
+     * @param opts  Options for getting SmartContractParams. See type definition for more information.
+     */
     public async getSmartContractParamsOrThrowAsync(
         quote: SwapQuote,
         opts: Partial<SwapQuoteGetOutputOpts>,
@@ -62,6 +72,11 @@ export class SwapQuoteConsumer implements SwapQuoteConsumerBase<SmartContractPar
         return consumer.getSmartContractParamsOrThrowAsync(quote, opts);
     }
 
+    /**
+     * Given a SwapQuote and desired rate (in takerAsset), attempt to execute the swap.
+     * @param quote An object that conforms to SwapQuote. See type definition for more information.
+     * @param opts  Options for getting CalldataInfo. See type definition for more information.
+     */
     public async executeSwapQuoteOrThrowAsync(
         quote: SwapQuote,
         opts: Partial<SwapQuoteExecutionOpts>,

packages/monorepo-scripts/src/doc_gen_configs.ts

@@ -25,6 +25,9 @@ export const docGenConfigs: DocGenConfigs = {
             'https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/ganache-core/index.d.ts#L8',
         'lightwallet.keystore':
             'https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/eth-lightwallet/index.d.ts#L36',
+        // HACK: Asset-swapper specifies marketSell and marketBuy quotes with a descriminant MarketOperation Type to ignore the error, linking Buy and Sell to MarketOperation
+        Buy: 'https://github.com/0xProject/0x-monorepo/blob/development/packages/types/src/index.ts',
+        Sell: 'https://github.com/0xProject/0x-monorepo/blob/development/packages/types/src/index.ts',
     },
     // If a 0x package re-exports an external package, we should add a link to it's exported items here
     EXTERNAL_EXPORT_TO_LINK: {

packages/website/md/docs/asset_swapper/installation.md

@@ -0,0 +1,18 @@
+#### Install
+
+```bash
+yarn add @0x/asset-swapper
+```
+
+#### Import
+
+```javascript
+import { SwapQuoter, SwapQuoteConsumer } from '@0x/asset-swapper';
+```
+
+or
+
+```javascript
+var SwapQuoter = require('@0x/asset-swapper').SwapQuoter;
+var SwapQuoteConsumer = require('@0x/asset-swapper').SwapQuoteConsumer;
+```

packages/website/md/docs/asset_swapper/introduction.md

@@ -0,0 +1 @@
+Welcome to the [asset-swapper](https://github.com/0xProject/0x-monorepo/tree/development/packages/asset-swapper) documentation! Asset-swapper is a library that provides an easy way to swap any ERC asset for another ERC asset for smart contract integrations, leveraging 0x liquidity.

packages/website/ts/containers/asset_swapper_documentation.ts

@@ -0,0 +1,42 @@
+import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
+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 { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
+
+/* tslint:disable:no-var-requires */
+const IntroMarkdown = require('md/docs/asset_swapper/introduction');
+const InstallationMarkdown = require('md/docs/asset_swapper/installation');
+/* tslint:enable:no-var-requires */
+
+const markdownSections = {
+    introduction: 'introduction',
+    installation: 'installation',
+};
+
+const docsInfoConfig: DocsInfoConfig = {
+    id: DocPackages.AssetSwapper,
+    packageName: '@0x/asset-swapper',
+    type: SupportedDocJson.TypeDoc,
+    displayName: 'AssetSwapper',
+    packageUrl: 'https://github.com/0xProject/0x-monorepo/packages/asset-swapper',
+    markdownMenu: {
+        introduction: [markdownSections.introduction],
+        install: [markdownSections.installation],
+    },
+    sectionNameToMarkdownByVersion: {
+        '0.0.1': {
+            [markdownSections.introduction]: IntroMarkdown,
+            [markdownSections.installation]: InstallationMarkdown,
+        },
+    },
+    markdownSections,
+};
+const mapStateToProps = getMapStateToProps(docsInfoConfig);
+
+export const Documentation: React.ComponentClass<DocPageProps> = connect(
+    mapStateToProps,
+    mapDispatchToProps,
+)(DocPageComponent);

packages/website/ts/index.tsx

@@ -95,6 +95,9 @@ const LazyEthereumTypesDocumentation = createLazyComponent('Documentation', asyn
 const LazyAssetBuyerDocumentation = createLazyComponent('Documentation', async () =>
     import(/* webpackChunkName: "assetBuyerDocs" */ 'ts/containers/asset_buyer_documentation'),
 );
+const LazyAssetSwapperDocumentation = createLazyComponent('Documentation', async () =>
+    import(/* webpackChunkName: "assetSwapperDocs" */ 'ts/containers/asset_swapper_documentation'),
+);
 
 const DOCUMENT_TITLE = '0x: The Protocol for Trading Tokens';
 const DOCUMENT_DESCRIPTION = 'An Open Protocol For Decentralized Exchange On The Ethereum Blockchain';
@@ -204,6 +207,10 @@ render(
                                     path={`${WebsitePaths.AssetBuyer}/:version?`}
                                     component={LazyAssetBuyerDocumentation}
                                 />
+                                <Route
+                                    path={`${WebsitePaths.AssetSwapper}/:version?`}
+                                    component={LazyAssetSwapperDocumentation}
+                                />
                                 <Route path={WebsitePaths.Docs} component={DocsHome as any} />
                                 {/* Legacy endpoints */}
                                 <Route

packages/website/ts/pages/documentation/doc_page.tsx

@@ -41,6 +41,7 @@ const docIdToSubpackageName: { [id: string]: string } = {
     [DocPackages.OrderWatcher]: 'order-watcher',
     [DocPackages.EthereumTypes]: 'ethereum-types',
     [DocPackages.AssetBuyer]: 'asset-buyer',
+    [DocPackages.AssetSwapper]: 'asset-swapper',
     [DocPackages.Migrations]: 'migrations',
 };
 

packages/website/ts/pages/documentation/docs_home.tsx

@@ -172,6 +172,14 @@ const CATEGORY_TO_PACKAGES: ObjectMap<Package[]> = {
                 to: WebsitePaths.AssetBuyer,
             },
         },
+        {
+            description:
+                'Coonvenience package for discovering and performing swaps for any ERC20 Assets',
+            link: {
+                title: '@0x/asset-swapper',
+                to: WebsitePaths.AssetSwapper,
+            },
+        },
     ],
     [Categories.ZeroExProtocolPython]: [
         {

packages/website/ts/types.ts

@@ -473,6 +473,7 @@ export enum WebsitePaths {
     OrderUtils = '/docs/order-utils',
     EthereumTypes = '/docs/ethereum-types',
     AssetBuyer = '/docs/asset-buyer',
+    AssetSwapper = '/docs/asset-swapper',
     Migrations = '/docs/migrations',
     Careers = '/careers',
     Credits = '/credits',
@@ -497,6 +498,7 @@ export enum DocPackages {
     ContractWrappers = 'CONTRACT_WRAPPERS',
     OrderWatcher = 'ORDER_WATCHER',
     AssetBuyer = 'ASSET_BUYER',
+    AssetSwapper = 'ASSET_SWAPPER',
     Migrations = 'MIGRATIONS',
 }
 
@@ -560,6 +562,7 @@ export enum Key {
     ContractWrappers = 'CONTRACT_WRAPPERS',
     OrderWatcher = 'ORDER_WATCHER',
     AssetBuyer = 'ASSET_BUYER',
+    AssetSwapper = 'ASSET_SWAPPER',
     Blog = 'BLOG',
     Forum = 'FORUM',
     Connect = 'CONNECT',