StrKeys

The StrKeys module provides TypeScript type guards for validating Stellar key formats as defined in SEP-23.

Type Guards

Use StrKey to validate and narrow string types:

import { StrKey } from "@colibri/core";

const input = "GABC...";

if (StrKey.isEd25519PublicKey(input)) {
  // TypeScript knows input is Ed25519PublicKey
  await loadAccount(input);
}

if (StrKey.isContractId(input)) {
  // TypeScript knows input is ContractId
  await invokeContract(input);
}

if (StrKey.isMuxedAddress(input)) {
  // TypeScript knows input is MuxedAddress
}

if (StrKey.isEd25519SecretKey(input)) {
  // TypeScript knows input is Ed25519SecretKey
  const signer = LocalSigner.fromSecret(input);
}

Example Usage

import { StrKey } from "@colibri/core";

function processAddress(address: string) {
  if (StrKey.isEd25519PublicKey(address)) {
    return loadAccount(address);
  }
  if (StrKey.isContractId(address)) {
    return invokeContract(address);
  }
  throw new Error(`Invalid address: ${address}`);
}

Next Steps

• Account — Load accounts using validated public keys

• Contract — Work with validated contract IDs

• Signer — Create signers from secret keys