Core functions
Last updated
Last updated
Allows you to check the token balance of an address. Returns token balance as uint.
Public function that anyone can call.
View function in that it does not modify the blockchain state - just reads from it.
_msgSender() is inherited from Context.sol, which is an abstract contract, defined as follows: function _msgSender() internal view virtual returns (address) { return msg.sender; }
Initially, this seems trivial as we could directly call msg.sender. However, as the documentation explains, they should not be accessed in such a direct manner, since when dealing with meta-transactions the account sending and paying for execution may not be the actual sender (as far as an application is concerned).
For regular transactions it returns msg.sender and for meta transactions it can be used to return the end user (rather than the relayer).
We will need to understand this function well, before we can move to appreciating what either transfer() or transferFrom() do.
In a nutshell, _transfer() updates both the token balance states of from and to , as provided. It is called on by both transfer() and transferFrom() -- which are commonly used in other Smart Contracts.
Both _beforeTokenTransfer and _afterTokenTransfer are hooks — empty function shells where we can use to inject our own custom functionality; without modifying _transfer() as it has been securely implemented.
It is often useful to perform some function each time tokens change hands. To that end, we should not modify _transfer as it is easy to write it insecurely. The solution therefore is to introduce hooks for custom functionality.
First two require statements are sanity checks.
The third ensures that you (address from), has the necessary balance to fulfil the transfer amount.
Subsequently, the token sender’s balance is updated to reflect the post-transaction figure. This is wrapped inside unchecked{}, to save gas.
The receiver’s token balance is incremented accordingly.
Finally the Transfer event is emitted.
The reason the "unchecked" keyword exists is to allow Solidity developers to write more efficient programs.
The default "checked" behaviour costs more gas when executing arithmetic operations, because under-the-hood those checks are implemented as a series of opcodes that, prior to performing the actual arithmetic, check for under/overflow and revert if it is detected.
If you are working on Solidity v0.8.0 or greater, and you are able to determine there is no possible way for your arithmetic to under/overflow (in this case, our 3rd require statement), then you can surround the arithmetic in an "unchecked" block.
_beforeTokenTransfer() and _afterTokenTransfer are hooks - empty functions for customization.
internal modifier means that the function can only be called within the contract itself and any derived contracts.
In this form, anyone can call _mint, which is not ideal. A typical implementation would be as follows, where the onlyOwner modifier is inherited from Ownable.sol
First is a sanity check, we obioculy cannot burn from a 0 address.
_beforeTokenTransfer is a hook, as is _afterTokenTransfer
Record current token balance of address
Check that balance exceeds burn
Unchecked to save gas since require statement was qualified: subtract burn amt from address balance
Update token’s total supply.
Emit Transfer event.
Similar to _mint, _burn in this form would be callable by anyone, hence onlyOwner is useful.
Stores current allowance into currentAllowance variable
If statement checks if currentAllowance is set to the maximum possible figure, else it ensures that currentAllowance is more than equals to the amount.
