Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Cid v2, Tagged Pointers #123

Closed
wants to merge 4 commits into from
Closed

WIP: Cid v2, Tagged Pointers #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
671887f
draft of CidV2 implementation
johnchandlerburnham Aug 5, 2022
44ea067
add test
johnchandlerburnham Aug 5, 2022
34f73cf
add v2 accessors and identity metadata test
johnchandlerburnham Aug 6, 2022
0175949
enable identity multihash feature in dev-deps
johnchandlerburnham Aug 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,4 @@ core2 = { version = "0.4", default-features = false }

[dev-dependencies]
serde_json = "1.0.59"
multihash = { version = "0.16.2", default-features = false, features = ["identity"] }
177 changes: 92 additions & 85 deletions src/arb.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,112 +5,119 @@ use std::convert::TryFrom;
use multihash::{Code, MultihashDigest, MultihashGeneric};
use quickcheck::Gen;
use rand::{
distributions::{weighted::WeightedIndex, Distribution},
Rng,
distributions::{weighted::WeightedIndex, Distribution},
Rng,
};

use arbitrary::{size_hint, Unstructured};

use crate::{CidGeneric, Version};

impl quickcheck::Arbitrary for Version {
fn arbitrary<G: Gen>(g: &mut G) -> Self {
let version = if g.gen_bool(0.7) { 1 } else { 0 };
Version::try_from(version).unwrap()
}
fn arbitrary<G: Gen>(g: &mut G) -> Self {
let version = if g.gen_bool(0.7) { 1 } else { 0 };
Version::try_from(version).unwrap()
}
}

impl<const S: usize> quickcheck::Arbitrary for CidGeneric<S> {
fn arbitrary<G: Gen>(g: &mut G) -> Self {
if S >= 32 && <Version as quickcheck::Arbitrary>::arbitrary(g) == Version::V0 {
let data: Vec<u8> = quickcheck::Arbitrary::arbitrary(g);
let hash = Code::Sha2_256
.digest(&data)
.resize()
.expect("digest too large");
CidGeneric::new_v0(hash).expect("sha2_256 is a valid hash for cid v0")
} else {
// In real world lower IPLD Codec codes more likely to happen, hence distribute them
// with bias towards smaller values.
let weights = [128, 32, 4, 4, 2, 2, 1, 1];
let dist = WeightedIndex::new(weights.iter()).unwrap();
let codec = match dist.sample(g) {
0 => g.gen_range(0, u64::pow(2, 7)),
1 => g.gen_range(u64::pow(2, 7), u64::pow(2, 14)),
2 => g.gen_range(u64::pow(2, 14), u64::pow(2, 21)),
3 => g.gen_range(u64::pow(2, 21), u64::pow(2, 28)),
4 => g.gen_range(u64::pow(2, 28), u64::pow(2, 35)),
5 => g.gen_range(u64::pow(2, 35), u64::pow(2, 42)),
6 => g.gen_range(u64::pow(2, 42), u64::pow(2, 49)),
7 => g.gen_range(u64::pow(2, 56), u64::pow(2, 63)),
_ => unreachable!(),
};

let hash: MultihashGeneric<S> = quickcheck::Arbitrary::arbitrary(g);
CidGeneric::new_v1(codec, hash)
}
impl<const S: usize, const M: usize> quickcheck::Arbitrary
for CidGeneric<S, M>
{
fn arbitrary<G: Gen>(g: &mut G) -> Self {
if S >= 32
&& <Version as quickcheck::Arbitrary>::arbitrary(g) == Version::V0
{
let data: Vec<u8> = quickcheck::Arbitrary::arbitrary(g);
let hash =
Code::Sha2_256.digest(&data).resize().expect("digest too large");
CidGeneric::new_v0(hash).expect("sha2_256 is a valid hash for cid v0")
} else {
// In real world lower IPLD Codec codes more likely to happen, hence distribute them
// with bias towards smaller values.
let weights = [128, 32, 4, 4, 2, 2, 1, 1];
let dist = WeightedIndex::new(weights.iter()).unwrap();
let codec = match dist.sample(g) {
0 => g.gen_range(0, u64::pow(2, 7)),
1 => g.gen_range(u64::pow(2, 7), u64::pow(2, 14)),
2 => g.gen_range(u64::pow(2, 14), u64::pow(2, 21)),
3 => g.gen_range(u64::pow(2, 21), u64::pow(2, 28)),
4 => g.gen_range(u64::pow(2, 28), u64::pow(2, 35)),
5 => g.gen_range(u64::pow(2, 35), u64::pow(2, 42)),
6 => g.gen_range(u64::pow(2, 42), u64::pow(2, 49)),
7 => g.gen_range(u64::pow(2, 56), u64::pow(2, 63)),
_ => unreachable!(),
};

let hash: MultihashGeneric<S> = quickcheck::Arbitrary::arbitrary(g);
CidGeneric::new_v1(codec, hash)
}
}
}

impl<'a, const S: usize> arbitrary::Arbitrary<'a> for CidGeneric<S> {
fn arbitrary(u: &mut Unstructured<'a>) -> arbitrary::Result<Self> {
if S >= 32 && u.ratio(1, 10)? {
let mh = MultihashGeneric::wrap(Code::Sha2_256.into(), u.bytes(32)?).unwrap();
return Ok(CidGeneric::new_v0(mh).expect("32 bytes is correct for v0"));
}

let mut codec = 0u64;
let mut len_choice = u.arbitrary::<u8>()? | 1;
impl<'a, const S: usize, const M: usize> arbitrary::Arbitrary<'a>
for CidGeneric<S, M>
{
fn arbitrary(u: &mut Unstructured<'a>) -> arbitrary::Result<Self> {
if S >= 32 && u.ratio(1, 10)? {
let mh =
MultihashGeneric::wrap(Code::Sha2_256.into(), u.bytes(32)?).unwrap();
return Ok(CidGeneric::new_v0(mh).expect("32 bytes is correct for v0"));
}

while len_choice & 1 == 1 {
len_choice >>= 1;
let mut codec = 0u64;
let mut len_choice = u.arbitrary::<u8>()? | 1;

let x = u.arbitrary::<u8>();
let next = codec
.checked_shl(8)
.zip(x.ok())
.map(|(next, x)| next.saturating_add(x as u64));
while len_choice & 1 == 1 {
len_choice >>= 1;

match next {
None => break,
Some(next) => codec = next,
}
}
let x = u.arbitrary::<u8>();
let next = codec
.checked_shl(8)
.zip(x.ok())
.map(|(next, x)| next.saturating_add(x as u64));

Ok(CidGeneric::new_v1(codec, u.arbitrary()?))
match next {
None => break,
Some(next) => codec = next,
}
}

fn size_hint(depth: usize) -> (usize, Option<usize>) {
let v1 = size_hint::and_all(&[
<[u8; 2]>::size_hint(depth),
(0, Some(8)),
<MultihashGeneric<S> as arbitrary::Arbitrary>::size_hint(depth),
]);
if S >= 32 {
size_hint::and(<u8>::size_hint(depth), size_hint::or((32, Some(32)), v1))
} else {
v1
}
Ok(CidGeneric::new_v1(codec, u.arbitrary()?))
}

fn size_hint(depth: usize) -> (usize, Option<usize>) {
let v1 = size_hint::and_all(&[
<[u8; 2]>::size_hint(depth),
(0, Some(8)),
<MultihashGeneric<S> as arbitrary::Arbitrary>::size_hint(depth),
]);
if S >= 32 {
size_hint::and(<u8>::size_hint(depth), size_hint::or((32, Some(32)), v1))
} else {
v1
}
}
}

#[cfg(test)]
mod tests {
use crate::CidGeneric;
use arbitrary::{Arbitrary, Unstructured};
use multihash::MultihashGeneric;

#[test]
fn arbitrary() {
let mut u = Unstructured::new(&[
1, 22, 41, 13, 5, 6, 7, 8, 9, 6, 10, 243, 43, 231, 123, 43, 153, 127, 67, 76, 24, 91,
23, 32, 32, 23, 65, 98, 193, 108, 3,
]);
let c = <CidGeneric<16> as Arbitrary>::arbitrary(&mut u).unwrap();
let c2 =
CidGeneric::<16>::new_v1(22, MultihashGeneric::wrap(13, &[6, 7, 8, 9, 6]).unwrap());
assert_eq!(c.hash(), c2.hash());
assert_eq!(c.codec(), c2.codec());
assert_eq!(c, c2)
}
use crate::CidGeneric;
use arbitrary::{Arbitrary, Unstructured};
use multihash::MultihashGeneric;

#[test]
fn arbitrary() {
let mut u = Unstructured::new(&[
1, 22, 41, 13, 5, 6, 7, 8, 9, 6, 10, 243, 43, 231, 123, 43, 153, 127, 67,
76, 24, 91, 23, 32, 32, 23, 65, 98, 193, 108, 3,
]);
let c = <CidGeneric<16, 0> as Arbitrary>::arbitrary(&mut u).unwrap();
let c2 = CidGeneric::<16, 0>::new_v1(
22,
MultihashGeneric::wrap(13, &[6, 7, 8, 9, 6]).unwrap(),
);
assert_eq!(c.hash(), c2.hash());
assert_eq!(c.codec(), c2.codec());
assert_eq!(c, c2)
}
}
Loading