xahau.js/src/ledger/ledger.ts

import {validate} from '../common'
import {FormattedLedger, parseLedger} from './parse/ledger'
import {Client} from '..'

export type GetLedgerOptions = {
  ledgerHash?: string
  ledgerVersion?: number
  includeAllData?: boolean
  includeTransactions?: boolean
  includeState?: boolean
}

async function getLedger(
  this: Client,
  options: GetLedgerOptions = {}
): Promise<FormattedLedger> {
  // 1. Validate
  validate.getLedger({options})
  // 2. Make Request
  const response = await this.request({command: 'ledger',
    ledger_hash: options.ledgerHash,
    ledger_index: options.ledgerVersion || 'validated',
    expand: options.includeAllData,
    transactions: options.includeTransactions,
    accounts: options.includeState
  })
  // 3. Return Formatted Response
  return parseLedger(response.result.ledger)
}

export default getLedger