Skip to content

Commit

Permalink
docs: update validator reg inline docs (#486)
Browse files Browse the repository at this point in the history
  • Loading branch information
shaspitz authored Nov 15, 2024
1 parent 0a2f8ff commit 9ce1c5d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
15 changes: 10 additions & 5 deletions contracts/contracts/validator-registry/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# Validator Registry Design doc

Validators are able to _opt-in to mev-commit_ in one of two ways:
Validators are able to _opt-in to mev-commit_ in one of three ways:

1. Restaking with the `MevCommitAVS` contract.
2. Simple staking with the `VanillaRegistry` contract.
2. Restaking with the `MevCommitMiddleware` contract.
3. Simple staking with the `VanillaRegistry` contract.

The `ValidatorOptInRouter` contract acts as a query router between both solutions, allowing any actor to query whether a group of validator pubkeys is opted-in to mev-commit.
The `ValidatorOptInRouter` contract acts as a query router between all three solutions, allowing any actor to query whether a group of validator pubkeys is opted-in to mev-commit.

## Mev-commit AVS - Restaking Solution
## Mev-commit AVS - Eigenlayer Restaking Solution

For more details on the Mev-commit AVS, please refer to the [Mev-commit AVS README](avs/README.md).
For more details on the `MevCommitAVS` contract, please refer to the [MevCommitAVS README](avs/README.md).

## Mev-commit Middleware - Symbiotic Restaking Solution

For more details on the `MevCommitMiddleware` contract, please refer to the [MevCommitMiddleware README](middleware/README.md).

## Vanilla Registry - Simple Staking Solution

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,10 @@ contract DeployHolesky is BaseDeploy {
);

INetworkMiddlewareService networkMiddlewareService = INetworkMiddlewareService(address(SymbioticHoleskyDevnetConsts.NETWORK_MIDDLEWARE_SERVICE));
if (networkMiddlewareService.middleware(msg.sender) == address(0)) {
networkMiddlewareService.setMiddleware(mevCommitMiddlewareProxy);
if (networkMiddlewareService.middleware(msg.sender) != address(0)) {
console.log("WARNING: overwriting existing middleware registration for network:", msg.sender);
}
networkMiddlewareService.setMiddleware(mevCommitMiddlewareProxy);

IBaseDelegator vault1Delegator = IBaseDelegator(address(SymbioticHoleskyDevnetConsts.VAULT_1_DELEGATOR));
vault1Delegator.setMaxNetworkLimit(SUBNETWORK_ID, VAULT1_MAX_NETWORK_LIMIT);
Expand Down

0 comments on commit 9ce1c5d

Please sign in to comment.