safe-apps-sdk/src/communication/messageFormatter.ts

SDK developed to integrate third-party apps with Safe app.

import { ErrorResponse, SDKRequestData, RequestId, SuccessResponse, MethodToResponse } from '../types';
import { getSDKVersion } from '../utils';
import { Methods } from './methods';
import { generateRequestId } from './utils';

class MessageFormatter {
  static makeRequest = <M extends Methods = Methods, P = unknown>(method: M, params: P): SDKRequestData<M, P> => {
    const id = generateRequestId();

    return {
      id,
      method,
      params,
      env: {
        sdkVersion: getSDKVersion(),
      },
    };
  };

  static makeResponse = (id: RequestId, data: MethodToResponse[Methods], version: string): SuccessResponse => ({
    id,
    success: true,
    version,
    data,
  });

  static makeErrorResponse = (id: RequestId, error: string, version: string): ErrorResponse => ({
    id,
    success: false,
    error,
    version,
  });
}

export { MessageFormatter };