mm-btc 0.1.1__tar.gz → 0.1.3__tar.gz

mm_btc-0.1.3/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: mm-btc
+Version: 0.1.3
+Requires-Python: >=3.12
+Requires-Dist: bitcoinlib~=0.7.1
+Requires-Dist: bit~=0.8.0
+Requires-Dist: hdwallet~=3.2.0
+Requires-Dist: mm-std~=0.1.9
+Requires-Dist: mnemonic>=0.21
+Requires-Dist: typer>=0.15.1

{mm_btc-0.1.1 → mm_btc-0.1.3}/justfile

@@ -6,14 +6,14 @@ clean:
     rm -rf .pytest_cache .mypy_cache .ruff_cache .coverage dist build src/*.egg-info
 
 build: clean lint audit test
-    uvx --from build pyproject-build --installer uv
+    uv build
 
 format:
     uv run ruff check --select I --fix src tests
     uv run ruff format src tests
 
 test:
-    uv run coverage run -m pytest -n auto tests
+    uv run pytest -n auto tests
 
 lint: format
     uv run ruff check src tests

{mm_btc-0.1.1 → mm_btc-0.1.3}/pyproject.toml

@@ -1,17 +1,16 @@
 [project]
 name = "mm-btc"
-version = "0.1.1"
+version = "0.1.3"
 description = ""
 requires-python = ">=3.12"
 dependencies = [
-    "mm-std~=0.1.2",
-    "hdwallet~=2.2.1",
+    "mm-std~=0.1.9",
+    "hdwallet~=3.2.0",
     "bit~=0.8.0",
-    "bitcoinlib~=0.6.15",
-
+    "bitcoinlib~=0.7.1",
+    "typer>=0.15.1",
+    "mnemonic>=0.21",
 ]
-[project.optional-dependencies]
-cli = ["typer~=0.12.5"]
 [project.scripts]
 mm-btc = "mm_btc.cli.cli:app"
 
@@ -21,20 +20,17 @@ build-backend = "hatchling.build"
 
 [tool.uv]
 dev-dependencies = [
-    "pytest~=8.3.3",
+    "pytest~=8.3.4",
     "pytest-xdist~=3.6.1",
-    "pytest-httpserver~=1.1.0",
-    "coverage~=7.6.0",
-    "ruff~=0.6.4",
-    "pip-audit~=2.7.0",
-    "bandit~=1.7.7",
-    "mypy~=1.11.2",
-    "types-python-dateutil~=2.9.0.20240906",
-    "types-PyYAML~=6.0.12.12",
+    "ruff~=0.8.4",
+    "pip-audit~=2.7.3",
+    "bandit~=1.8.0",
+    "mypy~=1.14.0",
+    "types-PyYAML~=6.0.12.20241221",
 ]
 
 [tool.mypy]
-python_version = "3.12"
+python_version = "3.13"
 warn_no_return = false
 strict = true
 exclude = ["^tests/", "^tmp/"]
@@ -44,7 +40,7 @@ ignore_missing_imports = true
 
 [tool.ruff]
 line-length = 130
-target-version = "py312"
+target-version = "py313"
 lint.select = [
     "F", # Pyflakes
     "E", "W", # pycodestyle

{mm_btc-0.1.1 → mm_btc-0.1.3}/src/mm_btc/cli/cli.py

@@ -7,6 +7,7 @@ from mm_std import print_plain
 
 from mm_btc.cli import cli_utils
 from mm_btc.cli.cmd import address_cmd, create_tx_cmd, decode_tx_cmd, mnemonic_cmd, utxo_cmd
+from mm_btc.wallet import AddressType
 
 app = typer.Typer(no_args_is_help=True, pretty_exceptions_enable=False, add_completion=False)
 
@@ -17,6 +18,7 @@ def mnemonic_command(  # nosec B107:hardcoded_password_default
     mnemonic: Annotated[str, typer.Option("--mnemonic", "-m", help="")] = "",
     passphrase: Annotated[str, typer.Option("--passphrase", "-p")] = "",
     path: Annotated[str, typer.Option("--path", help="Derivation path. Examples: bip44, bip88, m/44'/0'/0'/0")] = "bip44",
+    address_type: Annotated[AddressType, typer.Option("--address-type", "-a", help="Bitcoin address type")] = AddressType.P2WPKH,
     hex_: Annotated[bool, typer.Option("--hex", help="Print private key in hex format instead of WIF")] = False,
     words: int = typer.Option(12, "--words", "-w", help="Number of mnemonic words"),
     limit: int = typer.Option(10, "--limit", "-l"),
@@ -30,6 +32,7 @@ def mnemonic_command(  # nosec B107:hardcoded_password_default
             words=words,
             limit=limit,
             path=path,
+            address_type=address_type,
             hex=hex_,
             testnet=testnet,
         )

{mm_btc-0.1.1 → mm_btc-0.1.3}/src/mm_btc/cli/cmd/mnemonic_cmd.py

@@ -3,7 +3,7 @@ from enum import Enum
 
 from mm_std import print_plain
 
-from mm_btc.wallet import derive_accounts, generate_mnemonic
+from mm_btc.wallet import AddressType, derive_accounts, generate_mnemonic
 
 
 class PrivateType(str, Enum):
@@ -18,6 +18,7 @@ class Args:
     words: int
     limit: int
     hex: bool  # Print private key in hex format instead of WIF
+    address_type: AddressType
     path: str
     testnet: bool
 
@@ -26,7 +27,7 @@ def run(args: Args) -> None:
     mnemonic = args.mnemonic or generate_mnemonic()
     passphrase = args.passphrase
     path = get_derivation_path_prefix(args.path, args.testnet)
-    accounts = derive_accounts(mnemonic, passphrase, path, args.limit)
+    accounts = derive_accounts(mnemonic, passphrase, path, args.address_type, args.limit)
 
     print_plain(f"{mnemonic}")
     if passphrase:

mm_btc-0.1.3/src/mm_btc/wallet.py

@@ -0,0 +1,85 @@
+from dataclasses import dataclass
+from enum import Enum, unique
+
+from hdwallet import HDWallet
+from hdwallet.cryptocurrencies import Bitcoin
+from hdwallet.derivations import CustomDerivation
+from hdwallet.hds import BIP32HD
+from hdwallet.mnemonics import BIP39Mnemonic
+from mnemonic import Mnemonic
+
+BIP44_MAINNET_PATH = "m/44'/0'/0'/0"
+BIP44_TESTNET_PATH = "m/44'/1'/0'/0"
+BIP84_MAINNET_PATH = "m/84'/0'/0'/0"
+BIP84_TESTNET_PATH = "m/84'/1'/0'/0"
+
+
+@dataclass
+class Account:
+    address: str
+    private: str
+    wif: str
+    path: str
+
+
+@unique
+class AddressType(str, Enum):
+    P2PKH = "P2PKH"  # Pay to Public Key Hash
+    P2SH = "P2SH"  # Pay to Script Hash
+    P2TR = "P2TR"  # Taproot
+    P2WPKH = "P2WPKH"  # Native SegWit
+    P2WPKH_IN_P2SH = "P2WPKH-In-P2SH"
+    P2WSH = "P2WSH"  # Native SegWit
+    P2WSH_IN_P2SH = "P2WSH-In-P2SH"
+
+
+def generate_mnemonic(language: str = "english", words: int = 12) -> str:
+    return Mnemonic(language).generate(strength=mnemonic_words_to_strenght(words))
+
+
+def derive_accounts(mnemonic: str, passphrase: str, path_prefix: str, address_type: AddressType, limit: int) -> list[Account]:
+    coin = Bitcoin
+    if path_prefix.startswith("m/84'/1'"):
+        network = coin.NETWORKS.TESTNET
+    elif path_prefix.startswith("m/44'/1'"):
+        network = coin.NETWORKS.TESTNET
+    elif path_prefix.startswith("m/84'/0'"):
+        network = coin.NETWORKS.MAINNET
+    elif path_prefix.startswith("m/44'/0'"):
+        network = coin.NETWORKS.MAINNET
+    else:
+        raise ValueError("Invalid path")
+
+    wallet = HDWallet(cryptocurrency=coin, network=network, hd=BIP32HD, passphrase=passphrase).from_mnemonic(
+        BIP39Mnemonic(mnemonic)
+    )
+    wallet.clean_derivation()
+
+    accounts = []
+    for index_path in range(limit):
+        wallet.clean_derivation()
+        path = f"{path_prefix}/{index_path}"
+        w = wallet.from_derivation(derivation=CustomDerivation(path=path))
+        accounts.append(Account(address=w.address(address_type), private=w.private_key(), wif=w.wif(), path=path))
+        w.clean_derivation()
+
+    return accounts
+
+
+def mnemonic_words_to_strenght(words: int) -> int:
+    if words == 12:
+        return 128
+    if words == 15:
+        return 160
+    if words == 18:
+        return 192
+    if words == 21:
+        return 224
+    if words == 24:
+        return 256
+
+    raise ValueError("Invalid words")
+
+
+def is_testnet_address(address: str) -> bool:
+    return address.startswith(("m", "n", "tb1"))

{mm_btc-0.1.1 → mm_btc-0.1.3}/tests/test_wallet.py

@@ -3,6 +3,7 @@ from mm_btc.wallet import (
     BIP44_TESTNET_PATH,
     BIP84_MAINNET_PATH,
     BIP84_TESTNET_PATH,
+    AddressType,
     derive_accounts,
     generate_mnemonic,
 )
@@ -17,28 +18,28 @@ def test_generate_mnemonic():
 
 def test_derive_accounts(mnemonic, passphrase):
     # mainnet bip44
-    accs = derive_accounts(mnemonic, passphrase, BIP44_MAINNET_PATH, 2)
+    accs = derive_accounts(mnemonic, passphrase, BIP44_MAINNET_PATH, AddressType.P2PKH, 2)
     assert accs[1].path == "m/44'/0'/0'/0/1"
     assert accs[1].address == "13MJrGQq8RwLcGfdnY58666kCsZqevsadE"
     assert accs[1].private == "0d5feb50af849f2ebcc0c83a4446ddbceefd7b0ceba437a57161fa37702d096e"
     assert accs[1].wif == "Kwfi75WxsuaKnmxRUQDoEZDzKXkMC8E9Pzk3vVjEdPsJu1DXCFPv"
 
     # mainnet bip84
-    accs = derive_accounts(mnemonic, passphrase, BIP84_MAINNET_PATH, 2)
+    accs = derive_accounts(mnemonic, passphrase, BIP84_MAINNET_PATH, AddressType.P2WPKH, 2)
     assert accs[1].path == "m/84'/0'/0'/0/1"
     assert accs[1].address == "bc1qszqeg6gfcmt8zurkeayes2895urnea2m54rt3w"
     assert accs[1].private == "1cc57553f9e3e1b863693be92ac753f682f61f1a2dede2ceff97262027635334"
     assert accs[1].wif == "KxBdzQTQduYKoec1FWgwMDF9R1a4UdQp3ezyhjniw4W2k54Cb6gE"
 
     # testnet bip44
-    accs = derive_accounts(mnemonic, passphrase, BIP44_TESTNET_PATH, 2)
+    accs = derive_accounts(mnemonic, passphrase, BIP44_TESTNET_PATH, AddressType.P2PKH, 2)
     assert accs[1].path == "m/44'/1'/0'/0/1"
     assert accs[1].address == "miRfXh2aH6pjhdo5EoBt4RRdAipR88dcV3"
     assert accs[1].private == "3a2e8fc45c75ab8a7cdafacf7c77c941f8eebc813ee2f0e17ee86e7ac8584b3a"
     assert accs[1].wif == "cPXoLA4cRKxeht4iH6ZsCDQxPspFi8SEieZNTKDzGgog94Zg5Y64"
 
     # testnet bip84
-    accs = derive_accounts(mnemonic, passphrase, BIP84_TESTNET_PATH, 2)
+    accs = derive_accounts(mnemonic, passphrase, BIP84_TESTNET_PATH, AddressType.P2WPKH, 2)
     assert accs[1].path == "m/84'/1'/0'/0/1"
     assert accs[1].address == "tb1qp36pk9w408pgfpwn5myxwurr3fhzryn0lpyah2"
     assert accs[1].private == "150fd20e4cb377ae57b43fed59ca2765a9f5d91a20640a4cfdf43ceb5403d48c"