@avalanche-sdk/client/src/methods/pChain/types/getFeeConfig.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 { RequestErrorType } from "viem/utils";

/**
 * Return type for the `platform.getFeeConfig` method.
 * Get the fee configuration for the P-Chain.
 * @property weights - Weights to merge fee dimensions into a single gas value
 * @property maxCapacity - The maximum amount of gas the chain is allowed to store for future use
 * @property maxPerSecond - The maximum amount of gas the chain is allowed to consume per second
 * @property targetPerSecond - The target amount of gas the chain should consume per second to maintain stable fees
 * @property minPrice - The minimum price per unit of gas
 * @property excessConversionConstant - A constant used to convert excess gas into a gas price
 */
export type GetFeeConfigReturnType = {
  /**
   * Weights to merge fee dimensions into a single gas value.
   * Each dimension represents a specific resource cost:
   * - `bandwidth`: The weight for bandwidth usage.
   * - `dbRead`: The weight for database read operations.
   * - `dbWrite`: The weight for database write operations.
   * - `compute`: The weight for computational operations.
   */
  weights: [
    bandwidth: number,
    dbRead: number,
    dbWrite: number,
    compute: number
  ];

  /**
   * The maximum amount of gas the chain is allowed to store for future use.
   * This value ensures that the chain does not exceed its storage capacity.
   */
  maxCapacity: bigint;

  /**
   * The maximum amount of gas the chain is allowed to consume per second.
   * This value acts as a cap on the gas consumption rate.
   */
  maxPerSecond: bigint;

  /**
   * The target amount of gas the chain should consume per second to maintain
   * stable fees. This value helps regulate gas usage and fee stability.
   */
  targetPerSecond: bigint;

  /**
   * The minimum price per unit of gas. This value ensures that gas prices
   * do not fall below a certain threshold.
   */
  minPrice: bigint;

  /**
   * A constant used to convert excess gas into a gas price. This value
   * helps determine the relationship between excess gas and its impact
   * on gas pricing.
   */
  excessConversionConstant: bigint;
};

export type GetFeeConfigErrorType = RequestErrorType;

export type GetFeeConfigMethod = {
  Method: "platform.getFeeConfig";
  Parameters: {};
  ReturnType: GetFeeConfigReturnType;
};