Install the Avatar SDK

Install the package, depending on your package manager:

npm
Yarn
pnpm

npm install @thenamespace/avatar

yarn add @thenamespace/avatar

pnpm add @thenamespace/avatar

Initialize the client with your website domain. The domain is required because it is embedded in the SIWE message the user signs:

import { createAvatarClient } from '@thenamespace/avatar';

const client = createAvatarClient({
  domain: 'myapp.com',
});

To target testnet, set network: 'sepolia':

const client = createAvatarClient({
  domain: 'myapp.com',
  network: 'sepolia',
});

For automatic signing, pass a wallet provider directly:

const client = createAvatarClient({
  domain: 'myapp.com',
  network: 'mainnet',
  provider: walletClient, // Viem WalletClient, Ethers Wallet/Signer, or WalletProvider
});

AvatarSDKConfig

Parameter	Default	Description
`domain`	—	Your website domain. Required for SIWE authentication.
`network`	`mainnet`	`'mainnet'` or `'sepolia'`.
`apiUrl`	Namespace Metadata Service	Advanced override for the API base URL.
`provider`	—	Wallet used for automatic signing. Viem, Ethers, or a `WalletProvider`.

The SDK uses chain ID 1 for mainnet and 11155111 for sepolia when building SIWE messages. Before every automatic operation it compares the provider’s chain ID with the configured network and calls switchChain when available, otherwise it throws PROVIDER_CHAIN_MISMATCH.

Start building

How to guides

Starter kits

Concepts

Reference

AI tooling

Troubleshooting

Install the Avatar SDK

AvatarSDKConfig

​AvatarSDKConfig

AvatarSDKConfig