ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-09-27 23:38:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Trim PreflightHelpers pointer to just the reference

Browse Source
This commit is contained in:
Mayukha Vadari
2026-09-11 12:27:19 -04:00
parent 1745983b63
commit 4203d2f522
1 changed files with 1 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/libxrpl/tx/AGENTS.md
View File

@@ -6,14 +6,4 @@ Any change to transaction-processing behavior must be gated behind an amendment.
## Preflight helpers
Prefer the helpers in [`include/xrpl/tx/helpers/PreflightHelpers.h`](../../../include/xrpl/tx/helpers/PreflightHelpers.h) over ad-hoc checks in transactor preflight code:
- `checkBounds(value, min, max)` — inclusive range check.
- `checkSize(container, max)` — container size is at most `max`.
- `checkSizeAndNonEmpty(container, max)` — container is non-empty and size is at most `max`.
- `isZeroId(id)` — hash-like ID (e.g. a `uint256` object ID) is unset (compares against `beast::kZero`).
- `isPositiveXRPAmount(amount)` — amount is XRP and strictly positive.
- `isPositiveAmount(amount)` — amount of any asset is strictly positive.
- `isBadCurrency(currency)` — currency equals the reserved `badCurrency()` sentinel.
Use them to keep preflight logic uniform and to make the intent of each check explicit. If the same pattern appears in more than one transactor, add a new helper here rather than inlining the check.
When writing transactor preflight logic, prefer the helpers in [`include/xrpl/tx/helpers/PreflightHelpers.h`](../../../include/xrpl/tx/helpers/PreflightHelpers.h) over ad-hoc checks. If the same check pattern shows up in more than one transactor, add a new helper there rather than inlining it.