Skip to main content

getWhitelist

Description:

Fetch the whitelist for private vaults. Only addresses included in this list are eligible to stake in the private vault. The number of addresses in this list is indicated by the vault whitelistCount field.

Arguments:

NameTypeTypeDescription
vaultAddressstringYesThe address of the vault
addressInstring[]NoFilters results to include only addresses in the provided list. Helps to check, for example, if several addresses are added to the whitelist
orderDirection'asc' | 'desc'NoSpecifies the sorting order. Defaults to desc (descending order)
searchstringNoFilters results by the address field
limitnumberNoLimits the number of addresses returned. Defaults to 100
skipnumberNoSkips the specified number of addresses. Defaults to 0

Returns:

type List = {
createdAt: number
address: string
}

type Output = {
whitelist: List[]
}
NameDescription
whitelistAn array of objects representing the result of the query based on your parameters

Example:

await sdk.vault.getWhitelist({
vaultAddress: '0x...',
})