tx-engine 0.6.6__tar.gz → 0.6.7__tar.gz

tx_engine-0.6.7/.github/workflows/on_push.yml

@@ -0,0 +1,65 @@
+name: On Push
+on: [push]
+permissions:
+  contents: read
+
+jobs:
+  python-lint:
+    name: Lint Python
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout branch code
+        uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+      - name: Lint Python
+        working-directory: python
+        run: |
+          pip install mypy flake8 types-requests --root-user-action=ignore
+          flake8 --ignore=E501,E131,E402,E722 src ../tools
+          mypy --check-untyped-defs --ignore-missing-imports src ../tools 
+
+  rust-test:
+    name: Rust Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout branch code
+        uses: actions/checkout@v4
+      - name: Install Rust 
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+          cache: true
+      - name: Rust Tests
+        run: cargo test --all-features
+
+  python-test:
+    name: Python Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout branch code
+        uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+      - name: Install Rust 
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+          cache: true
+      - name: Clear wheel dir
+        run: rm target/wheels/* | true
+      - name: Maturin build
+        uses: PyO3/maturin-action@v1
+        with:
+          command: build --target-dir=target
+      - name: Install wheel
+        run: pip install --root-user-action=ignore --find-links=target/wheels tx-engine
+      - name: Python tests
+        working-directory: python
+        run: ./tests.sh

{tx_engine-0.6.6 → tx_engine-0.6.7}/Cargo.lock

@@ -28,9 +28,9 @@ dependencies = [
 
 [[package]]
 name = "anyhow"
-version = "1.0.87"
+version = "1.0.89"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "10f00e1f6e58a40e807377c75c6a7f97bf9044fab57816f2414e6f5f4499d7b8"
+checksum = "86fdf8605db99b54d3cd748a44c6d04df638eb5dafb219b135d0149bd0db01f6"
 
 [[package]]
 name = "async-mutex"
@@ -132,15 +132,15 @@ checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b"
 
 [[package]]
 name = "bytes"
-version = "1.7.1"
+version = "1.7.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8318a53db07bb3f8dca91a600466bdb3f2eaadeedfdbcf02e1accbad9271ba50"
+checksum = "428d9aa8fbc0670b7b8d6030a7fadd0f86151cae55e4dbbece15f3780a3dfaf3"
 
 [[package]]
 name = "cc"
-version = "1.1.18"
+version = "1.1.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b62ac837cdb5cb22e10a256099b4fc502b1dfe560cb282963a974d7abd80e476"
+checksum = "07b1695e2c7e8fc85310cde85aeaab7e3097f593c91d209d3f9df76c928100f0"
 dependencies = [
  "shlex",
 ]
@@ -153,7 +153,7 @@ checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
 
 [[package]]
 name = "chain-gang"
-version = "0.6.6"
+version = "0.6.7"
 dependencies = [
  "anyhow",
  "async-mutex",
@@ -171,6 +171,7 @@ dependencies = [
  "murmur3",
  "num-bigint",
  "num-traits",
+ "pbkdf2",
  "pyo3",
  "rand",
  "rand_core",
@@ -182,6 +183,7 @@ dependencies = [
  "sha1",
  "sha2",
  "snowflake",
+ "typenum",
 ]
 
 [[package]]
@@ -637,9 +639,9 @@ dependencies = [
 
 [[package]]
 name = "k256"
-version = "0.13.3"
+version = "0.13.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "956ff9b67e26e1a6a866cb758f12c6f8746208489e3e4a4b5580802f2f0a587b"
+checksum = "f6e3919bbaa2945715f0bb6d3934a173d1e9a59ac23767fbaaef277265a7411b"
 dependencies = [
  "cfg-if",
  "ecdsa",
@@ -864,6 +866,16 @@ dependencies = [
  "windows-targets 0.52.6",
 ]
 
+[[package]]
+name = "pbkdf2"
+version = "0.12.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f8ed6a7761f76e3b9f92dfb0a60a6a6477c61024b775147ff0973a02653abaf2"
+dependencies = [
+ "digest",
+ "hmac",
+]
+
 [[package]]
 name = "percent-encoding"
 version = "2.3.1"
@@ -894,15 +906,15 @@ dependencies = [
 
 [[package]]
 name = "pkg-config"
-version = "0.3.30"
+version = "0.3.31"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d231b230927b5e4ad203db57bbcbee2802f6bce620b1e4a9024a07d94e2907ec"
+checksum = "953ec861398dccce10c670dfeaf3ec4911ca479e9c02154b3a215178c5f566f2"
 
 [[package]]
 name = "portable-atomic"
-version = "1.7.0"
+version = "1.8.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "da544ee218f0d287a911e9c99a39a8c9bc8fcad3cb8db5959940044ecfc67265"
+checksum = "d30538d42559de6b034bc76fd6dd4c38961b1ee5c6c56e3808c50128fdbc22ce"
 
 [[package]]
 name = "ppv-lite86"
@@ -1026,9 +1038,9 @@ dependencies = [
 
 [[package]]
 name = "redox_syscall"
-version = "0.5.3"
+version = "0.5.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2a908a6e00f1fdd0dfd9c0eb08ce85126f6d8bbda50017e74bc4a4b7d4a926a4"
+checksum = "0884ad60e090bf1345b93da0a5de8923c93884cd03f40dfcfddd3b4bee661853"
 dependencies = [
  "bitflags 2.6.0",
 ]
@@ -1129,9 +1141,9 @@ checksum = "719b953e2095829ee67db738b3bfa9fa368c94900df327b3f07fe6e794d2fe1f"
 
 [[package]]
 name = "rustix"
-version = "0.38.36"
+version = "0.38.37"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3f55e80d50763938498dd5ebb18647174e0c76dc38c5505294bb224624f30f36"
+checksum = "8acb788b847c24f28525660c4d7758620a7210875711f79e7f663cc152726811"
 dependencies = [
  "bitflags 2.6.0",
  "errno",
@@ -1199,9 +1211,9 @@ dependencies = [
 
 [[package]]
 name = "security-framework-sys"
-version = "2.11.1"
+version = "2.12.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "75da29fe9b9b08fe9d6b22b5b4bcbc75d8db3aa31e639aa56bb62e9d46bfceaf"
+checksum = "ea4a292869320c0272d7bc55a5a6aafaff59b4f63404a003887b679a2e05b4b6"
 dependencies = [
  "core-foundation-sys",
  "libc",
@@ -1491,15 +1503,15 @@ checksum = "08f95100a766bf4f8f28f90d77e0a5461bbdb219042e7679bebe79004fed8d75"
 
 [[package]]
 name = "unicode-ident"
-version = "1.0.12"
+version = "1.0.13"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
+checksum = "e91b56cd4cadaeb79bbf1a5645f6b4f8dc5bde8834ad5894a8db35fda9efa1fe"
 
 [[package]]
 name = "unicode-normalization"
-version = "0.1.23"
+version = "0.1.24"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a56d1686db2308d901306f92a263857ef59ea39678a5458e7cb17f01415101f5"
+checksum = "5033c97c4262335cded6d6fc3e5c18ab755e1a3dc96376350f3d8e9f009ad956"
 dependencies = [
  "tinyvec",
 ]

{tx_engine-0.6.6 → tx_engine-0.6.7}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "chain-gang"
-version = "0.6.6"
+version = "0.6.7"
 description = "This is a library that enables monitoring of multiple blockchains (BTC, BCH, BSV)."
 # repository = "https://github.com/brentongunning/rust-sv"
 authors = ["Arthur Gordon <a.gordon@nchain.com>"]
@@ -27,9 +27,9 @@ sha2 = "0.10.8"
 k256 = { version = "0.13.3", features = ["alloc", "arithmetic", "digest", "ecdsa", "once_cell", "pkcs8", "precomputed-tables", "schnorr",
     "sha2", "sha256", "signature", "std"]}
 snowflake = "1.3"
-
 hmac = "0.12.1"
 base58 = "0.2.0"
+pbkdf2 = "0.12.2"
 
 # Used by the interface feature
 serde = { version = "1.0.86", features = ["derive"], optional = true }
@@ -44,6 +44,7 @@ pyo3 = { version = "0.21.2", optional = true }
 regex = "1.10.5"
 lazy_static = "1.5.0"
 rand_core = "0.6.4"
+typenum = "1.17" 
 
 
 [lib]

tx_engine-0.6.7/PKG-INFO

@@ -0,0 +1,287 @@
+Metadata-Version: 2.3
+Name: tx_engine
+Version: 0.6.7
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Dist: requests ==2.32.3
+Requires-Dist: python-bitcoinrpc ==1.0
+Requires-Dist: cryptography ==43.0.1
+License-File: LICENSE
+License-File: LICENSE-rust-sv
+Summary: This library provides a Python interface for building BitcoinSV scripts and transactions.
+Keywords: bitcoin,sv,cash,crypto
+Author: Arthur Gordon <a.gordon@nchain.com>
+Author-email: Arthur Gordon <a.gordon@nchain.com>
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# TX Engine
+
+This library provides a Python interface for building BitcoinSV scripts and transactions.
+
+For documentation of the Python Classes see below.
+
+# Python Installation
+As this library is hosted on PyPi (https://pypi.org/project/tx-engine/) and is installed using:
+
+```bash
+pip install tx-engine
+```
+
+## Example Tx class usage
+So to parse a hex string to Tx:
+
+```python
+from tx_engine import Tx
+
+src_tx = "0100000001c7151ebaf14dbfe922bd90700a7580f6db7d5a1b898ce79cb9ce459e17f12909000000006b4830450221008b001e8d8110804ac66e467cd2452f468cba4a2a1d90d59679fe5075d24e5f5302206eb04e79214c09913fad1e3c0c2498be7f457ed63323ac6f2d9a38d53586a58d41210395deb00349c0ae73412a55bec70a7793fc6860a193d29dd61d73c6271ffcbd4cffffffff0103000000000000001976a91496795fb99fd6c0f214f7a0e96019f642225f52d288ac00000000"
+
+tx = tx.parse_hexstr(src_tx)
+print(tx)
+
+> PyTx { version: 1, tx_ins: [PyTxIn { prev_tx: "0929f1179e45ceb99ce78c891b5a7ddbf680750a7090bd22e9bf4df1ba1e15c7", prev_index: 0, sequence: 4294967295, script_sig: [0x48 0x30450221008b001e8d8110804ac66e467cd2452f468cba4a2a1d90d59679fe5075d24e5f5302206eb04e79214c09913fad1e3c0c2498be7f457ed63323ac6f2d9a38d53586a58d41 0x21 0x0395deb00349c0ae73412a55bec70a7793fc6860a193d29dd61d73c6271ffcbd4c] }], tx_outs: [PyTxOut { amount: 3, script_pubkey: [OP_DUP OP_HASH160 0x14 0x96795fb99fd6c0f214f7a0e96019f642225f52d2 OP_EQUALVERIFY OP_CHECKSIG] }], locktime: 0 }
+```
+
+
+# Overview of the tx-engine Classes
+The tx-engine provides the following classes:
+
+![tx-engine classes](docs/diagrams/python_classes.png)
+
+# Python Classes
+
+This provides an overview of the Python Classes their properties and methods, 
+including:
+
+* [Script](#script)
+* [Context](#context)
+* [Tx](#tx)
+* [TxIn](#txin)
+* [TxOut](#txout)
+* [Wallet](#wallet)
+* [Interface Factory](#interface-factory)
+* [Blockchain Interface](#blockchain-interface)
+* [Other Functions](#other-functions)
+
+## Script
+
+The Script class represents bitcoin script.
+For more details about bitcoin script see https://wiki.bitcoinsv.io/index.php/Script.
+
+Script has the following property:
+* `cmds` - byte arrary of bitcoin operations
+
+Script has the following methods:
+
+* `__init__(self, cmds: bytes=[]) -> Script` - Constructor that takes an array of bytes 
+* `append_byte(self, byte: byte)` - Appends a single opcode or data byte
+* `append_data(self, data: bytes)` - Appends data (without OP_PUSHDATA)
+* `append_pushdata(self, data: bytes)` - Appends the opcodes and provided data that push it onto the stack
+* `raw_serialize(self) -> bytes` - Return the serialised script without the length prepended
+* `serialize(self) -> bytes` - Return the serialised script with the length prepended
+*  `get_commands(self) -> bytes` - Return a copy of the commands in this script
+* `__add__(self, other: Script) -> Script` - Enable script addition e.g. `c_script = a_script + b_script`
+* `to_string(self) -> String` - return the script as a string, that can be parsed by `parse_string()`. Note also that you can just print the script (`print(script)`)
+* `is_p2pkh(self) -> bool` - returns True if script is a Pay to Public Key Hash script
+
+
+Script has the following class methods:
+* `Script.parse_string(in_string: str) -> Script` - Converts a string of OP_CODES into a Script
+* `Script.parse(in_bytes: bytes) -> Script` - Converts an array of bytes into a Script
+
+
+## Context
+
+The `context` is the environment in which bitcoin scripts are executed.
+
+Context has the following properties:
+* `cmds` - the commands to execute
+* `ip_limit` - the number of commands to execute before stopping (optional)
+* z - 
+* `stack` - main data stack
+* `alt_stack` - seconary stack
+* `raw_stack` - which contains the `stack` prior to converting to numbers
+* `raw_alt_stack` - as above for the `alt_stack`
+
+Context has the following methods:
+
+* `__init__(self, script: Script, cmds: Commands = None, ip_limit: int , z: bytes)` - constructor
+* `evaluate_core(self, quiet: bool = False) -> bool` - evaluates the script/cmds using the the interpreter and returns the stacks (`raw_stack`, `raw_alt_stack`). if quiet is true, dont print exceptions
+* `evaluate(self, quiet: bool = False) -> bool` - executes the script and decode stack elements to numbers (`stack`, `alt_stack`). Checks `stack` is true on return. if quiet is true, dont print exceptions.
+* `get_stack(self) -> Stack` - Return the `stack` as human readable
+* `get_altstack(self) -> Stack`-  Return the `alt_stack` as human readable
+
+Example from unit tests of using `evaluate_core` and `raw_stack`:
+```python
+script = Script([OP_PUSHDATA1, 0x02, b"\x01\x02"])
+context = Context(script=script)
+self.assertTrue(context.evaluate_core())
+self.assertEqual(context.raw_stack, [[1, 2]])
+```
+
+### Quiet Evalutation
+ Both `evaluate` and `evaluate_core` have a parameter `quiet`.
+ If the `quiet` parameter is set to `True` the `evaluate` function does not print out exceptions when executing code.  This `quiet` parameter is currently only used in unit tests.
+
+
+## Tx
+
+Tx represents a bitcoin transaction.
+
+Tx has the following properties:
+* `version` - unsigned integer
+* `tx_ins` - array of `TxIn` classes,
+* `tx_outs` - array of `TxOut` classes
+* `locktime` - unsigned integer
+
+Tx has the following methods:
+
+* `__init__(version: int, tx_ins: [TxIn], tx_outs: [TxOut], locktime: int=0) -> Tx` - Constructor that takes the fields 
+* `id(self) -> str` - Return human-readable hexadecimal of the transaction hash
+* `hash(self) -> bytes` - Return transaction hash as bytes
+* `is_coinbase(self) -> bool` - Returns true if it is a coinbase transaction
+* `serialize(self) -> bytes` - Returns Tx as bytes
+* `copy(self) -> Tx` - Returns a copy of the Tx
+* `to_string(self) -> String` - return the Tx as a string. Note also that you can just print the tx (`print(tx)`).
+* `validate(self, [Tx]) -> Result` - provide the input txs, returns None on success and throws a RuntimeError exception on failure. Note can not validate coinbase or pre-genesis transactions.
+
+    
+Tx has the following class methods:
+
+* `Tx.parse(in_bytes: bytes) -> Tx`  - Parse bytes to produce Tx
+* `Tx.parse_hexstr(in_hexstr: String) -> Tx`  - Parse hex string to produce Tx
+
+So to parse a hex string to Tx:
+```Python
+from tx_engine import Tx
+
+src_tx = "0100000001c7151ebaf14dbfe922bd90700a7580f6db7d5a1b898ce79cb9ce459e17f12909000000006b4830450221008b001e8d8110804ac66e467cd2452f468cba4a2a1d90d59679fe5075d24e5f5302206eb04e79214c09913fad1e3c0c2498be7f457ed63323ac6f2d9a38d53586a58d41210395deb00349c0ae73412a55bec70a7793fc6860a193d29dd61d73c6271ffcbd4cffffffff0103000000000000001976a91496795fb99fd6c0f214f7a0e96019f642225f52d288ac00000000"
+
+tx = tx.parse_hexstr(src_tx)
+print(tx)
+
+PyTx { version: 1, tx_ins: [PyTxIn { prev_tx: "0929f1179e45ceb99ce78c891b5a7ddbf680750a7090bd22e9bf4df1ba1e15c7", prev_index: 0, sequence: 4294967295, script_sig: [0x48 0x30450221008b001e8d8110804ac66e467cd2452f468cba4a2a1d90d59679fe5075d24e5f5302206eb04e79214c09913fad1e3c0c2498be7f457ed63323ac6f2d9a38d53586a58d41 0x21 0x0395deb00349c0ae73412a55bec70a7793fc6860a193d29dd61d73c6271ffcbd4c] }], tx_outs: [PyTxOut { amount: 3, script_pubkey: [OP_DUP OP_HASH160 0x14 0x96795fb99fd6c0f214f7a0e96019f642225f52d2 OP_EQUALVERIFY OP_CHECKSIG] }], locktime: 0 }
+```
+
+
+## TxIn
+TxIn represents is a bitcoin transaction input.
+
+TxIn has the following properties:
+
+* `prev_tx` - Transaction Id as hex string
+* `prev_index` - unsigned int
+* `script_sig` - Script
+* `sequence` -  int
+
+TxIn has the following constructor method:
+* `__init__(prev_tx: String, prev_index: int, script_sig: Script=[], sequence: int=0xFFFFFFFF) -> TxIn` - Constructor that takes the fields 
+
+Note txin can be printed using the standard print, for example: 
+```Python
+print(txin)
+PyTxIn { prev_tx: "5c866b70189008586a4951d144df93dcca4d3a1b701e3786566f819450eca9ba", prev_index: 0, sequence: 4294967295, script_sig: [] }
+```
+
+
+## TxOut
+TxOut represents a bitcoin transaction output.
+
+TxOut has the following properties:
+
+* `amount` - int
+* `script_pubkey` - Script
+
+
+TxOut has the following constructor method:
+
+* `__init__(amount: int, script_pubkey: Script) -> TxOut` - Constructor that takes the fields 
+
+Note txin can be printed using the standard print, for example: 
+```Python
+print(txout)
+PyTxOut { amount: 100, script_pubkey: [OP_DUP OP_HASH160 0x14 0x10375cfe32b917cd24ca1038f824cd00f7391859 OP_EQUALVERIFY OP_CHECKSIG] }
+```
+
+## Wallet
+This class represents the Wallet functionality, including handling of private and public keys and signing transactions.
+
+Wallet class has the following methods:
+
+* `__init__(wif_key: str) -> Wallet` - Constructor that takes a private key in WIF format
+* `sign_tx(self, index: int, input_tx: Tx, tx: Tx) -> Tx` - Sign a transaction input with the provided previous tx and sighash flags, Returns new signed tx
+* `sign_tx_sighash(self, index: int, input_tx: Tx, tx: Tx, sighash_type: int) -> Tx` - Sign a transaction input with the provided previous tx and sighash flags, Returns new signed tx
+* `get_locking_script(self) -> Script` - Returns a locking script based on the public key
+* `get_public_key_as_hexstr(self) -> String` - Return the public key as a hex string
+* `get_address(self) -> String` - Return the address based on the public key
+* `to_wif(self) -> String` - Return the private key in WIF format
+* `get_network(self) -> String` - Returns the current network associated with this keypair
+* `to_int(self) -> Integer` - Returns the scaler value of the private key as a python integer
+* `to_hex(self) -> String` - Returns the scaler value of the private key as a string in hex format
+
+* `Wallet.generate_keypair(network) -> Wallet` - Given network (BSV_Testnet) return a keypair in Wallet format
+* `Wallet.from_hexstr(network, hexstr) -> Wallet` - Given a network identifier and scalar value as a hex string, return a keypair in Wallet format
+* `Wallet.from_bytes(network, bytes) -> Wallet` - Given a network identifier and a scalar value as a byte array, return a keypair in Wallet format
+* `Wallet.from_int(network, integer) -> Wallet` - Given a network identifier and a scaler value as an integer, return a keypair in Wallet format
+
+The library provides some additional helper functions to handle keys in different formats. 
+* `wif_to_bytes(wif: string) -> bytes` - Given a key in WIF format, it returns a byte array of the scalar value of the private key
+* `bytes_to_wif(key_bytes, network) -> String` - Given a byte array and a network identifier, returns the WIF format for the private key
+* `wif_from_pw_nonce(password, nonce, optional<network>) -> WIF` - Given a password, nonce (strings) return a WIF format for the private key. The default for the network is BSV_Mainnet. For a testnet format, please use BSv_Testnet
+
+
+![Bitcoin Keys](docs/diagrams/keys.png)
+
+
+## Interface Factory
+The InterfaceFactory is class for creating interfaces to the BSV blockchain (`BlockchainInterface`).
+
+The InterfaceFactory class one method:
+
+* `set_config(self, config: ConfigType) -> BlockchainInterface` - This reads the configuration `interface_type` field and returns the configured `BlockchainInterface`
+
+## Blockchain Interface
+
+The BlockchainInterface class provides an interface to the BSV network.
+
+BlockchainInterface class has the following methods:
+
+* `__init__(self)` - Constructor that takes no parameters
+* `set_config(self, config)` - configures the interface based on the provide config
+* `get_addr_history(self, address)` - Return the transaction history with this address
+* `is_testnet(self) -> bool` - Return true if this interface is connected to BSV Testnet
+* `get_utxo(self, address)` - Return the utxo associated with this address
+* `get_balance(self, address)` - Return the balance associated with this address
+* `get_block_count(self)` - Return the height of the chain
+* `get_best_block_hash(self)` - Return the hash of the latest block
+* `get_merkle_proof(self, block_hash: str, tx_id: str) -> str` - Given the block hash and tx_id return the merkle proof
+* `get_transaction(self, txid: str)` - Return the transaction (as Dictionary) associated with this txid
+* `get_raw_transaction(self, txid: str) -> Optional[str]` - Return the transaction (as kexstring) associated with this txid, use cached copy if available.
+* `broadcast_tx(self, transaction: str)` - broadcast this tx to the network
+* `get_block(self, blockhash: str) -> Dict` - Return the block given the block hash
+* `get_block_header(self, blockhash: str) -> Dict` - Returns te block_header for a given block hash
+
+### WoC Interface
+The `WoCInterface` is a `BlockchainInterface` that communicates with the WhatsOnChain API. 
+Note that if you are using this you will need to install the python library `requests`.
+
+### Mock Interface 
+The `Mock Interface` is a `BlockchainInterface` that is used for unit testing.
+
+### RPC Interface 
+The `RPC Interface` is a `BlockchainInterface` that is used for connecting to the RPC interface of mining nodes.
+
+
+# Other Functions
+These are public key and address functions that are likely to be used if you don't have the private key and 
+are not using the Wallet class.
+
+* `address_to_public_key_hash(address: str) -> bytes` - Given the address return the hash160 of the public key
+* `hash160(data: bytes) -> bytes` - Returns the hash160 of the provided data (usually the public key)
+* `p2pkh_script(h160: bytes) -> Script` - Takes the hash160 of the public key and returns the locking script
+* `public_key_to_address(public_key: bytes, network: str) -> String` - Given the public key and the network (either `BSV_Mainnet` or `BSV_Testnet`) return the address
+
+
+

tx_engine-0.6.6/docs/PythonClasses.md → tx_engine-0.6.7/README.md

@@ -1,3 +1,36 @@
+# TX Engine
+
+This library provides a Python interface for building BitcoinSV scripts and transactions.
+
+For documentation of the Python Classes see below.
+
+# Python Installation
+As this library is hosted on PyPi (https://pypi.org/project/tx-engine/) and is installed using:
+
+```bash
+pip install tx-engine
+```
+
+## Example Tx class usage
+So to parse a hex string to Tx:
+
+```python
+from tx_engine import Tx
+
+src_tx = "0100000001c7151ebaf14dbfe922bd90700a7580f6db7d5a1b898ce79cb9ce459e17f12909000000006b4830450221008b001e8d8110804ac66e467cd2452f468cba4a2a1d90d59679fe5075d24e5f5302206eb04e79214c09913fad1e3c0c2498be7f457ed63323ac6f2d9a38d53586a58d41210395deb00349c0ae73412a55bec70a7793fc6860a193d29dd61d73c6271ffcbd4cffffffff0103000000000000001976a91496795fb99fd6c0f214f7a0e96019f642225f52d288ac00000000"
+
+tx = tx.parse_hexstr(src_tx)
+print(tx)
+
+> PyTx { version: 1, tx_ins: [PyTxIn { prev_tx: "0929f1179e45ceb99ce78c891b5a7ddbf680750a7090bd22e9bf4df1ba1e15c7", prev_index: 0, sequence: 4294967295, script_sig: [0x48 0x30450221008b001e8d8110804ac66e467cd2452f468cba4a2a1d90d59679fe5075d24e5f5302206eb04e79214c09913fad1e3c0c2498be7f457ed63323ac6f2d9a38d53586a58d41 0x21 0x0395deb00349c0ae73412a55bec70a7793fc6860a193d29dd61d73c6271ffcbd4c] }], tx_outs: [PyTxOut { amount: 3, script_pubkey: [OP_DUP OP_HASH160 0x14 0x96795fb99fd6c0f214f7a0e96019f642225f52d2 OP_EQUALVERIFY OP_CHECKSIG] }], locktime: 0 }
+```
+
+
+# Overview of the tx-engine Classes
+The tx-engine provides the following classes:
+
+![tx-engine classes](docs/diagrams/python_classes.png)
+
 # Python Classes
 
 This provides an overview of the Python Classes their properties and methods, 
@@ -165,7 +198,23 @@ Wallet class has the following methods:
 * `get_public_key_as_hexstr(self) -> String` - Return the public key as a hex string
 * `get_address(self) -> String` - Return the address based on the public key
 * `to_wif(self) -> String` - Return the private key in WIF format
+* `get_network(self) -> String` - Returns the current network associated with this keypair
+* `to_int(self) -> Integer` - Returns the scaler value of the private key as a python integer
+* `to_hex(self) -> String` - Returns the scaler value of the private key as a string in hex format
+
 * `Wallet.generate_keypair(network) -> Wallet` - Given network (BSV_Testnet) return a keypair in Wallet format
+* `Wallet.from_hexstr(network, hexstr) -> Wallet` - Given a network identifier and scalar value as a hex string, return a keypair in Wallet format
+* `Wallet.from_bytes(network, bytes) -> Wallet` - Given a network identifier and a scalar value as a byte array, return a keypair in Wallet format
+* `Wallet.from_int(network, integer) -> Wallet` - Given a network identifier and a scaler value as an integer, return a keypair in Wallet format
+
+The library provides some additional helper functions to handle keys in different formats. 
+* `wif_to_bytes(wif: string) -> bytes` - Given a key in WIF format, it returns a byte array of the scalar value of the private key
+* `bytes_to_wif(key_bytes, network) -> String` - Given a byte array and a network identifier, returns the WIF format for the private key
+* `wif_from_pw_nonce(password, nonce, optional<network>) -> WIF` - Given a password, nonce (strings) return a WIF format for the private key. The default for the network is BSV_Mainnet. For a testnet format, please use BSv_Testnet
+
+
+![Bitcoin Keys](docs/diagrams/keys.png)
+
 
 ## Interface Factory
 The InterfaceFactory is class for creating interfaces to the BSV blockchain (`BlockchainInterface`).
@@ -199,13 +248,12 @@ BlockchainInterface class has the following methods:
 The `WoCInterface` is a `BlockchainInterface` that communicates with the WhatsOnChain API. 
 Note that if you are using this you will need to install the python library `requests`.
 
-```bash
-pip3 install requests 
-```
-
 ### Mock Interface 
 The `Mock Interface` is a `BlockchainInterface` that is used for unit testing.
 
+### RPC Interface 
+The `RPC Interface` is a `BlockchainInterface` that is used for connecting to the RPC interface of mining nodes.
+
 
 # Other Functions
 These are public key and address functions that are likely to be used if you don't have the private key and 
@@ -217,4 +265,3 @@ are not using the Wallet class.
 * `public_key_to_address(public_key: bytes, network: str) -> String` - Given the public key and the network (either `BSV_Mainnet` or `BSV_Testnet`) return the address
 
 
-![Bitcoin Keys](diagrams/keys.png)

{tx_engine-0.6.6 → tx_engine-0.6.7}/docs/Releases.md

@@ -34,4 +34,5 @@
 * v0.6.3 - Added Tx.parse_hexstr - broken!
 * v0.6.4 - Added Tx.parse_hexstr
 * v0.6.5 - wif_to_bytes wallet function added TxIn to Output function added, minor version bump
-* v0.6.6 - wif_to_bytes wallet function added TxIn to Output function added, minor version bump (forgot to bump the version in cargo.toml)
+* v0.6.6 - wif_to_bytes wallet function added TxIn to Output function added, minor version bump (forgot to bump the version in cargo.toml)
+* v0.6.7 - additional wallet functions added to support WildBits