lens-modules 3.1.1 → 3.1.3

package/contracts/actions/account/TippingAccountAction.sol

@@ -2,23 +2,33 @@
 // Copyright (C) 2024 Lens Labs. All Rights Reserved.
 pragma solidity ^0.8.26;
 
-import {OwnableMetadataBasedAccountAction} from "./base/OwnableMetadataBasedAccountAction.sol";
+import {OwnableMetadataBasedAccountAction} from "lens-modules/contracts/actions/account/base/OwnableMetadataBasedAccountAction.sol";
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import {KeyValue} from "../../core/types/Types.sol";
-import {Errors} from "../../core/types/Errors.sol";
+import {KeyValue, RecipientData} from "lens-modules/contracts/core/types/Types.sol";
+import {Errors} from "lens-modules/contracts/core/types/Errors.sol";
+import {Initializable} from "lens-modules/contracts/core/upgradeability/Initializable.sol";
+import {LensPaymentHandler} from "lens-modules/contracts/extensions/fees/LensPaymentHandler.sol";
 
-contract TippingAccountAction is OwnableMetadataBasedAccountAction {
+contract TippingAccountAction is LensPaymentHandler, OwnableMetadataBasedAccountAction, Initializable {
     using SafeERC20 for IERC20;
 
     /// @custom:keccak lens.param.amount
     bytes32 constant PARAM__TIP_AMOUNT = 0xc8a06abcb0f2366f32dc2741bdf075c3215e3108918311ec0ac742f1ffd37f49;
     /// @custom:keccak lens.param.token
-    bytes32 constant PARAM__TIP_TOKEN = 0xee737c77be2981e91c179485406e6d793521b20aca5e2137b6c497949a74bc94;
+    bytes32 public constant PARAM__TIP_TOKEN = 0xee737c77be2981e91c179485406e6d793521b20aca5e2137b6c497949a74bc94;
+    /// @custom:keccak lens.param.referrals
+    bytes32 constant PARAM__REFERRALS = 0x183a1b7fdb9626f5ae4e8cac88ee13cc03b29800d2690f61e2a2566f76d8773f;
 
-    constructor(address actionHub, address owner, string memory metadataURI)
-        OwnableMetadataBasedAccountAction(actionHub, owner, metadataURI)
-    {}
+    uint16 constant REFERRALS_FEE_MAX_BPS = 2000; // 20.00%
+
+    constructor(address actionHub) OwnableMetadataBasedAccountAction(actionHub, address(0), "") {
+        _disableInitializers();
+    }
+
+    function initialize(address owner, string memory metadataURI) external initializer {
+        OwnableMetadataBasedAccountAction._initialize(owner, metadataURI);
+    }
 
     function _execute(address originalMsgSender, address account, KeyValue[] calldata params)
         internal
@@ -27,15 +37,25 @@ contract TippingAccountAction is OwnableMetadataBasedAccountAction {
     {
         address erc20Token;
         uint256 tipAmount;
+        RecipientData[] memory referrals = new RecipientData[](0);
         for (uint256 i = 0; i < params.length; i++) {
             if (params[i].key == PARAM__TIP_AMOUNT) {
                 tipAmount = abi.decode(params[i].value, (uint256));
             } else if (params[i].key == PARAM__TIP_TOKEN) {
                 erc20Token = abi.decode(params[i].value, (address));
+            } else if (params[i].key == PARAM__REFERRALS) {
+                referrals = abi.decode(params[i].value, (RecipientData[]));
             }
         }
         require(tipAmount > 0, Errors.InvalidParameter());
-        IERC20(erc20Token).safeTransferFrom(originalMsgSender, account, tipAmount);
+        _handlePayment({
+            payer: originalMsgSender,
+            token: erc20Token,
+            amount: tipAmount,
+            recipient: account,
+            referrals: referrals,
+            referralFeeBps: REFERRALS_FEE_MAX_BPS
+        });
         return "";
     }
 }

package/contracts/actions/account/base/BaseAccountAction.sol

@@ -2,16 +2,17 @@
 // Copyright (C) 2024 Lens Labs. All Rights Reserved.
 pragma solidity ^0.8.26;
 
-import {KeyValue} from "../../../core/types/Types.sol";
-import {BaseAction} from "../../base/BaseAction.sol";
-import {IAccountAction} from "../../../extensions/actions/ActionHub.sol";
-import {Errors} from "../../../core/types/Errors.sol";
+import {KeyValue} from "lens-modules/contracts/core/types/Types.sol";
+import {BaseAction} from "lens-modules/contracts/actions/base/BaseAction.sol";
+import {IAccountAction} from "lens-modules/contracts/extensions/actions/ActionHub.sol";
+import {Errors} from "lens-modules/contracts/core/types/Errors.sol";
 
 abstract contract BaseAccountAction is BaseAction, IAccountAction {
     constructor(address actionHub) BaseAction(actionHub) {}
 
     function configure(address originalMsgSender, address account, KeyValue[] calldata params)
         external
+        payable
         override
         onlyActionHub
         returns (bytes memory)
@@ -21,6 +22,7 @@ abstract contract BaseAccountAction is BaseAction, IAccountAction {
 
     function execute(address originalMsgSender, address account, KeyValue[] calldata params)
         external
+        payable
         override
         onlyActionHub
         returns (bytes memory)
@@ -30,6 +32,7 @@ abstract contract BaseAccountAction is BaseAction, IAccountAction {
 
     function setDisabled(address originalMsgSender, address account, bool isDisabled, KeyValue[] calldata params)
         external
+        payable
         override
         onlyActionHub
         returns (bytes memory)

package/contracts/actions/account/base/OwnableMetadataBasedAccountAction.sol

@@ -2,9 +2,9 @@
 // Copyright (C) 2024 Lens Labs. All Rights Reserved.
 pragma solidity ^0.8.26;
 
-import {Ownable} from "../../../core/access/Ownable.sol";
-import {MetadataBased} from "../../../core/base/MetadataBased.sol";
-import {BaseAccountAction} from "./BaseAccountAction.sol";
+import {Ownable} from "lens-modules/contracts/core/access/Ownable.sol";
+import {MetadataBased} from "lens-modules/contracts/core/base/MetadataBased.sol";
+import {BaseAccountAction} from "lens-modules/contracts/actions/account/base/BaseAccountAction.sol";
 
 abstract contract OwnableMetadataBasedAccountAction is BaseAccountAction, Ownable, MetadataBased {
     event Lens_AccountAction_MetadataURISet(string metadataURI);
@@ -14,6 +14,11 @@ abstract contract OwnableMetadataBasedAccountAction is BaseAccountAction, Ownabl
         _setMetadataURI(metadataURI);
     }
 
+    function _initialize(address owner, string memory metadataURI) internal {
+        _transferOwnership(owner);
+        _setMetadataURI(metadataURI);
+    }
+
     function _emitMetadataURISet(string memory metadataURI, address /* source */ ) internal virtual override {
         emit Lens_AccountAction_MetadataURISet(metadataURI);
     }

package/contracts/actions/base/BaseAction.sol

@@ -2,8 +2,8 @@
 // Copyright (C) 2024 Lens Labs. All Rights Reserved.
 pragma solidity ^0.8.26;
 
-import {UNIVERSAL_ACTION_MAGIC_VALUE} from "../../extensions/actions/ActionHub.sol";
-import {Errors} from "../../core/types/Errors.sol";
+import {UNIVERSAL_ACTION_MAGIC_VALUE} from "lens-modules/contracts/extensions/actions/ActionHub.sol";
+import {Errors} from "lens-modules/contracts/core/types/Errors.sol";
 
 abstract contract BaseAction {
     address immutable ACTION_HUB;

package/contracts/actions/post/TippingPostAction.sol

@@ -2,24 +2,34 @@
 // Copyright (C) 2024 Lens Labs. All Rights Reserved.
 pragma solidity ^0.8.26;
 
-import {OwnableMetadataBasedPostAction} from "./base/OwnableMetadataBasedPostAction.sol";
+import {OwnableMetadataBasedPostAction} from "lens-modules/contracts/actions/post/base/OwnableMetadataBasedPostAction.sol";
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import {KeyValue} from "../../core/types/Types.sol";
-import {IFeed} from "../../core/interfaces/IFeed.sol";
-import {Errors} from "../../core/types/Errors.sol";
+import {KeyValue, RecipientData} from "lens-modules/contracts/core/types/Types.sol";
+import {IFeed} from "lens-modules/contracts/core/interfaces/IFeed.sol";
+import {Errors} from "lens-modules/contracts/core/types/Errors.sol";
+import {Initializable} from "lens-modules/contracts/core/upgradeability/Initializable.sol";
+import {LensPaymentHandler} from "lens-modules/contracts/extensions/fees/LensPaymentHandler.sol";
 
-contract TippingPostAction is OwnableMetadataBasedPostAction {
+contract TippingPostAction is LensPaymentHandler, OwnableMetadataBasedPostAction, Initializable {
     using SafeERC20 for IERC20;
 
     /// @custom:keccak lens.param.amount
     bytes32 constant PARAM__TIP_AMOUNT = 0xc8a06abcb0f2366f32dc2741bdf075c3215e3108918311ec0ac742f1ffd37f49;
     /// @custom:keccak lens.param.token
     bytes32 constant PARAM__TIP_TOKEN = 0xee737c77be2981e91c179485406e6d793521b20aca5e2137b6c497949a74bc94;
+    /// @custom:keccak lens.param.referrals
+    bytes32 constant PARAM__REFERRALS = 0x183a1b7fdb9626f5ae4e8cac88ee13cc03b29800d2690f61e2a2566f76d8773f;
 
-    constructor(address actionHub, address owner, string memory metadataURI)
-        OwnableMetadataBasedPostAction(actionHub, owner, metadataURI)
-    {}
+    uint16 constant REFERRALS_FEE_MAX_BPS = 2000; // 20.00%
+
+    constructor(address actionHub) OwnableMetadataBasedPostAction(actionHub, address(0), "") {
+        _disableInitializers();
+    }
+
+    function initialize(address owner, string memory metadataURI) external initializer {
+        OwnableMetadataBasedPostAction._initialize(owner, metadataURI);
+    }
 
     function _execute(address originalMsgSender, address feed, uint256 postId, KeyValue[] calldata params)
         internal
@@ -28,16 +38,26 @@ contract TippingPostAction is OwnableMetadataBasedPostAction {
     {
         address erc20Token;
         uint256 tipAmount;
+        RecipientData[] memory referrals = new RecipientData[](0);
         for (uint256 i = 0; i < params.length; i++) {
             if (params[i].key == PARAM__TIP_AMOUNT) {
                 tipAmount = abi.decode(params[i].value, (uint256));
             } else if (params[i].key == PARAM__TIP_TOKEN) {
                 erc20Token = abi.decode(params[i].value, (address));
+            } else if (params[i].key == PARAM__REFERRALS) {
+                referrals = abi.decode(params[i].value, (RecipientData[]));
             }
         }
         require(tipAmount > 0, Errors.InvalidParameter());
         address account = IFeed(feed).getPostAuthor(postId);
-        IERC20(erc20Token).safeTransferFrom(originalMsgSender, account, tipAmount);
+        _handlePayment({
+            payer: originalMsgSender,
+            token: erc20Token,
+            amount: tipAmount,
+            recipient: account,
+            referrals: referrals,
+            referralFeeBps: REFERRALS_FEE_MAX_BPS
+        });
         return abi.encode(account);
     }
 }

package/contracts/actions/post/base/BasePostAction.sol

@@ -2,16 +2,17 @@
 // Copyright (C) 2024 Lens Labs. All Rights Reserved.
 pragma solidity ^0.8.26;
 
-import {KeyValue} from "../../../core/types/Types.sol";
-import {BaseAction} from "../../base/BaseAction.sol";
-import {IPostAction} from "../../../extensions/actions/ActionHub.sol";
-import {Errors} from "../../../core/types/Errors.sol";
+import {KeyValue} from "lens-modules/contracts/core/types/Types.sol";
+import {BaseAction} from "lens-modules/contracts/actions/base/BaseAction.sol";
+import {IPostAction} from "lens-modules/contracts/extensions/actions/ActionHub.sol";
+import {Errors} from "lens-modules/contracts/core/types/Errors.sol";
 
 abstract contract BasePostAction is BaseAction, IPostAction {
     constructor(address actionHub) BaseAction(actionHub) {}
 
     function configure(address originalMsgSender, address feed, uint256 postId, KeyValue[] calldata params)
         external
+        payable
         override
         onlyActionHub
         returns (bytes memory)
@@ -21,6 +22,7 @@ abstract contract BasePostAction is BaseAction, IPostAction {
 
     function execute(address originalMsgSender, address feed, uint256 postId, KeyValue[] calldata params)
         external
+        payable
         override
         onlyActionHub
         returns (bytes memory)
@@ -34,7 +36,7 @@ abstract contract BasePostAction is BaseAction, IPostAction {
         uint256 postId,
         bool isDisabled,
         KeyValue[] calldata params
-    ) external override onlyActionHub returns (bytes memory) {
+    ) external payable override onlyActionHub returns (bytes memory) {
         return _setDisabled(originalMsgSender, feed, postId, isDisabled, params);
     }
 

package/contracts/actions/post/base/OwnableMetadataBasedPostAction.sol

@@ -2,9 +2,9 @@
 // Copyright (C) 2024 Lens Labs. All Rights Reserved.
 pragma solidity ^0.8.26;
 
-import {Ownable} from "../../../core/access/Ownable.sol";
-import {MetadataBased} from "../../../core/base/MetadataBased.sol";
-import {BasePostAction} from "./BasePostAction.sol";
+import {Ownable} from "lens-modules/contracts/core/access/Ownable.sol";
+import {MetadataBased} from "lens-modules/contracts/core/base/MetadataBased.sol";
+import {BasePostAction} from "lens-modules/contracts/actions/post/base/BasePostAction.sol";
 
 abstract contract OwnableMetadataBasedPostAction is BasePostAction, Ownable, MetadataBased {
     event Lens_PostAction_MetadataURISet(string metadataURI);
@@ -14,6 +14,11 @@ abstract contract OwnableMetadataBasedPostAction is BasePostAction, Ownable, Met
         _setMetadataURI(metadataURI);
     }
 
+    function _initialize(address owner, string memory metadataURI) internal {
+        _transferOwnership(owner);
+        _setMetadataURI(metadataURI);
+    }
+
     function _emitMetadataURISet(string memory metadataURI, address /* source */ ) internal virtual override {
         emit Lens_PostAction_MetadataURISet(metadataURI);
     }

package/contracts/actions/post/collect/ISimpleCollectAction.sol

@@ -2,7 +2,8 @@
 // Copyright (C) 2024 Lens Labs. All Rights Reserved.
 pragma solidity ^0.8.26;
 
-import {IPostAction} from "../../../extensions/actions/ActionHub.sol";
+import {IPostAction} from "lens-modules/contracts/extensions/actions/ActionHub.sol";
+import {RecipientData} from "lens-modules/contracts/core/types/Types.sol";
 
 /**
  * @notice A storage struct containing all data regarding a post's collect action.
@@ -11,17 +12,27 @@ import {IPostAction} from "../../../extensions/actions/ActionHub.sol";
  * @param collectLimit The maximum number of collects for this publication. 0 for no limit.
  * @param token The token associated with this publication.
  * @param currentCollects The current number of collects for this publication.
- * @param recipient Recipient of collect fees.
+ * @param recipients Recipients of collect amount.
  * @param endTimestamp The end timestamp after which collecting is impossible. 0 for no expiry.
+ * @param referralFeeBps The referral fee in basis points.
+ * @param followerOnlyGraph  The graph that holds the follow relations that restrict who can collect this post.
  * @param collectionAddress The address of the collectible ERC721 contract.
+ * @param isImmutable If true, it means that:
+ *          - The Post URI is snapshotted at configuration time and cannot be changed later.
+ *          - Collected posts' NFTs remain permanently available.
+ *          - What you see is what you get; editing the Post URI or deleting the post will disable collection.
+ *         Note: This immutability is only guaranteed if the URI is hosted on immutable storage. Mutability inherent
+ *         to the chosen storage technology exceeds the on-chain verification capabilities.
+ * @param isDisabled Whether the collect action is disabled or not.
  */
 struct CollectActionData {
     uint160 amount;
     uint96 collectLimit;
     address token;
     uint96 currentCollects;
-    address recipient;
+    RecipientData[] recipients;
     uint72 endTimestamp;
+    uint16 referralFeeBps;
     address followerOnlyGraph;
     address collectionAddress;
     bool isImmutable;

package/contracts/actions/post/collect/LensCollectedPost.sol

@@ -2,11 +2,15 @@
 // Copyright (C) 2024 Lens Labs. All Rights Reserved.
 pragma solidity ^0.8.26;
 
-import "../../../core/base/LensERC721.sol";
-import {IERC7572} from "./IERC7572.sol";
-import {IFeed} from "../../../core/interfaces/IFeed.sol";
-import {ITokenURIProvider} from "../../../core/interfaces/ITokenURIProvider.sol";
-import {Errors} from "../../../core/types/Errors.sol";
+import "lens-modules/contracts/core/base/LensERC721.sol";
+import {IFeed} from "lens-modules/contracts/core/interfaces/IFeed.sol";
+import {ITokenURIProvider} from "lens-modules/contracts/core/interfaces/ITokenURIProvider.sol";
+import {Errors} from "lens-modules/contracts/core/types/Errors.sol";
+
+struct ContentURISnapshot {
+    string contentURI;
+    uint256 tokenId;
+}
 
 /**
  * @notice A contract that represents a Lens Collected Post.
@@ -19,52 +23,97 @@ import {Errors} from "../../../core/types/Errors.sol";
  * If the Collect is immutable - it will snapshot the content of the post and always return the snapshotted tokenURI
  * even if the post was updated or deleted. The contractURI, however, always stays the same, as it was at the moment of
  * Collect creation.
+ *
+ * We assume tokenIds are sequential and start from 1.
  */
-contract LensCollectedPost is LensERC721, IERC7572 {
-    string internal _contentURISnapshot;
-    string internal _contractURI;
-    address internal immutable _feed;
-    uint256 internal immutable _postId;
-    address internal immutable _collectAction;
-
-    constructor(address feed, uint256 postId, bool isImmutable) {
+contract LensCollectedPost is LensERC721 {
+    event Lens_LensCollectedPost_Transfer(address indexed from, address indexed to, uint256 indexed tokenId);
+
+    ContentURISnapshot[] internal _contentURISnapshots;
+    bool internal _isImmutable;
+    address internal immutable FEED;
+    uint256 internal immutable POST_ID;
+    address internal immutable COLLECT_ACTION;
+
+    constructor(address feed, uint256 postId, bool isImmutableCollect) {
         LensERC721._initialize("Lens Collected Post", "LCP", ITokenURIProvider(address(0)));
-        string memory contentURI = IFeed(feed).getPost(postId).contentURI;
-        require(bytes(contentURI).length > 0, Errors.InvalidParameter());
-        _feed = feed;
-        _postId = postId;
-        _contractURI = contentURI;
-        _collectAction = msg.sender;
-        if (isImmutable) {
-            _contentURISnapshot = contentURI;
+        COLLECT_ACTION = msg.sender;
+        FEED = feed;
+        POST_ID = postId;
+        // Getting the URI outside the if to use it as a length validation too.
+        string memory contentURI = _getNonEmptyContentURIFromPost();
+        if (isImmutableCollect) {
+            _turnImmutable(contentURI);
         }
-        emit ContractURIUpdated();
     }
 
     function mint(address to, uint256 tokenId) external {
-        require(msg.sender == _collectAction, Errors.InvalidMsgSender());
+        require(msg.sender == COLLECT_ACTION, Errors.InvalidMsgSender());
+        _takeContentURISnapshotIfNeeded(tokenId);
         _mint(to, tokenId);
     }
 
-    // Getters
-
-    function contractURI() external view returns (string memory) {
-        return _contractURI;
+    function turnImmutable() external {
+        require(msg.sender == COLLECT_ACTION, Errors.InvalidMsgSender());
+        if (!_isImmutable) {
+            _turnImmutable(_getNonEmptyContentURIFromPost());
+        }
     }
 
-    function tokenURI(uint256 /*tokenId*/ ) public view override returns (string memory) {
-        if (bytes(_contentURISnapshot).length > 0) {
-            return _contentURISnapshot;
+    // Getters
+
+    function tokenURI(uint256 tokenId) public view override returns (string memory) {
+        if (_isImmutable) {
+            // Searching for snapshots (starting from latest)
+            for (uint256 i = _contentURISnapshots.length - 1; i > 0; i--) {
+                if (_contentURISnapshots[i].tokenId <= tokenId) {
+                    return _contentURISnapshots[i].contentURI;
+                }
+            }
+            // contentURISnapshot[0] is always taken when the collection is marked as immutable,
+            // so we can guarantee it's present and non-empty.
+            return _contentURISnapshots[0].contentURI;
         } else {
-            string memory contentURI = IFeed(_feed).getPost(_postId).contentURI;
-            // If content was deleted we fail. You can override this to return the empty URI if preferred.
-            require(bytes(contentURI).length > 0, Errors.DoesNotExist());
-            return contentURI;
+            return _getNonEmptyContentURIFromPost();
         }
     }
 
+    function getPostId() external view returns (uint256) {
+        return POST_ID;
+    }
+
+    function isImmutable() external view returns (bool) {
+        return _isImmutable;
+    }
+
     // Internal
 
+    function _getNonEmptyContentURIFromPost() internal view returns (string memory) {
+        string memory contentURI = IFeed(FEED).getPost(POST_ID).contentURI;
+        require(bytes(contentURI).length > 0, Errors.InvalidParameter());
+        return contentURI;
+    }
+
+    function _turnImmutable(string memory contentURI) internal {
+        _isImmutable = true;
+        _contentURISnapshots.push(ContentURISnapshot(contentURI, 0));
+    }
+
+    function _takeContentURISnapshotIfNeeded(uint256 tokenId) internal {
+        if (_isImmutable) {
+            // Getting the content URI will revert if the post was deleted or does not exist.
+            string memory contentURI = _getNonEmptyContentURIFromPost();
+            string memory latestContentURISnapshot = _contentURISnapshots[_contentURISnapshots.length - 1].contentURI;
+            if (keccak256(bytes(contentURI)) != keccak256(bytes(latestContentURISnapshot))) {
+                _contentURISnapshots.push(ContentURISnapshot(contentURI, tokenId));
+            }
+        }
+    }
+
+    function _afterTokenTransfer(address from, address to, uint256 tokenId) internal virtual override {
+        emit Lens_LensCollectedPost_Transfer(from, to, tokenId);
+    }
+
     // Disabling integrated LensERC721 tokenURIProvider
     function _beforeTokenURIProviderSet(ITokenURIProvider /* tokenURIProvider */ ) internal pure override {
         revert Errors.NotImplemented();