ipor-fusion 4.0.0.dev63__tar.gz → 4.0.0.dev66__tar.gz

{ipor_fusion-4.0.0.dev63 → ipor_fusion-4.0.0.dev66}/MIGRATION_4.md

@@ -29,15 +29,22 @@ widths or address spelling.
 | `RoleId` | a `Roles` member (accepted as is), or `RoleId(n)`; `Roles.resolve(name)` returns one |
 | `Decimals`, `Period`, `Amount`, ... | `Decimals(8)`, `Period(0)`, `Amount(n)` (unchanged) |
 | `ChecksumAddress` | `Web3.to_checksum_address(value)` |
-| `HexAddress` | any `ChecksumAddress`, or `parse_hex_address(value)` (20 bytes or hex in any spelling → lowercase `0x` form) |
+| `HexAddress` | any `ChecksumAddress`, or `parse_hex_address(value)` (20 bytes or `0x`/`0X`-prefixed hex in any case → lowercase `0x` form) |
 | `MorphoBlueMarketId` | `parse_morpho_market_id(value)`: 32 bytes or hex in any spelling, always `0x` + 64 lowercase digits |
-| `TxHash` | `parse_tx_hash(value)` (32 bytes or hex in any spelling) |
+| `TxHash` | `parse_tx_hash(value)` (32 bytes or `0x`/`0X`-prefixed hex in any case) |
 | `PlasmaVaultAddress`, `FuseAddress`, `AccessManagerAddress` | from the SDK (`PlasmaVault.address`, `get_fuses()`, `get_access_manager_address()`, `FusionInstance`, discovery), or `parse_plasma_vault_address` / `parse_fuse_address` / `parse_access_manager_address(value)` for a raw address; they label the role and check nothing on chain |
 | crosschain ids | `CommandId(b)`, `MessageId(b)`, `AssetId(b)`, `OperationId(b)`, `TransferId(b)`, `ReturnRequestId(b)`, `PositionSetHash(b)` (bytes32); `ProposalId(n)`, `DeploymentRequestId(n)`, `StargateAssetId(n)` (int) |
 | HyperCore ids | `HyperCoreTokenIndex(n)` (or `USDC_TOKEN_INDEX`), `HyperCoreAsset(n)` (or `hip3_action_asset(dex, index)`), `HyperCoreOrderId(n)`, `HyperCoreClientOrderId(n)`, `MarginTableId(n)`, `HyperCoreActionId(n)`, `PayloadHash(b)` |
 | external state | `ProposalHash(b)` |
 | `BlockIdentifier` | a block number, `"latest"` / `"pending"` / ..., or a block hash |
 
+The address and hash parsers (`parse_hex_address`, `parse_tx_hash`,
+`parse_plasma_vault_address`, `parse_fuse_address`, `parse_access_manager_address`)
+validate strictly: a string needs exactly one `0x`/`0X` prefix and the exact number of
+hex digits, with no surrounding whitespace; anything else raises `ValueError`. Strip
+user input yourself before parsing it. `parse_morpho_market_id` still accepts hex
+without `0x`.
+
 `MessageId` covers both a CCIP `messageId` and a LayerZero `guid`. `AssetId` is the
 crosschain executor's `bytes32` asset id; a Stargate pool's `uint16` asset id is
 `StargateAssetId`. `DeploymentRequestId` is a factory's `uint256` dispatcher request;
@@ -49,8 +56,9 @@ a `bytes32` return (recall) request is `ReturnRequestId`.
 `build_vault_info_json`, `ensure_supported_chain` and `fetch_vault_lending_health`
 take `ChainId`. The vault is a `PlasmaVaultAddress` (see *Address roles*) in
 `validate_vault` and `fetch_deployment_info`; `build_vault_info_json(ctx, plasma_vault,
-data, chain_id, chain_label)` takes no address and labels the document with
-`plasma_vault.address`. `fetch_unpriceable_priced_tokens` takes the oracle and
+data, *, chain_id, chain_label)` takes no address, takes the chain by keyword, and
+labels the document with `plasma_vault.address` (a test that mocks `PlasmaVault`
+sets `.address`). `fetch_unpriceable_priced_tokens` takes the oracle and
 underlying as `ChecksumAddress`. `resolve_token_symbol`, `resolve_token_decimals`,
 `get_contract_name` and `get_deployment_tx` take `HexAddress` (a checksum address
 fits), and the `resolve_name` / `resolve_symbol` callbacks receive one (a callback

{ipor_fusion-4.0.0.dev63 → ipor_fusion-4.0.0.dev66}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: ipor-fusion
-Version: 4.0.0.dev63
+Version: 4.0.0.dev66
 Summary: The IPOR Fusion SDK for Python
 Project-URL: homepage, https://ipor.io
 Project-URL: repository, https://github.com/IPOR-Labs/ipor-fusion.py

{ipor_fusion-4.0.0.dev63 → ipor_fusion-4.0.0.dev66}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ipor-fusion"
-version = "4.0.0.dev63"
+version = "4.0.0.dev66"
 description = "The IPOR Fusion SDK for Python"
 authors = [
     { name = "Adam Mydlarz", email = "amydlarz@gmail.com" },

{ipor_fusion-4.0.0.dev63 → ipor_fusion-4.0.0.dev66}/src/ipor_fusion/cli/vault_info_view.py

@@ -98,8 +98,8 @@ def _print_vault_info(
             ctx,
             plasma_vault,
             data,
-            chain_id,
-            chain_label,
+            chain_id=chain_id,
+            chain_label=chain_label,
             resolve_name=partial(get_contract_name, chain_id, api_key=api_key),
         )
         click.echo(json.dumps(result, indent=2))

{ipor_fusion-4.0.0.dev63 → ipor_fusion-4.0.0.dev66}/src/ipor_fusion/fuses/external_state_events.py

@@ -196,7 +196,12 @@ def external_state_event_name(topic: bytes | str) -> str | None:
 def _hex(value: Any) -> TxHash | None:
     if value is None:
         return None
-    return parse_tx_hash(_as_bytes(value, "transactionHash"))
+    raw = _as_bytes(value, "transactionHash")
+    if len(raw) != 32:
+        raise ExternalStateEventDecodeError(
+            f"transactionHash: {len(raw)} bytes, expected 32"
+        )
+    return parse_tx_hash(raw)
 
 
 def decode_external_state_event(log: Mapping[str, Any]) -> ExternalStateEvent | None:

{ipor_fusion-4.0.0.dev63 → ipor_fusion-4.0.0.dev66}/src/ipor_fusion/mcp/server.py

@@ -216,8 +216,8 @@ def vault_info(
         ctx,
         plasma_vault,
         data,
-        chain_id,
-        chain_label,
+        chain_id=chain_id,
+        chain_label=chain_label,
         resolve_name=partial(get_contract_name, chain_id, api_key=api_key),
     )
     return VaultInfoResponse.model_validate(result)

{ipor_fusion-4.0.0.dev63 → ipor_fusion-4.0.0.dev66}/src/ipor_fusion/substrates.py

@@ -47,10 +47,15 @@ class SubstrateInfo:
 #   Slippage variant: [2 type chars][62 value chars]
 
 
+def _address(hex_digits: str) -> HexAddress:
+    """The address in 40 hex digits sliced out of a substrate word."""
+    return parse_hex_address("0x" + hex_digits)
+
+
 def _decode_type_lshift160(hex_str: str, types: dict[int, str]) -> SubstrateInfo:
     """Decode type<<160 | address (Ebisu, Midas, Balancer, Velodrome)."""
     type_byte = int(hex_str[22:24], 16)
-    addr = parse_hex_address(hex_str[24:])
+    addr = _address(hex_str[24:])
     label = types.get(type_byte, f"type={type_byte}")
     return SubstrateInfo(address=addr, type_label=label)
 
@@ -63,13 +68,13 @@ def _decode_type_lshift248(hex_str: str, types: dict[int, str]) -> SubstrateInfo
         return SubstrateInfo(
             raw_hex=f"0x{hex_str}", type_label=label, extra={"slippage": str(value)}
         )
-    addr = parse_hex_address(hex_str[24:])
+    addr = _address(hex_str[24:])
     return SubstrateInfo(address=addr, type_label=label)
 
 
 def _decode_plain_address(hex_str: str) -> SubstrateInfo:
     """Decode zero-padded address: 12 zero bytes + 20 address bytes."""
-    return SubstrateInfo(address=parse_hex_address(hex_str[24:]))
+    return SubstrateInfo(address=_address(hex_str[24:]))
 
 
 def _decode_morpho(hex_str: str) -> SubstrateInfo:
@@ -84,14 +89,14 @@ def _decode_uniswap_v4(hex_str: str) -> SubstrateInfo:
     substrate-as-asset (12 zero bytes + address)."""
     if hex_str[:24] == "0" * 24:
         return SubstrateInfo(
-            address=parse_hex_address(hex_str[24:]), type_label="uniswap_v4_token"
+            address=_address(hex_str[24:]), type_label="uniswap_v4_token"
         )
     return SubstrateInfo(raw_hex=f"0x{hex_str}", type_label="uniswap_v4_pool_id")
 
 
 def _decode_enso(hex_str: str) -> SubstrateInfo:
     """Decode address<<96 | selector<<64 (Enso)."""
-    addr = parse_hex_address(hex_str[0:40])
+    addr = _address(hex_str[0:40])
     selector = f"0x{hex_str[40:48]}"
     return SubstrateInfo(
         address=addr, type_label="ENSO_TARGET", extra={"selector": selector}
@@ -100,7 +105,7 @@ def _decode_enso(hex_str: str) -> SubstrateInfo:
 
 def _decode_dolomite(hex_str: str) -> SubstrateInfo:
     """Decode asset<<96 | subAccountId<<88 | canBorrow<<80 (Dolomite)."""
-    addr = parse_hex_address(hex_str[0:40])
+    addr = _address(hex_str[0:40])
     sub_account_id = int(hex_str[40:42], 16)
     can_borrow = (int(hex_str[42:44], 16) & 0x01) == 1
     return SubstrateInfo(
@@ -127,7 +132,7 @@ def _decode_aave_v4(hex_str: str) -> SubstrateInfo:
         return SubstrateInfo(raw_hex=f"0x{hex_str}", type_label=label)
     flags = int(hex_str[50:52], 16)
     return SubstrateInfo(
-        address=parse_hex_address(hex_str[2:42]),
+        address=_address(hex_str[2:42]),
         type_label="AAVE_V4_RESERVE",
         extra={
             "reserve_id": str(int(hex_str[42:50], 16)),
@@ -145,7 +150,7 @@ def _decode_euler_v2(hex_str: str) -> SubstrateInfo:
     plain-address path silently produces a malformed address (last 20 bytes are
     flag bytes + zero padding).
     """
-    addr = parse_hex_address(hex_str[0:40])
+    addr = _address(hex_str[0:40])
     is_collateral = (int(hex_str[40:42], 16) & 0x01) == 1
     can_borrow = (int(hex_str[42:44], 16) & 0x01) == 1
     sub_account = f"0x{hex_str[44:46]}"
@@ -174,13 +179,13 @@ def _decode_async_action(hex_str: str) -> SubstrateInfo:
     type_byte = int(hex_str[0:2], 16)
     if type_byte == 0:
         return SubstrateInfo(
-            address=parse_hex_address(hex_str[2:42]),
+            address=_address(hex_str[2:42]),
             type_label="ALLOWED_AMOUNT_TO_OUTSIDE",
             extra={"amount": str(int(hex_str[42:64], 16))},
         )
     if type_byte == 1:
         return SubstrateInfo(
-            address=parse_hex_address(hex_str[16:56]),
+            address=_address(hex_str[16:56]),
             type_label="ALLOWED_TARGETS",
             extra={"selector": f"0x{hex_str[56:64]}"},
         )
@@ -225,10 +230,10 @@ def _decode_external_state(hex_str: str) -> SubstrateInfo:
     if type_byte == 0:
         return SubstrateInfo(raw_hex=f"0x{hex_str}", type_label="UNDEFINED")
     if label := _EXTERNAL_STATE_ADDRESS_TYPES.get(type_byte):
-        return SubstrateInfo(address=parse_hex_address(hex_str[24:]), type_label=label)
+        return SubstrateInfo(address=_address(hex_str[24:]), type_label=label)
     if type_byte == 2:
         return SubstrateInfo(
-            address=parse_hex_address(hex_str[24:]),
+            address=_address(hex_str[24:]),
             type_label="TARGET",
             extra={"selector": f"0x{hex_str[16:24]}"},
         )
@@ -266,7 +271,7 @@ def _decode_crosschain(hex_str: str) -> SubstrateInfo:
             is_error=True,
             extra={"chain_id": str(chain_id)},
         )
-    info = SubstrateInfo(address=parse_hex_address(hex_str[24:]), type_label=label)
+    info = SubstrateInfo(address=_address(hex_str[24:]), type_label=label)
     if type_byte == 2:
         info.extra = {"chain_id": str(chain_id)}
     return info
@@ -326,7 +331,7 @@ def _decode_hypercore(hex_str: str) -> SubstrateInfo:
         return _hypercore_invalid(hex_str, label)
     if type_byte == 1:
         return SubstrateInfo(
-            address=parse_hex_address(hex_str[24:]),
+            address=_address(hex_str[24:]),
             type_label=label,
             extra={"token_index": str(int(hex_str[8:24], 16))},
         )
@@ -347,10 +352,10 @@ def _decode_hypercore(hex_str: str) -> SubstrateInfo:
             extra["read_index"] = str(read_index_of(asset))
         return SubstrateInfo(raw_hex=f"0x{hex_str}", type_label=label, extra=extra)
     if type_byte == 3:
-        return SubstrateInfo(address=parse_hex_address(hex_str[24:]), type_label=label)
+        return SubstrateInfo(address=_address(hex_str[24:]), type_label=label)
     if type_byte == 4:
         return SubstrateInfo(
-            address=parse_hex_address(hex_str[24:]),
+            address=_address(hex_str[24:]),
             type_label=label,
             extra={"max_fee_rate_decibps": str(int(hex_str[8:24], 16))},
         )

{ipor_fusion-4.0.0.dev63 → ipor_fusion-4.0.0.dev66}/src/ipor_fusion/types.py

@@ -145,22 +145,28 @@ def _hex_digits(value: str | bytes, size: int, what: str) -> str:
         if len(value) != size:
             raise ValueError(f"invalid {what} (expected {size} bytes): {value!r}")
         return value.hex()
-    digits = value.strip().removeprefix("0x").removeprefix("0X").lower()
-    if len(digits) != 2 * size or any(c not in "0123456789abcdef" for c in digits):
-        raise ValueError(f"invalid {what} (expected {size}-byte hex): {value}")
+    digits = value[2:].lower()
+    if (
+        value[:2] not in ("0x", "0X")
+        or len(digits) != 2 * size
+        or any(c not in "0123456789abcdef" for c in digits)
+    ):
+        raise ValueError(f"invalid {what} (expected 0x and {size}-byte hex): {value!r}")
     return digits
 
 
 def parse_hex_address(value: str | bytes) -> HexAddress:
-    """An address as ``0x`` and 40 lowercase hex digits, from 20 raw bytes or hex
-    in any spelling; raises ``ValueError`` on anything else. For a checksummed
+    """An address as ``0x`` and 40 lowercase hex digits, from 20 raw bytes or
+    ``0x``-prefixed hex in any case; raises ``ValueError`` on anything else,
+    surrounding whitespace included. For a checksummed
     address use ``Web3.to_checksum_address``."""
     return HexAddress(HexStr("0x" + _hex_digits(value, 20, "address")))
 
 
 def parse_tx_hash(value: str | bytes) -> TxHash:
     """A transaction hash as ``0x`` and 64 lowercase hex digits, from 32 raw bytes
-    or hex in any spelling; raises ``ValueError`` on anything else."""
+    or ``0x``-prefixed hex in any case; raises ``ValueError`` on anything else,
+    surrounding whitespace included."""
     return TxHash(HexStr("0x" + _hex_digits(value, 32, "transaction hash")))
 
 
@@ -169,9 +175,10 @@ def _checksum(value: str | bytes) -> ChecksumAddress:
 
 
 def parse_plasma_vault_address(value: str | bytes) -> PlasmaVaultAddress:
-    """A Plasma Vault's address, checksummed from 20 raw bytes or hex in any
-    spelling; raises ``ValueError`` on anything else. It labels the role and
-    checks nothing on chain."""
+    """A Plasma Vault's address, checksummed from 20 raw bytes or ``0x``/``0X``
+    and 40 hex digits in any case; raises ``ValueError`` on anything else,
+    surrounding whitespace included. It labels the role and checks nothing on
+    chain."""
     return PlasmaVaultAddress(_checksum(value))
 
 

{ipor_fusion-4.0.0.dev63 → ipor_fusion-4.0.0.dev66}/tests/test_cli_vault_info_golden.py

@@ -378,8 +378,8 @@ def test_public_builder_renders_the_cli_json(scenario: str) -> None:
         ctx,
         PlasmaVault(ctx, VAULT),  # type: ignore[arg-type]
         data,
-        1,
-        "ethereum",
+        chain_id=1,
+        chain_label="ethereum",
         resolve_name=lambda address: _NAMES_BY_ADDRESS.get(address.lower(), ""),
     )
     expected = (FIXTURES / f"{scenario}.json").read_text(encoding="utf-8")

{ipor_fusion-4.0.0.dev63 → ipor_fusion-4.0.0.dev66}/tests/test_external_state_events.py

@@ -96,6 +96,13 @@ def test_hex_text_data_and_topics_from_an_indexer_decode_too():
     assert event.transaction_hash == "0x" + "fb" * 32
 
 
+def test_a_short_transaction_hash_is_a_decode_error():
+    log = _log("ExternalStateAssetRescued", (SIGNER,))
+    log["transactionHash"] = bytes(31)
+    with pytest.raises(ExternalStateEventDecodeError, match="transactionHash"):
+        decode_external_state_event(log)
+
+
 def test_an_unknown_topic_is_none_and_a_malformed_listed_one_raises():
     assert (
         decode_external_state_event(

{ipor_fusion-4.0.0.dev63 → ipor_fusion-4.0.0.dev66}/tests/test_types_and_events.py

@@ -64,23 +64,34 @@ class TestExtractEvents:
 
 
 class TestParsers:
-    def test_hex_address_is_lowercase_0x_from_any_spelling(self):
+    def test_hex_address_is_lowercase_0x_from_either_prefix_case(self):
         from ipor_fusion import parse_hex_address
 
         checksum = "0xAbCdEf0123456789aBcDeF0123456789AbCdEf01"
         lower = checksum.lower()
         assert parse_hex_address(checksum) == lower
-        assert parse_hex_address(lower[2:]) == lower
+        assert parse_hex_address("0X" + lower[2:]) == lower
         assert parse_hex_address(bytes.fromhex(lower[2:])) == lower
 
-    def test_tx_hash_is_lowercase_0x_from_any_spelling(self):
+    def test_tx_hash_is_lowercase_0x_from_either_prefix_case(self):
         from ipor_fusion import parse_tx_hash
 
         digest = "AB" * 32
-        assert parse_tx_hash(digest) == "0x" + digest.lower()
+        assert parse_tx_hash("0x" + digest) == "0x" + digest.lower()
         assert parse_tx_hash(bytes.fromhex(digest)) == "0x" + digest.lower()
 
-    @pytest.mark.parametrize("value", ["0x1234", "0x" + "zz" * 20, b"\x00" * 19])
+    @pytest.mark.parametrize(
+        "value",
+        [
+            "0x1234",
+            "0x" + "zz" * 20,
+            b"\x00" * 19,
+            "ab" * 20,
+            " 0x" + "ab" * 20,
+            "0x" + "ab" * 20 + "\n",
+            "0x0X" + "ab" * 19,
+        ],
+    )
     def test_hex_address_rejects_anything_else(self, value):
         from ipor_fusion import parse_hex_address
 

{ipor_fusion-4.0.0.dev63 → ipor_fusion-4.0.0.dev66}/tests/typed_client/consumer.py

@@ -78,7 +78,7 @@ def vault_reads(ctx: Web3Context, vault: PlasmaVault) -> None:
     ensure_supported_chain(ETHEREUM)
     data = fetch_vault_data(ctx, vault, chain_id=ETHEREUM)
     fetch_deployment_info(ctx, ETHEREUM, VAULT, None)
-    build_vault_info_json(ctx, vault, data, ETHEREUM, "ethereum")
+    build_vault_info_json(ctx, vault, data, chain_id=ETHEREUM, chain_label="ethereum")
     validate_vault(ctx, VAULT)
     resolve_token_symbol(ctx, VAULT)
     fetch_unpriceable_priced_tokens(ctx, VAULT, VAULT, [], {}, None)