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β
| Parameter | Type | Description | Required |
|---|---|---|---|
| config | ReadConfig | Contract address and publicClient | Yes |
| args | [bigint] | Epoch number | Yes |
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β
| Parameter | Type | Description | Required |
|---|---|---|---|
| config | ReadConfig | Contract address and publicClient | Yes |
| args | [Address, bigint] | User address, epoch number | Yes |
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β
| Parameter | Type | Description | Required |
|---|---|---|---|
| config | ReadConfig | Contract address and publicClient | Yes |
| args | [Address, bytes32, bigint] | User address, vaultId, epoch number | Yes |
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β
| Parameter | Type | Description | Required |
|---|---|---|---|
| config | ReadConfig | Contract address and publicClient | Yes |
| args | [Address] | User address | Yes |
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)