refactor: rename get-vk-commitment to get-commitment (#608)

Co-authored-by: Mariano A. Nicolini <mariano.nicolini.91@gmail.com>

Author: taturosati

batcher/aligned-sdk/src/sdk.rs

@@ -308,14 +308,14 @@ async fn _verify_proof_onchain(
     Ok(result)
 }
 
-/// Returns the commitment for a given verification key.
+/// Returns the commitment for a given input. Input can be verification key, public input, etc.
 /// # Arguments
-/// * `content` - The verification key for which the commitment will be calculated.
+/// * `content` - The content for which the commitment will be calculated.
 /// # Returns
-/// * The verification key commitment.
+/// * The commitment.
 /// # Errors
 /// * None.
-pub fn get_verification_key_commitment(content: &[u8]) -> [u8; 32] {
+pub fn get_commitment(content: &[u8]) -> [u8; 32] {
     let mut hasher = Keccak256::new();
     hasher.update(content);
     hasher.finalize().into()

batcher/aligned/src/main.rs

@@ -18,15 +18,15 @@ use log::{error, info};
 use transaction::eip2718::TypedTransaction;
 
 use aligned_sdk::errors::{AlignedError, SubmitError};
-use aligned_sdk::sdk::{get_verification_key_commitment, submit_multiple, verify_proof_onchain};
+use aligned_sdk::sdk::{get_commitment, submit_multiple, verify_proof_onchain};
 use aligned_sdk::types::AlignedVerificationData;
 use aligned_sdk::types::Chain;
 use aligned_sdk::types::ProvingSystemId;
 use aligned_sdk::types::VerificationData;
 
 use crate::AlignedCommands::DepositToBatcher;
+use crate::AlignedCommands::GetCommitment;
 use crate::AlignedCommands::GetUserBalance;
-use crate::AlignedCommands::GetVerificationKeyCommitment;
 use crate::AlignedCommands::Submit;
 use crate::AlignedCommands::VerifyProofOnchain;
 
@@ -44,13 +44,9 @@ pub enum AlignedCommands {
     #[clap(about = "Verify the proof was included in a verified batch on Ethereum")]
     VerifyProofOnchain(VerifyProofOnchainArgs),
 
-    // GetVerificationKey, command name is get-vk-commitment
-    #[clap(
-        about = "Create verification key for proving system",
-        name = "get-vk-commitment"
-    )]
-    GetVerificationKeyCommitment(GetVerificationKeyCommitmentArgs),
-    // GetVericiationKey, command name is get-vk-commitment
+    // Get commitment for file, command name is get-commitment
+    #[clap(about = "Get commitment for file", name = "get-commitment")]
+    GetCommitment(GetCommitmentArgs),
     #[clap(
         about = "Deposits Ethereum in the batcher to pay for proofs",
         name = "deposit-to-batcher"
@@ -155,7 +151,7 @@ pub struct VerifyProofOnchainArgs {
 
 #[derive(Parser, Debug)]
 #[command(version, about, long_about = None)]
-pub struct GetVerificationKeyCommitmentArgs {
+pub struct GetCommitmentArgs {
     #[arg(name = "File name", long = "input")]
     input_file: PathBuf,
     #[arg(name = "Output file", long = "output")]
@@ -336,10 +332,10 @@ async fn main() -> Result<(), AlignedError> {
                 info!("Your proof was not included in the batch.");
             }
         }
-        GetVerificationKeyCommitment(args) => {
+        GetCommitment(args) => {
             let content = read_file(args.input_file)?;
 
-            let hash = get_verification_key_commitment(&content);
+            let hash = get_commitment(&content);
 
             info!("Commitment: {}", hex::encode(hash));
             if let Some(output_file) = args.output_file {

docs/guides/1_SDK.md

@@ -100,12 +100,12 @@ pub async fn verify_proof_onchain(
 - `ParsingError` if there is an error parsing the address of the contract.
 - `EthError` if there is an error verifying the proof on-chain.
 
-### get_verification_key_commitment
+### get_commitment
 
 Generates a keccak256 hash commitment of the verification key.
 
 ```rust
-pub fn get_verification_key_commitment(
+pub fn get_commitment(
     content: &[u8]
 ) -> [u8; 32]
 ```

docs/guides/2_using_aligned_on_your_app.md

@@ -31,7 +31,7 @@ without actually generating and submitting a proof.
 You can do this by running the following command:
 
 ```bash
-aligned get-vk-commitment --input <path_to_input_file>
+aligned get-commitment --input <path_to_input_file>
 ```
 
 For SP1 you would use the elf of the program as the input file.