aboutsummaryrefslogtreecommitdiffstats
path: root/packages
diff options
context:
space:
mode:
authorfragosti <francesco.agosti93@gmail.com>2018-09-25 05:14:07 +0800
committerfragosti <francesco.agosti93@gmail.com>2018-09-25 05:14:07 +0800
commit89033e01e81fba91aecf62822b582f6f007f5494 (patch)
tree38e06657c5070d59968e04f688394a79b7945744 /packages
parent264b25c58de7170dd1e28afe94b7a8e70170f207 (diff)
downloaddexon-sol-tools-89033e01e81fba91aecf62822b582f6f007f5494.tar
dexon-sol-tools-89033e01e81fba91aecf62822b582f6f007f5494.tar.gz
dexon-sol-tools-89033e01e81fba91aecf62822b582f6f007f5494.tar.bz2
dexon-sol-tools-89033e01e81fba91aecf62822b582f6f007f5494.tar.lz
dexon-sol-tools-89033e01e81fba91aecf62822b582f6f007f5494.tar.xz
dexon-sol-tools-89033e01e81fba91aecf62822b582f6f007f5494.tar.zst
dexon-sol-tools-89033e01e81fba91aecf62822b582f6f007f5494.zip
Provide convenience methods on AssetBuyerManager
Diffstat (limited to 'packages')
-rw-r--r--packages/asset-buyer/src/asset_buyer.ts1
-rw-r--r--packages/asset-buyer/src/asset_buyer_manager.ts43
2 files changed, 43 insertions, 1 deletions
diff --git a/packages/asset-buyer/src/asset_buyer.ts b/packages/asset-buyer/src/asset_buyer.ts
index 409e34e74..39b0aa619 100644
--- a/packages/asset-buyer/src/asset_buyer.ts
+++ b/packages/asset-buyer/src/asset_buyer.ts
@@ -225,6 +225,7 @@ export class AssetBuyer {
* @param rate The desired rate to execute the buy at. Affects the amount of ETH sent with the transaction, defaults to buyQuote.maxRate.
* @param takerAddress The address to perform the buy. Defaults to the first available address from the provider.
* @param feeRecipient The address where affiliate fees are sent. Defaults to null address (0x000...000).
+ *
* @return A promise of the txHash.
*/
public async executeBuyQuoteAsync(
diff --git a/packages/asset-buyer/src/asset_buyer_manager.ts b/packages/asset-buyer/src/asset_buyer_manager.ts
index 3f96a79bb..1e2c5db5e 100644
--- a/packages/asset-buyer/src/asset_buyer_manager.ts
+++ b/packages/asset-buyer/src/asset_buyer_manager.ts
@@ -2,6 +2,7 @@ import { HttpClient } from '@0xproject/connect';
import { ContractWrappers } from '@0xproject/contract-wrappers';
import { SignedOrder } from '@0xproject/order-utils';
import { ObjectMap } from '@0xproject/types';
+import { BigNumber } from '@0xproject/utils';
import { Provider } from 'ethereum-types';
import * as _ from 'lodash';
@@ -12,7 +13,7 @@ import { StandardRelayerAPIOrderProvider } from './order_providers/standard_rela
import { assert } from './utils/assert';
import { assetDataUtils } from './utils/asset_data_utils';
-import { AssetBuyerManagerError, OrderProvider } from './types';
+import { AssetBuyerManagerError, BuyQuote, BuyQuoteRequestOpts, OrderProvider } from './types';
export class AssetBuyerManager {
// Map of assetData to AssetBuyer for that assetData
@@ -163,4 +164,44 @@ export class AssetBuyerManager {
public getAssetDatas(): string[] {
return _.keys(this._assetBuyerMap);
}
+ /**
+ * Get a `BuyQuote` containing all information relevant to fulfilling a buy.
+ * You can then pass the `BuyQuote` to `executeBuyQuoteAsync` to execute the buy.
+ *
+ * @param assetData The assetData that identifies the desired asset to buy.
+ * @param assetBuyAmount The amount of asset to buy.
+ * @param feePercentage The affiliate fee percentage. Defaults to 0.
+ * @param forceOrderRefresh If set to true, new orders and state will be fetched instead of waiting for
+ * the next orderRefreshIntervalMs. Defaults to false.
+ * @return An object that conforms to BuyQuote that satisfies the request. See type definition for more information.
+ */
+ public async getBuyQuoteAsync(
+ assetData: string,
+ assetBuyAmount: BigNumber,
+ options: Partial<BuyQuoteRequestOpts>,
+ ): Promise<BuyQuote> {
+ return this.getAssetBuyerFromAssetData(assetData).getBuyQuoteAsync(assetBuyAmount, options);
+ }
+ /**
+ * Given a BuyQuote and desired rate, attempt to execute the buy.
+ * @param buyQuote An object that conforms to BuyQuote. See type definition for more information.
+ * @param rate The desired rate to execute the buy at. Affects the amount of ETH sent with the transaction, defaults to buyQuote.maxRate.
+ * @param takerAddress The address to perform the buy. Defaults to the first available address from the provider.
+ * @param feeRecipient The address where affiliate fees are sent. Defaults to null address (0x000...000).
+ *
+ * @return A promise of the txHash.
+ */
+ public async executeBuyQuoteAsync(
+ buyQuote: BuyQuote,
+ rate?: BigNumber,
+ takerAddress?: string,
+ feeRecipient?: string,
+ ): Promise<string> {
+ return this.getAssetBuyerFromAssetData(buyQuote.assetData).executeBuyQuoteAsync(
+ buyQuote,
+ rate,
+ takerAddress,
+ feeRecipient,
+ );
+ }
}