docs(builder): clarify Felt division across builder docs#284
Open
alimmaster wants to merge 3 commits into0xMiden:mainfrom
Open
docs(builder): clarify Felt division across builder docs#284alimmaster wants to merge 3 commits into0xMiden:mainfrom
alimmaster wants to merge 3 commits into0xMiden:mainfrom
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
1 participant
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.
Current behavior
The builder docs mention that Felt division uses the multiplicative inverse, but the explanation is fragmented and easy to miss.
As a result, developers can misread Felt division as standard integer division, especially in business-logic scenarios like token amounts, fee calculations, and proportional splits.
New behavior
This change improves Felt division guidance in three places:
Divisionsubsection totypes.mdwith side-by-sideu64vsFeltexamplesWhen to use Felt vs u64section topatterns.mdpitfalls.mdBreaking changes
None.
Other info
Documentation-only update.
Closes #232.