aboutsummaryrefslogtreecommitdiffstats
path: root/packages/order-watcher
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2019-01-12 00:12:55 +0800
committerFabio Berger <me@fabioberger.com>2019-01-12 00:12:55 +0800
commit96ff5eef644b8c4d3f8fc4ec53270991fb51f121 (patch)
tree530f43b03d2b3aa09b5f6552d4285df92d45fed0 /packages/order-watcher
parent7f5a2c972bb86df77c423fb7029e9a629ecc1ede (diff)
parent2cf57a48dd2857dd5cf2f31f4c60dd47ae4d34a5 (diff)
downloaddexon-0x-contracts-96ff5eef644b8c4d3f8fc4ec53270991fb51f121.tar
dexon-0x-contracts-96ff5eef644b8c4d3f8fc4ec53270991fb51f121.tar.gz
dexon-0x-contracts-96ff5eef644b8c4d3f8fc4ec53270991fb51f121.tar.bz2
dexon-0x-contracts-96ff5eef644b8c4d3f8fc4ec53270991fb51f121.tar.lz
dexon-0x-contracts-96ff5eef644b8c4d3f8fc4ec53270991fb51f121.tar.xz
dexon-0x-contracts-96ff5eef644b8c4d3f8fc4ec53270991fb51f121.tar.zst
dexon-0x-contracts-96ff5eef644b8c4d3f8fc4ec53270991fb51f121.zip
merge development
Diffstat (limited to 'packages/order-watcher')
-rw-r--r--packages/order-watcher/CHANGELOG.json24
-rw-r--r--packages/order-watcher/README.md20
2 files changed, 18 insertions, 26 deletions
diff --git a/packages/order-watcher/CHANGELOG.json b/packages/order-watcher/CHANGELOG.json
index afd523f88..e98a36719 100644
--- a/packages/order-watcher/CHANGELOG.json
+++ b/packages/order-watcher/CHANGELOG.json
@@ -13,8 +13,7 @@
"version": "2.3.0",
"changes": [
{
- "note":
- "Added a WebSocket interface to OrderWatcher so that it can be used by a client written in any language",
+ "note": "Added a WebSocket interface to OrderWatcher so that it can be used by a client written in any language",
"pr": 1427
}
]
@@ -59,8 +58,7 @@
"version": "2.2.4",
"changes": [
{
- "note":
- "Fix the bug when order watcher was throwing an error on order removal when maker token was ZRX",
+ "note": "Fix the bug when order watcher was throwing an error on order removal when maker token was ZRX",
"pr": 1259
}
],
@@ -74,8 +72,7 @@
"pr": 1227
},
{
- "note":
- "Fix the bug when order watcher was trying to convert undefined to an object in case of CancelUpTo event"
+ "note": "Fix the bug when order watcher was trying to convert undefined to an object in case of CancelUpTo event"
}
],
"timestamp": 1542134075
@@ -106,8 +103,7 @@
"pr": 1118
},
{
- "note":
- "Updated to use new modularized artifacts and the latest version of @0xproject/contract-wrappers. Constructor has a new optional `contractAddresses` parameter.",
+ "note": "Updated to use new modularized artifacts and the latest version of @0xproject/contract-wrappers. Constructor has a new optional `contractAddresses` parameter.",
"pr": 1105
}
],
@@ -136,18 +132,15 @@
"version": "2.0.0",
"changes": [
{
- "note":
- "Fixes dropped events issue by fetching logs by blockHash instead of blockNumber. Support for fetching by blockHash was added in Geth > v1.8.13 and Parity > v2.1.0. Infura works too.",
+ "note": "Fixes dropped events issue by fetching logs by blockHash instead of blockNumber. Support for fetching by blockHash was added in Geth > v1.8.13 and Parity > v2.1.0. Infura works too.",
"pr": 1080
},
{
- "note":
- "Fix misunderstanding about blockstream interface callbacks and pass the raw JSON RPC responses to it",
+ "note": "Fix misunderstanding about blockstream interface callbacks and pass the raw JSON RPC responses to it",
"pr": 1080
},
{
- "note":
- "Add `transactionHash` to `OrderState` emitted by `OrderWatcher` subscriptions if the order's state change originated from a transaction.",
+ "note": "Add `transactionHash` to `OrderState` emitted by `OrderWatcher` subscriptions if the order's state change originated from a transaction.",
"pr": 1087
}
],
@@ -211,8 +204,7 @@
"version": "1.0.1-rc.4",
"changes": [
{
- "note":
- "Export types: `ExchangeContractErrs`, `OrderRelevantState`, `JSONRPCRequestPayload`, `JSONRPCErrorCallback` and `JSONRPCResponsePayload`",
+ "note": "Export types: `ExchangeContractErrs`, `OrderRelevantState`, `JSONRPCRequestPayload`, `JSONRPCErrorCallback` and `JSONRPCResponsePayload`",
"pr": 924
},
{
diff --git a/packages/order-watcher/README.md b/packages/order-watcher/README.md
index 385fe4715..a841775b6 100644
--- a/packages/order-watcher/README.md
+++ b/packages/order-watcher/README.md
@@ -36,7 +36,7 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol
**Environmental Variables**
Several environmental variables can be set to configure the server:
-* `ORDER_WATCHER_HTTP_PORT` specifies the port that the http server will listen on
+- `ORDER_WATCHER_HTTP_PORT` specifies the port that the http server will listen on
and accept connections from. When this is not set, we default to 8080.
**Requests**
@@ -58,10 +58,10 @@ wsClient = create_connection("ws://127.0.0.1:8080")
With the connection established, you prepare the payload for your request. The payload is a json object with a format established by the [JSON RPC specification](https://www.jsonrpc.org/specification):
-* `id`: All requests require you to specify a numerical `id`. When the server responds to the request, the response will have the same `id` as the one supplied with your request.
-* `jsonrpc`: This is always the string `'2.0'`.
-* `method`: This specifies the OrderWatcher method you want to call. I.e., `'ADD_ORDER'`, `'REMOVE_ORDER'` or `'GET_STATS'`.
-* `params`: These contain the parameters needed by OrderWatcher to execute the method you called. For `ADD_ORDER`, provide `{ signedOrder: <your signedOrder> }`. For `REMOVE_ORDER`, provide `{ orderHash: <your orderHash> }`. For `GET_STATS`, no parameters are needed, so you may leave this empty.
+- `id`: All requests require you to specify a numerical `id`. When the server responds to the request, the response will have the same `id` as the one supplied with your request.
+- `jsonrpc`: This is always the string `'2.0'`.
+- `method`: This specifies the OrderWatcher method you want to call. I.e., `'ADD_ORDER'`, `'REMOVE_ORDER'` or `'GET_STATS'`.
+- `params`: These contain the parameters needed by OrderWatcher to execute the method you called. For `ADD_ORDER`, provide `{ signedOrder: <your signedOrder> }`. For `REMOVE_ORDER`, provide `{ orderHash: <your orderHash> }`. For `GET_STATS`, no parameters are needed, so you may leave this empty.
Next, convert the payload to a string and send it through the connection.
In Javascript:
@@ -92,11 +92,11 @@ wsClient.send(json.dumps(remove_order_payload));
**Response**
The server responds to all requests in a similar format. In the data field, you'll find another object containing the following fields:
-* `id`: The id corresponding to the request that the server is responding to. `UPDATE` responses are not based on any requests so the `id` field is omitted`.
-* `jsonrpc`: Always `'2.0'`.
-* `method`: The method the server is responding to. Eg. `ADD_ORDER`. When order states change the server may also initiate a response. In this case, method will be listed as `UPDATE`.
-* `result`: This field varies based on the method. `UPDATE` responses contain the new order state. `GET_STATS` responses contain the current order count. When there are errors, this field is omitted.
-* `error`: When there is an error executing a request, the [JSON RPC](https://www.jsonrpc.org/specification) error object is listed here. When the server responds successfully, this field is omitted.
+- `id`: The id corresponding to the request that the server is responding to. `UPDATE` responses are not based on any requests so the `id` field is omitted`.
+- `jsonrpc`: Always `'2.0'`.
+- `method`: The method the server is responding to. Eg. `ADD_ORDER`. When order states change the server may also initiate a response. In this case, method will be listed as `UPDATE`.
+- `result`: This field varies based on the method. `UPDATE` responses contain the new order state. `GET_STATS` responses contain the current order count. When there are errors, this field is omitted.
+- `error`: When there is an error executing a request, the [JSON RPC](https://www.jsonrpc.org/specification) error object is listed here. When the server responds successfully, this field is omitted.
In Javascript, the responses can be parsed using the `onmessage` callback: