View Functions

isFollowModuleWhitelisted()

function isFollowModuleWhitelisted(address followModule) external view returns (bool);

Returns

This function returns whether a follow module is whitelisted.

It should...

1. Return true if a follow module is whitelisted, false otherwise.

isReferenceModuleWhitelisted()

function isReferenceModuleWhitelisted(address referenceModule) external view returns (bool);

Returns

This function returns whether a reference module is whitelisted.

It should...

1. Return true if a reference module is whitelisted, false otherwise.

isCollectModuleWhitelisted()

function isCollectModuleWhitelisted(address collectModule) external view returns (bool);

Returns

This function returns whether a collect module is whitelisted.

It should...

1. Return true if a collect module is whitelisted, false otherwise.

getGovernance()

function getGovernance() external view returns (address);

Returns

This function returns the current governance address.

It should...

1. Return the current governance address.

getDispatcher()

function getDispatcher(uint256 profileId) external view returns (address);

Returns

This function returns the dispatcher for the given profile if any.

It should...

1. Return the dispatcher address set for a given profile if it exists (which can be the zero address).
2. Return the zero address if the profile does not exist

getPubCount()

function getPubCount(uint256 profileId) external view returns (uint256);

Returns

This function returns the publication count for the given profile.

It should...

1. Return the publication count for the given profile if the profile exists (which can be zero).
2. Return zero if the profile does not exist.

getFollowNFT()

function getFollowNFT(uint256 profileId) external view returns (address);

Returns

This function returns the follow NFT for the given profile, if any.

It should...

1. Return the follow NFT for the given profile if the profile exists (which can be the zero address).
2. Return the zero address if the profile does not exist.

getCollectNFT()

function getCollectNFT(uint256 profileId, uint256 pubId) external view returns (address);

Returns

This function returns the collect NFT for the given publication, if any.

It should...

1. Return the collect NFT for the given publication if the publication exists (which can be the zero address).
2. Return the zero address if the publication does not exist.

getFollowNFTURI()

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

Returns

This function returns the follow NFT URI for the given profile.

It should...

1. Return the follow NFT URI for the given profile (which can be an empty string).

getFollowModule()

function getFollowModule(uint256 profileId) external view returns (address);

Returns

This function returns the follow module for the given profile, if any.

It should...

1. Return the follow module for the given profile if the profile exists (which can be the zero address).
2. Return the zero address if the profile does not exist.

getCollectModule()

function getCollectModule(uint256 profileId, uint256 pubId) external view returns (address);

Returns

This function returns the collect module for the given publication. Note that a publication should not have the zero address as a collect module.

It should...

1. Return the collect module for the given publication if the publication exists.
2. Return the zero address if the publication does not exist.

getReferenceModule()

function getReferenceModule(uint256 profileId, uint256 pubId) external view returns (address);

Returns

This function returns the reference module for the given publication, if any.

It should...

1. Return the reference module for the given publication if the publication exists (which can be the zero address).
2. Return the zero address if the publication does not exist.

getHandle()

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

Returns

This function returns the handle for the given profile.

It should...

1. Return the handle for the given profile if the profile exists.
2. Return an empty string if the profile does not exist.

getPubPointer()

function getPubPointer(uint256 profileId, uint256 pubId) external view returns (uint256, uint256);

Returns

This function returns the publication pointer mapped to the given publication, if any. Pointers only exist for mirrors and comments; they indicate the publication being "mirrored" or "commented" on and should never be non-zero for posts.

It should...

1. Return the profile and publication IDs pointed by the given publication if the publication exists (which can both be zero, but neither should ever be zero if the other is zero)
2. Return both values as zero if the publication does not exist

getContentURI()

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

Returns

This function returns the content URI mapped to the given publication, if any. Note that content URIs only exist for posts and comments and should always be empty for mirrors.

It should...

1. Return the content URI mapped to the given publication if the publication exists (which can be an empty string)
2. Return the content URI mapped to the pointed publication if the given publication is a mirror.
3. Return an empty string if the publication does not exist

getProfileIdByHandle()

function getProfileIdByHandle(string calldata handle) external view returns (uint256);

Returns

This function returns the profile ID of the profile mapped to a given handle, if any.

It should...

1. Return the profile ID of the profile mapped to the given handle.
2. Return zero if there is no profile with this handle.

getProfile()

function getProfile(uint256 profileId) external view returns (DataTypes.ProfileStruct memory);

Returns

This function returns the profile struct of the profile mapped to a given token ID.

It should...

1. Return the profile struct for a given profile if the profile exists.
2. Return an empty struct if the profile doesn't exist.

getPub()

function getPub(uint256 profileId, uint256 pubId) external view returns (DataTypes.PublicationStruct memory);

Returns

This function returns the publication struct for a given profile ID and publication ID.

It should...

1. Return the publication struct if the publication exists.
2. Return an empty struct if the publication does not exist.

getPubType()

function getPubType(uint256 profileId, uint256 pubId) external view returns (DataTypes.PubType);

Returns

This function returns the publication type for a given profile ID and publication ID.

It should...

1. Return one of the PubType enum members: Post, Comment or Mirror if the publication exists.
2. Return the PubType enum member Nonexistant if the publication does not exist.