Skip to main content

Epochs & Utilization

Functions for querying epoch information and utilization metrics.

multiVaultCurrentEpoch​

Get the current epoch number.

Returns​

Promise<bigint> // Current epoch number

Example​

import { multiVaultCurrentEpoch } from '@0xintuition/protocol'

const epoch = await multiVaultCurrentEpoch({ address, publicClient })
console.log('Current epoch:', epoch)

multiVaultGetTotalUtilizationForEpoch​

Get total protocol utilization for an epoch.

Parameters​

ParameterTypeDescriptionRequired
configReadConfigContract address and publicClientYes
args[bigint]Epoch numberYes

Returns​

Promise<bigint> // Total utilization

Example​

import { multiVaultGetTotalUtilizationForEpoch } from '@0xintuition/protocol'

const totalUtil = await multiVaultGetTotalUtilizationForEpoch(
{ address, publicClient },
{ args: [epochNumber] }
)

console.log('Total utilization:', totalUtil)

multiVaultGetUserUtilizationForEpoch​

Get user's total utilization for an epoch.

Parameters​

ParameterTypeDescriptionRequired
configReadConfigContract address and publicClientYes
args[Address, bigint]User address, epoch numberYes

Returns​

Promise<bigint> // User's total utilization

Example​

import { multiVaultGetUserUtilizationForEpoch } from '@0xintuition/protocol'

const userUtil = await multiVaultGetUserUtilizationForEpoch(
{ address, publicClient },
{ args: [userAddress, epochNumber] }
)

console.log('User utilization:', userUtil)

multiVaultGetUserUtilizationInEpoch​

Get user's utilization in a specific vault for an epoch.

Parameters​

ParameterTypeDescriptionRequired
configReadConfigContract address and publicClientYes
args[Address, bytes32, bigint]User address, vaultId, epoch numberYes

Returns​

Promise<bigint> // User's vault-specific utilization

Example​

import { multiVaultGetUserUtilizationInEpoch } from '@0xintuition/protocol'

const vaultUtil = await multiVaultGetUserUtilizationInEpoch(
{ address, publicClient },
{ args: [userAddress, vaultId, epochNumber] }
)

console.log('Vault utilization:', vaultUtil)

multiVaultGetUserLastActiveEpoch​

Get user's last active epoch.

Parameters​

ParameterTypeDescriptionRequired
configReadConfigContract address and publicClientYes
args[Address]User addressYes

Returns​

Promise<bigint> // Last active epoch number

Example​

import { multiVaultGetUserLastActiveEpoch } from '@0xintuition/protocol'

const lastEpoch = await multiVaultGetUserLastActiveEpoch(
{ address, publicClient },
{ args: [userAddress] }
)

console.log('Last active epoch:', lastEpoch)

See Also​