feat: upgraded FP contract to include burn-extension

Author: xtools-at

README.md

@@ -143,7 +143,7 @@ npx hardhat --network beam setupOFT --target-network ethereum --local-contract M
 # Ethereum
 npx hardhat --network ethereum setupOFT --target-network beam --local-contract MyUsdcProxyOFT --remote-contract MyUsdcOFT
 
-# important: add "--skip-adapter true" when _not_ using upgradeable contracts
+# important: add "--skip-adapter true" to the `setupOFT` command when *NOT* using upgradeable contracts (non-upgradeable contracts don't have this method)
 ```
 
 All done, let's test our bridge by transferring 20 USDC from Ethereum to Beam:
@@ -255,12 +255,12 @@ npx hardhat --network avalanche etherscan-verify
 
 ## Supported networks
 
-The LayerZero protocol is active on a wide selection of [test](https://docs.layerzero.network/v1/developers/technical-reference/testnet/testnet-addresses)- and
-[mainnets](https://docs.layerzero.network/v1/developers/technical-reference/mainnet/mainnet-addresses), though not all chains are interconnected by default.
+The LayerZero protocol is active on a wide selection of [test](https://docs.layerzero.network/v1/developers/evm/technical-reference/testnet/testnet-addresses)- and
+[mainnets](https://docs.layerzero.network/v1/developers/evm/technical-reference/mainnet/mainnet-addresses), though not all chains are interconnected by default.
 
 Currently, both Beam test- and mainnet connect to
 
-- Ethereum (Goerli & Sepolia on testnet)
+- Ethereum (Sepolia on testnet)
 - Avalanche C-Chain
 - BNB Smart Chain
 - Fantom

contracts/contracts-upgradable/examples/OFTPermit.sol

@@ -5,7 +5,32 @@ pragma solidity ^0.8.18;
 import "../token/oft/v2/fee/OFTWithFeePermitUpgradeable.sol";
 import "../token/oft/v2/fee/ProxyOFTWithFeeUpgradeable.sol";
 
-contract ForgottenPlaylandOFT is OFTWithFeePermitUpgradeable {}
+contract ForgottenPlaylandOFT is OFTWithFeePermitUpgradeable {
+    /**
+     * @dev Destroys `amount` tokens from the caller.
+     *
+     * See {ERC20-_burn}.
+     */
+    function burn(uint amount) public virtual {
+        _burn(_msgSender(), amount);
+    }
+
+    /**
+     * @dev Destroys `amount` tokens from `account`, deducting from the caller's
+     * allowance.
+     *
+     * See {ERC20-_burn} and {ERC20-allowance}.
+     *
+     * Requirements:
+     *
+     * - the caller must have allowance for ``accounts``'s tokens of at least
+     * `amount`.
+     */
+    function burnFrom(address account, uint amount) public virtual {
+        _spendAllowance(account, _msgSender(), amount);
+        _burn(account, amount);
+    }
+}
 
 contract ForgottenPlaylandProxyOFT is ProxyOFTWithFeeUpgradeable {}
 
@@ -16,3 +41,15 @@ contract CastleOfBlackwaterProxyOFT is ProxyOFTWithFeeUpgradeable {}
 contract BeamcatOFT is OFTWithFeePermitUpgradeable {}
 
 contract BeamcatProxyOFT is ProxyOFTWithFeeUpgradeable {}
+
+contract UfoOFT is OFTWithFeePermitUpgradeable {}
+
+contract UfoProxyOFT is ProxyOFTWithFeeUpgradeable {}
+
+contract GoldOFT is OFTWithFeePermitUpgradeable {
+    function decimals() public view virtual override returns (uint8) {
+        return 6;
+    }
+}
+
+contract GoldProxyOFT is ProxyOFTWithFeeUpgradeable {}