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 From 83d0bad3a1e6635dedb46fbd99ee1bec5246d4bf Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Mon, 5 Feb 2018 16:28:03 -0800 Subject: Addressed comments and update 0xProject/types-ethereumjs-util deps --- packages/testnet-faucets/src/ts/handler.ts | 92 +++++++++++++----------------- 1 file changed, 41 insertions(+), 51 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 7883cefd8..1dae8a47f 100644 --- a/packages/testnet-faucets/src/ts/handler.ts +++ b/packages/testnet-faucets/src/ts/handler.ts @@ -2,13 +2,13 @@ import { Order, SignedOrder, ZeroEx } from '0x.js'; import { BigNumber } from '@0xproject/utils'; import * as express from 'express'; import * as _ from 'lodash'; +import * as Web3 from 'web3'; // 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'); @@ -22,12 +22,6 @@ import { rpcUrls } from './rpc_urls'; import { utils } from './utils'; import { ZRXRequestQueue } from './zrx_request_queue'; -// HACK: web3 leaks XMLHttpRequest into the global scope and causes requests to hang -// because they are using the wrong XHR package. -// Filed issue: https://github.com/ethereum/web3.js/issues/844 -// tslint:disable-next-line:ordered-imports -import * as Web3 from 'web3'; - interface ItemByNetworkId { [networkId: string]: T; } @@ -38,15 +32,46 @@ enum RequestedAssetType { ZRX = 'ZRX', } -const TWO_DAYS_IN_MS = 1.728e8; // TODO: make this configurable +const FIVE_DAYS_IN_MS = 4.32e8; // TODO: make this configurable export class Handler { private _zeroExByNetworkId: ItemByNetworkId = {}; private _etherRequestQueueByNetworkId: ItemByNetworkId = {}; private _zrxRequestQueueByNetworkId: ItemByNetworkId = {}; + private static _dispenseAsset( + req: express.Request, + res: express.Response, + requestQueueByNetworkId: ItemByNetworkId, + requestedAssetType: RequestedAssetType, + ) { + const requestQueue = _.get(requestQueueByNetworkId, req.params.networkId); + if (_.isUndefined(requestQueue)) { + res.status(400).send('UNSUPPORTED_NETWORK_ID'); + return; + } + const didAddToQueue = requestQueue.add(req.params.recipient); + if (!didAddToQueue) { + res.status(503).send('QUEUE_IS_FULL'); + return; + } + utils.consoleLog(`Added ${req.params.recipient} to queue: ${requestedAssetType} networkId: ${req.params.networkId}`); + res.status(200).end(); + } + private static _createProviderEngine(rpcUrl: string) { + const engine = new ProviderEngine(); + engine.addProvider(new NonceSubprovider()); + engine.addProvider(new HookedWalletSubprovider(idManagement)); + engine.addProvider( + new RpcSubprovider({ + rpcUrl, + }), + ); + engine.start(); + return engine; + } constructor() { _.forIn(rpcUrls, (rpcUrl: string, networkId: string) => { - const providerObj = this._createProviderEngine(rpcUrl); + const providerObj = Handler._createProviderEngine(rpcUrl); const web3 = new Web3(providerObj); const zeroExConfig = { networkId: +networkId, @@ -77,10 +102,10 @@ export class Handler { res.status(200).send(payload); } public dispenseEther(req: express.Request, res: express.Response) { - this._dispenseAsset(req, res, this._etherRequestQueueByNetworkId, RequestedAssetType.ETH); + Handler._dispenseAsset(req, res, this._etherRequestQueueByNetworkId, RequestedAssetType.ETH); } public dispenseZRX(req: express.Request, res: express.Response) { - this._dispenseAsset(req, res, this._zrxRequestQueueByNetworkId, RequestedAssetType.ZRX); + Handler._dispenseAsset(req, res, this._zrxRequestQueueByNetworkId, RequestedAssetType.ZRX); } public async dispenseWETHOrder(req: express.Request, res: express.Response) { await this._dispenseOrder(req, res, RequestedAssetType.WETH); @@ -88,28 +113,8 @@ export class Handler { 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: ItemByNetworkId, - requestedAssetType: RequestedAssetType, - ) { - const requestQueue = _.get(requestQueueByNetworkId, req.networkId); - if (_.isUndefined(requestQueue)) { - res.status(400).send('UNSUPPORTED_NETWORK_ID'); - return; - } - const didAddToQueue = requestQueue.add(req.recipientAddress); - if (!didAddToQueue) { - res.status(503).send('QUEUE_IS_FULL'); - return; - } - 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); + const zeroEx = _.get(this._zeroExByNetworkId, req.params.networkId); if (_.isUndefined(zeroEx)) { res.status(400).send('UNSUPPORTED_NETWORK_ID'); return; @@ -117,21 +122,19 @@ export class Handler { res.setHeader('Content-Type', 'application/json'); const makerTokenAddress = await zeroEx.tokenRegistry.getTokenAddressBySymbolIfExistsAsync(requestedAssetType); if (_.isUndefined(makerTokenAddress)) { - res.status(400).send('INVALID_TOKEN'); - return; + throw new Error(`Unsupported asset type: ${requestedAssetType}`); } 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; + throw new Error(`Unsupported asset type: ${requestedAssetType}`); } const makerTokenAmount = new BigNumber(0.1); const takerTokenAmount = new BigNumber(0.1); const order: Order = { maker: configs.DISPENSER_ADDRESS, - taker: req.recipientAddress, + taker: req.params.recipient, makerFee: new BigNumber(0), takerFee: new BigNumber(0), makerTokenAmount, @@ -141,7 +144,7 @@ export class Handler { salt: ZeroEx.generatePseudoRandomSalt(), exchangeContractAddress: zeroEx.exchange.getContractAddress(), feeRecipient: ZeroEx.NULL_ADDRESS, - expirationUnixTimestampSec: new BigNumber(Date.now() + TWO_DAYS_IN_MS), + expirationUnixTimestampSec: new BigNumber(Date.now() + FIVE_DAYS_IN_MS), }; const orderHash = ZeroEx.getOrderHashHex(order); const signature = await zeroEx.signOrderHashAsync(orderHash, configs.DISPENSER_ADDRESS, false); @@ -154,17 +157,4 @@ export class Handler { 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(); - engine.addProvider(new NonceSubprovider()); - engine.addProvider(new HookedWalletSubprovider(idManagement)); - engine.addProvider( - new RpcSubprovider({ - rpcUrl, - }), - ); - engine.start(); - return engine; - } } -- cgit v1.2.3 From 6bdabe72b955b0a5cc613fea61b7eacee606d5a9 Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Tue, 6 Feb 2018 11:48:56 -0800 Subject: Prettier --- packages/testnet-faucets/src/ts/handler.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (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 1dae8a47f..e9ced3437 100644 --- a/packages/testnet-faucets/src/ts/handler.ts +++ b/packages/testnet-faucets/src/ts/handler.ts @@ -54,7 +54,9 @@ export class Handler { res.status(503).send('QUEUE_IS_FULL'); return; } - utils.consoleLog(`Added ${req.params.recipient} to queue: ${requestedAssetType} networkId: ${req.params.networkId}`); + utils.consoleLog( + `Added ${req.params.recipient} to queue: ${requestedAssetType} networkId: ${req.params.networkId}`, + ); res.status(200).end(); } private static _createProviderEngine(rpcUrl: string) { -- cgit v1.2.3