@waku/message-hash/src/index.ts

TypeScript implementation of the Deterministic Message Hashing as specified in 14/WAKU2-MESSAGE

import { sha256 } from "@noble/hashes/sha256";
import type { IDecodedMessage, IProtoMessage } from "@waku/interfaces";
import { isDefined } from "@waku/utils";
import {
  bytesToHex,
  concat,
  numberToBytes,
  utf8ToBytes
} from "@waku/utils/bytes";

/**
 * Deterministic Message Hashing as defined in
 * [14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/#deterministic-message-hashing)
 */
export function messageHash(
  pubsubTopic: string,
  message: IProtoMessage | IDecodedMessage
): Uint8Array {
  const pubsubTopicBytes = utf8ToBytes(pubsubTopic);
  const contentTopicBytes = utf8ToBytes(message.contentTopic);
  const timestampBytes = tryConvertTimestampToBytes(message.timestamp);

  const bytes = concat(
    [
      pubsubTopicBytes,
      message.payload,
      contentTopicBytes,
      message.meta,
      timestampBytes
    ].filter(isDefined)
  );

  return sha256(bytes);
}

function tryConvertTimestampToBytes(
  timestamp: Date | number | bigint | undefined
): undefined | Uint8Array {
  if (!timestamp) {
    return;
  }

  let bigIntTimestamp: bigint;

  if (typeof timestamp === "bigint") {
    bigIntTimestamp = timestamp;
  } else {
    bigIntTimestamp = BigInt(timestamp.valueOf()) * 1000000n;
  }

  return numberToBytes(bigIntTimestamp);
}

export function messageHashStr(
  pubsubTopic: string,
  message: IProtoMessage | IDecodedMessage
): string {
  const hash = messageHash(pubsubTopic, message);
  const hashStr = bytesToHex(hash);
  return hashStr;
}