getAccountSummary

getAccountSummary(client, options): Promise<OutputType>

Defined in: packages/synapse-core/src/pay/get-account-summary.ts:137

Get a comprehensive account summary from the Payments contract.

Fetches account state, fixed lockup totals, and (optionally) current epoch in parallel, then derives debt, available funds, lockup breakdown, runway, and gross coverage client-side.

Parameters

Parameter	Type	Description
`client`	`Client`<`Transport`, `Chain`>	The client to use to get the account summary.
`options`	`OptionsType`	getAccountSummary.OptionsType

Returns

Promise<OutputType>

Full account summary getAccountSummary.OutputType

Throws

Errors getAccountSummary.ErrorType

Example

import { getAccountSummary } from '@filoz/synapse-core/pay'
import { createPublicClient, http } from 'viem'
import { calibration } from '@filoz/synapse-core/chains'

const client = createPublicClient({
  chain: calibration,
  transport: http(),
})

const summary = await getAccountSummary(client, {
  address: '0x1234567890123456789012345678901234567890',
})

console.log('Available:', summary.availableFunds)
console.log('Runway in epochs:', summary.runwayInEpochs)
console.log('Gross coverage in epochs:', summary.grossCoverageInEpochs)