Contract Overview
Balance:
0 MATIC
My Name Tag:
Not Available
Txn Hash |
Method
|
Block
|
From
|
To
|
Value | [Txn Fee] | |||
---|---|---|---|---|---|---|---|---|---|
0x4af3cb24ee5c6056a3f9b7bf20d326b3d54c8f804754450da25ca801236295d6 | 0x60c06040 | 26267761 | 393 days 16 hrs ago | 0xcb6c7b2e340d50701d45d55507f19a5ce5d72330 | IN | Create: LimitedTimedFeeCollectModule | 0 MATIC | 0.001783672571 |
[ Download CSV Export ]
Contract Name:
LimitedTimedFeeCollectModule
Compiler Version
v0.8.10+commit.fc410830
Optimization Enabled:
Yes with 200 runs
Other Settings:
default evmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity 0.8.10; import {ICollectModule} from '../../../interfaces/ICollectModule.sol'; import {Errors} from '../../../libraries/Errors.sol'; import {FeeModuleBase} from '../FeeModuleBase.sol'; import {ModuleBase} from '../ModuleBase.sol'; import {FollowValidationModuleBase} from '../FollowValidationModuleBase.sol'; import {IERC20} from '@openzeppelin/contracts/token/ERC20/IERC20.sol'; import {SafeERC20} from '@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol'; import {IERC721} from '@openzeppelin/contracts/token/ERC721/IERC721.sol'; /** * @notice A struct containing the necessary data to execute collect actions on a publication. * * @param collectLimit The maximum number of collects for this publication. * @param currentCollects The current number of collects for this publication. * @param amount The collecting cost associated with this publication. * @param currency The currency associated with this publication. * @param recipient The recipient address associated with this publication. * @param referralFee The referral fee associated with this publication. * @param endTimestamp The end timestamp after which collecting is impossible. * @param followerOnly Whether only followers should be able to collect. */ struct ProfilePublicationData { uint256 collectLimit; uint256 currentCollects; uint256 amount; address currency; address recipient; uint16 referralFee; bool followerOnly; uint40 endTimestamp; } /** * @title LimitedTimedFeeCollectModule * @author Lens Protocol * * @notice This is a simple Lens CollectModule implementation, inheriting from the ICollectModule interface and * the FeeCollectModuleBase abstract contract. To optimize on gas, this module uses a constant 24 hour maximum * collection time. * * This module works by allowing limited collects for a publication within the allotted time with a given fee. */ contract LimitedTimedFeeCollectModule is FeeModuleBase, FollowValidationModuleBase, ICollectModule { using SafeERC20 for IERC20; uint24 internal constant ONE_DAY = 24 hours; mapping(uint256 => mapping(uint256 => ProfilePublicationData)) internal _dataByPublicationByProfile; constructor(address hub, address moduleGlobals) FeeModuleBase(moduleGlobals) ModuleBase(hub) {} /** * @notice This collect module levies a fee on collects and supports referrals. Thus, we need to decode data. * * @param profileId The profile ID of the publication to initialize this module for's publishing profile. * @param pubId The publication ID of the publication to initialize this module for. * @param data The arbitrary data parameter, decoded into: * uint256 collectLimit: The maximum amount of collects. * uint256 amount: The currency total amount to levy. * address currency: The currency address, must be internally whitelisted. * address recipient: The custom recipient address to direct earnings to. * uint16 referralFee: The referral fee to set. * bool followerOnly: Whether only followers should be able to collect. * * @return bytes An abi encoded bytes parameter, containing (in order): collectLimit, amount, currency, recipient, referral fee & end timestamp. */ function initializePublicationCollectModule( uint256 profileId, uint256 pubId, bytes calldata data ) external override onlyHub returns (bytes memory) { unchecked { uint40 endTimestamp = uint40(block.timestamp) + ONE_DAY; ( uint256 collectLimit, uint256 amount, address currency, address recipient, uint16 referralFee, bool followerOnly ) = abi.decode(data, (uint256, uint256, address, address, uint16, bool)); if ( collectLimit == 0 || !_currencyWhitelisted(currency) || recipient == address(0) || referralFee > BPS_MAX || amount == 0 ) revert Errors.InitParamsInvalid(); _dataByPublicationByProfile[profileId][pubId].collectLimit = collectLimit; _dataByPublicationByProfile[profileId][pubId].amount = amount; _dataByPublicationByProfile[profileId][pubId].currency = currency; _dataByPublicationByProfile[profileId][pubId].recipient = recipient; _dataByPublicationByProfile[profileId][pubId].referralFee = referralFee; _dataByPublicationByProfile[profileId][pubId].followerOnly = followerOnly; _dataByPublicationByProfile[profileId][pubId].endTimestamp = endTimestamp; return abi.encode( collectLimit, amount, currency, recipient, referralFee, followerOnly, endTimestamp ); } } /** * @dev Processes a collect by: * 1. Ensuring the collector is a follower * 2. Ensuring the current timestamp is less than or equal to the collect end timestamp * 3. Ensuring the collect does not pass the collect limit * 4. Charging a fee */ function processCollect( uint256 referrerProfileId, address collector, uint256 profileId, uint256 pubId, bytes calldata data ) external override onlyHub { if (_dataByPublicationByProfile[profileId][pubId].followerOnly) _checkFollowValidity(profileId, collector); uint256 endTimestamp = _dataByPublicationByProfile[profileId][pubId].endTimestamp; if (block.timestamp > endTimestamp) revert Errors.CollectExpired(); if ( _dataByPublicationByProfile[profileId][pubId].currentCollects >= _dataByPublicationByProfile[profileId][pubId].collectLimit ) { revert Errors.MintLimitExceeded(); } else { ++_dataByPublicationByProfile[profileId][pubId].currentCollects; if (referrerProfileId == profileId) { _processCollect(collector, profileId, pubId, data); } else { _processCollectWithReferral(referrerProfileId, collector, profileId, pubId, data); } } } /** * @notice Returns the publication data for a given publication, or an empty struct if that publication was not * initialized with this module. * * @param profileId The token ID of the profile mapped to the publication to query. * @param pubId The publication ID of the publication to query. * * @return ProfilepublicationData The ProfilePublicationData struct mapped to that publication. */ function getPublicationData(uint256 profileId, uint256 pubId) external view returns (ProfilePublicationData memory) { return _dataByPublicationByProfile[profileId][pubId]; } function _processCollect( address collector, uint256 profileId, uint256 pubId, bytes calldata data ) internal { uint256 amount = _dataByPublicationByProfile[profileId][pubId].amount; address currency = _dataByPublicationByProfile[profileId][pubId].currency; _validateDataIsExpected(data, currency, amount); (address treasury, uint16 treasuryFee) = _treasuryData(); address recipient = _dataByPublicationByProfile[profileId][pubId].recipient; uint256 treasuryAmount = (amount * treasuryFee) / BPS_MAX; uint256 adjustedAmount = amount - treasuryAmount; IERC20(currency).safeTransferFrom(collector, recipient, adjustedAmount); if (treasuryAmount > 0) IERC20(currency).safeTransferFrom(collector, treasury, treasuryAmount); } function _processCollectWithReferral( uint256 referrerProfileId, address collector, uint256 profileId, uint256 pubId, bytes calldata data ) internal { uint256 amount = _dataByPublicationByProfile[profileId][pubId].amount; address currency = _dataByPublicationByProfile[profileId][pubId].currency; _validateDataIsExpected(data, currency, amount); uint256 referralFee = _dataByPublicationByProfile[profileId][pubId].referralFee; address treasury; uint256 treasuryAmount; // Avoids stack too deep { uint16 treasuryFee; (treasury, treasuryFee) = _treasuryData(); treasuryAmount = (amount * treasuryFee) / BPS_MAX; } uint256 adjustedAmount = amount - treasuryAmount; if (referralFee != 0) { // The reason we levy the referral fee on the adjusted amount is so that referral fees // don't bypass the treasury fee, in essence referrals pay their fair share to the treasury. uint256 referralAmount = (adjustedAmount * referralFee) / BPS_MAX; adjustedAmount = adjustedAmount - referralAmount; address referralRecipient = IERC721(HUB).ownerOf(referrerProfileId); IERC20(currency).safeTransferFrom(collector, referralRecipient, referralAmount); } address recipient = _dataByPublicationByProfile[profileId][pubId].recipient; IERC20(currency).safeTransferFrom(collector, recipient, adjustedAmount); if (treasuryAmount > 0) IERC20(currency).safeTransferFrom(collector, treasury, treasuryAmount); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity 0.8.10; /** * @title ICollectModule * @author Lens Protocol * * @notice This is the standard interface for all Lens-compatible CollectModules. */ interface ICollectModule { /** * @notice Initializes data for a given publication being published. This can only be called by the hub. * * @param profileId The token ID of the profile publishing the publication. * @param pubId The associated publication's LensHub publication ID. * @param data Arbitrary data __passed from the user!__ to be decoded. * * @return bytes An abi encoded byte array encapsulating the execution's state changes. This will be emitted by the * hub alongside the collect module's address and should be consumed by front ends. */ function initializePublicationCollectModule( uint256 profileId, uint256 pubId, bytes calldata data ) external returns (bytes memory); /** * @notice Processes a collect action for a given publication, this can only be called by the hub. * * @param referrerProfileId The LensHub profile token ID of the referrer's profile (only different in case of mirrors). * @param collector The collector address. * @param profileId The token ID of the profile associated with the publication being collected. * @param pubId The LensHub publication ID associated with the publication being collected. * @param data Arbitrary data __passed from the collector!__ to be decoded. */ function processCollect( uint256 referrerProfileId, address collector, uint256 profileId, uint256 pubId, bytes calldata data ) external; }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity 0.8.10; library Errors { error CannotInitImplementation(); error Initialized(); error SignatureExpired(); error ZeroSpender(); error SignatureInvalid(); error NotOwnerOrApproved(); error NotHub(); error TokenDoesNotExist(); error NotGovernance(); error NotGovernanceOrEmergencyAdmin(); error EmergencyAdminCannotUnpause(); error CallerNotWhitelistedModule(); error CollectModuleNotWhitelisted(); error FollowModuleNotWhitelisted(); error ReferenceModuleNotWhitelisted(); error ProfileCreatorNotWhitelisted(); error NotProfileOwner(); error NotProfileOwnerOrDispatcher(); error NotDispatcher(); error PublicationDoesNotExist(); error HandleTaken(); error HandleLengthInvalid(); error HandleContainsInvalidCharacters(); error ProfileImageURILengthInvalid(); error CallerNotFollowNFT(); error CallerNotCollectNFT(); error BlockNumberInvalid(); error ArrayMismatch(); error CannotCommentOnSelf(); // Module Errors error InitParamsInvalid(); error CollectExpired(); error FollowInvalid(); error ModuleDataMismatch(); error FollowNotApproved(); error MintLimitExceeded(); error CollectNotAllowed(); // MultiState Errors error Paused(); error PublishingPaused(); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity 0.8.10; import {Errors} from '../../libraries/Errors.sol'; import {Events} from '../../libraries/Events.sol'; import {IModuleGlobals} from '../../interfaces/IModuleGlobals.sol'; /** * @title FeeModuleBase * @author Lens Protocol * * @notice This is an abstract contract to be inherited from by modules that require basic fee functionality. It * contains getters for module globals parameters as well as a validation function to check expected data. */ abstract contract FeeModuleBase { uint16 internal constant BPS_MAX = 10000; address public immutable MODULE_GLOBALS; constructor(address moduleGlobals) { if (moduleGlobals == address(0)) revert Errors.InitParamsInvalid(); MODULE_GLOBALS = moduleGlobals; emit Events.FeeModuleBaseConstructed(moduleGlobals, block.timestamp); } function _currencyWhitelisted(address currency) internal view returns (bool) { return IModuleGlobals(MODULE_GLOBALS).isCurrencyWhitelisted(currency); } function _treasuryData() internal view returns (address, uint16) { return IModuleGlobals(MODULE_GLOBALS).getTreasuryData(); } function _validateDataIsExpected( bytes calldata data, address currency, uint256 amount ) internal pure { (address decodedCurrency, uint256 decodedAmount) = abi.decode(data, (address, uint256)); if (decodedAmount != amount || decodedCurrency != currency) revert Errors.ModuleDataMismatch(); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity 0.8.10; import {Errors} from '../../libraries/Errors.sol'; import {Events} from '../../libraries/Events.sol'; /** * @title ModuleBase * @author Lens Protocol * * @notice This abstract contract adds a public `HUB` immutable to inheriting modules, as well as an * `onlyHub` modifier. */ abstract contract ModuleBase { address public immutable HUB; modifier onlyHub() { if (msg.sender != HUB) revert Errors.NotHub(); _; } constructor(address hub) { if (hub == address(0)) revert Errors.InitParamsInvalid(); HUB = hub; emit Events.ModuleBaseConstructed(hub, block.timestamp); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity 0.8.10; import {IFollowModule} from '../../interfaces/IFollowModule.sol'; import {ILensHub} from '../../interfaces/ILensHub.sol'; import {Errors} from '../../libraries/Errors.sol'; import {Events} from '../../libraries/Events.sol'; import {ModuleBase} from './ModuleBase.sol'; import {IERC721} from '@openzeppelin/contracts/token/ERC721/IERC721.sol'; /** * @title FollowValidationModuleBase * @author Lens Protocol * * @notice This abstract contract adds a simple non-specific follow validation function. * * NOTE: Both the `HUB` variable and `_checkFollowValidity()` function are exposed to inheriting * contracts. * * NOTE: This is only compatible with COLLECT & REFERENCE MODULES. */ abstract contract FollowValidationModuleBase is ModuleBase { /** * @notice Validates whether a given user is following a given profile. * * @dev It will revert if the user is not following the profile except the case when the user is the profile owner. * * @param profileId The ID of the profile that should be followed by the given user. * @param user The address of the user that should be following the given profile. */ function _checkFollowValidity(uint256 profileId, address user) internal view { address followModule = ILensHub(HUB).getFollowModule(profileId); bool isFollowing; if (followModule != address(0)) { isFollowing = IFollowModule(followModule).isFollowing(profileId, user, 0); } else { address followNFT = ILensHub(HUB).getFollowNFT(profileId); isFollowing = followNFT != address(0) && IERC721(followNFT).balanceOf(user) != 0; } if (!isFollowing && IERC721(HUB).ownerOf(profileId) != user) { revert Errors.FollowInvalid(); } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.5.0) (token/ERC20/IERC20.sol) pragma solidity ^0.8.0; /** * @dev Interface of the ERC20 standard as defined in the EIP. */ interface IERC20 { /** * @dev Returns the amount of tokens in existence. */ function totalSupply() external view returns (uint256); /** * @dev Returns the amount of tokens owned by `account`. */ function balanceOf(address account) external view returns (uint256); /** * @dev Moves `amount` tokens from the caller's account to `to`. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transfer(address to, uint256 amount) external returns (bool); /** * @dev Returns the remaining number of tokens that `spender` will be * allowed to spend on behalf of `owner` through {transferFrom}. This is * zero by default. * * This value changes when {approve} or {transferFrom} are called. */ function allowance(address owner, address spender) external view returns (uint256); /** * @dev Sets `amount` as the allowance of `spender` over the caller's tokens. * * Returns a boolean value indicating whether the operation succeeded. * * IMPORTANT: Beware that changing an allowance with this method brings the risk * that someone may use both the old and the new allowance by unfortunate * transaction ordering. One possible solution to mitigate this race * condition is to first reduce the spender's allowance to 0 and set the * desired value afterwards: * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 * * Emits an {Approval} event. */ function approve(address spender, uint256 amount) external returns (bool); /** * @dev Moves `amount` tokens from `from` to `to` using the * allowance mechanism. `amount` is then deducted from the caller's * allowance. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transferFrom( address from, address to, uint256 amount ) external returns (bool); /** * @dev Emitted when `value` tokens are moved from one account (`from`) to * another (`to`). * * Note that `value` may be zero. */ event Transfer(address indexed from, address indexed to, uint256 value); /** * @dev Emitted when the allowance of a `spender` for an `owner` is set by * a call to {approve}. `value` is the new allowance. */ event Approval(address indexed owner, address indexed spender, uint256 value); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (token/ERC20/utils/SafeERC20.sol) pragma solidity ^0.8.0; import "../IERC20.sol"; import "../../../utils/Address.sol"; /** * @title SafeERC20 * @dev Wrappers around ERC20 operations that throw on failure (when the token * contract returns false). Tokens that return no value (and instead revert or * throw on failure) are also supported, non-reverting calls are assumed to be * successful. * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract, * which allows you to call the safe operations as `token.safeTransfer(...)`, etc. */ library SafeERC20 { using Address for address; function safeTransfer( IERC20 token, address to, uint256 value ) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value)); } function safeTransferFrom( IERC20 token, address from, address to, uint256 value ) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value)); } /** * @dev Deprecated. This function has issues similar to the ones found in * {IERC20-approve}, and its usage is discouraged. * * Whenever possible, use {safeIncreaseAllowance} and * {safeDecreaseAllowance} instead. */ function safeApprove( IERC20 token, address spender, uint256 value ) internal { // safeApprove should only be called when setting an initial allowance, // or when resetting it to zero. To increase and decrease it, use // 'safeIncreaseAllowance' and 'safeDecreaseAllowance' require( (value == 0) || (token.allowance(address(this), spender) == 0), "SafeERC20: approve from non-zero to non-zero allowance" ); _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value)); } function safeIncreaseAllowance( IERC20 token, address spender, uint256 value ) internal { uint256 newAllowance = token.allowance(address(this), spender) + value; _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } function safeDecreaseAllowance( IERC20 token, address spender, uint256 value ) internal { unchecked { uint256 oldAllowance = token.allowance(address(this), spender); require(oldAllowance >= value, "SafeERC20: decreased allowance below zero"); uint256 newAllowance = oldAllowance - value; _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } } /** * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement * on the return value: the return value is optional (but if data is returned, it must not be false). * @param token The token targeted by the call. * @param data The call data (encoded using abi.encode or one of its variants). */ function _callOptionalReturn(IERC20 token, bytes memory data) private { // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since // we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that // the target address contains contract code and also asserts for success in the low-level call. bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed"); if (returndata.length > 0) { // Return data is optional require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed"); } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (token/ERC721/IERC721.sol) pragma solidity ^0.8.0; import "../../utils/introspection/IERC165.sol"; /** * @dev Required interface of an ERC721 compliant contract. */ interface IERC721 is IERC165 { /** * @dev Emitted when `tokenId` token is transferred from `from` to `to`. */ event Transfer(address indexed from, address indexed to, uint256 indexed tokenId); /** * @dev Emitted when `owner` enables `approved` to manage the `tokenId` token. */ event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId); /** * @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets. */ event ApprovalForAll(address indexed owner, address indexed operator, bool approved); /** * @dev Returns the number of tokens in ``owner``'s account. */ function balanceOf(address owner) external view returns (uint256 balance); /** * @dev Returns the owner of the `tokenId` token. * * Requirements: * * - `tokenId` must exist. */ function ownerOf(uint256 tokenId) external view returns (address owner); /** * @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients * are aware of the ERC721 protocol to prevent tokens from being forever locked. * * Requirements: * * - `from` cannot be the zero address. * - `to` cannot be the zero address. * - `tokenId` token must exist and be owned by `from`. * - If the caller is not `from`, it must be have been allowed to move this token by either {approve} or {setApprovalForAll}. * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer. * * Emits a {Transfer} event. */ function safeTransferFrom( address from, address to, uint256 tokenId ) external; /** * @dev Transfers `tokenId` token from `from` to `to`. * * WARNING: Usage of this method is discouraged, use {safeTransferFrom} whenever possible. * * Requirements: * * - `from` cannot be the zero address. * - `to` cannot be the zero address. * - `tokenId` token must be owned by `from`. * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}. * * Emits a {Transfer} event. */ function transferFrom( address from, address to, uint256 tokenId ) external; /** * @dev Gives permission to `to` to transfer `tokenId` token to another account. * The approval is cleared when the token is transferred. * * Only a single account can be approved at a time, so approving the zero address clears previous approvals. * * Requirements: * * - The caller must own the token or be an approved operator. * - `tokenId` must exist. * * Emits an {Approval} event. */ function approve(address to, uint256 tokenId) external; /** * @dev Returns the account approved for `tokenId` token. * * Requirements: * * - `tokenId` must exist. */ function getApproved(uint256 tokenId) external view returns (address operator); /** * @dev Approve or remove `operator` as an operator for the caller. * Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller. * * Requirements: * * - The `operator` cannot be the caller. * * Emits an {ApprovalForAll} event. */ function setApprovalForAll(address operator, bool _approved) external; /** * @dev Returns if the `operator` is allowed to manage all of the assets of `owner`. * * See {setApprovalForAll} */ function isApprovedForAll(address owner, address operator) external view returns (bool); /** * @dev Safely transfers `tokenId` token from `from` to `to`. * * Requirements: * * - `from` cannot be the zero address. * - `to` cannot be the zero address. * - `tokenId` token must exist and be owned by `from`. * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}. * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer. * * Emits a {Transfer} event. */ function safeTransferFrom( address from, address to, uint256 tokenId, bytes calldata data ) external; }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity 0.8.10; import {DataTypes} from './DataTypes.sol'; library Events { /** * @dev Emitted when the NFT contract's name and symbol are set at initialization. * * @param name The NFT name set. * @param symbol The NFT symbol set. * @param timestamp The current block timestamp. */ event BaseInitialized(string name, string symbol, uint256 timestamp); /** * @dev Emitted when the hub state is set. * * @param caller The caller who set the state. * @param prevState The previous protocol state, an enum of either `Paused`, `PublishingPaused` or `Unpaused`. * @param newState The newly set state, an enum of either `Paused`, `PublishingPaused` or `Unpaused`. * @param timestamp The current block timestamp. */ event StateSet( address indexed caller, DataTypes.ProtocolState indexed prevState, DataTypes.ProtocolState indexed newState, uint256 timestamp ); /** * @dev Emitted when the governance address is changed. We emit the caller even though it should be the previous * governance address, as we cannot guarantee this will always be the case due to upgradeability. * * @param caller The caller who set the governance address. * @param prevGovernance The previous governance address. * @param newGovernance The new governance address set. * @param timestamp The current block timestamp. */ event GovernanceSet( address indexed caller, address indexed prevGovernance, address indexed newGovernance, uint256 timestamp ); /** * @dev Emitted when the emergency admin is changed. We emit the caller even though it should be the previous * governance address, as we cannot guarantee this will always be the case due to upgradeability. * * @param caller The caller who set the emergency admin address. * @param oldEmergencyAdmin The previous emergency admin address. * @param newEmergencyAdmin The new emergency admin address set. * @param timestamp The current block timestamp. */ event EmergencyAdminSet( address indexed caller, address indexed oldEmergencyAdmin, address indexed newEmergencyAdmin, uint256 timestamp ); /** * @dev Emitted when a profile creator is added to or removed from the whitelist. * * @param profileCreator The address of the profile creator. * @param whitelisted Whether or not the profile creator is being added to the whitelist. * @param timestamp The current block timestamp. */ event ProfileCreatorWhitelisted( address indexed profileCreator, bool indexed whitelisted, uint256 timestamp ); /** * @dev Emitted when a follow module is added to or removed from the whitelist. * * @param followModule The address of the follow module. * @param whitelisted Whether or not the follow module is being added to the whitelist. * @param timestamp The current block timestamp. */ event FollowModuleWhitelisted( address indexed followModule, bool indexed whitelisted, uint256 timestamp ); /** * @dev Emitted when a reference module is added to or removed from the whitelist. * * @param referenceModule The address of the reference module. * @param whitelisted Whether or not the reference module is being added to the whitelist. * @param timestamp The current block timestamp. */ event ReferenceModuleWhitelisted( address indexed referenceModule, bool indexed whitelisted, uint256 timestamp ); /** * @dev Emitted when a collect module is added to or removed from the whitelist. * * @param collectModule The address of the collect module. * @param whitelisted Whether or not the collect module is being added to the whitelist. * @param timestamp The current block timestamp. */ event CollectModuleWhitelisted( address indexed collectModule, bool indexed whitelisted, uint256 timestamp ); /** * @dev Emitted when a profile is created. * * @param profileId The newly created profile's token ID. * @param creator The profile creator, who created the token with the given profile ID. * @param to The address receiving the profile with the given profile ID. * @param handle The handle set for the profile. * @param imageURI The image uri set for the profile. * @param followModule The profile's newly set follow module. This CAN be the zero address. * @param followModuleReturnData The data returned from the follow module's initialization. This is abi encoded * and totally depends on the follow module chosen. * @param followNFTURI The URI set for the profile's follow NFT. * @param timestamp The current block timestamp. */ event ProfileCreated( uint256 indexed profileId, address indexed creator, address indexed to, string handle, string imageURI, address followModule, bytes followModuleReturnData, string followNFTURI, uint256 timestamp ); /** * @dev Emitted when a a default profile is set for a wallet as its main identity * * @param wallet The wallet which set or unset its default profile. * @param profileId The token ID of the profile being set as default, or zero. * @param timestamp The current block timestamp. */ event DefaultProfileSet(address indexed wallet, uint256 indexed profileId, uint256 timestamp); /** * @dev Emitted when a dispatcher is set for a specific profile. * * @param profileId The token ID of the profile for which the dispatcher is set. * @param dispatcher The dispatcher set for the given profile. * @param timestamp The current block timestamp. */ event DispatcherSet(uint256 indexed profileId, address indexed dispatcher, uint256 timestamp); /** * @dev Emitted when a profile's URI is set. * * @param profileId The token ID of the profile for which the URI is set. * @param imageURI The URI set for the given profile. * @param timestamp The current block timestamp. */ event ProfileImageURISet(uint256 indexed profileId, string imageURI, uint256 timestamp); /** * @dev Emitted when a follow NFT's URI is set. * * @param profileId The token ID of the profile for which the followNFT URI is set. * @param followNFTURI The follow NFT URI set. * @param timestamp The current block timestamp. */ event FollowNFTURISet(uint256 indexed profileId, string followNFTURI, uint256 timestamp); /** * @dev Emitted when a profile's follow module is set. * * @param profileId The profile's token ID. * @param followModule The profile's newly set follow module. This CAN be the zero address. * @param followModuleReturnData The data returned from the follow module's initialization. This is abi encoded * and totally depends on the follow module chosen. * @param timestamp The current block timestamp. */ event FollowModuleSet( uint256 indexed profileId, address followModule, bytes followModuleReturnData, uint256 timestamp ); /** * @dev Emitted when a "post" is published. * * @param profileId The profile's token ID. * @param pubId The new publication's ID. * @param contentURI The URI mapped to this new publication. * @param collectModule The collect module mapped to this new publication. This CANNOT be the zero address. * @param collectModuleReturnData The data returned from the collect module's initialization for this given * publication. This is abi encoded and totally depends on the collect module chosen. * @param referenceModule The reference module set for this publication. * @param referenceModuleReturnData The data returned from the reference module at initialization. This is abi * encoded and totally depends on the reference module chosen. * @param timestamp The current block timestamp. */ event PostCreated( uint256 indexed profileId, uint256 indexed pubId, string contentURI, address collectModule, bytes collectModuleReturnData, address referenceModule, bytes referenceModuleReturnData, uint256 timestamp ); /** * @dev Emitted when a "comment" is published. * * @param profileId The profile's token ID. * @param pubId The new publication's ID. * @param contentURI The URI mapped to this new publication. * @param profileIdPointed The profile token ID that this comment points to. * @param pubIdPointed The publication ID that this comment points to. * @param referenceModuleData The data passed to the reference module. * @param collectModule The collect module mapped to this new publication. This CANNOT be the zero address. * @param collectModuleReturnData The data returned from the collect module's initialization for this given * publication. This is abi encoded and totally depends on the collect module chosen. * @param referenceModule The reference module set for this publication. * @param referenceModuleReturnData The data returned from the reference module at initialization. This is abi * encoded and totally depends on the reference module chosen. * @param timestamp The current block timestamp. */ event CommentCreated( uint256 indexed profileId, uint256 indexed pubId, string contentURI, uint256 profileIdPointed, uint256 pubIdPointed, bytes referenceModuleData, address collectModule, bytes collectModuleReturnData, address referenceModule, bytes referenceModuleReturnData, uint256 timestamp ); /** * @dev Emitted when a "mirror" is published. * * @param profileId The profile's token ID. * @param pubId The new publication's ID. * @param profileIdPointed The profile token ID that this mirror points to. * @param pubIdPointed The publication ID that this mirror points to. * @param referenceModuleData The data passed to the reference module. * @param referenceModule The reference module set for this publication. * @param referenceModuleReturnData The data returned from the reference module at initialization. This is abi * encoded and totally depends on the reference module chosen. * @param timestamp The current block timestamp. */ event MirrorCreated( uint256 indexed profileId, uint256 indexed pubId, uint256 profileIdPointed, uint256 pubIdPointed, bytes referenceModuleData, address referenceModule, bytes referenceModuleReturnData, uint256 timestamp ); /** * @dev Emitted when a followNFT clone is deployed using a lazy deployment pattern. * * @param profileId The token ID of the profile to which this followNFT is associated. * @param followNFT The address of the newly deployed followNFT clone. * @param timestamp The current block timestamp. */ event FollowNFTDeployed( uint256 indexed profileId, address indexed followNFT, uint256 timestamp ); /** * @dev Emitted when a collectNFT clone is deployed using a lazy deployment pattern. * * @param profileId The publisher's profile token ID. * @param pubId The publication associated with the newly deployed collectNFT clone's ID. * @param collectNFT The address of the newly deployed collectNFT clone. * @param timestamp The current block timestamp. */ event CollectNFTDeployed( uint256 indexed profileId, uint256 indexed pubId, address indexed collectNFT, uint256 timestamp ); /** * @dev Emitted upon a successful collect action. * * @param collector The address collecting the publication. * @param profileId The token ID of the profile that the collect was initiated towards, useful to differentiate mirrors. * @param pubId The publication ID that the collect was initiated towards, useful to differentiate mirrors. * @param rootProfileId The profile token ID of the profile whose publication is being collected. * @param rootPubId The publication ID of the publication being collected. * @param collectModuleData The data passed to the collect module. * @param timestamp The current block timestamp. */ event Collected( address indexed collector, uint256 indexed profileId, uint256 indexed pubId, uint256 rootProfileId, uint256 rootPubId, bytes collectModuleData, uint256 timestamp ); /** * @dev Emitted upon a successful follow action. * * @param follower The address following the given profiles. * @param profileIds The token ID array of the profiles being followed. * @param followModuleDatas The array of data parameters passed to each follow module. * @param timestamp The current block timestamp. */ event Followed( address indexed follower, uint256[] profileIds, bytes[] followModuleDatas, uint256 timestamp ); /** * @dev Emitted via callback when a followNFT is transferred. * * @param profileId The token ID of the profile associated with the followNFT being transferred. * @param followNFTId The followNFT being transferred's token ID. * @param from The address the followNFT is being transferred from. * @param to The address the followNFT is being transferred to. * @param timestamp The current block timestamp. */ event FollowNFTTransferred( uint256 indexed profileId, uint256 indexed followNFTId, address from, address to, uint256 timestamp ); /** * @dev Emitted via callback when a collectNFT is transferred. * * @param profileId The token ID of the profile associated with the collectNFT being transferred. * @param pubId The publication ID associated with the collectNFT being transferred. * @param collectNFTId The collectNFT being transferred's token ID. * @param from The address the collectNFT is being transferred from. * @param to The address the collectNFT is being transferred to. * @param timestamp The current block timestamp. */ event CollectNFTTransferred( uint256 indexed profileId, uint256 indexed pubId, uint256 indexed collectNFTId, address from, address to, uint256 timestamp ); // Collect/Follow NFT-Specific /** * @dev Emitted when a newly deployed follow NFT is initialized. * * @param profileId The token ID of the profile connected to this follow NFT. * @param timestamp The current block timestamp. */ event FollowNFTInitialized(uint256 indexed profileId, uint256 timestamp); /** * @dev Emitted when delegation power in a FollowNFT is changed. * * @param delegate The delegate whose power has been changed. * @param newPower The new governance power mapped to the delegate. * @param timestamp The current block timestamp. */ event FollowNFTDelegatedPowerChanged( address indexed delegate, uint256 indexed newPower, uint256 timestamp ); /** * @dev Emitted when a newly deployed collect NFT is initialized. * * @param profileId The token ID of the profile connected to the publication mapped to this collect NFT. * @param pubId The publication ID connected to the publication mapped to this collect NFT. * @param timestamp The current block timestamp. */ event CollectNFTInitialized( uint256 indexed profileId, uint256 indexed pubId, uint256 timestamp ); // Module-Specific /** * @notice Emitted when the ModuleGlobals governance address is set. * * @param prevGovernance The previous governance address. * @param newGovernance The new governance address set. * @param timestamp The current block timestamp. */ event ModuleGlobalsGovernanceSet( address indexed prevGovernance, address indexed newGovernance, uint256 timestamp ); /** * @notice Emitted when the ModuleGlobals treasury address is set. * * @param prevTreasury The previous treasury address. * @param newTreasury The new treasury address set. * @param timestamp The current block timestamp. */ event ModuleGlobalsTreasurySet( address indexed prevTreasury, address indexed newTreasury, uint256 timestamp ); /** * @notice Emitted when the ModuleGlobals treasury fee is set. * * @param prevTreasuryFee The previous treasury fee in BPS. * @param newTreasuryFee The new treasury fee in BPS. * @param timestamp The current block timestamp. */ event ModuleGlobalsTreasuryFeeSet( uint16 indexed prevTreasuryFee, uint16 indexed newTreasuryFee, uint256 timestamp ); /** * @notice Emitted when a currency is added to or removed from the ModuleGlobals whitelist. * * @param currency The currency address. * @param prevWhitelisted Whether or not the currency was previously whitelisted. * @param whitelisted Whether or not the currency is whitelisted. * @param timestamp The current block timestamp. */ event ModuleGlobalsCurrencyWhitelisted( address indexed currency, bool indexed prevWhitelisted, bool indexed whitelisted, uint256 timestamp ); /** * @notice Emitted when a module inheriting from the `FeeModuleBase` is constructed. * * @param moduleGlobals The ModuleGlobals contract address used. * @param timestamp The current block timestamp. */ event FeeModuleBaseConstructed(address indexed moduleGlobals, uint256 timestamp); /** * @notice Emitted when a module inheriting from the `ModuleBase` is constructed. * * @param hub The LensHub contract address used. * @param timestamp The current block timestamp. */ event ModuleBaseConstructed(address indexed hub, uint256 timestamp); /** * @notice Emitted when one or multiple addresses are approved (or disapproved) for following in * the `ApprovalFollowModule`. * * @param owner The profile owner who executed the approval. * @param profileId The profile ID that the follow approvals are granted/revoked for. * @param addresses The addresses that have had the follow approvals grnated/revoked. * @param approved Whether each corresponding address is now approved or disapproved. * @param timestamp The current block timestamp. */ event FollowsApproved( address indexed owner, uint256 indexed profileId, address[] addresses, bool[] approved, uint256 timestamp ); /** * @dev Emitted when the user wants to enable or disable follows in the `LensPeriphery`. * * @param owner The profile owner who executed the toggle. * @param profileIds The array of token IDs of the profiles each followNFT is associated with. * @param enabled The array of whether each FollowNFT's follow is enabled/disabled. * @param timestamp The current block timestamp. */ event FollowsToggled( address indexed owner, uint256[] profileIds, bool[] enabled, uint256 timestamp ); /** * @dev Emitted when the metadata associated with a profile is set in the `LensPeriphery`. * * @param profileId The profile ID the metadata is set for. * @param metadata The metadata set for the profile and user. * @param timestamp The current block timestamp. */ event ProfileMetadataSet( uint256 indexed profileId, string metadata, uint256 timestamp ); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity 0.8.10; /** * @title IModuleGlobals * @author Lens Protocol * * @notice This is the interface for the ModuleGlobals contract, a data providing contract to be queried by modules * for the most up-to-date parameters. */ interface IModuleGlobals { /** * @notice Sets the governance address. This function can only be called by governance. * * @param newGovernance The new governance address to set. */ function setGovernance(address newGovernance) external; /** * @notice Sets the treasury address. This function can only be called by governance. * * @param newTreasury The new treasury address to set. */ function setTreasury(address newTreasury) external; /** * @notice Sets the treasury fee. This function can only be called by governance. * * @param newTreasuryFee The new treasury fee to set. */ function setTreasuryFee(uint16 newTreasuryFee) external; /** * @notice Adds or removes a currency from the whitelist. This function can only be called by governance. * * @param currency The currency to add or remove from the whitelist. * @param toWhitelist Whether to add or remove the currency from the whitelist. */ function whitelistCurrency(address currency, bool toWhitelist) external; /// ************************ /// *****VIEW FUNCTIONS***** /// ************************ /** * @notice Returns whether a currency is whitelisted. * * @param currency The currency to query the whitelist for. * * @return bool True if the queried currency is whitelisted, false otherwise. */ function isCurrencyWhitelisted(address currency) external view returns (bool); /** * @notice Returns the governance address. * * @return address The governance address. */ function getGovernance() external view returns (address); /** * @notice Returns the treasury address. * * @return address The treasury address. */ function getTreasury() external view returns (address); /** * @notice Returns the treasury fee. * * @return uint16 The treasury fee. */ function getTreasuryFee() external view returns (uint16); /** * @notice Returns the treasury address and treasury fee in a single call. * * @return tuplee First, the treasury address, second, the treasury fee. */ function getTreasuryData() external view returns (address, uint16); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity 0.8.10; /** * @title DataTypes * @author Lens Protocol * * @notice A standard library of data types used throughout the Lens Protocol. */ library DataTypes { /** * @notice An enum containing the different states the protocol can be in, limiting certain actions. * * @param Unpaused The fully unpaused state. * @param PublishingPaused The state where only publication creation functions are paused. * @param Paused The fully paused state. */ enum ProtocolState { Unpaused, PublishingPaused, Paused } /** * @notice An enum specifically used in a helper function to easily retrieve the publication type for integrations. * * @param Post A standard post, having a URI, a collect module but no pointer to another publication. * @param Comment A comment, having a URI, a collect module and a pointer to another publication. * @param Mirror A mirror, having a pointer to another publication, but no URI or collect module. * @param Nonexistent An indicator showing the queried publication does not exist. */ enum PubType { Post, Comment, Mirror, Nonexistent } /** * @notice A struct containing the necessary information to reconstruct an EIP-712 typed data signature. * * @param v The signature's recovery parameter. * @param r The signature's r parameter. * @param s The signature's s parameter * @param deadline The signature's deadline */ struct EIP712Signature { uint8 v; bytes32 r; bytes32 s; uint256 deadline; } /** * @notice A struct containing profile data. * * @param pubCount The number of publications made to this profile. * @param followModule The address of the current follow module in use by this profile, can be empty. * @param followNFT The address of the followNFT associated with this profile, can be empty.. * @param handle The profile's associated handle. * @param imageURI The URI to be used for the profile's image. * @param followNFTURI The URI to be used for the follow NFT. */ struct ProfileStruct { uint256 pubCount; address followModule; address followNFT; string handle; string imageURI; string followNFTURI; } /** * @notice A struct containing data associated with each new publication. * * @param profileIdPointed The profile token ID this publication points to, for mirrors and comments. * @param pubIdPointed The publication ID this publication points to, for mirrors and comments. * @param contentURI The URI associated with this publication. * @param referenceModule The address of the current reference module in use by this profile, can be empty. * @param collectModule The address of the collect module associated with this publication, this exists for all publication. * @param collectNFT The address of the collectNFT associated with this publication, if any. */ struct PublicationStruct { uint256 profileIdPointed; uint256 pubIdPointed; string contentURI; address referenceModule; address collectModule; address collectNFT; } /** * @notice A struct containing the parameters required for the `createProfile()` function. * * @param to The address receiving the profile. * @param handle The handle to set for the profile, must be unique and non-empty. * @param imageURI The URI to set for the profile image. * @param followModule The follow module to use, can be the zero address. * @param followModuleInitData The follow module initialization data, if any. * @param followNFTURI The URI to use for the follow NFT. */ struct CreateProfileData { address to; string handle; string imageURI; address followModule; bytes followModuleInitData; string followNFTURI; } /** * @notice A struct containing the parameters required for the `setDefaultProfileWithSig()` function. Parameters are * the same as the regular `setDefaultProfile()` function, with an added EIP712Signature. * * @param wallet The address of the wallet setting the default profile. * @param profileId The token ID of the profile which will be set as default, or zero. * @param sig The EIP712Signature struct containing the profile owner's signature. */ struct SetDefaultProfileWithSigData { address wallet; uint256 profileId; EIP712Signature sig; } /** * @notice A struct containing the parameters required for the `setFollowModuleWithSig()` function. Parameters are * the same as the regular `setFollowModule()` function, with an added EIP712Signature. * * @param profileId The token ID of the profile to change the followModule for. * @param followModule The followModule to set for the given profile, must be whitelisted. * @param followModuleInitData The data to be passed to the followModule for initialization. * @param sig The EIP712Signature struct containing the profile owner's signature. */ struct SetFollowModuleWithSigData { uint256 profileId; address followModule; bytes followModuleInitData; EIP712Signature sig; } /** * @notice A struct containing the parameters required for the `setDispatcherWithSig()` function. Parameters are the same * as the regular `setDispatcher()` function, with an added EIP712Signature. * * @param profileId The token ID of the profile to set the dispatcher for. * @param dispatcher The dispatcher address to set for the profile. * @param sig The EIP712Signature struct containing the profile owner's signature. */ struct SetDispatcherWithSigData { uint256 profileId; address dispatcher; EIP712Signature sig; } /** * @notice A struct containing the parameters required for the `setProfileImageURIWithSig()` function. Parameters are the same * as the regular `setProfileImageURI()` function, with an added EIP712Signature. * * @param profileId The token ID of the profile to set the URI for. * @param imageURI The URI to set for the given profile image. * @param sig The EIP712Signature struct containing the profile owner's signature. */ struct SetProfileImageURIWithSigData { uint256 profileId; string imageURI; EIP712Signature sig; } /** * @notice A struct containing the parameters required for the `setFollowNFTURIWithSig()` function. Parameters are the same * as the regular `setFollowNFTURI()` function, with an added EIP712Signature. * * @param profileId The token ID of the profile for which to set the followNFT URI. * @param followNFTURI The follow NFT URI to set. * @param sig The EIP712Signature struct containing the followNFT's associated profile owner's signature. */ struct SetFollowNFTURIWithSigData { uint256 profileId; string followNFTURI; EIP712Signature sig; } /** * @notice A struct containing the parameters required for the `post()` function. * * @param profileId The token ID of the profile to publish to. * @param contentURI The URI to set for this new publication. * @param collectModule The collect module to set for this new publication. * @param collectModuleInitData The data to pass to the collect module's initialization. * @param referenceModule The reference module to set for the given publication, must be whitelisted. * @param referenceModuleInitData The data to be passed to the reference module for initialization. */ struct PostData { uint256 profileId; string contentURI; address collectModule; bytes collectModuleInitData; address referenceModule; bytes referenceModuleInitData; } /** * @notice A struct containing the parameters required for the `postWithSig()` function. Parameters are the same as * the regular `post()` function, with an added EIP712Signature. * * @param profileId The token ID of the profile to publish to. * @param contentURI The URI to set for this new publication. * @param collectModule The collectModule to set for this new publication. * @param collectModuleInitData The data to pass to the collectModule's initialization. * @param referenceModule The reference module to set for the given publication, must be whitelisted. * @param referenceModuleInitData The data to be passed to the reference module for initialization. * @param sig The EIP712Signature struct containing the profile owner's signature. */ struct PostWithSigData { uint256 profileId; string contentURI; address collectModule; bytes collectModuleInitData; address referenceModule; bytes referenceModuleInitData; EIP712Signature sig; } /** * @notice A struct containing the parameters required for the `comment()` function. * * @param profileId The token ID of the profile to publish to. * @param contentURI The URI to set for this new publication. * @param profileIdPointed The profile token ID to point the comment to. * @param pubIdPointed The publication ID to point the comment to. * @param referenceModuleData The data passed to the reference module. * @param collectModule The collect module to set for this new publication. * @param collectModuleInitData The data to pass to the collect module's initialization. * @param referenceModule The reference module to set for the given publication, must be whitelisted. * @param referenceModuleInitData The data to be passed to the reference module for initialization. */ struct CommentData { uint256 profileId; string contentURI; uint256 profileIdPointed; uint256 pubIdPointed; bytes referenceModuleData; address collectModule; bytes collectModuleInitData; address referenceModule; bytes referenceModuleInitData; } /** * @notice A struct containing the parameters required for the `commentWithSig()` function. Parameters are the same as * the regular `comment()` function, with an added EIP712Signature. * * @param profileId The token ID of the profile to publish to. * @param contentURI The URI to set for this new publication. * @param profileIdPointed The profile token ID to point the comment to. * @param pubIdPointed The publication ID to point the comment to. * @param referenceModuleData The data passed to the reference module. * @param collectModule The collectModule to set for this new publication. * @param collectModuleInitData The data to pass to the collectModule's initialization. * @param referenceModule The reference module to set for the given publication, must be whitelisted. * @param referenceModuleInitData The data to be passed to the reference module for initialization. * @param sig The EIP712Signature struct containing the profile owner's signature. */ struct CommentWithSigData { uint256 profileId; string contentURI; uint256 profileIdPointed; uint256 pubIdPointed; bytes referenceModuleData; address collectModule; bytes collectModuleInitData; address referenceModule; bytes referenceModuleInitData; EIP712Signature sig; } /** * @notice A struct containing the parameters required for the `mirror()` function. * * @param profileId The token ID of the profile to publish to. * @param profileIdPointed The profile token ID to point the mirror to. * @param pubIdPointed The publication ID to point the mirror to. * @param referenceModuleData The data passed to the reference module. * @param referenceModule The reference module to set for the given publication, must be whitelisted. * @param referenceModuleInitData The data to be passed to the reference module for initialization. */ struct MirrorData { uint256 profileId; uint256 profileIdPointed; uint256 pubIdPointed; bytes referenceModuleData; address referenceModule; bytes referenceModuleInitData; } /** * @notice A struct containing the parameters required for the `mirrorWithSig()` function. Parameters are the same as * the regular `mirror()` function, with an added EIP712Signature. * * @param profileId The token ID of the profile to publish to. * @param profileIdPointed The profile token ID to point the mirror to. * @param pubIdPointed The publication ID to point the mirror to. * @param referenceModuleData The data passed to the reference module. * @param referenceModule The reference module to set for the given publication, must be whitelisted. * @param referenceModuleInitData The data to be passed to the reference module for initialization. * @param sig The EIP712Signature struct containing the profile owner's signature. */ struct MirrorWithSigData { uint256 profileId; uint256 profileIdPointed; uint256 pubIdPointed; bytes referenceModuleData; address referenceModule; bytes referenceModuleInitData; EIP712Signature sig; } /** * @notice A struct containing the parameters required for the `followWithSig()` function. Parameters are the same * as the regular `follow()` function, with the follower's (signer) address and an EIP712Signature added. * * @param follower The follower which is the message signer. * @param profileIds The array of token IDs of the profiles to follow. * @param datas The array of arbitrary data to pass to the followModules if needed. * @param sig The EIP712Signature struct containing the follower's signature. */ struct FollowWithSigData { address follower; uint256[] profileIds; bytes[] datas; EIP712Signature sig; } /** * @notice A struct containing the parameters required for the `collectWithSig()` function. Parameters are the same as * the regular `collect()` function, with the collector's (signer) address and an EIP712Signature added. * * @param collector The collector which is the message signer. * @param profileId The token ID of the profile that published the publication to collect. * @param pubId The publication to collect's publication ID. * @param data The arbitrary data to pass to the collectModule if needed. * @param sig The EIP712Signature struct containing the collector's signature. */ struct CollectWithSigData { address collector; uint256 profileId; uint256 pubId; bytes data; EIP712Signature sig; } /** * @notice A struct containing the parameters required for the `setProfileMetadataWithSig()` function. * * @param profileId The profile ID for which to set the metadata. * @param metadata The metadata string to set for the profile and user. * @param sig The EIP712Signature struct containing the user's signature. */ struct SetProfileMetadataWithSigData { uint256 profileId; string metadata; EIP712Signature sig; } /** * @notice A struct containing the parameters required for the `toggleFollowWithSig()` function. * * @param follower The follower which is the message signer. * @param profileIds The token ID array of the profiles. * @param enables The array of booleans to enable/disable follows. * @param sig The EIP712Signature struct containing the follower's signature. */ struct ToggleFollowWithSigData { address follower; uint256[] profileIds; bool[] enables; EIP712Signature sig; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity 0.8.10; /** * @title IFollowModule * @author Lens Protocol * * @notice This is the standard interface for all Lens-compatible FollowModules. */ interface IFollowModule { /** * @notice Initializes a follow module for a given Lens profile. This can only be called by the hub contract. * * @param profileId The token ID of the profile to initialize this follow module for. * @param data Arbitrary data passed by the profile creator. * * @return bytes The encoded data to emit in the hub. */ function initializeFollowModule(uint256 profileId, bytes calldata data) external returns (bytes memory); /** * @notice Processes a given follow, this can only be called from the LensHub contract. * * @param follower The follower address. * @param profileId The token ID of the profile being followed. * @param data Arbitrary data passed by the follower. */ function processFollow( address follower, uint256 profileId, bytes calldata data ) external; /** * @notice This is a transfer hook that is called upon follow NFT transfer in `beforeTokenTransfer. This can * only be called from the LensHub contract. * * NOTE: Special care needs to be taken here: It is possible that follow NFTs were issued before this module * was initialized if the profile's follow module was previously different. This transfer hook should take this * into consideration, especially when the module holds state associated with individual follow NFTs. * * @param profileId The token ID of the profile associated with the follow NFT being transferred. * @param from The address sending the follow NFT. * @param to The address receiving the follow NFT. * @param followNFTTokenId The token ID of the follow NFT being transferred. */ function followModuleTransferHook( uint256 profileId, address from, address to, uint256 followNFTTokenId ) external; /** * @notice This is a helper function that could be used in conjunction with specific collect modules. * * NOTE: This function IS meant to replace a check on follower NFT ownership. * * NOTE: It is assumed that not all collect modules are aware of the token ID to pass. In these cases, * this should receive a `followNFTTokenId` of 0, which is impossible regardless. * * One example of a use case for this would be a subscription-based following system: * 1. The collect module: * - Decodes a follower NFT token ID from user-passed data. * - Fetches the follow module from the hub. * - Calls `isFollowing` passing the profile ID, follower & follower token ID and checks it returned true. * 2. The follow module: * - Validates the subscription status for that given NFT, reverting on an invalid subscription. * * @param profileId The token ID of the profile to validate the follow for. * @param follower The follower address to validate the follow for. * @param followNFTTokenId The followNFT token ID to validate the follow for. * * @return true if the given address is following the given profile ID, false otherwise. */ function isFollowing( uint256 profileId, address follower, uint256 followNFTTokenId ) external view returns (bool); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity 0.8.10; import {DataTypes} from '../libraries/DataTypes.sol'; /** * @title ILensHub * @author Lens Protocol * * @notice This is the interface for the LensHub contract, the main entry point for the Lens Protocol. * You'll find all the events and external functions, as well as the reasoning behind them here. */ interface ILensHub { /** * @notice Initializes the LensHub NFT, setting the initial governance address as well as the name and symbol in * the LensNFTBase contract. * * @param name The name to set for the hub NFT. * @param symbol The symbol to set for the hub NFT. * @param newGovernance The governance address to set. */ function initialize( string calldata name, string calldata symbol, address newGovernance ) external; /** * @notice Sets the privileged governance role. This function can only be called by the current governance * address. * * @param newGovernance The new governance address to set. */ function setGovernance(address newGovernance) external; /** * @notice Sets the emergency admin, which is a permissioned role able to set the protocol state. This function * can only be called by the governance address. * * @param newEmergencyAdmin The new emergency admin address to set. */ function setEmergencyAdmin(address newEmergencyAdmin) external; /** * @notice Sets the protocol state to either a global pause, a publishing pause or an unpaused state. This function * can only be called by the governance address or the emergency admin address. * * Note that this reverts if the emergency admin calls it if: * 1. The emergency admin is attempting to unpause. * 2. The emergency admin is calling while the protocol is already paused. * * @param newState The state to set, as a member of the ProtocolState enum. */ function setState(DataTypes.ProtocolState newState) external; /** * @notice Adds or removes a profile creator from the whitelist. This function can only be called by the current * governance address. * * @param profileCreator The profile creator address to add or remove from the whitelist. * @param whitelist Whether or not the profile creator should be whitelisted. */ function whitelistProfileCreator(address profileCreator, bool whitelist) external; /** * @notice Adds or removes a follow module from the whitelist. This function can only be called by the current * governance address. * * @param followModule The follow module contract address to add or remove from the whitelist. * @param whitelist Whether or not the follow module should be whitelisted. */ function whitelistFollowModule(address followModule, bool whitelist) external; /** * @notice Adds or removes a reference module from the whitelist. This function can only be called by the current * governance address. * * @param referenceModule The reference module contract to add or remove from the whitelist. * @param whitelist Whether or not the reference module should be whitelisted. */ function whitelistReferenceModule(address referenceModule, bool whitelist) external; /** * @notice Adds or removes a collect module from the whitelist. This function can only be called by the current * governance address. * * @param collectModule The collect module contract address to add or remove from the whitelist. * @param whitelist Whether or not the collect module should be whitelisted. */ function whitelistCollectModule(address collectModule, bool whitelist) external; /** * @notice Creates a profile with the specified parameters, minting a profile NFT to the given recipient. This * function must be called by a whitelisted profile creator. * * @param vars A CreateProfileData struct containing the following params: * to: The address receiving the profile. * handle: The handle to set for the profile, must be unique and non-empty. * imageURI: The URI to set for the profile image. * followModule: The follow module to use, can be the zero address. * followModuleInitData: The follow module initialization data, if any. */ function createProfile(DataTypes.CreateProfileData calldata vars) external returns (uint256); /** * @notice Sets the mapping between wallet and its main profile identity. * * @param profileId The token ID of the profile to set as the main profile identity. */ function setDefaultProfile(uint256 profileId) external; /** * @notice Sets the mapping between wallet and its main profile identity via signature with the specified parameters. * * @param vars A SetDefaultProfileWithSigData struct, including the regular parameters and an EIP712Signature struct. */ function setDefaultProfileWithSig(DataTypes.SetDefaultProfileWithSigData calldata vars) external; /** * @notice Sets a profile's follow module, must be called by the profile owner. * * @param profileId The token ID of the profile to set the follow module for. * @param followModule The follow module to set for the given profile, must be whitelisted. * @param followModuleInitData The data to be passed to the follow module for initialization. */ function setFollowModule( uint256 profileId, address followModule, bytes calldata followModuleInitData ) external; /** * @notice Sets a profile's follow module via signature with the specified parameters. * * @param vars A SetFollowModuleWithSigData struct, including the regular parameters and an EIP712Signature struct. */ function setFollowModuleWithSig(DataTypes.SetFollowModuleWithSigData calldata vars) external; /** * @notice Sets a profile's dispatcher, giving that dispatcher rights to publish to that profile. * * @param profileId The token ID of the profile of the profile to set the dispatcher for. * @param dispatcher The dispatcher address to set for the given profile ID. */ function setDispatcher(uint256 profileId, address dispatcher) external; /** * @notice Sets a profile's dispatcher via signature with the specified parameters. * * @param vars A SetDispatcherWithSigData struct, including the regular parameters and an EIP712Signature struct. */ function setDispatcherWithSig(DataTypes.SetDispatcherWithSigData calldata vars) external; /** * @notice Sets a profile's URI, which is reflected in the `tokenURI()` function. * * @param profileId The token ID of the profile of the profile to set the URI for. * @param imageURI The URI to set for the given profile. */ function setProfileImageURI(uint256 profileId, string calldata imageURI) external; /** * @notice Sets a profile's URI via signature with the specified parameters. * * @param vars A SetProfileImageURIWithSigData struct, including the regular parameters and an EIP712Signature struct. */ function setProfileImageURIWithSig(DataTypes.SetProfileImageURIWithSigData calldata vars) external; /** * @notice Sets a followNFT URI for a given profile's follow NFT. * * @param profileId The token ID of the profile for which to set the followNFT URI. * @param followNFTURI The follow NFT URI to set. */ function setFollowNFTURI(uint256 profileId, string calldata followNFTURI) external; /** * @notice Sets a followNFT URI via signature with the specified parameters. * * @param vars A SetFollowNFTURIWithSigData struct, including the regular parameters and an EIP712Signature struct. */ function setFollowNFTURIWithSig(DataTypes.SetFollowNFTURIWithSigData calldata vars) external; /** * @notice Publishes a post to a given profile, must be called by the profile owner. * * @param vars A PostData struct containing the needed parameters. * * @return uint256 An integer representing the post's publication ID. */ function post(DataTypes.PostData calldata vars) external returns (uint256); /** * @notice Publishes a post to a given profile via signature with the specified parameters. * * @param vars A PostWithSigData struct containing the regular parameters and an EIP712Signature struct. * * @return uint256 An integer representing the post's publication ID. */ function postWithSig(DataTypes.PostWithSigData calldata vars) external returns (uint256); /** * @notice Publishes a comment to a given profile, must be called by the profile owner. * * @param vars A CommentData struct containing the needed parameters. * * @return uint256 An integer representing the comment's publication ID. */ function comment(DataTypes.CommentData calldata vars) external returns (uint256); /** * @notice Publishes a comment to a given profile via signature with the specified parameters. * * @param vars A CommentWithSigData struct containing the regular parameters and an EIP712Signature struct. * * @return uint256 An integer representing the comment's publication ID. */ function commentWithSig(DataTypes.CommentWithSigData calldata vars) external returns (uint256); /** * @notice Publishes a mirror to a given profile, must be called by the profile owner. * * @param vars A MirrorData struct containing the necessary parameters. * * @return uint256 An integer representing the mirror's publication ID. */ function mirror(DataTypes.MirrorData calldata vars) external returns (uint256); /** * @notice Publishes a mirror to a given profile via signature with the specified parameters. * * @param vars A MirrorWithSigData struct containing the regular parameters and an EIP712Signature struct. * * @return uint256 An integer representing the mirror's publication ID. */ function mirrorWithSig(DataTypes.MirrorWithSigData calldata vars) external returns (uint256); /** * @notice Follows the given profiles, executing each profile's follow module logic (if any) and minting followNFTs to the caller. * * NOTE: Both the `profileIds` and `datas` arrays must be of the same length, regardless if the profiles do not have a follow module set. * * @param profileIds The token ID array of the profiles to follow. * @param datas The arbitrary data array to pass to the follow module for each profile if needed. * * @return uint256[] An array of integers representing the minted follow NFTs token IDs. */ function follow(uint256[] calldata profileIds, bytes[] calldata datas) external returns (uint256[] memory); /** * @notice Follows a given profile via signature with the specified parameters. * * @param vars A FollowWithSigData struct containing the regular parameters as well as the signing follower's address * and an EIP712Signature struct. * * @return uint256[] An array of integers representing the minted follow NFTs token IDs. */ function followWithSig(DataTypes.FollowWithSigData calldata vars) external returns (uint256[] memory); /** * @notice Collects a given publication, executing collect module logic and minting a collectNFT to the caller. * * @param profileId The token ID of the profile that published the publication to collect. * @param pubId The publication to collect's publication ID. * @param data The arbitrary data to pass to the collect module if needed. * * @return uint256 An integer representing the minted token ID. */ function collect( uint256 profileId, uint256 pubId, bytes calldata data ) external returns (uint256); /** * @notice Collects a given publication via signature with the specified parameters. * * @param vars A CollectWithSigData struct containing the regular parameters as well as the collector's address and * an EIP712Signature struct. * * @return uint256 An integer representing the minted token ID. */ function collectWithSig(DataTypes.CollectWithSigData calldata vars) external returns (uint256); /** * @dev Helper function to emit a detailed followNFT transfer event from the hub, to be consumed by frontends to track * followNFT transfers. * * @param profileId The token ID of the profile associated with the followNFT being transferred. * @param followNFTId The followNFT being transferred's token ID. * @param from The address the followNFT is being transferred from. * @param to The address the followNFT is being transferred to. */ function emitFollowNFTTransferEvent( uint256 profileId, uint256 followNFTId, address from, address to ) external; /** * @dev Helper function to emit a detailed collectNFT transfer event from the hub, to be consumed by frontends to track * collectNFT transfers. * * @param profileId The token ID of the profile associated with the collect NFT being transferred. * @param pubId The publication ID associated with the collect NFT being transferred. * @param collectNFTId The collectNFT being transferred's token ID. * @param from The address the collectNFT is being transferred from. * @param to The address the collectNFT is being transferred to. */ function emitCollectNFTTransferEvent( uint256 profileId, uint256 pubId, uint256 collectNFTId, address from, address to ) external; /// ************************ /// *****VIEW FUNCTIONS***** /// ************************ /** * @notice Returns whether or not a profile creator is whitelisted. * * @param profileCreator The address of the profile creator to check. * * @return bool True if the profile creator is whitelisted, false otherwise. */ function isProfileCreatorWhitelisted(address profileCreator) external view returns (bool); /** * @notice Returns default profile for a given wallet address * * @param wallet The address to find the default mapping * * @return uint256 The default profile id, which will be 0 if not mapped. */ function defaultProfile(address wallet) external view returns (uint256); /** * @notice Returns whether or not a follow module is whitelisted. * * @param followModule The address of the follow module to check. * * @return bool True if the the follow module is whitelisted, false otherwise. */ function isFollowModuleWhitelisted(address followModule) external view returns (bool); /** * @notice Returns whether or not a reference module is whitelisted. * * @param referenceModule The address of the reference module to check. * * @return bool True if the the reference module is whitelisted, false otherwise. */ function isReferenceModuleWhitelisted(address referenceModule) external view returns (bool); /** * @notice Returns whether or not a collect module is whitelisted. * * @param collectModule The address of the collect module to check. * * @return bool True if the the collect module is whitelisted, false otherwise. */ function isCollectModuleWhitelisted(address collectModule) external view returns (bool); /** * @notice Returns the currently configured governance address. * * @return address The address of the currently configured governance. */ function getGovernance() external view returns (address); /** * @notice Returns the dispatcher associated with a profile. * * @param profileId The token ID of the profile to query the dispatcher for. * * @return address The dispatcher address associated with the profile. */ function getDispatcher(uint256 profileId) external view returns (address); /** * @notice Returns the publication count for a given profile. * * @param profileId The token ID of the profile to query. * * @return uint256 The number of publications associated with the queried profile. */ function getPubCount(uint256 profileId) external view returns (uint256); /** * @notice Returns the followNFT associated with a given profile, if any. * * @param profileId The token ID of the profile to query the followNFT for. * * @return address The followNFT associated with the given profile. */ function getFollowNFT(uint256 profileId) external view returns (address); /** * @notice Returns the followNFT URI associated with a given profile. * * @param profileId The token ID of the profile to query the followNFT URI for. * * @return string The followNFT URI associated with the given profile. */ function getFollowNFTURI(uint256 profileId) external view returns (string memory); /** * @notice Returns the collectNFT associated with a given publication, if any. * * @param profileId The token ID of the profile that published the publication to query. * @param pubId The publication ID of the publication to query. * * @return address The address of the collectNFT associated with the queried publication. */ function getCollectNFT(uint256 profileId, uint256 pubId) external view returns (address); /** * @notice Returns the follow module associated witha given profile, if any. * * @param profileId The token ID of the profile to query the follow module for. * * @return address The address of the follow module associated with the given profile. */ function getFollowModule(uint256 profileId) external view returns (address); /** * @notice Returns the collect module associated with a given publication. * * @param profileId The token ID of the profile that published the publication to query. * @param pubId The publication ID of the publication to query. * * @return address The address of the collect module associated with the queried publication. */ function getCollectModule(uint256 profileId, uint256 pubId) external view returns (address); /** * @notice Returns the reference module associated witha given profile, if any. * * @param profileId The token ID of the profile that published the publication to querythe reference module for. * @param pubId The publication ID of the publication to query the reference module for. * * @return address The address of the reference module associated with the given profile. */ function getReferenceModule(uint256 profileId, uint256 pubId) external view returns (address); /** * @notice Returns the handle associated with a profile. * * @param profileId The token ID of the profile to query the handle for. * * @return string The handle associated with the profile. */ function getHandle(uint256 profileId) external view returns (string memory); /** * @notice Returns the publication pointer (profileId & pubId) associated with a given publication. * * @param profileId The token ID of the profile that published the publication to query the pointer for. * @param pubId The publication ID of the publication to query the pointer for. * * @return tuple First, the profile ID of the profile the current publication is pointing to, second, the * publication ID of the publication the current publication is pointing to. */ function getPubPointer(uint256 profileId, uint256 pubId) external view returns (uint256, uint256); /** * @notice Returns the URI associated with a given publication. * * @param profileId The token ID of the profile that published the publication to query. * @param pubId The publication ID of the publication to query. * * @return string The URI associated with a given publication. */ function getContentURI(uint256 profileId, uint256 pubId) external view returns (string memory); /** * @notice Returns the profile token ID according to a given handle. * * @param handle The handle to resolve the profile token ID with. * * @return uint256 The profile ID the passed handle points to. */ function getProfileIdByHandle(string calldata handle) external view returns (uint256); /** * @notice Returns the full profile struct associated with a given profile token ID. * * @param profileId The token ID of the profile to query. * * @return ProfileStruct The profile struct of the given profile. */ function getProfile(uint256 profileId) external view returns (DataTypes.ProfileStruct memory); /** * @notice Returns the full publication struct for a given publication. * * @param profileId The token ID of the profile that published the publication to query. * @param pubId The publication ID of the publication to query. * * @return PublicationStruct The publication struct associated with the queried publication. */ function getPub(uint256 profileId, uint256 pubId) external view returns (DataTypes.PublicationStruct memory); /** * @notice Returns the publication type associated with a given publication. * * @param profileId The token ID of the profile that published the publication to query. * @param pubId The publication ID of the publication to query. * * @return PubType The publication type, as a member of an enum (either "post," "comment" or "mirror"). */ function getPubType(uint256 profileId, uint256 pubId) external view returns (DataTypes.PubType); /** * @notice Returns the follow NFT implementation address. * * @return address The follow NFT implementation address. */ function getFollowNFTImpl() external view returns (address); /** * @notice Returns the collect NFT implementation address. * * @return address The collect NFT implementation address. */ function getCollectNFTImpl() external view returns (address); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol) pragma solidity ^0.8.0; /** * @dev Interface of the ERC165 standard, as defined in the * https://eips.ethereum.org/EIPS/eip-165[EIP]. * * Implementers can declare support of contract interfaces, which can then be * queried by others ({ERC165Checker}). * * For an implementation, see {ERC165}. */ interface IERC165 { /** * @dev Returns true if this contract implements the interface defined by * `interfaceId`. See the corresponding * https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section] * to learn more about how these ids are created. * * This function call must use less than 30 000 gas. */ function supportsInterface(bytes4 interfaceId) external view returns (bool); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.5.0) (utils/Address.sol) pragma solidity ^0.8.1; /** * @dev Collection of functions related to the address type */ library Address { /** * @dev Returns true if `account` is a contract. * * [IMPORTANT] * ==== * It is unsafe to assume that an address for which this function returns * false is an externally-owned account (EOA) and not a contract. * * Among others, `isContract` will return false for the following * types of addresses: * * - an externally-owned account * - a contract in construction * - an address where a contract will be created * - an address where a contract lived, but was destroyed * ==== * * [IMPORTANT] * ==== * You shouldn't rely on `isContract` to protect against flash loan attacks! * * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract * constructor. * ==== */ function isContract(address account) internal view returns (bool) { // This method relies on extcodesize/address.code.length, which returns 0 // for contracts in construction, since the code is only stored at the end // of the constructor execution. return account.code.length > 0; } /** * @dev Replacement for Solidity's `transfer`: sends `amount` wei to * `recipient`, forwarding all available gas and reverting on errors. * * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost * of certain opcodes, possibly making contracts go over the 2300 gas limit * imposed by `transfer`, making them unable to receive funds via * `transfer`. {sendValue} removes this limitation. * * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more]. * * IMPORTANT: because control is transferred to `recipient`, care must be * taken to not create reentrancy vulnerabilities. Consider using * {ReentrancyGuard} or the * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern]. */ function sendValue(address payable recipient, uint256 amount) internal { require(address(this).balance >= amount, "Address: insufficient balance"); (bool success, ) = recipient.call{value: amount}(""); require(success, "Address: unable to send value, recipient may have reverted"); } /** * @dev Performs a Solidity function call using a low level `call`. A * plain `call` is an unsafe replacement for a function call: use this * function instead. * * If `target` reverts with a revert reason, it is bubbled up by this * function (like regular Solidity function calls). * * Returns the raw returned data. To convert to the expected return value, * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`]. * * Requirements: * * - `target` must be a contract. * - calling `target` with `data` must not revert. * * _Available since v3.1._ */ function functionCall(address target, bytes memory data) internal returns (bytes memory) { return functionCall(target, data, "Address: low-level call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with * `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { return functionCallWithValue(target, data, 0, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but also transferring `value` wei to `target`. * * Requirements: * * - the calling contract must have an ETH balance of at least `value`. * - the called Solidity function must be `payable`. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value ) internal returns (bytes memory) { return functionCallWithValue(target, data, value, "Address: low-level call with value failed"); } /** * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but * with `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value, string memory errorMessage ) internal returns (bytes memory) { require(address(this).balance >= value, "Address: insufficient balance for call"); require(isContract(target), "Address: call to non-contract"); (bool success, bytes memory returndata) = target.call{value: value}(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) { return functionStaticCall(target, data, "Address: low-level static call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall( address target, bytes memory data, string memory errorMessage ) internal view returns (bytes memory) { require(isContract(target), "Address: static call to non-contract"); (bool success, bytes memory returndata) = target.staticcall(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) { return functionDelegateCall(target, data, "Address: low-level delegate call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { require(isContract(target), "Address: delegate call to non-contract"); (bool success, bytes memory returndata) = target.delegatecall(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the * revert reason using the provided one. * * _Available since v4.3._ */ function verifyCallResult( bool success, bytes memory returndata, string memory errorMessage ) internal pure returns (bytes memory) { if (success) { return returndata; } else { // Look for revert reason and bubble it up if present if (returndata.length > 0) { // The easiest way to bubble the revert reason is using memory via assembly assembly { let returndata_size := mload(returndata) revert(add(32, returndata), returndata_size) } } else { revert(errorMessage); } } } }
{ "optimizer": { "enabled": true, "runs": 200, "details": { "yul": true } }, "outputSelection": { "*": { "*": [ "evm.bytecode", "evm.deployedBytecode", "devdoc", "userdoc", "metadata", "abi" ] } }, "libraries": {} }
[{"inputs":[{"internalType":"address","name":"hub","type":"address"},{"internalType":"address","name":"moduleGlobals","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"CollectExpired","type":"error"},{"inputs":[],"name":"FollowInvalid","type":"error"},{"inputs":[],"name":"InitParamsInvalid","type":"error"},{"inputs":[],"name":"MintLimitExceeded","type":"error"},{"inputs":[],"name":"ModuleDataMismatch","type":"error"},{"inputs":[],"name":"NotHub","type":"error"},{"inputs":[],"name":"HUB","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MODULE_GLOBALS","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"profileId","type":"uint256"},{"internalType":"uint256","name":"pubId","type":"uint256"}],"name":"getPublicationData","outputs":[{"components":[{"internalType":"uint256","name":"collectLimit","type":"uint256"},{"internalType":"uint256","name":"currentCollects","type":"uint256"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"address","name":"currency","type":"address"},{"internalType":"address","name":"recipient","type":"address"},{"internalType":"uint16","name":"referralFee","type":"uint16"},{"internalType":"bool","name":"followerOnly","type":"bool"},{"internalType":"uint40","name":"endTimestamp","type":"uint40"}],"internalType":"struct ProfilePublicationData","name":"","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"profileId","type":"uint256"},{"internalType":"uint256","name":"pubId","type":"uint256"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"initializePublicationCollectModule","outputs":[{"internalType":"bytes","name":"","type":"bytes"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"referrerProfileId","type":"uint256"},{"internalType":"address","name":"collector","type":"address"},{"internalType":"uint256","name":"profileId","type":"uint256"},{"internalType":"uint256","name":"pubId","type":"uint256"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"processCollect","outputs":[],"stateMutability":"nonpayable","type":"function"}]
Contract Creation Code
60c06040523480156200001157600080fd5b506040516200163438038062001634833981016040819052620000349162000131565b81816001600160a01b0381166200005e576040516348be0eb360e01b815260040160405180910390fd5b6001600160a01b03811660808190526040514281527f4e84a529f4c627b5e787037d117873af1018768804cca3c7f0d47041fe2c89ed9060200160405180910390a2506001600160a01b038116620000c9576040516348be0eb360e01b815260040160405180910390fd5b6001600160a01b03811660a08190526040514281527ff1a1fa6b64aa95186f5a1285e76198d0da80d9c5a88062641d447f1d7c54e56c9060200160405180910390a250505062000169565b80516001600160a01b03811681146200012c57600080fd5b919050565b600080604083850312156200014557600080fd5b620001508362000114565b9150620001606020840162000114565b90509250929050565b60805160a05161146d620001c76000396000818161019e01528181610202015281816105010152818161070501528181610823015281816109310152610baf01526000818161015f015281816106790152610cf2015261146d6000f3fe608060405234801561001057600080fd5b50600436106100575760003560e01c80633f5038921461005c57806388ffe8511461015a578063a4c52b8614610199578063c233f951146101c0578063e49c3dda146101e0575b600080fd5b61014461006a36600461101b565b6040805161010081018252600080825260208201819052918101829052606081018290526080810182905260a0810182905260c0810182905260e081019190915250600091825260208281526040808420928452918152918190208151610100810183528154815260018201549381019390935260028101549183019190915260038101546001600160a01b0390811660608401526004909101549081166080830152600160a01b810461ffff1660a0830152600160b01b810460ff16151560c0830152600160b81b900464ffffffffff1660e082015290565b604051610151919061103d565b60405180910390f35b6101817f000000000000000000000000000000000000000000000000000000000000000081565b6040516001600160a01b039091168152602001610151565b6101817f000000000000000000000000000000000000000000000000000000000000000081565b6101d36101ce366004611102565b6101f5565b60405161015191906111ad565b6101f36101ee3660046111d8565b6104f6565b005b6060336001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001614610240576040516313bd2e8360e31b815260040160405180910390fd5b42620151800160008080808080610259898b018b611269565b955095509550955095509550856000148061027a575061027884610657565b155b8061028c57506001600160a01b038316155b8061029c575061271061ffff8316115b806102a5575084155b156102c3576040516348be0eb360e01b815260040160405180910390fd5b856000808e815260200190815260200160002060008d815260200190815260200160002060000181905550846000808e815260200190815260200160002060008d815260200190815260200160002060020181905550836000808e815260200190815260200160002060008d815260200190815260200160002060030160006101000a8154816001600160a01b0302191690836001600160a01b03160217905550826000808e815260200190815260200160002060008d815260200190815260200160002060040160006101000a8154816001600160a01b0302191690836001600160a01b03160217905550816000808e815260200190815260200160002060008d815260200190815260200160002060040160146101000a81548161ffff021916908361ffff160217905550806000808e815260200190815260200160002060008d815260200190815260200160002060040160166101000a81548160ff021916908315150217905550866000808e815260200190815260200160002060008d815260200190815260200160002060040160176101000a81548164ffffffffff021916908364ffffffffff1602179055508585858585858c6040516020016104d6979695949392919096875260208701959095526001600160a01b03938416604087015291909216606085015261ffff919091166080840152151560a083015264ffffffffff1660c082015260e00190565b604051602081830303815290604052975050505050505050949350505050565b336001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000161461053f576040516313bd2e8360e31b815260040160405180910390fd5b600084815260208181526040808320868452909152902060040154600160b01b900460ff16156105735761057384866106ec565b600084815260208181526040808320868452909152902060040154600160b81b900464ffffffffff16428110156105bd576040516304cd703960e51b815260040160405180910390fd5b60008581526020818152604080832087845290915290208054600190910154106105fa57604051635b21dfd360e11b815260040160405180910390fd5b60008581526020818152604080832087845290915281206001018054909190610622906112ef565b90915550868514156106405761063b86868686866109ee565b61064e565b61064e878787878787610ac6565b50505050505050565b6040516343b938c560e01b81526001600160a01b0382811660048301526000917f0000000000000000000000000000000000000000000000000000000000000000909116906343b938c590602401602060405180830381865afa1580156106c2573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106e6919061130a565b92915050565b604051633648f48360e21b8152600481018390526000907f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03169063d923d20c90602401602060405180830381865afa158015610754573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906107789190611327565b905060006001600160a01b0382161561080a576040516311470f4360e21b8152600481018590526001600160a01b0384811660248301526000604483015283169063451c3d0c90606401602060405180830381865afa1580156107df573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610803919061130a565b905061091c565b60405163a9ec656360e01b8152600481018590526000907f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03169063a9ec656390602401602060405180830381865afa158015610872573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906108969190611327565b90506001600160a01b0381161580159061091857506040516370a0823160e01b81526001600160a01b0385811660048301528216906370a0823190602401602060405180830381865afa1580156108f1573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906109159190611344565b15155b9150505b801580156109ca5750826001600160a01b03167f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316636352211e866040518263ffffffff1660e01b815260040161097d91815260200190565b602060405180830381865afa15801561099a573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906109be9190611327565b6001600160a01b031614155b156109e857604051636992d36b60e11b815260040160405180910390fd5b50505050565b600084815260208181526040808320868452909152902060028101546003909101546001600160a01b0316610a2584848385610c93565b600080610a30610ced565b60008a8152602081815260408083208c84529091528120600401549294509092506001600160a01b0390911690612710610a6e61ffff85168861135d565b610a78919061137c565b90506000610a86828861139e565b9050610a9d6001600160a01b0387168d8584610d79565b8115610ab857610ab86001600160a01b0387168d8785610d79565b505050505050505050505050565b600084815260208181526040808320868452909152902060028101546003909101546001600160a01b0316610afd84848385610c93565b600086815260208181526040808320888452909152812060040154600160a01b900461ffff16908080610b2e610ced565b9093509050612710610b4461ffff83168861135d565b610b4e919061137c565b915060009050610b5e828761139e565b90508315610c34576000612710610b75868461135d565b610b7f919061137c565b9050610b8b818361139e565b6040516331a9108f60e11b8152600481018f90529092506000906001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001690636352211e90602401602060405180830381865afa158015610bf6573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610c1a9190611327565b9050610c316001600160a01b0388168e8385610d79565b50505b60008a8152602081815260408083208c84529091529020600401546001600160a01b0390811690610c699087168d8385610d79565b8215610c8457610c846001600160a01b0387168d8686610d79565b50505050505050505050505050565b600080610ca2858701876113b5565b915091508281141580610cc75750836001600160a01b0316826001600160a01b031614155b15610ce5576040516346308bd560e01b815260040160405180910390fd5b505050505050565b6000807f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166398f965d16040518163ffffffff1660e01b81526004016040805180830381865afa158015610d4d573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610d7191906113e1565b915091509091565b604080516001600160a01b038581166024830152848116604483015260648083018590528351808403909101815260849092018352602080830180516001600160e01b03166323b872dd60e01b17905283518085019094528084527f5361666545524332303a206c6f772d6c6576656c2063616c6c206661696c6564908401526109e892879291600091610e11918516908490610e98565b805190915015610e935780806020019051810190610e2f919061130a565b610e935760405162461bcd60e51b815260206004820152602a60248201527f5361666545524332303a204552433230206f7065726174696f6e20646964206e6044820152691bdd081cdd58d8d9595960b21b60648201526084015b60405180910390fd5b505050565b6060610ea78484600085610eb1565b90505b9392505050565b606082471015610f125760405162461bcd60e51b815260206004820152602660248201527f416464726573733a20696e73756666696369656e742062616c616e636520666f6044820152651c8818d85b1b60d21b6064820152608401610e8a565b6001600160a01b0385163b610f695760405162461bcd60e51b815260206004820152601d60248201527f416464726573733a2063616c6c20746f206e6f6e2d636f6e74726163740000006044820152606401610e8a565b600080866001600160a01b03168587604051610f85919061141b565b60006040518083038185875af1925050503d8060008114610fc2576040519150601f19603f3d011682016040523d82523d6000602084013e610fc7565b606091505b5091509150610fd7828286610fe2565b979650505050505050565b60608315610ff1575081610eaa565b8251156110015782518084602001fd5b8160405162461bcd60e51b8152600401610e8a91906111ad565b6000806040838503121561102e57600080fd5b50508035926020909101359150565b600061010082019050825182526020830151602083015260408301516040830152606083015160018060a01b038082166060850152806080860151166080850152505061ffff60a08401511660a083015260c0830151151560c083015260e08301516110b260e084018264ffffffffff169052565b5092915050565b60008083601f8401126110cb57600080fd5b50813567ffffffffffffffff8111156110e357600080fd5b6020830191508360208285010111156110fb57600080fd5b9250929050565b6000806000806060858703121561111857600080fd5b8435935060208501359250604085013567ffffffffffffffff81111561113d57600080fd5b611149878288016110b9565b95989497509550505050565b60005b83811015611170578181015183820152602001611158565b838111156109e85750506000910152565b60008151808452611199816020860160208601611155565b601f01601f19169290920160200192915050565b602081526000610eaa6020830184611181565b6001600160a01b03811681146111d557600080fd5b50565b60008060008060008060a087890312156111f157600080fd5b863595506020870135611203816111c0565b94506040870135935060608701359250608087013567ffffffffffffffff81111561122d57600080fd5b61123989828a016110b9565b979a9699509497509295939492505050565b61ffff811681146111d557600080fd5b80151581146111d557600080fd5b60008060008060008060c0878903121561128257600080fd5b8635955060208701359450604087013561129b816111c0565b935060608701356112ab816111c0565b925060808701356112bb8161124b565b915060a08701356112cb8161125b565b809150509295509295509295565b634e487b7160e01b600052601160045260246000fd5b6000600019821415611303576113036112d9565b5060010190565b60006020828403121561131c57600080fd5b8151610eaa8161125b565b60006020828403121561133957600080fd5b8151610eaa816111c0565b60006020828403121561135657600080fd5b5051919050565b6000816000190483118215151615611377576113776112d9565b500290565b60008261139957634e487b7160e01b600052601260045260246000fd5b500490565b6000828210156113b0576113b06112d9565b500390565b600080604083850312156113c857600080fd5b82356113d3816111c0565b946020939093013593505050565b600080604083850312156113f457600080fd5b82516113ff816111c0565b60208401519092506114108161124b565b809150509250929050565b6000825161142d818460208701611155565b919091019291505056fea2646970667358221220adf3717951b2b8e727d40a37ed9c6ca9c2e035c0fee2c0c8b56b981d441813ed64736f6c634300080a003300000000000000000000000060ae865ee4c725cd04353b5aab364553f56cef820000000000000000000000001353aadfe5fed85382826757a95de908bd21c4f9
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
00000000000000000000000060ae865ee4c725cd04353b5aab364553f56cef820000000000000000000000001353aadfe5fed85382826757a95de908bd21c4f9
-----Decoded View---------------
Arg [0] : hub (address): 0x60ae865ee4c725cd04353b5aab364553f56cef82
Arg [1] : moduleGlobals (address): 0x1353aadfe5fed85382826757a95de908bd21c4f9
-----Encoded View---------------
2 Constructor Arguments found :
Arg [0] : 00000000000000000000000060ae865ee4c725cd04353b5aab364553f56cef82
Arg [1] : 0000000000000000000000001353aadfe5fed85382826757a95de908bd21c4f9
Age | Block | Fee Address | BC Fee Address | Voting Power | Jailed | Incoming |
---|