Skip to main content

AValueDistributor

Overview​

License: MIT​

abstract contract AValueDistributor

The Staking module

Contract module for distributing value among users based on their shares.

The algorithm ensures that the distribution is proportional to the shares held by each user and takes into account changes in the cumulative sum over time.

This contract can be used as a base contract for implementing various distribution mechanisms, such as token staking, profit sharing, or dividend distribution.

It includes hooks for performing additional logic when shares are added or removed, or when value is distributed.

Structs info​

UserDistribution​

struct UserDistribution {
    uint256 shares;
    uint256 cumulativeSum;
    uint256 owedValue;
}

AValueDistributorStorage​

struct AValueDistributorStorage {
    uint256 totalShares;
    uint256 cumulativeSum;
    uint256 updatedAt;
    mapping(address => AValueDistributor.UserDistribution) userDistributions;
}

Events info​

SharesAdded​

event SharesAdded(address user, uint256 amount)

SharesRemoved​

event SharesRemoved(address user, uint256 amount)

ValueDistributed​

event ValueDistributed(address user, uint256 amount)

Errors info​

AmountIsZero​

error AmountIsZero()

InsufficientOwedValue​

error InsufficientOwedValue(address account, uint256 balance, uint256 needed)

InsufficientSharesAmount​

error InsufficientSharesAmount(address account, uint256 balance, uint256 needed)

UserIsZeroAddress​

error UserIsZeroAddress()

Functions info​

totalShares (0x3a98ef39)​

function totalShares() public view returns (uint256)

Returns the total number of shares.

Return values:

NameTypeDescription
[0]uint256The total number of shares.

cumulativeSum (0xa16f5fd2)​

function cumulativeSum() public view returns (uint256)

Returns the cumulative sum of value that has been distributed.

Return values:

NameTypeDescription
[0]uint256The cumulative sum of value that has been distributed.

updatedAt (0x7519ab50)​

function updatedAt() public view returns (uint256)

Returns the timestamp of the last update.

Return values:

NameTypeDescription
[0]uint256The timestamp of the last update.

userDistribution (0x3cf69475)​

function userDistribution(
    address user_
) public view returns (AValueDistributor.UserDistribution memory)

Returns the distribution details for a specific user.

Parameters:

NameTypeDescription
user_addressThe address of the user.

Return values:

NameTypeDescription
[0]struct AValueDistributor.UserDistributionThe distribution details including user's shares, cumulative sum and value owed.

getOwedValue (0x2d3bac1b)​

function getOwedValue(address user_) public view returns (uint256)

Gets the amount of value owed to a specific user.

Parameters:

NameTypeDescription
user_addressThe address of the user.

Return values:

NameTypeDescription
[0]uint256The total owed value to the user.

precision (0xd3b5dc3b)​

function precision() public pure virtual returns (uint256)