Files
protocol/packages/sra-report

SRA Report

This package allows you to generate reports detailing an endpoint's standard relayer API HTTP specification 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 before getting started.

Install Dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

yarn config set workspaces-experimental true

Then install dependencies

yarn install

Build

yarn build

Lint

yarn lint