useBalance

useBalance(props?): { data: undefined | { actualLockup: bigint; availableFunds: bigint; funds: bigint; lockupCurrent: bigint; lockupLastSettledAt: bigint; lockupRate: bigint; }; } | { data: undefined | { actualLockup: bigint; availableFunds: bigint; funds: bigint; lockupCurrent: bigint; lockupLastSettledAt: bigint; lockupRate: bigint; }; } | { data: undefined | { actualLockup: bigint; availableFunds: bigint; funds: bigint; lockupCurrent: bigint; lockupLastSettledAt: bigint; lockupRate: bigint; }; } | { data: undefined | { actualLockup: bigint; availableFunds: bigint; funds: bigint; lockupCurrent: bigint; lockupLastSettledAt: bigint; lockupRate: bigint; }; } | { data: undefined | { actualLockup: bigint; availableFunds: bigint; funds: bigint; lockupCurrent: bigint; lockupLastSettledAt: bigint; lockupRate: bigint; }; } | { data: undefined | { actualLockup: bigint; availableFunds: bigint; funds: bigint; lockupCurrent: bigint; lockupLastSettledAt: bigint; lockupRate: bigint; }; }

Defined in: packages/iso-filecoin-synapse/src/hooks/payments.ts:57

Get the balance of the payments contract including the lockup and rate.

Parameters

Parameter	Type	Description
props?	BalanceProps	The props for the balance.

Returns

{ data: undefined | { actualLockup: bigint; availableFunds: bigint; funds: bigint; lockupCurrent: bigint; lockupLastSettledAt: bigint; lockupRate: bigint; }; } | { data: undefined | { actualLockup: bigint; availableFunds: bigint; funds: bigint; lockupCurrent: bigint; lockupLastSettledAt: bigint; lockupRate: bigint; }; } | { data: undefined | { actualLockup: bigint; availableFunds: bigint; funds: bigint; lockupCurrent: bigint; lockupLastSettledAt: bigint; lockupRate: bigint; }; } | { data: undefined | { actualLockup: bigint; availableFunds: bigint; funds: bigint; lockupCurrent: bigint; lockupLastSettledAt: bigint; lockupRate: bigint; }; } | { data: undefined | { actualLockup: bigint; availableFunds: bigint; funds: bigint; lockupCurrent: bigint; lockupLastSettledAt: bigint; lockupRate: bigint; }; } | { data: undefined | { actualLockup: bigint; availableFunds: bigint; funds: bigint; lockupCurrent: bigint; lockupLastSettledAt: bigint; lockupRate: bigint; }; }

The balance of the payments contract.