feat: Implement ERC721CommonUpgradeable contract

.github/template/create-pull-request.md

@@ -0,0 +1,2 @@
+### Description
+PR to merge from [{{ .fromBranch }}](/axieinfinity/foundry-contract-template/tree/{{ .fromBranch }}) to [{{ .toBranch }}](/axieinfinity/foundry-contract-template/tree/{{ .toBranch }}).

.github/workflows/test.yml

@@ -0,0 +1,54 @@
+name: test
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+      - 'feature/*'
+      - 'features/*'
+  pull_request:
+    branches:
+      - main
+      - dev
+      - 'feature/*'
+      - 'features/*'
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Foundry project
+    runs-on: [self-hosted, dockerize]
+    steps:
+      - id: 'gh-app'
+        name: 'Get Token'
+        uses: 'tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a' #v1.7.0
+        with:
+          app_id: ${{ secrets.GH_APP_ID }}
+          private_key: ${{ secrets.GH_PRIVATE_KEY }}
+
+      - uses: actions/[email protected]
+        with:
+          submodules: recursive
+          token: ${{ steps.gh-app.outputs.token }}
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run Forge build
+        run: |
+          forge --version
+          forge build --sizes
+        id: build
+
+      - name: Run Forge tests
+        run: |
+          forge test -vvv
+        id: test

.gitmodules

@@ -6,3 +6,7 @@
 	path = lib/openzeppelin-contracts
 	url = https://github.com/openzeppelin/openzeppelin-contracts
 	branch = v4.8.2
+[submodule "lib/openzeppelin-contracts-upgradeable"]
+	path = lib/openzeppelin-contracts-upgradeable
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable
+	branch = v4.9.5

foundry.toml

@@ -4,10 +4,13 @@ out = 'out'
 libs = ['lib', 'party']
 
 # See more config options https://github.com/foundry-rs/foundry/tree/master/config
-solc = '0.8.17'
 evm_version = 'istanbul'
 cache_path = 'cache/foundry'
 
+extra_output = ["devdoc", "userdoc", "storagelayout"]
+fs_permissions = [{ access = "read-write", path = "./" }]
+
 [fmt]
-line_length = 120
 tab_width = 2
+line_length = 120
+bracket_spacing = true

scripts/deploy/logic/erc721-upgradeable-logic.sol

@@ -0,0 +1,16 @@
+import { HardhatRuntimeEnvironment } from 'hardhat/types';
+
+const deploy = async ({ getNamedAccounts, deployments, ethers }: HardhatRuntimeEnvironment) => {
+  const { deploy } = deployments;
+  const { deployer } = await getNamedAccounts();
+  await deploy('SampleERC721CommonUpgradeableLogic', {
+    contract: 'ERC721CommonUpgradeable',
+    from: deployer,
+    log: true,
+  });
+};
+
+deploy.tags = ['SampleERC721CommonUpgradeableLogic'];
+deploy.dependencies = ['VerifyContracts'];
+
+export default deploy;

scripts/deploy/proxy-admin.ts

@@ -0,0 +1,16 @@
+import { HardhatRuntimeEnvironment } from 'hardhat/types';
+
+const deploy = async ({ getNamedAccounts, deployments, ethers }: HardhatRuntimeEnvironment) => {
+  const { deploy } = deployments;
+  const { deployer } = await getNamedAccounts();
+  await deploy('ProxyAdmin', {
+    contract: 'ProxyAdmin',
+    from: deployer,
+    log: true,
+  });
+};
+
+deploy.tags = ['ProxyAdmin'];
+deploy.dependencies = ['VerifyContracts'];
+
+export default deploy;

scripts/deploy/proxy/erc721-upgradeable-proxy.ts

@@ -0,0 +1,25 @@
+import { ERC721CommonUpgradeable__factory } from '../../typechain-types';
+import { HardhatRuntimeEnvironment } from 'hardhat/types';
+
+const erc721Interface = ERC721CommonUpgradeable__factory.createInterface();
+
+const deploy = async ({ getNamedAccounts, deployments, network }: HardhatRuntimeEnvironment) => {
+  const { deploy } = deployments;
+  const { deployer } = await getNamedAccounts();
+  const proxyAdmin = await deployments.get('ProxyAdmin');
+  const logicContract = await deployments.get('SampleERC721CommonUpgradeableLogic');
+
+  const data = erc721Interface.encodeFunctionData('initialize', ['SampleERC721', 'NFT', 'http://example.com/']);
+
+  await deploy('SampleERC721CommonUpgradeableProxy', {
+    contract: 'TransparentUpgradeableProxy',
+    from: deployer,
+    log: true,
+    args: [logicContract.address, proxyAdmin, data],
+  });
+};
+
+deploy.tags = ['SampleERC721CommonUpgradeableProxy'];
+deploy.dependencies = ['VerifyContracts', 'ProxyAdmin', 'SampleERC721CommonUpgradeableLogic'];
+
+export default deploy;

src/ERC721Common.sol

@@ -1,18 +1,17 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.0;
 
-import "./refs/IERC721State.sol";
+import "./interfaces/IERC721State.sol";
+import "./interfaces/IERC721Common.sol";
 import "./refs/ERC721Nonce.sol";
 import "./ERC721PresetMinterPauserAutoIdCustomized.sol";
 
-abstract contract ERC721Common is ERC721Nonce, ERC721PresetMinterPauserAutoIdCustomized, IERC721State {
+abstract contract ERC721Common is ERC721Nonce, ERC721PresetMinterPauserAutoIdCustomized, IERC721State, IERC721Common {
   constructor(string memory name, string memory symbol, string memory baseTokenURI)
     ERC721PresetMinterPauserAutoIdCustomized(name, symbol, baseTokenURI)
-  {}
+  { }
 
-  /**
-   * @inheritdoc IERC721State
-   */
+  /// @inheritdoc IERC721State
   function stateOf(uint256 _tokenId) external view virtual override returns (bytes memory) {
     require(_exists(_tokenId), "ERC721Common: query for non-existent token");
     return abi.encodePacked(ownerOf(_tokenId), nonces[_tokenId], _tokenId);
@@ -41,7 +40,8 @@ abstract contract ERC721Common is ERC721Nonce, ERC721PresetMinterPauserAutoIdCus
     override(ERC721, ERC721PresetMinterPauserAutoIdCustomized)
     returns (bool)
   {
-    return super.supportsInterface(interfaceId);
+    return interfaceId == type(IERC721Common).interfaceId || interfaceId == type(IERC721State).interfaceId
+      || super.supportsInterface(interfaceId);
   }
 
   /**

src/ERC721PresetMinterPauserAutoIdCustomized.sol

@@ -8,6 +8,7 @@ import "../lib/openzeppelin-contracts/contracts/token/ERC721/extensions/ERC721Pa
 import "../lib/openzeppelin-contracts/contracts/access/AccessControlEnumerable.sol";
 import "../lib/openzeppelin-contracts/contracts/utils/Context.sol";
 import "../lib/openzeppelin-contracts/contracts/utils/Counters.sol";
+import "./interfaces/IERC721PresetMinterPauserAutoIdCustomized.sol";
 
 /**
  * @dev ERC721PresetMinterPauserAutoId is a customized version of
@@ -118,7 +119,8 @@ contract ERC721PresetMinterPauserAutoIdCustomized is
     override(AccessControlEnumerable, ERC721, ERC721Enumerable)
     returns (bool)
   {
-    return super.supportsInterface(interfaceId);
+    return
+      interfaceId == type(IERC721PresetMinterPauserAutoIdCustomized).interfaceId || super.supportsInterface(interfaceId);
   }
 
   /**

src/interfaces/IERC721Common.sol

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.0;
+
+interface IERC721Common {
+  /**
+   * @dev Bulk create new tokens for `_recipients`. Tokens ID will be automatically
+   * assigned (and available on the emitted {IERC721Upgradeable-Transfer} event), and the token
+   * URI autogenerated based on the base URI passed at construction.
+   *
+   * See {ERC721Upgradeable-_mint}.
+   *
+   * Requirements:
+   *
+   * - the caller must have the `MINTER_ROLE`.
+   */
+  function bulkMint(address[] calldata recipients) external returns (uint256[] memory tokenIds);
+}

src/interfaces/IERC721PresetMinterPauserAutoIdCustomized.sol

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.0;
+
+interface IERC721PresetMinterPauserAutoIdCustomized {
+  /**
+   * @dev Creates a new token for `to`. Its token ID will be automatically
+   * assigned (and available on the emitted {IERC721Upgradeable-Transfer} event), and the token
+   * URI autogenerated based on the base URI passed at construction.
+   *
+   * See {ERC721Upgradeable-_mint}.
+   *
+   * Requirements:
+   *
+   * - the caller must have the `MINTER_ROLE`.
+   */
+  function mint(address to) external returns (uint256 tokenId);
+
+  /**
+   * @dev Pauses all token transfers.
+   *
+   * See {ERC721PausableUpgradeable} and {PausableUpgradeable-_pause}.
+   *
+   * Requirements:
+   *
+   * - the caller must have the `PAUSER_ROLE`.
+   */
+  function pause() external;
+
+  /**
+   * @dev Unpauses all token transfers.
+   *
+   * See {ERC721PausableUpgradeable} and {PausableUpgradeable-_unpause}.
+   *
+   * Requirements:
+   *
+   * - the caller must have the `PAUSER_ROLE`.
+   */
+  function unpause() external;
+}

src/mock/SampleERC721Upgradeable.sol

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.0;
+
+import "../upgradeable/ERC721CommonUpgradeable.sol";
+
+contract SampleERC721Upgradeable is ERC721CommonUpgradeable {}

src/upgradeable/ERC721CommonUpgradeable.sol

@@ -0,0 +1,91 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.22;
+
+import { ERC721Upgradeable } from
+  "../../lib/openzeppelin-contracts-upgradeable/contracts/token/ERC721/ERC721Upgradeable.sol";
+import { IERC721State } from "../interfaces/IERC721State.sol";
+import { IERC721Common } from "../interfaces/IERC721Common.sol";
+import { ERC721NonceUpgradeable } from "./refs/ERC721NonceUpgradeable.sol";
+import { ERC721PresetMinterPauserAutoIdCustomizedUpgradeable } from
+  "./ERC721PresetMinterPauserAutoIdCustomizedUpgradeable.sol";
+
+abstract contract ERC721CommonUpgradeable is
+  ERC721NonceUpgradeable,
+  ERC721PresetMinterPauserAutoIdCustomizedUpgradeable,
+  IERC721State,
+  IERC721Common
+{
+  error ErrInvalidArrayLength();
+  error ErrNonExistentToken();
+
+  /**
+   * @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.
+   */
+  uint256[50] private __gap;
+
+  /// @custom:oz-upgrades-unsafe-allow constructor
+  constructor() {
+    _disableInitializers();
+  }
+
+  /// @inheritdoc IERC721State
+  function stateOf(uint256 tokenId) external view virtual override returns (bytes memory) {
+    if (!_exists(tokenId)) revert ErrNonExistentToken();
+    return abi.encodePacked(ownerOf(tokenId), nonces(tokenId), tokenId);
+  }
+
+  /// @inheritdoc IERC721Common
+  function bulkMint(address[] calldata recipients)
+    external
+    virtual
+    onlyRole(MINTER_ROLE)
+    returns (uint256[] memory tokenIds)
+  {
+    uint256 length = recipients.length;
+    if (length == 0) revert ErrInvalidArrayLength();
+    tokenIds = new uint256[](length);
+
+    for (uint256 i; i < length; ++i) {
+      tokenIds[i] = _mintFor(recipients[i]);
+    }
+  }
+
+  /**
+   * @dev Override `IERC165-supportsInterface`.
+   */
+  function supportsInterface(bytes4 interfaceId)
+    public
+    view
+    virtual
+    override(ERC721Upgradeable, ERC721PresetMinterPauserAutoIdCustomizedUpgradeable)
+    returns (bool)
+  {
+    return interfaceId == type(IERC721State).interfaceId || interfaceId == type(IERC721Common).interfaceId
+      || super.supportsInterface(interfaceId);
+  }
+
+  /**
+   * @dev Override `ERC721Upgradeable-_baseURI`.
+   */
+  function _baseURI()
+    internal
+    view
+    virtual
+    override(ERC721Upgradeable, ERC721PresetMinterPauserAutoIdCustomizedUpgradeable)
+    returns (string memory)
+  {
+    return super._baseURI();
+  }
+
+  /**
+   * @dev Override `ERC721PresetMinterPauserAutoIdCustomizedUpgradeable-_beforeTokenTransfer`.
+   */
+  function _beforeTokenTransfer(address from, address to, uint256 firstTokenId, uint256 batchSize)
+    internal
+    virtual
+    override(ERC721NonceUpgradeable, ERC721PresetMinterPauserAutoIdCustomizedUpgradeable)
+  {
+    super._beforeTokenTransfer(from, to, firstTokenId, batchSize);
+  }
+}