DegreesOfSeparationReferenceModule

Git Source

Inherits: HubRestricted, IReferenceModule

Author: Lens Protocol

This reference module allows to set a degree of separation n, and then allows to quote/comment/mirror only to profiles that are at most at n degrees of separation from the source profile, which is expected to be set as the author of the root publication.

State Variables

MAX_DEGREES_OF_SEPARATION

Because of the "Six degrees of separation" theory, in the long term, setting up 5, 6 or more degrees of separation will be almost equivalent to turning off the restriction. If we also take into account the gas cost of performing the validations on-chain, and the cost of off-chain computation of the path, makes sense to only support up to 3 degrees of separation.

uint8 public constant MAX_DEGREES_OF_SEPARATION = 2;

_moduleConfig

mapping(uint256 profileId => mapping(uint256 pubId => ModuleConfig config)) internal _moduleConfig;

Functions

constructor

constructor(address hub) HubRestricted(hub);

initializeReferenceModule

Initializes data for the given publication being published with this Reference module.

*The data param should have ABI-encoded the following information:

• bool commentsRestricted: Indicates if the comment operation is restricted or open to everyone.
• bool quotesRestricted: Indicates if the quote operation is restricted or open to everyone.
• bool mirrorsRestricted: Indicates if the mirror operation is restricted or open to everyone.
• uint8 degreesOfSeparation: The max degrees of separation allowed for restricted operations.
• uint128 sourceProfile The ID of the profile from where the follower path should be started. Expected to be set as the author of the root publication.*

function initializeReferenceModule(uint256 profileId, uint256 pubId, address, bytes calldata data)
    external
    override
    onlyHub
    returns (bytes memory);

Parameters

Returns

processComment

Processes a comment being published. This includes any module logic like transferring tokens, checking for conditions (e.g. token-gated), etc.

It will apply the degrees of separation restriction if the publication has commentsRestricted enabled. The param processCommentParams.data has ABI-encoded the array of profile IDs representing the follower path between the source profile and the profile authoring the comment. In addition, if comments were restricted, inheritance of commenting restrictions will be enforced.

function processComment(Types.ProcessCommentParams calldata processCommentParams)
    external
    view
    override
    onlyHub
    returns (bytes memory);

Parameters

Returns

processQuote

Processes a quote being published. This includes any module logic like transferring tokens, checking for conditions (e.g. token-gated), etc.

It will apply the degrees of separation restriction if the publication has quotesRestricted enabled. The param processQuoteParams.data has ABI-encoded the array of profile IDs representing the follower path between the source profile and the profile authoring the quote.

function processQuote(Types.ProcessQuoteParams calldata processQuoteParams)
    external
    view
    override
    onlyHub
    returns (bytes memory);

Parameters

Returns

processMirror

Processes a mirror being published. This includes any module logic like transferring tokens, checking for conditions (e.g. token-gated), etc.

It will apply the degrees of separation restriction if the publication has mirrorsRestricted enabled. The param processMirrorParams.data has ABI-encoded the array of profile IDs representing the follower path between the source profile and the profile authoring the mirror.

function processMirror(Types.ProcessMirrorParams calldata processMirrorParams)
    external
    view
    override
    onlyHub
    returns (bytes memory);

Parameters

Returns

getModuleConfig

Gets the module configuration for the given publication.

function getModuleConfig(uint256 profileId, uint256 pubId) external view returns (ModuleConfig memory);

Parameters

Returns

_validateDegreesOfSeparationRestriction

The data has encoded an array of integers, each integer is a profile ID, the whole array represents a path of n profiles. Let's define X --> Y as The owner of X is following Y. Then, being path[i] the i-th profile in the path, the following condition must be met for a given path of n profiles: sourceProfile --> path[0] --> path[1] --> path[2] --> ... --> path[n-2] --> path[n-1] --> profileId

function _validateDegreesOfSeparationRestriction(
    uint256 sourceProfile,
    uint256 profileId,
    uint8 degreesOfSeparation,
    uint256[] memory profilePath
) internal view;

Parameters

_validateCommentInheritedConfigFromPointedPub

Validates that the comment configuration is inherited from pointed publication.

function _validateCommentInheritedConfigFromPointedPub(ModuleConfig memory pointedPubConfig, uint256 profileId)
    internal
    view;

Parameters

Errors

InvalidDegreesOfSeparation

error InvalidDegreesOfSeparation();

OperationDisabled

error OperationDisabled();

ProfilePathExceedsDegreesOfSeparation

error ProfilePathExceedsDegreesOfSeparation();

NotInheritingPointedPubConfig

error NotInheritingPointedPubConfig();