build: Add default constructor and javadoc for crypto, datatypes subprojects (#7069)

* javadoc - Adding default constructor and javadoc for :crypto
* javadoc - Adding default constructor and javadoc for :datatypes

---------

Signed-off-by: Usman Saleem <usman@usmans.info>
Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>
pull/7072/head
Usman Saleem 7 months ago committed by GitHub
parent a7e5548135
commit 892fc5e3ae
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 3
      crypto/algorithms/src/main/java/org/hyperledger/besu/crypto/ECPointUtil.java
  2. 3
      crypto/algorithms/src/main/java/org/hyperledger/besu/crypto/KeyPairUtil.java
  3. 3
      crypto/algorithms/src/main/java/org/hyperledger/besu/crypto/SecureRandomProvider.java
  4. 7
      crypto/algorithms/src/main/java/org/hyperledger/besu/crypto/altbn128/AltBn128Fq12Pairer.java
  5. 7
      datatypes/src/main/java/org/hyperledger/besu/datatypes/AccessListEntry.java
  6. 9
      datatypes/src/main/java/org/hyperledger/besu/datatypes/BlobsWithCommitments.java

@ -24,6 +24,9 @@ import org.bouncycastle.util.BigIntegers;
/** The Ec point util class. */
public class ECPointUtil {
/** Default constructor. */
private ECPointUtil() {}
/**
* From bouncy castle ec point to ECPoint.
*

@ -38,6 +38,9 @@ public class KeyPairUtil {
private static final Supplier<SignatureAlgorithm> SIGNATURE_ALGORITHM =
Suppliers.memoize(SignatureAlgorithmFactory::getInstance);
/** Default constructor */
private KeyPairUtil() {}
/**
* Load resource file string.
*

@ -23,6 +23,9 @@ import java.security.SecureRandom;
public class SecureRandomProvider {
private static final SecureRandom publicSecureRandom = secureRandom();
/** Default constructor. */
private SecureRandomProvider() {}
/**
* Returns a shared instance of secure random intended to be used where the value is used publicly
*

@ -20,8 +20,8 @@ import java.math.BigInteger;
import java.util.Arrays;
/**
* Adapted from the pc_ecc (Apache 2 License) implementation:
* https://github.com/ethereum/py_ecc/blob/master/py_ecc/bn128/bn128_field_elements.py
* Adapted from the pc_ecc (Apache 2 License) <a
* href="https://github.com/ethereum/py_ecc/tree/main/py_ecc/bn128">implementation</a>.
*/
public class AltBn128Fq12Pairer {
@ -33,6 +33,9 @@ public class AltBn128Fq12Pairer {
new BigInteger(
"21888242871839275222246405745257275088548364400416034343698204186575808495617");
/** Default constructor */
private AltBn128Fq12Pairer() {}
/**
* Pair fq 12.
*

@ -22,7 +22,12 @@ import com.fasterxml.jackson.annotation.JsonProperty;
import org.apache.tuweni.bytes.Bytes;
import org.apache.tuweni.bytes.Bytes32;
/** An access list entry as defined in EIP-2930 */
/**
* An access list entry as defined in EIP-2930
*
* @param address The Address
* @param storageKeys List of storage keys
*/
public record AccessListEntry(Address address, List<Bytes32> storageKeys) {
/**
* Create access list entry.

@ -22,7 +22,14 @@ import java.util.Objects;
/** A class to hold the blobs, commitments, proofs and versioned hashes for a set of blobs. */
public class BlobsWithCommitments {
/** A record to hold the blob, commitment, proof and versioned hash for a blob. */
/**
* A record to hold the blob, commitment, proof and versioned hash for a blob.
*
* @param blob The blob
* @param kzgCommitment The commitment
* @param kzgProof The proof
* @param versionedHash The versioned hash
*/
public record BlobQuad(
Blob blob, KZGCommitment kzgCommitment, KZGProof kzgProof, VersionedHash versionedHash) {}

Loading…
Cancel
Save