@avalanche-sdk/client/src/methods/wallet/getAccountPubKey.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 { AvalancheWalletCoreClient } from "../../clients/createAvalancheWalletCoreClient";
import { AvalancheWalletRpcSchema } from "./avalancheWalletRPCSchema.js";
import { GetAccountPubKeyReturnType } from "./types/getAccountPubKey.js";

/**
 * Get the public key of the account
 * @param client - The client to use {@link AvalancheWalletCoreClient}
 * @returns The public key of the account {@link GetAccountPubKeyReturnType}
 *
 * @example
 *
 * import { createWalletCoreClient, http } from '@avalanche-sdk/client'
 * import { avalanche } from '@avalanche-sdk/client/chains'
 * import { getAccountPubKey } from '@avalanche-sdk/client/methods/wallet'
 *
 * // Create an local avalanche account otherwise pass custom transport
 * const privateKey = "0x..."
 * const account = privateKeyToAvalancheAccount(privateKey)
 *
 * // Create a wallet core client
 * const client = createWalletCoreClient({
 *   chain: avalanche,
 *   transport: {
 *     type: "http",
 *     url: "https://api.avax.network/ext/bc/C/rpc",
 *   },
 *   account,
 * })
 *
 * // or pass custom transport
 * const client = createWalletCoreClient({
 *   chain: avalanche,
 *   transport: {
 *     type: "custom",
 *     provider: window.avalanche!,
 *   },
 * })
 *
 *
 * const pubKey = await getAccountPubKey(client)
 *
 */
export async function getAccountPubKey(
  client: AvalancheWalletCoreClient
): Promise<GetAccountPubKeyReturnType> {
  return client.request<
    AvalancheWalletRpcSchema,
    {
      method: "avalanche_getAccountPubKey";
      params: {};
    },
    GetAccountPubKeyReturnType
  >({
    method: "avalanche_getAccountPubKey",
    params: {},
  });
}