docs(fees): document the pricing model and its invariants - #430
Merged
Conversation
env.events().all() reflects only the most recent contract invocation, not a running total across separate calls (consistent with every other event test in this file). The test compared post-transfer event count against a pre-transfer count captured after a *different* call (set_service_metadata), expecting accumulation that never happens, so it failed on every run regardless of contract behavior. Fixed to assert directly on this call's own event count.
Jagadeeshftw
force-pushed
the
docs/fees-01-model
branch
from
July 28, 2026 21:18
423d7ed to
63e974a
Compare
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.
Summary
docs/escrow/pricing.mdcovered flat-rate and tiered billing but never documentedset_price_bounds/get_min_service_price/get_max_service_price, even thoughset_service_pricehas enforced them since they were added. Adds a new "Global price bounds" section plus API-reference and security-notes entries:PriceOutOfBounds/InvertedPriceBanderrors, and the zero-is-free-vs-floor interaction.set_price_tiersnever consultsMinServicePrice/MaxServicePrice— a tier price can bypass the global bounds thatset_service_priceenforces for the same value. Not fixed here; flagged as a known asymmetry for anyone relying on the bounds as a hard invariant.pricing.mdand (already-existing) doc conventions consistently —pricing.mditself wasn't linked from the README's documentation index; added that too.No contract code changes — docs only.
Closes #296
Validation
cargo fmt --all -- --checkcargo build -p escrowcargo test -p escrow— 352 passed, 1 pre-existing failure unrelated to this change (test_transfer_service_ownership_genuine_transfer_emits_event, fails identically onmain)