StaticHelpersChecksum

Overview

The StaticHelpersChecksum class provides static helper functions for BrightChain and BrightChain Quorum. It includes utilities for encryption, Shamir’s Secret Sharing, ECDSA, BIP39 Mnemonic generation, AES encryption, and RSA key generation, encryption/decryption.

Methods

Sha3DefaultHashBits

• Purpose: Default hash bits for SHA3.
• Type: Static readonly property.
• Value: 512.

Sha3ChecksumBufferLength

• Purpose: Length of a SHA3 checksum buffer.
• Type: Static readonly property.
• Value: 64.

calculateChecksum

• Purpose: Calculates the checksum of a buffer.
• Parameters:
  • data (Buffer): The buffer to calculate the checksum of.
• Returns: The checksum as a buffer.
• Example:

  const data = Buffer.from('hello world');
  const checksum = StaticHelpersChecksum.calculateChecksum(data);
  

calculateChecksumAsync

• Purpose: Calculates the checksum of a buffer or readable stream.
• Parameters:

  • input (Buffer

    Readable): The buffer or readable stream to calculate the checksum of.

• Returns: The checksum as a buffer.
• Example:

  const data = Buffer.from('hello world');
  const checksum = await StaticHelpersChecksum.calculateChecksumAsync(data);
  

validateChecksum

• Purpose: Validates a checksum against a buffer.
• Parameters:
  • data (Buffer): The data to validate.
  • checksum (ChecksumBuffer): The checksum to validate against.
• Returns: True if the checksum is valid, false otherwise.
• Example:

  const data = Buffer.from('hello world');
  const checksum = StaticHelpersChecksum.calculateChecksum(data);
  const isValid = StaticHelpersChecksum.validateChecksum(data, checksum);
  

validateChecksumAsync

• Purpose: Validates a checksum against a buffer or readable stream.
• Parameters:

  • data (Buffer

    Readable): The data to validate.

  • checksum (ChecksumBuffer): The checksum to validate against.
• Returns: True if the checksum is valid, false otherwise.
• Example:

  const data = Buffer.from('hello world');
  const checksum = StaticHelpersChecksum.calculateChecksum(data);
  const isValid = await StaticHelpersChecksum.validateChecksumAsync(
    data,
    checksum,
  );
  

checksumBufferToChecksumString

• Purpose: Converts a checksum buffer to a checksum string.
• Parameters:
  • checksumBuffer (ChecksumBuffer): The checksum buffer to convert.
• Returns: The checksum as a string.
• Example:

  const data = Buffer.from('hello world');
  const checksumBuffer = StaticHelpersChecksum.calculateChecksum(data);
  const checksumString =
    StaticHelpersChecksum.checksumBufferToChecksumString(checksumBuffer);
  

checksumStringToChecksumBuffer

• Purpose: Converts a checksum string to a checksum buffer.
• Parameters:
  • checksumString (ChecksumString): The checksum string to convert.
• Returns: The checksum as a buffer.
• Example:

  const data = Buffer.from('hello world');
  const checksumBuffer = StaticHelpersChecksum.calculateChecksum(data);
  const checksumString =
    StaticHelpersChecksum.checksumBufferToChecksumString(checksumBuffer);
  const backToBuffer =
    StaticHelpersChecksum.checksumStringToChecksumBuffer(checksumString);
  

Conclusion

The StaticHelpersChecksum class provides essential utilities for checksum calculations, validation, and conversion, ensuring data integrity and security in the BrightChain and BrightChain Quorum systems.