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.

extractRouting is the core function of the library. It reconciles an address and memo into a canonical routing result.

Function Signatures

function extractRouting(input: RoutingInput): RoutingResult

Input: RoutingInput

FieldTypeDescription
addressstringThe destination address (G, M, or C).
memoTypestring(Optional) ID, TEXT, HASH, or RETURN.
memoValuestring(Optional) The raw memo value.

Output: RoutingResult

FieldTypeDescription
addressstringThe canonical base G-address.
routingIdstringThe extracted 64-bit ID (or empty string).
warningsWarning[]List of warnings encountered.
destinationErrorstringError code if the destination is invalid.