[DOCUMENTATION] Add inline JSDoc comments to all lib/ utility functions

[dev-fatima-24]

Priority: medium

Description

The frontend lib/ directory (stellar.ts, soroban.ts, freighter.ts, carbon-utils.ts) contains complex utility functions with no documentation. Every exported function must have a JSDoc comment explaining its purpose, parameters, return value, and any side effects. This is required for IDE autocomplete and onboarding.

Acceptance Criteria

• Every exported function in lib/ has a JSDoc comment
• JSDoc includes: @description, @param (with types), @returns, and @throws where applicable
• Complex functions include a @example block
• Comments are accurate and match the actual function behavior
• TypeScript types are not duplicated in JSDoc where they are already in the signature

[dotmantissa]

@dotmantissa has applied to work on this issue as part of the Stellar Wave Program's 5th wave.

Please, assign this issue to me.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @dotmantissa to this issue.

[JohnOluB]

@JohnOluB has applied to work on this issue as part of the Stellar Wave Program's 5th wave.

I’ll start by going through every exported function inside lib/ and adding clean JSDoc comments that clearly explain what each function does, its inputs, outputs, and any errors it can throw. I’ll also add simple usage examples for the more complex ones so contributors can understand them quickly without digging into implementation details.

I’ve worked with TypeScript utility layers before and will make sure CarbonLedger’s core helpers are properly documented, consistent, and easy to use from any IDE.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @JohnOluB to this issue.

[raphael-01-visual]

@raphael-01-visual has applied to work on this issue as part of the Stellar Wave Program's 5th wave.

Can I work on this issue ? ETA - 12hrs

ℹ️ Repo Maintainers: To accept this application, review their application or assign @raphael-01-visual to this issue.

[drips-wave]

Congratulations, @raphael-01-visual! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on June 2, 2026.

🧑‍💻 @raphael-01-visual: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊