@@@@@@@@@
                                        @@@@@@@@@@@@@@@@@@@@@
                                    @@@@@@@@@@@@@@@@@@@@@@@@@@@@
                                  @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
                                @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
              @@@@@@@@@@@       @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@      @@@@@@@@@@@
        @@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@
      @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
    @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@              @@@@@@@@@@@@@@              @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@          @@@@@@@   @@@@@@@@@         @@@@@@    @@@@@@@@@@@@@@@@@@@@@@@@@
  @@@@@@@@@@@@@@@@@@@@@@  @@        @@@@@@@@  @@@@@@   @       @@@@@@@@   @@@@@@@@@@@@@@@@@@@@@@
    @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
      @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
          @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
            @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@            @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
                @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@  @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
                      @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
                          @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
                                  @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Lens Protocol

The Lens Protocol is a decentralized, non-custodial social graph. Lens implements unique, on-chain social interaction mechanisms analogous to commonly understood Web2 social media interactions, but significantly expanded with unique functionality that empower communities to form and participants to own their own social graph.

Cloning

You must clone the repo using SSH:

git clone [email protected]:lens-protocol/core-private.git

Setup

1. Install Foundry by following the instructions from their repository.
   • curl -L https://foundry.paradigm.xyz | bash
   • foundryup
   • done
2. Install the dependencies by running : npm i && forge install

You can now build it using:

npm run build

Testing

You can run unit tests using

npm run test

Coverage

You can run coverage using

npm run coverage

You can go to our docs to learn more about Lens Protocol.

Contents

• upgradeability
• ERC2981CollectionRoyalties
• HubRestricted
• LensBaseERC721
• LensGovernable
• LensHubEventHooks
• LensHubStorage
• LensImplGetters
• LensProfiles

Contents

• FollowNFTProxy
• VersionedInitializable

FollowNFTProxy

Git Source

Inherits: Proxy

State Variables

HUB

address immutable HUB;

Functions

constructor

constructor(bytes memory data);

_implementation

function _implementation() internal view override returns (address);

VersionedInitializable

Git Source

Author: Lens Protocol, inspired by Aave's implementation, which is in turn inspired by OpenZeppelin's Initializable contract

Helper contract to implement initializer functions. To use it, replace the constructor with a function that has the initializer modifier. WARNING: Unlike constructors, initializer functions must be manually invoked. This applies both to deploying an Initializable contract, as well as extending an Initializable contract via inheritance. WARNING: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or ensure that all initializers are idempotent, because this is not dealt with automatically as with constructors. This is slightly modified from Aave's version.

State Variables

originalImpl

address private immutable originalImpl;

Functions

initializer

Modifier to use in the initializer function of a contract.

modifier initializer();

constructor

constructor();

getRevision

returns the revision number of the contract Needs to be defined in the inherited class as a constant.

function getRevision() internal pure virtual returns (uint256);

ERC2981CollectionRoyalties

Git Source

Inherits: IERC2981

State Variables

BASIS_POINTS

uint16 internal constant BASIS_POINTS = 10000;

INTERFACE_ID_ERC2981

bytes4 internal constant INTERFACE_ID_ERC2981 = 0x2a55205a;

Functions

supportsInterface

See {IERC165-supportsInterface}.

function supportsInterface(bytes4 interfaceId) public view virtual returns (bool);

setRoyalty

Changes the royalty percentage for secondary sales.

function setRoyalty(uint256 royaltiesInBasisPoints) external;

Parameters

royaltyInfo

Called with the sale price to determine how much royalty is owed and to whom.

function royaltyInfo(uint256 tokenId, uint256 salePrice) external view returns (address, uint256);

Parameters

Returns

_setRoyalty

function _setRoyalty(uint256 royaltiesInBasisPoints) internal virtual;

_getRoyaltyAmount

function _getRoyaltyAmount(uint256, uint256 salePrice) internal view virtual returns (uint256);

_storeRoyaltiesInBasisPoints

function _storeRoyaltiesInBasisPoints(uint256 royaltiesInBasisPoints) internal virtual;

_loadRoyaltiesInBasisPoints

function _loadRoyaltiesInBasisPoints() internal view virtual returns (uint256);

_beforeRoyaltiesSet

function _beforeRoyaltiesSet(uint256 royaltiesInBasisPoints) internal view virtual;

_getRoyaltiesInBasisPointsSlot

function _getRoyaltiesInBasisPointsSlot() internal view virtual returns (uint256);

_getReceiver

function _getReceiver(uint256 tokenId) internal view virtual returns (address);

HubRestricted

Git Source

Author: Lens Protocol

This abstract contract adds a public HUB immutable field, as well as an onlyHub modifier, to inherit from contracts that have functions restricted to be only called by the Lens hub.

State Variables

HUB

address public immutable HUB;

Functions

onlyHub

modifier onlyHub();

constructor

constructor(address hub);

LensBaseERC721

Git Source

Inherits: ERC165, ILensERC721

*Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC721] Non-Fungible Token Standard, including the Metadata extension, but not including the Enumerable extension, which is available separately as {ERC721Enumerable}. Modifications:

1. Refactored _operatorApprovals setter into an internal function to allow meta-transactions.
2. Constructor replaced with an initializer.
3. Mint timestamp is now stored in a TokenData struct alongside the owner address.*

State Variables

_name

string private _name;

_symbol

string private _symbol;

_tokenData

mapping(uint256 => Types.TokenData) private _tokenData;

_balances

mapping(address => uint256) private _balances;

_tokenApprovals

mapping(uint256 => address) private _tokenApprovals;

_operatorApprovals

mapping(address => mapping(address => bool)) private _operatorApprovals;

__DEPRECATED__ownedTokens

mapping(address => mapping(uint256 => uint256)) private __DEPRECATED__ownedTokens;

__DEPRECATED__ownedTokensIndex

mapping(uint256 => uint256) private __DEPRECATED__ownedTokensIndex;

_totalSupply

uint256 private _totalSupply;

__DEPRECATED__allTokensIndex

mapping(uint256 => uint256) private __DEPRECATED__allTokensIndex;

_nonces

mapping(address => uint256) private _nonces;

Functions

_initialize

Initializes the ERC721 name and symbol.

function _initialize(string calldata name_, string calldata symbol_) internal;

Parameters

tokenURI

Returns the Uniform Resource Identifier (URI) for tokenId token.

function tokenURI(uint256 tokenId) external view virtual returns (string memory);

supportsInterface

See {IERC165-supportsInterface}.

function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool);

nonces

function nonces(address signer) public view override returns (uint256);

getDomainSeparator

Returns the EIP-712 domain separator for this contract.

function getDomainSeparator() external view virtual override returns (bytes32);

Returns

balanceOf

See {IERC721-balanceOf}.

function balanceOf(address owner) public view virtual override returns (uint256);

ownerOf

See {IERC721-ownerOf}.

function ownerOf(uint256 tokenId) public view virtual override returns (address);

mintTimestampOf

See {IERC721Timestamped-mintTimestampOf}

function mintTimestampOf(uint256 tokenId) public view virtual override returns (uint256);

tokenDataOf

See {IERC721Timestamped-tokenDataOf}

function tokenDataOf(uint256 tokenId) public view virtual override returns (Types.TokenData memory);

exists

See {IERC721Timestamped-exists}

function exists(uint256 tokenId) public view virtual override returns (bool);

name

See {IERC721Metadata-name}.

function name() public view virtual override returns (string memory);

symbol

See {IERC721Metadata-symbol}.

function symbol() public view virtual override returns (string memory);

totalSupply

function totalSupply() external view virtual override returns (uint256);

approve

See {IERC721-approve}.

function approve(address to, uint256 tokenId) public virtual override;

getApproved

See {IERC721-getApproved}.

function getApproved(uint256 tokenId) public view virtual override returns (address);

setApprovalForAll

See {IERC721-setApprovalForAll}.

function setApprovalForAll(address operator, bool approved) public virtual override;

isApprovedForAll

See {IERC721-isApprovedForAll}.

function isApprovedForAll(address owner, address operator) public view virtual override returns (bool);

transferFrom

See {IERC721-transferFrom}.

function transferFrom(address from, address to, uint256 tokenId) public virtual override;

safeTransferFrom

See {IERC721-safeTransferFrom}.

function safeTransferFrom(address from, address to, uint256 tokenId) public virtual override;

safeTransferFrom

See {IERC721-safeTransferFrom}.

function safeTransferFrom(address from, address to, uint256 tokenId, bytes memory _data) public virtual override;

burn

*Burns tokenId. Requirements:

• The caller must own tokenId or be an approved operator.*

function burn(uint256 tokenId) public virtual override;

_unsafeOwnerOf

Returns the owner of the tokenId token.

It is prefixed as unsafe as it does not revert when the token does not exist.

function _unsafeOwnerOf(uint256 tokenId) internal view returns (address);

Parameters

Returns

_safeTransfer

*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. _data is additional data, it has no specified format and it is sent in call to to. This internal function is equivalent to {safeTransferFrom}, and can be used to e.g. implement alternative mechanisms to perform a token transfer, such as signature-based. Requirements:

• from cannot be the zero address.
• to cannot be the zero address.
• tokenId token must exist and be owned by from.
• If to refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer. Emits a {Transfer} event.*

function _safeTransfer(address from, address to, uint256 tokenId, bytes memory _data) internal virtual;

_exists

Returns whether tokenId exists. Tokens can be managed by their owner or approved accounts via {approve} or {setApprovalForAll}. Tokens start existing when they are minted (_mint), and stop existing when they are burned (_burn).

function _exists(uint256 tokenId) internal view virtual returns (bool);

_isApprovedOrOwner

*Returns whether spender is allowed to manage tokenId. Requirements:

• tokenId must exist.*

function _isApprovedOrOwner(address spender, uint256 tokenId) internal view virtual returns (bool);

_mint

*Mints tokenId and transfers it to to. WARNING: Usage of this method is discouraged, use {_safeMint} whenever possible Requirements:

• tokenId must not exist.
• to cannot be the zero address. Emits a {Transfer} event.*

function _mint(address to, uint256 tokenId) internal virtual;

_burn

*Destroys tokenId. The approval is cleared when the token is burned. Requirements:

• tokenId must exist. Emits a {Transfer} event.*

function _burn(uint256 tokenId) internal virtual;

_transfer

*Transfers tokenId from from to to. As opposed to {transferFrom}, this imposes no restrictions on msg.sender. Requirements:

• to cannot be the zero address.
• tokenId token must be owned by from. Emits a {Transfer} event.*

function _transfer(address from, address to, uint256 tokenId) internal virtual;

_approve

Approve to to operate on tokenId Emits a {Approval} event.

function _approve(address to, uint256 tokenId) internal virtual;

_setOperatorApproval

Refactored from the original OZ ERC721 implementation: approve or revoke approval from operator to operate on all tokens owned by owner. Emits a {ApprovalForAll} event.

function _setOperatorApproval(address owner, address operator, bool approved) internal virtual;

_checkOnERC721Received

Private function to invoke {IERC721Receiver-onERC721Received} on a target address. The call is not executed if the target address is not a contract.

function _checkOnERC721Received(address from, address to, uint256 tokenId, bytes memory _data) private returns (bool);

Parameters

Returns

_beforeTokenTransfer

*Hook that is called before any token transfer. This includes minting and burning. Calling conditions:

• When from and to are both non-zero, from's tokenId will be transferred to to.
• When from is zero, tokenId will be minted for to.
• When to is zero, from's tokenId will be burned.
• from and to are never both zero. To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].*

function _beforeTokenTransfer(address from, address to, uint256 tokenId) internal virtual;

LensGovernable

Git Source

Inherits: ILensGovernable

Functions

onlyGov

This modifier reverts if the caller is not the configured governance address.

modifier onlyGov();

setGovernance

GOV FUNCTIONS ///

function setGovernance(address newGovernance) external override onlyGov;

Parameters

setEmergencyAdmin

Sets the emergency admin, which is a permissioned role able to set the protocol state.

function setEmergencyAdmin(address newEmergencyAdmin) external override onlyGov;

Parameters

setState

Sets the protocol state to either a global pause, a publishing pause or an unpaused state.

function setState(Types.ProtocolState newState) external override;

Parameters

setTreasury

Sets the treasury address.

function setTreasury(address newTreasury) external override onlyGov;

Parameters

setTreasuryFee

Sets the treasury fee.

function setTreasuryFee(uint16 newTreasuryFee) external override onlyGov;

Parameters

whitelistProfileCreator

Adds or removes a profile creator from the whitelist.

function whitelistProfileCreator(address profileCreator, bool whitelist) external override onlyGov;

Parameters

getGovernance

EXTERNAL VIEW FUNCTIONS ///

function getGovernance() external view override returns (address);

Returns

getState

Returns the current protocol state.

function getState() external view override returns (Types.ProtocolState);

Returns

isProfileCreatorWhitelisted

Returns whether or not a profile creator is whitelisted.

function isProfileCreatorWhitelisted(address profileCreator) external view override returns (bool);

Parameters

Returns

getTreasury

Returns the treasury address.

function getTreasury() external view override returns (address);

Returns

getTreasuryFee

Returns the treasury fee.

function getTreasuryFee() external view override returns (uint16);

Returns

getTreasuryData

Returns the treasury address and treasury fee in a single call.

function getTreasuryData() external view override returns (address, uint16);

Returns

LensHubEventHooks

Git Source

Inherits: ILensHubEventHooks

Functions

emitUnfollowedEvent

Helper function to emit an Unfollowed event from the hub, to be consumed by indexers to track unfollows.

function emitUnfollowedEvent(uint256 unfollowerProfileId, uint256 idOfProfileUnfollowed, address transactionExecutor)
    external
    override;

Parameters

emitCollectNFTTransferEvent

DEPRECATED FUNCTIONS ///

function emitCollectNFTTransferEvent(uint256 profileId, uint256 pubId, uint256 collectNFTId, address from, address to)
    external;

LensHubStorage

Git Source

Author: Lens Protocol

This is an abstract contract that ONLY contains storage for the LensHub contract. This MUST be inherited last to preserve the LensHub storage layout. Adding storage variables should be done ONLY at the bottom of this contract.

State Variables

_lastInitializedRevision

uint256 private _lastInitializedRevision;

_state

Types.ProtocolState internal _state;

_profileCreatorWhitelisted

mapping(address profileCreator => bool isWhitelisted) internal _profileCreatorWhitelisted;

__DEPRECATED__followModuleWhitelisted

mapping(address => bool isWhitelisted) internal __DEPRECATED__followModuleWhitelisted;

__DEPRECATED__collectModuleWhitelisted

mapping(address collectModule => bool isWhitelisted) internal __DEPRECATED__collectModuleWhitelisted;

__DEPRECATED__referenceModuleWhitelisted

mapping(address referenceModule => bool isWhitelisted) internal __DEPRECATED__referenceModuleWhitelisted;

__DEPRECATED__dispatcherByProfile

mapping(uint256 profileId => address dispatcher) internal __DEPRECATED__dispatcherByProfile;

__DEPRECATED__profileIdByHandleHash

mapping(bytes32 handleHash => uint256 profileId) internal __DEPRECATED__profileIdByHandleHash;

_profiles

mapping(uint256 profileId => Types.Profile profile) internal _profiles;

_publications

mapping(uint256 profileId => mapping(uint256 pubId => Types.Publication publication)) internal _publications;

__DEPRECATED__defaultProfiles

mapping(address userAddress => uint256 profileId) internal __DEPRECATED__defaultProfiles;

_profileCounter

uint256 internal _profileCounter;

_governance

address internal _governance;

_emergencyAdmin

address internal _emergencyAdmin;

_tokenGuardianDisablingTimestamp

mapping(address => uint256) internal _tokenGuardianDisablingTimestamp;

_delegatedExecutorsConfigs

mapping(uint256 profileId => Types.DelegatedExecutorsConfig config) internal _delegatedExecutorsConfigs;

_blockedStatus

mapping(uint256 blockerProfileId => mapping(uint256 blockedProfileId => bool isBlocked)) internal _blockedStatus;

_profileRoyaltiesBps

uint256 internal _profileRoyaltiesBps;

_migrationAdminWhitelisted

mapping(address migrationAdmin => bool allowed) internal _migrationAdminWhitelisted;

_treasuryData

Types.TreasuryData internal _treasuryData;

LensImplGetters

Git Source

Inherits: ILensImplGetters

State Variables

FOLLOW_NFT_IMPL

address internal immutable FOLLOW_NFT_IMPL;

__LEGACY__COLLECT_NFT_IMPL

address internal immutable __LEGACY__COLLECT_NFT_IMPL;

MODULE_REGISTRY

address internal immutable MODULE_REGISTRY;

Functions

constructor

constructor(address followNFTImpl, address collectNFTImpl, address moduleRegistry);

getFollowNFTImpl

Returns the Follow NFT implementation address that is used for all deployed Follow NFTs.

function getFollowNFTImpl() external view override returns (address);

Returns

getLegacyCollectNFTImpl

Returns the Collect NFT implementation address that is used for each new deployed Collect NFT.

function getLegacyCollectNFTImpl() external view override returns (address);

Returns

getModuleRegistry

Returns the address of the registry that stores all modules that are used by the Lens Protocol.

function getModuleRegistry() external view override returns (address);

Returns

LensProfiles

Git Source

Inherits: LensBaseERC721, ERC2981CollectionRoyalties, ILensProfiles

State Variables

TOKEN_GUARDIAN_COOLDOWN

uint256 internal immutable TOKEN_GUARDIAN_COOLDOWN;

Functions

constructor

constructor(uint256 tokenGuardianCooldown);

whenNotPaused

modifier whenNotPaused();

onlyProfileOwner

modifier onlyProfileOwner(address expectedOwner, uint256 profileId);

onlyEOA

modifier onlyEOA();

getTokenGuardianDisablingTimestamp

Returns the timestamp at which the Token Guardian will become effectively disabled.

function getTokenGuardianDisablingTimestamp(address wallet) external view returns (uint256);

Parameters

Returns

DANGER__disableTokenGuardian

DANGER: Triggers disabling the profile protection mechanism for the msg.sender, which will allow transfers or approvals over profiles held by it. Disabling the mechanism will have a 7-day timelock before it becomes effective, allowing the owner to re-enable the protection back in case of being under attack. The protection layer only applies to EOA wallets.

function DANGER__disableTokenGuardian() external onlyEOA;

enableTokenGuardian

Enables back the profile protection mechanism for the msg.sender, preventing profile transfers or approvals (except when revoking them). The protection layer only applies to EOA wallets.

function enableTokenGuardian() external onlyEOA;

burn

Burns a profile, this maintains the profile data struct.

function burn(uint256 tokenId)
    public
    override(LensBaseERC721, IERC721Burnable)
    whenNotPaused
    onlyProfileOwner(msg.sender, tokenId);

tokenURI

Overrides the ERC721 tokenURI function to return the associated URI with a given profile.

function tokenURI(uint256 tokenId) public view override(LensBaseERC721, IERC721Metadata) returns (string memory);

approve

function approve(address to, uint256 tokenId) public override(LensBaseERC721, IERC721);

setApprovalForAll

function setApprovalForAll(address operator, bool approved) public override(LensBaseERC721, IERC721);

supportsInterface

See {IERC165-supportsInterface}.

function supportsInterface(bytes4 interfaceId)
    public
    view
    virtual
    override(LensBaseERC721, ERC2981CollectionRoyalties, IERC165)
    returns (bool);

_hasTokenGuardianEnabled

function _hasTokenGuardianEnabled(address wallet) internal view returns (bool);

_getRoyaltiesInBasisPointsSlot

function _getRoyaltiesInBasisPointsSlot() internal pure override returns (uint256);

_getReceiver

function _getReceiver(uint256) internal view override returns (address);

_beforeRoyaltiesSet

function _beforeRoyaltiesSet(uint256) internal view override;

_beforeTokenTransfer

function _beforeTokenTransfer(address from, address to, uint256 tokenId) internal override whenNotPaused;

Contents

• ICollectModule
• ICollectNFT
• IERC721Burnable
• IERC721MetaTx
• IERC721Timestamped
• IFollowModule
• IFollowNFT
• ILegacyCollectModule
• ILegacyCollectNFT
• ILegacyFollowModule
• ILegacyReferenceModule
• ILensERC721
• ILensGovernable
• ILensHandles
• ILensHub
• ILensHubEventHooks
• ILensHubInitializable
• ILensImplGetters
• ILensProfiles
• ILensProtocol
• IModuleRegistry
• IPublicationActionModule
• IReferenceModule
• ITokenHandleRegistry

ICollectModule

Git Source

Author: Lens Protocol

This is the standard interface for all Lens-compatible CollectModules. Collect modules allow users to execute custom logic upon a collect action over a publication, like:

• Only allow the collect if the collector is following the publication author.
• Only allow the collect if the collector has made a payment to
• Allow any collect but only during the first 24 hours.
• Etc.

Functions

initializePublicationCollectModule

Initializes data for a given publication being published.

function initializePublicationCollectModule(
    uint256 profileId,
    uint256 pubId,
    address transactionExecutor,
    bytes calldata data
) external returns (bytes memory);

Parameters

Returns

processCollect

Processes a collect action for a given publication.

function processCollect(Types.ProcessCollectParams calldata processCollectParams) external returns (bytes memory);

Parameters

Returns

ICollectNFT

Git Source

Author: Lens Protocol

This is the interface for the CollectNFT contract. Which is cloned upon the first collect for any given publication.

Functions

initialize

Initializes the collect NFT, setting the feed as the privileged minter, storing the collected publication pointer and initializing the name and symbol in the LensNFTBase contract.

function initialize(uint256 profileId, uint256 pubId) external;

Parameters

mint

Mints a collect NFT to the specified address. This can only be called by the hub and is called upon collection.

function mint(address to) external returns (uint256);

Parameters

Returns

getSourcePublicationPointer

Returns the source publication of this collect NFT.

function getSourcePublicationPointer() external view returns (uint256, uint256);

Returns

IERC721Burnable

Git Source

Author: Lens Protocol

Extension of ERC-721 including a function that allows the token to be burned.

Functions

burn

Burns an NFT, removing it from circulation and essentially destroying it.

function burn(uint256 tokenId) external;

Parameters

IERC721MetaTx

Git Source

Author: Lens Protocol

Extension of ERC-721 including meta-tx signatures related functions.

Functions

nonces

Returns the current signature nonce of the given signer.

function nonces(address signer) external view returns (uint256);

Parameters

Returns

getDomainSeparator

Returns the EIP-712 domain separator for this contract.

function getDomainSeparator() external view returns (bytes32);

Returns

IERC721Timestamped

Git Source

Author: Lens Protocol

Extension of ERC-721 including a struct for token data, which contains the owner and the mint timestamp, as well as their associated getters.

Functions

mintTimestampOf

Returns the mint timestamp associated with a given NFT.

function mintTimestampOf(uint256 tokenId) external view returns (uint256);

Parameters

Returns

tokenDataOf

Returns the token data associated with a given NFT. This allows fetching the token owner and mint timestamp in a single call.

function tokenDataOf(uint256 tokenId) external view returns (Types.TokenData memory);

Parameters

Returns

exists

Returns whether a token with the given token ID exists.

function exists(uint256 tokenId) external view returns (bool);

Parameters

Returns

totalSupply

Returns the amount of tokens in circulation.

function totalSupply() external view returns (uint256);

Returns

IFollowModule

Git Source

Author: Lens Protocol

This is the standard interface for all Lens-compatible Follow Modules. These are responsible for processing the follow actions and can be used to implement any kind of follow logic. For example:

• Token-gated follows (e.g. a user must hold a certain amount of a token to follow a profile).
• Paid follows (e.g. a user must pay a certain amount of a token to follow a profile).
• Rewarding users for following a profile.
• Etc.

Functions

initializeFollowModule

Initializes a follow module for a given Lens profile.

function initializeFollowModule(uint256 profileId, address transactionExecutor, bytes calldata data)
    external
    returns (bytes memory);

Parameters

Returns

processFollow

Processes a given follow.

function processFollow(
    uint256 followerProfileId,
    uint256 followTokenId,
    address transactionExecutor,
    uint256 targetProfileId,
    bytes calldata data
) external returns (bytes memory);

Parameters

Returns

IFollowNFT

Git Source

Author: Lens Protocol

This is the interface for the FollowNFT contract, which is cloned upon the first follow for any profile. By default the Follow tokens are tied to the follower profile, which means that they will be automatically transferred with it. This is achieved by them not being ERC-721 initially. However, the Follow NFT collections support converting them to ERC-721 tokens (i.e. wrapping) natively, enabling composability with existing ERC-721-based protocols.

Functions

initialize

Initializes the follow NFT.

Sets the targeted profile, and the token royalties.

function initialize(uint256 profileId) external;

Parameters

follow

Makes the passed profile follow the profile targeted in this contract.

function follow(uint256 followerProfileId, address transactionExecutor, uint256 followTokenId)
    external
    returns (uint256);

Parameters

Returns

unfollow

Makes the passed profile unfollow the profile targeted in this contract.

function unfollow(uint256 unfollowerProfileId, address transactionExecutor) external;

Parameters

removeFollower

Removes the follower from the given follow NFT.

Only on wrapped token.

function removeFollower(uint256 followTokenId) external;

Parameters

approveFollow

Approves the given profile to follow with the given wrapped token.

Only on wrapped tokens. It approves setting a follower on the given wrapped follow token, which lets the follow token owner to allow a profile to follow with his token without losing its ownership. This approval is cleared on transfers, as well as when unwrapping.

function approveFollow(uint256 approvedProfileId, uint256 followTokenId) external;

Parameters

wrap

Unties the follow token from the follower's profile one, and wraps it into the ERC-721 untied follow tokens collection. Untied follow tokens will NOT be automatically transferred with their follower profile.

Only on unwrapped follow tokens.

function wrap(uint256 followTokenId) external;

Parameters

wrap

Unties the follow token from the follower's profile one, and wraps it into the ERC-721 untied follow tokens collection. Untied follow tokens will NOT be automatically transferred with their follower profile.

Only on unwrapped follow tokens.

function wrap(uint256 followTokenId, address wrappedTokenReceiver) external;

Parameters

unwrap

Unwraps the follow token from the ERC-721 untied follow tokens collection, and ties it to the follower's profile token. Tokens that are tied to the follower profile will be automatically transferred with it.

function unwrap(uint256 followTokenId) external;

Parameters

processBlock

Processes logic when the given profile is being blocked. If it was following the targeted profile, this will make it unfollow.

function processBlock(uint256 followerProfileId) external returns (bool);

Parameters

Returns

getFollowerProfileId

GETTERS ///

Gets the ID of the profile following with the given follow token.

function getFollowerProfileId(uint256 followTokenId) external view returns (uint256);

Parameters

Returns

getOriginalFollowTimestamp

Gets the original follow timestamp of the given follow token.

function getOriginalFollowTimestamp(uint256 followTokenId) external view returns (uint256);

Parameters

Returns

getFollowTimestamp

Gets the current follow timestamp of the given follow token.

function getFollowTimestamp(uint256 followTokenId) external view returns (uint256);

Parameters

Returns

getProfileIdAllowedToRecover

Gets the ID of the profile allowed to recover the given follow token.

function getProfileIdAllowedToRecover(uint256 followTokenId) external view returns (uint256);

Parameters

Returns

getFollowData

Gets the follow data of the given follow token.

function getFollowData(uint256 followTokenId) external view returns (Types.FollowData memory);

Parameters

Returns

isFollowing

Tells if the given profile is following the profile targeted in this contract.

function isFollowing(uint256 followerProfileId) external view returns (bool);

Parameters

Returns

getFollowTokenId

Gets the ID of the token being used to follow by the given follower.

function getFollowTokenId(uint256 followerProfileId) external view returns (uint256);

Parameters

Returns

getFollowApproved

Gets the ID of the profile approved to follow with the given token.

function getFollowApproved(uint256 followTokenId) external view returns (uint256);

Parameters

Returns

getFollowerCount

Gets the count of the followers of the profile targeted in this contract.

This number might be out of sync if one of the followers burns their profile.

function getFollowerCount() external view returns (uint256);

Returns

Errors

AlreadyFollowing

error AlreadyFollowing();

NotFollowing

error NotFollowing();

FollowTokenDoesNotExist

error FollowTokenDoesNotExist();

AlreadyWrapped

error AlreadyWrapped();

OnlyWrappedFollowTokens

error OnlyWrappedFollowTokens();

DoesNotHavePermissions

error DoesNotHavePermissions();

ILegacyCollectModule

Git Source

Author: Lens Protocol

This is the deprecated interface for previously Lens-compatible CollectModules.

Functions

initializePublicationCollectModule

Initializes data for a given publication being published. This can only be called by the hub.

function initializePublicationCollectModule(uint256 profileId, uint256 pubId, bytes calldata data)
    external
    returns (bytes memory);

Parameters

Returns

processCollect

Processes a collect action for a given publication, this can only be called by the hub.

function processCollect(
    uint256 referrerProfileId,
    address collector,
    uint256 profileId,
    uint256 pubId,
    bytes calldata data
) external;

Parameters

ILegacyCollectNFT

Git Source

Author: Lens Protocol

This is the interface for the Lens V1 CollectNFT contract. Which is cloned upon the first collect for any given publication.

Functions

initialize

Initializes the collect NFT, setting the feed as the privileged minter, storing the collected publication pointer and initializing the name and symbol in the LensNFTBase contract.

function initialize(uint256 profileId, uint256 pubId, string calldata name, string calldata symbol) external;

Parameters

mint

Mints a collect NFT to the specified address.

function mint(address to) external returns (uint256);

Parameters

Returns

getSourcePublicationPointer

Returns the source publication of this collect NFT.

function getSourcePublicationPointer() external view returns (uint256, uint256);

Returns

ILegacyFollowModule

Git Source

Author: Lens Protocol

This is the deprecated interface for previously Lens-compatible FollowModules.

Functions

initializeFollowModule

Initializes a follow module for a given Lens profile. This can only be called by the hub contract.

function initializeFollowModule(uint256 profileId, bytes calldata data) external returns (bytes memory);

Parameters

Returns

processFollow

Processes a given follow, this can only be called from the LensHub contract.

function processFollow(address follower, uint256 profileId, bytes calldata data) external;

Parameters

followModuleTransferHook

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 a state associated with individual follow NFTs.

function followModuleTransferHook(uint256 profileId, address from, address to, uint256 followNFTTokenId) external;

Parameters

isFollowing

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.

function isFollowing(uint256 profileId, address follower, uint256 followNFTTokenId) external view returns (bool);

Parameters

Returns

ILegacyReferenceModule

Git Source

Author: Lens Protocol

This is the deprecated interface for previously Lens-compatible ReferenceModules.

Functions

initializeReferenceModule

Initializes data for a given publication being published. This can only be called by the hub.

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

Parameters

Returns

processComment

Processes a comment action referencing a given publication. This can only be called by the hub.

function processComment(uint256 profileId, uint256 pointedProfileId, uint256 pointedPubId, bytes calldata data)
    external;

Parameters

processMirror

Processes a mirror action referencing a given publication. This can only be called by the hub.

function processMirror(uint256 profileId, uint256 pointedProfileId, uint256 pointedPubId, bytes calldata data)
    external;

Parameters

ILensERC721

Git Source

Inherits: IERC721, IERC721Timestamped, IERC721Burnable, IERC721MetaTx, IERC721Metadata

ILensGovernable

Git Source

Author: Lens Protocol

This is the interface for the Lens Protocol main governance functions.

Functions

setGovernance

Sets the privileged governance role.

function setGovernance(address newGovernance) external;

Parameters

setEmergencyAdmin

Sets the emergency admin, which is a permissioned role able to set the protocol state.

function setEmergencyAdmin(address newEmergencyAdmin) external;

Parameters

setState

Sets the protocol state to either a global pause, a publishing pause or an unpaused state.

function setState(Types.ProtocolState newState) external;

Parameters

whitelistProfileCreator

Adds or removes a profile creator from the whitelist.

function whitelistProfileCreator(address profileCreator, bool whitelist) external;

Parameters

setTreasury

Sets the treasury address.

function setTreasury(address newTreasury) external;

Parameters

setTreasuryFee

Sets the treasury fee.

function setTreasuryFee(uint16 newTreasuryFee) external;

Parameters

getGovernance

Returns the currently configured governance address.

function getGovernance() external view returns (address);

Returns

getState

Gets the state currently set in the protocol. It could be a global pause, a publishing pause or an unpaused state.

function getState() external view returns (Types.ProtocolState);

Returns

isProfileCreatorWhitelisted

Returns whether or not a profile creator is whitelisted.

function isProfileCreatorWhitelisted(address profileCreator) external view returns (bool);

Parameters

Returns

getTreasury

Returns the treasury address.

function getTreasury() external view returns (address);

Returns

getTreasuryFee

Returns the treasury fee.

function getTreasuryFee() external view returns (uint16);

Returns

getTreasuryData

Returns the treasury address and treasury fee in a single call.

function getTreasuryData() external view returns (address, uint16);

Returns

ILensHandles

Git Source

Inherits: IERC721

Author: Lens Protocol

This is the interface for the LensHandles contract that is responsible for minting and burning handle NFTs. A handle is composed of a local name and a namespace, separated by a dot. Example: satoshi.lens is a handle composed of the local name satoshi and the namespace lens.

Functions

mintHandle

Mints a handle NFT in the given namespace.

function mintHandle(address to, string calldata localName) external returns (uint256);

Parameters

Returns

burn

Burns a handle NFT.

function burn(uint256 tokenId) external;

Parameters

getNamespace

Gets the namespace of the contract. It's 'lens' for the LensHandles contract.

function getNamespace() external pure returns (string memory);

Returns

getNamespaceHash

Gets the hash of the namespace of the contract. It's keccak256('lens') for the LensHandles contract.

function getNamespaceHash() external pure returns (bytes32);

Returns

exists

Returns whether tokenId exists. Tokens start existing when they are minted (_mint), and stop existing when they are burned (_burn).

function exists(uint256 tokenId) external view returns (bool);

Returns

ILensHub

Git Source

Inherits: ILensProfiles, ILensProtocol, ILensGovernable, ILensHubEventHooks, ILensImplGetters

ILensHubEventHooks

Git Source

Author: Lens Protocol

This is the interface for the LensHub contract's event hooks. As we want most of the core events to be emitted by the LensHub contract, event hooks are needed for core events generated by pheripheral contracts.

Functions

emitUnfollowedEvent

Helper function to emit an Unfollowed event from the hub, to be consumed by indexers to track unfollows.

function emitUnfollowedEvent(uint256 unfollowerProfileId, uint256 idOfProfileUnfollowed, address transactionExecutor)
    external;

Parameters

ILensHubInitializable

Git Source

Author: Lens Protocol

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.

Functions

initialize

Initializes the LensHub, setting the initial governance address, the name and symbol of the profiles in the LensNFTBase contract, and Protocol State (Paused).

This is assuming a proxy pattern is implemented.

function initialize(string calldata name, string calldata symbol, address newGovernance) external;

Parameters

ILensImplGetters

Git Source

Author: Lens Protocol

This is the interface for the LensHub contract's implementation getters. These implementations will be used for deploying each respective contract for each profile.

Functions

getFollowNFTImpl

Returns the Follow NFT implementation address that is used for all deployed Follow NFTs.

function getFollowNFTImpl() external view returns (address);

Returns

getLegacyCollectNFTImpl

Returns the Collect NFT implementation address that is used for each new deployed Collect NFT.

function getLegacyCollectNFTImpl() external view returns (address);

Returns

getModuleRegistry

Returns the address of the registry that stores all modules that are used by the Lens Protocol.

function getModuleRegistry() external view returns (address);

Returns

ILensProfiles

Git Source

Inherits: ILensERC721

Functions

DANGER__disableTokenGuardian

DANGER: Triggers disabling the profile protection mechanism for the msg.sender, which will allow transfers or approvals over profiles held by it. Disabling the mechanism will have a 7-day timelock before it becomes effective, allowing the owner to re-enable the protection back in case of being under attack. The protection layer only applies to EOA wallets.

function DANGER__disableTokenGuardian() external;

enableTokenGuardian

Enables back the profile protection mechanism for the msg.sender, preventing profile transfers or approvals (except when revoking them). The protection layer only applies to EOA wallets.

function enableTokenGuardian() external;

getTokenGuardianDisablingTimestamp

Returns the timestamp at which the Token Guardian will become effectively disabled.

function getTokenGuardianDisablingTimestamp(address wallet) external view returns (uint256);

Parameters

Returns

ILensProtocol

Git Source

Author: Lens Protocol

This is the interface for Lens Protocol's core functions. It contains all the entry points for performing social operations.

Functions

createProfile

Creates a profile with the specified parameters, minting a Profile NFT to the given recipient.

function createProfile(Types.CreateProfileParams calldata createProfileParams) external returns (uint256);

Parameters

setProfileMetadataURI

Sets the metadata URI for the given profile.

function setProfileMetadataURI(uint256 profileId, string calldata metadataURI) external;

Parameters

setProfileMetadataURIWithSig

function setProfileMetadataURIWithSig(
    uint256 profileId,
    string calldata metadataURI,
    Types.EIP712Signature calldata signature
) external;

setFollowModule

Sets the follow module for the given profile.

function setFollowModule(uint256 profileId, address followModule, bytes calldata followModuleInitData) external;

Parameters

setFollowModuleWithSig

function setFollowModuleWithSig(
    uint256 profileId,
    address followModule,
    bytes calldata followModuleInitData,
    Types.EIP712Signature calldata signature
) external;

changeDelegatedExecutorsConfig

Changes the delegated executors configuration for the given profile. It allows setting the approvals for delegated executors in the specified configuration, as well as switching to it.

function changeDelegatedExecutorsConfig(
    uint256 delegatorProfileId,
    address[] calldata delegatedExecutors,
    bool[] calldata approvals,
    uint64 configNumber,
    bool switchToGivenConfig
) external;

Parameters

changeDelegatedExecutorsConfig

Changes the delegated executors configuration for the given profile under the current configuration.

function changeDelegatedExecutorsConfig(
    uint256 delegatorProfileId,
    address[] calldata delegatedExecutors,
    bool[] calldata approvals
) external;

Parameters

changeDelegatedExecutorsConfigWithSig

function changeDelegatedExecutorsConfigWithSig(
    uint256 delegatorProfileId,
    address[] calldata delegatedExecutors,
    bool[] calldata approvals,
    uint64 configNumber,
    bool switchToGivenConfig,
    Types.EIP712Signature calldata signature
) external;

post

Publishes a post. Post is the most basic publication type, and can be used to publish any kind of content. Posts can have these types of modules initialized:

• Action modules: any number of publication actions (e.g. collect, tip, etc.)
• Reference module: a module handling the rules when referencing this post (e.g. token-gated comments)

function post(Types.PostParams calldata postParams) external returns (uint256);

Parameters

Returns

postWithSig

function postWithSig(Types.PostParams calldata postParams, Types.EIP712Signature calldata signature)
    external
    returns (uint256);

comment

Publishes a comment on the given publication. Comment is a type of reference publication that points to another publication. Comments can have these types of modules initialized:

• Action modules: any number of publication actions (e.g. collect, tip, etc.)
• Reference module: a module handling the rules when referencing this comment (e.g. token-gated mirrors) Comments can have referrers (e.g. publications or profiles that allowed to discover the pointed publication).

function comment(Types.CommentParams calldata commentParams) external returns (uint256);

Parameters

Returns

commentWithSig

function commentWithSig(Types.CommentParams calldata commentParams, Types.EIP712Signature calldata signature)
    external
    returns (uint256);

mirror

Publishes a mirror of the given publication. Mirror is a type of reference publication that points to another publication but doesn't have content. Mirrors don't have any modules initialized. Mirrors can have referrers (e.g. publications or profiles that allowed to discover the pointed publication). You cannot mirror a mirror, comment on a mirror, or quote a mirror.

function mirror(Types.MirrorParams calldata mirrorParams) external returns (uint256);

Parameters

Returns

mirrorWithSig

function mirrorWithSig(Types.MirrorParams calldata mirrorParams, Types.EIP712Signature calldata signature)
    external
    returns (uint256);

quote

Publishes a quote of the given publication. Quote is a type of reference publication similar to mirror, but it has content and modules. Quotes can have these types of modules initialized:

• Action modules: any number of publication actions (e.g. collect, tip, etc.)
• Reference module: a module handling the rules when referencing this quote (e.g. token-gated comments on quote) Quotes can have referrers (e.g. publications or profiles that allowed to discover the pointed publication). Unlike mirrors, you can mirror a quote, comment on a quote, or quote a quote.

function quote(Types.QuoteParams calldata quoteParams) external returns (uint256);

Parameters

Returns

quoteWithSig

function quoteWithSig(Types.QuoteParams calldata quoteParams, Types.EIP712Signature calldata signature)
    external
    returns (uint256);

follow

Follows given profiles, executing each profile's follow module logic (if any).

Both the idsOfProfilesToFollow, followTokenIds, and datas arrays must be of the same length, regardless if the profiles do not have a follow module set.

function follow(
    uint256 followerProfileId,
    uint256[] calldata idsOfProfilesToFollow,
    uint256[] calldata followTokenIds,
    bytes[] calldata datas
) external returns (uint256[] memory);

Parameters

Returns

followWithSig

function followWithSig(
    uint256 followerProfileId,
    uint256[] calldata idsOfProfilesToFollow,
    uint256[] calldata followTokenIds,
    bytes[] calldata datas,
    Types.EIP712Signature calldata signature
) external returns (uint256[] memory);

unfollow

Unfollows given profiles.

function unfollow(uint256 unfollowerProfileId, uint256[] calldata idsOfProfilesToUnfollow) external;

Parameters

unfollowWithSig

function unfollowWithSig(
    uint256 unfollowerProfileId,
    uint256[] calldata idsOfProfilesToUnfollow,
    Types.EIP712Signature calldata signature
) external;

setBlockStatus

Sets the block status for the given profiles. Changing a profile's block status to true (i.e. blocked), when will also force them to unfollow. Blocked profiles cannot perform any actions with the profile that blocked them: they cannot comment or mirror their publications, they cannot follow them, they cannot collect, tip them, etc.

Both the idsOfProfilesToSetBlockStatus and blockStatus arrays must be of the same length.

function setBlockStatus(
    uint256 byProfileId,
    uint256[] calldata idsOfProfilesToSetBlockStatus,
    bool[] calldata blockStatus
) external;

Parameters

setBlockStatusWithSig

function setBlockStatusWithSig(
    uint256 byProfileId,
    uint256[] calldata idsOfProfilesToSetBlockStatus,
    bool[] calldata blockStatus,
    Types.EIP712Signature calldata signature
) external;

collectLegacy

Collects a given publication via signature with the specified parameters. Collect can have referrers (e.g. publications or profiles that allowed to discover the pointed publication).

function collectLegacy(Types.LegacyCollectParams calldata collectParams) external returns (uint256);

Parameters

Returns

collectLegacyWithSig

function collectLegacyWithSig(
    Types.LegacyCollectParams calldata collectParams,
    Types.EIP712Signature calldata signature
) external returns (uint256);

act

Acts on a given publication with the specified parameters. You can act on a publication except a mirror (if it has at least one action module initialized). Actions can have referrers (e.g. publications or profiles that allowed to discover the pointed publication).

function act(Types.PublicationActionParams calldata publicationActionParams) external returns (bytes memory);

Parameters

Returns

actWithSig

function actWithSig(
    Types.PublicationActionParams calldata publicationActionParams,
    Types.EIP712Signature calldata signature
) external returns (bytes memory);

isFollowing

VIEW FUNCTIONS ///

Returns whether or not followerProfileId is following followedProfileId.

function isFollowing(uint256 followerProfileId, uint256 followedProfileId) external view returns (bool);

Parameters

Returns

isDelegatedExecutorApproved

Returns whether the given address is approved as delegated executor, in the configuration with the given number, to act on behalf of the given profile.

function isDelegatedExecutorApproved(uint256 delegatorProfileId, address delegatedExecutor, uint64 configNumber)
    external
    view
    returns (bool);

Parameters

Returns

isDelegatedExecutorApproved

Returns whether the given address is approved as delegated executor, in the current configuration, to act on behalf of the given profile.

function isDelegatedExecutorApproved(uint256 delegatorProfileId, address delegatedExecutor)
    external
    view
    returns (bool);

Parameters

Returns

getDelegatedExecutorsConfigNumber

Returns the current delegated executor config number for the given profile.

function getDelegatedExecutorsConfigNumber(uint256 delegatorProfileId) external view returns (uint64);

Parameters

Returns

getDelegatedExecutorsPrevConfigNumber

Returns the previous used delegated executor config number for the given profile.

function getDelegatedExecutorsPrevConfigNumber(uint256 delegatorProfileId) external view returns (uint64);

Parameters

Returns

getDelegatedExecutorsMaxConfigNumberSet

Returns the maximum delegated executor config number for the given profile. This is the maximum config number that was ever used by this profile. When creating a new clean configuration, you can only use a number that is maxConfigNumber + 1.

function getDelegatedExecutorsMaxConfigNumberSet(uint256 delegatorProfileId) external view returns (uint64);

Parameters

Returns

isBlocked

Returns whether profileId is blocked by byProfileId. See setBlockStatus() for more information on how blocking works on the platform.

function isBlocked(uint256 profileId, uint256 byProfileId) external view returns (bool);

Parameters

Returns

getContentURI

Returns the URI associated with a given publication. This is used to store the publication's metadata, e.g.: content, images, etc.

function getContentURI(uint256 profileId, uint256 pubId) external view returns (string memory);

Parameters

Returns

getProfile

Returns the full profile struct associated with a given profile token ID.

function getProfile(uint256 profileId) external view returns (Types.Profile memory);

Parameters

Returns

getPublication

Returns the full publication struct for a given publication.

function getPublication(uint256 profileId, uint256 pubId) external view returns (Types.PublicationMemory memory);

Parameters

Returns

getPublicationType

Returns the type of a given publication. The type can be one of the following (see PublicationType enum):

• Nonexistent
• Post
• Comment
• Mirror
• Quote

function getPublicationType(uint256 profileId, uint256 pubId) external view returns (Types.PublicationType);

Parameters

Returns

isActionModuleEnabledInPublication

Returns wether a given Action Module is enabled for a given publication.

function isActionModuleEnabledInPublication(uint256 profileId, uint256 pubId, address module)
    external
    view
    returns (bool);

Parameters

Returns

IModuleRegistry

Git Source

Functions

registerModule

function registerModule(address moduleAddress, uint256 moduleType) external returns (bool);

getModuleTypes

function getModuleTypes(address moduleAddress) external view returns (uint256);

isModuleRegistered

function isModuleRegistered(address moduleAddress) external view returns (bool);

isModuleRegisteredAs

function isModuleRegisteredAs(address moduleAddress, uint256 moduleType) external view returns (bool);

registerErc20Currency

function registerErc20Currency(address currencyAddress) external returns (bool);

isErc20CurrencyRegistered

function isErc20CurrencyRegistered(address currencyAddress) external view returns (bool);

Enums

ModuleType

enum ModuleType {
    __,
    PUBLICATION_ACTION_MODULE,
    REFERENCE_MODULE,
    FOLLOW_MODULE
}

IPublicationActionModule

Git Source

Author: Lens Protocol

This is the standard interface for all Lens-compatible Publication Actions. Publication action modules allow users to execute actions directly from a publication, like:

• Minting NFTs.
• Collecting a publication.
• Sending funds to the publication author (e.g. tipping).
• Etc. Referrers are supported, so any publication or profile that references the publication can receive a share from the publication's action if the action module supports it.

Functions

initializePublicationAction

Initializes the action module for the given publication being published with this Action module.

function initializePublicationAction(uint256 profileId, uint256 pubId, address transactionExecutor, bytes calldata data)
    external
    returns (bytes memory);

Parameters

Returns

processPublicationAction

Processes the action for a given publication. This includes the action's logic and any monetary/token operations.

function processPublicationAction(Types.ProcessActionParams calldata processActionParams)
    external
    returns (bytes memory);

Parameters

Returns

IReferenceModule

Git Source

Author: Lens Protocol

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.

Functions

initializeReferenceModule

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

function initializeReferenceModule(uint256 profileId, uint256 pubId, address transactionExecutor, bytes calldata data)
    external
    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.

function processComment(Types.ProcessCommentParams calldata processCommentParams) external 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.

function processQuote(Types.ProcessQuoteParams calldata processQuoteParams) external 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.

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

Parameters

Returns

ITokenHandleRegistry

Git Source

Author: Lens Protocol

The interface for TokenHandleRegistry contract that is responsible for linking a handle NFT to a token NFT. Linking means a connection between the two NFTs is created, and the handle NFT can be used to resolve the token NFT or vice versa. The registry is responsible for keeping track of the links between the NFTs, and for resolving them. The first version of the registry is hard-coded to support only the .lens namespace and the Lens Protocol Profiles.

Functions

migrationLink

Lens V1 -> V2 migration function. Links a handle NFT to a profile NFT without additional checks to save gas. Will be called by the migration function (in MigrationLib) in LensHub, only for new handles being migrated.

function migrationLink(uint256 handleId, uint256 profileId) external;

Parameters

link

Links a handle NFT with a profile NFT. Linking means a connection between the two NFTs is created, and the handle NFT can be used to resolve the profile NFT or vice versa.

*In the first version of the registry, the NFT contracts are hard-coded:

• Handle is hard-coded to be of the .lens namespace
• Token is hard-coded to be of the Lens Protocol Profile In future versions, the registry will be more flexible and allow for different namespaces and tokens, so this function might be deprecated and replaced with a new one accepting addresses of the handle and token contracts.*

function link(uint256 handleId, uint256 profileId) external;

Parameters

unlink

Unlinks a handle NFT from a profile NFT.

*In the first version of the registry, the contracts are hard-coded:

• Handle is hard-coded to be of the .lens namespace
• Token is hard-coded to be of the Lens Protocol Profile In future versions, the registry will be more flexible and allow for different namespaces and tokens, so this function might be deprecated and replaced with a new one accepting addresses of the handle and token contracts.*

function unlink(uint256 handleId, uint256 profileId) external;

Parameters

resolve

Resolves a handle NFT to a profile NFT.

*In the first version of the registry, the contracts are hard-coded:

• Handle is hard-coded to be of the .lens namespace
• Token is hard-coded to be of the Lens Protocol Profile In future versions, the registry will be more flexible and allow for different namespaces and tokens, so this function might be deprecated and replaced with a new one.*

function resolve(uint256 handleId) external view returns (uint256);

Parameters

Returns

getDefaultHandle

Gets a default handle for a profile NFT (aka reverse resolution).

*In the first version of the registry, the contracts are hard-coded:

• Handle is hard-coded to be of the .lens namespace
• Token is hard-coded to be of the Lens Protocol Profile In future versions, the registry will be more flexible and allow for different namespaces and tokens, so this function might be deprecated and replaced with a new one.*

function getDefaultHandle(uint256 tokenId) external view returns (uint256);

Parameters

Returns

Contents

• constants
• token-uris
• ActionLib
• FollowLib
• GovernanceLib
• LegacyCollectLib
• MetaTxLib
• ILegacyFeeFollowModule
• MigrationLib
• ProfileLib
• PublicationLib
• StorageLib
• ValidationLib

Contents

• Errors
• Events
• Typehash
• Types

Errors

Git Source

Errors

CannotInitImplementation

error CannotInitImplementation();

Initialized

error Initialized();

SignatureExpired

error SignatureExpired();

SignatureInvalid

error SignatureInvalid();

InvalidOwner

error InvalidOwner();

NotOwnerOrApproved

error NotOwnerOrApproved();

NotHub

error NotHub();

TokenDoesNotExist

error TokenDoesNotExist();

NotGovernance

error NotGovernance();

NotGovernanceOrEmergencyAdmin

error NotGovernanceOrEmergencyAdmin();

EmergencyAdminCanOnlyPauseFurther

error EmergencyAdminCanOnlyPauseFurther();

NotProfileOwner

error NotProfileOwner();

PublicationDoesNotExist

error PublicationDoesNotExist();

CallerNotFollowNFT

error CallerNotFollowNFT();

CallerNotCollectNFT

error CallerNotCollectNFT();

ArrayMismatch

error ArrayMismatch();

NotWhitelisted

error NotWhitelisted();

NotRegistered

error NotRegistered();

InvalidParameter

error InvalidParameter();

ExecutorInvalid

error ExecutorInvalid();

Blocked

error Blocked();

SelfBlock

error SelfBlock();

NotFollowing

error NotFollowing();

SelfFollow

error SelfFollow();

InvalidReferrer

error InvalidReferrer();

InvalidPointedPub

error InvalidPointedPub();

NonERC721ReceiverImplementer

error NonERC721ReceiverImplementer();

AlreadyEnabled

error AlreadyEnabled();

InitParamsInvalid

error InitParamsInvalid();

ActionNotAllowed

error ActionNotAllowed();

CollectNotAllowed

error CollectNotAllowed();

Paused

error Paused();

PublishingPaused

error PublishingPaused();

GuardianEnabled

error GuardianEnabled();

NotEOA

error NotEOA();

DisablingAlreadyTriggered

error DisablingAlreadyTriggered();

NotMigrationAdmin

error NotMigrationAdmin();

Events

Git Source

Events

BaseInitialized

Emitted when the NFT contract's name and symbol are set at initialization.

event BaseInitialized(string name, string symbol, uint256 timestamp);

StateSet

Emitted when the hub state is set.

event StateSet(
    address indexed caller,
    Types.ProtocolState indexed prevState,
    Types.ProtocolState indexed newState,
    uint256 timestamp
);

GovernanceSet

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.

event GovernanceSet(
    address indexed caller, address indexed prevGovernance, address indexed newGovernance, uint256 timestamp
);

EmergencyAdminSet

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.

event EmergencyAdminSet(
    address indexed caller, address indexed oldEmergencyAdmin, address indexed newEmergencyAdmin, uint256 timestamp
);

ProfileCreatorWhitelisted

Emitted when a profile creator is added to or removed from the whitelist.

event ProfileCreatorWhitelisted(address indexed profileCreator, bool indexed whitelisted, uint256 timestamp);

ProfileCreated

Emitted when a profile is created.

event ProfileCreated(uint256 indexed profileId, address indexed creator, address indexed to, uint256 timestamp);

DelegatedExecutorsConfigChanged

Emitted when a delegated executors configuration is changed.

event DelegatedExecutorsConfigChanged(
    uint256 indexed delegatorProfileId,
    uint256 indexed configNumber,
    address[] delegatedExecutors,
    bool[] approvals,
    uint256 timestamp
);

DelegatedExecutorsConfigApplied

Emitted when a delegated executors configuration is applied.

event DelegatedExecutorsConfigApplied(
    uint256 indexed delegatorProfileId, uint256 indexed configNumber, uint256 timestamp
);

FollowModuleSet

Emitted when a profile's follow module is set.

event FollowModuleSet(
    uint256 indexed profileId,
    address followModule,
    bytes followModuleReturnData,
    address transactionExecutor,
    uint256 timestamp
);

PostCreated

Emitted when a post is successfully published.

event PostCreated(
    Types.PostParams postParams,
    uint256 indexed pubId,
    bytes[] actionModulesInitReturnDatas,
    bytes referenceModuleInitReturnData,
    address transactionExecutor,
    uint256 timestamp
);

CommentCreated

Emitted when a comment is successfully published.

event CommentCreated(
    Types.CommentParams commentParams,
    uint256 indexed pubId,
    bytes referenceModuleReturnData,
    bytes[] actionModulesInitReturnDatas,
    bytes referenceModuleInitReturnData,
    address transactionExecutor,
    uint256 timestamp
);

MirrorCreated

Emitted when a mirror is successfully published.

event MirrorCreated(
    Types.MirrorParams mirrorParams,
    uint256 indexed pubId,
    bytes referenceModuleReturnData,
    address transactionExecutor,
    uint256 timestamp
);

QuoteCreated

Emitted when a quote is successfully published.

event QuoteCreated(
    Types.QuoteParams quoteParams,
    uint256 indexed pubId,
    bytes referenceModuleReturnData,
    bytes[] actionModulesInitReturnDatas,
    bytes referenceModuleInitReturnData,
    address transactionExecutor,
    uint256 timestamp
);

FollowNFTDeployed

Emitted when a followNFT clone is deployed using a lazy deployment pattern.

event FollowNFTDeployed(uint256 indexed profileId, address indexed followNFT, uint256 timestamp);

LegacyCollectNFTDeployed

Emitted when a collectNFT clone is deployed using a lazy deployment pattern.

event LegacyCollectNFTDeployed(
    uint256 indexed profileId, uint256 indexed pubId, address indexed collectNFT, uint256 timestamp
);

Acted

Emitted upon a successful action.

event Acted(
    Types.PublicationActionParams publicationActionParams,
    bytes actionModuleReturnData,
    address transactionExecutor,
    uint256 timestamp
);

Followed

Emitted upon a successful follow operation.

event Followed(
    uint256 indexed followerProfileId,
    uint256 idOfProfileFollowed,
    uint256 followTokenIdAssigned,
    bytes followModuleData,
    bytes processFollowModuleReturnData,
    address transactionExecutor,
    uint256 timestamp
);

Unfollowed

Emitted upon a successful unfollow operation.

event Unfollowed(
    uint256 indexed unfollowerProfileId, uint256 idOfProfileUnfollowed, address transactionExecutor, uint256 timestamp
);

Blocked

Emitted upon a successful block, through a block status setting operation.

event Blocked(uint256 indexed byProfileId, uint256 idOfProfileBlocked, address transactionExecutor, uint256 timestamp);

Unblocked

Emitted upon a successful unblock, through a block status setting operation.

event Unblocked(
    uint256 indexed byProfileId, uint256 idOfProfileUnblocked, address transactionExecutor, uint256 timestamp
);

CollectNFTTransferred

Emitted via callback when a collectNFT is transferred.

event CollectNFTTransferred(
    uint256 indexed profileId,
    uint256 indexed pubId,
    uint256 indexed collectNFTId,
    address from,
    address to,
    uint256 timestamp
);

TreasurySet

Emitted when the treasury address is set.

event TreasurySet(address indexed prevTreasury, address indexed newTreasury, uint256 timestamp);

TreasuryFeeSet

Emitted when the treasury fee is set.

event TreasuryFeeSet(uint16 indexed prevTreasuryFee, uint16 indexed newTreasuryFee, uint256 timestamp);

ProfileMetadataSet

Emitted when the metadata associated with a profile is set in the LensPeriphery.

event ProfileMetadataSet(uint256 indexed profileId, string metadata, address transactionExecutor, uint256 timestamp);

TokenGuardianStateChanged

Emitted when an address' Profile Guardian state change is triggered.

event TokenGuardianStateChanged(
    address indexed wallet, bool indexed enabled, uint256 tokenGuardianDisablingTimestamp, uint256 timestamp
);

NonceUpdated

Emitted when a signer's nonce is used and, as a consequence, the next available nonce is updated.

event NonceUpdated(address indexed signer, uint256 nonce, uint256 timestamp);

Typehash

Git Source

State Variables

ACT

bytes32 constant ACT = keccak256(
    "Act(uint256 publicationActedProfileId,uint256 publicationActedId,uint256 actorProfileId,uint256[] referrerProfileIds,uint256[] referrerPubIds,address actionModuleAddress,bytes actionModuleData,uint256 nonce,uint256 deadline)"
);

CHANGE_DELEGATED_EXECUTORS_CONFIG

bytes32 constant CHANGE_DELEGATED_EXECUTORS_CONFIG = keccak256(
    "ChangeDelegatedExecutorsConfig(uint256 delegatorProfileId,address[] delegatedExecutors,bool[] approvals,uint64 configNumber,bool switchToGivenConfig,uint256 nonce,uint256 deadline)"
);

COLLECT_LEGACY

bytes32 constant COLLECT_LEGACY = keccak256(
    "CollectLegacy(uint256 publicationCollectedProfileId,uint256 publicationCollectedId,uint256 collectorProfileId,uint256 referrerProfileId,uint256 referrerPubId,bytes collectModuleData,uint256 nonce,uint256 deadline)"
);

COMMENT

bytes32 constant COMMENT = keccak256(
    "Comment(uint256 profileId,string contentURI,uint256 pointedProfileId,uint256 pointedPubId,uint256[] referrerProfileIds,uint256[] referrerPubIds,bytes referenceModuleData,address[] actionModules,bytes[] actionModulesInitDatas,address referenceModule,bytes referenceModuleInitData,uint256 nonce,uint256 deadline)"
);

EIP712_DOMAIN

bytes32 constant EIP712_DOMAIN =
    keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");

FOLLOW

bytes32 constant FOLLOW = keccak256(
    "Follow(uint256 followerProfileId,uint256[] idsOfProfilesToFollow,uint256[] followTokenIds,bytes[] datas,uint256 nonce,uint256 deadline)"
);

MIRROR

bytes32 constant MIRROR = keccak256(
    "Mirror(uint256 profileId,string metadataURI,uint256 pointedProfileId,uint256 pointedPubId,uint256[] referrerProfileIds,uint256[] referrerPubIds,bytes referenceModuleData,uint256 nonce,uint256 deadline)"
);

POST

bytes32 constant POST = keccak256(
    "Post(uint256 profileId,string contentURI,address[] actionModules,bytes[] actionModulesInitDatas,address referenceModule,bytes referenceModuleInitData,uint256 nonce,uint256 deadline)"
);

QUOTE

bytes32 constant QUOTE = keccak256(
    "Quote(uint256 profileId,string contentURI,uint256 pointedProfileId,uint256 pointedPubId,uint256[] referrerProfileIds,uint256[] referrerPubIds,bytes referenceModuleData,address[] actionModules,bytes[] actionModulesInitDatas,address referenceModule,bytes referenceModuleInitData,uint256 nonce,uint256 deadline)"
);

SET_BLOCK_STATUS

bytes32 constant SET_BLOCK_STATUS = keccak256(
    "SetBlockStatus(uint256 byProfileId,uint256[] idsOfProfilesToSetBlockStatus,bool[] blockStatus,uint256 nonce,uint256 deadline)"
);

SET_FOLLOW_MODULE

bytes32 constant SET_FOLLOW_MODULE = keccak256(
    "SetFollowModule(uint256 profileId,address followModule,bytes followModuleInitData,uint256 nonce,uint256 deadline)"
);

SET_PROFILE_METADATA_URI

bytes32 constant SET_PROFILE_METADATA_URI =
    keccak256("SetProfileMetadataURI(uint256 profileId,string metadataURI,uint256 nonce,uint256 deadline)");

UNFOLLOW

bytes32 constant UNFOLLOW =
    keccak256("Unfollow(uint256 unfollowerProfileId,uint256[] idsOfProfilesToUnfollow,uint256 nonce,uint256 deadline)");

Types

Git Source

Author: Lens Protocol

A standard library of data types used throughout the Lens Protocol.

Structs

TokenData

ERC721Timestamped storage. Contains the owner address and the mint timestamp for every NFT. Note: Instead of the owner address in the _tokenOwners private mapping, we now store it in the _tokenData mapping, alongside the mint timestamp.

struct TokenData {
    address owner;
    uint96 mintTimestamp;
}

FollowData

A struct containing token follow-related data.

struct FollowData {
    uint160 followerProfileId;
    uint48 originalFollowTimestamp;
    uint48 followTimestamp;
    uint256 profileIdAllowedToRecover;
}

EIP712Signature

A struct containing the necessary information to reconstruct an EIP-712 typed data signature.

struct EIP712Signature {
    address signer;
    uint8 v;
    bytes32 r;
    bytes32 s;
    uint256 deadline;
}

Profile

A struct containing profile data.

struct Profile {
    uint256 pubCount;
    address followModule;
    address followNFT;
    string __DEPRECATED__handle;
    string __DEPRECATED__imageURI;
    string __DEPRECATED__followNFTURI;
    string metadataURI;
}

Publication

A struct containing publication data.

struct Publication {
    uint256 pointedProfileId;
    uint256 pointedPubId;
    string contentURI;
    address referenceModule;
    address __DEPRECATED__collectModule;
    address __DEPRECATED__collectNFT;
    PublicationType pubType;
    uint256 rootProfileId;
    uint256 rootPubId;
    mapping(address => bool) actionModuleEnabled;
}

PublicationMemory

struct PublicationMemory {
    uint256 pointedProfileId;
    uint256 pointedPubId;
    string contentURI;
    address referenceModule;
    address __DEPRECATED__collectModule;
    address __DEPRECATED__collectNFT;
    PublicationType pubType;
    uint256 rootProfileId;
    uint256 rootPubId;
}

CreateProfileParams

A struct containing the parameters required for the createProfile() function.

struct CreateProfileParams {
    address to;
    address followModule;
    bytes followModuleInitData;
}

PostParams

A struct containing the parameters required for the post() function.

struct PostParams {
    uint256 profileId;
    string contentURI;
    address[] actionModules;
    bytes[] actionModulesInitDatas;
    address referenceModule;
    bytes referenceModuleInitData;
}

CommentParams

A struct containing the parameters required for the comment() function.

struct CommentParams {
    uint256 profileId;
    string contentURI;
    uint256 pointedProfileId;
    uint256 pointedPubId;
    uint256[] referrerProfileIds;
    uint256[] referrerPubIds;
    bytes referenceModuleData;
    address[] actionModules;
    bytes[] actionModulesInitDatas;
    address referenceModule;
    bytes referenceModuleInitData;
}

QuoteParams

A struct containing the parameters required for the quote() function.

struct QuoteParams {
    uint256 profileId;
    string contentURI;
    uint256 pointedProfileId;
    uint256 pointedPubId;
    uint256[] referrerProfileIds;
    uint256[] referrerPubIds;
    bytes referenceModuleData;
    address[] actionModules;
    bytes[] actionModulesInitDatas;
    address referenceModule;
    bytes referenceModuleInitData;
}

ReferencePubParams

A struct containing the parameters required for the comment() or quote() internal functions.

struct ReferencePubParams {
    uint256 profileId;
    string contentURI;
    uint256 pointedProfileId;
    uint256 pointedPubId;
    uint256[] referrerProfileIds;
    uint256[] referrerPubIds;
    bytes referenceModuleData;
    address[] actionModules;
    bytes[] actionModulesInitDatas;
    address referenceModule;
    bytes referenceModuleInitData;
}

MirrorParams

A struct containing the parameters required for the mirror() function.

struct MirrorParams {
    uint256 profileId;
    string metadataURI;
    uint256 pointedProfileId;
    uint256 pointedPubId;
    uint256[] referrerProfileIds;
    uint256[] referrerPubIds;
    bytes referenceModuleData;
}

LegacyCollectParams

Deprecated in V2: Will be removed after some time after upgrading to V2.

A struct containing the parameters required for the legacy collect() function.

The referrer can only be a mirror of the publication being collected.

struct LegacyCollectParams {
    uint256 publicationCollectedProfileId;
    uint256 publicationCollectedId;
    uint256 collectorProfileId;
    uint256 referrerProfileId;
    uint256 referrerPubId;
    bytes collectModuleData;
}

PublicationActionParams

A struct containing the parameters required for the action() function.

struct PublicationActionParams {
    uint256 publicationActedProfileId;
    uint256 publicationActedId;
    uint256 actorProfileId;
    uint256[] referrerProfileIds;
    uint256[] referrerPubIds;
    address actionModuleAddress;
    bytes actionModuleData;
}

ProcessActionParams

struct ProcessActionParams {
    uint256 publicationActedProfileId;
    uint256 publicationActedId;
    uint256 actorProfileId;
    address actorProfileOwner;
    address transactionExecutor;
    uint256[] referrerProfileIds;
    uint256[] referrerPubIds;
    Types.PublicationType[] referrerPubTypes;
    bytes actionModuleData;
}

ProcessCollectParams

struct ProcessCollectParams {
    uint256 publicationCollectedProfileId;
    uint256 publicationCollectedId;
    uint256 collectorProfileId;
    address collectorProfileOwner;
    address transactionExecutor;
    uint256[] referrerProfileIds;
    uint256[] referrerPubIds;
    Types.PublicationType[] referrerPubTypes;
    bytes data;
}

ProcessCommentParams

struct ProcessCommentParams {
    uint256 profileId;
    address transactionExecutor;
    uint256 pointedProfileId;
    uint256 pointedPubId;
    uint256[] referrerProfileIds;
    uint256[] referrerPubIds;
    Types.PublicationType[] referrerPubTypes;
    bytes data;
}

ProcessQuoteParams

struct ProcessQuoteParams {
    uint256 profileId;
    address transactionExecutor;
    uint256 pointedProfileId;
    uint256 pointedPubId;
    uint256[] referrerProfileIds;
    uint256[] referrerPubIds;
    Types.PublicationType[] referrerPubTypes;
    bytes data;
}

ProcessMirrorParams

struct ProcessMirrorParams {
    uint256 profileId;
    address transactionExecutor;
    uint256 pointedProfileId;
    uint256 pointedPubId;
    uint256[] referrerProfileIds;
    uint256[] referrerPubIds;
    Types.PublicationType[] referrerPubTypes;
    bytes data;
}

DelegatedExecutorsConfig

A struct containing a profile's delegated executors configuration.

struct DelegatedExecutorsConfig {
    mapping(uint256 => mapping(address => bool)) isApproved;
    uint64 configNumber;
    uint64 prevConfigNumber;
    uint64 maxConfigNumberSet;
}

TreasuryData

struct TreasuryData {
    address treasury;
    uint16 treasuryFeeBPS;
}

MigrationParams

struct MigrationParams {
    address lensHandlesAddress;
    address tokenHandleRegistryAddress;
    address legacyFeeFollowModule;
    address legacyProfileFollowModule;
    address newFeeFollowModule;
    address migrationAdmin;
}

Enums

ProtocolState

An enum containing the different states the protocol can be in, limiting certain actions.

enum ProtocolState {
    Unpaused,
    PublishingPaused,
    Paused
}

PublicationType

An enum specifically used in a helper function to easily retrieve the publication type for integrations.

enum PublicationType {
    Nonexistent,
    Post,
    Comment,
    Mirror,
    Quote
}

Contents

• FollowTokenURILib
• HandleTokenURILib
• ProfileTokenURILib
• TokenURIMainFontLib
• TokenURISecondaryFontLib

FollowTokenURILib

Git Source

Functions

getTokenURI

function getTokenURI(uint256 followTokenId, uint256 followedProfileId, uint256 originalFollowTimestamp)
    external
    pure
    returns (string memory);

_getSVGImageBase64Encoded

function _getSVGImageBase64Encoded(string memory followTokenIdAsString, string memory followedProfileIdAsString)
    private
    pure
    returns (string memory);

HandleTokenURILib

Git Source

Functions

getTokenURI

function getTokenURI(uint256 tokenId, string memory localName) external pure returns (string memory);

_getSVGImageBase64Encoded

function _getSVGImageBase64Encoded(string memory localName) private pure returns (string memory);

_localNameLengthToFontSize

Maps the local name length to a font size.

Gives the font size as a function of the local name length. This dynamic font size mapping ensures all handle token URIs will look nice when rendered as image.

function _localNameLengthToFontSize(uint256 localNameLength) internal pure returns (uint256);

Parameters

Returns

ProfileTokenURILib

Git Source

Functions

getTokenURI

function getTokenURI(uint256 profileId) external view returns (string memory);

_getSVGImageBase64Encoded

function _getSVGImageBase64Encoded(string memory profileIdAsString) private pure returns (string memory);

TokenURIMainFontLib

Git Source

Functions

getFontName

function getFontName() internal pure returns (string memory);

getFontBase64Encoded

function getFontBase64Encoded() external pure returns (string memory);

TokenURISecondaryFontLib

Git Source

Functions

getFontName

function getFontName() internal pure returns (string memory);

getFontBase64Encoded

function getFontBase64Encoded() external pure returns (string memory);

ActionLib

Git Source

Functions

act

function act(
    Types.PublicationActionParams calldata publicationActionParams,
    address transactionExecutor,
    address actorProfileOwner
) external returns (bytes memory);

_isActionEnabled

function _isActionEnabled(Types.Publication storage _publication, address actionModuleAddress)
    private
    view
    returns (bool);

FollowLib

Git Source

Functions

follow

function follow(
    uint256 followerProfileId,
    address transactionExecutor,
    uint256[] calldata idsOfProfilesToFollow,
    uint256[] calldata followTokenIds,
    bytes[] calldata followModuleDatas
) external returns (uint256[] memory);

unfollow

function unfollow(uint256 unfollowerProfileId, address transactionExecutor, uint256[] calldata idsOfProfilesToUnfollow)
    external;

_deployFollowNFT

Deploys the given profile's Follow NFT contract.

function _deployFollowNFT(uint256 profileId) private returns (address);

Parameters

Returns

_follow

function _follow(
    uint256 followerProfileId,
    address transactionExecutor,
    uint256 idOfProfileToFollow,
    uint256 followTokenId,
    bytes calldata followModuleData
) private returns (uint256);

_processFollow

function _processFollow(ProcessFollowParams memory processFollowParams) private returns (uint256);

Structs

ProcessFollowParams

struct ProcessFollowParams {
    address followNFT;
    uint256 followerProfileId;
    address transactionExecutor;
    uint256 idOfProfileToFollow;
    uint256 followTokenId;
    address followModule;
    bytes followModuleData;
}

GovernanceLib

Git Source

State Variables

BPS_MAX

uint16 internal constant BPS_MAX = 10000;

Functions

setGovernance

Sets the governance address.

function setGovernance(address newGovernance) external;

Parameters

setEmergencyAdmin

Sets the emergency admin address.

function setEmergencyAdmin(address newEmergencyAdmin) external;

Parameters

initState

Sets the protocol state, only meant to be called at initialization since this does not validate the caller.

function initState(Types.ProtocolState newState) external;

Parameters

setState

Sets the protocol state and validates the caller. The emergency admin can only pause further (Unpaused => PublishingPaused => Paused). Whereas governance can set any state.

function setState(Types.ProtocolState newState) external;

Parameters

_setState

function _setState(Types.ProtocolState newState) private returns (Types.ProtocolState);

whitelistProfileCreator

function whitelistProfileCreator(address profileCreator, bool whitelist) external;

setTreasury

function setTreasury(address newTreasury) internal;

setTreasuryFee

function setTreasuryFee(uint16 newTreasuryFee) internal;

LegacyCollectLib

Git Source

Author: Lens Protocol

Library containing the logic for legacy collect operation.

Functions

collect

function collect(
    Types.LegacyCollectParams calldata collectParams,
    address transactionExecutor,
    address collectorProfileOwner,
    address collectNFTImpl
) external returns (uint256);

_getOrDeployCollectNFT

function _getOrDeployCollectNFT(
    Types.Publication storage _collectedPublication,
    uint256 publicationCollectedProfileId,
    uint256 publicationCollectedId,
    address collectNFTImpl
) private returns (address);

_deployCollectNFT

Deploys the given profile's Collect NFT contract.

function _deployCollectNFT(uint256 profileId, uint256 pubId, address collectNFTImpl) private returns (address);

Parameters

Returns

Events

CollectedLegacy

Emitted upon a successful legacy collect action.

event CollectedLegacy(
    uint256 indexed publicationCollectedProfileId,
    uint256 indexed publicationCollectedId,
    address transactionExecutor,
    uint256 referrerProfileId,
    uint256 referrerPubId,
    bytes collectModuleData,
    uint256 timestamp
);

MetaTxLib

Git Source

Author: Lens Protocol NOTE: the functions in this contract operate under the assumption that the passed signer is already validated to either be the originator or one of their delegated executors.

User nonces are incremented from this library as well.

State Variables

EIP712_DOMAIN_VERSION

string constant EIP712_DOMAIN_VERSION = "2";

EIP712_DOMAIN_VERSION_HASH

bytes32 constant EIP712_DOMAIN_VERSION_HASH = keccak256(bytes(EIP712_DOMAIN_VERSION));

EIP1271_MAGIC_VALUE

bytes4 constant EIP1271_MAGIC_VALUE = 0x1626ba7e;

LENS_HUB_CACHED_POLYGON_DOMAIN_SEPARATOR

We store the domain separator and LensHub Proxy address as constants to save gas. keccak256( abi.encode( keccak256('EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)'), keccak256('Lens Protocol Profiles'), // Contract Name keccak256('2'), // Version Hash 137, // Polygon Chain ID address(0xDb46d1Dc155634FbC732f92E853b10B288AD5a1d) // Verifying Contract Address - LensHub Address ) );

bytes32 constant LENS_HUB_CACHED_POLYGON_DOMAIN_SEPARATOR =
    0xbf9544cf7d7a0338fc4f071be35409a61e51e9caef559305410ad74e16a05f2d;

LENS_HUB_ADDRESS

address constant LENS_HUB_ADDRESS = 0xDb46d1Dc155634FbC732f92E853b10B288AD5a1d;

POLYGON_CHAIN_ID

uint256 constant POLYGON_CHAIN_ID = 137;

Functions

validateSetProfileMetadataURISignature

function validateSetProfileMetadataURISignature(
    Types.EIP712Signature calldata signature,
    uint256 profileId,
    string calldata metadataURI
) external;

validateSetFollowModuleSignature

function validateSetFollowModuleSignature(
    Types.EIP712Signature calldata signature,
    uint256 profileId,
    address followModule,
    bytes calldata followModuleInitData
) external;

validateChangeDelegatedExecutorsConfigSignature

function validateChangeDelegatedExecutorsConfigSignature(
    Types.EIP712Signature calldata signature,
    uint256 delegatorProfileId,
    address[] calldata delegatedExecutors,
    bool[] calldata approvals,
    uint64 configNumber,
    bool switchToGivenConfig
) external;

validatePostSignature

function validatePostSignature(Types.EIP712Signature calldata signature, Types.PostParams calldata postParams)
    external;

validateCommentSignature

function validateCommentSignature(Types.EIP712Signature calldata signature, Types.CommentParams calldata commentParams)
    external;

validateQuoteSignature

function validateQuoteSignature(Types.EIP712Signature calldata signature, Types.QuoteParams calldata quoteParams)
    external;

validateMirrorSignature

function validateMirrorSignature(Types.EIP712Signature calldata signature, Types.MirrorParams calldata mirrorParams)
    external;

validateFollowSignature

function validateFollowSignature(
    Types.EIP712Signature calldata signature,
    uint256 followerProfileId,
    uint256[] calldata idsOfProfilesToFollow,
    uint256[] calldata followTokenIds,
    bytes[] calldata datas
) external;

validateUnfollowSignature

function validateUnfollowSignature(
    Types.EIP712Signature calldata signature,
    uint256 unfollowerProfileId,
    uint256[] calldata idsOfProfilesToUnfollow
) external;

validateSetBlockStatusSignature

function validateSetBlockStatusSignature(
    Types.EIP712Signature calldata signature,
    uint256 byProfileId,
    uint256[] calldata idsOfProfilesToSetBlockStatus,
    bool[] calldata blockStatus
) external;

validateLegacyCollectSignature

function validateLegacyCollectSignature(
    Types.EIP712Signature calldata signature,
    Types.LegacyCollectParams calldata collectParams
) external;

validateActSignature

function validateActSignature(
    Types.EIP712Signature calldata signature,
    Types.PublicationActionParams calldata publicationActionParams
) external;

calculateDomainSeparator

function calculateDomainSeparator() internal view returns (bytes32);

_validateRecoveredAddress

Wrapper for ecrecover to reduce code size, used in meta-tx specific functions.

function _validateRecoveredAddress(bytes32 digest, Types.EIP712Signature calldata signature) private view;

_calculateDigest

Calculates EIP712 digest based on the current DOMAIN_SEPARATOR.

function _calculateDigest(bytes32 hashedMessage) private view returns (bytes32);

Parameters

Returns

_getNonceIncrementAndEmitEvent

This fetches a signer's current nonce and increments it so it's ready for the next meta-tx. Also emits the NonceUpdated event.

function _getNonceIncrementAndEmitEvent(address signer) private returns (uint256);

Parameters

Returns

_encodeUsingEip712Rules

function _encodeUsingEip712Rules(bytes[] memory bytesArray) private pure returns (bytes32);

_encodeUsingEip712Rules

function _encodeUsingEip712Rules(bool[] memory boolArray) private pure returns (bytes32);

_encodeUsingEip712Rules

function _encodeUsingEip712Rules(address[] memory addressArray) private pure returns (bytes32);

_encodeUsingEip712Rules

function _encodeUsingEip712Rules(uint256[] memory uint256Array) private pure returns (bytes32);

_encodeUsingEip712Rules

function _encodeUsingEip712Rules(bytes32[] memory bytes32Array) private pure returns (bytes32);

_encodeUsingEip712Rules

function _encodeUsingEip712Rules(string memory stringValue) private pure returns (bytes32);

_encodeUsingEip712Rules

function _encodeUsingEip712Rules(bytes memory bytesValue) private pure returns (bytes32);

ILegacyFeeFollowModule

Git Source

Functions

getProfileData

function getProfileData(uint256 profileId) external view returns (ProfileData memory);

Structs

ProfileData

struct ProfileData {
    address currency;
    uint256 amount;
    address recipient;
}

MigrationLib

Git Source

State Variables

LENS_PROTOCOL_PROFILE_ID

uint256 internal constant LENS_PROTOCOL_PROFILE_ID = 1;

DOT_LENS_SUFFIX_LENGTH

uint256 internal constant DOT_LENS_SUFFIX_LENGTH = 5;

Functions

batchMigrateProfiles

Migrates an array of profiles from V1 to V2. This function can be callable by anyone. We would still perform the migration in batches by ourselves, but good to allow users to migrate on their own if they want to.

function batchMigrateProfiles(
    uint256[] calldata profileIds,
    LensHandles lensHandles,
    TokenHandleRegistry tokenHandleRegistry
) external;

Parameters

_migrateProfile

Migrates a profile from V1 to V2.

We do not revert in any case, as we want to allow the migration to continue even if one profile fails (and it usually fails if already migrated or profileNFT moved).

Estimated gas cost of one profile migration is around 178k gas.

function _migrateProfile(uint256 profileId, LensHandles lensHandles, TokenHandleRegistry tokenHandleRegistry) private;

Parameters

batchMigrateFollows

function batchMigrateFollows(
    uint256 followerProfileIds,
    uint256[] calldata idsOfProfileFollowed,
    uint256[] calldata followTokenIds
) external;

batchMigrateFollowers

function batchMigrateFollowers(
    uint256[] calldata followerProfileIds,
    uint256 idOfProfileFollowed,
    uint256[] calldata followTokenIds
) external;

_migrateFollow

function _migrateFollow(
    address followNFT,
    uint256 followerProfileId,
    uint256 idOfProfileFollowed,
    uint256 followTokenId
) private;

batchMigrateFollowModules

function batchMigrateFollowModules(
    uint256[] calldata profileIds,
    address legacyFeeFollowModule,
    address legacyProfileFollowModule,
    address newFeeFollowModule
) external;

Events

ProfileMigrated

event ProfileMigrated(uint256 profileId, address profileDestination, string handle, uint256 handleId);

ProfileLib

Git Source

Functions

MODULE_REGISTRY

function MODULE_REGISTRY() internal view returns (IModuleRegistry);

ownerOf

function ownerOf(uint256 profileId) internal view returns (address);

exists

function exists(uint256 profileId) internal view returns (bool);

createProfile

Creates a profile with the given parameters to the given address. Minting happens in the hub.

function createProfile(Types.CreateProfileParams calldata createProfileParams, uint256 profileId) external;

Parameters

setFollowModule

Sets the follow module for a given profile.

function setFollowModule(
    uint256 profileId,
    address followModule,
    bytes calldata followModuleInitData,
    address transactionExecutor
) external;

Parameters

setProfileMetadataURI

function setProfileMetadataURI(uint256 profileId, string calldata metadataURI, address transactionExecutor) external;

_initFollowModule

function _initFollowModule(
    uint256 profileId,
    address transactionExecutor,
    address followModule,
    bytes memory followModuleInitData
) private returns (bytes memory);

setBlockStatus

function setBlockStatus(
    uint256 byProfileId,
    uint256[] calldata idsOfProfilesToSetBlockStatus,
    bool[] calldata blockStatus,
    address transactionExecutor
) external;

switchToNewFreshDelegatedExecutorsConfig

function switchToNewFreshDelegatedExecutorsConfig(uint256 profileId) external;

changeDelegatedExecutorsConfig

function changeDelegatedExecutorsConfig(
    uint256 delegatorProfileId,
    address[] calldata delegatedExecutors,
    bool[] calldata approvals
) external;

changeGivenDelegatedExecutorsConfig

function changeGivenDelegatedExecutorsConfig(
    uint256 delegatorProfileId,
    address[] calldata delegatedExecutors,
    bool[] calldata approvals,
    uint64 configNumber,
    bool switchToGivenConfig
) external;

isExecutorApproved

function isExecutorApproved(uint256 delegatorProfileId, address delegatedExecutor) external view returns (bool);

_changeDelegatedExecutorsConfig

function _changeDelegatedExecutorsConfig(
    Types.DelegatedExecutorsConfig storage _delegatedExecutorsConfig,
    uint256 delegatorProfileId,
    address[] memory delegatedExecutors,
    bool[] memory approvals,
    uint64 configNumber,
    bool switchToGivenConfig
) private;

_prepareStorageToApplyChangesUnderGivenConfig

function _prepareStorageToApplyChangesUnderGivenConfig(
    Types.DelegatedExecutorsConfig storage _delegatedExecutorsConfig,
    uint64 configNumber,
    bool switchToGivenConfig
) private returns (bool);

_setFollowModule

function _setFollowModule(
    uint256 profileId,
    address followModule,
    bytes calldata followModuleInitData,
    address transactionExecutor
) private;

PublicationLib

Git Source

Functions

MODULE_REGISTRY

function MODULE_REGISTRY() internal view returns (IModuleRegistry);

post

Publishes a post to a given profile.

function post(Types.PostParams calldata postParams, address transactionExecutor) external returns (uint256);

Parameters

Returns

comment

Publishes a comment to a given profile via signature.

function comment(Types.CommentParams calldata commentParams, address transactionExecutor) external returns (uint256);

Parameters

Returns

mirror

Publishes a mirror to a given profile.

function mirror(Types.MirrorParams calldata mirrorParams, address transactionExecutor) external returns (uint256);

Parameters

Returns

quote

Publishes a quote publication to a given profile via signature.

function quote(Types.QuoteParams calldata quoteParams, address transactionExecutor) external returns (uint256);

Parameters

Returns

getPublicationType

function getPublicationType(uint256 profileId, uint256 pubId) internal view returns (Types.PublicationType);

getContentURI

function getContentURI(uint256 profileId, uint256 pubId) external view returns (string memory);

_asReferencePubParams

function _asReferencePubParams(Types.QuoteParams calldata quoteParams)
    private
    pure
    returns (Types.ReferencePubParams calldata referencePubParams);

_asReferencePubParams

function _asReferencePubParams(Types.CommentParams calldata commentParams)
    private
    pure
    returns (Types.ReferencePubParams calldata referencePubParams);

_createReferencePublication

function _createReferencePublication(
    Types.ReferencePubParams calldata referencePubParams,
    address transactionExecutor,
    Types.PublicationType referencePubType
) private returns (uint256, bytes[] memory, bytes memory, Types.PublicationType[] memory);

_fillReferencePublicationStorage

function _fillReferencePublicationStorage(
    Types.ReferencePubParams calldata referencePubParams,
    Types.PublicationType referencePubType
) private returns (uint256, uint256);

_fillRootOfPublicationInStorage

function _fillRootOfPublicationInStorage(
    Types.Publication storage _publication,
    uint256 pointedProfileId,
    uint256 pointedPubId
) internal returns (uint256);

_processCommentIfNeeded

function _processCommentIfNeeded(
    Types.CommentParams calldata commentParams,
    address transactionExecutor,
    Types.PublicationType[] memory referrerPubTypes
) private returns (bytes memory);

_processQuoteIfNeeded

Equivalent to reverting with the returned error selector if the length is not zero.

function _processQuoteIfNeeded(
    Types.QuoteParams calldata quoteParams,
    address transactionExecutor,
    Types.PublicationType[] memory referrerPubTypes
) private returns (bytes memory);

_processMirrorIfNeeded

Equivalent to reverting with the returned error selector if the length is not zero.

function _processMirrorIfNeeded(
    Types.MirrorParams calldata mirrorParams,
    address transactionExecutor,
    Types.PublicationType[] memory referrerPubTypes
) private returns (bytes memory);

_initPubActionModules

function _initPubActionModules(InitActionModuleParams memory params) private returns (bytes[] memory);

_initPubReferenceModule

function _initPubReferenceModule(InitReferenceModuleParams memory params) private returns (bytes memory);

Structs

InitActionModuleParams

Equivalent to reverting with the returned error selector if the length is not zero.

struct InitActionModuleParams {
    uint256 profileId;
    address transactionExecutor;
    uint256 pubId;
    address[] actionModules;
    bytes[] actionModulesInitDatas;
}

InitReferenceModuleParams

struct InitReferenceModuleParams {
    uint256 profileId;
    address transactionExecutor;
    uint256 pubId;
    address referenceModule;
    bytes referenceModuleInitData;
}

StorageLib

Git Source

State Variables

TOKEN_DATA_MAPPING_SLOT

uint256 constant TOKEN_DATA_MAPPING_SLOT = 2;

SIG_NONCES_MAPPING_SLOT

uint256 constant SIG_NONCES_MAPPING_SLOT = 10;

LAST_INITIALIZED_REVISION_SLOT

uint256 constant LAST_INITIALIZED_REVISION_SLOT = 11;

PROTOCOL_STATE_SLOT

uint256 constant PROTOCOL_STATE_SLOT = 12;

PROFILE_CREATOR_WHITELIST_MAPPING_SLOT

uint256 constant PROFILE_CREATOR_WHITELIST_MAPPING_SLOT = 13;

PROFILE_ID_BY_HANDLE_HASH_MAPPING_SLOT

uint256 constant PROFILE_ID_BY_HANDLE_HASH_MAPPING_SLOT = 18;

PROFILES_MAPPING_SLOT

uint256 constant PROFILES_MAPPING_SLOT = 19;

PUBLICATIONS_MAPPING_SLOT

uint256 constant PUBLICATIONS_MAPPING_SLOT = 20;

PROFILE_COUNTER_SLOT

uint256 constant PROFILE_COUNTER_SLOT = 22;

GOVERNANCE_SLOT

uint256 constant GOVERNANCE_SLOT = 23;

EMERGENCY_ADMIN_SLOT

uint256 constant EMERGENCY_ADMIN_SLOT = 24;

TOKEN_GUARDIAN_DISABLING_TIMESTAMP_MAPPING_SLOT

Introduced in Lens V1.3: ///

uint256 constant TOKEN_GUARDIAN_DISABLING_TIMESTAMP_MAPPING_SLOT = 25;

DELEGATED_EXECUTOR_CONFIG_MAPPING_SLOT

Introduced in Lens V2: ///

uint256 constant DELEGATED_EXECUTOR_CONFIG_MAPPING_SLOT = 26;

BLOCKED_STATUS_MAPPING_SLOT

uint256 constant BLOCKED_STATUS_MAPPING_SLOT = 27;

PROFILE_ROYALTIES_BPS_SLOT

uint256 constant PROFILE_ROYALTIES_BPS_SLOT = 28;

MIGRATION_ADMINS_WHITELISTED_MAPPING_SLOT

uint256 constant MIGRATION_ADMINS_WHITELISTED_MAPPING_SLOT = 29;

TREASURY_DATA_SLOT

uint256 constant TREASURY_DATA_SLOT = 30;

Functions

getPublication

function getPublication(uint256 profileId, uint256 pubId)
    internal
    pure
    returns (Types.Publication storage _publication);

getPublicationMemory

function getPublicationMemory(uint256 profileId, uint256 pubId)
    internal
    pure
    returns (Types.PublicationMemory memory);

getProfile

function getProfile(uint256 profileId) internal pure returns (Types.Profile storage _profiles);

getDelegatedExecutorsConfig

function getDelegatedExecutorsConfig(uint256 delegatorProfileId)
    internal
    pure
    returns (Types.DelegatedExecutorsConfig storage _delegatedExecutorsConfig);

tokenGuardianDisablingTimestamp

function tokenGuardianDisablingTimestamp()
    internal
    pure
    returns (mapping(address => uint256) storage _tokenGuardianDisablingTimestamp);

getTokenData

function getTokenData(uint256 tokenId) internal pure returns (Types.TokenData storage _tokenData);

blockedStatus

function blockedStatus(uint256 blockerProfileId)
    internal
    pure
    returns (mapping(uint256 => bool) storage _blockedStatus);

nonces

function nonces() internal pure returns (mapping(address => uint256) storage _nonces);

profileIdByHandleHash

function profileIdByHandleHash() internal pure returns (mapping(bytes32 => uint256) storage _profileIdByHandleHash);

profileCreatorWhitelisted

function profileCreatorWhitelisted()
    internal
    pure
    returns (mapping(address => bool) storage _profileCreatorWhitelisted);

migrationAdminWhitelisted

function migrationAdminWhitelisted()
    internal
    pure
    returns (mapping(address => bool) storage _migrationAdminWhitelisted);

getGovernance

function getGovernance() internal view returns (address _governance);

setGovernance

function setGovernance(address newGovernance) internal;

getEmergencyAdmin

function getEmergencyAdmin() internal view returns (address _emergencyAdmin);

setEmergencyAdmin

function setEmergencyAdmin(address newEmergencyAdmin) internal;

getState

function getState() internal view returns (Types.ProtocolState _state);

setState

function setState(Types.ProtocolState newState) internal;

getLastInitializedRevision

function getLastInitializedRevision() internal view returns (uint256 _lastInitializedRevision);

setLastInitializedRevision

function setLastInitializedRevision(uint256 newLastInitializedRevision) internal;

getTreasuryData

function getTreasuryData() internal pure returns (Types.TreasuryData storage _treasuryData);

ValidationLib

Git Source

Author: Lens Protocol

Functions

validatePointedPub

function validatePointedPub(uint256 profileId, uint256 pubId) internal view;

validateAddressIsProfileOwner

function validateAddressIsProfileOwner(address expectedProfileOwner, uint256 profileId) internal view;

validateAddressIsProfileOwnerOrDelegatedExecutor

function validateAddressIsProfileOwnerOrDelegatedExecutor(address expectedOwnerOrDelegatedExecutor, uint256 profileId)
    internal
    view;

validateAddressIsDelegatedExecutor

function validateAddressIsDelegatedExecutor(address expectedDelegatedExecutor, uint256 delegatorProfileId)
    internal
    view;

validateProfileCreatorWhitelisted

function validateProfileCreatorWhitelisted(address profileCreator) internal view;

validateNotBlocked

function validateNotBlocked(uint256 profile, uint256 byProfile) internal view;

validateNotBlocked

function validateNotBlocked(uint256 profile, uint256 byProfile, bool unidirectionalCheck) internal view;

validateProfileExists

function validateProfileExists(uint256 profileId) internal view;

validateCallerIsGovernance

function validateCallerIsGovernance() internal view;

validateReferrersAndGetReferrersPubTypes

function validateReferrersAndGetReferrersPubTypes(
    uint256[] memory referrerProfileIds,
    uint256[] memory referrerPubIds,
    uint256 targetedProfileId,
    uint256 targetedPubId
) internal view returns (Types.PublicationType[] memory);

validateLegacyCollectReferrer

function validateLegacyCollectReferrer(
    uint256 referrerProfileId,
    uint256 referrerPubId,
    uint256 publicationCollectedProfileId,
    uint256 publicationCollectedId
) external view;

_validateReferrerAndGetReferrerPubType

function _validateReferrerAndGetReferrerPubType(
    uint256 referrerProfileId,
    uint256 referrerPubId,
    uint256 targetedProfileId,
    uint256 targetedPubId
) private view returns (Types.PublicationType);

_validateReferrerAsPost

function _validateReferrerAsPost(
    uint256 referrerProfileId,
    uint256 referrerPubId,
    uint256 targetedProfileId,
    uint256 targetedPubId
) private view;

_validateReferrerAsMirrorOrCommentOrQuote

Validates that the referrer publication and the interacted publication are linked.

function _validateReferrerAsMirrorOrCommentOrQuote(
    uint256 referrerProfileId,
    uint256 referrerPubId,
    uint256 targetedProfileId,
    uint256 targetedPubId
) private view;

Parameters

Contents

• access
• ImmutableOwnable
• LegacyCollectNFT
• LensHubInitializable
• LensV2Migration
• LensV2UpgradeContract
• ModuleRegistry
• ProfileCreationProxy

Contents

• ControllableByContract
• Governance
• LitAccessControl
• ProxyAdmin

ControllableByContract

Git Source

Inherits: Ownable

State Variables

controllerContract

address public controllerContract;

Functions

onlyOwnerOrControllerContract

modifier onlyOwnerOrControllerContract();

constructor

constructor(address owner) Ownable;

clearControllerContract

function clearControllerContract() external onlyOwnerOrControllerContract;

setControllerContract

function setControllerContract(address newControllerContract) external onlyOwner;

Events

ControllerContractUpdated

event ControllerContractUpdated(address previousControllerContract, address newControllerContract);

Errors

Unauthorized

error Unauthorized();

Governance

Git Source

Inherits: ControllableByContract

State Variables

LENS_HUB

ILensHub public immutable LENS_HUB;

Functions

constructor

constructor(address lensHubAddress_, address governanceOwner_) ControllableByContract(governanceOwner_);

lensHub_setGovernance

ONLY GOVERNANCE OWNER ///

function lensHub_setGovernance(address newGovernance) external onlyOwner;

lensHub_setEmergencyAdmin

function lensHub_setEmergencyAdmin(address newEmergencyAdmin) external onlyOwner;

lensHub_whitelistProfileCreator

ONLY GOVERNANCE OWNER OR CONTROLLER CONTRACT ///

function lensHub_whitelistProfileCreator(address profileCreator, bool whitelist)
    external
    onlyOwnerOrControllerContract;

executeAsGovernance

function executeAsGovernance(address target, bytes calldata data)
    external
    payable
    onlyOwnerOrControllerContract
    returns (bytes memory);

LitAccessControl

Git Source

Author: Lens Protocol

This contract enables additional access control for encrypted publications on Lens by reporting whether an address owns or has control over a given profile.

State Variables

LENS_HUB

address internal immutable LENS_HUB;

COLLECT_PUB_ACTION

address internal immutable COLLECT_PUB_ACTION;

Functions

constructor

constructor(address lensHub, address collectPubAction);

hasAccess

Function used to check whether an address is the Owner or Delegated Executor of a profile.

function hasAccess(address requestorAddress, uint256 profileId, bytes memory) external view returns (bool);

Parameters

Returns

isFollowing

Function used to check whether followerProfileId is following profileId and requestor is Owner/Delegated Executor of followerProfileId.

function isFollowing(address requestorAddress, uint256 profileId, uint256 followerProfileId, bytes memory)
    external
    view
    returns (bool);

Parameters

hasCollected

Function used to check whether an address owns or has collected the publication.

function hasCollected(
    address requestorAddress,
    uint256 publisherId,
    uint256 pubId,
    uint256 collectorProfileId,
    bytes memory
) external view returns (bool);

Parameters

Returns

_isOwnerOrDelegatedExecutor

Internal function used to check whether an address is the Owner or DelegatedExecutor of a profile.

function _isOwnerOrDelegatedExecutor(address requestorAddress, uint256 profileId) internal view returns (bool);

Parameters

Returns

ProxyAdmin

Git Source

Inherits: ControllableByContract

State Variables

LENS_HUB_PROXY

TransparentUpgradeableProxy public immutable LENS_HUB_PROXY;

previousImplementation

address public previousImplementation;

Functions

constructor

constructor(address lensHubAddress_, address previousImplementation_, address proxyAdminOwner_)
    ControllableByContract(proxyAdminOwner_);

currentImplementation

function currentImplementation() external returns (address);

rollbackLastUpgrade

ONLY PROXY ADMIN OWNER ///

function rollbackLastUpgrade() external onlyOwner;

proxy_changeAdmin

function proxy_changeAdmin(address newAdmin) external onlyOwner;

proxy_upgrade

ONLY PROXY ADMIN OWNER OR CONTROLLER CONTRACT ///

function proxy_upgrade(address newImplementation) external onlyOwnerOrControllerContract;

proxy_upgradeAndCall

function proxy_upgradeAndCall(address newImplementation, bytes calldata data) external onlyOwnerOrControllerContract;

ImmutableOwnable

Git Source

State Variables

OWNER

address public immutable OWNER;

LENS_HUB

address public immutable LENS_HUB;

Functions

onlyOwner

modifier onlyOwner();

onlyOwnerOrHub

modifier onlyOwnerOrHub();

constructor

constructor(address owner, address lensHub);

Errors

OnlyOwner

error OnlyOwner();

OnlyOwnerOrHub

error OnlyOwnerOrHub();

LegacyCollectNFT

Git Source

Inherits: LensBaseERC721, ERC2981CollectionRoyalties, ICollectNFT

Author: Lens Protocol

This is the NFT contract that is minted upon collecting a given publication. It is cloned upon the first collect for a given publication, and the token URI points to the original publication's contentURI.

This is the Legacy CollectNFT that is used for Legacy Lens V1 publications. The new CollectNFT was introduced in Lens V2 with the only difference that it is restricted by the Action Module instead of the LensHub.

State Variables

HUB

address public immutable HUB;

_profileId

uint256 internal _profileId;

_pubId

uint256 internal _pubId;

_tokenIdCounter

uint256 internal _tokenIdCounter;

_initialized

bool private _initialized;

_royaltiesInBasisPoints

uint256 internal _royaltiesInBasisPoints;

Functions

constructor

constructor(address hub);

initialize

Initializes the collect NFT, setting the feed as the privileged minter, storing the collected publication pointer and initializing the name and symbol in the LensNFTBase contract.

function initialize(uint256 profileId, uint256 pubId) external override;

Parameters

mint

Mints a collect NFT to the specified address. This can only be called by the hub and is called upon collection.

function mint(address to) external override returns (uint256);

Parameters

Returns

getSourcePublicationPointer

Returns the source publication of this collect NFT.

function getSourcePublicationPointer() external view override returns (uint256, uint256);

Returns

tokenURI

function tokenURI(uint256 tokenId) public view override returns (string memory);

name

See {IERC721Metadata-name}.

function name() public view override returns (string memory);

symbol

See {IERC721Metadata-symbol}.

function symbol() public pure override returns (string memory);

supportsInterface

See {IERC165-supportsInterface}.

function supportsInterface(bytes4 interfaceId)
    public
    view
    virtual
    override(ERC2981CollectionRoyalties, LensBaseERC721)
    returns (bool);

_getReceiver

function _getReceiver(uint256) internal view override returns (address);

_beforeRoyaltiesSet

function _beforeRoyaltiesSet(uint256) internal view override;

_getRoyaltiesInBasisPointsSlot

function _getRoyaltiesInBasisPointsSlot() internal pure override returns (uint256);

LensHubInitializable

Git Source

Inherits: LensHub, VersionedInitializable, ILensHubInitializable

Author: Lens Protocol

Extension of LensHub contract that includes initialization for fresh deployments.

State Variables

REVISION

uint256 internal constant REVISION = 1;

Functions

constructor

constructor(
    address followNFTImpl,
    address collectNFTImpl,
    address moduleRegistry,
    uint256 tokenGuardianCooldown,
    Types.MigrationParams memory migrationParams
) LensHub(followNFTImpl, collectNFTImpl, moduleRegistry, tokenGuardianCooldown, migrationParams);

initialize

Initializes the LensHub, setting the initial governance address, the name and symbol of the profiles in the LensNFTBase contract, and Protocol State (Paused).

This is assuming a proxy pattern is implemented.

function initialize(string calldata name, string calldata symbol, address newGovernance)
    external
    override
    initializer;

Parameters

getRevision

function getRevision() internal pure virtual override returns (uint256);

LensV2Migration

Git Source

State Variables

FEE_FOLLOW_MODULE

address internal immutable FEE_FOLLOW_MODULE;

PROFILE_FOLLOW_MODULE

address internal immutable PROFILE_FOLLOW_MODULE;