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:
Name | Type | Type | Description |
---|---|---|---|
vaultAddress | string | Yes | The address of the vault |
addressIn | string[] | No | Filters 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' | No | Specifies the sorting order. Defaults to desc (descending order) |
search | string | No | Filters results by the address field |
limit | number | No | Limits the number of addresses returned. Defaults to 100 |
skip | number | No | Skips the specified number of addresses. Defaults to 0 |
Returns:
type List = {
createdAt: number
address: string
}
type Output = {
whitelist: List[]
}
Name | Description |
---|---|
whitelist | An array of objects representing the result of the query based on your parameters |
Example:
await sdk.vault.getWhitelist({
vaultAddress: '0x...',
})