aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-12-17 08:52:37 +0800
committerFabio Berger <me@fabioberger.com>2018-12-17 08:52:37 +0800
commitee4185ab465c76b64b65efefb92e11b0ca4ecad4 (patch)
treeafbe107fe1de101ad8e804df35f3886b0fbc7276
parent7661cfc85ef9e267d15bd4d7bd06c3b6cc3f7931 (diff)
downloaddexon-sol-tools-ee4185ab465c76b64b65efefb92e11b0ca4ecad4.tar
dexon-sol-tools-ee4185ab465c76b64b65efefb92e11b0ca4ecad4.tar.gz
dexon-sol-tools-ee4185ab465c76b64b65efefb92e11b0ca4ecad4.tar.bz2
dexon-sol-tools-ee4185ab465c76b64b65efefb92e11b0ca4ecad4.tar.lz
dexon-sol-tools-ee4185ab465c76b64b65efefb92e11b0ca4ecad4.tar.xz
dexon-sol-tools-ee4185ab465c76b64b65efefb92e11b0ca4ecad4.tar.zst
dexon-sol-tools-ee4185ab465c76b64b65efefb92e11b0ca4ecad4.zip
Move OrderWatcher Websocket schemas to json-schemas and convert to JSON so that they are language agnostic
-rw-r--r--packages/json-schemas/schemas/order_watcher_web_socket_request_schema.json52
-rw-r--r--packages/json-schemas/schemas/order_watcher_web_socket_utf8_message_schema.json10
-rw-r--r--packages/json-schemas/src/schemas.ts4
-rw-r--r--packages/json-schemas/tsconfig.json2
-rw-r--r--packages/order-watcher/src/order_watcher/order_watcher_websocket_server.ts6
-rw-r--r--packages/order-watcher/src/schemas/websocket_schemas.ts61
6 files changed, 71 insertions, 64 deletions
diff --git a/packages/json-schemas/schemas/order_watcher_web_socket_request_schema.json b/packages/json-schemas/schemas/order_watcher_web_socket_request_schema.json
new file mode 100644
index 000000000..4666c6291
--- /dev/null
+++ b/packages/json-schemas/schemas/order_watcher_web_socket_request_schema.json
@@ -0,0 +1,52 @@
+{
+ "id": "/orderWatcherWebSocketRequestSchema",
+ "type": "object",
+ "definitions": {
+ "signedOrderParam": {
+ "type": "object",
+ "properties": {
+ "signedOrder": { "$ref": "/signedOrderSchema" }
+ },
+ "required": ["signedOrder"]
+ },
+ "orderHashParam": {
+ "type": "object",
+ "properties": {
+ "orderHash": { "$ref": "/hexSchema" }
+ },
+ "required": ["orderHash"]
+ }
+ },
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "id": { "type": "string" },
+ "jsonrpc": { "type": "string" },
+ "method": { "enum": ["ADD_ORDER"] },
+ "params": { "$ref": "#/definitions/signedOrderParam" }
+ },
+ "required": ["id", "jsonrpc", "method", "params"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "id": { "type": "string" },
+ "jsonrpc": { "type": "string" },
+ "method": { "enum": ["REMOVE_ORDER"] },
+ "params": { "$ref": "#/definitions/orderHashParam" }
+ },
+ "required": ["id", "jsonrpc", "method", "params"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "id": { "type": "string" },
+ "jsonrpc": { "type": "string" },
+ "method": { "enum": ["GET_STATS"] },
+ "params": {}
+ },
+ "required": ["id", "jsonrpc", "method"]
+ }
+ ]
+} \ No newline at end of file
diff --git a/packages/json-schemas/schemas/order_watcher_web_socket_utf8_message_schema.json b/packages/json-schemas/schemas/order_watcher_web_socket_utf8_message_schema.json
new file mode 100644
index 000000000..154d6d754
--- /dev/null
+++ b/packages/json-schemas/schemas/order_watcher_web_socket_utf8_message_schema.json
@@ -0,0 +1,10 @@
+{
+ "id": "/orderWatcherWebSocketUtf8MessageSchema",
+ "properties": {
+ "utf8Data": { "type": "string" }
+ },
+ "required": [
+ "utf8Data"
+ ],
+ "type": "object"
+}
diff --git a/packages/json-schemas/src/schemas.ts b/packages/json-schemas/src/schemas.ts
index 21a6f424c..050f4e625 100644
--- a/packages/json-schemas/src/schemas.ts
+++ b/packages/json-schemas/src/schemas.ts
@@ -16,6 +16,8 @@ import * as orderFillOrKillRequestsSchema from '../schemas/order_fill_or_kill_re
import * as orderFillRequestsSchema from '../schemas/order_fill_requests_schema.json';
import * as orderHashSchema from '../schemas/order_hash_schema.json';
import * as orderSchema from '../schemas/order_schema.json';
+import * as orderWatcherWebSocketRequestSchema from '../schemas/order_watcher_web_socket_request_schema.json';
+import * as orderWatcherWebSocketUtf8MessageSchema from '../schemas/order_watcher_web_socket_utf8_message_schema.json';
import * as orderBookRequestSchema from '../schemas/orderbook_request_schema.json';
import * as ordersRequestOptsSchema from '../schemas/orders_request_opts_schema.json';
import * as ordersSchema from '../schemas/orders_schema.json';
@@ -66,6 +68,8 @@ export const schemas = {
jsNumber,
requestOptsSchema,
pagedRequestOptsSchema,
+ orderWatcherWebSocketRequestSchema,
+ orderWatcherWebSocketUtf8MessageSchema,
ordersRequestOptsSchema,
orderBookRequestSchema,
orderConfigRequestSchema,
diff --git a/packages/json-schemas/tsconfig.json b/packages/json-schemas/tsconfig.json
index a79d54385..ec573290c 100644
--- a/packages/json-schemas/tsconfig.json
+++ b/packages/json-schemas/tsconfig.json
@@ -23,6 +23,8 @@
"./schemas/order_schema.json",
"./schemas/signed_order_schema.json",
"./schemas/orders_schema.json",
+ "./schemas/order_watcher_web_socket_request_schema.json",
+ "./schemas/order_watcher_web_socket_utf8_message_schema.json",
"./schemas/paginated_collection_schema.json",
"./schemas/relayer_api_asset_data_pairs_response_schema.json",
"./schemas/relayer_api_asset_data_pairs_schema.json",
diff --git a/packages/order-watcher/src/order_watcher/order_watcher_websocket_server.ts b/packages/order-watcher/src/order_watcher/order_watcher_websocket_server.ts
index eac48f849..f90961cc8 100644
--- a/packages/order-watcher/src/order_watcher/order_watcher_websocket_server.ts
+++ b/packages/order-watcher/src/order_watcher/order_watcher_websocket_server.ts
@@ -1,11 +1,11 @@
import { ContractAddresses } from '@0x/contract-addresses';
+import { schemas } from '@0x/json-schemas';
import { OrderStateInvalid, OrderStateValid, SignedOrder } from '@0x/types';
import { BigNumber, logUtils } from '@0x/utils';
import { Provider } from 'ethereum-types';
import * as http from 'http';
import * as WebSocket from 'websocket';
-import { webSocketRequestSchema, webSocketUtf8MessageSchema } from '../schemas/websocket_schemas';
import { GetStatsResult, OrderWatcherConfig, OrderWatcherMethod, WebSocketRequest, WebSocketResponse } from '../types';
import { assert } from '../utils/assert';
@@ -105,9 +105,9 @@ export class OrderWatcherWebSocketServer {
private async _onMessageCallbackAsync(connection: WebSocket.connection, message: any): Promise<void> {
let response: WebSocketResponse;
- assert.doesConformToSchema('message', message, webSocketUtf8MessageSchema);
+ assert.doesConformToSchema('message', message, schemas.orderWatcherWebSocketUtf8MessageSchema);
const request: WebSocketRequest = JSON.parse(message.utf8Data);
- assert.doesConformToSchema('request', request, webSocketRequestSchema);
+ assert.doesConformToSchema('request', request, schemas.orderWatcherWebSocketRequestSchema);
assert.isString(request.jsonrpc, JSON_RPC_VERSION);
try {
response = {
diff --git a/packages/order-watcher/src/schemas/websocket_schemas.ts b/packages/order-watcher/src/schemas/websocket_schemas.ts
index 263dd45b3..df54a38e1 100644
--- a/packages/order-watcher/src/schemas/websocket_schemas.ts
+++ b/packages/order-watcher/src/schemas/websocket_schemas.ts
@@ -1,63 +1,2 @@
// TODO: Move these schemas to the `json-schemas` package and convert to JSON
// Rename to `OrderWatcherWebSocketRequestSchema`, etc...
-export const webSocketUtf8MessageSchema = {
- id: '/webSocketUtf8MessageSchema',
- properties: {
- utf8Data: { type: 'string' },
- },
- type: 'object',
- required: ['utf8Data'],
-};
-
-export const webSocketRequestSchema = {
- id: '/webSocketRequestSchema',
- type: 'object',
- definitions: {
- signedOrderParam: {
- type: 'object',
- properties: {
- signedOrder: { $ref: '/signedOrderSchema' },
- },
- required: ['signedOrder'],
- },
- orderHashParam: {
- type: 'object',
- properties: {
- orderHash: { $ref: '/hexSchema' },
- },
- required: ['orderHash'],
- },
- },
- oneOf: [
- {
- type: 'object',
- properties: {
- id: { type: 'string' },
- jsonrpc: { type: 'string' },
- method: { enum: ['ADD_ORDER'] },
- params: { $ref: '#/definitions/signedOrderParam' },
- },
- required: ['id', 'jsonrpc', 'method', 'params'],
- },
- {
- type: 'object',
- properties: {
- id: { type: 'string' },
- jsonrpc: { type: 'string' },
- method: { enum: ['REMOVE_ORDER'] },
- params: { $ref: '#/definitions/orderHashParam' },
- },
- required: ['id', 'jsonrpc', 'method', 'params'],
- },
- {
- type: 'object',
- properties: {
- id: { type: 'string' },
- jsonrpc: { type: 'string' },
- method: { enum: ['GET_STATS'] },
- params: {},
- },
- required: ['id', 'jsonrpc', 'method'],
- },
- ],
-};