fix: rename function and typos after review

Author: Damien LACHAUME / PALO-IT

.github/workflows/test-client.yml

@@ -197,7 +197,7 @@ jobs:
         run: |
           echo "AGGREGATOR_ENDPOINT=${{ inputs.aggregator_endpoint }}" > ./www-test/.env
           echo "GENESIS_VERIFICATION_KEY=$(curl -s ${{ inputs.genesis_verification_key }})" >> ./www-test/.env
-          echo "TRANSACTIONS_HASHES_TO_CERTIFY=$(curl -s ${{ inputs.transactions_hashes_to_certify }})" >> ./www-test/.env
+          echo "TRANSACTIONS_HASHES_TO_CERTIFY=${{ inputs.transactions_hashes_to_certify }}" >> ./www-test/.env
 
       - name: Start the server
         working-directory: mithril-client-wasm

docs/website/root/glossary.md

@@ -26,9 +26,9 @@ A Cardano key pair is an asymmetric key pair used to identify a [stake pool oper
 
 ## Cardano transaction
 
-A Cardano transaction proof is a cryptographic proof that a set of Cardano transactions is included in the global Cardano transactions set. It is generated unpon request using a [Mithril client](#mithril-client) and is tied to a [certificate](#certificate).
+A Cardano transaction proof is a cryptographic proof that a sub-set of Cardano transactions is included in the Cardano transactions set. It is generated upon request from a [Mithril client](#mithril-client) and is signed by a [certificate](#certificate).
 
-A Cardano transaction commitment is stamp that state how much of the global Cardano transactions sets a [Mithril aggregator](#mithril-aggregator) is aware of, only for those transactions a Cardano transaction proof can be generated.
+A Cardano transactions set commitment represents, in a succinct way, the Cardano transactions set that was signed by Mithril at a given [Beacon](#beacon).
 
 ## Certificate
 

docs/website/root/manual/developer-docs/nodes/mithril-client-library-wasm.md

@@ -14,7 +14,7 @@ Mithril client library WASM can be used by Javascript developers to use the Mith
 It is responsible for handling the different types of data certified by Mithril, and available through a Mithril aggregator:
 - [**Snapshot**](../../../glossary.md#snapshot): list and get.
 - [**Mithril stake distribution**](../../../glossary.md#stake-distribution): list and get.
-- [**Cardano transaction**](../../../glossary.md#cardano-transaction): list & get commitment, get proofs
+- [**Cardano transaction**](../../../glossary.md#cardano-transaction): list & get commitments, get proofs
 - [**Certificate**](../../../glossary.md#certificate): list, get, and chain validation.
 
 :::
@@ -124,7 +124,7 @@ console.log("Proof certificate hash", proof.certificate_hash);
 let proof_certificate = await client.verify_certificate_chain(proof.certificate_hash);
 console.log("verify_certificate_chain OK, last_certificate_from_chain:", proof_certificate);
 
-let valid_cardano_transaction_proof = await client.unstable.compute_cardano_transaction_proof_message(proof, proof_certificate);
+let valid_cardano_transaction_proof = await client.unstable.verify_cardano_transaction_proof_then_compute_message(proof, proof_certificate);
 console.log("valid_cardano_transaction_proof:", valid_cardano_transaction_proof);
 ```
 

mithril-client-wasm/README.md

@@ -7,7 +7,7 @@
 * The different types of available data certified by Mithril are:
     * Snapshot: list and get.
     * Mithril stake distribution: list and get.
-    * Cardano transactions proofs: list & get commitment, get proofs
+    * Cardano transactions: list & get commitments, get proofs
     * Certificate: list, get, and chain validation.
 
 ## Installation

mithril-client-wasm/src/client_wasm.rs

@@ -275,9 +275,9 @@ impl MithrilUnstableClient {
         Ok(result)
     }
 
-    /// Call the client to compute a cardano transaction proof message
+    /// Call the client to verify a cardano transaction proof and compute a message
     #[wasm_bindgen]
-    pub async fn compute_cardano_transaction_proof_message(
+    pub async fn verify_cardano_transaction_proof_then_compute_message(
         &self,
         cardano_transaction_proof: CardanoTransactionsProofs,
         certificate: JsValue,
@@ -552,7 +552,7 @@ mod tests {
 
         client
             .unstable
-            .compute_cardano_transaction_proof_message(tx_proof, certificate)
+            .verify_cardano_transaction_proof_then_compute_message(tx_proof, certificate)
             .await
             .expect("Compute tx proof message for matching cert failed");
     }

mithril-client-wasm/www-test/index.js

@@ -172,13 +172,13 @@ if (aggregator_capabilities.includes("CardanoTransactions")) {
     let ctx_proof_message;
     test_number++;
     await run_test(
-      "compute_cardano_transaction_proof_message",
+      "verify_cardano_transaction_proof_then_compute_message",
       test_number,
       async () => {
         ctx_proof_message =
-          await client.unstable.compute_cardano_transaction_proof_message(ctx_proof, proof_certificate);
+          await client.unstable.verify_cardano_transaction_proof_then_compute_message(ctx_proof, proof_certificate);
         console.log(
-          "compute_cardano_transaction_proof_message",
+          "verify_cardano_transaction_proof_then_compute_message",
           ctx_proof_message
         );
       }

mithril-client-wasm/www/index.js

@@ -84,6 +84,6 @@ displayMessageInDOM("Result", "certificate chain verified ✓");
 console.log("verify_certificate_chain OK, last_certificate_from_chain:", proof_certificate);
 
 displayStepInDOM(10, "Validating Cardano transaction proof message...");
-let valid_cardano_transaction_proof = await client.unstable.compute_cardano_transaction_proof_message(proof, proof_certificate);
+let valid_cardano_transaction_proof = await client.unstable.verify_cardano_transaction_proof_then_compute_message(proof, proof_certificate);
 displayMessageInDOM("Result", "Cardano transaction proof message validated ✓");
 console.log("valid_cardano_transaction_proof:", valid_cardano_transaction_proof);