Files
core/contracts/interfaces/ICollectModule.sol
Peter Michael dd137b2dee Initial commit
2022-01-25 15:19:42 -05:00

45 lines
1.7 KiB
Solidity

// SPDX-License-Identifier: AGPL-3.0-only
pragma solidity 0.8.10;
/**
* @title ICollectModule
* @author Lens
*
* @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 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;
}