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.

Stellar Address Kit uses a two-layered messaging system to help you integrate safely without being overly restrictive.

​
Error vs Warning

  • Error (destinationError): The destination is unusable (e.g., malformed checksum or C-address). No routing can be performed.
  • Warning (warnings): The destination is technically valid, but there are issues the developer should know about (e.g., precision loss or redundant memos).

​
Severity Levels

LevelMeaningAction
INFOInformational change (e.g., input was lowercase).Safe to ignore in production.
WARNPotential issue (e.g., Numeric MEMO_TEXT).Log to your monitoring system.
ERRORCritical issue (e.g., M-address ID overflow).Reject the transaction.

​
The Warning Type (TypeScript)

Warnings are returned as a discriminated union, allowing for type-safe handling of specialized metadata. 
type Warning = 
  | { code: 'JS_PRECISION_LOSS'; severity: 'ERROR'; message: string }
  | { code: 'REDUNDANT_MEMO'; severity: 'INFO'; message: string }
  | { code: 'MEMO_TYPE_MISMATCH'; severity: 'WARN'; message: string }
  // ... and others

​
The destinationError Invariant

The Invariant: If destinationError is present, all other fields (address, routingId, warnings) will be null, none, or empty.