getDiagnosticsread-only

Get a diagnostics report about the state of the wallet, serialized as a string in the requested format.

Request:

The request arguments must be a GetDiagnosticsRequest object.

Response:

On success, the result is a GetDiagnosticsResponse: the diagnostics report serialized as a string.

Expected errors:

The caller can handle the following errors inline: WALLET_CORE_API_BAD_REQUEST.

Details:

The report is privacy-scrubbed: transaction identifiers are replaced by synthetic labels. It contains the wallet-core version, the database backend with record counts, the known exchanges, coins, bank accounts and the newest transactions (at most transactionLimit of them). The WALLET_CORE_API_BAD_REQUEST error is raised when transactionLimit is not a non-negative safe integer smaller than Number.MAX_SAFE_INTEGER.

interface GetDiagnosticsRequest {
  // Serialized output format.  Defaults to JSON.
  format?: DiagnosticsFormat;

  // Maximum number of newest transactions to include.  Defaults to 100.
  transactionLimit?: number;

  // Information supplied by the wallet frontend invoking wallet-core.
  frontendInfo?: DiagnosticsFrontendInfo;
}

type DiagnosticsFormat = "json" | "yaml";

interface DiagnosticsFrontendInfo {
  name: string;
  version: string;
  platform?: string;
}

// A serialized diagnostics report in the requested format, returned
// as a string so that clients can save it without depending on the
// report's internal schema.
type GetDiagnosticsResponse = string;