doc: improve document of crypto

Author: SpiderMan670

ts_src/crypto.ts

@@ -8,10 +8,22 @@ import { ripemd160 } from '@noble/hashes/ripemd160';
 import { sha256 } from '@noble/hashes/sha256';
 import * as tools from 'uint8array-tools';
 
+/**
+ * Computes the HASH160 (RIPEMD-160 after SHA-256) of the given buffer.
+ *
+ * @param buffer - The input data to be hashed.
+ * @returns The HASH160 of the input buffer.
+ */
 export function hash160(buffer: Uint8Array): Uint8Array {
   return ripemd160(sha256(buffer));
 }
 
+/**
+ * Computes the double SHA-256 hash of the given buffer.
+ *
+ * @param buffer - The input data to be hashed.
+ * @returns The double SHA-256 hash of the input buffer.
+ */
 export function hash256(buffer: Uint8Array): Uint8Array {
   return sha256(sha256(buffer));
 }
@@ -31,9 +43,23 @@ export type TaggedHashPrefix = (typeof TAGS)[number];
 type TaggedHashPrefixes = {
   [key in TaggedHashPrefix]: Uint8Array;
 };
-/** An object mapping tags to their tagged hash prefix of [SHA256(tag) | SHA256(tag)] */
+
 /**
- * Defines the tagged hash prefixes used in the crypto module.
+ * A collection of tagged hash prefixes used in various BIP (Bitcoin Improvement Proposals)
+ * and Taproot-related operations. Each prefix is represented as a `Uint8Array`.
+ * 
+ * @constant
+ * @type {TaggedHashPrefixes}
+ * 
+ * @property {'BIP0340/challenge'} - Prefix for BIP0340 challenge.
+ * @property {'BIP0340/aux'} - Prefix for BIP0340 auxiliary data.
+ * @property {'BIP0340/nonce'} - Prefix for BIP0340 nonce.
+ * @property {TapLeaf} - Prefix for Taproot leaf.
+ * @property {TapBranch} - Prefix for Taproot branch.
+ * @property {TapSighash} - Prefix for Taproot sighash.
+ * @property {TapTweak} - Prefix for Taproot tweak.
+ * @property {'KeyAgg list'} - Prefix for key aggregation list.
+ * @property {'KeyAgg coefficient'} - Prefix for key aggregation coefficient.
  */
 export const TAGGED_HASH_PREFIXES: TaggedHashPrefixes = {
   'BIP0340/challenge': Uint8Array.from([
@@ -92,9 +118,17 @@ export const TAGGED_HASH_PREFIXES: TaggedHashPrefixes = {
   ]),
 };
 
+/**
+ * Computes a tagged hash using the specified prefix and data.
+ *
+ * @param prefix - The prefix to use for the tagged hash. This should be one of the values from the `TaggedHashPrefix` enum.
+ * @param data - The data to hash, provided as a `Uint8Array`.
+ * @returns The resulting tagged hash as a `Uint8Array`.
+ */
 export function taggedHash(
   prefix: TaggedHashPrefix,
   data: Uint8Array,
 ): Uint8Array {
   return sha256(tools.concat([TAGGED_HASH_PREFIXES[prefix], data]));
 }
+