rbsecp256k1 6.0.1 → 6.0.2

data/documentation/key_pair.md

@@ -1,25 +1,25 @@
-[Index](index.md)
-
-Secp256k1::KeyPair
-==================
-
-Secp256k1::KeyPair represents a public-private Secp256k1 key pair.
-
-Instance Methods
-----------------
-
-#### public_key
-
-Returns the [PublicKey](public_key.md) part of this key pair.
-
-#### xonly_public_key
-
-Returns the [XOnlyPublicKey](xonly_public_key.md).
-
-#### private_key
-
-Returns the [PrivateKey](private_key.md) part of this key pair.
-
-#### ==(other)
-
-Returns `true` if the `other` has the same public and private key.
+[Index](index.md)
+
+Secp256k1::KeyPair
+==================
+
+Secp256k1::KeyPair represents a public-private Secp256k1 key pair.
+
+Instance Methods
+----------------
+
+#### public_key
+
+Returns the [PublicKey](public_key.md) part of this key pair.
+
+#### xonly_public_key
+
+Returns the [XOnlyPublicKey](xonly_public_key.md).
+
+#### private_key
+
+Returns the [PrivateKey](private_key.md) part of this key pair.
+
+#### ==(other)
+
+Returns `true` if the `other` has the same public and private key.

data/documentation/private_key.md

@@ -1,25 +1,25 @@
-[Index](index.md)
-
-Secp256k1::PrivateKey
-=====================
-
-Secp256k1::PrivateKey represents the private key part of a public-private key pair.
-
-Class Methods
--------------
-
-#### from_data(private_key_data)
-
-Loads new private key from the given binary `private_key_data` string. Raises
-`Secp256k1::Error` if the given data is invalid.
-
-Instance Methods
-----------------
-
-#### data
-
-Returns the binary private key data as a `String`.
-
-#### ==(other)
-
-Returns `true` if this private key matches `other`.
+[Index](index.md)
+
+Secp256k1::PrivateKey
+=====================
+
+Secp256k1::PrivateKey represents the private key part of a public-private key pair.
+
+Class Methods
+-------------
+
+#### from_data(private_key_data)
+
+Loads new private key from the given binary `private_key_data` string. Raises
+`Secp256k1::Error` if the given data is invalid.
+
+Instance Methods
+----------------
+
+#### data
+
+Returns the binary private key data as a `String`.
+
+#### ==(other)
+
+Returns `true` if this private key matches `other`.

data/documentation/public_key.md

@@ -1,36 +1,36 @@
-[Index](index.md)
-
-Secp256k1::PublicKey
-====================
-
-Secp256k1::PublicKey represents the public key part of a public-private key pair.
-
-See: [KeyPair](key_pair.md)
-
-Class Methods
--------------
-
-#### from_data(public_key_data)
-
-Parses compressed or uncompressed from binary string `public_key_data` and
-creates and returns a new public key from it. Raises a `Secp256k1::DeserializationError`
-if the given public key data is invalid.
-
-Instance Methods
-----------------
-
-#### compressed
-
-Returns the binary compressed representation of this public key.
-
-#### uncompressed
-
-Returns the binary uncompressed representation of this public key.
-
-### to_xonly
-
-Returns the `XOnlyPublicKey` equivalent of this key.
-
-#### ==(other)
-
-Return `true` if this public key matches `other`.
+[Index](index.md)
+
+Secp256k1::PublicKey
+====================
+
+Secp256k1::PublicKey represents the public key part of a public-private key pair.
+
+See: [KeyPair](key_pair.md)
+
+Class Methods
+-------------
+
+#### from_data(public_key_data)
+
+Parses compressed or uncompressed from binary string `public_key_data` and
+creates and returns a new public key from it. Raises a `Secp256k1::DeserializationError`
+if the given public key data is invalid.
+
+Instance Methods
+----------------
+
+#### compressed
+
+Returns the binary compressed representation of this public key.
+
+#### uncompressed
+
+Returns the binary uncompressed representation of this public key.
+
+### to_xonly
+
+Returns the `XOnlyPublicKey` equivalent of this key.
+
+#### ==(other)
+
+Return `true` if this public key matches `other`.

data/documentation/recoverable_signature.md

@@ -1,30 +1,30 @@
-[Index](index.md)
-
-Secp256k1::RecoverableSignature
-===============================
-
-**Requires:** libsecp256k1 was build with recovery module.
-
-Secp256k1::RecoverableSignature represents a recoverable ECDSA signature
-signing the 32-byte SHA-256 hash of some data.
-
-Instance Methods
-----------------
-
-#### compact
-
-Returns an array whose first element is the 64-byte compact signature as a
-binary string and whose second element is the integer recovery ID.
-
-#### recover_public_key
-
-Recovers the public key corresponding to the recoverable signature. Returns a
-[PublicKey](public_key.md).
-
-#### to_signature
-
-Converts a recoverable signature to a non-recoverable [Signature](signature.md) object.
-
-#### ==(other)
-
-Returns `true` if this recoverable signature matches `other`.
+[Index](index.md)
+
+Secp256k1::RecoverableSignature
+===============================
+
+**Requires:** libsecp256k1 was build with recovery module.
+
+Secp256k1::RecoverableSignature represents a recoverable ECDSA signature
+signing the 32-byte SHA-256 hash of some data.
+
+Instance Methods
+----------------
+
+#### compact
+
+Returns an array whose first element is the 64-byte compact signature as a
+binary string and whose second element is the integer recovery ID.
+
+#### recover_public_key
+
+Recovers the public key corresponding to the recoverable signature. Returns a
+[PublicKey](public_key.md).
+
+#### to_signature
+
+Converts a recoverable signature to a non-recoverable [Signature](signature.md) object.
+
+#### ==(other)
+
+Returns `true` if this recoverable signature matches `other`.

data/documentation/schnorr_signature.md

@@ -1,30 +1,34 @@
-[Index](index.md)
-
-Secp256k1::SchnorrSignature
-===========================
-
-Secp256k1::SchnorrSignature represents an Schnorr signature signing a 32-byte message.
-
-Class Methods
--------------
-
-#### from_data(schnorr_sig_data)
-
-Loads a new Schnorr signature from the given 64-byte binary
-`schnorr_sig_data`. Does not perform any validation on the loaded data.
-
-Instance Methods
-----------------
-
-#### serialized
-
-Returns the 64-byte binary `String` of the serialized Schnorr signature.
-
-#### verify(msg, xonly_pubkey)
-
-Returns `true` if the schnorr signature is a valid signing of `msg` with the
-private key for `xonly_pubkey`, `false` otherwise.
-
-#### ==(other)
-
-Returns `true` if this signature matches `other`.
+[Index](index.md)
+
+Secp256k1::SchnorrSignature
+===========================
+
+Secp256k1::SchnorrSignature represents a 64-byte Schnorr signature of a message
+of any byte length, including zero.
+
+Class Methods
+-------------
+
+#### from_data(schnorr_sig_data)
+
+Loads a new Schnorr signature from the given 64-byte binary
+`schnorr_sig_data`. Does not perform any validation on the loaded data.
+
+Instance Methods
+----------------
+
+#### serialized
+
+Returns the 64-byte binary `String` of the serialized Schnorr signature.
+
+#### verify(msg, xonly_pubkey)
+
+Returns `true` if the schnorr signature is a valid signing of `msg` with the
+private key for `xonly_pubkey`, `false` otherwise.
+
+`msg` must be a Ruby `String` containing the exact bytes passed to signing.
+It may have any byte length, including zero. No implicit hashing is performed.
+
+#### ==(other)
+
+Returns `true` if this signature matches `other`.

data/documentation/secp256k1.md

@@ -1,24 +1,24 @@
-[Index](index.md)
-
-Secp256k1
-=========
-
-Secp256k1 is the top-level module for this library.
-
-Class Methods
--------------
-
-#### have_recovery?
-
-Returns `true` if the recovery module was built with libsecp256k1, `false`
-otherwise.
-
-#### have_ecdh?
-
-Returns `true` if the EC Diffie-Hellman module was built with libsecp256k1,
-`false` otherwise.
-
-#### have_schnorr?
-
-Returns `true` if the Schnorr signature module was built with libsecp256k1,
-`false` otherwise.
+[Index](index.md)
+
+Secp256k1
+=========
+
+Secp256k1 is the top-level module for this library.
+
+Class Methods
+-------------
+
+#### have_recovery?
+
+Returns `true` if the recovery module was built with libsecp256k1, `false`
+otherwise.
+
+#### have_ecdh?
+
+Returns `true` if the EC Diffie-Hellman module was built with libsecp256k1,
+`false` otherwise.
+
+#### have_schnorr?
+
+Returns `true` if the Schnorr signature module was built with libsecp256k1,
+`false` otherwise.

data/documentation/shared_secret.md

@@ -1,14 +1,14 @@
-[Index](index.md)
-
-Secp256k1::SharedSecret
-=======================
-
-Secp256k1::SharedSecret represents a 32-byte shared secret computed from a
-public key (point) and private key (scalar).
-
-Instance Methods
-----------------
-
-#### data
-
-Binary string containing the 32-byte shared secret.
+[Index](index.md)
+
+Secp256k1::SharedSecret
+=======================
+
+Secp256k1::SharedSecret represents a 32-byte shared secret computed from a
+public key (point) and private key (scalar).
+
+Instance Methods
+----------------
+
+#### data
+
+Binary string containing the 32-byte shared secret.

data/documentation/signature.md

@@ -1,42 +1,42 @@
-[Index](index.md)
-
-Secp256k1::Signature
-====================
-
-Secp256k1::Signature represents an ECDSA signature signing the 32-byte SHA-256
-hash of some data.
-
-Class Methods
--------------
-
-#### from_compact(compact_signature)
-
-Parses a signature from binary string `compact_signature`. Raises a
-`Secp256k1::DeserializationError` if the signature data is invalid.
-
-#### from_der_encoded(der_encoded_signature)
-
-Parses a signature from binary string `der_encoded_signature`. Raises a
-`Secp256k1::DeserializationError` if the signature data is invalid.
-
-Instance Methods
-----------------
-
-#### der_encoded
-
-Returns the DER encoded representation of this signature.
-
-#### compact
-
-Returns the compact 64-byte representation of this signature.
-
-#### normalized
-
-Returns an array containing two elements. The first is a Boolean indicating
-whether or not the signature was normalized, false if it was already in lower-S
-normal form. The second element is a `Signature` containing the normalized
-signature object.
-
-#### ==(other)
-
-Returns `true` if this signature matches `other`.
+[Index](index.md)
+
+Secp256k1::Signature
+====================
+
+Secp256k1::Signature represents an ECDSA signature signing the 32-byte SHA-256
+hash of some data.
+
+Class Methods
+-------------
+
+#### from_compact(compact_signature)
+
+Parses a signature from binary string `compact_signature`. Raises a
+`Secp256k1::DeserializationError` if the signature data is invalid.
+
+#### from_der_encoded(der_encoded_signature)
+
+Parses a signature from binary string `der_encoded_signature`. Raises a
+`Secp256k1::DeserializationError` if the signature data is invalid.
+
+Instance Methods
+----------------
+
+#### der_encoded
+
+Returns the DER encoded representation of this signature.
+
+#### compact
+
+Returns the compact 64-byte representation of this signature.
+
+#### normalized
+
+Returns an array containing two elements. The first is a Boolean indicating
+whether or not the signature was normalized, false if it was already in lower-S
+normal form. The second element is a `Signature` containing the normalized
+signature object.
+
+#### ==(other)
+
+Returns `true` if this signature matches `other`.

data/documentation/util.md

@@ -1,17 +1,17 @@
-[Index](index.md)
-
-Secp256k1::Util
-===============
-
-Secp256k1::Util in a module containing generally useful methods for using the library.
-
-Class Methods
--------------
-
-#### bin_to_hex(binary_data)
-
-Returns the hexadecimal string representation of `binary_data`
-
-#### hex_to_bin(hex_string)
-
-Returns the binary string representation of `hex_string`
+[Index](index.md)
+
+Secp256k1::Util
+===============
+
+Secp256k1::Util in a module containing generally useful methods for using the library.
+
+Class Methods
+-------------
+
+#### bin_to_hex(binary_data)
+
+Returns the hexadecimal string representation of `binary_data`
+
+#### hex_to_bin(hex_string)
+
+Returns the binary string representation of `hex_string`

data/documentation/xonly_public_key.md

@@ -1,29 +1,29 @@
-[Index](index.md)
-
-Secp256k1::XOnlyPublicKey
-=========================
-
-Secp256k1::XOnlyPublicKey represents an x-only public key version of a public key.
-
-See: [KeyPair](key_pair.md)
-
-Class Methods
--------------
-
-#### from_data(xonly_public_key_serialized)
-
-Parses the 32-byte serialized binary `xonly_public_key_serialized` and creates
-and returns a new x-only public key from it. Raises a
-`Secp256k1::DeserializationError` if the given x-only public key data is
-invalid.
-
-Instance Methods
-----------------
-
-#### serialized
-
-Serializes the `XOnlyPublicKey` into a 32-byte binary `String`.
-
-#### ==(other)
-
-Return `true` if this x-only public key matches `other`.
+[Index](index.md)
+
+Secp256k1::XOnlyPublicKey
+=========================
+
+Secp256k1::XOnlyPublicKey represents an x-only public key version of a public key.
+
+See: [KeyPair](key_pair.md)
+
+Class Methods
+-------------
+
+#### from_data(xonly_public_key_serialized)
+
+Parses the 32-byte serialized binary `xonly_public_key_serialized` and creates
+and returns a new x-only public key from it. Raises a
+`Secp256k1::DeserializationError` if the given x-only public key data is
+invalid.
+
+Instance Methods
+----------------
+
+#### serialized
+
+Serializes the `XOnlyPublicKey` into a 32-byte binary `String`.
+
+#### ==(other)
+
+Return `true` if this x-only public key matches `other`.