IIVPToken#

function allowance(
    address owner,
    address spender
) external view returns (
    uint256);

Returns the remaining number of tokens that spender will be allowed to spend on behalf of owner through transferFrom. This is zero by default.

This value changes when approve or transferFrom are called.

function approve(
    address spender,
    uint256 amount
) external returns (
    bool);

Sets amount as the allowance of spender over the caller's tokens.

Returns a boolean value indicating whether the operation succeeded.

IMPORTANT: Beware that changing an allowance with this method brings the risk that someone may use both the old and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards: https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729

Emits an Approval event.

function balanceOf(
    address account
) external view returns (
    uint256);

Returns the amount of tokens owned by account.

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

Queries the token balance of _owner at a specific _blockNumber.

function batchDelegate(
    address[] _delegatees,
    uint256[] _bips
) external;

Undelegate all percentage delegations from the sender and then delegate corresponding _bips percentage of voting power from the sender to each member of the _delegatees array.

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

Return the vote power for several addresses.

function cleanupBlockNumber(
) external view returns (
    uint256);

Get the current cleanup block number set with setCleanupBlockNumber.

function decimals(
) external view returns (
    uint8);

Returns the number of decimals used to get its user representation. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5.05 (505 / 10²).

Tokens usually opt for a value of 18, imitating the relationship between Ether and wei. This is the default value returned by this function, unless it's overridden.

NOTE: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including balanceOf and transfer.

Should be compatible with ERC20 method.

function delegate(
    address _to,
    uint256 _bips
) external;

Delegate voting power to account _to from msg.sender, by percentage.

function delegateExplicit(
    address _to,
    uint256 _amount
) external;

Explicitly delegate _amount voting power to account _to from msg.sender. Compare with delegate which delegates by percentage.

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

Get the list of addresses to which _who is delegating, and their percentages.

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

Get the list of addresses to which _who is delegating, and their percentages, at the given block.

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

Get the delegation mode for account '_who'. This mode determines whether vote power is allocated by percentage or by explicit amount. Once the delegation mode is set, it can never be changed, even if all delegations are removed.

function governanceVotePower(
) external view returns (
    contract IGovernanceVotePower);

When set, allows token owners to participate in governance voting and delegating governance vote power.

function name(
) external view returns (
    string);

Returns the name of the token.

Should be compatible with ERC20 method.

function readVotePowerContract(
) external view returns (
    contract IVPContractEvents);

Returns VPContract event interface used for read-only operations (view methods). The only non-view method that might be called on it is revokeDelegationAt.

readVotePowerContract is almost always equal to writeVotePowerContract except during an upgrade from one VPContract to a new version (which should happen rarely or never and will be announced beforehand).

Do not call any methods on VPContract directly. State changing methods are forbidden from direct calls. All methods are exposed via VPToken. This is the reason that this method returns IVPContractEvents. Use it only for listening to events and revoking.

function revokeDelegationAt(
    address _who,
    uint256 _blockNumber
) external;

Revoke all delegation from sender to _who at given block. Only affects the reads via votePowerOfAtCached() in the block _blockNumber. Block _blockNumber must be in the past. This method should be used only to prevent rogue delegate voting in the current voting block. To stop delegating use delegate / 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.

function setCleanupBlockNumberManager(
    address _cleanupBlockNumberManager
) external;

Set the contract that is allowed to set cleanupBlockNumber. Usually this will be an instance of CleanupBlockNumberManager.

function setGovernanceVotePower(
    contract IIGovernanceVotePower _governanceVotePower
) external;

Sets new governance vote power contract that allows token owners to participate in governance voting and delegate governance vote power.

function symbol(
) external view returns (
    string);

Returns the symbol of the token, usually a shorter version of the name.

Should be compatible with ERC20 method.

function totalSupply(
) external view returns (
    uint256);

Returns the amount of tokens in existence.

function totalSupplyAt(
    uint256 _blockNumber
) external view returns (
    uint256);

Total amount of tokens held by all accounts at a specific block number.

function totalVotePower(
) external view returns (
    uint256);

Get the current total vote power.

function totalVotePowerAt(
    uint256 _blockNumber
) external view returns (
    uint256);

Get the total vote power at block _blockNumber.

function totalVotePowerAtCached(
    uint256 _blockNumber
) external returns (
    uint256);

Get the total vote power at block _blockNumber using cache. It tries to read the cached value and if it is not found, reads the actual value and stores it in the cache. Can only be used if _blockNumber is in the past, otherwise reverts.

function transfer(
    address recipient,
    uint256 amount
) external returns (
    bool);

Moves amount tokens from the caller's account to recipient.

Returns a boolean value indicating whether the operation succeeded.

Emits a Transfer event.

function transferFrom(
    address sender,
    address recipient,
    uint256 amount
) external returns (
    bool);

Moves amount tokens from sender to recipient using the allowance mechanism. amount is then deducted from the caller's allowance.

Returns a boolean value indicating whether the operation succeeded.

Emits a Transfer event.

function undelegateAll(
) external;

Undelegate all voting power of msg.sender. This effectively revokes all previous delegations. Can only be used with percentage delegation. Does not reset delegation mode back to NOT SET.

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

Undelegate all explicit vote power by amount of msg.sender. Can only be used with explicit delegation. Does not reset delegation mode back to NOT SET.

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

Compute the current undelegated vote power of the _owner account.

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

Get the undelegated vote power of the _owner account at a given block number.

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

Get current delegated vote power from delegator _from to delegatee _to.

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

Get delegated vote power from delegator _from to delegatee _to at _blockNumber.

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

Get the current vote power of _owner.

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

Get the vote power of _owner at block _blockNumber

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

Get the vote power of _owner at block _blockNumber using cache. It tries to read the cached value and if it is not found, reads the actual value and stores it in the cache. Can only be used if _blockNumber is in the past, otherwise reverts.

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

Get the vote power of _owner at block _blockNumber, ignoring revocation information (and cache).

function writeVotePowerContract(
) external view returns (
    contract IVPContractEvents);

Returns VPContract event interface used for state-changing operations (non-view methods). The only non-view method that might be called on it is revokeDelegationAt.

writeVotePowerContract is almost always equal to readVotePowerContract, except during upgrade from one VPContract to a new version (which should happen rarely or never and will be announced beforehand). In the case of an upgrade, writeVotePowerContract is replaced first to establish delegations. After some period (e.g., after a reward epoch ends), readVotePowerContract is set equal to it.

Do not call any methods on VPContract directly. State changing methods are forbidden from direct calls. All are exposed via VPToken. This is the reason that this method returns IVPContractEvents Use it only for listening to events, delegating, and revoking.