mirror of
https://github.com/lens-protocol/core.git
synced 2026-01-11 15:18:08 -05:00
73 lines
3.0 KiB
Solidity
73 lines
3.0 KiB
Solidity
// SPDX-License-Identifier: MIT
|
|
|
|
pragma solidity >=0.6.0;
|
|
|
|
import {Types} from 'contracts/libraries/constants/Types.sol';
|
|
|
|
/**
|
|
* @title IReferenceModule
|
|
* @author Lens Protocol
|
|
*
|
|
* @notice This is the standard interface for all Lens-compatible ReferenceModules.
|
|
* Reference modules allow executing some action when a publication is referenced, like:
|
|
* - Rewards for mirroring/commenting/quoting a publication.
|
|
* - Token-gated comments/mirrors/quotes of a publication.
|
|
* - Etc.
|
|
*/
|
|
interface IReferenceModule {
|
|
/**
|
|
* @notice Initializes data for the given publication being published with this Reference module.
|
|
* @custom:permissions LensHub.
|
|
*
|
|
* @param profileId The token ID of the profile publishing the publication.
|
|
* @param pubId The associated publication's LensHub publication ID.
|
|
* @param transactionExecutor The address of the transaction executor (e.g. for any funds to transferFrom).
|
|
* @param data Arbitrary data passed from the user to be decoded by the Reference Module during initialization.
|
|
*
|
|
* @return bytes Any custom ABI-encoded data. This will be a LensHub event params that can be used by
|
|
* indexers or UIs.
|
|
*/
|
|
function initializeReferenceModule(
|
|
uint256 profileId,
|
|
uint256 pubId,
|
|
address transactionExecutor,
|
|
bytes calldata data
|
|
) external returns (bytes memory);
|
|
|
|
/**
|
|
* @notice Processes a comment being published. This includes any module logic like transferring tokens,
|
|
* checking for conditions (e.g. token-gated), etc.
|
|
* @custom:permissions LensHub.
|
|
*
|
|
* @param processCommentParams The parameters for processing a comment.
|
|
*
|
|
* @return bytes Any custom ABI-encoded data. This will be a LensHub event params that can be used by
|
|
* indexers or UIs.
|
|
*/
|
|
function processComment(Types.ProcessCommentParams calldata processCommentParams) external returns (bytes memory);
|
|
|
|
/**
|
|
* @notice Processes a quote being published. This includes any module logic like transferring tokens,
|
|
* checking for conditions (e.g. token-gated), etc.
|
|
* @custom:permissions LensHub
|
|
*
|
|
* @param processQuoteParams The parameters for processing a quote.
|
|
*
|
|
* @return bytes Any custom ABI-encoded data. This will be a LensHub event params that can be used by
|
|
* indexers or UIs.
|
|
*/
|
|
function processQuote(Types.ProcessQuoteParams calldata processQuoteParams) external returns (bytes memory);
|
|
|
|
/**
|
|
* @notice Processes a mirror being published. This includes any module logic like transferring tokens,
|
|
* checking for conditions (e.g. token-gated), etc.
|
|
* @custom:permissions LensHub
|
|
*
|
|
* @param processMirrorParams The parameters for processing a mirror.
|
|
*
|
|
* @return bytes Any custom ABI-encoded data. This will be a LensHub event params that can be used by
|
|
* indexers or UIs.
|
|
*/
|
|
function processMirror(Types.ProcessMirrorParams calldata processMirrorParams) external returns (bytes memory);
|
|
}
|