Skip to main content

Documentation Index

Fetch the complete documentation index at: https://stellaraddresskit.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

To be considered a compliant implementation of the Stellar Address Kit, a package must pass these 8 critical “canary” vectors.
CaseWhy it matters
2^53 + 1 CanaryVerifies that the implementation does not lose precision on large IDs.
uint64 MaxEnsures 18,446,744,073,709,551,615 is handled as a string.
uint64 OverflowConfirms that IDs larger than 64-bit trigger an error.
Lowercase InputVerifies that addresses are normalized to uppercase in the output.
NOTANADDRESSEnsures malformed strings return INVALID_CHECKSUM.
Tampered ChecksumConfirms that modifying one character in an address triggers an error.
C-Address DestinationEnsures contracts are flagged as INVALID_DESTINATION for routing.
Invariant CheckVerifies that if an error is present, all other result fields are empty.