mm-btc 0.4.2__tar.gz → 0.5.1__tar.gz

mm_btc-0.5.1/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: mm-btc
+Version: 0.5.1
+Requires-Python: >=3.13
+Requires-Dist: bitcoinlib~=0.7.4
+Requires-Dist: bit~=0.8.0
+Requires-Dist: hdwallet~=3.4.0
+Requires-Dist: mm-cryptocurrency~=0.4.2
+Requires-Dist: mm-print>=0.0.3
+Requires-Dist: mnemonic~=0.21
+Requires-Dist: typer~=0.16.0

mm_btc-0.5.1/README.md

@@ -0,0 +1,154 @@
+# mm-btc
+
+A Python library and CLI tool for Bitcoin operations, designed for developers who need to work with Bitcoin wallets, transactions, and blockchain data.
+
+⚠️ **This project is under active development. New features and breaking changes may be introduced.**
+
+
+
+
+## Library Usage
+
+### Working with Mnemonics and Wallets
+
+```python
+from mm_btc.wallet import generate_mnemonic, derive_accounts, AddressType
+
+# Generate a new mnemonic
+mnemonic = generate_mnemonic(words=12)
+print(f"Mnemonic: {mnemonic}")
+
+# Derive accounts from mnemonic
+accounts = derive_accounts(
+    mnemonic=mnemonic,
+    passphrase="",
+    path_prefix="m/84'/0'/0'/0",  # BIP84 mainnet
+    address_type=AddressType.P2WPKH,
+    limit=5
+)
+
+for account in accounts:
+    print(f"Address: {account.address}")
+    print(f"Private Key: {account.private}")
+    print(f"WIF: {account.wif}")
+    print(f"Path: {account.path}")
+```
+
+### Blockchain API Integration
+
+```python
+import asyncio
+from mm_btc.blockstream import BlockstreamClient
+
+async def get_address_info():
+    client = BlockstreamClient(testnet=False)
+    
+    # Get address information
+    address_info = await client.get_address("bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh")
+    if address_info.is_ok():
+        print(f"Balance: {address_info.value.chain_stats.funded_txo_sum}")
+    
+    # Get UTXOs
+    utxos = await client.get_utxo("bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh")
+    if utxos.is_ok():
+        for utxo in utxos.value:
+            print(f"TXID: {utxo.txid}, Value: {utxo.value}")
+
+asyncio.run(get_address_info())
+```
+
+
+## CLI Usage
+
+The `mm-btc` command provides several subcommands for Bitcoin operations.
+
+### Mnemonic Operations
+
+```bash
+# Generate a new 12-word mnemonic and derive addresses
+mm-btc mnemonic
+
+# Use existing mnemonic with custom parameters
+mm-btc mnemonic -m "your twelve word mnemonic phrase here..." -l 5 --address-type P2WPKH
+
+# Generate testnet addresses
+mm-btc mnemonic --testnet --path bip84
+
+# Use custom derivation path
+mm-btc mnemonic --path "m/44'/0'/0'/0" --hex
+```
+
+### Address Information
+
+```bash
+# Get address information from Blockstream API
+mm-btc address bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
+
+# Get UTXOs for an address
+mm-btc utxo bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
+```
+
+### Transaction Operations
+
+```bash
+# Create a transaction from config file
+mm-btc create-tx config.toml
+
+# Decode a transaction
+mm-btc decode-tx 02000000000101... --testnet
+```
+
+### Configuration Example
+
+Create a `config.toml` file for transaction creation:
+
+```toml
+from_address = "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
+private = "your_private_key_wif_format"
+
+[[outputs]]
+address = "bc1qrecipient_address_here"
+amount = 50000  # Amount in satoshis
+
+[[outputs]]
+address = "bc1qanother_recipient"
+amount = 25000
+```
+
+## Address Types
+
+Supported Bitcoin address types:
+
+- `P2PKH` - Pay to Public Key Hash (Legacy)
+- `P2SH` - Pay to Script Hash
+- `P2WPKH` - Native SegWit (Bech32)
+- `P2WPKH_IN_P2SH` - SegWit wrapped in P2SH
+- `P2WSH` - Native SegWit Script
+- `P2WSH_IN_P2SH` - SegWit Script wrapped in P2SH  
+- `P2TR` - Taproot
+
+## Derivation Paths
+
+- **BIP44**: `m/44'/0'/0'/0` (mainnet) / `m/44'/1'/0'/0` (testnet)
+- **BIP84**: `m/84'/0'/0'/0` (mainnet) / `m/84'/1'/0'/0` (testnet)
+- **Custom**: Specify your own path like `m/44'/0'/0'/0`
+
+
+## Dependencies
+
+- `hdwallet` - HD wallet operations
+- `bit` - Bitcoin transaction creation
+- `bitcoinlib` - Bitcoin utilities
+- `mnemonic` - BIP39 mnemonic generation
+- `typer` - CLI framework
+- `mm-print` - Pretty printing utilities
+- `mm-cryptocurrency` - Cryptocurrency utilities
+
+
+## References
+
+- [Bitcoin Transactions](https://en.bitcoin.it/wiki/Transaction)
+- [Address Prefixes](https://en.bitcoin.it/wiki/List_of_address_prefixes)
+- [Bitcoin BIPs](https://github.com/bitcoin/bips/blob/master/README.mediawiki)
+- [Blockstream API](https://github.com/Blockstream/esplora/blob/master/API.md)
+

{mm_btc-0.4.2 → mm_btc-0.5.1}/pyproject.toml

@@ -1,15 +1,16 @@
 [project]
 name = "mm-btc"
-version = "0.4.2"
+version = "0.5.1"
 description = ""
-requires-python = ">=3.12"
+requires-python = ">=3.13"
 dependencies = [
-    "mm-crypto-utils>=0.3.6",
     "hdwallet~=3.4.0",
     "bit~=0.8.0",
-    "bitcoinlib~=0.7.3",
+    "bitcoinlib~=0.7.4",
     "mnemonic~=0.21",
-    "typer~=0.15.2",
+    "typer~=0.16.0",
+    "mm-print>=0.0.3",
+    "mm-cryptocurrency~=0.4.2",
 ]
 [project.scripts]
 mm-btc = "mm_btc.cli.cli:app"
@@ -21,14 +22,15 @@ build-backend = "hatchling.build"
 
 [tool.uv]
 dev-dependencies = [
-    "pytest~=8.3.5",
-    "pytest-xdist~=3.6.1",
+    "pytest~=8.4.0",
+    "pytest-asyncio~=1.0.0",
+    "pytest-xdist~=3.7.0",
     "pytest-httpserver~=1.1.3",
-    "ruff~=0.11.6",
+    "ruff~=0.11.13",
     "pip-audit~=2.9.0",
     "bandit~=1.8.3",
-    "mypy~=1.15.0",
-    "pytest-asyncio>=0.26.0",
+    "mypy~=1.16.0",
+    "python-dotenv>=1.1.0",
 ]
 
 
@@ -38,7 +40,12 @@ warn_no_return = false
 strict = true
 exclude = ["^tests/", "^tmp/"]
 [[tool.mypy.overrides]]
-module = ["hdwallet.*", "hdwallet.symbols.*", "bit.*", "bitcoinlib.transactions.*"]
+module = [
+    "hdwallet.*",
+    "hdwallet.symbols.*",
+    "bit.*",
+    "bitcoinlib.transactions.*",
+]
 ignore_missing_imports = true
 
 [tool.ruff]
@@ -47,27 +54,27 @@ target-version = "py313"
 [tool.ruff.lint]
 select = ["ALL"]
 ignore = [
-    "TC", # flake8-type-checking, TYPE_CHECKING is dangerous, for example it doesn't work with pydantic
-    "A005", # flake8-builtins: stdlib-module-shadowing
-    "ERA001", # eradicate: commented-out-code
-    "PT", # flake8-pytest-style
-    "D", # pydocstyle
-    "FIX", # flake8-fixme
+    "TC",      # flake8-type-checking, TYPE_CHECKING is dangerous, for example it doesn't work with pydantic
+    "A005",    # flake8-builtins: stdlib-module-shadowing
+    "ERA001",  # eradicate: commented-out-code
+    "PT",      # flake8-pytest-style
+    "D",       # pydocstyle
+    "FIX",     # flake8-fixme
     "PLR0911", # pylint: too-many-return-statements
     "PLR0912", # pylint: too-many-branches
     "PLR0913", # pylint: too-many-arguments
     "PLR2004", # pylint: magic-value-comparison
     "PLC0414", # pylint: useless-import-alias
-    "FBT", # flake8-boolean-trap
-    "EM", # flake8-errmsg
-    "TRY003", # tryceratops: raise-vanilla-args
-    "C901", # mccabe: complex-structure,
-    "BLE001", # flake8-blind-except
-    "S311", # bandit: suspicious-non-cryptographic-random-usage
-    "TD002", # flake8-todos: missing-todo-author
-    "TD003", # flake8-todos: missing-todo-link
-    "RET503", # flake8-return: implicit-return
-    "COM812", # it's used in ruff formatter
+    "FBT",     # flake8-boolean-trap
+    "EM",      # flake8-errmsg
+    "TRY003",  # tryceratops: raise-vanilla-args
+    "C901",    # mccabe: complex-structure,
+    "BLE001",  # flake8-blind-except
+    "S311",    # bandit: suspicious-non-cryptographic-random-usage
+    "TD002",   # flake8-todos: missing-todo-author
+    "TD003",   # flake8-todos: missing-todo-link
+    "RET503",  # flake8-return: implicit-return
+    "COM812",  # it's used in ruff formatter
 ]
 [tool.ruff.lint.pep8-naming]
 classmethod-decorators = ["field_validator"]

{mm_btc-0.4.2 → mm_btc-0.5.1}/src/mm_btc/blockstream.py

@@ -1,6 +1,8 @@
 from collections.abc import Sequence
 
-from mm_std import HttpResponse, Result, http_request, random_str_choice
+from mm_cryptocurrency import random_proxy
+from mm_http import HttpResponse, http_request
+from mm_result import Result
 from pydantic import BaseModel
 
 MAINNET_BASE_URL = "https://blockstream.info/api"
@@ -67,14 +69,14 @@ class BlockstreamClient:
             res = await self._request(f"/address/{address}")
             try:
                 if res.status_code == 400:
-                    return res.to_err("400 Bad Request")
-                return res.to_ok(Address(**res.parse_json_body()))
+                    return res.to_result_err("400 Bad Request")
+                return res.to_result_ok(Address(**res.parse_json_body()))
             except Exception as e:
-                result = res.to_err(e)
+                result = res.to_result_err(e)
         return result
 
     async def get_confirmed_balance(self, address: str) -> Result[int]:
-        return (await self.get_address(address)).and_then(
+        return (await self.get_address(address)).chain(
             lambda a: Result.ok(a.chain_stats.funded_txo_sum - a.chain_stats.spent_txo_sum)
         )
 
@@ -83,9 +85,9 @@ class BlockstreamClient:
         for _ in range(self.attempts):
             res = await self._request(f"/address/{address}/utxo")
             try:
-                return res.to_ok([Utxo(**out) for out in res.parse_json_body()])
+                return res.to_result_ok([Utxo(**out) for out in res.parse_json_body()])
             except Exception as e:
-                result = res.to_err(e)
+                result = res.to_result_err(e)
         return result
 
     async def get_mempool(self) -> Result[Mempool]:
@@ -93,10 +95,10 @@ class BlockstreamClient:
         for _ in range(self.attempts):
             res = await self._request("/mempool")
             try:
-                return res.to_ok(Mempool(**res.parse_json_body()))
+                return res.to_result_ok(Mempool(**res.parse_json_body()))
             except Exception as e:
-                result = res.to_err(e)
+                result = res.to_result_err(e)
         return result
 
     async def _request(self, url: str) -> HttpResponse:
-        return await http_request(f"{self.base_url}{url}", timeout=self.timeout, proxy=random_str_choice(self.proxies))
+        return await http_request(f"{self.base_url}{url}", timeout=self.timeout, proxy=random_proxy(self.proxies))

{mm_btc-0.4.2 → mm_btc-0.5.1}/src/mm_btc/cli/cli.py

@@ -3,9 +3,9 @@ import importlib.metadata
 from pathlib import Path
 from typing import Annotated
 
+import mm_print
 import typer
 import typer.core
-from mm_std import print_plain
 
 from mm_btc.wallet import AddressType
 
@@ -68,7 +68,7 @@ def utxo_command(address: str) -> None:
 
 def version_callback(value: bool) -> None:
     if value:
-        print_plain(f"mm-btc: v{importlib.metadata.version('mm-btc')}")
+        mm_print.print_plain(f"mm-btc: v{importlib.metadata.version('mm-btc')}")
         raise typer.Exit
 
 

{mm_btc-0.4.2 → mm_btc-0.5.1}/src/mm_btc/cli/cmd/address_cmd.py

@@ -1,4 +1,4 @@
-from mm_std import print_json
+import mm_print
 
 from mm_btc.blockstream import BlockstreamClient
 from mm_btc.wallet import is_testnet_address
@@ -7,4 +7,4 @@ from mm_btc.wallet import is_testnet_address
 async def run(address: str) -> None:
     client = BlockstreamClient(testnet=is_testnet_address(address))
     res = await client.get_address(address)
-    print_json(res.value_or_error())
+    mm_print.print_json(res.value_or_error())

{mm_btc-0.4.2 → mm_btc-0.5.1}/src/mm_btc/cli/cmd/create_tx_cmd.py

@@ -1,7 +1,8 @@
 from pathlib import Path
 
+import mm_print
 from bit import PrivateKey, PrivateKeyTestnet
-from mm_std import BaseConfig, print_console
+from mm_cryptocurrency import BaseConfig
 
 from mm_btc.wallet import is_testnet_address
 
@@ -24,4 +25,4 @@ def run(config_path: Path) -> None:
     outputs = [(o.address, o.amount, "satoshi") for o in config.outputs]
 
     tx = key.create_transaction(outputs)
-    print_console(tx)
+    mm_print.print_json(tx)

{mm_btc-0.4.2 → mm_btc-0.5.1}/src/mm_btc/cli/cmd/decode_tx_cmd.py

@@ -1,8 +1,8 @@
-from mm_std import print_json
+import mm_print
 
 from mm_btc.tx import decode_tx
 
 
 def run(tx_hex: str, testnet: bool = False) -> None:
     res = decode_tx(tx_hex, testnet)
-    print_json(res)
+    mm_print.print_json(res)

{mm_btc-0.4.2 → mm_btc-0.5.1}/src/mm_btc/cli/cmd/mnemonic_cmd.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass
 from enum import Enum
 
-from mm_std import print_plain
+import mm_print
 
 from mm_btc.wallet import AddressType, derive_accounts, generate_mnemonic
 
@@ -29,12 +29,12 @@ def run(args: Args) -> None:
     path = get_derivation_path_prefix(args.path, args.testnet)
     accounts = derive_accounts(mnemonic, passphrase, path, args.address_type, args.limit)
 
-    print_plain(f"{mnemonic}")
+    mm_print.print_plain(f"{mnemonic}")
     if passphrase:
-        print_plain(f"{passphrase}")
+        mm_print.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}")
+        mm_print.print_plain(f"{acc.path} {acc.address} {private}")
 
 
 def get_derivation_path_prefix(path: str, testnet: bool) -> str:

{mm_btc-0.4.2 → mm_btc-0.5.1}/src/mm_btc/cli/cmd/utxo_cmd.py

@@ -1,4 +1,4 @@
-from mm_std import print_json
+import mm_print
 
 from mm_btc.blockstream import BlockstreamClient
 from mm_btc.wallet import is_testnet_address
@@ -7,4 +7,4 @@ from mm_btc.wallet import is_testnet_address
 async def run(address: str) -> None:
     client = BlockstreamClient(testnet=is_testnet_address(address))
     res = await client.get_utxo(address)
-    print_json(res.value_or_error())
+    mm_print.print_json(res.value_or_error())

{mm_btc-0.4.2 → mm_btc-0.5.1}/tests/conftest.py

@@ -1,8 +1,14 @@
+import os
+
 import pytest
-from mm_crypto_utils.proxy import fetch_proxies_or_fatal_sync
-from mm_std import get_dotenv
+from dotenv import load_dotenv
+from mm_cryptocurrency import fetch_proxies_sync
 from typer.testing import CliRunner
 
+load_dotenv()
+
+PROXIES_URL = os.getenv("PROXIES_URL")
+
 
 @pytest.fixture()
 def mnemonic() -> str:
@@ -26,7 +32,7 @@ def binance_address() -> str:
 
 @pytest.fixture
 def proxies() -> list[str]:
-    return fetch_proxies_or_fatal_sync(get_dotenv("PROXIES_URL"))
+    return fetch_proxies_sync(PROXIES_URL).unwrap("cannot fetch proxies")
 
 
 @pytest.fixture

{mm_btc-0.4.2 → mm_btc-0.5.1}/tests/test_blockstream.py

@@ -19,11 +19,11 @@ async def test_get_address(binance_address, proxies):
 
     # invalid address
     res = await client.get_address("bc1pa48c294qk7yd7sc8y0wxydc3a2frv5j83e65rvm48v3ej098s5zs8kvh5d")
-    assert res.unwrap_error() == blockstream.ERROR_400_BAD_REQUEST
+    assert res.unwrap_err() == blockstream.ERROR_400_BAD_REQUEST
 
     # invalid network
     res = await client.get_address("mqkwWDWdgXhYunfoKvQfYyydwB5vdma3cK")
-    assert res.unwrap_error() == blockstream.ERROR_400_BAD_REQUEST
+    assert res.unwrap_err() == blockstream.ERROR_400_BAD_REQUEST
 
 
 async def test_get_confirmed_balance(binance_address, proxies):