xproof 0.2.4__tar.gz → 0.2.6__tar.gz

{xproof-0.2.4 → xproof-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xproof
-Version: 0.2.4
+Version: 0.2.6
 Summary: Python SDK for xProof — blockchain-anchored proof-of-existence for AI agents on MultiversX
 Author-email: xProof <contact@xproof.app>
 License-Expression: MIT

{xproof-0.2.4 → xproof-0.2.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "xproof"
-version = "0.2.4"
+version = "0.2.6"
 description = "Python SDK for xProof — blockchain-anchored proof-of-existence for AI agents on MultiversX"
 readme = "README.md"
 license = "MIT"

{xproof-0.2.4 → xproof-0.2.6}/xproof/__init__.py

@@ -14,14 +14,19 @@ from .models import (
     BatchResult,
     BatchResultSummary,
     Certification,
+    ConfidenceTrail,
+    ConfidenceTrailStage,
+    PolicyCheckResult,
+    PolicyViolation,
     PricingInfo,
     PricingTier,
     RegistrationResult,
+    ReversibilityClass,
     TrialInfo,
 )
 from .utils import hash_bytes, hash_file
 
-__version__ = "0.2.3"
+__version__ = "0.2.6"
 
 __all__ = [
     "XProofClient",
@@ -30,6 +35,11 @@ __all__ = [
     "Certification",
     "BatchResult",
     "BatchResultSummary",
+    "ConfidenceTrail",
+    "ConfidenceTrailStage",
+    "PolicyCheckResult",
+    "PolicyViolation",
+    "ReversibilityClass",
     "PricingInfo",
     "PricingTier",
     "RegistrationResult",

{xproof-0.2.4 → xproof-0.2.6}/xproof/client.py

@@ -1,7 +1,7 @@
 """Main client for the xProof API."""
 
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, List, Literal, Optional, Union
 
 import requests
 
@@ -14,10 +14,18 @@ from .exceptions import (
     ValidationError,
     XProofError,
 )
-from .models import BatchResult, Certification, PricingInfo, RegistrationResult
+from .models import (
+    BatchResult,
+    Certification,
+    ConfidenceTrail,
+    PolicyCheckResult,
+    PricingInfo,
+    RegistrationResult,
+    ReversibilityClass,
+)
 from .utils import hash_file
 
-__version__ = "0.2.4"
+__version__ = "0.2.6"
 
 DEFAULT_BASE_URL = "https://xproof.app"
 DEFAULT_TIMEOUT = 30
@@ -232,6 +240,7 @@ class XProofClient:
         what: Optional[str] = None,
         when: Optional[str] = None,
         why: Optional[str] = None,
+        reversibility_class: Optional[ReversibilityClass] = None,
         metadata: Optional[Dict[str, Any]] = None,
     ) -> Certification:
         """Certify a file using a pre-computed SHA-256 hash.
@@ -253,6 +262,9 @@ class XProofClient:
             what: 4W — action hash or description.
             when: 4W — ISO-8601 timestamp.
             why: 4W — instruction or reason.
+            reversibility_class: Governance class — one of ``reversible``,
+                ``costly``, or ``irreversible``. Irreversible actions above
+                the configured confidence threshold trigger a policy violation.
             metadata: Arbitrary key-value metadata stored alongside the proof.
 
         Returns:
@@ -270,6 +282,8 @@ class XProofClient:
             proof_metadata["when"] = when
         if why is not None:
             proof_metadata["why"] = why
+        if reversibility_class is not None:
+            proof_metadata["reversibility_class"] = reversibility_class
 
         payload: Dict[str, Any] = {
             "filename": file_name,
@@ -296,6 +310,7 @@ class XProofClient:
         what: Optional[str] = None,
         when: Optional[str] = None,
         why: Optional[str] = None,
+        reversibility_class: Optional[ReversibilityClass] = None,
         metadata: Optional[Dict[str, Any]] = None,
     ) -> Certification:
         """Certify a file hash with confidence-level anchoring.
@@ -318,6 +333,10 @@ class XProofClient:
             what: 4W -- action hash or description.
             when: 4W -- ISO-8601 timestamp.
             why: 4W -- instruction or reason.
+            reversibility_class: Governance class, typed as one of
+                ``'reversible'``, ``'costly'``, or ``'irreversible'``.
+                Irreversible actions above the configured confidence threshold
+                trigger a policy violation.
             metadata: Extra key-value metadata stored alongside the proof.
 
         Returns:
@@ -349,6 +368,8 @@ class XProofClient:
             proof_metadata["when"] = when
         if why is not None:
             proof_metadata["why"] = why
+        if reversibility_class is not None:
+            proof_metadata["reversibility_class"] = reversibility_class
 
         payload: Dict[str, Any] = {
             "filename": file_name,
@@ -359,16 +380,18 @@ class XProofClient:
         data = self._request("POST", "/api/proof", json=payload)
         return Certification.from_dict(data)
 
-    def get_confidence_trail(self, decision_id: str) -> Dict[str, Any]:
+    def get_confidence_trail(self, decision_id: str) -> ConfidenceTrail:
         """Retrieve the full confidence trail for a decision chain.
 
         Args:
             decision_id: The shared identifier linking proofs in the chain.
 
         Returns:
-            A dictionary with ``decision_id``, ``total_anchors``,
+            A :class:`ConfidenceTrail` with ``decision_id``, ``total_anchors``,
             ``current_confidence``, ``current_stage``, ``is_finalized``,
+            ``policy_compliant``, ``policy_violations``,
             and ``stages`` (list of anchor details sorted by confidence).
+            Access the raw API dict via ``.raw``.
         """
         from urllib.parse import quote
         data = self._request(
@@ -376,7 +399,33 @@ class XProofClient:
             f"/api/confidence-trail/{quote(decision_id, safe='')}",
             auth_required=False,
         )
-        return data
+        return ConfidenceTrail.from_dict(data)
+
+    def get_policy_check(self, decision_id: str) -> PolicyCheckResult:
+        """Check policy compliance for a decision chain without fetching the full trail.
+
+        A lightweight alternative to :meth:`get_confidence_trail` for agents that
+        only need to know whether a decision chain is compliant and which proofs
+        violated the reversibility policy.
+
+        Args:
+            decision_id: The shared identifier linking proofs in the chain.
+
+        Returns:
+            A :class:`PolicyCheckResult` with ``policy_compliant``,
+            ``policy_violations``, ``total_anchors``, and ``checked_at``.
+            Access the raw API dict via ``.raw``.
+
+        Raises:
+            NotFoundError: If no proofs exist for this decision_id.
+        """
+        from urllib.parse import quote
+        data = self._request(
+            "GET",
+            f"/api/proofs/policy-check?decision_id={quote(decision_id, safe='')}",
+            auth_required=False,
+        )
+        return PolicyCheckResult.from_dict(data)
 
     def get_context_drift(self, decision_id: str) -> Dict[str, Any]:
         """Detect execution context drift across a decision chain.

{xproof-0.2.4 → xproof-0.2.6}/xproof/models.py

@@ -1,7 +1,114 @@
 """Data models for the xProof SDK."""
 
 from dataclasses import dataclass, field
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List, Literal, Optional
+
+ReversibilityClass = Literal["reversible", "costly", "irreversible"]
+
+
+@dataclass
+class PolicyViolation:
+    """A single policy violation detected by the server."""
+
+    rule: str
+    message: str
+    severity: str = "error"
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "PolicyViolation":
+        return cls(
+            rule=data.get("rule", ""),
+            message=data.get("message", ""),
+            severity=data.get("severity", "error"),
+        )
+
+
+@dataclass
+class ConfidenceTrailStage:
+    """One stage anchor in a confidence trail."""
+
+    proof_id: str
+    confidence_level: float
+    threshold_stage: str
+    reversibility_class: Optional[str] = None
+    anchored_at: str = ""
+    transaction_hash: str = ""
+    transaction_url: str = ""
+    policy_violations: List[PolicyViolation] = field(default_factory=list)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "ConfidenceTrailStage":
+        metadata = data.get("metadata", {})
+        violations_raw = data.get("policy_violations", [])
+        return cls(
+            proof_id=data.get("proof_id", data.get("id", "")),
+            confidence_level=data.get("confidence_level", metadata.get("confidence_level", 0.0)),
+            threshold_stage=data.get("threshold_stage", metadata.get("threshold_stage", "")),
+            reversibility_class=data.get(
+                "reversibility_class", metadata.get("reversibility_class")
+            ),
+            anchored_at=data.get("anchored_at", data.get("created_at", "")),
+            transaction_hash=data.get("transaction_hash", ""),
+            transaction_url=data.get("transaction_url", ""),
+            policy_violations=[PolicyViolation.from_dict(v) for v in violations_raw],
+        )
+
+
+@dataclass
+class ConfidenceTrail:
+    """Full confidence trail for a decision chain."""
+
+    decision_id: str
+    total_anchors: int = 0
+    current_confidence: float = 0.0
+    current_stage: str = ""
+    is_finalized: bool = False
+    policy_compliant: bool = True
+    policy_violations: List[PolicyViolation] = field(default_factory=list)
+    stages: List[ConfidenceTrailStage] = field(default_factory=list)
+    raw: Dict[str, Any] = field(default_factory=dict)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "ConfidenceTrail":
+        """Create a ConfidenceTrail from an API response dictionary."""
+        stages = [ConfidenceTrailStage.from_dict(s) for s in data.get("stages", [])]
+        violations_raw = data.get("policy_violations", [])
+        return cls(
+            decision_id=data.get("decision_id", ""),
+            total_anchors=data.get("total_anchors", len(stages)),
+            current_confidence=data.get("current_confidence", 0.0),
+            current_stage=data.get("current_stage", ""),
+            is_finalized=data.get("is_finalized", False),
+            policy_compliant=data.get("policy_compliant", True),
+            policy_violations=[PolicyViolation.from_dict(v) for v in violations_raw],
+            stages=stages,
+            raw=data,
+        )
+
+
+@dataclass
+class PolicyCheckResult:
+    """Lightweight governance compliance report for a decision chain."""
+
+    decision_id: str
+    total_anchors: int = 0
+    policy_compliant: bool = True
+    policy_violations: List[PolicyViolation] = field(default_factory=list)
+    checked_at: str = ""
+    raw: Dict[str, Any] = field(default_factory=dict)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "PolicyCheckResult":
+        """Create a PolicyCheckResult from an API response dictionary."""
+        violations_raw = data.get("policy_violations", [])
+        return cls(
+            decision_id=data.get("decision_id", ""),
+            total_anchors=data.get("total_anchors", 0),
+            policy_compliant=data.get("policy_compliant", True),
+            policy_violations=[PolicyViolation.from_dict(v) for v in violations_raw],
+            checked_at=data.get("checked_at", ""),
+            raw=data,
+        )
 
 
 @dataclass
@@ -21,11 +128,13 @@ class Certification:
     is_public: bool = True
     certificate_url: str = ""
     verify_url: str = ""
+    reversibility_class: Optional[str] = None
 
     @classmethod
     def from_dict(cls, data: Dict[str, Any]) -> "Certification":
         """Create a Certification from an API response dictionary."""
         blockchain = data.get("blockchain", {})
+        metadata = data.get("metadata", {})
         return cls(
             id=data.get("id", data.get("proof_id", "")),
             file_name=data.get("fileName", data.get("filename", data.get("file_name", ""))),
@@ -46,6 +155,9 @@ class Certification:
             is_public=data.get("isPublic", data.get("is_public", True)),
             certificate_url=data.get("certificateUrl", data.get("certificate_url", "")),
             verify_url=data.get("verifyUrl", data.get("verify_url", "")),
+            reversibility_class=data.get(
+                "reversibility_class", metadata.get("reversibility_class")
+            ),
         )
 
 

{xproof-0.2.4 → xproof-0.2.6}/xproof.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xproof
-Version: 0.2.4
+Version: 0.2.6
 Summary: Python SDK for xProof — blockchain-anchored proof-of-existence for AI agents on MultiversX
 Author-email: xProof <contact@xproof.app>
 License-Expression: MIT