Skip to main content

TX Engine

Python interface for building Bitcoin SV scripts and transactions. The native core is the Rust chain-gang library.

Requires Python 3.11+. Install from PyPI:

pip install tx-engine

Documentation

Topic Link
Documentation index docs/README.md
Python class reference docs/Python-API.md
HD wallets (mnemonic, BIP-44) docs/BIP-32-Python.md
Chronicle (Python examples) docs/Chronicle-Python.md
Chronicle (full spec) docs/Chronicle.md
Local development python/README.md

Quick example

from tx_engine import Tx

src_tx = (
    "0100000001c7151ebaf14dbfe922bd90700a7580f6db7d5a1b898ce79cb9ce459e17f1290900000000"
    "6b4830450221008b001e8d8110804ac66e467cd2452f468cba4a2a1d90d59679fe5075d24e5f530220"
    "6eb04e79214c09913fad1e3c0c2498be7f457ed63323ac6f2d9a38d53586a58d41210395deb00349c0ae7"
    "3412a55bec70a7793fc6860a193d29dd61d73c6271ffcbd4cffffffff0103000000000000001976a914"
    "96795fb99fd6c0f214f7a0e96019f642225f52d288ac00000000"
)

tx = Tx.parse_hexstr(src_tx)
print(tx)

Chronicle upgrade

Bitcoin SV Chronicle is supported in both the Rust library and Python bindings. Guide: docs/Chronicle-Python.md.

Chronicle script rules apply when tx.version > 1. Use version: 2 (or higher) on spending transactions to opt in.

Check Python API
Version-only (offline / mempool-style) Tx.validate(utxos)
Consensus at a known block height Tx.validate_at_height(utxos, block_height, network) — network is BSV_Mainnet, BSV_Testnet, or BSV_STN
Script debugger / partial eval Context(tx_version=2, lock_script=...)

See docs/Chronicle.md for sighash routing, opcodes, two-phase evaluation, malleability rules, and script number limits.

HD wallets

BIP-32 / BIP-39 / BIP-44 support via HdWallet and watch-only HdWatchWallet. Guide: docs/BIP-32-Python.md.

from tx_engine import HdWallet, bsv_coin_type

hd = HdWallet.from_mnemonic("BSV_Mainnet", "abandon abandon ... about")
print(hd.address_at_bip44(bsv_coin_type(), 0, True, 0))

Metadata

Release files for tx-engine 0.13.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tx-engine 0.13.0
File Size Uploaded
tx_engine-0.13.0.tar.gz 585.0 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for tx-engine 0.13.0
File
tx_engine-0.13.0-cp311-abi3-win_amd64.whl CPython 3.11 abi3 Windows x86-64 Details
tx_engine-0.13.0-cp311-abi3-win32.whl CPython 3.11 abi3 Windows x86-32 Details
tx_engine-0.13.0-cp311-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.11 abi3 Linux glibc 2.17+ x86-64 Details
tx_engine-0.13.0-cp311-abi3-macosx_11_0_arm64.whl CPython 3.11 abi3 macOS 11.0+ ARM64 Details
tx_engine-0.13.0-cp311-abi3-macosx_10_12_x86_64.whl CPython 3.11 abi3 macOS 10.12+ x86-64 Details

Total release size: 3.3 MB

Release files / tx_engine-0.13.0.tar.gz

Download URL tx_engine-0.13.0.tar.gz
Size 585.0 kB
Tags Source
SHA-256 checksum
How to use checksums
30cca5a7ab53ab65f367b9259994e4a5c92cd7ebfbc3497dd1daf4743843aa87
BLAKE2b-256 checksum
How to use checksums
da7e92a61c0b354c846d4a56e90ddedb5ca4385fb650f8187bd552d0267f7148
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release files / tx_engine-0.13.0-cp311-abi3-win_amd64.whl

Download URL tx_engine-0.13.0-cp311-abi3-win_amd64.whl
Size 499.9 kB
Tags CPython 3.11 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
d1702c4d7c528bff04f4497781e13512a1381d87689147ece1f6ba91474f9e26
BLAKE2b-256 checksum
How to use checksums
8e4c3743ba3926effdc517a1ee5e6179b96047ca0061aed1ca35b3fbd0939d62
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release files / tx_engine-0.13.0-cp311-abi3-win32.whl

Download URL tx_engine-0.13.0-cp311-abi3-win32.whl
Size 465.1 kB
Tags CPython 3.11 Windows x86-32 abi3
SHA-256 checksum
How to use checksums
2ec070f61003dbf395e4420d99991e98ffd21177eadc813886adbe64bdc52fcd
BLAKE2b-256 checksum
How to use checksums
2d8f170821c8d0a39ab38d9091f10966ba88cd9ca8788dc59f812652de3138ca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release files / tx_engine-0.13.0-cp311-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL tx_engine-0.13.0-cp311-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 611.3 kB
Tags CPython 3.11 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
027b07038beffaadbc75bc757053b6d6b86dc2be34366b0bc76bf97982102341
BLAKE2b-256 checksum
How to use checksums
d5dd354ded437b8f03c0316c006ea907d90cef00a45a0e908d08482c3b2715c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release files / tx_engine-0.13.0-cp311-abi3-macosx_11_0_arm64.whl

Download URL tx_engine-0.13.0-cp311-abi3-macosx_11_0_arm64.whl
Size 558.9 kB
Tags CPython 3.11 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
bab54a2201bc255aae2907e90c12a1e025d1048783ed454063882bf44ee8761f
BLAKE2b-256 checksum
How to use checksums
3920e7ccb821a4acac1b4557c56b00da5e7a109f9a916a5fe40a3bf4e2e8611a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release files / tx_engine-0.13.0-cp311-abi3-macosx_10_12_x86_64.whl

Download URL tx_engine-0.13.0-cp311-abi3-macosx_10_12_x86_64.whl
Size 595.1 kB
Tags CPython 3.11 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
f5e26a6ef1db749d7a7edad45190ab13f6a61b149e8af06314d0c9ee35cf83d5
BLAKE2b-256 checksum
How to use checksums
84ad1ccee95d83c0dae46bdc621cf244d2a1cbcf4f3f4c2d08aa7cd4de424136
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release history Release notifications | RSS feed

0.13.1

6 release files

This release

0.13.0 This release

6 release files

0.11.5

6 release files

0.11.4

6 release files

0.11.3

6 release files

0.11.2

6 release files

0.10.1

6 release files

0.10.0

6 release files

0.9.1

6 release files

0.9.0

22 release files

0.8.0

19 release files

0.7.4

19 release files

0.7.3

17 release files

0.7.2

17 release files

0.7.1

16 release files

0.7.0

16 release files

0.6.8

63 release files

0.6.7

65 release files

0.6.6

65 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page