Added doc for signWithEntropy

Christewart · Apr 17, 2020 · c9bab11 · c9bab11
1 parent d249767
commit c9bab11
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/java/org/bitcoin/NativeSecp256k1.java b/src/java/org/bitcoin/NativeSecp256k1.java
@@ -113,6 +113,12 @@ public static byte[] sign(byte[] data, byte[] seckey) throws AssertFailException
     /**
      * libsecp256k1 Create an ECDSA signature adding specified entropy.
      *
+     * This can be used to include your own entropy to nonce generation
+     * in addition to the message and private key, while still doing so deterministically.
+     *
+     * In particular, this is used when generating low R signatures.
+     * See https://github.com/bitcoin/bitcoin/pull/13666/
+     *
      * @param data Message hash, 32 bytes
      * @param seckey ECDSA Secret key, 32 bytes
      * @param entropy 32 bytes of entropy