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

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.3
File Size Uploaded
tx_engine-0.11.3.tar.gz 514.5 kB Details

Built distributions (wheels)

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

Download URL tx_engine-0.11.3.tar.gz
Size 514.5 kB
Tags Source
SHA-256 checksum
How to use checksums
fcbc997062a43bc910fcdfcfdc2d976d8302b0ef97e349b37b9e4b9e49de1ebe
BLAKE2b-256 checksum
How to use checksums
f0aea2701acbf56729c29a6f2f518ccb0f5b84adfa4d283fb612d6e0e16a12b7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

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

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

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

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

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

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

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

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

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

Download URL tx_engine-0.11.3-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
a9baf97e8d0a03e0a97dd9cacf1df903084e8954954152b62e37c94634f06b69
BLAKE2b-256 checksum
How to use checksums
a32570be885e23393d9f94cdf83b0d4d07c91ec1098ef0890b1eb706cc5e87ff
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

This release

0.11.3 This release

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