Skip to content

docs: update TIP-1017 spec doc and simplify #2873

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

Open
howydev wants to merge 5 commits into
base: howy/val-config-v2-events
Choose a base branch
from
+265 −669
Open

docs: update TIP-1017 spec doc and simplify #2873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5a23b9e
docs: simplify TIP-1017 abstract, motivation, and notation
howydev Feb 26, 2026
bc47d96
docs: fix TIP-1017 interface errors, grammar, and migration section
howydev Feb 26, 2026
ba377a0
docs: restructure TIP-1017 security section with tests and invariants
howydev Feb 26, 2026
b31348c
wip update spec
howydev Mar 3, 2026
8bb9500
feat: improve flow
howydev Mar 3, 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
6 changes: 3 additions & 3 deletions crates/contracts/src/precompiles/validator_config_v2.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ crate::sol! {
error PublicKeyAlreadyExists();
error Unauthorized();
error AddressAlreadyHasValidator();
error ValidatorAlreadyDeleted();
error ValidatorAlreadyDeactivated();
error ValidatorNotFound();
}
}
Expand All @@ -178,8 +178,8 @@ impl ValidatorConfigV2Error {
Self::ValidatorNotFound(IValidatorConfigV2::ValidatorNotFound {})
}

pub const fn validator_already_deleted() -> Self {
Self::ValidatorAlreadyDeleted(IValidatorConfigV2::ValidatorAlreadyDeleted {})
pub const fn validator_already_deactivated() -> Self {
Self::ValidatorAlreadyDeactivated(IValidatorConfigV2::ValidatorAlreadyDeactivated {})
}

pub const fn invalid_public_key() -> Self {
Expand Down
8 changes: 4 additions & 4 deletions crates/precompiles/src/validator_config_v2/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ impl ValidatorConfigV2 {
}
let v = self.validators[idx as usize].read()?;
if v.deactivated_at_height != 0 {
Err(ValidatorConfigV2Error::validator_already_deleted())?
Err(ValidatorConfigV2Error::validator_already_deactivated())?
}
Ok(v)
}
Expand Down Expand Up @@ -462,7 +462,7 @@ impl ValidatorConfigV2 {
}
let v = self.validators[call.idx as usize].read()?;
if v.deactivated_at_height != 0 {
Err(ValidatorConfigV2Error::validator_already_deleted())?
Err(ValidatorConfigV2Error::validator_already_deactivated())?
}
let config = self.config.read()?;
if sender != v.validator_address && !config.is_owner(sender) {
Expand Down Expand Up @@ -1083,7 +1083,7 @@ mod tests {
);
assert_eq!(
result,
Err(ValidatorConfigV2Error::validator_already_deleted().into())
Err(ValidatorConfigV2Error::validator_already_deactivated().into())
);

Ok(())
Expand Down Expand Up @@ -1398,7 +1398,7 @@ mod tests {
);
assert_eq!(
result,
Err(ValidatorConfigV2Error::validator_already_deleted().into())
Err(ValidatorConfigV2Error::validator_already_deactivated().into())
);

Ok(())
Expand Down
8 changes: 4 additions & 4 deletions tips/ref-impls/src/ValidatorConfigV2.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ contract ValidatorConfigV2 is IValidatorConfigV2 {

ValidatorStorage storage v = validatorsArray[idx];
if (v.deactivatedAtHeight != 0) {
revert ValidatorAlreadyDeleted();
revert ValidatorAlreadyDeactivated();
}

_checkOnlyOwnerOrValidator(v.validatorAddress);
Expand Down Expand Up @@ -169,7 +169,7 @@ contract ValidatorConfigV2 is IValidatorConfigV2 {

ValidatorStorage storage oldValidator = validatorsArray[idx];
if (oldValidator.deactivatedAtHeight != 0) {
revert ValidatorAlreadyDeleted();
revert ValidatorAlreadyDeactivated();
}

address validatorAddress = oldValidator.validatorAddress;
Expand Down Expand Up @@ -227,7 +227,7 @@ contract ValidatorConfigV2 is IValidatorConfigV2 {

ValidatorStorage storage v = validatorsArray[idx];
if (v.deactivatedAtHeight != 0) {
revert ValidatorAlreadyDeleted();
revert ValidatorAlreadyDeactivated();
}

_checkOnlyOwnerOrValidator(v.validatorAddress);
Expand Down Expand Up @@ -260,7 +260,7 @@ contract ValidatorConfigV2 is IValidatorConfigV2 {

ValidatorStorage storage v = validatorsArray[idx];
if (v.deactivatedAtHeight != 0) {
revert ValidatorAlreadyDeleted();
revert ValidatorAlreadyDeactivated();
}

address currentAddress = v.validatorAddress;
Expand Down
2 changes: 1 addition & 1 deletion tips/ref-impls/src/interfaces/IValidatorConfigV2.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ interface IValidatorConfigV2 {
error ValidatorNotFound();

/// @notice Thrown when trying to deactivate an already-deactivated validator
error ValidatorAlreadyDeleted();
error ValidatorAlreadyDeactivated();

/// @notice Thrown when public key is invalid (zero)
error InvalidPublicKey();
Expand Down
16 changes: 8 additions & 8 deletions tips/ref-impls/test/ValidatorConfigV2.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,13 +298,13 @@ contract ValidatorConfigV2Test is BaseTest {
assertEq(err, abi.encodeWithSelector(IValidatorConfigV2.ValidatorNotFound.selector));
}

// 3. ValidatorAlreadyDeleted (already deactivated)
// 3. ValidatorAlreadyDeactivated (already deactivated)
validatorConfigV2.deactivateValidator(2);
try validatorConfigV2.deactivateValidator(2) {
revert CallShouldHaveReverted();
} catch (bytes memory err) {
assertEq(
err, abi.encodeWithSelector(IValidatorConfigV2.ValidatorAlreadyDeleted.selector)
err, abi.encodeWithSelector(IValidatorConfigV2.ValidatorAlreadyDeactivated.selector)
);
}
}
Expand Down Expand Up @@ -422,15 +422,15 @@ contract ValidatorConfigV2Test is BaseTest {
);
}

// 5. ValidatorAlreadyDeleted (after deactivation)
// 5. ValidatorAlreadyDeactivated (after deactivation)
validatorConfigV2.deactivateValidator(2);
try validatorConfigV2.rotateValidator(
2, PUB_KEY_3, ingress2, egress2, _signRotate(PRIV_KEY_3, validator1, ingress2, egress2)
) {
revert CallShouldHaveReverted();
} catch (bytes memory err) {
assertEq(
err, abi.encodeWithSelector(IValidatorConfigV2.ValidatorAlreadyDeleted.selector)
err, abi.encodeWithSelector(IValidatorConfigV2.ValidatorAlreadyDeactivated.selector)
);
}

Expand Down Expand Up @@ -509,13 +509,13 @@ contract ValidatorConfigV2Test is BaseTest {
assertEq(err, abi.encodeWithSelector(IValidatorConfigV2.Unauthorized.selector));
}

// 3. ValidatorAlreadyDeleted (after deactivation)
// 3. ValidatorAlreadyDeactivated (after deactivation)
validatorConfigV2.deactivateValidator(2);
try validatorConfigV2.setIpAddresses(2, ingress2, egress2) {
revert CallShouldHaveReverted();
} catch (bytes memory err) {
assertEq(
err, abi.encodeWithSelector(IValidatorConfigV2.ValidatorAlreadyDeleted.selector)
err, abi.encodeWithSelector(IValidatorConfigV2.ValidatorAlreadyDeactivated.selector)
);
}
}
Expand Down Expand Up @@ -616,13 +616,13 @@ contract ValidatorConfigV2Test is BaseTest {
);
}

// 5. ValidatorAlreadyDeleted (after deactivation)
// 5. ValidatorAlreadyDeactivated (after deactivation)
validatorConfigV2.deactivateValidator(2);
try validatorConfigV2.transferValidatorOwnership(2, validator3) {
revert CallShouldHaveReverted();
} catch (bytes memory err) {
assertEq(
err, abi.encodeWithSelector(IValidatorConfigV2.ValidatorAlreadyDeleted.selector)
err, abi.encodeWithSelector(IValidatorConfigV2.ValidatorAlreadyDeactivated.selector)
);
}
}
Expand Down
2 changes: 1 addition & 1 deletion tips/ref-impls/test/invariants/ValidatorConfigV2.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ contract ValidatorConfigV2InvariantTest is InvariantBaseTest {
|| selector == IValidatorConfigV2.NotIp.selector
|| selector == IValidatorConfigV2.InvalidSignature.selector
|| selector == IValidatorConfigV2.IngressAlreadyExists.selector
|| selector == IValidatorConfigV2.ValidatorAlreadyDeleted.selector;
|| selector == IValidatorConfigV2.ValidatorAlreadyDeactivated.selector;
assertTrue(isKnown, string.concat("Unknown error: ", vm.toString(selector)));
}

Expand Down
Loading
Loading