@towns-protocol/contracts 0.0.452 → 0.0.455

package/docs/membership_architecture.md

@@ -19,8 +19,12 @@ MembershipFacet (external interface)
       ├─ PointsBase (rewards points)
       └─ ERC721ABase (NFT implementation)
 
-SpaceEntitlementGated (result handler)
+SpaceEntitlementGated (xchain/SpaceEntitlementGated.sol)
   └─ Overrides _onEntitlementCheckResultPosted()
+
+ProtocolFeeLib (ProtocolFeeLib.sol)
+  └─ Wraps FeeManager.chargeFee with ERC20 approval handling
+  └─ Used by: MembershipJoin, TippingBase
 ```
 
 ### Storage Architecture
@@ -67,6 +71,8 @@ Memberships can be priced in:
 
 Currency validation happens in `_setMembershipCurrency()` which requires the token to have an enabled fee configuration in FeeManager.
 
+**Note**: Rewards points (`_mintMembershipPoints`) are only minted for native ETH payments. ERC20 payments require an oracle for point calculation.
+
 ## Core Flow: Join → Entitlement Check → Token
 
 ### Happy Path (Local Entitlement)
@@ -84,10 +90,10 @@ User: joinSpace(receiver) + payment
   │   └─ ✓ User has local entitlement → PASS
   │
   ├─ Charge for Join
-  │   ├─ Protocol fee → Platform
+  │   ├─ Protocol fee → Platform (via FeeManager)
   │   ├─ Partner fee → Partner (if any)
   │   ├─ Referral fee → Referrer (if any)
-  │   └─ Base price → Space owner
+  │   └─ Base price remains in contract as revenue
   │
   ├─ Refund Excess (if overpaid)
   │
@@ -218,10 +224,21 @@ function _releaseCapturedValue(bytes32 transactionId, uint256 amount) internal
 ### Fee Distribution
 
 ```solidity
+// MembershipJoin.sol - pays protocol fee via FeeManager
+function _payProtocolFee(address currency, uint256 basePrice, uint256 expectedFee) internal
+
+// ProtocolFeeLib.sol - shared fee charging logic
+function charge(
+    address spaceFactory,    // FeeManager address
+    bytes32 feeType,         // fee type identifier
+    address user,            // payer (msg.sender)
+    address currency,        // NATIVE_TOKEN or ERC20
+    uint256 amount,          // base price for fee calculation
+    uint256 expectedFee      // pre-calculated fee amount
+) internal returns (uint256 protocolFee)
+
 // MembershipBase.sol
-function _collectProtocolFee(address payer, uint256 membershipPrice)
-    internal returns (uint256 protocolFee)
-function _transferIn(address from, uint256 amount) internal returns (uint256)
+function _transferIn(address currency, address from, uint256 amount) internal returns (uint256)
 ```
 
 ### Entitlement Checking

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@towns-protocol/contracts",
-  "version": "0.0.452",
+  "version": "0.0.455",
   "scripts": {
     "clean": "forge clean",
     "compile": "forge build",
@@ -20,12 +20,12 @@
     "@openzeppelin/contracts": "^5.4.0",
     "@openzeppelin/contracts-upgradeable": "^5.4.0",
     "@prb/math": "^4.1.0",
-    "@towns-protocol/diamond": "^0.6.3",
+    "@towns-protocol/diamond": "^0.7.0",
     "@uniswap/permit2": "github:towns-protocol/permit2#v1.0.0",
     "account-abstraction": "github:eth-infinitism/account-abstraction#v0.7.0",
     "crypto-lib": "github:towns-protocol/crypto-lib#v1.0.1",
     "modular-account": "github:towns-protocol/modular-account#v1.0.0",
-    "solady": "^0.1.24"
+    "solady": "^0.1.26"
   },
   "devDependencies": {
     "@layerzerolabs/lz-evm-messagelib-v2": "^3.0.112",
@@ -33,9 +33,9 @@
     "@layerzerolabs/oapp-evm": "^0.3.2",
     "@openzeppelin/merkle-tree": "^1.0.8",
     "@prb/test": "^0.6.4",
-    "@towns-protocol/prettier-config": "^0.0.452",
+    "@towns-protocol/prettier-config": "^0.0.455",
     "@wagmi/cli": "^2.2.0",
-    "forge-std": "github:foundry-rs/forge-std#v1.10.0",
+    "forge-std": "github:foundry-rs/forge-std#v1.12.0",
     "prettier": "^3.5.3",
     "prettier-plugin-solidity": "^1.4.2",
     "solhint": "^5.0.5",
@@ -50,5 +50,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9a059c5131953b959b34917c260ff209af281cb1"
+  "gitHead": "9a5d511378b12fca4eb316895e0bbfe137de137b"
 }

package/scripts/common/Interaction.s.sol

@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-//interfaces
+// interfaces
 
-//libraries
+// libraries
 
-//contracts
+// contracts
 
 import {DeployBase} from "./DeployBase.s.sol";
 import {Script} from "forge-std/Script.sol";

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

@@ -88,16 +88,13 @@ contract DeployBaseRegistry is IDiamondInitHelper, DiamondHelper, Deployer {
         facetHelper.add("NodeOperatorFacet");
         facetHelper.add("MetadataFacet");
         facetHelper.add("EntitlementChecker");
-
-        facetHelper.deployBatch(deployer);
-
         facetHelper.add("RewardsDistributionV2");
         facetHelper.add("SpaceDelegationFacet");
         facetHelper.add("MainnetDelegation");
         facetHelper.add("EIP712Facet");
         facetHelper.add("XChain");
 
-        // Deploy all facets in a single batch transaction
+        // Deploy all facets
         facetHelper.deployBatch(deployer);
 
         // Deploy or retrieve the towns token

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

@@ -103,20 +103,12 @@ contract DeploySpace is IDiamondInitHelper, DiamondHelper, Deployer {
         facetHelper.add("MembershipFacet");
         facetHelper.add("MembershipMetadata");
         facetHelper.add("EntitlementDataQueryable");
-
-        // Deploy the first batch of facets
-        facetHelper.deployBatch(deployer);
-
         facetHelper.add("EntitlementsManager");
         facetHelper.add("Roles");
         facetHelper.add("Channels");
         facetHelper.add("TokenPausableFacet");
         facetHelper.add("ReferralsFacet");
         facetHelper.add("ReviewFacet");
-
-        // Deploy the second batch of facets
-        facetHelper.deployBatch(deployer);
-
         facetHelper.add("SpaceEntitlementGated");
         facetHelper.add("SwapFacet");
         facetHelper.add("TippingFacet");
@@ -128,7 +120,7 @@ contract DeploySpace is IDiamondInitHelper, DiamondHelper, Deployer {
             facetHelper.add("MockLegacyMembership");
         }
 
-        // Deploy the third batch of facets
+        // Deploy all facets
         facetHelper.deployBatch(deployer);
 
         // deploy and add facets one by one to avoid stack too deep

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

@@ -145,10 +145,6 @@ contract DeploySpaceFactory is IDiamondInitHelper, DiamondHelper, Deployer {
         facetHelper.add("PricingModulesFacet");
         facetHelper.add("ImplementationRegistryFacet");
         facetHelper.add("SCL_EIP6565");
-
-        // Deploy the second batch of facets
-        facetHelper.deployBatch(deployer);
-
         facetHelper.add("WalletLink");
         facetHelper.add("EIP712Facet");
         facetHelper.add("PartnerRegistry");
@@ -162,7 +158,7 @@ contract DeploySpaceFactory is IDiamondInitHelper, DiamondHelper, Deployer {
             facetHelper.add("MockLegacyArchitect");
         }
 
-        // Deploy the third batch of facets
+        // Deploy all facets
         facetHelper.deployBatch(deployer);
 
         if (isAnvil()) {

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

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 
-//libraries
+// libraries
 
-//contracts
+// contracts
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 import {AppFactoryFacet} from "src/apps/facets/factory/AppFactoryFacet.sol";
 import {DynamicArrayLib} from "solady/utils/DynamicArrayLib.sol";

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

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 
-//libraries
+// libraries
 
-//contracts
+// 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";

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

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 import {ISchemaResolver} from "@ethereum-attestation-service/eas-contracts/resolver/ISchemaResolver.sol";
 
-//libraries
+// libraries
 
-//contracts
+// contracts
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 import {AppRegistryFacet} from "src/apps/facets/registry/AppRegistryFacet.sol";
 import {DynamicArrayLib} from "solady/utils/DynamicArrayLib.sol";

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

@@ -1,14 +1,14 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 import {IArchitect} from "src/factory/facets/architect/IArchitect.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 
-//contracts
+// contracts
 import {Architect} from "src/factory/facets/architect/Architect.sol";
 
 library DeployArchitect {

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

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 
-//libraries
+// libraries
 
-//contracts
+// contracts
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 import {AttestationRegistry} from "src/apps/facets/attest/AttestationRegistry.sol";
 

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

@@ -1,14 +1,14 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 import {IERC721A} from "src/diamond/facets/token/ERC721A/IERC721A.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 
-//contracts
+// contracts
 import {ERC721A} from "src/diamond/facets/token/ERC721A/ERC721A.sol";
 
 library DeployERC721ANonTransferable {

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

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 
-//contracts
+// contracts
 import {FeatureManagerFacet} from "src/factory/facets/feature/FeatureManagerFacet.sol";
 
 library DeployFeatureManager {

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

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 import {DynamicArrayLib} from "solady/utils/DynamicArrayLib.sol";
 
-//contracts
+// contracts
 import {MainnetDelegation} from "src/base/registry/facets/mainnet/MainnetDelegation.sol";
 
 library DeployMainnetDelegation {

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

@@ -1,14 +1,14 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/Diamond.sol";
 import {IMembershipMetadata} from "src/spaces/facets/membership/metadata/IMembershipMetadata.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 
-//contracts
+// contracts
 
 library DeployMembershipMetadata {
     function selectors() internal pure returns (bytes4[] memory res) {

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

@@ -1,14 +1,14 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 
-//contracts
+// contracts
 import {MerkleAirdrop} from "src/utils/airdrop/merkle/MerkleAirdrop.sol";
 
 library DeployMerkleAirdrop {

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

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 
-//contracts
+// contracts
 import {MetadataFacet} from "src/diamond/facets/metadata/MetadataFacet.sol";
 
 library DeployMetadata {

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

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 
-//contracts
+// contracts
 import {MockLegacyArchitect} from "test/mocks/legacy/MockLegacyArchitect.sol";
 
 library DeployMockLegacyArchitect {

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

@@ -1,14 +1,14 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 import {DynamicArrayLib} from "solady/utils/DynamicArrayLib.sol";
 
-//contracts
+// contracts
 import {NodeOperatorFacet} from "src/base/registry/facets/operator/NodeOperatorFacet.sol";
 
 library DeployNodeOperator {

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

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 
-//contracts
+// contracts
 import {PartnerRegistry} from "src/factory/facets/partner/PartnerRegistry.sol";
 
 library DeployPartnerRegistry {

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

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 
-//contracts
+// contracts
 import {PricingModulesFacet} from "src/factory/facets/architect/pricing/PricingModulesFacet.sol";
 
 library DeployPricingModules {

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

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 
-//libraries
+// libraries
 
-//contracts
+// contracts
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 import {SchemaRegistry} from "src/apps/facets/schema/SchemaRegistry.sol";
 

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

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 
-//contracts
+// contracts
 import {SpaceFactoryInit} from "src/factory/SpaceFactoryInit.sol";
 
 library DeploySpaceFactoryInit {

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

@@ -1,17 +1,17 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IVotes} from "@openzeppelin/contracts/governance/utils/IVotes.sol";
 import {IERC6372} from "@openzeppelin/contracts/interfaces/IERC6372.sol";
 import {IDiamond} from "@towns-protocol/diamond/src/Diamond.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 import {DynamicArrayLib} from "solady/utils/DynamicArrayLib.sol";
 import {DeployERC721A} from "./DeployERC721A.s.sol";
 
-//contracts
+// contracts
 import {SpaceOwner} from "src/spaces/facets/owner/SpaceOwner.sol";
 
 library DeploySpaceOwnerFacet {

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

@@ -1,14 +1,14 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/Diamond.sol";
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 
-//contracts
+// contracts
 import {TokenMigrationFacet} from "src/tokens/migration/TokenMigrationFacet.sol";
 
 library DeployTokenMigration {

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

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/IDiamond.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 
-//contracts
+// contracts
 import {XChain} from "src/base/registry/facets/xchain/XChain.sol";
 
 library DeployXChain {

package/scripts/deployments/utils/DeployAccountFactory.s.sol

@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 
-//libraries
+// libraries
 
-//contracts
+// contracts
 import {EntryPoint} from "@eth-infinitism/account-abstraction/core/EntryPoint.sol";
 import {SimpleAccountFactory} from "@eth-infinitism/account-abstraction/samples/SimpleAccountFactory.sol";
 import {Deployer} from "scripts/common/Deployer.s.sol";

package/scripts/deployments/utils/DeployEntitlementGatedExample.s.sol

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IEntitlementChecker} from "src/base/registry/facets/checker/IEntitlementChecker.sol";
 
-//libraries
+// libraries
 
-//contracts
+// contracts
 import {Deployer} from "scripts/common/Deployer.s.sol";
 import {MockEntitlementGated} from "test/mocks/MockEntitlementGated.sol";
 

package/scripts/deployments/utils/DeployEntrypoint.s.sol

@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 
-//libraries
+// libraries
 
-//contracts
+// contracts
 import {EntryPoint} from "@eth-infinitism/account-abstraction/core/EntryPoint.sol";
 import {Deployer} from "scripts/common/Deployer.s.sol";
 

package/scripts/deployments/utils/DeployMember.s.sol

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-//interfaces
+// interfaces
 
-//libraries
+// libraries
 import {MerkleTree} from "test/utils/MerkleTree.sol";
 
-//contracts
+// contracts
 import {Deployer} from "scripts/common/Deployer.s.sol";
 import {Member} from "src/tokens/Member.sol";
 

package/scripts/deployments/utils/DeployMockLegacyMembership.s.sol

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 import {IDiamond} from "@towns-protocol/diamond/src/Diamond.sol";
 
-//libraries
+// libraries
 import {LibDeploy} from "@towns-protocol/diamond/src/utils/LibDeploy.sol";
 
-//contracts
+// contracts
 import {MockLegacyMembership} from "test/mocks/legacy/membership/MockLegacyMembership.sol";
 
 library DeployMockLegacyMembership {

package/scripts/deployments/utils/DeployMockMessenger.s.sol

@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-//interfaces
+// interfaces
 
-//libraries
+// libraries
 
-//contracts
+// contracts
 import {Deployer} from "scripts/common/Deployer.s.sol";
 import {MockMessenger} from "test/mocks/MockMessenger.sol";