Draft Inverse Bloom Filter

2025-01-20 07:47:07 +00:00
parent d6a04f4350
commit 1aebc6da42
21 changed files with 1285 additions and 381 deletions
@@ -12,6 +12,22 @@ export type MnemonicRaw = {
 /**
 * Class representing a BIP39 Mnemonic phrase.
 * Supports 12, 15, 18, 21, and 24 word phrases with optional passphrase.
+ *
+ * @example
+ *
+ * ```ts
+ * // Import our primitives.
+ * import { Mnemonic } from '@xocash/primitives';
+ *
+ * // Generate a random mnemonic.
+ * const mnemonic = Mnemonic.generateRandom();
+ *
+ * // Output the mnemonic phrase.
+ * console.log(mnemonic.toPhrase());
+ *
+ * // Derive the seed from the mnemonic.
+ * console.log(mnemonic.toSeed());
+ * ```
 */
 export class Mnemonic {
  protected static VALID_WORD_COUNTS = new Set([12, 15, 18, 21, 24]);