diff options
| -rw-r--r-- | src/0x.js.ts | 44 | ||||
| -rw-r--r-- | src/contract_wrappers/exchange_wrapper.ts | 36 | ||||
| -rw-r--r-- | src/types.ts | 4 | ||||
| -rw-r--r-- | src/utils/constants.ts | 2 | ||||
| -rw-r--r-- | src/utils/decorators.ts | 35 | ||||
| -rw-r--r-- | tsconfig.json | 1 |
6 files changed, 86 insertions, 36 deletions
diff --git a/src/0x.js.ts b/src/0x.js.ts index 3a149ae6e..f01c918d6 100644 --- a/src/0x.js.ts +++ b/src/0x.js.ts @@ -36,18 +36,18 @@ export class ZeroEx { private _web3Wrapper: Web3Wrapper; /** * Verifies that the elliptic curve signature `signature` was generated - * by signing `dataHex` with the private key corresponding to the `signerAddressHex` address. - * @param dataHex The hex encoded data signed by the supplied signature. - * @param signature A JS object containing the elliptic curve signature parameters. - * @param signerAddressHex The hex encoded address that signed the dataHex, producing the supplied signature. - * @return Whether the signature is valid for the supplied signerAddressHex and dataHex. + * by signing `data` with the private key corresponding to the `signerAddress` address. + * @param data The hex encoded data signed by the supplied signature. + * @param signature A JS object containing the elliptic curve signature parameters. + * @param signerAddress The hex encoded address that signed the data, producing the supplied signature. + * @return Whether the signature is valid for the supplied signerAddress and data. */ - public static isValidSignature(dataHex: string, signature: ECSignature, signerAddressHex: string): boolean { - assert.isHexString('dataHex', dataHex); + public static isValidSignature(data: string, signature: ECSignature, signerAddress: string): boolean { + assert.isHexString('data', data); assert.doesConformToSchema('signature', signature, ecSignatureSchema); - assert.isETHAddressHex('signerAddressHex', signerAddressHex); + assert.isETHAddressHex('signerAddress', signerAddress); - const dataBuff = ethUtil.toBuffer(dataHex); + const dataBuff = ethUtil.toBuffer(data); const msgHashBuff = ethUtil.hashPersonalMessage(dataBuff); try { const pubKey = ethUtil.ecrecover( @@ -56,7 +56,7 @@ export class ZeroEx { ethUtil.toBuffer(signature.r), ethUtil.toBuffer(signature.s)); const retrievedAddress = ethUtil.bufferToHex(ethUtil.pubToAddress(pubKey)); - return retrievedAddress === signerAddressHex; + return retrievedAddress === signerAddress; } catch (err) { return false; } @@ -79,14 +79,14 @@ export class ZeroEx { * Checks if the supplied hex encoded order hash is valid. * Note: Valid means it has the expected format, not that an order with the orderHash exists. * Use this method when processing orderHashes submitted as user input. - * @param orderHashHex Hex encoded orderHash. - * @return Whether the supplied orderHashHex has the expected format. + * @param orderHash Hex encoded orderHash. + * @return Whether the supplied orderHash has the expected format. */ - public static isValidOrderHash(orderHashHex: string): boolean { + public static isValidOrderHash(orderHash: string): boolean { // Since this method can be called to check if any arbitrary string conforms to an orderHash's // format, we only assert that we were indeed passed a string. - assert.isString('orderHashHex', orderHashHex); - const isValidOrderHash = utils.isValidOrderHash(orderHashHex); + assert.isString('orderHash', orderHash); + const isValidOrderHash = utils.isValidOrderHash(orderHash); return isValidOrderHash; } /** @@ -167,13 +167,13 @@ export class ZeroEx { /** * Signs an orderHash and returns it's elliptic curve signature. * This method currently supports TestRPC, Geth and Parity above and below V1.6.6 - * @param orderHashHex Hex encoded orderHash to sign. + * @param orderHash Hex encoded orderHash to sign. * @param signerAddress The hex encoded Ethereum address you wish to sign it with. This address * must be available via the Web3.Provider supplied to 0x.js. - * @return A JS object containing the Elliptic curve signature parameters generated by signing the orderHashHex. + * @return A JS object containing the Elliptic curve signature parameters generated by signing the orderHash. */ - public async signOrderHashAsync(orderHashHex: string, signerAddress: string): Promise<ECSignature> { - assert.isHexString('orderHashHex', orderHashHex); + public async signOrderHashAsync(orderHash: string, signerAddress: string): Promise<ECSignature> { + assert.isHexString('orderHash', orderHash); await assert.isSenderAddressAsync('signerAddress', signerAddress, this._web3Wrapper); let msgHashHex; @@ -181,9 +181,9 @@ export class ZeroEx { const isParityNode = utils.isParityNode(nodeVersion); if (isParityNode) { // Parity node adds the personalMessage prefix itself - msgHashHex = orderHashHex; + msgHashHex = orderHash; } else { - const orderHashBuff = ethUtil.toBuffer(orderHashHex); + const orderHashBuff = ethUtil.toBuffer(orderHash); const msgHashBuff = ethUtil.hashPersonalMessage(orderHashBuff); msgHashHex = ethUtil.bufferToHex(msgHashBuff); } @@ -218,7 +218,7 @@ export class ZeroEx { r: ethUtil.bufferToHex(r), s: ethUtil.bufferToHex(s), }; - const isValidSignature = ZeroEx.isValidSignature(orderHashHex, ecSignature, signerAddress); + const isValidSignature = ZeroEx.isValidSignature(orderHash, ecSignature, signerAddress); if (!isValidSignature) { throw new Error(ZeroExError.INVALID_SIGNATURE); } diff --git a/src/contract_wrappers/exchange_wrapper.ts b/src/contract_wrappers/exchange_wrapper.ts index 232d84789..a08901004 100644 --- a/src/contract_wrappers/exchange_wrapper.ts +++ b/src/contract_wrappers/exchange_wrapper.ts @@ -35,6 +35,7 @@ import {orderFillOrKillRequestsSchema} from '../schemas/order_fill_or_kill_reque import {signedOrderSchema, orderSchema} from '../schemas/order_schemas'; import {constants} from '../utils/constants'; import {TokenWrapper} from './token_wrapper'; +import {decorators} from '../utils/decorators'; export class ExchangeWrapper extends ContractWrapper { private _exchangeContractErrCodesToMsg = { @@ -79,44 +80,44 @@ export class ExchangeWrapper extends ContractWrapper { * Returns the unavailable takerAmount of an order. Unavailable amount is defined as the total * amount that has been filled or cancelled. The remaining takerAmount can be calculated by * subtracting the unavailable amount from the total order takerAmount. - * @param orderHashHex The hex encoded orderHash for which you would like to retrieve the - * unavailable takerAmount. + * @param orderHash The hex encoded orderHash for which you would like to retrieve the + * unavailable takerAmount. * @return The amount of the order (in taker tokens) that has either been filled or canceled. */ - public async getUnavailableTakerAmountAsync(orderHashHex: string): Promise<BigNumber.BigNumber> { - assert.isValidOrderHash('orderHashHex', orderHashHex); + public async getUnavailableTakerAmountAsync(orderHash: string): Promise<BigNumber.BigNumber> { + assert.isValidOrderHash('orderHash', orderHash); const exchangeContract = await this._getExchangeContractAsync(); - let unavailableAmountInBaseUnits = await exchangeContract.getUnavailableValueT.call(orderHashHex); + let unavailableAmountInBaseUnits = await exchangeContract.getUnavailableValueT.call(orderHash); // Wrap BigNumbers returned from web3 with our own (later) version of BigNumber unavailableAmountInBaseUnits = new BigNumber(unavailableAmountInBaseUnits); return unavailableAmountInBaseUnits; } /** * Retrieve the takerAmount of an order that has already been filled. - * @param orderHashHex The hex encoded orderHash for which you would like to retrieve the filled takerAmount. + * @param orderHash The hex encoded orderHash for which you would like to retrieve the filled takerAmount. * @return The amount of the order (in taker tokens) that has already been filled. */ - public async getFilledTakerAmountAsync(orderHashHex: string): Promise<BigNumber.BigNumber> { - assert.isValidOrderHash('orderHashHex', orderHashHex); + public async getFilledTakerAmountAsync(orderHash: string): Promise<BigNumber.BigNumber> { + assert.isValidOrderHash('orderHash', orderHash); const exchangeContract = await this._getExchangeContractAsync(); - let fillAmountInBaseUnits = await exchangeContract.filled.call(orderHashHex); + let fillAmountInBaseUnits = await exchangeContract.filled.call(orderHash); // Wrap BigNumbers returned from web3 with our own (later) version of BigNumber fillAmountInBaseUnits = new BigNumber(fillAmountInBaseUnits); return fillAmountInBaseUnits; } /** * Retrieve the takerAmount of an order that has been cancelled. - * @param orderHashHex The hex encoded orderHash for which you would like to retrieve the - * cancelled takerAmount. + * @param orderHash The hex encoded orderHash for which you would like to retrieve the + * cancelled takerAmount. * @return The amount of the order (in taker tokens) that has been cancelled. */ - public async getCanceledTakerAmountAsync(orderHashHex: string): Promise<BigNumber.BigNumber> { - assert.isValidOrderHash('orderHashHex', orderHashHex); + public async getCanceledTakerAmountAsync(orderHash: string): Promise<BigNumber.BigNumber> { + assert.isValidOrderHash('orderHash', orderHash); const exchangeContract = await this._getExchangeContractAsync(); - let cancelledAmountInBaseUnits = await exchangeContract.cancelled.call(orderHashHex); + let cancelledAmountInBaseUnits = await exchangeContract.cancelled.call(orderHash); // Wrap BigNumbers returned from web3 with our own (later) version of BigNumber cancelledAmountInBaseUnits = new BigNumber(cancelledAmountInBaseUnits); return cancelledAmountInBaseUnits; @@ -135,6 +136,7 @@ export class ExchangeWrapper extends ContractWrapper { * @param takerAddress The user Ethereum address who would like to fill this order. * Must be available via the supplied Web3.Provider passed to 0x.js. */ + @decorators.contractCallErrorHandler public async fillOrderAsync(signedOrder: SignedOrder, takerTokenFillAmount: BigNumber.BigNumber, shouldCheckTransfer: boolean, takerAddress: string): Promise<void> { assert.doesConformToSchema('signedOrder', signedOrder, signedOrderSchema); @@ -188,6 +190,7 @@ export class ExchangeWrapper extends ContractWrapper { * @param takerAddress The user Ethereum address who would like to fill these orders. * Must be available via the supplied Web3.Provider passed to 0x.js. */ + @decorators.contractCallErrorHandler public async fillOrdersUpToAsync(signedOrders: SignedOrder[], takerTokenFillAmount: BigNumber.BigNumber, shouldCheckTransfer: boolean, takerAddress: string): Promise<void> { const takerTokenAddresses = _.map(signedOrders, signedOrder => signedOrder.takerTokenAddress); @@ -259,6 +262,7 @@ export class ExchangeWrapper extends ContractWrapper { * @param takerAddress The user Ethereum address who would like to fill these orders. * Must be available via the supplied Web3.Provider passed to 0x.js. */ + @decorators.contractCallErrorHandler public async batchFillOrderAsync(orderFillRequests: OrderFillRequest[], shouldCheckTransfer: boolean, takerAddress: string): Promise<void> { assert.isBoolean('shouldCheckTransfer', shouldCheckTransfer); @@ -323,6 +327,7 @@ export class ExchangeWrapper extends ContractWrapper { * @param takerAddress The user Ethereum address who would like to fill this order. * Must be available via the supplied Web3.Provider passed to 0x.js. */ + @decorators.contractCallErrorHandler public async fillOrKillOrderAsync(signedOrder: SignedOrder, takerTokenFillAmount: BigNumber.BigNumber, takerAddress: string): Promise<void> { assert.doesConformToSchema('signedOrder', signedOrder, signedOrderSchema); @@ -369,6 +374,7 @@ export class ExchangeWrapper extends ContractWrapper { * @param takerAddress The user Ethereum address who would like to fill there orders. * Must be available via the supplied Web3.Provider passed to 0x.js. */ + @decorators.contractCallErrorHandler public async batchFillOrKillAsync(orderFillOrKillRequests: OrderFillOrKillRequest[], takerAddress: string): Promise<void> { await assert.isSenderAddressAsync('takerAddress', takerAddress, this._web3Wrapper); @@ -424,6 +430,7 @@ export class ExchangeWrapper extends ContractWrapper { * The order you would like to cancel. * @param takerTokenCancelAmount The amount (specified in taker tokens) that you would like to cancel. */ + @decorators.contractCallErrorHandler public async cancelOrderAsync( order: Order|SignedOrder, takerTokenCancelAmount: BigNumber.BigNumber): Promise<void> { assert.doesConformToSchema('order', order, orderSchema); @@ -459,6 +466,7 @@ export class ExchangeWrapper extends ContractWrapper { * @param orderCancellationRequests An array of JS objects that conform to the OrderCancellationRequest * interface. */ + @decorators.contractCallErrorHandler public async batchCancelOrderAsync(orderCancellationRequests: OrderCancellationRequest[]): Promise<void> { const makers = _.map(orderCancellationRequests, cancellationRequest => cancellationRequest.order.maker); assert.hasAtMostOneUniqueValue(makers, ExchangeContractErrs.MULTIPLE_MAKERS_IN_SINGLE_CANCEL_BATCH_DISALLOWED); diff --git a/src/types.ts b/src/types.ts index 5237fdb1b..4b9250654 100644 --- a/src/types.ts +++ b/src/types.ts @@ -18,6 +18,8 @@ export const ZeroExError = strEnum([ 'ZRX_NOT_IN_TOKEN_REGISTRY', 'INSUFFICIENT_ALLOWANCE_FOR_TRANSFER', 'INSUFFICIENT_BALANCE_FOR_TRANSFER', + 'INVALID_JUMP', + 'OUT_OF_GAS', ]); export type ZeroExError = keyof typeof ZeroExError; @@ -263,3 +265,5 @@ export interface OrderFillRequest { signedOrder: SignedOrder; takerTokenFillAmount: BigNumber.BigNumber; } + +export type AsyncMethod = (...args: any[]) => Promise<any>; diff --git a/src/utils/constants.ts b/src/utils/constants.ts index fef0a91a0..d56ee16c5 100644 --- a/src/utils/constants.ts +++ b/src/utils/constants.ts @@ -2,4 +2,6 @@ export const constants = { NULL_ADDRESS: '0x0000000000000000000000000000000000000000', TESTRPC_NETWORK_ID: 50, MAX_DIGITS_IN_UNSIGNED_256_INT: 78, + INVALID_JUMP_PATTERN: 'invalid JUMP at', + OUT_OF_GAS_PATTERN: 'out of gas', }; diff --git a/src/utils/decorators.ts b/src/utils/decorators.ts new file mode 100644 index 000000000..a25f2cff5 --- /dev/null +++ b/src/utils/decorators.ts @@ -0,0 +1,35 @@ +import * as _ from 'lodash'; +import {constants} from './constants'; +import {AsyncMethod, ZeroExError} from '../types'; + +export const decorators = { + /** + * Source: https://stackoverflow.com/a/29837695/3546986 + */ + contractCallErrorHandler(target: object, + key: string|symbol, + descriptor: TypedPropertyDescriptor<AsyncMethod>, + ): TypedPropertyDescriptor<AsyncMethod> { + const originalMethod = (descriptor.value as AsyncMethod); + + // Do not use arrow syntax here. Use a function expression in + // order to use the correct value of `this` in this method + // tslint:disable-next-line:only-arrow-functions + descriptor.value = async function(...args: any[]) { + try { + const result = await originalMethod.apply(this, args); + return result; + } catch (error) { + if (_.includes(error.message, constants.INVALID_JUMP_PATTERN)) { + throw new Error(ZeroExError.INVALID_JUMP); + } + if (_.includes(error.message, constants.OUT_OF_GAS_PATTERN)) { + throw new Error(ZeroExError.OUT_OF_GAS); + } + throw error; + } + }; + + return descriptor; + }, +}; diff --git a/tsconfig.json b/tsconfig.json index 6e49168b7..e26c01048 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -7,6 +7,7 @@ "sourceMap": true, "declaration": true, "noImplicitAny": true, + "experimentalDecorators": true, "strictNullChecks": true }, "include": [ |