totalAccountFixedLockup

totalAccountFixedLockup(client, options): Promise<OutputType>

Defined in: packages/synapse-core/src/pay/total-account-fixed-lockup.ts:55

Get the total fixed lockup across all rails for an account.

Fetches all rails for the payer, then batches getRail calls via multicall to sum lockupFixed. Includes terminated-but-not-finalized rails since they still hold locked funds until finalization.

Parameters

Parameter	Type	Description
`client`	`Client`<`Transport`, `Chain`>	The client to use to get the total account fixed lockup.
`options`	`OptionsType`	totalAccountFixedLockup.OptionsType

Returns

Promise<OutputType>

The total fixed lockup and active rail count totalAccountFixedLockup.OutputType

Throws

Errors totalAccountFixedLockup.ErrorType

Example

import { totalAccountFixedLockup } 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 lockup = await totalAccountFixedLockup(client, {
  address: '0x1234567890123456789012345678901234567890',
})

console.log('Total fixed lockup:', lockup.totalFixedLockup)