# Copyright (c) 2026 Emanuele Bellocchia
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""Module for Algorand address encoding/decoding."""
# Imports
from typing import Any, Union
from typing_extensions import override
from bip_utils.addr.addr_dec_utils import AddrDecUtils
from bip_utils.addr.addr_key_validator import AddrKeyValidator
from bip_utils.addr.iaddr_decoder import IAddrDecoder
from bip_utils.addr.iaddr_encoder import IAddrEncoder
from bip_utils.ecc import Ed25519PublicKey, IPublicKey
from bip_utils.utils.crypto import Sha512_256
from bip_utils.utils.misc import Base32Decoder, Base32Encoder
class AlgoAddrConst:
"""Class container for Algorand address constants."""
# Checksum length in bytes
CHECKSUM_BYTE_LEN: int = 4
class _AlgoAddrUtils:
"""Algorand address utility class."""
@staticmethod
def ComputeChecksum(pub_key_bytes: bytes) -> bytes:
"""
Compute checksum in Algorand format.
Args:
pub_key_bytes (bytes): Public key bytes
Returns:
bytes: Computed checksum
"""
return Sha512_256.QuickDigest(pub_key_bytes)[-1 * AlgoAddrConst.CHECKSUM_BYTE_LEN:]
class AlgoAddrDecoder(IAddrDecoder):
"""
Algorand address decoder class.
It allows the Algorand address decoding.
"""
@override
@staticmethod
def DecodeAddr(addr: str,
**kwargs: Any) -> bytes:
"""
Decode an Algorand address to bytes.
Args:
addr (str): Address string
**kwargs : Not used
Returns:
bytes: Public key bytes
Raises:
ValueError: If the address encoding is not valid
"""
# Decode from base32
addr_dec_bytes = Base32Decoder.Decode(addr)
# Validate length
AddrDecUtils.ValidateLength(addr_dec_bytes,
Ed25519PublicKey.CompressedLength() + AlgoAddrConst.CHECKSUM_BYTE_LEN - 1)
# Get back checksum and public key bytes
pub_key_bytes, checksum_bytes = AddrDecUtils.SplitPartsByChecksum(addr_dec_bytes,
AlgoAddrConst.CHECKSUM_BYTE_LEN)
# Validate checksum
AddrDecUtils.ValidateChecksum(pub_key_bytes, checksum_bytes, _AlgoAddrUtils.ComputeChecksum)
# Validate public key
AddrDecUtils.ValidatePubKey(pub_key_bytes, Ed25519PublicKey)
return pub_key_bytes
class AlgoAddrEncoder(IAddrEncoder):
"""
Algorand address encoder class.
It allows the Algorand address encoding.
"""
@override
@staticmethod
def EncodeKey(pub_key: Union[bytes, IPublicKey],
**kwargs: Any) -> str:
"""
Encode a public key to Algorand address.
Args:
pub_key (bytes or IPublicKey): Public key bytes or object
**kwargs : Not used
Returns:
str: Address string
Raises:
ValueError: If the public key is not valid
TypeError: If the public key is not ed25519
"""
pub_key_obj = AddrKeyValidator.ValidateAndGetEd25519Key(pub_key)
pub_key_bytes = pub_key_obj.RawCompressed().ToBytes()[1:]
# Compute checksum
checksum_bytes = _AlgoAddrUtils.ComputeChecksum(pub_key_bytes)
# Encode to base32
return Base32Encoder.EncodeNoPadding(pub_key_bytes + checksum_bytes)
# Deprecated: only for compatibility, Encoder class shall be used instead
AlgoAddr = AlgoAddrEncoder