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.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.11.0
File Size Uploaded
tx_engine-0.11.0.tar.gz 500.2 kB Details

Built distributions (wheels)

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

Download URL tx_engine-0.11.0.tar.gz
Size 500.2 kB
Tags Source
SHA-256 checksum
How to use checksums
e2e4e37ef136376ee7e07ebf4df0b0d595ec2a1d27f1c597b3fcc1baa56c32bb
BLAKE2b-256 checksum
How to use checksums
178ddd8488a75afe28d2dbea645c97d2f2781abe27d9081944166af5238650c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

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

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

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

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

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

Download URL tx_engine-0.11.0-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
7ec5d43ae0b2e1953aa8208bd69ada065adad0f7ef76205a80fbe95454a1e132
BLAKE2b-256 checksum
How to use checksums
33aafa9e25ce5aef910de0596f63615009d97c2555866efdd16fbeff1fc7b343
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

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

Download URL tx_engine-0.11.0-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
f2c0a4fb3a1d6e7eadb3729de55f9f3ec580a132e190a720d6d110bbd88d26ed
BLAKE2b-256 checksum
How to use checksums
5e8f347a32d457e62dd9b42f90038060636689b31b554a404024a199191ae75c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

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

Download URL tx_engine-0.11.0-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
77b18bb6ae5ca0d1c313d8d8f1c2026307b2d9262ff6a56edea9cec490b316bd
BLAKE2b-256 checksum
How to use checksums
0b0986712a00f4a354c52082466a8b0919d79151c3f06d890a01652aad3bf015
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

0.11.2

6 release files

This release

0.11.0 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