[framework] Formatting: crypto, test, kiosk 3/N (#19496)

## Description Formats 3 parts of the Sui Framework: `crypto`, `kiosk` and `test` Previous PRs: - #19461 - #19463 ## Test plan All existing tests pass. --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [ ] JSON-RPC: - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK: - [ ] REST API:
MystenLabs · Sep 23, 2024 · 29e6347 · 29e6347
1 parent d2a5f44
commit 29e6347
Show file tree

Hide file tree

Showing 32 changed files with 2,426 additions and 2,318 deletions.
diff --git a/crates/sui-framework/docs/sui-framework/bls12381.md b/crates/sui-framework/docs/sui-framework/bls12381.md
@@ -299,7 +299,11 @@ BLS_SIG_BLS12381G1_XMD:SHA-256_SSWU_RO_NUL_, return true. Otherwise, return fals
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="bls12381.md#0x2_bls12381_bls12381_min_sig_verify">bls12381_min_sig_verify</a>(signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, public_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;): bool;
+<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="bls12381.md#0x2_bls12381_bls12381_min_sig_verify">bls12381_min_sig_verify</a>(
+    signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    public_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+): bool;
 </code></pre>
 
 
@@ -327,7 +331,11 @@ BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_NUL_, return true. Otherwise, return fals
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="bls12381.md#0x2_bls12381_bls12381_min_pk_verify">bls12381_min_pk_verify</a>(signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, public_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;): bool;
+<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="bls12381.md#0x2_bls12381_bls12381_min_pk_verify">bls12381_min_pk_verify</a>(
+    signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    public_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+): bool;
 </code></pre>
 
 
@@ -817,7 +825,10 @@ Aborts with <code>EInputTooLong</code> if the vectors are larger than 32 (may in
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>fun</b> <a href="bls12381.md#0x2_bls12381_g1_multi_scalar_multiplication">g1_multi_scalar_multiplication</a>(scalars: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;Element&lt;<a href="bls12381.md#0x2_bls12381_Scalar">Scalar</a>&gt;&gt;, elements: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;Element&lt;<a href="bls12381.md#0x2_bls12381_G1">G1</a>&gt;&gt;): Element&lt;<a href="bls12381.md#0x2_bls12381_G1">G1</a>&gt; {
+<pre><code><b>public</b> <b>fun</b> <a href="bls12381.md#0x2_bls12381_g1_multi_scalar_multiplication">g1_multi_scalar_multiplication</a>(
+    scalars: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;Element&lt;<a href="bls12381.md#0x2_bls12381_Scalar">Scalar</a>&gt;&gt;,
+    elements: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;Element&lt;<a href="bls12381.md#0x2_bls12381_G1">G1</a>&gt;&gt;,
+): Element&lt;<a href="bls12381.md#0x2_bls12381_G1">G1</a>&gt; {
     <a href="group_ops.md#0x2_group_ops_multi_scalar_multiplication">group_ops::multi_scalar_multiplication</a>(<a href="bls12381.md#0x2_bls12381_G1_TYPE">G1_TYPE</a>, scalars, elements)
 }
 </code></pre>
@@ -1064,7 +1075,10 @@ Aborts with <code>EInputTooLong</code> if the vectors are larger than 32 (may in
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>fun</b> <a href="bls12381.md#0x2_bls12381_g2_multi_scalar_multiplication">g2_multi_scalar_multiplication</a>(scalars: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;Element&lt;<a href="bls12381.md#0x2_bls12381_Scalar">Scalar</a>&gt;&gt;, elements: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;Element&lt;<a href="bls12381.md#0x2_bls12381_G2">G2</a>&gt;&gt;): Element&lt;<a href="bls12381.md#0x2_bls12381_G2">G2</a>&gt; {
+<pre><code><b>public</b> <b>fun</b> <a href="bls12381.md#0x2_bls12381_g2_multi_scalar_multiplication">g2_multi_scalar_multiplication</a>(
+    scalars: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;Element&lt;<a href="bls12381.md#0x2_bls12381_Scalar">Scalar</a>&gt;&gt;,
+    elements: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;Element&lt;<a href="bls12381.md#0x2_bls12381_G2">G2</a>&gt;&gt;,
+): Element&lt;<a href="bls12381.md#0x2_bls12381_G2">G2</a>&gt; {
     <a href="group_ops.md#0x2_group_ops_multi_scalar_multiplication">group_ops::multi_scalar_multiplication</a>(<a href="bls12381.md#0x2_bls12381_G2_TYPE">G2_TYPE</a>, scalars, elements)
 }
 </code></pre>

diff --git a/crates/sui-framework/docs/sui-framework/ecdsa_k1.md b/crates/sui-framework/docs/sui-framework/ecdsa_k1.md
@@ -93,7 +93,11 @@ applied to Secp256k1 signatures. May abort with <code><a href="ecdsa_k1.md#0x2_e
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="ecdsa_k1.md#0x2_ecdsa_k1_secp256k1_ecrecover">secp256k1_ecrecover</a>(signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, <a href="hash.md#0x2_hash">hash</a>: u8): <a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;;
+<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="ecdsa_k1.md#0x2_ecdsa_k1_secp256k1_ecrecover">secp256k1_ecrecover</a>(
+    signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    <a href="hash.md#0x2_hash">hash</a>: u8,
+): <a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;;
 </code></pre>
 
 
@@ -150,7 +154,12 @@ If the signature is valid to the pubkey and hashed message, return true. Else fa
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="ecdsa_k1.md#0x2_ecdsa_k1_secp256k1_verify">secp256k1_verify</a>(signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, public_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, <a href="hash.md#0x2_hash">hash</a>: u8): bool;
+<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="ecdsa_k1.md#0x2_ecdsa_k1_secp256k1_verify">secp256k1_verify</a>(
+    signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    public_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    <a href="hash.md#0x2_hash">hash</a>: u8,
+): bool;
 </code></pre>
 
 

diff --git a/crates/sui-framework/docs/sui-framework/ecdsa_r1.md b/crates/sui-framework/docs/sui-framework/ecdsa_r1.md
@@ -82,7 +82,11 @@ applied to Secp256r1 signatures. May fail with <code><a href="ecdsa_r1.md#0x2_ec
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="ecdsa_r1.md#0x2_ecdsa_r1_secp256r1_ecrecover">secp256r1_ecrecover</a>(signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, <a href="hash.md#0x2_hash">hash</a>: u8): <a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;;
+<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="ecdsa_r1.md#0x2_ecdsa_r1_secp256r1_ecrecover">secp256r1_ecrecover</a>(
+    signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    <a href="hash.md#0x2_hash">hash</a>: u8,
+): <a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;;
 </code></pre>
 
 
@@ -113,7 +117,12 @@ If the signature is valid to the pubkey and hashed message, return true. Else fa
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="ecdsa_r1.md#0x2_ecdsa_r1_secp256r1_verify">secp256r1_verify</a>(signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, public_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, <a href="hash.md#0x2_hash">hash</a>: u8): bool;
+<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="ecdsa_r1.md#0x2_ecdsa_r1_secp256r1_verify">secp256r1_verify</a>(
+    signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    public_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    <a href="hash.md#0x2_hash">hash</a>: u8,
+): bool;
 </code></pre>
 
 

diff --git a/crates/sui-framework/docs/sui-framework/ecvrf.md b/crates/sui-framework/docs/sui-framework/ecvrf.md
@@ -64,7 +64,12 @@ Verify a proof for a Ristretto ECVRF. Returns true if the proof is valid and cor
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="ecvrf.md#0x2_ecvrf_ecvrf_verify">ecvrf_verify</a>(<a href="hash.md#0x2_hash">hash</a>: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, alpha_string: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, public_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, proof: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;): bool;
+<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="ecvrf.md#0x2_ecvrf_ecvrf_verify">ecvrf_verify</a>(
+    <a href="hash.md#0x2_hash">hash</a>: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    alpha_string: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    public_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    proof: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+): bool;
 </code></pre>
 
 

diff --git a/crates/sui-framework/docs/sui-framework/ed25519.md b/crates/sui-framework/docs/sui-framework/ed25519.md
@@ -32,7 +32,11 @@ Otherwise, return false.
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="ed25519.md#0x2_ed25519_ed25519_verify">ed25519_verify</a>(signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, public_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;): bool;
+<pre><code><b>public</b> <b>native</b> <b>fun</b> <a href="ed25519.md#0x2_ed25519_ed25519_verify">ed25519_verify</a>(
+    signature: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    public_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    msg: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+): bool;
 </code></pre>
 
 

diff --git a/crates/sui-framework/docs/sui-framework/groth16.md b/crates/sui-framework/docs/sui-framework/groth16.md
@@ -268,12 +268,17 @@ Creates a <code><a href="groth16.md#0x2_groth16_PreparedVerifyingKey">PreparedVe
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>fun</b> <a href="groth16.md#0x2_groth16_pvk_from_bytes">pvk_from_bytes</a>(vk_gamma_abc_g1_bytes: <a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, alpha_g1_beta_g2_bytes: <a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, gamma_g2_neg_pc_bytes: <a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, delta_g2_neg_pc_bytes: <a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;): <a href="groth16.md#0x2_groth16_PreparedVerifyingKey">PreparedVerifyingKey</a> {
+<pre><code><b>public</b> <b>fun</b> <a href="groth16.md#0x2_groth16_pvk_from_bytes">pvk_from_bytes</a>(
+    vk_gamma_abc_g1_bytes: <a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    alpha_g1_beta_g2_bytes: <a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    gamma_g2_neg_pc_bytes: <a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    delta_g2_neg_pc_bytes: <a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+): <a href="groth16.md#0x2_groth16_PreparedVerifyingKey">PreparedVerifyingKey</a> {
     <a href="groth16.md#0x2_groth16_PreparedVerifyingKey">PreparedVerifyingKey</a> {
         vk_gamma_abc_g1_bytes,
         alpha_g1_beta_g2_bytes,
         gamma_g2_neg_pc_bytes,
-        delta_g2_neg_pc_bytes
+        delta_g2_neg_pc_bytes,
     }
 }
 </code></pre>
@@ -411,7 +416,10 @@ Native functions that flattens the inputs into an array and passes to the Rust n
 <summary>Implementation</summary>
 
 
-<pre><code><b>native</b> <b>fun</b> <a href="groth16.md#0x2_groth16_prepare_verifying_key_internal">prepare_verifying_key_internal</a>(curve: u8, verifying_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;): <a href="groth16.md#0x2_groth16_PreparedVerifyingKey">PreparedVerifyingKey</a>;
+<pre><code><b>native</b> <b>fun</b> <a href="groth16.md#0x2_groth16_prepare_verifying_key_internal">prepare_verifying_key_internal</a>(
+    curve: u8,
+    verifying_key: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+): <a href="groth16.md#0x2_groth16_PreparedVerifyingKey">PreparedVerifyingKey</a>;
 </code></pre>
 
 
@@ -439,15 +447,20 @@ Returns a boolean indicating whether the proof is valid.
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>fun</b> <a href="groth16.md#0x2_groth16_verify_groth16_proof">verify_groth16_proof</a>(curve: &<a href="groth16.md#0x2_groth16_Curve">Curve</a>, prepared_verifying_key: &<a href="groth16.md#0x2_groth16_PreparedVerifyingKey">PreparedVerifyingKey</a>, public_proof_inputs: &<a href="groth16.md#0x2_groth16_PublicProofInputs">PublicProofInputs</a>, proof_points: &<a href="groth16.md#0x2_groth16_ProofPoints">ProofPoints</a>): bool {
+<pre><code><b>public</b> <b>fun</b> <a href="groth16.md#0x2_groth16_verify_groth16_proof">verify_groth16_proof</a>(
+    curve: &<a href="groth16.md#0x2_groth16_Curve">Curve</a>,
+    prepared_verifying_key: &<a href="groth16.md#0x2_groth16_PreparedVerifyingKey">PreparedVerifyingKey</a>,
+    public_proof_inputs: &<a href="groth16.md#0x2_groth16_PublicProofInputs">PublicProofInputs</a>,
+    proof_points: &<a href="groth16.md#0x2_groth16_ProofPoints">ProofPoints</a>,
+): bool {
     <a href="groth16.md#0x2_groth16_verify_groth16_proof_internal">verify_groth16_proof_internal</a>(
         curve.id,
         &prepared_verifying_key.vk_gamma_abc_g1_bytes,
         &prepared_verifying_key.alpha_g1_beta_g2_bytes,
         &prepared_verifying_key.gamma_g2_neg_pc_bytes,
         &prepared_verifying_key.delta_g2_neg_pc_bytes,
         &public_proof_inputs.bytes,
-        &proof_points.bytes
+        &proof_points.bytes,
     )
 }
 </code></pre>
@@ -472,7 +485,15 @@ Native functions that flattens the inputs into arrays of vectors and passed to t
 <summary>Implementation</summary>
 
 
-<pre><code><b>native</b> <b>fun</b> <a href="groth16.md#0x2_groth16_verify_groth16_proof_internal">verify_groth16_proof_internal</a>(curve: u8, vk_gamma_abc_g1_bytes: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, alpha_g1_beta_g2_bytes: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, gamma_g2_neg_pc_bytes: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, delta_g2_neg_pc_bytes: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, public_proof_inputs: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;, proof_points: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;): bool;
+<pre><code><b>native</b> <b>fun</b> <a href="groth16.md#0x2_groth16_verify_groth16_proof_internal">verify_groth16_proof_internal</a>(
+    curve: u8,
+    vk_gamma_abc_g1_bytes: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    alpha_g1_beta_g2_bytes: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    gamma_g2_neg_pc_bytes: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    delta_g2_neg_pc_bytes: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    public_proof_inputs: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+    proof_points: &<a href="../move-stdlib/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
+): bool;
 </code></pre>