Merge pull request #38 from iotaledger/feat/notarization-api

feat: read-only notarization api

Author: itsyaasir

Cargo.toml

@@ -14,12 +14,12 @@ members = ["notarization-rs"]
 anyhow = "1.0"
 async-trait = "0.1.88"
 cfg-if = "1.0"
+bcs = { version = "0.1.6" }
 fastcrypto = { git = "https://github.com/MystenLabs/fastcrypto", rev = "2f502fd8570fe4e9cff36eea5bbd6fef22002898", package = "fastcrypto" }
-identity_iota_core = { git = "https://github.com/iotaledger/identity.rs.git", branch = "feat/identity-rebased-alpha-public-interaction-rust", default-features = false, features = [
-    "iota-client",
-], package = "identity_iota_core" }
-identity_iota_interaction = { git = "https://github.com/iotaledger/identity.rs.git", branch = "feat/identity-rebased-alpha-public-interaction-rust", package = "identity_iota_interaction" }
+iota_interaction = { git = "https://github.com/iotaledger/product-core.git", branch = "feat/add-dev-inspect-tx", package = "iota_interaction" }
+iota_interaction_rust = { git = "https://github.com/iotaledger/product-core.git", branch = "feat/add-dev-inspect-tx", package = "iota_interaction_rust" }
 phf = { version = "0.11.2", features = ["macros"] }
+product_common = { git = "https://github.com/iotaledger/product-core.git", branch = "feat/add-dev-inspect-tx", package = "product_common" }
 serde = { version = "1.0", default-features = false, features = [
     "alloc",
     "derive",

notarization-move/sources/notarization.move

@@ -350,12 +350,12 @@ public fun version_count<D: store + drop + copy>(self: &Notarization<D>): u64 {
     self.state_version_count
 }
 
-public fun description<D: store + drop + copy>(self: &Notarization<D>): &Option<String> {
-    &self.immutable_metadata.description
+public fun description<D: store + drop + copy>(self: &Notarization<D>): Option<String> {
+    self.immutable_metadata.description
 }
 
-public fun updateable_metadata<D: store + drop + copy>(self: &Notarization<D>): &Option<String> {
-    &self.updateable_metadata
+public fun updateable_metadata<D: store + drop + copy>(self: &Notarization<D>): Option<String> {
+    self.updateable_metadata
 }
 
 public fun notarization_method<D: store + drop + copy>(self: &Notarization<D>): NotarizationMethod {
@@ -425,7 +425,7 @@ public fun is_destroy_allowed<D: store + drop + copy>(self: &Notarization<D>, cl
 /// See fun `are_locked_notarization_invariants_ok()` and
 /// `are_dynamic_notarization_invariants_ok()`
 /// for more details.
-public fun assert_method_specific_invariants<D: store + drop + copy>(self: &Notarization<D>) {
+public(package) fun assert_method_specific_invariants<D: store + drop + copy>(self: &Notarization<D>) {
     if (self.method.is_dynamic()) {
         assert!(
             are_dynamic_notarization_invariants_ok(&self.immutable_metadata),
@@ -443,7 +443,7 @@ public fun assert_method_specific_invariants<D: store + drop + copy>(self: &Nota
 ///
 /// - `self.immutable_metadata.locking` must exist.
 /// - `updated_lock` and `transfer_lock` must be `TimeLock::UntilDestroyed`.
-public fun are_locked_notarization_invariants_ok(immutable_metadata: &ImmutableMetadata): bool {
+public(package) fun are_locked_notarization_invariants_ok(immutable_metadata: &ImmutableMetadata): bool {
     if (immutable_metadata.locking.is_some()) {
         let lock_metadata = option::borrow(&immutable_metadata.locking);
         timelock::is_until_destroyed(&lock_metadata.transfer_lock) && timelock::is_until_destroyed(&lock_metadata.update_lock)
@@ -459,7 +459,7 @@ public fun are_locked_notarization_invariants_ok(immutable_metadata: &ImmutableM
 ///   If `immutable_metadata.locking` exists, all locks except `transfer_lock`
 ///   must be `TimeLock::None`
 ///   and the `transfer_lock` must not be `TimeLock::None`.
-public fun are_dynamic_notarization_invariants_ok(immutable_metadata: &ImmutableMetadata): bool {
+public(package) fun are_dynamic_notarization_invariants_ok(immutable_metadata: &ImmutableMetadata): bool {
     if (immutable_metadata.locking.is_some()) {
         let lock_metadata = option::borrow(&immutable_metadata.locking);
 

notarization-rs/Cargo.toml

@@ -15,38 +15,46 @@ description = "A data notarization toolkit for the IOTA Ledger."
 anyhow.workspace = true
 cfg-if.workspace = true
 fastcrypto.workspace = true
-identity_iota_core.workspace = true
 phf.workspace = true
+product_common = { workspace = true, features = ["transaction"] }
 serde.workspace = true
 serde_json.workspace = true
 thiserror.workspace = true
 strum.workspace = true
+async-trait.workspace = true
+bcs.workspace = true
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
-identity_iota_interaction.workspace = true
+iota_interaction = { git = "https://github.com/iotaledger/product-core.git", branch = "feat/add-dev-inspect-tx", package = "iota_interaction", default-features = false }
+iota_interaction_rust = { git = "https://github.com/iotaledger/product-core.git", branch = "feat/add-dev-inspect-tx", package = "iota_interaction_rust", default-features = false }
 iota-config = { git = "https://github.com/iotaledger/iota.git", package = "iota-config", tag = "v0.11.6-rc" }
 iota-sdk = { git = "https://github.com/iotaledger/iota.git", package = "iota-sdk", tag = "v0.11.6-rc" }
 move-core-types = { git = "https://github.com/iotaledger/iota.git", package = "move-core-types", tag = "v0.11.6-rc" }
-secret-storage = { git = "https://github.com/iotaledger/secret-storage.git", tag = "v0.3.0" }
+secret-storage = { git = "https://github.com/iotaledger/secret-storage.git", tag = "v0.3.0", default-features = false }
 shared-crypto = { git = "https://github.com/iotaledger/iota.git", package = "shared-crypto", tag = "v0.11.6-rc" }
-tokio = { version = "1.29.0", default-features = false, features = ["macros", "sync", "rt", "process"] }
+tokio = { version = "1.29.0", default-features = false, features = [
+    "macros",
+    "sync",
+    "rt",
+    "process",
+] }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
-identity_iota_interaction = { git = "https://github.com/iotaledger/identity.rs.git", branch = "feat/identity-rebased-alpha-public-interaction-rust", package = "identity_iota_interaction", default-features = false }
-iota_interaction_ts = { git = "https://github.com/iotaledger/identity.rs.git", branch = "feat/identity-rebased-alpha-public-interaction-rust", package = "iota_interaction_ts" }
-secret-storage = { git = "https://github.com/iotaledger/secret-storage.git", default-features = false, tag = "v0.3.0" }
+iota_interaction = { git = "https://github.com/iotaledger/product-core.git", branch = "feat/add-dev-inspect-tx", package = "iota_interaction", default-features = false }
+iota_interaction_ts = { git = "https://github.com/iotaledger/product-core.git", branch = "feat/add-dev-inspect-tx", package = "iota_interaction_ts" }
 
-[target.'cfg(target_arch = "wasm32")'.dependencies.identity_iota_core]
-git = "https://github.com/iotaledger/identity.rs.git"
-branch = "feat/identity-rebased-alpha-public-interaction-rust"
-package = "identity_iota_core"
-default-features = false
-features = ["iota-client", "revocation-bitmap"]
 
 [dev-dependencies]
 async-trait.workspace = true
 identity_jose = { git = "https://github.com/iotaledger/identity.rs.git", branch = "feat/identity-rebased-alpha-public-interaction-rust", package = "identity_jose" }
-identity_storage = { git = "https://github.com/iotaledger/identity.rs.git", branch = "feat/identity-rebased-alpha-public-interaction-rust", package = "identity_storage", features = ["send-sync-storage", "storage-signer"] }
-identity_iota_interaction = { git = "https://github.com/iotaledger/identity.rs.git", branch = "feat/identity-rebased-alpha-public-interaction-rust", package = "identity_iota_interaction", features = ["keytool-signer"] }
+identity_storage = { git = "https://github.com/iotaledger/identity.rs.git", branch = "feat/identity-rebased-alpha-public-interaction-rust", package = "identity_storage", features = [
+    "send-sync-storage",
+    "storage-signer",
+] }
+iota_interaction = { git = "https://github.com/iotaledger/product-core.git", branch = "feat/add-dev-inspect-tx", package = "iota_interaction" }
 lazy_static = "1.5.0"
 
+[features]
+send-sync = ["send-sync-storage"]
+# Enables `Send` + `Sync` bounds for the storage traits.
+send-sync-storage = ["secret-storage/send-sync-storage"]

notarization-rs/src/client/full_client.rs

@@ -0,0 +1,83 @@
+use std::ops::Deref;
+
+use iota_interaction::types::base_types::{IotaAddress, ObjectID};
+use iota_interaction::types::crypto::PublicKey;
+use iota_interaction::{IotaKeySignature, OptionalSync};
+use iota_interaction_rust::IotaClientAdapter;
+use product_common::core_client::{CoreClient, CoreClientReadOnly};
+use product_common::network_name::NetworkName;
+use secret_storage::Signer;
+
+use super::read_only::NotarizationClientReadOnly;
+use crate::error::Error;
+
+/// A client for interacting with the IOTA network.
+#[derive(Clone)]
+pub struct NotarizationClient<S> {
+    /// [`NotarizationClientReadOnly`] instance, used for read-only operations.
+    read_client: NotarizationClientReadOnly,
+    /// The public key of the client.
+    public_key: PublicKey,
+    /// The signer of the client.
+    signer: S,
+}
+
+impl<S> Deref for NotarizationClient<S> {
+    type Target = NotarizationClientReadOnly;
+    fn deref(&self) -> &Self::Target {
+        &self.read_client
+    }
+}
+
+impl<S> NotarizationClient<S>
+where
+    S: Signer<IotaKeySignature>,
+{
+    /// Create a new [`NotarizationClient`].
+    pub async fn new(client: NotarizationClientReadOnly, signer: S) -> Result<Self, Error> {
+        let public_key = signer
+            .public_key()
+            .await
+            .map_err(|e| Error::InvalidKey(e.to_string()))?;
+
+        Ok(Self {
+            public_key,
+            read_client: client,
+            signer,
+        })
+    }
+}
+
+impl<S> CoreClientReadOnly for NotarizationClient<S>
+where
+    S: OptionalSync,
+{
+    fn client_adapter(&self) -> &IotaClientAdapter {
+        &self.read_client
+    }
+
+    fn package_id(&self) -> ObjectID {
+        self.read_client.package_id()
+    }
+
+    fn network_name(&self) -> &NetworkName {
+        self.read_client.network()
+    }
+}
+
+impl<S> CoreClient<S> for NotarizationClient<S>
+where
+    S: Signer<IotaKeySignature> + OptionalSync,
+{
+    fn sender_address(&self) -> IotaAddress {
+        IotaAddress::from(&self.public_key)
+    }
+
+    fn signer(&self) -> &S {
+        &self.signer
+    }
+
+    fn sender_public_key(&self) -> &PublicKey {
+        &self.public_key
+    }
+}

notarization-rs/src/client/mod.rs

@@ -0,0 +1,2 @@
+pub mod full_client;
+pub mod read_only;