cive/types/fee.ts

Cive is an interface for the Conflux Core Space, built on Viem.

import type { OneOf } from './utils.js'

export type GasAndCollateral<TQuantity = bigint> = {
  gasLimit: TQuantity
  gasUsed: TQuantity
  storageCollateralized: TQuantity
}

export type FeeHistory<TQuantity = bigint> = {
  /**
   * An array of block base fees per gas (in wei). This includes the next block after
   * the newest of the returned range, because this value can be derived from the newest block.
   * Zeroes are returned for pre-EIP-1559 blocks. */
  baseFeePerGas: TQuantity[]
  /** An array of block gas used ratios. These are calculated as the ratio of gasUsed and gasLimit. */
  gasUsedRatio: number[]
  /** Lowest number block of the returned range. */
  oldestBlock: TQuantity
  /** An array of effective priority fees (in wei) per gas data points from a single block. All zeroes are returned if the block is empty. */
  reward?: TQuantity[][] | undefined
}

export type FeeValuesLegacy<TQuantity = bigint> = {
  /** Base fee per gas. */
  gasPrice: TQuantity
  maxFeePerGas?: never | undefined
  maxPriorityFeePerGas?: never | undefined
}

export type FeeValuesEIP1559<TQuantity = bigint> = {
  gasPrice?: never | undefined
  /** Total fee per gas in wei (gasPrice/baseFeePerGas + maxPriorityFeePerGas). */
  maxFeePerGas: TQuantity
  /** Max priority fee per gas (in wei). */
  maxPriorityFeePerGas: TQuantity
}

export type FeeValues<TQuantity = bigint> = OneOf<
  FeeValuesLegacy<TQuantity> | FeeValuesEIP1559<TQuantity>
>

export type FeeValuesType = 'legacy' | 'eip1559'