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

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.1
File Size Uploaded
tx_engine-0.13.1.tar.gz 585.5 kB Details

Built distributions (wheels)

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

Download URL tx_engine-0.13.1.tar.gz
Size 585.5 kB
Tags Source
SHA-256 checksum
How to use checksums
d45524a17491b0c88d00aa92a2fc42c9edd3b57abc2b9717805135f7ade908a3
BLAKE2b-256 checksum
How to use checksums
53d6748ceaeb6ccb89b6aee4ebe3a3aa8ce76120a56e98c74729be43b106da59
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

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

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

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

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

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

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

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

Download URL tx_engine-0.13.1-cp311-abi3-macosx_11_0_arm64.whl
Size 561.1 kB
Tags CPython 3.11 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
2ed40fb3b2c799660350fefd567ccb19559e1facf2c0df57fcad553e57c59840
BLAKE2b-256 checksum
How to use checksums
81f783feb3915ed285db855189638fff2ef29ca691c1c60479866c2bf833cc62
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

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

Download URL tx_engine-0.13.1-cp311-abi3-macosx_10_12_x86_64.whl
Size 603.8 kB
Tags CPython 3.11 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
5eebff7dd25b10b7d5aa01c0e54c6a3554fa189c0dae563aaa8ecf0eed3feb75
BLAKE2b-256 checksum
How to use checksums
0b9982df53903cc675eda6f8650259eb2e9d04520dc1d9c0442ab336079c2e09
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.15.0

Release history Release notifications | RSS feed

This release

0.13.1 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