Skip to main content

getRewardSplitters

Description:

Fetch the list of created reward splitters. A reward splitter is a contract designed to distribute vault rewards among multiple fee recipients in predefined proportions. To use a reward splitter, its address should be added to the vault as a fee recipient.

Arguments:

NameTypeTypeDescription
vaultAddressstringYesThe address of the vault
idstringNoReward splitter address
ownerstringNoThe owner of the reward splitter

Returns:

type FeeRecipient = {
shares: bigint
percent: number
address: string
}

type RewardSplitter = {
owner: string
address: string
totalShares: bigint
feeRecipients: FeeRecipient[]
}

type Output = {
rewardSplitters: RewardSplitter[]
}
NameDescription
rewardSplittersAn array of objects representing the result of the query based on your parameters

Example:

await sdk.vault.getRewardSplitters({
owner: '0x...', // OR id: '0x...'
vaultAddress: '0x...',
})