@nextrope/xrpl/src/models/methods/serverState.ts

A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser

import { BaseRequest, BaseResponse } from './baseMethod'
import { JobType, ServerState, StateAccountingFinal } from './serverInfo'

/**
 * The `server_state` command asks the server for various machine-readable
 * information about the rippled server's current state. The response is almost
 * the same as the server_info method, but uses units that are easier to process
 * instead of easier to read.
 *
 * @category Requests
 */
export interface ServerStateRequest extends BaseRequest {
  command: 'server_state'
}

/**
 * Response expected from a {@link ServerStateRequest}.
 *
 * @category Responses
 */
export interface ServerStateResponse extends BaseResponse {
  result: {
    state: {
      amendment_blocked?: boolean
      build_version: string
      complete_ledgers: string
      closed_ledger?: {
        age: number
        base_fee: number
        hash: string
        reserve_base: number
        reserve_inc: number
        seq: number
      }
      io_latency_ms: number
      jq_trans_overflow: string
      last_close: {
        // coverage_time_s only exists for `server_info` requests. `server_state` is a "non human" api request,
        // therefore the type is coverage_time
        // See https://github.com/XRPLF/rippled/blob/83faf43140e27e5d6d6779eaa0ffb75c33d98029/src/ripple/app/misc/NetworkOPs.cpp#L2458
        converge_time: number
        proposers: number
      }
      load?: {
        job_types: JobType[]
        threads: number
      }
      load_base: number
      load_factor: number
      load_factor_fee_escalation?: number
      load_factor_fee_queue?: number
      load_factor_fee_reference?: number
      load_factor_server?: number
      network_id: number
      peer_disconnects?: string
      peer_disconnects_resources?: string
      peers: number
      pubkey_node: string
      pubkey_validator?: string
      server_state: ServerState
      server_state_duration_us: string
      state_accounting: StateAccountingFinal
      time: string
      uptime: number
      validated_ledger?: {
        age?: number
        base_fee: number
        close_time: number
        hash: string
        reserve_base: number
        reserve_inc: number
        seq: number
      }
      validation_quorum: number
      validator_list_expires?: number
    }
  }
}