blob: 49609aeb268f0a924803d8c754d4226fe814ee28 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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
```
|
