mm-btc 0.0.2__tar.gz → 0.0.4__tar.gz

{mm_btc-0.0.2 → mm_btc-0.0.4}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: mm-btc
-Version: 0.0.2
+Version: 0.0.4
 Requires-Python: >=3.12
 Requires-Dist: mm-std~=0.1.0
 Requires-Dist: hdwallet~=2.2.1
+Requires-Dist: typer~=0.12.3
 Provides-Extra: dev
 Requires-Dist: build~=1.2.1; extra == "dev"
 Requires-Dist: twine~=5.1.0; extra == "dev"

mm_btc-0.0.4/README.txt

@@ -0,0 +1 @@
+mm-btc

{mm_btc-0.0.2 → mm_btc-0.0.4}/pyproject.toml

@@ -1,10 +1,11 @@
 [project]
 name = "mm-btc"
-version = "0.0.2"
+version = "0.0.4"
 description = ""
 dependencies = [
     "mm-std~=0.1.0",
-    "hdwallet~=2.2.1"
+    "hdwallet~=2.2.1",
+    "typer~=0.12.3"
 ]
 requires-python = ">=3.12"
 [project.optional-dependencies]
@@ -23,6 +24,8 @@ dev = [
     "types-requests~=2.32.0.20240523",
     "types-PyYAML~=6.0.12.12",
 ]
+[project.scripts]
+mm-btc = "mm_btc.cli.cli:app"
 
 
 [build-system]

mm_btc-0.0.4/src/mm_btc/cli/cli.py

@@ -0,0 +1,47 @@
+from typing import Annotated
+
+import typer
+from mm_std import print_plain
+
+from mm_btc.cli import cli_utils
+from mm_btc.cli.cmd import mnemonic_cmd
+
+app = typer.Typer(no_args_is_help=True, pretty_exceptions_enable=False, add_completion=False)
+
+
+@app.command(name="mnemonic", help="Generate keys based on a mnemonic")
+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",
+    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"),
+    testnet: bool = typer.Option(False, "--testnet", "-t", help="Testnet network"),
+) -> None:
+    mnemonic_cmd.run(
+        mnemonic_cmd.Args(
+            mnemonic=mnemonic,
+            passphrase=passphrase,
+            words=words,
+            limit=limit,
+            path=path,
+            hex=hex_,
+            testnet=testnet,
+        )
+    )
+
+
+def version_callback(value: bool) -> None:
+    if value:
+        print_plain(f"mm-eth version: {cli_utils.get_version()}")
+        raise typer.Exit()
+
+
+@app.callback()
+def main(_version: bool = typer.Option(None, "--version", callback=version_callback, is_eager=True)) -> None:
+    pass
+
+
+if __name__ == "__main_":
+    app()

mm_btc-0.0.4/src/mm_btc/cli/cli_utils.py

@@ -0,0 +1,5 @@
+import importlib.metadata
+
+
+def get_version() -> str:
+    return importlib.metadata.version("mm-btc")

mm_btc-0.0.4/src/mm_btc/cli/cmd/mnemonic_cmd.py

@@ -0,0 +1,48 @@
+from dataclasses import dataclass
+from enum import Enum
+
+from mm_std import print_plain
+
+from mm_btc.wallet import derive_accounts, generate_mnemonic
+
+
+class PrivateType(str, Enum):
+    hex = "hex"
+    wif = "wif"
+
+
+@dataclass
+class Args:
+    mnemonic: str
+    passphrase: str
+    words: int
+    limit: int
+    hex: bool  # Print private key in hex format instead of WIF
+    path: str
+    testnet: bool
+
+
+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)
+
+    print_plain(f"{mnemonic}")
+    if passphrase:
+        print_plain(f"{passphrase}")
+    for acc in accounts:
+        private = acc.private if args.hex else acc.wif
+        print_plain(f"{acc.path} {acc.address} {private}")
+
+
+def get_derivation_path_prefix(path: str, testnet: bool) -> str:
+    if path.startswith("m/"):
+        return path
+    coin = "1" if testnet else "0"
+    if path == "bip44":
+        return f"m/44'/{coin}'/0'/0"
+    if path == "bip84":
+        return f"m/84'/{coin}'/0'/0"
+
+    raise ValueError("Invalid path")

{mm_btc-0.0.2 → mm_btc-0.0.4}/src/mm_btc/wallet.py

@@ -14,10 +14,12 @@ BIP84_TESTNET_PATH = "m/84'/1'/0'/0"
 class Account:
     address: str
     private: str
+    wif: str
     path: str
 
 
-def generate_mnemonic(language: str = "english", strength: int = 128) -> str:
+def generate_mnemonic(language: str = "english", words: int = 12) -> str:
+    strength = mnemonic_words_to_strenght(words)
     return new_mnemonic(language=language, strength=strength)  # type: ignore[no-any-return]
 
 
@@ -39,7 +41,22 @@ def derive_accounts(mnemonic: str, passphrase: str, path: str, limit: int) -> li
     accounts = []
     for index_path in range(limit):
         w.from_path(path=f"{path}/{index_path}")
-        accounts.append(Account(address=w.address(), private=w.wif(), path=f"{path}/{index_path}"))
+        accounts.append(Account(address=w.address(), private=w.private_key(), wif=w.wif(), path=f"{path}/{index_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")

{mm_btc-0.0.2 → mm_btc-0.0.4}/src/mm_btc.egg-info/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: mm-btc
-Version: 0.0.2
+Version: 0.0.4
 Requires-Python: >=3.12
 Requires-Dist: mm-std~=0.1.0
 Requires-Dist: hdwallet~=2.2.1
+Requires-Dist: typer~=0.12.3
 Provides-Extra: dev
 Requires-Dist: build~=1.2.1; extra == "dev"
 Requires-Dist: twine~=5.1.0; extra == "dev"

{mm_btc-0.0.2 → mm_btc-0.0.4}/src/mm_btc.egg-info/SOURCES.txt

@@ -7,7 +7,13 @@ src/mm_btc/wallet.py
 src/mm_btc.egg-info/PKG-INFO
 src/mm_btc.egg-info/SOURCES.txt
 src/mm_btc.egg-info/dependency_links.txt
+src/mm_btc.egg-info/entry_points.txt
 src/mm_btc.egg-info/requires.txt
 src/mm_btc.egg-info/top_level.txt
+src/mm_btc/cli/__init__.py
+src/mm_btc/cli/cli.py
+src/mm_btc/cli/cli_utils.py
+src/mm_btc/cli/cmd/__init__.py
+src/mm_btc/cli/cmd/mnemonic_cmd.py
 tests/test_blockstream.py
 tests/test_wallet.py

mm_btc-0.0.4/src/mm_btc.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mm-btc = mm_btc.cli.cli:app

{mm_btc-0.0.2 → mm_btc-0.0.4}/src/mm_btc.egg-info/requires.txt

@@ -1,5 +1,6 @@
 mm-std~=0.1.0
 hdwallet~=2.2.1
+typer~=0.12.3
 
 [dev]
 build~=1.2.1

{mm_btc-0.0.2 → mm_btc-0.0.4}/tests/test_blockstream.py

@@ -1,24 +1,24 @@
 from mm_btc import blockstream
 
 
-def test_get_address(binance_address):
+def test_get_address(binance_address, proxies):
     # non-empty address
-    res = blockstream.get_address(binance_address)
+    res = blockstream.get_address(binance_address, proxies=proxies)
     assert res.unwrap().chain_stats.tx_count > 800
 
     # empty address
-    res = blockstream.get_address("bc1pa48c294qk7yd7sc8y0wxydc3a2frv5j83e65rvm48v3ej098s5zs8kvh6d")
+    res = blockstream.get_address("bc1pa48c294qk7yd7sc8y0wxydc3a2frv5j83e65rvm48v3ej098s5zs8kvh6d", proxies=proxies)
     assert res.unwrap().chain_stats.tx_count == 0
 
     # invalid address
-    res = blockstream.get_address("bc1pa48c294qk7yd7sc8y0wxydc3a2frv5j83e65rvm48v3ej098s5zs8kvh5d")
+    res = blockstream.get_address("bc1pa48c294qk7yd7sc8y0wxydc3a2frv5j83e65rvm48v3ej098s5zs8kvh5d", proxies=proxies)
     assert res.unwrap_err() == blockstream.ERROR_INVALID_ADDRESS
 
     # invalid network
-    res = blockstream.get_address(binance_address, testnet=True)
+    res = blockstream.get_address(binance_address, testnet=True, proxies=proxies)
     assert res.unwrap_err() == blockstream.ERROR_INVALID_NETWORK
 
 
-def test_get_confirmed_balance(binance_address):
-    res = blockstream.get_confirmed_balance(binance_address)
+def test_get_confirmed_balance(binance_address, proxies):
+    res = blockstream.get_confirmed_balance(binance_address, proxies=proxies)
     assert res.unwrap() > 0

mm_btc-0.0.4/tests/test_wallet.py

@@ -0,0 +1,45 @@
+from mm_btc.wallet import (
+    BIP44_MAINNET_PATH,
+    BIP44_TESTNET_PATH,
+    BIP84_MAINNET_PATH,
+    BIP84_TESTNET_PATH,
+    derive_accounts,
+    generate_mnemonic,
+)
+
+
+def test_generate_mnemonic():
+    mnemonic = generate_mnemonic(words=24)
+    assert len(mnemonic.split()) == 24
+
+    assert generate_mnemonic() != generate_mnemonic()
+
+
+def test_derive_accounts(mnemonic, passphrase):
+    # mainnet bip44
+    accs = derive_accounts(mnemonic, passphrase, BIP44_MAINNET_PATH, 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)
+    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)
+    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)
+    assert accs[1].path == "m/84'/1'/0'/0/1"
+    assert accs[1].address == "tb1qp36pk9w408pgfpwn5myxwurr3fhzryn0lpyah2"
+    assert accs[1].private == "150fd20e4cb377ae57b43fed59ca2765a9f5d91a20640a4cfdf43ceb5403d48c"
+    assert accs[1].wif == "cNHeFPcfq2XFfDAgq9icSK8NX29C1exPHekqYQdWgruQ6gPMBmXD"

mm_btc-0.0.2/README.txt

@@ -1,2 +0,0 @@
-For tests:
- - binance address: 34xp4vRoCGJym3xR7yCVPFHoCNxv4Twseo

mm_btc-0.0.2/tests/test_wallet.py

@@ -1,44 +0,0 @@
-from mm_btc.wallet import (
-    BIP44_MAINNET_PATH,
-    BIP44_TESTNET_PATH,
-    BIP84_MAINNET_PATH,
-    BIP84_TESTNET_PATH,
-    derive_accounts,
-    generate_mnemonic,
-)
-
-
-def test_generate_mnemonic():
-    mnemonic = generate_mnemonic(strength=256)
-    assert len(mnemonic.split()) == 24
-
-    assert generate_mnemonic() != generate_mnemonic()
-
-
-def test_derive_accounts():
-    mnemonic = "arrange mutual earth tackle smart kangaroo rigid census exotic acoustic stock dream eager area laptop"
-    passphrase = "my-secret"
-
-    # mainnet bip44
-    accs = derive_accounts(mnemonic, passphrase, BIP44_MAINNET_PATH, 2)
-    assert accs[1].path == "m/44'/0'/0'/0/1"
-    assert accs[1].address == "1L4Ghh4kuJuRCXrFrczwCV2TaggfCgf6B3"
-    assert accs[1].private == "Kz4zoYPJ5astywoTbxHQr5SgFvMCekMqnWDFnXjY9CfvFtyNnGiE"
-
-    # mainnet bip84
-    accs = derive_accounts(mnemonic, passphrase, BIP84_MAINNET_PATH, 2)
-    assert accs[1].path == "m/84'/0'/0'/0/1"
-    assert accs[1].address == "bc1qrq2mwuqz3utyqz97xjq5npl0dyq5gmddpxdf8k"
-    assert accs[1].private == "L447sW2JenqmEMMi7GoiUZDxTpY3Ni5ZfRrRxAbufiYwZV1AHytj"
-
-    # testnet bip44
-    accs = derive_accounts(mnemonic, passphrase, BIP44_TESTNET_PATH, 2)
-    assert accs[1].path == "m/44'/1'/0'/0/1"
-    assert accs[1].address == "n3DsvbopmKJaxHNgdZ6VVK4mB9fcuhXy5w"
-    assert accs[1].private == "cVsAhYpSm2x8V2fQJdjmfBGm1aW7xKH1U8eZTpG9giz8usxNv4da"
-
-    # testnet bip84
-    accs = derive_accounts(mnemonic, passphrase, BIP84_TESTNET_PATH, 2)
-    assert accs[1].path == "m/84'/1'/0'/0/1"
-    assert accs[1].address == "tb1q4cu7pgs0w5s4ctjz4m6gx6m4rv8eqjwtnt0a4j"
-    assert accs[1].private == "cPASMrozgCxXD6GQsJhge7hPY81j3huF8RJBY1PYwKmUVSYgeSRw"