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'; import { AssetBuyer } from './asset_buyer'; import { constants } from './constants'; import { BasicOrderProvider } from './order_providers/basic_order_provider'; import { StandardRelayerAPIOrderProvider } from './order_providers/standard_relayer_api_order_provider'; import { assert } from './utils/assert'; import { assetDataUtils } from './utils/asset_data_utils'; import { AssetBuyerManagerError, BuyQuote, BuyQuoteRequestOpts, OrderProvider } from './types'; export class AssetBuyerManager { // Map of assetData to AssetBuyer for that assetData private readonly _assetBuyerMap: ObjectMap; /** * Returns an array of all assetDatas available at the provided sraApiUrl * @param sraApiUrl The standard relayer API base HTTP url you would like to source orders from. * @param pairedWithAssetData Optional filter argument to return assetDatas that only pair with this assetData value. * * @return An array of all assetDatas available at the provider sraApiUrl */ public static async getAllAvailableAssetDatasAsync( sraApiUrl: string, pairedWithAssetData?: string, ): Promise { const client = new HttpClient(sraApiUrl); const params = { assetDataA: pairedWithAssetData, perPage: constants.MAX_PER_PAGE, }; const assetPairsResponse = await client.getAssetPairsAsync(params); return _.uniq(_.map(assetPairsResponse.records, pairsItem => pairsItem.assetDataB.assetData)); } /** * Instantiates a new AssetBuyerManager instance with all available assetDatas at the provided sraApiUrl * @param provider The Provider instance you would like to use for interacting with the Ethereum network. * @param sraApiUrl The standard relayer API base HTTP url you would like to source orders from. * @param networkId The ethereum network id. Defaults to 1 (mainnet). * @param orderRefreshIntervalMs The interval in ms that getBuyQuoteAsync should trigger an refresh of orders and order states. Defaults to 10000ms (10s). * @param expiryBufferSeconds The number of seconds to add when calculating whether an order is expired or not. Defaults to 15s. * * @return An promise of an instance of AssetBuyerManager */ public static async getAssetBuyerManagerFromStandardRelayerApiAsync( provider: Provider, sraApiUrl: string, networkId: number = constants.MAINNET_NETWORK_ID, orderRefreshIntervalMs?: number, expiryBufferSeconds?: number, ): Promise { const contractWrappers = new ContractWrappers(provider, { networkId }); const etherTokenAssetData = assetDataUtils.getEtherTokenAssetDataOrThrow(contractWrappers); const assetDatas = await AssetBuyerManager.getAllAvailableAssetDatasAsync(sraApiUrl, etherTokenAssetData); const orderProvider = new StandardRelayerAPIOrderProvider(sraApiUrl); return new AssetBuyerManager( provider, assetDatas, orderProvider, networkId, orderRefreshIntervalMs, expiryBufferSeconds, ); } /** * Instantiates a new AssetBuyerManager 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. * @param networkId The ethereum network id. Defaults to 1 (mainnet). * @param orderRefreshIntervalMs The interval in ms that getBuyQuoteAsync should trigger an refresh of orders and order states. Defaults to 10000ms (10s). * @param expiryBufferSeconds The number of seconds to add when calculating whether an order is expired or not. Defaults to 15s. * * @return An instance of AssetBuyerManager */ public static getAssetBuyerManagerFromProvidedOrders( provider: Provider, orders: SignedOrder[], feeOrders: SignedOrder[] = [], networkId?: number, orderRefreshIntervalMs?: number, expiryBufferSeconds?: number, ): AssetBuyerManager { const assetDatas = _.map(orders, order => order.makerAssetData); const orderProvider = new BasicOrderProvider(_.concat(orders, feeOrders)); return new AssetBuyerManager( provider, assetDatas, orderProvider, networkId, orderRefreshIntervalMs, expiryBufferSeconds, ); } /** * Instantiates a new AssetBuyerManager instance * @param provider The Provider instance you would like to use for interacting with the Ethereum network. * @param assetDatas The assetDatas of the desired assets to buy (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). * @param orderProvider An object that conforms to OrderProvider, see type for definition. * @param networkId The ethereum network id. Defaults to 1 (mainnet). * @param orderRefreshIntervalMs The interval in ms that getBuyQuoteAsync should trigger an refresh of orders and order states. Defaults to 10000ms (10s). * @param expiryBufferSeconds The number of seconds to add when calculating whether an order is expired or not. Defaults to 15s. * * @return An instance of AssetBuyerManager */ constructor( provider: Provider, assetDatas: string[], orderProvider: OrderProvider, networkId?: number, orderRefreshIntervalMs?: number, expiryBufferSeconds?: number, ) { assert.assert(assetDatas.length > 0, `Expected 'assetDatas' to be a non-empty array.`); this._assetBuyerMap = _.reduce( assetDatas, (accAssetBuyerMap: ObjectMap, assetData: string) => { accAssetBuyerMap[assetData] = new AssetBuyer( provider, assetData, orderProvider, networkId, orderRefreshIntervalMs, expiryBufferSeconds, ); return accAssetBuyerMap; }, {}, ); } /** * Get an AssetBuyer for the provided assetData * @param assetData The desired assetData. * * @return An instance of AssetBuyer */ public getAssetBuyerFromAssetData(assetData: string): AssetBuyer { const assetBuyer = this._assetBuyerMap[assetData]; if (_.isUndefined(assetBuyer)) { throw new Error(`${AssetBuyerManagerError.AssetBuyerNotFound}: For assetData ${assetData}`); } return assetBuyer; } /** * Get an AssetBuyer for the provided ERC20 tokenAddress * @param tokenAddress The desired tokenAddress. * * @return An instance of AssetBuyer */ public getAssetBuyerFromERC20TokenAddress(tokenAddress: string): AssetBuyer { const assetData = assetDataUtils.encodeERC20AssetData(tokenAddress); return this.getAssetBuyerFromAssetData(assetData); } /** * Get a list of all the assetDatas that the instance supports * * @return An array of assetData strings */ 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, ): Promise { 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 { return this.getAssetBuyerFromAssetData(buyQuote.assetData).executeBuyQuoteAsync( buyQuote, rate, takerAddress, feeRecipient, ); } }