IWeb3Entry

Git Source

Functions

initialize

Initializes the Web3Entry.

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

Parameters

createCharacter

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

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

Parameters

setHandle

Sets new handle for a given character.

Owner permission only.

function setHandle(uint256 characterId, string calldata newHandle) external;

Parameters

setSocialToken

Sets a social token for a given character.

Owner permission only.

function setSocialToken(uint256 characterId, address tokenAddress) external;

Parameters

setCharacterUri

Sets a new URI for a given character.

function setCharacterUri(uint256 characterId, string calldata newUri) external;

Parameters

setPrimaryCharacterId

Sets a given character as primary.

Only character owner can call this function.

function setPrimaryCharacterId(uint256 characterId) external;

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;

Parameters

grantOperatorPermissionsWithSig

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

Only character owner can call.

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

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

Parameters

grantOperators4Note

Grant operators allowlist and blocklist roles of a note.

function grantOperators4Note(
    uint256 characterId,
    uint256 noteId,
    address[] calldata blocklist,
    address[] calldata allowlist
) external;

Parameters

setLinklistUri

Sets a new metadataURI for a given link list.

function setLinklistUri(uint256 linkListId, string calldata uri) external;

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;

Parameters

linkAddress

Links an address with the given parameters.

function linkAddress(DataTypes.linkAddressData calldata vars) external;

Parameters

unlinkAddress

Unlinks an address with the given parameters.

function unlinkAddress(DataTypes.unlinkAddressData calldata vars) external;

Parameters

linkCharacter

Links a character with the given parameters.

function linkCharacter(DataTypes.linkCharacterData calldata vars) external;

Parameters

unlinkCharacter

Unlinks a character with the given parameters.

function unlinkCharacter(DataTypes.unlinkCharacterData calldata vars) external;

Parameters

createThenLinkCharacter

Create a character and then link it.

function createThenLinkCharacter(DataTypes.createThenLinkCharacterData calldata vars)
    external
    returns (uint256 characterId);

Parameters

linkNote

Links a note with the given parameters.

function linkNote(DataTypes.linkNoteData calldata vars) external;

Parameters

unlinkNote

UnLinks a note with the given parameters.

function unlinkNote(DataTypes.unlinkNoteData calldata vars) external;

Parameters

linkERC721

Links an ERC721 with the given parameters.

function linkERC721(DataTypes.linkERC721Data calldata vars) external;

Parameters

unlinkERC721

Unlinks an ERC721 with the given parameters.

function unlinkERC721(DataTypes.unlinkERC721Data calldata vars) external;

Parameters

linkAnyUri

Links any uri with the given parameters.

function linkAnyUri(DataTypes.linkAnyUriData calldata vars) external;

Parameters

unlinkAnyUri

Unlinks any uri with the given parameters.

function unlinkAnyUri(DataTypes.unlinkAnyUriData calldata vars) external;

Parameters

linkLinklist

Links a linklist with the given parameters.

function linkLinklist(DataTypes.linkLinklistData calldata vars) external;

Parameters

unlinkLinklist

Unlinks a linklist with the given parameters.

function unlinkLinklist(DataTypes.unlinkLinklistData calldata vars) external;

Parameters

setLinkModule4Character

Sets a link module for a given character.

function setLinkModule4Character(DataTypes.setLinkModule4CharacterData calldata vars) external;

Parameters

setLinkModule4Note

Sets a link module for a given note.

function setLinkModule4Note(DataTypes.setLinkModule4NoteData calldata vars) external;

Parameters

mintNote

Mints an nft with the given note.

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

Parameters

setMintModule4Note

Sets a mint module for the given note.

function setMintModule4Note(DataTypes.setMintModule4NoteData calldata vars) external;

Parameters

postNote

Posts a note with the given parameters.

function postNote(DataTypes.PostNoteData calldata vars) external returns (uint256 noteId);

Parameters

setNoteUri

Set URI for a note.

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

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;

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;

Parameters

postNote4Character

Posts a note for a given character.

function postNote4Character(DataTypes.PostNoteData calldata vars, uint256 toCharacterId)
    external
    returns (uint256 noteId);

Parameters

Returns

postNote4Address

Posts a note for a given address.

function postNote4Address(DataTypes.PostNoteData calldata vars, address ethAddress) external returns (uint256 noteId);

Parameters

Returns

postNote4Linklist

Posts a note for a given linklist.

function postNote4Linklist(DataTypes.PostNoteData calldata vars, uint256 toLinklistId)
    external
    returns (uint256 noteId);

Parameters

Returns

postNote4Note

Posts a note for a given note.

function postNote4Note(DataTypes.PostNoteData calldata vars, DataTypes.NoteStruct calldata note)
    external
    returns (uint256 noteId);

Parameters

Returns

postNote4ERC721

Posts a note for a given ERC721.

function postNote4ERC721(DataTypes.PostNoteData calldata vars, DataTypes.ERC721Struct calldata erc721)
    external
    returns (uint256 noteId);

Parameters

Returns

postNote4AnyUri

Posts a note for a given uri.

function postNote4AnyUri(DataTypes.PostNoteData calldata vars, string calldata uri) external 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;

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 returns (address[] memory);

Parameters

Returns

getOperatorPermissions

Get permission bitmap of an operator.

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

Parameters

Returns

getOperators4Note

Get operators blocklist and allowlist for a note.

function getOperators4Note(uint256 characterId, uint256 noteId)
    external
    view
    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 returns (bool);

Parameters

Returns

getPrimaryCharacterId

Returns primary character for a given account.

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

Parameters

Returns

isPrimaryCharacter

Returns whether or not a character is primary character.

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

Parameters

Returns

getCharacter

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

function getCharacter(uint256 characterId) external view 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 returns (DataTypes.Character memory);

Parameters

Returns

getHandle

Returns the handle of character with a given character.

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

Parameters

Returns

getCharacterUri

Returns the uri of character with a given character.

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

Parameters

Returns

getNote

Returns the full note struct associated with a given note.

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

Parameters

Returns

getLinklistUri

Returns the uri of linklist with a given linklist.

function getLinklistUri(uint256 tokenId) external view 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 returns (uint256);

Parameters

Returns

getLinklistType

Returns the linkType of linklist with a given linklist.

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

Parameters

Returns

getLinklistContract

Returns the address of linklist contract.

function getLinklistContract() external view returns (address);

Returns

getDomainSeparator

Returns the domain separator for this NFT contract.

function getDomainSeparator() external view 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 returns (uint256);

Parameters

Returns

getRevision

Returns the revision number of web3Entry contract.

function getRevision() external pure returns (uint256);

Returns