Skip to content

README.md

Latest commit

 

History

History
58 lines (40 loc) · 1.92 KB

README.md

File metadata and controls

58 lines (40 loc) · 1.92 KB
Raw

Python IPLD

This project aims to speed up The AT Protocol SDK by using Rust for the heavy lifting. Only atproto related parts are implemented first.

Code snippet:

import libipld

# CID
print(libipld.decode_cid('bafyreig7jbijxpn4lfhvnvyuwf5u5jyhd7begxwyiqe7ingwxycjdqjjoa'))
# Output: {'hash': {'size': 32, 'code': 18, 'digest': b'\xdfHP\x9b\xbd\xbcYOV\xd7\x14\xb1{N\xa7\x07\x1f\xc2C^\xd8D\t\xf44\xd6\xbe\x04\x91\xc1)p'}, 'version': 1, 'codec': 113}
print(libipld.encode_cid(b'\x01q\x12 \xb6\x81\x1a\x1d\x7f\x8c\x17\x91\xdam\x1bO\x13m\xc0\xe2&y\xea\xfe\xaaX\xd6M~/\xaa\xd5\x89\x0e\x9d\x9c'))
# Output: bafyreifwqenb274mc6i5u3i3j4jw3qhcez46v7vkldle27rpvlkysdu5tq

# DAG-CBOR
print(libipld.decode_dag_cbor(b'\xa2aa\x0cabfhello!'))
# Output: {'a': 12, 'b': 'hello!'}
print(libipld.encode_dag_cbor({'a': 12, 'b': 'hello!'}))
# Output: b'\xa2aa\x0cabfhello!'

# multibase
print(libipld.decode_multibase('ueWVzIG1hbmkgIQ'))
# Output: ('u', b'yes mani !')
print(libipld.encode_multibase('u', b'yes mani !'))
# Output: ueWVzIG1hbmkgIQ

Features

  • Decode DAG-CBOR (decode_dag_cbor(bytes) -> dict, decode_dag_cbor_multi(bytes) -> list[dict])
  • Encode DAG-CBOR (encode_dag_cbor(obj) -> bytes)
  • Decode CID (decode_cid(str | bytes) -> dict). Accepts CID stringified form or CID raw byte form.
  • Encode CID (encode_cid(bytes) -> str). Encodes CID raw byte form to stringified form.
  • Decode Multibase (decode_multibase(str) -> tuple[str, bytes]). Returns base and data.
  • Encode Multibase (encode_multibase(str, bytes) -> str). Accepts base and data.
  • Decode CAR (decode_car(bytes) -> tuple[dict, dict[bytes, dict]]). Returns a header and blocks mapped by CID. CIDs in raw byte form.

Requirements

  • Python 3.8 or higher.

Installing

You can install or upgrade libipld via

pip install libipld

Contributing

Contributions of all sizes are welcome.

License

MIT