README.md

0x Relayer Registry

A collection of relayers built on 0x and their corresponding metadata.

Addition to this repository is not a requirement to use the 0x Protocol. It's intended to make it easier for traders and developers to find SRA-Compliant relayers and take advantage of networked liquidity, as well as for users to find a relayer to start trading on.

Usage

Option A. Clone this repo and import relayers.json into your own project or
Option B. Get the latest version by fetching it directly from this repo
$ curl -i -H "Accept: application/json" https://api.github.com/repos/0xProject/0x-relayer-registry/contents/relayers.json?client_id={CLIENT_ID}&client_secret={CLIENT_SECRET}

Entries that have values for sra_http_endpoint or sra_ws_endpoint comply with the Standard Relayer API. These endpoints can be easily queried using 0x Connect.

Submission Process

1. Fork this repository.
2. Add your logo image in a web-safe format (GIF, JPEG, or PNG) to the images folder.
3. Add an entry to relayers.json that complies with the Relayer JSON Schema in schemas.ts
4. Install yarn and run yarn install
5. Run yarn test to verify that the updated relayers.json file passes schema validation.
6. Submit PR for approval

A sample submission:

{
    "name"      : "Sample Relayer",
    "url"       : "https://asamplewebsite.com",
    "logo"      : "samplerelayer.png",
    "networks"  : [
        {
            "networkId" : 1,
            "sra_http_endpoint" : "https://api.asamplewebsite.com/",
            "sra_ws_endpoint" : "ws://api.asamplewebsite.com",
            "static_order_fields" : {
                "fee_recipient_addresses": ["0x1111111111111111111111111111111111111111"]
            }
        }
    ]
}

A full list of permitted fields can be found in the schemas.ts file.