@towns-protocol/contracts 0.0.366 → 0.0.368

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@towns-protocol/contracts",
-  "version": "0.0.366",
+  "version": "0.0.368",
   "packageManager": "yarn@3.8.0",
   "scripts": {
     "build-types": "bash scripts/build-contract-types.sh",
@@ -35,7 +35,7 @@
     "@layerzerolabs/oapp-evm": "^0.3.2",
     "@openzeppelin/merkle-tree": "^1.0.8",
     "@prb/test": "^0.6.4",
-    "@towns-protocol/prettier-config": "^0.0.366",
+    "@towns-protocol/prettier-config": "^0.0.368",
     "@typechain/ethers-v5": "^11.1.2",
     "@wagmi/cli": "^2.2.0",
     "forge-std": "github:foundry-rs/forge-std#v1.10.0",
@@ -57,5 +57,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ed5b2f3718b5da967d60c30fc589bdf20568f992"
+  "gitHead": "bb014c92cd91d742be6ea53ac56027ec90e4d345"
 }

package/src/apps/facets/registry/AppRegistryBase.sol

@@ -137,7 +137,8 @@ abstract contract AppRegistryBase is IAppRegistryBase, SchemaBase, AttestationBa
             params.name,
             params.permissions,
             params.installPrice,
-            duration
+            duration,
+            params.client
         );
 
         version = _registerApp(ITownsApp(app), params.client);

package/src/apps/helpers/ISimpleApp.sol

@@ -14,6 +14,18 @@ interface ISimpleAppBase {
     /// @notice Thrown when there is no balance to withdraw
     error NoBalanceToWithdraw();
 
+    /// @notice Thrown when the currency address is the zero address
+    error InvalidAddressInput();
+
+    /// @notice Thrown when the amount is zero
+    error InvalidAmount();
+
+    /// @notice Thrown when the caller is not allowed
+    error InvalidCaller();
+
+    /// @notice Thrown when the currency is invalid
+    error InvalidCurrency();
+
     /// @notice Emitted when the app is withdrawn
     /// @param recipient The address that received the withdrawal
     /// @param amount The amount of tokens withdrawn
@@ -27,6 +39,12 @@ interface ISimpleAppBase {
     /// @notice Emitted when permissions are updated
     /// @param permissions The new permissions
     event PermissionsUpdated(bytes32[] permissions);
+
+    /// @notice Emitted when the currency is sent
+    /// @param recipient The address that received the currency
+    /// @param currency The currency that was sent
+    /// @param amount The amount of currency that was sent
+    event SendCurrency(address indexed recipient, address indexed currency, uint256 amount);
 }
 
 interface ISimpleApp is ISimpleAppBase {
@@ -34,6 +52,12 @@ interface ISimpleApp is ISimpleAppBase {
     /// @param recipient The address to withdraw the ETH to
     function withdrawETH(address recipient) external;
 
+    /// @notice Sends the currency balance of the app to the recipient
+    /// @param recipient The address to send the currency to
+    /// @param currency The currency to send
+    /// @param amount The amount of currency to send
+    function sendCurrency(address recipient, address currency, uint256 amount) external;
+
     /// @notice Updates the pricing of the app
     /// @param installPrice The new install price
     /// @param accessDuration The new access duration
@@ -54,6 +78,7 @@ interface ISimpleApp is ISimpleAppBase {
         string calldata appId,
         bytes32[] calldata permissions,
         uint256 installPrice,
-        uint48 accessDuration
+        uint48 accessDuration,
+        address client
     ) external;
 }

package/src/apps/helpers/SimpleApp.sol

@@ -28,7 +28,8 @@ contract SimpleApp is ISimpleApp, Ownable, BaseApp, Initializable {
         string calldata appId,
         bytes32[] calldata permissions,
         uint256 installPrice,
-        uint48 accessDuration
+        uint48 accessDuration,
+        address client
     ) external initializer {
         _setOwner(owner);
         SimpleAppStorage.Layout storage $ = SimpleAppStorage.getLayout();
@@ -36,6 +37,7 @@ contract SimpleApp is ISimpleApp, Ownable, BaseApp, Initializable {
         $.permissions = permissions;
         $.installPrice = installPrice;
         $.accessDuration = accessDuration;
+        $.client = client;
     }
 
     /// @inheritdoc ISimpleApp
@@ -50,6 +52,19 @@ contract SimpleApp is ISimpleApp, Ownable, BaseApp, Initializable {
         emit Withdrawal(recipient, balance);
     }
 
+    function sendCurrency(address recipient, address currency, uint256 amount) external {
+        _checkAllowed();
+
+        if (recipient == address(0)) ZeroAddress.selector.revertWith();
+        if (currency == address(0)) currency = CurrencyTransfer.NATIVE_TOKEN;
+        else if (currency.code.length == 0) InvalidCurrency.selector.revertWith();
+        if (amount == 0) InvalidAmount.selector.revertWith();
+
+        CurrencyTransfer.transferCurrency(currency, address(this), recipient, amount);
+
+        emit SendCurrency(recipient, currency, amount);
+    }
+
     /// @inheritdoc ISimpleApp
     function updatePricing(uint256 installPrice, uint48 accessDuration) external onlyOwner {
         SimpleAppStorage.Layout storage $ = SimpleAppStorage.getLayout();
@@ -99,4 +114,10 @@ contract SimpleApp is ISimpleApp, Ownable, BaseApp, Initializable {
     function _moduleOwner() internal view override returns (address) {
         return owner();
     }
+
+    function _checkAllowed() internal view {
+        if (msg.sender == owner()) return;
+        if (msg.sender == SimpleAppStorage.getLayout().client) return;
+        InvalidCaller.selector.revertWith();
+    }
 }

package/src/apps/helpers/SimpleAppStorage.sol

@@ -17,6 +17,7 @@ library SimpleAppStorage {
         bytes32[] permissions;
         uint256 installPrice;
         uint48 accessDuration;
+        address client;
     }
 
     function getLayout() internal pure returns (Layout storage l) {

package/src/spaces/facets/membership/MembershipBase.sol

@@ -20,19 +20,19 @@ abstract contract MembershipBase is IMembershipBase {
     using SafeTransferLib for address;
 
     function __MembershipBase_init(Membership memory info, address spaceFactory) internal {
-        MembershipStorage.Layout storage ds = MembershipStorage.layout();
+        MembershipStorage.Layout storage $ = MembershipStorage.layout();
 
-        ds.spaceFactory = spaceFactory;
-        ds.pricingModule = info.pricingModule;
-        ds.membershipCurrency = CurrencyTransfer.NATIVE_TOKEN;
-        ds.membershipMaxSupply = info.maxSupply;
+        $.spaceFactory = spaceFactory;
+        $.pricingModule = info.pricingModule;
+        $.membershipCurrency = CurrencyTransfer.NATIVE_TOKEN;
+        $.membershipMaxSupply = info.maxSupply;
 
         if (info.freeAllocation > 0) {
             _verifyFreeAllocation(info.freeAllocation);
-            ds.freeAllocation = info.freeAllocation;
+            $.freeAllocation = info.freeAllocation;
         }
 
-        ds.freeAllocationEnabled = true;
+        $.freeAllocationEnabled = true;
 
         if (info.price > 0) {
             _verifyPrice(info.price);
@@ -41,7 +41,7 @@ abstract contract MembershipBase is IMembershipBase {
 
         if (info.duration > 0) {
             _verifyDuration(info.duration);
-            ds.membershipDuration = info.duration;
+            $.membershipDuration = info.duration;
         }
     }
 
@@ -75,13 +75,13 @@ abstract contract MembershipBase is IMembershipBase {
     }
 
     function _transferIn(address from, uint256 amount) internal returns (uint256) {
-        MembershipStorage.Layout storage ds = MembershipStorage.layout();
+        MembershipStorage.Layout storage $ = MembershipStorage.layout();
 
         // get the currency being used for membership
         address currency = _getMembershipCurrency();
 
         if (currency == CurrencyTransfer.NATIVE_TOKEN) {
-            ds.tokenBalance += amount;
+            $.tokenBalance += amount;
             return amount;
         }
 
@@ -94,7 +94,7 @@ abstract contract MembershipBase is IMembershipBase {
         uint256 finalAmount = balanceAfter - balanceBefore;
         if (finalAmount != amount) Membership__InsufficientPayment.selector.revertWith();
 
-        ds.tokenBalance += finalAmount;
+        $.tokenBalance += finalAmount;
         return finalAmount;
     }
 
@@ -162,14 +162,12 @@ abstract contract MembershipBase is IMembershipBase {
     function _getMembershipPrice(
         uint256 totalSupply
     ) internal view virtual returns (uint256 membershipPrice) {
-        // get free allocation
-        uint256 freeAllocation = _getMembershipFreeAllocation();
         address pricingModule = _getPricingModule();
-
         IPlatformRequirements platform = _getPlatformRequirements();
-
         if (pricingModule == address(0)) return platform.getMembershipFee();
 
+        // get free allocation
+        uint256 freeAllocation = _getMembershipFreeAllocation();
         membershipPrice = IMembershipPricing(pricingModule).getPrice(freeAllocation, totalSupply);
         uint256 minPrice = platform.getMembershipMinPrice();
         if (membershipPrice < minPrice) return platform.getMembershipFee();
@@ -183,11 +181,11 @@ abstract contract MembershipBase is IMembershipBase {
         uint256 tokenId,
         uint256 totalSupply
     ) internal view returns (uint256) {
-        MembershipStorage.Layout storage ds = MembershipStorage.layout();
+        MembershipStorage.Layout storage $ = MembershipStorage.layout();
         IPlatformRequirements platform = _getPlatformRequirements();
 
         uint256 minFee = platform.getMembershipFee();
-        uint256 renewalPrice = ds.renewalPriceByTokenId[tokenId];
+        uint256 renewalPrice = $.renewalPriceByTokenId[tokenId];
 
         if (renewalPrice != 0) return FixedPointMathLib.max(renewalPrice, minFee);
 
@@ -207,16 +205,15 @@ abstract contract MembershipBase is IMembershipBase {
     }
 
     function _setMembershipFreeAllocation(uint256 newAllocation) internal {
-        MembershipStorage.Layout storage ds = MembershipStorage.layout();
-        ds.freeAllocation = newAllocation;
-        ds.freeAllocationEnabled = true;
+        MembershipStorage.Layout storage $ = MembershipStorage.layout();
+        ($.freeAllocation, $.freeAllocationEnabled) = (newAllocation, true);
         emit MembershipFreeAllocationUpdated(newAllocation);
     }
 
     function _getMembershipFreeAllocation() internal view returns (uint256) {
-        MembershipStorage.Layout storage ds = MembershipStorage.layout();
+        MembershipStorage.Layout storage $ = MembershipStorage.layout();
 
-        if (ds.freeAllocationEnabled) return ds.freeAllocation;
+        if ($.freeAllocationEnabled) return $.freeAllocation;
 
         return _getPlatformRequirements().getMembershipMintLimit();
     }

package/src/spaces/facets/membership/MembershipStorage.sol

@@ -31,10 +31,9 @@ library MembershipStorage {
         bool freeAllocationEnabled;
     }
 
-    function layout() internal pure returns (Layout storage l) {
-        bytes32 slot = STORAGE_SLOT;
+    function layout() internal pure returns (Layout storage $) {
         assembly {
-            l.slot := slot
+            $.slot := STORAGE_SLOT
         }
     }
 }

package/src/spaces/facets/membership/join/MembershipJoin.sol

@@ -74,7 +74,6 @@ abstract contract MembershipJoin is
         uint256 totalSupply = _totalSupply();
         uint256 membershipPrice = _getMembershipPrice(totalSupply);
         uint256 freeAllocation = _getMembershipFreeAllocation();
-        uint256 prepaidSupply = _getPrepaidSupply();
 
         joinDetails.basePrice = membershipPrice;
         if (freeAllocation > totalSupply) {
@@ -82,14 +81,14 @@ abstract contract MembershipJoin is
         }
 
         // Check if this is a free join due to prepaid supply
+        uint256 prepaidSupply = _getPrepaidSupply();
         if (prepaidSupply > 0) {
             joinDetails.isPrepaid = true;
             return joinDetails;
         }
 
         // Regular paid join
-        joinDetails.amountDue = membershipPrice;
-        joinDetails.shouldCharge = true;
+        (joinDetails.amountDue, joinDetails.shouldCharge) = (membershipPrice, true);
     }
 
     /// @notice Handles the process of joining a space
@@ -144,9 +143,7 @@ abstract contract MembershipJoin is
         }
 
         // Consume prepaid membership if applicable
-        if (joinDetails.isPrepaid) {
-            _reducePrepay(1);
-        }
+        if (joinDetails.isPrepaid) _reducePrepay(1);
 
         _validateUserReferral(receiver, referral);
 
@@ -186,10 +183,8 @@ abstract contract MembershipJoin is
     }
 
     function _validateUserReferral(address receiver, ReferralTypes memory referral) internal view {
-        if (referral.userReferral != address(0)) {
-            if (referral.userReferral == receiver || referral.userReferral == msg.sender) {
-                Membership__InvalidAddress.selector.revertWith();
-            }
+        if (referral.userReferral == receiver || referral.userReferral == msg.sender) {
+            Membership__InvalidAddress.selector.revertWith();
         }
     }