feat: Bitswap py-cid Migration Phase 1 + Phase 2 (#1235)

* the helper function required for proper conversion the terms to the CID object

* pushed the builder part

* pushed the new functions for compute cid v0 or cid v1

* removed the unused functions

* fix: PR 1235 – add newsfragment, type aliases, narrow exceptions, parse_cid docstring

- Add newsfragments/1234.feature.rst for issue #1234
- Fix mypy: CIDInput/CIDObject as TypeAlias in libp2p/bitswap/cid.py
- Narrow except Exception to ValueError in get_cid_prefix, reconstruct_cid_from_prefix_and_data, verify_cid, parse_cid_version, parse_cid_codec
- Docstring: parse_cid accepts hex with or without 0x

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: acul71 <34693171+acul71@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

Author: 3 people

examples/cid/cid_usage.py

@@ -9,11 +9,11 @@
 from libp2p.bitswap.cid import (
     CODEC_DAG_PB,
     CODEC_RAW,
-    analyze_cid_collection,
     compute_cid_v0,
     compute_cid_v1,
-    detect_cid_encoding_format,
-    recompute_cid_from_data,
+    compute_cid_v1_obj,
+    parse_cid_codec,
+    parse_cid_version,
     verify_cid,
 )
 
@@ -44,33 +44,17 @@ def main() -> None:
         ("CIDv1 raw", cid_v1_raw),
         ("CIDv1 dag-pb", cid_v1_dag_pb),
     ]:
-        info = detect_cid_encoding_format(cid)
-        if "error" in info:
-            logger.info("%s: %s", name, info["error"])
-        else:
-            logger.info(
-                "%s: version=%s, codec=%s, encoding=%s, is_breaking=%s",
-                name,
-                info["version"],
-                info["codec_name"],
-                info["encoding"],
-                info["is_breaking"],
-            )
-
-    try:
-        recomputed = recompute_cid_from_data(cid_v1_raw, data)
-        logger.info("Recomputed CID matches original: %s", cid_v1_raw == recomputed)
-    except ValueError as e:
-        logger.info("Recompute error: %s", e)
-
-    collection = [cid_v0, cid_v1_raw, cid_v1_dag_pb]
-    analysis = analyze_cid_collection(collection)
+        logger.info(
+            "%s: version=%s, codec=%s",
+            name,
+            parse_cid_version(cid),
+            parse_cid_codec(cid),
+        )
+
+    cid_obj = compute_cid_v1_obj(data, codec=CODEC_RAW)
+    logger.info("CIDv1 object text form: %s", cid_obj)
     logger.info(
-        "Collection: total=%s, backward_compatible=%s, breaking_change=%s, by_codec=%s",
-        analysis["total"],
-        analysis["backward_compatible"],
-        analysis["breaking_change"],
-        analysis["by_codec"],
+        "CIDv1 object bytes == compute_cid_v1 bytes: %s", cid_obj.buffer == cid_v1_raw
     )
 
 

libp2p/bitswap/__init__.py

@@ -11,8 +11,14 @@
 from . import config
 from .cid import (
     compute_cid,
+    compute_cid_obj,
     compute_cid_v0,
+    compute_cid_v0_obj,
     compute_cid_v1,
+    compute_cid_v1_obj,
+    parse_cid,
+    cid_to_bytes,
+    cid_to_text,
     get_cid_prefix,
     reconstruct_cid_from_prefix_and_data,
     verify_cid,
@@ -41,8 +47,14 @@
     "config",
     # CID utilities
     "compute_cid",
+    "compute_cid_obj",
     "compute_cid_v0",
+    "compute_cid_v0_obj",
     "compute_cid_v1",
+    "compute_cid_v1_obj",
+    "parse_cid",
+    "cid_to_bytes",
+    "cid_to_text",
     "get_cid_prefix",
     "reconstruct_cid_from_prefix_and_data",
     "verify_cid",