Docs Home

This details the content of the profile contract. View Deployed Contracts for the address.

Profiles can be directly modified with a block explorer that supports contract interactions.

updateAll

This is the main function in the contract. It can be used to update all or only some parts of the profile.

Parameters
User The address of the user who’s profile is to be updated
Bio New bio to be set.
Website New website to be set.
IPFSHash IPFS hash of an image to be used as the profile picture, if an NFT isn’t used. Mints an Avatar NFT with the image.
Signature An optional parameter for a relay to use if the transaction was signed with EIP-712. This lets the interaction be free for the user, since the relay address pays the gas fee.

Other contract functions

Function Description
updateAllCheap Same as the updateAll function, but with no on-chain storage. An event is emitted with the new information.
setBio New bio to be set. Sets in storage and emits an event.
setBioCheap Same as setBio, but with no on-chain storage.
setWebsite New website to be set. Sets in storage and emits an event.
setWebsiteCheap Same as setWebsite, but with no on-chain storage.
connectAvatarNFT Sets an NFT with chainId, contractAddress, and tokenId. The user is not verified as the owner of the NFT on-chain. The frontend verifies that instead. Sets in storage and emits an event.
connectAvatarNFTCheap Same as connectAvatarNFT, but with no on-chain storage.
verify Sets a link to a tweet (or other platform) holding the address of the user. This external account can be used as verification. Sets in storage and emits an event.
verifyCheap Same as verify, but with no on-chain storage.
setUseVerifiedSourceUsername Sets a boolean value which says whether or not to use the username that the user has on the externally verified platform. Sets in storage and emits an event.
setUseVerifiedSourceUsernameCheap Same as setUseVerifiedSourceUsername, but with no on-chain storage.
verifyAndSetSourceUsername Combines verify and setUseVerifiedSourceUsername into one function to save gas.
verifyAndSetSourceUsernameCheap Same as verifyAndSetSourceUsername, but with no on-chain storage.