@avalanche-sdk/client/src/methods/admin/setLoggerLevel.ts

A TypeScript SDK for interacting with the Avalanche network through JSON-RPC APIs. This SDK provides a comprehensive set of tools to interact with all Avalanche chains (P-Chain, X-Chain, C-Chain) and various APIs, including wallet functionality for transa

import { Chain, Transport } from "viem";
import {
  AvalancheCoreClient,
  AvalancheCoreClient as Client,
} from "../../clients/createAvalancheCoreClient.js";
import { AdminRpcSchema } from "./adminRpcSchema.js";
import { SetLoggerLevelParameters } from "./types/setLoggerLevel.js";

/**
 * Sets log and display levels of loggers.
 *
 * - Docs: https://build.avax.network/docs/api-reference/admin-api#adminsetloggerlevel
 *
 * @param client - The client to use. {@link AvalancheCoreClient}
 * @param params - The logger name, log level, and display level. {@link SetLoggerLevelParameters}
 * @returns Promise that resolves when the logger levels are set
 *
 * @example
 * ```ts
 * import { createAvalancheCoreClient } from '@avalanche-sdk/client'
 * import { avalanche } from '@avalanche-sdk/client/chains'
 * import { setLoggerLevel } from '@avalanche-sdk/client/methods/admin'
 *
 * const client = createAvalancheCoreClient({
 *   chain: avalanche,
 *   transport: {
 *     type: "http",
 *     url: "<url>",
 *   },
 * });
 *
 * await setLoggerLevel(client, {
 *   loggerName: "C",
 *   logLevel: "DEBUG",
 *   displayLevel: "INFO"
 * });
 * ```
 */
export async function setLoggerLevel<chain extends Chain | undefined>(
  client: Client<Transport, chain>,
  params: SetLoggerLevelParameters
): Promise<void> {
  return client.request<
    AdminRpcSchema,
    {
      method: "admin.setLoggerLevel";
      params: SetLoggerLevelParameters;
    },
    void
  >({
    method: "admin.setLoggerLevel",
    params,
  });
}