ERC 20 Votes
Extension of ERC20 to support Compound-like voting and delegation. This version is more generic than Compound's, and supports token supply up to 2^224^ - 1, while COMP is limited to 2^96^ - 1. NOTE: If exact COMP compatibility is required, use the {ERC20VotesComp} variant of this module. This extension keeps a history (checkpoints) of each account's vote power. Vote power can be delegated either by calling the {delegate} function directly, or by providing a signature to be used with {delegateBySig}. Voting power can be queried through the public accessors {getVotes} and {getPastVotes}. By default, token balance does not account for voting power. This makes transfers cheaper. The downside is that it requires users to delegate to themselves in order to activate checkpoints and have their voting power tracked. Enabling self-delegation can easily be done by overriding the {delegates} function. Keep in mind however that this will significantly increase the base gas cost of transfers. Available since v4.2.
Methods
DOMAIN_SEPARATOR
See {IERC20Permit-DOMAIN_SEPARATOR}.
Returns
allowance
See {IERC20-allowance}.
Parameters
Returns
approve
See {IERC20-approve}. Requirements: - spender
cannot be the zero address.
Parameters
Returns
balanceOf
See {IERC20-balanceOf}.
Parameters
Returns
checkpoints
Get the pos
-th checkpoint for account
.
Parameters
Returns
decimals
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 ** 2
). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the value {ERC20} uses, unless this function is overridden; NOTE: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.
Returns
decreaseAllowance
Atomically decreases the allowance granted to spender
by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender
cannot be the zero address. - spender
must have allowance for the caller of at least subtractedValue
.
Parameters
Returns
delegate
Delegate votes from the sender to delegatee
.
Parameters
delegateBySig
Delegates votes from signer to delegatee
Parameters
delegates
Get the address account
is currently delegating to.
Parameters
Returns
getPastTotalSupply
Retrieve the totalSupply
at the end of blockNumber
. Note, this value is the sum of all balances. It is but NOT the sum of all the delegated votes! Requirements: - blockNumber
must have been already mined
Parameters
Returns
getPastVotes
Retrieve the number of votes for account
at the end of blockNumber
. Requirements: - blockNumber
must have been already mined
Parameters
Returns
getVotes
Gets the current votes balance for account
Parameters
Returns
increaseAllowance
Atomically increases the allowance granted to spender
by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender
cannot be the zero address.
Parameters
Returns
name
Returns the name of the token.
Returns
nonces
See {IERC20Permit-nonces}.
Parameters
Returns
numCheckpoints
Get number of checkpoints for account
.
Parameters
Returns
permit
See {IERC20Permit-permit}.
Parameters
symbol
Returns the symbol of the token, usually a shorter version of the name.
Returns
totalSupply
See {IERC20-totalSupply}.
Returns
transfer
See {IERC20-transfer}. Requirements: - recipient
cannot be the zero address. - the caller must have a balance of at least amount
.
Parameters
Returns
transferFrom
See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. Requirements: - sender
and recipient
cannot be the zero address. - sender
must have a balance of at least amount
. - the caller must have allowance for sender
's tokens of at least amount
.
Parameters
Returns
Events
Approval
Parameters
DelegateChanged
Emitted when an account changes their delegate.
Parameters
DelegateVotesChanged
Emitted when a token transfer or delegate change results in changes to an account's voting power.
Parameters
Transfer
Parameters
Last updated