Merge pull request #52 from iotaledger/feat/add-docs

feat(docs): Add docs to the Notarization codebase

Author: itsyaasir

examples/01_create_locked_notarization.rs

@@ -31,7 +31,7 @@ async fn main() -> Result<()> {
         ))
         .with_immutable_description("Critical legal document".to_string())
         .with_updatable_metadata("Initial document metadata".to_string())
-        .with_delete_at(TimeLock::UnlockAt(unlock_at as u32))
+        .with_delete_lock(TimeLock::UnlockAt(unlock_at as u32))
         .finish()?
         .build_and_execute(&notarization_client)
         .await?

examples/04_destroy_notarization.rs

@@ -94,7 +94,7 @@ async fn main() -> Result<()> {
         .create_locked_notarization()
         .with_state(State::from_string("Delete-locked content".to_string(), None))
         .with_immutable_description("Delete-locked document".to_string())
-        .with_delete_at(TimeLock::UnlockAt(unlock_at as u32))
+        .with_delete_lock(TimeLock::UnlockAt(unlock_at as u32))
         .finish()?
         .build_and_execute(&notarization_client)
         .await?
@@ -127,7 +127,7 @@ async fn main() -> Result<()> {
         .create_locked_notarization()
         .with_state(State::from_string("No delete lock content".to_string(), None))
         .with_immutable_description("No delete lock document".to_string())
-        .with_delete_at(TimeLock::None)
+        .with_delete_lock(TimeLock::None)
         .finish()?
         .build_and_execute(&notarization_client)
         .await?

examples/07_transfer_dynamic_notarization.rs

@@ -108,7 +108,7 @@ async fn main() -> Result<()> {
         .create_locked_notarization()
         .with_state(State::from_string("Locked document content".to_string(), None))
         .with_immutable_description("Locked document".to_string())
-        .with_delete_at(TimeLock::None)
+        .with_delete_lock(TimeLock::None)
         .finish()?
         .build_and_execute(&notarization_client)
         .await?

examples/08_access_read_only_methods.rs

@@ -142,7 +142,7 @@ async fn main() -> Result<()> {
         ))
         .with_immutable_description("Locked test document".to_string())
         .with_updatable_metadata("Locked document metadata".to_string())
-        .with_delete_at(TimeLock::UnlockAt(unlock_at as u32))
+        .with_delete_lock(TimeLock::UnlockAt(unlock_at as u32))
         .finish()?
         .build_and_execute(&notarization_client)
         .await?

examples/utils/utils.rs

@@ -3,8 +3,7 @@
 
 use anyhow::Context;
 use iota_sdk::{IOTA_LOCAL_NETWORK_URL, IotaClientBuilder};
-use notarization::client::full_client::NotarizationClient;
-use notarization::client::read_only::NotarizationClientReadOnly;
+use notarization::client::{NotarizationClient, NotarizationClientReadOnly};
 use product_common::test_utils::{InMemSigner, request_funds};
 
 pub async fn get_read_only_client() -> anyhow::Result<NotarizationClientReadOnly> {

notarization-move/Move.lock

@@ -29,9 +29,9 @@ flavor = "iota"
 [env]
 
 [env.localnet]
-chain-id = "002d6fb7"
-original-published-id = "0x760def1fd86d216536bb3f8809baed9e075a73c428aeb776e4d47ad88e9fc6b4"
-latest-published-id = "0x760def1fd86d216536bb3f8809baed9e075a73c428aeb776e4d47ad88e9fc6b4"
+chain-id = "2e3bf941"
+original-published-id = "0x6846c50db5a90464e5768e945990098c98be5ee41a296981a8c440fdf9512aac"
+latest-published-id = "0x6846c50db5a90464e5768e945990098c98be5ee41a296981a8c440fdf9512aac"
 published-version = "1"
 
 [env.devnet]