Skip to content

Match each frozen record file to a released suite of its own #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thedavidmeister merged 2 commits into from
Sep 20, 2026
Merged

Match each frozen record file to a released suite of its own #241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2b541e
Match each frozen record file to a released suite of its own
Sep 20, 2026
2b80301
Cut the design argument from the one-for-one frozen record check
Sep 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 36 additions & 14 deletions src/abstract/RainDeployVerifySnapshotBase.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,14 @@ error StoredRuntimeCodeHashMismatch(string suite, bytes32 storedBytecodeHash, by
/// @param path The frozen record file no released suite declares.
error FrozenSnapshotNotReleased(string path);

/// Thrown when the frozen record holds more files recording one deploy address
/// than the declaration holds released suites deriving it.
/// @param path The record file the record ran out of declarations at.
/// @param deployedAddress The address that file declares.
/// @param records The record files declaring it, up to and including `path`.
/// @param released The released suites whose creation code derives it.
error FrozenSnapshotsOutnumberReleases(string path, address deployedAddress, uint256 records, uint256 released);

/// Thrown when a file in the frozen record declares no deployed address. The
/// record holds generated snapshots and nothing else, and `DEPLOYED_ADDRESS` is
/// what makes one the record of a deployment rather than a file that happens to
Expand Down Expand Up @@ -96,12 +104,12 @@ error EtherscanEntryUnresolvable(string entry);
///
/// **Anchored to the record.** Every file in the frozen record — the
/// append-only `src/generated/<tag>/` directories — is declared by a released
/// suite. This is the one check that is about the DECLARATION rather than about
/// what a declared suite records, and it exists because everything anchored to
/// a chain reads `releasedSuites()`, which is a separate file from the record
/// it describes. A release missing from it is not caught anywhere else, by
/// anything: it simply stops being checked, and every check there is stays
/// green.
/// suite OF ITS OWN, one for one. This is the one check that is about the
/// DECLARATION rather than about what a declared suite records, and it exists
/// because everything anchored to a chain reads `releasedSuites()`, which is a
/// separate file from the record it describes. A release missing from it is not
/// caught anywhere else, by anything: it simply stops being checked, and every
/// check there is stays green.
///
/// None of the three can catch a suite that was never deployed, or that is no
/// longer deployed. Only `RainDeployVerifyChain` can, and nothing here is a
Expand Down Expand Up @@ -246,7 +254,7 @@ abstract contract RainDeployVerifySnapshotBase is RainDeployVerifyBase {
}

/// Checks the frozen record against the released declaration: every file in
/// the record is declared by a released suite.
/// the record is declared by a released suite OF ITS OWN.
///
/// `releasedSuites()` is a generated file, and everything anchored to a
/// chain reads it. A frozen tag it does not name is therefore not a missing
Expand All @@ -271,30 +279,44 @@ abstract contract RainDeployVerifySnapshotBase is RainDeployVerifyBase {
/// The match is by address: the address a file DECLARES against the address
/// a suite's creation code DERIVES. The derived side is a pure function of
/// the creation code, so a suite whose creation code derives the address a
/// file records IS that file's release.
/// file records IS a release of those bytes.
///
/// Nothing is matched by name, which would assert only that a convention
/// was followed. Nothing is matched by searching the file's text either: a
/// record is mostly two hex payloads thousands of digits long, and an
/// address that merely OCCURS somewhere in one of them says nothing about
/// what the file records.
///
/// A RENAMED entry is not caught: the counts are unchanged.
/// @param paths The frozen record's files.
/// @param released The declared released suites.
function checkFrozenSnapshotsReleased(string[] memory paths, DeploySuite[] memory released) internal view {
address[] memory recorded = new address[](paths.length);

for (uint256 i = 0; i < paths.length; i++) {
address recorded = recordedDeployedAddress(paths[i], vm.readFile(paths[i]));
recorded[i] = recordedDeployedAddress(paths[i], vm.readFile(paths[i]));

bool declared = false;
uint256 declarations = 0;
for (uint256 j = 0; j < released.length; j++) {
if (recorded == LibRainDeploy.zoltuAddress(released[j].creationCode)) {
declared = true;
break;
if (recorded[i] == LibRainDeploy.zoltuAddress(released[j].creationCode)) {
declarations++;
}
}

if (!declared) {
if (declarations == 0) {
revert FrozenSnapshotNotReleased(paths[i]);
}

uint256 records = 1;
for (uint256 k = 0; k < i; k++) {
if (recorded[k] == recorded[i]) {
records++;
}
}

if (records > declarations) {
revert FrozenSnapshotsOutnumberReleases(paths[i], recorded[i], records, declarations);
}
}
}

Expand Down
87 changes: 87 additions & 0 deletions test/src/abstract/RainDeployVerifySnapshotBase.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
EtherscanEntryUnresolvable,
FrozenSnapshotAmbiguous,
FrozenSnapshotNotReleased,
FrozenSnapshotsOutnumberReleases,
FrozenSnapshotUnreadable,
RainDeployVerifySnapshotBase,
StoredAddressMismatch,
Expand All @@ -26,6 +27,18 @@ import {
DEPLOYED_ADDRESS as ADDRESS_REGISTRY_DEPLOYED_ADDRESS,
RUNTIME_CODE as ADDRESS_REGISTRY_RUNTIME_CODE
} from "../../../src/generated/candidate/AddressRegistry.sol";
import {
BYTECODE_HASH as ADDRESS_REGISTRY_0_1_10_BYTECODE_HASH,
CREATION_CODE as ADDRESS_REGISTRY_0_1_10_CREATION_CODE,
DEPLOYED_ADDRESS as ADDRESS_REGISTRY_0_1_10_DEPLOYED_ADDRESS,
RUNTIME_CODE as ADDRESS_REGISTRY_0_1_10_RUNTIME_CODE
} from "../../../src/generated/0_1_10/AddressRegistry.sol";
import {
BYTECODE_HASH as ADDRESS_REGISTRY_0_1_11_BYTECODE_HASH,
CREATION_CODE as ADDRESS_REGISTRY_0_1_11_CREATION_CODE,
DEPLOYED_ADDRESS as ADDRESS_REGISTRY_0_1_11_DEPLOYED_ADDRESS,
RUNTIME_CODE as ADDRESS_REGISTRY_0_1_11_RUNTIME_CODE
} from "../../../src/generated/0_1_11/AddressRegistry.sol";

/// @title RainDeployVerifySnapshotBaseTest
/// @notice `RainDeployVerifySnapshotBase` inherited by a exemplar repo, so the
Expand Down Expand Up @@ -152,6 +165,80 @@ contract RainDeployVerifySnapshotBaseTest is ExampleDeploySuites, RainDeployVeri
this.externalCheckFrozenSnapshotsReleased(recordOfTheGeneratedSnapshot(), wrongRelease);
}

function recordOfTheTwinReleases() internal pure returns (string[] memory paths) {
paths = new string[](2);
paths[0] = LibRainDeploySnapshot.pathForSnapshot("0_1_10", "AddressRegistry");
paths[1] = LibRainDeploySnapshot.pathForSnapshot("0_1_11", "AddressRegistry");
}

function declaredOlderTwin() internal pure returns (DeploySuite memory) {
return DeploySuite({
suite: "address-registry@0_1_10",
creationCode: ADDRESS_REGISTRY_0_1_10_CREATION_CODE,
storedDeployedAddress: ADDRESS_REGISTRY_0_1_10_DEPLOYED_ADDRESS,
storedBytecodeHash: ADDRESS_REGISTRY_0_1_10_BYTECODE_HASH,
storedRuntimeCode: ADDRESS_REGISTRY_0_1_10_RUNTIME_CODE,
artifactPath: "src/concrete/AddressRegistry.sol:AddressRegistry",
dependencies: new address[](0)
});
}

function declaredNewerTwin() internal pure returns (DeploySuite memory) {
return DeploySuite({
suite: "address-registry@0_1_11",
creationCode: ADDRESS_REGISTRY_0_1_11_CREATION_CODE,
storedDeployedAddress: ADDRESS_REGISTRY_0_1_11_DEPLOYED_ADDRESS,
storedBytecodeHash: ADDRESS_REGISTRY_0_1_11_BYTECODE_HASH,
storedRuntimeCode: ADDRESS_REGISTRY_0_1_11_RUNTIME_CODE,
artifactPath: "src/concrete/AddressRegistry.sol:AddressRegistry",
dependencies: new address[](0)
});
}

function testTwinReleasesFrozeTheSameCreationCode() external pure {
assertEq(keccak256(ADDRESS_REGISTRY_0_1_10_CREATION_CODE), keccak256(ADDRESS_REGISTRY_0_1_11_CREATION_CODE));
assertEq(ADDRESS_REGISTRY_0_1_10_DEPLOYED_ADDRESS, ADDRESS_REGISTRY_0_1_11_DEPLOYED_ADDRESS);
assertEq(
LibRainDeploy.zoltuAddress(ADDRESS_REGISTRY_0_1_10_CREATION_CODE),
LibRainDeploy.zoltuAddress(ADDRESS_REGISTRY_0_1_11_CREATION_CODE)
);
}

function testFrozenSnapshotTwinReleaseDroppedFromTheDeclarationReverts() external {
DeploySuite[] memory released = new DeploySuite[](1);
released[0] = declaredNewerTwin();

vm.expectRevert(
abi.encodeWithSelector(
FrozenSnapshotsOutnumberReleases.selector,
recordOfTheTwinReleases()[1],
ADDRESS_REGISTRY_0_1_11_DEPLOYED_ADDRESS,
uint256(2),
uint256(1)
)
);
this.externalCheckFrozenSnapshotsReleased(recordOfTheTwinReleases(), released);
}

function testFrozenSnapshotTwinReleasesBothDeclaredPasses() external view {
DeploySuite[] memory released = new DeploySuite[](2);
released[0] = declaredOlderTwin();
released[1] = declaredNewerTwin();

this.externalCheckFrozenSnapshotsReleased(recordOfTheTwinReleases(), released);
}

function testFrozenSnapshotMoreDeclarationsThanRecordFilesPasses() external view {
string[] memory paths = new string[](1);
paths[0] = recordOfTheTwinReleases()[1];

DeploySuite[] memory released = new DeploySuite[](2);
released[0] = declaredOlderTwin();
released[1] = declaredNewerTwin();

this.externalCheckFrozenSnapshotsReleased(paths, released);
}

/// A record in the generated shape that DECLARES one address and merely
/// mentions another — in a comment, and in a second address constant.
/// @param declared The address the record declares as its deploy address.
Expand Down
Loading