xrpld-lab 3.0.0__tar.gz

xrpld_lab-3.0.0/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: xrpld-lab
+Version: 3.0.0
+Summary: Build xrpld networks and standalone ledgers
+Author: Denis Angell
+Author-email: dangell@transia.co
+Requires-Python: >=3.9.6,<4.0.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: xrpld-publisher (>=2.0.0,<3.0.0)

xrpld_lab-3.0.0/pyproject.toml

@@ -0,0 +1,25 @@
+[tool.poetry]
+name = "xrpld-lab"
+version = "3.0.0"
+description = "Build xrpld networks and standalone ledgers"
+authors = ["Denis Angell <dangell@transia.co>"]
+packages = [
+    { include = "xrpld_lab" },
+]
+
+[tool.poetry.dependencies]
+python = "^3.9.6"
+pyyaml = "^6.0.1"
+requests = "^2.31.0"
+xrpld-publisher = "^2.0.0"
+
+[tool.poetry.dev-dependencies]
+pytest = "^7.2.1"
+flake8 = "^3.8.4"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+xrpld-lab = "xrpld_lab.cli:main"

xrpld_lab-3.0.0/xrpld_lab/__init__.py

@@ -0,0 +1 @@
+__version__ = "3.0.0"

xrpld_lab-3.0.0/xrpld_lab/amendments.py

@@ -0,0 +1,147 @@
+"""Amendment parsing and genesis-file helpers.
+
+Parses C++ feature macro lines (XRPL_FEATURE, XRPL_FIX, REGISTER_FEATURE,
+REGISTER_FIX) to extract amendment names and their SHA-512-half hashes,
+then optionally writes them into a genesis JSON ledger.
+"""
+
+import hashlib
+import os
+import re
+from typing import Dict, List
+
+from xrpld_lab.utils import read_json
+
+_PACKAGE_DIR = os.path.abspath(os.path.dirname(__file__))
+
+
+# ---------------------------------------------------------------------------
+# Helpers
+# ---------------------------------------------------------------------------
+
+
+def _amendment_name_hash(name: str) -> str:
+    """SHA-512 half of a UTF-8 amendment name (first 64 hex chars, uppercase)."""
+    return hashlib.sha512(name.encode("utf-8")).digest().hex().upper()[:64]
+
+
+# ---------------------------------------------------------------------------
+# Public API
+# ---------------------------------------------------------------------------
+
+
+def parse_supported(value: str) -> bool:
+    """Parse C++ Supported/DefaultVote value.  ``'no'`` -> False, else True."""
+    return value != "no"
+
+
+def get_feature_lines_from_path(path: str) -> list[str]:
+    """Read a C++ feature file and return its lines."""
+    with open(path, "r") as f:
+        return f.readlines()
+
+
+def get_feature_lines_from_content(content: bytes) -> list[str]:
+    """Decode *bytes* content and split into lines."""
+    return content.decode("utf-8").splitlines()
+
+
+def parse_amendments(lines: list) -> Dict[str, str]:
+    """Parse C++ macro lines into ``{amendment_name: sha512_half_hash}``.
+
+    Handles four macro styles:
+
+    * ``XRPL_FEATURE(Name, ...)``
+    * ``XRPL_FIX(Name, ...)`` -- prepends ``"fix"`` to the name
+    * ``REGISTER_FEATURE(Name, ...)``
+    * ``REGISTER_FIX(Name, ...)``
+
+    Only amendments marked ``Supported::yes`` (or any value other than ``no``)
+    are included.  The hash is the first 64 hex characters of the SHA-512
+    digest of the UTF-8 encoded amendment name.
+    """
+    amendments: Dict[str, dict] = {}
+
+    for line in lines:
+        amendment_name: str = ""
+
+        if re.match(r"XRPL_FIX", line):
+            m = re.search(r"XRPL_FIX\)?.*?\((.*?),", line)
+            if not m:
+                continue
+            amendment_name = f"fix{m.group(1)}"
+        elif re.match(r"XRPL_FEATURE", line):
+            m = re.search(r"XRPL_FEATURE\((.*?),", line)
+            if not m:
+                continue
+            amendment_name = m.group(1)
+        elif re.match(r"REGISTER_FIX", line):
+            m = re.search(r"REGISTER_FIX\)?.*?\((.*?),", line)
+            if not m:
+                continue
+            amendment_name = m.group(1)
+        elif re.match(r"REGISTER_FEATURE", line):
+            m = re.search(r"REGISTER_FEATURE\((.*?),", line)
+            if not m:
+                continue
+            amendment_name = m.group(1)
+        else:
+            continue
+
+        supported_match = re.findall(r"Supported::(yes|no)", line)
+        default_vote_match = re.findall(r"DefaultVote::(yes|no)", line)
+
+        amendments[amendment_name] = {
+            "supported": parse_supported(
+                supported_match[0] if supported_match else "no"
+            ),
+            "default_vote": parse_supported(
+                default_vote_match[0] if default_vote_match else "no"
+            ),
+        }
+
+    return {
+        k: _amendment_name_hash(k)
+        for k, v in amendments.items()
+        if v["supported"] is True
+    }
+
+
+def convert_to_list_of_hashes(features: Dict[str, str]) -> List[str]:
+    """Return a flat list of hash strings from *features*."""
+    return list(features.values())
+
+
+def update_genesis(
+    features: Dict[str, str],
+    protocol_name: str,
+    genesis_path: str = None,
+) -> dict:
+    """Update a genesis JSON file with amendment hashes.
+
+    Parameters
+    ----------
+    features:
+        ``{name: hash}`` mapping produced by :func:`parse_amendments`.
+    protocol_name:
+        ``"xrpl"`` or ``"xahau"``.
+    genesis_path:
+        Explicit path to a genesis JSON file.  When *None* the default
+        package location ``xrpld_lab/genesis.<protocol>.json`` is used.
+
+    Returns
+    -------
+    dict
+        The full genesis dict with the ``Amendments`` list replaced.
+    """
+    if genesis_path is None:
+        genesis_path = os.path.join(_PACKAGE_DIR, f"genesis.{protocol_name}.json")
+
+    json_dict = read_json(genesis_path)
+    new_amendments: List[str] = convert_to_list_of_hashes(features)
+
+    for entry in json_dict["ledger"]["accountState"]:
+        if "Amendments" in entry:
+            entry["Amendments"] = new_amendments
+
+    return json_dict