Skip to content

Commit 77cb72f

Browse files
committed
docs: better instructions
1 parent 0893e0b commit 77cb72f

File tree

2 files changed

+59
-62
lines changed

2 files changed

+59
-62
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"chainInfo": {
3+
"chainId": 17000
4+
},
5+
"permissions" : {
6+
"owner": "<owner_address>",
7+
"aggregator": "<aggregator_address>",
8+
"upgrader": "<upgrader_address>",
9+
"churner": "<churner_address>",
10+
"ejector": "<ejector_address>",
11+
"deployer": "<deployer_address>",
12+
"pauser": "<pauser_address>",
13+
"initalPausedStatus": 0
14+
},
15+
"minimumStakes": [
16+
1
17+
],
18+
"strategyWeights": [
19+
[
20+
{
21+
"0_strategy": "TBD",
22+
"1_multiplier": 1e+18
23+
}
24+
]
25+
],
26+
"operatorSetParams": [
27+
{
28+
"0_maxOperatorCount": 200,
29+
"1_kickBIPsOfOperatorStake": 11000,
30+
"2_kickBIPsOfTotalStake": 50
31+
}
32+
],
33+
"uri": ""
34+
}

docs/0_internal/2_deploy_contracts.md

Lines changed: 25 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ Also, you will be able to deploy the Batcher Payment Service contract.
2222
- Get an API KEY from Etherescan to verify the contracts. You can follow this [guide](https://docs.etherscan.io/getting-started/viewing-api-usage-statistics).
2323

2424
- You need a hot wallet with some ETH to deploy the contracts. The deployment cost is approximately 30M gas units.
25+
26+
You can create a hot wallet with cast using the following command:
27+
28+
```bash
29+
2530
2631
## AlignedServiceManager Contracts
2732
@@ -41,46 +46,32 @@ For **Sepolia** deployment, the `env` file is available [here](../../contracts/s
4146
4247
### Set DEPLOY_CONFIG_PATH file
4348
44-
You need to complete the `DEPLOY_CONFIG_PATH` file with the following information:
49+
You need to set the following address in the config file:
4550
46-
```json
47-
{
48-
"chainInfo": {
49-
"chainId": "<chain_id>"
50-
},
51-
"permissions": {
52-
"owner": "<owner_address>",
53-
"aggregator": "<aggregator_address>",
54-
"upgrader": "<upgrader_address>",
55-
"churner": "<churner_address>",
56-
"ejector": "<ejector_address>",
57-
"deployer": "<deployer_address>",
58-
"initalPausedStatus": 0
59-
},
60-
"minimumStakes": [],
61-
"strategyWeights": [],
62-
"operatorSetParams": [],
63-
"uri": ""
64-
}
65-
```
51+
- `owner`: Address that will be the owner of the contracts. This address can be a multisig or a normal wallet.
52+
- `aggregator`: Address that will be the aggregator of Aligned.
53+
- `upgrader`: Address that will be the upgrader of the contracts. This address can be a multisig or a normal wallet.
54+
- `churner`: Address that will be the churner of the contracts. This address can be a multisig or a normal wallet.
55+
- `ejector`: Address that will be the ejector of the contracts. This address can be a multisig or a normal wallet.
56+
- `deployer`: Address that will be the deployer of the contracts. This address can be a multisig or a normal wallet.
6657
67-
You can find an example config file in [aligned.holesky.config.json](../../contracts/script/deploy/config/holesky/aligned.holesky.config.json).
58+
For **Mainnet** deployment, complete the following [config file](../../contracts/script/deploy/config/mainnet/aligned.mainnet.config.json).
59+
60+
For **Holesky** deployment, complete the following [config file](../../contracts/script/deploy/config/holesky/aligned.holesky.config.json).
61+
62+
For **Sepolia** deployment, complete the following [config file](../../contracts/script/deploy/config/sepolia/aligned.sepolia.config.json).
6863
6964
> [!NOTE]
7065
>
66+
> Strategies are already filled in the config files. Also, you can find them in the following links
67+
>
7168
> You can find the list of Mainnet strategies for the `strategyWeights` field [here](https://github.com/Layr-Labs/eigenlayer-contracts?tab=readme-ov-file#current-mainnet-deployment)
7269
>
7370
> You can find the list of Holesky strategies for the `strategyWeights` field [here](https://github.com/Layr-Labs/eigenlayer-contracts?tab=readme-ov-file#current-testnet-deployment)
7471
75-
#### Multisig configuration
76-
77-
If you are using a Multisig for the contracts management (like upgrades or pauses), you need to set the Multisig address in the `permissions` sections.
78-
79-
For example, if you are using a Multisig for the `upgrader` permission, you need to set the Multisig address in the `upgrader` field.
80-
8172
### Deploy the contracts
8273
83-
Once you have configured the `.env` and `DEPLOY_CONFIG_PATH` files, you can run the following command:
74+
Once you have configured the `.env` and `config` files, you can run the following command:
8475
8576
For **Mainnet** deployment:
8677
@@ -100,40 +91,12 @@ For **Sepolia** deployment:
10091
make deploy_sepolia_aligned_contracts
10192
```
10293

103-
Once the contracts are deployed, you will see the following output at `OUTPUT_PATH` file:
94+
If the deployment is correct, you will find the deployment information here:
95+
96+
- [Mainnet deployment](../../contracts/script/output/mainnet/alignedlayer_deployment_output.json)
97+
- [Holesky deployment](../../contracts/script/output/holesky/alignedlayer_deployment_output.json)
98+
- [Sepolia deployment](../../contracts/script/output/sepolia/alignedlayer_deployment_output.json)
10499

105-
```json
106-
{
107-
"addresses": {
108-
"alignedLayerProxyAdmin": "<aligned_layer_proxy_admin_address>",
109-
"alignedLayerServiceManager": "<aligned_layer_service_manager_address>",
110-
"alignedLayerServiceManagerImplementation": "<aligned_layer_service_manager_implementation_address>",
111-
"blsApkRegistry": "<bls_apk_registry_address>",
112-
"blsApkRegistryImplementation": "<bls_apk_registry_implementation_address>",
113-
"indexRegistry": "<index_registry_address>",
114-
"indexRegistryImplementation": "<index_registry_implementation_address>",
115-
"operatorStateRetriever": "<operator_state_retriever_address>",
116-
"pauserRegistry": "<pauser_registry_address>",
117-
"registryCoordinator": "<registry_coordinator_address>",
118-
"registryCoordinatorImplementation": "<registry_coordinator_implementation_address>",
119-
"serviceManagerRouter": "<service_manager_router_address>",
120-
"stakeRegistry": "<stake_registry_address>",
121-
"stakeRegistryImplementation": "<stake_registry_implementation_address>"
122-
},
123-
"chainInfo": {
124-
"chainId": 17000,
125-
"deploymentBlock": 1628199
126-
},
127-
"permissions": {
128-
"alignedLayerAggregator": "<aligned_layer_aggregator_address>",
129-
"alignedLayerChurner": "<aligned_layer_churner_address>",
130-
"alignedLayerEjector": "<aligned_layer_ejector_address>",
131-
"alignedLayerOwner": "<aligned_layer_owner_address>",
132-
"alignedLayerPauser": "<aligned_layer_pauser_address>",
133-
"alignedLayerUpgrader": "<aligned_layer_upgrader_address>"
134-
}
135-
}
136-
```
137100

138101
## Batcher Payments Service Contracts
139102

0 commit comments

Comments
 (0)