Websockets - Relay

Relay Status Websockets

Relay Status Websockets specifically stream transaction statuses for both cross and same-chain status, though the stages differ slightly.

Integrating Relay Websockets

Refer to the guide below on how to integrate the websocket into your application. You may also refer to the websocket reference for more details.

Events

Authentication

The Websocket Service is available for anyone with strict rate limits. For customers with an API key it can be used for authentication for higher rate limits, the service is available at the following URL wss://ws.relay.link To connect using an API key, provide your API key as a query param in the connection url:

const wss = new ws(`wss://ws.relay.link?apiKey=${YOUR_API_KEY}`);

Authentication is generally not required in client-side applications.

The websocket server needs to restart to deploy updates The websocket server uses a rolling restart mechanism to deploy new changes. This will disconnect you and require you to reconnect to the websocket server. There is no downtime, as you are only disconnected once the new server is up and running. Please make sure to include logic in your implementation to handle these restarts, and reconnect accordingly.

Interacting with the Websocket

Before sending any messages over the Websocket, wait for a ready message back from the server. The message looks like:

{
    "type": "connection", // The type of operation
    "status": "ready", // The status of the operation
    "data": {
        "id": "9nqpzwmwh86" // Your socket id for debugging purposes
    }
}

Subscribing with Filters

Below is an example on how to subscribe to a websocket using filters.

Subscribe

Subscribe Response

{
    "type": "subscribe",
    "event": "request.status.updated",
    "filters": {
        "id": "0xae0827617d4ae75b406969971c2d4df9a8e8d819ff0f09581fb45ca123fcc7a0"
    }
}

{
    "type": "subscribe",
    "status": "success",
    "data": {
        "event": "request.status.updated",
        "filters": {
            "id": "0xae0827617d4ae75b406969971c2d4df9a8e8d819ff0f09581fb45ca123fcc7a0"
        }
    }
}

Unsubscribing

Unsubscribe

Unsubscribe Response

{
    "type": "unsubscribe",
    "event": "request.status.updated",
  "filters": {
      "id": "0xae0827617d4ae75b406969971c2d4df9a8e8d819ff0f09581fb45ca123fcc7a0"
  }
}

{
    "type": "unsubscribe",
    "status": "success",
    "data": {
        "event": "request.status.updated"
    }
}

Unsubscribing is not required if disconnecting from the websocket as the server cleans up automatically.

Example

Javascript

npm install ws

const ws = require("ws");

const YOUR_API_KEY = "";

const wss = new ws(`wss://ws.relay.link?apiKey=${YOUR_API_KEY}`);

wss.on("open", function open() {
  console.log("Connected to Relay");

wss.on("message", function incoming(data) {
    console.log("Message received: ", JSON.stringify(JSON.parse(data)));

// When the connection is ready, subscribe to the top-bids event
    if (JSON.parse(data).status === "ready") {
      console.log("Subscribing");
      wss.send(
        JSON.stringify({
          type: "subscribe",
          event: "request.status.updated",
          filters: {
            id: "0xae0827617d4ae75b406969971c2d4df9a8e8d819ff0f09581fb45ca123fcc7a0",
          },
        })
      );

// To unsubscribe, send the following message
      // wss.send(
      //     JSON.stringify({
      //         type: 'unsubscribe',
      //         event: 'request.status.updated',
      //     }),
      // );
    }
  });
});