From 44162811bd57afb89e5d052a2d9db25007cc1463 Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Fri, 26 Jan 2018 09:40:42 -0800 Subject: Add order signing and dispensing ability to faucet --- packages/testnet-faucets/src/ts/handler.ts | 116 +++++++++++++++++++++-------- 1 file changed, 86 insertions(+), 30 deletions(-) (limited to 'packages/testnet-faucets/src/ts/handler.ts') diff --git a/packages/testnet-faucets/src/ts/handler.ts b/packages/testnet-faucets/src/ts/handler.ts index bf5b3e81e..7883cefd8 100644 --- a/packages/testnet-faucets/src/ts/handler.ts +++ b/packages/testnet-faucets/src/ts/handler.ts @@ -1,11 +1,20 @@ -import { addressUtils } from '@0xproject/utils'; +import { Order, SignedOrder, ZeroEx } from '0x.js'; +import { BigNumber } from '@0xproject/utils'; import * as express from 'express'; import * as _ from 'lodash'; + +// HACK: web3 injects XMLHttpRequest into the global scope and ProviderEngine checks XMLHttpRequest +// to know whether it is running in a browser or node environment. We need it to be undefined since +// we are not running in a browser env. +// Filed issue: https://github.com/ethereum/web3.js/issues/844 +(global as any).XMLHttpRequest = undefined; + import ProviderEngine = require('web3-provider-engine'); import HookedWalletSubprovider = require('web3-provider-engine/subproviders/hooked-wallet'); import NonceSubprovider = require('web3-provider-engine/subproviders/nonce-tracker'); import RpcSubprovider = require('web3-provider-engine/subproviders/rpc'); +import { configs } from './configs'; import { EtherRequestQueue } from './ether_request_queue'; import { idManagement } from './id_management'; import { RequestQueue } from './request_queue'; @@ -19,32 +28,38 @@ import { ZRXRequestQueue } from './zrx_request_queue'; // tslint:disable-next-line:ordered-imports import * as Web3 from 'web3'; -interface RequestQueueByNetworkId { - [networkId: string]: RequestQueue; +interface ItemByNetworkId { + [networkId: string]: T; } -enum QueueType { +enum RequestedAssetType { ETH = 'ETH', + WETH = 'WETH', ZRX = 'ZRX', } -const DEFAULT_NETWORK_ID = 42; // kovan +const TWO_DAYS_IN_MS = 1.728e8; // TODO: make this configurable export class Handler { - private _etherRequestQueueByNetworkId: RequestQueueByNetworkId = {}; - private _zrxRequestQueueByNetworkId: RequestQueueByNetworkId = {}; + private _zeroExByNetworkId: ItemByNetworkId = {}; + private _etherRequestQueueByNetworkId: ItemByNetworkId = {}; + private _zrxRequestQueueByNetworkId: ItemByNetworkId = {}; constructor() { _.forIn(rpcUrls, (rpcUrl: string, networkId: string) => { const providerObj = this._createProviderEngine(rpcUrl); const web3 = new Web3(providerObj); + const zeroExConfig = { + networkId: +networkId, + }; + const zeroEx = new ZeroEx(web3.currentProvider, zeroExConfig); + this._zeroExByNetworkId[networkId] = zeroEx; this._etherRequestQueueByNetworkId[networkId] = new EtherRequestQueue(web3); - this._zrxRequestQueueByNetworkId[networkId] = new ZRXRequestQueue(web3, +networkId); + this._zrxRequestQueueByNetworkId[networkId] = new ZRXRequestQueue(web3, zeroEx); }); } public getQueueInfo(req: express.Request, res: express.Response) { res.setHeader('Content-Type', 'application/json'); const queueInfo = _.mapValues(rpcUrls, (rpcUrl: string, networkId: string) => { - utils.consoleLog(networkId); const etherRequestQueue = this._etherRequestQueueByNetworkId[networkId]; const zrxRequestQueue = this._zrxRequestQueueByNetworkId[networkId]; return { @@ -62,37 +77,83 @@ export class Handler { res.status(200).send(payload); } public dispenseEther(req: express.Request, res: express.Response) { - this._dispense(req, res, this._etherRequestQueueByNetworkId, QueueType.ETH); + this._dispenseAsset(req, res, this._etherRequestQueueByNetworkId, RequestedAssetType.ETH); } public dispenseZRX(req: express.Request, res: express.Response) { - this._dispense(req, res, this._zrxRequestQueueByNetworkId, QueueType.ZRX); + this._dispenseAsset(req, res, this._zrxRequestQueueByNetworkId, RequestedAssetType.ZRX); + } + public async dispenseWETHOrder(req: express.Request, res: express.Response) { + await this._dispenseOrder(req, res, RequestedAssetType.WETH); } - private _dispense( + public async dispenseZRXOrder(req: express.Request, res: express.Response, next: express.NextFunction) { + await this._dispenseOrder(req, res, RequestedAssetType.ZRX); + } + // tslint:disable-next-line:prefer-function-over-method + private _dispenseAsset( req: express.Request, res: express.Response, - requestQueueByNetworkId: RequestQueueByNetworkId, - queueType: QueueType, + requestQueueByNetworkId: ItemByNetworkId, + requestedAssetType: RequestedAssetType, ) { - const recipientAddress = req.params.recipient; - if (_.isUndefined(recipientAddress) || !this._isValidEthereumAddress(recipientAddress)) { - res.status(400).send('INVALID_RECIPIENT_ADDRESS'); - return; - } - const networkId = _.get(req.query, 'networkId', DEFAULT_NETWORK_ID); - const requestQueue = _.get(requestQueueByNetworkId, networkId); + const requestQueue = _.get(requestQueueByNetworkId, req.networkId); if (_.isUndefined(requestQueue)) { - res.status(400).send('INVALID_NETWORK_ID'); + res.status(400).send('UNSUPPORTED_NETWORK_ID'); return; } - const lowerCaseRecipientAddress = recipientAddress.toLowerCase(); - const didAddToQueue = requestQueue.add(lowerCaseRecipientAddress); + const didAddToQueue = requestQueue.add(req.recipientAddress); if (!didAddToQueue) { res.status(503).send('QUEUE_IS_FULL'); return; } - utils.consoleLog(`Added ${lowerCaseRecipientAddress} to queue: ${queueType} networkId: ${networkId}`); + utils.consoleLog(`Added ${req.recipientAddress} to queue: ${requestedAssetType} networkId: ${req.networkId}`); res.status(200).end(); } + private async _dispenseOrder(req: express.Request, res: express.Response, requestedAssetType: RequestedAssetType) { + const zeroEx = _.get(this._zeroExByNetworkId, req.networkId); + if (_.isUndefined(zeroEx)) { + res.status(400).send('UNSUPPORTED_NETWORK_ID'); + return; + } + res.setHeader('Content-Type', 'application/json'); + const makerTokenAddress = await zeroEx.tokenRegistry.getTokenAddressBySymbolIfExistsAsync(requestedAssetType); + if (_.isUndefined(makerTokenAddress)) { + res.status(400).send('INVALID_TOKEN'); + return; + } + const takerTokenSymbol = + requestedAssetType === RequestedAssetType.WETH ? RequestedAssetType.ZRX : RequestedAssetType.WETH; + const takerTokenAddress = await zeroEx.tokenRegistry.getTokenAddressBySymbolIfExistsAsync(takerTokenSymbol); + if (_.isUndefined(takerTokenAddress)) { + res.status(400).send('INVALID_TOKEN'); + return; + } + const makerTokenAmount = new BigNumber(0.1); + const takerTokenAmount = new BigNumber(0.1); + const order: Order = { + maker: configs.DISPENSER_ADDRESS, + taker: req.recipientAddress, + makerFee: new BigNumber(0), + takerFee: new BigNumber(0), + makerTokenAmount, + takerTokenAmount, + makerTokenAddress, + takerTokenAddress, + salt: ZeroEx.generatePseudoRandomSalt(), + exchangeContractAddress: zeroEx.exchange.getContractAddress(), + feeRecipient: ZeroEx.NULL_ADDRESS, + expirationUnixTimestampSec: new BigNumber(Date.now() + TWO_DAYS_IN_MS), + }; + const orderHash = ZeroEx.getOrderHashHex(order); + const signature = await zeroEx.signOrderHashAsync(orderHash, configs.DISPENSER_ADDRESS, false); + const signedOrder = { + ...order, + signature, + }; + const signedOrderHash = ZeroEx.getOrderHashHex(signedOrder); + const payload = JSON.stringify(signedOrder); + utils.consoleLog(`Dispensed signed order: ${payload}`); + res.status(200).send(payload); + } // tslint:disable-next-line:prefer-function-over-method private _createProviderEngine(rpcUrl: string) { const engine = new ProviderEngine(); @@ -106,9 +167,4 @@ export class Handler { engine.start(); return engine; } - // tslint:disable-next-line:prefer-function-over-method - private _isValidEthereumAddress(address: string): boolean { - const lowercaseAddress = address.toLowerCase(); - return addressUtils.isAddress(lowercaseAddress); - } } -- cgit v1.2.3