Quick Start

Get up and running with ERC-7866 in minutes.

Deploy SoulProfile

import { SoulProfile } from "../contracts/core/SoulProfile.sol";

// Deploy contract
SoulProfile profile = new SoulProfile();

Create a Profile

// Create profile with username and avatar
profile.createProfile(
    "alice",
    "ipfs://QmXxxxx..." // Avatar metadata URI
);

Set Avatars

Default Avatar

// Set default avatar used across all dApps
profile.setDefaultAvatar("ipfs://QmYyyyy...");

dApp-Specific Avatar

// Set public avatar (everyone can see)
profile.setDappAvatar(
    "MyGameDApp",
    "ipfs://game-avatar-metadata...",
    true  // isPublic
);

// Set private avatar (only you can see)
profile.setDappAvatar(
    "PrivateDApp",
    "ipfs://private-metadata...",
    false  // isPublic
);

Retrieve Profiles

Get Full Profile

SoulProfile.Profile memory profile = soulProfile.getProfile(userAddress);
// Returns: { username, defaultAvatarURI, bio, website }

Look Up by Username

address alice = soulProfile.getProfileByUsername("alice");

Get dApp Avatar

SoulProfile.DappAvatar memory gameAvatar = soulProfile.getDappAvatar(
    userAddress,
    "MyGameDApp"
);
// Privacy enforced: returns empty URI if private and caller isn't owner

Check if Profile Exists

bool exists = soulProfile.hasProfile(userAddress);

Next Steps