Struct Document 

pub struct Document {
    pub context: Vec<String>,
    pub id: String,
    pub controller: Vec<String>,
    pub verification_method: Vec<VerificationMethod>,
    pub assertion_method: Vec<String>,
    pub key_agreement: Vec<String>,
    pub proof: Proof,
    pub identity: Option<String>,
    pub created_at: String,
    pub updated_at: String,
    pub ma: Option<Ipld>,
}

A did:ma: DID document.

Contains verification methods, proof, and optional extension data. Documents are signed with Ed25519 over a BLAKE3 hash of the dag-cbor-serialized payload (all fields except proof).

Examples

use ma_did::{generate_identity, Document};

let id = generate_identity(
    "k51qzi5uqu5dj9807pbuod1pplf0vxh8m4lfy3ewl9qbm2s8dsf9ugdf9gedhr"
).unwrap();

// Verify the signature
id.document.verify().unwrap();

// Validate structural correctness
id.document.validate().unwrap();

// Round-trip through JSON
let json = id.document.marshal().unwrap();
let restored = Document::unmarshal(&json).unwrap();
assert_eq!(id.document, restored);

// Round-trip through CBOR
let cbor = id.document.to_cbor().unwrap();
let restored = Document::from_cbor(&cbor).unwrap();
assert_eq!(id.document, restored);

Extension namespace

The ma field is an opaque IPLD value for application-defined extension data. did-ma does not interpret or validate its contents. Using Ipld gives native support for CID links and dag-cbor/dag-json round-tripping.

use std::collections::BTreeMap;
use ipld_core::ipld::Ipld;
use ma_did::{Did, Document};

let did = Did::new_url("k51qzi5uqu5dj9807pbuod1pplf0vxh8m4lfy3ewl9qbm2s8dsf9ugdf9gedhr", None::<String>).unwrap();
let mut doc = Document::new(&did, &did);
let ma = Ipld::Map(BTreeMap::from([
    ("type".into(), Ipld::String("agent".into())),
    ("services".into(), Ipld::Map(BTreeMap::new())),
]));
doc.set_ma(ma);
assert!(doc.ma.is_some());
doc.clear_ma();
assert!(doc.ma.is_none());

Fields

context: Vec<String>

id: String

controller: Vec<String>

verification_method: Vec<VerificationMethod>

assertion_method: Vec<String>

key_agreement: Vec<String>

proof: Proof

identity: Option<String>

created_at: String

updated_at: String

ma: Option<Ipld>

Implementations

impl Document

pub fn new(identity: &Did, controller: &Did) -> Self

pub fn set_ma(&mut self, ma: Ipld)

Set the opaque ma extension namespace.

pub fn clear_ma(&mut self)

Clear the ma extension namespace.

pub fn to_cbor(&self) -> Result<Vec<u8>>

pub fn from_cbor(bytes: &[u8]) -> Result<Self>

pub fn marshal(&self) -> Result<String>

pub fn unmarshal(s: &str) -> Result<Self>

pub fn add_controller(&mut self, controller: impl Into<String>) -> Result<()>

pub fn add_verification_method( &mut self, method: VerificationMethod, ) -> Result<()>

pub fn get_verification_method_by_id( &self, method_id: &str, ) -> Result<&VerificationMethod>

pub fn set_identity(&mut self, identity: impl Into<String>) -> Result<()>

pub fn touch(&mut self)

Update the updatedAt timestamp to the current time.

pub fn assertion_method_public_key(&self) -> Result<VerifyingKey>

pub fn key_agreement_public_key_bytes(&self) -> Result<[u8; 32]>

pub fn payload_document(&self) -> Self

pub fn payload_bytes(&self) -> Result<Vec<u8>>

pub fn payload_hash(&self) -> Result<[u8; 32]>

pub fn sign( &mut self, signing_key: &SigningKey, verification_method: &VerificationMethod, ) -> Result<()>

pub fn verify(&self) -> Result<()>

pub fn validate(&self) -> Result<()>

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Document

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Document

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Document

fn eq(&self, other: &Document) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Document

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Document

impl StructuralPartialEq for Document