address-encoder 1.0.0__tar.gz

address_encoder-1.0.0/.env

@@ -0,0 +1,3 @@
+pypi-AgEIcHlwaS5vcmcCJDRkNjU4ZTdiLTlmYTItNGYyMi05YTY4LWFhYWIyMTFhNjU1YwACKlszLCJiY2ViMzg0MS0wMjRmLTQ3MzAtOTExNS0zZjUyODJjZjBmOGIiXQAABiAQTgin7-P6NYHgqZVRnuD0ImyOAvwebGbhW7g8sJfbeQ
+
+pypi-AgENdGVzdC5weXBpLm9yZwIkOWUzNzA1MWMtZGM1ZS00MGViLWE2ODEtOWMzYmRiMmY2MWU3AAIqWzMsImJlOWRkNjUwLTE0ZTAtNDBmZi1hZmYyLTBhZjY4OTQ3Y2NlNiJdAAAGIFT0vEKURkTraegquuCTD5GfN7u1wn33DI2EF0N4D5gY

address_encoder-1.0.0/.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest -q

address_encoder-1.0.0/.gitignore

@@ -0,0 +1,9 @@
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+dist/
+build/

address_encoder-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ENS Labs Limited
+
+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.

address_encoder-1.0.0/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: address-encoder
+Version: 1.0.0
+Summary: Encodes and decodes address formats for various cryptocurrencies
+Project-URL: Homepage, https://github.com/ensdomains/address-encoder
+Project-URL: Repository, https://github.com/ensdomains/address-encoder
+Author: ENS Domains
+License-Expression: MIT
+License-File: LICENSE
+Keywords: address,cryptocurrency,decoder,encoder,ens
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: base58>=2.1.0
+Requires-Dist: cbor2>=5.6.0
+Requires-Dist: pycryptodome>=3.20.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# 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](https://eips.ethereum.org/EIPS/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](https://docs.ens.domains/ens-improvement-proposals/ensip-11-evmchain-address-resolution#specification) for more detail.
+
+## Installation
+
+Coming soon to PyPI. In the meantime, install from source.
+
+For local development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Usage
+
+```python
+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:
+
+```python
+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
+
+```python
+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`:
+
+```python
+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:
+
+```python
+from address_encoder import get_coder_by_coin_type
+
+op = get_coder_by_coin_type(2147483658)  # 0x80000000 | 10
+```
+
+## Development
+
+```bash
+pytest
+```
+
+### Maintainer scripts
+
+Interactive helpers for adding coins and keeping docs in sync:
+
+```bash
+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](https://github.com/satoshilabs/slips/blob/master/slip-0044.md). 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](https://github.com/satoshilabs/slips/blob/master/slip-0044.md) 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

address_encoder-1.0.0/README.md

@@ -0,0 +1,102 @@
+# 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](https://eips.ethereum.org/EIPS/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](https://docs.ens.domains/ens-improvement-proposals/ensip-11-evmchain-address-resolution#specification) for more detail.
+
+## Installation
+
+Coming soon to PyPI. In the meantime, install from source.
+
+For local development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Usage
+
+```python
+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:
+
+```python
+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
+
+```python
+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`:
+
+```python
+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:
+
+```python
+from address_encoder import get_coder_by_coin_type
+
+op = get_coder_by_coin_type(2147483658)  # 0x80000000 | 10
+```
+
+## Development
+
+```bash
+pytest
+```
+
+### Maintainer scripts
+
+Interactive helpers for adding coins and keeping docs in sync:
+
+```bash
+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](https://github.com/satoshilabs/slips/blob/master/slip-0044.md). 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](https://github.com/satoshilabs/slips/blob/master/slip-0044.md) 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

address_encoder-1.0.0/docs/supported-cryptocurrencies.md

@@ -0,0 +1,171 @@
+## Supported Cryptocurrencies
+
+### EVM Chains
+
+The following EVM chains are supported:
+
+| Chain ID | Name | Full Name | Coin Type |
+| --- | --- | --- | --- |
+| 0 | default | Default | 2147483648 |
+| 10 | op | Optimism | 2147483658 |
+| 25 | cro | Cronos | 2147483673 |
+| 56 | bsc | BNB Smart Chain | 2147483704 |
+| 60 | go | GoChain | 2147483708 |
+| 61 | etc | Ethereum Classic | 2147483709 |
+| 88 | tomo | TomoChain | 2147483736 |
+| 99 | poa | POA | 2147483747 |
+| 100 | gno | Gnosis | 2147483748 |
+| 108 | tt | ThunderCore | 2147483756 |
+| 137 | matic | Polygon | 2147483785 |
+| 169 | manta | Manta Pacific | 2147483817 |
+| 246 | ewt | Energy Web | 2147483894 |
+| 250 | ftm | Fantom Opera | 2147483898 |
+| 288 | boba | Boba | 2147483936 |
+| 324 | zksync | zkSync | 2147483972 |
+| 361 | theta | Theta | 2147484009 |
+| 820 | clo | Callisto | 2147484468 |
+| 1088 | metis | Metis | 2147484736 |
+| 5000 | mantle | Mantle | 2147488648 |
+| 8453 | base | Base | 2147492101 |
+| 39797 | nrg | Energi | 2147523445 |
+| 42161 | arb1 | Arbitrum One | 2147525809 |
+| 42220 | celo | Celo | 2147525868 |
+| 43114 | avaxc | Avalanche C-Chain | 2147526762 |
+| 59144 | linea | Linea | 2147542792 |
+| 534352 | scr | Scroll | 2148018000 |
+| 7777777 | zora | Zora | 2155261425 |
+
+### Legacy Coins
+
+The following legacy coins are supported:
+
+| Coin Type | Name | Full Name | Replacement Name | Replacement Coin Type |
+| --- | --- | --- | --- | --- |
+| 61 | etcLegacy | Ethereum Classic | etc | 2147483709 |
+| 178 | poaLegacy | POA | poa | 2147483747 |
+| 246 | ewtLegacy | Energy Web | ewt | 2147483894 |
+| 500 | thetaLegacy | Theta | theta | 2147484009 |
+| 574 | vlxLegacy | Velas | vlx | 5655640 |
+| 700 | gnoLegacy | Gnosis | gno | 2147483748 |
+| 820 | cloLegacy | Callisto | clo | 2147484468 |
+| 889 | tomoLegacy | TomoChain | tomo | 2147483736 |
+| 1001 | ttLegacy | ThunderCore | tt | 2147483756 |
+| 1007 | ftmLegacy | Fantom | ftm | 2147483898 |
+| 6060 | goLegacy | GoChain | go | 2147483708 |
+| 9797 | nrgLegacy | Energi | nrg | 2147523445 |
+| 52752 | celoLegacy | Celo | celo | 2147525868 |
+
+### Coins
+
+The following coins are supported:
+
+| Coin Type | Name | Full Name | Encoding Type |
+| --- | --- | --- | --- |
+| 0 | btc | Bitcoin | base58check P2PKH and P2SH, and bech32 segwit |
+| 2 | ltc | Litecoin | base58check P2PHK and P2SH, and bech32 segwit |
+| 3 | doge | Dogecoin | base58check P2PKH and P2SH |
+| 4 | rdd | Reddcoin | base58check P2PKH and P2SH |
+| 5 | dash | Dash | base58check P2PKH and P2SH |
+| 6 | ppc | Peercoin | base58check P2PKH and P2SH |
+| 7 | nmc | Namecoin | base58check |
+| 14 | via | Viacoin | base58check P2PKH and P2SH |
+| 20 | dgb | DigiByte | base58check P2PKH and P2SH, and bech32 segwit |
+| 22 | mona | Monacoin | base58check P2PKH and P2SH, and bech32 segwit |
+| 42 | dcr | Decred | base58, no check |
+| 43 | xem | NEM | base32 |
+| 55 | aib | AIB | base58check P2PKH and P2SH |
+| 57 | sys | Syscoin | base58check P2PKH and P2SH, and bech32 segwit |
+| 60 | eth | Ethereum | checksummed-hex |
+| 74 | icx | ICON | custom |
+| 77 | xvg | Verge | base58check P2PKH and P2SH |
+| 105 | strat | Stratis | base58check P2PKH and P2SH |
+| 111 | ark | ARK | base58check |
+| 118 | atom | Atom | bech32 |
+| 121 | zen | Zencash | base58check |
+| 128 | xmr | Monero | base58xmr |
+| 133 | zec | Zcash | base58check P2PKH and P2SH, bech32 (Sprout shielded not supported) |
+| 134 | lsk | Lisk | hex with suffix |
+| 135 | steem | Steem | base58 + ripemd160-checksum |
+| 136 | firo | Firo | base58check P2PKH and P2SH |
+| 137 | rbtc | RSK | checksummed-hex |
+| 141 | kmd | Komodo | base58check |
+| 144 | xrp | Ripple | base58check-ripple |
+| 145 | bch | Bitcoin Cash | base58check and cashAddr; decodes to cashAddr |
+| 148 | xlm | Stellar Lumens | ed25519 public key |
+| 153 | btm | Bytom | bech32 segwit |
+| 156 | btg | Bitcoin Gold | base58check P2PKH and P2SH, and bech32 segwit |
+| 165 | nano | Nano | nano-base32 |
+| 175 | rvn | Ravencoin | base58check P2PKH and P2SH |
+| 192 | lcc | LitecoinCash | base58check P2PKH and P2SH, and bech32 segwit |
+| 194 | eos | EOS | base58 + ripemd160-checksum |
+| 195 | trx | Tron | base58check |
+| 204 | bcn | Bytecoin | base58xmr |
+| 235 | fio | FIO | base58 + ripemd160-checksum |
+| 236 | bsv | BitcoinSV | base58check |
+| 242 | nim | Nimiq | custom |
+| 283 | algo | Algorand | checksummed-base32 |
+| 291 | iost | IOST | base58, no check |
+| 301 | divi | Divi Project | base58check P2PKH and P2SH |
+| 304 | iotx | IoTeX | bech32 |
+| 308 | bts | Bitshares | base58 + ripemd160-checksum |
+| 309 | ckb | Nervos CKB | bech32 |
+| 313 | zil | Zilliqa | bech32 |
+| 326 | mrx | Metrix Coin | base58check |
+| 330 | luna | Terra | bech32 |
+| 354 | dot | Polkadot | ss58 |
+| 360 | vsys | V Systems | custom |
+| 367 | abbc | ABBC | base58 + ripemd160-checksum |
+| 397 | near | NEAR Protocol | custom |
+| 415 | etn | Electroneum | base58xmr |
+| 425 | aion | Aion | hex |
+| 434 | ksm | Kusama | ss58 |
+| 457 | ae | æternity | base58check |
+| 459 | kava | Kava | bech32 |
+| 461 | fil | Filecoin | base10 + leb128 and base32 + blake2b checksum |
+| 472 | ar | Arweave | base64url |
+| 489 | cca | Counos | base58check P2PKH and P2SH |
+| 501 | sol | Solana | base58, no check |
+| 508 | egld | MultiversX | bech32 |
+| 535 | xhv | Haven Protocol | base58xmr |
+| 539 | flow | Flow | hex |
+| 566 | iris | Irisnet | bech32 |
+| 568 | lrg | Large Coin | base58check P2PKH and P2SH |
+| 569 | sero | Super Zero Protocol | base58, no check |
+| 570 | bdx | Beldex | base58xmr |
+| 571 | ccxx | Counos X | base58check P2PKH and P2SH, and bech32 segwit |
+| 573 | srm | Serum | base58, no check |
+| 576 | bps | BitcoinPoS | base58check P2PKH and P2SH |
+| 589 | tfuel | Theta Fuel | checksummed-hex |
+| 592 | grin | Grin | base58check |
+| 714 | bnb | BNB | bech32 |
+| 784 | sui | Sui | hex |
+| 818 | vet | VeChain | checksummed-hex |
+| 825 | hive | Hive | base58 + ripemd160-checksum |
+| 888 | neo | NEO | base58check |
+| 904 | hnt | Helium | base58check |
+| 931 | rune | THORChain | bech32 |
+| 999 | bcd | Bitcoin Diamond | base58check P2PKH and P2SH, and bech32 segwit |
+| 1023 | one | HARMONY-ONE | bech32 |
+| 1024 | ont | Ontology | base58check |
+| 1237 | nostr | Nostr | bech32 |
+| 1729 | xtz | Tezos | base58check |
+| 1815 | ada | Cardano | base58, no check + crc32-checksum and bech32 |
+| 1991 | sc | Sia | blake2b checksum |
+| 2301 | qtum | QTUM | base58check |
+| 2303 | gxc | GXChain | base58 + ripemd160-checksum |
+| 2305 | ela | Elastos | base58 |
+| 2718 | nas | Nebulas | base58 + sha3-256-checksum |
+| 3030 | hbar | Hedera HBAR | custom |
+| 4218 | iota | IOTA | iotaBech32 |
+| 5353 | hns | Handshake | custom |
+| 5757 | stx | Stacks | crockford base32 P2PKH and P2SH + ripemd160-checksum |
+| 8444 | xch | Chia | bech32m |
+| 8964 | nuls | NULS | base58 |
+| 9000 | avax | Avalanche | bech32 |
+| 9004 | strk | StarkNet | keccak256-checksumed-hex |
+| 16754 | ardr | Ardor | custom |
+| 19167 | flux | Flux | base58check P2PKH and P2SH, bech32 (Sprout shielded not supported) |
+| 99999 | wicc | Waykichain | base58check P2PKH and P2SH |
+| 5655640 | vlx | Velas | base58, no check |
+| 5718350 | wan | Wanchain | checksummed-hex |
+| 5741564 | waves | Waves | base58 |

address_encoder-1.0.0/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "address-encoder"
+version = "1.0.0"
+description = "Encodes and decodes address formats for various cryptocurrencies"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [{ name = "ENS Domains" }]
+keywords = ["ens", "cryptocurrency", "address", "encoder", "decoder"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Software Development :: Libraries",
+  "Typing :: Typed",
+]
+dependencies = [
+  "base58>=2.1.0",
+  "cbor2>=5.6.0",
+  "pycryptodome>=3.20.0",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0.0", "mypy>=1.8.0", "ruff>=0.4.0"]
+
+[project.urls]
+Homepage = "https://github.com/ensdomains/address-encoder"
+Repository = "https://github.com/ensdomains/address-encoder"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/address_encoder"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+packages = ["address_encoder"]