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.

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

Creder renamed to SerderACDC to match keripy convention #166

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "cesride"
version = "0.6.3"
version = "0.6.4"
edition = "2021"
description = "Cryptographic primitives for use with Composable Event Streaming Representation (CESR)"
license = "Apache-2.0"
Expand Down
2 changes: 1 addition & 1 deletion src/core/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ pub mod bexter;
pub mod cigar;
pub mod common;
pub mod counter;
pub mod creder;
pub mod dater;
pub mod diger;
pub mod indexer;
Expand All @@ -15,6 +14,7 @@ pub mod saider;
pub mod salter;
pub mod seqner;
pub mod serder;
pub mod serder_acdc;
pub mod siger;
pub mod signer;
pub mod tholder;
Expand Down
56 changes: 30 additions & 26 deletions src/core/creder.rs → src/core/serder_acdc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,12 @@ use crate::{
error::{err, Error, Result},
};

/// SerderACDC is a serder subclass with Labels for ACDC packet types (ilks) and properties for
/// exposing field values of ACDC messages.
///
/// See Docs for Serder.
#[derive(Clone, Debug, PartialEq)]
pub struct Creder {
pub struct SerderACDC {
code: String,
raw: Vec<u8>,
ked: Value,
Expand All @@ -21,13 +25,13 @@ pub struct Creder {

fn validate_ident(ident: &str) -> Result<()> {
if ident != Identage::ACDC {
return err!(Error::Value("creder must be an ACDC".to_string()));
return err!(Error::Value("SerderACDC must be an ACDC".to_string()));
}

Ok(())
}

impl Creder {
impl SerderACDC {
pub fn new(
code: Option<&str>,
raw: Option<&[u8]>,
Expand All @@ -36,10 +40,10 @@ impl Creder {
sad: Option<&Self>,
) -> Result<Self> {
let code = code.unwrap_or(matter::Codex::Blake3_256);
let creder = Sadder::new(Some(code), raw, kind, ked, sad)?;
validate_ident(&creder.ident())?;
let serder_acdc = Sadder::new(Some(code), raw, kind, ked, sad)?;
validate_ident(&serder_acdc.ident())?;

Ok(creder)
Ok(serder_acdc)
}

pub fn new_with_ked(ked: &Value, code: Option<&str>, kind: Option<&str>) -> Result<Self> {
Expand Down Expand Up @@ -87,9 +91,9 @@ impl Creder {
}
}

impl Default for Creder {
impl Default for SerderACDC {
fn default() -> Self {
Creder {
SerderACDC {
code: matter::Codex::Blake3_256.to_string(),
raw: vec![],
ked: dat!({}),
Expand All @@ -102,7 +106,7 @@ impl Default for Creder {
}
}

impl Sadder for Creder {
impl Sadder for SerderACDC {
fn code(&self) -> String {
self.code.clone()
}
Expand Down Expand Up @@ -175,7 +179,7 @@ mod test {
Saider,
};

use super::{Creder, Sadder};
use super::{Sadder, SerderACDC};

#[test]
fn sanity() {
Expand Down Expand Up @@ -228,13 +232,13 @@ mod test {
let acdc_json = acdc_value.to_json().unwrap();
let acdc_message = acdc_json.as_bytes();

assert!(Creder::new_with_raw(keri_message).is_err());
let result = Creder::new(None, Some(acdc_message), None, None, None);
assert!(SerderACDC::new_with_raw(keri_message).is_err());
let result = SerderACDC::new(None, Some(acdc_message), None, None, None);
assert!(result.is_ok());
let creder = result.unwrap();
assert!(Creder::new_with_ked(&creder.crd(), None, None).is_ok());
let serder_acdc = result.unwrap();
assert!(SerderACDC::new_with_ked(&serder_acdc.crd(), None, None).is_ok());
assert_eq!(
creder.chains().unwrap().to_json().unwrap(),
serder_acdc.chains().unwrap().to_json().unwrap(),
dat!({
"d": "ECuynR9pRY6A6dWRlc2DTSF7AWY2a-w-6qhx7vd-pWT-",
"acceptedBlock": {
Expand All @@ -246,19 +250,19 @@ mod test {
.to_json()
.unwrap()
);
assert_eq!(creder.issuer().unwrap(), "ENayINhHQnx6525EpcTmkvo6ZixiJyiskwkVNbMPohYa");
assert_eq!(serder_acdc.issuer().unwrap(), "ENayINhHQnx6525EpcTmkvo6ZixiJyiskwkVNbMPohYa");
assert_eq!(
creder.subject().to_json().unwrap(),
serder_acdc.subject().to_json().unwrap(),
dat!({
"d": "EOsCUbK6Ve7qb-h15ljNyvVhLz2rq6iaCcA86AAoeZyX",
"dt": "2023-04-30T00:34:11.853572+00:00"
})
.to_json()
.unwrap()
);
assert_eq!(creder.schema().unwrap(), "EE5uDJTq5cc6AEdqbyMpvARUjsK_chNdInf3xyRoCBcT");
assert_eq!(serder_acdc.schema().unwrap(), "EE5uDJTq5cc6AEdqbyMpvARUjsK_chNdInf3xyRoCBcT");
assert_eq!(
creder.status().unwrap().unwrap(),
serder_acdc.status().unwrap().unwrap(),
"EINZnO3Z30Q7y2oV1sDCQphieRH244-XJFRAbzuFbU7n"
);

Expand All @@ -284,13 +288,13 @@ mod test {
let acdc_json = acdc_value.to_json().unwrap();
let acdc_message = acdc_json.as_bytes();

let creder = Creder::new_with_raw(acdc_message).unwrap();
let serder_acdc = SerderACDC::new_with_raw(acdc_message).unwrap();

assert_eq!(creder.status().unwrap(), None);
assert_eq!(creder.chains().unwrap(), dat!({}));
assert_eq!(creder.raw(), acdc_message);
assert_eq!(creder.kind(), Serialage::JSON);
assert_eq!(creder.size(), acdc_message.len() as u32);
assert_eq!(creder.version(), *CURRENT_VERSION);
assert_eq!(serder_acdc.status().unwrap(), None);
assert_eq!(serder_acdc.chains().unwrap(), dat!({}));
assert_eq!(serder_acdc.raw(), acdc_message);
assert_eq!(serder_acdc.kind(), Serialage::JSON);
assert_eq!(serder_acdc.size(), acdc_message.len() as u32);
assert_eq!(serder_acdc.version(), *CURRENT_VERSION);
}
}
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ pub use crate::{
cigar::Cigar,
common,
counter::{tables as counter, Counter}, // This seems like it shoudl be an abstract class
creder::Creder,
dater::Dater,
diger::Diger,
indexer::{tables as indexer, Indexer},
Expand All @@ -25,6 +24,7 @@ pub use crate::{
salter::Salter,
seqner::Seqner,
serder::Serder,
serder_acdc::SerderACDC,
siger::Siger,
signer::Signer,
tholder::Tholder,
Expand Down
Loading