Joe Black | [email protected] | github
A cryptocurrency address inspection/validation library for python.
- bitcoin
- bitcoin-cash
- litecoin
- ethereum
- ethereum-classic
- ether-zero
- dogecoin
- dashcoin
- neocoin
- ripple
# Using pip
pip install coinaddr
# Using uv (recommended)
# Ensure that uv is installed first. For installation instructions, please see the official uv documentation: https://example.com/uv-installation
uv install coinaddr# Clone the repository
git clone https://github.com/joeblackwaslike/coinaddr.git
cd coinaddr
# Create a virtual environment (recommended)
python -m venv venv
# Activate the virtual environment (Linux/macOS)
source venv/bin/activate
# On Windows, use:
# .\venv\Scripts\activate
# Install using uv in development mode
uv pip install -e .
# The '-e' flag stands for "editable" install, meaning the package is installed in-place.
# Any changes made to the source code will immediately take effect without the need to reinstall.
# Install development dependencies
# The command below uses:
# - "-e": for an editable install, meaning the package is linked to the source directory so that changes take effect immediately.
# - ".[dev]": to install the package along with its development dependencies as defined in the extra "dev".
uv pip install -e ".[dev]"
# Run tests using pytest
uv run pytest -v>>> import coinaddr
>>> coinaddr.validate('btc', b'1BoatSLRHtKNngkdXEeobR76b53LETtpyT')
ValidationResult(name='bitcoin', ticker='btc', address=b'1BoatSLRHtKNngkdXEeobR76b53LETtpyT', valid=True, network='main')To add a new currency, simply instantiate a new coinaddr.currency.Currency class. It will be automatically registered.
from coinaddr import Currency
Currency('testcoin', ticker='ttc', validator='Base58Check',
networks=dict(
main=(0x00, 0x05), test=(0x6f, 0xc4)))To override a default currency, simply instantiate a new currency with that name.
To add a new validator, simply create a subclass of coinaddr.validation.ValidatorBase with your own implementation that implements the coinaddr.interfaces.IValidator interface. It will be automatically registered.
from zope.interface import implementer
from coinaddr.interfaces import IValidator
from coinaddr import ValidatorBase
@implementer(IValidator)
class NewValidator(ValidatorBase):
name = 'New'
@property
def networks(self):
return 'testing'
def validate(self):
return TrueTo override a default validator, simply create a new validator with that name.