ETH Price: $2,230.59 (-2.30%)

Transaction Decoder

Block:
16809307 at Mar-12-2023 03:34:11 AM +UTC
Transaction Fee:
0.002985760733186691 ETH $6.66
Gas Used:
150,691 Gas / 19.813796001 Gwei

Emitted Events:

117 TokenERC1155.TransferSingle( operator=[Sender] 0xe6ba139ff2f6c568ff7dfedd382d6888ec237852, from=0x00000000...000000000, to=[Sender] 0xe6ba139ff2f6c568ff7dfedd382d6888ec237852, id=0, value=1 )
118 TokenERC1155.TokensMinted( mintedTo=[Sender] 0xe6ba139ff2f6c568ff7dfedd382d6888ec237852, tokenIdMinted=0, uri=ipfs://Qme5hLRqEBnQ77FJxwKRjaq6ApVwDbAqr9au21CCWMrttx, quantityMinted=1 )
119 TokenERC1155.TokensMintedWithSignature( signer=0x5bE12d4b...B7A2A0aF8, mintedTo=[Sender] 0xe6ba139ff2f6c568ff7dfedd382d6888ec237852, tokenIdMinted=0, mintRequest=[{name:to, type:address, order:1, indexed:false, value:0xe6BA139FF2f6C568fF7DFEDd382D6888Ec237852, valueString:0xe6BA139FF2f6C568fF7DFEDd382D6888Ec237852}, {name:royaltyRecipient, type:address, order:2, indexed:false, value:0x0000000000000000000000000000000000000000, valueString:0x0000000000000000000000000000000000000000}, {name:royaltyBps, type:uint256, order:3, indexed:false, value:0, valueString:0}, {name:primarySaleRecipient, type:address, order:4, indexed:false, value:0x0000000000000000000000000000000000000000, valueString:0x0000000000000000000000000000000000000000}, {name:tokenId, type:uint256, order:5, indexed:false, value:0, valueString:0}, {name:uri, type:string, order:6, indexed:false, value:, valueString:}, {name:quantity, type:uint256, order:7, indexed:false, value:1, valueString:1}, {name:pricePerToken, type:uint256, order:8, indexed:false, value:690000000000000, valueString:690000000000000}, {name:currency, type:address, order:9, indexed:false, value:0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE, valueString:0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE}, {name:validityStartTimestamp, type:uint128, order:10, indexed:false, value:0, valueString:0}, {name:validityEndTimestamp, type:uint128, order:11, indexed:false, value:1993918585, valueString:1993918585}, {name:uid, type:bytes32, order:12, indexed:false, value:A413B2BEF4FCA1C521EAF27BBF62979415CE182F9F9F9D62E12107D8383819C3, valueString:A413B2BEF4FCA1C521EAF27BBF62979415CE182F9F9F9D62E12107D8383819C3}] )

Account State Difference:

  Address   Before After State Difference Code
0x138c3d30...e613a9008
(Mirror: Treasury)
253.286573656025238339 Eth253.287263656025238339 Eth0.00069
2.11582394732000926 Eth2.11583901642000926 Eth0.0000150691
0x84162fE2...616E44735
0xe6BA139F...8Ec237852
0.010750339476478563 Eth
Nonce: 12
0.007074578743291872 Eth
Nonce: 13
0.003675760733186691

Execution Trace

ETH 0.00069 TokenERC1155.mintWithSignature( _req=[{name:to, type:address, order:1, indexed:false, value:0xe6BA139FF2f6C568fF7DFEDd382D6888Ec237852, valueString:0xe6BA139FF2f6C568fF7DFEDd382D6888Ec237852}, {name:royaltyRecipient, type:address, order:2, indexed:false, value:0x0000000000000000000000000000000000000000, valueString:0x0000000000000000000000000000000000000000}, {name:royaltyBps, type:uint256, order:3, indexed:false, value:0, valueString:0}, {name:primarySaleRecipient, type:address, order:4, indexed:false, value:0x0000000000000000000000000000000000000000, valueString:0x0000000000000000000000000000000000000000}, {name:tokenId, type:uint256, order:5, indexed:false, value:0, valueString:0}, {name:uri, type:string, order:6, indexed:false, value:, valueString:}, {name:quantity, type:uint256, order:7, indexed:false, value:1, valueString:1}, {name:pricePerToken, type:uint256, order:8, indexed:false, value:690000000000000, valueString:690000000000000}, {name:currency, type:address, order:9, indexed:false, value:0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE, valueString:0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE}, {name:validityStartTimestamp, type:uint128, order:10, indexed:false, value:0, valueString:0}, {name:validityEndTimestamp, type:uint128, order:11, indexed:false, value:1993918585, valueString:1993918585}, {name:uid, type:bytes32, order:12, indexed:false, value:A413B2BEF4FCA1C521EAF27BBF62979415CE182F9F9F9D62E12107D8383819C3, valueString:A413B2BEF4FCA1C521EAF27BBF62979415CE182F9F9F9D62E12107D8383819C3}], _signature=0x0A3E9644FBFA3AA13B890339506850F85BA44EDA42B2C76F9B5A2F23785B7B810FC7CBCA46012D9201FF1C15DC66A400B314DC4C0206637197081DFDBA6AFE2E1C )
  • ETH 0.00069 TokenERC1155.mintWithSignature( _req=[{name:to, type:address, order:1, indexed:false, value:0xe6BA139FF2f6C568fF7DFEDd382D6888Ec237852, valueString:0xe6BA139FF2f6C568fF7DFEDd382D6888Ec237852}, {name:royaltyRecipient, type:address, order:2, indexed:false, value:0x0000000000000000000000000000000000000000, valueString:0x0000000000000000000000000000000000000000}, {name:royaltyBps, type:uint256, order:3, indexed:false, value:0, valueString:0}, {name:primarySaleRecipient, type:address, order:4, indexed:false, value:0x0000000000000000000000000000000000000000, valueString:0x0000000000000000000000000000000000000000}, {name:tokenId, type:uint256, order:5, indexed:false, value:0, valueString:0}, {name:uri, type:string, order:6, indexed:false, value:, valueString:}, {name:quantity, type:uint256, order:7, indexed:false, value:1, valueString:1}, {name:pricePerToken, type:uint256, order:8, indexed:false, value:690000000000000, valueString:690000000000000}, {name:currency, type:address, order:9, indexed:false, value:0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE, valueString:0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE}, {name:validityStartTimestamp, type:uint128, order:10, indexed:false, value:0, valueString:0}, {name:validityEndTimestamp, type:uint128, order:11, indexed:false, value:1993918585, valueString:1993918585}, {name:uid, type:bytes32, order:12, indexed:false, value:A413B2BEF4FCA1C521EAF27BBF62979415CE182F9F9F9D62E12107D8383819C3, valueString:A413B2BEF4FCA1C521EAF27BBF62979415CE182F9F9F9D62E12107D8383819C3}], _signature=0x0A3E9644FBFA3AA13B890339506850F85BA44EDA42B2C76F9B5A2F23785B7B810FC7CBCA46012D9201FF1C15DC66A400B314DC4C0206637197081DFDBA6AFE2E1C )
    • Null: 0x000...001.269514ba( )
    • ETH 0.00069 MirrorTreasury.CALL( )
      • TributaryRegistry.producerToTributary( 0x84162fE2E695Fedbf4D3bcA1c3458FB616E44735 ) => ( 0x0000000000000000000000000000000000000000 )
        File 1 of 4: TokenERC1155
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev Interface of the ERC165 standard, as defined in the
         * [EIP](https://eips.ethereum.org/EIPS/eip-165).
         *
         * Implementers can declare support of contract interfaces, which can then be
         * queried by others ({ERC165Checker}).
         *
         * For an implementation, see {ERC165}.
         */
        interface IERC165 {
            /**
             * @dev Returns true if this contract implements the interface defined by
             * `interfaceId`. See the corresponding
             * [EIP section](https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified)
             * to learn more about how these ids are created.
             *
             * This function call must use less than 30 000 gas.
             */
            function supportsInterface(bytes4 interfaceId) external view returns (bool);
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        /**
         * @title ERC20 interface
         * @dev see https://github.com/ethereum/EIPs/issues/20
         */
        interface IERC20 {
            function totalSupply() external view returns (uint256);
            function balanceOf(address who) external view returns (uint256);
            function allowance(address owner, address spender) external view returns (uint256);
            function transfer(address to, uint256 value) external returns (bool);
            function approve(address spender, uint256 value) external returns (bool);
            function transferFrom(
                address from,
                address to,
                uint256 value
            ) external returns (bool);
            event Transfer(address indexed from, address indexed to, uint256 value);
            event Approval(address indexed owner, address indexed spender, uint256 value);
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        import "./IERC165.sol";
        /**
         * @dev Interface for the NFT Royalty Standard.
         *
         * A standardized way to retrieve royalty payment information for non-fungible tokens (NFTs) to enable universal
         * support for royalty payments across all NFT marketplaces and ecosystem participants.
         *
         * _Available since v4.5._
         */
        interface IERC2981 is IERC165 {
            /**
             * @dev Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of
             * exchange. The royalty amount is denominated and should be payed in that same unit of exchange.
             */
            function royaltyInfo(uint256 tokenId, uint256 salePrice)
                external
                view
                returns (address receiver, uint256 royaltyAmount);
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        import { OperatorFiltererUpgradeable } from "./OperatorFiltererUpgradeable.sol";
        abstract contract DefaultOperatorFiltererUpgradeable is OperatorFiltererUpgradeable {
            address constant DEFAULT_SUBSCRIPTION = address(0x3cc6CddA760b79bAfa08dF41ECFA224f810dCeB6);
            function __DefaultOperatorFilterer_init() internal {
                OperatorFiltererUpgradeable.__OperatorFilterer_init(DEFAULT_SUBSCRIPTION, true);
            }
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        import "./interface/IOperatorFilterToggle.sol";
        abstract contract OperatorFilterToggle is IOperatorFilterToggle {
            bool public operatorRestriction;
            function setOperatorRestriction(bool _restriction) external {
                require(_canSetOperatorRestriction(), "Not authorized to set operator restriction.");
                _setOperatorRestriction(_restriction);
            }
            function _setOperatorRestriction(bool _restriction) internal {
                operatorRestriction = _restriction;
                emit OperatorRestriction(_restriction);
            }
            function _canSetOperatorRestriction() internal virtual returns (bool);
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        import "./interface/IOperatorFilterRegistry.sol";
        import "./OperatorFilterToggle.sol";
        abstract contract OperatorFiltererUpgradeable is OperatorFilterToggle {
            error OperatorNotAllowed(address operator);
            IOperatorFilterRegistry constant OPERATOR_FILTER_REGISTRY =
                IOperatorFilterRegistry(0x000000000000AAeB6D7670E522A718067333cd4E);
            function __OperatorFilterer_init(address subscriptionOrRegistrantToCopy, bool subscribe) internal {
                // If an inheriting token contract is deployed to a network without the registry deployed, the modifier
                // will not revert, but the contract will need to be registered with the registry once it is deployed in
                // order for the modifier to filter addresses.
                if (address(OPERATOR_FILTER_REGISTRY).code.length > 0) {
                    if (!OPERATOR_FILTER_REGISTRY.isRegistered(address(this))) {
                        if (subscribe) {
                            OPERATOR_FILTER_REGISTRY.registerAndSubscribe(address(this), subscriptionOrRegistrantToCopy);
                        } else {
                            if (subscriptionOrRegistrantToCopy != address(0)) {
                                OPERATOR_FILTER_REGISTRY.registerAndCopyEntries(address(this), subscriptionOrRegistrantToCopy);
                            } else {
                                OPERATOR_FILTER_REGISTRY.register(address(this));
                            }
                        }
                    }
                }
            }
            modifier onlyAllowedOperator(address from) virtual {
                // Check registry code length to facilitate testing in environments without a deployed registry.
                if (operatorRestriction) {
                    if (address(OPERATOR_FILTER_REGISTRY).code.length > 0) {
                        // Allow spending tokens from addresses with balance
                        // Note that this still allows listings and marketplaces with escrow to transfer tokens if transferred
                        // from an EOA.
                        if (from == msg.sender) {
                            _;
                            return;
                        }
                        if (!OPERATOR_FILTER_REGISTRY.isOperatorAllowed(address(this), msg.sender)) {
                            revert OperatorNotAllowed(msg.sender);
                        }
                    }
                }
                _;
            }
            modifier onlyAllowedOperatorApproval(address operator) virtual {
                // Check registry code length to facilitate testing in environments without a deployed registry.
                if (operatorRestriction) {
                    if (address(OPERATOR_FILTER_REGISTRY).code.length > 0) {
                        if (!OPERATOR_FILTER_REGISTRY.isOperatorAllowed(address(this), operator)) {
                            revert OperatorNotAllowed(operator);
                        }
                    }
                }
                _;
            }
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        interface IOperatorFilterRegistry {
            function isOperatorAllowed(address registrant, address operator) external view returns (bool);
            function register(address registrant) external;
            function registerAndSubscribe(address registrant, address subscription) external;
            function registerAndCopyEntries(address registrant, address registrantToCopy) external;
            function unregister(address addr) external;
            function updateOperator(
                address registrant,
                address operator,
                bool filtered
            ) external;
            function updateOperators(
                address registrant,
                address[] calldata operators,
                bool filtered
            ) external;
            function updateCodeHash(
                address registrant,
                bytes32 codehash,
                bool filtered
            ) external;
            function updateCodeHashes(
                address registrant,
                bytes32[] calldata codeHashes,
                bool filtered
            ) external;
            function subscribe(address registrant, address registrantToSubscribe) external;
            function unsubscribe(address registrant, bool copyExistingEntries) external;
            function subscriptionOf(address addr) external returns (address registrant);
            function subscribers(address registrant) external returns (address[] memory);
            function subscriberAt(address registrant, uint256 index) external returns (address);
            function copyEntriesOf(address registrant, address registrantToCopy) external;
            function isOperatorFiltered(address registrant, address operator) external returns (bool);
            function isCodeHashOfFiltered(address registrant, address operatorWithCode) external returns (bool);
            function isCodeHashFiltered(address registrant, bytes32 codeHash) external returns (bool);
            function filteredOperators(address addr) external returns (address[] memory);
            function filteredCodeHashes(address addr) external returns (bytes32[] memory);
            function filteredOperatorAt(address registrant, uint256 index) external returns (address);
            function filteredCodeHashAt(address registrant, uint256 index) external returns (bytes32);
            function isRegistered(address addr) external returns (bool);
            function codeHashOf(address addr) external returns (bytes32);
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        interface IOperatorFilterToggle {
            event OperatorRestriction(bool restriction);
            function operatorRestriction() external view returns (bool);
            function setOperatorRestriction(bool restriction) external;
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        /**
         *  Thirdweb's `Ownable` is a contract extension to be used with any base contract. It exposes functions for setting and reading
         *  who the 'owner' of the inheriting smart contract is, and lets the inheriting contract perform conditional logic that uses
         *  information about who the contract's owner is.
         */
        interface IOwnable {
            /// @dev Returns the owner of the contract.
            function owner() external view returns (address);
            /// @dev Lets a module admin set a new owner for the contract. The new owner must be a module admin.
            function setOwner(address _newOwner) external;
            /// @dev Emitted when a new Owner is set.
            event OwnerUpdated(address indexed prevOwner, address indexed newOwner);
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        /**
         *  Thirdweb's `PlatformFee` is a contract extension to be used with any base contract. It exposes functions for setting and reading
         *  the recipient of platform fee and the platform fee basis points, and lets the inheriting contract perform conditional logic
         *  that uses information about platform fees, if desired.
         */
        interface IPlatformFee {
            /// @dev Returns the platform fee bps and recipient.
            function getPlatformFeeInfo() external view returns (address, uint16);
            /// @dev Lets a module admin update the fees on primary sales.
            function setPlatformFeeInfo(address _platformFeeRecipient, uint256 _platformFeeBps) external;
            /// @dev Emitted when fee on primary sales is updated.
            event PlatformFeeInfoUpdated(address indexed platformFeeRecipient, uint256 platformFeeBps);
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        /**
         *  Thirdweb's `Primary` is a contract extension to be used with any base contract. It exposes functions for setting and reading
         *  the recipient of primary sales, and lets the inheriting contract perform conditional logic that uses information about
         *  primary sales, if desired.
         */
        interface IPrimarySale {
            /// @dev The adress that receives all primary sales value.
            function primarySaleRecipient() external view returns (address);
            /// @dev Lets a module admin set the default recipient of all primary sales.
            function setPrimarySaleRecipient(address _saleRecipient) external;
            /// @dev Emitted when a new sale recipient is set.
            event PrimarySaleRecipientUpdated(address indexed recipient);
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        import "../../eip/interface/IERC2981.sol";
        /**
         *  Thirdweb's `Royalty` is a contract extension to be used with any base contract. It exposes functions for setting and reading
         *  the recipient of royalty fee and the royalty fee basis points, and lets the inheriting contract perform conditional logic
         *  that uses information about royalty fees, if desired.
         *
         *  The `Royalty` contract is ERC2981 compliant.
         */
        interface IRoyalty is IERC2981 {
            struct RoyaltyInfo {
                address recipient;
                uint256 bps;
            }
            /// @dev Returns the royalty recipient and fee bps.
            function getDefaultRoyaltyInfo() external view returns (address, uint16);
            /// @dev Lets a module admin update the royalty bps and recipient.
            function setDefaultRoyaltyInfo(address _royaltyRecipient, uint256 _royaltyBps) external;
            /// @dev Lets a module admin set the royalty recipient for a particular token Id.
            function setRoyaltyInfoForToken(
                uint256 tokenId,
                address recipient,
                uint256 bps
            ) external;
            /// @dev Returns the royalty recipient for a particular token Id.
            function getRoyaltyInfoForToken(uint256 tokenId) external view returns (address, uint16);
            /// @dev Emitted when royalty info is updated.
            event DefaultRoyalty(address indexed newRoyaltyRecipient, uint256 newRoyaltyBps);
            /// @dev Emitted when royalty recipient for tokenId is set
            event RoyaltyForToken(uint256 indexed tokenId, address indexed royaltyRecipient, uint256 royaltyBps);
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.11;
        interface IThirdwebContract {
            /// @dev Returns the module type of the contract.
            function contractType() external pure returns (bytes32);
            /// @dev Returns the version of the contract.
            function contractVersion() external pure returns (uint8);
            /// @dev Returns the metadata URI of the contract.
            function contractURI() external view returns (string memory);
            /**
             *  @dev Sets contract URI for the storefront-level metadata of the contract.
             *       Only module admin can call this function.
             */
            function setContractURI(string calldata _uri) external;
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        interface IWETH {
            function deposit() external payable;
            function withdraw(uint256 amount) external;
            function transfer(address to, uint256 value) external returns (bool);
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.11;
        import "@openzeppelin/contracts-upgradeable/token/ERC1155/IERC1155Upgradeable.sol";
        /**
         *  `SignatureMint1155` is an ERC 1155 contract. It lets anyone mint NFTs by producing a mint request
         *  and a signature (produced by an account with MINTER_ROLE, signing the mint request).
         */
        interface ITokenERC1155 is IERC1155Upgradeable {
            /**
             *  @notice The body of a request to mint NFTs.
             *
             *  @param to The receiver of the NFTs to mint.
             *  @param royaltyRecipient The recipient of the minted NFT's secondary sales royalties.
             *  @param primarySaleRecipient The recipient of the minted NFT's primary sales proceeds.
             *  @param tokenId Optional: specify only if not first mint.
             *  @param uri The URI of the NFT to mint.
             *  @param quantity The quantity of NFTs to mint.
             *  @param pricePerToken Price to pay for minting with the signature.
             *  @param currency The currency in which the price per token must be paid.
             *  @param validityStartTimestamp The unix timestamp after which the request is valid.
             *  @param validityEndTimestamp The unix timestamp after which the request expires.
             *  @param uid A unique identifier for the request.
             */
            struct MintRequest {
                address to;
                address royaltyRecipient;
                uint256 royaltyBps;
                address primarySaleRecipient;
                uint256 tokenId;
                string uri;
                uint256 quantity;
                uint256 pricePerToken;
                address currency;
                uint128 validityStartTimestamp;
                uint128 validityEndTimestamp;
                bytes32 uid;
            }
            /// @dev Emitted when an account with MINTER_ROLE mints an NFT.
            event TokensMinted(address indexed mintedTo, uint256 indexed tokenIdMinted, string uri, uint256 quantityMinted);
            /// @dev Emitted when tokens are minted.
            event TokensMintedWithSignature(
                address indexed signer,
                address indexed mintedTo,
                uint256 indexed tokenIdMinted,
                MintRequest mintRequest
            );
            /**
             *  @notice Verifies that a mint request is signed by an account holding
             *         MINTER_ROLE (at the time of the function call).
             *
             *  @param req The mint request.
             *  @param signature The signature produced by an account signing the mint request.
             *
             *  returns (success, signer) Result of verification and the recovered address.
             */
            function verify(MintRequest calldata req, bytes calldata signature)
                external
                view
                returns (bool success, address signer);
            /**
             *  @notice Lets an account with MINTER_ROLE mint an NFT.
             *
             *  @param to The address to mint the NFT to.
             *  @param tokenId The tokenId of the NFTs to mint
             *  @param uri The URI to assign to the NFT.
             *  @param amount The number of copies of the NFT to mint.
             *
             */
            function mintTo(
                address to,
                uint256 tokenId,
                string calldata uri,
                uint256 amount
            ) external;
            /**
             *  @notice Mints an NFT according to the provided mint request.
             *
             *  @param req The mint request.
             *  @param signature he signature produced by an account signing the mint request.
             */
            function mintWithSignature(MintRequest calldata req, bytes calldata signature) external payable;
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        // Helper interfaces
        import { IWETH } from "../interfaces/IWETH.sol";
        import "../openzeppelin-presets/token/ERC20/utils/SafeERC20.sol";
        library CurrencyTransferLib {
            using SafeERC20 for IERC20;
            /// @dev The address interpreted as native token of the chain.
            address public constant NATIVE_TOKEN = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE;
            /// @dev Transfers a given amount of currency.
            function transferCurrency(
                address _currency,
                address _from,
                address _to,
                uint256 _amount
            ) internal {
                if (_amount == 0) {
                    return;
                }
                if (_currency == NATIVE_TOKEN) {
                    safeTransferNativeToken(_to, _amount);
                } else {
                    safeTransferERC20(_currency, _from, _to, _amount);
                }
            }
            /// @dev Transfers a given amount of currency. (With native token wrapping)
            function transferCurrencyWithWrapper(
                address _currency,
                address _from,
                address _to,
                uint256 _amount,
                address _nativeTokenWrapper
            ) internal {
                if (_amount == 0) {
                    return;
                }
                if (_currency == NATIVE_TOKEN) {
                    if (_from == address(this)) {
                        // withdraw from weth then transfer withdrawn native token to recipient
                        IWETH(_nativeTokenWrapper).withdraw(_amount);
                        safeTransferNativeTokenWithWrapper(_to, _amount, _nativeTokenWrapper);
                    } else if (_to == address(this)) {
                        // store native currency in weth
                        require(_amount == msg.value, "msg.value != amount");
                        IWETH(_nativeTokenWrapper).deposit{ value: _amount }();
                    } else {
                        safeTransferNativeTokenWithWrapper(_to, _amount, _nativeTokenWrapper);
                    }
                } else {
                    safeTransferERC20(_currency, _from, _to, _amount);
                }
            }
            /// @dev Transfer `amount` of ERC20 token from `from` to `to`.
            function safeTransferERC20(
                address _currency,
                address _from,
                address _to,
                uint256 _amount
            ) internal {
                if (_from == _to) {
                    return;
                }
                if (_from == address(this)) {
                    IERC20(_currency).safeTransfer(_to, _amount);
                } else {
                    IERC20(_currency).safeTransferFrom(_from, _to, _amount);
                }
            }
            /// @dev Transfers `amount` of native token to `to`.
            function safeTransferNativeToken(address to, uint256 value) internal {
                // solhint-disable avoid-low-level-calls
                // slither-disable-next-line low-level-calls
                (bool success, ) = to.call{ value: value }("");
                require(success, "native token transfer failed");
            }
            /// @dev Transfers `amount` of native token to `to`. (With native token wrapping)
            function safeTransferNativeTokenWithWrapper(
                address to,
                uint256 value,
                address _nativeTokenWrapper
            ) internal {
                // solhint-disable avoid-low-level-calls
                // slither-disable-next-line low-level-calls
                (bool success, ) = to.call{ value: value }("");
                if (!success) {
                    IWETH(_nativeTokenWrapper).deposit{ value: value }();
                    IERC20(_nativeTokenWrapper).safeTransfer(to, value);
                }
            }
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.11;
        /// @author thirdweb
        library FeeType {
            uint256 internal constant PRIMARY_SALE = 0;
            uint256 internal constant MARKET_SALE = 1;
            uint256 internal constant SPLIT = 2;
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        /**
         * @dev Collection of functions related to the address type
         */
        library TWAddress {
            /**
             * @dev Returns true if `account` is a contract.
             *
             * [IMPORTANT]
             * ====
             * It is unsafe to assume that an address for which this function returns
             * false is an externally-owned account (EOA) and not a contract.
             *
             * Among others, `isContract` will return false for the following
             * types of addresses:
             *
             *  - an externally-owned account
             *  - a contract in construction
             *  - an address where a contract will be created
             *  - an address where a contract lived, but was destroyed
             * ====
             *
             * [IMPORTANT]
             * ====
             * You shouldn't rely on `isContract` to protect against flash loan attacks!
             *
             * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
             * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
             * constructor.
             * ====
             */
            function isContract(address account) internal view returns (bool) {
                // This method relies on extcodesize/address.code.length, which returns 0
                // for contracts in construction, since the code is only stored at the end
                // of the constructor execution.
                return account.code.length > 0;
            }
            /**
             * @dev Replacement for Solidity's `transfer`: sends `amount` wei to
             * `recipient`, forwarding all available gas and reverting on errors.
             *
             * [EIP1884](https://eips.ethereum.org/EIPS/eip-1884) increases the gas cost
             * of certain opcodes, possibly making contracts go over the 2300 gas limit
             * imposed by `transfer`, making them unable to receive funds via
             * `transfer`. {sendValue} removes this limitation.
             *
             * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
             *
             * IMPORTANT: because control is transferred to `recipient`, care must be
             * taken to not create reentrancy vulnerabilities. Consider using
             * {ReentrancyGuard} or the
             * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
             */
            function sendValue(address payable recipient, uint256 amount) internal {
                require(address(this).balance >= amount, "Address: insufficient balance");
                (bool success, ) = recipient.call{ value: amount }("");
                require(success, "Address: unable to send value, recipient may have reverted");
            }
            /**
             * @dev Performs a Solidity function call using a low level `call`. A
             * plain `call` is an unsafe replacement for a function call: use this
             * function instead.
             *
             * If `target` reverts with a revert reason, it is bubbled up by this
             * function (like regular Solidity function calls).
             *
             * Returns the raw returned data. To convert to the expected return value,
             * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
             *
             * Requirements:
             *
             * - `target` must be a contract.
             * - calling `target` with `data` must not revert.
             *
             * _Available since v3.1._
             */
            function functionCall(address target, bytes memory data) internal returns (bytes memory) {
                return functionCall(target, data, "Address: low-level call failed");
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
             * `errorMessage` as a fallback revert reason when `target` reverts.
             *
             * _Available since v3.1._
             */
            function functionCall(
                address target,
                bytes memory data,
                string memory errorMessage
            ) internal returns (bytes memory) {
                return functionCallWithValue(target, data, 0, errorMessage);
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
             * but also transferring `value` wei to `target`.
             *
             * Requirements:
             *
             * - the calling contract must have an ETH balance of at least `value`.
             * - the called Solidity function must be `payable`.
             *
             * _Available since v3.1._
             */
            function functionCallWithValue(
                address target,
                bytes memory data,
                uint256 value
            ) internal returns (bytes memory) {
                return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
            }
            /**
             * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
             * with `errorMessage` as a fallback revert reason when `target` reverts.
             *
             * _Available since v3.1._
             */
            function functionCallWithValue(
                address target,
                bytes memory data,
                uint256 value,
                string memory errorMessage
            ) internal returns (bytes memory) {
                require(address(this).balance >= value, "Address: insufficient balance for call");
                require(isContract(target), "Address: call to non-contract");
                (bool success, bytes memory returndata) = target.call{ value: value }(data);
                return verifyCallResult(success, returndata, errorMessage);
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
             * but performing a static call.
             *
             * _Available since v3.3._
             */
            function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
                return functionStaticCall(target, data, "Address: low-level static call failed");
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
             * but performing a static call.
             *
             * _Available since v3.3._
             */
            function functionStaticCall(
                address target,
                bytes memory data,
                string memory errorMessage
            ) internal view returns (bytes memory) {
                require(isContract(target), "Address: static call to non-contract");
                (bool success, bytes memory returndata) = target.staticcall(data);
                return verifyCallResult(success, returndata, errorMessage);
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
             * but performing a delegate call.
             *
             * _Available since v3.4._
             */
            function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
                return functionDelegateCall(target, data, "Address: low-level delegate call failed");
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
             * but performing a delegate call.
             *
             * _Available since v3.4._
             */
            function functionDelegateCall(
                address target,
                bytes memory data,
                string memory errorMessage
            ) internal returns (bytes memory) {
                require(isContract(target), "Address: delegate call to non-contract");
                (bool success, bytes memory returndata) = target.delegatecall(data);
                return verifyCallResult(success, returndata, errorMessage);
            }
            /**
             * @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
             * revert reason using the provided one.
             *
             * _Available since v4.3._
             */
            function verifyCallResult(
                bool success,
                bytes memory returndata,
                string memory errorMessage
            ) internal pure returns (bytes memory) {
                if (success) {
                    return returndata;
                } else {
                    // Look for revert reason and bubble it up if present
                    if (returndata.length > 0) {
                        // The easiest way to bubble the revert reason is using memory via assembly
                        assembly {
                            let returndata_size := mload(returndata)
                            revert(add(32, returndata), returndata_size)
                        }
                    } else {
                        revert(errorMessage);
                    }
                }
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.0 (metatx/ERC2771Context.sol)
        pragma solidity ^0.8.11;
        import "@openzeppelin/contracts-upgradeable/utils/ContextUpgradeable.sol";
        import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
        /**
         * @dev Context variant with ERC2771 support.
         */
        abstract contract ERC2771ContextUpgradeable is Initializable, ContextUpgradeable {
            mapping(address => bool) private _trustedForwarder;
            function __ERC2771Context_init(address[] memory trustedForwarder) internal onlyInitializing {
                __Context_init_unchained();
                __ERC2771Context_init_unchained(trustedForwarder);
            }
            function __ERC2771Context_init_unchained(address[] memory trustedForwarder) internal onlyInitializing {
                for (uint256 i = 0; i < trustedForwarder.length; i++) {
                    _trustedForwarder[trustedForwarder[i]] = true;
                }
            }
            function isTrustedForwarder(address forwarder) public view virtual returns (bool) {
                return _trustedForwarder[forwarder];
            }
            function _msgSender() internal view virtual override returns (address sender) {
                if (isTrustedForwarder(msg.sender)) {
                    // The assembly code is more direct than the Solidity version using `abi.decode`.
                    assembly {
                        sender := shr(96, calldataload(sub(calldatasize(), 20)))
                    }
                } else {
                    return super._msgSender();
                }
            }
            function _msgData() internal view virtual override returns (bytes calldata) {
                if (isTrustedForwarder(msg.sender)) {
                    return msg.data[:msg.data.length - 20];
                } else {
                    return super._msgData();
                }
            }
            uint256[49] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (token/ERC20/utils/SafeERC20.sol)
        pragma solidity ^0.8.0;
        import "../../../../eip/interface/IERC20.sol";
        import "../../../../lib/TWAddress.sol";
        /**
         * @title SafeERC20
         * @dev Wrappers around ERC20 operations that throw on failure (when the token
         * contract returns false). Tokens that return no value (and instead revert or
         * throw on failure) are also supported, non-reverting calls are assumed to be
         * successful.
         * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
         * which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
         */
        library SafeERC20 {
            using TWAddress for address;
            function safeTransfer(
                IERC20 token,
                address to,
                uint256 value
            ) internal {
                _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
            }
            function safeTransferFrom(
                IERC20 token,
                address from,
                address to,
                uint256 value
            ) internal {
                _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
            }
            /**
             * @dev Deprecated. This function has issues similar to the ones found in
             * {IERC20-approve}, and its usage is discouraged.
             *
             * Whenever possible, use {safeIncreaseAllowance} and
             * {safeDecreaseAllowance} instead.
             */
            function safeApprove(
                IERC20 token,
                address spender,
                uint256 value
            ) internal {
                // safeApprove should only be called when setting an initial allowance,
                // or when resetting it to zero. To increase and decrease it, use
                // 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
                require(
                    (value == 0) || (token.allowance(address(this), spender) == 0),
                    "SafeERC20: approve from non-zero to non-zero allowance"
                );
                _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
            }
            function safeIncreaseAllowance(
                IERC20 token,
                address spender,
                uint256 value
            ) internal {
                uint256 newAllowance = token.allowance(address(this), spender) + value;
                _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
            }
            function safeDecreaseAllowance(
                IERC20 token,
                address spender,
                uint256 value
            ) internal {
                unchecked {
                    uint256 oldAllowance = token.allowance(address(this), spender);
                    require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
                    uint256 newAllowance = oldAllowance - value;
                    _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
                }
            }
            /**
             * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
             * on the return value: the return value is optional (but if data is returned, it must not be false).
             * @param token The token targeted by the call.
             * @param data The call data (encoded using abi.encode or one of its variants).
             */
            function _callOptionalReturn(IERC20 token, bytes memory data) private {
                // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
                // we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that
                // the target address contains contract code and also asserts for success in the low-level call.
                bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
                if (returndata.length > 0) {
                    // Return data is optional
                    require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
                }
            }
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.11;
        /// @author thirdweb
        //   $$\\     $$\\       $$\\                 $$\\                         $$\\
        //   $$ |    $$ |      \\__|                $$ |                        $$ |
        // $$$$$$\\   $$$$$$$\\  $$\\  $$$$$$\\   $$$$$$$ |$$\\  $$\\  $$\\  $$$$$$\\  $$$$$$$\\
        // \\_$$  _|  $$  __$$\\ $$ |$$  __$$\\ $$  __$$ |$$ | $$ | $$ |$$  __$$\\ $$  __$$\\
        //   $$ |    $$ |  $$ |$$ |$$ |  \\__|$$ /  $$ |$$ | $$ | $$ |$$$$$$$$ |$$ |  $$ |
        //   $$ |$$\\ $$ |  $$ |$$ |$$ |      $$ |  $$ |$$ | $$ | $$ |$$   ____|$$ |  $$ |
        //   \\$$$$  |$$ |  $$ |$$ |$$ |      \\$$$$$$$ |\\$$$$$\\$$$$  |\\$$$$$$$\\ $$$$$$$  |
        //    \\____/ \\__|  \\__|\\__|\\__|       \\_______| \\_____\\____/  \\_______|\\_______/
        // Interface
        import { ITokenERC1155 } from "../interfaces/token/ITokenERC1155.sol";
        import "../interfaces/IThirdwebContract.sol";
        import "../extension/interface/IPlatformFee.sol";
        import "../extension/interface/IPrimarySale.sol";
        import "../extension/interface/IRoyalty.sol";
        import "../extension/interface/IOwnable.sol";
        // Token
        import "@openzeppelin/contracts-upgradeable/token/ERC1155/ERC1155Upgradeable.sol";
        // Signature utils
        import "@openzeppelin/contracts-upgradeable/utils/cryptography/ECDSAUpgradeable.sol";
        import "@openzeppelin/contracts-upgradeable/utils/cryptography/draft-EIP712Upgradeable.sol";
        // Access Control + security
        import "@openzeppelin/contracts-upgradeable/access/AccessControlEnumerableUpgradeable.sol";
        import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
        // Utils
        import "@openzeppelin/contracts-upgradeable/utils/StringsUpgradeable.sol";
        import "@openzeppelin/contracts-upgradeable/utils/MulticallUpgradeable.sol";
        import "../lib/CurrencyTransferLib.sol";
        import "../lib/FeeType.sol";
        import "../openzeppelin-presets/metatx/ERC2771ContextUpgradeable.sol";
        // Helper interfaces
        import "@openzeppelin/contracts-upgradeable/interfaces/IERC2981Upgradeable.sol";
        // OpenSea operator filter
        import "../extension/DefaultOperatorFiltererUpgradeable.sol";
        contract TokenERC1155 is
            Initializable,
            IThirdwebContract,
            IOwnable,
            IRoyalty,
            IPrimarySale,
            IPlatformFee,
            EIP712Upgradeable,
            ReentrancyGuardUpgradeable,
            ERC2771ContextUpgradeable,
            MulticallUpgradeable,
            AccessControlEnumerableUpgradeable,
            DefaultOperatorFiltererUpgradeable,
            ERC1155Upgradeable,
            ITokenERC1155
        {
            using ECDSAUpgradeable for bytes32;
            using StringsUpgradeable for uint256;
            bytes32 private constant MODULE_TYPE = bytes32("TokenERC1155");
            uint256 private constant VERSION = 1;
            /// @dev Fee type variants: percentage fee and flat fee
            enum PlatformFeeType {
                Bps,
                Flat
            }
            // Token name
            string public name;
            // Token symbol
            string public symbol;
            bytes32 private constant TYPEHASH =
                keccak256(
                    "MintRequest(address to,address royaltyRecipient,uint256 royaltyBps,address primarySaleRecipient,uint256 tokenId,string uri,uint256 quantity,uint256 pricePerToken,address currency,uint128 validityStartTimestamp,uint128 validityEndTimestamp,bytes32 uid)"
                );
            /// @dev Only TRANSFER_ROLE holders can have tokens transferred from or to them, during restricted transfers.
            bytes32 private constant TRANSFER_ROLE = keccak256("TRANSFER_ROLE");
            /// @dev Only MINTER_ROLE holders can sign off on `MintRequest`s.
            bytes32 private constant MINTER_ROLE = keccak256("MINTER_ROLE");
            /// @dev Max bps in the thirdweb system
            uint256 private constant MAX_BPS = 10_000;
            /// @dev Owner of the contract (purpose: OpenSea compatibility, etc.)
            address private _owner;
            /// @dev The next token ID of the NFT to mint.
            uint256 public nextTokenIdToMint;
            /// @dev The adress that receives all primary sales value.
            address public primarySaleRecipient;
            /// @dev The adress that receives all primary sales value.
            address public platformFeeRecipient;
            /// @dev The recipient of who gets the royalty.
            address private royaltyRecipient;
            /// @dev The percentage of royalty how much royalty in basis points.
            uint128 private royaltyBps;
            /// @dev The % of primary sales collected by the contract as fees.
            uint128 private platformFeeBps;
            /// @dev The flat amount collected by the contract as fees on primary sales.
            uint256 private flatPlatformFee;
            /// @dev Fee type variants: percentage fee and flat fee
            PlatformFeeType private platformFeeType;
            /// @dev Contract level metadata.
            string public contractURI;
            /// @dev Mapping from mint request UID => whether the mint request is processed.
            mapping(bytes32 => bool) private minted;
            mapping(uint256 => string) private _tokenURI;
            /// @dev Token ID => total circulating supply of tokens with that ID.
            mapping(uint256 => uint256) public totalSupply;
            /// @dev Token ID => the address of the recipient of primary sales.
            mapping(uint256 => address) public saleRecipientForToken;
            /// @dev Token ID => royalty recipient and bps for token
            mapping(uint256 => RoyaltyInfo) private royaltyInfoForToken;
            /// @dev Emitted when flat fee on primary sales is updated.
            event FlatPlatformFeeUpdated(address platformFeeRecipient, uint256 flatFee);
            /// @dev Emitted when platform fee type is updated.
            event PlatformFeeTypeUpdated(PlatformFeeType feeType);
            constructor() initializer {}
            /// @dev Initiliazes the contract, like a constructor.
            function initialize(
                address _defaultAdmin,
                string memory _name,
                string memory _symbol,
                string memory _contractURI,
                address[] memory _trustedForwarders,
                address _primarySaleRecipient,
                address _royaltyRecipient,
                uint128 _royaltyBps,
                uint128 _platformFeeBps,
                address _platformFeeRecipient
            ) external initializer {
                // Initialize inherited contracts, most base-like -> most derived.
                __ReentrancyGuard_init();
                __EIP712_init("TokenERC1155", "1");
                __ERC2771Context_init(_trustedForwarders);
                __ERC1155_init("");
                // Initialize this contract's state.
                _setOperatorRestriction(true);
                name = _name;
                symbol = _symbol;
                royaltyRecipient = _royaltyRecipient;
                royaltyBps = _royaltyBps;
                platformFeeRecipient = _platformFeeRecipient;
                primarySaleRecipient = _primarySaleRecipient;
                contractURI = _contractURI;
                require(_platformFeeBps <= MAX_BPS, "exceeds MAX_BPS");
                platformFeeBps = _platformFeeBps;
                // Fee type Bps by default
                platformFeeType = PlatformFeeType.Bps;
                _owner = _defaultAdmin;
                _setupRole(DEFAULT_ADMIN_ROLE, _defaultAdmin);
                _setupRole(MINTER_ROLE, _defaultAdmin);
                _setupRole(TRANSFER_ROLE, _defaultAdmin);
                _setupRole(TRANSFER_ROLE, address(0));
            }
            ///     =====   Public functions  =====
            /// @dev Returns the module type of the contract.
            function contractType() external pure returns (bytes32) {
                return MODULE_TYPE;
            }
            /// @dev Returns the version of the contract.
            function contractVersion() external pure returns (uint8) {
                return uint8(VERSION);
            }
            /**
             * @dev Returns the address of the current owner.
             */
            function owner() public view returns (address) {
                return hasRole(DEFAULT_ADMIN_ROLE, _owner) ? _owner : address(0);
            }
            /// @dev Verifies that a mint request is signed by an account holding MINTER_ROLE (at the time of the function call).
            function verify(MintRequest calldata _req, bytes calldata _signature) public view returns (bool, address) {
                address signer = recoverAddress(_req, _signature);
                return (!minted[_req.uid] && hasRole(MINTER_ROLE, signer), signer);
            }
            /// @dev Returns the URI for a tokenId
            function uri(uint256 _tokenId) public view override returns (string memory) {
                return _tokenURI[_tokenId];
            }
            /// @dev Lets an account with MINTER_ROLE mint an NFT.
            function mintTo(
                address _to,
                uint256 _tokenId,
                string calldata _uri,
                uint256 _amount
            ) external onlyRole(MINTER_ROLE) {
                uint256 tokenIdToMint;
                if (_tokenId == type(uint256).max) {
                    tokenIdToMint = nextTokenIdToMint;
                    nextTokenIdToMint += 1;
                } else {
                    require(_tokenId < nextTokenIdToMint, "invalid id");
                    tokenIdToMint = _tokenId;
                }
                // `_mintTo` is re-used. `mintTo` just adds a minter role check.
                _mintTo(_to, _uri, tokenIdToMint, _amount);
            }
            ///     =====   External functions  =====
            /// @dev See EIP-2981
            function royaltyInfo(uint256 tokenId, uint256 salePrice)
                external
                view
                virtual
                returns (address receiver, uint256 royaltyAmount)
            {
                (address recipient, uint256 bps) = getRoyaltyInfoForToken(tokenId);
                receiver = recipient;
                royaltyAmount = (salePrice * bps) / MAX_BPS;
            }
            /// @dev Mints an NFT according to the provided mint request.
            function mintWithSignature(MintRequest calldata _req, bytes calldata _signature) external payable nonReentrant {
                address signer = verifyRequest(_req, _signature);
                address receiver = _req.to;
                uint256 tokenIdToMint;
                if (_req.tokenId == type(uint256).max) {
                    tokenIdToMint = nextTokenIdToMint;
                    nextTokenIdToMint += 1;
                } else {
                    require(_req.tokenId < nextTokenIdToMint, "invalid id");
                    tokenIdToMint = _req.tokenId;
                }
                if (_req.royaltyRecipient != address(0)) {
                    royaltyInfoForToken[tokenIdToMint] = RoyaltyInfo({
                        recipient: _req.royaltyRecipient,
                        bps: _req.royaltyBps
                    });
                }
                _mintTo(receiver, _req.uri, tokenIdToMint, _req.quantity);
                collectPrice(_req);
                emit TokensMintedWithSignature(signer, receiver, tokenIdToMint, _req);
            }
            //      =====   Setter functions  =====
            /// @dev Lets a module admin set the default recipient of all primary sales.
            function setPrimarySaleRecipient(address _saleRecipient) external onlyRole(DEFAULT_ADMIN_ROLE) {
                primarySaleRecipient = _saleRecipient;
                emit PrimarySaleRecipientUpdated(_saleRecipient);
            }
            /// @dev Lets a module admin update the royalty bps and recipient.
            function setDefaultRoyaltyInfo(address _royaltyRecipient, uint256 _royaltyBps)
                external
                onlyRole(DEFAULT_ADMIN_ROLE)
            {
                require(_royaltyBps <= MAX_BPS, "exceed royalty bps");
                royaltyRecipient = _royaltyRecipient;
                royaltyBps = uint128(_royaltyBps);
                emit DefaultRoyalty(_royaltyRecipient, _royaltyBps);
            }
            /// @dev Lets a module admin set the royalty recipient for a particular token Id.
            function setRoyaltyInfoForToken(
                uint256 _tokenId,
                address _recipient,
                uint256 _bps
            ) external onlyRole(DEFAULT_ADMIN_ROLE) {
                require(_bps <= MAX_BPS, "exceed royalty bps");
                royaltyInfoForToken[_tokenId] = RoyaltyInfo({ recipient: _recipient, bps: _bps });
                emit RoyaltyForToken(_tokenId, _recipient, _bps);
            }
            /// @dev Lets a module admin update the fees on primary sales.
            function setPlatformFeeInfo(address _platformFeeRecipient, uint256 _platformFeeBps)
                external
                onlyRole(DEFAULT_ADMIN_ROLE)
            {
                require(_platformFeeBps <= MAX_BPS, "exceeds MAX_BPS");
                platformFeeBps = uint64(_platformFeeBps);
                platformFeeRecipient = _platformFeeRecipient;
                emit PlatformFeeInfoUpdated(_platformFeeRecipient, _platformFeeBps);
            }
            /// @dev Lets a module admin set a flat fee on primary sales.
            function setFlatPlatformFeeInfo(address _platformFeeRecipient, uint256 _flatFee)
                external
                onlyRole(DEFAULT_ADMIN_ROLE)
            {
                flatPlatformFee = _flatFee;
                platformFeeRecipient = _platformFeeRecipient;
                emit FlatPlatformFeeUpdated(_platformFeeRecipient, _flatFee);
            }
            /// @dev Lets a module admin set a flat fee on primary sales.
            function setPlatformFeeType(PlatformFeeType _feeType) external onlyRole(DEFAULT_ADMIN_ROLE) {
                platformFeeType = _feeType;
                emit PlatformFeeTypeUpdated(_feeType);
            }
            /// @dev Lets a module admin set a new owner for the contract. The new owner must be a module admin.
            function setOwner(address _newOwner) external onlyRole(DEFAULT_ADMIN_ROLE) {
                require(hasRole(DEFAULT_ADMIN_ROLE, _newOwner), "new owner not module admin.");
                address _prevOwner = _owner;
                _owner = _newOwner;
                emit OwnerUpdated(_prevOwner, _newOwner);
            }
            /// @dev Lets a module admin set the URI for contract-level metadata.
            function setContractURI(string calldata _uri) external onlyRole(DEFAULT_ADMIN_ROLE) {
                contractURI = _uri;
            }
            ///     =====   Getter functions    =====
            /// @dev Returns the platform fee bps and recipient.
            function getPlatformFeeInfo() external view returns (address, uint16) {
                return (platformFeeRecipient, uint16(platformFeeBps));
            }
            /// @dev Returns the flat platform fee and recipient.
            function getFlatPlatformFeeInfo() external view returns (address, uint256) {
                return (platformFeeRecipient, flatPlatformFee);
            }
            /// @dev Returns the platform fee type.
            function getPlatformFeeType() external view returns (PlatformFeeType) {
                return platformFeeType;
            }
            /// @dev Returns default royalty info.
            function getDefaultRoyaltyInfo() external view returns (address, uint16) {
                return (royaltyRecipient, uint16(royaltyBps));
            }
            /// @dev Returns the royalty recipient for a particular token Id.
            function getRoyaltyInfoForToken(uint256 _tokenId) public view returns (address, uint16) {
                RoyaltyInfo memory royaltyForToken = royaltyInfoForToken[_tokenId];
                return
                    royaltyForToken.recipient == address(0)
                        ? (royaltyRecipient, uint16(royaltyBps))
                        : (royaltyForToken.recipient, uint16(royaltyForToken.bps));
            }
            ///     =====   Internal functions  =====
            /// @dev Mints an NFT to `to`
            function _mintTo(
                address _to,
                string calldata _uri,
                uint256 _tokenId,
                uint256 _amount
            ) internal {
                if (bytes(_tokenURI[_tokenId]).length == 0) {
                    require(bytes(_uri).length > 0, "empty uri.");
                    _tokenURI[_tokenId] = _uri;
                }
                _mint(_to, _tokenId, _amount, "");
                emit TokensMinted(_to, _tokenId, _tokenURI[_tokenId], _amount);
            }
            /// @dev Returns the address of the signer of the mint request.
            function recoverAddress(MintRequest calldata _req, bytes calldata _signature) internal view returns (address) {
                return _hashTypedDataV4(keccak256(_encodeRequest(_req))).recover(_signature);
            }
            /// @dev Resolves 'stack too deep' error in `recoverAddress`.
            function _encodeRequest(MintRequest calldata _req) internal pure returns (bytes memory) {
                return
                    abi.encode(
                        TYPEHASH,
                        _req.to,
                        _req.royaltyRecipient,
                        _req.royaltyBps,
                        _req.primarySaleRecipient,
                        _req.tokenId,
                        keccak256(bytes(_req.uri)),
                        _req.quantity,
                        _req.pricePerToken,
                        _req.currency,
                        _req.validityStartTimestamp,
                        _req.validityEndTimestamp,
                        _req.uid
                    );
            }
            /// @dev Verifies that a mint request is valid.
            function verifyRequest(MintRequest calldata _req, bytes calldata _signature) internal returns (address) {
                (bool success, address signer) = verify(_req, _signature);
                require(success, "invalid signature");
                require(
                    _req.validityStartTimestamp <= block.timestamp && _req.validityEndTimestamp >= block.timestamp,
                    "request expired"
                );
                require(_req.to != address(0), "recipient undefined");
                require(_req.quantity > 0, "zero quantity");
                minted[_req.uid] = true;
                return signer;
            }
            /// @dev Collects and distributes the primary sale value of tokens being claimed.
            function collectPrice(MintRequest calldata _req) internal {
                if (_req.pricePerToken == 0) {
                    return;
                }
                uint256 totalPrice = _req.pricePerToken * _req.quantity;
                uint256 platformFees = platformFeeType == PlatformFeeType.Flat
                    ? flatPlatformFee
                    : ((totalPrice * platformFeeBps) / MAX_BPS);
                require(totalPrice >= platformFees, "price less than platform fee");
                if (_req.currency == CurrencyTransferLib.NATIVE_TOKEN) {
                    require(msg.value == totalPrice, "must send total price.");
                } else {
                    require(msg.value == 0, "msg value not zero");
                }
                address saleRecipient = _req.primarySaleRecipient == address(0)
                    ? primarySaleRecipient
                    : _req.primarySaleRecipient;
                CurrencyTransferLib.transferCurrency(_req.currency, _msgSender(), platformFeeRecipient, platformFees);
                CurrencyTransferLib.transferCurrency(_req.currency, _msgSender(), saleRecipient, totalPrice - platformFees);
            }
            ///     =====   Low-level overrides  =====
            /// @dev Lets a token owner burn the tokens they own (i.e. destroy for good)
            function burn(
                address account,
                uint256 id,
                uint256 value
            ) public virtual {
                require(
                    account == _msgSender() || isApprovedForAll(account, _msgSender()),
                    "ERC1155: caller is not owner nor approved."
                );
                _burn(account, id, value);
            }
            /// @dev Lets a token owner burn multiple tokens they own at once (i.e. destroy for good)
            function burnBatch(
                address account,
                uint256[] memory ids,
                uint256[] memory values
            ) public virtual {
                require(
                    account == _msgSender() || isApprovedForAll(account, _msgSender()),
                    "ERC1155: caller is not owner nor approved."
                );
                _burnBatch(account, ids, values);
            }
            /**
             * @dev See {ERC1155-_beforeTokenTransfer}.
             */
            function _beforeTokenTransfer(
                address operator,
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) internal virtual override {
                super._beforeTokenTransfer(operator, from, to, ids, amounts, data);
                // if transfer is restricted on the contract, we still want to allow burning and minting
                if (!hasRole(TRANSFER_ROLE, address(0)) && from != address(0) && to != address(0)) {
                    require(hasRole(TRANSFER_ROLE, from) || hasRole(TRANSFER_ROLE, to), "restricted to TRANSFER_ROLE holders.");
                }
                if (from == address(0)) {
                    for (uint256 i = 0; i < ids.length; ++i) {
                        totalSupply[ids[i]] += amounts[i];
                    }
                }
                if (to == address(0)) {
                    for (uint256 i = 0; i < ids.length; ++i) {
                        totalSupply[ids[i]] -= amounts[i];
                    }
                }
            }
            /// @dev See {ERC1155-setApprovalForAll}
            function setApprovalForAll(address operator, bool approved)
                public
                override(ERC1155Upgradeable, IERC1155Upgradeable)
                onlyAllowedOperatorApproval(operator)
            {
                super.setApprovalForAll(operator, approved);
            }
            /**
             * @dev See {IERC1155-safeTransferFrom}.
             */
            function safeTransferFrom(
                address from,
                address to,
                uint256 id,
                uint256 amount,
                bytes memory data
            ) public override(ERC1155Upgradeable, IERC1155Upgradeable) onlyAllowedOperator(from) {
                super.safeTransferFrom(from, to, id, amount, data);
            }
            /**
             * @dev See {IERC1155-safeBatchTransferFrom}.
             */
            function safeBatchTransferFrom(
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) public override(ERC1155Upgradeable, IERC1155Upgradeable) onlyAllowedOperator(from) {
                super.safeBatchTransferFrom(from, to, ids, amounts, data);
            }
            function supportsInterface(bytes4 interfaceId)
                public
                view
                virtual
                override(AccessControlEnumerableUpgradeable, ERC1155Upgradeable, IERC165Upgradeable, IERC165)
                returns (bool)
            {
                return
                    super.supportsInterface(interfaceId) ||
                    interfaceId == type(IERC1155Upgradeable).interfaceId ||
                    interfaceId == type(IERC2981Upgradeable).interfaceId;
            }
            /// @dev Returns whether operator restriction can be set in the given execution context.
            function _canSetOperatorRestriction() internal virtual override returns (bool) {
                return hasRole(DEFAULT_ADMIN_ROLE, _msgSender());
            }
            function _msgSender()
                internal
                view
                virtual
                override(ContextUpgradeable, ERC2771ContextUpgradeable)
                returns (address sender)
            {
                return ERC2771ContextUpgradeable._msgSender();
            }
            function _msgData()
                internal
                view
                virtual
                override(ContextUpgradeable, ERC2771ContextUpgradeable)
                returns (bytes calldata)
            {
                return ERC2771ContextUpgradeable._msgData();
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.5.0) (access/AccessControlEnumerable.sol)
        pragma solidity ^0.8.0;
        import "./IAccessControlEnumerableUpgradeable.sol";
        import "./AccessControlUpgradeable.sol";
        import "../utils/structs/EnumerableSetUpgradeable.sol";
        import "../proxy/utils/Initializable.sol";
        /**
         * @dev Extension of {AccessControl} that allows enumerating the members of each role.
         */
        abstract contract AccessControlEnumerableUpgradeable is Initializable, IAccessControlEnumerableUpgradeable, AccessControlUpgradeable {
            function __AccessControlEnumerable_init() internal onlyInitializing {
            }
            function __AccessControlEnumerable_init_unchained() internal onlyInitializing {
            }
            using EnumerableSetUpgradeable for EnumerableSetUpgradeable.AddressSet;
            mapping(bytes32 => EnumerableSetUpgradeable.AddressSet) private _roleMembers;
            /**
             * @dev See {IERC165-supportsInterface}.
             */
            function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
                return interfaceId == type(IAccessControlEnumerableUpgradeable).interfaceId || super.supportsInterface(interfaceId);
            }
            /**
             * @dev Returns one of the accounts that have `role`. `index` must be a
             * value between 0 and {getRoleMemberCount}, non-inclusive.
             *
             * Role bearers are not sorted in any particular way, and their ordering may
             * change at any point.
             *
             * WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure
             * you perform all queries on the same block. See the following
             * https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post]
             * for more information.
             */
            function getRoleMember(bytes32 role, uint256 index) public view virtual override returns (address) {
                return _roleMembers[role].at(index);
            }
            /**
             * @dev Returns the number of accounts that have `role`. Can be used
             * together with {getRoleMember} to enumerate all bearers of a role.
             */
            function getRoleMemberCount(bytes32 role) public view virtual override returns (uint256) {
                return _roleMembers[role].length();
            }
            /**
             * @dev Overload {_grantRole} to track enumerable memberships
             */
            function _grantRole(bytes32 role, address account) internal virtual override {
                super._grantRole(role, account);
                _roleMembers[role].add(account);
            }
            /**
             * @dev Overload {_revokeRole} to track enumerable memberships
             */
            function _revokeRole(bytes32 role, address account) internal virtual override {
                super._revokeRole(role, account);
                _roleMembers[role].remove(account);
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[49] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (access/AccessControl.sol)
        pragma solidity ^0.8.0;
        import "./IAccessControlUpgradeable.sol";
        import "../utils/ContextUpgradeable.sol";
        import "../utils/StringsUpgradeable.sol";
        import "../utils/introspection/ERC165Upgradeable.sol";
        import "../proxy/utils/Initializable.sol";
        /**
         * @dev Contract module that allows children to implement role-based access
         * control mechanisms. This is a lightweight version that doesn't allow enumerating role
         * members except through off-chain means by accessing the contract event logs. Some
         * applications may benefit from on-chain enumerability, for those cases see
         * {AccessControlEnumerable}.
         *
         * Roles are referred to by their `bytes32` identifier. These should be exposed
         * in the external API and be unique. The best way to achieve this is by
         * using `public constant` hash digests:
         *
         * ```
         * bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
         * ```
         *
         * Roles can be used to represent a set of permissions. To restrict access to a
         * function call, use {hasRole}:
         *
         * ```
         * function foo() public {
         *     require(hasRole(MY_ROLE, msg.sender));
         *     ...
         * }
         * ```
         *
         * Roles can be granted and revoked dynamically via the {grantRole} and
         * {revokeRole} functions. Each role has an associated admin role, and only
         * accounts that have a role's admin role can call {grantRole} and {revokeRole}.
         *
         * By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
         * that only accounts with this role will be able to grant or revoke other
         * roles. More complex role relationships can be created by using
         * {_setRoleAdmin}.
         *
         * WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
         * grant and revoke this role. Extra precautions should be taken to secure
         * accounts that have been granted it.
         */
        abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable, IAccessControlUpgradeable, ERC165Upgradeable {
            function __AccessControl_init() internal onlyInitializing {
            }
            function __AccessControl_init_unchained() internal onlyInitializing {
            }
            struct RoleData {
                mapping(address => bool) members;
                bytes32 adminRole;
            }
            mapping(bytes32 => RoleData) private _roles;
            bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
            /**
             * @dev Modifier that checks that an account has a specific role. Reverts
             * with a standardized message including the required role.
             *
             * The format of the revert reason is given by the following regular expression:
             *
             *  /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
             *
             * _Available since v4.1._
             */
            modifier onlyRole(bytes32 role) {
                _checkRole(role);
                _;
            }
            /**
             * @dev See {IERC165-supportsInterface}.
             */
            function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
                return interfaceId == type(IAccessControlUpgradeable).interfaceId || super.supportsInterface(interfaceId);
            }
            /**
             * @dev Returns `true` if `account` has been granted `role`.
             */
            function hasRole(bytes32 role, address account) public view virtual override returns (bool) {
                return _roles[role].members[account];
            }
            /**
             * @dev Revert with a standard message if `_msgSender()` is missing `role`.
             * Overriding this function changes the behavior of the {onlyRole} modifier.
             *
             * Format of the revert message is described in {_checkRole}.
             *
             * _Available since v4.6._
             */
            function _checkRole(bytes32 role) internal view virtual {
                _checkRole(role, _msgSender());
            }
            /**
             * @dev Revert with a standard message if `account` is missing `role`.
             *
             * The format of the revert reason is given by the following regular expression:
             *
             *  /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
             */
            function _checkRole(bytes32 role, address account) internal view virtual {
                if (!hasRole(role, account)) {
                    revert(
                        string(
                            abi.encodePacked(
                                "AccessControl: account ",
                                StringsUpgradeable.toHexString(uint160(account), 20),
                                " is missing role ",
                                StringsUpgradeable.toHexString(uint256(role), 32)
                            )
                        )
                    );
                }
            }
            /**
             * @dev Returns the admin role that controls `role`. See {grantRole} and
             * {revokeRole}.
             *
             * To change a role's admin, use {_setRoleAdmin}.
             */
            function getRoleAdmin(bytes32 role) public view virtual override returns (bytes32) {
                return _roles[role].adminRole;
            }
            /**
             * @dev Grants `role` to `account`.
             *
             * If `account` had not been already granted `role`, emits a {RoleGranted}
             * event.
             *
             * Requirements:
             *
             * - the caller must have ``role``'s admin role.
             *
             * May emit a {RoleGranted} event.
             */
            function grantRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {
                _grantRole(role, account);
            }
            /**
             * @dev Revokes `role` from `account`.
             *
             * If `account` had been granted `role`, emits a {RoleRevoked} event.
             *
             * Requirements:
             *
             * - the caller must have ``role``'s admin role.
             *
             * May emit a {RoleRevoked} event.
             */
            function revokeRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {
                _revokeRole(role, account);
            }
            /**
             * @dev Revokes `role` from the calling account.
             *
             * Roles are often managed via {grantRole} and {revokeRole}: this function's
             * purpose is to provide a mechanism for accounts to lose their privileges
             * if they are compromised (such as when a trusted device is misplaced).
             *
             * If the calling account had been revoked `role`, emits a {RoleRevoked}
             * event.
             *
             * Requirements:
             *
             * - the caller must be `account`.
             *
             * May emit a {RoleRevoked} event.
             */
            function renounceRole(bytes32 role, address account) public virtual override {
                require(account == _msgSender(), "AccessControl: can only renounce roles for self");
                _revokeRole(role, account);
            }
            /**
             * @dev Grants `role` to `account`.
             *
             * If `account` had not been already granted `role`, emits a {RoleGranted}
             * event. Note that unlike {grantRole}, this function doesn't perform any
             * checks on the calling account.
             *
             * May emit a {RoleGranted} event.
             *
             * [WARNING]
             * ====
             * This function should only be called from the constructor when setting
             * up the initial roles for the system.
             *
             * Using this function in any other way is effectively circumventing the admin
             * system imposed by {AccessControl}.
             * ====
             *
             * NOTE: This function is deprecated in favor of {_grantRole}.
             */
            function _setupRole(bytes32 role, address account) internal virtual {
                _grantRole(role, account);
            }
            /**
             * @dev Sets `adminRole` as ``role``'s admin role.
             *
             * Emits a {RoleAdminChanged} event.
             */
            function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
                bytes32 previousAdminRole = getRoleAdmin(role);
                _roles[role].adminRole = adminRole;
                emit RoleAdminChanged(role, previousAdminRole, adminRole);
            }
            /**
             * @dev Grants `role` to `account`.
             *
             * Internal function without access restriction.
             *
             * May emit a {RoleGranted} event.
             */
            function _grantRole(bytes32 role, address account) internal virtual {
                if (!hasRole(role, account)) {
                    _roles[role].members[account] = true;
                    emit RoleGranted(role, account, _msgSender());
                }
            }
            /**
             * @dev Revokes `role` from `account`.
             *
             * Internal function without access restriction.
             *
             * May emit a {RoleRevoked} event.
             */
            function _revokeRole(bytes32 role, address account) internal virtual {
                if (hasRole(role, account)) {
                    _roles[role].members[account] = false;
                    emit RoleRevoked(role, account, _msgSender());
                }
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[49] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (access/IAccessControlEnumerable.sol)
        pragma solidity ^0.8.0;
        import "./IAccessControlUpgradeable.sol";
        /**
         * @dev External interface of AccessControlEnumerable declared to support ERC165 detection.
         */
        interface IAccessControlEnumerableUpgradeable is IAccessControlUpgradeable {
            /**
             * @dev Returns one of the accounts that have `role`. `index` must be a
             * value between 0 and {getRoleMemberCount}, non-inclusive.
             *
             * Role bearers are not sorted in any particular way, and their ordering may
             * change at any point.
             *
             * WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure
             * you perform all queries on the same block. See the following
             * https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post]
             * for more information.
             */
            function getRoleMember(bytes32 role, uint256 index) external view returns (address);
            /**
             * @dev Returns the number of accounts that have `role`. Can be used
             * together with {getRoleMember} to enumerate all bearers of a role.
             */
            function getRoleMemberCount(bytes32 role) external view returns (uint256);
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (access/IAccessControl.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev External interface of AccessControl declared to support ERC165 detection.
         */
        interface IAccessControlUpgradeable {
            /**
             * @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
             *
             * `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
             * {RoleAdminChanged} not being emitted signaling this.
             *
             * _Available since v3.1._
             */
            event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
            /**
             * @dev Emitted when `account` is granted `role`.
             *
             * `sender` is the account that originated the contract call, an admin role
             * bearer except when using {AccessControl-_setupRole}.
             */
            event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
            /**
             * @dev Emitted when `account` is revoked `role`.
             *
             * `sender` is the account that originated the contract call:
             *   - if using `revokeRole`, it is the admin role bearer
             *   - if using `renounceRole`, it is the role bearer (i.e. `account`)
             */
            event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
            /**
             * @dev Returns `true` if `account` has been granted `role`.
             */
            function hasRole(bytes32 role, address account) external view returns (bool);
            /**
             * @dev Returns the admin role that controls `role`. See {grantRole} and
             * {revokeRole}.
             *
             * To change a role's admin, use {AccessControl-_setRoleAdmin}.
             */
            function getRoleAdmin(bytes32 role) external view returns (bytes32);
            /**
             * @dev Grants `role` to `account`.
             *
             * If `account` had not been already granted `role`, emits a {RoleGranted}
             * event.
             *
             * Requirements:
             *
             * - the caller must have ``role``'s admin role.
             */
            function grantRole(bytes32 role, address account) external;
            /**
             * @dev Revokes `role` from `account`.
             *
             * If `account` had been granted `role`, emits a {RoleRevoked} event.
             *
             * Requirements:
             *
             * - the caller must have ``role``'s admin role.
             */
            function revokeRole(bytes32 role, address account) external;
            /**
             * @dev Revokes `role` from the calling account.
             *
             * Roles are often managed via {grantRole} and {revokeRole}: this function's
             * purpose is to provide a mechanism for accounts to lose their privileges
             * if they are compromised (such as when a trusted device is misplaced).
             *
             * If the calling account had been granted `role`, emits a {RoleRevoked}
             * event.
             *
             * Requirements:
             *
             * - the caller must be `account`.
             */
            function renounceRole(bytes32 role, address account) external;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.6.0) (interfaces/IERC2981.sol)
        pragma solidity ^0.8.0;
        import "../utils/introspection/IERC165Upgradeable.sol";
        /**
         * @dev Interface for the NFT Royalty Standard.
         *
         * A standardized way to retrieve royalty payment information for non-fungible tokens (NFTs) to enable universal
         * support for royalty payments across all NFT marketplaces and ecosystem participants.
         *
         * _Available since v4.5._
         */
        interface IERC2981Upgradeable is IERC165Upgradeable {
            /**
             * @dev Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of
             * exchange. The royalty amount is denominated and should be paid in that same unit of exchange.
             */
            function royaltyInfo(uint256 tokenId, uint256 salePrice)
                external
                view
                returns (address receiver, uint256 royaltyAmount);
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (proxy/utils/Initializable.sol)
        pragma solidity ^0.8.2;
        import "../../utils/AddressUpgradeable.sol";
        /**
         * @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
         * behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
         * external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
         * function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
         *
         * The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
         * reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
         * case an upgrade adds a module that needs to be initialized.
         *
         * For example:
         *
         * [.hljs-theme-light.nopadding]
         * ```
         * contract MyToken is ERC20Upgradeable {
         *     function initialize() initializer public {
         *         __ERC20_init("MyToken", "MTK");
         *     }
         * }
         * contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
         *     function initializeV2() reinitializer(2) public {
         *         __ERC20Permit_init("MyToken");
         *     }
         * }
         * ```
         *
         * TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
         * possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
         *
         * CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
         * that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
         *
         * [CAUTION]
         * ====
         * Avoid leaving a contract uninitialized.
         *
         * An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
         * contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
         * the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
         *
         * [.hljs-theme-light.nopadding]
         * ```
         * /// @custom:oz-upgrades-unsafe-allow constructor
         * constructor() {
         *     _disableInitializers();
         * }
         * ```
         * ====
         */
        abstract contract Initializable {
            /**
             * @dev Indicates that the contract has been initialized.
             * @custom:oz-retyped-from bool
             */
            uint8 private _initialized;
            /**
             * @dev Indicates that the contract is in the process of being initialized.
             */
            bool private _initializing;
            /**
             * @dev Triggered when the contract has been initialized or reinitialized.
             */
            event Initialized(uint8 version);
            /**
             * @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
             * `onlyInitializing` functions can be used to initialize parent contracts. Equivalent to `reinitializer(1)`.
             */
            modifier initializer() {
                bool isTopLevelCall = !_initializing;
                require(
                    (isTopLevelCall && _initialized < 1) || (!AddressUpgradeable.isContract(address(this)) && _initialized == 1),
                    "Initializable: contract is already initialized"
                );
                _initialized = 1;
                if (isTopLevelCall) {
                    _initializing = true;
                }
                _;
                if (isTopLevelCall) {
                    _initializing = false;
                    emit Initialized(1);
                }
            }
            /**
             * @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
             * contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
             * used to initialize parent contracts.
             *
             * `initializer` is equivalent to `reinitializer(1)`, so a reinitializer may be used after the original
             * initialization step. This is essential to configure modules that are added through upgrades and that require
             * initialization.
             *
             * Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
             * a contract, executing them in the right order is up to the developer or operator.
             */
            modifier reinitializer(uint8 version) {
                require(!_initializing && _initialized < version, "Initializable: contract is already initialized");
                _initialized = version;
                _initializing = true;
                _;
                _initializing = false;
                emit Initialized(version);
            }
            /**
             * @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
             * {initializer} and {reinitializer} modifiers, directly or indirectly.
             */
            modifier onlyInitializing() {
                require(_initializing, "Initializable: contract is not initializing");
                _;
            }
            /**
             * @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
             * Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
             * to any version. It is recommended to use this to lock implementation contracts that are designed to be called
             * through proxies.
             */
            function _disableInitializers() internal virtual {
                require(!_initializing, "Initializable: contract is initializing");
                if (_initialized < type(uint8).max) {
                    _initialized = type(uint8).max;
                    emit Initialized(type(uint8).max);
                }
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (security/ReentrancyGuard.sol)
        pragma solidity ^0.8.0;
        import "../proxy/utils/Initializable.sol";
        /**
         * @dev Contract module that helps prevent reentrant calls to a function.
         *
         * Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
         * available, which can be applied to functions to make sure there are no nested
         * (reentrant) calls to them.
         *
         * Note that because there is a single `nonReentrant` guard, functions marked as
         * `nonReentrant` may not call one another. This can be worked around by making
         * those functions `private`, and then adding `external` `nonReentrant` entry
         * points to them.
         *
         * TIP: If you would like to learn more about reentrancy and alternative ways
         * to protect against it, check out our blog post
         * https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
         */
        abstract contract ReentrancyGuardUpgradeable is Initializable {
            // Booleans are more expensive than uint256 or any type that takes up a full
            // word because each write operation emits an extra SLOAD to first read the
            // slot's contents, replace the bits taken up by the boolean, and then write
            // back. This is the compiler's defense against contract upgrades and
            // pointer aliasing, and it cannot be disabled.
            // The values being non-zero value makes deployment a bit more expensive,
            // but in exchange the refund on every call to nonReentrant will be lower in
            // amount. Since refunds are capped to a percentage of the total
            // transaction's gas, it is best to keep them low in cases like this one, to
            // increase the likelihood of the full refund coming into effect.
            uint256 private constant _NOT_ENTERED = 1;
            uint256 private constant _ENTERED = 2;
            uint256 private _status;
            function __ReentrancyGuard_init() internal onlyInitializing {
                __ReentrancyGuard_init_unchained();
            }
            function __ReentrancyGuard_init_unchained() internal onlyInitializing {
                _status = _NOT_ENTERED;
            }
            /**
             * @dev Prevents a contract from calling itself, directly or indirectly.
             * Calling a `nonReentrant` function from another `nonReentrant`
             * function is not supported. It is possible to prevent this from happening
             * by making the `nonReentrant` function external, and making it call a
             * `private` function that does the actual work.
             */
            modifier nonReentrant() {
                // On the first call to nonReentrant, _notEntered will be true
                require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
                // Any calls to nonReentrant after this point will fail
                _status = _ENTERED;
                _;
                // By storing the original value once again, a refund is triggered (see
                // https://eips.ethereum.org/EIPS/eip-2200)
                _status = _NOT_ENTERED;
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[49] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (token/ERC1155/ERC1155.sol)
        pragma solidity ^0.8.0;
        import "./IERC1155Upgradeable.sol";
        import "./IERC1155ReceiverUpgradeable.sol";
        import "./extensions/IERC1155MetadataURIUpgradeable.sol";
        import "../../utils/AddressUpgradeable.sol";
        import "../../utils/ContextUpgradeable.sol";
        import "../../utils/introspection/ERC165Upgradeable.sol";
        import "../../proxy/utils/Initializable.sol";
        /**
         * @dev Implementation of the basic standard multi-token.
         * See https://eips.ethereum.org/EIPS/eip-1155
         * Originally based on code by Enjin: https://github.com/enjin/erc-1155
         *
         * _Available since v3.1._
         */
        contract ERC1155Upgradeable is Initializable, ContextUpgradeable, ERC165Upgradeable, IERC1155Upgradeable, IERC1155MetadataURIUpgradeable {
            using AddressUpgradeable for address;
            // Mapping from token ID to account balances
            mapping(uint256 => mapping(address => uint256)) private _balances;
            // Mapping from account to operator approvals
            mapping(address => mapping(address => bool)) private _operatorApprovals;
            // Used as the URI for all token types by relying on ID substitution, e.g. https://token-cdn-domain/{id}.json
            string private _uri;
            /**
             * @dev See {_setURI}.
             */
            function __ERC1155_init(string memory uri_) internal onlyInitializing {
                __ERC1155_init_unchained(uri_);
            }
            function __ERC1155_init_unchained(string memory uri_) internal onlyInitializing {
                _setURI(uri_);
            }
            /**
             * @dev See {IERC165-supportsInterface}.
             */
            function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165Upgradeable, IERC165Upgradeable) returns (bool) {
                return
                    interfaceId == type(IERC1155Upgradeable).interfaceId ||
                    interfaceId == type(IERC1155MetadataURIUpgradeable).interfaceId ||
                    super.supportsInterface(interfaceId);
            }
            /**
             * @dev See {IERC1155MetadataURI-uri}.
             *
             * This implementation returns the same URI for *all* token types. It relies
             * on the token type ID substitution mechanism
             * https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the EIP].
             *
             * Clients calling this function must replace the `\\{id\\}` substring with the
             * actual token type ID.
             */
            function uri(uint256) public view virtual override returns (string memory) {
                return _uri;
            }
            /**
             * @dev See {IERC1155-balanceOf}.
             *
             * Requirements:
             *
             * - `account` cannot be the zero address.
             */
            function balanceOf(address account, uint256 id) public view virtual override returns (uint256) {
                require(account != address(0), "ERC1155: address zero is not a valid owner");
                return _balances[id][account];
            }
            /**
             * @dev See {IERC1155-balanceOfBatch}.
             *
             * Requirements:
             *
             * - `accounts` and `ids` must have the same length.
             */
            function balanceOfBatch(address[] memory accounts, uint256[] memory ids)
                public
                view
                virtual
                override
                returns (uint256[] memory)
            {
                require(accounts.length == ids.length, "ERC1155: accounts and ids length mismatch");
                uint256[] memory batchBalances = new uint256[](accounts.length);
                for (uint256 i = 0; i < accounts.length; ++i) {
                    batchBalances[i] = balanceOf(accounts[i], ids[i]);
                }
                return batchBalances;
            }
            /**
             * @dev See {IERC1155-setApprovalForAll}.
             */
            function setApprovalForAll(address operator, bool approved) public virtual override {
                _setApprovalForAll(_msgSender(), operator, approved);
            }
            /**
             * @dev See {IERC1155-isApprovedForAll}.
             */
            function isApprovedForAll(address account, address operator) public view virtual override returns (bool) {
                return _operatorApprovals[account][operator];
            }
            /**
             * @dev See {IERC1155-safeTransferFrom}.
             */
            function safeTransferFrom(
                address from,
                address to,
                uint256 id,
                uint256 amount,
                bytes memory data
            ) public virtual override {
                require(
                    from == _msgSender() || isApprovedForAll(from, _msgSender()),
                    "ERC1155: caller is not token owner nor approved"
                );
                _safeTransferFrom(from, to, id, amount, data);
            }
            /**
             * @dev See {IERC1155-safeBatchTransferFrom}.
             */
            function safeBatchTransferFrom(
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) public virtual override {
                require(
                    from == _msgSender() || isApprovedForAll(from, _msgSender()),
                    "ERC1155: caller is not token owner nor approved"
                );
                _safeBatchTransferFrom(from, to, ids, amounts, data);
            }
            /**
             * @dev Transfers `amount` tokens of token type `id` from `from` to `to`.
             *
             * Emits a {TransferSingle} event.
             *
             * Requirements:
             *
             * - `to` cannot be the zero address.
             * - `from` must have a balance of tokens of type `id` of at least `amount`.
             * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
             * acceptance magic value.
             */
            function _safeTransferFrom(
                address from,
                address to,
                uint256 id,
                uint256 amount,
                bytes memory data
            ) internal virtual {
                require(to != address(0), "ERC1155: transfer to the zero address");
                address operator = _msgSender();
                uint256[] memory ids = _asSingletonArray(id);
                uint256[] memory amounts = _asSingletonArray(amount);
                _beforeTokenTransfer(operator, from, to, ids, amounts, data);
                uint256 fromBalance = _balances[id][from];
                require(fromBalance >= amount, "ERC1155: insufficient balance for transfer");
                unchecked {
                    _balances[id][from] = fromBalance - amount;
                }
                _balances[id][to] += amount;
                emit TransferSingle(operator, from, to, id, amount);
                _afterTokenTransfer(operator, from, to, ids, amounts, data);
                _doSafeTransferAcceptanceCheck(operator, from, to, id, amount, data);
            }
            /**
             * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_safeTransferFrom}.
             *
             * Emits a {TransferBatch} event.
             *
             * Requirements:
             *
             * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
             * acceptance magic value.
             */
            function _safeBatchTransferFrom(
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) internal virtual {
                require(ids.length == amounts.length, "ERC1155: ids and amounts length mismatch");
                require(to != address(0), "ERC1155: transfer to the zero address");
                address operator = _msgSender();
                _beforeTokenTransfer(operator, from, to, ids, amounts, data);
                for (uint256 i = 0; i < ids.length; ++i) {
                    uint256 id = ids[i];
                    uint256 amount = amounts[i];
                    uint256 fromBalance = _balances[id][from];
                    require(fromBalance >= amount, "ERC1155: insufficient balance for transfer");
                    unchecked {
                        _balances[id][from] = fromBalance - amount;
                    }
                    _balances[id][to] += amount;
                }
                emit TransferBatch(operator, from, to, ids, amounts);
                _afterTokenTransfer(operator, from, to, ids, amounts, data);
                _doSafeBatchTransferAcceptanceCheck(operator, from, to, ids, amounts, data);
            }
            /**
             * @dev Sets a new URI for all token types, by relying on the token type ID
             * substitution mechanism
             * https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the EIP].
             *
             * By this mechanism, any occurrence of the `\\{id\\}` substring in either the
             * URI or any of the amounts in the JSON file at said URI will be replaced by
             * clients with the token type ID.
             *
             * For example, the `https://token-cdn-domain/\\{id\\}.json` URI would be
             * interpreted by clients as
             * `https://token-cdn-domain/000000000000000000000000000000000000000000000000000000000004cce0.json`
             * for token type ID 0x4cce0.
             *
             * See {uri}.
             *
             * Because these URIs cannot be meaningfully represented by the {URI} event,
             * this function emits no events.
             */
            function _setURI(string memory newuri) internal virtual {
                _uri = newuri;
            }
            /**
             * @dev Creates `amount` tokens of token type `id`, and assigns them to `to`.
             *
             * Emits a {TransferSingle} event.
             *
             * Requirements:
             *
             * - `to` cannot be the zero address.
             * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
             * acceptance magic value.
             */
            function _mint(
                address to,
                uint256 id,
                uint256 amount,
                bytes memory data
            ) internal virtual {
                require(to != address(0), "ERC1155: mint to the zero address");
                address operator = _msgSender();
                uint256[] memory ids = _asSingletonArray(id);
                uint256[] memory amounts = _asSingletonArray(amount);
                _beforeTokenTransfer(operator, address(0), to, ids, amounts, data);
                _balances[id][to] += amount;
                emit TransferSingle(operator, address(0), to, id, amount);
                _afterTokenTransfer(operator, address(0), to, ids, amounts, data);
                _doSafeTransferAcceptanceCheck(operator, address(0), to, id, amount, data);
            }
            /**
             * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_mint}.
             *
             * Emits a {TransferBatch} event.
             *
             * Requirements:
             *
             * - `ids` and `amounts` must have the same length.
             * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
             * acceptance magic value.
             */
            function _mintBatch(
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) internal virtual {
                require(to != address(0), "ERC1155: mint to the zero address");
                require(ids.length == amounts.length, "ERC1155: ids and amounts length mismatch");
                address operator = _msgSender();
                _beforeTokenTransfer(operator, address(0), to, ids, amounts, data);
                for (uint256 i = 0; i < ids.length; i++) {
                    _balances[ids[i]][to] += amounts[i];
                }
                emit TransferBatch(operator, address(0), to, ids, amounts);
                _afterTokenTransfer(operator, address(0), to, ids, amounts, data);
                _doSafeBatchTransferAcceptanceCheck(operator, address(0), to, ids, amounts, data);
            }
            /**
             * @dev Destroys `amount` tokens of token type `id` from `from`
             *
             * Emits a {TransferSingle} event.
             *
             * Requirements:
             *
             * - `from` cannot be the zero address.
             * - `from` must have at least `amount` tokens of token type `id`.
             */
            function _burn(
                address from,
                uint256 id,
                uint256 amount
            ) internal virtual {
                require(from != address(0), "ERC1155: burn from the zero address");
                address operator = _msgSender();
                uint256[] memory ids = _asSingletonArray(id);
                uint256[] memory amounts = _asSingletonArray(amount);
                _beforeTokenTransfer(operator, from, address(0), ids, amounts, "");
                uint256 fromBalance = _balances[id][from];
                require(fromBalance >= amount, "ERC1155: burn amount exceeds balance");
                unchecked {
                    _balances[id][from] = fromBalance - amount;
                }
                emit TransferSingle(operator, from, address(0), id, amount);
                _afterTokenTransfer(operator, from, address(0), ids, amounts, "");
            }
            /**
             * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_burn}.
             *
             * Emits a {TransferBatch} event.
             *
             * Requirements:
             *
             * - `ids` and `amounts` must have the same length.
             */
            function _burnBatch(
                address from,
                uint256[] memory ids,
                uint256[] memory amounts
            ) internal virtual {
                require(from != address(0), "ERC1155: burn from the zero address");
                require(ids.length == amounts.length, "ERC1155: ids and amounts length mismatch");
                address operator = _msgSender();
                _beforeTokenTransfer(operator, from, address(0), ids, amounts, "");
                for (uint256 i = 0; i < ids.length; i++) {
                    uint256 id = ids[i];
                    uint256 amount = amounts[i];
                    uint256 fromBalance = _balances[id][from];
                    require(fromBalance >= amount, "ERC1155: burn amount exceeds balance");
                    unchecked {
                        _balances[id][from] = fromBalance - amount;
                    }
                }
                emit TransferBatch(operator, from, address(0), ids, amounts);
                _afterTokenTransfer(operator, from, address(0), ids, amounts, "");
            }
            /**
             * @dev Approve `operator` to operate on all of `owner` tokens
             *
             * Emits an {ApprovalForAll} event.
             */
            function _setApprovalForAll(
                address owner,
                address operator,
                bool approved
            ) internal virtual {
                require(owner != operator, "ERC1155: setting approval status for self");
                _operatorApprovals[owner][operator] = approved;
                emit ApprovalForAll(owner, operator, approved);
            }
            /**
             * @dev Hook that is called before any token transfer. This includes minting
             * and burning, as well as batched variants.
             *
             * The same hook is called on both single and batched variants. For single
             * transfers, the length of the `ids` and `amounts` arrays will be 1.
             *
             * Calling conditions (for each `id` and `amount` pair):
             *
             * - When `from` and `to` are both non-zero, `amount` of ``from``'s tokens
             * of token type `id` will be  transferred to `to`.
             * - When `from` is zero, `amount` tokens of token type `id` will be minted
             * for `to`.
             * - when `to` is zero, `amount` of ``from``'s tokens of token type `id`
             * will be burned.
             * - `from` and `to` are never both zero.
             * - `ids` and `amounts` have the same, non-zero length.
             *
             * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
             */
            function _beforeTokenTransfer(
                address operator,
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) internal virtual {}
            /**
             * @dev Hook that is called after any token transfer. This includes minting
             * and burning, as well as batched variants.
             *
             * The same hook is called on both single and batched variants. For single
             * transfers, the length of the `id` and `amount` arrays will be 1.
             *
             * Calling conditions (for each `id` and `amount` pair):
             *
             * - When `from` and `to` are both non-zero, `amount` of ``from``'s tokens
             * of token type `id` will be  transferred to `to`.
             * - When `from` is zero, `amount` tokens of token type `id` will be minted
             * for `to`.
             * - when `to` is zero, `amount` of ``from``'s tokens of token type `id`
             * will be burned.
             * - `from` and `to` are never both zero.
             * - `ids` and `amounts` have the same, non-zero length.
             *
             * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
             */
            function _afterTokenTransfer(
                address operator,
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) internal virtual {}
            function _doSafeTransferAcceptanceCheck(
                address operator,
                address from,
                address to,
                uint256 id,
                uint256 amount,
                bytes memory data
            ) private {
                if (to.isContract()) {
                    try IERC1155ReceiverUpgradeable(to).onERC1155Received(operator, from, id, amount, data) returns (bytes4 response) {
                        if (response != IERC1155ReceiverUpgradeable.onERC1155Received.selector) {
                            revert("ERC1155: ERC1155Receiver rejected tokens");
                        }
                    } catch Error(string memory reason) {
                        revert(reason);
                    } catch {
                        revert("ERC1155: transfer to non ERC1155Receiver implementer");
                    }
                }
            }
            function _doSafeBatchTransferAcceptanceCheck(
                address operator,
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) private {
                if (to.isContract()) {
                    try IERC1155ReceiverUpgradeable(to).onERC1155BatchReceived(operator, from, ids, amounts, data) returns (
                        bytes4 response
                    ) {
                        if (response != IERC1155ReceiverUpgradeable.onERC1155BatchReceived.selector) {
                            revert("ERC1155: ERC1155Receiver rejected tokens");
                        }
                    } catch Error(string memory reason) {
                        revert(reason);
                    } catch {
                        revert("ERC1155: transfer to non ERC1155Receiver implementer");
                    }
                }
            }
            function _asSingletonArray(uint256 element) private pure returns (uint256[] memory) {
                uint256[] memory array = new uint256[](1);
                array[0] = element;
                return array;
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[47] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.5.0) (token/ERC1155/IERC1155Receiver.sol)
        pragma solidity ^0.8.0;
        import "../../utils/introspection/IERC165Upgradeable.sol";
        /**
         * @dev _Available since v3.1._
         */
        interface IERC1155ReceiverUpgradeable is IERC165Upgradeable {
            /**
             * @dev Handles the receipt of a single ERC1155 token type. This function is
             * called at the end of a `safeTransferFrom` after the balance has been updated.
             *
             * NOTE: To accept the transfer, this must return
             * `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))`
             * (i.e. 0xf23a6e61, or its own function selector).
             *
             * @param operator The address which initiated the transfer (i.e. msg.sender)
             * @param from The address which previously owned the token
             * @param id The ID of the token being transferred
             * @param value The amount of tokens being transferred
             * @param data Additional data with no specified format
             * @return `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` if transfer is allowed
             */
            function onERC1155Received(
                address operator,
                address from,
                uint256 id,
                uint256 value,
                bytes calldata data
            ) external returns (bytes4);
            /**
             * @dev Handles the receipt of a multiple ERC1155 token types. This function
             * is called at the end of a `safeBatchTransferFrom` after the balances have
             * been updated.
             *
             * NOTE: To accept the transfer(s), this must return
             * `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))`
             * (i.e. 0xbc197c81, or its own function selector).
             *
             * @param operator The address which initiated the batch transfer (i.e. msg.sender)
             * @param from The address which previously owned the token
             * @param ids An array containing ids of each token being transferred (order and length must match values array)
             * @param values An array containing amounts of each token being transferred (order and length must match ids array)
             * @param data Additional data with no specified format
             * @return `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` if transfer is allowed
             */
            function onERC1155BatchReceived(
                address operator,
                address from,
                uint256[] calldata ids,
                uint256[] calldata values,
                bytes calldata data
            ) external returns (bytes4);
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (token/ERC1155/IERC1155.sol)
        pragma solidity ^0.8.0;
        import "../../utils/introspection/IERC165Upgradeable.sol";
        /**
         * @dev Required interface of an ERC1155 compliant contract, as defined in the
         * https://eips.ethereum.org/EIPS/eip-1155[EIP].
         *
         * _Available since v3.1._
         */
        interface IERC1155Upgradeable is IERC165Upgradeable {
            /**
             * @dev Emitted when `value` tokens of token type `id` are transferred from `from` to `to` by `operator`.
             */
            event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value);
            /**
             * @dev Equivalent to multiple {TransferSingle} events, where `operator`, `from` and `to` are the same for all
             * transfers.
             */
            event TransferBatch(
                address indexed operator,
                address indexed from,
                address indexed to,
                uint256[] ids,
                uint256[] values
            );
            /**
             * @dev Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to
             * `approved`.
             */
            event ApprovalForAll(address indexed account, address indexed operator, bool approved);
            /**
             * @dev Emitted when the URI for token type `id` changes to `value`, if it is a non-programmatic URI.
             *
             * If an {URI} event was emitted for `id`, the standard
             * https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[guarantees] that `value` will equal the value
             * returned by {IERC1155MetadataURI-uri}.
             */
            event URI(string value, uint256 indexed id);
            /**
             * @dev Returns the amount of tokens of token type `id` owned by `account`.
             *
             * Requirements:
             *
             * - `account` cannot be the zero address.
             */
            function balanceOf(address account, uint256 id) external view returns (uint256);
            /**
             * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {balanceOf}.
             *
             * Requirements:
             *
             * - `accounts` and `ids` must have the same length.
             */
            function balanceOfBatch(address[] calldata accounts, uint256[] calldata ids)
                external
                view
                returns (uint256[] memory);
            /**
             * @dev Grants or revokes permission to `operator` to transfer the caller's tokens, according to `approved`,
             *
             * Emits an {ApprovalForAll} event.
             *
             * Requirements:
             *
             * - `operator` cannot be the caller.
             */
            function setApprovalForAll(address operator, bool approved) external;
            /**
             * @dev Returns true if `operator` is approved to transfer ``account``'s tokens.
             *
             * See {setApprovalForAll}.
             */
            function isApprovedForAll(address account, address operator) external view returns (bool);
            /**
             * @dev Transfers `amount` tokens of token type `id` from `from` to `to`.
             *
             * Emits a {TransferSingle} event.
             *
             * Requirements:
             *
             * - `to` cannot be the zero address.
             * - If the caller is not `from`, it must have been approved to spend ``from``'s tokens via {setApprovalForAll}.
             * - `from` must have a balance of tokens of type `id` of at least `amount`.
             * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
             * acceptance magic value.
             */
            function safeTransferFrom(
                address from,
                address to,
                uint256 id,
                uint256 amount,
                bytes calldata data
            ) external;
            /**
             * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {safeTransferFrom}.
             *
             * Emits a {TransferBatch} event.
             *
             * Requirements:
             *
             * - `ids` and `amounts` must have the same length.
             * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
             * acceptance magic value.
             */
            function safeBatchTransferFrom(
                address from,
                address to,
                uint256[] calldata ids,
                uint256[] calldata amounts,
                bytes calldata data
            ) external;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (token/ERC1155/extensions/IERC1155MetadataURI.sol)
        pragma solidity ^0.8.0;
        import "../IERC1155Upgradeable.sol";
        /**
         * @dev Interface of the optional ERC1155MetadataExtension interface, as defined
         * in the https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[EIP].
         *
         * _Available since v3.1._
         */
        interface IERC1155MetadataURIUpgradeable is IERC1155Upgradeable {
            /**
             * @dev Returns the URI for token type `id`.
             *
             * If the `\\{id\\}` substring is present in the URI, it must be replaced by
             * clients with the actual token type ID.
             */
            function uri(uint256 id) external view returns (string memory);
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (utils/Address.sol)
        pragma solidity ^0.8.1;
        /**
         * @dev Collection of functions related to the address type
         */
        library AddressUpgradeable {
            /**
             * @dev Returns true if `account` is a contract.
             *
             * [IMPORTANT]
             * ====
             * It is unsafe to assume that an address for which this function returns
             * false is an externally-owned account (EOA) and not a contract.
             *
             * Among others, `isContract` will return false for the following
             * types of addresses:
             *
             *  - an externally-owned account
             *  - a contract in construction
             *  - an address where a contract will be created
             *  - an address where a contract lived, but was destroyed
             * ====
             *
             * [IMPORTANT]
             * ====
             * You shouldn't rely on `isContract` to protect against flash loan attacks!
             *
             * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
             * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
             * constructor.
             * ====
             */
            function isContract(address account) internal view returns (bool) {
                // This method relies on extcodesize/address.code.length, which returns 0
                // for contracts in construction, since the code is only stored at the end
                // of the constructor execution.
                return account.code.length > 0;
            }
            /**
             * @dev Replacement for Solidity's `transfer`: sends `amount` wei to
             * `recipient`, forwarding all available gas and reverting on errors.
             *
             * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
             * of certain opcodes, possibly making contracts go over the 2300 gas limit
             * imposed by `transfer`, making them unable to receive funds via
             * `transfer`. {sendValue} removes this limitation.
             *
             * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
             *
             * IMPORTANT: because control is transferred to `recipient`, care must be
             * taken to not create reentrancy vulnerabilities. Consider using
             * {ReentrancyGuard} or the
             * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
             */
            function sendValue(address payable recipient, uint256 amount) internal {
                require(address(this).balance >= amount, "Address: insufficient balance");
                (bool success, ) = recipient.call{value: amount}("");
                require(success, "Address: unable to send value, recipient may have reverted");
            }
            /**
             * @dev Performs a Solidity function call using a low level `call`. A
             * plain `call` is an unsafe replacement for a function call: use this
             * function instead.
             *
             * If `target` reverts with a revert reason, it is bubbled up by this
             * function (like regular Solidity function calls).
             *
             * Returns the raw returned data. To convert to the expected return value,
             * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
             *
             * Requirements:
             *
             * - `target` must be a contract.
             * - calling `target` with `data` must not revert.
             *
             * _Available since v3.1._
             */
            function functionCall(address target, bytes memory data) internal returns (bytes memory) {
                return functionCall(target, data, "Address: low-level call failed");
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
             * `errorMessage` as a fallback revert reason when `target` reverts.
             *
             * _Available since v3.1._
             */
            function functionCall(
                address target,
                bytes memory data,
                string memory errorMessage
            ) internal returns (bytes memory) {
                return functionCallWithValue(target, data, 0, errorMessage);
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
             * but also transferring `value` wei to `target`.
             *
             * Requirements:
             *
             * - the calling contract must have an ETH balance of at least `value`.
             * - the called Solidity function must be `payable`.
             *
             * _Available since v3.1._
             */
            function functionCallWithValue(
                address target,
                bytes memory data,
                uint256 value
            ) internal returns (bytes memory) {
                return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
            }
            /**
             * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
             * with `errorMessage` as a fallback revert reason when `target` reverts.
             *
             * _Available since v3.1._
             */
            function functionCallWithValue(
                address target,
                bytes memory data,
                uint256 value,
                string memory errorMessage
            ) internal returns (bytes memory) {
                require(address(this).balance >= value, "Address: insufficient balance for call");
                require(isContract(target), "Address: call to non-contract");
                (bool success, bytes memory returndata) = target.call{value: value}(data);
                return verifyCallResult(success, returndata, errorMessage);
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
             * but performing a static call.
             *
             * _Available since v3.3._
             */
            function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
                return functionStaticCall(target, data, "Address: low-level static call failed");
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
             * but performing a static call.
             *
             * _Available since v3.3._
             */
            function functionStaticCall(
                address target,
                bytes memory data,
                string memory errorMessage
            ) internal view returns (bytes memory) {
                require(isContract(target), "Address: static call to non-contract");
                (bool success, bytes memory returndata) = target.staticcall(data);
                return verifyCallResult(success, returndata, errorMessage);
            }
            /**
             * @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
             * revert reason using the provided one.
             *
             * _Available since v4.3._
             */
            function verifyCallResult(
                bool success,
                bytes memory returndata,
                string memory errorMessage
            ) internal pure returns (bytes memory) {
                if (success) {
                    return returndata;
                } else {
                    // Look for revert reason and bubble it up if present
                    if (returndata.length > 0) {
                        // The easiest way to bubble the revert reason is using memory via assembly
                        /// @solidity memory-safe-assembly
                        assembly {
                            let returndata_size := mload(returndata)
                            revert(add(32, returndata), returndata_size)
                        }
                    } else {
                        revert(errorMessage);
                    }
                }
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
        pragma solidity ^0.8.0;
        import "../proxy/utils/Initializable.sol";
        /**
         * @dev Provides information about the current execution context, including the
         * sender of the transaction and its data. While these are generally available
         * via msg.sender and msg.data, 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).
         *
         * This contract is only required for intermediate, library-like contracts.
         */
        abstract contract ContextUpgradeable is Initializable {
            function __Context_init() internal onlyInitializing {
            }
            function __Context_init_unchained() internal onlyInitializing {
            }
            function _msgSender() internal view virtual returns (address) {
                return msg.sender;
            }
            function _msgData() internal view virtual returns (bytes calldata) {
                return msg.data;
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[50] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.5.0) (utils/Multicall.sol)
        pragma solidity ^0.8.0;
        import "./AddressUpgradeable.sol";
        import "../proxy/utils/Initializable.sol";
        /**
         * @dev Provides a function to batch together multiple calls in a single external call.
         *
         * _Available since v4.1._
         */
        abstract contract MulticallUpgradeable is Initializable {
            function __Multicall_init() internal onlyInitializing {
            }
            function __Multicall_init_unchained() internal onlyInitializing {
            }
            /**
             * @dev Receives and executes a batch of function calls on this contract.
             */
            function multicall(bytes[] calldata data) external virtual returns (bytes[] memory results) {
                results = new bytes[](data.length);
                for (uint256 i = 0; i < data.length; i++) {
                    results[i] = _functionDelegateCall(address(this), data[i]);
                }
                return results;
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
             * but performing a delegate call.
             *
             * _Available since v3.4._
             */
            function _functionDelegateCall(address target, bytes memory data) private returns (bytes memory) {
                require(AddressUpgradeable.isContract(target), "Address: delegate call to non-contract");
                // solhint-disable-next-line avoid-low-level-calls
                (bool success, bytes memory returndata) = target.delegatecall(data);
                return AddressUpgradeable.verifyCallResult(success, returndata, "Address: low-level delegate call failed");
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[50] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (utils/Strings.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev String operations.
         */
        library StringsUpgradeable {
            bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef";
            uint8 private constant _ADDRESS_LENGTH = 20;
            /**
             * @dev Converts a `uint256` to its ASCII `string` decimal representation.
             */
            function toString(uint256 value) internal pure returns (string memory) {
                // Inspired by OraclizeAPI's implementation - MIT licence
                // https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol
                if (value == 0) {
                    return "0";
                }
                uint256 temp = value;
                uint256 digits;
                while (temp != 0) {
                    digits++;
                    temp /= 10;
                }
                bytes memory buffer = new bytes(digits);
                while (value != 0) {
                    digits -= 1;
                    buffer[digits] = bytes1(uint8(48 + uint256(value % 10)));
                    value /= 10;
                }
                return string(buffer);
            }
            /**
             * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
             */
            function toHexString(uint256 value) internal pure returns (string memory) {
                if (value == 0) {
                    return "0x00";
                }
                uint256 temp = value;
                uint256 length = 0;
                while (temp != 0) {
                    length++;
                    temp >>= 8;
                }
                return toHexString(value, length);
            }
            /**
             * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
             */
            function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
                bytes memory buffer = new bytes(2 * length + 2);
                buffer[0] = "0";
                buffer[1] = "x";
                for (uint256 i = 2 * length + 1; i > 1; --i) {
                    buffer[i] = _HEX_SYMBOLS[value & 0xf];
                    value >>= 4;
                }
                require(value == 0, "Strings: hex length insufficient");
                return string(buffer);
            }
            /**
             * @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation.
             */
            function toHexString(address addr) internal pure returns (string memory) {
                return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH);
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.3) (utils/cryptography/ECDSA.sol)
        pragma solidity ^0.8.0;
        import "../StringsUpgradeable.sol";
        /**
         * @dev Elliptic Curve Digital Signature Algorithm (ECDSA) operations.
         *
         * These functions can be used to verify that a message was signed by the holder
         * of the private keys of a given address.
         */
        library ECDSAUpgradeable {
            enum RecoverError {
                NoError,
                InvalidSignature,
                InvalidSignatureLength,
                InvalidSignatureS,
                InvalidSignatureV
            }
            function _throwError(RecoverError error) private pure {
                if (error == RecoverError.NoError) {
                    return; // no error: do nothing
                } else if (error == RecoverError.InvalidSignature) {
                    revert("ECDSA: invalid signature");
                } else if (error == RecoverError.InvalidSignatureLength) {
                    revert("ECDSA: invalid signature length");
                } else if (error == RecoverError.InvalidSignatureS) {
                    revert("ECDSA: invalid signature 's' value");
                } else if (error == RecoverError.InvalidSignatureV) {
                    revert("ECDSA: invalid signature 'v' value");
                }
            }
            /**
             * @dev Returns the address that signed a hashed message (`hash`) with
             * `signature` or error string. This address can then be used for verification purposes.
             *
             * The `ecrecover` EVM opcode allows for malleable (non-unique) signatures:
             * this function rejects them by requiring the `s` value to be in the lower
             * half order, and the `v` value to be either 27 or 28.
             *
             * IMPORTANT: `hash` _must_ be the result of a hash operation for the
             * verification to be secure: it is possible to craft signatures that
             * recover to arbitrary addresses for non-hashed data. A safe way to ensure
             * this is by receiving a hash of the original message (which may otherwise
             * be too long), and then calling {toEthSignedMessageHash} on it.
             *
             * Documentation for signature generation:
             * - with https://web3js.readthedocs.io/en/v1.3.4/web3-eth-accounts.html#sign[Web3.js]
             * - with https://docs.ethers.io/v5/api/signer/#Signer-signMessage[ethers]
             *
             * _Available since v4.3._
             */
            function tryRecover(bytes32 hash, bytes memory signature) internal pure returns (address, RecoverError) {
                if (signature.length == 65) {
                    bytes32 r;
                    bytes32 s;
                    uint8 v;
                    // ecrecover takes the signature parameters, and the only way to get them
                    // currently is to use assembly.
                    /// @solidity memory-safe-assembly
                    assembly {
                        r := mload(add(signature, 0x20))
                        s := mload(add(signature, 0x40))
                        v := byte(0, mload(add(signature, 0x60)))
                    }
                    return tryRecover(hash, v, r, s);
                } else {
                    return (address(0), RecoverError.InvalidSignatureLength);
                }
            }
            /**
             * @dev Returns the address that signed a hashed message (`hash`) with
             * `signature`. This address can then be used for verification purposes.
             *
             * The `ecrecover` EVM opcode allows for malleable (non-unique) signatures:
             * this function rejects them by requiring the `s` value to be in the lower
             * half order, and the `v` value to be either 27 or 28.
             *
             * IMPORTANT: `hash` _must_ be the result of a hash operation for the
             * verification to be secure: it is possible to craft signatures that
             * recover to arbitrary addresses for non-hashed data. A safe way to ensure
             * this is by receiving a hash of the original message (which may otherwise
             * be too long), and then calling {toEthSignedMessageHash} on it.
             */
            function recover(bytes32 hash, bytes memory signature) internal pure returns (address) {
                (address recovered, RecoverError error) = tryRecover(hash, signature);
                _throwError(error);
                return recovered;
            }
            /**
             * @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately.
             *
             * See https://eips.ethereum.org/EIPS/eip-2098[EIP-2098 short signatures]
             *
             * _Available since v4.3._
             */
            function tryRecover(
                bytes32 hash,
                bytes32 r,
                bytes32 vs
            ) internal pure returns (address, RecoverError) {
                bytes32 s = vs & bytes32(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff);
                uint8 v = uint8((uint256(vs) >> 255) + 27);
                return tryRecover(hash, v, r, s);
            }
            /**
             * @dev Overload of {ECDSA-recover} that receives the `r and `vs` short-signature fields separately.
             *
             * _Available since v4.2._
             */
            function recover(
                bytes32 hash,
                bytes32 r,
                bytes32 vs
            ) internal pure returns (address) {
                (address recovered, RecoverError error) = tryRecover(hash, r, vs);
                _throwError(error);
                return recovered;
            }
            /**
             * @dev Overload of {ECDSA-tryRecover} that receives the `v`,
             * `r` and `s` signature fields separately.
             *
             * _Available since v4.3._
             */
            function tryRecover(
                bytes32 hash,
                uint8 v,
                bytes32 r,
                bytes32 s
            ) internal pure returns (address, RecoverError) {
                // EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature
                // unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines
                // the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. Most
                // signatures from current libraries generate a unique signature with an s-value in the lower half order.
                //
                // If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value
                // with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or
                // vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept
                // these malleable signatures as well.
                if (uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) {
                    return (address(0), RecoverError.InvalidSignatureS);
                }
                if (v != 27 && v != 28) {
                    return (address(0), RecoverError.InvalidSignatureV);
                }
                // If the signature is valid (and not malleable), return the signer address
                address signer = ecrecover(hash, v, r, s);
                if (signer == address(0)) {
                    return (address(0), RecoverError.InvalidSignature);
                }
                return (signer, RecoverError.NoError);
            }
            /**
             * @dev Overload of {ECDSA-recover} that receives the `v`,
             * `r` and `s` signature fields separately.
             */
            function recover(
                bytes32 hash,
                uint8 v,
                bytes32 r,
                bytes32 s
            ) internal pure returns (address) {
                (address recovered, RecoverError error) = tryRecover(hash, v, r, s);
                _throwError(error);
                return recovered;
            }
            /**
             * @dev Returns an Ethereum Signed Message, created from a `hash`. This
             * produces hash corresponding to the one signed with the
             * https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`]
             * JSON-RPC method as part of EIP-191.
             *
             * See {recover}.
             */
            function toEthSignedMessageHash(bytes32 hash) internal pure returns (bytes32) {
                // 32 is the length in bytes of hash,
                // enforced by the type signature above
                return keccak256(abi.encodePacked("\\x19Ethereum Signed Message:\
        32", hash));
            }
            /**
             * @dev Returns an Ethereum Signed Message, created from `s`. This
             * produces hash corresponding to the one signed with the
             * https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`]
             * JSON-RPC method as part of EIP-191.
             *
             * See {recover}.
             */
            function toEthSignedMessageHash(bytes memory s) internal pure returns (bytes32) {
                return keccak256(abi.encodePacked("\\x19Ethereum Signed Message:\
        ", StringsUpgradeable.toString(s.length), s));
            }
            /**
             * @dev Returns an Ethereum Signed Typed Data, created from a
             * `domainSeparator` and a `structHash`. This produces hash corresponding
             * to the one signed with the
             * https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`]
             * JSON-RPC method as part of EIP-712.
             *
             * See {recover}.
             */
            function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32) {
                return keccak256(abi.encodePacked("\\x19\\x01", domainSeparator, structHash));
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (utils/cryptography/draft-EIP712.sol)
        pragma solidity ^0.8.0;
        import "./ECDSAUpgradeable.sol";
        import "../../proxy/utils/Initializable.sol";
        /**
         * @dev https://eips.ethereum.org/EIPS/eip-712[EIP 712] is a standard for hashing and signing of typed structured data.
         *
         * The encoding specified in the EIP is very generic, and such a generic implementation in Solidity is not feasible,
         * thus this contract does not implement the encoding itself. Protocols need to implement the type-specific encoding
         * they need in their contracts using a combination of `abi.encode` and `keccak256`.
         *
         * This contract implements the EIP 712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding
         * scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA
         * ({_hashTypedDataV4}).
         *
         * The implementation of the domain separator was designed to be as efficient as possible while still properly updating
         * the chain id to protect against replay attacks on an eventual fork of the chain.
         *
         * NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method
         * https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask].
         *
         * _Available since v3.4._
         *
         * @custom:storage-size 52
         */
        abstract contract EIP712Upgradeable is Initializable {
            /* solhint-disable var-name-mixedcase */
            bytes32 private _HASHED_NAME;
            bytes32 private _HASHED_VERSION;
            bytes32 private constant _TYPE_HASH = keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");
            /* solhint-enable var-name-mixedcase */
            /**
             * @dev Initializes the domain separator and parameter caches.
             *
             * The meaning of `name` and `version` is specified in
             * https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator[EIP 712]:
             *
             * - `name`: the user readable name of the signing domain, i.e. the name of the DApp or the protocol.
             * - `version`: the current major version of the signing domain.
             *
             * NOTE: These parameters cannot be changed except through a xref:learn::upgrading-smart-contracts.adoc[smart
             * contract upgrade].
             */
            function __EIP712_init(string memory name, string memory version) internal onlyInitializing {
                __EIP712_init_unchained(name, version);
            }
            function __EIP712_init_unchained(string memory name, string memory version) internal onlyInitializing {
                bytes32 hashedName = keccak256(bytes(name));
                bytes32 hashedVersion = keccak256(bytes(version));
                _HASHED_NAME = hashedName;
                _HASHED_VERSION = hashedVersion;
            }
            /**
             * @dev Returns the domain separator for the current chain.
             */
            function _domainSeparatorV4() internal view returns (bytes32) {
                return _buildDomainSeparator(_TYPE_HASH, _EIP712NameHash(), _EIP712VersionHash());
            }
            function _buildDomainSeparator(
                bytes32 typeHash,
                bytes32 nameHash,
                bytes32 versionHash
            ) private view returns (bytes32) {
                return keccak256(abi.encode(typeHash, nameHash, versionHash, block.chainid, address(this)));
            }
            /**
             * @dev Given an already https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct[hashed struct], this
             * function returns the hash of the fully encoded EIP712 message for this domain.
             *
             * This hash can be used together with {ECDSA-recover} to obtain the signer of a message. For example:
             *
             * ```solidity
             * bytes32 digest = _hashTypedDataV4(keccak256(abi.encode(
             *     keccak256("Mail(address to,string contents)"),
             *     mailTo,
             *     keccak256(bytes(mailContents))
             * )));
             * address signer = ECDSA.recover(digest, signature);
             * ```
             */
            function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) {
                return ECDSAUpgradeable.toTypedDataHash(_domainSeparatorV4(), structHash);
            }
            /**
             * @dev The hash of the name parameter for the EIP712 domain.
             *
             * NOTE: This function reads from storage by default, but can be redefined to return a constant value if gas costs
             * are a concern.
             */
            function _EIP712NameHash() internal virtual view returns (bytes32) {
                return _HASHED_NAME;
            }
            /**
             * @dev The hash of the version parameter for the EIP712 domain.
             *
             * NOTE: This function reads from storage by default, but can be redefined to return a constant value if gas costs
             * are a concern.
             */
            function _EIP712VersionHash() internal virtual view returns (bytes32) {
                return _HASHED_VERSION;
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[50] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)
        pragma solidity ^0.8.0;
        import "./IERC165Upgradeable.sol";
        import "../../proxy/utils/Initializable.sol";
        /**
         * @dev Implementation of the {IERC165} interface.
         *
         * Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
         * for the additional interface id that will be supported. For example:
         *
         * ```solidity
         * function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
         *     return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
         * }
         * ```
         *
         * Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
         */
        abstract contract ERC165Upgradeable is Initializable, IERC165Upgradeable {
            function __ERC165_init() internal onlyInitializing {
            }
            function __ERC165_init_unchained() internal onlyInitializing {
            }
            /**
             * @dev See {IERC165-supportsInterface}.
             */
            function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
                return interfaceId == type(IERC165Upgradeable).interfaceId;
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[50] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev Interface of the ERC165 standard, as defined in the
         * https://eips.ethereum.org/EIPS/eip-165[EIP].
         *
         * Implementers can declare support of contract interfaces, which can then be
         * queried by others ({ERC165Checker}).
         *
         * For an implementation, see {ERC165}.
         */
        interface IERC165Upgradeable {
            /**
             * @dev Returns true if this contract implements the interface defined by
             * `interfaceId`. See the corresponding
             * https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
             * to learn more about how these ids are created.
             *
             * This function call must use less than 30 000 gas.
             */
            function supportsInterface(bytes4 interfaceId) external view returns (bool);
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (utils/structs/EnumerableSet.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev Library for managing
         * https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive
         * types.
         *
         * Sets have the following properties:
         *
         * - Elements are added, removed, and checked for existence in constant time
         * (O(1)).
         * - Elements are enumerated in O(n). No guarantees are made on the ordering.
         *
         * ```
         * contract Example {
         *     // Add the library methods
         *     using EnumerableSet for EnumerableSet.AddressSet;
         *
         *     // Declare a set state variable
         *     EnumerableSet.AddressSet private mySet;
         * }
         * ```
         *
         * As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`)
         * and `uint256` (`UintSet`) are supported.
         *
         * [WARNING]
         * ====
         *  Trying to delete such a structure from storage will likely result in data corruption, rendering the structure unusable.
         *  See https://github.com/ethereum/solidity/pull/11843[ethereum/solidity#11843] for more info.
         *
         *  In order to clean an EnumerableSet, you can either remove all elements one by one or create a fresh instance using an array of EnumerableSet.
         * ====
         */
        library EnumerableSetUpgradeable {
            // To implement this library for multiple types with as little code
            // repetition as possible, we write it in terms of a generic Set type with
            // bytes32 values.
            // The Set implementation uses private functions, and user-facing
            // implementations (such as AddressSet) are just wrappers around the
            // underlying Set.
            // This means that we can only create new EnumerableSets for types that fit
            // in bytes32.
            struct Set {
                // Storage of set values
                bytes32[] _values;
                // Position of the value in the `values` array, plus 1 because index 0
                // means a value is not in the set.
                mapping(bytes32 => uint256) _indexes;
            }
            /**
             * @dev Add a value to a set. O(1).
             *
             * Returns true if the value was added to the set, that is if it was not
             * already present.
             */
            function _add(Set storage set, bytes32 value) private returns (bool) {
                if (!_contains(set, value)) {
                    set._values.push(value);
                    // The value is stored at length-1, but we add 1 to all indexes
                    // and use 0 as a sentinel value
                    set._indexes[value] = set._values.length;
                    return true;
                } else {
                    return false;
                }
            }
            /**
             * @dev Removes a value from a set. O(1).
             *
             * Returns true if the value was removed from the set, that is if it was
             * present.
             */
            function _remove(Set storage set, bytes32 value) private returns (bool) {
                // We read and store the value's index to prevent multiple reads from the same storage slot
                uint256 valueIndex = set._indexes[value];
                if (valueIndex != 0) {
                    // Equivalent to contains(set, value)
                    // To delete an element from the _values array in O(1), we swap the element to delete with the last one in
                    // the array, and then remove the last element (sometimes called as 'swap and pop').
                    // This modifies the order of the array, as noted in {at}.
                    uint256 toDeleteIndex = valueIndex - 1;
                    uint256 lastIndex = set._values.length - 1;
                    if (lastIndex != toDeleteIndex) {
                        bytes32 lastValue = set._values[lastIndex];
                        // Move the last value to the index where the value to delete is
                        set._values[toDeleteIndex] = lastValue;
                        // Update the index for the moved value
                        set._indexes[lastValue] = valueIndex; // Replace lastValue's index to valueIndex
                    }
                    // Delete the slot where the moved value was stored
                    set._values.pop();
                    // Delete the index for the deleted slot
                    delete set._indexes[value];
                    return true;
                } else {
                    return false;
                }
            }
            /**
             * @dev Returns true if the value is in the set. O(1).
             */
            function _contains(Set storage set, bytes32 value) private view returns (bool) {
                return set._indexes[value] != 0;
            }
            /**
             * @dev Returns the number of values on the set. O(1).
             */
            function _length(Set storage set) private view returns (uint256) {
                return set._values.length;
            }
            /**
             * @dev Returns the value stored at position `index` in the set. O(1).
             *
             * Note that there are no guarantees on the ordering of values inside the
             * array, and it may change when more values are added or removed.
             *
             * Requirements:
             *
             * - `index` must be strictly less than {length}.
             */
            function _at(Set storage set, uint256 index) private view returns (bytes32) {
                return set._values[index];
            }
            /**
             * @dev Return the entire set in an array
             *
             * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
             * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
             * this function has an unbounded cost, and using it as part of a state-changing function may render the function
             * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
             */
            function _values(Set storage set) private view returns (bytes32[] memory) {
                return set._values;
            }
            // Bytes32Set
            struct Bytes32Set {
                Set _inner;
            }
            /**
             * @dev Add a value to a set. O(1).
             *
             * Returns true if the value was added to the set, that is if it was not
             * already present.
             */
            function add(Bytes32Set storage set, bytes32 value) internal returns (bool) {
                return _add(set._inner, value);
            }
            /**
             * @dev Removes a value from a set. O(1).
             *
             * Returns true if the value was removed from the set, that is if it was
             * present.
             */
            function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) {
                return _remove(set._inner, value);
            }
            /**
             * @dev Returns true if the value is in the set. O(1).
             */
            function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) {
                return _contains(set._inner, value);
            }
            /**
             * @dev Returns the number of values in the set. O(1).
             */
            function length(Bytes32Set storage set) internal view returns (uint256) {
                return _length(set._inner);
            }
            /**
             * @dev Returns the value stored at position `index` in the set. O(1).
             *
             * Note that there are no guarantees on the ordering of values inside the
             * array, and it may change when more values are added or removed.
             *
             * Requirements:
             *
             * - `index` must be strictly less than {length}.
             */
            function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) {
                return _at(set._inner, index);
            }
            /**
             * @dev Return the entire set in an array
             *
             * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
             * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
             * this function has an unbounded cost, and using it as part of a state-changing function may render the function
             * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
             */
            function values(Bytes32Set storage set) internal view returns (bytes32[] memory) {
                return _values(set._inner);
            }
            // AddressSet
            struct AddressSet {
                Set _inner;
            }
            /**
             * @dev Add a value to a set. O(1).
             *
             * Returns true if the value was added to the set, that is if it was not
             * already present.
             */
            function add(AddressSet storage set, address value) internal returns (bool) {
                return _add(set._inner, bytes32(uint256(uint160(value))));
            }
            /**
             * @dev Removes a value from a set. O(1).
             *
             * Returns true if the value was removed from the set, that is if it was
             * present.
             */
            function remove(AddressSet storage set, address value) internal returns (bool) {
                return _remove(set._inner, bytes32(uint256(uint160(value))));
            }
            /**
             * @dev Returns true if the value is in the set. O(1).
             */
            function contains(AddressSet storage set, address value) internal view returns (bool) {
                return _contains(set._inner, bytes32(uint256(uint160(value))));
            }
            /**
             * @dev Returns the number of values in the set. O(1).
             */
            function length(AddressSet storage set) internal view returns (uint256) {
                return _length(set._inner);
            }
            /**
             * @dev Returns the value stored at position `index` in the set. O(1).
             *
             * Note that there are no guarantees on the ordering of values inside the
             * array, and it may change when more values are added or removed.
             *
             * Requirements:
             *
             * - `index` must be strictly less than {length}.
             */
            function at(AddressSet storage set, uint256 index) internal view returns (address) {
                return address(uint160(uint256(_at(set._inner, index))));
            }
            /**
             * @dev Return the entire set in an array
             *
             * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
             * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
             * this function has an unbounded cost, and using it as part of a state-changing function may render the function
             * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
             */
            function values(AddressSet storage set) internal view returns (address[] memory) {
                bytes32[] memory store = _values(set._inner);
                address[] memory result;
                /// @solidity memory-safe-assembly
                assembly {
                    result := store
                }
                return result;
            }
            // UintSet
            struct UintSet {
                Set _inner;
            }
            /**
             * @dev Add a value to a set. O(1).
             *
             * Returns true if the value was added to the set, that is if it was not
             * already present.
             */
            function add(UintSet storage set, uint256 value) internal returns (bool) {
                return _add(set._inner, bytes32(value));
            }
            /**
             * @dev Removes a value from a set. O(1).
             *
             * Returns true if the value was removed from the set, that is if it was
             * present.
             */
            function remove(UintSet storage set, uint256 value) internal returns (bool) {
                return _remove(set._inner, bytes32(value));
            }
            /**
             * @dev Returns true if the value is in the set. O(1).
             */
            function contains(UintSet storage set, uint256 value) internal view returns (bool) {
                return _contains(set._inner, bytes32(value));
            }
            /**
             * @dev Returns the number of values on the set. O(1).
             */
            function length(UintSet storage set) internal view returns (uint256) {
                return _length(set._inner);
            }
            /**
             * @dev Returns the value stored at position `index` in the set. O(1).
             *
             * Note that there are no guarantees on the ordering of values inside the
             * array, and it may change when more values are added or removed.
             *
             * Requirements:
             *
             * - `index` must be strictly less than {length}.
             */
            function at(UintSet storage set, uint256 index) internal view returns (uint256) {
                return uint256(_at(set._inner, index));
            }
            /**
             * @dev Return the entire set in an array
             *
             * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
             * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
             * this function has an unbounded cost, and using it as part of a state-changing function may render the function
             * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
             */
            function values(UintSet storage set) internal view returns (uint256[] memory) {
                bytes32[] memory store = _values(set._inner);
                uint256[] memory result;
                /// @solidity memory-safe-assembly
                assembly {
                    result := store
                }
                return result;
            }
        }
        

        File 2 of 4: TokenERC1155
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev Interface of the ERC165 standard, as defined in the
         * [EIP](https://eips.ethereum.org/EIPS/eip-165).
         *
         * Implementers can declare support of contract interfaces, which can then be
         * queried by others ({ERC165Checker}).
         *
         * For an implementation, see {ERC165}.
         */
        interface IERC165 {
            /**
             * @dev Returns true if this contract implements the interface defined by
             * `interfaceId`. See the corresponding
             * [EIP section](https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified)
             * to learn more about how these ids are created.
             *
             * This function call must use less than 30 000 gas.
             */
            function supportsInterface(bytes4 interfaceId) external view returns (bool);
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        /**
         * @title ERC20 interface
         * @dev see https://github.com/ethereum/EIPs/issues/20
         */
        interface IERC20 {
            function totalSupply() external view returns (uint256);
            function balanceOf(address who) external view returns (uint256);
            function allowance(address owner, address spender) external view returns (uint256);
            function transfer(address to, uint256 value) external returns (bool);
            function approve(address spender, uint256 value) external returns (bool);
            function transferFrom(
                address from,
                address to,
                uint256 value
            ) external returns (bool);
            event Transfer(address indexed from, address indexed to, uint256 value);
            event Approval(address indexed owner, address indexed spender, uint256 value);
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        import "./IERC165.sol";
        /**
         * @dev Interface for the NFT Royalty Standard.
         *
         * A standardized way to retrieve royalty payment information for non-fungible tokens (NFTs) to enable universal
         * support for royalty payments across all NFT marketplaces and ecosystem participants.
         *
         * _Available since v4.5._
         */
        interface IERC2981 is IERC165 {
            /**
             * @dev Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of
             * exchange. The royalty amount is denominated and should be payed in that same unit of exchange.
             */
            function royaltyInfo(uint256 tokenId, uint256 salePrice)
                external
                view
                returns (address receiver, uint256 royaltyAmount);
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        import { OperatorFiltererUpgradeable } from "./OperatorFiltererUpgradeable.sol";
        abstract contract DefaultOperatorFiltererUpgradeable is OperatorFiltererUpgradeable {
            address constant DEFAULT_SUBSCRIPTION = address(0x3cc6CddA760b79bAfa08dF41ECFA224f810dCeB6);
            function __DefaultOperatorFilterer_init() internal {
                OperatorFiltererUpgradeable.__OperatorFilterer_init(DEFAULT_SUBSCRIPTION, true);
            }
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        import "./interface/IOperatorFilterToggle.sol";
        abstract contract OperatorFilterToggle is IOperatorFilterToggle {
            bool public operatorRestriction;
            function setOperatorRestriction(bool _restriction) external {
                require(_canSetOperatorRestriction(), "Not authorized to set operator restriction.");
                _setOperatorRestriction(_restriction);
            }
            function _setOperatorRestriction(bool _restriction) internal {
                operatorRestriction = _restriction;
                emit OperatorRestriction(_restriction);
            }
            function _canSetOperatorRestriction() internal virtual returns (bool);
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        import "./interface/IOperatorFilterRegistry.sol";
        import "./OperatorFilterToggle.sol";
        abstract contract OperatorFiltererUpgradeable is OperatorFilterToggle {
            error OperatorNotAllowed(address operator);
            IOperatorFilterRegistry constant OPERATOR_FILTER_REGISTRY =
                IOperatorFilterRegistry(0x000000000000AAeB6D7670E522A718067333cd4E);
            function __OperatorFilterer_init(address subscriptionOrRegistrantToCopy, bool subscribe) internal {
                // If an inheriting token contract is deployed to a network without the registry deployed, the modifier
                // will not revert, but the contract will need to be registered with the registry once it is deployed in
                // order for the modifier to filter addresses.
                if (address(OPERATOR_FILTER_REGISTRY).code.length > 0) {
                    if (!OPERATOR_FILTER_REGISTRY.isRegistered(address(this))) {
                        if (subscribe) {
                            OPERATOR_FILTER_REGISTRY.registerAndSubscribe(address(this), subscriptionOrRegistrantToCopy);
                        } else {
                            if (subscriptionOrRegistrantToCopy != address(0)) {
                                OPERATOR_FILTER_REGISTRY.registerAndCopyEntries(address(this), subscriptionOrRegistrantToCopy);
                            } else {
                                OPERATOR_FILTER_REGISTRY.register(address(this));
                            }
                        }
                    }
                }
            }
            modifier onlyAllowedOperator(address from) virtual {
                // Check registry code length to facilitate testing in environments without a deployed registry.
                if (operatorRestriction) {
                    if (address(OPERATOR_FILTER_REGISTRY).code.length > 0) {
                        // Allow spending tokens from addresses with balance
                        // Note that this still allows listings and marketplaces with escrow to transfer tokens if transferred
                        // from an EOA.
                        if (from == msg.sender) {
                            _;
                            return;
                        }
                        if (!OPERATOR_FILTER_REGISTRY.isOperatorAllowed(address(this), msg.sender)) {
                            revert OperatorNotAllowed(msg.sender);
                        }
                    }
                }
                _;
            }
            modifier onlyAllowedOperatorApproval(address operator) virtual {
                // Check registry code length to facilitate testing in environments without a deployed registry.
                if (operatorRestriction) {
                    if (address(OPERATOR_FILTER_REGISTRY).code.length > 0) {
                        if (!OPERATOR_FILTER_REGISTRY.isOperatorAllowed(address(this), operator)) {
                            revert OperatorNotAllowed(operator);
                        }
                    }
                }
                _;
            }
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        interface IOperatorFilterRegistry {
            function isOperatorAllowed(address registrant, address operator) external view returns (bool);
            function register(address registrant) external;
            function registerAndSubscribe(address registrant, address subscription) external;
            function registerAndCopyEntries(address registrant, address registrantToCopy) external;
            function unregister(address addr) external;
            function updateOperator(
                address registrant,
                address operator,
                bool filtered
            ) external;
            function updateOperators(
                address registrant,
                address[] calldata operators,
                bool filtered
            ) external;
            function updateCodeHash(
                address registrant,
                bytes32 codehash,
                bool filtered
            ) external;
            function updateCodeHashes(
                address registrant,
                bytes32[] calldata codeHashes,
                bool filtered
            ) external;
            function subscribe(address registrant, address registrantToSubscribe) external;
            function unsubscribe(address registrant, bool copyExistingEntries) external;
            function subscriptionOf(address addr) external returns (address registrant);
            function subscribers(address registrant) external returns (address[] memory);
            function subscriberAt(address registrant, uint256 index) external returns (address);
            function copyEntriesOf(address registrant, address registrantToCopy) external;
            function isOperatorFiltered(address registrant, address operator) external returns (bool);
            function isCodeHashOfFiltered(address registrant, address operatorWithCode) external returns (bool);
            function isCodeHashFiltered(address registrant, bytes32 codeHash) external returns (bool);
            function filteredOperators(address addr) external returns (address[] memory);
            function filteredCodeHashes(address addr) external returns (bytes32[] memory);
            function filteredOperatorAt(address registrant, uint256 index) external returns (address);
            function filteredCodeHashAt(address registrant, uint256 index) external returns (bytes32);
            function isRegistered(address addr) external returns (bool);
            function codeHashOf(address addr) external returns (bytes32);
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        interface IOperatorFilterToggle {
            event OperatorRestriction(bool restriction);
            function operatorRestriction() external view returns (bool);
            function setOperatorRestriction(bool restriction) external;
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        /**
         *  Thirdweb's `Ownable` is a contract extension to be used with any base contract. It exposes functions for setting and reading
         *  who the 'owner' of the inheriting smart contract is, and lets the inheriting contract perform conditional logic that uses
         *  information about who the contract's owner is.
         */
        interface IOwnable {
            /// @dev Returns the owner of the contract.
            function owner() external view returns (address);
            /// @dev Lets a module admin set a new owner for the contract. The new owner must be a module admin.
            function setOwner(address _newOwner) external;
            /// @dev Emitted when a new Owner is set.
            event OwnerUpdated(address indexed prevOwner, address indexed newOwner);
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        /**
         *  Thirdweb's `PlatformFee` is a contract extension to be used with any base contract. It exposes functions for setting and reading
         *  the recipient of platform fee and the platform fee basis points, and lets the inheriting contract perform conditional logic
         *  that uses information about platform fees, if desired.
         */
        interface IPlatformFee {
            /// @dev Returns the platform fee bps and recipient.
            function getPlatformFeeInfo() external view returns (address, uint16);
            /// @dev Lets a module admin update the fees on primary sales.
            function setPlatformFeeInfo(address _platformFeeRecipient, uint256 _platformFeeBps) external;
            /// @dev Emitted when fee on primary sales is updated.
            event PlatformFeeInfoUpdated(address indexed platformFeeRecipient, uint256 platformFeeBps);
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        /**
         *  Thirdweb's `Primary` is a contract extension to be used with any base contract. It exposes functions for setting and reading
         *  the recipient of primary sales, and lets the inheriting contract perform conditional logic that uses information about
         *  primary sales, if desired.
         */
        interface IPrimarySale {
            /// @dev The adress that receives all primary sales value.
            function primarySaleRecipient() external view returns (address);
            /// @dev Lets a module admin set the default recipient of all primary sales.
            function setPrimarySaleRecipient(address _saleRecipient) external;
            /// @dev Emitted when a new sale recipient is set.
            event PrimarySaleRecipientUpdated(address indexed recipient);
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        import "../../eip/interface/IERC2981.sol";
        /**
         *  Thirdweb's `Royalty` is a contract extension to be used with any base contract. It exposes functions for setting and reading
         *  the recipient of royalty fee and the royalty fee basis points, and lets the inheriting contract perform conditional logic
         *  that uses information about royalty fees, if desired.
         *
         *  The `Royalty` contract is ERC2981 compliant.
         */
        interface IRoyalty is IERC2981 {
            struct RoyaltyInfo {
                address recipient;
                uint256 bps;
            }
            /// @dev Returns the royalty recipient and fee bps.
            function getDefaultRoyaltyInfo() external view returns (address, uint16);
            /// @dev Lets a module admin update the royalty bps and recipient.
            function setDefaultRoyaltyInfo(address _royaltyRecipient, uint256 _royaltyBps) external;
            /// @dev Lets a module admin set the royalty recipient for a particular token Id.
            function setRoyaltyInfoForToken(
                uint256 tokenId,
                address recipient,
                uint256 bps
            ) external;
            /// @dev Returns the royalty recipient for a particular token Id.
            function getRoyaltyInfoForToken(uint256 tokenId) external view returns (address, uint16);
            /// @dev Emitted when royalty info is updated.
            event DefaultRoyalty(address indexed newRoyaltyRecipient, uint256 newRoyaltyBps);
            /// @dev Emitted when royalty recipient for tokenId is set
            event RoyaltyForToken(uint256 indexed tokenId, address indexed royaltyRecipient, uint256 royaltyBps);
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.11;
        interface IThirdwebContract {
            /// @dev Returns the module type of the contract.
            function contractType() external pure returns (bytes32);
            /// @dev Returns the version of the contract.
            function contractVersion() external pure returns (uint8);
            /// @dev Returns the metadata URI of the contract.
            function contractURI() external view returns (string memory);
            /**
             *  @dev Sets contract URI for the storefront-level metadata of the contract.
             *       Only module admin can call this function.
             */
            function setContractURI(string calldata _uri) external;
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        interface IWETH {
            function deposit() external payable;
            function withdraw(uint256 amount) external;
            function transfer(address to, uint256 value) external returns (bool);
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.11;
        import "@openzeppelin/contracts-upgradeable/token/ERC1155/IERC1155Upgradeable.sol";
        /**
         *  `SignatureMint1155` is an ERC 1155 contract. It lets anyone mint NFTs by producing a mint request
         *  and a signature (produced by an account with MINTER_ROLE, signing the mint request).
         */
        interface ITokenERC1155 is IERC1155Upgradeable {
            /**
             *  @notice The body of a request to mint NFTs.
             *
             *  @param to The receiver of the NFTs to mint.
             *  @param royaltyRecipient The recipient of the minted NFT's secondary sales royalties.
             *  @param primarySaleRecipient The recipient of the minted NFT's primary sales proceeds.
             *  @param tokenId Optional: specify only if not first mint.
             *  @param uri The URI of the NFT to mint.
             *  @param quantity The quantity of NFTs to mint.
             *  @param pricePerToken Price to pay for minting with the signature.
             *  @param currency The currency in which the price per token must be paid.
             *  @param validityStartTimestamp The unix timestamp after which the request is valid.
             *  @param validityEndTimestamp The unix timestamp after which the request expires.
             *  @param uid A unique identifier for the request.
             */
            struct MintRequest {
                address to;
                address royaltyRecipient;
                uint256 royaltyBps;
                address primarySaleRecipient;
                uint256 tokenId;
                string uri;
                uint256 quantity;
                uint256 pricePerToken;
                address currency;
                uint128 validityStartTimestamp;
                uint128 validityEndTimestamp;
                bytes32 uid;
            }
            /// @dev Emitted when an account with MINTER_ROLE mints an NFT.
            event TokensMinted(address indexed mintedTo, uint256 indexed tokenIdMinted, string uri, uint256 quantityMinted);
            /// @dev Emitted when tokens are minted.
            event TokensMintedWithSignature(
                address indexed signer,
                address indexed mintedTo,
                uint256 indexed tokenIdMinted,
                MintRequest mintRequest
            );
            /**
             *  @notice Verifies that a mint request is signed by an account holding
             *         MINTER_ROLE (at the time of the function call).
             *
             *  @param req The mint request.
             *  @param signature The signature produced by an account signing the mint request.
             *
             *  returns (success, signer) Result of verification and the recovered address.
             */
            function verify(MintRequest calldata req, bytes calldata signature)
                external
                view
                returns (bool success, address signer);
            /**
             *  @notice Lets an account with MINTER_ROLE mint an NFT.
             *
             *  @param to The address to mint the NFT to.
             *  @param tokenId The tokenId of the NFTs to mint
             *  @param uri The URI to assign to the NFT.
             *  @param amount The number of copies of the NFT to mint.
             *
             */
            function mintTo(
                address to,
                uint256 tokenId,
                string calldata uri,
                uint256 amount
            ) external;
            /**
             *  @notice Mints an NFT according to the provided mint request.
             *
             *  @param req The mint request.
             *  @param signature he signature produced by an account signing the mint request.
             */
            function mintWithSignature(MintRequest calldata req, bytes calldata signature) external payable;
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        // Helper interfaces
        import { IWETH } from "../interfaces/IWETH.sol";
        import "../openzeppelin-presets/token/ERC20/utils/SafeERC20.sol";
        library CurrencyTransferLib {
            using SafeERC20 for IERC20;
            /// @dev The address interpreted as native token of the chain.
            address public constant NATIVE_TOKEN = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE;
            /// @dev Transfers a given amount of currency.
            function transferCurrency(
                address _currency,
                address _from,
                address _to,
                uint256 _amount
            ) internal {
                if (_amount == 0) {
                    return;
                }
                if (_currency == NATIVE_TOKEN) {
                    safeTransferNativeToken(_to, _amount);
                } else {
                    safeTransferERC20(_currency, _from, _to, _amount);
                }
            }
            /// @dev Transfers a given amount of currency. (With native token wrapping)
            function transferCurrencyWithWrapper(
                address _currency,
                address _from,
                address _to,
                uint256 _amount,
                address _nativeTokenWrapper
            ) internal {
                if (_amount == 0) {
                    return;
                }
                if (_currency == NATIVE_TOKEN) {
                    if (_from == address(this)) {
                        // withdraw from weth then transfer withdrawn native token to recipient
                        IWETH(_nativeTokenWrapper).withdraw(_amount);
                        safeTransferNativeTokenWithWrapper(_to, _amount, _nativeTokenWrapper);
                    } else if (_to == address(this)) {
                        // store native currency in weth
                        require(_amount == msg.value, "msg.value != amount");
                        IWETH(_nativeTokenWrapper).deposit{ value: _amount }();
                    } else {
                        safeTransferNativeTokenWithWrapper(_to, _amount, _nativeTokenWrapper);
                    }
                } else {
                    safeTransferERC20(_currency, _from, _to, _amount);
                }
            }
            /// @dev Transfer `amount` of ERC20 token from `from` to `to`.
            function safeTransferERC20(
                address _currency,
                address _from,
                address _to,
                uint256 _amount
            ) internal {
                if (_from == _to) {
                    return;
                }
                if (_from == address(this)) {
                    IERC20(_currency).safeTransfer(_to, _amount);
                } else {
                    IERC20(_currency).safeTransferFrom(_from, _to, _amount);
                }
            }
            /// @dev Transfers `amount` of native token to `to`.
            function safeTransferNativeToken(address to, uint256 value) internal {
                // solhint-disable avoid-low-level-calls
                // slither-disable-next-line low-level-calls
                (bool success, ) = to.call{ value: value }("");
                require(success, "native token transfer failed");
            }
            /// @dev Transfers `amount` of native token to `to`. (With native token wrapping)
            function safeTransferNativeTokenWithWrapper(
                address to,
                uint256 value,
                address _nativeTokenWrapper
            ) internal {
                // solhint-disable avoid-low-level-calls
                // slither-disable-next-line low-level-calls
                (bool success, ) = to.call{ value: value }("");
                if (!success) {
                    IWETH(_nativeTokenWrapper).deposit{ value: value }();
                    IERC20(_nativeTokenWrapper).safeTransfer(to, value);
                }
            }
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.11;
        /// @author thirdweb
        library FeeType {
            uint256 internal constant PRIMARY_SALE = 0;
            uint256 internal constant MARKET_SALE = 1;
            uint256 internal constant SPLIT = 2;
        }
        // SPDX-License-Identifier: Apache 2.0
        pragma solidity ^0.8.0;
        /// @author thirdweb
        /**
         * @dev Collection of functions related to the address type
         */
        library TWAddress {
            /**
             * @dev Returns true if `account` is a contract.
             *
             * [IMPORTANT]
             * ====
             * It is unsafe to assume that an address for which this function returns
             * false is an externally-owned account (EOA) and not a contract.
             *
             * Among others, `isContract` will return false for the following
             * types of addresses:
             *
             *  - an externally-owned account
             *  - a contract in construction
             *  - an address where a contract will be created
             *  - an address where a contract lived, but was destroyed
             * ====
             *
             * [IMPORTANT]
             * ====
             * You shouldn't rely on `isContract` to protect against flash loan attacks!
             *
             * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
             * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
             * constructor.
             * ====
             */
            function isContract(address account) internal view returns (bool) {
                // This method relies on extcodesize/address.code.length, which returns 0
                // for contracts in construction, since the code is only stored at the end
                // of the constructor execution.
                return account.code.length > 0;
            }
            /**
             * @dev Replacement for Solidity's `transfer`: sends `amount` wei to
             * `recipient`, forwarding all available gas and reverting on errors.
             *
             * [EIP1884](https://eips.ethereum.org/EIPS/eip-1884) increases the gas cost
             * of certain opcodes, possibly making contracts go over the 2300 gas limit
             * imposed by `transfer`, making them unable to receive funds via
             * `transfer`. {sendValue} removes this limitation.
             *
             * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
             *
             * IMPORTANT: because control is transferred to `recipient`, care must be
             * taken to not create reentrancy vulnerabilities. Consider using
             * {ReentrancyGuard} or the
             * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
             */
            function sendValue(address payable recipient, uint256 amount) internal {
                require(address(this).balance >= amount, "Address: insufficient balance");
                (bool success, ) = recipient.call{ value: amount }("");
                require(success, "Address: unable to send value, recipient may have reverted");
            }
            /**
             * @dev Performs a Solidity function call using a low level `call`. A
             * plain `call` is an unsafe replacement for a function call: use this
             * function instead.
             *
             * If `target` reverts with a revert reason, it is bubbled up by this
             * function (like regular Solidity function calls).
             *
             * Returns the raw returned data. To convert to the expected return value,
             * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
             *
             * Requirements:
             *
             * - `target` must be a contract.
             * - calling `target` with `data` must not revert.
             *
             * _Available since v3.1._
             */
            function functionCall(address target, bytes memory data) internal returns (bytes memory) {
                return functionCall(target, data, "Address: low-level call failed");
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
             * `errorMessage` as a fallback revert reason when `target` reverts.
             *
             * _Available since v3.1._
             */
            function functionCall(
                address target,
                bytes memory data,
                string memory errorMessage
            ) internal returns (bytes memory) {
                return functionCallWithValue(target, data, 0, errorMessage);
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
             * but also transferring `value` wei to `target`.
             *
             * Requirements:
             *
             * - the calling contract must have an ETH balance of at least `value`.
             * - the called Solidity function must be `payable`.
             *
             * _Available since v3.1._
             */
            function functionCallWithValue(
                address target,
                bytes memory data,
                uint256 value
            ) internal returns (bytes memory) {
                return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
            }
            /**
             * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
             * with `errorMessage` as a fallback revert reason when `target` reverts.
             *
             * _Available since v3.1._
             */
            function functionCallWithValue(
                address target,
                bytes memory data,
                uint256 value,
                string memory errorMessage
            ) internal returns (bytes memory) {
                require(address(this).balance >= value, "Address: insufficient balance for call");
                require(isContract(target), "Address: call to non-contract");
                (bool success, bytes memory returndata) = target.call{ value: value }(data);
                return verifyCallResult(success, returndata, errorMessage);
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
             * but performing a static call.
             *
             * _Available since v3.3._
             */
            function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
                return functionStaticCall(target, data, "Address: low-level static call failed");
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
             * but performing a static call.
             *
             * _Available since v3.3._
             */
            function functionStaticCall(
                address target,
                bytes memory data,
                string memory errorMessage
            ) internal view returns (bytes memory) {
                require(isContract(target), "Address: static call to non-contract");
                (bool success, bytes memory returndata) = target.staticcall(data);
                return verifyCallResult(success, returndata, errorMessage);
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
             * but performing a delegate call.
             *
             * _Available since v3.4._
             */
            function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
                return functionDelegateCall(target, data, "Address: low-level delegate call failed");
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
             * but performing a delegate call.
             *
             * _Available since v3.4._
             */
            function functionDelegateCall(
                address target,
                bytes memory data,
                string memory errorMessage
            ) internal returns (bytes memory) {
                require(isContract(target), "Address: delegate call to non-contract");
                (bool success, bytes memory returndata) = target.delegatecall(data);
                return verifyCallResult(success, returndata, errorMessage);
            }
            /**
             * @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
             * revert reason using the provided one.
             *
             * _Available since v4.3._
             */
            function verifyCallResult(
                bool success,
                bytes memory returndata,
                string memory errorMessage
            ) internal pure returns (bytes memory) {
                if (success) {
                    return returndata;
                } else {
                    // Look for revert reason and bubble it up if present
                    if (returndata.length > 0) {
                        // The easiest way to bubble the revert reason is using memory via assembly
                        assembly {
                            let returndata_size := mload(returndata)
                            revert(add(32, returndata), returndata_size)
                        }
                    } else {
                        revert(errorMessage);
                    }
                }
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.0 (metatx/ERC2771Context.sol)
        pragma solidity ^0.8.11;
        import "@openzeppelin/contracts-upgradeable/utils/ContextUpgradeable.sol";
        import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
        /**
         * @dev Context variant with ERC2771 support.
         */
        abstract contract ERC2771ContextUpgradeable is Initializable, ContextUpgradeable {
            mapping(address => bool) private _trustedForwarder;
            function __ERC2771Context_init(address[] memory trustedForwarder) internal onlyInitializing {
                __Context_init_unchained();
                __ERC2771Context_init_unchained(trustedForwarder);
            }
            function __ERC2771Context_init_unchained(address[] memory trustedForwarder) internal onlyInitializing {
                for (uint256 i = 0; i < trustedForwarder.length; i++) {
                    _trustedForwarder[trustedForwarder[i]] = true;
                }
            }
            function isTrustedForwarder(address forwarder) public view virtual returns (bool) {
                return _trustedForwarder[forwarder];
            }
            function _msgSender() internal view virtual override returns (address sender) {
                if (isTrustedForwarder(msg.sender)) {
                    // The assembly code is more direct than the Solidity version using `abi.decode`.
                    assembly {
                        sender := shr(96, calldataload(sub(calldatasize(), 20)))
                    }
                } else {
                    return super._msgSender();
                }
            }
            function _msgData() internal view virtual override returns (bytes calldata) {
                if (isTrustedForwarder(msg.sender)) {
                    return msg.data[:msg.data.length - 20];
                } else {
                    return super._msgData();
                }
            }
            uint256[49] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (token/ERC20/utils/SafeERC20.sol)
        pragma solidity ^0.8.0;
        import "../../../../eip/interface/IERC20.sol";
        import "../../../../lib/TWAddress.sol";
        /**
         * @title SafeERC20
         * @dev Wrappers around ERC20 operations that throw on failure (when the token
         * contract returns false). Tokens that return no value (and instead revert or
         * throw on failure) are also supported, non-reverting calls are assumed to be
         * successful.
         * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
         * which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
         */
        library SafeERC20 {
            using TWAddress for address;
            function safeTransfer(
                IERC20 token,
                address to,
                uint256 value
            ) internal {
                _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
            }
            function safeTransferFrom(
                IERC20 token,
                address from,
                address to,
                uint256 value
            ) internal {
                _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
            }
            /**
             * @dev Deprecated. This function has issues similar to the ones found in
             * {IERC20-approve}, and its usage is discouraged.
             *
             * Whenever possible, use {safeIncreaseAllowance} and
             * {safeDecreaseAllowance} instead.
             */
            function safeApprove(
                IERC20 token,
                address spender,
                uint256 value
            ) internal {
                // safeApprove should only be called when setting an initial allowance,
                // or when resetting it to zero. To increase and decrease it, use
                // 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
                require(
                    (value == 0) || (token.allowance(address(this), spender) == 0),
                    "SafeERC20: approve from non-zero to non-zero allowance"
                );
                _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
            }
            function safeIncreaseAllowance(
                IERC20 token,
                address spender,
                uint256 value
            ) internal {
                uint256 newAllowance = token.allowance(address(this), spender) + value;
                _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
            }
            function safeDecreaseAllowance(
                IERC20 token,
                address spender,
                uint256 value
            ) internal {
                unchecked {
                    uint256 oldAllowance = token.allowance(address(this), spender);
                    require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
                    uint256 newAllowance = oldAllowance - value;
                    _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
                }
            }
            /**
             * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
             * on the return value: the return value is optional (but if data is returned, it must not be false).
             * @param token The token targeted by the call.
             * @param data The call data (encoded using abi.encode or one of its variants).
             */
            function _callOptionalReturn(IERC20 token, bytes memory data) private {
                // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
                // we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that
                // the target address contains contract code and also asserts for success in the low-level call.
                bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
                if (returndata.length > 0) {
                    // Return data is optional
                    require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
                }
            }
        }
        // SPDX-License-Identifier: Apache-2.0
        pragma solidity ^0.8.11;
        /// @author thirdweb
        //   $$\\     $$\\       $$\\                 $$\\                         $$\\
        //   $$ |    $$ |      \\__|                $$ |                        $$ |
        // $$$$$$\\   $$$$$$$\\  $$\\  $$$$$$\\   $$$$$$$ |$$\\  $$\\  $$\\  $$$$$$\\  $$$$$$$\\
        // \\_$$  _|  $$  __$$\\ $$ |$$  __$$\\ $$  __$$ |$$ | $$ | $$ |$$  __$$\\ $$  __$$\\
        //   $$ |    $$ |  $$ |$$ |$$ |  \\__|$$ /  $$ |$$ | $$ | $$ |$$$$$$$$ |$$ |  $$ |
        //   $$ |$$\\ $$ |  $$ |$$ |$$ |      $$ |  $$ |$$ | $$ | $$ |$$   ____|$$ |  $$ |
        //   \\$$$$  |$$ |  $$ |$$ |$$ |      \\$$$$$$$ |\\$$$$$\\$$$$  |\\$$$$$$$\\ $$$$$$$  |
        //    \\____/ \\__|  \\__|\\__|\\__|       \\_______| \\_____\\____/  \\_______|\\_______/
        // Interface
        import { ITokenERC1155 } from "../interfaces/token/ITokenERC1155.sol";
        import "../interfaces/IThirdwebContract.sol";
        import "../extension/interface/IPlatformFee.sol";
        import "../extension/interface/IPrimarySale.sol";
        import "../extension/interface/IRoyalty.sol";
        import "../extension/interface/IOwnable.sol";
        // Token
        import "@openzeppelin/contracts-upgradeable/token/ERC1155/ERC1155Upgradeable.sol";
        // Signature utils
        import "@openzeppelin/contracts-upgradeable/utils/cryptography/ECDSAUpgradeable.sol";
        import "@openzeppelin/contracts-upgradeable/utils/cryptography/draft-EIP712Upgradeable.sol";
        // Access Control + security
        import "@openzeppelin/contracts-upgradeable/access/AccessControlEnumerableUpgradeable.sol";
        import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
        // Utils
        import "@openzeppelin/contracts-upgradeable/utils/StringsUpgradeable.sol";
        import "@openzeppelin/contracts-upgradeable/utils/MulticallUpgradeable.sol";
        import "../lib/CurrencyTransferLib.sol";
        import "../lib/FeeType.sol";
        import "../openzeppelin-presets/metatx/ERC2771ContextUpgradeable.sol";
        // Helper interfaces
        import "@openzeppelin/contracts-upgradeable/interfaces/IERC2981Upgradeable.sol";
        // OpenSea operator filter
        import "../extension/DefaultOperatorFiltererUpgradeable.sol";
        contract TokenERC1155 is
            Initializable,
            IThirdwebContract,
            IOwnable,
            IRoyalty,
            IPrimarySale,
            IPlatformFee,
            EIP712Upgradeable,
            ReentrancyGuardUpgradeable,
            ERC2771ContextUpgradeable,
            MulticallUpgradeable,
            AccessControlEnumerableUpgradeable,
            DefaultOperatorFiltererUpgradeable,
            ERC1155Upgradeable,
            ITokenERC1155
        {
            using ECDSAUpgradeable for bytes32;
            using StringsUpgradeable for uint256;
            bytes32 private constant MODULE_TYPE = bytes32("TokenERC1155");
            uint256 private constant VERSION = 1;
            /// @dev Fee type variants: percentage fee and flat fee
            enum PlatformFeeType {
                Bps,
                Flat
            }
            // Token name
            string public name;
            // Token symbol
            string public symbol;
            bytes32 private constant TYPEHASH =
                keccak256(
                    "MintRequest(address to,address royaltyRecipient,uint256 royaltyBps,address primarySaleRecipient,uint256 tokenId,string uri,uint256 quantity,uint256 pricePerToken,address currency,uint128 validityStartTimestamp,uint128 validityEndTimestamp,bytes32 uid)"
                );
            /// @dev Only TRANSFER_ROLE holders can have tokens transferred from or to them, during restricted transfers.
            bytes32 private constant TRANSFER_ROLE = keccak256("TRANSFER_ROLE");
            /// @dev Only MINTER_ROLE holders can sign off on `MintRequest`s.
            bytes32 private constant MINTER_ROLE = keccak256("MINTER_ROLE");
            /// @dev Max bps in the thirdweb system
            uint256 private constant MAX_BPS = 10_000;
            /// @dev Owner of the contract (purpose: OpenSea compatibility, etc.)
            address private _owner;
            /// @dev The next token ID of the NFT to mint.
            uint256 public nextTokenIdToMint;
            /// @dev The adress that receives all primary sales value.
            address public primarySaleRecipient;
            /// @dev The adress that receives all primary sales value.
            address public platformFeeRecipient;
            /// @dev The recipient of who gets the royalty.
            address private royaltyRecipient;
            /// @dev The percentage of royalty how much royalty in basis points.
            uint128 private royaltyBps;
            /// @dev The % of primary sales collected by the contract as fees.
            uint128 private platformFeeBps;
            /// @dev The flat amount collected by the contract as fees on primary sales.
            uint256 private flatPlatformFee;
            /// @dev Fee type variants: percentage fee and flat fee
            PlatformFeeType private platformFeeType;
            /// @dev Contract level metadata.
            string public contractURI;
            /// @dev Mapping from mint request UID => whether the mint request is processed.
            mapping(bytes32 => bool) private minted;
            mapping(uint256 => string) private _tokenURI;
            /// @dev Token ID => total circulating supply of tokens with that ID.
            mapping(uint256 => uint256) public totalSupply;
            /// @dev Token ID => the address of the recipient of primary sales.
            mapping(uint256 => address) public saleRecipientForToken;
            /// @dev Token ID => royalty recipient and bps for token
            mapping(uint256 => RoyaltyInfo) private royaltyInfoForToken;
            /// @dev Emitted when flat fee on primary sales is updated.
            event FlatPlatformFeeUpdated(address platformFeeRecipient, uint256 flatFee);
            /// @dev Emitted when platform fee type is updated.
            event PlatformFeeTypeUpdated(PlatformFeeType feeType);
            constructor() initializer {}
            /// @dev Initiliazes the contract, like a constructor.
            function initialize(
                address _defaultAdmin,
                string memory _name,
                string memory _symbol,
                string memory _contractURI,
                address[] memory _trustedForwarders,
                address _primarySaleRecipient,
                address _royaltyRecipient,
                uint128 _royaltyBps,
                uint128 _platformFeeBps,
                address _platformFeeRecipient
            ) external initializer {
                // Initialize inherited contracts, most base-like -> most derived.
                __ReentrancyGuard_init();
                __EIP712_init("TokenERC1155", "1");
                __ERC2771Context_init(_trustedForwarders);
                __ERC1155_init("");
                // Initialize this contract's state.
                _setOperatorRestriction(true);
                name = _name;
                symbol = _symbol;
                royaltyRecipient = _royaltyRecipient;
                royaltyBps = _royaltyBps;
                platformFeeRecipient = _platformFeeRecipient;
                primarySaleRecipient = _primarySaleRecipient;
                contractURI = _contractURI;
                require(_platformFeeBps <= MAX_BPS, "exceeds MAX_BPS");
                platformFeeBps = _platformFeeBps;
                // Fee type Bps by default
                platformFeeType = PlatformFeeType.Bps;
                _owner = _defaultAdmin;
                _setupRole(DEFAULT_ADMIN_ROLE, _defaultAdmin);
                _setupRole(MINTER_ROLE, _defaultAdmin);
                _setupRole(TRANSFER_ROLE, _defaultAdmin);
                _setupRole(TRANSFER_ROLE, address(0));
            }
            ///     =====   Public functions  =====
            /// @dev Returns the module type of the contract.
            function contractType() external pure returns (bytes32) {
                return MODULE_TYPE;
            }
            /// @dev Returns the version of the contract.
            function contractVersion() external pure returns (uint8) {
                return uint8(VERSION);
            }
            /**
             * @dev Returns the address of the current owner.
             */
            function owner() public view returns (address) {
                return hasRole(DEFAULT_ADMIN_ROLE, _owner) ? _owner : address(0);
            }
            /// @dev Verifies that a mint request is signed by an account holding MINTER_ROLE (at the time of the function call).
            function verify(MintRequest calldata _req, bytes calldata _signature) public view returns (bool, address) {
                address signer = recoverAddress(_req, _signature);
                return (!minted[_req.uid] && hasRole(MINTER_ROLE, signer), signer);
            }
            /// @dev Returns the URI for a tokenId
            function uri(uint256 _tokenId) public view override returns (string memory) {
                return _tokenURI[_tokenId];
            }
            /// @dev Lets an account with MINTER_ROLE mint an NFT.
            function mintTo(
                address _to,
                uint256 _tokenId,
                string calldata _uri,
                uint256 _amount
            ) external onlyRole(MINTER_ROLE) {
                uint256 tokenIdToMint;
                if (_tokenId == type(uint256).max) {
                    tokenIdToMint = nextTokenIdToMint;
                    nextTokenIdToMint += 1;
                } else {
                    require(_tokenId < nextTokenIdToMint, "invalid id");
                    tokenIdToMint = _tokenId;
                }
                // `_mintTo` is re-used. `mintTo` just adds a minter role check.
                _mintTo(_to, _uri, tokenIdToMint, _amount);
            }
            ///     =====   External functions  =====
            /// @dev See EIP-2981
            function royaltyInfo(uint256 tokenId, uint256 salePrice)
                external
                view
                virtual
                returns (address receiver, uint256 royaltyAmount)
            {
                (address recipient, uint256 bps) = getRoyaltyInfoForToken(tokenId);
                receiver = recipient;
                royaltyAmount = (salePrice * bps) / MAX_BPS;
            }
            /// @dev Mints an NFT according to the provided mint request.
            function mintWithSignature(MintRequest calldata _req, bytes calldata _signature) external payable nonReentrant {
                address signer = verifyRequest(_req, _signature);
                address receiver = _req.to;
                uint256 tokenIdToMint;
                if (_req.tokenId == type(uint256).max) {
                    tokenIdToMint = nextTokenIdToMint;
                    nextTokenIdToMint += 1;
                } else {
                    require(_req.tokenId < nextTokenIdToMint, "invalid id");
                    tokenIdToMint = _req.tokenId;
                }
                if (_req.royaltyRecipient != address(0)) {
                    royaltyInfoForToken[tokenIdToMint] = RoyaltyInfo({
                        recipient: _req.royaltyRecipient,
                        bps: _req.royaltyBps
                    });
                }
                _mintTo(receiver, _req.uri, tokenIdToMint, _req.quantity);
                collectPrice(_req);
                emit TokensMintedWithSignature(signer, receiver, tokenIdToMint, _req);
            }
            //      =====   Setter functions  =====
            /// @dev Lets a module admin set the default recipient of all primary sales.
            function setPrimarySaleRecipient(address _saleRecipient) external onlyRole(DEFAULT_ADMIN_ROLE) {
                primarySaleRecipient = _saleRecipient;
                emit PrimarySaleRecipientUpdated(_saleRecipient);
            }
            /// @dev Lets a module admin update the royalty bps and recipient.
            function setDefaultRoyaltyInfo(address _royaltyRecipient, uint256 _royaltyBps)
                external
                onlyRole(DEFAULT_ADMIN_ROLE)
            {
                require(_royaltyBps <= MAX_BPS, "exceed royalty bps");
                royaltyRecipient = _royaltyRecipient;
                royaltyBps = uint128(_royaltyBps);
                emit DefaultRoyalty(_royaltyRecipient, _royaltyBps);
            }
            /// @dev Lets a module admin set the royalty recipient for a particular token Id.
            function setRoyaltyInfoForToken(
                uint256 _tokenId,
                address _recipient,
                uint256 _bps
            ) external onlyRole(DEFAULT_ADMIN_ROLE) {
                require(_bps <= MAX_BPS, "exceed royalty bps");
                royaltyInfoForToken[_tokenId] = RoyaltyInfo({ recipient: _recipient, bps: _bps });
                emit RoyaltyForToken(_tokenId, _recipient, _bps);
            }
            /// @dev Lets a module admin update the fees on primary sales.
            function setPlatformFeeInfo(address _platformFeeRecipient, uint256 _platformFeeBps)
                external
                onlyRole(DEFAULT_ADMIN_ROLE)
            {
                require(_platformFeeBps <= MAX_BPS, "exceeds MAX_BPS");
                platformFeeBps = uint64(_platformFeeBps);
                platformFeeRecipient = _platformFeeRecipient;
                emit PlatformFeeInfoUpdated(_platformFeeRecipient, _platformFeeBps);
            }
            /// @dev Lets a module admin set a flat fee on primary sales.
            function setFlatPlatformFeeInfo(address _platformFeeRecipient, uint256 _flatFee)
                external
                onlyRole(DEFAULT_ADMIN_ROLE)
            {
                flatPlatformFee = _flatFee;
                platformFeeRecipient = _platformFeeRecipient;
                emit FlatPlatformFeeUpdated(_platformFeeRecipient, _flatFee);
            }
            /// @dev Lets a module admin set a flat fee on primary sales.
            function setPlatformFeeType(PlatformFeeType _feeType) external onlyRole(DEFAULT_ADMIN_ROLE) {
                platformFeeType = _feeType;
                emit PlatformFeeTypeUpdated(_feeType);
            }
            /// @dev Lets a module admin set a new owner for the contract. The new owner must be a module admin.
            function setOwner(address _newOwner) external onlyRole(DEFAULT_ADMIN_ROLE) {
                require(hasRole(DEFAULT_ADMIN_ROLE, _newOwner), "new owner not module admin.");
                address _prevOwner = _owner;
                _owner = _newOwner;
                emit OwnerUpdated(_prevOwner, _newOwner);
            }
            /// @dev Lets a module admin set the URI for contract-level metadata.
            function setContractURI(string calldata _uri) external onlyRole(DEFAULT_ADMIN_ROLE) {
                contractURI = _uri;
            }
            ///     =====   Getter functions    =====
            /// @dev Returns the platform fee bps and recipient.
            function getPlatformFeeInfo() external view returns (address, uint16) {
                return (platformFeeRecipient, uint16(platformFeeBps));
            }
            /// @dev Returns the flat platform fee and recipient.
            function getFlatPlatformFeeInfo() external view returns (address, uint256) {
                return (platformFeeRecipient, flatPlatformFee);
            }
            /// @dev Returns the platform fee type.
            function getPlatformFeeType() external view returns (PlatformFeeType) {
                return platformFeeType;
            }
            /// @dev Returns default royalty info.
            function getDefaultRoyaltyInfo() external view returns (address, uint16) {
                return (royaltyRecipient, uint16(royaltyBps));
            }
            /// @dev Returns the royalty recipient for a particular token Id.
            function getRoyaltyInfoForToken(uint256 _tokenId) public view returns (address, uint16) {
                RoyaltyInfo memory royaltyForToken = royaltyInfoForToken[_tokenId];
                return
                    royaltyForToken.recipient == address(0)
                        ? (royaltyRecipient, uint16(royaltyBps))
                        : (royaltyForToken.recipient, uint16(royaltyForToken.bps));
            }
            ///     =====   Internal functions  =====
            /// @dev Mints an NFT to `to`
            function _mintTo(
                address _to,
                string calldata _uri,
                uint256 _tokenId,
                uint256 _amount
            ) internal {
                if (bytes(_tokenURI[_tokenId]).length == 0) {
                    require(bytes(_uri).length > 0, "empty uri.");
                    _tokenURI[_tokenId] = _uri;
                }
                _mint(_to, _tokenId, _amount, "");
                emit TokensMinted(_to, _tokenId, _tokenURI[_tokenId], _amount);
            }
            /// @dev Returns the address of the signer of the mint request.
            function recoverAddress(MintRequest calldata _req, bytes calldata _signature) internal view returns (address) {
                return _hashTypedDataV4(keccak256(_encodeRequest(_req))).recover(_signature);
            }
            /// @dev Resolves 'stack too deep' error in `recoverAddress`.
            function _encodeRequest(MintRequest calldata _req) internal pure returns (bytes memory) {
                return
                    abi.encode(
                        TYPEHASH,
                        _req.to,
                        _req.royaltyRecipient,
                        _req.royaltyBps,
                        _req.primarySaleRecipient,
                        _req.tokenId,
                        keccak256(bytes(_req.uri)),
                        _req.quantity,
                        _req.pricePerToken,
                        _req.currency,
                        _req.validityStartTimestamp,
                        _req.validityEndTimestamp,
                        _req.uid
                    );
            }
            /// @dev Verifies that a mint request is valid.
            function verifyRequest(MintRequest calldata _req, bytes calldata _signature) internal returns (address) {
                (bool success, address signer) = verify(_req, _signature);
                require(success, "invalid signature");
                require(
                    _req.validityStartTimestamp <= block.timestamp && _req.validityEndTimestamp >= block.timestamp,
                    "request expired"
                );
                require(_req.to != address(0), "recipient undefined");
                require(_req.quantity > 0, "zero quantity");
                minted[_req.uid] = true;
                return signer;
            }
            /// @dev Collects and distributes the primary sale value of tokens being claimed.
            function collectPrice(MintRequest calldata _req) internal {
                if (_req.pricePerToken == 0) {
                    return;
                }
                uint256 totalPrice = _req.pricePerToken * _req.quantity;
                uint256 platformFees = platformFeeType == PlatformFeeType.Flat
                    ? flatPlatformFee
                    : ((totalPrice * platformFeeBps) / MAX_BPS);
                require(totalPrice >= platformFees, "price less than platform fee");
                if (_req.currency == CurrencyTransferLib.NATIVE_TOKEN) {
                    require(msg.value == totalPrice, "must send total price.");
                } else {
                    require(msg.value == 0, "msg value not zero");
                }
                address saleRecipient = _req.primarySaleRecipient == address(0)
                    ? primarySaleRecipient
                    : _req.primarySaleRecipient;
                CurrencyTransferLib.transferCurrency(_req.currency, _msgSender(), platformFeeRecipient, platformFees);
                CurrencyTransferLib.transferCurrency(_req.currency, _msgSender(), saleRecipient, totalPrice - platformFees);
            }
            ///     =====   Low-level overrides  =====
            /// @dev Lets a token owner burn the tokens they own (i.e. destroy for good)
            function burn(
                address account,
                uint256 id,
                uint256 value
            ) public virtual {
                require(
                    account == _msgSender() || isApprovedForAll(account, _msgSender()),
                    "ERC1155: caller is not owner nor approved."
                );
                _burn(account, id, value);
            }
            /// @dev Lets a token owner burn multiple tokens they own at once (i.e. destroy for good)
            function burnBatch(
                address account,
                uint256[] memory ids,
                uint256[] memory values
            ) public virtual {
                require(
                    account == _msgSender() || isApprovedForAll(account, _msgSender()),
                    "ERC1155: caller is not owner nor approved."
                );
                _burnBatch(account, ids, values);
            }
            /**
             * @dev See {ERC1155-_beforeTokenTransfer}.
             */
            function _beforeTokenTransfer(
                address operator,
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) internal virtual override {
                super._beforeTokenTransfer(operator, from, to, ids, amounts, data);
                // if transfer is restricted on the contract, we still want to allow burning and minting
                if (!hasRole(TRANSFER_ROLE, address(0)) && from != address(0) && to != address(0)) {
                    require(hasRole(TRANSFER_ROLE, from) || hasRole(TRANSFER_ROLE, to), "restricted to TRANSFER_ROLE holders.");
                }
                if (from == address(0)) {
                    for (uint256 i = 0; i < ids.length; ++i) {
                        totalSupply[ids[i]] += amounts[i];
                    }
                }
                if (to == address(0)) {
                    for (uint256 i = 0; i < ids.length; ++i) {
                        totalSupply[ids[i]] -= amounts[i];
                    }
                }
            }
            /// @dev See {ERC1155-setApprovalForAll}
            function setApprovalForAll(address operator, bool approved)
                public
                override(ERC1155Upgradeable, IERC1155Upgradeable)
                onlyAllowedOperatorApproval(operator)
            {
                super.setApprovalForAll(operator, approved);
            }
            /**
             * @dev See {IERC1155-safeTransferFrom}.
             */
            function safeTransferFrom(
                address from,
                address to,
                uint256 id,
                uint256 amount,
                bytes memory data
            ) public override(ERC1155Upgradeable, IERC1155Upgradeable) onlyAllowedOperator(from) {
                super.safeTransferFrom(from, to, id, amount, data);
            }
            /**
             * @dev See {IERC1155-safeBatchTransferFrom}.
             */
            function safeBatchTransferFrom(
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) public override(ERC1155Upgradeable, IERC1155Upgradeable) onlyAllowedOperator(from) {
                super.safeBatchTransferFrom(from, to, ids, amounts, data);
            }
            function supportsInterface(bytes4 interfaceId)
                public
                view
                virtual
                override(AccessControlEnumerableUpgradeable, ERC1155Upgradeable, IERC165Upgradeable, IERC165)
                returns (bool)
            {
                return
                    super.supportsInterface(interfaceId) ||
                    interfaceId == type(IERC1155Upgradeable).interfaceId ||
                    interfaceId == type(IERC2981Upgradeable).interfaceId;
            }
            /// @dev Returns whether operator restriction can be set in the given execution context.
            function _canSetOperatorRestriction() internal virtual override returns (bool) {
                return hasRole(DEFAULT_ADMIN_ROLE, _msgSender());
            }
            function _msgSender()
                internal
                view
                virtual
                override(ContextUpgradeable, ERC2771ContextUpgradeable)
                returns (address sender)
            {
                return ERC2771ContextUpgradeable._msgSender();
            }
            function _msgData()
                internal
                view
                virtual
                override(ContextUpgradeable, ERC2771ContextUpgradeable)
                returns (bytes calldata)
            {
                return ERC2771ContextUpgradeable._msgData();
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.5.0) (access/AccessControlEnumerable.sol)
        pragma solidity ^0.8.0;
        import "./IAccessControlEnumerableUpgradeable.sol";
        import "./AccessControlUpgradeable.sol";
        import "../utils/structs/EnumerableSetUpgradeable.sol";
        import "../proxy/utils/Initializable.sol";
        /**
         * @dev Extension of {AccessControl} that allows enumerating the members of each role.
         */
        abstract contract AccessControlEnumerableUpgradeable is Initializable, IAccessControlEnumerableUpgradeable, AccessControlUpgradeable {
            function __AccessControlEnumerable_init() internal onlyInitializing {
            }
            function __AccessControlEnumerable_init_unchained() internal onlyInitializing {
            }
            using EnumerableSetUpgradeable for EnumerableSetUpgradeable.AddressSet;
            mapping(bytes32 => EnumerableSetUpgradeable.AddressSet) private _roleMembers;
            /**
             * @dev See {IERC165-supportsInterface}.
             */
            function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
                return interfaceId == type(IAccessControlEnumerableUpgradeable).interfaceId || super.supportsInterface(interfaceId);
            }
            /**
             * @dev Returns one of the accounts that have `role`. `index` must be a
             * value between 0 and {getRoleMemberCount}, non-inclusive.
             *
             * Role bearers are not sorted in any particular way, and their ordering may
             * change at any point.
             *
             * WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure
             * you perform all queries on the same block. See the following
             * https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post]
             * for more information.
             */
            function getRoleMember(bytes32 role, uint256 index) public view virtual override returns (address) {
                return _roleMembers[role].at(index);
            }
            /**
             * @dev Returns the number of accounts that have `role`. Can be used
             * together with {getRoleMember} to enumerate all bearers of a role.
             */
            function getRoleMemberCount(bytes32 role) public view virtual override returns (uint256) {
                return _roleMembers[role].length();
            }
            /**
             * @dev Overload {_grantRole} to track enumerable memberships
             */
            function _grantRole(bytes32 role, address account) internal virtual override {
                super._grantRole(role, account);
                _roleMembers[role].add(account);
            }
            /**
             * @dev Overload {_revokeRole} to track enumerable memberships
             */
            function _revokeRole(bytes32 role, address account) internal virtual override {
                super._revokeRole(role, account);
                _roleMembers[role].remove(account);
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[49] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (access/AccessControl.sol)
        pragma solidity ^0.8.0;
        import "./IAccessControlUpgradeable.sol";
        import "../utils/ContextUpgradeable.sol";
        import "../utils/StringsUpgradeable.sol";
        import "../utils/introspection/ERC165Upgradeable.sol";
        import "../proxy/utils/Initializable.sol";
        /**
         * @dev Contract module that allows children to implement role-based access
         * control mechanisms. This is a lightweight version that doesn't allow enumerating role
         * members except through off-chain means by accessing the contract event logs. Some
         * applications may benefit from on-chain enumerability, for those cases see
         * {AccessControlEnumerable}.
         *
         * Roles are referred to by their `bytes32` identifier. These should be exposed
         * in the external API and be unique. The best way to achieve this is by
         * using `public constant` hash digests:
         *
         * ```
         * bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
         * ```
         *
         * Roles can be used to represent a set of permissions. To restrict access to a
         * function call, use {hasRole}:
         *
         * ```
         * function foo() public {
         *     require(hasRole(MY_ROLE, msg.sender));
         *     ...
         * }
         * ```
         *
         * Roles can be granted and revoked dynamically via the {grantRole} and
         * {revokeRole} functions. Each role has an associated admin role, and only
         * accounts that have a role's admin role can call {grantRole} and {revokeRole}.
         *
         * By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
         * that only accounts with this role will be able to grant or revoke other
         * roles. More complex role relationships can be created by using
         * {_setRoleAdmin}.
         *
         * WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
         * grant and revoke this role. Extra precautions should be taken to secure
         * accounts that have been granted it.
         */
        abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable, IAccessControlUpgradeable, ERC165Upgradeable {
            function __AccessControl_init() internal onlyInitializing {
            }
            function __AccessControl_init_unchained() internal onlyInitializing {
            }
            struct RoleData {
                mapping(address => bool) members;
                bytes32 adminRole;
            }
            mapping(bytes32 => RoleData) private _roles;
            bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
            /**
             * @dev Modifier that checks that an account has a specific role. Reverts
             * with a standardized message including the required role.
             *
             * The format of the revert reason is given by the following regular expression:
             *
             *  /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
             *
             * _Available since v4.1._
             */
            modifier onlyRole(bytes32 role) {
                _checkRole(role);
                _;
            }
            /**
             * @dev See {IERC165-supportsInterface}.
             */
            function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
                return interfaceId == type(IAccessControlUpgradeable).interfaceId || super.supportsInterface(interfaceId);
            }
            /**
             * @dev Returns `true` if `account` has been granted `role`.
             */
            function hasRole(bytes32 role, address account) public view virtual override returns (bool) {
                return _roles[role].members[account];
            }
            /**
             * @dev Revert with a standard message if `_msgSender()` is missing `role`.
             * Overriding this function changes the behavior of the {onlyRole} modifier.
             *
             * Format of the revert message is described in {_checkRole}.
             *
             * _Available since v4.6._
             */
            function _checkRole(bytes32 role) internal view virtual {
                _checkRole(role, _msgSender());
            }
            /**
             * @dev Revert with a standard message if `account` is missing `role`.
             *
             * The format of the revert reason is given by the following regular expression:
             *
             *  /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
             */
            function _checkRole(bytes32 role, address account) internal view virtual {
                if (!hasRole(role, account)) {
                    revert(
                        string(
                            abi.encodePacked(
                                "AccessControl: account ",
                                StringsUpgradeable.toHexString(uint160(account), 20),
                                " is missing role ",
                                StringsUpgradeable.toHexString(uint256(role), 32)
                            )
                        )
                    );
                }
            }
            /**
             * @dev Returns the admin role that controls `role`. See {grantRole} and
             * {revokeRole}.
             *
             * To change a role's admin, use {_setRoleAdmin}.
             */
            function getRoleAdmin(bytes32 role) public view virtual override returns (bytes32) {
                return _roles[role].adminRole;
            }
            /**
             * @dev Grants `role` to `account`.
             *
             * If `account` had not been already granted `role`, emits a {RoleGranted}
             * event.
             *
             * Requirements:
             *
             * - the caller must have ``role``'s admin role.
             *
             * May emit a {RoleGranted} event.
             */
            function grantRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {
                _grantRole(role, account);
            }
            /**
             * @dev Revokes `role` from `account`.
             *
             * If `account` had been granted `role`, emits a {RoleRevoked} event.
             *
             * Requirements:
             *
             * - the caller must have ``role``'s admin role.
             *
             * May emit a {RoleRevoked} event.
             */
            function revokeRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {
                _revokeRole(role, account);
            }
            /**
             * @dev Revokes `role` from the calling account.
             *
             * Roles are often managed via {grantRole} and {revokeRole}: this function's
             * purpose is to provide a mechanism for accounts to lose their privileges
             * if they are compromised (such as when a trusted device is misplaced).
             *
             * If the calling account had been revoked `role`, emits a {RoleRevoked}
             * event.
             *
             * Requirements:
             *
             * - the caller must be `account`.
             *
             * May emit a {RoleRevoked} event.
             */
            function renounceRole(bytes32 role, address account) public virtual override {
                require(account == _msgSender(), "AccessControl: can only renounce roles for self");
                _revokeRole(role, account);
            }
            /**
             * @dev Grants `role` to `account`.
             *
             * If `account` had not been already granted `role`, emits a {RoleGranted}
             * event. Note that unlike {grantRole}, this function doesn't perform any
             * checks on the calling account.
             *
             * May emit a {RoleGranted} event.
             *
             * [WARNING]
             * ====
             * This function should only be called from the constructor when setting
             * up the initial roles for the system.
             *
             * Using this function in any other way is effectively circumventing the admin
             * system imposed by {AccessControl}.
             * ====
             *
             * NOTE: This function is deprecated in favor of {_grantRole}.
             */
            function _setupRole(bytes32 role, address account) internal virtual {
                _grantRole(role, account);
            }
            /**
             * @dev Sets `adminRole` as ``role``'s admin role.
             *
             * Emits a {RoleAdminChanged} event.
             */
            function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
                bytes32 previousAdminRole = getRoleAdmin(role);
                _roles[role].adminRole = adminRole;
                emit RoleAdminChanged(role, previousAdminRole, adminRole);
            }
            /**
             * @dev Grants `role` to `account`.
             *
             * Internal function without access restriction.
             *
             * May emit a {RoleGranted} event.
             */
            function _grantRole(bytes32 role, address account) internal virtual {
                if (!hasRole(role, account)) {
                    _roles[role].members[account] = true;
                    emit RoleGranted(role, account, _msgSender());
                }
            }
            /**
             * @dev Revokes `role` from `account`.
             *
             * Internal function without access restriction.
             *
             * May emit a {RoleRevoked} event.
             */
            function _revokeRole(bytes32 role, address account) internal virtual {
                if (hasRole(role, account)) {
                    _roles[role].members[account] = false;
                    emit RoleRevoked(role, account, _msgSender());
                }
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[49] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (access/IAccessControlEnumerable.sol)
        pragma solidity ^0.8.0;
        import "./IAccessControlUpgradeable.sol";
        /**
         * @dev External interface of AccessControlEnumerable declared to support ERC165 detection.
         */
        interface IAccessControlEnumerableUpgradeable is IAccessControlUpgradeable {
            /**
             * @dev Returns one of the accounts that have `role`. `index` must be a
             * value between 0 and {getRoleMemberCount}, non-inclusive.
             *
             * Role bearers are not sorted in any particular way, and their ordering may
             * change at any point.
             *
             * WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure
             * you perform all queries on the same block. See the following
             * https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post]
             * for more information.
             */
            function getRoleMember(bytes32 role, uint256 index) external view returns (address);
            /**
             * @dev Returns the number of accounts that have `role`. Can be used
             * together with {getRoleMember} to enumerate all bearers of a role.
             */
            function getRoleMemberCount(bytes32 role) external view returns (uint256);
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (access/IAccessControl.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev External interface of AccessControl declared to support ERC165 detection.
         */
        interface IAccessControlUpgradeable {
            /**
             * @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
             *
             * `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
             * {RoleAdminChanged} not being emitted signaling this.
             *
             * _Available since v3.1._
             */
            event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
            /**
             * @dev Emitted when `account` is granted `role`.
             *
             * `sender` is the account that originated the contract call, an admin role
             * bearer except when using {AccessControl-_setupRole}.
             */
            event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
            /**
             * @dev Emitted when `account` is revoked `role`.
             *
             * `sender` is the account that originated the contract call:
             *   - if using `revokeRole`, it is the admin role bearer
             *   - if using `renounceRole`, it is the role bearer (i.e. `account`)
             */
            event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
            /**
             * @dev Returns `true` if `account` has been granted `role`.
             */
            function hasRole(bytes32 role, address account) external view returns (bool);
            /**
             * @dev Returns the admin role that controls `role`. See {grantRole} and
             * {revokeRole}.
             *
             * To change a role's admin, use {AccessControl-_setRoleAdmin}.
             */
            function getRoleAdmin(bytes32 role) external view returns (bytes32);
            /**
             * @dev Grants `role` to `account`.
             *
             * If `account` had not been already granted `role`, emits a {RoleGranted}
             * event.
             *
             * Requirements:
             *
             * - the caller must have ``role``'s admin role.
             */
            function grantRole(bytes32 role, address account) external;
            /**
             * @dev Revokes `role` from `account`.
             *
             * If `account` had been granted `role`, emits a {RoleRevoked} event.
             *
             * Requirements:
             *
             * - the caller must have ``role``'s admin role.
             */
            function revokeRole(bytes32 role, address account) external;
            /**
             * @dev Revokes `role` from the calling account.
             *
             * Roles are often managed via {grantRole} and {revokeRole}: this function's
             * purpose is to provide a mechanism for accounts to lose their privileges
             * if they are compromised (such as when a trusted device is misplaced).
             *
             * If the calling account had been granted `role`, emits a {RoleRevoked}
             * event.
             *
             * Requirements:
             *
             * - the caller must be `account`.
             */
            function renounceRole(bytes32 role, address account) external;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.6.0) (interfaces/IERC2981.sol)
        pragma solidity ^0.8.0;
        import "../utils/introspection/IERC165Upgradeable.sol";
        /**
         * @dev Interface for the NFT Royalty Standard.
         *
         * A standardized way to retrieve royalty payment information for non-fungible tokens (NFTs) to enable universal
         * support for royalty payments across all NFT marketplaces and ecosystem participants.
         *
         * _Available since v4.5._
         */
        interface IERC2981Upgradeable is IERC165Upgradeable {
            /**
             * @dev Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of
             * exchange. The royalty amount is denominated and should be paid in that same unit of exchange.
             */
            function royaltyInfo(uint256 tokenId, uint256 salePrice)
                external
                view
                returns (address receiver, uint256 royaltyAmount);
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (proxy/utils/Initializable.sol)
        pragma solidity ^0.8.2;
        import "../../utils/AddressUpgradeable.sol";
        /**
         * @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
         * behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
         * external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
         * function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
         *
         * The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
         * reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
         * case an upgrade adds a module that needs to be initialized.
         *
         * For example:
         *
         * [.hljs-theme-light.nopadding]
         * ```
         * contract MyToken is ERC20Upgradeable {
         *     function initialize() initializer public {
         *         __ERC20_init("MyToken", "MTK");
         *     }
         * }
         * contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
         *     function initializeV2() reinitializer(2) public {
         *         __ERC20Permit_init("MyToken");
         *     }
         * }
         * ```
         *
         * TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
         * possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
         *
         * CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
         * that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
         *
         * [CAUTION]
         * ====
         * Avoid leaving a contract uninitialized.
         *
         * An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
         * contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
         * the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
         *
         * [.hljs-theme-light.nopadding]
         * ```
         * /// @custom:oz-upgrades-unsafe-allow constructor
         * constructor() {
         *     _disableInitializers();
         * }
         * ```
         * ====
         */
        abstract contract Initializable {
            /**
             * @dev Indicates that the contract has been initialized.
             * @custom:oz-retyped-from bool
             */
            uint8 private _initialized;
            /**
             * @dev Indicates that the contract is in the process of being initialized.
             */
            bool private _initializing;
            /**
             * @dev Triggered when the contract has been initialized or reinitialized.
             */
            event Initialized(uint8 version);
            /**
             * @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
             * `onlyInitializing` functions can be used to initialize parent contracts. Equivalent to `reinitializer(1)`.
             */
            modifier initializer() {
                bool isTopLevelCall = !_initializing;
                require(
                    (isTopLevelCall && _initialized < 1) || (!AddressUpgradeable.isContract(address(this)) && _initialized == 1),
                    "Initializable: contract is already initialized"
                );
                _initialized = 1;
                if (isTopLevelCall) {
                    _initializing = true;
                }
                _;
                if (isTopLevelCall) {
                    _initializing = false;
                    emit Initialized(1);
                }
            }
            /**
             * @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
             * contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
             * used to initialize parent contracts.
             *
             * `initializer` is equivalent to `reinitializer(1)`, so a reinitializer may be used after the original
             * initialization step. This is essential to configure modules that are added through upgrades and that require
             * initialization.
             *
             * Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
             * a contract, executing them in the right order is up to the developer or operator.
             */
            modifier reinitializer(uint8 version) {
                require(!_initializing && _initialized < version, "Initializable: contract is already initialized");
                _initialized = version;
                _initializing = true;
                _;
                _initializing = false;
                emit Initialized(version);
            }
            /**
             * @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
             * {initializer} and {reinitializer} modifiers, directly or indirectly.
             */
            modifier onlyInitializing() {
                require(_initializing, "Initializable: contract is not initializing");
                _;
            }
            /**
             * @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
             * Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
             * to any version. It is recommended to use this to lock implementation contracts that are designed to be called
             * through proxies.
             */
            function _disableInitializers() internal virtual {
                require(!_initializing, "Initializable: contract is initializing");
                if (_initialized < type(uint8).max) {
                    _initialized = type(uint8).max;
                    emit Initialized(type(uint8).max);
                }
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (security/ReentrancyGuard.sol)
        pragma solidity ^0.8.0;
        import "../proxy/utils/Initializable.sol";
        /**
         * @dev Contract module that helps prevent reentrant calls to a function.
         *
         * Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
         * available, which can be applied to functions to make sure there are no nested
         * (reentrant) calls to them.
         *
         * Note that because there is a single `nonReentrant` guard, functions marked as
         * `nonReentrant` may not call one another. This can be worked around by making
         * those functions `private`, and then adding `external` `nonReentrant` entry
         * points to them.
         *
         * TIP: If you would like to learn more about reentrancy and alternative ways
         * to protect against it, check out our blog post
         * https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
         */
        abstract contract ReentrancyGuardUpgradeable is Initializable {
            // Booleans are more expensive than uint256 or any type that takes up a full
            // word because each write operation emits an extra SLOAD to first read the
            // slot's contents, replace the bits taken up by the boolean, and then write
            // back. This is the compiler's defense against contract upgrades and
            // pointer aliasing, and it cannot be disabled.
            // The values being non-zero value makes deployment a bit more expensive,
            // but in exchange the refund on every call to nonReentrant will be lower in
            // amount. Since refunds are capped to a percentage of the total
            // transaction's gas, it is best to keep them low in cases like this one, to
            // increase the likelihood of the full refund coming into effect.
            uint256 private constant _NOT_ENTERED = 1;
            uint256 private constant _ENTERED = 2;
            uint256 private _status;
            function __ReentrancyGuard_init() internal onlyInitializing {
                __ReentrancyGuard_init_unchained();
            }
            function __ReentrancyGuard_init_unchained() internal onlyInitializing {
                _status = _NOT_ENTERED;
            }
            /**
             * @dev Prevents a contract from calling itself, directly or indirectly.
             * Calling a `nonReentrant` function from another `nonReentrant`
             * function is not supported. It is possible to prevent this from happening
             * by making the `nonReentrant` function external, and making it call a
             * `private` function that does the actual work.
             */
            modifier nonReentrant() {
                // On the first call to nonReentrant, _notEntered will be true
                require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
                // Any calls to nonReentrant after this point will fail
                _status = _ENTERED;
                _;
                // By storing the original value once again, a refund is triggered (see
                // https://eips.ethereum.org/EIPS/eip-2200)
                _status = _NOT_ENTERED;
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[49] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (token/ERC1155/ERC1155.sol)
        pragma solidity ^0.8.0;
        import "./IERC1155Upgradeable.sol";
        import "./IERC1155ReceiverUpgradeable.sol";
        import "./extensions/IERC1155MetadataURIUpgradeable.sol";
        import "../../utils/AddressUpgradeable.sol";
        import "../../utils/ContextUpgradeable.sol";
        import "../../utils/introspection/ERC165Upgradeable.sol";
        import "../../proxy/utils/Initializable.sol";
        /**
         * @dev Implementation of the basic standard multi-token.
         * See https://eips.ethereum.org/EIPS/eip-1155
         * Originally based on code by Enjin: https://github.com/enjin/erc-1155
         *
         * _Available since v3.1._
         */
        contract ERC1155Upgradeable is Initializable, ContextUpgradeable, ERC165Upgradeable, IERC1155Upgradeable, IERC1155MetadataURIUpgradeable {
            using AddressUpgradeable for address;
            // Mapping from token ID to account balances
            mapping(uint256 => mapping(address => uint256)) private _balances;
            // Mapping from account to operator approvals
            mapping(address => mapping(address => bool)) private _operatorApprovals;
            // Used as the URI for all token types by relying on ID substitution, e.g. https://token-cdn-domain/{id}.json
            string private _uri;
            /**
             * @dev See {_setURI}.
             */
            function __ERC1155_init(string memory uri_) internal onlyInitializing {
                __ERC1155_init_unchained(uri_);
            }
            function __ERC1155_init_unchained(string memory uri_) internal onlyInitializing {
                _setURI(uri_);
            }
            /**
             * @dev See {IERC165-supportsInterface}.
             */
            function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165Upgradeable, IERC165Upgradeable) returns (bool) {
                return
                    interfaceId == type(IERC1155Upgradeable).interfaceId ||
                    interfaceId == type(IERC1155MetadataURIUpgradeable).interfaceId ||
                    super.supportsInterface(interfaceId);
            }
            /**
             * @dev See {IERC1155MetadataURI-uri}.
             *
             * This implementation returns the same URI for *all* token types. It relies
             * on the token type ID substitution mechanism
             * https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the EIP].
             *
             * Clients calling this function must replace the `\\{id\\}` substring with the
             * actual token type ID.
             */
            function uri(uint256) public view virtual override returns (string memory) {
                return _uri;
            }
            /**
             * @dev See {IERC1155-balanceOf}.
             *
             * Requirements:
             *
             * - `account` cannot be the zero address.
             */
            function balanceOf(address account, uint256 id) public view virtual override returns (uint256) {
                require(account != address(0), "ERC1155: address zero is not a valid owner");
                return _balances[id][account];
            }
            /**
             * @dev See {IERC1155-balanceOfBatch}.
             *
             * Requirements:
             *
             * - `accounts` and `ids` must have the same length.
             */
            function balanceOfBatch(address[] memory accounts, uint256[] memory ids)
                public
                view
                virtual
                override
                returns (uint256[] memory)
            {
                require(accounts.length == ids.length, "ERC1155: accounts and ids length mismatch");
                uint256[] memory batchBalances = new uint256[](accounts.length);
                for (uint256 i = 0; i < accounts.length; ++i) {
                    batchBalances[i] = balanceOf(accounts[i], ids[i]);
                }
                return batchBalances;
            }
            /**
             * @dev See {IERC1155-setApprovalForAll}.
             */
            function setApprovalForAll(address operator, bool approved) public virtual override {
                _setApprovalForAll(_msgSender(), operator, approved);
            }
            /**
             * @dev See {IERC1155-isApprovedForAll}.
             */
            function isApprovedForAll(address account, address operator) public view virtual override returns (bool) {
                return _operatorApprovals[account][operator];
            }
            /**
             * @dev See {IERC1155-safeTransferFrom}.
             */
            function safeTransferFrom(
                address from,
                address to,
                uint256 id,
                uint256 amount,
                bytes memory data
            ) public virtual override {
                require(
                    from == _msgSender() || isApprovedForAll(from, _msgSender()),
                    "ERC1155: caller is not token owner nor approved"
                );
                _safeTransferFrom(from, to, id, amount, data);
            }
            /**
             * @dev See {IERC1155-safeBatchTransferFrom}.
             */
            function safeBatchTransferFrom(
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) public virtual override {
                require(
                    from == _msgSender() || isApprovedForAll(from, _msgSender()),
                    "ERC1155: caller is not token owner nor approved"
                );
                _safeBatchTransferFrom(from, to, ids, amounts, data);
            }
            /**
             * @dev Transfers `amount` tokens of token type `id` from `from` to `to`.
             *
             * Emits a {TransferSingle} event.
             *
             * Requirements:
             *
             * - `to` cannot be the zero address.
             * - `from` must have a balance of tokens of type `id` of at least `amount`.
             * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
             * acceptance magic value.
             */
            function _safeTransferFrom(
                address from,
                address to,
                uint256 id,
                uint256 amount,
                bytes memory data
            ) internal virtual {
                require(to != address(0), "ERC1155: transfer to the zero address");
                address operator = _msgSender();
                uint256[] memory ids = _asSingletonArray(id);
                uint256[] memory amounts = _asSingletonArray(amount);
                _beforeTokenTransfer(operator, from, to, ids, amounts, data);
                uint256 fromBalance = _balances[id][from];
                require(fromBalance >= amount, "ERC1155: insufficient balance for transfer");
                unchecked {
                    _balances[id][from] = fromBalance - amount;
                }
                _balances[id][to] += amount;
                emit TransferSingle(operator, from, to, id, amount);
                _afterTokenTransfer(operator, from, to, ids, amounts, data);
                _doSafeTransferAcceptanceCheck(operator, from, to, id, amount, data);
            }
            /**
             * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_safeTransferFrom}.
             *
             * Emits a {TransferBatch} event.
             *
             * Requirements:
             *
             * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
             * acceptance magic value.
             */
            function _safeBatchTransferFrom(
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) internal virtual {
                require(ids.length == amounts.length, "ERC1155: ids and amounts length mismatch");
                require(to != address(0), "ERC1155: transfer to the zero address");
                address operator = _msgSender();
                _beforeTokenTransfer(operator, from, to, ids, amounts, data);
                for (uint256 i = 0; i < ids.length; ++i) {
                    uint256 id = ids[i];
                    uint256 amount = amounts[i];
                    uint256 fromBalance = _balances[id][from];
                    require(fromBalance >= amount, "ERC1155: insufficient balance for transfer");
                    unchecked {
                        _balances[id][from] = fromBalance - amount;
                    }
                    _balances[id][to] += amount;
                }
                emit TransferBatch(operator, from, to, ids, amounts);
                _afterTokenTransfer(operator, from, to, ids, amounts, data);
                _doSafeBatchTransferAcceptanceCheck(operator, from, to, ids, amounts, data);
            }
            /**
             * @dev Sets a new URI for all token types, by relying on the token type ID
             * substitution mechanism
             * https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the EIP].
             *
             * By this mechanism, any occurrence of the `\\{id\\}` substring in either the
             * URI or any of the amounts in the JSON file at said URI will be replaced by
             * clients with the token type ID.
             *
             * For example, the `https://token-cdn-domain/\\{id\\}.json` URI would be
             * interpreted by clients as
             * `https://token-cdn-domain/000000000000000000000000000000000000000000000000000000000004cce0.json`
             * for token type ID 0x4cce0.
             *
             * See {uri}.
             *
             * Because these URIs cannot be meaningfully represented by the {URI} event,
             * this function emits no events.
             */
            function _setURI(string memory newuri) internal virtual {
                _uri = newuri;
            }
            /**
             * @dev Creates `amount` tokens of token type `id`, and assigns them to `to`.
             *
             * Emits a {TransferSingle} event.
             *
             * Requirements:
             *
             * - `to` cannot be the zero address.
             * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
             * acceptance magic value.
             */
            function _mint(
                address to,
                uint256 id,
                uint256 amount,
                bytes memory data
            ) internal virtual {
                require(to != address(0), "ERC1155: mint to the zero address");
                address operator = _msgSender();
                uint256[] memory ids = _asSingletonArray(id);
                uint256[] memory amounts = _asSingletonArray(amount);
                _beforeTokenTransfer(operator, address(0), to, ids, amounts, data);
                _balances[id][to] += amount;
                emit TransferSingle(operator, address(0), to, id, amount);
                _afterTokenTransfer(operator, address(0), to, ids, amounts, data);
                _doSafeTransferAcceptanceCheck(operator, address(0), to, id, amount, data);
            }
            /**
             * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_mint}.
             *
             * Emits a {TransferBatch} event.
             *
             * Requirements:
             *
             * - `ids` and `amounts` must have the same length.
             * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
             * acceptance magic value.
             */
            function _mintBatch(
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) internal virtual {
                require(to != address(0), "ERC1155: mint to the zero address");
                require(ids.length == amounts.length, "ERC1155: ids and amounts length mismatch");
                address operator = _msgSender();
                _beforeTokenTransfer(operator, address(0), to, ids, amounts, data);
                for (uint256 i = 0; i < ids.length; i++) {
                    _balances[ids[i]][to] += amounts[i];
                }
                emit TransferBatch(operator, address(0), to, ids, amounts);
                _afterTokenTransfer(operator, address(0), to, ids, amounts, data);
                _doSafeBatchTransferAcceptanceCheck(operator, address(0), to, ids, amounts, data);
            }
            /**
             * @dev Destroys `amount` tokens of token type `id` from `from`
             *
             * Emits a {TransferSingle} event.
             *
             * Requirements:
             *
             * - `from` cannot be the zero address.
             * - `from` must have at least `amount` tokens of token type `id`.
             */
            function _burn(
                address from,
                uint256 id,
                uint256 amount
            ) internal virtual {
                require(from != address(0), "ERC1155: burn from the zero address");
                address operator = _msgSender();
                uint256[] memory ids = _asSingletonArray(id);
                uint256[] memory amounts = _asSingletonArray(amount);
                _beforeTokenTransfer(operator, from, address(0), ids, amounts, "");
                uint256 fromBalance = _balances[id][from];
                require(fromBalance >= amount, "ERC1155: burn amount exceeds balance");
                unchecked {
                    _balances[id][from] = fromBalance - amount;
                }
                emit TransferSingle(operator, from, address(0), id, amount);
                _afterTokenTransfer(operator, from, address(0), ids, amounts, "");
            }
            /**
             * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_burn}.
             *
             * Emits a {TransferBatch} event.
             *
             * Requirements:
             *
             * - `ids` and `amounts` must have the same length.
             */
            function _burnBatch(
                address from,
                uint256[] memory ids,
                uint256[] memory amounts
            ) internal virtual {
                require(from != address(0), "ERC1155: burn from the zero address");
                require(ids.length == amounts.length, "ERC1155: ids and amounts length mismatch");
                address operator = _msgSender();
                _beforeTokenTransfer(operator, from, address(0), ids, amounts, "");
                for (uint256 i = 0; i < ids.length; i++) {
                    uint256 id = ids[i];
                    uint256 amount = amounts[i];
                    uint256 fromBalance = _balances[id][from];
                    require(fromBalance >= amount, "ERC1155: burn amount exceeds balance");
                    unchecked {
                        _balances[id][from] = fromBalance - amount;
                    }
                }
                emit TransferBatch(operator, from, address(0), ids, amounts);
                _afterTokenTransfer(operator, from, address(0), ids, amounts, "");
            }
            /**
             * @dev Approve `operator` to operate on all of `owner` tokens
             *
             * Emits an {ApprovalForAll} event.
             */
            function _setApprovalForAll(
                address owner,
                address operator,
                bool approved
            ) internal virtual {
                require(owner != operator, "ERC1155: setting approval status for self");
                _operatorApprovals[owner][operator] = approved;
                emit ApprovalForAll(owner, operator, approved);
            }
            /**
             * @dev Hook that is called before any token transfer. This includes minting
             * and burning, as well as batched variants.
             *
             * The same hook is called on both single and batched variants. For single
             * transfers, the length of the `ids` and `amounts` arrays will be 1.
             *
             * Calling conditions (for each `id` and `amount` pair):
             *
             * - When `from` and `to` are both non-zero, `amount` of ``from``'s tokens
             * of token type `id` will be  transferred to `to`.
             * - When `from` is zero, `amount` tokens of token type `id` will be minted
             * for `to`.
             * - when `to` is zero, `amount` of ``from``'s tokens of token type `id`
             * will be burned.
             * - `from` and `to` are never both zero.
             * - `ids` and `amounts` have the same, non-zero length.
             *
             * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
             */
            function _beforeTokenTransfer(
                address operator,
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) internal virtual {}
            /**
             * @dev Hook that is called after any token transfer. This includes minting
             * and burning, as well as batched variants.
             *
             * The same hook is called on both single and batched variants. For single
             * transfers, the length of the `id` and `amount` arrays will be 1.
             *
             * Calling conditions (for each `id` and `amount` pair):
             *
             * - When `from` and `to` are both non-zero, `amount` of ``from``'s tokens
             * of token type `id` will be  transferred to `to`.
             * - When `from` is zero, `amount` tokens of token type `id` will be minted
             * for `to`.
             * - when `to` is zero, `amount` of ``from``'s tokens of token type `id`
             * will be burned.
             * - `from` and `to` are never both zero.
             * - `ids` and `amounts` have the same, non-zero length.
             *
             * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
             */
            function _afterTokenTransfer(
                address operator,
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) internal virtual {}
            function _doSafeTransferAcceptanceCheck(
                address operator,
                address from,
                address to,
                uint256 id,
                uint256 amount,
                bytes memory data
            ) private {
                if (to.isContract()) {
                    try IERC1155ReceiverUpgradeable(to).onERC1155Received(operator, from, id, amount, data) returns (bytes4 response) {
                        if (response != IERC1155ReceiverUpgradeable.onERC1155Received.selector) {
                            revert("ERC1155: ERC1155Receiver rejected tokens");
                        }
                    } catch Error(string memory reason) {
                        revert(reason);
                    } catch {
                        revert("ERC1155: transfer to non ERC1155Receiver implementer");
                    }
                }
            }
            function _doSafeBatchTransferAcceptanceCheck(
                address operator,
                address from,
                address to,
                uint256[] memory ids,
                uint256[] memory amounts,
                bytes memory data
            ) private {
                if (to.isContract()) {
                    try IERC1155ReceiverUpgradeable(to).onERC1155BatchReceived(operator, from, ids, amounts, data) returns (
                        bytes4 response
                    ) {
                        if (response != IERC1155ReceiverUpgradeable.onERC1155BatchReceived.selector) {
                            revert("ERC1155: ERC1155Receiver rejected tokens");
                        }
                    } catch Error(string memory reason) {
                        revert(reason);
                    } catch {
                        revert("ERC1155: transfer to non ERC1155Receiver implementer");
                    }
                }
            }
            function _asSingletonArray(uint256 element) private pure returns (uint256[] memory) {
                uint256[] memory array = new uint256[](1);
                array[0] = element;
                return array;
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[47] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.5.0) (token/ERC1155/IERC1155Receiver.sol)
        pragma solidity ^0.8.0;
        import "../../utils/introspection/IERC165Upgradeable.sol";
        /**
         * @dev _Available since v3.1._
         */
        interface IERC1155ReceiverUpgradeable is IERC165Upgradeable {
            /**
             * @dev Handles the receipt of a single ERC1155 token type. This function is
             * called at the end of a `safeTransferFrom` after the balance has been updated.
             *
             * NOTE: To accept the transfer, this must return
             * `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))`
             * (i.e. 0xf23a6e61, or its own function selector).
             *
             * @param operator The address which initiated the transfer (i.e. msg.sender)
             * @param from The address which previously owned the token
             * @param id The ID of the token being transferred
             * @param value The amount of tokens being transferred
             * @param data Additional data with no specified format
             * @return `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` if transfer is allowed
             */
            function onERC1155Received(
                address operator,
                address from,
                uint256 id,
                uint256 value,
                bytes calldata data
            ) external returns (bytes4);
            /**
             * @dev Handles the receipt of a multiple ERC1155 token types. This function
             * is called at the end of a `safeBatchTransferFrom` after the balances have
             * been updated.
             *
             * NOTE: To accept the transfer(s), this must return
             * `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))`
             * (i.e. 0xbc197c81, or its own function selector).
             *
             * @param operator The address which initiated the batch transfer (i.e. msg.sender)
             * @param from The address which previously owned the token
             * @param ids An array containing ids of each token being transferred (order and length must match values array)
             * @param values An array containing amounts of each token being transferred (order and length must match ids array)
             * @param data Additional data with no specified format
             * @return `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` if transfer is allowed
             */
            function onERC1155BatchReceived(
                address operator,
                address from,
                uint256[] calldata ids,
                uint256[] calldata values,
                bytes calldata data
            ) external returns (bytes4);
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (token/ERC1155/IERC1155.sol)
        pragma solidity ^0.8.0;
        import "../../utils/introspection/IERC165Upgradeable.sol";
        /**
         * @dev Required interface of an ERC1155 compliant contract, as defined in the
         * https://eips.ethereum.org/EIPS/eip-1155[EIP].
         *
         * _Available since v3.1._
         */
        interface IERC1155Upgradeable is IERC165Upgradeable {
            /**
             * @dev Emitted when `value` tokens of token type `id` are transferred from `from` to `to` by `operator`.
             */
            event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value);
            /**
             * @dev Equivalent to multiple {TransferSingle} events, where `operator`, `from` and `to` are the same for all
             * transfers.
             */
            event TransferBatch(
                address indexed operator,
                address indexed from,
                address indexed to,
                uint256[] ids,
                uint256[] values
            );
            /**
             * @dev Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to
             * `approved`.
             */
            event ApprovalForAll(address indexed account, address indexed operator, bool approved);
            /**
             * @dev Emitted when the URI for token type `id` changes to `value`, if it is a non-programmatic URI.
             *
             * If an {URI} event was emitted for `id`, the standard
             * https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[guarantees] that `value` will equal the value
             * returned by {IERC1155MetadataURI-uri}.
             */
            event URI(string value, uint256 indexed id);
            /**
             * @dev Returns the amount of tokens of token type `id` owned by `account`.
             *
             * Requirements:
             *
             * - `account` cannot be the zero address.
             */
            function balanceOf(address account, uint256 id) external view returns (uint256);
            /**
             * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {balanceOf}.
             *
             * Requirements:
             *
             * - `accounts` and `ids` must have the same length.
             */
            function balanceOfBatch(address[] calldata accounts, uint256[] calldata ids)
                external
                view
                returns (uint256[] memory);
            /**
             * @dev Grants or revokes permission to `operator` to transfer the caller's tokens, according to `approved`,
             *
             * Emits an {ApprovalForAll} event.
             *
             * Requirements:
             *
             * - `operator` cannot be the caller.
             */
            function setApprovalForAll(address operator, bool approved) external;
            /**
             * @dev Returns true if `operator` is approved to transfer ``account``'s tokens.
             *
             * See {setApprovalForAll}.
             */
            function isApprovedForAll(address account, address operator) external view returns (bool);
            /**
             * @dev Transfers `amount` tokens of token type `id` from `from` to `to`.
             *
             * Emits a {TransferSingle} event.
             *
             * Requirements:
             *
             * - `to` cannot be the zero address.
             * - If the caller is not `from`, it must have been approved to spend ``from``'s tokens via {setApprovalForAll}.
             * - `from` must have a balance of tokens of type `id` of at least `amount`.
             * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
             * acceptance magic value.
             */
            function safeTransferFrom(
                address from,
                address to,
                uint256 id,
                uint256 amount,
                bytes calldata data
            ) external;
            /**
             * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {safeTransferFrom}.
             *
             * Emits a {TransferBatch} event.
             *
             * Requirements:
             *
             * - `ids` and `amounts` must have the same length.
             * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
             * acceptance magic value.
             */
            function safeBatchTransferFrom(
                address from,
                address to,
                uint256[] calldata ids,
                uint256[] calldata amounts,
                bytes calldata data
            ) external;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (token/ERC1155/extensions/IERC1155MetadataURI.sol)
        pragma solidity ^0.8.0;
        import "../IERC1155Upgradeable.sol";
        /**
         * @dev Interface of the optional ERC1155MetadataExtension interface, as defined
         * in the https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[EIP].
         *
         * _Available since v3.1._
         */
        interface IERC1155MetadataURIUpgradeable is IERC1155Upgradeable {
            /**
             * @dev Returns the URI for token type `id`.
             *
             * If the `\\{id\\}` substring is present in the URI, it must be replaced by
             * clients with the actual token type ID.
             */
            function uri(uint256 id) external view returns (string memory);
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (utils/Address.sol)
        pragma solidity ^0.8.1;
        /**
         * @dev Collection of functions related to the address type
         */
        library AddressUpgradeable {
            /**
             * @dev Returns true if `account` is a contract.
             *
             * [IMPORTANT]
             * ====
             * It is unsafe to assume that an address for which this function returns
             * false is an externally-owned account (EOA) and not a contract.
             *
             * Among others, `isContract` will return false for the following
             * types of addresses:
             *
             *  - an externally-owned account
             *  - a contract in construction
             *  - an address where a contract will be created
             *  - an address where a contract lived, but was destroyed
             * ====
             *
             * [IMPORTANT]
             * ====
             * You shouldn't rely on `isContract` to protect against flash loan attacks!
             *
             * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
             * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
             * constructor.
             * ====
             */
            function isContract(address account) internal view returns (bool) {
                // This method relies on extcodesize/address.code.length, which returns 0
                // for contracts in construction, since the code is only stored at the end
                // of the constructor execution.
                return account.code.length > 0;
            }
            /**
             * @dev Replacement for Solidity's `transfer`: sends `amount` wei to
             * `recipient`, forwarding all available gas and reverting on errors.
             *
             * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
             * of certain opcodes, possibly making contracts go over the 2300 gas limit
             * imposed by `transfer`, making them unable to receive funds via
             * `transfer`. {sendValue} removes this limitation.
             *
             * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
             *
             * IMPORTANT: because control is transferred to `recipient`, care must be
             * taken to not create reentrancy vulnerabilities. Consider using
             * {ReentrancyGuard} or the
             * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
             */
            function sendValue(address payable recipient, uint256 amount) internal {
                require(address(this).balance >= amount, "Address: insufficient balance");
                (bool success, ) = recipient.call{value: amount}("");
                require(success, "Address: unable to send value, recipient may have reverted");
            }
            /**
             * @dev Performs a Solidity function call using a low level `call`. A
             * plain `call` is an unsafe replacement for a function call: use this
             * function instead.
             *
             * If `target` reverts with a revert reason, it is bubbled up by this
             * function (like regular Solidity function calls).
             *
             * Returns the raw returned data. To convert to the expected return value,
             * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
             *
             * Requirements:
             *
             * - `target` must be a contract.
             * - calling `target` with `data` must not revert.
             *
             * _Available since v3.1._
             */
            function functionCall(address target, bytes memory data) internal returns (bytes memory) {
                return functionCall(target, data, "Address: low-level call failed");
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
             * `errorMessage` as a fallback revert reason when `target` reverts.
             *
             * _Available since v3.1._
             */
            function functionCall(
                address target,
                bytes memory data,
                string memory errorMessage
            ) internal returns (bytes memory) {
                return functionCallWithValue(target, data, 0, errorMessage);
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
             * but also transferring `value` wei to `target`.
             *
             * Requirements:
             *
             * - the calling contract must have an ETH balance of at least `value`.
             * - the called Solidity function must be `payable`.
             *
             * _Available since v3.1._
             */
            function functionCallWithValue(
                address target,
                bytes memory data,
                uint256 value
            ) internal returns (bytes memory) {
                return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
            }
            /**
             * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
             * with `errorMessage` as a fallback revert reason when `target` reverts.
             *
             * _Available since v3.1._
             */
            function functionCallWithValue(
                address target,
                bytes memory data,
                uint256 value,
                string memory errorMessage
            ) internal returns (bytes memory) {
                require(address(this).balance >= value, "Address: insufficient balance for call");
                require(isContract(target), "Address: call to non-contract");
                (bool success, bytes memory returndata) = target.call{value: value}(data);
                return verifyCallResult(success, returndata, errorMessage);
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
             * but performing a static call.
             *
             * _Available since v3.3._
             */
            function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
                return functionStaticCall(target, data, "Address: low-level static call failed");
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
             * but performing a static call.
             *
             * _Available since v3.3._
             */
            function functionStaticCall(
                address target,
                bytes memory data,
                string memory errorMessage
            ) internal view returns (bytes memory) {
                require(isContract(target), "Address: static call to non-contract");
                (bool success, bytes memory returndata) = target.staticcall(data);
                return verifyCallResult(success, returndata, errorMessage);
            }
            /**
             * @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
             * revert reason using the provided one.
             *
             * _Available since v4.3._
             */
            function verifyCallResult(
                bool success,
                bytes memory returndata,
                string memory errorMessage
            ) internal pure returns (bytes memory) {
                if (success) {
                    return returndata;
                } else {
                    // Look for revert reason and bubble it up if present
                    if (returndata.length > 0) {
                        // The easiest way to bubble the revert reason is using memory via assembly
                        /// @solidity memory-safe-assembly
                        assembly {
                            let returndata_size := mload(returndata)
                            revert(add(32, returndata), returndata_size)
                        }
                    } else {
                        revert(errorMessage);
                    }
                }
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
        pragma solidity ^0.8.0;
        import "../proxy/utils/Initializable.sol";
        /**
         * @dev Provides information about the current execution context, including the
         * sender of the transaction and its data. While these are generally available
         * via msg.sender and msg.data, 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).
         *
         * This contract is only required for intermediate, library-like contracts.
         */
        abstract contract ContextUpgradeable is Initializable {
            function __Context_init() internal onlyInitializing {
            }
            function __Context_init_unchained() internal onlyInitializing {
            }
            function _msgSender() internal view virtual returns (address) {
                return msg.sender;
            }
            function _msgData() internal view virtual returns (bytes calldata) {
                return msg.data;
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[50] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.5.0) (utils/Multicall.sol)
        pragma solidity ^0.8.0;
        import "./AddressUpgradeable.sol";
        import "../proxy/utils/Initializable.sol";
        /**
         * @dev Provides a function to batch together multiple calls in a single external call.
         *
         * _Available since v4.1._
         */
        abstract contract MulticallUpgradeable is Initializable {
            function __Multicall_init() internal onlyInitializing {
            }
            function __Multicall_init_unchained() internal onlyInitializing {
            }
            /**
             * @dev Receives and executes a batch of function calls on this contract.
             */
            function multicall(bytes[] calldata data) external virtual returns (bytes[] memory results) {
                results = new bytes[](data.length);
                for (uint256 i = 0; i < data.length; i++) {
                    results[i] = _functionDelegateCall(address(this), data[i]);
                }
                return results;
            }
            /**
             * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
             * but performing a delegate call.
             *
             * _Available since v3.4._
             */
            function _functionDelegateCall(address target, bytes memory data) private returns (bytes memory) {
                require(AddressUpgradeable.isContract(target), "Address: delegate call to non-contract");
                // solhint-disable-next-line avoid-low-level-calls
                (bool success, bytes memory returndata) = target.delegatecall(data);
                return AddressUpgradeable.verifyCallResult(success, returndata, "Address: low-level delegate call failed");
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[50] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (utils/Strings.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev String operations.
         */
        library StringsUpgradeable {
            bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef";
            uint8 private constant _ADDRESS_LENGTH = 20;
            /**
             * @dev Converts a `uint256` to its ASCII `string` decimal representation.
             */
            function toString(uint256 value) internal pure returns (string memory) {
                // Inspired by OraclizeAPI's implementation - MIT licence
                // https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol
                if (value == 0) {
                    return "0";
                }
                uint256 temp = value;
                uint256 digits;
                while (temp != 0) {
                    digits++;
                    temp /= 10;
                }
                bytes memory buffer = new bytes(digits);
                while (value != 0) {
                    digits -= 1;
                    buffer[digits] = bytes1(uint8(48 + uint256(value % 10)));
                    value /= 10;
                }
                return string(buffer);
            }
            /**
             * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
             */
            function toHexString(uint256 value) internal pure returns (string memory) {
                if (value == 0) {
                    return "0x00";
                }
                uint256 temp = value;
                uint256 length = 0;
                while (temp != 0) {
                    length++;
                    temp >>= 8;
                }
                return toHexString(value, length);
            }
            /**
             * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
             */
            function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
                bytes memory buffer = new bytes(2 * length + 2);
                buffer[0] = "0";
                buffer[1] = "x";
                for (uint256 i = 2 * length + 1; i > 1; --i) {
                    buffer[i] = _HEX_SYMBOLS[value & 0xf];
                    value >>= 4;
                }
                require(value == 0, "Strings: hex length insufficient");
                return string(buffer);
            }
            /**
             * @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation.
             */
            function toHexString(address addr) internal pure returns (string memory) {
                return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH);
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.3) (utils/cryptography/ECDSA.sol)
        pragma solidity ^0.8.0;
        import "../StringsUpgradeable.sol";
        /**
         * @dev Elliptic Curve Digital Signature Algorithm (ECDSA) operations.
         *
         * These functions can be used to verify that a message was signed by the holder
         * of the private keys of a given address.
         */
        library ECDSAUpgradeable {
            enum RecoverError {
                NoError,
                InvalidSignature,
                InvalidSignatureLength,
                InvalidSignatureS,
                InvalidSignatureV
            }
            function _throwError(RecoverError error) private pure {
                if (error == RecoverError.NoError) {
                    return; // no error: do nothing
                } else if (error == RecoverError.InvalidSignature) {
                    revert("ECDSA: invalid signature");
                } else if (error == RecoverError.InvalidSignatureLength) {
                    revert("ECDSA: invalid signature length");
                } else if (error == RecoverError.InvalidSignatureS) {
                    revert("ECDSA: invalid signature 's' value");
                } else if (error == RecoverError.InvalidSignatureV) {
                    revert("ECDSA: invalid signature 'v' value");
                }
            }
            /**
             * @dev Returns the address that signed a hashed message (`hash`) with
             * `signature` or error string. This address can then be used for verification purposes.
             *
             * The `ecrecover` EVM opcode allows for malleable (non-unique) signatures:
             * this function rejects them by requiring the `s` value to be in the lower
             * half order, and the `v` value to be either 27 or 28.
             *
             * IMPORTANT: `hash` _must_ be the result of a hash operation for the
             * verification to be secure: it is possible to craft signatures that
             * recover to arbitrary addresses for non-hashed data. A safe way to ensure
             * this is by receiving a hash of the original message (which may otherwise
             * be too long), and then calling {toEthSignedMessageHash} on it.
             *
             * Documentation for signature generation:
             * - with https://web3js.readthedocs.io/en/v1.3.4/web3-eth-accounts.html#sign[Web3.js]
             * - with https://docs.ethers.io/v5/api/signer/#Signer-signMessage[ethers]
             *
             * _Available since v4.3._
             */
            function tryRecover(bytes32 hash, bytes memory signature) internal pure returns (address, RecoverError) {
                if (signature.length == 65) {
                    bytes32 r;
                    bytes32 s;
                    uint8 v;
                    // ecrecover takes the signature parameters, and the only way to get them
                    // currently is to use assembly.
                    /// @solidity memory-safe-assembly
                    assembly {
                        r := mload(add(signature, 0x20))
                        s := mload(add(signature, 0x40))
                        v := byte(0, mload(add(signature, 0x60)))
                    }
                    return tryRecover(hash, v, r, s);
                } else {
                    return (address(0), RecoverError.InvalidSignatureLength);
                }
            }
            /**
             * @dev Returns the address that signed a hashed message (`hash`) with
             * `signature`. This address can then be used for verification purposes.
             *
             * The `ecrecover` EVM opcode allows for malleable (non-unique) signatures:
             * this function rejects them by requiring the `s` value to be in the lower
             * half order, and the `v` value to be either 27 or 28.
             *
             * IMPORTANT: `hash` _must_ be the result of a hash operation for the
             * verification to be secure: it is possible to craft signatures that
             * recover to arbitrary addresses for non-hashed data. A safe way to ensure
             * this is by receiving a hash of the original message (which may otherwise
             * be too long), and then calling {toEthSignedMessageHash} on it.
             */
            function recover(bytes32 hash, bytes memory signature) internal pure returns (address) {
                (address recovered, RecoverError error) = tryRecover(hash, signature);
                _throwError(error);
                return recovered;
            }
            /**
             * @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately.
             *
             * See https://eips.ethereum.org/EIPS/eip-2098[EIP-2098 short signatures]
             *
             * _Available since v4.3._
             */
            function tryRecover(
                bytes32 hash,
                bytes32 r,
                bytes32 vs
            ) internal pure returns (address, RecoverError) {
                bytes32 s = vs & bytes32(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff);
                uint8 v = uint8((uint256(vs) >> 255) + 27);
                return tryRecover(hash, v, r, s);
            }
            /**
             * @dev Overload of {ECDSA-recover} that receives the `r and `vs` short-signature fields separately.
             *
             * _Available since v4.2._
             */
            function recover(
                bytes32 hash,
                bytes32 r,
                bytes32 vs
            ) internal pure returns (address) {
                (address recovered, RecoverError error) = tryRecover(hash, r, vs);
                _throwError(error);
                return recovered;
            }
            /**
             * @dev Overload of {ECDSA-tryRecover} that receives the `v`,
             * `r` and `s` signature fields separately.
             *
             * _Available since v4.3._
             */
            function tryRecover(
                bytes32 hash,
                uint8 v,
                bytes32 r,
                bytes32 s
            ) internal pure returns (address, RecoverError) {
                // EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature
                // unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines
                // the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. Most
                // signatures from current libraries generate a unique signature with an s-value in the lower half order.
                //
                // If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value
                // with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or
                // vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept
                // these malleable signatures as well.
                if (uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) {
                    return (address(0), RecoverError.InvalidSignatureS);
                }
                if (v != 27 && v != 28) {
                    return (address(0), RecoverError.InvalidSignatureV);
                }
                // If the signature is valid (and not malleable), return the signer address
                address signer = ecrecover(hash, v, r, s);
                if (signer == address(0)) {
                    return (address(0), RecoverError.InvalidSignature);
                }
                return (signer, RecoverError.NoError);
            }
            /**
             * @dev Overload of {ECDSA-recover} that receives the `v`,
             * `r` and `s` signature fields separately.
             */
            function recover(
                bytes32 hash,
                uint8 v,
                bytes32 r,
                bytes32 s
            ) internal pure returns (address) {
                (address recovered, RecoverError error) = tryRecover(hash, v, r, s);
                _throwError(error);
                return recovered;
            }
            /**
             * @dev Returns an Ethereum Signed Message, created from a `hash`. This
             * produces hash corresponding to the one signed with the
             * https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`]
             * JSON-RPC method as part of EIP-191.
             *
             * See {recover}.
             */
            function toEthSignedMessageHash(bytes32 hash) internal pure returns (bytes32) {
                // 32 is the length in bytes of hash,
                // enforced by the type signature above
                return keccak256(abi.encodePacked("\\x19Ethereum Signed Message:\
        32", hash));
            }
            /**
             * @dev Returns an Ethereum Signed Message, created from `s`. This
             * produces hash corresponding to the one signed with the
             * https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`]
             * JSON-RPC method as part of EIP-191.
             *
             * See {recover}.
             */
            function toEthSignedMessageHash(bytes memory s) internal pure returns (bytes32) {
                return keccak256(abi.encodePacked("\\x19Ethereum Signed Message:\
        ", StringsUpgradeable.toString(s.length), s));
            }
            /**
             * @dev Returns an Ethereum Signed Typed Data, created from a
             * `domainSeparator` and a `structHash`. This produces hash corresponding
             * to the one signed with the
             * https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`]
             * JSON-RPC method as part of EIP-712.
             *
             * See {recover}.
             */
            function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32) {
                return keccak256(abi.encodePacked("\\x19\\x01", domainSeparator, structHash));
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (utils/cryptography/draft-EIP712.sol)
        pragma solidity ^0.8.0;
        import "./ECDSAUpgradeable.sol";
        import "../../proxy/utils/Initializable.sol";
        /**
         * @dev https://eips.ethereum.org/EIPS/eip-712[EIP 712] is a standard for hashing and signing of typed structured data.
         *
         * The encoding specified in the EIP is very generic, and such a generic implementation in Solidity is not feasible,
         * thus this contract does not implement the encoding itself. Protocols need to implement the type-specific encoding
         * they need in their contracts using a combination of `abi.encode` and `keccak256`.
         *
         * This contract implements the EIP 712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding
         * scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA
         * ({_hashTypedDataV4}).
         *
         * The implementation of the domain separator was designed to be as efficient as possible while still properly updating
         * the chain id to protect against replay attacks on an eventual fork of the chain.
         *
         * NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method
         * https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask].
         *
         * _Available since v3.4._
         *
         * @custom:storage-size 52
         */
        abstract contract EIP712Upgradeable is Initializable {
            /* solhint-disable var-name-mixedcase */
            bytes32 private _HASHED_NAME;
            bytes32 private _HASHED_VERSION;
            bytes32 private constant _TYPE_HASH = keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");
            /* solhint-enable var-name-mixedcase */
            /**
             * @dev Initializes the domain separator and parameter caches.
             *
             * The meaning of `name` and `version` is specified in
             * https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator[EIP 712]:
             *
             * - `name`: the user readable name of the signing domain, i.e. the name of the DApp or the protocol.
             * - `version`: the current major version of the signing domain.
             *
             * NOTE: These parameters cannot be changed except through a xref:learn::upgrading-smart-contracts.adoc[smart
             * contract upgrade].
             */
            function __EIP712_init(string memory name, string memory version) internal onlyInitializing {
                __EIP712_init_unchained(name, version);
            }
            function __EIP712_init_unchained(string memory name, string memory version) internal onlyInitializing {
                bytes32 hashedName = keccak256(bytes(name));
                bytes32 hashedVersion = keccak256(bytes(version));
                _HASHED_NAME = hashedName;
                _HASHED_VERSION = hashedVersion;
            }
            /**
             * @dev Returns the domain separator for the current chain.
             */
            function _domainSeparatorV4() internal view returns (bytes32) {
                return _buildDomainSeparator(_TYPE_HASH, _EIP712NameHash(), _EIP712VersionHash());
            }
            function _buildDomainSeparator(
                bytes32 typeHash,
                bytes32 nameHash,
                bytes32 versionHash
            ) private view returns (bytes32) {
                return keccak256(abi.encode(typeHash, nameHash, versionHash, block.chainid, address(this)));
            }
            /**
             * @dev Given an already https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct[hashed struct], this
             * function returns the hash of the fully encoded EIP712 message for this domain.
             *
             * This hash can be used together with {ECDSA-recover} to obtain the signer of a message. For example:
             *
             * ```solidity
             * bytes32 digest = _hashTypedDataV4(keccak256(abi.encode(
             *     keccak256("Mail(address to,string contents)"),
             *     mailTo,
             *     keccak256(bytes(mailContents))
             * )));
             * address signer = ECDSA.recover(digest, signature);
             * ```
             */
            function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) {
                return ECDSAUpgradeable.toTypedDataHash(_domainSeparatorV4(), structHash);
            }
            /**
             * @dev The hash of the name parameter for the EIP712 domain.
             *
             * NOTE: This function reads from storage by default, but can be redefined to return a constant value if gas costs
             * are a concern.
             */
            function _EIP712NameHash() internal virtual view returns (bytes32) {
                return _HASHED_NAME;
            }
            /**
             * @dev The hash of the version parameter for the EIP712 domain.
             *
             * NOTE: This function reads from storage by default, but can be redefined to return a constant value if gas costs
             * are a concern.
             */
            function _EIP712VersionHash() internal virtual view returns (bytes32) {
                return _HASHED_VERSION;
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[50] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)
        pragma solidity ^0.8.0;
        import "./IERC165Upgradeable.sol";
        import "../../proxy/utils/Initializable.sol";
        /**
         * @dev Implementation of the {IERC165} interface.
         *
         * Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
         * for the additional interface id that will be supported. For example:
         *
         * ```solidity
         * function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
         *     return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
         * }
         * ```
         *
         * Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
         */
        abstract contract ERC165Upgradeable is Initializable, IERC165Upgradeable {
            function __ERC165_init() internal onlyInitializing {
            }
            function __ERC165_init_unchained() internal onlyInitializing {
            }
            /**
             * @dev See {IERC165-supportsInterface}.
             */
            function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
                return interfaceId == type(IERC165Upgradeable).interfaceId;
            }
            /**
             * @dev This empty reserved space is put in place to allow future versions to add new
             * variables without shifting down storage in the inheritance chain.
             * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
             */
            uint256[50] private __gap;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev Interface of the ERC165 standard, as defined in the
         * https://eips.ethereum.org/EIPS/eip-165[EIP].
         *
         * Implementers can declare support of contract interfaces, which can then be
         * queried by others ({ERC165Checker}).
         *
         * For an implementation, see {ERC165}.
         */
        interface IERC165Upgradeable {
            /**
             * @dev Returns true if this contract implements the interface defined by
             * `interfaceId`. See the corresponding
             * https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
             * to learn more about how these ids are created.
             *
             * This function call must use less than 30 000 gas.
             */
            function supportsInterface(bytes4 interfaceId) external view returns (bool);
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (utils/structs/EnumerableSet.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev Library for managing
         * https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive
         * types.
         *
         * Sets have the following properties:
         *
         * - Elements are added, removed, and checked for existence in constant time
         * (O(1)).
         * - Elements are enumerated in O(n). No guarantees are made on the ordering.
         *
         * ```
         * contract Example {
         *     // Add the library methods
         *     using EnumerableSet for EnumerableSet.AddressSet;
         *
         *     // Declare a set state variable
         *     EnumerableSet.AddressSet private mySet;
         * }
         * ```
         *
         * As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`)
         * and `uint256` (`UintSet`) are supported.
         *
         * [WARNING]
         * ====
         *  Trying to delete such a structure from storage will likely result in data corruption, rendering the structure unusable.
         *  See https://github.com/ethereum/solidity/pull/11843[ethereum/solidity#11843] for more info.
         *
         *  In order to clean an EnumerableSet, you can either remove all elements one by one or create a fresh instance using an array of EnumerableSet.
         * ====
         */
        library EnumerableSetUpgradeable {
            // To implement this library for multiple types with as little code
            // repetition as possible, we write it in terms of a generic Set type with
            // bytes32 values.
            // The Set implementation uses private functions, and user-facing
            // implementations (such as AddressSet) are just wrappers around the
            // underlying Set.
            // This means that we can only create new EnumerableSets for types that fit
            // in bytes32.
            struct Set {
                // Storage of set values
                bytes32[] _values;
                // Position of the value in the `values` array, plus 1 because index 0
                // means a value is not in the set.
                mapping(bytes32 => uint256) _indexes;
            }
            /**
             * @dev Add a value to a set. O(1).
             *
             * Returns true if the value was added to the set, that is if it was not
             * already present.
             */
            function _add(Set storage set, bytes32 value) private returns (bool) {
                if (!_contains(set, value)) {
                    set._values.push(value);
                    // The value is stored at length-1, but we add 1 to all indexes
                    // and use 0 as a sentinel value
                    set._indexes[value] = set._values.length;
                    return true;
                } else {
                    return false;
                }
            }
            /**
             * @dev Removes a value from a set. O(1).
             *
             * Returns true if the value was removed from the set, that is if it was
             * present.
             */
            function _remove(Set storage set, bytes32 value) private returns (bool) {
                // We read and store the value's index to prevent multiple reads from the same storage slot
                uint256 valueIndex = set._indexes[value];
                if (valueIndex != 0) {
                    // Equivalent to contains(set, value)
                    // To delete an element from the _values array in O(1), we swap the element to delete with the last one in
                    // the array, and then remove the last element (sometimes called as 'swap and pop').
                    // This modifies the order of the array, as noted in {at}.
                    uint256 toDeleteIndex = valueIndex - 1;
                    uint256 lastIndex = set._values.length - 1;
                    if (lastIndex != toDeleteIndex) {
                        bytes32 lastValue = set._values[lastIndex];
                        // Move the last value to the index where the value to delete is
                        set._values[toDeleteIndex] = lastValue;
                        // Update the index for the moved value
                        set._indexes[lastValue] = valueIndex; // Replace lastValue's index to valueIndex
                    }
                    // Delete the slot where the moved value was stored
                    set._values.pop();
                    // Delete the index for the deleted slot
                    delete set._indexes[value];
                    return true;
                } else {
                    return false;
                }
            }
            /**
             * @dev Returns true if the value is in the set. O(1).
             */
            function _contains(Set storage set, bytes32 value) private view returns (bool) {
                return set._indexes[value] != 0;
            }
            /**
             * @dev Returns the number of values on the set. O(1).
             */
            function _length(Set storage set) private view returns (uint256) {
                return set._values.length;
            }
            /**
             * @dev Returns the value stored at position `index` in the set. O(1).
             *
             * Note that there are no guarantees on the ordering of values inside the
             * array, and it may change when more values are added or removed.
             *
             * Requirements:
             *
             * - `index` must be strictly less than {length}.
             */
            function _at(Set storage set, uint256 index) private view returns (bytes32) {
                return set._values[index];
            }
            /**
             * @dev Return the entire set in an array
             *
             * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
             * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
             * this function has an unbounded cost, and using it as part of a state-changing function may render the function
             * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
             */
            function _values(Set storage set) private view returns (bytes32[] memory) {
                return set._values;
            }
            // Bytes32Set
            struct Bytes32Set {
                Set _inner;
            }
            /**
             * @dev Add a value to a set. O(1).
             *
             * Returns true if the value was added to the set, that is if it was not
             * already present.
             */
            function add(Bytes32Set storage set, bytes32 value) internal returns (bool) {
                return _add(set._inner, value);
            }
            /**
             * @dev Removes a value from a set. O(1).
             *
             * Returns true if the value was removed from the set, that is if it was
             * present.
             */
            function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) {
                return _remove(set._inner, value);
            }
            /**
             * @dev Returns true if the value is in the set. O(1).
             */
            function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) {
                return _contains(set._inner, value);
            }
            /**
             * @dev Returns the number of values in the set. O(1).
             */
            function length(Bytes32Set storage set) internal view returns (uint256) {
                return _length(set._inner);
            }
            /**
             * @dev Returns the value stored at position `index` in the set. O(1).
             *
             * Note that there are no guarantees on the ordering of values inside the
             * array, and it may change when more values are added or removed.
             *
             * Requirements:
             *
             * - `index` must be strictly less than {length}.
             */
            function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) {
                return _at(set._inner, index);
            }
            /**
             * @dev Return the entire set in an array
             *
             * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
             * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
             * this function has an unbounded cost, and using it as part of a state-changing function may render the function
             * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
             */
            function values(Bytes32Set storage set) internal view returns (bytes32[] memory) {
                return _values(set._inner);
            }
            // AddressSet
            struct AddressSet {
                Set _inner;
            }
            /**
             * @dev Add a value to a set. O(1).
             *
             * Returns true if the value was added to the set, that is if it was not
             * already present.
             */
            function add(AddressSet storage set, address value) internal returns (bool) {
                return _add(set._inner, bytes32(uint256(uint160(value))));
            }
            /**
             * @dev Removes a value from a set. O(1).
             *
             * Returns true if the value was removed from the set, that is if it was
             * present.
             */
            function remove(AddressSet storage set, address value) internal returns (bool) {
                return _remove(set._inner, bytes32(uint256(uint160(value))));
            }
            /**
             * @dev Returns true if the value is in the set. O(1).
             */
            function contains(AddressSet storage set, address value) internal view returns (bool) {
                return _contains(set._inner, bytes32(uint256(uint160(value))));
            }
            /**
             * @dev Returns the number of values in the set. O(1).
             */
            function length(AddressSet storage set) internal view returns (uint256) {
                return _length(set._inner);
            }
            /**
             * @dev Returns the value stored at position `index` in the set. O(1).
             *
             * Note that there are no guarantees on the ordering of values inside the
             * array, and it may change when more values are added or removed.
             *
             * Requirements:
             *
             * - `index` must be strictly less than {length}.
             */
            function at(AddressSet storage set, uint256 index) internal view returns (address) {
                return address(uint160(uint256(_at(set._inner, index))));
            }
            /**
             * @dev Return the entire set in an array
             *
             * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
             * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
             * this function has an unbounded cost, and using it as part of a state-changing function may render the function
             * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
             */
            function values(AddressSet storage set) internal view returns (address[] memory) {
                bytes32[] memory store = _values(set._inner);
                address[] memory result;
                /// @solidity memory-safe-assembly
                assembly {
                    result := store
                }
                return result;
            }
            // UintSet
            struct UintSet {
                Set _inner;
            }
            /**
             * @dev Add a value to a set. O(1).
             *
             * Returns true if the value was added to the set, that is if it was not
             * already present.
             */
            function add(UintSet storage set, uint256 value) internal returns (bool) {
                return _add(set._inner, bytes32(value));
            }
            /**
             * @dev Removes a value from a set. O(1).
             *
             * Returns true if the value was removed from the set, that is if it was
             * present.
             */
            function remove(UintSet storage set, uint256 value) internal returns (bool) {
                return _remove(set._inner, bytes32(value));
            }
            /**
             * @dev Returns true if the value is in the set. O(1).
             */
            function contains(UintSet storage set, uint256 value) internal view returns (bool) {
                return _contains(set._inner, bytes32(value));
            }
            /**
             * @dev Returns the number of values on the set. O(1).
             */
            function length(UintSet storage set) internal view returns (uint256) {
                return _length(set._inner);
            }
            /**
             * @dev Returns the value stored at position `index` in the set. O(1).
             *
             * Note that there are no guarantees on the ordering of values inside the
             * array, and it may change when more values are added or removed.
             *
             * Requirements:
             *
             * - `index` must be strictly less than {length}.
             */
            function at(UintSet storage set, uint256 index) internal view returns (uint256) {
                return uint256(_at(set._inner, index));
            }
            /**
             * @dev Return the entire set in an array
             *
             * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
             * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
             * this function has an unbounded cost, and using it as part of a state-changing function may render the function
             * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
             */
            function values(UintSet storage set) internal view returns (uint256[] memory) {
                bytes32[] memory store = _values(set._inner);
                uint256[] memory result;
                /// @solidity memory-safe-assembly
                assembly {
                    result := store
                }
                return result;
            }
        }
        

        File 3 of 4: MirrorTreasury
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity 0.8.6;
        import {IDistributionLogic} from "../distribution/interface/IDistributionLogic.sol";
        import {ITributaryRegistry} from "../interface/ITributaryRegistry.sol";
        import {ITreasuryConfig} from "../interface/ITreasuryConfig.sol";
        import {IMirrorTreasury} from "../interface/IMirrorTreasury.sol";
        import {Governable} from "../lib/Governable.sol";
        interface IERC20 {
            function transfer(address to, uint256 value) external returns (bool);
        }
        contract MirrorTreasury is IMirrorTreasury, Governable {
            // ============ Treasury Configuration ============
            // Used to pull the active distribution model.
            address public treasuryConfig;
            // ============ Tributary Registry ============
            // Used to find tributary addresses associated with Economic Producers.
            address public tributaryRegistry;
            // ============ Structs ============
            // Allows governance to execute generic functions.
            struct Call {
                // The target of the transaction.
                address target;
                // The value passed into the transaction.
                uint96 value;
                // Any data passed with the call.
                bytes data;
            }
            // ============ Events ============
            // Emitted when the treasury transfers ETH.
            event Transfer(address indexed from, address indexed to, uint256 value);
            // Emitted when the treasury transfers an ERC20 token.
            event ERC20Transfer(
                address indexed token,
                address indexed from,
                address indexed to,
                uint256 amount
            );
            // ============ Constructor ============
            // NOTE: Once deployed, tributaryRegistry and treasuryConfig should be set.
            constructor(address owner_) Governable(owner_) {}
            // ============ Treasury Contributions ============
            /**
             * A safe, public function for making contributions to the treasury.
             * If a tributary is registered for the contributor, then governance
             * tokens will be allocated according to the active distribution model.
             */
            function contribute(uint256 amount) public payable override {
                require(msg.value == amount, "msg.value != amount");
                _allocateGovernance(msg.sender, amount);
            }
            // Allows directly contributing with a specify treasury, but the sender
            // must be registered as a "singleton producer" - e.g. auctions house.
            function contributeWithTributary(address tributary)
                public
                payable
                override
            {
                // Here we don't revert, but instead just don't allocate goverance
                // if the call isn't registered as an economic producer.
                if (
                    ITributaryRegistry(tributaryRegistry).singletonProducer(msg.sender)
                ) {
                    _allocateGovernanceToTributary(tributary, msg.value);
                }
            }
            /**
             * Allows receiving ETH, and can mint treasury governance tokens in
             * exchange. Uses a registry to specify which addresses are allowed
             * to receive gov tokens in exchange for contributing ETH.
             */
            receive() external payable {
                _allocateGovernance(msg.sender, msg.value);
            }
            // ============ Treasury Configuration ============
            function setTreasuryConfig(address treasuryConfig_) public onlyGovernance {
                treasuryConfig = treasuryConfig_;
            }
            // ============ Tributary Registry Configuration ============
            function setTributaryRegistry(address tributaryRegistry_)
                public
                onlyGovernance
            {
                tributaryRegistry = tributaryRegistry_;
            }
            // ============ Funds Administration ============
            function transferFunds(address payable to, uint256 value)
                external
                override
                onlyGovernance
            {
                _sendFunds(to, value);
                emit Transfer(address(this), to, value);
            }
            function transferERC20(
                address token,
                address to,
                uint256 amount
            ) external override onlyGovernance {
                IERC20(token).transfer(to, amount);
                emit ERC20Transfer(token, address(this), to, amount);
            }
            // ============ Generic Call Execution ============
            function executeGeneric(Call memory call) public onlyGovernance {
                (bool ok, ) = call.target.call{value: uint256(call.value)}(call.data);
                require(ok, "execute transaction failed");
            }
            // ============ Private Utils ============
            function _sendFunds(address payable recipient, uint256 amount) private {
                require(
                    address(this).balance >= amount,
                    "Insufficient balance for send"
                );
                (bool success, ) = recipient.call{value: amount}("");
                require(success, "Unable to send value: recipient may have reverted");
            }
            function _allocateGovernance(address producer, uint256 amount) private {
                // Get the tributary that was registered for the given producer.
                address tributary = ITributaryRegistry(tributaryRegistry)
                    .producerToTributary(producer);
                _allocateGovernanceToTributary(tributary, amount);
            }
            function _allocateGovernanceToTributary(address tributary, uint256 amount)
                private
            {
                // If there is a registered tributary to mint Mirror tokens for,
                // then, here, we go and mint those tokens! Else, just accept ETH, no sweat.
                if (tributary != address(0)) {
                    address distributionModel = ITreasuryConfig(treasuryConfig)
                        .distributionModel();
                    IDistributionLogic(distributionModel).distribute(tributary, amount);
                }
            }
        }
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity 0.8.6;
        interface IDistributionLogic {
            function version() external returns (uint256);
            function distribute(address tributary, uint256 contribution) external;
            function claim(address claimant) external;
            function claimable(address claimant) external view returns (uint256);
            function increaseAwards(address member, uint256 amount) external;
        }
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity 0.8.6;
        interface ITributaryRegistry {
            function addRegistrar(address registrar) external;
            function removeRegistrar(address registrar) external;
            function addSingletonProducer(address producer) external;
            function removeSingletonProducer(address producer) external;
            function registerTributary(address producer, address tributary) external;
            function producerToTributary(address producer)
                external
                returns (address tributary);
            function singletonProducer(address producer) external returns (bool);
            function changeTributary(address producer, address newTributary) external;
        }
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity 0.8.6;
        interface ITreasuryConfig {
            function treasury() external returns (address payable);
            function distributionModel() external returns (address);
        }
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity 0.8.6;
        interface IMirrorTreasury {
            function transferFunds(address payable to, uint256 value) external;
            function transferERC20(
                address token,
                address to,
                uint256 value
            ) external;
            function contributeWithTributary(address tributary) external payable;
            function contribute(uint256 amount) external payable;
        }
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity 0.8.6;
        import {Ownable} from "../lib/Ownable.sol";
        import {IGovernable} from "../lib/interface/IGovernable.sol";
        contract Governable is Ownable, IGovernable {
            // ============ Mutable Storage ============
            // Mirror governance contract.
            address public override governor;
            // ============ Modifiers ============
            modifier onlyGovernance() {
                require(isOwner() || isGovernor(), "caller is not governance");
                _;
            }
            modifier onlyGovernor() {
                require(isGovernor(), "caller is not governor");
                _;
            }
            // ============ Constructor ============
            constructor(address owner_) Ownable(owner_) {}
            // ============ Administration ============
            function changeGovernor(address governor_) public override onlyGovernance {
                governor = governor_;
            }
            // ============ Utility Functions ============
            function isGovernor() public view override returns (bool) {
                return msg.sender == governor;
            }
        }
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity 0.8.6;
        contract Ownable {
            address public owner;
            address private nextOwner;
            event OwnershipTransferred(
                address indexed previousOwner,
                address indexed newOwner
            );
            // modifiers
            modifier onlyOwner() {
                require(isOwner(), "caller is not the owner.");
                _;
            }
            modifier onlyNextOwner() {
                require(isNextOwner(), "current owner must set caller as next owner.");
                _;
            }
            /**
             * @dev Initialize contract by setting transaction submitter as initial owner.
             */
            constructor(address owner_) {
                owner = owner_;
                emit OwnershipTransferred(address(0), owner);
            }
            /**
             * @dev Initiate ownership transfer by setting nextOwner.
             */
            function transferOwnership(address nextOwner_) external onlyOwner {
                require(nextOwner_ != address(0), "Next owner is the zero address.");
                nextOwner = nextOwner_;
            }
            /**
             * @dev Cancel ownership transfer by deleting nextOwner.
             */
            function cancelOwnershipTransfer() external onlyOwner {
                delete nextOwner;
            }
            /**
             * @dev Accepts ownership transfer by setting owner.
             */
            function acceptOwnership() external onlyNextOwner {
                delete nextOwner;
                owner = msg.sender;
                emit OwnershipTransferred(owner, msg.sender);
            }
            /**
             * @dev Renounce ownership by setting owner to zero address.
             */
            function renounceOwnership() external onlyOwner {
                owner = address(0);
                emit OwnershipTransferred(owner, address(0));
            }
            /**
             * @dev Returns true if the caller is the current owner.
             */
            function isOwner() public view returns (bool) {
                return msg.sender == owner;
            }
            /**
             * @dev Returns true if the caller is the next owner.
             */
            function isNextOwner() public view returns (bool) {
                return msg.sender == nextOwner;
            }
        }
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity 0.8.6;
        interface IGovernable {
            function changeGovernor(address governor_) external;
            function isGovernor() external view returns (bool);
            function governor() external view returns (address);
        }
        

        File 4 of 4: TributaryRegistry
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity 0.8.6;
        import {ITributaryRegistry} from "../interface/ITributaryRegistry.sol";
        import {Governable} from "../lib/Governable.sol";
        /**
         * Allows a registrar contract to register a new proxy as a block
         * that directs Mirror Token distribution to a tributary.
         * Ensures that the tributary is an Mirror DAO, and that only a valid
         * "Mirror Economic Block" created by a registered registrar, can contribute ETH
         * to the treasury. Otherwise, anyone could send ETH to the treasury to mint Mirror tokens.
         * @author MirrorXYZ
         */
        contract TributaryRegistry is Governable, ITributaryRegistry {
            // ============ Mutable Storage ============
            // E.g. crowdfund factory. Can register producer => tributary.
            mapping(address => bool) allowedRegistrar;
            // E.g. crowdfund proxy => Mirror DAO.
            mapping(address => address) public override producerToTributary;
            // E.g. auctions house. Can send funds and specify tributary directly.
            mapping(address => bool) public override singletonProducer;
            // ============ Modifiers ============
            modifier onlyRegistrar() {
                require(allowedRegistrar[msg.sender], "sender not registered");
                _;
            }
            constructor(address owner_) Governable(owner_) {}
            // ============ Configuration ============
            function addRegistrar(address registrar) public override onlyGovernance {
                allowedRegistrar[registrar] = true;
            }
            function removeRegistrar(address registrar) public override onlyGovernance {
                delete allowedRegistrar[registrar];
            }
            function addSingletonProducer(address producer)
                public
                override
                onlyGovernance
            {
                singletonProducer[producer] = true;
            }
            function removeSingletonProducer(address producer)
                public
                override
                onlyGovernance
            {
                delete singletonProducer[producer];
            }
            // ============ Tributary Configuration ============
            /**
             * Register a producer's (crowdfund, edition etc) tributary. Can only be called
             * by an allowed registrar.
             */
            function registerTributary(address producer, address tributary)
                public
                override
                onlyRegistrar
            {
                producerToTributary[producer] = tributary;
            }
            /**
             * Allows the current tributary to update to a new tributary.
             */
            function changeTributary(address producer, address newTributary)
                public
                override
                onlyRegistrar
            {
                // Check that the sender of the transaction is the current tributary.
                require(
                    msg.sender == producerToTributary[producer],
                    "only for current tributary"
                );
                // Allow the current tributary to update to a new tributary.
                producerToTributary[producer] = newTributary;
            }
        }
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity 0.8.6;
        interface ITributaryRegistry {
            function addRegistrar(address registrar) external;
            function removeRegistrar(address registrar) external;
            function addSingletonProducer(address producer) external;
            function removeSingletonProducer(address producer) external;
            function registerTributary(address producer, address tributary) external;
            function producerToTributary(address producer)
                external
                returns (address tributary);
            function singletonProducer(address producer) external returns (bool);
            function changeTributary(address producer, address newTributary) external;
        }
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity 0.8.6;
        import {Ownable} from "../lib/Ownable.sol";
        import {IGovernable} from "../lib/interface/IGovernable.sol";
        contract Governable is Ownable, IGovernable {
            // ============ Mutable Storage ============
            // Mirror governance contract.
            address public override governor;
            // ============ Modifiers ============
            modifier onlyGovernance() {
                require(isOwner() || isGovernor(), "caller is not governance");
                _;
            }
            modifier onlyGovernor() {
                require(isGovernor(), "caller is not governor");
                _;
            }
            // ============ Constructor ============
            constructor(address owner_) Ownable(owner_) {}
            // ============ Administration ============
            function changeGovernor(address governor_) public override onlyGovernance {
                governor = governor_;
            }
            // ============ Utility Functions ============
            function isGovernor() public view override returns (bool) {
                return msg.sender == governor;
            }
        }
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity 0.8.6;
        contract Ownable {
            address public owner;
            address private nextOwner;
            event OwnershipTransferred(
                address indexed previousOwner,
                address indexed newOwner
            );
            // modifiers
            modifier onlyOwner() {
                require(isOwner(), "caller is not the owner.");
                _;
            }
            modifier onlyNextOwner() {
                require(isNextOwner(), "current owner must set caller as next owner.");
                _;
            }
            /**
             * @dev Initialize contract by setting transaction submitter as initial owner.
             */
            constructor(address owner_) {
                owner = owner_;
                emit OwnershipTransferred(address(0), owner);
            }
            /**
             * @dev Initiate ownership transfer by setting nextOwner.
             */
            function transferOwnership(address nextOwner_) external onlyOwner {
                require(nextOwner_ != address(0), "Next owner is the zero address.");
                nextOwner = nextOwner_;
            }
            /**
             * @dev Cancel ownership transfer by deleting nextOwner.
             */
            function cancelOwnershipTransfer() external onlyOwner {
                delete nextOwner;
            }
            /**
             * @dev Accepts ownership transfer by setting owner.
             */
            function acceptOwnership() external onlyNextOwner {
                delete nextOwner;
                owner = msg.sender;
                emit OwnershipTransferred(owner, msg.sender);
            }
            /**
             * @dev Renounce ownership by setting owner to zero address.
             */
            function renounceOwnership() external onlyOwner {
                owner = address(0);
                emit OwnershipTransferred(owner, address(0));
            }
            /**
             * @dev Returns true if the caller is the current owner.
             */
            function isOwner() public view returns (bool) {
                return msg.sender == owner;
            }
            /**
             * @dev Returns true if the caller is the next owner.
             */
            function isNextOwner() public view returns (bool) {
                return msg.sender == nextOwner;
            }
        }
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity 0.8.6;
        interface IGovernable {
            function changeGovernor(address governor_) external;
            function isGovernor() external view returns (bool);
            function governor() external view returns (address);
        }