implement _burn()

latticexyz · Aug 28, 2024 · 0f64286 · 0f64286
1 parent 947d8b8
commit 0f64286
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/packages/world-module-erc20-own-store/src/MUDERC20.sol b/packages/world-module-erc20-own-store/src/MUDERC20.sol
@@ -120,6 +120,20 @@ contract MUDERC20 is Store, IERC20Errors, IERC20Events {
     _update(from, to, value);
   }
 
+  /**
+   * @dev Destroys a `value` amount of tokens from `account`, lowering the total supply.
+   * Relies on the `_update` mechanism.
+   *
+   * Emits a {Transfer} event with `to` set to the zero address.
+   *
+   */
+  function _burn(address account, uint256 value) internal {
+    if (account == address(0)) {
+        revert ERC20InvalidSender(address(0));
+    }
+    _update(account, address(0), value);
+  }
+
   /**
    * @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from`
    * (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding