Web3Entry

Git Source

Inherits: IWeb3Entry, Multicall, NFTBase, Web3EntryStorage, Initializable, Web3EntryExtendStorage

State Variables

REVISION

uint256 internal constant REVISION = 4;

Functions

validateCallerPermission

modifier validateCallerPermission(uint256 characterId, uint256 permissionId);

onlyExistingToken

modifier onlyExistingToken(uint256 tokenId);

initialize

Initializes the Web3Entry.

function initialize(
    string calldata name_,
    string calldata symbol_,
    address linklist_,
    address mintNFTImpl_,
    address periphery_,
    address newbieVilla_
) external override reinitializer(3);

Parameters

grantOperatorPermissions

Grant an address as an operator and authorize it with custom permissions.

Every bit in permissionBitMap stands for a corresponding method in Web3Entry. more details in OP.sol.

function grantOperatorPermissions(uint256 characterId, address operator, uint256 permissionBitMap)
    external
    override
    validateCallerPermission(characterId, OP.GRANT_OPERATOR_PERMISSIONS);

Parameters

grantOperatorPermissionsWithSig

Grant an address as an operator and authorize it with custom permissions via signature.

Only character owner can call.

function grantOperatorPermissionsWithSig(
    uint256 characterId,
    address operator,
    uint256 permissionBitMap,
    DataTypes.EIP712Signature calldata signature
) external override;

Parameters

grantOperators4Note

Grant operators allowlist and blocklist roles of a note.

function grantOperators4Note(
    uint256 characterId,
    uint256 noteId,
    address[] calldata blocklist,
    address[] calldata allowlist
) external override validateCallerPermission(characterId, OP.GRANT_OPERATORS_FOR_NOTE);

Parameters

createCharacter

This method creates a character with the given parameters to the given address.

function createCharacter(DataTypes.CreateCharacterData calldata vars) external override returns (uint256 characterId);

Parameters

setHandle

Sets new handle for a given character.

Owner permission only.

function setHandle(uint256 characterId, string calldata newHandle)
    external
    override
    validateCallerPermission(characterId, OP.SET_HANDLE);

Parameters

setSocialToken

Sets a social token for a given character.

Owner permission only.

function setSocialToken(uint256 characterId, address tokenAddress)
    external
    override
    validateCallerPermission(characterId, OP.SET_SOCIAL_TOKEN);

Parameters

setPrimaryCharacterId

Sets a given character as primary.

Only character owner can call this function.

function setPrimaryCharacterId(uint256 characterId) external override;

Parameters

setCharacterUri

Sets a new URI for a given character.

function setCharacterUri(uint256 characterId, string calldata newUri)
    external
    override
    validateCallerPermission(characterId, OP.SET_CHARACTER_URI);

Parameters

setLinklistUri

Sets a new metadataURI for a given link list.

function setLinklistUri(uint256 linklistId, string calldata uri) external override;

Parameters

setLinklistType

Sets a link type for a given linklist.

Emits a {DetachLinklist} event and a {AttachLinklist} event from web3Entry contract..
Emits a {LinkTypeSet} event from linklist contract.
Linklist is the group of all linking objects with the same link type, like "like".
Each character can only have one linklist for each link type.
It will fail if you try to set a link type which is already set for some linklist owned by the same character.

function setLinklistType(uint256 linklistId, bytes32 linkType) external override;

Parameters

linkCharacter

Links a character with the given parameters.

function linkCharacter(DataTypes.linkCharacterData calldata vars)
    external
    override
    onlyExistingToken(vars.toCharacterId)
    validateCallerPermission(vars.fromCharacterId, OP.LINK_CHARACTER);

Parameters

unlinkCharacter

Unlinks a character with the given parameters.

function unlinkCharacter(DataTypes.unlinkCharacterData calldata vars)
    external
    override
    validateCallerPermission(vars.fromCharacterId, OP.UNLINK_CHARACTER);

Parameters

createThenLinkCharacter

Create a character and then link it.

function createThenLinkCharacter(DataTypes.createThenLinkCharacterData calldata vars)
    external
    override
    validateCallerPermission(vars.fromCharacterId, OP.CREATE_THEN_LINK_CHARACTER)
    returns (uint256 characterId);

Parameters

linkNote

Links a note with the given parameters.

function linkNote(DataTypes.linkNoteData calldata vars)
    external
    override
    validateCallerPermission(vars.fromCharacterId, OP.LINK_NOTE);

Parameters

unlinkNote

UnLinks a note with the given parameters.

function unlinkNote(DataTypes.unlinkNoteData calldata vars)
    external
    override
    validateCallerPermission(vars.fromCharacterId, OP.UNLINK_NOTE);

Parameters

linkERC721

Links an ERC721 with the given parameters.

function linkERC721(DataTypes.linkERC721Data calldata vars)
    external
    override
    validateCallerPermission(vars.fromCharacterId, OP.LINK_ERC721);

Parameters

unlinkERC721

Unlinks an ERC721 with the given parameters.

function unlinkERC721(DataTypes.unlinkERC721Data calldata vars)
    external
    override
    validateCallerPermission(vars.fromCharacterId, OP.UNLINK_ERC721);

Parameters

linkAddress

Links an address with the given parameters.

function linkAddress(DataTypes.linkAddressData calldata vars)
    external
    override
    validateCallerPermission(vars.fromCharacterId, OP.LINK_ADDRESS);

Parameters

unlinkAddress

Unlinks an address with the given parameters.

function unlinkAddress(DataTypes.unlinkAddressData calldata vars)
    external
    override
    validateCallerPermission(vars.fromCharacterId, OP.UNLINK_ADDRESS);

Parameters

linkAnyUri

Links any uri with the given parameters.

function linkAnyUri(DataTypes.linkAnyUriData calldata vars)
    external
    override
    validateCallerPermission(vars.fromCharacterId, OP.LINK_ANYURI);

Parameters

unlinkAnyUri

Unlinks any uri with the given parameters.

function unlinkAnyUri(DataTypes.unlinkAnyUriData calldata vars)
    external
    override
    validateCallerPermission(vars.fromCharacterId, OP.UNLINK_ANYURI);

Parameters

linkLinklist

Links a linklist with the given parameters.

function linkLinklist(DataTypes.linkLinklistData calldata vars)
    external
    override
    validateCallerPermission(vars.fromCharacterId, OP.LINK_LINKLIST);

Parameters

unlinkLinklist

Unlinks a linklist with the given parameters.

function unlinkLinklist(DataTypes.unlinkLinklistData calldata vars)
    external
    override
    validateCallerPermission(vars.fromCharacterId, OP.UNLINK_LINKLIST);

Parameters

setLinkModule4Character

Sets a link module for a given character.

function setLinkModule4Character(DataTypes.setLinkModule4CharacterData calldata vars)
    external
    override
    validateCallerPermission(vars.characterId, OP.SET_LINK_MODULE_FOR_CHARACTER);

Parameters

setLinkModule4Note

Sets a link module for a given note.

function setLinkModule4Note(DataTypes.setLinkModule4NoteData calldata vars)
    external
    override
    validateCallerPermission(vars.characterId, OP.SET_LINK_MODULE_FOR_NOTE);

Parameters

mintNote

Mints an nft with the given note.

function mintNote(DataTypes.MintNoteData calldata vars) external override returns (uint256 tokenId);

Parameters

setMintModule4Note

Sets a mint module for the given note.

function setMintModule4Note(DataTypes.setMintModule4NoteData calldata vars)
    external
    override
    validateCallerPermission(vars.characterId, OP.SET_MINT_MODULE_FOR_NOTE);

Parameters

postNote

Posts a note with the given parameters.

function postNote(DataTypes.PostNoteData calldata vars)
    external
    override
    validateCallerPermission(vars.characterId, OP.POST_NOTE)
    returns (uint256 noteId);

Parameters

setNoteUri

Set URI for a note.

function setNoteUri(uint256 characterId, uint256 noteId, string calldata newUri) external override;

Parameters

lockNote

Lock a note and put it into a immutable state where no modifications are allowed. Locked notes are usually assumed as final versions.

function lockNote(uint256 characterId, uint256 noteId)
    external
    override
    validateCallerPermission(characterId, OP.LOCK_NOTE);

Parameters

deleteNote

Delete a note.

Deleting a note doesn't essentially mean that the txs or contents are being removed due to the immutability of blockchain itself, but the deleted notes will be tagged as deleted after calling deleteNote.

function deleteNote(uint256 characterId, uint256 noteId)
    external
    override
    validateCallerPermission(characterId, OP.DELETE_NOTE);

Parameters

postNote4Character

Posts a note for a given character.

function postNote4Character(DataTypes.PostNoteData calldata vars, uint256 toCharacterId)
    external
    override
    validateCallerPermission(vars.characterId, OP.POST_NOTE_FOR_CHARACTER)
    returns (uint256 noteId);

Parameters

Returns

postNote4Address

Posts a note for a given address.

function postNote4Address(DataTypes.PostNoteData calldata vars, address ethAddress)
    external
    override
    validateCallerPermission(vars.characterId, OP.POST_NOTE_FOR_ADDRESS)
    returns (uint256 noteId);

Parameters

Returns

postNote4Linklist

Posts a note for a given linklist.

function postNote4Linklist(DataTypes.PostNoteData calldata vars, uint256 toLinklistId)
    external
    override
    validateCallerPermission(vars.characterId, OP.POST_NOTE_FOR_LINKLIST)
    returns (uint256 noteId);

Parameters

Returns

postNote4Note

Posts a note for a given note.

function postNote4Note(DataTypes.PostNoteData calldata vars, DataTypes.NoteStruct calldata note)
    external
    override
    validateCallerPermission(vars.characterId, OP.POST_NOTE_FOR_NOTE)
    returns (uint256 noteId);

Parameters

Returns

postNote4ERC721

Posts a note for a given ERC721.

function postNote4ERC721(DataTypes.PostNoteData calldata vars, DataTypes.ERC721Struct calldata erc721)
    external
    override
    validateCallerPermission(vars.characterId, OP.POST_NOTE_FOR_ERC721)
    returns (uint256 noteId);

Parameters

Returns

postNote4AnyUri

Posts a note for a given uri.

function postNote4AnyUri(DataTypes.PostNoteData calldata vars, string calldata uri)
    external
    override
    validateCallerPermission(vars.characterId, OP.POST_NOTE_FOR_ANYURI)
    returns (uint256 noteId);

Parameters

Returns

burnLinklist

Burns a linklist NFT.

It will burn the linklist NFT and remove the links from a character.

function burnLinklist(uint256 linklistId) external override;

Parameters

getOperators

Get operator list of a character. This operator list has only a sole purpose, which is keeping records of keys of operatorsPermissionBitMap. Thus, addresses queried by this function not always have operator permissions. Keep in mind don't use this function to check authorizations!!!

function getOperators(uint256 characterId) external view override returns (address[] memory);

Parameters

Returns

getOperatorPermissions

Get permission bitmap of an operator.

function getOperatorPermissions(uint256 characterId, address operator) external view override returns (uint256);

Parameters

Returns

getOperators4Note

Get operators blocklist and allowlist for a note.

function getOperators4Note(uint256 characterId, uint256 noteId)
    external
    view
    override
    returns (address[] memory blocklist, address[] memory allowlist);

Parameters

isOperatorAllowedForNote

Query if a operator has permission for a note.

function isOperatorAllowedForNote(uint256 characterId, uint256 noteId, address operator)
    external
    view
    override
    returns (bool);

Parameters

Returns

getPrimaryCharacterId

Returns primary character for a given account.

function getPrimaryCharacterId(address account) external view override returns (uint256);

Parameters

Returns

isPrimaryCharacter

Returns whether or not a character is primary character.

function isPrimaryCharacter(uint256 characterId) external view override returns (bool);

Parameters

Returns

getCharacter

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

function getCharacter(uint256 characterId)
    external
    view
    override
    onlyExistingToken(characterId)
    returns (DataTypes.Character memory);

Parameters

Returns

getCharacterByHandle

Returns the full character struct associated with a given character handle.

function getCharacterByHandle(string calldata handle) external view override returns (DataTypes.Character memory);

Parameters

Returns

getHandle

Returns the handle of character with a given character.

function getHandle(uint256 characterId) external view override onlyExistingToken(characterId) returns (string memory);

Parameters

Returns

getCharacterUri

Returns the uri of character with a given character.

function getCharacterUri(uint256 characterId) external view override returns (string memory);

Parameters

Returns

getNote

Returns the full note struct associated with a given note.

function getNote(uint256 characterId, uint256 noteId) external view override returns (DataTypes.Note memory);

Parameters

Returns

getLinklistUri

Returns the uri of linklist with a given linklist.

function getLinklistUri(uint256 tokenId) external view override returns (string memory);

Parameters

Returns

getLinklistId

Returns the token ID of linklist with a given character and linkType.

function getLinklistId(uint256 characterId, bytes32 linkType) external view override returns (uint256);

Parameters

Returns

getLinklistType

Returns the linkType of linklist with a given linklist.

function getLinklistType(uint256 linkListId) external view override returns (bytes32);

Parameters

Returns

getLinklistContract

Returns the address of linklist contract.

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

Returns

getDomainSeparator

Returns the domain separator for this NFT contract.

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

Returns

nonces

Returns the current nonce for owner. This value must be included whenever a signature is generated by grantOperatorPermissionsWithSig. Every successful call to grantOperatorPermissionsWithSig increases owner's nonce by one. This prevents a signature from being used multiple times.

function nonces(address owner) external view override returns (uint256);

Parameters

Returns

getRevision

Returns the revision number of web3Entry contract.

function getRevision() external pure override returns (uint256);

Returns

burn

Burns a web3Entry character nft.

function burn(uint256 tokenId) public virtual override;

Parameters

tokenURI

Returns the associated URI with a given character.

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

Parameters

Returns

_createCharacter

function _createCharacter(DataTypes.CreateCharacterData memory vars, bool validateHandle)
    internal
    returns (uint256 characterId);

_beforeTokenTransfer

Operators will be reset to blank before the characters are transferred in order to grant the whole control power to receivers of character transfers. If character is transferred from newbieVilla contract, don't clear operators. Permissions4Note is left unset, because permissions for notes are always stricter than default.

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

_afterTokenTransfer

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

_nextNoteId

function _nextNoteId(uint256 characterId) internal returns (uint256);

_isOperatorAllowedForNote

It will first check note permission, and then check operators permission.

function _isOperatorAllowedForNote(uint256 characterId, uint256 noteId, address operator)
    internal
    view
    returns (bool);

_validateCallerPermission

function _validateCallerPermission(uint256 characterId, uint256 permissionId) internal view;

_callerIsCharacterOwner

function _callerIsCharacterOwner(address caller, uint256 characterId) internal view returns (bool);

_validateCallerPermission4Note

function _validateCallerPermission4Note(uint256 characterId, uint256 noteId) internal view;

_checkBit

_checkBit checks if the value of the i'th bit of x is 1

function _checkBit(uint256 x, uint256 i) internal pure returns (bool);

_addressToHexString

_addressToHexString converts an address to its ASCII `string hexadecimal representation.

function _addressToHexString(address addr) internal pure returns (string memory);

_handleHash

function _handleHash(string memory handle) internal pure returns (bytes32);