aboutsummaryrefslogtreecommitdiffstats
path: root/packages
diff options
context:
space:
mode:
Diffstat (limited to 'packages')
-rw-r--r--packages/sra-report/.npmignore5
-rw-r--r--packages/sra-report/CHANGELOG.md1
-rw-r--r--packages/sra-report/README.md53
-rw-r--r--packages/sra-report/package.json45
-rw-r--r--packages/sra-report/postman_configs/collections/sra_report.postman_collection.json937
-rw-r--r--packages/sra-report/postman_configs/environments/kovan_tokens.postman_environment.json34
-rw-r--r--packages/sra-report/postman_configs/environments/mainnet_tokens.postman_environment.json34
-rw-r--r--packages/sra-report/scripts/postpublish.js5
-rw-r--r--packages/sra-report/src/globals.d.ts6
-rw-r--r--packages/sra-report/src/index.ts86
-rw-r--r--packages/sra-report/src/postman_environment_factory.ts74
-rw-r--r--packages/sra-report/src/utils.ts5
-rw-r--r--packages/sra-report/tsconfig.json7
-rw-r--r--packages/sra-report/tslint.json3
14 files changed, 1295 insertions, 0 deletions
diff --git a/packages/sra-report/.npmignore b/packages/sra-report/.npmignore
new file mode 100644
index 000000000..87bc30436
--- /dev/null
+++ b/packages/sra-report/.npmignore
@@ -0,0 +1,5 @@
+.*
+yarn-error.log
+/src/
+/scripts/
+tsconfig.json
diff --git a/packages/sra-report/CHANGELOG.md b/packages/sra-report/CHANGELOG.md
new file mode 100644
index 000000000..a0cf709bc
--- /dev/null
+++ b/packages/sra-report/CHANGELOG.md
@@ -0,0 +1 @@
+# CHANGELOG
diff --git a/packages/sra-report/README.md b/packages/sra-report/README.md
new file mode 100644
index 000000000..49609aeb2
--- /dev/null
+++ b/packages/sra-report/README.md
@@ -0,0 +1,53 @@
+# SRA Report
+
+This package allows you to generate reports detailing an endpoint's [standard relayer API HTTP specification](https://github.com/0xProject/standard-relayer-api/blob/master/http/v0.md) compliance.
+
+## Installation
+
+`yarn add -g @0xproject/sra-report`
+
+## Usage
+
+```
+sra-report
+Options:
+ --help Show help [boolean]
+ --version Show version number [boolean]
+ --url, -u API endpoint to test for standard relayer API compliance
+ [string] [required]
+ --output, -o, --out Folder where to write the reports [string]
+ --network-id, -n ID of the network that the API is serving orders from
+ [number] [default: 1]
+```
+
+## Contributing
+
+We strongly encourage that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
+
+Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
+
+### Install Dependencies
+
+If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
+
+```bash
+yarn config set workspaces-experimental true
+```
+
+Then install dependencies
+
+```bash
+yarn install
+```
+
+### Build
+
+```bash
+yarn build
+```
+
+### Lint
+
+```bash
+yarn lint
+```
diff --git a/packages/sra-report/package.json b/packages/sra-report/package.json
new file mode 100644
index 000000000..6168c128e
--- /dev/null
+++ b/packages/sra-report/package.json
@@ -0,0 +1,45 @@
+{
+ "name": "@0xproject/sra-report",
+ "version": "0.0.1",
+ "description": "Generate reports for standard relayer API compliance",
+ "main": "lib/index.js",
+ "types": "lib/index.d.ts",
+ "scripts": {
+ "build:watch": "tsc -w",
+ "lint": "tslint --project . 'src/**/*.ts'",
+ "clean": "shx rm -rf lib",
+ "build": "tsc"
+ },
+ "bin": {
+ "sra-report": "lib/index.js"
+ },
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/0xProject/0x.js.git"
+ },
+ "license": "Apache-2.0",
+ "bugs": {
+ "url": "https://github.com/0xProject/0x.js/issues"
+ },
+ "homepage": "https://github.com/0xProject/0x.js/packages/abi-gen/README.md",
+ "dependencies": {
+ "0x.js": "^0.32.4",
+ "@0xproject/assert": "^0.0.20",
+ "@0xproject/connect": "^0.6.1",
+ "@0xproject/json-schemas": "^0.7.12",
+ "@0xproject/utils": "^0.3.4",
+ "chalk": "^2.3.0",
+ "lodash": "^4.17.4",
+ "newman": "^3.9.3",
+ "yargs": "^10.0.3"
+ },
+ "devDependencies": {
+ "@0xproject/tslint-config": "^0.4.9",
+ "@types/lodash": "^4.14.86",
+ "@types/node": "^8.0.53",
+ "@types/yargs": "^10.0.0",
+ "shx": "^0.2.2",
+ "tslint": "5.8.0",
+ "typescript": "2.7.1"
+ }
+}
diff --git a/packages/sra-report/postman_configs/collections/sra_report.postman_collection.json b/packages/sra-report/postman_configs/collections/sra_report.postman_collection.json
new file mode 100644
index 000000000..569596576
--- /dev/null
+++ b/packages/sra-report/postman_configs/collections/sra_report.postman_collection.json
@@ -0,0 +1,937 @@
+{
+ "info": {
+ "name": "sra_report",
+ "_postman_id": "d5828163-ddb9-46a9-ec39-c2b81417b6c0",
+ "description":
+ "[Standard Relayer API](\nhttps://github.com/0xProject/standard-relayer-api)\n\n\n0x Protocol is an open standard. Because of this, we expect many independent applications to be built that will want to use the protocol. In order to make it easier for anyone to source liquidity that conforms to the 0x order format, relayers can opt-in to implementing a set of standard relayer API endpoints. In doing so, they allow clients of the standard relayer API to access the orders on their orderbook.",
+ "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+ },
+ "item": [
+ {
+ "name": "GET /token_pairs",
+ "description": "",
+ "item": [
+ {
+ "name": "default request",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "42cb5e3f-6013-4a7c-b341-0d10cb3f2c9c",
+ "type": "text/javascript",
+ "exec": [""]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/token_pairs",
+ "host": ["{{url}}"],
+ "path": ["token_pairs"]
+ },
+ "description": ""
+ },
+ "response": []
+ },
+ {
+ "name": "tokenA param",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "53ad6be0-4196-47a1-bbf5-fa96e3c5d47e",
+ "type": "text/javascript",
+ "exec": [
+ "const filterTokenEnvKey = 'WETH_address';",
+ "const filterTokenAddress = pm.environment.get(filterTokenEnvKey);",
+ "const responseJsonData = pm.response.json();",
+ "pm.test('Token pairs are properly filtered', function() {",
+ " _.forEach(responseJsonData, function(tokenPair) {",
+ " const tokenAIsFilterToken = _.get(tokenPair, 'tokenA') === filterTokenAddress;",
+ " const tokenBIsFilterToken = _.get(tokenPair, 'tokenB') === filterTokenAddress;",
+ " const condition = tokenAIsFilterToken || tokenBIsFilterToken",
+ " pm.expect(condition).to.be.true;",
+ " });",
+ "});",
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/token_pairs?tokenA={{WETH_address}}",
+ "host": ["{{url}}"],
+ "path": ["token_pairs"],
+ "query": [
+ {
+ "key": "tokenA",
+ "value": "{{WETH_address}}",
+ "equals": true
+ }
+ ]
+ },
+ "description": ""
+ },
+ "response": []
+ },
+ {
+ "name": "tokenB param",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "7224b56e-0000-4d77-b355-f9bfd7d6320f",
+ "type": "text/javascript",
+ "exec": [
+ "const filterTokenEnvKey = 'WETH_address';",
+ "const filterTokenAddress = pm.environment.get(filterTokenEnvKey);",
+ "const responseJsonData = pm.response.json();",
+ "pm.test('Token pairs are properly filtered', function() {",
+ " _.forEach(responseJsonData, function(tokenPair) {",
+ " const tokenAIsFilterToken = _.get(tokenPair, 'tokenA') === filterTokenAddress;",
+ " const tokenBIsFilterToken = _.get(tokenPair, 'tokenB') === filterTokenAddress;",
+ " const condition = tokenAIsFilterToken || tokenBIsFilterToken",
+ " pm.expect(condition).to.be.true;",
+ " });",
+ "});",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/token_pairs?tokenB={{WETH_address}}",
+ "host": ["{{url}}"],
+ "path": ["token_pairs"],
+ "query": [
+ {
+ "key": "tokenB",
+ "value": "{{WETH_address}}",
+ "equals": true
+ }
+ ]
+ },
+ "description": ""
+ },
+ "response": []
+ },
+ {
+ "name": "tokenA and tokenB params",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "32a19952-90c7-4f11-b95c-815b0746ef8b",
+ "type": "text/javascript",
+ "exec": [
+ "const filterTokenAEnvKey = 'WETH_address';",
+ "const filterTokenBEnvKey = 'ZRX_address';",
+ "const filterTokenAAddress = pm.environment.get(filterTokenAEnvKey);",
+ "const filterTokenBAddress = pm.environment.get(filterTokenBEnvKey);",
+ "const responseJsonData = pm.response.json();",
+ "pm.test('Token pairs are properly filtered', function() {",
+ " _.forEach(responseJsonData, function(tokenPair) {",
+ " const tokenAIsFilterTokenA = _.get(tokenPair, 'tokenA') === filterTokenAAddress;",
+ " const tokenAIsFilterTokenB = _.get(tokenPair, 'tokenA') === filterTokenBAddress;",
+ " const tokenBIsFilterTokenA = _.get(tokenPair, 'tokenB') === filterTokenAAddress;",
+ " const tokenBIsFilterTokenB = _.get(tokenPair, 'tokenB') === filterTokenBAddress;",
+ " const condition = (tokenAIsFilterTokenA && tokenBIsFilterTokenB) || (tokenBIsFilterTokenA && tokenAIsFilterTokenB)",
+ " pm.expect(condition).to.be.true;",
+ " });",
+ "});",
+ ""
+ ]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/token_pairs?tokenA={{WETH_address}}&tokenB={{ZRX_address}}",
+ "host": ["{{url}}"],
+ "path": ["token_pairs"],
+ "query": [
+ {
+ "key": "tokenA",
+ "value": "{{WETH_address}}",
+ "equals": true
+ },
+ {
+ "key": "tokenB",
+ "value": "{{ZRX_address}}",
+ "equals": true
+ }
+ ]
+ },
+ "description": ""
+ },
+ "response": []
+ }
+ ],
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "id": "3d032e92-6a17-49f0-8115-bae1c7298b55",
+ "type": "text/javascript",
+ "exec": [""]
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "id": "25addb38-bd1c-4eb3-a193-5617119dc0d6",
+ "type": "text/javascript",
+ "exec": [
+ "const schema = tv4.getSchema('/RelayerApiTokenPairsResponse');",
+ "const responseJsonData = pm.response.json();",
+ "",
+ "pm.test('Schema is valid', function() {",
+ " pm.expect(tv4.validate(responseJsonData, schema)).to.be.true;",
+ "});",
+ ""
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "name": "GET /orders",
+ "description": "",
+ "item": [
+ {
+ "name": "default request",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "118f47dd-1d93-4288-841f-de88783eff3b",
+ "type": "text/javascript",
+ "exec": [""]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/orders",
+ "host": ["{{url}}"],
+ "path": ["orders"]
+ },
+ "description":
+ "Retrieves a list of orders given query parameters. For querying an entire orderbook snapshot, the orderbook endpoint is recommended.\n\nParameters\n * exchangeContractAddress [string]: returns orders created for this exchange address\n * tokenAddress [string]: returns orders where makerTokenAddress or takerTokenAddress is token address\n * makerTokenAddress [string]: returns orders with specified makerTokenAddress\n * takerTokenAddress [string]: returns orders with specified makerTokenAddress\n * maker [string]: returns orders where maker is maker address\n * taker [string]: returns orders where taker is taker address\n * trader [string]: returns orders where maker or taker is trader address\n * feeRecipient [string]: returns orders where feeRecipient is feeRecipient address\n\nAll parameters are optional."
+ },
+ "response": []
+ },
+ {
+ "name": "exchangeContract param",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "f10e0a91-3401-4023-afef-5bff93a25232",
+ "type": "text/javascript",
+ "exec": [
+ "const exchangeContractEnvKey = 'EXCHANGE_CONTRACT_address';",
+ "const requestedExchangeContractAddress = pm.environment.get(exchangeContractEnvKey);",
+ "const responseJsonData = pm.response.json();",
+ "pm.test('Orders are properly filtered', function() {",
+ " _.forEach(responseJsonData, function(order) {",
+ " const returnedExchangeContractAddress = _.get(order, 'exchangeContractAddress');",
+ " pm.expect(requestedExchangeContractAddress).to.equal(returnedExchangeContractAddress);",
+ " });",
+ "});",
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/orders?exchangeContractAddress={{EXCHANGE_CONTRACT_address}}",
+ "host": ["{{url}}"],
+ "path": ["orders"],
+ "query": [
+ {
+ "key": "exchangeContractAddress",
+ "value": "{{EXCHANGE_CONTRACT_address}}",
+ "equals": true
+ }
+ ]
+ },
+ "description":
+ "Retrieves a list of orders given query parameters. For querying an entire orderbook snapshot, the orderbook endpoint is recommended.\n\nParameters\n * exchangeContractAddress [string]: returns orders created for this exchange address\n * tokenAddress [string]: returns orders where makerTokenAddress or takerTokenAddress is token address\n * makerTokenAddress [string]: returns orders with specified makerTokenAddress\n * takerTokenAddress [string]: returns orders with specified makerTokenAddress\n * maker [string]: returns orders where maker is maker address\n * taker [string]: returns orders where taker is taker address\n * trader [string]: returns orders where maker or taker is trader address\n * feeRecipient [string]: returns orders where feeRecipient is feeRecipient address\n\nAll parameters are optional."
+ },
+ "response": []
+ },
+ {
+ "name": "tokenAddress param",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "d915624e-9d71-4499-a133-cc8268199895",
+ "type": "text/javascript",
+ "exec": [
+ "const filterTokenEnvKey = 'ZRX_address';",
+ "const filterTokenAddress = pm.environment.get(filterTokenEnvKey);",
+ "const responseJsonData = pm.response.json();",
+ "pm.test('Orders are properly filtered', function() {",
+ " _.forEach(responseJsonData, function(order) {",
+ " const makerTokenAddress = _.get(order, 'makerTokenAddress');",
+ " const takerTokenAddress = _.get(order, 'takerTokenAddress');",
+ " const makerTokenAddressIsFilterToken = makerTokenAddress === filterTokenAddress;",
+ " const takerTokenAddressIsFilterToken = takerTokenAddress === filterTokenAddress;",
+ " const condition = makerTokenAddressIsFilterToken || takerTokenAddressIsFilterToken;",
+ " pm.expect(condition).to.be.true;",
+ " });",
+ "});",
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/orders?tokenAddress={{ZRX_address}}",
+ "host": ["{{url}}"],
+ "path": ["orders"],
+ "query": [
+ {
+ "key": "tokenAddress",
+ "value": "{{ZRX_address}}",
+ "equals": true
+ }
+ ]
+ },
+ "description":
+ "Retrieves a list of orders given query parameters. For querying an entire orderbook snapshot, the orderbook endpoint is recommended.\n\nParameters\n * exchangeContractAddress [string]: returns orders created for this exchange address\n * tokenAddress [string]: returns orders where makerTokenAddress or takerTokenAddress is token address\n * makerTokenAddress [string]: returns orders with specified makerTokenAddress\n * takerTokenAddress [string]: returns orders with specified makerTokenAddress\n * maker [string]: returns orders where maker is maker address\n * taker [string]: returns orders where taker is taker address\n * trader [string]: returns orders where maker or taker is trader address\n * feeRecipient [string]: returns orders where feeRecipient is feeRecipient address\n\nAll parameters are optional."
+ },
+ "response": []
+ },
+ {
+ "name": "makerTokenAddress param",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "5599a829-b127-4b21-8690-12cc764972a9",
+ "type": "text/javascript",
+ "exec": [
+ "const filterTokenEnvKey = 'ZRX_address';",
+ "const filterTokenAddress = pm.environment.get(filterTokenEnvKey);",
+ "const responseJsonData = pm.response.json();",
+ "pm.test('Orders are properly filtered', function() {",
+ " _.forEach(responseJsonData, function(order) {",
+ " const makerTokenAddress = _.get(order, 'makerTokenAddress');",
+ " pm.expect(makerTokenAddress).to.be.equal(filterTokenAddress);",
+ " });",
+ "});",
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/orders?makerTokenAddress={{ZRX_address}}",
+ "host": ["{{url}}"],
+ "path": ["orders"],
+ "query": [
+ {
+ "key": "makerTokenAddress",
+ "value": "{{ZRX_address}}",
+ "equals": true
+ }
+ ]
+ },
+ "description":
+ "Retrieves a list of orders given query parameters. For querying an entire orderbook snapshot, the orderbook endpoint is recommended.\n\nParameters\n * exchangeContractAddress [string]: returns orders created for this exchange address\n * tokenAddress [string]: returns orders where makerTokenAddress or takerTokenAddress is token address\n * makerTokenAddress [string]: returns orders with specified makerTokenAddress\n * takerTokenAddress [string]: returns orders with specified makerTokenAddress\n * maker [string]: returns orders where maker is maker address\n * taker [string]: returns orders where taker is taker address\n * trader [string]: returns orders where maker or taker is trader address\n * feeRecipient [string]: returns orders where feeRecipient is feeRecipient address\n\nAll parameters are optional."
+ },
+ "response": []
+ },
+ {
+ "name": "takerTokenAddress param",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "d5ac5604-b13b-40c2-ba31-3033f52136a2",
+ "type": "text/javascript",
+ "exec": [
+ "const filterTokenEnvKey = 'ZRX_address';",
+ "const filterTokenAddress = pm.environment.get(filterTokenEnvKey);",
+ "const responseJsonData = pm.response.json();",
+ "pm.test('Orders are properly filtered', function() {",
+ " _.forEach(responseJsonData, function(order) {",
+ " const takerTokenAddress = _.get(order, 'takerTokenAddress');",
+ " pm.expect(takerTokenAddress).to.be.equal(filterTokenAddress);",
+ " });",
+ "});",
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/orders?takerTokenAddress={{ZRX_address}}",
+ "host": ["{{url}}"],
+ "path": ["orders"],
+ "query": [
+ {
+ "key": "takerTokenAddress",
+ "value": "{{ZRX_address}}",
+ "equals": true
+ }
+ ]
+ },
+ "description":
+ "Retrieves a list of orders given query parameters. For querying an entire orderbook snapshot, the orderbook endpoint is recommended.\n\nParameters\n * exchangeContractAddress [string]: returns orders created for this exchange address\n * tokenAddress [string]: returns orders where makerTokenAddress or takerTokenAddress is token address\n * makerTokenAddress [string]: returns orders with specified makerTokenAddress\n * takerTokenAddress [string]: returns orders with specified makerTokenAddress\n * maker [string]: returns orders where maker is maker address\n * taker [string]: returns orders where taker is taker address\n * trader [string]: returns orders where maker or taker is trader address\n * feeRecipient [string]: returns orders where feeRecipient is feeRecipient address\n\nAll parameters are optional."
+ },
+ "response": []
+ },
+ {
+ "name": "maker param",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "efc85eb8-7791-4b14-9dee-c5e80adec4b8",
+ "type": "text/javascript",
+ "exec": [
+ "const orderMakerEnvKey = 'orderMaker';",
+ "const referenceOrderMakerAddress = pm.globals.get(orderMakerEnvKey);",
+ "const responseJsonData = pm.response.json();",
+ "pm.test('Orders are properly filtered', function() {",
+ " _.forEach(responseJsonData, function(order) {",
+ " const returnedMakerAddress = _.get(order, 'maker');",
+ " pm.expect(referenceOrderMakerAddress).to.be.equal(returnedMakerAddress);",
+ " });",
+ "});",
+ ""
+ ]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/orders?maker={{orderMaker}}",
+ "host": ["{{url}}"],
+ "path": ["orders"],
+ "query": [
+ {
+ "key": "maker",
+ "value": "{{orderMaker}}",
+ "equals": true
+ }
+ ]
+ },
+ "description":
+ "Retrieves a list of orders given query parameters. For querying an entire orderbook snapshot, the orderbook endpoint is recommended.\n\nParameters\n * exchangeContractAddress [string]: returns orders created for this exchange address\n * tokenAddress [string]: returns orders where makerTokenAddress or takerTokenAddress is token address\n * makerTokenAddress [string]: returns orders with specified makerTokenAddress\n * takerTokenAddress [string]: returns orders with specified makerTokenAddress\n * maker [string]: returns orders where maker is maker address\n * taker [string]: returns orders where taker is taker address\n * trader [string]: returns orders where maker or taker is trader address\n * feeRecipient [string]: returns orders where feeRecipient is feeRecipient address\n\nAll parameters are optional."
+ },
+ "response": []
+ },
+ {
+ "name": "taker param",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "a299a290-58b9-434c-b5e8-98ef9e5f70da",
+ "type": "text/javascript",
+ "exec": [
+ "const orderTakerEnvKey = 'orderTaker';",
+ "const referenceOrderTakerAddress = pm.globals.get(orderTakerEnvKey);",
+ "const responseJsonData = pm.response.json();",
+ "pm.test('Orders are properly filtered', function() {",
+ " _.forEach(responseJsonData, function(order) {",
+ " const returnedTakerAddress = _.get(order, 'taker');",
+ " pm.expect(referenceOrderTakerAddress).to.be.equal(returnedTakerAddress);",
+ " });",
+ "});",
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/orders?taker={{orderTaker}}",
+ "host": ["{{url}}"],
+ "path": ["orders"],
+ "query": [
+ {
+ "key": "taker",
+ "value": "{{orderTaker}}",
+ "equals": true
+ }
+ ]
+ },
+ "description":
+ "Retrieves a list of orders given query parameters. For querying an entire orderbook snapshot, the orderbook endpoint is recommended.\n\nParameters\n * exchangeContractAddress [string]: returns orders created for this exchange address\n * tokenAddress [string]: returns orders where makerTokenAddress or takerTokenAddress is token address\n * makerTokenAddress [string]: returns orders with specified makerTokenAddress\n * takerTokenAddress [string]: returns orders with specified makerTokenAddress\n * maker [string]: returns orders where maker is maker address\n * taker [string]: returns orders where taker is taker address\n * trader [string]: returns orders where maker or taker is trader address\n * feeRecipient [string]: returns orders where feeRecipient is feeRecipient address\n\nAll parameters are optional."
+ },
+ "response": []
+ },
+ {
+ "name": "trader param",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "e80aa474-3352-45dd-87ef-2980bab961fb",
+ "type": "text/javascript",
+ "exec": [
+ "const orderTraderEnvKey = 'orderMaker';",
+ "const referenceOrderTraderAddress = pm.globals.get(orderTraderEnvKey);",
+ "const responseJsonData = pm.response.json();",
+ "pm.test('Orders are properly filtered', function() {",
+ " _.forEach(responseJsonData, function(order) {",
+ " const returnedMakerAddress = _.get(order, 'maker');",
+ " const returnedTakerAddress = _.get(order, 'taker');",
+ " const condition = (referenceOrderTraderAddress === returnedMakerAddress) || (referenceOrderTraderAddress === returnedTakerAddress);",
+ " pm.expect(condition).to.be.true;",
+ " });",
+ "});",
+ "",
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/orders?trader={{orderMaker}}",
+ "host": ["{{url}}"],
+ "path": ["orders"],
+ "query": [
+ {
+ "key": "trader",
+ "value": "{{orderMaker}}",
+ "equals": true
+ }
+ ]
+ },
+ "description":
+ "Retrieves a list of orders given query parameters. For querying an entire orderbook snapshot, the orderbook endpoint is recommended.\n\nParameters\n * exchangeContractAddress [string]: returns orders created for this exchange address\n * tokenAddress [string]: returns orders where makerTokenAddress or takerTokenAddress is token address\n * makerTokenAddress [string]: returns orders with specified makerTokenAddress\n * takerTokenAddress [string]: returns orders with specified makerTokenAddress\n * maker [string]: returns orders where maker is maker address\n * taker [string]: returns orders where taker is taker address\n * trader [string]: returns orders where maker or taker is trader address\n * feeRecipient [string]: returns orders where feeRecipient is feeRecipient address\n\nAll parameters are optional."
+ },
+ "response": []
+ },
+ {
+ "name": "feeRecipient param",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "fb34198e-221b-406d-8da4-4e7eed400cbe",
+ "type": "text/javascript",
+ "exec": [
+ "const orderFeeRecipientEnvKey = 'orderFeeRecipient';",
+ "const referenceOrderFeeRecipientAddress = pm.globals.get(orderFeeRecipientEnvKey);",
+ "const responseJsonData = pm.response.json();",
+ "pm.test('Orders are properly filtered', function() {",
+ " _.forEach(responseJsonData, function(order) {",
+ " const returnedFeeRecipientAddress = _.get(order, 'feeRecipient');",
+ " pm.expect(referenceOrderFeeRecipientAddress).to.be.equal(returnedFeeRecipientAddress);",
+ " });",
+ "});",
+ "",
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/orders?feeRecipient={{orderFeeRecipient}}",
+ "host": ["{{url}}"],
+ "path": ["orders"],
+ "query": [
+ {
+ "key": "feeRecipient",
+ "value": "{{orderFeeRecipient}}",
+ "equals": true
+ }
+ ]
+ },
+ "description":
+ "Retrieves a list of orders given query parameters. For querying an entire orderbook snapshot, the orderbook endpoint is recommended.\n\nParameters\n * exchangeContractAddress [string]: returns orders created for this exchange address\n * tokenAddress [string]: returns orders where makerTokenAddress or takerTokenAddress is token address\n * makerTokenAddress [string]: returns orders with specified makerTokenAddress\n * takerTokenAddress [string]: returns orders with specified makerTokenAddress\n * maker [string]: returns orders where maker is maker address\n * taker [string]: returns orders where taker is taker address\n * trader [string]: returns orders where maker or taker is trader address\n * feeRecipient [string]: returns orders where feeRecipient is feeRecipient address\n\nAll parameters are optional."
+ },
+ "response": []
+ }
+ ],
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "id": "4eafcc26-fb01-4182-b963-67a0b418fcbc",
+ "type": "text/javascript",
+ "exec": [""]
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "id": "d28effd1-4a73-4ee8-82cc-21b1ab06928d",
+ "type": "text/javascript",
+ "exec": [
+ "const schema = tv4.getSchema('/signedOrdersSchema');",
+ "const responseJsonData = pm.response.json();",
+ "",
+ "pm.test('Schema is valid', function() {",
+ " pm.expect(tv4.validate(responseJsonData, schema)).to.be.true;",
+ "});",
+ ""
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "name": "GET /order",
+ "description": "",
+ "item": [
+ {
+ "name": "orderHash param",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "e847f317-6346-4ee5-bd94-7554eb3073b3",
+ "type": "text/javascript",
+ "exec": [
+ "const orderEnvKey = 'order';",
+ "const referenceOrderString = pm.globals.get(orderEnvKey);",
+ "const referenceOrderJson = JSON.parse(referenceOrderString);",
+ "const orderPropertyNames = [",
+ " 'maker',",
+ " 'taker',",
+ " 'makerFee',",
+ " 'takerFee',",
+ " 'makerTokenAmount',",
+ " 'takerTokenAmount',",
+ " 'makerTokenAddress',",
+ " 'takerTokenAddress',",
+ " 'salt',",
+ " 'feeRecipient',",
+ " 'expirationUnixTimestampSec',",
+ " 'exchangeContractAddress'",
+ "];",
+ "const signaturePropertyNames = [",
+ " 'v',",
+ " 'r',",
+ " 's'",
+ "];",
+ "const returnedOrderJson = pm.response.json();",
+ "pm.test('Order is properly retreived', function() {",
+ " _.forEach(orderPropertyNames, function(propertyName) {",
+ " const returnedProperty = _.get(returnedOrderJson, propertyName);",
+ " const referenceProperty = _.get(referenceOrderJson, propertyName);",
+ " pm.expect(returnedProperty).to.be.equal(referenceProperty);",
+ " });",
+ " const returnedSignature = _.get(returnedOrderJson, 'ecSignature');",
+ " const referenceSignature = _.get(returnedOrderJson, 'ecSignature');",
+ " _.forEach(signaturePropertyNames, function(propertyName) {",
+ " const returnedSignatureProperty = _.get(returnedSignature, propertyName);",
+ " const referenceSignatureProperty = _.get(referenceSignature, propertyName);",
+ " pm.expect(returnedSignatureProperty).to.be.equal(referenceSignatureProperty);",
+ " });",
+ "});",
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw": "{{url}}/order/{{orderHash}}",
+ "host": ["{{url}}"],
+ "path": ["order", "{{orderHash}}"]
+ },
+ "description": "Retrieves a specific order by orderHash."
+ },
+ "response": []
+ }
+ ],
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "id": "e356d2ff-d105-42c1-b679-d9d917dcd68d",
+ "type": "text/javascript",
+ "exec": [""]
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "id": "8d2d4717-6f76-47ab-8e5a-f383192f6ee4",
+ "type": "text/javascript",
+ "exec": [
+ "const schema = tv4.getSchema('/SignedOrder');",
+ "const responseJsonData = pm.response.json();",
+ "",
+ "pm.test('Schema is valid', function() {",
+ " pm.expect(tv4.validate(responseJsonData, schema)).to.be.true;",
+ "});",
+ ""
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "name": "GET /orderbook",
+ "description": "",
+ "item": [
+ {
+ "name": "baseTokenAddress and quoteTokenAddress params",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "67d95152-3561-4db2-aaba-d26ceb44b4fd",
+ "type": "text/javascript",
+ "exec": [
+ "const baseTokenEnvKey = 'ZRX_address';",
+ "const quoteTokenEnvKey = 'WETH_address';",
+ "const baseTokenAddress = pm.environment.get(baseTokenEnvKey);",
+ "const quoteTokenAddress = pm.environment.get(quoteTokenEnvKey);",
+ "const responseJsonData = pm.response.json();",
+ "pm.test('Orderbook is properly filtered', function() {",
+ " const bids = _.get(responseJsonData, 'bids');",
+ " const asks = _.get(responseJsonData, 'asks');",
+ " _.forEach(bids, function(order) {",
+ " const makerTokenAddress = _.get(order, 'makerTokenAddress');",
+ " const takerTokenAddress = _.get(order, 'takerTokenAddress');",
+ " pm.expect(makerTokenAddress).to.be.equal(quoteTokenAddress);",
+ " pm.expect(takerTokenAddress).to.be.equal(baseTokenAddress);",
+ " });",
+ " _.forEach(asks, function(order) {",
+ " const makerTokenAddress = _.get(order, 'makerTokenAddress');",
+ " const takerTokenAddress = _.get(order, 'takerTokenAddress');",
+ " pm.expect(makerTokenAddress).to.be.equal(baseTokenAddress);",
+ " pm.expect(takerTokenAddress).to.be.equal(quoteTokenAddress);",
+ " });",
+ "});",
+ "",
+ "",
+ "",
+ ""
+ ]
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "body": {},
+ "url": {
+ "raw":
+ "{{url}}/orderbook?baseTokenAddress={{ZRX_address}}&quoteTokenAddress={{WETH_address}}",
+ "host": ["{{url}}"],
+ "path": ["orderbook"],
+ "query": [
+ {
+ "key": "baseTokenAddress",
+ "value": "{{ZRX_address}}",
+ "equals": true
+ },
+ {
+ "key": "quoteTokenAddress",
+ "value": "{{WETH_address}}",
+ "equals": true
+ }
+ ]
+ },
+ "description":
+ "Retrieves a list of orders given query parameters. For querying an entire orderbook snapshot, the orderbook endpoint is recommended.\n\nParameters\n * exchangeContractAddress [string]: returns orders created for this exchange address\n * tokenAddress [string]: returns orders where makerTokenAddress or takerTokenAddress is token address\n * makerTokenAddress [string]: returns orders with specified makerTokenAddress\n * takerTokenAddress [string]: returns orders with specified makerTokenAddress\n * maker [string]: returns orders where maker is maker address\n * taker [string]: returns orders where taker is taker address\n * trader [string]: returns orders where maker or taker is trader address\n * feeRecipient [string]: returns orders where feeRecipient is feeRecipient address\n\nAll parameters are optional."
+ },
+ "response": []
+ }
+ ],
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "id": "bdf90dbc-9217-4089-8bc0-351baadddd3e",
+ "type": "text/javascript",
+ "exec": [""]
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "id": "d5080a34-57c4-4d5d-8e01-5e79599282ec",
+ "type": "text/javascript",
+ "exec": [
+ "const schema = tv4.getSchema('/RelayerApiOrderBookResponse');",
+ "const responseJsonData = pm.response.json();",
+ "",
+ "pm.test('Schema is valid', function() {",
+ " pm.expect(tv4.validate(responseJsonData, schema)).to.be.true;",
+ "});",
+ ""
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "name": "POST /fees",
+ "description": "",
+ "item": [
+ {
+ "name": "default request",
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw":
+ "{\n \"exchangeContractAddress\": \"0x12459c951127e0c374ff9105dda097662a027093\",\n \"maker\": \"0x9e56625509c2f60af937f23b7b532600390e8c8b\",\n \"taker\": \"0x0000000000000000000000000000000000000000\",\n \"makerTokenAddress\": \"0x323b5d4c32345ced77393b3530b1eed0f346429d\",\n \"takerTokenAddress\": \"0xef7fff64389b814a946f3e92105513705ca6b990\",\n \"makerTokenAmount\": \"10000000000000000\",\n \"takerTokenAmount\": \"20000000000000000\",\n \"expirationUnixTimestampSec\": \"42\",\n \"salt\": \"67006738228878699843088602623665307406148487219438534730168799356281242528500\"\n}"
+ },
+ "url": {
+ "raw": "{{url}}/fees",
+ "host": ["{{url}}"],
+ "path": ["fees"]
+ },
+ "description":
+ "Given an unsigned order without the fee-related properties, returns the required feeRecipient, makerFee, and takerFee of that order."
+ },
+ "response": []
+ }
+ ],
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "id": "75d66506-0fa9-4b0e-982b-ef53bf3310f8",
+ "type": "text/javascript",
+ "exec": [""]
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "id": "4c5f9f7b-8635-4bdb-9240-a74754a2de4f",
+ "type": "text/javascript",
+ "exec": [
+ "const schema = tv4.getSchema('/RelayerApiFeesResponse');",
+ "const responseJsonData = pm.response.json();",
+ "",
+ "pm.test('Schema is valid', function() {",
+ " pm.expect(tv4.validate(responseJsonData, schema)).to.be.true;",
+ "});",
+ ""
+ ]
+ }
+ }
+ ]
+ }
+ ],
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "id": "da60f639-df79-4f4d-9861-79219f5fc341",
+ "type": "text/javascript",
+ "exec": [
+ "const schemaKeysString = pm.globals.get('schemaKeys');",
+ "const schemaKeys = JSON.parse(schemaKeysString);",
+ "_.forEach(schemaKeys, function(schemaKey) {",
+ " const schemaString = pm.globals.get(schemaKey);",
+ " const schema = JSON.parse(schemaString);",
+ " tv4.addSchema(schema);",
+ "});",
+ ""
+ ]
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "id": "b4917e72-ac87-421d-b7a5-21b64285ba5b",
+ "type": "text/javascript",
+ "exec": [
+ "pm.test('Has Content-Type header with value application/json', function () {",
+ " pm.response.to.have.header('Content-Type');",
+ " const contentType = postman.getResponseHeader('Content-Type');",
+ " pm.expect(contentType).to.include('application/json');",
+ "});",
+ ""
+ ]
+ }
+ }
+ ]
+}
diff --git a/packages/sra-report/postman_configs/environments/kovan_tokens.postman_environment.json b/packages/sra-report/postman_configs/environments/kovan_tokens.postman_environment.json
new file mode 100644
index 000000000..480c1231b
--- /dev/null
+++ b/packages/sra-report/postman_configs/environments/kovan_tokens.postman_environment.json
@@ -0,0 +1,34 @@
+{
+ "id": "8dab7221-c8b8-2931-92c8-605f6f4072e1",
+ "name": "Kovan Tokens",
+ "values": [
+ {
+ "enabled": true,
+ "key": "DAI_address",
+ "value": "0xb18845c260f680d5b9d84649638813e342e4f8c9",
+ "type": "text"
+ },
+ {
+ "enabled": true,
+ "key": "WETH_address",
+ "value": "0xd0a1e359811322d97991e03f863a0c30c2cf029c",
+ "type": "text"
+ },
+ {
+ "enabled": true,
+ "key": "ZRX_address",
+ "value": "0x6ff6c0ff1d68b964901f986d4c9fa3ac68346570",
+ "type": "text"
+ },
+ {
+ "enabled": true,
+ "key": "EXCHANGE_CONTRACT_address",
+ "value": "0x90fe2af704b34e0224bf2299c838e04d4dcf1364",
+ "type": "text"
+ }
+ ],
+ "timestamp": 1518639440766,
+ "_postman_variable_scope": "environment",
+ "_postman_exported_at": "2018-02-14T22:49:13.162Z",
+ "_postman_exported_using": "Postman/5.5.2"
+}
diff --git a/packages/sra-report/postman_configs/environments/mainnet_tokens.postman_environment.json b/packages/sra-report/postman_configs/environments/mainnet_tokens.postman_environment.json
new file mode 100644
index 000000000..f18c38f46
--- /dev/null
+++ b/packages/sra-report/postman_configs/environments/mainnet_tokens.postman_environment.json
@@ -0,0 +1,34 @@
+{
+ "id": "e1087711-9cff-fd54-ba20-990b17a15f80",
+ "name": "Mainnet tokens",
+ "values": [
+ {
+ "enabled": true,
+ "key": "DAI_address",
+ "value": "0x89d24a6b4ccb1b6faa2625fe562bdd9a23260359",
+ "type": "text"
+ },
+ {
+ "enabled": true,
+ "key": "WETH_address",
+ "value": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
+ "type": "text"
+ },
+ {
+ "enabled": true,
+ "key": "ZRX_address",
+ "value": "0xe41d2489571d322189246dafa5ebde1f4699f498",
+ "type": "text"
+ },
+ {
+ "enabled": true,
+ "key": "EXCHANGE_CONTRACT_address",
+ "value": "0x12459c951127e0c374ff9105dda097662a027093",
+ "type": "text"
+ }
+ ],
+ "timestamp": 1518561760642,
+ "_postman_variable_scope": "environment",
+ "_postman_exported_at": "2018-02-14T22:48:11.259Z",
+ "_postman_exported_using": "Postman/5.5.2"
+}
diff --git a/packages/sra-report/scripts/postpublish.js b/packages/sra-report/scripts/postpublish.js
new file mode 100644
index 000000000..b3e5407c8
--- /dev/null
+++ b/packages/sra-report/scripts/postpublish.js
@@ -0,0 +1,5 @@
+const postpublish_utils = require('../../../scripts/postpublish_utils');
+const packageJSON = require('../package.json');
+
+const subPackageName = packageJSON.name;
+postpublish_utils.standardPostPublishAsync(subPackageName); \ No newline at end of file
diff --git a/packages/sra-report/src/globals.d.ts b/packages/sra-report/src/globals.d.ts
new file mode 100644
index 000000000..eb09d3fcf
--- /dev/null
+++ b/packages/sra-report/src/globals.d.ts
@@ -0,0 +1,6 @@
+declare module 'newman';
+
+declare module '*.json' {
+ const value: any;
+ export default value;
+}
diff --git a/packages/sra-report/src/index.ts b/packages/sra-report/src/index.ts
new file mode 100644
index 000000000..bee9db192
--- /dev/null
+++ b/packages/sra-report/src/index.ts
@@ -0,0 +1,86 @@
+#!/usr/bin/env node
+import { assert } from '@0xproject/assert';
+import { HttpClient } from '@0xproject/connect';
+import { Schema, schemas } from '@0xproject/json-schemas';
+import { promisify } from '@0xproject/utils';
+import chalk from 'chalk';
+import * as _ from 'lodash';
+import * as newman from 'newman';
+import * as yargs from 'yargs';
+
+import * as sraReportCollectionJSON from '../postman_configs/collections/sra_report.postman_collection.json';
+
+import { postmanEnvironmentFactory } from './postman_environment_factory';
+import { utils } from './utils';
+
+const newmanRunAsync = promisify<void>(newman.run);
+const DEFAULT_NETWORK_ID = 1;
+const SUPPORTED_NETWORK_IDS = [1, 42];
+
+// extract command line arguments
+const args = yargs
+ .option('url', {
+ alias: ['u'],
+ describe: 'API endpoint to test for standard relayer API compliance',
+ type: 'string',
+ demandOption: true,
+ })
+ .option('output', {
+ alias: ['o', 'out'],
+ describe: 'Folder where to write the reports',
+ type: 'string',
+ normalize: true,
+ demandOption: false,
+ })
+ .option('network-id', {
+ alias: ['n'],
+ describe: 'ID of the network that the API is serving orders from',
+ type: 'number',
+ default: DEFAULT_NETWORK_ID,
+ })
+ .example("$0 --url 'http://api.example.com' --out 'src/contracts/generated/' --network-id 42", 'Full usage example')
+ .argv;
+// perform extra validation on command line arguments
+try {
+ assert.isHttpUrl('args', args.url);
+} catch (err) {
+ utils.log(`${chalk.red(`Invalid url format:`)} ${args.url}`);
+ process.exit(1);
+}
+if (!_.includes(SUPPORTED_NETWORK_IDS, args.networkId)) {
+ utils.log(`${chalk.red(`Unsupported network id:`)} ${args.networkId}`);
+ utils.log(`${chalk.bold(`Supported network ids:`)} ${SUPPORTED_NETWORK_IDS}`);
+ process.exit(1);
+}
+
+const mainAsync = async () => {
+ const httpClient = new HttpClient(args.url);
+ const orders = await httpClient.getOrdersAsync();
+ const firstOrder = _.head(orders);
+ if (_.isUndefined(firstOrder)) {
+ throw new Error('Could not get any orders from /orders endpoint');
+ }
+ const newmanEnvironmentOptions = {
+ collection: sraReportCollectionJSON,
+ globals: postmanEnvironmentFactory.createGlobalEnvironment(args.url, firstOrder),
+ environment: postmanEnvironmentFactory.createNetworkEnvironment(args.networkId),
+ };
+ const newmanReporterOptions = !_.isUndefined(args.output)
+ ? {
+ reporters: 'json',
+ reporter: {
+ json: {
+ export: args.output,
+ },
+ },
+ }
+ : {
+ reporters: 'cli',
+ };
+ const newmanRunOptions = {
+ ...newmanEnvironmentOptions,
+ ...newmanReporterOptions,
+ };
+ await newmanRunAsync(newmanRunOptions);
+};
+mainAsync().catch(utils.log);
diff --git a/packages/sra-report/src/postman_environment_factory.ts b/packages/sra-report/src/postman_environment_factory.ts
new file mode 100644
index 000000000..a8753d9ff
--- /dev/null
+++ b/packages/sra-report/src/postman_environment_factory.ts
@@ -0,0 +1,74 @@
+import { SignedOrder, ZeroEx } from '0x.js';
+import { Schema, schemas as schemasByName } from '@0xproject/json-schemas';
+import * as _ from 'lodash';
+
+import * as kovanTokensEnvironmentJSON from '../postman_configs/environments/kovan_tokens.postman_environment.json';
+import * as mainnetTokensEnvironmentJSON from '../postman_configs/environments/mainnet_tokens.postman_environment.json';
+
+interface EnvironmentValue {
+ key: string;
+ value: string;
+ enabled: boolean;
+ type: string;
+}
+
+export const postmanEnvironmentFactory = {
+ createGlobalEnvironment(url: string, order: SignedOrder) {
+ const schemas: Schema[] = _.values(schemasByName);
+ const schemaEnvironmentValues = _.compact(
+ _.map(schemas, (schema: Schema) => {
+ if (_.isUndefined(schema.id)) {
+ return undefined;
+ } else {
+ const schemaKey = convertSchemaIdToKey(schema.id);
+ const stringifiedSchema = JSON.stringify(schema);
+ const schemaEnvironmentValue = createEnvironmentValue(schemaKey, stringifiedSchema);
+ return schemaEnvironmentValue;
+ }
+ }),
+ );
+ const schemaKeys = _.map(schemaEnvironmentValues, (environmentValue: EnvironmentValue) => {
+ return environmentValue.key;
+ });
+ const allEnvironmentValues = _.concat(
+ schemaEnvironmentValues,
+ createEnvironmentValue('schemaKeys', JSON.stringify(schemaKeys)),
+ createEnvironmentValue('url', url),
+ createEnvironmentValue('order', JSON.stringify(order)),
+ createEnvironmentValue('orderMaker', order.maker),
+ createEnvironmentValue('orderTaker', order.taker),
+ createEnvironmentValue('orderFeeRecipient', order.feeRecipient),
+ createEnvironmentValue('orderHash', ZeroEx.getOrderHashHex(order)),
+ );
+ const environment = {
+ values: allEnvironmentValues,
+ };
+ return environment;
+ },
+ createNetworkEnvironment(networkId: number) {
+ switch (networkId) {
+ case 1:
+ return mainnetTokensEnvironmentJSON;
+ case 42:
+ return kovanTokensEnvironmentJSON;
+ default:
+ return {};
+ }
+ },
+};
+function convertSchemaIdToKey(schemaId: string) {
+ let result = schemaId;
+ if (_.startsWith(result, '/')) {
+ result = result.substr(1);
+ }
+ result = `${result}Schema`;
+ return result;
+}
+function createEnvironmentValue(key: string, value: string) {
+ return {
+ key,
+ value,
+ enabled: true,
+ type: 'text',
+ };
+}
diff --git a/packages/sra-report/src/utils.ts b/packages/sra-report/src/utils.ts
new file mode 100644
index 000000000..5423cabd9
--- /dev/null
+++ b/packages/sra-report/src/utils.ts
@@ -0,0 +1,5 @@
+export const utils = {
+ log(...args: any[]): void {
+ console.log(...args); // tslint:disable-line:no-console
+ },
+};
diff --git a/packages/sra-report/tsconfig.json b/packages/sra-report/tsconfig.json
new file mode 100644
index 000000000..3d967d05f
--- /dev/null
+++ b/packages/sra-report/tsconfig.json
@@ -0,0 +1,7 @@
+{
+ "extends": "../../tsconfig",
+ "compilerOptions": {
+ "outDir": "lib"
+ },
+ "include": ["./src/**/*", "../../node_modules/web3-typescript-typings/index.d.ts"]
+}
diff --git a/packages/sra-report/tslint.json b/packages/sra-report/tslint.json
new file mode 100644
index 000000000..ffaefe83a
--- /dev/null
+++ b/packages/sra-report/tslint.json
@@ -0,0 +1,3 @@
+{
+ "extends": ["@0xproject/tslint-config"]
+}
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-08 19:47:17 +0800