From 6fa70362e54a33aabbd07084a31030d7a4823e57 Mon Sep 17 00:00:00 2001 From: Yasir Date: Fri, 10 Jul 2026 07:28:55 +0300 Subject: [PATCH] chore: align documentation naming conventions --- README.md | 18 +++++++++--------- audit-trail-move/README.md | 2 +- audit-trail-rs/README.md | 2 +- audit-trail-rs/src/client/read_only.rs | 6 +++--- bindings/wasm/audit_trail_wasm/README.md | 2 +- .../audit_trail_wasm/src/trail_handle/mod.rs | 2 +- bindings/wasm/notarization_wasm/README.md | 2 +- .../wasm/notarization_wasm/examples/README.md | 4 ++-- .../src/wasm_notarization_client.rs | 4 ++-- .../src/wasm_notarization_client_read_only.rs | 10 +++++----- notarization-rs/src/client/read_only.rs | 10 +++++----- 11 files changed, 31 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 2268ca57..7d9be965 100644 --- a/README.md +++ b/README.md @@ -41,10 +41,10 @@ See [Single Notarization resources](#single-notarization) for one on-chain proof See [Audit Trails resources](#audit-trails) for structured record histories with permissions, capabilities, tagging, and write or delete controls. -If you need to integrate the Notarization on-chain contracts into your own Move package: +If you need to integrate the Notarization on-chain contracts into your own Move Package: -- [Notarization contracts](./notarization-move) -- [Audit trail contracts](./audit-trail-move) +- [Notarization Move Package](./notarization-move) +- [Audit Trails Move Package](./audit-trail-move) If you want to build a client application: @@ -59,20 +59,20 @@ If you want to build a client application: ### Single Notarization -- [Rust package README](./notarization-rs/README.md) +- [Rust Package README](./notarization-rs/README.md) - [Rust API documentation](https://iotaledger.github.io/notarization/notarization/index.html) - [Rust Examples](./examples/README.md) -- [Move package README](./notarization-move/README.md) -- [Wasm package README](./bindings/wasm/notarization_wasm/README.md) +- [Move Package README](./notarization-move/README.md) +- [Wasm Package README](./bindings/wasm/notarization_wasm/README.md) - [Wasm Examples](./bindings/wasm/notarization_wasm/examples/README.md) ### Audit Trails -- [Rust package README](./audit-trail-rs/README.md) +- [Rust Package README](./audit-trail-rs/README.md) - [Rust API documentation](https://iotaledger.github.io/notarization/audit_trails/index.html) - [Rust Examples](./examples/audit-trail/README.md) -- [Move package README](./audit-trail-move/README.md) -- [Wasm package README](./bindings/wasm/audit_trail_wasm/README.md) +- [Move Package README](./audit-trail-move/README.md) +- [Wasm Package README](./bindings/wasm/audit_trail_wasm/README.md) - [Wasm Examples](./bindings/wasm/audit_trail_wasm/examples/README.md) ## Contributing diff --git a/audit-trail-move/README.md b/audit-trail-move/README.md index a0492d93..9c14d919 100644 --- a/audit-trail-move/README.md +++ b/audit-trail-move/README.md @@ -78,7 +78,7 @@ cd audit-trail-move eval $(./scripts/upgrade_package.sh) ``` -The upgrade script reads the active chain from the IOTA CLI, resolves the current Audit Trails package ID from `Move.lock`, finds the matching `UpgradeCap` in the active wallet, and prints the upgraded `IOTA_AUDIT_TRAIL_PKG_ID`. +The upgrade script reads the active chain from the IOTA CLI, resolves the current Audit Trails Package ID from `Move.lock`, finds the matching `UpgradeCap` in the active wallet, and prints the upgraded `IOTA_AUDIT_TRAIL_PKG_ID`. The package history files [`Move.lock`](./Move.lock) and [`Move.history.json`](./Move.history.json) are used by the Rust crate to resolve and track deployed package versions. diff --git a/audit-trail-rs/README.md b/audit-trail-rs/README.md index 6c4684f9..5bc1f294 100644 --- a/audit-trail-rs/README.md +++ b/audit-trail-rs/README.md @@ -2,7 +2,7 @@ ## Introduction -The Audit Trails Rust package provides the Rust client for structured record histories in the IOTA Notarization Toolkit. +The Audit Trails Rust Package provides the Rust client for structured record histories in the IOTA Notarization Toolkit. The package also provides an `AuditTrailBuilder` that creates audit trail objects on the IOTA ledger and an `AuditTrailHandle` that interacts with existing trails. The handle maps to one on-chain audit trail and provides typed APIs for records, diff --git a/audit-trail-rs/src/client/read_only.rs b/audit-trail-rs/src/client/read_only.rs index 38c17af3..1b600ef0 100644 --- a/audit-trail-rs/src/client/read_only.rs +++ b/audit-trail-rs/src/client/read_only.rs @@ -48,9 +48,9 @@ pub struct PackageOverrides { pub struct AuditTrailClientReadOnly { /// The underlying IOTA client adapter used for communication. iota_client: IotaClientAdapter, - /// The [`ObjectId`] of the deployed Audit Trail Package (smart contract). + /// The [`ObjectId`] of the deployed Audit Trails Package (smart contract). audit_trail_pkg_id: ObjectId, - /// The [`ObjectId`] of the deployed TfComponents package used by Audit Trail. + /// The [`ObjectId`] of the deployed TfComponents Package used by Audit Trails. pub(crate) tf_components_pkg_id: ObjectId, /// The name of the network this client is connected to (e.g., "mainnet", "testnet"). network: NetworkName, @@ -78,7 +78,7 @@ impl AuditTrailClientReadOnly { /// Returns the package ID used by this client. /// - /// This is the deployed audit-trail Move package ID, not a trail object ID. + /// This is the deployed Audit Trails Move Package ID, not a trail object ID. pub fn package_id(&self) -> ObjectId { self.audit_trail_pkg_id } diff --git a/bindings/wasm/audit_trail_wasm/README.md b/bindings/wasm/audit_trail_wasm/README.md index 55d0f619..f58a7a74 100644 --- a/bindings/wasm/audit_trail_wasm/README.md +++ b/bindings/wasm/audit_trail_wasm/README.md @@ -72,7 +72,7 @@ to [rustup.rs](https://rustup.rs) for the installation. - [Node.js](https://nodejs.org/en) (>= `v20`) - [Rust](https://www.rust-lang.org/) (>= 1.65) - [Cargo](https://doc.rust-lang.org/cargo/) (>= 1.65) -- for running example: a local network node with the IOTA Audit Trails package deployed as described in [Local Network Setup](https://docs.iota.org/developer/iota-notarization/audit-trails/getting-started/local-network-setup) +- for running example: a local network node with the IOTA Audit Trails Package deployed as described in [Local Network Setup](https://docs.iota.org/developer/iota-notarization/audit-trails/getting-started/local-network-setup) ### 1. Install Local Tooling diff --git a/bindings/wasm/audit_trail_wasm/src/trail_handle/mod.rs b/bindings/wasm/audit_trail_wasm/src/trail_handle/mod.rs index 82735444..4ad07432 100644 --- a/bindings/wasm/audit_trail_wasm/src/trail_handle/mod.rs +++ b/bindings/wasm/audit_trail_wasm/src/trail_handle/mod.rs @@ -84,7 +84,7 @@ impl WasmAuditTrailHandle { /// /// @remarks /// Bumps the trail's stored data layout to the current package version. Intended to be called - /// once after the audit-trail Move package is upgraded. + /// once after the Audit Trails Move Package is upgraded. /// /// Requires the {@link Permission.Migrate} permission. /// diff --git a/bindings/wasm/notarization_wasm/README.md b/bindings/wasm/notarization_wasm/README.md index 8ee36603..e79170d5 100644 --- a/bindings/wasm/notarization_wasm/README.md +++ b/bindings/wasm/notarization_wasm/README.md @@ -32,7 +32,7 @@ to [rustup.rs](https://rustup.rs) for the installation. - [Node.js](https://nodejs.org/en) (>= `v20`) - [Rust](https://www.rust-lang.org/) (>= 1.65) - [Cargo](https://doc.rust-lang.org/cargo/) (>= 1.65) -- for running example: a local network node with the IOTA notarization package deployed as being described +- for running example: a local network node with the IOTA Notarization Package deployed as being described [here](https://docs.iota.org/developer/iota-notarization/single-notarization/getting-started/local-network-setup) ### 1. Install Local Tooling diff --git a/bindings/wasm/notarization_wasm/examples/README.md b/bindings/wasm/notarization_wasm/examples/README.md index 932eaafc..15828d24 100644 --- a/bindings/wasm/notarization_wasm/examples/README.md +++ b/bindings/wasm/notarization_wasm/examples/README.md @@ -13,10 +13,10 @@ Examples can be run against - a local IOTA node - or an existing network, e.g. the IOTA testnet -When setting up the local node, you'll also need to publish a notarization package as described in +When setting up the local node, you'll also need to publish a Notarization Package as described in [Local Network Setup](https://docs.iota.org/developer/iota-notarization/getting-started/local-network-setup) in the documentation portal. You'll also need to provide an environment variable `IOTA_NOTARIZATION_PKG_ID` set to the package-id of your locally deployed -notarization package, to be able to run the examples against the local node. +Notarization Package, to be able to run the examples against the local node. In case of running the examples against an existing network, this network needs to have a faucet to fund your accounts (the IOTA testnet (`https://api.testnet.iota.cafe`) supports this), and you need to specify this via `NETWORK_URL`. diff --git a/bindings/wasm/notarization_wasm/src/wasm_notarization_client.rs b/bindings/wasm/notarization_wasm/src/wasm_notarization_client.rs index 0d7965c6..f501107a 100644 --- a/bindings/wasm/notarization_wasm/src/wasm_notarization_client.rs +++ b/bindings/wasm/notarization_wasm/src/wasm_notarization_client.rs @@ -76,7 +76,7 @@ impl WasmNotarizationClient { self.0.network().to_string() } - /// The notarization package ID this client is using. + /// The Notarization Package ID this client is using. #[wasm_bindgen(js_name = packageId)] pub fn package_id(&self) -> String { self.0.package_id().to_string() @@ -90,7 +90,7 @@ impl WasmNotarizationClient { self.0.tf_components_package_id().unwrap_or(ObjectId::ZERO).to_string() } - /// The full history of notarization package IDs known on this network, + /// The full history of Notarization Package IDs known on this network, /// most recent first. #[wasm_bindgen(js_name = packageHistory)] pub fn package_history(&self) -> Vec { diff --git a/bindings/wasm/notarization_wasm/src/wasm_notarization_client_read_only.rs b/bindings/wasm/notarization_wasm/src/wasm_notarization_client_read_only.rs index 4e8941a6..e6f24cb9 100644 --- a/bindings/wasm/notarization_wasm/src/wasm_notarization_client_read_only.rs +++ b/bindings/wasm/notarization_wasm/src/wasm_notarization_client_read_only.rs @@ -28,14 +28,14 @@ pub struct WasmNotarizationClientReadOnly(pub(crate) NotarizationClientReadOnly) #[wasm_bindgen(js_class = NotarizationClientReadOnly)] impl WasmNotarizationClientReadOnly { - /// Constructs a read-only client and resolves the notarization package + /// Constructs a read-only client and resolves the Notarization Package /// for the network the given IOTA client is connected to. /// /// @param iotaClient - An IOTA client connected to the target network. /// /// @returns A connected {@link NotarizationClientReadOnly}. /// - /// @throws When the network cannot be queried or no notarization package + /// @throws When the network cannot be queried or no Notarization Package /// is available for it. #[wasm_bindgen(js_name = create)] pub async fn new(iota_client: WasmIotaClient) -> Result { @@ -52,7 +52,7 @@ impl WasmNotarizationClientReadOnly { /// resolve the latest package on the network. /// /// @param iotaClient - An IOTA client connected to the target network. - /// @param iotaNotarizationPkgId - The notarization package ID to pin to. + /// @param iotaNotarizationPkgId - The Notarization Package ID to pin to. /// /// @returns A connected {@link NotarizationClientReadOnly}. /// @@ -74,7 +74,7 @@ impl WasmNotarizationClientReadOnly { Ok(WasmNotarizationClientReadOnly(inner_client)) } - /// The notarization package ID this client is using. + /// The Notarization Package ID this client is using. #[wasm_bindgen(js_name = packageId)] pub fn package_id(&self) -> String { self.0.package_id().to_string() @@ -88,7 +88,7 @@ impl WasmNotarizationClientReadOnly { self.0.tf_components_package_id().unwrap_or(ObjectId::ZERO).to_string() } - /// The full history of notarization package IDs known on this network, + /// The full history of Notarization Package IDs known on this network, /// most recent first. #[wasm_bindgen(js_name = packageHistory)] pub fn package_history(&self) -> Vec { diff --git a/notarization-rs/src/client/read_only.rs b/notarization-rs/src/client/read_only.rs index ea6e6d2f..a5828f67 100644 --- a/notarization-rs/src/client/read_only.rs +++ b/notarization-rs/src/client/read_only.rs @@ -38,7 +38,7 @@ use crate::package; pub struct NotarizationClientReadOnly { /// The underlying IOTA client adapter used for communication. iota_client: IotaClientAdapter, - /// The [`ObjectId`] of the deployed Notarization package (smart contract). + /// The [`ObjectId`] of the deployed Notarization Package (smart contract). /// All interactions go through this package ID. notarization_pkg_id: ObjectId, /// The name of the network this client is connected to (e.g., "mainnet", "testnet"). @@ -76,7 +76,7 @@ impl NotarizationClientReadOnly { /// /// # Failures /// This function fails if the provided `iota_client` is connected to an unrecognized - /// network for which the notarization package ID is not known in the internal + /// network for which the Notarization Package ID is not known in the internal /// package registry. /// /// # Arguments @@ -137,7 +137,7 @@ impl NotarizationClientReadOnly { }) } - /// Creates a new [`NotarizationClientReadOnly`] with a specific notarization package ID. + /// Creates a new [`NotarizationClientReadOnly`] with a specific Notarization Package ID. /// /// This function allows overriding the package ID lookup from the registry, which is useful /// for connecting to networks where the package ID is known but not yet registered, or @@ -146,7 +146,7 @@ impl NotarizationClientReadOnly { /// # Arguments /// /// * `iota_client`: The IOTA client instance. - /// * `package_id`: The specific [`ObjectId`] of the Notarization package to use. + /// * `package_id`: The specific [`ObjectId`] of the Notarization Package to use. /// /// # Returns /// A `Result` containing the initialized [`NotarizationClientReadOnly`] or an [`Error`]. @@ -457,7 +457,7 @@ impl NotarizationClientReadOnly { #[async_trait::async_trait] impl CoreClientReadOnly for NotarizationClientReadOnly { - /// Returns the [`ObjectId`] of the Notarization package used by this client. + /// Returns the [`ObjectId`] of the Notarization Package used by this client. fn package_id(&self) -> ObjectId { self.notarization_pkg_id }