feat(passport): add referral tracking

Signed-off-by: Chris Lahaye <[email protected]>

contracts/passport/BaseV1.sol

@@ -13,10 +13,11 @@ contract BaseV1 is ERC165Upgradeable, GatewayV1Axelar, GatewayV1Call, IBaseV1 {
     uint256 public maxSupply;
 
     uint256 private _tokenIdCounter;
-    mapping(address => uint256) private _tokens;
-
     uint256 private _totalReservations;
+
+    mapping(address => uint256) private _referrals;
     mapping(address => uint256) private _reservations;
+    mapping(address => uint256) private _tokens;
 
     mapping(uint256 => address) private _owners;
     mapping(uint256 => bytes32) private _networks;
@@ -59,7 +60,9 @@ contract BaseV1 is ERC165Upgradeable, GatewayV1Axelar, GatewayV1Call, IBaseV1 {
     function grant(
         Assignment[] calldata assignments
     ) public onlyRole(DEFAULT_ADMIN_ROLE) {
-        if (!_tryReserve(assignments)) {
+        (bool success, ) = _tryReserve(assignments);
+
+        if (!success) {
             revert Forbidden();
         }
     }
@@ -90,6 +93,12 @@ contract BaseV1 is ERC165Upgradeable, GatewayV1Axelar, GatewayV1Call, IBaseV1 {
         }
     }
 
+    function referrals(
+        address referrer
+    ) public view override returns (uint256) {
+        return _referrals[referrer];
+    }
+
     function reservations(
         address owner
     ) public view override returns (uint256) {
@@ -228,10 +237,6 @@ contract BaseV1 is ERC165Upgradeable, GatewayV1Axelar, GatewayV1Call, IBaseV1 {
         (uint256 purchaseId, address sender, address payable referrer) = abi
             .decode(params, (uint256, address, address));
 
-        if (_tokens[referrer] == 0) {
-            delete referrer;
-        }
-
         bool success;
         uint256 tokenId = _tokenIdCounter;
 
@@ -246,6 +251,14 @@ contract BaseV1 is ERC165Upgradeable, GatewayV1Axelar, GatewayV1Call, IBaseV1 {
             }
         }
 
+        if (_tokens[referrer] == 0) {
+            delete referrer;
+        } else if (success) {
+            unchecked {
+                ++_referrals[referrer];
+            }
+        }
+
         emit ExecutePurchase(
             network,
             purchaseId,
@@ -271,7 +284,11 @@ contract BaseV1 is ERC165Upgradeable, GatewayV1Axelar, GatewayV1Call, IBaseV1 {
             Assignment[] memory assignments
         ) = abi.decode(params, (uint256, address, Assignment[]));
 
-        bool success = _tryReserve(assignments);
+        (bool success, uint256 count) = _tryReserve(assignments);
+
+        if (success) {
+            _referrals[sender] += count;
+        }
 
         emit ExecuteReserve(network, paymentId, sender, assignments, success);
 
@@ -361,18 +378,16 @@ contract BaseV1 is ERC165Upgradeable, GatewayV1Axelar, GatewayV1Call, IBaseV1 {
 
     function _tryReserve(
         Assignment[] memory assignments
-    ) internal returns (bool success) {
+    ) internal returns (bool success, uint256) {
         uint256 totalReservations_ = _totalReservations +
             countAssignments(assignments);
 
         if (totalReservations_ + totalSupply() > maxSupply) {
-            return false;
+            return (false, 0);
         }
 
         _totalReservations = totalReservations_;
 
-        _increaseReservations(assignments);
-
-        return true;
+        return (true, _increaseReservations(assignments));
     }
 }

contracts/passport/IBaseV1.sol

@@ -45,6 +45,8 @@ interface IBaseV1 is IERC165Upgradeable {
 
     function ownerOf(uint256 tokenId) external view returns (address owner);
 
+    function referrals(address referrer) external view returns (uint256);
+
     function reservations(address owner) external view returns (uint256);
 
     function token(address owner) external view returns (uint256);

test/Passport.ts

@@ -413,6 +413,12 @@ describe('Passport', () => {
 
         expect(await baseV1.reservations(signers[5].address)).to.eq(0);
       });
+
+      it('should have referrals', async () => {
+        const { signers, baseV1 } = await loadFixture(deployFixture);
+
+        expect(await baseV1.referrals(signers[5].address)).to.eq(2);
+      });
     });
 
     describe('signer 6', () => {