Skip to content

docs: add JSDoc to extractRouting (closes #186) #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codeZe-us merged 1 commit into from
Mar 29, 2026
Merged

docs: add JSDoc to extractRouting (closes #186) #195

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions packages/core-ts/src/routing/extract.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,17 @@ function assertRoutableAddress(destination: string): void {
}
}

/**
* Extracts routing information from a given destination address and memo.
*
* @param input - The routing input containing the destination address, memo type, and memo value.
* @returns The extracted routing result including destination base account, routing ID, routing source, and warnings.
*
* Decision Branches:
* - M-address: The destination is parsed as a muxed account. The routing ID from the M-address takes precedence over any provided memo.
* - G-address with MEMO_ID: The destination is a standard G-address. The routing ID is extracted from the MEMO_ID.
* - G-address with MEMO_TEXT: The destination is a standard G-address. The routing ID is extracted from the MEMO_TEXT if it represents a valid numeric uint64.
*/
export function extractRouting(input: RoutingInput): RoutingResult {
assertRoutableAddress(input.destination);

Expand Down
Loading