diff options
author | Brandon Millman <brandon@0xproject.com> | 2018-10-18 01:57:57 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-10-18 01:57:57 +0800 |
commit | b2012bf1610eda65afe180b04df6c9ee8f5dc659 (patch) | |
tree | 1beb80ae49db8a19bdcd2039fb471d1c60b8656a /packages/asset-buyer | |
parent | c767404ad09ca9fdacf9ab43c0e6b13fc70bffb9 (diff) | |
parent | 81505ba56cc8a5b0a2991b07e8320a442ee74f27 (diff) | |
download | dexon-sol-tools-b2012bf1610eda65afe180b04df6c9ee8f5dc659.tar dexon-sol-tools-b2012bf1610eda65afe180b04df6c9ee8f5dc659.tar.gz dexon-sol-tools-b2012bf1610eda65afe180b04df6c9ee8f5dc659.tar.bz2 dexon-sol-tools-b2012bf1610eda65afe180b04df6c9ee8f5dc659.tar.lz dexon-sol-tools-b2012bf1610eda65afe180b04df6c9ee8f5dc659.tar.xz dexon-sol-tools-b2012bf1610eda65afe180b04df6c9ee8f5dc659.tar.zst dexon-sol-tools-b2012bf1610eda65afe180b04df6c9ee8f5dc659.zip |
Merge pull request #1139 from 0xProject/feature/website/asset-buyer-docs
[asset-buyer][monorepo-scripts][website] Add asset-buyer documentation
Diffstat (limited to 'packages/asset-buyer')
-rw-r--r-- | packages/asset-buyer/CHANGELOG.json | 12 | ||||
-rw-r--r-- | packages/asset-buyer/package.json | 3 | ||||
-rw-r--r-- | packages/asset-buyer/src/index.ts | 10 |
3 files changed, 22 insertions, 3 deletions
diff --git a/packages/asset-buyer/CHANGELOG.json b/packages/asset-buyer/CHANGELOG.json index ad9257276..e55661235 100644 --- a/packages/asset-buyer/CHANGELOG.json +++ b/packages/asset-buyer/CHANGELOG.json @@ -13,6 +13,18 @@ "note": "Updated to use new modularized artifacts and the latest version of @0xproject/contract-wrappers", "pr": 1105 + }, + { + "note": "Add `gasLimit` and `gasPrice` as optional properties on `BuyQuoteExecutionOpts`", + "pr": 1116 + }, + { + "note": "Add `docs:json` command to package.json", + "pr": 1139 + }, + { + "note": "Add missing types to public interface", + "pr": 1139 } ] }, diff --git a/packages/asset-buyer/package.json b/packages/asset-buyer/package.json index 8c8f3c92c..13de96e6b 100644 --- a/packages/asset-buyer/package.json +++ b/packages/asset-buyer/package.json @@ -17,7 +17,8 @@ "coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info", "test:circleci": "yarn test:coverage", "run_mocha": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js --exit", - "clean": "shx rm -rf lib test_temp" + "clean": "shx rm -rf lib test_temp", + "docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES" }, "config": { "postpublish": { diff --git a/packages/asset-buyer/src/index.ts b/packages/asset-buyer/src/index.ts index e856843f0..9ac3c0b8a 100644 --- a/packages/asset-buyer/src/index.ts +++ b/packages/asset-buyer/src/index.ts @@ -1,4 +1,10 @@ -export { Provider } from 'ethereum-types'; +export { + JSONRPCRequestPayload, + JSONRPCResponsePayload, + JSONRPCResponseError, + JSONRPCErrorCallback, + Provider, +} from 'ethereum-types'; export { SignedOrder } from '@0xproject/types'; export { BigNumber } from '@0xproject/utils'; @@ -9,8 +15,8 @@ export { AssetBuyerError, AssetBuyerOpts, BuyQuote, - BuyQuoteInfo, BuyQuoteExecutionOpts, + BuyQuoteInfo, BuyQuoteRequestOpts, OrderProvider, OrderProviderRequest, |