Skip to main content
Use uploadAvatar and uploadHeader to upload or replace the avatar or header image for a subname. These methods require a provider so the SDK can sign the SIWE message for you.

Upload an avatar

Upload a header

uploadHeader accepts the same options. Header uploads have a higher size limit:

UploadOptions

UploadResult

  • url - Stable alias for the public image URL.
  • avatarUrl / headerUrl - Canonical URL returned by the Metadata Service for the respective upload type.
  • isUpdate - true when an existing image was replaced.
  • pending - true when the subname is not yet registered; the image is stored and applied on registration.

File limits

The SDK validates file size and format before uploading and throws FILE_TOO_LARGE or INVALID_FILE_FORMAT when a check fails.