Include Policy in Tx table of contents, include info on max_fee req…

…uirements
FuelLabs · Mar 4, 2024 · 9e5ef30 · 9e5ef30
1 parent 85f98ab
commit 9e5ef30
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/src/tx-format/index.md b/src/tx-format/index.md
@@ -18,4 +18,5 @@ The Fuel Transaction Format.
   - [`OutputVariable`](./output.md#outputvariable)
   - [`OutputContractCreated`](./output.md#outputcontractcreated)
 - [`Witness`](./witness.md)
+- [`Policy`](./policy.md)
 - [`TXPointer`](./tx-pointer.md)
diff --git a/src/tx-format/policy.md b/src/tx-format/policy.md
@@ -44,11 +44,12 @@ Transaction is invalid if:
 
 ## `MaxFee`
 
-| name      | type     | description                                                     |
-|-----------|----------|-----------------------------------------------------------------|
-| `max_fee` | `uint64` | The maximum fee payable by this transaction using `BASE_ASSET`. |
+| name      | type     | description                                                                                                                                |
+|-----------|----------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| `max_fee` | `uint64` | The maximum fee payable by this transaction using `BASE_ASSET`. This is used to check transactions before the actual `gas_price` is known. |
 
 Transaction is invalid if:
 
+- `max_fee` is not set
 - `max_fee > sum_inputs(tx, BASE_ASSET_ID) - sum_outputs(tx, BASE_ASSET_ID)`
 - `max_fee < reserved_fee_balance(tx, BASE_ASSET_ID)`