tx-engine 0.11.2__tar.gz → 0.11.3__tar.gz

{tx_engine-0.11.2 → tx_engine-0.11.3}/.github/workflows/CI.yml

@@ -47,8 +47,8 @@ jobs:
           #- runner: ubuntu-latest
           #  target: ppc64le
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
         with:
           python-version: '3.11'
       - name: Build wheels
@@ -59,7 +59,7 @@ jobs:
           sccache: 'true'
           manylinux: auto
       - name: Upload wheels
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: wheels-linux-${{ matrix.platform.target }}
           path: dist
@@ -75,8 +75,8 @@ jobs:
           - runner: windows-latest
             target: x86
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
         with:
           python-version: '3.11'
           architecture: ${{ matrix.platform.target }}
@@ -87,7 +87,7 @@ jobs:
           args: --release --out dist --interpreter 3.11
           sccache: 'true'
       - name: Upload wheels
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: wheels-windows-${{ matrix.platform.target }}
           path: dist
@@ -103,8 +103,8 @@ jobs:
           - runner: macos-14
             target: aarch64
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
         with:
           python-version: '3.11'
       - name: Build wheels
@@ -114,7 +114,7 @@ jobs:
           args: --release --out dist --interpreter 3.11
           sccache: 'true'
       - name: Upload wheels
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: wheels-macos-${{ matrix.platform.target }}
           path: dist
@@ -123,14 +123,14 @@ jobs:
     runs-on: ubuntu-latest
     if: "startsWith(github.ref, 'refs/tags/')"
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
       - name: Build sdist
         uses: PyO3/maturin-action@v1
         with:
           command: sdist
           args: --out dist
       - name: Upload sdist
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: wheels-sdist
           path: dist
@@ -141,7 +141,7 @@ jobs:
     if: "startsWith(github.ref, 'refs/tags/')"
     needs: [linux, windows, macos, sdist]
     steps:
-      - uses: actions/download-artifact@v4
+      - uses: actions/download-artifact@v8
       - name: Publish to PyPI
         uses: PyO3/maturin-action@v1
         env:
@@ -155,7 +155,7 @@ jobs:
     runs-on: ubuntu-latest
     if: "startsWith(github.ref, 'refs/tags/')"
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
       - name: Install Rust
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:

{tx_engine-0.11.2 → tx_engine-0.11.3}/.github/workflows/on_push.yml

@@ -13,9 +13,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout branch code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
       - name: Install Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v7
         with:
           python-version: '3.12'
           cache: 'pip'
@@ -31,7 +31,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout branch code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
       - name: Install Rust 
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
@@ -45,7 +45,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout branch code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
       - name: Install Rust
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
@@ -75,7 +75,7 @@ jobs:
             args: "--no-default-features"
     steps:
       - name: Checkout branch code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
       - name: Install Rust
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
@@ -93,9 +93,9 @@ jobs:
         python-version: ['3.11', '3.12', '3.13', '3.14']
     steps:
       - name: Checkout branch code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
       - name: Install Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v7
         with:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'

{tx_engine-0.11.2 → tx_engine-0.11.3}/Cargo.lock

@@ -30,7 +30,7 @@ checksum = "82f6aeea286b8eb4dd3431a1be1b59d290ace00f5bfd8e2a159bc2a05e2c1667"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 3.0.5",
+ "syn 3.0.6",
 ]
 
 [[package]]
@@ -136,9 +136,9 @@ checksum = "fc652a48c352aef3ea3aed32080501cf3ef6ed5da78602a020c991775b0aff04"
 
 [[package]]
 name = "cc"
-version = "1.4.6"
+version = "1.4.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a3eb0f42d6c360dc3f8a821f6bf2fdea7f72bfd36b3076eb0e6d1e9e0752fff4"
+checksum = "54413ede23c2daf518f35156dfde027feb2374004d63bd497f983c8db9c0e313"
 dependencies = [
  "find-msvc-tools",
  "jobserver",
@@ -148,9 +148,9 @@ dependencies = [
 
 [[package]]
 name = "cfg-if"
-version = "1.0.4"
+version = "1.0.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
+checksum = "4e7648175b45a9a48536d676f68d918270699102aa8dab5496df06904c914600"
 
 [[package]]
 name = "cfg_aliases"
@@ -171,7 +171,7 @@ dependencies = [
 
 [[package]]
 name = "chain-gang"
-version = "0.11.2"
+version = "0.11.3"
 dependencies = [
  "async-lock",
  "async-trait",
@@ -197,6 +197,7 @@ dependencies = [
  "sha1",
  "sha2",
  "thiserror",
+ "tokio",
  "url",
 ]
 
@@ -345,7 +346,7 @@ checksum = "c6232dd377dcc64799954cbd3a9bb882e9cdc1308ccd87b1c098f1fb2eaf82a8"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 3.0.5",
+ "syn 3.0.6",
 ]
 
 [[package]]
@@ -454,9 +455,9 @@ dependencies = [
 
 [[package]]
 name = "find-msvc-tools"
-version = "0.1.12"
+version = "0.1.13"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3e0f1c7c3a72c66fd80abe965175f7523475c0489a87d3ff9d6e8c87d87a9d2d"
+checksum = "ef25905e51abafe4dcea6c15fec58c57b601cdbd0ee53d22ea1d3016c587d39b"
 
 [[package]]
 name = "fnv"
@@ -675,9 +676,9 @@ dependencies = [
 
 [[package]]
 name = "hyper-rustls"
-version = "0.27.9"
+version = "0.27.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "33ca68d021ef39cf6463ab54c1d0f5daf03377b70561305bb89a8f83aab66e0f"
+checksum = "dfa8e654703247911e29c23fbeaa261834bd9bb74efba2f9acddc37bfb127f53"
 dependencies = [
  "http",
  "hyper",
@@ -995,7 +996,7 @@ dependencies = [
  "proc-macro2",
  "quote",
  "rustversion",
- "syn 3.0.5",
+ "syn 3.0.6",
 ]
 
 [[package]]
@@ -1277,9 +1278,9 @@ checksum = "f8dcc9c7d52a811697d2151c701e0d08956f92b0e24136cf4cf27b57a6a0d9bf"
 
 [[package]]
 name = "rand"
-version = "0.10.2"
+version = "0.10.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c7f5fa3a058cd35567ef9bfa5e75732bee0f9e4c55fa90477bef2dfcdbc4be80"
+checksum = "65c9fb96cbc91e3478eaae79a69fcd3f1ae4ad052e471fe6732fff548984b4af"
 dependencies = [
  "chacha20",
  "getrandom 0.4.3",
@@ -1593,7 +1594,7 @@ checksum = "e7a5d71263a5a7d47b41f6b3f06ba276f10cc18b0931f1799f710578e2309348"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 3.0.5",
+ "syn 3.0.6",
 ]
 
 [[package]]
@@ -1730,9 +1731,9 @@ dependencies = [
 
 [[package]]
 name = "syn"
-version = "3.0.5"
+version = "3.0.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "12df2e0110f65b775f769bb17ef989067a1d931b2eb822bd4346631eeada89f9"
+checksum = "8593e8e72159ed2257d083c7a454a85cbf854f37a0966d8d483aff8c8a3ebcee"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -1756,7 +1757,7 @@ checksum = "901704edd0dfe137f1987838ee4f259e4e063c31371bdb423f7ae38ec6f77f02"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 3.0.5",
+ "syn 3.0.6",
 ]
 
 [[package]]
@@ -1803,7 +1804,7 @@ checksum = "bc04cd3e1236dd4a98afca4569f2deb3f120e5422a4023be2cb683f8486292af"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 3.0.5",
+ "syn 3.0.6",
 ]
 
 [[package]]
@@ -1938,9 +1939,9 @@ checksum = "b6f5e870be6c3b371b77fe0ee0bafb859fa4964b4404c27de1d380043c4dda20"
 
 [[package]]
 name = "unicode-ident"
-version = "1.0.24"
+version = "1.0.26"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+checksum = "d245f478577f809a851594d02313b640fb437e0bb33866753cff937863096954"
 
 [[package]]
 name = "untrusted"
@@ -2033,7 +2034,7 @@ dependencies = [
  "bumpalo",
  "proc-macro2",
  "quote",
- "syn 3.0.5",
+ "syn 3.0.6",
  "wasm-bindgen-shared",
 ]
 
@@ -2238,7 +2239,7 @@ checksum = "33811428bee40dbceb6d545e95754741d17a6aef9a4849f0fd62e2ba4f412a78"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 3.0.5",
+ "syn 3.0.6",
  "synstructure",
 ]
 
@@ -2259,7 +2260,7 @@ checksum = "f75b4683f6c7f45248d4d64056a24298c6281e0993356d7d1b4a1a962ef10d4a"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 3.0.5",
+ "syn 3.0.6",
  "synstructure",
 ]
 
@@ -2299,7 +2300,7 @@ checksum = "34df6fc39dbd26ddc9c10e6a2984476e13acce22e64e4487636ef494369225da"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 3.0.5",
+ "syn 3.0.6",
 ]
 
 [[package]]

{tx_engine-0.11.2 → tx_engine-0.11.3}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "chain-gang"
-version = "0.11.2"
+version = "0.11.3"
 description = "This is a library that enables monitoring of multiple blockchains (BTC, BCH, BSV)."
 repository = "https://github.com/nchain-innovation/chain-gang"
 homepage = "https://github.com/nchain-innovation/chain-gang"
@@ -44,6 +44,9 @@ serde_json = { version = "1.0.151" }
 reqwest = { version = "0.13.4", features = ["json"], optional = true }
 async-lock = { version = "3.4.2", optional = true }
 async-trait = { version = "0.1.91", optional = true }
+# Already in the tree via reqwest; the "time" feature is for the backoff
+# between paginated WhatsOnChain requests
+tokio = { version = "1", features = ["time"], optional = true }
 
 # For python feature
 # abi3-py311 builds against the stable ABI: one wheel (cp311-abi3) works on
@@ -64,5 +67,5 @@ lto = true          # Enable link-time optimizations to shrink binary
 # serde and serde_json are unconditional dependencies, so there is nothing
 # left for the default feature to switch on
 default = []
-interface = ["dep:reqwest", "dep:async-lock", "dep:async-trait"]
+interface = ["dep:reqwest", "dep:async-lock", "dep:async-trait", "dep:tokio"]
 python = ["dep:pyo3"]

{tx_engine-0.11.2 → tx_engine-0.11.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tx_engine
-Version: 0.11.2
+Version: 0.11.3
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11

{tx_engine-0.11.2 → tx_engine-0.11.3}/docs/Releases.md

@@ -59,3 +59,4 @@
 * v0.11.0 - **Breaking.** Regtest support: `Network::BSV_Regtest` and a JSON-RPC `RpcInterface` for talking to a local node, verified against a bitcoin-sv regtest node. `Peer::id` is now `PeerId` rather than `snowflake::ProcessUniqueId`; `generate_wif` takes a `Network` instead of its name and returns `Result`, where an unrecognised name used to yield a mainnet key; `decode_base58_checksum`, `ExtendedKey::decode` and `WocInterface` return errors where they used to panic; unconfirmed UTXOs report `UNCONFIRMED_HEIGHT` (-1) through every interface, WhatsOnChain's own `height: 0` being translated on the way in; `Block::validate` enforces the Chronicle activation height it already had; `ChainGangError` no longer discards the message of `ResponseError`, `JSONParseError` and `InvalidOperation`. `serde` and `serde_json` are ordinary dependencies, so `--no-default-features` compiles. Dropped `typenum`, `lazy_static` and `snowflake`; moved `async-mutex` to `async-lock` and `base58` to `bs58`. CI gained clippy, a feature matrix and Python lint gates
 * v0.11.1 - `RpcInterface::import_address` asks the node to watch an address, opt-in because whether to touch the node's wallet is the caller's decision; a JSON-RPC method answering `"result": null`, as `importaddress` does, is now success rather than "returned neither a result nor an error"; documented that balance and UTXO queries see only what the node's wallet tracks, so an unwatched address reads as zero with no error, in both the Rust and Python clients; added [Regtest.md](Regtest.md), a guide to running against a private chain; cleared the rustdoc warnings
 * v0.11.2 - Two robustness fixes. Additive API only, so cargo treats this as a compatible upgrade: `util::read_exact_vec`, `util::bounded_capacity`, `util::MAX_PREALLOC_ELEMENTS` and `script::stack::pop_bigint_checked_minimal` are new, and nothing existing changes shape. Wire-format reads no longer size an allocation from a sender-controlled length prefix: 17 sites across `tx_in`/`tx_out`, `tx`, `block`, `merkle_block`, `filter_add`/`filter_load`, `protoconf`/`createstrm`, `version` and `reject` now grow a buffer as bytes arrive via `util::read_exact_vec`, or cap a speculative reserve with `util::bounded_capacity`, so a 27-byte transaction declaring a 2^48-byte script is an error rather than an allocation-failure `SIGABRT` that a consumer cannot catch. Script evaluation applies minimal *number* encoding only where a stack item is decoded as a number, not to every push: a 33-byte public key or a 20-byte hash ending `0x00` or `0x80` is ordinary data, and rejecting it as `Non-minimal push data` refused roughly 1 in 128 standard P2PKH spends. Minimal-*push* (BIP-62) is unchanged, and minimal-number enforcement now also covers the bigint arithmetic operands it previously missed
+* v0.11.3 - WhatsOnChain endpoint fixes. No API change: `Balance` and `UtxoEntry` keep their fields, and the new types are internal. `get_utxo` reads `/address/{addr}/unspent/all` and follows every page, where it previously read the undocumented `/unspent` and stopped at 1000 entries with no way to ask for the rest, so a busy address came back silently truncated and a caller could not tell 1000 UTXOs from 50,000; on `1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa` that is 20960 entries rather than 1000, the old result being a strict subset of the new one. Unconfirmed outputs are now recognised by the entry's `status` field, falling back to `height == 0` as before. `get_balance` reads `/confirmed/balance` and `/unconfirmed/balance`, the endpoints that replaced the undocumented combined `/balance`, reproducing its figures to the satoshi. Both endpoints report failures in the body with HTTP 200, so an error is no longer read as an empty UTXO set or a zero balance. **Paging and the split balance turn one request into several, and WhatsOnChain rate limits**, so requests now back off on 429/502/503/504, matching what the Python client already did; `tokio` joins the `interface` feature for its timer, having already been present through `reqwest`. The parallel Python client is changed to match. CI actions moved off the deprecated Node 20 runtime

tx_engine-0.11.3/python/src/tests/test_woc_balance.py

@@ -0,0 +1,63 @@
+""" Test of the WoC balance split across confirmed/unconfirmed endpoints
+
+WhatsOnChain replaced the combined /address/{addr}/balance with separate
+confirmed and unconfirmed endpoints. Covers the combining, which needs no
+network.
+"""
+import unittest
+from unittest.mock import patch
+
+from tx_engine.interface import woc
+
+
+class WoCBalanceTest(unittest.TestCase):
+    """ Test of the WoC balance combining """
+
+    def test_the_two_halves_combine(self):
+        # Shapes as observed against mainnet
+        responses = [
+            {"address": "1A1z", "script": "8b01df4e", "confirmed": 7297358945,
+             "error": "", "associatedScripts": [{"script": "740485f3", "type": "pubkey"}]},
+            {"address": "1A1z", "script": "8b01df4e", "unconfirmed": 42, "error": ""},
+        ]
+        with patch.object(woc, "get_response", side_effect=responses):
+            self.assertEqual(
+                woc.get_balance("1A1z", testnet=False),
+                {"confirmed": 7297358945, "unconfirmed": 42},
+            )
+
+    def test_a_body_error_is_not_mistaken_for_a_zero_balance(self):
+        # Reported with HTTP 200, so the body is the only signal
+        with patch.object(
+            woc, "get_response",
+            side_effect=[{"confirmed": 0, "error": "invalid address"}],
+        ):
+            self.assertIsNone(woc.get_balance("nonsense", testnet=False))
+
+    def test_a_failed_request_gives_none(self):
+        with patch.object(woc, "get_response", side_effect=[None]):
+            self.assertIsNone(woc.get_balance("1A1z", testnet=False))
+
+    def test_a_failed_second_request_gives_none(self):
+        # The unconfirmed half failing must not report a confirmed-only balance
+        with patch.object(
+            woc, "get_response",
+            side_effect=[{"confirmed": 100, "error": ""}, None],
+        ):
+            self.assertIsNone(woc.get_balance("1A1z", testnet=False))
+
+    def test_a_negative_unconfirmed_balance_survives(self):
+        # Spending a confirmed UTXO from the mempool makes this negative
+        with patch.object(
+            woc, "get_response",
+            side_effect=[{"confirmed": 100, "error": ""},
+                         {"unconfirmed": -5000, "error": ""}],
+        ):
+            self.assertEqual(
+                woc.get_balance("1A1z", testnet=False),
+                {"confirmed": 100, "unconfirmed": -5000},
+            )
+
+
+if __name__ == "__main__":
+    unittest.main()

{tx_engine-0.11.2 → tx_engine-0.11.3}/python/src/tests/test_woc_interface.py

@@ -14,7 +14,7 @@ class WoCHeightTest(unittest.TestCase):
     """ Test of the WoC unconfirmed height normalisation """
 
     def test_height_zero_becomes_the_unconfirmed_sentinel(self):
-        # Trimmed from a real /address/{addr}/unspent response. Transaction
+        # Trimmed from a real /address/{addr}/unspent/all response. Transaction
         # fa7f15f8..d860 was in WhatsOnChain's own mempool/raw list, with no
         # blockhash, blockheight or confirmations.
         utxo: List[Dict[str, Any]] = [
@@ -28,6 +28,23 @@ class WoCHeightTest(unittest.TestCase):
         self.assertEqual(utxo[0]["height"], 964754)
         self.assertEqual(utxo[1]["value"], 2954693)
 
+    def test_status_marks_an_unconfirmed_entry_even_at_a_real_height(self):
+        # status is the documented signal on /unspent/all; height is the fallback
+        utxo: List[Dict[str, Any]] = [
+            {"height": 964754, "tx_pos": 0, "tx_hash": "aa", "value": 1,
+             "isSpentInMempoolTx": False, "status": "unconfirmed"},
+        ]
+        _normalise_unconfirmed(utxo)
+        self.assertEqual(utxo[0]["height"], UNCONFIRMED_HEIGHT)
+
+    def test_a_confirmed_status_keeps_its_height(self):
+        utxo: List[Dict[str, Any]] = [
+            {"height": 964754, "tx_pos": 0, "tx_hash": "aa", "value": 1,
+             "isSpentInMempoolTx": False, "status": "confirmed"},
+        ]
+        _normalise_unconfirmed(utxo)
+        self.assertEqual(utxo[0]["height"], 964754)
+
     def test_is_idempotent(self):
         utxo: List[Dict[str, Any]] = [
             {"height": UNCONFIRMED_HEIGHT, "tx_pos": 0, "tx_hash": "aa", "value": 1}

{tx_engine-0.11.2 → tx_engine-0.11.3}/python/src/tx_engine/interface/woc.py

@@ -23,15 +23,16 @@ def get_url(testnet: bool = True) -> str:
     return "https://api.whatsonchain.com/v1/bsv/main"
 
 
-def get_response(url: str, max_retries: int = 5):
+def get_response(url: str, max_retries: int = 5, params: Optional[Dict] = None):
     """This is the guts of all the WoC requests.
 
     Retries on connection errors and transient HTTP responses (429/502/503/504).
+    `params` are appended as a query string, encoded by requests.
     """
     transient_status = {429, 502, 503, 504}
     for attempt in range(max_retries):
         try:
-            response = requests.get(url, timeout=30)
+            response = requests.get(url, timeout=30, params=params)
         except (ConnectionError, requests.Timeout) as e:
             LOGGER.warning(f"WoC request error for {url}: {e}")
             if attempt + 1 >= max_retries:
@@ -58,27 +59,56 @@ def get_response(url: str, max_retries: int = 5):
     return None
 
 
+#: Upper bound on pages fetched for one address. Each page is up to 1000
+#: entries, so this allows 1M UTXOs. It exists only so that a server that kept
+#: handing back a next-page token could not spin forever; reaching it raises
+#: rather than truncating, which is the whole point of moving off /unspent.
+MAX_UTXO_PAGES = 1000
+
+
 def get_unspent_transactions(address: str, testnet: bool = True):
-    """Return the unspent transations associated with this address"""
-    return get_response(f"{get_url(testnet)}/address/{address}/unspent")
+    """Return the unspent transactions associated with this address
+
+    Reads /unspent/all, which covers both confirmed and unconfirmed outputs and
+    paginates at 1000 entries. Every page is followed, so the returned list is
+    complete; the superseded /unspent stopped at 1000 with no way to ask for
+    the rest, so a busy address came back silently truncated.
+
+    Returns a list of entries, as before. None if a request fails.
+    """
+    base = f"{get_url(testnet)}/address/{address}/unspent/all"
+    entries: list = []
+    token = ""
+
+    for _ in range(MAX_UTXO_PAGES):
+        # The token is opaque and server-supplied, so it is passed as a
+        # parameter rather than interpolated into the path
+        page = get_response(base, params={"token": token} if token else None)
+        if page is None:
+            return None
+        error = page.get("error")
+        if error:
+            # Reported in the body with a 200, so it would otherwise read as an
+            # empty UTXO set
+            LOGGER.warning(f"WhatsOnChain error = {error}")
+            return None
+        entries.extend(page.get("result") or [])
+
+        next_token = page.get("nextPageToken") or ""
+        if not next_token or next_token == token:
+            return entries
+        token = next_token
+
+    raise ValueError(f"address has more than {MAX_UTXO_PAGES} pages of UTXOs")
 
 
 def get_last_unspent(address: str, testnet: bool = True):
-    """Return the unspent transations associated with this address"""
-    tx_hash = None
-    tx_pos = 0
-    value = 0
-    url = "{}/address/{}/unspent".format(get_url(testnet), address)
-    response = requests.get(url)
-    if response.status_code == 200:
-        data = response.json()
-        LOGGER.debug(f"data = {data}")
-        tx_hash = data[-1]["tx_hash"]
-        tx_pos = data[-1]["tx_pos"]
-        value = data[-1]["value"]
-    else:
-        LOGGER.info(f"response = {response}")
-    return (tx_hash, tx_pos, value)
+    """Return the last unspent transaction associated with this address"""
+    data = get_unspent_transactions(address, testnet=testnet)
+    if not data:
+        return (None, 0, 0)
+    LOGGER.debug(f"data = {data}")
+    return (data[-1]["tx_hash"], data[-1]["tx_pos"], data[-1]["value"])
 
 
 def get_transaction(tx_id: str, testnet: bool = True):
@@ -109,8 +139,36 @@ def get_history(address: str, testnet: bool = True):
 
 
 def get_balance(address: str, testnet: bool = True):
-    """Return the balance associated with this address"""
-    return get_response(f"{get_url(testnet)}/address/{address}/balance")
+    """Return the balance associated with this address
+
+    Reads /confirmed/balance and /unconfirmed/balance, the endpoints that
+    replaced the combined /balance. That costs two requests where there was
+    one, so the two halves are read a moment apart; an address being spent to
+    between them could report a confirmed figure from just before a block and
+    an unconfirmed one from just after. The combined endpoint is undocumented,
+    which is the trade being made.
+
+    Returns {"confirmed": int, "unconfirmed": int} as before, or None if
+    either request fails.
+    """
+    base = f"{get_url(testnet)}/address/{address}"
+
+    confirmed = get_response(f"{base}/confirmed/balance")
+    if confirmed is None or confirmed.get("error"):
+        if confirmed is not None:
+            LOGGER.warning(f"WhatsOnChain error = {confirmed['error']}")
+        return None
+
+    unconfirmed = get_response(f"{base}/unconfirmed/balance")
+    if unconfirmed is None or unconfirmed.get("error"):
+        if unconfirmed is not None:
+            LOGGER.warning(f"WhatsOnChain error = {unconfirmed['error']}")
+        return None
+
+    return {
+        "confirmed": confirmed.get("confirmed", 0),
+        "unconfirmed": unconfirmed.get("unconfirmed", 0),
+    }
 
 
 def get_chain_info(testnet: bool = True):

{tx_engine-0.11.2 → tx_engine-0.11.3}/python/src/tx_engine/interface/woc_interface.py

@@ -20,14 +20,16 @@ LOGGER = logging.getLogger(__name__)
 def _normalise_unconfirmed(utxo):
     """Rewrite WhatsOnChain's unconfirmed marker to this package's
 
-    WhatsOnChain reports a mempool UTXO as `height: 0`, while a negative height
-    is what means unconfirmed here and in the Rust crate, so the value is
-    translated on the way in rather than left for every caller to special-case.
-    A height of 0 cannot mean the genesis block: the genesis coinbase is
-    unspendable, so it never appears in an unspent set.
+    A negative height is what means unconfirmed here and in the Rust crate.
+    WhatsOnChain signals it two ways: `status: "unconfirmed"` on /unspent/all,
+    and `height: 0`. Both are honoured, the status first, so the value is
+    translated on the way in rather than left for every caller to
+    special-case. A height of 0 cannot mean the genesis block: the genesis
+    coinbase is unspendable, so it never appears in an unspent set.
     """
     for entry in utxo:
-        if entry.get("height") == 0:
+        status = str(entry.get("status", "")).lower()
+        if status == "unconfirmed" or entry.get("height") == 0:
             entry["height"] = UNCONFIRMED_HEIGHT
     return utxo