diff options
| -rw-r--r-- | package.json | 2 | ||||
| -rw-r--r-- | src/ts/0x.js.ts | 3 | ||||
| -rw-r--r-- | src/ts/globals.d.ts | 4 | ||||
| -rw-r--r-- | src/ts/schemas/ec_signature_schema.ts | 10 | ||||
| -rw-r--r-- | src/ts/utils/assert.ts | 11 | ||||
| -rw-r--r-- | src/ts/utils/schema_validator.ts | 13 |
6 files changed, 39 insertions, 4 deletions
diff --git a/package.json b/package.json index 275a57a93..f6740b268 100644 --- a/package.json +++ b/package.json @@ -33,6 +33,7 @@ "devDependencies": { "@types/bignumber.js": "^4.0.2", "@types/chai": "^3.5.2", + "@types/jsonschema": "^1.1.1", "@types/mocha": "^2.2.41", "@types/node": "^7.0.22", "awesome-typescript-loader": "^3.1.3", @@ -53,6 +54,7 @@ "dependencies": { "bignumber.js": "^4.0.2", "ethereumjs-util": "^5.1.1", + "jsonschema": "^1.1.1", "web3": "^0.19.0" } } diff --git a/src/ts/0x.js.ts b/src/ts/0x.js.ts index acbdd01e2..8de87e96e 100644 --- a/src/ts/0x.js.ts +++ b/src/ts/0x.js.ts @@ -1,6 +1,7 @@ import * as BigNumber from 'bignumber.js'; import * as ethUtil from 'ethereumjs-util'; import {assert} from './utils/assert'; +import {ECSignatureSchema} from './schemas/ec_signature_schema'; /** * Elliptic Curve signature @@ -18,7 +19,7 @@ export class ZeroEx { */ public static isValidSignature(data: string, signature: ECSignature, signer: ETHAddressHex): boolean { assert.isString('data', data); - assert.isObject('signature', signature); + assert.doesConformToSchema('signature', signature, ECSignatureSchema); assert.isETHAddressHex('signer', signer); const dataBuff = ethUtil.toBuffer(data); diff --git a/src/ts/globals.d.ts b/src/ts/globals.d.ts index 0f7391b39..659638a1e 100644 --- a/src/ts/globals.d.ts +++ b/src/ts/globals.d.ts @@ -2,6 +2,10 @@ declare type ETHPublicKey = string; declare type ETHAddressHex = string; declare type ETHAddressBuff = Buffer; +declare interface Schema { + id: string; +} + declare module 'ethereumjs-util' { const toBuffer: (data: string) => Buffer; const hashPersonalMessage: (msg: Buffer) => Buffer; diff --git a/src/ts/schemas/ec_signature_schema.ts b/src/ts/schemas/ec_signature_schema.ts new file mode 100644 index 000000000..e4249afc2 --- /dev/null +++ b/src/ts/schemas/ec_signature_schema.ts @@ -0,0 +1,10 @@ +export const ECSignatureSchema = { + id: '/ECSignature', + properties: { + v: {type: 'number'}, + r: {type: 'string'}, + s: {type: 'string'}, + }, + required: ['v', 'r', 's'], + type: 'object', +}; diff --git a/src/ts/utils/assert.ts b/src/ts/utils/assert.ts index a29ae922d..7fb51fbdc 100644 --- a/src/ts/utils/assert.ts +++ b/src/ts/utils/assert.ts @@ -1,6 +1,7 @@ import * as _ from 'lodash'; import * as BigNumber from 'bignumber.js'; import Web3 = require('web3'); +import {SchemaValidator} from './schema_validator'; export const assert = { isBigNumber(variableName: string, value: BigNumber.BigNumber) { @@ -14,12 +15,16 @@ export const assert = { 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)); }, + doesConformToSchema(variableName: string, value: object, schema: Schema) { + const schemaValidator = new SchemaValidator(); + const validationResult = schemaValidator.validate(value, schema); + const hasValidationErrors = validationResult.errors.length > 0; + const assertMsg = `Expected ${variableName} to conform to schema ${schema.id}, encountered: $value`; + this.assert(!hasValidationErrors, assertMsg); + }, assert(condition: boolean, message: string) { if (!condition) { throw new Error(message); diff --git a/src/ts/utils/schema_validator.ts b/src/ts/utils/schema_validator.ts new file mode 100644 index 000000000..a0d6f1bee --- /dev/null +++ b/src/ts/utils/schema_validator.ts @@ -0,0 +1,13 @@ +import {Validator as V, ValidatorResult} from 'jsonschema'; +import {ECSignatureSchema} from '../schemas/ec_signature_schema'; + +export class SchemaValidator { + private v: V; + constructor() { + this.v = new V(); + this.v.addSchema(ECSignatureSchema, ECSignatureSchema.id); + } + public validate(instance: object, schema: Schema): ValidatorResult { + return this.v.validate(instance, schema); + } +} |