Skip to main content

Getting Started

The addresses package provides a robust solution for handling interoperable blockchain addresses across different networks, following the ERC-7930 standard. This guide will help you get started with using the package in your projects.

Basic Usage​

The package provides two main ways to work with addresses:

  1. Using the InteropAddressProvider class
  2. Using individual utility functions

Using InteropAddressProvider​

import { InteropAddressProvider } from "@wonderland/interop";

// Convert a human-readable address to binary format
const humanReadableAddress = "alice.eth@eip155:1#ABCD1234";
const binaryAddress = await InteropAddressProvider.humanReadableToBinary(humanReadableAddress);

// Convert a binary address back to human-readable format
const humanReadable = await InteropAddressProvider.binaryToHumanReadable(binaryAddress);

// Extract chain ID from a binary address
const chainId = await InteropAddressProvider.getChainId(binaryAddress);

// Extract the address component from a binary address
const address = await InteropAddressProvider.getAddress(binaryAddress);

Using Individual Functions​

For better tree-shaking and modularity, you can import individual functions:

import {
    binaryToHumanReadable,
    getAddress,
    getChainId,
    humanReadableToBinary,
} from "@wonderland/interop";

const humanReadableAddress = "alice.eth@eip155:1#ABCD1234";
const binaryAddress = await humanReadableToBinary(humanReadableAddress);

Address Format​

The package supports two main address formats:

  1. Human-Readable Format: {address}@{chainType}:{chainReference}#{checksum} Example: alice.eth@eip155:1#ABCD1234
  2. Binary Format: ERC-7930 compliant representation of the address

The package provides methods for converting a human-readable address to its binary representation and vice versa.

References​