Merge pull request #59 from iotaledger/feat/update-readme

Update README.md

Author: chrisgitiota

.github/notarization.svg

@@ -185,13 +185,13 @@ jobs:
           awk '$1 ~ /[0-9].*/' | \
           parallel -k -j 4 --retries 3 --joblog report.log ./target/release/examples/{}
           cat report.log
-#      - name: Run Rust Readme examples
-#        # run examples only on ubuntu for now
-#        if: matrix.os == 'ubuntu-24.04'
-#        run: |
-#          cd bindings/wasm/notarization_wasm
-#          npm ci
-#          npm run test:readme:rust
+      #      - name: Run Rust Readme examples
+      #        # run examples only on ubuntu for now
+      #        if: matrix.os == 'ubuntu-24.04'
+      #        run: |
+      #          cd bindings/wasm/notarization_wasm
+      #          npm ci
+      #          npm run test:readme:rust
 
       - name: Archive server logs
         if: ${{ env.IOTA_SERVER_LOGFILE }}

.github/workflows/build-and-test.yml

@@ -26,7 +26,7 @@ strum = { version = "0.27", default-features = false, features = ["std", "derive
 thiserror = { version = "2.0", default-features = false }
 
 secret-storage = { git = "https://github.com/iotaledger/secret-storage.git", tag = "v0.3.0", default-features = false }
-tokio = { version = "1.43", default-features = false, features = ["macros", "sync", "rt", "process"] }
+tokio = { version = "1.44.2", default-features = false, features = ["macros", "sync", "rt", "process"] }
 
 [profile.release.package.iota_interaction_ts]
 opt-level = 's'

Cargo.toml

@@ -39,7 +39,7 @@ function replace(tsconfig, dist, artifact, mode) {
                 value = path.relative(absoluteFilePath, absoluteIncludePath).replace(/\\/g, "/");
             }
 
-            if(key.endsWith('*')) {
+            if (key.endsWith("*")) {
                 console.log(`\t dropping '*' from ${key}`);
                 key = key.slice(0, -1);
             }

README.md

@@ -30,7 +30,7 @@ serde-wasm-bindgen = "0.6.5"
 serde_json = { version = "1.0", default-features = false }
 serde_repr = { version = "0.1", default-features = false }
 # Want to use the nice API of tokio::sync::RwLock for now even though we can't use threads.
-tokio = { version = "1.43", default-features = false, features = ["sync"] }
+tokio = { version = "1.44.2", default-features = false, features = ["sync"] }
 tsify = "0.4.5"
 wasm-bindgen = { version = "0.2.100", features = ["serde-serialize"] }
 wasm-bindgen-futures = { version = "0.4", default-features = false }

bindings/wasm/build/replace_paths.js

@@ -2,8 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use js_sys::Uint8Array;
-use notarization::core::types::{Data, ImmutableMetadata, LockMetadata, State};
-use notarization::core::NotarizationMethod;
+use notarization::core::types::{Data, ImmutableMetadata, LockMetadata, NotarizationMethod, State};
 use serde::{Deserialize, Serialize};
 use wasm_bindgen::prelude::*;
 

bindings/wasm/notarization_wasm/Cargo.toml

@@ -5,8 +5,7 @@ use std::time::{SystemTime, UNIX_EPOCH};
 
 use anyhow::Result;
 use examples::get_funded_client;
-use notarization::core::NotarizationMethod;
-use notarization::core::types::{State, TimeLock};
+use notarization::core::types::{NotarizationMethod, State, TimeLock};
 
 #[tokio::main]
 async fn main() -> Result<()> {
@@ -19,7 +18,7 @@ async fn main() -> Result<()> {
     let now_ts = SystemTime::now().duration_since(UNIX_EPOCH).unwrap().as_secs();
     let unlock_at = now_ts + 86400; // 24 hours
 
-    println!("Creating locked notarization with delete lock until: {}", unlock_at);
+    println!("Creating locked notarization with delete lock until: {unlock_at}");
 
     // Create a locked notarization with state and delete lock
     let locked_notarization = notarization_client

bindings/wasm/notarization_wasm/src/wasm_types.rs

@@ -5,8 +5,7 @@ use std::time::{SystemTime, UNIX_EPOCH};
 
 use anyhow::Result;
 use examples::get_funded_client;
-use notarization::core::NotarizationMethod;
-use notarization::core::types::{State, TimeLock};
+use notarization::core::types::{NotarizationMethod, State, TimeLock};
 
 #[tokio::main]
 async fn main() -> Result<()> {
@@ -65,7 +64,7 @@ async fn main() -> Result<()> {
 
     println!("\n📊 Notarization Status:");
     println!("Simple notarization - Method: {:?}", simple_notarization.method);
-    println!("Transfer-locked notarization - Transfer locked: {}", is_transfer_locked);
+    println!("Transfer-locked notarization - Transfer locked: {is_transfer_locked}");
     println!("\n🔄 Dynamic notarizations can be updated and transferred (unless transfer-locked)");
     println!("📝 State and metadata can be modified over time");
 

examples/01_create_locked_notarization.rs

@@ -28,7 +28,7 @@ async fn main() -> Result<()> {
         .output
         .id;
 
-    println!("✅ Dynamic notarization created with ID: {:?}", dynamic_notarization_id);
+    println!("✅ Dynamic notarization created with ID: {dynamic_notarization_id:?}");
 
     let current_state = notarization_client.state(*dynamic_notarization_id.object_id()).await?;
     println!("Initial state: {}", current_state.data.as_text()?);
@@ -44,7 +44,7 @@ async fn main() -> Result<()> {
 
     match state_update_result {
         Ok(_) => println!("✅ State update succeeded"),
-        Err(e) => println!("❌ State update failed - {}", e),
+        Err(e) => println!("❌ State update failed - {e}"),
     }
 
     println!("\n📝 Updating metadata on dynamic notarization...");
@@ -57,7 +57,7 @@ async fn main() -> Result<()> {
 
     match metadata_update_result {
         Ok(_) => println!("✅ Metadata update succeeded"),
-        Err(e) => println!("❌ Metadata update failed - {}", e),
+        Err(e) => println!("❌ Metadata update failed - {e}"),
     }
 
     let current_state = notarization_client.state(*dynamic_notarization_id.object_id()).await?;