EmojiAddress Client

Client library for working with the emoji address service.

Installation

npm install @yaring/emojiaddress

Configuration

Create a .env file:

EMOJI_ADDRESS_API_URL=https://your-api-url.com/api

Usage

import { EmojiAddressClient } from 'emojiaddress';

// Initialize client
const client = new EmojiAddressClient(process.env.EMOJI_ADDRESS_API_URL!);

// Generate unique address
const { data } = await client.generateUniqueAddress();
console.log('Generated:', data.emojiAddress);

// Activate address
const activated = await client.activateAddress(
    data.emojiAddress,
    '0x1234...',
    { name: 'John Doe' }
);

// Get all user addresses
const userAddresses = await client.getUserAddresses('0x1234...');

API

generateUniqueAddress()

Generates a unique emoji address.

activateAddress(emojiAddress: string[], address: string, metadata: Record<string, string>)

Activates an emoji address with the specified metadata.

checkAvailability(emojiAddress: string[])

Checks if an emoji address is available.

getUserAddresses(address: string)

Retrieves all addresses associated with a user.

updateAddress(emojiAddress: string[], metadata: Record<string, string>, type?: string)

Updates the metadata and type of an existing address.

Development

# Install dependencies
npm install

# Build
npm run build

# Run tests
npm test

# Run tests with coverage
npm run test:coverage

Error Handling

The client includes comprehensive error handling for:

• Network connectivity issues
• Server errors
• Timeout errors
• Invalid responses

Response Types

interface ApiResponse<T> {
    success: boolean;
    data?: T;
    error?: string;
    details?: any;
}

interface EmojiAddress {
    address: string;
    emojiAddress: string[];
    type: 'profile' | 'payment' | 'crypto_check' | 'other';
    isNativeAddress: boolean;
    metadata: Record<string, string>;
    createdAt: string;
    updatedAt: string;
}

License

MIT