V0.6.2 - Improve Linear Pricing (#78)

* make list limit update check against uint32 max

* add refund mechanism + tests

* update const back to prod

* add verify package

* more packages

Author: kneelsdev

contracts/Archetype.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// Archetype v0.6.1
+// Archetype v0.6.2
 //
 //        d8888                 888               888
 //       d88888                 888               888
@@ -148,23 +148,38 @@ contract Archetype is
       });
     }
 
-    ArchetypeLogic.validateMint(invite, config, auth, _minted, signature, args);
+    uint128 cost = uint128(
+      ArchetypeLogic.computePrice(
+        invite,
+        config.discounts,
+        args.quantity,
+        args.listSupply,
+        args.affiliate != address(0)
+      )
+    );
+
+    ArchetypeLogic.validateMint(invite, config, auth, _minted, signature, args, cost);
 
     if (invite.limit < invite.maxSupply) {
       _minted[_msgSender()][auth.key] += quantity;
     }
-    if (invite.maxSupply < config.maxSupply) {
+    if (invite.maxSupply < UINT32_MAX) {
       _listSupply[auth.key] += quantity;
     }
+
     ArchetypeLogic.updateBalances(
       invite,
       config,
       _ownerBalance,
       _affiliateBalance,
-      args.listSupply,
       affiliate,
-      quantity
+      quantity,
+      cost
     );
+
+    if (msg.value > cost) {
+      _refund(_msgSender(), msg.value - cost);
+    }
   }
 
   function mintTo(
@@ -191,24 +206,40 @@ contract Archetype is
       });
     }
 
-    ArchetypeLogic.validateMint(i, config, auth, _minted, signature, args);
+    uint128 cost = uint128(
+      ArchetypeLogic.computePrice(
+        i,
+        config.discounts,
+        args.quantity,
+        args.listSupply,
+        args.affiliate != address(0)
+      )
+    );
+
+    ArchetypeLogic.validateMint(i, config, auth, _minted, signature, args, cost);
+
     _mint(to, quantity);
 
     if (i.limit < i.maxSupply) {
       _minted[_msgSender()][auth.key] += quantity;
     }
-    if (i.maxSupply < config.maxSupply) {
+    if (i.maxSupply < UINT32_MAX) {
       _listSupply[auth.key] += quantity;
     }
+
     ArchetypeLogic.updateBalances(
       i,
       config,
       _ownerBalance,
       _affiliateBalance,
-      args.listSupply,
       affiliate,
-      quantity
+      quantity,
+      cost
     );
+
+    if (msg.value > cost) {
+      _refund(_msgSender(), msg.value - cost);
+    }
   }
 
   function burnToMint(uint256[] calldata tokenIds) external {
@@ -289,8 +320,8 @@ contract Archetype is
     bool affiliateUsed
   ) external view returns (uint256) {
     DutchInvite storage i = invites[key];
-    uint256 listSupply = _listSupply[key];
-    return ArchetypeLogic.computePrice(i, config.discounts, quantity, listSupply, affiliateUsed);
+    uint256 listSupply_ = _listSupply[key];
+    return ArchetypeLogic.computePrice(i, config.discounts, quantity, listSupply_, affiliateUsed);
   }
 
   //
@@ -512,6 +543,13 @@ contract Archetype is
     _;
   }
 
+  function _refund(address to, uint256 refund) internal {
+    (bool success, ) = payable(to).call{ value: refund }("");
+    if (!success) {
+      revert TransferFailed();
+    }
+  }
+
   // OPTIONAL ROYALTY ENFORCEMENT WITH OPENSEA
   function enableRoyaltyEnforcement() external _onlyOwner {
     if (options.royaltyEnforcementLocked) {

contracts/ArchetypeLogic.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// ArchetypeLogic v0.6.1
+// ArchetypeLogic v0.6.2
 //
 //        d8888                 888               888
 //       d88888                 888               888
@@ -138,6 +138,7 @@ struct ValidationArgs {
 address constant PLATFORM = 0x86B82972282Dd22348374bC63fd21620F7ED847B;
 address constant BATCH = 0x6Bc558A6DC48dEfa0e7022713c23D65Ab26e4Fa7;
 uint16 constant MAXBPS = 5000; // max fee or discount is 50%
+uint32 constant UINT32_MAX = 2**32 - 1;
 
 library ArchetypeLogic {
   //
@@ -205,7 +206,8 @@ library ArchetypeLogic {
     Auth calldata auth,
     mapping(address => mapping(bytes32 => uint256)) storage minted,
     bytes calldata signature,
-    ValidationArgs memory args
+    ValidationArgs memory args,
+    uint128 cost
   ) public view {
     address msgSender = _msgSender();
     if (args.affiliate != address(0)) {
@@ -262,14 +264,6 @@ library ArchetypeLogic {
       revert MaxSupplyExceeded();
     }
 
-    uint256 cost = computePrice(
-      i,
-      config.discounts,
-      args.quantity,
-      args.listSupply,
-      args.affiliate != address(0)
-    );
-
     if (i.tokenAddress != address(0)) {
       IERC20Upgradeable erc20Token = IERC20Upgradeable(i.tokenAddress);
       if (erc20Token.allowance(msgSender, address(this)) < cost) {
@@ -287,10 +281,6 @@ library ArchetypeLogic {
       if (msg.value < cost) {
         revert InsufficientEthSent();
       }
-
-      if (msg.value > cost) {
-        revert ExcessiveEthSent();
-      }
     }
   }
 
@@ -356,17 +346,11 @@ library ArchetypeLogic {
     Config storage config,
     mapping(address => OwnerBalance) storage _ownerBalance,
     mapping(address => mapping(address => uint128)) storage _affiliateBalance,
-    uint256 listSupply,
     address affiliate,
-    uint256 quantity
+    uint256 quantity,
+    uint128 value
   ) public {
     address tokenAddress = i.tokenAddress;
-    uint128 value = uint128(msg.value);
-    if (tokenAddress != address(0)) {
-      value = uint128(
-        computePrice(i, config.discounts, quantity, listSupply, affiliate != address(0))
-      );
-    }
 
     uint128 affiliateWad;
     if (affiliate != address(0)) {

hardhat.config.ts

@@ -5,7 +5,7 @@ import "solidity-coverage";
 import "@openzeppelin/hardhat-upgrades";
 import "@nomiclabs/hardhat-web3";
 import "@nomiclabs/hardhat-ethers";
-import "@nomiclabs/hardhat-etherscan";
+import "@nomicfoundation/hardhat-verify";
 import "@nomiclabs/hardhat-truffle5";
 import "@nomiclabs/hardhat-waffle";
 import "@typechain/hardhat";