chore(hermes): Minor cleanup (typos & formatting) (#701)

* Cleanup

* Further cleanup

Author: rafal-ch

hermes/bin/src/runtime_extensions/hermes/cardano/host.rs

@@ -164,7 +164,7 @@ impl HostNetwork for HermesRuntimeContext {
     ///
     ///    Note: For both `+n` and `-n`, the `start` does not need to be a true block.
     ///    They will return the block which appears at this block offset, given the
-    /// arbitrary start point.  IF the `start` block does exist, it will never
+    /// arbitrary start point.  If the `start` block does exist, it will never be
     /// returned with a positive or negative `step`, as it is `step` 0.
     ///
     /// Example, Given three consecutive blocks at slots `100`, `200` and `300` the

hermes/bin/src/runtime_extensions/hermes/localtime/host.rs

@@ -16,7 +16,7 @@ impl Host for HermesRuntimeContext {
     ///
     /// `when` : The datetime we want to convert (Optional, if not set it will convert
     /// `now`).
-    /// `tz` : The timezone to use. (Optional, if not set uses the local machines
+    /// `tz` : The timezone to use. (Optional, if not set uses the machine's
     /// configured local timezone.)
     ///
     /// **Returns**
@@ -36,7 +36,7 @@ impl Host for HermesRuntimeContext {
     /// **Parameters**
     ///
     /// `time` : The localtime to convert.
-    /// `tz` : The timezone to use. (Optional, if not set uses the local machines
+    /// `tz` : The timezone to use. (Optional, if not set uses the machine's
     /// configured local timezone.)
     ///
     /// **Returns**

wasm/wasi/wit/deps/hermes-cardano/api.wit

@@ -39,7 +39,7 @@ interface api {
         /// The live tip of the blockchain, following the upstream node.
         tip,
         /// The immutable tip of the blockchain
-        /// e.g., The last block which has reached the absolute finality and can never rolls back.
+        /// e.g., The last block which has reached the absolute finality and can never roll back.
         immutable-tip,
     }
 
@@ -56,7 +56,7 @@ interface api {
         /// Unknown network.
         unknown-network
     }
-    
+
     /// Errors that can happen for block.
     enum block-error {
         /// Block is not found.
@@ -76,9 +76,9 @@ interface api {
         /// **Parameters**
         ///
         /// - `network`: The Cardano network to connect to (e.g., Mainnet, Preprod, Preview).
-        /// 
+        ///
         /// **Returns**
-        /// 
+        ///
         /// - `ok(network)`: A resource network, if successfully create network resource.
         /// - `error(create-network-error)`: If creating network resource failed.
         new: static func(network: cardano-network) -> result<network, create-network-error>;
@@ -94,54 +94,52 @@ interface api {
         ///
         /// **Returns**
         ///
-        /// - `ok(u32)`: A unsigned integer represent the underlying 32-bit representation of subscription ID
-        ///              resource. this subscription. Use to distinguishes events from different subscribers
-        ///              and provides control over subscription management.The ID must be unique across all 
-        ///              active subscriptions.
+        /// - `ok(u32)`: A unsigned integer representing the underlying 32-bit subscription resource ID.
+        ///              This is used to distinguish events from different subscribers and provides
+        ///              control over subscription management.The ID must be unique across all active subscriptions.
         /// - `error(subscribe-error)`: If subscription failed.
         subscribe-block: func(start: sync-slot) -> result<u32, subscribe-error>;
 
         /// Subscribe to blockchain immutable rolls forward.
         ///
         /// This sets up a subscription to receive event when the immutable part of the blockchain
         /// roll forwards.
-        /// 
+        ///
         /// **Parameters**
         ///
         /// - `start`: The slot to begin following from.
-        /// 
+        ///
         /// **Returns**
-        /// 
-        /// - `ok(u32)`: A unsigned integer represent the underlying 32-bit representation of subscription ID
-        ///              resource. this subscription. Use to distinguishes events from different subscribers
-        ///              and provides control over subscription management.The ID must be unique across all 
-        ///              active subscriptions.
+        ///
+        /// - `ok(u32)`: A unsigned integer representing the underlying 32-bit subscription resource ID.
+        ///              This is used to distinguish events from different subscribers and provides
+        ///              control over subscription management.The ID must be unique across all active subscriptions.
         /// - `error(subscribe-error)`: If subscription failed.
         subscribe-immutable-roll-forward: func(start: sync-slot) -> result<u32, subscribe-error>;
 
         /// Get a block relative to `start` by `step`.
         ///
         /// **Parameters**
         /// - `start`: Slot to begin retrieval from, current tip if `None`.
-        /// - `step` 
-        ///     -`0` : the block at `start`, will return `None` if there is no block exactly at this `start` slot.   
-        ///     -`+n`: the `n`‑th block *after* the given `start` slot.  
-        ///     –`‑n`: the `n`‑th block *before* the given `start` slot.  
-        ///  
-        /// Note: For both `+n` and `-n`, the `start` does not need to be a true block.  
-        /// They will return the block which appears at this block offset, given the arbitrary start point.  
-        /// IF the `start` block does exist, it will never returned with a positive or negative `step`, as it is `step` 0.  
-        ///  
-        /// Example, Given three consecutive blocks at slots `100`, `200` and `300` the following will be returned:  
+        /// - `step`
+        ///     -`0` : the block at `start`, will return `None` if there is no block exactly at this `start` slot.
+        ///     -`+n`: the `n`‑th block *after* the given `start` slot.
+        ///     –`‑n`: the `n`‑th block *before* the given `start` slot.
+        ///
+        /// Note: For both `+n` and `-n`, the `start` does not need to be a true block.
+        /// They will return the block which appears at this block offset, given the arbitrary start point.
+        /// If the `start` block does exist, it will never be returned with a positive or negative `step`, as it is `step` 0.
+        ///
+        /// Example, Given three consecutive blocks at slots `100`, `200` and `300` the following will be returned:
         ///     - `start = 100, step = 0` -> 100 (Exact match)
         ///     - `start = 100, step = 2` -> 300 (Skips 200)
         ///     - `start = 150, step = 1` -> 200 (Rounds up from 150)
         ///     - `start = 200, step = 1` -> 300 (Forward iteration)
         ///     - `start = 300, step = -2` -> 100 (Skips 200)
         ///     - `start = 250, step = -2` -> 100 (Rounds down to 200 first)
-        /// 
+        ///
         /// **Returns**
-        /// 
+        ///
         /// - Returns a `block` resource, `None` if block cannot be retrieved.
         get-block: func(start: option<slot>, step: s64) -> option<block>;
 
@@ -166,12 +164,12 @@ interface api {
         /// - `false` if the block is in the mutable part.
         is-immutable: func() -> bool;
 
-        /// Returns whether the block is the first block of a rollback.  
-        ///  
-        /// **Returns**  
-        ///  
+        /// Returns whether the block is the first block of a rollback.
+        ///
+        /// **Returns**
+        ///
         /// - `ok(bool)` True if the block is the first block of a rollback,
-        ///              otherwise, False.  
+        ///              otherwise, False.
         /// - `error(block-error)`: If block cannot be retrieved.
         is-rollback: func() -> result<bool, block-error>;
 
@@ -224,7 +222,7 @@ interface api {
         /// **Parameters**
         ///
         /// - `label`: A metadata label used as a key to get the associated metadata.
-        /// 
+        ///
         /// **Returns**
         ///
         /// - `option<cbor>` : The CBOR format of the metadata, `None` if the label requested is not present.
@@ -234,12 +232,12 @@ interface api {
         /// Returns the transaction hash.
         ///
         /// **Returns**
-        /// 
+        ///
         /// - `option<txn-hash>` : Cardano transaction hash - Blake2b-256, `None` if cannot retrieve the transaction hash.
         get-txn-hash: func() -> option<txn-hash>;
 
         /// Returns the raw CBOR representation of the transaction.
-        /// 
+        ///
         /// **Returns**
         ///
         /// - `option<cbor>` : The CBOR format of the transaction, `None` if cannot retrieve the raw transaction.
@@ -248,13 +246,13 @@ interface api {
 
     resource subscription-id {
         /// Returns the network that this subscription is in.
-        /// 
+        ///
         /// **Returns**
-        /// 
+        ///
         /// - `cardano-network` : The Cardano network that this subscription is in.
         get-network: func() -> cardano-network;
 
-                
+
         /// Unsubscribing block event of this `subscription-id` instance.
         /// Once this function is called, the subscription instance, `subscription-id` will be removed.
         unsubscribe: func();

wasm/wasi/wit/deps/hermes-cron/api.wit

@@ -36,14 +36,14 @@ interface api {
         tag: cron-event-tag
     }
 
-    /// A discreet time entry used to help convert numeric times into crontab entries.
+    /// A discrete time entry used to help convert numeric times into crontab entries.
     variant cron-component {
         // Maps to `*` in a cron schedule (ie, match all)
         all,
         // Match an absolute time/date
         at(u8),
         // Match an inclusive list of time/date values.
-        range(tuple<u8,u8>),
+        range(tuple<u8, u8>),
     }
 
     /// A list of cron time components
@@ -114,7 +114,7 @@ interface api {
     /// - A list of tuples containing the scheduled crontabs and their tags, along with the current retrigger flag.
     ///   The list is sorted from most crontab that will trigger soonest to latest.
     ///   Crontabs are only listed once, in the case where a crontab may be scheduled
-    ///   may times before a later one.
+    ///   many times before a later one.
     ///     - `0` - `cron-tagged` - The Tagged crontab event.
     ///     - `1` - `bool` - The state of the retrigger flag.
     ///
@@ -138,7 +138,7 @@ interface api {
 
     /// # Make a crontab entry from individual time values.
     ///
-    /// Crates the properly formatted cron entry
+    /// Creates the properly formatted cron entry
     /// from numeric cron time components.
     /// Convenience function to make building cron strings simpler when they are
     /// calculated from data.
@@ -162,12 +162,11 @@ interface api {
     /// Redundant entries will be removed.
     ///     - For example specifying a `month` as `3` and `2-4` will
     ///         remove the individual month and only produce the range.
-    mkcron: func(dow: cron-time, month: cron-time, day: cron-time,
-                 hour: cron-time, minute: cron-time ) -> cron-sched;
+    mkcron: func(dow: cron-time, month: cron-time, day: cron-time, 
+    hour: cron-time, minute: cron-time ) -> cron-sched;
 }
 
 /// World just for the Hermes 'cron' API and Event.
 world cron-api {
     import api;
 }
-  

wasm/wasi/wit/deps/hermes-ipfs/api.wit

@@ -7,8 +7,8 @@ interface api {
     /// This is content that can be validated.
     variant ipfs-content {
         /// DHT value
-        dht(tuple<dht-key,dht-value>),
-        pubsub(tuple<pubsub-topic,message-data>),
+        dht(tuple<dht-key, dht-value>),
+        pubsub(tuple<pubsub-topic, message-data>),
     }
     /// The binary contents of an IPFS file.
     type ipfs-file = list<u8>;
@@ -24,7 +24,7 @@ interface api {
     type pubsub-topic = string;
     /// A PubSub message from a topic subscription.
     record pubsub-message {
-        /// The topic that the message was received on. 
+        /// The topic that the message was received on.
         topic: pubsub-topic,
         /// The contents of the message.
         message: message-data,
@@ -79,9 +79,9 @@ interface api {
     file-pin: func(path: ipfs-path) -> result<bool, errno>;
     /// Un-pins an IPFS file by path.
     file-unpin: func(path: ipfs-path) -> result<bool, errno>;
-    /// Evict peer from network.
+    /// Evicts peer from network.
     peer-evict: func(peer: peer-id) -> result<bool, errno>;
-    /// Publish a message to a topic.
+    /// Publishes a message to a topic.
     pubsub-publish: func(topic: pubsub-topic, message: message-data) -> result<_, errno>;
     /// Subscribes to a PubSub topic.
     pubsub-subscribe: func(topic: pubsub-topic) -> result<bool, errno>;

wasm/wasi/wit/deps/hermes-localtime/api.wit

@@ -44,7 +44,7 @@ interface api {
     /// **Parameters**
     /// 
     /// `when` : The datetime we want to convert (Optional, if not set it will convert `now`).
-    /// `tz` : The timezone to use. (Optional, if not set uses the local machines configured local timezone.)
+    /// `tz` : The timezone to use. (Optional, if not set uses the machine's configured local timezone.)
     /// 
     /// **Returns**
     /// 
@@ -59,7 +59,7 @@ interface api {
     /// **Parameters**
     /// 
     /// `time` : The localtime to convert.
-    /// `tz` : The timezone to use. (Optional, if not set uses the local machines configured local timezone.)
+    /// `tz` : The timezone to use. (Optional, if not set uses the machine's configured local timezone.)
     /// 
     /// **Returns**
     ///