Commit fc17a1d9 by Leo Arias Committed by Francisco Giordano

Add usage docs to ERC20 Snapshot (#1639)

parent c44e40c2
...@@ -11,6 +11,11 @@ import "../token/ERC20/ERC20.sol"; ...@@ -11,6 +11,11 @@ import "../token/ERC20/ERC20.sol";
* https://github.com/Giveth/minime/blob/ea04d950eea153a04c51fa510b068b9dded390cb/contracts/MiniMeToken.sol * https://github.com/Giveth/minime/blob/ea04d950eea153a04c51fa510b068b9dded390cb/contracts/MiniMeToken.sol
* When a snapshot is made, the balances and totalSupply at the time of the snapshot are recorded for later * When a snapshot is made, the balances and totalSupply at the time of the snapshot are recorded for later
* access. * access.
*
* To make a snapshot, call the `snapshot` function, which will emit the `Snapshot` event and return a snapshot id.
* To get the total supply from a snapshot, call the function `totalSupplyAt` with the snapshot id.
* To get the balance of an account from a snapshot, call the `balanceOfAt` function with the snapshot id and the
* account address.
* @author Validity Labs AG <info@validitylabs.org> * @author Validity Labs AG <info@validitylabs.org>
*/ */
contract ERC20Snapshot is ERC20 { contract ERC20Snapshot is ERC20 {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment