Введение #

Aurora RPC - это библиотека, которая реализует обмен информацией в формате клиент ↔ сервер с использованием методологии RPC поверх протокола WebSocket.

Обмен данными осуществляется в формате JSON, протокол обмена данных основан на спецификации JSON-RPC 2.0.

Сходства и различия с JSON-RPC #

Протокол Aurora RPC основан на стандарте JSON-RPC 2.0. Он реализует аналогичную структуру запроса и ответа, за исключением отсутствия указания параметра jsonrpc:

interface Request {
  id?: number | string; // Не обязательно для уведомлений
  method: string;
  params?: object | array; // Не обязательно для уведомлений
}

interface Response {
  id: number | string;
  result: object | array;
}

При возврате ошибки используется следующий тип:

interface ResponseError {
  id: number | string;
  error: {
    code: number;
    message: string;
  };
}

Коды ошибок соответствуют тем, что используются в JSON-RPC: