Skip to content

Commit

Permalink
Updating Cluster Configuration Files (#530)
Browse files Browse the repository at this point in the history
* updating config files

* implmenting Hanan's suggestions

* fixing v1.8.0

* fixed a comment

---------

Co-authored-by: “Max <“max@obol.tech”>
  • Loading branch information
slugmann321 and “Max authored Feb 4, 2025
1 parent 7531424 commit dfbbeb5
Showing 1 changed file with 59 additions and 19 deletions.
78 changes: 59 additions & 19 deletions docs/learn/charon/cluster-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,37 +31,54 @@ The schema of the `cluster-definition.json` is defined as:
```json
{
"name": "best cluster", // Optional cosmetic identifier
"uuid": "1234-abcdef-1234-abcdef", // Random unique identifier.
"creator": {
"address": "0x123..abfc", //ETH1 address of the creator
"config_signature": "0x123654...abcedf" // EIP712 Signature of config_hash using creator privkey
},
"operators": [
"version": "v1.8.0", // Schema version
"num_validators": 1, // Number of distributed validators to be created in cluster-lock.json
"threshold": 3, // Optional threshold required for signature reconstruction
"dkg_algorithm": "default", // Optional DKG algorithm for key generation
"fork_version": "0x01017000", // Chain/Network identifier
"config_hash": "0xabcfde...acbfed", // Hash of the static (non-changing) fields
"timestamp": "2025-01-01T12:00:00+00:00", // Creation timestamp
"operators": [
{
"address": "0x123..abfc", // ETH1 address of the operator
"enr": "enr://abcdef...12345", // Charon node ENR
"config_signature": "0x123456...abcdef", // EIP712 Signature of config_hash by ETH1 address priv key
"enr_signature": "0x123654...abcedf" // EIP712 Signature of ENR by ETH1 address priv key
"enr_signature": "0x123654...abcedf", // EIP712 Signature of ENR by ETH1 address priv key
"config_signature": "0x123456...abcdef" // EIP712 Signature of config_hash by ETH1 address priv key
},
{
"address": "0x123..abfc",
"enr": "enr://abcdef...12345",
"enr_signature": "0x123654...abcedf",
"config_signature": "0x123456...abcdef"
},
{
"address": "0x123..abfc",
"enr": "enr://abcdef...12345",
"enr_signature": "0x123654...abcedf",
"config_signature": "0x123456...abcdef"
},
{
"address": "0x123..abfc",
"enr": "enr://abcdef...12345",
"enr_signature": "0x123654...abcedf",
"config_signature": "0x123456...abcdef"
}
],
"uuid": "1234-abcdef-1234-abcdef", // Random unique identifier.
"version": "v1.2.0", // Schema version
"timestamp": "2022-01-01T12:00:00+00:00", // Creation timestamp
"num_validators": 2, // Number of distributed validators to be created in cluster-lock.json
"threshold": 3, // Optional threshold required for signature reconstruction
"definition_hash": "0xabcdef...abcedef", // Final hash of all fields
"validators": [
{
"fee_recipient_address": "0x123..abfc", // ETH1 fee_recipient address of validator
"withdrawal_address": "0x123..abfc" // ETH1 withdrawal address of validator
},
{
"fee_recipient_address": "0x123..abfc", // ETH1 fee_recipient address of validator
"withdrawal_address": "0x123..abfc" // ETH1 withdrawal address of validator
}
],
"dkg_algorithm": "foo_dkg_v1", // Optional DKG algorithm for key generation
"fork_version": "0x00112233", // Chain/Network identifier
"config_hash": "0xabcfde...acbfed", // Hash of the static (non-changing) fields
"definition_hash": "0xabcdef...abcedef" // Final hash of all fields
"deposit_amounts": [
"32000000000"
]
}
```

Expand All @@ -88,11 +105,34 @@ The `cluster-lock.json` has the following schema:
{
"distributed_public_key": "0x123..abfc", // DV root pubkey
"public_shares": [ "abc...fed", "cfd...bfe"], // Length equal to cluster_definition.operators
"fee_recipient": "0x123..abfc" // Defaults to withdrawal address if not set, can be edited manually
"partial_deposit_data": [
{
"pubkey": "0x123..abfc",
"withdrawal_credentials": "0x123..abfc",
"amount": "32000000000",
"signature": "0x123456...abcdef",
"deposit_data_root": "0x123456...abcdef"
}
],
"builder_registration": {
"message": {
"fee_recipient": "0x123456...abcdef",
"gas_limit": 30000000,
"timestamp": 1696000704,
"pubkey": "0x123456...abcdef"
},
"signature": "0x123456...abcdef"
}
}
],
"lock_hash": "abcdef...abcedef", // Config_hash plus distributed_validators
"signature_aggregate": "abcdef...abcedef" // BLS aggregate signature of the lock hash signed by each DV pubkey.
"signature_aggregate": "abcdef...abcedef", // BLS aggregate signature of the lock hash signed by each DV pubkey.
"lock_hash": "abcdef...abcedef", // definition_hash plus distributed_validators
"node_signatures": [
"0x123456...abcdef",
"0x123456...abcdef",
"0x123456...abcdef",
"0x123456...abcdef"
]
}
```

Expand Down

0 comments on commit dfbbeb5

Please sign in to comment.