ERC-20 合約逐步解說

1// SPDX-License-Identifier: MIT
複製

1pragma solidity >=0.6.0 <0.8.0;
複製

1/**
2 * @dev EIP 中定義的 ERC20 標準介面。
3 */
複製

1interface IERC20 {
複製

1    /**
2     * @dev 傳回現存的代幣數量。
3     */
4    function totalSupply() external view returns (uint256);
複製

1    /**
2     * @dev 傳回 `account` 擁有的代幣數量。
3     */
4    function balanceOf(address account) external view returns (uint256);
複製

1    /**
2     * @dev 將 `amount` 數量的代幣從呼叫者的帳戶轉移到 `recipient`。
3     *
4     * 傳回一個布林值，表示操作是否成功。
5     *
6     * 發出一個 {Transfer} 事件。
7     */
8    function transfer(address recipient, uint256 amount) external returns (bool);
複製

1    /**
2     * @dev 傳回 `spender` 將被允許透過 {transferFrom} 代表 `owner` 花費的
3     * 剩餘代幣數量。預設為零。
4     *
5     * 當 {approve} 或 {transferFrom} 被呼叫時，此值會改變。
6     */
7    function allowance(address owner, address spender) external view returns (uint256);
複製

1    /**
2     * @dev 將 `spender` 對呼叫者代幣的授權額度設為 `amount`。
3     *
4     * 傳回一個布林值，表示操作是否成功。
5     *
6     * 重要：請注意，使用此方法更改授權額度存在風險，
7     * 有人可能會因不幸的交易排序而同時使用舊的和新的授權額度。一種可能的解決方案是
8     * 先將花費者的授權額度降至 0，然後再設定所需的值，以減輕這種競爭
9     * 條件：
10     * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
11     *
12     * 發出一個 {Approval} 事件。
13     */
14    function approve(address spender, uint256 amount) external returns (bool);
顯示全部
複製

1    /**
2     * @dev 使用授權額度機制將 `amount` 的代幣從 `sender` 轉移到 `recipient`。
3     * 然後，`amount` 會從呼叫者的授權額度中扣除。
4     *
5     * 傳回一個布林值，表示操作是否成功。
6     *
7     * 發出一個 {Transfer} 事件。
8     */
9    function transferFrom(address sender, address recipient, uint256 amount) external returns (bool);
顯示全部
複製

1
2    /**
3     * @dev 當 `value` 數量的代幣從一個帳戶 (`from`) 移動到
4     * 另一個帳戶 (`to`) 時發出。
5     *
6     * 請注意 `value` 可能為零。
7     */
8    event Transfer(address indexed from, address indexed to, uint256 value);
9
10    /**
11     * @dev 當 `owner` 的 `spender` 的授權額度透過
12     * 呼叫 {approve} 設定時發出。`value` 是新的授權額度。
13     */
14    event Approval(address indexed owner, address indexed spender, uint256 value);
15}
顯示全部
複製

1// SPDX-License-Identifier: MIT
2pragma solidity >=0.6.0 <0.8.0;
複製

1
2import "../../GSN/Context.sol";
3import "./IERC20.sol";
4import "../../math/SafeMath.sol";
複製

1/**
2 * @dev {IERC20} 介面的實作。
3 *
4 * 此實作與代幣的創建方式無關。這意味著
5 * 必須在衍生合約中使用 {_mint} 新增供應機制。
6 * 若要使用通用機制，請參閱 {ERC20PresetMinterPauser}。
7 *
8 * 提示：詳細說明請參閱我們的指南
9 * https://forum.zeppelin.solutions/t/how-to-implement-erc20-supply-mechanisms/226[如何
10 * 實作供應機制]。
11 *
12 * 我們遵循了一般的 OpenZeppelin 指南：函式在失敗時會還原
13 * 而非傳回 `false`。此行為是常規的
14 * 且不與 ERC20 應用程式的預期衝突。
15 *
16 * 此外，在呼叫 {transferFrom} 時會發出 {Approval} 事件。
17 * 這允許應用程式僅透過監聽所述事件來重構所有帳戶的授權額度。
18 * EIP 的其他實作可能不會發出這些事件，
19 * 因為規範並未要求。
20 *
21 * 最後，新增了非標準的 {decreaseAllowance} 和 {increaseAllowance}
22 * 函式來緩解圍繞設定授權額度的眾所周知的問題。
23 * 請參閱 {IERC20-approve}。
24 */
25
顯示全部
複製

1contract ERC20 is Context, IERC20 {
複製

1
2    using SafeMath for uint256;
3
複製

1    mapping (address => uint256) private _balances;
複製

1    mapping (address => mapping (address => uint256)) private _allowances;
複製

1    uint256 private _totalSupply;
複製

1    string private _name;
2    string private _symbol;
3    uint8 private _decimals;
複製

1    /**
2     * @dev 設定 {name} 和 {symbol} 的值，並將 {decimals} 初始化為
3     * 預設值 18。
4     *
5     * 要為 {decimals} 選擇不同的值，請使用 {_setupDecimals}。
6     *
7     * 這三個值都是不可變的：它們只能在建構期間設定一次。
8     */
9    constructor (string memory name_, string memory symbol_) public {
10        // 在 Solidity ≥0.7.0 中，'public' 是隱含的，可以省略。
11
12        _name = name_;
13        _symbol = symbol_;
14        _decimals = 18;
15    }
顯示全部
複製

1    /**
2     * @dev 傳回代幣的名稱。
3     */
4    function name() public view returns (string memory) {
5        return _name;
6    }
7
8    /**
9     * @dev 傳回代幣的符號，通常是名稱的較短版本。
10     */
11    function symbol() public view returns (string memory) {
12        return _symbol;
13    }
14
15    /**
16     * @dev 傳回用於獲取其使用者表示的小數位數。
17     * 例如，如果 `decimals` 等於 `2`，`505` 代幣的餘額應
18     * 對使用者顯示為 `5,05` (`505 / 10 ** 2`)。
19     *
20     * 代幣通常選擇值 18，模仿以太幣和 wei 之間的關係。這是 {ERC20} 使用的值，
21     * 除非呼叫 {_setupDecimals}。
22     *
23     * 注意：此資訊僅用於 _顯示_ 目的：它在
24     * 任何方面都不會影響合約的任何算術，包括
25     * {IERC20-balanceOf} 和 {IERC20-transfer}。
26     */
27    function decimals() public view returns (uint8) {
28        return _decimals;
29    }
顯示全部
複製

1    /**
2     * @dev 請參閱 {IERC20-totalSupply}。
3     */
4    function totalSupply() public view override returns (uint256) {
5        return _totalSupply;
6    }
複製

1    /**
2     * @dev 請參閱 {IERC20-balanceOf}。
3     */
4    function balanceOf(address account) public view override returns (uint256) {
5        return _balances[account];
6    }
複製

1    /**
2     * @dev 請參閱 {IERC20-transfer}。
3     *
4     * 要求：
5     *
6     * - `recipient` 不能是零地址。
7     * - 呼叫者必須擁有至少 `amount` 的餘額。
8     */
9    function transfer(address recipient, uint256 amount) public virtual override returns (bool) {
顯示全部
複製

1        _transfer(_msgSender(), recipient, amount);
2        return true;
3    }
複製

1    /**
2     * @dev 請參閱 {IERC20-allowance}。
3     */
4    function allowance(address owner, address spender) public view virtual override returns (uint256) {
5        return _allowances[owner][spender];
6    }
複製

1    /**
2     * @dev 請參閱 {IERC20-approve}。
3     *
4     * 要求：
5     *
6     * - `spender` 不能是零地址。
7     */
8    function approve(address spender, uint256 amount) public virtual override returns (bool) {
複製

1        _approve(_msgSender(), spender, amount);
2        return true;
3    }
複製

1    /**
2     * @dev 請參閱 {IERC20-transferFrom}。
3     *
4     * 發出一個 {Approval} 事件，表示已更新的授權額度。這不是 EIP 所要求的。
5     * 請參閱 {ERC20} 開頭的說明。
6     *
7     * 要求：
8     *
9     * - `sender` 和 `recipient` 不能是零地址。
10     * - `sender` 必須擁有至少 `amount` 的餘額。
11     * - 呼叫者對 ``sender`` 的代幣的授權額度必須至少為
12     * `amount`。
13     */
14    function transferFrom(address sender, address recipient, uint256 amount) public virtual
15                                                override returns (bool) {
16        _transfer(sender, recipient, amount);
顯示全部
複製

1        _approve(sender, _msgSender(), _allowances[sender][_msgSender()].sub(amount,
2             "ERC20: transfer amount exceeds allowance"));
3        return true;
4    }
複製

1    /**
2     * @dev 以原子方式增加呼叫者授予 `spender` 的授權額度。
3     *
4     * 這是 {approve} 的替代方案，可用於緩解 {IERC20-approve} 中描述的問題。
5     *
6     * 發出一個 {Approval} 事件，表示已更新的授權額度。
7     *
8     * 要求：
9     *
10     * - `spender` 不能是零地址。
11     */
12    function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) {
13        _approve(_msgSender(), spender, _allowances[_msgSender()][spender].add(addedValue));
14        return true;
15    }
顯示全部
複製

1
2    /**
3     * @dev 以原子方式減少呼叫者授予 `spender` 的授權額度。
4     *
5     * 這是 {approve} 的替代方案，可用於緩解 {IERC20-approve} 中描述的問題。
6     *
7     * 發出一個 {Approval} 事件，表示已更新的授權額度。
8     *
9     * 要求：
10     *
11     * - `spender` 不能是零地址。
12     * - `spender` 對呼叫者的授權額度必須至少為
13     * `subtractedValue`。
14     */
15    function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) {
16        _approve(_msgSender(), spender, _allowances[_msgSender()][spender].sub(subtractedValue,
17                "ERC20: decreased allowance below zero"));
18        return true;
19    }
顯示全部
複製

1    /**
2     * @dev 將 `amount` 的代幣從 `sender` 轉移到 `recipient`。
3     *
4     * 這個內部函式相當於 {transfer}，可以用於
5     * 例如，實作自動代幣費用、削減機制等。
6     *
7     * 發出一個 {Transfer} 事件。
8     *
9     * 要求：
10     *
11     * - `sender` 不能是零地址。
12     * - `recipient` 不能是零地址。
13     * - `sender` 必須擁有至少 `amount` 的餘額。
14     */
15    function _transfer(address sender, address recipient, uint256 amount) internal virtual {
顯示全部
複製

1        require(sender != address(0), "ERC20: transfer from the zero address");
2        require(recipient != address(0), "ERC20: transfer to the zero address");
複製

1        _beforeTokenTransfer(sender, recipient, amount);
2
複製

1        _balances[sender] = _balances[sender].sub(amount, "ERC20: transfer amount exceeds balance");
2        _balances[recipient] = _balances[recipient].add(amount);
複製

1        emit Transfer(sender, recipient, amount);
2    }
複製

1    /** @dev 建立 `amount` 數量的代幣並將其分配給 `account`，增加
2     * 總供應量。
3     *
4     * 發出一個 `from` 設為零地址的 {Transfer} 事件。
5     *
6     * 要求：
7     *
8     * - `to` 不能是零地址。
9     */
10    function _mint(address account, uint256 amount) internal virtual {
11        require(account != address(0), "ERC20: mint to the zero address");
12        _beforeTokenTransfer(address(0), account, amount);
13        _totalSupply = _totalSupply.add(amount);
14        _balances[account] = _balances[account].add(amount);
15        emit Transfer(address(0), account, amount);
16    }
顯示全部
複製

1    /**
2     * @dev 從 `account` 銷毀 `amount` 數量的代幣，減少
3     * 總供應量。
4     *
5     * 發出一個 `to` 設為零地址的 {Transfer} 事件。
6     *
7     * 要求：
8     *
9     * - `account` 不能是零地址。
10     * - `account` 必須至少擁有 `amount` 數量的代幣。
11     */
12    function _burn(address account, uint256 amount) internal virtual {
13        require(account != address(0), "ERC20: burn from the zero address");
14
15        _beforeTokenTransfer(account, address(0), amount);
16
17        _balances[account] = _balances[account].sub(amount, "ERC20: burn amount exceeds balance");
18        _totalSupply = _totalSupply.sub(amount);
19        emit Transfer(account, address(0), amount);
20    }
顯示全部
複製

1    /**
2     * @dev 將 `spender` 對 `owner` 代幣的授權額度設為 `amount`。
3     *
4     * 這個內部函式等同於 `approve`，可以用於例如
5     * 為某些子系統設定自動授權額度等。
6     *
7     * 發出一個 {Approval} 事件。
8     *
9     * 要求：
10     *
11     * - `owner` 不能是零地址。
12     * - `spender` 不能是零地址。
13     */
14    function _approve(address owner, address spender, uint256 amount) internal virtual {
15        require(owner != address(0), "ERC20: approve from the zero address");
16        require(spender != address(0), "ERC20: approve to the zero address");
17
18        _allowances[owner][spender] = amount;
顯示全部
複製

1        emit Approval(owner, spender, amount);
2    }
3
複製

1
2
3    /**
4     * @dev 將 {decimals} 設為非預設值 18 的值。
5     *
6     * 警告：此函式只應在建構函式中呼叫。大多數
7     * 與代幣合約互動的應用程式不會預期
8     * {decimals} 會改變，如果改變了可能會運作不正確。
9     */
10    function _setupDecimals(uint8 decimals_) internal {
11        _decimals = decimals_;
12    }
顯示全部
複製

1
2    /**
3     * @dev 在任何代幣轉移之前呼叫的鉤子。這包括
4     * 鑄造和銷毀。
5     *
6     * 呼叫條件：
7     *
8     * - 當 `from` 和 `to` 都非零時，`amount` 數量的 ``from`` 的代幣
9     * 將被轉移到 `to`。
10     * - 當 `from` 為零時，將為 `to` 鑄造 `amount` 數量的代幣。
11     * - 當 `to` 為零時，`amount` 數量的 ``from`` 的代幣將被銷毀。
12     * - `from` 和 `to` 永遠不會同時為零。
13     *
14     * 要了解更多關於鉤子的資訊，請前往 xref:ROOT:extending-contracts.adoc#using-hooks[使用鉤子]。
15     */
16    function _beforeTokenTransfer(address from, address to, uint256 amount) internal virtual { }
17}
顯示全部
複製