add brief comment

kevaundray · kevaundray · commit 8648008350f5 · 2024-05-13T20:44:42.000+01:00
diff --git a/src.rs/src/verkle_ffi_api.rs b/src.rs/src/verkle_ffi_api.rs
@@ -205,6 +205,9 @@ pub fn zero_commitment() -> Uint8Array {
     bytes_to_js_value(ffi_interface::ZERO_POINT).into()
 }
 
+/// Verifies an execution witness' pre-state values and proof against a prestate root
+/// At a high level, this method verifies that the reads in the pre-state are consistent with the
+/// root.
 #[allow(deprecated)]
 #[wasm_bindgen(js_name = "verifyExecutionWitnessPreState")]
 pub fn verify_execution_witness_prestate(prestate_root: &str, execution_witness: &str) -> bool {

Original file line number	Diff line number	Diff line change
`@@ -205,6 +205,9 @@ pub fn zero_commitment() -> Uint8Array {`
`205`	`205`	`bytes_to_js_value(ffi_interface::ZERO_POINT).into()`
`206`	`206`	`}`
`207`	`207`
	`208`	`+/// Verifies an execution witness' pre-state values and proof against a prestate root`
	`209`	`+/// At a high level, this method verifies that the reads in the pre-state are consistent with the`
	`210`	`+/// root.`
`208`	`211`	`#[allow(deprecated)]`
`209`	`212`	`#[wasm_bindgen(js_name = "verifyExecutionWitnessPreState")]`
`210`	`213`	`pub fn verify_execution_witness_prestate(prestate_root: &str, execution_witness: &str) -> bool {`