ipor-fusion 4.0.0.dev282__tar.gz → 4.0.0.dev286__tar.gz

{ipor_fusion-4.0.0.dev282 → ipor_fusion-4.0.0.dev286}/MIGRATION_4.md

@@ -390,6 +390,43 @@ module was renamed to match. Import the decoders with `from ipor_fusion import
 external_state_events` and `from ipor_fusion.hypercore import hypercore_events`;
 the modules are internal.
 
+#### HyperCore follows the released contracts
+
+4.0 reads and encodes the HyperCore contracts `ipor-abi` publishes on HyperEVM
+(contracts release 2026-10-21), not the earlier market-55 test deployment.
+
+- **Pending reader.** `HYPERCORE_PENDING_READERS[999]` is
+  `0x1EFFb12434f5fb59a636C54D8CBaC93b13DF1A9E`. `HyperCorePendingReader.is_pending()`
+  is gone (the released reader has no `isPending()`): call `is_action_pending()`,
+  and `is_order_in_flight()` for the order rate limit. `pending_state()` decodes
+  the released 23-word tuple only; the earlier reader `0x83F54bc9…` returns 18
+  words and is no longer supported. A vault of the earlier build (its pre-hooks
+  predate the transfer effect) reads through the released reader only while
+  nothing is in flight: the struct only grew, so a settled state decodes the same,
+  but during an action the released reader derives `pending`/`settled` from effect
+  fields the earlier hooks never write, so it can disagree with what that vault
+  enforces.
+- **`HyperCorePendingState`.** Removed: `settlement_mode`, `reported_result`,
+  `result_l1_block`, `refreshing` (the contracts no longer write them). Added:
+  `effect_kind` (`HyperCoreEffectKind`), `effect_token_index`, `effect_evm_asset`,
+  `expected_balance`, `timeout_at`, `last_order_l1_block`. A transfer with an effect
+  settles when the expected balance is observed or `timeout_at` passes.
+- **`vault info` / `vault_info`.** `hypercore.pending` drops `refreshing`,
+  `settlement_mode`, `reported_result` and gains the six fields above.
+- **Settlement mode removed.** `SettlementMode` and `HyperCoreReportedResult` are
+  gone, and so are the settlement fuse and reporter events
+  (`HyperCoreReportedActionSettled`, `ReportSubmitted`, `ObserverSetProposed`,
+  `ObserverSetChanged`, `RecoveryProposed`, `RecoveryExecuted` and their `*Args`
+  / `*Event` classes): orders settle by time, transfers by time and effect.
+  `HyperCoreConfigKey.WINDOW_ORDER_SECONDS` and `SETTLEMENT_MODE` keep their
+  numbers but are reserved and ignored (`RESERVED_HYPERCORE_CONFIG_KEYS`); a
+  decoded substrate of either carries `extra["reserved"] == "true"`.
+- **New substrates.** `HyperCoreSubstrates.perp_position_cap(asset,
+  max_position_notional_usd6)` (type 7) and `HyperCoreConfigKey`
+  `TRANSFER_TIMEOUT_SECONDS`, `ACTIVATION_FEE_ALLOWANCE_USDC_WEI`, `MAX_NAV_JUMP_BPS`,
+  `MAX_MARK_ORACLE_DEVIATION_BPS`, `NAV_JUMP_FLOOR_USD6` (7..11); `decode_substrate`
+  decodes them instead of flagging them as errors.
+
 **Removed.**
 
 - `IporFusionMarkets.RWA`: market 50 is `IporFusionMarkets.EXTERNAL_STATE`.

{ipor_fusion-4.0.0.dev282 → ipor_fusion-4.0.0.dev286}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: ipor-fusion
-Version: 4.0.0.dev282
+Version: 4.0.0.dev286
 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.dev282 → ipor_fusion-4.0.0.dev286}/pyproject.toml

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

{ipor_fusion-4.0.0.dev282 → ipor_fusion-4.0.0.dev286}/src/ipor_fusion/fuses/hypercore.py

@@ -95,15 +95,12 @@ class TimeInForce(IntEnum):
     IOC = 3
 
 
-class SettlementMode(IntEnum):
-    """``Config{SettlementMode}``: how a pending action is cleared."""
-
-    TIMING = 1
-    REPORTED = 2
-
-
 class HyperCoreConfigKey(IntEnum):
-    """``HyperCoreSubstrateLib.ConfigKey`` (the Undefined member is invalid)."""
+    """``HyperCoreSubstrateLib.ConfigKey`` (the Undefined member is invalid).
+
+    The numbering is stable: ``WINDOW_ORDER_SECONDS`` (2) and
+    ``SETTLEMENT_MODE`` (5) are reserved and ignored by the fuses; orders
+    settle by time and the observed effect only."""
 
     WINDOW_TRANSFER_SECONDS = 1
     WINDOW_ORDER_SECONDS = 2
@@ -111,6 +108,17 @@ class HyperCoreConfigKey(IntEnum):
     PERP_DEX_IDS = 4
     SETTLEMENT_MODE = 5
     SPOT_SEND_BRIDGE_ENABLED = 6
+    TRANSFER_TIMEOUT_SECONDS = 7
+    ACTIVATION_FEE_ALLOWANCE_USDC_WEI = 8
+    MAX_NAV_JUMP_BPS = 9
+    MAX_MARK_ORACLE_DEVIATION_BPS = 10
+    NAV_JUMP_FLOOR_USD6 = 11
+
+
+#: Config keys the fuses ignore (kept for their stable numbering).
+RESERVED_HYPERCORE_CONFIG_KEYS = frozenset(
+    {HyperCoreConfigKey.WINDOW_ORDER_SECONDS, HyperCoreConfigKey.SETTLEMENT_MODE}
+)
 
 
 def hip3_action_asset(dex: int, index_in_dex: int) -> HyperCoreAsset:
@@ -347,11 +355,13 @@ class HyperCoreSubstrates:
     (at most one when any of them is HIP-3), Destinations for ``sendAsset`` /
     ``spotSend`` (only the vault itself and, for the Core -> EVM route, the
     token's :func:`system_address` are accepted by the fuses), a SendCap per
-    token (mandatory: a token without one cannot be sent), Builders, and the
-    Config keys. ``WINDOW_ORDER_SECONDS`` and ``SETTLEMENT_MODE`` are required
-    before any order or cancel, ``MAX_USD_CLASS_TRANSFER_USD6`` before a margin
-    transfer; ``WINDOW_TRANSFER_SECONDS`` defaults to 2 s and
-    ``SPOT_SEND_BRIDGE_ENABLED`` to disabled. :func:`ipor_fusion.decode_substrate`
+    token (mandatory: a token without one cannot be sent), Builders, a
+    PerpPositionCap per market whose open position is capped, and the Config
+    keys. ``MAX_USD_CLASS_TRANSFER_USD6`` is required before a margin transfer;
+    ``WINDOW_TRANSFER_SECONDS`` defaults to 2 s, ``SPOT_SEND_BRIDGE_ENABLED`` to
+    disabled, ``TRANSFER_TIMEOUT_SECONDS`` to 600 s (at least 60),
+    ``MAX_NAV_JUMP_BPS`` to 5000 and ``MAX_MARK_ORACLE_DEVIATION_BPS`` to 500;
+    the reserved keys are ignored. :func:`ipor_fusion.decode_substrate`
     inverts these.
     """
 
@@ -394,7 +404,9 @@ class HyperCoreSubstrates:
     @staticmethod
     def config(key: HyperCoreConfigKey, value: int) -> bytes:
         """One Config key; ``PERP_DEX_IDS`` is a bitmap (bit i enables perp
-        dex i, bit 0 stays clear), ``SETTLEMENT_MODE`` a :class:`SettlementMode`."""
+        dex i, bit 0 stays clear). The reserved keys
+        (:data:`RESERVED_HYPERCORE_CONFIG_KEYS`) encode but the fuses ignore
+        them."""
         key = HyperCoreConfigKey(key)
         _validate_uint(value, 240, "value")
         return _word(5, (int(key) << 240) | value)
@@ -405,3 +417,14 @@ class HyperCoreSubstrates:
         _validate_uint(token_index, 64, "token_index")
         _validate_uint(max_wei, 128, "max_wei")
         return _word(6, (token_index << 128) | max_wei)
+
+    @staticmethod
+    def perp_position_cap(
+        asset: HyperCoreAsset, max_position_notional_usd6: int
+    ) -> bytes:
+        """Cap on the open position notional of action asset ``asset`` in USD
+        (6 decimals); the order fuse reverts
+        ``HyperCoreOrderFusePositionCapExceeded`` above it."""
+        _validate_uint(asset, 32, "asset")
+        _validate_uint(max_position_notional_usd6, 88, "max_position_notional_usd6")
+        return _word(7, (asset << 216) | (max_position_notional_usd6 << 128))

{ipor_fusion-4.0.0.dev282 → ipor_fusion-4.0.0.dev286}/src/ipor_fusion/fuses/hypercore_event_decoding.py

@@ -1,13 +1,12 @@
-"""HyperCore events by topic: the fuses', the pending library's, the
-settlement fuse's and the settlement reporter's.
+"""HyperCore events by topic: the fuses' and the pending library's.
 
 Mirrors the ``event`` declarations in ``contracts/fuses/hypercore``. Every
 parameter is unindexed (the repository's event policy), so a log decodes from
 its ``data`` alone; the first parameter of a fuse event, ``version``, is the
 fuse's own address (``VERSION``). ``HyperCoreActionEnqueued`` is emitted by
 the vault (the fuses run as delegatecalls) once per enqueued action and
-``HyperCoreActionSettled`` only from a settlement fuse transaction; TIMING
-settlements emit nothing.
+``HyperCoreActionSettled`` by either HyperCore pre-hook when it clears a settled
+action.
 
 Status: preview, not production. The contracts behind it are under active development, the mainnet deployments are a proof of concept and IPOR Labs canaries, and interfaces may change between minor versions; see ``ipor_fusion.about.PREVIEW_FEATURES``.
 """
@@ -134,42 +133,6 @@ HYPERCORE_EVENT_SPECS: tuple[HyperCoreEventSpec, ...] = (
         ),
     ),
     HyperCoreEventSpec("HyperCoreActionSettled", (("uint256", "nonce"),)),
-    # HyperCoreSettlementFuse
-    HyperCoreEventSpec(
-        "HyperCoreReportedActionSettled",
-        (
-            ("uint256", "nonce"),
-            ("uint24", "actionId"),
-            ("bytes32", "payloadHash"),
-            ("uint8", "outcome"),
-            ("uint64", "resultL1Block"),
-            ("bytes32", "evidenceHash"),
-            ("bytes32", "reasonHash"),
-        ),
-    ),
-    # HyperCoreSettlementReporter
-    HyperCoreEventSpec(
-        "ReportSubmitted",
-        (("bytes32", "digest"), ("uint256", "nonce"), ("uint8", "outcome")),
-    ),
-    HyperCoreEventSpec("ObserverSetProposed", (("uint64", "executeAfter"),)),
-    HyperCoreEventSpec(
-        "ObserverSetChanged",
-        (("address", "observer0"), ("address", "observer1"), ("address", "observer2")),
-    ),
-    HyperCoreEventSpec(
-        "RecoveryProposed",
-        (
-            ("bytes32", "digest"),
-            ("bytes32", "evidenceHash"),
-            ("bytes32", "reasonHash"),
-            ("uint64", "executeAfter"),
-        ),
-    ),
-    HyperCoreEventSpec(
-        "RecoveryExecuted",
-        (("bytes32", "digest"), ("bytes32", "evidenceHash"), ("bytes32", "reasonHash")),
-    ),
 )
 
 # Event parameters by their Solidity names; ``version`` is the emitting fuse.
@@ -250,45 +213,6 @@ class HyperCoreActionSettledArgs(TypedDict):
     nonce: int
 
 
-class HyperCoreReportedActionSettledArgs(TypedDict):
-    nonce: int
-    actionId: HyperCoreActionId
-    payloadHash: PayloadHash
-    outcome: int
-    resultL1Block: int
-    evidenceHash: bytes
-    reasonHash: bytes
-
-
-class HyperCoreReportSubmittedArgs(TypedDict):
-    digest: bytes
-    nonce: int
-    outcome: int
-
-
-class HyperCoreObserverSetProposedArgs(TypedDict):
-    executeAfter: Timestamp
-
-
-class HyperCoreObserverSetChangedArgs(TypedDict):
-    observer0: ChecksumAddress
-    observer1: ChecksumAddress
-    observer2: ChecksumAddress
-
-
-class HyperCoreRecoveryProposedArgs(TypedDict):
-    digest: bytes
-    evidenceHash: bytes
-    reasonHash: bytes
-    executeAfter: Timestamp
-
-
-class HyperCoreRecoveryExecutedArgs(TypedDict):
-    digest: bytes
-    evidenceHash: bytes
-    reasonHash: bytes
-
-
 #: The parameters of one HyperCore event.
 HyperCoreEventArgs: TypeAlias = (
     HyperCoreDepositFuseEnterArgs
@@ -301,12 +225,6 @@ HyperCoreEventArgs: TypeAlias = (
     | HyperCoreBuilderFeeFuseEnterArgs
     | HyperCoreActionEnqueuedArgs
     | HyperCoreActionSettledArgs
-    | HyperCoreReportedActionSettledArgs
-    | HyperCoreReportSubmittedArgs
-    | HyperCoreObserverSetProposedArgs
-    | HyperCoreObserverSetChangedArgs
-    | HyperCoreRecoveryProposedArgs
-    | HyperCoreRecoveryExecutedArgs
 )
 
 #: topic0 -> spec, for every HyperCore event.
@@ -403,42 +321,6 @@ class HyperCoreActionSettledEvent(_HyperCoreEventBase):
     args: HyperCoreActionSettledArgs
 
 
-@dataclass(frozen=True, slots=True, kw_only=True)
-class HyperCoreReportedActionSettledEvent(_HyperCoreEventBase):
-    name: Literal["HyperCoreReportedActionSettled"] = "HyperCoreReportedActionSettled"
-    args: HyperCoreReportedActionSettledArgs
-
-
-@dataclass(frozen=True, slots=True, kw_only=True)
-class HyperCoreReportSubmittedEvent(_HyperCoreEventBase):
-    name: Literal["ReportSubmitted"] = "ReportSubmitted"
-    args: HyperCoreReportSubmittedArgs
-
-
-@dataclass(frozen=True, slots=True, kw_only=True)
-class HyperCoreObserverSetProposedEvent(_HyperCoreEventBase):
-    name: Literal["ObserverSetProposed"] = "ObserverSetProposed"
-    args: HyperCoreObserverSetProposedArgs
-
-
-@dataclass(frozen=True, slots=True, kw_only=True)
-class HyperCoreObserverSetChangedEvent(_HyperCoreEventBase):
-    name: Literal["ObserverSetChanged"] = "ObserverSetChanged"
-    args: HyperCoreObserverSetChangedArgs
-
-
-@dataclass(frozen=True, slots=True, kw_only=True)
-class HyperCoreRecoveryProposedEvent(_HyperCoreEventBase):
-    name: Literal["RecoveryProposed"] = "RecoveryProposed"
-    args: HyperCoreRecoveryProposedArgs
-
-
-@dataclass(frozen=True, slots=True, kw_only=True)
-class HyperCoreRecoveryExecutedEvent(_HyperCoreEventBase):
-    name: Literal["RecoveryExecuted"] = "RecoveryExecuted"
-    args: HyperCoreRecoveryExecutedArgs
-
-
 #: One decoded HyperCore event; ``event.name == "..."`` narrows it, and its
 #: ``args``, to that event's class.
 HyperCoreEvent: TypeAlias = (
@@ -452,12 +334,6 @@ HyperCoreEvent: TypeAlias = (
     | HyperCoreBuilderFeeFuseEnterEvent
     | HyperCoreActionEnqueuedEvent
     | HyperCoreActionSettledEvent
-    | HyperCoreReportedActionSettledEvent
-    | HyperCoreReportSubmittedEvent
-    | HyperCoreObserverSetProposedEvent
-    | HyperCoreObserverSetChangedEvent
-    | HyperCoreRecoveryProposedEvent
-    | HyperCoreRecoveryExecutedEvent
 )
 
 #: Event name -> its event class (``args`` annotation: its TypedDict).
@@ -472,12 +348,6 @@ HYPERCORE_EVENT_CLASSES: dict[str, type[HyperCoreEvent]] = {
     "HyperCoreBuilderFeeFuseEnter": HyperCoreBuilderFeeFuseEnterEvent,
     "HyperCoreActionEnqueued": HyperCoreActionEnqueuedEvent,
     "HyperCoreActionSettled": HyperCoreActionSettledEvent,
-    "HyperCoreReportedActionSettled": HyperCoreReportedActionSettledEvent,
-    "ReportSubmitted": HyperCoreReportSubmittedEvent,
-    "ObserverSetProposed": HyperCoreObserverSetProposedEvent,
-    "ObserverSetChanged": HyperCoreObserverSetChangedEvent,
-    "RecoveryProposed": HyperCoreRecoveryProposedEvent,
-    "RecoveryExecuted": HyperCoreRecoveryExecutedEvent,
 }
 
 

{ipor_fusion-4.0.0.dev282 → ipor_fusion-4.0.0.dev286}/src/ipor_fusion/hypercore/__init__.py

@@ -6,6 +6,7 @@ minor release, which is why they live here rather than in `ipor_fusion`.
 """
 
 from ipor_fusion.fuses.hypercore import (
+    RESERVED_HYPERCORE_CONFIG_KEYS,
     SPOT_DEX,
     USDC_SYSTEM_ADDRESS,
     USDC_TOKEN_INDEX,
@@ -17,7 +18,6 @@ from ipor_fusion.fuses.hypercore import (
     HyperCoreOrderFuse,
     HyperCoreSendFuse,
     HyperCoreSubstrates,
-    SettlementMode,
     TimeInForce,
     hip3_action_asset,
     is_hip3_asset,
@@ -47,20 +47,8 @@ from ipor_fusion.fuses.hypercore_event_decoding import (
     HyperCoreEventSpec,
     HyperCoreMarginFuseEnterArgs,
     HyperCoreMarginFuseEnterEvent,
-    HyperCoreObserverSetChangedArgs,
-    HyperCoreObserverSetChangedEvent,
-    HyperCoreObserverSetProposedArgs,
-    HyperCoreObserverSetProposedEvent,
     HyperCoreOrderFuseEnterArgs,
     HyperCoreOrderFuseEnterEvent,
-    HyperCoreRecoveryExecutedArgs,
-    HyperCoreRecoveryExecutedEvent,
-    HyperCoreRecoveryProposedArgs,
-    HyperCoreRecoveryProposedEvent,
-    HyperCoreReportedActionSettledArgs,
-    HyperCoreReportedActionSettledEvent,
-    HyperCoreReportSubmittedArgs,
-    HyperCoreReportSubmittedEvent,
     HyperCoreSendFuseSendAssetArgs,
     HyperCoreSendFuseSendAssetEvent,
     HyperCoreSendFuseSpotSendArgs,
@@ -75,6 +63,7 @@ from ipor_fusion.readers.hypercore import (
     HYPERCORE_PENDING_READERS,
     HyperCoreAccountMarginSummary,
     HyperCoreActionClass,
+    HyperCoreEffectKind,
     HyperCoreNav,
     HyperCorePendingReader,
     HyperCorePendingState,
@@ -83,7 +72,6 @@ from ipor_fusion.readers.hypercore import (
     HyperCorePerpMarket,
     HyperCorePosition,
     HyperCoreReader,
-    HyperCoreReportedResult,
     HyperCoreSpotBalance,
     HyperCoreSpotLeg,
     HyperCoreTokenInfo,
@@ -154,10 +142,6 @@ __all__ = [
     "HyperCoreMarginFuseEnterArgs",
     "HyperCoreMarginFuseEnterEvent",
     "HyperCoreNav",
-    "HyperCoreObserverSetChangedArgs",
-    "HyperCoreObserverSetChangedEvent",
-    "HyperCoreObserverSetProposedArgs",
-    "HyperCoreObserverSetProposedEvent",
     "HyperCoreOrderFuse",
     "HyperCoreOrderFuseEnterArgs",
     "HyperCoreOrderFuseEnterEvent",
@@ -169,15 +153,7 @@ __all__ = [
     "HyperCorePerpMarket",
     "HyperCorePosition",
     "HyperCoreReader",
-    "HyperCoreRecoveryExecutedArgs",
-    "HyperCoreRecoveryExecutedEvent",
-    "HyperCoreRecoveryProposedArgs",
-    "HyperCoreRecoveryProposedEvent",
-    "HyperCoreReportSubmittedArgs",
-    "HyperCoreReportSubmittedEvent",
-    "HyperCoreReportedActionSettledArgs",
-    "HyperCoreReportedActionSettledEvent",
-    "HyperCoreReportedResult",
+    "HyperCoreEffectKind",
     "HyperCoreSendFuse",
     "HyperCoreSendFuseSendAssetArgs",
     "HyperCoreSendFuseSendAssetEvent",
@@ -192,7 +168,7 @@ __all__ = [
     "HyperCoreTransferSnapshot",
     "HyperCoreTransferStatus",
     "HyperCoreVaultState",
-    "SettlementMode",
+    "RESERVED_HYPERCORE_CONFIG_KEYS",
     "TimeInForce",
     "compare_hypercore_transfer",
     "convert_to_wad_int",

{ipor_fusion-4.0.0.dev282 → ipor_fusion-4.0.0.dev286}/src/ipor_fusion/mcp/models.py

@@ -972,14 +972,12 @@ class HyperCorePerpMarketEntry(_Base):
 
 class HyperCorePendingEntry(_Base):
     """HyperCorePendingReader.pendingState(): `pending` and `settled` are the
-    authoritative predicates; the raw fields stay after a TIMING settlement."""
+    authoritative predicates; the raw fields stay after a settlement until the
+    next enqueue."""
 
     pending: bool
     settled: bool
-    refreshing: bool
     action_class: Literal["NONE", "TRANSFER", "ORDER"]
-    settlement_mode: Literal["TIMING", "REPORTED"] | None
-    reported_result: Literal["NONE", "EXECUTED", "REJECTED"]
     action_id: int
     action_nonce: int
     pending_until: int
@@ -992,6 +990,20 @@ class HyperCorePendingEntry(_Base):
     )
     current_timestamp: int
     l1_block_available: bool
+    effect_kind: Literal["NONE", "CORE_SPOT", "EVM_BALANCE"] = Field(
+        description="The balance a transfer waits for before it settles."
+    )
+    effect_token_index: int = Field(description="Core token of a CORE_SPOT effect.")
+    effect_evm_asset: str = Field(description="ERC-20 of an EVM_BALANCE effect.")
+    expected_balance: int = Field(
+        description="Balance (Core wei or token units) that settles the transfer."
+    )
+    timeout_at: int = Field(
+        description="Unix time after which the transfer settles without the effect."
+    )
+    last_order_l1_block: int = Field(
+        description="Core L1 block of the last order; another waits for the next."
+    )
 
 
 class HyperCoreSection(_Base):