Merge pull request #346 from ene-rizzles/feat/stellar-key-validation

Add Stellar public key validation utility (#244)

Author: AlAfiz

src/components/TokenSelectModal.tsx

@@ -3,6 +3,7 @@
 import React, { useState, useMemo } from 'react';
 import { X, AlertCircle } from 'lucide-react';
 import Icon from './ui/Icon';
+import { isValidStellarPublicKey } from '@/lib/validation';
 
 interface Token {
   symbol: string;
@@ -35,7 +36,7 @@ export const TokenSelectModal: React.FC<TokenSelectModalProps> = ({
     );
   }, [tokens, searchQuery]);
 
-  const isStellarAddress = searchQuery.length === 56;
+  const isStellarAddress = isValidStellarPublicKey(searchQuery);
   const showImportUI = isStellarAddress && filteredTokens.length === 0;
 
   if (!isOpen) return null;

src/lib/__tests__/validation.test.ts

@@ -0,0 +1,43 @@
+import { isValidStellarPublicKey } from '../validation';
+
+describe('isValidStellarPublicKey', () => {
+  const VALID_KEY = 'GBBHPLX4LBHS5JPC4FBDHD4YDZSZJZG7VQMIY6RDZT6HRJ5QJ5N6KFGH';
+
+  test('returns true for valid Stellar public key', () => {
+    expect(isValidStellarPublicKey(VALID_KEY)).toBe(true);
+  });
+
+  test('returns false for string not starting with G', () => {
+    expect(isValidStellarPublicKey('A' + VALID_KEY.slice(1))).toBe(false);
+  });
+
+  test('returns false for string shorter than 56 characters', () => {
+    expect(isValidStellarPublicKey('GBBHPLX4LBHS5JPC4FBDHD4YDZSZJZG7VQMIY6RDZT6HRJ5QJ5N6KF')).toBe(
+      false
+    );
+  });
+
+  test('returns false for string longer than 56 characters', () => {
+    expect(isValidStellarPublicKey(VALID_KEY + 'A')).toBe(false);
+  });
+
+  test('returns false for empty string', () => {
+    expect(isValidStellarPublicKey('')).toBe(false);
+  });
+
+  test('returns false for non-string input', () => {
+    expect(isValidStellarPublicKey(null as any)).toBe(false);
+    expect(isValidStellarPublicKey(undefined as any)).toBe(false);
+  });
+
+  test('returns false for key with invalid base32 characters', () => {
+    const invalidKey = 'GBBHPLX4LBHS5JPC4FBDHD4YDZSZJZG7VQMIY6RDZT6HRJ5QJ5N6KFGI';
+    expect(isValidStellarPublicKey(invalidKey)).toBe(false);
+  });
+
+  test('returns true for another valid Stellar public key', () => {
+    expect(
+      isValidStellarPublicKey('GBBD67IF633ZHJ2CCYBT6RILOY7Y6S6M5SOW2S2ZQRAGI7XRYB2TOC6S')
+    ).toBe(true);
+  });
+});

src/lib/validation.ts

@@ -0,0 +1,24 @@
+/**
+ * Validates whether a given string is a properly formatted Stellar public key.
+ *
+ * A valid Stellar ed25519 public key:
+ * - Starts with the letter 'G'
+ * - Is exactly 56 characters long
+ * - Uses the Stellar base32 alphabet (A-Z, 2-7)
+ *
+ * For bulletproof validation, consider using `@stellar/stellar-sdk`'s
+ * `StrKey.isValidEd25519PublicKey()` which performs additional checksum verification.
+ *
+ * @param key - The string to validate
+ * @returns True if the string is a valid Stellar public key
+ */
+export function isValidStellarPublicKey(key: string): boolean {
+  if (!key || typeof key !== 'string') return false;
+
+  if (key.length !== 56 || key[0] !== 'G') return false;
+
+  const stellarKeyRegex = /^G[A-Z2-7]{55}$/;
+  if (!stellarKeyRegex.test(key)) return false;
+
+  return true;
+}