1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

// Copyright 2020-2022 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

use core::fmt::Debug;
use core::fmt::Display;
use core::fmt::Formatter;
use core::fmt::Result as FmtResult;

use serde::Deserialize;
use serde::Serialize;

use identity_core::convert::FmtJson;
use identity_iota_core::did::IotaDID;
use identity_iota_core::diff::DiffMessage;
use identity_iota_core::document::IotaDocument;
use identity_iota_core::tangle::MessageId;
use identity_iota_core::tangle::MessageIdExt;

use crate::error::Result;
use crate::tangle::TangleRef;

/// An IOTA DID document resolved from the Tangle. Represents an integration chain message possibly
/// merged with one or more diff messages.
#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
pub struct ResolvedIotaDocument {
  #[serde(flatten)]
  pub document: IotaDocument,

  /// [`MessageId`] of this integration chain document.
  #[serde(
    rename = "integrationMessageId",
    default = "MessageId::null",
    skip_serializing_if = "MessageIdExt::is_null"
  )]
  pub integration_message_id: MessageId,

  /// [`MessageId`] of the last diff chain message merged into this during resolution, or null.
  #[deprecated(since = "0.5.0", note = "diff chain features are slated for removal")]
  #[serde(
    rename = "diffMessageId",
    default = "MessageId::null",
    skip_serializing_if = "MessageIdExt::is_null"
  )]
  pub diff_message_id: MessageId,
  // TODO: version_id
}

impl ResolvedIotaDocument {
  /// Attempts to merge changes from a [`DiffMessage`] into this document and
  /// updates the [`ResolvedIotaDocument::diff_message_id`].
  ///
  /// If merging fails the document remains unmodified, otherwise this represents
  /// the merged document state.
  ///
  /// See [`IotaDocument::merge_diff`].
  ///
  /// # Errors
  ///
  /// Fails if the merge operation or signature verification on the diff fails.
  #[deprecated(since = "0.5.0", note = "diff chain features are slated for removal")]
  pub fn merge_diff_message(&mut self, diff_message: &DiffMessage) -> Result<()> {
    self.document.merge_diff(diff_message)?;
    self.diff_message_id = *diff_message.message_id();

    Ok(())
  }
}

impl TangleRef for ResolvedIotaDocument {
  fn did(&self) -> &IotaDID {
    self.document.id()
  }

  fn message_id(&self) -> &MessageId {
    &self.integration_message_id
  }

  fn set_message_id(&mut self, message_id: MessageId) {
    self.integration_message_id = message_id;
  }

  fn previous_message_id(&self) -> &MessageId {
    &self.document.metadata.previous_message_id
  }

  fn set_previous_message_id(&mut self, message_id: MessageId) {
    self.document.metadata.previous_message_id = message_id;
  }
}

impl Display for ResolvedIotaDocument {
  fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
    self.fmt_json(f)
  }
}

impl From<IotaDocument> for ResolvedIotaDocument {
  fn from(document: IotaDocument) -> Self {
    Self {
      document,
      integration_message_id: MessageId::null(),
      diff_message_id: MessageId::null(),
    }
  }
}

impl AsRef<IotaDocument> for ResolvedIotaDocument {
  fn as_ref(&self) -> &IotaDocument {
    &self.document
  }
}

#[cfg(test)]
mod tests {
  use identity_core::convert::FromJson;
  use identity_core::convert::ToJson;
  use identity_core::crypto::KeyPair;
  use identity_core::crypto::KeyType;

  use super::*;

  // Characterization test: We need to be informed if it becomes impossible to deserialize a serialized `IotaDocument`
  // into a `ResolvedIotaDocument` as the Wasm bindings currently depend on this fact.
  #[test]
  fn can_deserialize_from_iota_document() {
    let private_key: &[u8] = &[0; 32];
    let keypair: KeyPair = KeyPair::try_from_private_key_bytes(KeyType::Ed25519, private_key).unwrap();

    let document: IotaDocument = IotaDocument::new(&keypair).unwrap();
    let deserialization: Result<ResolvedIotaDocument, identity_core::Error> =
      ResolvedIotaDocument::from_json(document.to_json().unwrap().as_str());

    assert!(deserialization.is_ok());
    assert_eq!(deserialization.unwrap().document, document);
  }
}