examples: make key generation doc consistent

bitcoin-core · Oct 14, 2024 · 5bab8f6 · 5bab8f6
1 parent e890822
commit 5bab8f6
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 15 deletions.
diff --git a/examples/ecdh.c b/examples/ecdh.c
@@ -47,8 +47,8 @@ int main(void) {
         return 1;
     }
     /* If the secret key is zero or out of range (greater than secp256k1's
-    * order), we fail. Note that the probability of this occurring
-    * is negligible with a properly functioning random number generator. */
+    * order), we fail. Note that the probability of this occurring is negligible
+    * with a properly functioning random number generator. */
     if (!secp256k1_ec_seckey_verify(ctx, seckey1) || !secp256k1_ec_seckey_verify(ctx, seckey2)) {
         printf("Generated secret key is invalid. This indicates an issue with the random number generator.\n");
         return 1;

diff --git a/examples/ecdsa.c b/examples/ecdsa.c
@@ -49,13 +49,13 @@ int main(void) {
     assert(return_val);
 
     /*** Key Generation ***/
-    /* If the secret key is zero or out of range (greater than secp256k1's
-    * order), we return 1. Note that the probability of this occurring
-    * is negligible with a properly functioning random number generator. */
     if (!fill_random(seckey, sizeof(seckey))) {
         printf("Failed to generate randomness\n");
         return 1;
     }
+    /* If the secret key is zero or out of range (greater than secp256k1's
+    * order), we fail. Note that the probability of this occurring is negligible
+    * with a properly functioning random number generator. */
     if (!secp256k1_ec_seckey_verify(ctx, seckey)) {
         printf("Generated secret key is invalid. This indicates an issue with the random number generator.\n");
         return 1;

diff --git a/examples/ellswift.c b/examples/ellswift.c
@@ -47,14 +47,13 @@ int main(void) {
     assert(return_val);
 
     /*** Generate secret keys ***/
-
-    /* If the secret key is zero or out of range (greater than secp256k1's
-     * order), we return 1. Note that the probability of this occurring
-     * is negligible with a properly functioning random number generator. */
     if (!fill_random(seckey1, sizeof(seckey1)) || !fill_random(seckey2, sizeof(seckey2))) {
         printf("Failed to generate randomness\n");
         return 1;
     }
+    /* If the secret key is zero or out of range (greater than secp256k1's
+    * order), we fail. Note that the probability of this occurring is negligible
+    * with a properly functioning random number generator. */
     if (!secp256k1_ec_seckey_verify(ctx, seckey1) || !secp256k1_ec_seckey_verify(ctx, seckey2)) {
         printf("Generated secret key is invalid. This indicates an issue with the random number generator.\n");
         return 1;

diff --git a/examples/schnorr.c b/examples/schnorr.c
@@ -43,18 +43,17 @@ int main(void) {
     assert(return_val);
 
     /*** Key Generation ***/
-    /* If the secret key is zero or out of range (greater than secp256k1's
-    * order), we return 1. Note that the probability of this occurring
-    * is negligible with a properly functioning random number generator. */
     if (!fill_random(seckey, sizeof(seckey))) {
         printf("Failed to generate randomness\n");
         return 1;
     }
-    /* Try to create a keypair with a valid context, it should only fail if
-     * the secret key is zero or out of range. */
+    /* Try to create a keypair with a valid context. This only fails if the
+     * secret key is zero or out of range (greater than secp256k1's order). Note
+     * that the probability of this occurring is negligible with a properly
+     * functioning random number generator. */
     if (!secp256k1_keypair_create(ctx, &keypair, seckey)) {
         printf("Generated secret key is invalid. This indicates an issue with the random number generator.\n");
-	return 1;
+        return 1;
     }
 
     /* Extract the X-only public key from the keypair. We pass NULL for