VPContract#

function batchVotePowerOfAt(
    address[] _owners,
    uint256 _blockNumber
) external view returns (
    uint256[] _votePowers);

Get the vote power of a set of addresses at a given block number.

function cleanupBlockNumber(
) external view returns (
    uint256);

Get the current cleanup block number set with setCleanupBlockNumber.

constructor(
    contract IVPToken _ownerToken,
    bool _isReplacement
) public;

Construct VPContract for given VPToken.

function delegate(
    address _from,
    address _to,
    uint256 _balance,
    uint256 _bips
) external;

Delegate _bips percentage of voting power from a delegator address to a delegatee address.

function delegateExplicit(
    address _from,
    address _to,
    uint256 _balance,
    uint256 _amount
) external;

Explicitly delegate _amount tokens of voting power from a delegator address to a delegatee address.

function delegatesOf(
    address _owner
) external view returns (
    address[] _delegateAddresses,
    uint256[] _bips,
    uint256 _count,
    uint256 _delegationMode);

Get the percentages and addresses being delegated to by a vote power delegator.

function delegatesOfAt(
    address _owner,
    uint256 _blockNumber
) public view returns (
    address[] _delegateAddresses,
    uint256[] _bips,
    uint256 _count,
    uint256 _delegationMode);

Get the percentages and addresses being delegated to by a vote power delegator, at a given block.

function delegationModeOf(
    address _who
) external view returns (
    uint256);

Get the delegation mode of an address. This mode determines whether vote power is allocated by percentage or by explicit value and cannot be changed once set with delegate or delegateExplicit.

function explicitDelegationHistoryCleanup(
    address _from,
    address _to,
    uint256 _count
) external returns (
    uint256);

Delete explicit delegation checkpoints that expired (i.e. are before cleanupBlockNumber). Method can only be called from the cleanerContract (which may be a proxy to external cleaners).

function isReplacement(
) external view returns (
    bool);

Return true if this IIVPContract is configured to be used as a replacement for other contract. It means that vote powers are not necessarily correct at the initialization, therefore every method that reads vote power must check whether it is initialized for that address and block.

function ownerToken(
) external view returns (
    contract IVPToken);

The VPToken (or some other contract) that owns this VPContract. All state changing methods may be called only from this address. This is because original msg.sender is typically sent in a parameter and we must make sure that it cannot be faked by directly calling IIVPContract methods. Owner token is also used in case of replacement to recover vote powers from balances.

function percentageDelegationHistoryCleanup(
    address _owner,
    uint256 _count
) external returns (
    uint256);

Delete percentage delegation checkpoints that expired (i.e. are before cleanupBlockNumber). Method can only be called from the cleanerContract (which may be a proxy to external cleaners).

function revocationCleanup(
    address _from,
    address _to,
    uint256 _blockNumber
) external returns (
    uint256);

Delete revocation entry that expired (i.e. is before cleanupBlockNumber). Method can only be called from the cleanerContract (which may be a proxy to external cleaners).

function revokeDelegationAt(
    address _from,
    address _to,
    uint256 _balance,
    uint256 _blockNumber
) external;

Revoke all vote power delegation from a delegator address to a delegatee address at a given block. Only affects the reads via votePowerOfAtCached in the block _blockNumber. This method should be used only to prevent rogue delegate voting in the current voting block. To stop delegating use delegate or delegateExplicit with value of 0, or undelegateAll/ undelegateAllExplicit.

function setCleanerContract(
    address _cleanerContract
) external;

Set the contract that is allowed to call history cleaning methods.

function setCleanupBlockNumber(
    uint256 _blockNumber
) external;

Set the cleanup block number. Historic data for the blocks before cleanupBlockNumber can be erased. History before that block should never be used since it can be inconsistent. In particular, cleanup block number must be lower than the current vote power block.

The method can be called only by the owner token.

function undelegateAll(
    address _from,
    uint256 _balance
) external;

Undelegate all voting power for a delegator address. Can only be used with percentage delegation. Does not reset delegation mode back to NOTSET.

function undelegateAllExplicit(
    address _from,
    address[] _delegateAddresses
) external returns (
    uint256);

Undelegate all explicit vote power by amount for a delegator address. Can only be used with explicit delegation. Does not reset delegation mode back to NOTSET.

function undelegatedVotePowerOf(
    address _owner,
    uint256 _balance
) external view returns (
    uint256);

Compute the current undelegated vote power of an address.

function undelegatedVotePowerOfAt(
    address _owner,
    uint256 _balance,
    uint256 _blockNumber
) external view returns (
    uint256);

Compute the undelegated vote power of an address at a given block.

function updateAtTokenTransfer(
    address _from,
    address _to,
    uint256 _fromBalance,
    uint256 _toBalance,
    uint256 _amount
) external;

Update vote powers when tokens are transferred. Also update delegated vote powers for percentage delegation and check for enough funds for explicit delegations.

function votePowerCacheCleanup(
    address _owner,
    uint256 _blockNumber
) external returns (
    uint256);

Delete vote power cache entry that expired (i.e. is before cleanupBlockNumber). Method can only be called from the cleanerContract (which may be a proxy to external cleaners).

function votePowerFromTo(
    address _from,
    address _to,
    uint256 _balance
) external view returns (
    uint256);

Get current delegated vote power from a delegator to a delegatee.

function votePowerFromToAt(
    address _from,
    address _to,
    uint256 _balance,
    uint256 _blockNumber
) external view returns (
    uint256);

Get delegated the vote power from a delegator to a delegatee at a given block number.

function votePowerHistoryCleanup(
    address _owner,
    uint256 _count
) external returns (
    uint256);

Delete vote power checkpoints that expired (i.e. are before cleanupBlockNumber). Method can only be called from the cleanerContract (which may be a proxy to external cleaners).

function votePowerOf(
    address _who
) external view returns (
    uint256);

Get the current vote power of an address.

function votePowerOfAt(
    address _who,
    uint256 _blockNumber
) public view returns (
    uint256);

Get the vote power of an address at a given block number

function votePowerOfAtCached(
    address _who,
    uint256 _blockNumber
) external returns (
    uint256);

Get the vote power of an address at a given block number. Reads/updates cache and upholds revocations.

function votePowerOfAtIgnoringRevocation(
    address _who,
    uint256 _blockNumber
) external view returns (
    uint256);

Get the vote power of an address at a given block number, ignoring revocation information and cache.

modifier notBeforeCleanupBlock(    uint256 _blockNumber)

Reading from history is not allowed before cleanupBlockNumber, since data before that might have been deleted and is thus unreliable.

modifier onlyCleaner()

History cleaning methods can be called only from cleanerContract.

modifier onlyExplicit(    address sender)

If a delegate cannot be added by explicit amount, revert.

modifier onlyOwnerToken()

All external methods in VPContract can only be executed by the owner token.

modifier onlyPercent(    address sender)

If a delegate cannot be added by percentage, revert.

    address cleanerContract

Address of the contract that is allowed to call methods for history cleaning.

    bool isReplacement

Return true if this IIVPContract is configured to be used as a replacement for other contract. It means that vote powers are not necessarily correct at the initialization, therefore every method that reads vote power must check whether it is initialized for that address and block.

    contract IVPToken ownerToken

The VPToken (or some other contract) that owns this VPContract. All state changing methods may be called only from this address. This is because original msg.sender is typically sent in a parameter and we must make sure that it cannot be faked by directly calling IIVPContract methods. Owner token is also used in case of replacement to recover vote powers from balances.