diff options
author | Fabio Berger <me@fabioberger.com> | 2017-05-25 16:58:40 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2017-05-25 16:58:40 +0800 |
commit | 755c980a56385f2fe4198b5d4a312d7af0eab02c (patch) | |
tree | 60b53698073d403d2a02f355dcae348c84a34333 | |
parent | 140a160ba0627f80f998555438df1d797c75380e (diff) | |
download | dexon-sol-tools-755c980a56385f2fe4198b5d4a312d7af0eab02c.tar.gz dexon-sol-tools-755c980a56385f2fe4198b5d4a312d7af0eab02c.tar.zst dexon-sol-tools-755c980a56385f2fe4198b5d4a312d7af0eab02c.zip |
Add assertions library and add them for all function args
-rw-r--r-- | package.json | 6 | ||||
-rw-r--r-- | src/ts/0x.js.ts | 6 | ||||
-rw-r--r-- | src/ts/utils/assert.ts | 31 | ||||
-rw-r--r-- | tsconfig.json | 3 |
4 files changed, 44 insertions, 2 deletions
diff --git a/package.json b/package.json index 2f345a3f1..275a57a93 100644 --- a/package.json +++ b/package.json @@ -31,6 +31,7 @@ "node": ">=6.0.0" }, "devDependencies": { + "@types/bignumber.js": "^4.0.2", "@types/chai": "^3.5.2", "@types/mocha": "^2.2.41", "@types/node": "^7.0.22", @@ -46,9 +47,12 @@ "tslint-config-0xproject": "^0.0.2", "typedoc": "^0.7.1", "typescript": "^2.3.3", + "web3-typescript-typings": "0.0.3", "webpack": "^2.6.0" }, "dependencies": { - "ethereumjs-util": "^5.1.1" + "bignumber.js": "^4.0.2", + "ethereumjs-util": "^5.1.1", + "web3": "^0.19.0" } } diff --git a/src/ts/0x.js.ts b/src/ts/0x.js.ts index dd67c49a0..acbdd01e2 100644 --- a/src/ts/0x.js.ts +++ b/src/ts/0x.js.ts @@ -1,4 +1,6 @@ +import * as BigNumber from 'bignumber.js'; import * as ethUtil from 'ethereumjs-util'; +import {assert} from './utils/assert'; /** * Elliptic Curve signature @@ -15,6 +17,10 @@ export class ZeroEx { * by signing `data` with the private key corresponding to the `signer` address. */ public static isValidSignature(data: string, signature: ECSignature, signer: ETHAddressHex): boolean { + assert.isString('data', data); + assert.isObject('signature', signature); + assert.isETHAddressHex('signer', signer); + const dataBuff = ethUtil.toBuffer(data); const msgHashBuff = ethUtil.hashPersonalMessage(dataBuff); try { diff --git a/src/ts/utils/assert.ts b/src/ts/utils/assert.ts new file mode 100644 index 000000000..a29ae922d --- /dev/null +++ b/src/ts/utils/assert.ts @@ -0,0 +1,31 @@ +import * as _ from 'lodash'; +import * as BigNumber from 'bignumber.js'; +import Web3 = require('web3'); + +export const assert = { + isBigNumber(variableName: string, value: BigNumber.BigNumber) { + const isBigNumber = _.isObject(value) && value.isBigNumber; + this.assert(isBigNumber, this.typeAssertionMessage(variableName, 'BigNumber', value)); + }, + isString(variableName: string, value: string) { + this.assert(_.isString(value), this.typeAssertionMessage(variableName, 'string', value)); + }, + isETHAddressHex(variableName: string, value: ETHAddressHex) { + const web3 = new Web3(); + this.assert(web3.isAddress(value), this.typeAssertionMessage(variableName, 'ETHAddressHex', value)); + }, + isObject(variableName: string, value: object) { + this.assert(_.isObject(value), this.typeAssertionMessage(variableName, 'object', value)); + }, + isNumber(variableName: string, value: number) { + this.assert(_.isFinite(value), this.typeAssertionMessage(variableName, 'number', value)); + }, + assert(condition: boolean, message: string) { + if (!condition) { + throw new Error(message); + } + }, + typeAssertionMessage(variableName: string, type: string, value: any) { + return `Expected ${variableName} to be of type ${type}, encountered: ${value}`; + }, +}; diff --git a/tsconfig.json b/tsconfig.json index 1c3f8eb0a..b86d0ec6e 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -11,6 +11,7 @@ }, "include": [ "./src/**/*", - "./test/**/*" + "./test/**/*", + "./node_modules/web3-typescript-typings/index.d.ts" ] } |