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.12.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.12.0
File Size Uploaded
tx_engine-0.12.0.tar.gz 564.6 kB Details

Built distributions (wheels)

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

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

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

Download URL tx_engine-0.12.0-cp311-abi3-win_amd64.whl
Size 982.1 kB
Tags CPython 3.11 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
823376a8e3dd91de18952c48ad860f9454f4000abb572623919fa7305d653bf9
BLAKE2b-256 checksum
How to use checksums
539a0c7ff2beba8d82d62f9b205c2a677d32780c157e6b36505767cd848d1e33
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

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

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

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

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

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

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

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

Download URL tx_engine-0.12.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
7f2cd12fbe36fa586c60ce36729f9457c13d3ce1ce24183c78869e9d64bbf0cb
BLAKE2b-256 checksum
How to use checksums
e6f4066c1de21acb07f7e61899890424869543db2dadf488d589a20645464527
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.12.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