Type-safety gap: StreamBuilder.build()'s return type claims ratePerSecond is always a string, but a number input stays a number at runtime

[Jaydbrown]

StreamBuilder.ratePerSecond(val: number | bigint) (src/builder.ts) accepts either a number or a bigint. build() runs the config through bigintSafeStringify(), which only converts values whose typeof is 'bigint' to strings — a plain number value passes through unchanged. But build()'s return is force-cast with as { ...; ratePerSecond?: string }, so calling .ratePerSecond(500).build() (a valid call per the method's own signature) produces an object whose ratePerSecond is the runtime number 500, while the TypeScript type asserts it's a string. Any caller trusting the declared type (e.g. doing .trim() or string concatenation on it) hits a runtime error TypeScript can't catch.

[XxHugheadxX]

Reviewed StreamBuilder.build() before applying — the type gap is real and traces to how bigintSafeStringify works. ratePerSecond(val) accepts number | bigint, and build()'s return type annotates ratePerSecond as always string. But bigintSafeStringify (utils.ts) only special-cases the bigint branch — for a plain number it returns the value unchanged, so a number input for ratePerSecond passes through build() as a number at runtime while the type signature promises a string. Any caller doing typeof config.ratePerSecond === 'string' or template-interpolating it assuming stringified precision would silently misbehave for number inputs specifically. Fix: coerce numeric ratePerSecond to a string explicitly in build() so the type is honest, keeping the existing public API rather than narrowing the setter. Tests: a build() call with a number ratePerSecond asserting typeof result.ratePerSecond === 'string', one with bigint input for existing behavior, plus keeping the existing builder suite green.

[bobo-24]

Hi! I came across this issue and would love to work on it. I have experience with similar tasks and I'm confident I can investigate, implement a clean solution, and thoroughly test it before submitting a PR. If the issue is still open, I would appreciate it if you could assign it to me. I’ll prioritize this immediately and ensure a reliable solution is delivered as soon as possible. Thank you!

[CITYZEN-AL-MUSTAPHA]

@CITYZEN-AL-MUSTAPHA has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

I'd like to be assigned to this issue. I'll deliver a clean, maintainable solution that matches the requirements.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @CITYZEN-AL-MUSTAPHA to this issue.

[Juliet283]

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

Hi Maintainer, I’ve got my eyes on this issue and would love to turn that interest into a meaningful contribution. I’m ready to take responsibility for the work and see it through. Please consider me for the assignment.

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

[Lspnjr1]

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

Hi @maintainers
I’m Lspnjr1
Interested in working on this issue. I understand the type mismatch and can fix the ratePerSecond serialization so both number and bigint inputs produce the declared string output at runtime, while preserving existing builder behavior and adding regression tests for both cases.

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

[BigJohn-dev]

@BigJohn-dev has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

Allow me fix this ASAP

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

[Akanjioladayo5]

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

I'm interested in taking on this issue and contributing to the Stellar ecosystem. I've reviewed the requirements and understand the expected outcome. I can investigate the existing implementation, identify the best approach, and deliver a clean, focused solution that follows the project's standards.

I'll make sure the implementation is properly tested, maintainable, and doesn't introduce unnecessary changes. I'm ready to start working on this and would appreciate being assigned the issue if it's available.

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

[benzy018]

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

Hello Maintainer, I'd like to work on this issue. I'll fix the StreamBuilder.build() type mismatch so ratePerSecond accurately reflects its runtime value, add regression tests for string and number inputs, and submit a clean PR within 2 days. Thank you!

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

[Teescom]

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

i will like to work on this

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

[drips-wave]

Congratulations, @Teescom! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on August 31, 2026.

🧑‍💻 @Teescom: 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 🌊