@towns-protocol/contracts 0.0.375 → 0.0.377

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@towns-protocol/contracts",
-  "version": "0.0.375",
+  "version": "0.0.377",
   "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.375",
+    "@towns-protocol/prettier-config": "^0.0.377",
     "@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": "f64537fbf8d7eca815c5c5e52f601a387e713a0a"
+  "gitHead": "a289c507ab3ae080d0b07e9f881743223580fdf4"
 }

package/scripts/deployments/diamonds/DeployAppRegistry.s.sol

@@ -13,6 +13,8 @@ import {LibString} from "solady/utils/LibString.sol";
 import {DeployMetadata} from "../facets/DeployMetadata.s.sol";
 import {DeployAppRegistryFacet} from "../facets/DeployAppRegistryFacet.s.sol";
 import {DeployUpgradeableBeacon} from "../facets/DeployUpgradeableBeacon.s.sol";
+import {DeployAppInstallerFacet} from "../facets/DeployAppInstallerFacet.s.sol";
+import {DeploySpaceFactory} from "../diamonds/DeploySpaceFactory.s.sol";
 
 // contracts
 import {Diamond} from "@towns-protocol/diamond/src/Diamond.sol";
@@ -26,29 +28,19 @@ import {Deployer} from "../../common/Deployer.s.sol";
 contract DeployAppRegistry is IDiamondInitHelper, DiamondHelper, Deployer {
     using LibString for string;
 
-    address private SPACE_FACTORY;
-
     DeployFacet private facetHelper = new DeployFacet();
+    DeploySpaceFactory private deploySpaceFactory = new DeploySpaceFactory();
 
     string internal constant APP_REGISTRY_SCHEMA = "address app, address client";
+    address internal spaceFactory;
 
     function versionName() public pure override returns (string memory) {
         return "appRegistry";
     }
 
-    function setSpaceFactory(address factory) public {
-        SPACE_FACTORY = factory;
-    }
-
-    function getSpaceFactory() public returns (address) {
-        if (SPACE_FACTORY != address(0)) {
-            return SPACE_FACTORY;
-        }
-
-        return getDeployment("spaceFactory");
-    }
-
     function addImmutableCuts(address deployer) internal {
+        spaceFactory = deploySpaceFactory.deploy(deployer);
+
         // Queue up all core facets for batch deployment
         facetHelper.add("DiamondCutFacet");
         facetHelper.add("DiamondLoupeFacet");
@@ -94,6 +86,7 @@ contract DeployAppRegistry is IDiamondInitHelper, DiamondHelper, Deployer {
         facetHelper.add("MetadataFacet");
         facetHelper.add("UpgradeableBeaconFacet");
         facetHelper.add("AppRegistryFacet");
+        facetHelper.add("AppInstallerFacet");
         facetHelper.add("SimpleApp");
 
         facetHelper.deployBatch(deployer);
@@ -118,7 +111,14 @@ contract DeployAppRegistry is IDiamondInitHelper, DiamondHelper, Deployer {
         addFacet(
             makeCut(facet, FacetCutAction.Add, DeployAppRegistryFacet.selectors()),
             facet,
-            DeployAppRegistryFacet.makeInitData(getSpaceFactory(), APP_REGISTRY_SCHEMA, address(0))
+            DeployAppRegistryFacet.makeInitData(spaceFactory, APP_REGISTRY_SCHEMA, address(0))
+        );
+
+        facet = facetHelper.getDeployedAddress("AppInstallerFacet");
+        addFacet(
+            makeCut(facet, FacetCutAction.Add, DeployAppInstallerFacet.selectors()),
+            facet,
+            DeployAppInstallerFacet.makeInitData()
         );
 
         address multiInit = facetHelper.getDeployedAddress("MultiInit");
@@ -150,6 +150,9 @@ contract DeployAppRegistry is IDiamondInitHelper, DiamondHelper, Deployer {
             if (facetName.eq("AppRegistryFacet")) {
                 addCut(makeCut(facet, FacetCutAction.Add, DeployAppRegistryFacet.selectors()));
             }
+            if (facetName.eq("AppInstallerFacet")) {
+                addCut(makeCut(facet, FacetCutAction.Add, DeployAppInstallerFacet.selectors()));
+            }
         }
 
         return baseFacets();

package/scripts/deployments/facets/DeployAppInstallerFacet.s.sol

@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.23;
+
+//interfaces
+import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
+
+//libraries
+
+//contracts
+import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
+import {AppInstallerFacet} from "src/apps/facets/installer/AppInstallerFacet.sol";
+import {DynamicArrayLib} from "solady/utils/DynamicArrayLib.sol";
+
+library DeployAppInstallerFacet {
+    using DynamicArrayLib for DynamicArrayLib.DynamicArray;
+
+    function selectors() internal pure returns (bytes4[] memory res) {
+        DynamicArrayLib.DynamicArray memory arr = DynamicArrayLib.p().reserve(4);
+        arr.p(AppInstallerFacet.installApp.selector);
+        arr.p(AppInstallerFacet.uninstallApp.selector);
+        arr.p(AppInstallerFacet.updateApp.selector);
+        arr.p(AppInstallerFacet.renewApp.selector);
+        bytes32[] memory selectors_ = arr.asBytes32Array();
+        assembly ("memory-safe") {
+            res := selectors_
+        }
+    }
+
+    function makeCut(
+        address facetAddress,
+        IDiamond.FacetCutAction action
+    ) internal pure returns (IDiamond.FacetCut memory) {
+        return
+            IDiamond.FacetCut({
+                action: action,
+                facetAddress: facetAddress,
+                functionSelectors: selectors()
+            });
+    }
+
+    function makeInitData() internal pure returns (bytes memory) {
+        return abi.encodeCall(AppInstallerFacet.__AppInstaller_init, ());
+    }
+
+    function deploy() internal returns (address) {
+        return LibDeploy.deployCode("AppInstallerFacet.sol", "");
+    }
+}

package/scripts/deployments/facets/DeployAppRegistryFacet.s.sol

@@ -16,7 +16,7 @@ library DeployAppRegistryFacet {
     using DynamicArrayLib for DynamicArrayLib.DynamicArray;
 
     function selectors() internal pure returns (bytes4[] memory res) {
-        DynamicArrayLib.DynamicArray memory arr = DynamicArrayLib.p().reserve(18);
+        DynamicArrayLib.DynamicArray memory arr = DynamicArrayLib.p().reserve(14);
         arr.p(AppRegistryFacet.getAppSchema.selector);
         arr.p(AppRegistryFacet.getAppSchemaId.selector);
         arr.p(AppRegistryFacet.getAppById.selector);
@@ -25,16 +25,12 @@ library DeployAppRegistryFacet {
         arr.p(AppRegistryFacet.removeApp.selector);
         arr.p(AppRegistryFacet.createApp.selector);
         arr.p(AppRegistryFacet.upgradeApp.selector);
-        arr.p(AppRegistryFacet.installApp.selector);
-        arr.p(AppRegistryFacet.uninstallApp.selector);
-        arr.p(AppRegistryFacet.updateApp.selector);
         arr.p(AppRegistryFacet.getAppPrice.selector);
         arr.p(AppRegistryFacet.getAppDuration.selector);
         arr.p(AppRegistryFacet.adminRegisterAppSchema.selector);
         arr.p(AppRegistryFacet.adminBanApp.selector);
         arr.p(AppRegistryFacet.isAppBanned.selector);
         arr.p(AppRegistryFacet.getAppByClient.selector);
-        arr.p(AppRegistryFacet.renewApp.selector);
         bytes32[] memory selectors_ = arr.asBytes32Array();
         assembly ("memory-safe") {
             res := selectors_

package/src/apps/facets/installer/AppInstallerFacet.sol

@@ -0,0 +1,66 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.29;
+
+// interfaces
+import {ITownsApp} from "../../ITownsApp.sol";
+import {IAppAccount} from "../../../spaces/facets/account/IAppAccount.sol";
+import {IAppInstaller} from "./IAppInstaller.sol";
+
+// libraries
+
+// contracts
+import {Facet} from "@towns-protocol/diamond/src/facets/Facet.sol";
+import {AppRegistryBase} from "../registry/AppRegistryBase.sol";
+import {ReentrancyGuardTransient} from "solady/utils/ReentrancyGuardTransient.sol";
+
+/// @title AppInstallerFacet
+/// @author Towns Protocol
+/// @notice Facet for installing apps to spaces
+contract AppInstallerFacet is IAppInstaller, AppRegistryBase, ReentrancyGuardTransient, Facet {
+    function __AppInstaller_init() external onlyInitializing {
+        _addInterface(type(IAppInstaller).interfaceId);
+    }
+
+    /// @notice Install an app
+    /// @param app The app address to install
+    /// @param space The space to install the app to
+    /// @param data The data to pass to the app's onInstall function
+    function installApp(
+        ITownsApp app,
+        IAppAccount space,
+        bytes calldata data
+    ) external payable nonReentrant onlyAllowed(space) {
+        _installApp(address(app), address(space), data);
+    }
+
+    /// @notice Uninstall an app
+    /// @param app The app address to uninstall
+    /// @param space The space to uninstall the app from
+    /// @param data The data to pass to the app's onUninstall function
+    function uninstallApp(
+        ITownsApp app,
+        IAppAccount space,
+        bytes calldata data
+    ) external nonReentrant onlyAllowed(space) {
+        _uninstallApp(address(app), address(space), data);
+    }
+
+    /// @notice Update an app to the latest version
+    /// @param app The app address to update
+    /// @param space The space to update the app to
+    function updateApp(ITownsApp app, IAppAccount space) external nonReentrant onlyAllowed(space) {
+        _updateApp(address(app), address(space));
+    }
+
+    /// @notice Renew an app
+    /// @param app The app address to renew
+    /// @param space The space to renew the app for
+    /// @param data The data to pass to the app's onRenewApp function
+    function renewApp(
+        ITownsApp app,
+        IAppAccount space,
+        bytes calldata data
+    ) external payable nonReentrant onlyAllowed(space) {
+        _renewApp(address(app), address(space), data);
+    }
+}

package/src/apps/facets/installer/IAppInstaller.sol

@@ -0,0 +1,35 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.29;
+
+// interfaces
+import {ITownsApp} from "../../ITownsApp.sol";
+import {IAppAccount} from "../../../spaces/facets/account/IAppAccount.sol";
+
+// libraries
+
+// contracts
+
+interface IAppInstaller {
+    /// @notice Install an app
+    /// @param app The app address to install
+    /// @param account The account to install the app to
+    /// @param data The data to pass to the app's onInstall function
+    function installApp(ITownsApp app, IAppAccount account, bytes calldata data) external payable;
+
+    /// @notice Uninstall an app
+    /// @param app The app address to uninstall
+    /// @param account The account to uninstall the app from
+    /// @param data The data to pass to the app's onUninstall function
+    function uninstallApp(ITownsApp app, IAppAccount account, bytes calldata data) external;
+
+    /// @notice Update an app to the latest version
+    /// @param app The app address to update
+    /// @param account The account to update the app to
+    function updateApp(ITownsApp app, IAppAccount account) external;
+
+    /// @notice Renew an app
+    /// @param app The app address to renew
+    /// @param account The account to renew the app for
+    /// @param data The data to pass to the app's onRenewApp function
+    function renewApp(ITownsApp app, IAppAccount account, bytes calldata data) external payable;
+}

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

@@ -35,6 +35,11 @@ abstract contract AppRegistryBase is IAppRegistryBase, SchemaBase, AttestationBa
 
     uint48 private constant MAX_DURATION = 365 days;
 
+    modifier onlyAllowed(IAppAccount account) {
+        if (IERC173(address(account)).owner() != msg.sender) NotAllowed.selector.revertWith();
+        _;
+    }
+
     function __AppRegistry_init_unchained(
         address spaceFactory,
         string calldata schema,
@@ -321,10 +326,6 @@ abstract contract AppRegistryBase is IAppRegistryBase, SchemaBase, AttestationBa
         emit AppRenewed(app, account, appId);
     }
 
-    function _onlyAllowed(address account) internal view {
-        if (IERC173(account).owner() != msg.sender) NotAllowed.selector.revertWith();
-    }
-
     function _getProtocolFee(uint256 installPrice) internal view returns (uint256) {
         IPlatformRequirements platform = _getPlatformRequirements();
         uint256 baseFee = platform.getMembershipFee();

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

@@ -16,6 +16,9 @@ import {Facet} from "@towns-protocol/diamond/src/facets/Facet.sol";
 import {ReentrancyGuard} from "solady/utils/ReentrancyGuard.sol";
 import {OwnableBase} from "@towns-protocol/diamond/src/facets/ownable/OwnableBase.sol";
 
+/// @title AppRegistryFacet
+/// @author Towns Protocol
+/// @notice Facet for managing app registry
 contract AppRegistryFacet is IAppRegistry, AppRegistryBase, OwnableBase, ReentrancyGuard, Facet {
     function __AppRegistry_init(
         address spaceFactory,
@@ -95,53 +98,6 @@ contract AppRegistryFacet is IAppRegistry, AppRegistryBase, OwnableBase, Reentra
     /*                        Space Functions                     */
     /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
 
-    /// @notice Install an app
-    /// @param app The app address to install
-    /// @param space The space to install the app to
-    /// @param data The data to pass to the app's onInstall function
-    function installApp(
-        ITownsApp app,
-        IAppAccount space,
-        bytes calldata data
-    ) external payable nonReentrant {
-        _onlyAllowed(address(space));
-        return _installApp(address(app), address(space), data);
-    }
-
-    /// @notice Uninstall an app
-    /// @param app The app address to uninstall
-    /// @param space The space to uninstall the app from
-    /// @param data The data to pass to the app's onUninstall function
-    function uninstallApp(
-        ITownsApp app,
-        IAppAccount space,
-        bytes calldata data
-    ) external nonReentrant {
-        _onlyAllowed(address(space));
-        _uninstallApp(address(app), address(space), data);
-    }
-
-    /// @notice Update an app to the latest version
-    /// @param app The app address to update
-    /// @param space The space to update the app to
-    function updateApp(ITownsApp app, IAppAccount space) external nonReentrant {
-        _onlyAllowed(address(space));
-        _updateApp(address(app), address(space));
-    }
-
-    /// @notice Renew an app
-    /// @param app The app address to renew
-    /// @param account The account to renew the app for
-    /// @param data The data to pass to the app's onRenewApp function
-    function renewApp(
-        ITownsApp app,
-        IAppAccount account,
-        bytes calldata data
-    ) external payable nonReentrant {
-        _onlyAllowed(address(account));
-        _renewApp(address(app), address(account), data);
-    }
-
     /// @notice Get the schema structure used for registering modules
     /// @return The schema structure
     function getAppSchema() external view returns (string memory) {

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

@@ -140,29 +140,6 @@ interface IAppRegistry is IAppRegistryBase {
     /// @param appId The app ID to remove
     function removeApp(bytes32 appId) external;
 
-    /// @notice Renew an app
-    /// @param app The app address to renew
-    /// @param account The account to renew the app for
-    /// @param data The data to pass to the app's onRenewApp function
-    function renewApp(ITownsApp app, IAppAccount account, bytes calldata data) external payable;
-
-    /// @notice Install an app
-    /// @param app The app address to install
-    /// @param account The account to install the app to
-    /// @param data The data to pass to the app's onInstall function
-    function installApp(ITownsApp app, IAppAccount account, bytes calldata data) external payable;
-
-    /// @notice Uninstall an app
-    /// @param app The app address to uninstall
-    /// @param account The account to uninstall the app from
-    /// @param data The data to pass to the app's onUninstall function
-    function uninstallApp(ITownsApp app, IAppAccount account, bytes calldata data) external;
-
-    /// @notice Update an app to the latest version
-    /// @param app The app address to update
-    /// @param account The account to update the app to
-    function updateApp(ITownsApp app, IAppAccount account) external;
-
     /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
     /*                           Admin                            */
     /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/

package/src/spaces/facets/Entitled.sol

@@ -14,13 +14,13 @@ import {CustomRevert} from "../../utils/libraries/CustomRevert.sol";
 import {EntitlementsManagerStorage} from "./entitlements/EntitlementsManagerStorage.sol";
 import {MembershipStorage} from "./membership/MembershipStorage.sol";
 import {BanningStorage} from "./banning/BanningStorage.sol";
-import {AppAccountStorage} from "./account/AppAccountStorage.sol";
+import {AppAccountBase} from "./account/AppAccountBase.sol";
 import {DependencyLib} from "./DependencyLib.sol";
 
 // contracts
 import {TokenOwnableBase} from "@towns-protocol/diamond/src/facets/ownable/token/TokenOwnableBase.sol";
 
-abstract contract Entitled is IEntitlementBase, TokenOwnableBase {
+abstract contract Entitled is IEntitlementBase, TokenOwnableBase, AppAccountBase {
     using EnumerableSet for EnumerableSet.AddressSet;
     using EnumerableSet for EnumerableSet.UintSet;
     using CustomRevert for bytes4;
@@ -135,7 +135,7 @@ abstract contract Entitled is IEntitlementBase, TokenOwnableBase {
         address app = DependencyLib.getAppRegistry().getAppByClient(client);
         if (app == address(0)) return false;
 
-        return AppAccountStorage.isAppEntitled(app, client, permission);
+        return _isAppEntitled(app, client, permission);
     }
 
     function _hasAnyBannedWallet(address[] memory wallets) internal view returns (bool) {

package/src/spaces/facets/account/AppAccountBase.sol

@@ -241,7 +241,27 @@ abstract contract AppAccountBase is
         address client,
         bytes32 permission
     ) internal view returns (bool) {
-        return AppAccountStorage.isAppEntitled(module, client, permission);
+        bytes32 appId = AppAccountStorage.getLayout().appIdByApp[module];
+        if (appId == EMPTY_UID) return false;
+
+        IAppRegistry registry = DependencyLib.getAppRegistry();
+        if (registry.isAppBanned(module)) return false;
+
+        IAppRegistry.App memory app = registry.getAppById(appId);
+        if (app.appId == EMPTY_UID) return false;
+
+        (bool hasClientAccess, , bool isGroupActive) = ExecutorStorage.hasGroupAccess(
+            app.appId,
+            client
+        );
+        if (!hasClientAccess || !isGroupActive) return false;
+
+        uint256 permissionsLength = app.permissions.length;
+        for (uint256 i; i < permissionsLength; ++i) {
+            if (app.permissions[i] == permission) return true;
+        }
+
+        return false;
     }
 
     /// @notice Gets the ID of the installed app.

package/src/spaces/facets/account/AppAccountStorage.sol

@@ -37,27 +37,4 @@ library AppAccountStorage {
         if (appId == EMPTY_UID) return app;
         return DependencyLib.getAppRegistry().getAppById(appId);
     }
-
-    function isAppEntitled(
-        address module,
-        address client,
-        bytes32 permission
-    ) internal view returns (bool) {
-        IAppRegistry.App memory app = getApp(module);
-
-        if (app.appId == EMPTY_UID) return false;
-
-        (bool hasClientAccess, , bool isGroupActive) = ExecutorStorage.hasGroupAccess(
-            app.appId,
-            client
-        );
-        if (!hasClientAccess || !isGroupActive) return false;
-
-        uint256 permissionsLength = app.permissions.length;
-        for (uint256 i; i < permissionsLength; ++i) {
-            if (app.permissions[i] == permission) return true;
-        }
-
-        return false;
-    }
 }

package/src/spaces/facets/tipping/ITipping.sol

@@ -60,7 +60,7 @@ interface ITippingBase {
         TipRecipientType indexed recipientType,
         address currency,
         uint256 amount,
-        uint256 tokenId // 0 if not a member tip
+        bytes data
     );
 
     // Maintain legacy event for backwards compatibility

package/src/spaces/facets/tipping/TippingBase.sol

@@ -84,7 +84,7 @@ abstract contract TippingBase is ITippingBase, PointsBase {
             TipRecipientType.Member,
             tipRequest.currency,
             tipAmount,
-            tipRequest.tokenId
+            abi.encode(tipRequest.tokenId)
         );
     }
 
@@ -121,7 +121,7 @@ abstract contract TippingBase is ITippingBase, PointsBase {
             TipRecipientType.Member,
             params.currency,
             tipAmount,
-            params.tokenId
+            params.metadata.data
         );
 
         emit Tip(
@@ -165,7 +165,7 @@ abstract contract TippingBase is ITippingBase, PointsBase {
             TipRecipientType.Bot,
             params.currency,
             tipAmount,
-            0
+            params.metadata.data
         );
     }