Skip to main content

Encodes and decodes address formats for various cryptocurrencies

Project description

address-encoder

Encodes and decodes address formats for various cryptocurrencies. Converts addresses between human-readable text and their native binary representations for use with EIP-2304 and ENS multichain resolution.

EVM compatible chains are either specified using SLIP-44 coin type or 0x80000000 | chainId where 0x80000000 is the MSB (most significant bit) reserved at SLIP-44 and no coin types exist in that range. This is to avoid number collision with the existing coin types.

See ENSIP-11 for more detail.

Installation

pip install address-encoder

Available on PyPI.

For local development:

pip install -e ".[dev]"

Usage

from address_encoder import get_coder_by_coin_name

btc = get_coder_by_coin_name("btc")
decoded = btc.decode("1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa")
encoded = btc.encode(decoded)

Hex input

Encoders expect bytes. Convert hex strings with the utility helpers:

from address_encoder import get_coder_by_coin_name
from address_encoder.utils import hex_to_bytes

btc = get_coder_by_coin_name("btc")
address = btc.encode(hex_to_bytes("0x76a91462e907b15cbf27d5425399ebf6f0fb50ebb88f1888ac"))

Direct coin imports

from address_encoder.coins.btc import btc

decoded = btc.decode("1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa")

EVM chains

Many EVM chains are supported, but none of them (except ETH) are exported from address_encoder.coins. To encode or decode addresses for an EVM chain, use the ETH codec via get_coder_by_coin_name:

from address_encoder import get_coder_by_coin_name

op = get_coder_by_coin_name("op")  # Optimism
decoded = op.decode("0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb")

You can also look up a codec by coin type:

from address_encoder import get_coder_by_coin_type

op = get_coder_by_coin_type(2147483658)  # 0x80000000 | 10

Development

pytest

Maintainer scripts

Interactive helpers for adding coins and keeping docs in sync:

python3 scripts/generate_coin.py          # scaffold a new non-EVM coin module and test
python3 scripts/add_evm_coin.py           # add EVM chain entries to coin maps
python3 scripts/format_supported_coins.py # regenerate docs/supported-cryptocurrencies.md
python3 scripts/prepublish_only.py        # run tests and verify the wheel builds

Coin types

When adding a new coin, the coin type is a numeric identifier from SLIP-44. It must be an integer, not a coin name or symbol.

Chain type Coin type Script
Non-EVM (e.g. BTC, SOL) SLIP-44 index (e.g. 0 for Bitcoin, 501 for Solana) scripts/generate_coin.py
EVM (e.g. Optimism, Base) Computed as 0x80000000 | chainId — enter the chain ID only scripts/add_evm_coin.py

If the coin is not listed in SLIP-44, open a PR to add it there first.

Package layout

  • address_encoder — main API (get_coder_by_coin_name, get_coder_by_coin_type)
  • address_encoder.coins — per-coin codecs
  • address_encoder.coders — per-coin encode/decode function exports
  • address_encoder.consts — SLIP-44 and EVM chain mappings
  • address_encoder.utils — shared encoding primitives

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

address_encoder-1.0.1.tar.gz (63.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

address_encoder-1.0.1-py3-none-any.whl (79.1 kB view details)

Uploaded Python 3

File details

Details for the file address_encoder-1.0.1.tar.gz.

File metadata

  • Download URL: address_encoder-1.0.1.tar.gz
  • Upload date:
  • Size: 63.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for address_encoder-1.0.1.tar.gz
Algorithm Hash digest
SHA256 a47c8e0a268f0348e7b11437c0b7084de4679fc155de9ab464ebce544114fe5b
MD5 4348438e708901d70e297517d0f1f619
BLAKE2b-256 ce567ef36a8a718bd93d3b9439542a6a82982fc94ba6bdb712aecd957311181c

See more details on using hashes here.

Provenance

The following attestation bundles were made for address_encoder-1.0.1.tar.gz:

Publisher: publish.yml on ens-integrations/address-encoder-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file address_encoder-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for address_encoder-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 56660d4a207a34150078f63d562dd33f8474ca2ade1fdbe6d1f833e47bb8ac32
MD5 2da678883a17f0e872bf38235c6e59ea
BLAKE2b-256 9fd2293024eb52dd08dc2e0188910124869a35ba6d7444103ee91d8abde3174c

See more details on using hashes here.

Provenance

The following attestation bundles were made for address_encoder-1.0.1-py3-none-any.whl:

Publisher: publish.yml on ens-integrations/address-encoder-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page