From 2207f09ce2c8b595f75fce6387256a64c64b23c3 Mon Sep 17 00:00:00 2001 From: Alex Browne Date: Tue, 25 Sep 2018 14:41:45 -0700 Subject: Make event parsing more functional and less class-based --- .../events/event_handlers/base_event_handler.ts | 34 ---------- .../event_handlers/exchange_event_handler.ts | 76 ---------------------- .../src/data_types/events/exchange_events.ts | 75 +++++++++++++++++++++ packages/pipeline/src/index.ts | 17 ++--- 4 files changed, 79 insertions(+), 123 deletions(-) delete mode 100644 packages/pipeline/src/data_types/events/event_handlers/base_event_handler.ts delete mode 100644 packages/pipeline/src/data_types/events/event_handlers/exchange_event_handler.ts create mode 100644 packages/pipeline/src/data_types/events/exchange_events.ts diff --git a/packages/pipeline/src/data_types/events/event_handlers/base_event_handler.ts b/packages/pipeline/src/data_types/events/event_handlers/base_event_handler.ts deleted file mode 100644 index 59331fc4f..000000000 --- a/packages/pipeline/src/data_types/events/event_handlers/base_event_handler.ts +++ /dev/null @@ -1,34 +0,0 @@ -import { AbiDefinition, BlockParam, BlockParamLiteral, LogEntry } from 'ethereum-types'; -import * as R from 'ramda'; -import { BaseEntity } from 'typeorm'; - -import { Etherscan } from '../../../data_sources/etherscan'; -import { convertResponseToLogEntry } from '../event_utils'; - -export abstract class BaseEventHandler { - protected _abi: AbiDefinition[]; - protected _address: string; - protected _etherscan: Etherscan; - constructor(abi: AbiDefinition[], address: string, etherscan: Etherscan) { - this._abi = abi; - this._address = address; - this._etherscan = etherscan; - } - public abstract convertLogEntryToEventEntity(logEntry: LogEntry): EntityType; - - public async getEventsAsync( - fromBlock: BlockParam = BlockParamLiteral.Earliest, - toBlock: BlockParam = BlockParamLiteral.Latest, - ): Promise { - const rawEventsResponse = await this._etherscan.getContractEventsAsync(this._address, fromBlock, toBlock); - const logEntries = R.map(convertResponseToLogEntry, rawEventsResponse.result); - // Note(albrow): Imperative for loop is required here because we can't - // bind convertLogEntryToEventEntity without having a specific instance - // of a sub-class. - const result = []; - for (const logEntry of logEntries) { - result.push(this.convertLogEntryToEventEntity(logEntry)); - } - return result; - } -} diff --git a/packages/pipeline/src/data_types/events/event_handlers/exchange_event_handler.ts b/packages/pipeline/src/data_types/events/event_handlers/exchange_event_handler.ts deleted file mode 100644 index 38ff20595..000000000 --- a/packages/pipeline/src/data_types/events/event_handlers/exchange_event_handler.ts +++ /dev/null @@ -1,76 +0,0 @@ -import { ExchangeEventArgs, ExchangeFillEventArgs } from '@0xproject/contract-wrappers'; -import { assetDataUtils } from '@0xproject/order-utils'; -import { AssetProxyId, ERC721AssetData } from '@0xproject/types'; -import { AbiDecoder, BigNumber } from '@0xproject/utils'; -import { AbiDefinition, LogEntry, LogWithDecodedArgs } from 'ethereum-types'; -import * as R from 'ramda'; - -import { ExchangeFillEvent } from '../../../entities/ExchangeFillEvent'; -import { decodeLogEntry } from '../event_utils'; - -import { BaseEventHandler } from './base_event_handler'; - -// TODO(albrow): Union with other exchange event entity types -export type ExchangeEventEntity = ExchangeFillEvent; - -export class ExchangeEventHandler extends BaseEventHandler { - public convertLogEntryToEventEntity(logEntry: LogEntry): ExchangeEventEntity { - const decodedLogEntry = decodeLogEntry(this._abi, logEntry); - return _convertToEntity(decodedLogEntry); - } -} - -export function _convertToEntity(eventLog: LogWithDecodedArgs): ExchangeEventEntity { - switch (eventLog.event) { - case 'Fill': - return _convertToExchangeFillEvent(eventLog as LogWithDecodedArgs); - default: - return new ExchangeFillEvent(); - // throw new Error('unexpected eventLog.event type: ' + eventLog.event); - } -} - -export function _convertToExchangeFillEvent(eventLog: LogWithDecodedArgs): ExchangeFillEvent { - const makerAssetData = assetDataUtils.decodeAssetDataOrThrow(eventLog.args.makerAssetData); - const makerAssetType = makerAssetData.assetProxyId === AssetProxyId.ERC20 ? 'erc20' : 'erc721'; - const takerAssetData = assetDataUtils.decodeAssetDataOrThrow(eventLog.args.takerAssetData); - const takerAssetType = takerAssetData.assetProxyId === AssetProxyId.ERC20 ? 'erc20' : 'erc721'; - const exchangeFillEvent = new ExchangeFillEvent(); - exchangeFillEvent.logIndex = eventLog.logIndex as number; - exchangeFillEvent.address = eventLog.address as string; - exchangeFillEvent.rawData = eventLog.data as string; - exchangeFillEvent.blockNumber = eventLog.blockNumber as number; - exchangeFillEvent.makerAddress = eventLog.args.makerAddress.toString(); - exchangeFillEvent.takerAddress = eventLog.args.takerAddress.toString(); - exchangeFillEvent.feeRecepientAddress = eventLog.args.feeRecipientAddress; - exchangeFillEvent.senderAddress = eventLog.args.senderAddress; - exchangeFillEvent.makerAssetFilledAmount = eventLog.args.makerAssetFilledAmount.toString(); - exchangeFillEvent.takerAssetFilledAmount = eventLog.args.takerAssetFilledAmount.toString(); - exchangeFillEvent.makerFeePaid = eventLog.args.makerFeePaid.toString(); - exchangeFillEvent.takerFeePaid = eventLog.args.takerFeePaid.toString(); - exchangeFillEvent.orderHash = eventLog.args.orderHash; - exchangeFillEvent.rawMakerAssetData = eventLog.args.makerAssetData; - exchangeFillEvent.makerAssetType = makerAssetType; - exchangeFillEvent.makerAssetProxyId = makerAssetData.assetProxyId; - exchangeFillEvent.makerTokenAddress = makerAssetData.tokenAddress; - exchangeFillEvent.makerTokenId = bigNumbertoStringOrNull((makerAssetData as ERC721AssetData).tokenId); - exchangeFillEvent.rawTakerAssetData = eventLog.args.takerAssetData; - exchangeFillEvent.takerAssetType = takerAssetType; - exchangeFillEvent.takerAssetProxyId = takerAssetData.assetProxyId; - exchangeFillEvent.takerTokenAddress = takerAssetData.tokenAddress; - exchangeFillEvent.takerTokenId = bigNumbertoStringOrNull((takerAssetData as ERC721AssetData).tokenId); - return exchangeFillEvent; -} - -function bigNumbertoStringOrNull(n: BigNumber): string | null { - if (n == null) { - return null; - } - return n.toString(); -} - -function filterEventLogs( - eventLogs: Array>, -): Array> { - return R.filter(eventLog => eventLog.event === 'Fill', eventLogs); -} diff --git a/packages/pipeline/src/data_types/events/exchange_events.ts b/packages/pipeline/src/data_types/events/exchange_events.ts new file mode 100644 index 000000000..fb5341b58 --- /dev/null +++ b/packages/pipeline/src/data_types/events/exchange_events.ts @@ -0,0 +1,75 @@ +import { ExchangeEventArgs, ExchangeFillEventArgs } from '@0xproject/contract-wrappers'; +import { assetDataUtils } from '@0xproject/order-utils'; +import { AssetProxyId, ERC721AssetData } from '@0xproject/types'; +import { BigNumber } from '@0xproject/utils'; +import { LogWithDecodedArgs } from 'ethereum-types'; +import * as R from 'ramda'; + +import { artifacts } from '../../artifacts'; +import { EventsResponse } from '../../data_sources/etherscan'; +import { ExchangeFillEvent } from '../../entities/ExchangeFillEvent'; + +import { convertResponseToLogEntry, decodeLogEntry } from './event_utils'; + +// TODO(albrow): Union with other exchange event entity types +export type ExchangeEventEntity = ExchangeFillEvent; + +const exchangeContractAbi = artifacts.Exchange.compilerOutput.abi; + +export function parseExchangeEvents(rawEventsResponse: EventsResponse): ExchangeEventEntity[] { + const logEntries = R.map(convertResponseToLogEntry, rawEventsResponse.result); + const decodedLogEntries = R.map( + eventResponse => decodeLogEntry(exchangeContractAbi, eventResponse), + logEntries, + ); + const filteredLogEntries = R.filter(logEntry => R.contains(logEntry.event, ['Fill']), decodedLogEntries); + return R.map(_convertToEntity, filteredLogEntries); +} + +export function _convertToEntity(eventLog: LogWithDecodedArgs): ExchangeEventEntity { + switch (eventLog.event) { + case 'Fill': + return _convertToExchangeFillEvent(eventLog as LogWithDecodedArgs); + default: + throw new Error('unexpected eventLog.event type: ' + eventLog.event); + } +} + +export function _convertToExchangeFillEvent(eventLog: LogWithDecodedArgs): ExchangeFillEvent { + const makerAssetData = assetDataUtils.decodeAssetDataOrThrow(eventLog.args.makerAssetData); + const makerAssetType = makerAssetData.assetProxyId === AssetProxyId.ERC20 ? 'erc20' : 'erc721'; + const takerAssetData = assetDataUtils.decodeAssetDataOrThrow(eventLog.args.takerAssetData); + const takerAssetType = takerAssetData.assetProxyId === AssetProxyId.ERC20 ? 'erc20' : 'erc721'; + const exchangeFillEvent = new ExchangeFillEvent(); + exchangeFillEvent.logIndex = eventLog.logIndex as number; + exchangeFillEvent.address = eventLog.address as string; + exchangeFillEvent.rawData = eventLog.data as string; + exchangeFillEvent.blockNumber = eventLog.blockNumber as number; + exchangeFillEvent.makerAddress = eventLog.args.makerAddress.toString(); + exchangeFillEvent.takerAddress = eventLog.args.takerAddress.toString(); + exchangeFillEvent.feeRecepientAddress = eventLog.args.feeRecipientAddress; + exchangeFillEvent.senderAddress = eventLog.args.senderAddress; + exchangeFillEvent.makerAssetFilledAmount = eventLog.args.makerAssetFilledAmount.toString(); + exchangeFillEvent.takerAssetFilledAmount = eventLog.args.takerAssetFilledAmount.toString(); + exchangeFillEvent.makerFeePaid = eventLog.args.makerFeePaid.toString(); + exchangeFillEvent.takerFeePaid = eventLog.args.takerFeePaid.toString(); + exchangeFillEvent.orderHash = eventLog.args.orderHash; + exchangeFillEvent.rawMakerAssetData = eventLog.args.makerAssetData; + exchangeFillEvent.makerAssetType = makerAssetType; + exchangeFillEvent.makerAssetProxyId = makerAssetData.assetProxyId; + exchangeFillEvent.makerTokenAddress = makerAssetData.tokenAddress; + exchangeFillEvent.makerTokenId = bigNumbertoStringOrNull((makerAssetData as ERC721AssetData).tokenId); + exchangeFillEvent.rawTakerAssetData = eventLog.args.takerAssetData; + exchangeFillEvent.takerAssetType = takerAssetType; + exchangeFillEvent.takerAssetProxyId = takerAssetData.assetProxyId; + exchangeFillEvent.takerTokenAddress = takerAssetData.tokenAddress; + exchangeFillEvent.takerTokenId = bigNumbertoStringOrNull((takerAssetData as ERC721AssetData).tokenId); + return exchangeFillEvent; +} + +function bigNumbertoStringOrNull(n: BigNumber): string | null { + if (n == null) { + return null; + } + return n.toString(); +} diff --git a/packages/pipeline/src/index.ts b/packages/pipeline/src/index.ts index e71a6ae4c..c01ff57b4 100644 --- a/packages/pipeline/src/index.ts +++ b/packages/pipeline/src/index.ts @@ -1,12 +1,11 @@ import 'reflect-metadata'; import { createConnection } from 'typeorm'; -import { artifacts } from './artifacts'; import { Etherscan } from './data_sources/etherscan'; import { ExchangeFillEvent } from './entities/ExchangeFillEvent'; import { config } from './ormconfig'; -import { ExchangeEventHandler } from './data_types/events/event_handlers/exchange_event_handler'; +import { parseExchangeEvents } from './data_types/events/exchange_events'; const etherscan = new Etherscan(process.env.ETHERSCAN_API_KEY as string); const EXCHANGE_ADDRESS = '0x4f833a24e1f95d70f028921e27040ca56e09ab0b'; @@ -15,18 +14,10 @@ const EXCHANGE_ADDRESS = '0x4f833a24e1f95d70f028921e27040ca56e09ab0b'; const connection = await createConnection(config); const repository = connection.getRepository(ExchangeFillEvent); console.log(`found ${await repository.count()} existing fill events`); - const exchangeEventHandler = new ExchangeEventHandler( - artifacts.Exchange.compilerOutput.abi, - EXCHANGE_ADDRESS, - etherscan, - ); - const events = await exchangeEventHandler.getEventsAsync(); - console.log(JSON.stringify(events, null, 2)); + const rawEvents = await etherscan.getContractEventsAsync(EXCHANGE_ADDRESS); + const events = parseExchangeEvents(rawEvents); for (const event of events) { - // TODO(albrow): remove this check once we can parse all Exchange events - if (event.address != null) { - await event.save(); - } + await event.save(); } console.log(`now ${await repository.count()} total fill events`); })(); -- cgit v1.2.3