// SPDX-License-Identifier: Apache-2.0
pragma solidity ^0.8.27;

// modules
import {LSP7DigitalAsset} from "../../LSP7DigitalAsset.sol";

// errors
import {LSP7CappedSupplyCannotMintOverCap} from "./LSP7CappedSupplyErrors.sol";

/// @title LSP7CappedSupplyAbstract
/// @dev Abstract contract implementing a token supply cap.
abstract contract LSP7CappedSupplyAbstract is LSP7DigitalAsset {
    uint256 private immutable _TOKEN_SUPPLY_CAP;

    /// @notice Deploying a `LSP7CappedSupply` token contract with max token supply cap set to `tokenSupplyCap_`.
    /// @dev Deploy a `LSP7CappedSupply` token contract and set the maximum token supply token cap up to which it is not possible to mint more tokens.
    /// @param tokenSupplyCap_ The maximum total supply in wei, 0 to disable.
    constructor(uint256 tokenSupplyCap_) {
        _TOKEN_SUPPLY_CAP = tokenSupplyCap_;
    }

    /// @notice The maximum supply amount of tokens allowed to exist is `_TOKEN_SUPPLY_CAP`.
    /// @dev Get the maximum number of tokens that can exist to circulate. Once {totalSupply} reaches {totalSupplyCap}, it is not possible to mint more tokens.
    /// @return The maximum number of tokens that can exist in the contract.
    function tokenSupplyCap() public view virtual returns (uint256) {
        return _TOKEN_SUPPLY_CAP;
    }

    /// @dev Checks if minting `amount` of tokens would exceed the token supply cap.
    function _tokenSupplyCapCheck(
        address,
        /* to */
        uint256 amount,
        bool,
        /* force */
        bytes memory /* data */
    ) internal virtual {
        require(
            tokenSupplyCap() == 0 ||
                (totalSupply() + amount) <= tokenSupplyCap(),
            LSP7CappedSupplyCannotMintOverCap()
        );
    }

    /// @dev Same as {_mint} but allows to mint only if the {totalSupply}
    /// does not exceed the {tokenSupplyCap} after `amount` of tokens have been minted.
    function _mint(
        address to,
        uint256 amount,
        bool force,
        bytes memory data
    ) internal virtual override {
        _tokenSupplyCapCheck(to, amount, force, data);
        super._mint(to, amount, force, data);
    }
}