Skip to content

Commit bc63bb3

Browse files
Audit fix A13-2/p3: Document Deploy.sol constants
Add NatSpec to DEPLOYMENT_SUITE_TABLES and DEPLOYMENT_SUITE_CONTRACT explaining expected env var values and default behavior. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 1a4e05d commit bc63bb3

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

audit/2026-03-10-01/triage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ duplicates in the title.
5454
| A11-4 | 2 | LOW | Log table tests have zero assertions -- they only call and log | PENDING |
5555
| A11-5 | 2 | LOW | No test verifies table data integrity against known log10 reference values | PENDING |
5656
| A11-6 | 2 | LOW | No test for `toBytes` encoding correctness (round-trip or spot-check) | PENDING |
57-
| A13-2/p3 | 3 | LOW | `Deploy.sol` constants are undocumented and inconsistently named | PENDING |
57+
| A13-2/p3 | 3 | LOW | `Deploy.sol` constants are undocumented and inconsistently named | FIXED |

script/Deploy.sol

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,14 @@ import {LibDecimalFloatDeploy} from "../src/lib/deploy/LibDecimalFloatDeploy.sol
88
import {LibRainDeploy} from "rain.deploy/lib/LibRainDeploy.sol";
99
import {DecimalFloat} from "../src/concrete/DecimalFloat.sol";
1010

11+
/// @dev Hash of the "log-tables" deployment suite string. When the
12+
/// `DEPLOYMENT_SUITE` env var is set to "log-tables", the script deploys the
13+
/// log/antilog lookup tables as a data contract.
1114
bytes32 constant DEPLOYMENT_SUITE_TABLES = keccak256("log-tables");
15+
16+
/// @dev Hash of the "decimal-float" deployment suite string. When the
17+
/// `DEPLOYMENT_SUITE` env var is set to "decimal-float" (or omitted, as it is
18+
/// the default), the script deploys the DecimalFloat contract.
1219
bytes32 constant DEPLOYMENT_SUITE_CONTRACT = keccak256("decimal-float");
1320

1421
contract Deploy is Script {

0 commit comments

Comments
 (0)