Skip to content
iso-filecoin iso-filecoin

useAllowance

useAllowance(props?): UseQueryResult<{ costs: { perDay: bigint; perEpoch: bigint; perMonth: bigint; }; currentLockupAllowance: bigint; currentLockupUsed: bigint; currentRateAllowance: bigint; currentRateUsed: bigint; depositAmountNeeded: bigint; lockupAllowanceNeeded: bigint; rateAllowanceNeeded: bigint; sufficient: boolean; }, Error>

Defined in: packages/iso-filecoin-synapse/src/hooks/warm-storage.ts:40

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

Parameters

Section titled “Parameters”
ParameterTypeDescription
props?AllowancePropsThe props for the allowance.

Returns

Section titled “Returns”

UseQueryResult<{ costs: { perDay: bigint; perEpoch: bigint; perMonth: bigint; }; currentLockupAllowance: bigint; currentLockupUsed: bigint; currentRateAllowance: bigint; currentRateUsed: bigint; depositAmountNeeded: bigint; lockupAllowanceNeeded: bigint; rateAllowanceNeeded: bigint; sufficient: boolean; }, Error>

The balance of the payments contract.