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.11.2

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.11.2
File Size Uploaded
tx_engine-0.11.2.tar.gz 508.6 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for tx-engine 0.11.2
File
tx_engine-0.11.2-cp311-abi3-win_amd64.whl CPython 3.11 abi3 Windows x86-64 Details
tx_engine-0.11.2-cp311-abi3-win32.whl CPython 3.11 abi3 Windows x86-32 Details
tx_engine-0.11.2-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.11.2-cp311-abi3-macosx_11_0_arm64.whl CPython 3.11 abi3 macOS 11.0+ ARM64 Details
tx_engine-0.11.2-cp311-abi3-macosx_10_12_x86_64.whl CPython 3.11 abi3 macOS 10.12+ x86-64 Details

Total release size: 5.6 MB

Release files / tx_engine-0.11.2.tar.gz

Download URL tx_engine-0.11.2.tar.gz
Size 508.6 kB
Tags Source
SHA-256 checksum
How to use checksums
7c0489fcf8017593de6ac13244b6cfa92c27f607a2cd98379ca99197365e6ad9
BLAKE2b-256 checksum
How to use checksums
acc10b61b888fcdf783d3e6d5a59e796b7a0d90c540972bdbeb03b38f5061f0f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

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

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

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

Download URL tx_engine-0.11.2-cp311-abi3-win32.whl
Size 891.6 kB
Tags CPython 3.11 Windows x86-32 abi3
SHA-256 checksum
How to use checksums
0462ef6471352c812eaa767eb785e94807ab4a8b8866771a51e3329d32f053e3
BLAKE2b-256 checksum
How to use checksums
40e6113d902eb4bd0f0263fda0c75fbd167d7a24d5bb0b2f7d3a80022f35a703
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

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

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

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

Download URL tx_engine-0.11.2-cp311-abi3-macosx_11_0_arm64.whl
Size 1.0 MB
Tags CPython 3.11 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
d176f614ff6fa311b2497d99e0f63bd02e9542b459ffcdd2e54eaea08c045867
BLAKE2b-256 checksum
How to use checksums
a049974b432257ae0dcf3ea3cdbf5799426d3957369d07482c14afebedbd3392
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

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

Download URL tx_engine-0.11.2-cp311-abi3-macosx_10_12_x86_64.whl
Size 1.1 MB
Tags CPython 3.11 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
0f870f66f22454b0cb81b31206c79fc0fad3b564c90eb889b8242c94b8d6d74c
BLAKE2b-256 checksum
How to use checksums
602984c3f80715ed582fb84bd3e5222a68efcac9aaf7b386fa9520f94314a7fa
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

0.11.5

6 release files

0.11.4

6 release files

0.11.3

6 release files

This release

0.11.2 This release

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