From 37100d7284733aa8386b33bbb725224a0de568a2 Mon Sep 17 00:00:00 2001 From: Jonas Schnelli Date: Mon, 5 Oct 2015 12:50:11 +0200 Subject: [PATCH] improve ECDH header-doc - use pubkey instead of point - use privkey instead of scalar --- include/secp256k1_ecdh.h | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/include/secp256k1_ecdh.h b/include/secp256k1_ecdh.h index db520f4467a01..4b84d7a963499 100644 --- a/include/secp256k1_ecdh.h +++ b/include/secp256k1_ecdh.h @@ -10,17 +10,18 @@ extern "C" { /** Compute an EC Diffie-Hellman secret in constant time * Returns: 1: exponentiation was successful * 0: scalar was invalid (zero or overflow) - * Args: ctx: pointer to a context object (cannot be NULL) - * Out: result: a 32-byte array which will be populated by an ECDH - * secret computed from the point and scalar - * In: point: pointer to a public point - * scalar: a 32-byte scalar with which to multiply the point + * Args: ctx: pointer to a context object (cannot be NULL) + * Out: result: a 32-byte array which will be populated by an ECDH + * secret computed from the point and scalar + * In: pubkey: a pointer to a secp256k1_pubkey containing an + * initialized public key + * privkey: a 32-byte scalar with which to multiply the point */ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ecdh( const secp256k1_context* ctx, unsigned char *result, - const secp256k1_pubkey *point, - const unsigned char *scalar + const secp256k1_pubkey *pubkey, + const unsigned char *privkey ) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3) SECP256K1_ARG_NONNULL(4); # ifdef __cplusplus