diff options
author | fragosti <francesco.agosti93@gmail.com> | 2018-09-20 20:27:20 +0800 |
---|---|---|
committer | fragosti <francesco.agosti93@gmail.com> | 2018-09-20 20:27:20 +0800 |
commit | d23487bda9fa918d31bb940fffb74f8be0859be5 (patch) | |
tree | 62395b2bb37c641b9df7c518703fbaa85ed99ded /packages/asset-buyer/src/asset_buyer.ts | |
parent | 3238925aa4e13750e5a8e45b3130ce9e148efae8 (diff) | |
download | dexon-sol-tools-d23487bda9fa918d31bb940fffb74f8be0859be5.tar dexon-sol-tools-d23487bda9fa918d31bb940fffb74f8be0859be5.tar.gz dexon-sol-tools-d23487bda9fa918d31bb940fffb74f8be0859be5.tar.bz2 dexon-sol-tools-d23487bda9fa918d31bb940fffb74f8be0859be5.tar.lz dexon-sol-tools-d23487bda9fa918d31bb940fffb74f8be0859be5.tar.xz dexon-sol-tools-d23487bda9fa918d31bb940fffb74f8be0859be5.tar.zst dexon-sol-tools-d23487bda9fa918d31bb940fffb74f8be0859be5.zip |
Update descriptions for methods on AssetBuyer
Diffstat (limited to 'packages/asset-buyer/src/asset_buyer.ts')
-rw-r--r-- | packages/asset-buyer/src/asset_buyer.ts | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/packages/asset-buyer/src/asset_buyer.ts b/packages/asset-buyer/src/asset_buyer.ts index 5f57e3d7f..2b25c681c 100644 --- a/packages/asset-buyer/src/asset_buyer.ts +++ b/packages/asset-buyer/src/asset_buyer.ts @@ -33,7 +33,7 @@ export class AssetBuyer { private _lastRefreshTimeIfExists?: number; private _currentOrdersAndFillableAmountsIfExists?: AssetBuyerOrdersAndFillableAmounts; /** - * Instantiates a new AssetBuyer instance + * Instantiates a new AssetBuyer instance given existing liquidity in the form of orders and feeOrders. * @param provider The Provider instance you would like to use for interacting with the Ethereum network. * @param orders A non-empty array of objects that conform to SignedOrder. All orders must have the same makerAssetData and takerAssetData (WETH). * @param feeOrders A array of objects that conform to SignedOrder. All orders must have the same makerAssetData (ZRX) and takerAssetData (WETH). Defaults to an empty array. @@ -63,7 +63,7 @@ export class AssetBuyer { return assetBuyer; } /** - * Instantiates a new AssetBuyer instance + * Instantiates a new AssetBuyer instance given the desired assetData and a [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) endpoint * @param provider The Provider instance you would like to use for interacting with the Ethereum network. * @param assetData The assetData that identifies the desired asset to buy. * @param sraApiUrl The standard relayer API base HTTP url you would like to source orders from. @@ -89,7 +89,7 @@ export class AssetBuyer { return assetBuyer; } /** - * Instantiates a new AssetBuyer instance + * Instantiates a new AssetBuyer instance given the desired ERC20 token address and a [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) endpoint * @param provider The Provider instance you would like to use for interacting with the Ethereum network. * @param tokenAddress The ERC20 token address that identifies the desired asset to buy. * @param sraApiUrl The standard relayer API base HTTP url you would like to source orders from. |