Address - Ethereum Address Type

The Address type represents a 20-byte Ethereum address, used for identifying accounts, contracts, and other entities on the Ethereum blockchain. It's a fundamental type for smart contract interaction and access control in AssemblyScript Stylus.

Import

import { Address, AddressFactory } from "@wakeuplabs/as-stylus";

Overview

Address provides:

20-byte (160-bit) Ethereum address representation
Basic comparison and validation operations
String conversion for display
Clone functionality for copying addresses
Contract code detection

Available Operations

Based on the interface, Address supports these operations:

Core Operations

clone(): Address - Create a copy of the address
toString(): string - Convert to string representation
isZero(): boolean - Check if address is zero (null address)
equals(other: Address): boolean - Compare with another address
hasCode(): boolean - Check if address contains contract code

Factory Methods

AddressFactory.create(): Address - Create new Address instance (zero address)
AddressFactory.fromString(hex: string): Address - Create from hex string

Creation and Basic Usage

Creating Address Values

import { Address, AddressFactory } from "@wakeuplabs/as-stylus";

// Create zero address
const zeroAddr = AddressFactory.create();

// Create from hex string
const userAddress = AddressFactory.fromString("0x742d35Cc6634C0532925a3b8D93BEFD738C1234A");
const contractAddr = AddressFactory.fromString("0xA0b86a33E6417c2C1d9B77B1F77E2a3c71234567");

Basic Operations

// Address validation
function isValidAddress(addr: Address): boolean {
  return !addr.isZero();
}

// Address comparison
const owner = AddressFactory.fromString("0x742d35Cc6634C0532925a3b8D93BEFD738C1234A");
const caller = msg.sender;

const isOwner = caller.equals(owner);
const isNotZero = !caller.isZero();

// Convert to string representation
const addressString = owner.toString(); // "0x742d35cc6634c0532925a3b8d93befd738c1234a"

// Clone address
const ownerCopy = owner.clone();

// Check if address is a contract
const isContract = contractAddr.hasCode();

Validation Patterns

Address Validation

function validateAddressInput(addr: Address): void {
  if (addr.isZero()) {
    InvalidAddress.revert(addr);
  }
}

function requireContract(addr: Address): void {
  validateAddressInput(addr);

  if (!addr.hasCode()) {
    // Create custom error for EOA when contract expected
    InvalidAddress.revert(addr);
  }
}

function requireEOA(addr: Address): void {
  validateAddressInput(addr);

  if (addr.hasCode()) {
    // Create custom error for contract when EOA expected
    InvalidAddress.revert(addr);
  }
}

Batch Address Operations

function validateAddressArray(addresses: Address[]): void {
  if (addresses.length == 0) {
    return; // Empty array is valid
  }

  for (let i = 0; i < addresses.length; i++) {
    validateAddressInput(addresses[i]);

    // Check for duplicates
    for (let j = i + 1; j < addresses.length; j++) {
      if (addresses[i].equals(addresses[j])) {
        // Create custom error for duplicates
        InvalidAddress.revert(addresses[i]);
      }
    }
  }
}

function containsAddress(addresses: Address[], target: Address): boolean {
  for (let i = 0; i < addresses.length; i++) {
    if (addresses[i].equals(target)) {
      return true;
    }
  }
  return false;
}

Whitelist/Blacklist

import { Contract, External, View, Address, Mapping, msg } from "@wakeuplabs/as-stylus";

@Contract
export class Whitelist {
  owner: Address;
  whitelist: Mapping<Address, boolean> = new Mapping<Address, boolean>();

  constructor() {
    this.owner = msg.sender;
  }

  @External
  addToWhitelist(addr: Address): void {
    if (!msg.sender.equals(this.owner)) {
      Unauthorized.revert(msg.sender, this.owner);
    }

    if (addr.isZero()) {
      InvalidAddress.revert(addr);
    }

    this.whitelist.set(addr, true);
  }

  @External
  removeFromWhitelist(addr: Address): void {
    if (!msg.sender.equals(this.owner)) {
      Unauthorized.revert(msg.sender, this.owner);
    }

    this.whitelist.set(addr, false);
  }

  @View
  isWhitelisted(addr: Address): boolean {
    return this.whitelist.get(addr);
  }

  @External
  requireWhitelisted(addr: Address): void {
    if (!this.whitelist.get(addr)) {
      Unauthorized.revert(addr, this.owner);
    }
  }
}

Best Practices

Do

Always validate that addresses are not zero before using them
Use equals() to compare addresses
Use clone() to create copies of addresses when needed
Check that caller has permissions before sensitive operations
Emit events for important changes (ownership transfers, etc.)

Avoid

Comparing addresses with == or != operators
Accepting zero addresses without validation
Not checking permissions in administrative functions
Operations without logging events

Import​

Overview​

Available Operations​

Core Operations​

Factory Methods​

Creation and Basic Usage​

Creating Address Values​

Basic Operations​

Validation Patterns​

Address Validation​

Batch Address Operations​

Whitelist/Blacklist​

Best Practices​

Do​

Avoid​

📦 More Data Types