multi-cid

Rust implementation of the multiformats Content Identifier (CID) specification for IPFS and IPLD.

A CID is a self-describing content address. It pairs a version, a target codec, and a multihash of the content. This crate supports CIDv0 (legacy, base58btc, implicit dag-pb) and CIDv1 (modern, multibase, explicit codec).

This crate contains only the Cid half of the former bs-multicid workspace crate. The Vlad half lives in the standalone multi-vlad crate. The split lets a downstream crate depend on only the type it needs: multi-cid depends on multi-hash but not on multi-key or multi-sig, which were only required by Vlad.

Table of Contents

• Features
• Install
• Usage
• Feature Flags
• The Split from bs-multicid
• Testing
• Maintainers
• Contribute
• License

Features

• CIDv0 and CIDv1 support.
• Builder pattern for CIDs from a codec, target codec, and multihash.
• Multibase encoding via multi-base and multi-util. EncodedCid detects the encoding on decode, so base58btc v0 CIDs and multibase v1 CIDs both round-trip.
• LegacyEncodedCid for bare base58btc-encoded v0 CIDs.
• Serde integration under the serde feature. Human-readable formats give a struct (version, encoding, hash); binary formats give the raw bytes.
• DAG-CBOR tag 42 support under the dag_cbor feature, via multi-cbor.
• Type-safe wrappers: CidVersion and ContentType.

Install

Add this to your Cargo.toml:

[dependencies]
multi-cid = "0.1"

For DAG-CBOR tag 42 support:

[dependencies]
multi-cid = { version = "0.1", features = ["dag_cbor"] }

MSRV: Rust 1.85 (Edition 2021).

Usage

use multi_cid::cid;
use multi_codec::Codec;
use multi_hash::Builder as MhBuilder;

// Create a multihash
let hash = MhBuilder::new_from_bytes(Codec::Sha2256, b"hello world")
    .unwrap()
    .try_build()
    .unwrap();

// Create a CID v1
let cid = cid::Builder::new(Codec::Sha2256)
    .with_target_codec(Codec::DagCbor)
    .with_hash(&hash)
    .try_build()
    .unwrap();

// Encode to bytes and round-trip
let bytes: Vec<u8> = cid.clone().into();
let decoded = cid::Cid::try_from(&bytes[..]).unwrap();
assert_eq!(cid, decoded);

Feature Flags

The Split from bs-multicid

The former bs-multicid workspace crate contained two types: Cid and Vlad. These types do not import from each other. They have disjoint dependency sets:

• Cid needs multi-hash for the Multihash field.
• Vlad needs multi-key and multi-sig for the inner Multisig.

Splitting the crate lets a downstream crate depend on only the type it needs. For example, wacc needs Cid but not Vlad, so wacc does not pull in multi-key or multi-sig.

The multi-cid crate is the Cid half. The multi-vlad crate is the Vlad half.

Testing

cargo test --all-features
cargo clippy --all-targets --all-features -- -D warnings
cargo doc --all-features --no-deps

Maintainers

• Dave Grantham dwg@linuxprogrammer.org

Contribute

Pull requests go to the cryptidtech/multi-cid repository. Sign commits with GPG. Use Conventional Commits messages.

License

Licensed under Apache-2.0.

See LICENSE for the full text.