Files
core/contracts/interfaces/IDeprecatedReferenceModule.sol
vicnaum f88d23b4de misc: Grammar fixes
Co-authored-by: Alan <donosonaumczuk@gmail.com>
2023-03-24 16:09:34 +01:00

58 lines
2.3 KiB
Solidity

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.15;
/**
* @title IReferenceModule
* @author Lens Protocol
*
* @notice This is the deprecated interface for previously Lens-compatible ReferenceModules.
*/
interface IDeprecatedReferenceModule {
/**
* @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 initializeReferenceModule(
uint256 profileId,
uint256 pubId,
bytes calldata data
) external returns (bytes memory);
/**
* @notice Processes a comment action referencing a given publication. This can only be called by the hub.
*
* @param profileId The token ID of the profile associated with the publication being published.
* @param pointedProfileId The profile ID of the profile associated with the publication being referenced.
* @param pointedPubId The publication ID of the publication being referenced.
* @param data Arbitrary data __passed from the commenter!__ to be decoded.
*/
function processComment(
uint256 profileId,
uint256 pointedProfileId,
uint256 pointedPubId,
bytes calldata data
) external;
/**
* @notice Processes a mirror action referencing a given publication. This can only be called by the hub.
*
* @param profileId The token ID of the profile associated with the publication being published.
* @param pointedProfileId The profile ID of the profile associated with the publication being referenced.
* @param pointedPubId The publication ID of the publication being referenced.
* @param data Arbitrary data __passed from the mirrorer!__ to be decoded.
*/
function processMirror(
uint256 profileId,
uint256 pointedProfileId,
uint256 pointedPubId,
bytes calldata data
) external;
}