feat(feeEstimator): add estimateFeeForAmount helper with bigint precision (Fixes #615) - #803
Draft
s6pa1rta3n-lab wants to merge 1 commit into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #615
Summary of Changes
estimateFeeForAmount(amount: bigint, feeStats: FeeStats): { feeLumens: bigint; feePercent: number; totalWithFee: bigint }exported fromsrc/feeEstimator.ts.feeLumensfromfeeStats.baseFeewhile retainingbigintprecision throughout, computingtotalWithFee = amount + feeLumens.feePercentasNumber(feeLumens) / Number(amount) * 100and safely returned0whenamount === 0n.SdkErrorwith codeINVALID_RECIPIENT(SdkErrorCode.INVALID_RECIPIENT) ifamountis negative.FeeStatsinterface ({ baseFee: bigint; p50Fee: bigint; p99Fee: bigint }) insrc/types.ts.estimateFeeForAmount,estimateFee,estimateOperationCost,FeeStats, and fee estimator types fromsrc/index.ts.test/feeEstimator.test.tscovering known amounts, zero amount calculation, bigint preservation, and negative amount validation.Acceptance Criteria Checklist
estimateFeeForAmount(amount: bigint, feeStats: FeeStats): { feeLumens: bigint; feePercent: number; totalWithFee: bigint }exported fromsrc/feeEstimator.tsfeeLumensis derived fromfeeStats.baseFee;totalWithFee = amount + feeLumensfeePercentisNumber(feeLumens) / Number(amount) * 100— returns0whenamount === 0nSdkErrorwith codeINVALID_RECIPIENTifamountis negativeFeeStatstype:{ baseFee: bigint; p50Fee: bigint; p99Fee: bigint }— added tosrc/types.tssrc/index.tsPayout Routing
0xF46C9F6d70C50BF81ef3588AB523a90a594a2F89GCL6OXAMLD75BMTINA6EMRUDWK5THQUSHMYNLSNBCJAPZJHNYJTUNIBC