Skip to main content

YieldDistributor

The YieldDistributor contract manages yield distributions and dividend payments to token holders.

Functions​

distribute​

Creates a new yield distribution.

function distribute(
uint256 amount,
address paymentToken
) external returns (uint256 distributionId);

claim​

Claims yield for the caller.

function claim(uint256 distributionId) external;

getClaimableAmount​

Returns claimable amount for an address.

function getClaimableAmount(
address investor,
uint256 distributionId
) external view returns (uint256);

Events​

event DistributionCreated(uint256 indexed id, uint256 amount, address paymentToken);
event YieldClaimed(address indexed investor, uint256 indexed distributionId, uint256 amount);

See Also​