fix: add totalSupply, bump hardhat-upgrades version (#94)

contracts/token/IZNSDomainToken.sol

@@ -34,6 +34,8 @@ interface IZNSDomainToken is IERC2981Upgradeable, IERC721Upgradeable {
         uint96 defaultRoyaltyFraction
     ) external;
 
+    function totalSupply() external view returns (uint256);
+
     function register(
         address to,
         uint256 tokenId,

contracts/token/ZNSDomainToken.sol

@@ -29,6 +29,11 @@ contract ZNSDomainToken is
     */
     string private baseURI;
 
+    /**
+     * @dev Total supply of all tokens
+     */
+    uint256 private _totalSupply;
+
     /// @custom:oz-upgrades-unsafe-allow constructor
     constructor() {
         _disableInitializers();
@@ -55,6 +60,13 @@ contract ZNSDomainToken is
         _setDefaultRoyalty(defaultRoyaltyReceiver, defaultRoyaltyFraction);
     }
 
+    /**
+     * @notice Returns the total supply of all tokens
+     */
+    function totalSupply() external view override returns (uint256) {
+        return _totalSupply;
+    }
+
     /**
      * @notice Mints a token with a specified tokenId, using _safeMint, and sends it to the given address.
      * Used ONLY as a part of the Register flow that starts from `ZNSRootRegistrar.registerRootDomain()`
@@ -65,6 +77,7 @@ contract ZNSDomainToken is
      * @param _tokenURI The tokenURI to be set for the token minted.
      */
     function register(address to, uint256 tokenId, string memory _tokenURI) external override onlyRegistrar {
+        ++_totalSupply;
         _safeMint(to, tokenId);
         _setTokenURI(tokenId, _tokenURI);
     }
@@ -85,7 +98,7 @@ contract ZNSDomainToken is
     function tokenURI(uint256 tokenId)
     public
     view
-    override(ERC721Upgradeable, ERC721URIStorageUpgradeable, IZNSDomainToken)
+    override(ERC721URIStorageUpgradeable, ERC721Upgradeable, IZNSDomainToken)
     returns (string memory)
     {
         return super.tokenURI(tokenId);
@@ -168,9 +181,10 @@ contract ZNSDomainToken is
      */
     function _burn(uint256 tokenId)
     internal
-    override(ERC721Upgradeable, ERC721URIStorageUpgradeable)
+    override(ERC721URIStorageUpgradeable, ERC721Upgradeable)
     {
         super._burn(tokenId);
+        --_totalSupply;
     }
 
     /**

package.json

@@ -51,7 +51,7 @@
     "@openzeppelin/contracts-upgradeable": "4.9.3",
     "@openzeppelin/contracts-upgradeable-400": "npm:@openzeppelin/[email protected]",
     "@openzeppelin/defender-sdk": "^1.7.0",
-    "@openzeppelin/hardhat-upgrades": "2.4.3",
+    "@openzeppelin/hardhat-upgrades": "2.5.0",
     "@semantic-release/git": "^10.0.1",
     "@tenderly/hardhat-tenderly": "^2.0.1",
     "@typechain/ethers-v6": "^0.5.1",

test/DeployCampaign.integration.test.ts

@@ -73,7 +73,6 @@ describe("DeployCampaign - Integration", () => {
 
     let deployer;
     let provider;
-    let zeroVaultAddress;
 
     if (hre.network.name === "hardhat") {
       deployer = deployAdmin;

test/ZNSDomainToken.test.ts

@@ -100,6 +100,34 @@ describe("ZNSDomainToken", () => {
       expect(await zns.domainToken.ownerOf(tokenId)).to.equal(caller.address);
     });
 
+    it("Should increment the totalSupply when a domain is registered", async () => {
+      const tokenId = BigInt("1");
+
+      const supplyBefore = await zns.domainToken.totalSupply();
+
+      await zns.domainToken
+        .connect(mockRegistrar)
+        .register(caller.address, tokenId, randomTokenURI);
+
+      const supplyAfter = await zns.domainToken.totalSupply();
+      expect(supplyAfter).to.equal(supplyBefore + BigInt(1));
+    });
+
+    it("Should decrement the totalSupply when a domain is revoked", async () => {
+      const tokenId = BigInt("1");
+
+      const supplyBefore = await zns.domainToken.totalSupply();
+
+      await zns.domainToken
+        .connect(mockRegistrar)
+        .register(caller.address, tokenId, randomTokenURI);
+
+      await zns.domainToken.connect(mockRegistrar).revoke(tokenId);
+
+      const supplyAfter = await zns.domainToken.totalSupply();
+      expect(supplyAfter).to.equal(supplyBefore);
+    });
+
     it("Should revert when registering (minting) if caller does not have REGISTRAR_ROLE", async () => {
       const tokenId = BigInt("1");
       await expect(

test/gas/gas-costs.json

@@ -1,4 +1,4 @@
 {
-	"Root Domain Price": "469205",
-	"Subdomain Price": "462907"
+	"Root Domain Price": "475352",
+	"Subdomain Price": "469054"
 }

test/helpers/register-setup.ts

@@ -10,6 +10,7 @@ import { getDomainHashFromEvent } from "./events";
 import { distrConfigEmpty, fullDistrConfigEmpty, DEFAULT_TOKEN_URI, paymentConfigEmpty } from "./constants";
 import { getTokenContract } from "./tokens";
 import { ICurvePriceConfig } from "../../src/deploy/missions/types";
+import { expect } from "chai";
 
 const { ZeroAddress } = ethers;
 
@@ -29,6 +30,8 @@ export const defaultRootRegistration = async ({
   tokenURI ?: string;
   distrConfig ?: IDistributionConfig;
 }) : Promise<ContractTransactionReceipt | null> => {
+  const supplyBefore = await zns.domainToken.totalSupply();
+
   const tx = await zns.rootRegistrar.connect(user).registerRootDomain(
     domainName,
     domainContent, // Arbitrary address value
@@ -37,6 +40,9 @@ export const defaultRootRegistration = async ({
     paymentConfigEmpty
   );
 
+  const supplyAfter = await zns.domainToken.totalSupply();
+  expect(supplyAfter).to.equal(supplyBefore + BigInt(1));
+
   return tx.wait();
 };
 
@@ -92,6 +98,8 @@ export const defaultSubdomainRegistration = async ({
   tokenURI ?: string;
   distrConfig : IDistributionConfig;
 }) => {
+  const supplyBefore = await zns.domainToken.totalSupply();
+
   const tx = await zns.subRegistrar.connect(user).registerSubdomain(
     parentHash,
     subdomainLabel,
@@ -101,6 +109,9 @@ export const defaultSubdomainRegistration = async ({
     paymentConfigEmpty
   );
 
+  const supplyAfter = await zns.domainToken.totalSupply();
+  expect(supplyAfter).to.equal(supplyBefore + BigInt(1));
+
   return tx.wait();
 };