👤Profile

Assuming that you've successfully finished Setting up Ceramic, you can now use it to read and write the user's profile.

BasicProfile

While more data can be stored in the user profile using Ceramic, we use the following profile structure in Protico.

interface BasicProfile {
  name?: string;
  description?: string;
  avatar_url?: string;
  public_key?: string;
  isENSVerified?: boolean;
  social_connections?: Contact[];
  id?: string;
}

Parameters description

Parameter	Description	Optional
name	Username	Yes
description	User bio showing in their profile	Yes
avatar_url	User profile picture's url	Yes
public_key	User public key, used for message encryption	Yes
isENSVerified	Whether the username has been verified as an ENS associated with the address	Yes
social_connections	User contacts Do not manipulate this field directly, check Contacts instead.	Yes
id	User Ceramic ID Read only	Yes

Getting a user's profile

const profile: BasicProfile = await ceramicClient.profile.get(address:string);

Parameters description

Parameter	Description	Optional
address	Wallet address associated with the user	No

Updating a user's profile

You can update any part of the user's profile by passing a partial BasicProfile object to the update function:

const profile: BasicProfile = 
    await ceramicClient.profile.update(newProfile : Partial<BasicProfile>);

Resetting a user's profile

This will completely reset the user's profile by replacing it with a default one.

const profile: BasicProfile = await ceramicClient.profile.clear();