Metadata-Version: 2.1
Name: python-coinage
Version: 1.0.0
Summary: Cryptocurrency address validation module
Home-page: https://github.com/FranciscoDA/coinage.git
Author: Francisco Altoe
Author-email: franciscoda@outlook.com
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: base58check
Requires-Dist: pysha3

# Coinage
![Travis](https://travis-ci.org/FranciscoDA/coinage.svg?branch=master)

Coinage is a python module for validating cryptocurrency addresses with different formats among different blockchain networks.

# Examples

```py
from coinage import BitcoinBlockchain, FailedValidation, FailedChecksumValidation

btc = BitcoinBlockchain()

try:
	valid = btc.validate('abcdef1qpzry9x8gf2tvdw0s3jn54khce6mua7lmqqqxw')
	if valid.is_from_main_net():
		print('this address looks good')
	else:
		print('this isn\'t a mainnet address')
except FailedChecksumValidation:
	print('you probably made a mistake when copying this address')
except FailedValidation:
	print('this isnt a bitcoin address')
```

Or:

```py
from coinage import BitcoinBlockchain, FailedValidation, FailedChecksumValidation

btc = BitcoinBlockchain()

result, details = btc.is_valid('abcdef1qpzry9x8gf2tvdw0s3jn54khce6mua7lmqqqxw')
if result:
	if details.is_from_main_net():
		print('this address looks good')
	else:
		print('this isn\'t a mainnet address')
else:
	print('this isnt a valid bitcoin address')
```

# Sources
[Bitcoin wiki page about Bech32](https://en.bitcoin.it/wiki/Bech32)

[BIP-0173](https://en.bitcoin.it/wiki/BIP_0173)

[EIP-55](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-55.md)

[CashAddr Spec](https://github.com/bitcoincashorg/bitcoincash.org/blob/master/spec/cashaddr.md)

[Coinaddr Python Module](https://pypi.org/project/coinaddr/)


